Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

For X Dispatch 21.0. See here for other versions.

Anchor
top
top
Table of Contents
maxLevel3

...

  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

    Div

     

Back to top.


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

    Info

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

Back to top.


How to Delete a Message Format

...

  1. Go to Maintenance Message Format
  2. Right-click the message format you would like to delete and select Delete.

...

  1. .


Section Functions 

Insert excerpt
Next Dispatch Section Features
Next Dispatch Section Features
nopaneltrue

Back to top.


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. 

Note

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

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

    Div

    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. See Client Portal Punch-Through URL. 
  • In X Dispatch 21.0.4 or newer you can add at least 100,000 characters. 

 Image Modified

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

...

Select the Report Format you would like to use.

Back to top.


How to Preview Message Formats 

...

  1. Go to the Format or Advanced tab.
  2. Enter the order ID or stop ID in the Preview section. 

    Div


  3. Click Display.

Back to top.


Message Formats in X Dispatch

...

Select the message format sent to the driver in the driver record. See Drivers - New / Edit Driver.

Back to top.