Installation Instructions

Preparations

• Check that the requirements are met.

Installation

This is your checklist during the installation.

1. Add limepkg-traml-tracking as a dependency to your solution: poetry add limepkg-traml-tracking
2. Build and deploy/install your solution.
3. Use addon installer
4. Configure the add-on.
5. If using webhook: Set up policies
6. If using webhook: Set up Lime marketing webhook

Addon installer

The addon installer will automatically install the structure defined here. In the dialog for addon installer you can choose what limtypes that should be related on email sendouts and sms sendouts. Example could be "person" and "company".

Store the API key given to you in a secure place if you want actual feedback of TRAML sendouts (Opened, Clicked, Bounced, actual sendout-time and so on).

If you can't or don't want to use addon installer, create all the tables and fields manually in Lisa.

Disclaimer

Try to avoid installations with Addon installer during office hours, if possible declare a service window for it. Since the installation will change the database structure this will invalidate a lot of caches. Rebuilding those, is less problematic the fewer users are logged into the system. Create a backup of the customer's database before you're starting the LIP installation. Should anything go wrong and corrupt the database, you can simply restore the backup file.

Policies

Not mandatory, only do this if you want actual feedback of TRAML sendouts (Opened, Clicked, Bounced, actual sendout-time and so on)

1. Create table policies for tbl_tramlemail, tbl_tramlsms, tbl_tramlmergecode, tbl_linkclick (if you will be using link clicks), tbl_emailopening (if you will be using email openings) and add the limepkg-traml-tracking group

Lime marketing webhook

Not mandatory, only do this if you want actual feedback of TRAML sendouts (Opened, Clicked, Bounced, actual sendout-time)

1. Log in to Lime Marketing
2. Navigate to the Administration page

3. Go to Integrations>Webhook subscriptions, and create a new webhook subscription with the following information:

   • Name: Lime CRM Traml tracking
   • URL: https://<server>/<limeenvironment>/limepkg-traml-tracking/traml-status-webhook/
   • AppId: <Leave empty>
   • Secret: <Leave empty>
   • Send batched webhooks: NO (Could be set to YES as well if the Marketing app will generate a lot of webhooks)
   • Hide header settings: YES
   • Headers: x-api-key: <API-key for the [email protected] API user, that you got from addon installer>
   • Subscribe to all webhooks: Chose specific
   • Turn on webhooks for:
     • transactionmail.bounced
     • transactionmail.delivered
     • transactionmail.link_clicked
     • transactionmail.not_sent
     • transactionmail.opened
     • transactionmail.sent
     • transactionsms.delivery.failed
     • transactionsms.delivery.succeded
     • transactionsms.sent

   Warning

   Spaces matter! Don't remove the one after x-api-key:

   Info

   Remember to check Hide header settings to not display the API key in plain text

   

   

limepkg-transactional-message-library

The whole point of using this limepkg is to use it together with the limepkg-transactional-message-library, however you can configure and setup TRAML at any stage you want, before this installation or afterwards.