The Configuration Checklist - Standard

Updated 3 months ago by Angelo Matheou

Welcome to Aptrinsic!  

Although the initial installation should be straight-forward, we’ve put together this checklist to make it dead simple.

Note that this Install Checklist is for those who are NOT using any Tag Management platform.  If you are, please click on one of the below:

Still here?  Great, once you complete the below steps, your Aptrinsic Installation will be complete so that your events and their associated users/accounts from your product will be flowing into Aptrinsic.

Here's a quick setup video


STEP 1:  Create your Product Definition and Aptrinsic Tag Code

Navigate to Account Settings->Products and create your product definition and click Create, for example:

Once created, you’ll see there is a tab for each channel you can Generate an Aptrinsic Tag for (i.e. Web App, Website).  Let's create the Web App tag for this product by entering in the URL of your Web Application and clicking on the orange Generate button.  

The URL you enter is for informational purposes only and what you enter there does not impact your use of Aptrinsic.  Nevertheless, it is good practice to enter in the URL there to keep track of which of your products is assigned to which tags.

Now you have created the tag that will be associated with your product & channel (i.e. Web App or Website).

If you also have a website channel that you want to track leads from, click the Website tab, enter in the URL for your website and again, click the Generate button to create the tag for the website channel.

NOTES:

  • You have the ability to create, track and build engagements for more than just one product!  Just repeat the process for your additional products
  • You may also want to define one product for each of your environments that you plan on using with Aptrinsic (i.e. staging, production)
  • The free version of Aptrinsic allows for one product definition

STEP 2: Get the Tag Installed on to your Web App and Web Site (developer assistance needed)

Once you have the Aptrinsic Tag generated (STEP 1), click on the Copy Button to copy the Aptrinsic Tag code on to your clipboard.

Now you can paste the tag into an email, slack, JIRA ticket, etc. and send it to your developer with instructions to add it to the <head> section of your web application (or website) as close to the opening <head> element as possible and below any dataLayer=[{...}] declarations.

Check out the sample verbiage below that you can use for the note to your developer below :)


STEP 3: Make the Identify call (developer assistance needed)

The identify() call is javascript code that your developer will also need to add to your product.  This call should be made from your application from where the user authenticates so that your web application can provide user and account information of the user that is generating & sending events to Aptrinsic.

We've created a below sample message that you may want copy/paste and send off to your development team.

******************************************************************
***  BEGIN SAMPLE EMAIL TO DEVELOPER TEAM  ***

******************************************************************

Hi Dev Team,

We've signed up to use a vendor called Aptrinsic that will allow us to build in-application experiences (i.e. tooltips, sliders and guides) to help us with product adoption & user retention. As part of their installation, we need to perform both of the below tasks:

Task 1 

Add the Aptrinsic tag to our code to push our web app's events to the Aptrinsic platform.

Install the Aptrinsic Tag to the <head> section of our web application, as close to the opening <head> element as possible and below any dataLayer=[{...}] declarations.

Here is the tag to add to our production web application

[REPLACE THE XXXXXXXXXXXX WITH THE TAG FROM STEP 1]

Task 2

In our production web application, we'll need to also push the correct user/account over to Aptrinsic so

that we can associate the events that are tracked (i.e. clicks, page views, etc.) with the correct user/account.  

Please add the below javascript to the location of where the authentication code takes place in our web app.

If you can be sure to include all of the known user and account attributes that we have for that user

and account by referencing their API name, here is the full list of out of the box attributes and their API names.

If there are other attributes we should send to Aptrinsic, just let me know and I can set them

up in Aptrinsic as custom attributes (here).

//passing user and account objects: 
aptrinsic("identify",
{
//User Fields "id": "unique-user-id",
// Required for logged in app users
"email": "userEmail@address.com",
"firstName": "John",
"lastName": "Smith",
"signUpDate": 1522697426479,

//unix time in ms
"plan" : "gold",

//Custom attributes - please create those custom attributes in Aptrinsic via Account Settings to be tracked.
"price" : 95.5,
"userHash": "" // optional transient for HMAC identification },
{
//Account Fields
"id":"IBM", //Required
"name":"International Business Machine",
"Program": "Platinum"
// flat custom attributes
});

How did we do?