Configuration and Administration
Adding Content to an Enhanced Workbench Layout
This page is accessed via Configuration and Administration > User Configuration > Enhanced Workbench .
To define a new pane, hover over the Layout Configuration icon to see the content editor menu and 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.
You can add tables, one or more maps, one Driver Gantt chart, one Work Assignment Gantt chart, one or more manager layouts, one or more Load Config components to your layout, etc.
Adding a Table
You can add a table to a Workbench layout as follows:
- Select a Component Type of Table.
- Select an Object Type. Various fields appear only when you have selected a specific object type.
- Enter a Tab Name. In the finished workbench, the tab name appears on a tab at the top of the area you are defining. If left blank, the tab name defaults to the object name (for example Buy Shipment).
- Select a Screen Set. The screen set defines how the business object is displayed when you click on the ID.
- If you select an object type of Buy Shipment, Driver, Shipment Stop, or Work Assignment, the Show Gantt column check box appears. Select this check box if you want the table to have an In Gantt column in it. The In Gantt column allows you to select items and display them on a pane of the workbench defined to have either a Driver, Work Assignment, or Dock Scheduling Gantt chart.
If you select an object type of Shipment Stop and add as a detail table, the In Gantt column radio button appears. The In Gantt column allows you to select an item and display it on a pane of the workbench defined to have a Dock Scheduling Gantt chart.- For a Driver Gantt chart:
- For a driver, you can select this check box to add the driver to the Driver Gantt chart.
- For a Work Assignment Gantt chart:
- For a work assignment, you can select this check box to add the work assignment to the Work Assignment Gantt chart.
- For a Dock Scheduling Gantt chart:
- For a shipment stop, you can select this radio button to add location resource (dock door) to the Dock Scheduling Gantt chart.
- When you select a shipment stop used with a Dock Scheduling Gantt, the Gantt chart displays existing appointments if any for the selected location.
- For a Driver Gantt chart:
- When you select an object type of Buy Shipment, Driver, Location, Modeling Scenario, Modeling Shipment, Network, Order Movement, or Order Release, the Show map column check box appears. Select this check box if you want the table to have a Map column in it. The Map column allows you to select items and display them on a pane of the workbench defined to have a map.
- If you want the first row of data in the table to be selected automatically, select the Default first row selection check box. This option is not selected by default when you add a table.
- If this table is a child table to another table, select the Detail Table check box. You then see the Combined Detail Type drop-down list and the Associated Tables list.
- You can select a Combined Detail Type to determine how the records in the detail table are displayed. Mass update is supported while inline edit and filters are not supported for a combined detail table. The Combined Detail Types are described below. For sample configuration see, new topic.
- Grouped Combined Table shows the details of all the parent records selected in the Associated Tables saved search as a combined group for easier navigation.
If you select Grouped Combined Table, you see the Show Group Combined Collapse check box. Select this check box to see the results in a grouped format that is collapsed. You can click the Expand icon in your workbench results table to see the group expanded. - Ungrouped Combined Table shows the details of all of the parent records selected in the Associated Tables saved search as a single list of records.
- Grouped Combined Table shows the details of all the parent records selected in the Associated Tables saved search as a combined group for easier navigation.
- In the Associated Tables section, you must select at least one associated table saved search. If you select more than one associated table saved search, the detail table is associated with all of those tables. This search establishes the relationship between the parent and detail tables. For example, you can set up a layout with an order release table as the detail table for an accepted shipments parent table and declined shipments main table. It also is a non-finder-based saved query.
- You can select a Combined Detail Type to determine how the records in the detail table are displayed. Mass update is supported while inline edit and filters are not supported for a combined detail table. The Combined Detail Types are described below. For sample configuration see, new topic.
- If this is a parent table, you can select Grouped Table to determine how the records in the parent table are displayed. When you select the Grouped Table option, you see Saved Groups and Group by Columns boxes.
- Click in the Group by Columns box to see a list of available columns. Select a column, such as Source Location ID, to group the records in the parent table by that column. You can select more than one column to group by. Mass updated is supported while inline edit and filters are not supported for grouped table.
- Click the Save icon to save this group. When you save the group, the newly saved group is moved to the Saved Groups drop-down list. The entry selected in the Saved Groups drop-down list is the default selection in the Saved Groups pop-up on the search results.
- To edit a saved group, click the pencil icon (Edit) and the group is moved to the Group by Column field where you can add or remove columns. When you select Save, the saved group is updated.
- To delete a saved group, select it in the Saved Groups drop-down list and click the Clear icon.
- To add more saved groups, click the New icon to the right of the Group by Columns field. Then, click in the field and select the columns to group by. Click Save when the new group is complete.
In the Saved Groups field, multiple Saved Groups can be listed. These can be used when using the workbench table to change how the records on the table are grouped. - If columns containing dates are selected in your Saved Group, you can select the Group by Date Option to group the results by one of the following formats:
- Date and Time (default)
- Date
- Month
- Year
- Month and Year
-
- Saved Search allows you to select a Default Saved Search so that specific results are populated in the table when you use the layout. Use a default saved search for standard workbench layouts. This appears for objects such as buy shipment, driver, order release, etc.
- Action allows you to select an Action Data Mapping ID so that the table results are populated based on an OTM action. Use this option when a layout is launched from an action where the action knows exactly how to populate the table. Use of this option is only for advanced users, and caution is recommended. This appears for objects such as buy shipment, driver, order release, etc.
- Work Queue allows you to select a GTM Work Queue so that the table results are populated based on the GTM work queue. A work queue is a list of tasks that are assigned to a specific user and are used when creating GTM work queue workbench layouts. This appears for the GTM objects contact, party, transaction, transaction line, trade item structure, trade item structure component, declaration, and declaration line.
- In the Table Parameters Default section, select the icons that appear in the table toolbar. The icons are:
- Add
- Replace
- Remove
- New (must also be set up in the screen set)
- Edit (must also be set up in the screen set)
- Delete (not selected by default and must also be set up in the screen set)
- Refresh
- Export (must also be set up in the screen set)
- Run Analytics (not selected by default)
- Drag/Select Text (not shown if drag-and-drop is disabled in the Logic Configuration)
- Filter
- For combined tables, Group/Ungroup Combined Table (not selected by default)
Adding a Map
You can add a map to a Workbench layout as follows:
- Select a Component Type of Map.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- If you want to change which fields appear by default in the map hover text, expand the Hover Screen Sets section and select user-defined screen sets for one or more objects for which you want to change the hover text.
-
- A Hover Screen Set controls the fields which appear in the hovering pop-up window when you click the Show Details Hover icon on the map. Within the Hover Screen Sets section, you can select the screen sets for various objects supported by the map component.
- To configure the fields displayed in the hovering pop-up window on the screen set, select the Include in Hover Text option for fields in the Results tab via the More button.
- Once expanded, the Hover Screen Sets section is grouped as follows:
- Shipment: includes shipment-related objects such as buy shipment and shipment stop as well as logistics network modeling related objects such as modeling shipment and modeling shipment stop.
- Order: includes order-related objects such as order movement and order release.
- Driver: includes the driver object.
- Network: includes network-related objects such as location, network leg, region, and region details.
- Show Default Hover: This check box controls which default fields are shown in the map hover text pop-up. This check box is selected by default. To remove the default hover fields deselect this check box. The default hover fields are listed in column 3 in the table below.
Defining Fields for Map Hover Text
Note: It is only necessary to define fields If you want to change which fields appear by default in the map hover text. Many fields are already included by default in the map hover text. So check the default hover before making any changes.
You can change which fields appear in the map hover text for your workbench layouts as follows:
- To see both the default hover fields (column 3 below) and fields pre-defined in the PUBLIC screen set fields (column 2 below), select the Show Default Hover check box and leave the corresponding screen set field blank. This is the default.
- To see both the default hover fields and the fields specified in a user-defined screen set, select the Show Default Hover check box and specify a screen set.
- To see only the fields pre-defined in the PUBLIC screen sets, clear the Show Default Hover check box and leave the corresponding screen set field blank.
- To see only the fields specified in a user-defined screen set, clear the Show Default Hover check box and specify a screen set.
Note: If you leave the screen set field blank (which is the default), the PUBLIC screen set is automatically used. This will show the predefined fields see column 3 in the following table.
The following table details each PUBLIC screen set that has fields with the Include in Hover text check box selected by default. The third column in this table lists the fields for each business object that are controlled by the Show Default Hover check box. They are shown in the map hover if the Show Default Hover check box is selected.
PUBLIC screen set |
Fields where the Include In Hover Text option is selected in PUBLIC screen set |
The following fields are controlled by the Show Default Hover check box. They are shown in map hover if the Show Default Hover check box is selected. |
---|---|---|
BUY_SHIPMENT |
Service Provider ID, Mode, Total Actual Cost, First Equipment Group ID |
Rate Offering, Stop Time Type |
DRIVER |
First Name, Last Name, Driver Type ID |
Home Location, Next Available Time, Next Available Location |
LOCATION |
Location Name, Time Zone |
Latitude, Longitude, Location Address |
MODELING_SHIPMENT |
Service Provider ID, Mode, Total Actual Cost, First Equipment Group ID |
Rate Offering, Stop Time Type |
MODELING_SHIPMENT_STOP |
Distance |
Stop Type, Pick up/Drop-off, Pick up Order Releases/Drop-off Order Releases, Arrival, Departure, Source Location ID, Source Region, Destination Location ID, Destination Region |
ROUTING_NETWORK_LEG |
Source Location Role ID, Destination Location Role ID |
Source Location ID/Source Region, Destination Location ID/Destination Region, Network ID, Active, Modes |
ORDER_RELEASE |
Early Pickup Date, Late Pickup Date, Early Delivery Date, Late Delivery Date, Total Gross Weight, Total Gross Volume, Source Location ID, Destination Location ID |
Total Ship Unit Count |
ORDER_MOVEMENT |
Early Pickup Date, Late Pickup Date, Early Delivery Date, Late Delivery Date, Order Release ID, Source Location ID, Destination Location ID, Total Weight, Total Volume, Total Ship Unit Count |
Not Applicable |
REGION |
Representative Location |
Network ID, Latitude, Longitude, Location Address |
REGION_DETAIL |
Geo Hierarchy ID, Location ID, Zone1, Zone2, Low Range Value, High Range Value |
Sequence Number, Location Address, Zone3, Zone4 |
SHIPMENT_STOP |
Distance |
Stop Num, Stop Type, Pick up/Drop-off, Pick up Order Release/Drop-off Order Release, Planned Arrival, Planned Departure |
Tracking Event |
Not applicable |
Event Description, Latitude, Longitude, Time, Location |
Adding a Gantt Chart
Workbench supports the following Gantt charts:
- Dock Scheduling Gantt
- Driver Gantt
- Shipment Gantt
- Work Assignment Gantt
Dock Scheduling Gantt
- Select a Component Type of Dock Scheduling Gantt.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select a Location Resource Screen Set. The screen set defines how the location resource is displayed when you click on the Location Resource ID.
- Select an Appointment Screen Set. The screen set defines how the appointment is displayed when you click on the Appointment ID.
Driver Gantt
- Select a Component Type of Driver Gantt.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select a Driver Screen Set. The screen set defines how the driver is displayed when you click on the ID.
- Select a Shipment Screen Set. The screen set defines how the shipment is displayed when you click on the ID. Use only buy shipment screen sets.
Shipment Gantt
- Select a Component Type of Shipment Gantt.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select a Shipment Screen Set. The screen set defines how the shipment is displayed when you click on the ID. Use only Buy Shipment screen sets.
- Select a Shipment Stop Screen Set. The screen set defines how the shipment stop is displayed when you click on the ID.
Work Assignment Gantt
You can add either a standard work assignment gantt or a modeling work assignment gantt component.
- Select a Component Type of Work Assignment Gantt.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select either Work Assignment Gantt or Modeling Work Assignment Gannt. The dialog box changes depending on what you selected.
Work Assignment Gantt
If you selected, the Work Assignment Gantt option, select the following screen sets.
- Select a Work Assignment Screen Set. The screen set defines how the work assignment is displayed when you click on the ID.
- Select a Shipment Screen Set. The screen set defines how the shipment is displayed when you click on the ID. Use only Buy Shipment screen sets.
- Select a Shipment Stop Screen Set. The screen set defines how the shipment stop is displayed when you click on the ID.
Modeling Work Assignment Gantt
If you selected, the Modeling Work Assignment Gantt option, select the following screen sets.
- Select a Modeling Work Assignment Screen Set. The screen set defines how the modeling work assignment is displayed when you click on the ID.
- Select a Modeling Shipment Screen Set. The screen set defines how the modeling shipment is displayed when you click on the ID.
- Select a Modeling Shipment Stop Screen Set. The screen set defines how the modeling shipment stop is displayed when you click on the ID.
Note: Modeling work assignments and shipments are read only. You cannot run actions against them or use drag-and-drop functionality.
Adding a Manager Layout
You can add a view or edit manager layout to a workbench layout. This allows you to view or edit an OTM object such as a buy shipment or a GTM object such as a license.
The manager layout component populates when a record is selected on an associated table. The manager layout component displays the data for any object based on the screen set assigned to either the view or edit control of the associated table where the object is selected. For example, when a specific shipment is selected on a shipment table the manager layout displays the buy shipment view or edit manager page as defined on the screen set.
Note: It is recommended that your manager layouts have as few fields as possible! A minimal manager layout will be easier to navigate in the relatively small space available on a workbench layout and it will load faster.
Note: A main table must already exist on the layout prior to adding this component type.
You can add a manager layout component as follows:
- Select a Component Type of Manager Layout.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select one of the following radio buttons:
- Edit: Select to use the edit manager layout specified next to the Edit control on the screen set defined on the associated table.
- View: Select to use the view manager layout specified next to the View control on the screen set defined on the on the associated table.
- Select an Associated Table. The list of associated tables is populated based on the main tables already defined on the layout. For example, if your layout contains buy shipment and driver main tables, you see 2 check boxes: Buy Shipment and Driver.
Adding a 3D Load Viewer (Load Config)
In a layout that already contains a Shipment table, you can add a 3D load viewer. With the 3D load viewer, you can see the load configuration for a shipment in 3D format.
Note: A main table must already exist on the layout prior to adding the component type.
- Select a Component Type of Load Config.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select an Associated Table which is usually a shipment or modeling shipment table.
Adding Analytics
Workbench supports the following Oracle Analytics Server components:
- Analytics Dashboard
- Data Visualization
- Transactional Report
Analytics Dashboard
You can add an Oracle Analytics Server Dashboard to a Workbench layout as follows:
- Select a Component Type of Analytics Dashboard.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Enter a Dashboard Path.
This is the location of the dashboard on the file and not the relative path. To get the path,- Go to Transportation Intelligence > Catalog to see the Oracle Analytics Server Catalog.
- Navigate to location of the dashboard in the Catalog. All user-defined dashboards are in the Oracle Analytics Server Catalog location of Shared Folders/Custom. For the pre-defined dashboards, see the TI Reference Guide or the GTI Reference Guide.
- Right click on one of the reports in the dashboard and select Properties. The Location will be the OTM Dashboard Path. An example of a Dashboard Path is /shared/LML Dashboards/_portal/Logistic Machine Learning Dashboard.
- Optionally, select an Object Type. For example, Machine Learning Project.
- If you select an Object Type, enter a Dashboard Parameter. For example, "- Machine Learning Training Dimensions"."Project GID"
Data Visualization
You can add an Oracle Analytics Server Data Visualization project to a Workbench layout as follows:
- Select a Component Type of Data Visualization.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Enter a Project Path.
This is the location of the DV project for example /@Catalog/shared/LML Data Visualisation/LML- Input Data. For the pre-defined projects, see the TI Reference Guide.
To find out the project path:- Edit the project in Oracle Analytics Data Visualization.
- Go to Menu > Developer.
- Click the Embed tab.
- Copy the project path.
- Optionally, select an Object Type. For example, Machine Learning Project.
- If you select an Object Type, enter a Project Parameter. For example, "Logistics Machine Learning"."- Machine Learning Shipment Dimensions"."Project GID"
- Select an Associated Table . The list of associated tables is populated based on the main tables already defined on the layout. For example, if your layout contains buy shipment and driver main tables, you see 2 check boxes: Buy Shipment and Driver.
Transactional Reports
You can add an Oracle Analytics Publisher report to a Workbench layout as follows:
- Select a Component Type of Transactional Report.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Enter a Report Path.
This is the report path is Custom/shipment-weight-distribution.xdo. - Optionally, select an Object Type.
- If you select an Object Type, enter a Report Parameter.
Adding a Shipment Timeline
In a layout that already contains a Shipment table, you can add a shipment timeline. With the shipment timeline, you can see the events added for a shipment.
Note: A main table of Buy Shipment must already exist on the layout prior to adding the component type of Shipment Timeline.
- Select a Component Type of Shipment Timeline.
- Enter a Tab Name. In the finished layout, the tab name appears on a tab at the top of the area you are defining.
- Select an Associated Table must be Buy Shipment.
Related Topics
About Enhanced Workbench Layouts
Logic Configuration - Workbench
Using an Enhanced Workbench Table
Using an Enhanced Workbench Map
Using an Enhanced Workbench Gantt Chart
Using an Enhanced Workbench 3D Load Configuration Viewer