Onit Documentation

Email Tracking Provider User Guide

by Alex Heath Updated on

The Email Tracking Provider application allows you to provide workflow and notifications around the success or failure of delivery from Onit-generated emails, helping to monitor efficiency and ensure accountability.

With the Provider, users can either map their already-created email tracking application or create their own email tracking app.

Here's a step-by-step guide to using the Email Tracking Provider application.

Using the Email Tracking Provider

1. Click into the Email Tracking Providers application in the RAD.

2. The Email Tracking Providers screen will appear to the right. On the screen, click on the Add icon to add a new Email Tracking Provider.

3. This will open the Add Email Tracking Provider screen.

4. Fill out the Name of the provider. Use any name not currently taken by an Email Tracking Provider.

5. Use the drop-down menu to select the Application that will store the email logs. Note that you can either select an existing application from the drop-down menu or you can automatically create a new one by clicking on Create Email Tracking App.

If you need to create a new email tracking support application, the Create email tracking support app screen will pop up. Give the application a name and click Create.

6. Use the drop-down menu to select the Sent Date. This is the field on the app where you'll store the Sent Date value.

7. Use the drop-down menu to select the App Name, the field on the app where you'll store the Application Name value. This is the name of the application that triggers the email.

8. Use the drop-down menu to select the Reaction ID, the field on the app where you'll store the Reaction ID value. This is the name of the action that triggers the email.

9. Use the drop-down menu to select the Reaction Name, the field on the app where you'll store the Reaction ID value. This is the name of the action that triggers the email.

10. Use the drop-down menu to select the Atom ID. This is the field on the app where you'll store the Atom ID value.

11. Use the drop-down menu to select the Subject. This is the field on the app where you'll store the Subject value.

12. Use the drop-down menu to select the Recipient. This is the field on the app where you'll store the Recipient value.

12.  Use the drop-down menu to select the Status. This is the field on the app where you'll store the Status value.

13.  Select the Status Details. This is the field on the app where you'll store the Status Details.

NOTE: In the case of failures, Status Details can give actionable reasons for the failure.

14.  Fill in a Description (if necessary) and check the Enable box to start the Email Tracking Provider.

NOTE: Checking and unchecking the Enable box is an easy way to activate and deactivate the Provider.

15.  Add a Comment about the change you made (if needed) and click on Save to save the Provider.

To edit or delete Email Tracking Providers, go in to the Email Tracking Providers app and click on the desired Provider.

There, you can edit the Provider and click Save or click on Delete to remove the Provider entirely.

Once an Email Tracking Provider has been created it can be added to an Action that sends emails.

On Actions such as Send Notification you will see two new optional fields: On Any Failure and On Delivered. These fields are drop-downs containing the enabled Email Tracking Providers.

Multiple Email Tracking Providers can be created so that you can have one per Action or have separate apps for Successes and Failures.

Once you've created the Email Tracking Provider, you can view the tracked emails either in the created Email Tracking Provider application or in the Sent Email section under the Administration tab.

© 2024 Onit, Inc.

docs.onit.com contains proprietary and confidential information owned by Onit, Inc. that is subject to copyright. Onit presents it exclusively to you for your sole use in conjunction with using Onit products. No portion of the materials contained herein may be used for any other purpose. No portion of the materials contained herein may be shared with third parties or reproduced in any form.