Unit

• AdviseXpsTbdEmptyDelivery    1

• ApplyFlexFieldsToUnit    1

• ApplyPodDestinationToRouting    1

• CreateUnitDeparting    1

• DepartUnit    1

• PlaceTestUnitIntoYard    1

• PlaceUnitIntoYard    1

• PlanCargoOntoTruck    1

• PromoteAdvisedUnitForCategory    1

• PlaceUnitOnTruck    1

• ReadUnitDeparted    1

• RecordUnitDrayIn    1

• RejectUnitFailedToDeck    1

• ReplanUnitsIntoYard    1

AdviseXpsTbdEmptyDelivery

Description

The business task creates a new TBD unit, using the description of the unit in the specified EDO order item, to represent the unit being delivered at the gate. It also sends the MSGID_ADVISE_TBD_UNIT_REQUEST message to XPS, which then creates an orphan container for the TBD unit and a work instruction for the container.

The business task also assigns the value of the Transaction Number field to the BAT Number (on page 1) field in the Truck Visit Details if the BAT Number field was null.

Parameters

None

Dependencies

You must include the AdviseXpsTbdEmptyDelivery business task only at an ingate stage and not at an outgate stage.

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.

ApplyFlexFieldsToUnit

The business task applies data entered in any of the unit and unit facility visit flex fields, in the gate forms, to the container unit and the active or the advised unit facility visit when you save the gate transaction.

If you use this business task for a receival transaction in an appointment stage, a pre-advise container must already exist or the CreateContainerPreadvisedVisit (on page 1) business task must also be included in the appointment stage.

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), Receive Empty (RM)

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

Appointment: Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Export (RE), Dray In (RI), Receive Empty (RM)

IFT: Deliver Import (DI), Receive Export (RE)

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)

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

None

Dependencies

This business task does not copy the flex fields for break bulk units. To apply the flex fields for a break bulk unit, include the LoadBreakBulkCargoOnTruck (on page 1) business task in the gate configuration.

Related Business Task(s)

ApplyInspectionUnitFlexFields (on page 1)

LoadBreakBulkCargoOnTruck (on page 1)

Custom Code

None

Field(s)

None

ApplyPodDestinationToRouting

Applies the POD and Destination specified at the gate to the unit routing when a gate clerk processes a Dray In gate transaction.

CreateUnitDeparting

Description

This business task creates a chassis, accessory or a bundle unit at the outgate for the departing equipment, when a container departs on a chassis, or is attached with accessories or is a bundled equipment.

The business task automatically fills in goods, shipper, and origin from the equipment order the unit is departing against.

You must include this business task if you record chassis, attached accessories, or bundled equipment at the outgate for deliver gate transaction types.

For empties: If a unit that was gated out as an empty comes back to the terminal as an empty, N4 creates a new Active storage unit without carrying over any details from the previous visit. In addition, N4 also creates an export full preadvised unit in the Advised state if you have set ORDRBKNG002 to true, have selected the check box Check If All Done in the Gate Stage form, and the truck visit status is already completed. If you have not selected the check box Check If All Done in the Gate Stage form, N4 creates an active export unit in the Inbound state.

Parameters

None

Dependencies

The CreateUnitDeparting business task creates a unit only if the departing unit is in any one of the following transit states: Inbound, EC/In, Yard, and EC/Out.

When you include the CreateUnitDeparting business task at the outgate stage and set the ORDRBKNG002 (BKNG_EXPORT_AUTO_PREADVICE) setting to true, N4 creates a new Advised unit or updates an existing pre-advised unit against the booking.

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.

DepartUnit

Description

The business task marks a unit as departed if it is leaving the facility.

The business task departs units for completed transactions only. This prevents premature departure of units when the business task is configured at multiple gate stages.

When you include the DepartUnit business task at the truck visit level at the outgate, N4 departs all units on the chassis even if one of the containers on that chassis is still in the yard. To ensure that the extra containers on the chassis are placed back into the yard when you process a delivery at the outgate, include the DismountExtraUnitsAttachedToChassis (on page 1) business task before the DepartUnit business task at the truck visit level.

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:

• 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.  Clicking this button also triggers the EC event TV_ITZ_LANE_ARRIVAL.

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

PlaceTestUnitIntoYard

This business task is only used by the Navis QA team to test N4 without connecting to XPS.

Do not include this business task for a production system.

See also PlaceUnitIntoYard (on page 1).

PlaceUnitIntoYard

Description

The business task places a unit into the yard in the absence of a running XPS. Typically, this business task is used at the ingate for break-bulk or other gate transactions that do not involve XPS operations.

• For break-bulk gate transactions, include the PlaceBreakBulkOnTruck (on page 1) business task before you include the PlaceUnitIntoYard (on page 1) business task.

• For XPS operations, at the ingate, you must include the PlanUnitIntoYard (on page 1) business task instead of the PlaceUnitIntoYard (on page 1) business task.

• For non-XPS operations, including this business task at the outgate will not have an impact if the planned and placed positions of the container are the same. However, if the planned and placed positions (refined position) are different, including this task at the outgate will place the container back in its original planned position.

• If you include the business task for Receive Export transactions at the ingate stage, N4 updates the To Slot value in the Position field in the Units view when you complete the gate stage. This applies to the containers that are gated-in directly without pre-advise or appointments.

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.

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.

PromoteAdvisedUnitForCategory

The business task finds and demotes an existing Active unit, which conflicts with the current unit being received at the gate, and promotes the available Advised unit to receive as part of the gate transaction.

For example, when you receive a unit at the gate for which two unit facility visits (UFVs) exist in N4, where one has the Category = Storage, T-State = Advised, and is assigned to an ERO and the other has the Category = Export and the T-State = Active, this business task, if included, ensures that the Advised Storage unit is used in the gate transaction and the Active Export unit is demoted to the Advised state.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Receive Break-Bulk (RB), Receive Export (RE), Dray In (RI), Receive Empty (RM)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

PlaceUnitOnTruck (on page 1)

Custom Code

None

Field(s)

None

PlaceUnitOnTruck

The business task places the departing unit on a truck at the ingate or outgate. For a Deliver Empty (DM) gate transaction involving TBD units, it is recommended that you include the business task at the last gate stage where the swap takes place, usually the outgate stage.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM)

Client Type(s)

UI and Gate API

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

Parameters

None

Dependencies

Do not include this business task if you have already included the ConfirmDelivery (on page 1) business task.

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

ReadUnitDeparted

Description

The business task reads the details of all the departed UFVs for the container specified in the gate transaction and applies all the attributes of the departed unit to the gate transaction.

Parameters

None

Dependencies

You must include this business task only if you have a gate flow that requires you to process units associated with a gate transaction after the last stage for the gate transaction that marks the unit as departed is completed.

Do not include this business task at a gate stage that is before the unit is marked as Departed because in that case, the business task will not find any Departed UFVs and instead would clear all the equipment data associated with the gate transaction. As a result, any subsequent updates for the equipment will not be saved.

For example, Out is the last outgate stage that marks the unit as departed. However, after the Out stage, you have a stage Check where the container is inspected for any damages and the damages, if any are applied to the departing unit. To allow users to apply the damages or any other details to the unit, you must include the ReadUnitDeparted business task at the Check stage.

In addition, you must also select the Allow Transaction Edit check box at the Check stage. For more information, see Gate Stage form (on page 1).

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.

RecordUnitDrayIn

Records the UNIT_DRAY_IN event when the unit returns to the facility.

RejectUnitFailedToDeck

Rejects a gate transaction if XPS cannot find a valid yard position for the container at the ingate. For XPS operations only, use the failedToDeckSlot parameter to specify the failed to deck block name as specified in the settings file.

If you want to save unit updates made at the ingate while still rejecting the transaction when the unit fails to deck, then see Update a unit while at the same time rejecting it for failed to deck gate transactions? (on page 1).

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

ReplanUnitsIntoYard

Description

When a truck arrives at the terminal with a combination of gate transactions, such as pick up a full and an empty container and drop off a full and an empty container, each transaction is saved and a yard position is determined for the truck to pick up or drop off containers. After all the gate transactions have been recorded, XPS may be able to find more efficient positions for the containers associated with the truck visit depending on where the containers need to be dropped off or picked up from.

You must include this business task to send a replan request to XPS after all the gate transactions are saved and resequence the gate transactions associated with a truck visit if they can be processed in a more efficient manner.

If XPS returns new positions for any of the containers associated with the truck visit, these new positions are then printed on the mission statement for the driver.

Parameters

Uses the parameters set in the PlanUnitIntoYard (on page 1) business task.

Dependencies

You must:

• Include the PlanUnitIntoYard (on page 1) business task for all appropriate transaction types at the same gate stage.

• Include the CreateTransactionDocuments (on page 1) and PrintTransactionDocuments (on page 1) business tasks at the truck visit level instead of the transaction level tasks to create and print documents to ensure that only the updated mission statements are printed for the truck drivers.

• Ensure that RECDEF is to N. If RECDEF is set to Y, it prevents the ReplanUnitsIntoYard business task from updating work instructions.

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.