Message Formats (Classic Operations App)

Operations App is continuously updating and page layouts may differ. See here for other versions. 

Message formats are used when sending email messages to customers and email, text, or X Mobile messages to drivers. 

To access message formats go to MaintenanceMessage Formats.

How to Add a New Message Format

  1. Go to Maintenance > Message Formats.
  2. Click the New button in the toolbar.

Alternate steps:

  1. Click the arrow next to the New button, or press the Alt + N keys.
  2. Click Message Format, or press the M key.

Back to top.

How to Copy a Message Format

  1. Go to Maintenance > Message Formats.
  2. Right-click the message format you would like to copy.
  3. Select Copy

  4. 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:

  1. Go to Maintenance > Message Formats.
  2. Click the message format you would like to copy to select and highlight it blue.
  3. Press the Ctrl + C keys.
  4. Enter a new Format ID and click OK

Back to top.

How to Edit a Message Format

  1. Go to Maintenance > Message Formats.
  2. Double-click the message format you would like to edit.

Back to top.

How to Delete a Message Format

  1. Go to Maintenance Message Format.
  2. Double-click the message format you would like to delete.
  3. Click the Delete button at the bottom of the form.

Back to top.

Format Form

Field NameDescription
Format ID

Unique numeric ID for the message format.

Max value is 2,147,483,647. 

DescriptionName that describes the message format.

Back to top.

Message Format Form

General

  

Field NameDescription
Message Type

The message type of the format. 

Format dates asThe format that the date will display on the message.
Return Email NameThe 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 AddressThe email address that will be copied on the message.
Message SubjectThe subject of the message. The default value is "[OrderID]".
Maximum lengthThe maximum length of the message that is created from this format.
Maximum LengthThe maximum length of the message that is created from this format.
Sequence FieldsVisible 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.

  • X Mobile - Message through the X Mobile app.
  • Two-way Text Messaging (Legacy) - Text message to the driver's phone.
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 MessageThe number of seconds to delay the message.

Back to top.

Format

The Format tab allows you to set up the message to be sent. Use Available Fields to add auto-populated information to the message by clicking on the one you want to use and dragging it to the Message Format section. Available Fields available vary based on the Message Type in the General tab.

Quick Tips

  • Available Fields can be restricted to a certain number of characters. 

    Example

    [5POD] would return 5 characters to the POD value instead of the full POD.  If a POD of 123456789 were entered in it would return the first 5 as 12345.

  • Localized times for Available Fields
    • Server times: Invoiced, PickUpTimeFrom, DeliveryTimeFrom, Canceled 
    • Origin times: ReadyTimeFrom, ReadyTimeTo, PickedUp, AtOrigin, Confirmed, Dispatched, Ordered, Transmitted, ReceivedAtDock, UpdatedWhen, PickupETA
    • Destination times: DueTimeTo, DueTimeFrom, AtDestination, Delivered, DeliverETA
  • You can add Rapidship track order or attachment links to the Message Format section. See Client Portal Punch-Through URL.
  • In X Dispatch 21.0.4 or newer you can add at least 100,000 characters. 
  • In X Dispatch 22.1 or newer you can add flight information from an order using the Available Fields

  

Back to top.

Advanced

The Advanced tab allows you to execute a custom SQL statement when the message format is triggered and/or use a report format for the message format. 

  

Execute Custom SQL

Check the Execute SQL Statement checkbox and enter the SQL you would like to execute in the text are below.

Use Report Format

Select the Report Format you would like to use.

  

Back to top.

X Mobile Settings

The X Mobile Settings tab is visible when Message Type is set to "Driver". The X Mobile Settings tab allows you to select which actions are available in X Mobile when using the message format.

Back to top.

Message Formats in X Dispatch 

Customers

Select message formats to send your customers in the Alerts section in the Contact tab of the customer record. See Customers - New/Edit Customer.

  

Drivers

Select the message format sent to the driver in the driver record. See Drivers (Classic Operations App).

 

Human Resources

Select the message format to send the human resource in the Settlements tab of the human resource record. See Human Resources - New / Edit Human Resource.

Back to top.

CXTU Courses/Lessons
  • On-Boarding Training: Customer Notifications