Creates a work instruction in XPS to plan a departing unit onto a truck at the ingate stage. If there is no ingate stage for delivery gate transactions, you can include this business task at the outgate stage.
Use this business task only for XPS operations.
If you include this business task, ensure that the PlaceUnitOnTruck (on page 1) business task is excluded for the gate transaction type.
Include the ConfirmDelivery business task at the same gate stage or subsequent gate stage as the Select business tasks, such as SelectEmptyContainer for delivering an empty container. In other words, N4 must select the unit prior to confirming it.
The ConfirmDelivery business task uses the following parameters (on page 1):
allowMenWorking indicates if work instructions are allowed where men are working. When set to Y, the truck must wait at the next gate stage until the men working stack status flag is cleared by yard operations.
The default setting rejects gate transactions assigned to logical blocks where men are working.
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
The ConfirmDelivery business task sets the transit state of the unit as EC/Out.
|
Gate stage |
|
Deliver Break-Bulk (DB) Deliver Chassis (DC) Dray Off (DE) Deliver Import (DI) Deliver Empty (DM) |
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Deliver Empty (DM) and Dray Off (DE) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
ConfirmSwappedDelivery (on page 1) PlanSwappedContainerToYard (on page 1) |
|
Field(s) |
None |
Description
Creates a work instruction for XPS to pull the new empty container from the stack.
Parameters
The ConfirmSwappedDelivery business task uses the following parameters:
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
We recommend that you use a special work queue, other than the road queue, to swap containers.
Dependencies
If you include the ConfirmSwappedDelivery business task, you must also include the PlanSwappedContainerToYard (on page 1) business task.
Include this business task only if you use Equipment Control. If you process the swap stage manually, use the ReturnSwappedContainerToYard (on page 1) business task.
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).
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).
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.
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Deliver Empty (DM) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
AdviseXpsTbdEmptyDelivery (on page 1) |
|
Field(s) |
None |
Description
The business task creates a work instruction in XPS to plan a TBD Unit onto a truck at the ingate stage. If there is no ingate stage for delivery gate transactions, you can include this business task at the outgate stage.
The business task also sets the transit state of the unit as EC/Out.
Parameters
allowMenWorking indicates if work instructions are allowed where men are working. When set to Y, the truck must wait at the next gate stage until the men working stack status flag is cleared by yard operations.
The default setting rejects gate transactions assigned to logical blocks where men are working.
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
Dependencies
Include this business task only for XPS operations.
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).
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.
|
Functional Area |
Gate |
|
Execution Level |
Truck Visit |
|
Transaction Type(s) |
Truck Visit OUT |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
None |
|
Field(s) |
None |
Description
The business task sends a message to XPS with the container number of the actual container being delivered at the outgate. This container may be different from the one assigned to the truck visit at an ingate stage (especially during a Deliver Empty (DM) gate transaction).
After XPS receives the container information, it:
Reverts any work instructions (WIs) that were originally related to the truck visit but are no longer valid because a different container was delivered.
Sets the Move Kind of the container that was reverted as Other and returns the container to its original location.
You must include this business task only at the final outgate stage after which nothing else may change.
Parameters
None
Dependencies
For this business task to work, you must include the following business tasks at one of the ingate stages:
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:
pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.
N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.
If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.
on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.
The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage. When a user clicks Confirm Arrival, it also triggers the TV_ITZ_LANE_ARRIVAL EC event.
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).
validation: The business task is executed when a truck visit is created after successful execution of the pre-stage business tasks, but before the execution of the on-submit business tasks.
If a validation business task fails, N4 creates the truck visit and allows the user to send the truck visit to Trouble to be resolved later.
on-trouble: The business task is executed when the truck is sent to Trouble.
area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.
This gate work flow is executed when either of the following conditions is true:
N4 receives an area-done message through the API.
A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.
As the final step in a process-truck API message when all transactions have been submitted.
Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.
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.
The business task sends the notify-resume message to the Gate Operating System (GOS) when you successfully complete a gate stage by clicking the Proceed to Next Stage button on a gate form.
If there are any errors in the workflow, the business task does not send the notify-resume message.
Functional Area
Gate
Execution Level
Truck Visit
Transaction Type(s)
Truck Visit IN, Truck Visit OUT
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
None
Related Business Task(s)
None
Custom Code
None
Field(s)
None
Sends a message to XPS with the exchange lane assignment from the AssignExchangeLane (on page 1) business task.
Include this business task only for straddle operations and only at the last ingate stage, if more than one ingate stage exists.
|
Gate stage |
|
Deliver Chassis (DC) Dray Off (DE) Deliver Import (DI) Deliver Empty (DM) Receive Break-Bulk (RB) Receive Export (RE) Dray In (RI) Receive Empty (RM) |
|
Functional Area |
Gate |
|
Execution Level |
Truck Visit |
|
Transaction Type(s) |
Gate: Truck Visit IN |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
None |
|
Field(s) |
None |
Description
When you include this business task, FORM_VVD_CRANE_STATS sends a message to XPS with the gate transaction sequence numbers from the SequenceTransactions (on page 1). Also, N4 sends the updated position on truck value along with sequence number to XPS. XPS updates the POS field in the Work Queue window accordingly.
Parameters
None
Dependencies
None
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).
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.
Creates a work instruction to plan a full container arriving by inter-facility transfer, out of a shared yard block and into the next facility's yard. Include this business task for XPS operations only.
The PlanIFTUnitToYard business task uses the following parameters (on page 1):
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
yardBlockId: To specify the ID of the yard block to which XPS plans the unit. This parameter also enables you to plan IFT moves to logical blocks, such as the EC logical block. If XPS is able to find a valid slot for the yard block ID specified in this parameter, it plans the move to this slot. Otherwise, XPS uses yard allocations to find a specific position.
If you do not specify an existing work queue, XPS generates the work instruction for yard-server.
|
IFT stage |
|
Deliver Import (DI) Receive Export (RE) |
The business task creates a work instruction for XPS to return the empty container, originally assigned to a truck driver, to the yard if the truck driver wants to exchange the assigned empty container with another empty container before exiting the terminal.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Deliver Empty (DM), Deliver Import (DI)
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).
Client Type(s)
UI and Gate API
Parameters
The PlanSwappedContainerToYard business task has the following parameters:
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
We recommend that you use a special work queue, other than the road queue, to swap containers.
rejectGroup: Reject a container swap if the selected container belongs to the specified group.
Dependencies
You must include this business task only if you use Equipment Control. If you process the swap stage manually, use the ReturnSwappedContainerToYard (on page 1) business task.
In addition, if you include the PlanSwappedContainerToYard business task, you must also include the ConfirmSwappedDelivery (on page 1) business task.
Related Business Task(s)
ConfirmSwappedDelivery (on page 1)
ReturnSwappedContainerToYard (on page 1)
SelectEmptyContainerForSwap (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
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
SequenceTransactions (on page 1) |
|
Field(s) |
None |
Description
The business task creates a work instruction to plan a unit, arriving at the ingate, into the yard. When this business task is executed, XPS returns the exchange area ID associated with the position in N4.
If you also include the SequenceTransactions (on page 1) business task, when the gate stage is completed, N4 sorts the gate transactions in the order in which they must be executed and assigns a sequence number to each gate transaction.
Parameters
The business task uses the following parameters (on page 1):
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
Use the truckPosition parameter to specify the logical block queue where XPS must position the truck visit. For more information on setting parameters, see Business Tasks form (on page 1).
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
To configure a work queue to auto-complete road receivals to wheels, where there is no equipment to handle the move, set the workQueue parameter to WHEELS. For more information, see Configure work queues to auto-complete in the Navis N4: Equipment Control Administrator and User Guide.
defaultPositionId: Specify a default location for all received units. This enables you to continue gate processing even when XPS is down.
Dependencies
You must include this business task for XPS operations only.
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).
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.
The business task updates the position of the truck visit. If your gate configuration includes more than one ingate stage, you must include this business task only at the last ingate stage.
Functional Area
Gate
Execution Level
Transaction/Truck Visit
Transaction Type(s)
Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Truck Visit IN, Truck Visit OUT
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).
area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.
This gate work flow is executed when either of the following conditions is true:
N4 receives an area-done message through the API.
A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.
As the final step in a process-truck API message when all transactions have been submitted.
Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.
Client Type(s)
UI and Gate API
Parameters
Since the PositionTruckVisit business task is available for gate transactions and truck visits, the purpose of the truckPosition parameter varies.
For gate transactions, truckPosition defines where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate are:
LANE.X or GRIDQ for straddle operations
TQ for non-straddle operations
For truck visits, truckPosition defines where XPS should place the truck after the specific truck visit is successfully processed, enter an existing logical block in XPS per the configuration of your settings.xml file for the truckPosition parameter.
Generally, the setting is:
TIP at the ingate
OUT at the outgate
Regardless of gate stage, the truckPosition parameter is applicable only for XPS operations.
For more information on setting parameters, see Business Tasks form (on page 1).
Dependencies
Typically, for a receive gate transaction type, set the truckPosition parameter to the same value as the PlanUnitIntoYard (on page 1) business task and for a deliver gate transaction type, set the truckPosition parameter to the same value as the SelectImportContainer (on page 1), SelectEmptyContainer (on page 1), or SelectExportContainer (on page 1) business task.
If you have selected the Check If All Done check box at the outgate stage, you must include the business task for the area-done timing PositionTruckVisit (area-done) with the truckPosition parameter set as OUT, in addition to including the business task at the on-submit timing with the truckPosition parameter set as OUT. This ensures that the truck visit is processed correctly and the unit position is updated in XPS.
Related Business Task(s)
None
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
Sends a request to XPS to select an empty container based on the equipment order (booking, EDO, ERO) requirements.
The SelectEmptyContainer business task uses the following parameters:
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
Ignore an empty with a yard to yard plan: This check box indicates on whether XPS should pick a container with a yard to yard plan
If you select the Ignore an empty with a yard to yard plan check box, XPS does not pick a container with a yard to yard plan.
If you do not select the Ignore an empty with a yard to yard plan check box, XPS picks a container with a yard to yard plan. Default value.
For more information on setting parameters, see Business Tasks form (on page 1).
As a result of calling this business task, XPS returns the exchange area ID associated with the position in N4. If you also include the SequenceTransactions (on page 1) business task, when the gate stage is completed, N4 sorts the gate transactions in the order in which they must be executed and assigns a sequence number to each gate transaction.
|
Gate stage |
|
Deliver Empty (DM) |
Sends a request to XPS to select an empty container when a truck driver decides the exchange the assigned empty container with another empty container in the yard. Typically, containers are requested for a specific container operator, booking/order, and booking item.
To request empty containers in good condition, you can specify a container grade in the Grade field in the gate form. In this case, N4 selects an empty container for the specified grade.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Deliver Empty (DM)
Client Type(s)
UI and Gate API
Parameters
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
We recommend that you use a special work queue, other than the road queue, to swap containers.
setExchangeAreaIfNotNull: When you set this parameter to true, when you swap a container, N4 saves the new values for the exchange area and lane at the truck visit level and displays the same in XPS and at the yard stage.
If you do not set the ‘setExchangeAreaIfNotNull’ parameter or set it to false, when you swap a container, N4 updates the new values for the exchange area and lane at the truck visit level but displays an error message and does not save the new exchange area and lane in XPS or at the yard stage.
Dependencies
None
Related Business Task(s)
ConfirmSwappedDelivery (on page 1)
PlanSwappedContainerToYard (on page 1)
ReturnSwappedContainerToYard (on page 1)
Custom Code
None
Field(s)
Grade
The business task sends a request to XPS to select a dray-off export container for the specified export release number and equipment type, if provided. An export release number can be an export booking or delivery group ID. XPS searches for containers associated with the specified export release number, regardless of whether they are associated with a bill of lading or not.
XPS selects export containers only with the Dray Status set to dray-off, such as Forward to Loading Point or Return to shipper.
The business task sends a task ID and equipment ID of the container in the Bento message to XPS and XPS returns the exchange area ID associated with the position in N4.
For a Dray Off (DE) gate transaction, if you always specify the equipment number for the dray-off export container at the gate, you should not include the SelectExportContainer business task in your gate configuration. However, if you use an export release number and equipment type to identify the container for the Dray Off (DE) gate transaction, you should include the SelectExportContainer business task in your gate configuration.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Dray Off (DE)
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).
Client Type(s)
UI and Gate API
Parameters
The SelectExportContainer business task uses the following parameters:
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
Dependencies
If you also include the SequenceTransactions (on page 1) business task, when the gate stage is completed, N4 sorts the gate transactions in the order in which they must be executed and assigns a sequence number to each gate transaction.
You must also include the CancelWorkInstructionIfError (on page 1) business task so that the created work instruction is cleaned up if the transaction is not committed.
Related Business Task(s)
SequenceTransactions (on page 1)
CancelWorkInstructionIfError (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
The business task sends a request to XPS to select an import container based on the group ID, bill of lading, or import delivery order. If you specify a group ID or import delivery order (IDO), XPS searches for containers associated with the specified group or IDO that are not associated with a bill of lading.
This business task requires XPS.
The business task sends a task ID and equipment ID of the container in the Bento message to XPS and XPS returns the exchange area ID associated with the position in N4.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Deliver Import (DI)
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).
Client Type(s)
UI and Gate API
Parameters
The SelectImportContainer business task uses the following parameters:
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
For more information on setting parameters, see Business Tasks form (on page 1).
Dependencies
If you also include the SequenceTransactions (on page 1) business task, when the gate stage is completed, N4 sorts the gate transactions in the order in which they must be executed and assigns a sequence number to each gate transaction.
You must also include the CancelWorkInstructionIfError (on page 1) business task so that the created work instruction is cleaned up if the transaction is not committed.
Related Business Task(s)
SequenceTransactions (on page 1)
CancelWorkInstructionIfError (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
Sends a request to XPS to select an import container when a truck driver decides the exchange the assigned import container with another import container in the yard. Typically, container requests are for a specific container, or for matching containers based on the BL Number, Group ID, Import Deliver Order (IDO), or order item. If you provide a Container Number during the swap, N4 exchanges the assigned import container with the specified import container in the yard. Otherwise, N4 selects a container based on the matching criteria: BL Number, Group ID, Import Deliver Order (IDO), or order item.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Deliver Import (DI)
Client Type(s)
UI and Gate API
Parameters
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
Generally, the settings at the ingate for truckPostition are:
GRIDQ for straddle operations
TQ for non-straddle operations
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
We recommend that you use a special work queue, other than the road queue, to swap containers.
Dependencies
If the PlanSwappedContainerToYard (on page 1) business task is included in the gate configuration, a work instruction is created in XPS for the swapped out container to be placed back in the yard.
If the ReturnSwappedContainerToYard (on page 1) business task is included in the gate configuration, the swapped out container is placed back in the yard.
Related Business Task(s)
ConfirmSwappedDelivery (on page 1)
PlanSwappedContainerToYard (on page 1)
ReturnSwappedContainerToYard (on page 1)
Custom Code
None
Field(s)
None
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Dray Off (DE) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
ConfirmSwappedDelivery (on page 1) PlanSwappedContainerToYard (on page 1) SelectEmptyContainerForSwap (on page 1) |
|
Field(s) |
Container Nbr |
Description
When you include this business task, N4 sends a message to XPS to pick the best export container when a truck driver wants to exchange the assigned export container with another export container in the yard during the DE transaction. If you include this business task at the gate stage and provide a container number in the Gate form, N4 exchanges the assigned export container with the specified export container in the yard.
Parameters
truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a container in the yard, or where XPS should place the truck after the specific gate stage is successfully processed.
workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.
Dependencies
None.
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).
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).
Custom Code
None
Field(s)
None