Omail Integration Information

Omail System Settings

The following System Setting must be set to true to use the Omail integration functionality (by default, it is set to false):

System Setting Name System Setting Value
omeda.integration.enabled true

The following System Setting determines which servers at Omeda that ePublishing will establish a connection with:

System Setting Name System Setting Value
omeda.api.url https://ows.omeda.com

Possible values for this are:

  • Omeda Production is https://ows.omeda.com
  • Omeda Staging is https://ows.omedastaging.com

The following System Settings must be filled in, values are provided by Omeda at the beginning of your project:

  • omeda.­app.­id (this is the API key)
  • omeda.­approver.­user.­id (this is needed for API calls)
  • omeda.­brand.­abbr (this is the brand’s abbreviation setup by Omeda)
  • omeda.­owner.­user.­id (this is needed for API calls)

Newsletter Rendering Options

The following Rendering Options will need to be set in Newsletter Manager > Edit > Rendering Options for each newsletter you create. This is set once per newsletter, changes will then be rendered onto the individual newsletter issues:

Name Value Example
omeda.deployment.type 1234
omeda.test.email “eNews Mail” <enewsmail@clientsite.com>

omeda.deployment.type

Required. This is a value provided by Omeda.

omeda.test.email

Required. The value is a vanity name and email address that gets included in Omail’s test sends. This is handy in the event the newsletter editor is not part of the Omail test list (this way, test lists don’t have to be adjusted through Omail’s settings). Omeda requires to send a test approval email before sending the real newsletter as part of their process; however, confirming that test email is received is not required by the person receiving the test from this Rendering Option.

How to send newsletters using the Omail integration

  1. Make sure System Settings are set properly (and that omeda.integration.enabled is set to true)
  2. Go to Admin > editorial > Newsletter > List & Edit
  3. Select your Newsletter
  4. Set the “External mailing service list ID” on the Newsletter Manager > General page - this value comes from Omeda (they refer to it as the “Query Name”) and determines who receives the mailing
  5. Make sure all necessary Rendering Options are set for the Newsletter under Edit > Rendering Options
  6. Then go to Edit > Issue > Create
  7. Fill in the newsletter issue Title, Volume and Issue number are optional - if you are using content zones and shortcodes, make sure all of those are properly setup (see http://help.epublishing.com/m/32641/l/749289-setting-up-a-default-newsletter-template-with-shortcodes)
  8. Under Article, click Associate and choose the articles you want to include in the issue
  9. Click Create
  10. Now, go to Edit > Content
  11. Click Generate Creative Copy, click Save
  12. If you want to make any adjustments to the HTML you can click Edit in WYSIWYG editor, make your changes and save them, then save the content again in Newsletter Issue Manager’s Content page
  13. Add your issue’s subject line in the “Subject line for mailing” field
  14. Select a Publish Date
  15. Select a Publish Time (24 hour time, Central zone, be sure to set this for a time at least 5 minutes in the future)
  16. Send your test or Release the newsletter for publication
    1. If you are sending a test rather than an actual newsletter deployment, on the final page, enter any text string in the Alternate testing mailing list ID field (the word “test” will work perfectly) and instead of clicking Release for publication, click Send test publication. Admin requires the Alternate ID field to not be empty in order to send a test.
    2. Field/Button combinations, to confirm:
      1. External Mailing List ID / Release for Publication
        1. This will connect to Omeda’s Deployment API
      2. Alternate testing mailing list ID / Send test publication
        1. This will connect to Omeda’s Test API

For Newsletter Issue Releases:

Using the field/button combination of External Mailing List ID / Release for Publication, the following steps will be executed against Omeda’s Deployment API:

  1. Create a new deployment
  2. Add Audience to Deployment
  3. Check Audience Assignment Status
  4. Deploy Content
  5. Send test deployment
  6. Schedule the Deployment

For Newsletter Issue Tests:

Using the field/button combination of Alternate testing mailing list ID / Send test publication, the following steps will be executed against Omeda’s Test API:

  1. Create a new deployment
  2. Deploy Content
  3. Send test deployment

Other Important Notes/Reminders

  • If testing is being conducted in the ePublishing Stage environment, be sure to notify your Project Manager for each newsletter send - they will have to run a process on the ePublishing servers to execute the newsletter send for each issue.
  • Make sure that the value for omeda.test.email is valid on any new newsletters you create - the newsletter send will fail if this RO is not properly formatted.
  • Be sure to click Generate Creative Copy and Save on each newsletter issue before you send them to make sure that you’ve compiled the most up to date code.