Skip to content

Configuration

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

Runtime Config

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

Root page config

At the first page in lime admin you can find this config:

root page config

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

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).

Create limeobjects from traml automation events should be set to true if you want to create traml limoebjects based the automation step Send transactional email. (Beta feature in limepkg-transactional-message-library from version 1.8.0)

More info can be found here how that feature works.

Limetype config

To configure the limetypes and properties for this package, go to "Limetype config" section in Lime admin. Select limetypes for SMS, Email and Mergecode. The properties will be prefilld after selecting the limetypes if you have the default names of all properties.

limetype config

config link click opening

By checking the Enabled sync of clicked links/openings in the config you can control if 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,
    "createAutomationLimeobjects": True,
    "limetypes": {
        "willStoreSMS": True,
        "willStoreEmail": True,
        "tramlemail": {
            "propertyTramlmergecode": "tramlmergecode",
            "propertySendoutstatus": "send_status",
            "propertySent": "sent",
            "propertyDelivered": "delivered",
            "propertyFromname": "from_name",
            "propertyFromemail": "from_email",
            "propertyRecipientname": "recipient_name",
            "propertyRecipientemail": "recipient_email",
            "propertySubject": "subject",
            "propertyTransactionmail_id": "transactionmail_id",
            "propertyErrormessage": "errormessage",
            "propertyTemplateName": "templatename",
            "propertyTemplateId": "templateid",
            "propertyScheduledsendtime": "scheduledsendtime",
            "propertyEmlfile": "emlfile",
            "limetype": "transactional_message",
        },
        "tramlsms": {
            "propertySendoutstatus": "sendoutstatus",
            "propertySent": "sent",
            "propertySendernumber": "sendernumber",
            "propertyRecipientnumber": "recipientnumber",
            "propertyText": "text",
            "propertyTransactionsms_id": "transactionsms_id",
            "propertyErrormessage": "errormessage",
            "propertyScheduledsendtime": "scheduledsendtime",
            "limetype": "tramlsms",
        },
        "tramlmergecode": {
            "propertyTramlemail": "transactional_message",
            "propertyMergecode": "mergecode",
            "propertyValue": "value",
            "limetype": "tramlmergecode",
        },
        "linkClickEnabled": True,
        "linkClick": {
            "propertyLinkName": "linkname",
            "propertyLinkUrl": "linkurl",
            "propertyLinkValue": "linkvalue",
            "propertyLinkClickTime": "linkclicktime",
            "propertyLinkCategoryId": "linkcategoryid",
            "propertyLinkCategoryName": "linkcategoryname",
            "propertyTramlemail": "transactional_message",
            "limetype": "linkclick",
        },
        "emailOpenEnabled": True,
        "emailOpening": {
            "propertyEmailOpeningTime": "emailopeningtime",
            "propertyTramlemail": "transactional_message",
            "limetype": "emailopening",
        },
    },
}

Web Component for email visualisation

The TRAML Tracking web component can be manually added in Lime admin if the viewconfig was not imported via addon installer. Add lwc-limepkg-traml-tracking-traml-email-html in the following places depending on where you want to visualise the content of the email:

As a tab

  • Views➡Transactional message➡Card➡Tabs➡Custom tab

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➡Transactional message➡Card➡Widgets

Set the properties to this: 

{
    "isWidget": true
}

config web component widget

Application Config

TRAML Tracking is using the same application config as limepkg-transactional-message-library, no need for any extra config. (This addon use the Bedrock credentials from limepkg-transactional-message-library to show the sent email in the Web component)