Configuring Actions

This page is accessed via Configuration and Administration > User Configuration > Actions Manager.

Use the Action page to perform the following tasks for actions.

Create user-defined actions based on manager layouts.
Configure any existing report as a user-defined action that can be run manually from the Result page Action menu of a particular business object type.
Configure any existing automation agent as a user-defined action that can be run manually from the Results page Action menu of a particular business object type.
Create an action that sends an object to an external URL.
Configure any existing document as a user-defined action that can be run manually from the Results page Action menu of a particular business object type.
Edit the public actions and configure attributes for actions that support attributes.

Note: For every user-defined action created, you must run the Secure Action action against that action.

Create Manager Layout-based Actions

You can create user-defined actions that are used with configured manager layouts. This enables you to rename and rearrange fields on an action to meet your businesses needs. Several steps are involved in creating a user-defined action, including one portion of the process that is completed on the Actions Manager, as described here.

Enter an Action.
Enter a Label.
Select an Action Definition ID. If you selected a specific action definition, such as READY_TO_SHIP_OB_LINE, a Manager Layout section appears.
Enter an Audit Action ID if you want to monitor the action by using action checks.
Select a Domain Name.
Select the Long Running Task check box if you expect it to frequently process a large number of records. If this check box is selected and the Minimum Item Count is defined, the action will be considered a long running task if the minimum item count is met. All user actions check the number of objects selected to determine if a long-running threshold has been reached. E.g., if a bulk plan is run for one order, the action should not be tracked as long-running. But if a bulk plan is run for 100 orders, it could, depending on the value in the Minimum Item Count field, or the glog.action.numObjectsForLongRunningTask property.
Enter the Minimum Item Count to qualify this action as being long-running. If this field is not defined, the system defaults to the value defined in the glog.action.numObjectsForLongRunningTask property. Any value in this field overrides that property value. See Long Running task above for more details.
If you selected one of the special action definitions, choose a Manager Layout ID.
Click Finished.
Run the Secure Action action against the newly-created action.

Initialization Arguments

These are the parameters that are passed to an action to identify specific conditions. An example is assign and unassign. Suppose that one action's definition can handle both assign and unassign. Then, this information is passed through action arguments to tell which operation needs to take place. This data comes from the CSV file, so most of the time, these are read-only. There are a few exceptions. There are a few fleet related actions such as Assign Driver to Shipment, where the FLEET_IGNORE_DISPLAY argument can be modified. By default, this argument is true, so, when it is true, OTM displays the fleet planning Ignore Criteria page for this action. If you do not want this screen to appear, you can set it to false. This is the only argument that can be changed. All other arguments are read only.

Configure Reports as Actions

Follow these steps to configure a report as a manual action. After you create a user-defined action, you need to edit or create an appropriate screen set and configure that screen set to display the new action on the Actions menu.

Name the new action in the Action field. The action name will appear on the Actions tab of a screen set when you include the action on the screen set.
Select a Label to define the text that appears on the action menu for the action. This label text also appears on the Actions list in the Screen Set Manager (Actions tab).

For example, if you create an action with a Label ID that has text defined as MY ORDER REPORT, the Actions menu displays the action menu option as MY ORDER REPORT.
Select one of the following Action Definition IDs to configure report actions:
- RUN_REPORT_ORDER_BASE
- RUN_REPORT_ORDER_RELEASE
- RUN_REPORT_SHIPMENT
- RUN_REPORT_INVOICE
- RUN_REPORT_SHIPMENT_FROM_TENDER (planner screen set)
- RUN_REPORT_SHIPMENT_FROM_TENDER_SERV (service provider screen set)
Your selection of an Action Definition ID determines the Screen Sets to which you can add the action. For example, if you select RUN_REPORT_ORDER_BASE, only Screen Sets assigned to an Order Base Query ID (OB_ORDER_BASE) will display the action as a valid choice on the Actions tab in the Screen Set Manager.
Select a domain from the Domain Name drop-down list in which to store the user-defined action (or leave the default which is the current domain).
Perform a search in the Report ID field and select a report from the list. The report that you select should correspond with the Agent Definition ID that you selected. For example, if you create a user-defined report action for ORDER_BASE, select an order-centric report as opposed to a report on shipments, etc.
If you do not want to consolidate your reports, enter FALSE in the Consolidated field. If you leave this field empty or enter TRUE, the reports will be run as if they are consolidated.
Click Finished to save the new action.
Run the Secure Action action against the newly-created action.
Add the action to a Screen Set by configuring the Actions menu in the Screen Set Manager.
Note: Remember, only screen sets that are configured with a Query ID that matches the business object in the Action Definition ID can be configured with the user-defined action. In the example above, only screen sets with a Query ID of OB_ORDER_BASE can be used. Also, remember the name of the user-defined action must match the text defined for the Label ID that you used to create the action.

Configure Agents as Actions

Follow these steps to configure an automation agent as a manual action that can be run from the Results pages of various business objects. After you create a user-defined action, you need to edit or create an appropriate screen set and configure that screen set to display the user-defined action on the Actions menu.

Name the new action in the Action field. The action name will appear on the Actions tab of a screen set when you include the action on the screen set.
Select a Label to define the text that appears on the action menu for the action. This label text also appears on the Actions list in the Screen Set Manager (Actions tab).

For example, if you create an action with a Label ID that has text defined as MY ORDER AGENT, the Actions menu displays the action menu option as MY ORDER AGENT.
Select an Action Definition ID to configure agent actions.

The Action Definition ID determines the screen sets to which you can add the action. For example, if you select RUN_AGENT_ORDER_BASE, only screen sets assigned to an Order Base Query ID (OB_ORDER_BASE) will display the action as a valid choice on the Actions tab in the Screen Set Manager. The Action Definition ID also determines the automation agents that appear in the Agent ID list (see step 5). For example, if you select RUN_AGENT_ORDER_BASE, only agents with an Agent Type of ORDER BASE appear in the Agent ID list.
Select a Domain Name in which to store the new action (or leave the default which is the current domain).
Select an agent from the Agent ID list.
Select Results Message Text. For example, you can define the message text that appears on the action results screen.
Enter a value in seconds in the Auto Close Result Message Timer (seconds) field. This is a timer after which the action results screen with the above results message will auto close.
Click Finished to save the new action.
Run the Secure Action action against the newly-created action.
Add the action to a screen set by configuring the Actions menu in the Screen Set Manager.
Note: Remember, only screen sets that are configured with a Query ID that matches the business object in the Action Definition ID can be configured with the user-defined action. In the example above, only screen sets with a Query ID of OB_ORDER_BASE can be used. Also, remember the name of the user-defined action must match the text defined for the Label ID that you used to create the action.

Create Action for External URL

Follow these steps to create an action that sends an Order Base ID to an external URL.

Name the new action in the Action field. The action name will appear on the Actions tab of a screen set when you include the action on the screen set.
Select a Label that defines that text that appears on the action menu for the action. This Label text also appears on the Actions list in the Screen Set Manager (Actions tab).

For example, if you create an action with a Label ID that has text defined as SEND ORDER TO EXTERNAL WEBSITE, the Actions menu displays the action menu option as SEND ORDER TO EXTERNAL WEBSITE.
Select an Action Definition ID to configure an action, such as REDIRECT_ORDER_BASE, to send parameters to an external URL.
Select a Domain Name in which to store the new action (or leave the default which is the current domain).
Enter the URL for the website that will receive the order data; for example, https://www.example.com.
Enter a Parameter Name in the Parameter Name field for the Order Base ID. The Parameter Name is site specific and can be anything that you want it to be. For example, if you are redirecting an Order Base ID to http://.example.com and you want the ID to be named "value", enter the word value in the Parameter Name field. When Oracle Transportation Management redirects to the external site, it sends http:/example.com/value=CORP.ORDER123. If you leave Parameter Name blank, Oracle Transportation Management redirects with http://example.com/pk=CORP.ORDER123
Select a Parameter Value. You may select to send either the GID or XID with the action.
Click Finished to save the new action.
Run the Secure Action action against the newly-created action.
Add the action to a screen set by configuring the Actions menu in the Screen Set Manager.
Note: Remember, only screen sets that are configured with a Query ID that matches the business object in the Action Definition ID can be configured with the user-defined action. In the example above, only screen sets with a Query ID of OB_ORDER_BASE can be used. Also, remember the name of the user-defined action must match the text defined for the Label ID that you used to create the action.

Configure Documents as Actions

Follow these steps to configure a document as a manual action. After you create a user-defined action, you need to edit or create an appropriate screen set and configure that screen set to display the user-defined action on the Actions menu.

Name the new action in the Action field. The action name will appear on the Actions tab of a screen set when you include the action on the screen set.
Select a Label to define the text that appears on the action menu for the action. This Label text also appears on the Actions list in the Screen Set Manager (Actions tab).

For example, if you create an action with a Label ID that has text defined as MY DOCUMENT, the Actions menu displays the action menu option as MY DOCUMENT.
Select an Action Definition ID such as RUN_DOCUMENT_SHIPMENT to configure document actions. Your selection of an Action Definition ID determines the Screen Sets to which you can add the action.
Select a Domain Name in which to store the new action (or leave the default which is the current domain).
If you select the Preview field, the generated document will be marked as a preview and will not be saved when viewing the document in the document manager.
Perform a search in the Document Type field and select a document type from the list. The document type you select should correspond with the Agent Definition ID that you selected.
Click Finished to save the new action.
Run the Secure Action action against the newly-created action.
Add the action to a screen set by configuring the Actions menu in the Screen Set Manager.

Configure Action Attributes

Many planning actions honor various constraints as part of the standard shipment planning logic. However, you can configure the following planning actions to display an Ignore Constraints page when these actions are run. From the Ignore Constraints page, you can turn off the various constraints that appear. For example, you could configure the Create Buy Shipment - Direct action to ignore any order constraints such as Date Emphasis, Equipment, Itinerary, or Rate assignments, etc.

Action ID	Action Definition ID	Action Name	Manager/ Menu Link
ALTERNATE_SERVPROV	GET_SERVICE_PROVIDER_LIST	Change Service Provider	Shipment
BEST_SERVPROV	BEST_SERVICE_PROVIDER	Choose Least Cost	Shipment
BUILD_BUY_MULTI_STOP	BUILD_MULTI_STOP	Multistop	Order Release
BUILD_SELL_MULTI_STOP	BUILD_MULTI_STOP	Multistop	Order Release
BUILD_BUY_SHIPMENTS	GET_EQUIPMENT_GROUP_AND_PROFILE	Direct	Order Release
BUILD_SELL_SHIPMENTS	GET_EQUIPMENT_GROUP_AND_PROFILE	Direct	Order Release
CHANGE_EQUIPGROUP	GET_EQUIPMENT_GROUP	Change Equipment Group	Shipment
CHANGE_MODE	CHANGE_MODE_INPUT	Change Transport Mode	Shipment
CHANGE_SERVPROV	GET_SERVICE_PROVIDER	Select and Change Service Provider	Shipment
CHANGE_START_TIME	GET_START_TIME	Change Start Time	Shipment
CHANGE_STOP_TIME	GET_SHIPMENT_STOP_TIMES	Change Stop Time	Shipment
CREATE_RELAY_SHIP	CREATE_RELAY_SHIPMENT_INPUT	Create Relay Shipment	Shipment
DIVERT_SHIP	GET_LOCATION	Divert Shipment	Shipment
MANUALLY_BUILD_SHIP_UNIT_OB_LINE	MANUALLY_BUILD_SHIP_UNIT	Manually Build Order Release	Order Base
MANUALLY_CREATE_SHIP	MANUALLY_CREATE_SHIPMENT_INPUT	Manual (Create Buy/Sell Shipment)	Order Release
MERGE_SHIP	GET_CONSOLIDATE_FLAG	Merge	Shipment Manager
MOVE_ORDER_TO_BUY_SHIP MOVE_ORDER_TO_SELL_SHIP	MOVE_ORDER_TO_SHIPMENT_INPUT	Move Order to Existing Shipment	Order Release
PREFERRED_SERVPROV	GET_PREFERRED_SERVICE_PROVIDER_LIST	Choose Preferred Alternatives	Shipment
RESEQUENCE_STOPS	GET_NEW_STOP_SEQUENCE	Re-sequence Stops	Shipment
SHIPMENT_BUY_ITINERARIES SHIPMENT_SELL_ITINERARIES	GET_ITINERARIES	Direct - Show Valid Itineraries	Order Release
SPLIT_BY_ORDERS	SPLIT_SHIPMENT_BY_ORDERS_INPUT	Split by Orders	Shipment
SPLIT_BY_PERCENTAGE	GET_PERCENTAGE	Split by Percentage	Shipment
SPLIT_BY_SHIP_UNIT	GET_PERCENTAGE	Split by Ship Unit	Shipment
UNASSIGN_BUY	UN_ASSIGN_ORDER	Unassign Order - Buy	Order Release
UNASSIGN_SELL	UN_ASSIGN_ORDER	Unassign Order - Sell	Order Release

Note: To configure any of these public actions, you must log in with database administrator privileges.

From the Action manager, search for any of the actions listed above that you want to configure. You can search by entering an Action ID or by selecting the appropriate Action Definition ID. Use the above table as a reference to help find the action that you want to configure.
Edit the action.
Select the Display Ignore Criteria check box. This check box only displays for the Actions listed above. If the Display Ignore Criteria check box cannot be changed, it is hidden.
Click Finished.
Go the manager results page that contains the action that you configured and run the action to display the Ignore Criteria page.
Note: The Ignore Criteria page will appear for any user that logs into Oracle Transportation Management and runs the action.