Page Comparison

What is Mailigen?

Mailigen is newsletter creation and automation platform. Platform offers management of contact lists, creation of letter templates using WYSIWYG e-mail template editor, analysing campaign results and more. We can send Standard ERP customer letters such as announcements or adverts using them as delivery mechanism.

...

In the end, your Mailigen Settings should look something like this:

Sending a letter from SERP

...

In order to create Activities with the recipients of the Customer Letter as the contacts, add an Activity Type in the Mailigen settings.

If a campaign has been created from the Customer Letter (Campaign status has to be "Campaign Created". If the Status is "In Progress", run maintenance "Mailigen campaign check" (button in Customer Letter)) and it is OKed, Activities will be created for all of the recipients of the Customer Letter that currently match all of the criteria.

How to send a letter from Standard ERP

1. Create a First, in Mailigen, create a template you will use to format this e-mail. You  You can create one from scratch or use their provided templates, but the main thing is that you need to have a code of the template without any spaces and in capital letters. For this example I will use one called USER-PASSWORDS:
   
2. Create a new letter in CRM>>Register>>Customer CRM > Register Customer Letters
3. Select either specific customer or put an asterisk * in the customer field to send for all customers matching other criteria
4. Select either a specific customer category or leave it blank To send the letter to a specific contact, select the contact in the Customer field. To send the letter to all contacts, input an asterisk "*"

5. If you wish to filter the recipient contacts by category, select either a specific contact category or input an asterisk "*" to send the e-mails to all of the categories defined in the setting (if setting is blank, sends to all categories)

   If applicable

   categories

   • If the field Category has * in it and the field Include only categories is defined in the Mailigen Settings, e-mails will be sent only to these categories

   •  You cannot create a Mailigen campaign from a Customer Letter, if the contact category is indicated and does not match any of the ones defined in the Mailigen Settings Include only categories field
6. To send the letter to a classification list, choose the corresponding list name from the dropdown in the Mailigen List field
   • Choosing a classification list will automatically filter the contacts using the corresponding list classifications
   • If you leave this field blank, the letter will be sent to the main list defined in the Mailigen Settings
7. If applicable, select one or more classifications to filter down the contacts accordingly
8. Enter the subject of the e-mailthe email in the Header field
9. Enter the template name from above in the field Document Form Template (e.g. USER-PASSWORDS)
10. Select the person that should be placed in the Reply to of the e-mailemail in the Reply To (Email) field
11. To check which contacts will be the recipients of the letter, use Operation >> > Letter List
12. Run Operations>>Create Operations > Create Mailigen campaign. This will create a campaign on Mailigen side. in Mailigen with the title from the Header field
    • Along with the Campaign, one or multiple contact segments will be created, which titles are the Customer Letter number (field No.). These segments are used as the contact lists for the Campaign
    • After the operation, the field Mailigen Status will change from N/A to In Progress. 
    • Due to different business checks we can't send the campaign immediately
    To check if
    • , so to check if the campaign has been created successfully,
    presss
    • press the button
    "
    • Mailigen campaign check
    ".
    • • If everything went well, there will be a popup message, and the status of the letter will change to
    "
    • • Campaign created
    "
    • • If not, check the troubleshooting section to check what might have gone wrong
13. Click the Open Mailigen campaign button to go to Mailigen and send the campaignImage Added
14. Once the campaign is done, check OK in the letter to indicate that it has been done.
    • If there is an
    "
    • Activity type
    " filled
    • indicated in the
    setting
    • Mailigen Settings, then activities will be created for all of the recipients of the Customer Letter that currently match all of the criteria
    .
    Image Removed

How to set up the Mass Mail package on server

These are main steps for setup:

...

1. Install nodejs (for example: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-up-node-on-ec2-instance.html)

...

1. Link mailigen folder to SERP root folder for example

   Code Block
   ln -s git/mailigen mailigen

...

1. 
   

2. Install node package in the mailigen folder (for example npm install xmlhttprequest)

...

1. Add needed HAL rules

...

1. In SERP set up Timed Event MassMailCheckMn that will periodically update campaign status from Mailigen (i.e. is it created)
2. Add Mailigen settings in CRM > Settings > Mailigen Settings
   • Script runner - node (or full path to node, if just node does not work)
   • Campaign file location path - location, where the generated campaign and other informational files will be located. These indicate, which campaigns have been created. Example - tmp-mailigen/. The folder must exist!
   • Mailigen file location path - location, where the

...

1. • Mailigen code execution files are located. In a previous step, the git/mailigen folder was linked to mailigen, so this should be mailigen/
   • API key - From Mailigen > Settings > API keys
   • Authentication key - should match the parameter "key" defined in Webhook call URL
   • Main List Web ID - Mailigen contact list ID, that can be found in the URL, when the appropriate list is opened (https://admin.mailigen.com/contacts/dashboard/?id=XXXXXX, where X is a number)

Troubleshooting

...

• mailigen-debug.log file located in the server root contains information from the requests made and passed data. If there were any errors with a request, they will be displayed here
  • So if something did not work/happen, check mailigen-debug.log first
• If mailigen-debug.log file is present, but is empty, there might be a problem with either the script, or the running of the script. To check this, run the script manually:
  • In the server root run node mailigen/script.js (if node is the script runner and the symlinked mailigen folder from git was named mailigen) - this will most likely display any errors with the running of the script
• If the mailigen-debug.log file is present and is not empty, but has old data in it (e.g from a previous request), then that means that the script has not been called from HAL
  • If so, first check in the server console if there are both output messages:

    • Mailigen request is processing ... (Wait for a success message)

    • Mailigen request completed

  • If not, then that means the script failed to execute
  • If both messages were present on the server console, next you have to check if a mailigen.json file is created in the mailigen/ folder with the latest request data (If making a campaign, check the letter No., if adding an email to a list, check the email)
  • If so, this means that the HAL side has worked
  and
  • , but the script has not been run
  - problem with either
  • . Check if the Script runner
  being defined incorrect or
  • and Campaign file location
  path
  • is defined correctly.
  The If it is possible to run node from the command line in the server folder and
  •  The folder must exist beforehand
  .
  • • To check whether the Script runner and Campaign file location is defined correctly, run the script manually in the server root using the defined Script runner (e.g node mailigen/script.js). If it executes without errors, but it does not work when running from the Letter, then that means that the Script runner is defined incorrect
  .
  • • On a successful run, a file should be made in the defined Campaign file location (mailigen
  +
  • • _campaign_letterNr_timenow
  )On the server, Mailigen-debug.log outputs all of the key information that might be useful (segment, campaign creation, list modification etc
  • • .txt)