Document

• CreateDocument    1

• CreateTransactionDocuments    1

• CreateTruckVisitDocument    1

• PrintAllDocumentsAtTrouble    1

• PrintAllDocumentsFromScreen    1

• PrintDocument    1

• PrintDocumentAtTrouble    1

• PrintTransactionDocuments    1

CreateDocument

Description

The business task creates and saves a gate document. If you want to create a document that includes the Truck Turn Time and Out Time, include the CreateDocument business task at the last stage, such as the outgate stage, for the gate transaction type. To create a truck routing ticket, see CreateTruckVisitDocument (on page 1).

The N4 Gate API response shows only the FATAL errors as separate messages. To get all the SEVERE error messages in the Gate API response, you must configure a trouble document and include the CreateDocument(on-trouble) business task at the gate stage with Trouble Document Type ID.

Parameters

• docTypeId: Use this parameter to specify the existing document ID that you want to create at the selected gate stage. To create a document ID, see Document form (on page 1).

• executeAtTVLevel: Select the Execute At TV Level check box to print transaction level documents at the truck visit level. For more information, see Create and print gate transaction level tickets at the truck visit level (on page 1) in the Navis N4: Gate Administrator and User Guide.

For more information on setting parameters, see Business Tasks form (on page 1).

Dependencies

You must include the PrintDocument (on page 1) business task to print the gate document created.

Timing

• For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• on-trouble: The business task is executed when the truck is sent to Trouble.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

CreateTransactionDocuments

Description

The business task enables you to create gate transaction level documents at the truck visit level, when a gate stage is completed either through the UI or a gate API. When you use this business task, the gate workflow does not create the gate documents when you complete a gate transaction; instead, it waits until all the gate transactions for a gate stage are completed and then creates the gate transaction level documents when you complete the gate stage.

You may use this business task when you want the gate document to include truck visit level details that are not available when you complete a gate transaction but are available when you complete a gate stage either through the UI or a gate API. Some examples of such information include:

• Transaction sequences

• Gross weight calculated at the truck visit level

• Position returned from XPS through the truck visit level business task - ReplanUnitsIntoYard (on page 1)

Parameters

None

Dependencies

• You must include the CreateDocument (on page 1) and PrintDocument (on page 1) business tasks at the gate transaction level and select the Execute At TV Level check box for each of these business tasks that create and print documents that you want to create and print at the truck visit level instead of at the gate transaction level. For more information see Generate and print gate transaction level tickets at the truck visit level (on page 1) in the Navis N4: Gate Administrator and User Guide.

• You must include the PrintTransactionDocuments (on page 1) business task at the same truck visit level to print the documents that you create at the gate stage level.

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• on-trouble: The business task is executed when the truck is sent to Trouble.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

CreateTruckVisitDocument

The business task creates and saves a gate document for the truck visit details and all of the associated gate transactions details.

You can include the messages for each gate transaction in a truck visit gate document. In the document layout, the messages for a truck visit gate document are in the argo:Messages element located inside the argo:trkTransaction element. In addition, you can use the RouteLayout.xsl as a default document layout for the truck visit gate document.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Gate: Truck Visit IN, Truck Visit OUT

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• on-trouble: The business task is executed when the truck is sent to Trouble.

Client Type(s)

UI and Gate API

Parameters

docTypeId: Specify the existing document ID that you want to create at the selected gate stage. To create a document ID, see Document form (on page 1).

For more information on setting parameters, see Business Tasks form (on page 1).

Dependencies

You must also include the PrintDocument (on page 1) business task to print the gate document created.

Related Business Task(s)

CreateDocument (on page 1)

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

Field(s)

None

PrintAllDocumentsAtTrouble

Sends the latest version of each type of gate document that was created from the start of the truck visit to the GOS. If you include this business task, N4 executes it only when the trouble clerk processes the truck visit.

PrintAllDocumentsFromScreen

Sends a print command to the Gate Operating System (GOS) with the ticket data for all the gate transactions for a truck visit. N4 executes this business task only if the print command is submitted from the N4 interface, the <GateStage> tab (on page 1), or the Trouble Transactions tab (on page 1).

PrintDocument

Description

The business task prompts a user to select a printer to print a gate document.

If the PrintDocument business task is submitted from the screen, it prints directly and not via the GOS. However, if the PrintDocument business task is submitted via a Web Service request, it assumes that a GOS is present and does not attempt to print directly.

Parameters

• docTypeId: Specify the existing document ID that you want to create at the selected gate stage. To create a document ID, see Document form (on page 1).

• noOfCopies: Enter a pre-determined number to set the default number of copies that is displayed in the Print Tickets form (on page 1). This value is displayed in the No. Of Copies field and represents the number of gate tickets to be printed. However, the user can change this number in the Print Tickets form.

If you use the Gate API to print the ticket, you can specify the number of copies to be printed in the no-of-copies attribute of the document element. For more information about the attribute, see the gate-types.xsd file on your application server.

• displayPopup: Determines whether N4 must display the Print Tickets form or not.

• executeAtTVLevel: Select the Execute At TV Level check box to print transaction level documents at the truck visit level. For more information, see Create and print gate transaction level tickets at the truck visit level (on page 1) in the Navis N4: Gate Administrator and User Guide.

For more information on setting parameters, see Business Tasks form (on page 1).

Dependencies

If you include PrintDocument business task, you must include the CreateDocument (on page 1) or CreateTruckVisitDocument (on page 1) business tasks that creates the gate document that you want to print.

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• on-trouble: The business task is executed when the truck is sent to Trouble.

To print a trouble ticket when the truck visit itself has an error and needs to be sent to the trouble desk, you must include the business task for the on-trouble timing.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

PrintDocumentAtTrouble

Use this business task only for an automated gate. The PrintDocumentAtTrouble business task is similar to the PrintDocument (on page 1) business task except that it prints the gate document only when submitted by the clerk at the trouble stage. In addition, the business task sends the document as an XML to the GOS via a Web Service call.

docTypeId: Use this parameter to specify the existing document ID that you want to create at the selected gate stage. To create a document ID, see Document form (on page 1).

For more information on setting parameters, see Business Tasks form (on page 1).

If a document is printed as part of the normal flow and not by the trouble clerk, N4 assumes that the printing is handled by the GOS from data provided in response to GOS requests.

PrintTransactionDocuments

Description

The business task enables you to print gate transaction level documents at the truck visit level, when a gate stage is completed either through the UI or a gate API. When you use this business task, the gate workflow does not print the gate documents when you complete a gate transaction; instead, it waits until all the gate transactions for a gate stage are completed and then prints the gate transaction level documents when you complete the gate stage.

You may use this business task when you want the gate document to include truck visit level details that are not available when you complete a gate transaction but are available when you complete a gate stage either through the UI or a gate API. Some examples of such information include:

• Transaction sequences

• Gross weight calculated at the truck visit level

• Position returned from XPS through the truck visit level business task - ReplanUnitsIntoYard (on page 1)

Parameters

None

Dependencies

• You must include the CreateDocument (on page 1) and PrintDocument (on page 1) business tasks at the gate transaction level and select the Execute At TV Level check box for each of these business tasks that create and print documents that you want to create and print at the truck visit level instead of at the gate transaction level. For more information see Generate and print gate transaction level tickets at the truck visit level (on page 1) in the Navis N4: Gate Administrator and User Guide.

• You must include the CreateTransactionDocuments (on page 1) business task at the same truck visit level to create the documents that you want to print at the gate stage level.

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• on-trouble: The business task is executed when the truck is sent to Trouble.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.