Gate Business Tasks

Business tasks are tasks that are linked to code in N4 that allow for customized gate processing. You can configure business tasks to read or create new data for a gate transaction or truck visit, reject an appointment per the business rules required, and print gate documents for a gate transaction.

For more information on configuring business tasks, see Business Tasks (on page 1) form in the Navis N4: Gate Administrator and User Guide or in the online help.

You can include or exclude the following business tasks in N4 to configure the gate for the Deliver Break-Bulk (DB) and Receive Break-Bulk (RB) transaction types.

CreateBreakbulkUnit

The business tasks creates a break-bulk unit based on the bill of lading. You can include the business task at the ingate stage to create all types of cargo units: Identified, Quantified, or Measured. The business task sets the Position of the new unit as Truck. If a Bill of Lading and a BL Item is specified at the gate, the business task attaches the new unit to the bill of lading and the unit inherits the attributes of the bill of lading.

If you have already manifested an identified cargo unit, N4 still allows you to ingate the identified cargo unit. In this case, the business task does not create a new unit, instead it locates the existing unit and updates the Position of the unit as Truck.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Receive Break-Bulk (RB)

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)

LogCargoPickupMission

The business task constructs and logs the mission statement to instruct the truck driver about the cargo lots that need to be picked up from the yard for the Deliver Break-Bulk (DB) gate transaction. N4 prints this statement on a gate ticket using the document type specified in the CreateDocument (on page 1) business task.

You must include this business task at the first gate stage for the Deliver Break-Bulk (DB) gate transaction type. When the gate clerk selects the bill of lading and the bill of lading item, N4 retrieves the associated cargo lot information and uses the document type specified in the CreateDocument business task to create the cargo pickup mission ticket. The truck driver can use this document to identify the cargo lot positions in the yard and enter the yard to pick up the cargo lots.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Deliver Break-Bulk (DB)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

You must also include the CreateDocument business task to specify the document type to print the mission ticket.

Related Business Task(s)

CreateDocument (on page 1)

Custom Code

None

Field(s)

Cargo Bill Of Lading (on page 1)

Cargo BL Item (on page 1)

PlaceBreakBulkOnTruck

Places the arriving break-bulk cargo on the truck at the ingate.

See also PlaceUnitIntoYard (on page 1).

RejectCargoRequestedNotAtFacility

Description

The business task rejects a Deliver Break-Bulk (DB) gate transaction if there are no cargo lots for the given BL Item at the facility.

Parameters

None

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

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.

PlanCargoDirectDropOff

Description

You must include this business task in N4 if you want to perform the direct drop-off of cargo from the vessel to the gate. You can include this business task for the RB (Receive Breakbulk) gate transaction at the ingate stage.

The cargo will not be planned for direct pickup if the Is I/B to O/B Move Direct check box is not selected in the Gate form. This occurs even if you have included the PlanCargoDirectDropOff business task in N4.

Parameters

The PlanCargoDirectDropOff business task uses the following parameter (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.

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

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

PlanCargoDirectPickUp

Description

You must include this business task in N4 to perform the direct pickup of cargo from the gate to vessel. You can include this business task for the DB (Deliver Breakbulk) gate transaction at the ingate stage.

The cargo will not be planned for direct pickup if the Is I/B to O/B Move Direct check box is not selected in the Gate form. This occurs even if you have included the PlanCargoDirectPickUp business task in N4 .

Parameters

The PlanCargoDirectPickUp business task uses the following parameter (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.

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

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

PlanCargoOntoTruck

Description

You must include this business task in N4 if you want to plan the loading of the cargo lot associated with the BL/BL item onto the truck in the order of oldest to the latest. You can include this business task for the DB (Deliver BreakBulk) gate transaction at the ingate stage.If the gate transaction quantity is greater than the oldest lot quantity, then the the next oldest cargo lot will be considered for pickup. This will occur until the gate transaction quantity matches with the pickup cargo lot quantity.

The cargo will not be planned onto the truck if you have selected the Is I/B to O/B Move Direct check box in the Gate form. This occurs even if you have included the PlanCargoOntoTruck business task in N4.

Parameters

The PlanCargoOntoTruck business task uses the following parameter (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.

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

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

RejectAppointmentAlreadyUsed

Description

The business task rejects a gate transaction if a user enters an appointment number that exists in the system but has already been used (State = Used).

If you want to update the appointment State to Used when a gate clerk processes a gate transaction for the appointment, include the UpdateAppointmentStateToUsed (on page 1) business task at the gate stage.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

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.

RejectAppointmentForDifferentDriver

Description

The business task rejects a gate transaction if the truck driver specified at the gate does not match the truck driver specified in the gate appointment.

Parameters

None

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

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

• 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

None

RejectAppointmentNotCheckedIn

Description

The business task rejects the Truck Visit Appointment and the associated gate transaction if they are not in the CheckedIn state and displays an error message if they are in any other state.

Parameters

None

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

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

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.

RejectAppointmentForDifferentTranType

Description

When you include this business task for the Receive Empty (RM) transaction at the gate stage and try to save the gate form with an appointment number for a different transaction type, N4 displays an error message.

Parameters

None

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

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

RejectAppointmentForDifferentTruckCo

Description

The business task rejects a gate transaction if the trucking company specified at the gate does not match the trucking company specified for the appointment.

N4 implements this business task only if a valid appointment ID is specified and a trucking company has been specified for the appointment and the gate transaction.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectAppointmentForDifferentTruckLicenseNbr

Description

The business task rejects a gate transaction if the truck license number specified at the gate does not match the truck license number specified for the appointment.

N4 implements this business task only if a valid appointment ID is specified and a truck license number has been specified for the appointment and the gate transaction.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectAppointmentLaneRequired

Description

The business task rejects a gate transaction if a gate clerk does not specify an appointment number for a gate lane that requires appointments. For more information, see Gate Lane form (on page 1).

If you do not have any gate lanes defined for a gate but you include the RejectAppointmentLaneRequired business task, N4 assumes that the gate requires appointments.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectAppointmentNbrRequired

Description

The business task rejects a gate transaction if an appointment number is not specified.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectAppointmentNotMatchingGate

Description

The business task rejects a gate transaction if the specified appointment is for a different gate.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectAppointmentNotOnTime

Description

The business task rejects a gate transaction if the current date or time does not fall within the time slots for the specified appointment, including any tolerances.

N4 implements this business task only if the gate lane requires appointments or if the gate configuration does not include lanes.

For more information on setting up gate lanes and appointment rules, see Gate Lane form (on page 1), or Appointment Rule form (on page 1), respectively.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectCargoRequestedNotFound

Description

The business task rejects a gate transaction if any of the following conditions is true:

• A BL Item is not specified in the gate form.

• There are no cargo lots associated with the specified BL Item.

• The available Quantity for the cargo lot associated with the BL Item is less than the Quantity requested in the delivery order.

Parameters

None

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

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.

RejectCargoRequestedNotInYard

Description

The business task rejects a Deliver Break-Bulk (DB) gate transaction if there are no cargo lots for the given BL Item in the yard.

Parameters

None

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

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.

RejectAppointmentUnknown

Description

The business task rejects a gate transaction if a user enters an appointment number that does not exist in the system.

If the type of the appointment rule set (on page 1) in use is Truck Visit Appointment, this task applies to truck visit appointment numbers. Otherwise, the task only applies to transaction appointment numbers.

Parameters

None

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

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

• 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

None

RejectCargoUnloadNotComplete

The business task prevents the truck visit from proceeding to the next gate stage if all the cargo lots on the truck are not unloaded completely (Cargo Item Move Quantity is less than the Cargo Item Quantity) during a Receive Break Bulk (RB) gate transaction.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Gate: Truck Visit IN, Truck Visit OUT

Client Type(s)

UI

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectCarrierVisitNotMatchingBL

Description

The business task rejects a Receive Export (RE) gate transaction for a container with ISO Group “BR – Bulk Cargo in Rotainer” in the following scenarios:

• If a pre-advised container's vessel visit does not match the vessel visit in the bill of lading (BL).

• If the vessel visit does not match the vessel visit in the BL for a container that is not pre-advised.

Parameters

None

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

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

Custom Code

None

RejectCtrNotFoundForGroupOrBL

Rejects a gate transaction if N4 cannot find a container for the release number specified in the Release Number field. You may include this business task at the ingate stage and only for XPS operations.

In the Release Number field, you can enter a PIN number, group ID, or bill of lading number. You must exclude the RejectCtrNotFoundForGroupOrBL business task for the DI transaction type at the appointment stage to ensure that N4 allows you to create an appointment with a group ID (or BL Number) and without a container number.

RejectDirectHandlingVesselNotArrived

Description

This business task rejects the gate transaction if the I/B to O/B Move Direct check box is selected in the gate form for direct handling of cargo but the vessel has not yet arrived at the terminal.

Parameters

None

Dependencies

None

Timing

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

RejectPinNbrMismatch

The business task rejects a gate transaction if the PIN specified at the gate does not match the PIN in N4. For units, N4 matches the PIN specified at the gate with the PIN associated with the unit. For break-bulk cargo, N4 matches the PIN specified at the gate with the PIN associated with the delivery order or the bill of lading.

If the RejectPinNbrMismatch business task is included and you specify the delivery order and the bill of lading at the gate:

• If the delivery order has a PIN assigned, the business task rejects the gate transaction if the PIN at the gate does not match the delivery order PIN.

• If the delivery order PIN is null but the BL has a PIN assigned, the business task rejects the gate transaction if the PIN at the gate does not match the BL PIN.

If the RejectPinNbrMismatch business task is included and you specify only the bill of lading at the gate, the business task rejects the gate transaction if the PIN at the gate is null or does not match the BL PIN.

For more information, see How do I configure PIN related business tasks for break-bulk cargo?

If both the delivery order and the bill of lading are specified for the break-bulk cargo, N4 first matches the specified PIN to the Deliver Order PIN. If only the bill of lading is specified, N4 matches the specified PIN to the bill of lading PIN.

You can use the Delivery Requirements form to assign or edit the PIN for a unit. You can use the Bill of Lading form to associate a PIN to a BL. To associate a PIN to a Delivery Order, you can use either the Delivery Order form or the Create Delivery Order form.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Break-Bulk (DB), Dray Off (DE), Dray In (RI)

Gate: Deliver Break-Bulk (DB), Dray Off (DE), Deliver Import (DI)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

If you include this business task, you must add the Pin Number field to gate form to enable the user at the gate to enter a PIN.

Related Business Task(s)

RejectPinNbrNotEntered (on page 1)

RejectPinNbrNotAssigned (on page 1)

Custom Code

None

Field(s)

Pin Number (on page 1)

RejectPinNbrNotAssigned

The business task rejects a gate transaction if no PIN is assigned to the unit specified at the gate. For break-bulk cargo, the business task rejects the gate transaction if a PIN is not assigned to either the delivery order or the bill of lading specified at the gate.

The business task does not reject the gate transaction if either the delivery order or the bill of lading have a PIN assigned.

For more information, see How do I configure PIN related business tasks for break-bulk cargo?

You can use the Delivery Requirements form to assign or edit the PIN for a unit. You can use the Bill of Lading form to associate a PIN to a BL. To associate a PIN to a Delivery Order, you can use either the Delivery Order form or the Create Delivery Order form.

Functional Area

Appointment and Gate

Execution Level

Transaction

Timing

Pre-stage, validation

Transaction Type(s)

Appointment: Deliver Break-Bulk (DB), Dray Off (DE), Dray In (RI)

Gate: Deliver Break-Bulk (DB), Dray Off (DE), Deliver Import (DI)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

If you include this business task, you must add the Pin Number field to gate form to enable the user at the gate to enter a PIN.

Related Business Task(s)

RejectPinNbrNotEntered (on page 1)

RejectPinNbrMismatch (on page 1)

Custom Code

None

Field(s)

None

RejectPinNbrNotEntered

The business task rejects a gate transaction if the user at the gate does not enter a PIN.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Break-Bulk (DB), Dray Off (DE), Deliver Import (DI)

Gate: Deliver Break-Bulk (DB), Dray Off (DE), Deliver Import (DI)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

If you include this business task, you must add the Pin Number field to gate form to enable the user at the gate to enter a PIN. This business task does not validate the PIN entered at the gate. To ensure that a PIN is assigned to the delivery order or the bill of lading and that PIN entered at the gate matched the PIN for the delivery order or the bill of lading, include the RejectPinNbrNotAssigned (on page 1) and the RejectPinNbrMismatch (on page 1) business tasks, respectively. For more information, see How do I configure PIN related business tasks for break-bulk cargo?

Related Business Task(s)

RejectPinNbrMismatch (on page 1)

RejectPinNbrNotAssigned (on page 1)

Custom Code

None

Field(s)

Pin Number (on page 1)

RejectReleaseNbrUnknown

Rejects a gate transaction if the container release number entered by a gate clerk in the Import Release Number field, does not exist in N4.

You can enter a group ID or a bill of lading number in the Import Release Number field.

LoadBreakBulkCargoOnTruck

The business task loads the specified cargo lots from the specified yard location onto a truck. In addition, the business task applies the data entered in any of the Unit and UFV (Unit Facility Visit) flex fields, and seal numbers in the gate forms to the break bulk unit when you save the gate transaction.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Deliver Break-Bulk (DB)

Client Type(s)

UI

Parameters

None

Dependencies

If you use this business task to process a Deliver Break-Bulk (DB) transaction at the outgate stage, include the following fields in the outgate stage configuration.

• Cargo BL Item (on page 1)

• Cargo Item Move Quantity (on page 1)

• Unit Id (on page 1)

Related Business Task(s)

ApplyFlexFieldsToUnit (on page 1)

Custom Code

None

Field(s)

Cargo Lots

UnloadBreakBulkCargoFromTruck

The business task unloads cargo lots from the truck to the specified yard location. You can unload the entire cargo lot to a single yard location or to multiple yard locations.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Gate: Receive Break-Bulk (RB)

Client Type(s)

UI

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

Cargo Lots