Designing notification e-mail templates

Using a template lets you use the same format for each notification e-mail, rather than formatting them each time. You can create and modify preformatted templates for the event notification e-mails.

Specifying the application’s root address

First available in: Trimble Web Products 2017.2

When you design notification e-mail templates for eStat or CarrierHub, you can add a hyperlink that allows the user to view additional details about the event. When users click on this hyperlink, a new browser window or tab opens and the system redirects the user to the Event Details page. The system uses the value in the [$RootAddress$] data field to identify the base URL or web address for your company’s Trimble Web Products.

Before you add this data field to your templates, you must first define your application’s base (root) address. The default value is http://localhost/TmwWebProducts/.

To specify the application’s root address:

  1. Go to Menu > Configuration > Settings Manager.
    The Settings Manager page opens.

  2. Do one of the following:

    • If you want the setting change to apply to all roles, verify the Role field is set to [Global Settings].

    • If you want the setting change to apply to a specific role, select it in the Role field.
      A message asks you to verify that you want to change the role. Click OK to continue.

      Note: If the setting has already been changed for at least one role, its text label is bold and italic.

  3. On the Modules tab, in the Module Selection field, select Carrier or Customer.

  4. Click on the ModuleSettings tab.
    Details about the module settings are displayed.

  5. In the Application Root Address field, enter the base URL to your company’s Trimble Web Products.

    In this example, the bold part is the root address:
    http://may-doc-app01/WPFuel/estat/CustomerEmailTemplates.aspx

  6. Click Save.

Designing notification e-mail templates for eStat

To create and modify preformatted templates for the event notification e-mails for eStat, follow these steps.

  1. Go to Menu > Configuration > Customer Configuration > Customer Email Templates.
    The Customer Email Templates page opens.

    image19

  2. In the Events list, select the event for which the template will be used.

    Note: The listed items are the events that appear in the Menu > Configuration > Customer Configuration > Event Definitions > Define Events page. For existing templates, the formatting appears in the Subject field and text box.

  3. In the text box, use the inline editing tools to write and format the text.

    • Select the Design mode (default) and use the inline editing tools to write and format the text.

    • Select the HTML mode and enter the text using the appropriate HTML tags.

    • Write and format the article in another editor, and then copy and paste the text into the text box.

    See below for the e-mail data objects.

  4. To save the template, click Save.
    A message indicates that the template has been successfully updated.

  5. To test the template, click image20 E-mail.

  6. Complete the E-mail Test Parameters fields:

    Test e-mail field definitions
    Field Definition

    To Address

    Enter the e-mail address where the test e-mail will be sent

    Leg Number

    Unique, system-assigned trip segment ID number

    Stop Number

    Enter the stop number

    Order Number

    Enter the order number

  7. Click Send Email.
    The e-mail message is sent to the designated e-mail address.

    In this example of a cancelled shipment tender, the [$OrderNumber$] variable represents the order number. The [$FirstName$] variable represents the preparer’s first name and the [$LastName$] variable represents the preparer’s last name.

    image21

eStat e-mail data objects

Order Data field definitions

Field Definition

[$Accessorial$]

Total accessorial charges on the order

[$BillTo$]

Bill-To company ID

[$Miles$]

Total mileage recorded for the order

[$OrderBy$]

Order By company ID

[$OrderHeaderNumber$]

Unique system order header ID number for the load

[$OrderNumber$]

Unique system order ID number for the load

[$ReferenceNumber$]

Order reference number

[$Remarks$]

Order remarks

[$RevType1$]

RevType1 classification for the order

[$RevType2$]

RevType2 classification for the order

[$RevType3$]

RevType3 classification for the order

[$RevType4$]

RevType4 classification for the order

[$TotalCharge$]

Total charges for the order

[$TotalPieces$]

Actual number of units of the commodity being shipped

[$Trailer$]

ID of the lead trailer assigned to the trip segment

[$Trailer2$]

ID of the rear trailer assigned to the trip segment

[$TrailerType$]

TrlType1 classification for the trailer that is to be assigned to the order

[$Weight$]

Total weight recorded for the order

Leg Data field definitions

Field Definition

[$Carrier$]

System ID of the carrier assigned to the trip segment

[$CarrierName$]

Name of the carrier assigned to the trip segment

[$EDI204Date$]

The 204 date from the Lgh 204date column of the Planning Worksheet Available Trips grid

[$EDI204Status$]

The 204 status from the Lgh 204status column of the Planning Worksheet Available Trips grid

[$EndCity$]

Destination city for the load

[$EndCityState$]

City and state/province where the trip ends

[$EndCompanyName$]

Name of the destination company on the load

[$EndDate$]

Date on which the trip ends

[$EndState$]

State/province where the trip ends

[$LDMileage$]

Total loaded miles for the trip segment

[$LegNumber$]

Unique, system-assigned ID for the trip segment

[$LegStatus$]

Dispatch status for the trip segment

[$MTMileage$]

Total empty miles for the trip segment

[$PrimaryTrailer$]

ID of the lead trailer assigned to the trip segment

[$PrimaryTrailerPUP$]

ID of the rear trailer assigned to the trip segment

[$StartCity$]

Origin city

[$StartCityState$]

Origin city and state/province

[$StartCompanyName$]

Name of the origin company

[$StartDate$]

Date the trip starts

[$StartState$]

Origin state/province

Stop Data field definitions

Field Definition

[$Consignee$]

Consignee company ID

[$ConsigneeName$]

Consignee company name

[$ConsigneeStopNumber$]

Consignee stop number

[$EventCode$]

Event code

[$Shipper$]

Shipper company ID

[$ShipperName$]

Shipper company name

[$ShipperStopNumber$]

Shipper stop number

[$StopNumber$]

Unique, system-assigned ID number for the stop

[$StpAddress1$]

First line of the stop address

[$StpAddress2$]

Second line of the stop address

[$StpArrivalDate$]

Date and time the load arrived at the scheduled stop

[$StpComment$]

Comments about the scheduled stop

[$StpCompanyCity$]

City where the stop company is located

[$StpCompanyCityState$]

Stop city and state/province

[$StpCompanyName$]

Name of the company where the scheduled stop occurs

[$StpCompanyState$]

State/province where the stop company is located

[$StpCompanyZip$]

Stop company’s ZIP Code/postal code

[$StpContact$]

Contact at the stop company

[$StpDepartureDate$]

Date and time the load departed the scheduled stop

[$StpEarliestDate$]

Earliest stop arrival date

[$StpLatestDate$]

Latest stop departure date

[$StpMileage$]

Total mileage for the stop

[$StpPhone$]

Primary area code and phone number for the stop contact

[$StpPhone2$]

Additional area code and phone number for the stop contact

eStat field definitions

Field Definition

[$EndCityState$]

Destination city and state/province

[$EndDate$]

Date on which the trip ends

[$FirstName$]

First name of the person who prepared, accepted, entered, or refused the load.

[$LastName$]

Last name of the person who prepared, accepted, entered, or refused the load.

[$LDMileage$]

Number of loaded miles in the trip

[$OrderNumber$]

Unique, system-assigned order ID number for the trip

[$StartCityState$]

Origin city and state/province for the load

[$StartDate$]

Date the tractor will depart

Note: For multiple stops, create additional lines for [$StopNumber$], [$StpArrivalDate$], [$StpCompanyName$], and [$StpDepartureDate$].

Profile field definitions

Field Definition

[$FirstName$]

First name of the person who prepared the rate quote request

[$LastName$]

Last name of the person who prepared the rate quote request

[$Company$]

Company making the rate quote request

Origin:

[$OriginCustomer$]

Customer name associated with the load’s origin

[$OriginCityState$]

City and state location of the load’s origin

[$OriginZip$]

ZIP Code/postal code for city and state location of the load’s origin

Destination:

[$DestCustomer$]

Customer name associated with the load’s destination

[$DestCityState$]

City and state location of the load’s destination

[$DestZip$]

ZIP Code/postal code for city and state location of the load’s destination

Additional Details:

[$PickUpDate$]

Pickup date for the load

[$TotalStops$]

Total number of stops required for the load’s shipment

[$LoadValue$]

Load’s dollar value

[$Commodity$]

Information about the freight types included in the load

Use the [($$$$StopFreight$$$$)] tag to include multiple freight types in the e-mail. For example, to include the commodity code and description for two freight types you would add the following code to the e-mail template:

[($$$$StopFreight$$$$)]
Commodity: [($CmdCode$)] [($CmdDescription$)]
[/($$$$StopFreight$$$$)]

[($$$$StopFreight$$$$)]
Commodity: [($CmdCode$)] [($CmdDescription$)]
[/($$$$StopFreight$$$$)]

You can use any of these variables between the [($$$$StopFreight$$$$)] and [/($$$$StopFreight$$$$)] tags:

  • [$AccountOf$]

  • [$CmdCode$]

  • [$CmdDescription$]

  • [$cmdRefNumber$]

  • [$cmdRefNumberType$]

  • [$Height$]

  • [$HeightUnit$]

  • [$Length$]

  • [$LengthUnit$]

  • [$NetVolume$]

  • [$Quantity$]

  • [$QuantityUnit$]

  • [$Stackable$]

  • [$Supplier$]

  • [$Volume$]

  • [$VolumeUnit$]

  • [$Weight$]

  • [$WeightUnit$]

  • [$Width$]

  • [$WidthUnit$]

[$HazmatClass$]

Hazardous material class

[$Packaging$]

Hazardous material packaging

[$UNCode$]

Hazardous material UN code

[$Weight$]

Weight of the load

[$Quantity$]

Number of pieces in the load

[$RootAddress$]

The base URL to your company’s Trimble Web Products

Designing notification e-mail templates for CarrierHub

To create and modify preformatted templates for the event notification e-mails for CarrierHub, follow these steps.

  1. Go to Menu > Configuration > Carrier Configuration > Carrier Email Templates.
    The Event Email Templates page opens.

    Show me

    image22

  2. In the Events list, select the event for which the template will be used.

    Note: The listed items are the events that appear in the Menu > Configuration > Carrier Configuration > Define Events page. For existing templates, the formatting appears in the Subject field and text box.

  3. In the text box, use the inline editing tools to write and format the text.

    • Select the Design mode (default) and use the inline editing tools to write and format the text.

    • Select the HTML mode and enter the text using the appropriate HTML tags.

    • Write and format the article in another editor, and then copy and paste the text into the text box.

    See below for the data objects.

  4. To save the template, click Save.
    A message indicates that the template has been successfully updated.

  5. To test the template, click Email Test.

  6. Complete the E-mail Test Parameters fields.

    Field definitions
    Field Definition

    To Address

    Enter the e-mail address where the test e-mail will be sent

    Leg Number

    Unique, system-assigned trip segment ID number

    Stop Number

    Enter the stop number

    Order Number

    Enter the order number

    In this example, the [$LabelRequestLoadQ1$] variable represents the Company Name field label and [$RequestLoadQ1$] the actual company name entered by the carrier in the Load Request Details page.

    [$LabelRequestLoadQ2$] through [$LabelRequestLoadQ5$] are represented by the City/ST, Contact Name, Contact E-mail, and Contact Phone field labels.

    image26

CarrierHub e-mail data objects

Field definitions

Field Definition

[$CH_CarrierName$]

Name of the carrier

[$CH_FirstName$]

First name of the person who is the contact for the carrier

[$CH_LastName$]

Last name of the person who is the contact for the carrier

[$CH_CarrierID$]

System ID of the carrier assigned to the load

[$CH_EmailAddress$]

E-mail address of the user

[$CH_TMWSuiteID$]

TMWSuite ID associated with the user’s profile

[$CH_UserName$]

User’s ID

[$ConsigneeAddress1$]

First line of the consignee address

[$ConsigneeAddress2$]

Second line of the consignee address

[$ConsigneeCity$]

City where the consignee is located

[$ConsigneeID$]

System ID of the consignee company

[$ConsigneeName$]

Name of the consignee company

[$ConsigneeState$]

State/province where the consignee is located

[$ConsigneeZip$]

ZIP Code/postal code for the consignee address

[$EndCityState$]

City and state/province where the trip ends

[$EndDate$]

Date on which the trip ends

[$FirstLoadedStopAddress1$]

First line of the address for the first stop on the trip segment

[$FirstLoadedStopAddress2$]

Second line of the address for the first stop on the trip segment

[$FirstLoadedStopCity$]

City where the first stop is located

[$FirstLoadedStopID$]

System ID of the company at which the first stop on the trip segment occurs

[$FirstLoadedStopName$]

Name of the company where the first stop occurs

[$FirstLoadedStopState$]

State/province where the first stop is located

[$FirstLoadedStopZip$]

ZIP Code/postal code for the first stop address

[$LastLoadedStopAddress1$]

First line of the address for the last stop

[$LastLoadedStopAddress2$]

Second line of the address for the last stop

[$LastLoadedStopCity$]

City where the last stop is located

[$LastLoadedStopID$]

System ID of the company at which the last stop on the trip segment occurs

[$LastLoadedStopName$]

Name of the company where the last stop occurs

[$LastLoadedStopState$]

State/province where the last stop is located

[$LastLoadedStopZip$]

ZIP Code/postal code for the last stop address

[$LDMileage$]

Total loaded miles

[$LegNumber$]

Unique, system-assigned ID for the trip segment

[$ShipperAddress1$]

First line of the shipper address

[$ShipperAddress2$]

Second line of the shipper address

[$ShipperCity$]

City where the shipper is located

[$ShipperID$]

System ID of the shipper company

[$ShipperName$]

Name of the shipper company

[$ShipperState$]

State/province where the shipper is located

[$ShipperZip$]

ZIP Code/postal code for the shipper address

[$StartCityState$]

Origin city and state/province

[$StartDate$]

Date the trip starts

[$StopNumber$]

Unique, system-assigned ID number for the scheduled stop

[$StopsCount$]

Total number of stops

[$StpArrivalDate$]

Date of arrival at the scheduled stop

[$StpCompanyName$]

Name of the company where the scheduled stop occurs

[$StpDepartureDate$]

Date of departure from the scheduled stop

User-specified variables

These customizable variables appear in the Load Request Details section on the Available Loads page, when a carrier submits a request for a load. Using the Customize Page Fields page, you can modify them to meet your company’s needs.

These variables are also used in the load request notification e-mail.

image23

Field Definition

[$LabelRequestLoadQ1$]-[$LabelRequestLoadQ5$]

Customized questions for the Available Loads notification
e-mails.

  1. From your user menu, go to Customize.

  2. In the Customizer, select a Role.

  3. From the Choose a Control list, select Question1Label (AxnComboBox).

    image

  4. For the Text property, select the check box in the Customize? column.

    image

  5. In the Value column, enter the new field name; i.e., Company Name.

  6. Repeat Steps b and c for Question2Label through Question5Label, as needed.

[$RequestLoadQ1$]- [$RequestLoadQ5$]

When a carrier submits a request for a load, the text for these fields is pulled from the Load Request Details section of the Available Loads page.

Order Data field definitions

Field Definition

[$Accessorial$]

Total accessorial charges on the order

[$CountUnit$]

Count unit of measure

[$Miles$]

Total mileage recorded for the order

[$OrderHeaderNumber$]

Unique system order header ID number for the load

[$OrderNumber$]

Unique system order ID number for the load

[$TotalCharge$]

Total charges for the order

[$TotalPieces$]

Actual number of units of the commodity being shipped

[$TrailerType$]

TrlType1 classification for the trailer that is to be assigned to the order

[$Weight$]

Total weight recorded for the order

[$WeightUnit$]

Weight unit of measure

Leg Data field definitions

Field Definition

[$Carrier$]

System ID of the carrier assigned to the trip segment

[$CarrierName$]

Name of the carrier assigned to the trip segment

[$EDI204Date$]

204 date from the Lgh 204date column of the Planning Worksheet Available Trips grid

[$EDI204Status$]

204 status from the Lgh 204status column of the Planning Worksheet Available Trips grid

[$EndCity$]

Destination city for the load

[$EndCityState$]

City and state/province where the trip ends

[$EndCompanyName$]

Name of the destination company on the load

[$EndDate$]

Date on which the trip ends

[$EndState$]

State/province where the trip ends

[$LDMileage$]

Total loaded miles for the trip segment

[$LegNumber$]

Unique, system-assigned ID for the trip segment

[$LegStatus$]

Dispatch status for the trip segment

[$MTMileage$]

Total empty miles for the trip segment

[$PrimaryTrailer$]

ID of the lead trailer assigned to the trip segment

[$PrimaryTrailerPUP$]

ID of the rear trailer assigned to the trip segment

[$StartState$]

Origin state/province

[$StartCity$]

Origin city

[$StartCityState$]

Origin city and state/province

[$StartCompanyName$]

Name of the origin company

[$StartDate$]

Date the trip starts

Stop Data field definitions

Field Definition

[$StopNumber$]

Unique, system-assigned ID number for the stop

[$StpAddress1$]

First line of the stop address

[$StpAddress2$]

Second line of the stop address

[$StpArrivalDate$]

Date and time the load arrived at the scheduled stop

[$StpComment$]

Comments about the scheduled stop

[$StpCompanyCity$]

City where the stop company is located

[$StpCompanyCityState$]

Stop city and state/province

[$StpCompanyName$]

Name of the company where the scheduled stop occurs

[$StpCompanyState$]

State/province where the stop company is located

[$StpCompanyZip$]

Stop company’s ZIP Code/postal code

[$StpContact$]

Contact at the stop company

[$StpDepartureDate$]

Date and time the load departed the scheduled stop

[$StpMileage$]

Total mileage for the stop

[$StpPhone$]

Primary area code and phone number for the stop contact

[$StpPhone2$]

Additional area code and phone number for the stop contact

Check Call Form Properties field definitions

Field Definition

[$CkCallCity$]

The name of the city where the driver/tractor was located when contact was made

[$CkCallComment$]

Additional information about the check call

[$CkCallDate$]

The date of the check call

[$CkCallLatitude$]

The latitude recorded for the city, state/province, and ZIP Code/postal code where the driver/tractor was located when contact was made

[$CkCallLongitude$]

The longitude recorded for the city, state/province, and ZIP Code/postal code where the driver/tractor was located when contact was made

[$CkCallState$]

The name of the state/province where the driver/tractor was located when contact was made

[$CkCallZip$]

The ZIP Code/postal code for the driver/tractor location when contact was made

Bid Award field definitions

Field Definition

[$Carrier$]

Name of the carrier bidding for the load

[$CarrierBid$]

Sum of the dollar amounts bid for line haul, fuel, and accessorials

[$CmdCode$]

Commodity code

[$Contact$]

Name of the person who placed the bid

[$ContactFax$]

Fax number for the bidding carrier

[$ContactPhone$]

Phone number for the bidding carrier

[$FuelAmount$]

Dollar amount that the carrier is bidding for the load’s fuel

[$LinehaulAmount$]

Dollar amount that the carrier is bidding for the load’s line haul pay

[$OrderNumber$]

Order number for the bid

[$OtherAmount$]

Dollar amount the carrier is bidding for the load’s accessorial charges

[$ReasonCode$]

If the carrier declines to bid for a load, the reason the carrier is not participating

[$ReplyMessage$]

Additional information about the carrier or bid

E-mail data objects

Field Definition

[$FirstName$]

First name of the person who prepared the rate quote request

[$LastName$]

Last name of the person who prepared the rate quote request

[$Company$]

The company making the rate quote request

Origin:

[$OriginCustomer$]

The customer name associated with the load’s origin

[$OriginCityState$]

The city and state location of the load’s origin

[$OriginZip$]

The ZIP Code/postal code for city and state location of the load’s origin

Destination:

[$DestCustomer$]

The customer name associated with the load’s destination

[$DestCityState$]

The city and state location of the load’s destination

[$DestZip$]

The ZIP Code/postal code for city and state location of the load’s destination

Additional Details:

[$PickUpDate$]

The pickup date for the load

[$TotalStops$]

The total number of stops required for the load’s shipment

[$LoadValue$]

The load’s dollar value

[$Commodity$]

Information about the freight types included in the load

[$Weight$]

The load’s weight

[$Quantity$]

The load’s number of pieces

[$RootAddress$]

The base URL to your company’s Trimble Web Products