Use Business Rules to Automate Your Dispatching

In Helm CONNECT Jobs, business rules allow you to set up conditions that automatically trigger actions—such as events, jobs, and webhooks—when changes are made to your orders. This article describes how to set up the conditions for a business rule and how to set up the action that will be triggered when the conditions are met.

Use a Business Rule to Trigger an Event

A business rule can trigger events for surcharges and reporting. For example, you could create a late change event to trigger a surcharge if the trip start time is changed within four hours of the planned start time.

To set up a triggered event

1. Go to the Setup > Business Rules > Business Rules tab.
2. Click New Business Rules.
3. Use the Name field to give the new rule or rules a name.
4. Click in the Division field and select which division the rule or rules will apply to. The rules will apply to the selected division and any divisions below it on the division tree.
5. (Optional) Under Effective, enter a start or end date, or both.
6. Select the Triggered Event sub-tab.
7. To add the first condition, click Add Condition then click Select a field to display a list of options. Configure the condition as needed.
8. (Optional) To add another condition, repeat Step 7.
9. From the Event Type list, select the type of event that will be triggered.
10. (Optional) You have the option to pre-populate specific fields, such as Location or Description. Click Show all effects to see more fields.
11. Click Save Changes.

Use a Business Rule to Trigger a Job

A business rule can trigger jobs based on details such as a location or the size of the ship. For example, it could automatically create a job with a two-hour duration when a specific location within the port is added to the order.

To set up a triggered job

1. Go to the Setup > Business Rules > Business Rules tab.
2. Click New Business Rules.
3. Use the Name field to give the new rule or rules a name.
4. Click in the Division field and select which division the rule or rules will apply to. The rules will apply to the selected division and any divisions below it on the division tree.
5. (Optional) Under Effective, enter a start or end date, or both.
6. Select the Triggered Job sub-tab.
7. To add the first condition, click Add Condition then click Select a field to display a list of options. Configure the condition as needed.
8. (Optional) To add another condition, repeat Step 7.
9. From the Resource Type list, select the type of resource to be used on the triggered job.
10. (Optional) You have the option to pre-populate specific fields for the job, such as Planned Start Date or Planned End Date. Click Show all effects to see more fields.
11. (Optional) To add another resource to the job, click Add Resource then repeat steps 9 and 10.
12. Click Save Changes.

Use a Business Rule to Trigger a Webhook

A business rule can trigger webhooks to send notifications to external applications, such as Mailgun, Slack, or Twilio. For example, you could use Mailgun to send an email to a tug when it's been assigned to a job.

To set up a webhook

1. Go to the Setup > Business Rules > Business Rules tab.
2. Click New Business Rules.
3. Use the Name field to give the new rule or rules a name.
4. Click in the Division field and select which division the rule or rules will apply to. The rules will apply to the selected division and any divisions below it on the division tree.
5. (Optional) Under Effective, enter a start or end date, or both.
6. Select the Webhook sub-tab.
7. To add the first condition, click Add Condition then click Select a field to display a list of options. Configure the condition as needed.
8. (Optional) To add another condition, repeat Step 7.
9. (Optional) Use the Action Date field to schedule when the webhook will be sent, based on a time related to a trip or a job. For example, to send the webhook two hours before the scheduled start time of a job, enter DateAdd(jobStart, -120) in the Action Date field then select Original Job: Job Start Date from the Formula Values list.
10. Click Add Callback then complete the following fields:
    • Description: This field is optional; it simply allows you to add a name to the callback so you can identify it later.
    • URL: This is where the callback will be sent.
    • Content Type: Choose raw or x-www-form-urlencoded, depending on the requirements of the external application.
11. To add a JSON payload to the callback, click Add Format then complete the following fields:
    • Key
    • Value
12. (Optional) To add another payload to the callback, repeat Step 11.
13. (Optional) To add another callback, repeat Step 10.
14. Click Save Changes.

Case Study

Learn how Portugs uses business rules to send webhooks from Helm CONNECT to Mailgun. By configuring business rules to send order confirmation emails automatically once jobs are scheduled, Portugs has reduced errors, improved communication with their agents, and maximized their billing revenue.

We're Here to Help

Contact our team today to learn more about using business rules to automate your dispatching—we’d love to help!