Installation Instructions

1. Make Sure All Requirements are Met

Requirements can be found here.

2. Package Installation

The library is added to the solution by adding it to the dependencies:

poetry add limepkg-transactional-message-library

Info

Remember: If TRAML is being used by another limepkg that you are installing, it will automatically be installed for you, but you still need to configure it.

3. Set up Lime Marketing API-key

Log in to the Lime Marketing app as an administrator. Go to Administration -> Integrations -> API keys and create a new API key. Attach that API key to a user in Lime Marketing. It's recommended to select a user dedicated for integrations.

4. Sending Domain

Once a sending domain is verified, any email address from this domain can be used as the “from email address”. Follow the Lime Newsletter documentation for Setting Up Sending Domains to ensure that the domain is set up correctly.

5. Configure TRAML configuration

TRAML doesn't work without knowing the URL and API-key to Lime Marketing. Configure it by following the configuration instructions.

6. Test Lime Marketing Bedrock connection

To test the configured Lime Marketing Bedrock API URL and API-key go to Lime Admin -> Addons -> TRAML and click the Check Bedrock Connection button. The button should turn green - otherwise check the troubleshooting

7. Profit 🥇

8. Install "Transactional message" table (Optional)

Run the addon installer found under TRAML -> Setup in Lime Admin. This will add the transactional_message limetype to the database as well as configure the webclient view for the limetype. Don't forget to add the new limetype to the Browser Menu.

It's recommended to set a read-only policy to the table for all users.