Creating and saving a new view

There are two default dispatch views that are based on the system-defined SQL views: All Loads and All Inbound. They serve as templates for customized views. From these templates, you can create multiple dispatch views to meet the different needs of dispatchers or other users. Each view can contain its own restrictions and column displays. If necessary, review the General guidelines for creating and modifying views.

A SQL view is based on a SQL SELECT query that references one or more existing database tables. A SQL view does not store data like a database table, but determines what data is dynamically generated when the view is referenced. In effect, every view is a filter of the table data referenced in it, and this filter can restrict both the columns and the rows of the referenced database table.

  1. Do not modify the default All Loads and All Inbound views.

  2. Although you can create a new view from scratch, it is recommended that you copy the All Loads or All Inbound view, and then modify the copy to meet your needs.

To create a dispatch view based on one of the default views, follow these steps.

  1. Go to Maintenance > Maintain Planning Boards.
    The Maintain Planning Boards window opens.

    The window automatically shows the user groups in the User/Group tree. All Users is the default group that shows for all companies.

    image1

  2. In the window header, select Outbound/Loads or Inbound/Power.

    Note: The Historical view type is currently not functional.

  3. Select the view to copy.

    1. From the user tree, select the user or group that currently has access to the view you want to copy.

      • To specify a user, click image2 Expand next to a group name to expand the tree, and then select a user ID.

      • To specify a group, click the group name.

        Note: You cannot select the All Users group to copy a view.

    A list of dispatch views is shown in the grid.

    1. From the list of dispatch views, select the one you want to copy.

      image3

  4. Click Copy.
    The Create/Edit Board Definitions window opens.

    This sample shows the settings for the default Inbound Power view.

    image4

  5. In the Description field, enter a unique name for the new view.

    Note: This description is what the dispatcher will see when selecting a view.

    image5

  6. Verify the default SQL views are selected in the View Name drop-down list(s).

    The available view names include default SQL views supplied with the software, plus any other user-created SQL views.

    View type View Name field value Notes

    Outbound/Loads

    Order based views: PacePlanningTripsView

    Round trip hours views: PacePlanningTripViewRndTrpHrs

    The other view name fields do not apply to Outbound/Loads views.

    Inbound/Power

    Default views:

    • View Name: PacePlanningInboundView

    • Driver View Name: PacePlanningDriverView

    • Tractor View Name: PacePlanningTractorView

    • Trailer View Name: PacePlanningTrailerView

    • Carrier View Name: PacePlanningCarrierView

    The resource-specific views are seen in the Planning Worksheet and Card Planner sub tabs. For illustrations, see Working with dispatch views.

    Power (resource)-based Long Haul

    Default Inbound/Power views:

    • View Name: PacePlanningLongHaulDriverView or PacePlanningLongHaulCarrierView

    • Driver View Name: PacePlanningDriverView

    • Tractor View Name: PacePlanningTractorView

    • Trailer View Name: PacePlanningTrailerView

    • Carrier View Name: PacePlanningCarrierView

    • Quick Restricts: Select this checkbox if you want the Date restriction field to be available in the Card Planner and Planning Worksheet.

      This additional field is shown when you select PacePlanningLongHaulDriverView or PacePlanningLongHaulCarrierView in the View Name field.

    Driver-specific views are used in:

    • Card Planner, where you see multiple drivers and their trips at one glance.

    • Planning Worksheet, where you can focus on one driver at a time.

    For illustrations, see Working with dispatch views.

  7. If you want to make changes to the data grid columns, such as reordering or hiding columns, or changing the column heading, do the following:

    1. Next to the view you are changing, click Cols.
      The Select View Columns window opens.

      image6

    2. Edit any of the following:

      • Reorder the columns

        Enter a whole number corresponding to the desired position in the column’s Display column. Other column positions will be renumbered automatically.

      • Hide a column from displaying

        Clear the Visible Flag checkbox.

        Note: A hidden column can still be used as a filter in a view.

      • Change the name of a column heading

        In the OverrideName column, enter a new name or change the existing name that will display as the column heading on the data grid.

    3. When finished, close the Select View Columns window.

  8. On the Create/Edit Board Definitions window, click OK.
    The Board Definition window opens.

  9. In the Board Definition window header, identify any restrictions for the new view.

    Outbound/Loads view header

    image7

    Inbound/Power view header

    image8

    Definitions are listed in alphabetical order.

    Field Located in Definition

    Bill To

    Inbound, Outbound

    TMWSuite identification code assigned to the company that is to be billed for shipment of the fuel.

    To select multiple Bill To companies, hold CTRL down while selecting each company.

    Booked By

    Inbound, Outbound

    ID of the user who created the order.

    Carrier

    Inbound

    ID of a third party company that hauls loads.

    Description

    Inbound, Outbound

    The user-assigned name for the view.

    Dispatch Status

    Inbound, Outbound

    The statuses identify the current phase of the order’s life cycle.

    • AVL - Available
      The order is ready for dispatch.

      This status is automatically assigned to an order when it is first saved.

    • PLN - Planned
      A tentative assignment of resources has been made.

    • DSP - Dispatched
      A tentative assignment of resources has been made; the driver has been informed of this assignment.

    • STD - Started
      Resources have been assigned and the trip is in progress.

      This status is set automatically when you actualize the first stop on a trip.

    • CMP - Completed
      The order has been delivered. This status is set automatically when you actualize the last stop on a trip.

    Driver

    Inbound

    TMWSuite identification code for the driver.

    Hours Back

    Inbound, Outbound

    Used as a restriction when defining order-based views. This field sets the beginning timeframe for which trips are to be listed. It determines how far in the past the system will go back to search for available orders. The system subtracts the number of hours entered here from the current time. Only orders scheduled to start on or after the resulting date/time are listed.

    For example, suppose it is currently 10:00 AM on 1/15. If 48 is entered in this field, the system will list orders that were scheduled to start on or after 10:00 AM on 1/13.

    Note: A zero (0) in this field indicates that the list is not to be restricted according to trips' past start dates/times.

    Hours Out

    Inbound, Outbound

    Used as a restriction when defining order-based views. This field sets the ending timeframe for which orders are to be listed. It determines how far in the future the system will search for available orders.

    The system adds the number of hours entered here to the current time. Only orders scheduled to start on or before the resulting date/time are listed.

    For example, suppose it is currently 8:00 AM on 1/17. If 48 is entered in this field, the system will list orders that are scheduled to start on or before 8:00 AM on 1/19.

    Note: A zero (0) in this field indicates that the list is not to be restricted according to trip segments' future start dates/times.

    INSTATUS

    Inbound

    • DSP - Dispatched
      Tentative assignment of the tractor has been made; the driver has been informed of this assignment.

    • PLN - Planned
      Tentative assignment of the tractor has been made.

    • UNP - Unplanned
      Tractor has not been assigned to a future trip.

    Mileage (from/to)

    Outbound

    Distance from one location to another. Mileage can be measured from:

    • Stop to stop.

    • First stop to the last stop on a trip, excluding miles for interim stops.

    • First stop to the last stop on a trip, including miles for interim stops.

    TotalMailStatus

    Outbound

    Restricts the view to include orders having the selected TotalMail status.

    Note: Options are defined in the TotalMailStatus label, accessed in the System Administration application. All options are system codes and must not be changed. Do not add options, as they will not be recognized by TotalMail.

    Tractor

    Inbound

    ID assigned to the tractor

    TrlStatus

    Inbound

    Statuses that identify the trailer’s current activity level. Trip-related statuses are:

    • AVL - Available
      Trailer is not on an active trip, has not been assigned to any future trips, and does not have an active expiration.

    • PLN - Planned
      Trailer has been tentatively assigned to a trip.

    • DSP - Dispatched
      Tractor has been tentatively assigned to a trip; the driver has been informed of this assignment.

    • Use - In Use
      Trailer is assigned to a trip that is in progress.

    Statuses also may be used to identify expirations. A number of statuses come pre-loaded with the system; they are called system codes. Others are user-defined in the TrlStatus label, accessed in System Administration. Commonly used expiration-related statuses are:

    • OUT - Out of Service
      Trailer is disabled and should not be used on a trip.

    • VAC - In the Shop
      Trailer is undergoing maintenance and should not be dispatched on a trip.

  10. At the bottom of the Board Definition window, identify restriction fields as needed.

    Restrictions are organized into sections, which differ for Outbound/Loads views and Inbound/Power views.

    Notes:

    1. Each restriction section is marked by a blue title bar.

    2. If a section already contains restriction settings, the section expands automatically, and the number of set restrictions appears in parentheses after the section title.

    3. To open a section for editing, click image9 Expand next to the section title.

    4. To close a section, click image10 Collapse next to the section title.

    Definitions are listed in alphabetical order.

Outbound/Loads Board Definition restrictions
image11

Inbound/Power Board Definition restrictions
image12

Field Located in Definition

CarType1-4

Inbound

User-defined carrier categories to which the carrier is assigned.

Note: The field name and options are user-defined in the CarType1-4 labels, accessed in the System Administration application.

City

Inbound, Outbound

City where the company or stop is located.

COMPANY

Inbound

Commonly used to identify a subsidiary within your organization. The exact meaning is dependent on the type of record.

  • For a resource, an entry in this field identifies the company with which the resource is associated.

  • For an order, an entry in this field identifies the company that is responsible for completing the order.

Note: The field name and options for this field are set up by your company in the Company label, accessed in the System Administration application.

Company ID

Inbound, Outbound

TMWSuite identification code assigned to a company.

DIVISION

Inbound

Commonly used to identify the segment of your organization with which the resource is associated.

Note: The field name and options for this field are set up by your company in the Division label, accessed in the System Administration application.

DOMICILE

Inbound

Resource’s home location.

Note: The options for this field are set up by your company in the Domicile label, accessed in the System Administration application. The field name itself is hard-coded and cannot be changed.

DrvType1-4

Inbound

Driver classifications to which the driver has been assigned.

Note: The name and options for these fields are user-defined in the DrvType1 - 4 labels, accessed in the System Administration application. Assignment of drivers to driver classifications allows you to track the revenue collected for trips assigned to those drivers. In some cases, such classifications may also govern the pay rates used to determine driver settlements.

Fleet

Inbound

Fleet to which the resource is assigned.

Note: The Fleet options are user-defined in the Fleet label, accessed in the System Administration application.

LghType1-2

Inbound, Outbound

Categories to which trip segments are assigned for dispatch planning or pay purposes.

Note: The abbreviation Lgh stands for legheader, which is another term for trip segment.

Region 1/2
Region 3/4

Inbound, Outbound

User-defined region categories for geographic locations.

Note: The names for these regions are determined by your company, as are the subgroups defined for them. Regions and their subdivisions are established in the System Administration module.

RevType1-4

Inbound, Outbound

Revenue classifications to which a record is associated. Revenue classifications frequently are recorded for orders.

Notes:

  1. Classifying orders allows you to track the revenue collected for different types of loads.

  2. The names and options for these fields are user-defined. They are set up in the RevType1 - 4 labels in the System Administration application.

State

Inbound, Outbound

State where the company or stop is located.

TEAMLEADER

Inbound, Outbound

Identifies the team leader to which the resource is assigned.

Note: Options are user-defined in the TeamLeader label, accessed in the System Administration application.

TERMINAL

Inbound

Terminal location with which the resource is associated.

Note: Options are user-defined in the Terminal label, accessed in the System Administration application.

TrcType1-4

Inbound

User-defined tractor categories to which the tractor is assigned.

Note: The field name and options are user-defined in the TrcType1 - 4 labels, accessed in the System Administration application.

TrlType1-4

Inbound

User-defined trailer categories to which the trailer is assigned.

Note: The field name and options are user-defined in the TrcType1 - 4 labels, accessed in the System Administration application.

  1. If you want, restrict user access to the view.

    Notes:

    1. By default, if you selected a user group to locate the view to copy, all users will have full access to the new view.

      image13

    2. By default, if you selected a user to locate the view to copy, and only that user has access to the view, only that user will have access to the new view.

      image14

    3. If a user belongs to multiple groups, he or she will have access to the views assigned to each group.

      This example shows the resource-based views that can be accessed by a user belonging to the CIN and the CLE groups.

      image5

      1. At the bottom of the window, expand the View Assignment section.

        image15

      2. Click Add.
        A new row is added to the grid.

      3. From the AssignType list, select one of the following:

        • User: to assign the view to a user ID.

        • Group: to assign the view to all users in a user group.

      4. From the AssignValue list, select the user or user group.

      5. From the AssignLevel field, select one of the following:

        • Full: assigns read and write privileges to the specified user or group.

        • Read: assigns read-only privileges to the specified user or group.

      6. Repeat steps b through e for each user or user group to which you want to assign the view.

      7. To remove access to a user or user group, select the row and click Delete.
        Click Yes to confirm the deletion.

  2. If you want to view or edit the SQL code that restricts the view, expand the Raw Where Clause section.

    Note: This is an advanced feature. Contact Trimble Support for more information.

    image16

    This section serves a dual purpose:

    • The Raw Where Clause section displays the equivalent SQL statements for restrictions set in other sections of the window.

      Note: The Raw Where Clause section will not update if the section is expanded. If necessary, collapse and re-expand the Raw Where Clause section to view entries.

    • The Raw Where Clause section can be used to append additional restrictions to a view by entering SQL code directly.

    ModeFlags

    This field is a drop-down list that lets you select a database column type.

    ColumnName

    This is a free-form field where you can enter a column name. This column name must be associated with the column type you selected in the ModeFlags field.

    ColumnWhere

    This is a free-form field where you enter a SQL Where clause that appends additional restrictions to the view.

  3. When you are finished, click OK.
    The new view should now appear in the Maintain Planning Boards window.

  4. Click Save, then OK to close the window.

If the Planning Worksheet or Card Planner window is currently open, the new view will not be available until you close and re-open it, or open another instance of the window.