Message Formats (Classic Operations App)
This page is for the Classic Operations App. For the Operations App please see Message Formats.
- 1 How to Add a New Message Format
- 2 How to Copy a Message Format
- 3 How to Edit a Message Format
- 4 How to Delete a Message Format
- 5 Format Form
- 6 Message Format Form
- 6.1 General
- 6.2 Format
- 6.3 Advanced
- 6.3.1 Execute Custom SQL
- 6.3.2 Use Report Format
- 6.4 X Mobile Settings
- 7 Message Formats in the Operations App
- 7.1 Customers
- 7.2 Drivers
- 7.3 Human Resources
Message formats are used when sending email messages to customers and email, or text messages to drivers.
To access message formats go to Maintenance > Message Formats.
How to Add a New Message Format
Go to Maintenance > Message Formats.
Click the New button in the toolbar.
Alternate steps:
Click the arrow next to the New button, or press the Alt + N keys.
Click Message Format, or press the M key.
How to Copy a Message Format
Go to Maintenance > Message Formats.
Right-click the message format you would like to copy.
Select Copy.
Enter a new Format ID and click OK.
The message format will be created with the same Description as the message format you copied. Double click the message format you just created to edit and rename.
Alternate steps:
Go to Maintenance > Message Formats.
Click the message format you would like to copy to select and highlight it blue.
Press the Ctrl + C keys.
Enter a new Format ID and click OK.
How to Edit a Message Format
Go to Maintenance > Message Formats.
Double-click the message format you would like to edit.
How to Delete a Message Format
Go to Maintenance > Message Format.
Double-click the message format you would like to delete.
Click the Delete button at the bottom of the form.
Format Form
Field Name | Description |
|---|---|
Format ID | Unique numeric ID for the message format. Max value is 2,147,483,647. |
Description | Name that describes the message format. |
Message Format Form
General
Field Name | Description |
|---|---|
Message Type | The message type of the format.
|
Format dates as | The format that the date will display on the message. |
Return Email Name | The name associated with the Return Email Address. The default value is "[OrderID]". |
Return Email Address | The email address that a reply to the message will go to. This field is required for the message format to work without errors. |
CC Email Address | The email address that will be copied on the message. |
Message Subject | The subject of the message. The default value is "[OrderID]". |
Maximum length | The maximum length of the message that is created from this format. |
Maximum Length | The maximum length of the message that is created from this format. |
Sequence Fields | Visible when Message Type is set to "Driver" and enabled when Message Subsystem is set to "X Mobile". |
Message Subsystem | Visible when Message Type is set to "Driver". How the message will be delivered to the driver.
|
TCP Protocol | Visible when Message Type is set to "Driver". The TCP (Transmission Control Protocol) the message format will use. It will be either SMTP or SNPP. SNPP is the only option when Message Subsystem is set to "X Mobile". |
Server | Visible when Message Type is set to "Driver". The server the message format is using. |
Port | Visible when Message Type is set to "Driver". The port the message format is using. |
Delay Message | The number of seconds to delay the message. |