Gate Transaction

• AutoSubmitTransactions    1

• CancelTransactionIfInBundle    1

• CancelTransactionsForBundledEquipment    1

• PlanCargoIntoYard    1

• CreateTruckTransactionStages    1

• LogUserMessage    1

• RejectConditionTrue    1

• RejectDuplicateTransaction    1

• RejectGateRequired    1

• RejectTranNotMatchingBookingTrkc    1

• RejectTranNotMatchingHazardBooking    1

• RejectTranNotMatchingNonHazardBooking    1

• RejectTranNotMatchingNonOOGBooking    1

• RejectTranNotMatchingOOGBooking    1

• RejectTranNotMatchingOrderLineOperator    1

• RejectTransactionNotConfirmed    1

• RejectVGMWeightRequired    1

• RejectWrongGate    1

• UpdateTruck    1

• SelectGate    1

• SequenceTransactions    1

• SequenceTransactionsLeastBusy    1

• SetNextStage    1

• StopOnUnsupportedTransactionType    1

AutoSubmitTransactions

The business task, when included at the start of the yard stage, advances the gate transactions that are not covered by equipment control through the yard stage. You can use the business task parameters to determine the gate transaction types that are auto submitted by the business task.

When a truck arrives at an exchange area, N4 checks to ensure that the truck is expected at that area. To determine this N4 uses the next gate transaction that is not yet handled for the truck visit. If a truck visit has two gate transactions and the first transaction is not covered by equipment control, N4 is not able to validate the exchange area for the second gate transaction. Include this business task to mark the first gate transaction as handled and to indicate that the truck is now ready to perform the second gate transaction.

For example, if a truck enters a yard with a line chassis to pickup a container, N4 creates two gate transactions: Receive Chassis (RC) and Deliver Import (DI) for the truck visit. You can include this business task at the yard stage to mark the RC gate transaction as handled before the truck arrives at the exchange area for the DI gate transaction.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Gate: 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:

• 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.

Client Type(s)

UI and Gate API

Parameters

The business task uses the following parameters to determine the type of gate transactions to auto submit:

• Bare Chassis (isChassis): Select the check box to auto submit a gate transaction for bare chassis.

The default value for this parameter is false.

• To/From Wheeled Areas (toFromWheeledAreas): Select the check box to auto submit container transactions to/from wheeled areas.

The default value for this parameter is false.

Dependencies

There are no dependencies but the business

Related Business Task(s)

• SequenceTransactions (on page 1)

• RejectWrongExchangeArea (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

CancelTransactionIfInBundle

Cancels transactions for equipment added to a bundle during the ingate process.

CancelTransactionsForBundledEquipment

Cancels transactions for separate units added to a bundle during the ingate process. To insure proper sequencing of transaction submissions, also include the CancelTransactionIfInBundle (on page 1) business task.

PlanCargoIntoYard

Description

When you include this business task for a RB transaction type at the ingate stage, N4 assigns a planned position for the cargo based on the basic yard planning algorithm. If a valid position is not available, N4 plans the cargo to the default position which is the value set for the defaultPositionId parameter.

Parameters

The 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.

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

None

Timing

• For gate transactions, such as Receive Break-bulk, 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.

CreateTruckTransactionStages

Include this business task to implement dynamic calculation of gate stages using code defined in the CreateTroubleTransactionGroovyImpl Groovy plug-in.

This business task does not do anything when included without a defined CreateTroubleTransactionGroovyImpl plug-in.

LogUserMessage

Description

The business task generates an error that returns a user-defined message.

Parameters

This business task uses the following parameters:

• messageLevel: Specifies the level of error message that the business task must return:

• error: Returns an error in red.

• severe: Returns an error in red.

• warning: Returns a warning message.

• info: Logs the problem but does not display anything in the User Interface.

• userMessageNbr: The integer corresponding to the appropriate user-defined message N4 displays.

Dependencies

To make the message conditional, use the Set Filter (on page 1) option. You can also customize the LogUserMessage business task with Groovy code that will run before N4 executes the task.

To include the user messages in the truck visit document, include the LogUserMessage business task at the truck visit stage for the on-submit timing.

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:

• 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.

• 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.

• For appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

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.

RejectConditionTrue

Description

The business task rejects an appointment, a pre-advise for vessel or rail, a truck visit, or a gate transaction if the specified condition is true. You can define following two types of conditions:

• Specify a value for a form field

• Define a comparison between two form fields

You can include up to three RejectConditionTrue business tasks for a each type of gate stage.

Parameters

The RejectConditionTrue business task has the following parameters:

• fieldId: The first form field to be checked.

• comparisonOperator: For an equality comparison, use =, ==, or eq; for an inequality comparison, use !=, =!=, or ne.

• value: The value you want to compare with the form field.

• andFieldId: If comparing between two fields, the second form field to be checked.

• andComparisonOperator: For an equality comparison, use =, ==, or eq; for an inequality comparison, use !=, =!=, or ne.

• andValue: If comparing between two fields, the value you want to compare with the second form field.

• messageLevel: Specifies the level of error message that the business task must return:

• error: Returns an error in red.

• severe: Returns an error in red.

• warning: Returns a warning message.

• info: Logs the problem but does not display anything in the User Interface.

• userMessageNbr: The integer corresponding to the appropriate user-defined message N4 displays.

If you are checking for any value or no value, the entry for the value and the andValue parameters needs to be empty of any text including spaces.

Dependencies

If you include the RejectConditionTrue business task at the Pre-advise Vessel and Pre-advise Rail gate stages, you can use only the following fields with this business task:

• tranEqoNbr

• tranOrigin

• tranTrkcId

• tranCtrNbr

• tranBlNbr

• tranIdoId

• tranLineId

• tranChsNbr

• tranNotes

• tranUnitId

• tranCtrTypeId

• tranDestination

• tranShipper

• tranConsignee

• tranCtrNbrAssigned

• tranChsNbrAssigned

• tranCommodityCode

• tranGroupId

• tranStageId

• tranSealNbr1

• tranSealNbr2

• tranSealNbr3

• tranSealNbr4

• tranShandId

• tranShandId2

• tranShandId3

• tranImportReleaseNbr

• tranExportReleaseNbr

• tranCtrAccNbr

• tranReeferFaultCode

• tranScAgent

• tranUnitFlexString01-tranUnitFlexString15

• tranUfvFlexString01-tranUfvFlexString10

If you include the RejectConditionTrue business task at a regular Gate stage, it can support complex metafield IDs such as tranEqGrade.eqgrdId.

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:

• 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.

• 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.

• For appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

• For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form (on page 1).

• For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectDuplicateTransaction

The business task rejects a gate transaction if another gate transaction for the same truck visit and Bill of Lading (BL) Item already exists. You can create multiple gate transactions for the same BL Item for different truck visits. However, you cannot create multiple gate transactions for the same BL Item and the same truck visit; instead, you must increase the Cargo Item Move Quantity specified for the first gate transaction.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Break-Bulk (DB), Deliver Import (DI), Receive Break-Bulk (RB), Through Container (TC)

Gate: 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), Through Container (TC)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

Cargo Bill Of Lading (on page 1)

Cargo BL Item (on page 1)

Cargo Item Quantity (on page 1)

RejectGateRequired

For automated gate systems, rejects transactions if the SelectGate (on page 1) task fails to return a gate.

RejectTranNotMatchingBookingTrkc

Rejects a gate transaction if the trucking company specified at the gate does not match the trucking company specified in the equipment order (export booking or EDO).

RejectTranNotMatchingHazardBooking

Description

The business task rejects a transaction if the specified equipment order is for hazardous order items but the clerk does not enter hazards for the container.

Include this business task only if you do not allow non-hazardous containers through the ingate against hazardous equipment order.

Parameters

None

Dependencies

For appointments, you must include the Hazardous (on page 1) field in the Appt Tran Type (on page 1) form at the Appointment Stage in the gate configuration and mark it as ‘Required’.

Timing

• For appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

• For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form (on page 1).

• For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectTranNotMatchingNonHazardBooking

Rejects a transaction if the specified equipment order is for non-hazardous order items but the gate clerk specified hazards for the container.

Include this business task only if you do not allow hazardous containers through the ingate against non-hazardous equipment order.

See also RejectCtrHazardsNotMatchingBookingHazard (on page 1).

RejectTranNotMatchingNonOOGBooking

Description

The business task rejects a gate transaction if the specified equipment order item is for non OOG containers but the gate clerk specifies OOG details for the container.

Parameters

oogValidateOogDetailsNow: You can use this parameter to specify whether the RejectTranNotMatchingNonOOGBooking business task should check only for the Is OOG check box or for the check box and the OOG details:

• no: N4 validates only the Is OOG check box.

• yes: In addition, to the check box, N4 validates whether OOG details are specified in the OOG - Add/Edit form.

If you set the parameter as no or do not set the parameter at all, N4 validates only the Is OOG check box.

Dependencies

N4 executes the business task only if the order item does not have any OOG values associated with it. If you want N4 to also reject a gate transaction where the order item has OOG values associated with it, you must also include the RejectTranNotMatchingOOGBooking (on page 1) business task in your gate configuration.

To reject a gate transaction:

• If there is a mismatch between the container and the equipment order, regardless of whether the order has any OOG details specified or not, include both the RejectTranNotMatchingOOGBooking (on page 1) and the RejectTranNotMatchingNonOOGBooking business tasks.

• Only if the order has OOG details specified and the gate clerk does not enter any OOG details at the gate, include only the RejectTranNotMatchingOOGBooking 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).

• For appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

• For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form (on page 1).

• For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectTranNotMatchingOOGBooking

The business task rejects a gate transaction if the specified equipment order item is for OOG containers but the gate clerk does not specify OOG details for the container.

However, if the gate clerk specifies OOG details that do not match the OOG details specified in the equipment order item, the business task does not reject the gate transaction unless you set the oogCompareDetails parameter for the business task as Yes.

Functional Area

Pre-advise Vessel, Pre-advise Rail, Appointment, IFT, and Gate

Execution Level

Transaction

Transaction Type(s)

Pre-advise Vessel: Receive Export (RE), Dray In (RI)

Pre-advise Rail: Receive Export (RE), Dray In (RI)

Appointment: Receive Export (RE), Through Container (TC)

IFT: Receive Export (RE)

Gate: Receive Export (RE), Through Container (TC)

Timing

on-submit: When the truck is sent to next stage, but only after successful execution of the Validation tasks.

Client Type(s)

UI and Gate API

Parameters

oogCompareDetails: When set to Yes, N4 compares the specific OOG dimensions to see if a null value is in a field where a not null value is expected. N4 does not reject the gate transaction if the values in the OOG fields for the equipment order item do not match the values specified for the unit, exactly.

oogTolerance%: To add a tolerance % for comparing differences in OOG values in the same dimension. For example, to allow a difference of 10% for over height dimensions, specify 10 as the tolerance percentage.

For N4 to consider the oogTolerance% parameter, you must set the oogCompareDetails parameter as Yes.

Dependencies

N4 executes the business task only if the order item has OOG values associated with it. If you want N4 to also reject a gate transaction where the order item does not have any OOG values associated with it, you must also include the RejectTranNotMatchingNonOOGBooking (on page 1) business task in your gate configuration.

To reject a gate transaction:

• Regardless whether the order has any OOG details specified or not, include both the RejectTranNotMatchingOOGBooking and the RejectTranNotMatchingNonOOGBooking (on page 1) business tasks.

• Only if the order has OOG details specified and the gate clerk does not enter any OOG details at the gate, include only the RejectTranNotMatchingOOGBooking business task.

Related Business Task(s)

RejectTranNotMatchingNonOOGBooking (on page 1)

Custom Code

None

Field(s)

For Pre-advise Vessel/Pre-advise Rail:

OOG - Add/Edit (on page 1)

For IFT:

Is OOG (on page 1)

OOG - Add/Edit (on page 1)

For Gate:

OOG - Add/Edit (on page 1)

OOG (on page 1)

RejectTranNotMatchingOrderLineOperator

Description

The business task rejects a gate transaction if the line operator specified at the gate does not match the line operator specified in the equipment order.

Parameters

None

Dependencies

You must ensure that the fields on the gate form are listed in the following order:

• Equipment Number

• Equipment Type

• Line Operator

• Booking/Order

• Order item

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 appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

• For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form (on page 1).

• For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectTransactionNotConfirmed

Rejects a gate transaction if the truck driver does not confirm the gate transaction. This business task checks the value of the is-confirmed attribute of the truck-transaction element of the submit-transaction gate API. If the is-confirmed attribute us not set or is set as false, N4 rejects the gate transaction.

RejectVGMWeightRequired

The business task rejects a gate transaction if the VGM Weight (kg) is not specified for the container.

Functional Area

Gate, Pre-advise Vessel

Execution Level

Transaction

Transaction Type(s)

Gate: Dray Off (DE), Deliver Import (DI), Receive Export (RE), Dray In (RI), Through Container (TC), Unknown (UK)

Pre-advise Vessel: Receive Export (RE)

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

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

VGM Weight (on page 1)

RejectWrongGate

The business task rejects a gate transaction if:

• The gate transaction type is not processed at the selected gate.

• The equipment is in a yard that is not serviced by the selected gate.

For more information, see Yards tab (on page 1).

• The facility is not in the port rotation for the carrier visit specified for the equipment.

For a Receive Break-Bulk (RB) gate transaction type, the BL is used to determine if the trucker is at the right gate. For a Deliver Break-Bulk (DB) gate transaction type, the location of the cargo lot decides if the trucker is at the right gate.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Export (RE), Dray In (RI)

Gate: Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Export (RE), Dray In (RI)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

UpdateTruck

Description

If you include this business task at the outgate stage, N4 clears the tag value of the truck when the truck completes the truck visit.

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.

SelectGate

For automated gate systems, uses Groovy code to select a gate based on the gate transaction type.

In the code used to determine which gate to select, the return line is as follows:

inDao.addCustomCodeResponse(gateOrId);

Where gateOrId is either a type of gate or the string value of the gate ID.

If you do not provide Groovy customization for the SelectGate business task, and the container has a position, N4 selects a gate based on which gate services the yard and yard-block holding the container.

If you include the SelectGate business task, also include the RejectGateRequired (on page 1) business task.

SequenceTransactions

Description

The business task sequences the gate transactions, associated with a truck visit, in the order in which they should be performed. You specify a preferred sequence of exchange areas and gates for a truck that has to visit multiple exchange areas or gates using the Seq nbr field in the Gate form (on page 1) and Exchange Areas form (on page 1). N4 uses these values to determine the sequence of the gate transactions associated with a truck visit.

If you include the SequenceTransactions business task, you have more than one delivery going to more than one exchange area, and the positions on truck (POT) have not been specified, then you must specify the preferred sequence in the Seq nbr field for the gate and exchange area. (If the POT are specified, it is not necessary to specify the preferred sequence, and for dropoffs, the POTs are available because you can see the container on the truck when it arrives.) Otherwise, N4 displays an error at the gate when processing a truck visit for more than one exchange area or gate.

For a truck visit, N4 sequences the gate transactions according to the preferred order of exchange areas and gate and assigns truck positions to the containers matching this sequence. N4 first sequences any through containers (TC/ROT), then receive (drop-off) gate transactions from the rear of the truck to the front, and then the deliver gate transactions from the front of the truck to the rear. However, the exchange area of the last drop-off gate transaction takes precedence over the preferred sequence of exchange areas.

If a driver specifies the desired positions on the truck for each deliver transaction, N4 does not use the preferred sequence of exchange areas. Instead, the sequence of the deliver transactions from the front of the truck to the back takes precedence.

If the driver or the external Gate Operating System (GOS) wants to use specific positions:

• All the positions must be specified.

• The specified positions must not coincide with any through containers on the truck.

In the gate API responses, the exchange area for each gate transaction is recorded in the exchange-area-id tag of the truck-transaction element. The exchange area that the driver should proceed to next is recorded in the next-exchange-area-id tag of the truck-visit element.

When XPS setting RDACTV is set to 0, N4 includes sequencing information in the bento message. XPS uses this information to activate and dispatch road work instructions routed via ASC landside transfer zones in the order specified by the N4 gate.

Parameters

None

Dependencies

The position on the truck is required for all containers (drop offs and through (ROT) containers) present on the truck.

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 specified for the business task is executed at the beginning of the business task and overrides the business task code depending on the response returned. If a custom code returns a response, N4 stops any further execution of the business task and assumes that the custom code is responsible for setting the sequence numbers for the gate transactions.

SequenceTransactionsLeastBusy

The business task sorts the gate transactions for a truck visit into the order in which they should be performed and assigns a sequence number to each gate transaction.

The sequencing strategy picks the gate transaction that will be performed at the least busy exchange area as the first transaction. Since drop-offs take priority over pick-ups, the first transaction considered is the drop-off destined for the least busy exchange area, followed by all other drop-offs, and finally it considers the pick-ups. In the event where multiple exchange areas have the same loading factor, it uses the Seq nbr field in the Exchange Areas form (on page 1) to select the first area.

The business task determines how busy an exchange area is by calculating the ratio of trucks that have that area as their next exchange area to the number of lanes in the exchange area. The next exchange area for a truck is determined by looking at the exchange area for the next gate transaction (using the sequence number) that hasn't been handled, yet.

You can model an exchange area that does not have any physical lanes as having either no lanes or as having one lane. If the exchange area is modeled as having no lanes, it is assigned the load factor of zero and is pushed to the top of the priority list. If the exchange area is modeled with one lane, then it is likely pushed to the bottom of the list.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Truck Visit IN

Client Type(s)

UI and Gate API

Parameters

nextAreaSequence: Specifies the sequence of areas to visit after the first area. You must use a comma-separated list to enter multiple values.

Once the business task establishes the first gate transaction, it assigns Sequence Number = 1 to the gate transaction. It then sequences the following gate transactions by first looking for other gate transactions in the same direction (drop-offs or pick-ups) at the same exchange area and then by looking for gate transactions at the next exchange area according to the nextAreaSequence parameter. Once all the drop-offs are sequenced, it looks for pick-ups in the same exchange area and then follows the value specified in the nextAreaSequence parameter.

Dependencies

The SequenceTransactionsLeastBusy business task requires that you include at lease one of the following business tasks to determine the exchange area for the container either based on its current position (for deliveries) or based on its planned position (for receivals):

• PlanUnitIntoYard (on page 1) (for receivals)

• SelectEmptyContainer (on page 1) (for deliveries)

• SelectExportContainer (on page 1) (for deliveries)

• SelectImportContainer (on page 1) (for deliveries)

Related Business Task(s)

SequenceTransactions (on page 1)

Custom Code

If you add any custom code to the business task, N4 executes the custom code at the start of the task and overrides the business task code depending on the response returned. If the custom code returns a response, N4 stops processing the business task immediately after the custom code and assumes that the custom code is responsible for setting the sequence number of the gate transactions for the selected truck visit.

Field(s)

None

SetNextStage

Description

The business task explicitly sets the next gate stage for the selected gate transaction type. Use the nextStageId parameter (on page 1) to specify the next gate stage for a gate transaction type. In addition, you can use the Set Filter (on page 1) option to associate a filter, defined in the Gate Transactions view (on page 1) or the Truck Visits view (on page 1), with the business task. If you do not associate a filter with the business task, N4 executes the business task for all the gate transactions of this gate transaction type. However, if you associate a filter with the business task, N4 executes the business task only if the gate transaction matches the specified filter criteria.

For more information on a scenario where you can use this business task, see the Update a unit while at the same time rejecting it for failed to deck gate transactions (on page 1) in the Navis N4: Gate Administrator and User Guide.

Parameters

nextStageId: Specifies the next gate stage for a gate transaction type.

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-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.

Dependencies

For each gate transaction type, you can include the SetNextStage business tasks up to three times. However, if the SetNextStage business task is included more than once, the filters associated with each SetNextStage business task must be mutually exclusive. For example, one filter may be for export containers while the other filter may be for import containers.

If the filters associated with the included SetNextStage business tasks are not mutually exclusive, the next filter overwrites the previous filter. The filter associated with the business task is displayed in the Filter ID column in the Business Tasks form (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.

StopOnUnsupportedTransactionType

Stops gate transaction processing of the gate transaction type is not supported. Include this business task to handle to processing of unknown gate transaction types.