System Screen Element Version Operation fields

Screen Element Operation

Operation Type: A read-only field that indicates whether an operation is created to initiate a job instance or a general operation from the Transportation Manager Web user interface or Transportation Smartbench.
- General: An operation configured to execute any operation other than job initiation. Set by the "New" operation.
- Job: An operation that is configured to initiate job instances. See Job Server and Job Definitions view. Set by the "New Job" operation.
Screen Element Version Operation ID: The ID for the System Screen Element Version Operation. It is mandatory and cannot be modified after a row has been created. System provided Screen Element Version Operation IDs will end with the underscore character ("_"); user defined System Screen Element Version Operation IDs cannot end with the underscore character.
Description: User maintainable description. It is mandatory. It can be modified in Update mode for rows that are not system provided.
Selection Required: Indicates whether selection of a row (or rows) from a list is required before triggering this operation (For example: Selection of a row is not required for the "New" operation but it is required for "Properties") Supported values: Select Exactly One Row, Select One or More Rows, Select Zero or More Rows, Select Zero One or Two Rows, Selection not Required. It can be modified in Update mode for rows that are not system provided.

Note: If a user defined System Screen Element Version is created based on a system provided System Screen Element, the system provided operations that were duplicated will be designated as system provided.

Active: Indicates whether the operation is active for users in user groups when an override does not exist for the Screen Element Version. It is controlled by using the Activate and Deactivate operations.
System Provided: Indicates whether this System Screen Element Version Operation has been provided as part of the base Transportation Manager data set. Setting is controlled by the application.

Created at Release: For system-provided System Screen Element Version Operations, this indicates the Transportation Manager Release where the operation was introduced. For operations that are not system-provided, the current Transportation Manager Release will be assigned upon creation. Setting is controlled by the application.
Job ID: The ID of the job that will be initiated when this operation is requested. Use the secondary search icon to select an existing job.

Note: This field is displayed only when "Operation Type" is "Job".
Job Invocation: Indicates how the job identified by "Job ID" will be processed when user invokes this operation.
- Asynchronous: Initiates the job instance in the background allowing the user to perform other actions in the user interface. This option does not allow the user to view the status of the current job instance.
- Synchronous: Initiates the job instance by displaying the progress of the current job instance and those of the linked job instances. On completion of all the Job Instances, details of the job instances, job history elements and list of successful and failed entities will be displayed in the user interface. See Job Instance List.
Note: This field is displayed only when "Operation Type" is "Job".
URL: The URL that will be presented when this operation is requested. It is applicable only for user defined System Screen Element Version Operations; internal mapping will be used to navigate to pages for system-provided operations. User defined operations can refer to an existing TM component if the current set of operations do not already support it. For example, there are many system-provided load operations but not all of these operations are available from every TM or TSB list of loads. If the base version of a TM or TSB load list does not provide access to a desired operation, it can be added by creating a user-defined operation. Click the () icon (to the right of the URL field) to activate a secondary search that will list all eligible operations for the current list. If a TM component is selected, the URL and URL Parameters fields will be auto-populated with the necessary values required to reach this component.
Notes:
- This field is displayed only when "Operation Type" is "General".
- User defined operations based on TM component selection against a Smartbench screen element will prepend the ‘<@ServerHostPort@>’ keyword to the URL to assure proper navigation. When defining a new operation against any Smartbench screen element to an external application, be sure to include all values needed to reach the target URL.
- The URL string for user defined operations is validated against Domain Controls marked as Allow in Functions/User Defined Operations when entries are created or updated.
- Validation against Domain Controls also occurs when the user defined operation is executed. If validation fails at this point, execution fails with an error message.
URL Parameters: The parameters that should be passed to the target URL when this operation is requested. It is applicable only for user defined System Screen Element Version Operations; internal mapping will be used to navigate to other pages for system provided operations.

Note: This field is displayed only when Operation Type is General.

Generate URL: If selected, an external URL generator will construct the URL when the operation is executed. It is applicable only for user defined System Screen Element Version Operations. The URL field is used to indicate which external URL generator is used. For more information about generated URLs, see Special URL keywords.

Note: This field is displayed only when Operation Type is General.

Availability: Indicates whether the operation will be available when the Screen Element Version is accessed in update mode only, view mode only or when accessed in both update and view modes. It can be modified in Update mode for rows that are not system provided.
Eligible for Deactivation: Indicates whether this operation is eligible to be deactivated.

Note: The operation corresponding to the Return button will never be eligible for deactivation. It can be modified in Update mode for rows that are not system provided.

Allow Override to View Only Mode: Indicates whether authorization for this operation can be overridden from Update to View for a specific user group. This flag cannot be accessed in update mode. Applicable only for operations where Availability is "Both View and Update Mode". Setting will be True or False depending on whether the corresponding operation supports override of applicable security access setting from "Update" to "View Only" mode.

Defaults

Operation Text – Override: An override for the operation text. If specified, this value will be used as the text for the button or sub-menu operation when presented on lists. It is mandatory for operations that are not system provided.
Operation Text – Default: The tag code defining the default operation text for this operation. It will be used to retrieve the applicable text in the language of the user's locale. It is applicable only for system provided operations. The value is controlled internally.
Access Method: The method used to trigger the operation: button, sub-menu. It can be modified in Update mode.
Parent Operation ID: When the operation is accessed via a sub-menu, the Parent Operation ID will refer to another operation for the same User Group Screen Element Version. This will refer to either the button or next highest sub-menu operation from which this operation is accessed. It can be modified in Update mode.
Emphasized: Indicates whether the text should be emphasized. It is applicable only for operations representing buttons. A maximum of two buttons per list can be emphasized, one for update mode and the other for view mode. It can be modified in Update mode.

Note: This setting is not applicable to Smartbench.

Sub-Menu Header: Indicates whether the operation represents a sub-menu header.

Note: This field is displayed only when Operation Type is General.

Sequence: The relative sequence number for presentation. All operations at the same level will be organized based on sequence number, with lower numeric values presented first. It can be modified in Update mode. Presentation for operations with the same level and sequence will be determined by the system.
Show Verification Message: Controls whether a verification message will be issued when the operation is requested. It will be applicable only for operations that do not cause browser to navigate to a different page (for example, most delete, cancel, activate, deactivate operations).
View Mode Only: Indicates whether authorization for this operation has been overridden such that users in the user group will be is restricted to View access. This flag is available only for operations where the Allow Override to View Only Mode flag is True for the corresponding System Screen Element Version Operation.

Note: This field is displayed only when Operation Type is General.

Open in New Window: This defines whether the page referenced in the URL will be opened in a new window. It will always be false for system provided functions. It can be modified in Update mode for user created functions.

Note: This field is displayed only when Operation Type is General.

Open in Embedded Dialog: Indicates whether the page referenced in the URL will be opened in an embedded dialog; editable only for screen element version operations that are not system provided.
Notes:
- This setting is applicable only to Smartbench.
- This field is displayed only when Operation Type is General.
Use Post HTTP Method: Post requests submits data to be processed to a specific resource. These requests are never cached, do not remain in browser history, cannot be bookmarked and have no restrictions on data length. It will always be false for system provided functions. It can be modified in Update mode for user created functions.

Note: This field is displayed only when Operation Type is General.