Deploying the Integration

Describes the three-step deployment process.

Deploying this integration is a simple process that requires the following actions:

Completing the Integration Wizard

Steps to use the integration wizard.

To activate the integration, you must complete the Lyris integration wizard within the Data Connectors interface.

  1. Navigate to the Data Connectors (formerly Genesis) area within the Adobe Experience Cloud.

  2. Under Add Integration, under Lyris HQ, click Activate.

  3. Under General Settings, choose the desired Report Suite and provide a name for the integration.

  4. Fill in all your Lyris account-related information under Custom Values.

  5. Choose the appropriate reserved eVars and events from the drop-down menus.

  6. You may choose your own segments under Your Segments - apart from the 3 automated Partner segments.

  7. This integration may require downloading a few data point to your Lyris account. You may choose to give access for this under Access Request.

  8. Under Data Collection, you can choose to have an automated or a manual solution (JavaScript Plug-in) to collect query string parameters from the landing page URL. If you choose to have an automated solution, enter your query string parameter for Message ID and Recipient ID. For a JavaScript Plug-in, contact your Adobe Consultant.

  9. You may choose to have the Lyris Dashboard and bookmarks automatically generated for you.

  10. Review the integration summary and click Activate.

Configuration within the Lyris EmailLabs

Steps describing what to configure within Lyris following the completion of the wizard.

  1. After completing the integration wizard, you must work with the Lyris Professional team to complete the integration to your Lyris HQ account and facilitate testing.

  2. Add URL Query String Parameters: Verify that the URL append string is properly input into the Organization settings areas of the user interface. This should contain the campaign level ID (hq_m) and recipient level ID (hq_v).

    An example of a string ID is:


    If you are applying Lyris’s native analytics tool, Click Tracks tags all of the required variables that are added.

Verifying the Integration

Steps to verify that the Lyris/Adobe Analytics integration was successful.

Once all deployment steps have been completed, you can validate that the integration is successfully transferring data.


It takes a few days for the data exchange to begin. Please make sure you contact Lyris after you activate the integration.

  1. Navigate to your Lyris Integration within Data Connectors. Under the Support tab > Integration Activity Log, you should see events like Metric data imported successfully and/or Classification data imported successfully:

  2. Now view your Lyris message reports with the appropriate metrics. In the Adobe Experience Cloud, select Reports & Analytics.

  3. Select the appropriate Report Suite.

  4. Under Custom Conversions, select the Message ID Reports and choose Message ID/Message Name.

Query String Param Plug-In Code

Shows the Lyris plug-in code to use with Adobe Analytics.


Please make sure that you reserved the necessary eVars in the Admin Tool of Adobe Analytics before you work with the code below. Once you know which eVars you have reserved, replace eVarN with the relevant eVar. E.g. eVar10.

  * Plugin: getQueryParam 2.3 
s.getQueryParam=new Function("p","d","u","" 
+"var s=this,v='',i,t;d=d?d:'';u=u?u:(s.pageURL?s.pageURL:s.wd.locati" 
+"=p.length?i:i+1)}return v"); 
s.p_gpv=new Function("k","u","" 
+"var s=this,v='',i=u.indexOf('?'),q;if(k&&i>-1){q=u.substring(i+1);v" 
+",'&','p_gvf',k)}return v"); 
s.p_gvf=new Function("t","k","" 
+"if(t){var s=this,i=t.indexOf('='),p=i<0?t:t.substring(0,i),v=i<0?'T" 
+"rue':t.substring(i+1);if(p.toLowerCase()==k.toLowerCase())return s." 
+"epa(v)}return ''"); 
/*in the s_doPlugins function - Replace N with actual eVar number*/ 
s.eVarN=s.getQueryParam("<insert Lyris QS Param>");  
//places query param value from Message ID in eVarN variable s.eVarN=s.getQueryParam("<insert Lyris QS Param>");  
//places query param value from Recepient ID in eVarN variable 

On this page