User - Manual

Written By Devin O'Neill ()

Updated at April 8th, 2025

Summary

  • A cron job extends the functionality of a conventional job by allowing you to specify how the work should be run.
  • Only a single instance of a job should be run at any time. Also, keep in mind that in some rare cases, many iterations of the same job may be required.
  • That is, if one cron task fires while another is still running, the first will halt before continuing normally.

Connectivity Settings

As a user, you want to implement some functionality that needs connectivity between your server and Annex Cloud Server ESPs. Annex Cloud will be set up these settings in the Connectivity Settings section.

This Data Sync Dashboard shows connection name, platform, verification status, export, and search options.

Steps to add new ESP connection

To establish a new ESP connection, click on the Add New tab and fill in the following attributes.

Pass the connection, platform names. Annex cloud provides the Secret key, API key, Access Token, Token id, and many more depending on the platform’s requirement.

The secret key, Access Token, and Token ID fields change according to the platform selected.

if you are establishing a connection right away, select the test connection and hit the save tab.

Once a test connection is done and the connection is established, the verification status is verified.

Email Template

Email template helps you know the status of the cron the success or failure.

Navigation: Options > Data Sync > Email Template > Add New

For example, you want to run the cron the job to know the successful cron job email notification.

Pass the template name, subject of the email notification, email body, and set the type as Success to update the template. Once the cron job is successfully run then you will receive the email notifications.

How to establish the connection for a listed program

As you user, you can establish the connection to any listed program as you required. For example, establishing the connection for the Loyalty Program.

Navigation: Options > Data Sync > Loyalty Program

To establish the connection hit the Add New tab and select the ESP option.

The purpose of each section is explained in detail.

Sync Details

  • Choose Cron Server: They are multiple servers in cron execution. So Choose any one Cron Server 1 for the Loyalty module and Cron Server 2 for the rest of the modules.
  • Data Sync Name: Name of the configuration.
  • Connection: Select a platform /ESP to create the sync with. This platform is reflected from under Connectivity Settings.
  • List Name: According to the connection selected, the client ESP sends the list. Some ESPs may not have a list concept so for them, List fields will be hidden.
  • Use Delta Dataset: Here you can run the cron jobs from starting to till date then set the toggle button ON. If you need the latest information then set the toggle button OFF.
  • Sync Enabled: Sync is ON means it is active. Sync is OFF meant inactive

Click on the Save and Select Next tab to continue to the next section Email Notification.

Email Notification

The email notification section helps you to set up the email notification with the list of receivers to know the status of the cron jobs.

  • Enable Email Notification: Set the toggle ON to enable the Email Notifications.
  • Email From Name: Get the email notification from the Annex Cloud or Client name.
  • Notification From Email: Get the email notification from the Annex Cloud or Client email address. We can add multiple email notifications.
  • Notification Email List: Receiver Email id. Can be multiple
  • Notification For Success: If you select the success notification for the successful cron jobs you will get notifications.
  • Notification For Failure: If you select the Failure notification, for the failure cron jobs you will get notifications.

The template comes from Email Template settings, Subject and Message are not editable here.

Click on the Save and Select Next tab to continue to the next section Scheduler.

Scheduler

Cron is a task scheduler that executes tasks at regular intervals. Cron jobs are a type of task that is used to automate system maintenance and administration.

You can able to set the cron tasks to run every minute, hour, day of the month, month, weekday, or any combination of these frequencies.

Field Mapping

If you want to push any specific fields from any module here you can use Field Mapping functionality.

Click on Add Field configuration button to pull the specific fields from required modules.

Field Type, From Property, and To Property fields are common fields. These fields may change module-wise.

  • Field Type: Choose between Static and Dynamic data.
  • From Property: Select the list of the properties from Annex Cloud which are shown in the drop-down list.
  • To Property: ESP Platform field is nothing but a To Property.

Click on the Save button to complete the Field Mapping configuration, and the Finish button to complete the task.