1. Customs Filing Integration Guide
  2. Document Generation

Document Generation

If it is determined, based on running compliance rules on a declaration, that a document is required, you can generate the document for the declaration by running the Generate Document action. When this action is run, Global Trade Management Cloud retrieves all the information required to generate the document content, validates this information using the validation rules defined for the document type, and invokes the document creation mechanism. Documents can be created via tools such as Oracle Analytics Publisher.

Global Trade Management Cloud ships with default templates to generate using Oracle Analytics Publisher, EDI formatted export declaration documents that can be filed with the US Census via AES. To use these templates to generate EDI filing documents, the following properties must be set up.

To specify AES authentication details:

gtm.aes.param.P_TRANSMITTER_ID
gtm.aes.param.P_COMMUNICATION_PASSWORD_ID
gtm.aes.param.P_FILER_ID

Optionally if the Transmitter ID and Filer ID can vary on a transactional basis, they can be configured on each shipment. Global Trade Management Cloud will first look at the shipment to see if a Transmitter and/or Filer is specified as an Involved Party. If so, Global Trade Management Cloud will use the reference number on the associated Involved Party to populate the Transmitter ID and Filer ID. The Involved Party Qualifiers and Reference Number Qualifiers expected are listed in the Appendix. If the Involved Parties or the Reference Numbers are not present, Global Trade Management Cloud will use the values in the properties when generating the EDI filing document.

To indicate whether sample test data or actual export information is being sent:

gtm.aes.param.P_IS_PRODUCTION

To indicate the quantity qualifier ID and currency qualifier ID that should be reported:

gtm.aes.param.P_REPORTING_QUANTITY (default=ORDERED)
gtm.aes.param.P_REPORTING_CURRENCY (default=TOTAL VALUE)

To indicate the reference numbers and time zone that should be reported:

gtm.aes.param.P_REPORTING_REFERENCE_NUMBER (default=BN)
gtm.aes.param.P_REPORTING_REPORTING_FOREIGN_ENTITY(default=FOREIGN ENTITY)
gtm.aes.param.P_REPORTING_TIMEZONE (default=US/Eastern)

To indicate the classification code type that should be reported:

gtm.aes.param.P_CLASSIFICATION_CODE_TYPE (default=HTS US)

To indicate whether an alternate code type can be reported:

gtm.aes.param.P_ALLOW_ALTERNATE_CODE_TYPE (default=YES)

AES allows you to report the HTS or Schedule-B codes when filing export declarations. By setting the above properties, you can configure which code type to report and whether Global Trade Management Cloud can report an alternate code type. This means that if a user prefers to report the HTS codes and there is either no HTS code on the declaration line or if the HTS code is not reportable, then Global Trade Management Cloud will report a Schedule-B code.

To indicate the license value that must be reported: 

gtm.aes.param.P_REPORTING_LICENSE_VALUE

To generate the filing document, Global Trade Management Cloud iterates through all the declaration lines and selects those lines that have been marked, during report determination, with control types and control codes specific to the regime associated with the document type. Declaration lines that need to be included in the filing document have a control type in the Reporting Results grid in the Declaration Line manager in the UI.

Once all the information is retrieved, the document generation mechanism invokes a callback helper process. This callback helper process essentially performs miscellaneous tasks such as validating the statuses before and after document generation, plus any additional pre and post document generation tasks specific to the document type. For AES, Global Trade Management Cloud has defined a specific callback process AESFilingCallback that is associated with the AES_FILING document type. You can use the AES_FILING document type or you can create your own document types. However, any document type created for the purpose of creating a filing document that will be filed via AES must use the AESFilingCallback process. The document type to the callback helper processassociation is defined via the following property.

glog.reqdoc.reqdocCallbacks.<DOCUMENT_TYPE>=<callback-helper-java-class>

By default, the property is set as follows to indicate that AES_FILING document type is associated to the callback gtm.server.agent.business.transaction.AESFilingCallback.

glog.reqdoc.reqdocCallbacks.AES_FILING=gtm.server.agent.business.transaction.AESFilingCallback

The AESFilingCallback does the following:

  • Validates the statuses before generating the document.
  • Sets the status after generating the document.
  • Creates the filing reference numbers for the declaration lines.
  • Creates a tracking number for the filing document.

Global Trade Management Cloud tags the filing document with a tracking number which is returned in the filing response, allowing Global Trade Management Cloud to match a filing response back to the original filing document.

Documents generated for the declaration are listed on the Documents tab of the Declaration manager. You can view the generated document content and document statuses via the Document Manager.