Support : Implementation Guide
Alert Builder
Alert Builder

CoreTRM allows each tenant to create alerts based on the data available in system. The alerts can be sent by schedule or by approvals. The alert is sent via email and has a default sender email address of alerts@coretrm.com.

CoreTRM comes a set of default Approvals and Operations Alerts. Depending on client requirement, some of the existing alerts can be activated. Customised alerts can also be created using Alert Builder.

To access Alert Builder go to System Admin and then to the Alert Builder tab.

Creating an alert

For example, creating an alert for LC issuance deadline. The alert will trigger if the LC issuance due date is less than 7 days from today. The alert will provide the following information:

Contract Reference, Seller Name, Buyer name, Incoterms, Location, Commodity, Quantity, Unit, Credit Terms and LC Due Date.

Implementation Alert Builder Alerts

To create a new alert:

  1. Navigate to System Admin then Alert Builder.
  2. From the Alerts View, click on Panel New Button to create a new line.
  3. In Alert id, enter the name of the Alert. Typically, it can be used to describe what is the alert do. In our example, 7 Days from Today - LC issuance deadline.
  4. In Object Name, select the object from where the alert should retrieve the data. In our example, Transactions object will be used since transactions object has a calculated LC issuance Due Date(credittermduedate).
  5. In By Approvals?, tick the box if the alert is triggered when a change of approvalstatus happen.
  6. In By Schedule?, tick the box if the alert is triggered on a schedule basis. In our example, we will tick this box.
  7. In Delivery Type, email is the only option available currently.
  8. In Delivery Format, email is the only option available currently.
  9. In Email Addresses(;), enter the email address of users who will be receiving this alert.
  10. In Active?, tick this box to set the alert active.
  11. In Payload Item Refs, select the Item ref to be included in the email body. In our example, Contract Reference, Seller Name, Buyer name, Incoterms, Location, Commodity, Quantity, Unit, Credit Terms and LC Due Date will be included in the email body.
  12. In Email Subject, enter the email subject. This will appear in the email subject when the user received the alert email. In our example, LC issuance deadline - 7 Days from Today.
  13. In Email Formatting Culture, select the email formatting culture. This mainly affect date display.
  14. In Alert Description, enter any applicable alert description.
  15. In Webhook Num, unique number for this alert. This is generated after the alert is saved.
  16. Then, click on Save Button to confirm the creation.
  17. To edit alert details after creation, Click Edit Button to edit.

After the alert is created with the payload item ref required, we can now setup the criteria from which the system will select the data to be sent out. This can be set in the "Filters" tab.

To create a new alert, in Filters tab:

  1. From the Filters tab, click on Panel New Button to create a new line.
  2. In Order, indicate the order number of the filter criteria.
  3. In And Or, if there is more than 1 filter criteria, "And" or "Or" can be used to indicate the filter crieria relationship.
  4. In Left Brackets, left brackets can be included if two or more criteria is group together to form a filter criteria.
  5. For Example, brackets can be used to indicate more than one criteria form part of one criteria.

    Implementation Alert Builder Example Brackets

  6. In Left Item Ref., select the Left Item Ref to be used for this filter criteria.
  7. In Condition, select the condition to be used for this filter criteria.
  8. *Conditions available are "contains", "equals", "greater than", "greater than or equal to", "in", "less than", "less than or equal to", "not contains", "not equals" and "not in".

  9. In Right Item Ref., select the Right Item Ref if the condition is comparing with another Item Ref value. Either Right Item Ref. or Right Value is to be used.
  10. In Right Value, enter a Right Value if the condition is to compare with a fixed value. Either Right Item Ref. or Right Value is to be used.
  11. In Right Brackets, right brackets can be included if two or more criteria is group together to form a filter criteria..
  12. In Grouping Filters?, check the box if the filter criteria is involved a function that required group. Example of functions: fnSum, fnMax, fnMin, etc. Grouping filter works similar to the SQL Having clauses.
  13. *Example of Grouping Filters can be found here.*

  14. In Active?, check the box if this line of filter criteria is to be active.
  15. Click Save Button to confirm creation.
  16. To edit filter details after creation, Click Edit Button to edit.
  17. In our example, since we are sending out alerts for LC Issuance Due date 7 days from Today, we will use the following criteria:
  18. 100. Commodity type group equal to physical. In our example, we are only looking at Physical Trade.

    200. Commodity type group number not equal to 8. This will exclude Derivatives trade from the selection.

    300. A credit instrustment is selected.

    400. The LC Issuance Due Date is less than Today plus 7 days.

    500. Inventory indicator is False. To exclude any Inventory Trade.

    600. Quantity of the trade is not equal to zero.

    Implementation Alert Builder Alerts Filters

After filter criteria are setup, we can also rename and format each Item Ref that appear in the email alert. This can be done in "Item Overrides" tab.

To create a new alert, in Item Overrides tab:

  1. From the Item Overrides tab, click on Panel New Button to create a new line.
  2. In Item Reference, select the Item Refs that you wish to make a name change, set the decimal places or date format. The Item References use here should be of same name as those that are used in the "Payload Item Refs" in Alerts view.
  3. In Display Name, enter the name to display for this Item Ref in the email if applicable.
  4. In Decimal Places, enter the number of decimal places to display for this Item Ref in the email if applicable.
  5. In Date Format, .select the date format to display for this Item Ref in the email if applicable
  6. Click Save Button to confirm creation.
  7. To edit item overrides details after creation, Click Edit Button to edit.
  8. In our example, we can rename all the item ref and for credittermduedate, we can set to Date Format: Date. For quantity, we can set to 3 decimal places.
  9. Implementation Alert Builder Alerts Item Overrides

Below is an example of how the email is shown:

Implementation Alert Builder Alerts Email

After an alert is setup, we will need to setup a schedule task function that will trigger the email from the system.

This is done using the Schedule Task Function in the system. To access Schedule Task go to System Admin -> System Admin -> Schedule Task Tab.

*Note that access to this view maybe be restricted. Contact CoreTRM support if access is required.*

Implementation Alert Builder Alerts Schedule Task

To create a new schedule task, in schedule task view:

  1. Click on Panel New Button to create a new line.
  2. In Task Description, enter a description for the task.
  3. In Max(Last Run at DateTime), this shows the last run date time.
  4. In Run on Monday, tick this box if the schedule task is to be run on this day.
  5. In Run on Tuesday, tick this box if the schedule task is to be run on this day..
  6. In Run on Wednesday, tick this box if the schedule task is to be run on this day..
  7. In Run on Thursday, tick this box if the schedule task is to be run on this day..
  8. In Run on Friday, tick this box if the schedule task is to be run on this day..
  9. In Run on Saturday, tick this box if the schedule task is to be run on this day..
  10. In Run on Sunday, tick this box if the schedule task is to be run on this day..
  11. In Run at Time Hour, enter the time (Hour) of the day to run the schedule task. The time used is based on UTC Server Time.
  12. In Run at Time Minutes, enter the time (Minutes) of the day to run the schedule task.The time used is based on UTC Server Time.
  13. In Repeat Period, enter the repeat period if applicable.
  14. In Repeat Period Type, select the repeat period type if applicable.
  15. In Run as User Name, select the user name to use to run the schedule task. Typically, it will be schedule.
  16. In Active?, .tick this box if this schedule task is active.
  17. Click Save Button to confirm creation.
  18. To edit schedule task details after creation, Click Edit Button to edit.

In the example above, the schedule task is set to run everyday from Monday to Friday at 01:50am UTC time. For testing, you can select the select task and click on Run Now Button to trigger the schedule task immediately.

After an alert detais are setup, we will need to setup a schedule task function that will trigger the email from the system.

Implementation Alert Builder Alerts Schedule Task Step

To create a new task steps, in task step tab:

  1. Click on Panel New Button to create a new line.
  2. In Task Step Order Num, enter step order number for the task step.
  3. In Task Step Description, enter a description for the task step.
  4. In Method Id, enter the Method Id for the task step. In our example, to trigger the schedule task, method id is "ScheduledWebhooks".
  5. In Method Parameters, enter parameter for the method. In our example, we will only trigger alert "7 Days from Today - LC issuance deadline" for this schedule task. Therefore, we will use "filter=webhookseqnum.eq.5009".
  6. Alert's webhookseqnum can be found in Alerts that is created in the Alerts view.

  7. In Active Indicator, tick this box if this task step is active..
  8. Click Save Button to confirm creation.
  9. To edit task steps details after creation, Click Edit Button to edit.

To check that the schedule task is run and completed, click on the "Task History" tab of the schedule task.

Implementation Alert Builder Alerts Schedule Task History

Back to top
Need More Assistance?

Please get in touch.

Chat with

CoreTRM