GTM Transaction Agent Actions

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 transaction  be accurately understood and reported. Both the value and weight information must exist at the transaction level or errors will result when the records are processed. This page lets you specify both values.

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 transaction be accurately understood and reported. Both the value and weight information must exist at the transaction level or errors will result when the records are processed. This page lets you specify both IDs.

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 transaction be accurately understood and reported. Both the value and weight information must exist at the transaction level or errors will result when the records are processed. This page lets you specify both values.

Additionally, this action calculates charges that are also required to estimate landed costs for a transaction.

Parameters:

Quantity Qualifier ID

Value Qualifier ID

Assign License to Transaction

This agent action will assign licenses to lines contained in the transaction.

Assign Policy

This agent action assigns a compliance policy to a transaction.

Assign Variable

This is a utility agent action. See Assign Variable.

Call Service

This is a utility agent action. See Call Service.

Convert Trade Transaction 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 Data from Transaction

Use this action to copy different sets of sales information from a Sales Order (Transaction Type) to a Shipment (Transaction Type), and quickly build the necessary data with shipment as the base trade document for customs declaration and/or filing. Specific information like sales order details, sales price, Incoterms, involved parties (for example customer, consignee), ship from facility, legal entity, end use, and other tax determinates (for example specific involved parties, reference numbers, remarks, values, quantities, user-defined codes, ports etc.) can be copied from one transaction to another. Also see Copy Data from Transaction.

Parameters:

Data Config ID

Saved Query

Copy Data from Transaction Lines

Use this action to copy different sets of sales information from a Sales Order Line (Transaction Line Type) to a Fulfillment Line or Shipment Line (Transaction Line Type), and quickly build the necessary data with shipment line as the trade document for customs declaration and/or filing. Specific information like reference numbers, remarks, values, quantities, user-defined codes, Incoterms and Incoterm locations, percentages, country of origin, country of manufacture, involved parties, product classification, etc. can be copied from one transaction line to another. Also see Copy Data from Transaction Lines.

Parameters:

Data Config ID

Saved Query

Copy from Preceding Transaction Line

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 GTM Transaction

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 GTM Transaction

This is a utility agent action. See Copy Involved Parties to <object>.

Copy Refnums from GTM Transaction

This is a utility agent action. See Copy_Refnum_from_<object>_

Copy Refnums from Underlying Object -  Transaction

This agent action allows you to copy involved parties from the underlying object for which the agent is triggered to the related object.

Parameters:

Shipment Reference Number Qualifier

Shipment Line Reference Number Qualifier

Order Release Reference Number Qualifier

Order Release Line Reference Number Qualifier

Copy Refnums to GTM Transaction

This is a utility agent action. See Copy Refnums to <object>.

Copy Remark from Underlying Object -  Transaction

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 GTM Transaction

This is a utility agent action. See Copy Remarks from <object>.

Copy Remarks to GTM Transaction

This is a utility agent action. See Copy Remarks to <object>.

Create Declarations

Use this action to consolidate and then aggregate trade transactions into declarations, based on a selected declaration type. You can also use this agent action to add more transactions 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.

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 action to send shipment information to a third party data provider and obtain duty and tax values for a trade transaction or a trade transaction line.

Execute Compliance Screening

Use this agent action to screen transactions against the selected compliance rule set group.

Parameter:

Compliance Rule Set Group ID

Execute Policy

Use this action to run all screening services specified in the compliance policy in the order in which they are listed.

Parameter:

GTM Compliance Policy or Policy Qualifier.

Finalize Standard Document

Finalizes the latest revision for the standard document. The document is placed in a FINAL state.

Parameters:

Document Type

For

This is a utility agent action. See For.

For Each

This is a utility agent action. See For Each.

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 copy product classification data. See the Look Up Product Classification action.

Parameters:

Service Preference ID

Look Up Country of Origin

Use this agent action to  look up and assign the country of origin of the item associated with the trade transaction.

Note: The agent action will run based on the parameters configured in GTM Logic Configuration and GTM Transaction Configuration.

Look Up Trade Program - GTM Transaction

Use this agent action to copy item information over to transaction line/declaration line.

Note: The agent action will run based on the parameters configured in GTM Logic Configuration and GTM Transaction Configuration.

Mark Object for Delete on HD

This allows you to unload (soft delete) data from the historical database (HD) for the GTM transaction. 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 TRANSACTION - REMOVED agent event.

This agent action is included in the PUBLIC automation agent MARK GTM TRANSACTION ON HD AS DELETE.

Match Exits to Entries - GTM Transaction Line

Use this agent action to record entry and exit of a trade transaction line 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 the declarations with any data modified on a trade transaction. 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.

Use this agent action to record inventory entry movement of a trade transaction against a trade incentive program.

(Also see Record Entries into Programs.)

Re-Evaluate License on Transaction

Use this action to evaluate a license existing on an associated transaction line by taking into account any data modification done on the line. See Re-Evaluate License.

Remove from Declarations

Use this action to remove a trade transaction from a declaration. The agent action iterates over all the transaction lines of the trade transaction to execute the action. (Also see Remove Transactions/Declarations from Declarations.)

Parameters:

Saved Query

Note: If you don't provide a saved query, the application removes the transaction line from all the related declaration lines using an SQL as follows: 
select gtm_transaction_gid as decl_gid from gtm_transaction_line declLine 
where declLine.gtm_transaction_line_gid in (select gtm_transaction_line_gid 
from gtm_trans_line_reference gtlr where gtlr.trans_line_ref_gid =? )
You can provide a saved query to remove the transaction line from specific types of declaration. When the saved query is provided, it is executed on the transaction line and fetches the related declaration from which the transaction line needs to be removed. This saved query should be of type GtmShipmentQuery (GTM_SHIPMENT), and it should take a GTM_TRANSACTION_LINE_GID as an input. This saved query should be similar to the above SQL with some additional critieria.

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

This agent action performs restricted party screening on all the parties of the trade transaction and all its lines. Then for each trade transaction line, the action:

1. Sets status TL_RPLS=TL_RPLS_FAILED, if status of one of the parties is RPLS_FAILED.

2. Sets status TL_RPLS=TL_RPLS_PASSED, if status of all the parties is RPLS_PASSED.

3. Otherwise sets status TL_RPLS=TL_RPLS_REQUIRES_REVIEW.

Then it sets trade transaction status as follows:

1. TS_RPLS=TS_RPLS_FAILED, if status of one of the trade transaction lines is TL_RPLS_FAILED.

2. TS_RPLS=TS_RPLS_PASSED, if status of all the trade transaction lines is TL_RPLS_PASSED.

3. Otherwise TS_RPLS=TS_RPLS_REQUIRES_REVIEW.

Note: You can define the gtm.rps.involved_party_qual.exclude property with comma separated involved party qualifiers to exclude corresponding involved parties from restricted party screening and the above-mentioned status consideration.

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 Indicator

This is a utility agent action. See Set Indicator.

Set Internal Status

This is a utility agent action. See Set Internal Status.

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 lines to the 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 shipment header. See Sum Quantity and Value on Header.

Parameters:

Quantity and Value Configuration ID

Synchronize Data

Use this action to synchronize trade transactions with the underlying shipment/order release records.

Parameters:

Remark

Reference Number

Involved Party

Unassign License from Transaction

Use this action to unassign licenses which have been associated with transactions.

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.

Parameters:

Document Type

Update Classification Code

Use this action to synchronize an item's classification codes to new codes which might have uploaded during a data load.

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 action to verify that a product classification is accurate and correct for the current data version.

Wait

This is a utility agent action. See Wait.