Configuration

The following Lime Marketing configuration parameters are required:

  • api-key
  • URL
  • username (email address)

Warning

Make sure your customer/user has a Lime Marketing account!

If you do not have a Lime Marketing api-key or want to create a new one go to: Administration -> Integrations -> API-key settings and create a new key connected to an account.

On-premise

Starting from Lime CRM server version 2020.2 ("Keb"), TRAML now supports the usage of application-config.

  1. Follow the instructions on the Platform Docs and add config as in the example below to your YAML. Change customername in api_url to the customer specific site.
  2. Restart the Lime CRM Event Handler.
<app-name>:
  config:
    transactional_message_library:
      api_url: https://app.bwz.se/customername/bedrock/api/
      api_user: your-bwz-user
      dryrun: true | false

  secrets:
    transactional_message_library:
      api_key: your-api-key

How to Enable Application Config For Server Version 2020.2

Navigate to the event handler config in %ProgramData%\Lundalogik\LIME Pro Server\Event Handler\configs\config.yml and add the following:

  features:
    application_configuration: true

Restart the Lime CRM Event Handler.

TRAML on Legacy Lime CRM Servers

Application config is not supported before version 2020.2, configurations of earlier Lime CRM server versions should follow the steps below:

  1. Add your Lime Marketing credentials to "%ProgramData%\Lundalogik\LIME Pro Server\Event Handler\configs\config.yaml" as in the example below. Change customername in api_url to the customer specific site. Make sure the file contains valid YAML, i.e., correct indentation.
  2. Restart the Lime CRM Event Handler.
plugins:
  transactional_message_library:
    api_key: your-api-key
    api_url: https://app.bwz.se/customername/bedrock/api/
    api_user: your-bwz-api-user
    dryrun: true | false

Info

config.ini is ignored if a config.yaml exists.

Cloud

TRAML can be used in Cloud if you enable customizations or if you are using it through an add-on that has a dependency to TRAML and is deployed to the shared cloud, e.g. eSign. To configure TRAML in Cloud, go to CAFE and enter config as the following example YAMLs.

Configuration

Remember to change customername in api_url to the customer specific site.

transactional_message_library:
  api_url: https://app.bwz.se/customername/bedrock/api/
  api_user: your-bwz-api-user
  dryrun: true | false

Secrets

transactional_message_library:
  api_key: your-api-key

DRY-RUN

It is possible to test drive TRAML without actually sending any emails. By setting the configuration parameter dryrun to true, you can check that everything is working as expected, up to the point of actually posting to the bedrock API. TRAML will log the following info to the standard logger:

*** TRAML DRY RUN MODE *** Ready to POST 7 message(s) to the API but will stop here.

Make sure to set dryrun to false before deploying to production or no emails will be sent out!