Configuration¶

This section describes how you configure TRAML Tracking. You need to configure:

Runtime configuration
Web component configuration
Application configuration
Web client views

Runtime Config¶

Use Lime Admin to configure the Runtime Config. Each config parameter is described in and validated by Lime Admin.

Webhook usage is a flag if you will be using the webhook or not in this installation.

TRAML email limetype is a normal limetype and field mapping schema. TRAML SMS limetype is a normal limetype and field mapping schema. TRAML merge code limetype is a normal limetype and field mapping schema.

Link click limetype settings is a normal limetype and field mapping schema, only visible if Enable sync of clicked links is True Email opening limetype setting is a normal limetype and field mapping schema, only visible if Enable sync of email openings is True

Webhook usage¶

config webhook usage

This yes or no flag in the config is used as a decider on how status-option field and send-timefield will work when you create a Tracked TRAML card.

If you have this as No, all records will be set as status Sent and with the send time at the current time. If you set this to Yes, all records will be set as status Sending and without the send time. (The send time will be filled in by the webhook when the message is sent).

Link clicks and email openings¶

config link click opening

By checking the Enabled sync of clicked links/openings in the config you can control whether incoming link clicks and openings from a tracked traml email should show up in Lime. When using that feature you need to configure the tables and fields as well. This works similar to how it works in lime-newsletter and addon-lime-automation.

Example Configuration¶

This is an example that works out of the box with a Lime CRM Base Solution and the provided LIP package.

{
  "willUseWebhook": true,
  "willStoreSMS": true,
  "willStoreEmail": true,
  "tramlemail": {
    "propertyTramlmergecode": "tramlmergecode",
    "propertySendoutstatus": "sendoutstatus",
    "propertySent": "sent",
    "propertyDelivered": "delivered",
    "propertyFromname": "fromname",
    "propertyFromemail": "fromemail",
    "propertyRecipientname": "recipientname",
    "propertyRecipientemail": "recipientemail",
    "propertySubject": "subject",
    "propertyTransactionmail_id": "transactionmail_id",
    "propertyErrormessage": "errormessage",
    "propertyTemplateName": "templatename",
    "propertyTemplateId": "templateid",
    "propertyScheduledsendtime": "scheduledsendtime",
    "propertyEmlfile": "emlfile",
    "limetype": "tramlemail"
  },
  "tramlsms": {
    "propertySendoutstatus": "sendoutstatus",
    "propertySent": "sent",
    "propertySendernumber": "sendernumber",
    "propertyRecipientnumber": "recipientnumber",
    "propertyText": "text",
    "propertyTransactionsms_id": "transactionsms_id",
    "propertyErrormessage": "errormessage",
    "propertyScheduledsendtime": "scheduledsendtime",
    "limetype": "tramlsms"
  },
  "tramlmergecode": {
    "propertyTramlemail": "tramlemail",
    "propertyMergecode": "mergecode",
    "propertyValue": "value",
    "limetype": "tramlmergecode"
  },
  "linkClickEnabled": true,
  "linkClick": {
    "propertyLinkName": "linkname",
    "propertyLinkUrl": "linkurl",
    "propertyLinkValue": "linkvalue",
    "propertyLinkClickTime": "linkclicktime",
    "propertyLinkCategoryId": "linkcategoryid",
    "propertyLinkCategoryName": "linkcategoryname",
    "propertyTramlemail": "tramlemail",
    "limetype": "linkclick"
  },
  "emailOpenEnabled": true,
  "emailOpening": {
    "propertyEmailOpeningTime": "emailopeningtime",
    "propertyTramlemail": "tramlemail",
    "limetype": "emailopening"
  }
}

Web Component¶

The TRAML Tracking web component must be manually added in Lime admin. Add lwc-limepkg-traml-tracking-traml-email-html in the following places.

As a tab¶

Views➡Automatic email sendout➡Custom tabs

As Title you can use the translation key limepkg_traml_tracking.emailhtml.tabname or write something of you own liking.

config web component

On the card¶

Views➡Automatic email sendout➡Card➡Widgets

Set the properties to this:

{
    "isWidget": true
}

config web component widget