GTM Declaration Agent Actions

Note: Customs Shipment and Customs Shipment Line have been renamed as Declaration and Declaration Line, respectively. However, this change will not impact the Agent Type drop-down list. "GTM Shipment", "GTM Shipment Document", and "GTM Shipment Line" will continue to be displayed as options in this list.

This page is accessed via Business Process Automation > Agents and Milestones > Automation Agent.

If you select GTM SHIPMENT in the Agent Type field and do not select anything in the Data Type Association field, the agent actions listed here are available.

To use agent actions from other agent types (business objects), select the appropriate data type association. By selecting a data type association, an automation agent of one agent type (business object) can run related agent actions of a different agent type (business object). For example, an automation agent with a shipment agent type can run agent actions available for the order release agent type. To do this, select a data type association of SHIPMENT TO ORDER RELEASE.

Action	Description
Ad Hoc Notify Contact	This is a utility agent action. See Ad Hoc Notify Contact.
Allocate Charges by Value	Customs filing processes require that the weight and value of each declaration be accurately understood and reported. Both the value and weight information must exist at the declaration level or errors will result when the records are processed. This page lets you specify both values. When this action is run on a declaration, it can help calculate costs that need to be sent to AES. Additionally, this action calculates charges that are also required to estimate landed costs for a transaction. Parameters: Quantity Qualifier ID Value Qualifier ID
Allocate Charges by Weight	Customs filing processes require that the weight and value of each declaration be accurately understood and reported. Both the value and weight information must exist at the declaration level or errors will result when the records are processed. This page lets you specify both IDs. When this action is run on a declaration, it can help calculate costs that need to be sent to AES. Additionally, this action calculates charges that are also required to estimate landed costs for a transaction. Parameters: Quantity Qualifier ID Value Qualifier ID
Allocate Weight by Value	Customs filing processes require that the weight and value of each declaration be accurately understood and reported. Both the value and weight information must exist at the declaration level or errors will result when the records are processed. This page lets you specify both values. When this action is run on a declaration, it can help calculate costs that need to be sent to AES. Additionally, this action calculates charges that are also required to estimate landed costs for a transaction. Parameters: Quantity Qualifier ID Value Qualifier ID
Assign Classification To Customs Shipment Line	This agent action will assign the designated product classification to the declaration line. Access this action by selecting the "GTM Shipment to GTM Shipment Line" Data Type Association. Parameters: Classification Type Classification Code
Assign Policy	This agent action will assign the designated policy to the declaration. Parameters: Policy Policy Qualifier ID
Assign Variable	This is a utility agent action. See Assign Variable.
Call Service	This is a utility agent action. See Call Service.
Convert Customs Shipment UOMs	This agent action converts the existing UOM to the designated UOM after looking for and finding a match for the selected product classification type and quantity qualifier. The agent action first looks for a conversion rate between the source and target UOMs at the item level. If no conversion rate is found at the item level, the action will look for a conversion rate in the UOM table. If no conversion rate is found at either location, the action will fail and an appropriate error message will be displayed. It also supports conversion of duty rate UOM attributes for tax callout to a third party data provider for the purpose of calculating duties and taxes. Also see Convert UOMs. Parameter: Product Classification Type Quantity Qualifier ID Convert to REPORTING UOM 1 and REPORTING UOM 2 Convert to DUTY RATE UOM 1, DUTY RATE UOM 2, DUTY RATE UOM 3, DUTY RATE UOM 4, and DUTY RATE UOM 5
Copy Flexfields	This is a utility agent action. See Copy Flexfields.
Copy Flexfields To	This is a utility agent action. See Copy Flexfields To.
Copy Involved Parties from Customs Shipment	This is a utility agent action. See Copy Involved Parties from <object>.
Copy Involved Parties from Underlying Object	This agent action allows you to copy involved parties from the underlying object for which the agent is triggered to the related object. Parameters: InvParty Qualifier Line InvParty Qualifier
Copy Involved Parties to Customs Shipment	This is a utility agent action. See Copy Involved Parties to <object>.
Copy Refnums from Customs Shipment	This is a utility agent action. See Copy Refnums from <object>.
Copy Refnums from Underlying Object - Shipment	This agent action allows you to copy reference numbers from the underlying object to the related object for which the agent is triggered. Parameters: Shipment Reference Number Qualifier Shipment Line Reference Number Qualifier Order Release Reference Number Qualifier Order Release Line Reference Number Qualifier
Copy Refnums to Customs Shipment	This is a utility agent action. See Copy Refnums to <object>.
Copy Remark from Underlying Object - Shipment	This agent action allows you to copy remarks from the underlying object to the related object for which the agent is triggered. Parameters: Remark Qualifier Line Remark Qualifier ID
Copy Remarks from Customs Shipment	This is a utility agent action. See Copy Remarks from <object>.
Copy Remarks to Customs Shipment	This is a utility agent action. See Copy Remarks to <object>.
Create Declarations	Use this action to consolidate and then aggregate declarations into declarations, based on a selected declaration type. You can also use this agent action to add more declarations to an existing declaration. For details, see Create/Add to Existing Declarations. Parameter: Declaration type Add to Existing Declarations
Determine Policy	Use this agent action to identify applicable compliance policies.. Also see Determine Policy. Parameter: Compliance Rule Set Group ID
Direct SQL Update	This is a utility agent action. See Direct SQL Update.
Dont Persist	This is a utility agent action. See Dont Persist.
Else	This is a utility agent action. See Else.
Elseif	This is a utility agent action. See Elseif.
Estimate Distance	This is a utility agent action. See Estimate Distance.
Estimate Duty and Taxes	Use this agent action to send shipment information to a third party data provider and obtain duty and tax values for a declaration or a declaration line. Also see Estimate Duty and Taxes.
Execute Compliance Screening	Use this agent action to screen declarations against the selected compliance rule set group. Parameter: Compliance Rule Set Group ID
Execute Policy	Use this agent action to run all screening services specified in the compliance policy in the order in which they are listed. Parameters: Policy ID Policy Qualifier ID
File Customs	Use this agent action to send documents to the Automatic Export Service (AES). Also see File Customs. Parameters: Document Type Communication Method External System Resubmit
Finalize Standard Document	Finalizes the latest revision for the standard document. The document is placed in a FINAL state. Parameter: Document Type
For	This is a utility agent action. See For.
For Each	This is a utility agent action. See For Each.
Generate Declaration Message	Use this agent action to generate declaration message for a declaration. See Generate Declaration Message. Parameters: Out XML Profile Refnum to Copy from Declaration
Generate Refnum	This is a utility agent action. See Generate Refnum.
Generate Standard Document	Generates content for a standard document using the associated reporting engine and attaches it to a new revision for the document. Any review workflow is reset to require all reviewers to accept the revised document. Parameters: Document Type Annotation
If	This is a utility agent action. See If.
Lock	This is a utility agent action. See Lock.
Log	This is a utility agent action. See Log.
Log to Transmission Report	This is a utility agent action. See Log to Transmission Report.
Look Up Classification	Use this agent action to determine the classification status of the products included in a selected transaction. See the Product Classification Lookup Action. Parameters: Service Preference ID
Look Up Trade Program - GTM Shipment	Use this action to copy item information over to transaction line/declaration line. Parameters: Constraint Set ID
Mark Object for Delete on HD	This allows you to unload (soft delete) data from the historical database (HD) for the GTM declaration. This agent action is intended for use with Global Trade Intelligence. See the Data Flow to Global Trade Intelligence - Unload Data from HD help topic for complete details. This action must be added to an automation agent listening for the GTM SHIPMENT - REMOVED agent event. This agent action is included in the PUBLIC automation agent MARK GTM CUSTOM SHIPMENT ON HD AS DELETE.
Match Exits to Entries - GTM Shipment	Use this agent action to record inventory exit movement of a declaration against a trade incentive program. (Also see Match Exits to Entries.)
Notify Contact	This is a utility agent action. See Notify Contact.
Notify Document Reviewers	Notifies all document reviewers via their preferred communication method. If the subject is specified, the reviewers are notified of an ad-hoc event; otherwise, they are notified of the event that triggered the agent. Parameters: Document Type Subject
Notify Document Subscribers	Notifies all document subscribers via their preferred communication method. If the subject is specified, the subscribers are notified of an ad-hoc event; otherwise, they are notified of the event that triggered the agent. Parameters: Document Type Subject
Notify Involved Party	This is a utility agent action. See Notify Involved Party.
Persist	This is a utility agent action. See Persist.
Prepare Document	This is a utility agent action. See Prepare Document.
Print Document	This is a utility agent action. See Print Document.
Propagate Changes to Declarations	Use this action to sync declarations with any data modified on a declaration. For details, see Propagate Changes to Declarations.
Queue Event	This is a utility agent action. See Queue Event.
Raise Error	This is a utility agent action. See Raise Error.
Raise Event	This is a utility agent action. See Raise Event.
Raise Internal Event	This is a utility agent action. See Raise Internal Event.
Record Entries into Programs - GTM Shipment	Use this agent action to record inventory entry movement of a declaration against a trade incentive program. (Also see Record Entries into Programs.)
Remove from Declarations	Use this action to remove a declaration from a declaration. See Remove Transactions/Declarations from Declarations. Parameters: Saved Query Remove Empty Declaration
Remove Standard Document	Remove the latest revision for a given standard document on the business object. Parameter: Document Type
Schedule Event	This is a utility agent action. See Schedule Event.
Screen Restricted Parties	Screens to determine if party is restricted. Parameters: GTM Service Preference
Send Document Sets	This agent action follows the same logic as the web action Send Documents with the option of sending document sets. Note: The agent action will check if the given document sets are assigned to the business object. If not, the agent action fails and will not send the document sets to the user. Also, if any document set is not provided in the agent action, it fails. Parameter: Document Set
Send Integration	This is a utility agent action. See Send Integration.
Send Standard Document	Sends out the latest revision content to either a contact, an ad-hoc email address, or an IPP printer. Parameters: Document Type Reply To Contact Communication Method E-Mail Address Printer Number of Copies Page Ranges
Set Customs Shipment Filing State	Use this agent action to set statuses for customs documents. Also see Set Customs Shipment Filing State. Parameters: Document Type Status Value
Set Indicator	This is a utility agent action. See Set Indicator.
Set Internal Status	This is a utility agent action. See Set Internal Status.
Set Request Status	Use this agent action to set status group and status code for the request sent for filing a declaration with customs. Also see Set Request/Response Status. Parameters: Status Group ID Status Code ID
Set Response Status	Use this agent action to set status group and status code for the response received for filing a declaration with customs. Also see Set Request/Response Status. Parameters: Status Group ID Status Code ID
Set Standard Document Parameter	Sets an ad-hoc parameter value on the latest version of the standard document. Forwards the parameter to the CMS. If the parameter value is populated, the action adds or replaces the value for the specified parameter. Otherwise, the action removes the parameter. Parameters: Document Type Name Value
Set Status	This is a utility agent action. See Set Status.
Set User Defined Image	This is a utility agent action. See Set User Defined Image.
Stop	This is a utility agent action. See Stop.
Sum Quantity and Value Line to Header	Use this action to sum quantity and value information from declaration lines to the declaration header. See Sum Quantity and Value Line to Header. Parameters: Quantity and Value Configuration ID
Sum Quantity and Value to Header	Use this action to sum quantity and value information to the declaration header. See Sum Quantity and Value on Header. Parameters: Quantity and Value Configuration ID
Synchronize Data	Use this agent action to synchronize trade transactions with the underlying shipment/order release records. Parameters: Remark Reference Number Involved Party
Unfinalize Standard Document	Unfinalizes the latest revision for the standard document. The document reverts to a REVIEW state, if previous revisions are available; to a PREVIEW state, otherwise. Parameter: Document Type
Update Classification Code	See Update Classification Code action.
Update Standard Document Parameters	Reevaluates document parameters for the latest revision of the document type. Updates document parameter values and forwards them to the content management system. Parameters: Document Type
Verify Classification	Use this agent action to verify that a product classification is accurate and correct for the current data version. See the Verify Classification action. Parameters: Service Preference ID
Wait	This is a utility agent action. See Wait.

GTM Declaration Agent Actions

Related Topics