Message Formats (X Dispatch 21.0)

Owned by Michelle Cabaya
Last updated: Aug 15, 2023
4 min read

For X Dispatch 21.0. 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 Maintenance > Message Formats.

 

How to Add a New Message Format

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

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.


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. 

     

How to Edit a Message Format

  1. Go to Maintenance > Message Formats.

  2. Click the message format you would like to edit or right-click the row and select Edit. 

    The right-click menu option Open in New Window will open the edit form in a window that can be moved around.

How to Delete a Message Format

  1. Go to Maintenance > Message Format. 

  2. Click the message you would like to delete. 

  3. Click the  button. 

Alternate steps:

  1. Go to Maintenance > Message Format. 

  2. Right-click the message format you would like to delete and select Delete.


Section Functions 

Customize Grid Layout 

You can customize which columns you would like to view and arrange the order by clicking the Edit Grid Layout icon . 

Change View

Requires X Dispatch 19.1 or newer.

You can switch between a table view and a card view by clicking on the Card View icon  or Table View icon .

Zooming Settings

Requires X Dispatch 21.0 or newer.

You can zoom in or out of Next Dispatch pages in X Dispatch by right clicking on the page (other than on a card or table) and selecting Zoom In or Zoom Out, or use the Ctrl + or Ctrl - keys. 

Select

Use the checkbox at the beginning of each row, or at the top of each card, to select multiple records. 

Quick Tip

No more than 2 windows can be open or edited at a time. 

Right Click Menu

Right click on a row or card to view right click menu options.


Message Format Form

General

Field NameDescription
IDUnique numeric ID for the message format.
DescriptionName that describes the message format.
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.
Delay MessageThe number of seconds to delay the message.

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. Alternatively, you can place your cursor where you'd like the Available Field added in the Message Format section then double-click the Available Field to bring it over. Available Fields available vary based on the Message Type in the General tab. For "Customer On Demand" and "Customer Route" message types, you can preview your message after setting up the Message Format. 

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.

  • You can add Rapidship track order or attachment links to the Message Format section. 
  • In X Dispatch 21.0.4 or newer you can add at least 100,000 characters. 

 

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. For "Customer On Demand" and "Customer Route" message types, you can preview your message. 

Execute Custom SQL

Check the Execute SQL Statement checkbox and then click the . Use the Query Builder to create a query using the Available Fields, SQL Syntax, Tables/Views, and Table/View Columns. 

Use Report Format

Select the Report Format you would like to use.


How to Preview Message Formats 

You can preview the message format without having to send a test email for "Customer On Demand" and "Customer Route" message types. This works for previewing messages with standard Available Fields and Text as well as HTML and SQL Statements. 

  1. Go to the Format or Advanced tab.

  2. Enter the order ID or stop ID in the Preview section. 

  3. Click Display.


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.