Enhanced Workbench

This page is accessed via Configuration and Administration > User Configuration > Enhanced Workbench.

An enhanced workbench is a type of screen that allows you to create multi-pane layouts containing tables, maps, Gantt charts, manager layouts, and 3D load configuration viewers. Layouts define the look and feel of a workbench. Each layout can have multiple regions, with each region containing panes that display different, but related, information. For example, you might have a workbench containing a layout that has three panes: a list of buy shipments, a map, and a Driver or Work Assignment Gantt chart. The map would display the routes of the buy shipments, order movements, order releases, and drivers or work assignments, while the Gantt chart would show the buy shipments and drivers or work assignments.

The workbench designer allows you to create and edit workbench layouts. After you design layouts for a workbench, you can use the workbench by selecting the layout from the drop down list. Or, you can add the Layout ID as a menu item to either the Navigator and/or the Springboard. See Using a Workbench for more information.

Note: For users with any role other than ADMIN and DEFAULT, the following Access Controls are necessary. These access controls can be added the User Role or directly to the User:

     REST – Workbench
     Workbench – Create (This is required only for Add/Delete. Can also revoke the ability to Add/Delete.)
     User Interface - View (This is included in COMMON. By default all user roles typically have this COMMON Access Control

Creating a Layout

1. Click Create Layout.
2. Enter a Layout. This is the layout ID that appears in the Workbench Layout drop-down list.
3. Enter a Description.
4. Select a Logic Configuration. The list contains Workbench logic configurations. The settings defined in the selected logic configuration determine how the workbench will look and perform.
5. Select the Auto Refresh check box to schedule an automatic refresh of all data to occur on this layout. The refresh gets the latest data for the existing objects in each component, map, Gantt chart, etc. Selected saved searches automatically rerun and populate the main tables.

Note: Only ADMIN users can select the Auto Refresh check box and select an auto refresh interval.

Note: If a component is in certain state such as inline edit, the timer is reset.

7. If you selected auto refresh above, specify an Auto Refresh Interval (Minutes) between 5 and 120. The default is 20. The minimum is 5 minutes.
8. Select the Collapse Tabs check box to automatically hide all but the first tab within each pane when the workbench layout opens. By default, this is selected so that all enhanced workbench layouts open with the tabs collapsed.
9. Note the Layout Format of Default. 
10. Select a Domain.

Note: If you select the SERVPROV domain, then only service providers (carriers) can access workbench layouts which are created in this domain. For more details, see About Service Providers Accessing a Workbench Layout.

9. Click OK. You see a blank layout with only the (content editor menu icon).
10. Hover over to see the content editor menu:
    • To split the workbench along the horizontal axis, click (Split Horizontally) to create 2 regions.
    • To split the workbench along the vertical axis, click (Split Vertically) to create 2 regions.
    • To define a new pane, click (Add Content). This allows you to add content to a region. If you add content to the same region multiple times, each additional time creates a new component tab within the same region.
11. When you are finished adding and editing content, click  (Done Editing) to exit edit mode and view the finished layout.

Adding Content to a Layout

You can add one or more of the following components to a Workbench layout:

• tables
• maps
• Gantt charts
  • Dock Scheduling
  • Driver
  • Work Assignment
  • Shipment
• shipment timeline
• manager layouts
• load config
• analytics
  • Analytics Dashboards
  • Data Visualization projects
  • Transactional Report

Editing a Layout

1. Select an existing layout using the Select Layout icon.
2. To delete the layout, click Delete Layout.
3. To see the layout details you entered when you created the layout, click Layout Details in the Workbench Navigation menu.
4. To edit the layout, click Edit Layout to edit a previously created layout. See Creating a Layout and Adding Content for details on adding new content when editing a layout.
5. When you are finished adding and editing content, click  (Done Editing) to exit edit mode and view the finished layout.

Rearranging the Contents of a Layout

1. Select an existing layout using the Select Layout icon.
2. To edit the layout, click Edit Layout to edit a previously created layout. 
3. Once in edit mode, click the  (Rearrange Content) icon. You see the Rearrange Content dialog box.
4. Use the   to the right of a workbench object and drag it either up or down to move
5. When you are finished adding and editing content, click Ok.
6. Click  (Done Editing) to exit edit mode and view the finished layout.

Editing the Content of a Region

1. Select an existing layout using the Select Layout icon.
2. Click the Edit Layout icon to edit the layout.
3. Hover over the icon to see the options for editing/adding to the layout.
4. To split a pane along the horizontal axis, click (Split Horizontally). After a split, the first pane, the one on the left, contains the components of the original pane. The new blank pane is added to the right.
5. To split a pane along the vertical axis, click (Split Vertically). After a split, the top pane contains the components of the original pane. The new blank pane is added at the bottom.
6. To edit previously created content in a pane, select a component tab in a pane and click the  (Edit Content) icon. This icon appears at the lowest level section only (for example, the table or Gantt component).
7. Change the options available on the Edit Content dialog box and click OK to save your changes.
   
   You can change details about a component such as object type, tab name, etc.; but, you cannot change the component type when editing a region.
   
   Also, if a component type of Table has a dependent/child table in the layout, the object type of the main table cannot be changed. When you delete the dependent children, you can then change main table’s object type. You can change the object type of the child.
8. To remove content from a region or a pane, click (Remove Content). If you use this icon at a higher level section, all the included lower sections nested within that region or pane will also be removed.

Copying a Layout

You can copy an existing layout as follows:

1. Select an existing layout using the Select Layout icon.
2. Click the Copy Layout icon. See Creating a Layout details on the options available when copying a layout.

Setting up a Layout for use with an OTM Action

The following OTM actions use a public workbench layout:

• Map Bulk Plan Results
• Map Fleet Bulk Plan Results
• Map Inbound Shipments
• Map Order Releases
• Map Outbound Shipments
• Map Shipments
• Display on Map

You can create your own workbench layout for these OTM actions.

1. Create a new layout.
2. Add content to the new layout as necessary to show the appropriate data for the OTM action.
3. When adding table components, follow the steps below:
   1. Select an object type listed in the table below. For example, "Buy Shipment".
   2. Select a population method of "Action".
   3. Select an action data mapping ID depending on which object type you selected. See the table below. For example, since the object type is buy shipment you can select an action mapping ID of "Shipments Built in Bulk Plan".
   4. Save the layout.
4. Set one of the following parameters to control which workbench layout opens when the action is run:
   • Map Bulk Plan Results action: BULK PLAN VIEW LAYOUT ID
   • Map Fleet Bulk Plan Results action: VIEW FLEET BULK PLAN RESULTS LAYOUT ID
   • Map Inbound Shipments action: VIEW INBOUND SHIPMENTS LAYOUT ID
   • Map Order Releases action: VIEW ORDER RELEASES LAYOUT ID
   • Map Outbound Shipments action: VIEW OUTBOUND SHIPMENTS LAYOUT ID
   • Map Shipments action: VIEW SHIPMENTS LAYOUT ID
   • Display on Map option on the Move Order to (Existing) Shipment action: OPTIMIZE MOVE ORDER TO SHIPMENT LAYOUT ID

5. Now when you run the action, you see the workbench layout.

   Use this table when configuring your workbench tables:

   OTM Action	Table Object Type	Action Data Mapping ID
   Map Bulk Plan Results	Buy Shipment	Shipments Built in Bulk Plan
   Map Bulk Plan Results	Order Release	Orders Planned in Bulk Plan
   Map Bulk Plan Results	Order Release	Orders Failed in Bulk Plan
   Map Fleet Bulk Plan Results	Driver	Drivers
   Map Fleet Bulk Plan Results	Driver	Drivers Failed to Assign
   Map Fleet Bulk Plan Results	Buy Shipment	Shipments Assigned
   Map Fleet Bulk Plan Results	Buy Shipment	Shipments Failed to Assign
   Map Inbound Shipments	Buy Shipment	Shipments
   Map Order Releases	Order Release	Orders
   Map Outbound Shipments	Buy Shipment	Shipments
   Map Shipments	Buy Shipment	Shipments
   Optimize Move Order To Shipment - More Options - Add to Map	Order Release	Orders
   Optimize Move Order To Shipment - More Options - Add to Map	Buy Shipments	Shipments