Lyris Parameters

For more detailed descriptions of the parameters, see Configuring Lyris HQ.

Lyris.Enabled

Set this parameter to true to enable Lyris features in Aurea CRM. Default value is false.

Type: CheckBox

Lyris.SyncMiddlewareUri

Specify the URI of the Lyris Sync Middleware’s Active MQ endpoint. The URI should also include the port number. For example, tcp://52.204.45.159:61616.

Type: String

Lyris.SyncMiddlewareUsername

The username for authenticating with the Lyris Sync Middleware configured at the URL specified in the parameter: Lyris.SyncMiddlewareUri. For example, MQ2014000029. You can provide the username or Aurea support can provide one, when you place a request. For more information on the ordering process, see Ordering Access to the ACM SyncMiddleware.

Type: String

Lyris.SyncMiddlewarePassword

The password for authenticating with the Lyris Sync Middleware configured at the URL specified in the parameter: Lyris.SyncMiddlewareUri. For example, MQabc12345911. For more information on the ordering process, see Ordering Access to the ACM SyncMiddleware.

Type: String

Lyris.SegmentGeneratedNotificationEmail

The email address that receives an information message from Lyris, when Lyris completes the generation of a segment requested by Aurea CRM.

Type: String

Lyris.TriggerOnLyrisMessageDeleted

The name of the trigger to be executed by Aurea CRM, when an event notifying the deletion of a Lyris message is received by Lyris Sync Middleware consumer.

Type: String

Lyris.TriggerOnLyrisContactBounced

Specify the name of the trigger to be executed by Aurea CRM, when a target group member’s contact status is set to Bounced in Lyris. For detailed information on triggers and how to define them, see Triggers in the CRM.core Administrator Guide.

Type: String

Lyris.DoubleOptinMapping

Specify the value to enable the mapping of Lyris demographics to CRM fields used to create and update CRM records during the processing of ContactDataUpdateMessage with DoubleOptin. The specified value should have the format: 
infoAreaId:demographicId=fieldId,demographicId=fieldId|infoAreaId
An example value would be FI:1=5,2=8|KP:1=4,2=19,3=8|PE:1=2,2=7.

When a new recipient subscribes to a Lyris HQ mailing list on the Lyris HQ Landing page, he get a confirmation message before being added to the Mailing list. CRM adds contact to corresponding infoarea and not add to Target group, if the DoubleOption parameter is used. He is added to the appropriate info are based on the following heuristics:

1. Add the recipient to the Company contact if a Company contains the recipient as a contact email address.

2. If Company doesn't exist, then CRM.Web checks if a Company with the domain exists.

3. If Company with the domain exists, it checks if there is a PersonInCompany with a contact email of the recipient.

4. If PersonInCompany doesn't exist, the recipient is added to it.

5. If the Company with email or domain doesn't exist, CRM.Web checks if there is Person (PE) with contact email address of the recipient.

6. If Person doesn't exist, the recipient is added to the Person info area.

The DemographicID is defined in Lyris HQ and fieldID is defined in the ACRM infoarea. The types of DemographicID and fieldId should be of compatible types and are listed below:

  1. String=String
  2. String=Catalog value
  3. Date=Date
  4. Number=Number

Type: Character

Lyris.ActivityExecutionDemographicId

Specify the demographics ID, CRM is required to provide when requesting demographics to be created for the CRM fields, in Lyris. For more information on retrieving this value from Lyris HQ, see Getting Lyris Web Configuration Parameter Values from Lyris HQ

Type: multi select

Lyris.Host

Specify the URL of the server hosting the Lyris API. It should be either an IP address or a fully qualified name of the machine hosting Lyris HQ API. Example value, elabs14.com.

For more information on retrieving this value from Lyris HQ, see Getting Lyris Web Configuration Parameter Values from Lyris HQ.

Type: String

Lyris.APIPassword

Specify the authentication password to use, when Aurea CRM makes an API request to Lyris. For more information on retrieving this value from Lyris HQ, see Getting Lyris Web Configuration Parameter Values from Lyris HQ.

Type: String

Lyris.MailingListNamePrefix

Specify a prefix with which a new mailing list id is created in Lyris. A mailing list is created, when Aurea CRM transfers a marketing activity to Lyris.

Type: String

Lyris.MailingListUrlTemplate

Specify the string template used by Aurea CRM to generate the URL of a mailing list entity created by Lyris. The mailing list is created by Lyris on demand, when Aurea CRM transfers a marketing activity to Lyris. You can provide one of the following:

  1. https://Lyrishq.net – In this case the user is forwarded to the Lyris HQ dashboard and he has to find the required maling list object.
  2. https://<Lyris.Host>/v3/mailing_list.html?NEXTPAGE=mailing_list_view& setmlcookie=on&mlid={lyrisMailingListId}
    • Where <Lyris.Host> is the value of the Emaillab domain name set in the Lyris.Host web configuration parameter described above.

The specified template value should contain the placeholder tag {lyrisMessageId} which is replaced by the Lyris message id generated by Lyris. A sample value is https://www.elabs14.com/v3/mailing_list.html?NEXTPAGE=mailing_list_view&setmlcookie=on&mlid=385.

Note: Click on the Lyris mailing list link generated in Aurea CRM. This opens the required mailing list in Lyris Emaillabs, if the following conditions are satisfied:

  1. You have already logged into Lyris HQ at https://lyrishq.net.
  2. An instance of Emaillabs is already launched from Lyris HQ.

If the above conditions are not satisfied then you are directed to the login page at https://lyrishq.net.

Type: String

Lyris.MessageUrlTemplate

Specify the string template used by Aurea CRM to generate the URL of a message entity created by Lyris. The message is created by Lyris on demand from Aurea CRM. You can provide one of the following:

  1. https://Lyrishq.net – In this case the user is forwarded to the Lyris HQ dashboard and he has to find the required maling list object.
  2. https://<Lyris.Host>/v3/mailing_list.html?NEXTPAGE=mailing_list_view&setmlcookie=on&mid={lyrisMessageId}

Where <Lyris.Host> is the value of the Emaillab domain name set in the Lyris.Host web configuration parameter described above.

The specified template value should contain the placeholder tag {lyrisMessageId} which is replaced by the Lyris message id generated by Lyris. A sample value is https://ip-172-30-90-193.ec2.internal/v3/mailing_list.html?NEXTPAGE=mailing_list_view&setmlcookie=on&mlid=459.

Note: Clicking on the Lyris message link generated in Aurea CRM opens the required message in Lyris Emaillabs, if the following conditions are satisfied:

  1. You have already logged into Lyris HQ at https://lyrishq.net.
  2. An instance of Emaillabs is already launched from Lyris HQ.

If the above conditions are not satisfied then you are directed to the login page at https://lyrishq.net.

Type: String

Lyris.SegmentUrlTemplate

This web configuration parameter is used to enable the administrator to configure the URL template that is used by ACRM to construct a URL that leads to the UI page where a Lyris segment is displayed.

This URL is used for the creation of an anchor link that is displayed in the 3rd step of "Transfer of Target group to Lyris" process (see Configuring target group creation and scheduling). This enables the user to view the corresponding segment in Lyris UI on a single click. For further details on configuring Lyris HQ, see Configuring Lyris HQ.

The template URL stored in Lyris.SegmentUrlTemplate supports two placeholders:

  • {lyrisSegmentId}: This placeholder exist inside Lyris.SegmentUrlTemplate and is replaced during the construction of the URL by the Lyris segment ID.
  • {mailingListId}: This placeholder may or may not exist in Lyris.SegmentUrlTemplate as it is not mandatory. If it exists, it is replaced by the mailing list ID during the construction of the URL. If it is not present in the template then it is just ignored.

You can use one of the following two strings in the template to be used by CRM in generating the URL of a segment in Lyris:

  • https://Lyrishq.net – This takes the user to the Lyris HQ dashboard, where he needs to find the required maling list object.
  • https://<Lyris.Host>/v3/mailing_list.html?NEXTPAGE=mailing_list_filter_create&ID={lyrisSegmentId}, where <Lyris.Host> is the value of the domain name set in the Lyris.Host web configuration parameter as described in the above section. The specified template value should contain the placeholder tag {lyrisSegmentId} as explained above. For example, https://ip-172-30-90-193.ec2.internal/v3/mailing_list.html?NEXTPAGE=mailing_list_filter_create&ID=459.
Note: The following conditions must be met to open the required message in Lyris s, when you click on the Lyris segment link generated in Aurea CRM:
  • You must be logged into Lyris HQ at https://lyrishq.net.
  • An instance of Emaillabs is already launched from Lyris HQ.

If the above conditions are not met, the user is redirected to the login page at https://lyrishq.net.

Type: String

Lyris.SiteID

Specify the site id, a lyris parameter that is sent as part of all API requests by Aurea CRM. For more information on retrieving this value from Lyris HQ, see Getting Lyris Web Configuration Parameter Values from Lyris HQ.

Type: String

Lyris.TriggerOnLyrisContactBounced

Specify the name of the trigger to be executed by Aurea CRM, when a target group member’s contact status is set to Bounced in Lyris. For detailed information on triggers and how to define them, see Triggers in the CRM.core Administrator Guide.

Type: String

Lyris.TriggerOnLyrisContactUnsubscribed

Specify the name of the trigger to be executed by Aurea CRM, when a target group member’s contact status is set to Unsubscribed in Lyris. For detailed information on triggers and how to define them, >> Triggers in the CRM.core Administrator Guide.

Type: String

Lyris.DemographicOptionsLanguage

The language in which the demographics are created in Lyris. Valid values are: ger, eng, fre, spa, por, nld, dan, ita, cze, hun, slk, pol, gre, ukr, sln, rus, swe, fin, nor, tur, cro, ser, ron, jpn, chn, kor, bul, tha, and alb.

Type: String