Bundle

• AttachBundle    1

• LogBundleMission    1

• DetachPayloadFromBundle    1

• RejectBundledEqInYard    1

• RejectBundledEqNotInYard    1

• RejectBundleCannotBeUsedByLine    1

• RejectBundleNbrDuplicated    1

AttachBundle

Description

The business task attaches all the equipment in a bundle, created at the gate, to the primary equipment unit. The bundled equipment inherits the operator and owner of the master or primary equipment. However, if the payload equipment already has a record in a reference table (Configuration > Equipment menu), N4 does not update the operator and owner of the payload equipment to match the primary equipment.

You can use the Unit Inspector All Equipment tab to view the bundle information.

Parameters

detachRemovedBundles: If set to yes, when a unit is detached from a bundle during a gate transaction, N4 reverts the detached unit's visit and transit states accordingly. When set to no (or null), the detached unit's visit and transit states remain the same as the primary unit.

Dependencies

You must include this business task with the CreateContainerVisit (on page 1) business task at the selected gate stage. In addition, if you use the submit-transaction and submit-multiple-transactions APIs to parse the damages on a bundle, you must include this business task in your gate configuration.

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.

LogBundleMission

Constructs and logs the mission statement to instruct the driver about bundled equipment. N4 prints this statement on a gate ticket using the document type specified in the CreateDocument (on page 1) business task.

DetachPayloadFromBundle

Description

This business task is used to detach a payload container or chassis from the bundled containers or chassis.

When you include the business task DetachPayloadFromBundle at the ingate and outgate for a Deliver Empty (DM) transaction and enter the Equipment Delivery Order (EDO) number in the ingate Gate form, N4 assigns and updates a payload container in the Container Nbr Requested column in the Transactions tab in the ingate Gate form.

At the outgate,

- N4 departs the payload container based on the details you provide in the Container Nbr field in the outgate Gate form irrespective of whether it matches the container number provided at the ingate.

- If you provide a bundled master container number in the Container Nbr field in the outgate Gate form, N4 detaches and gates out the master container. One of the payload containers in the bundle becomes the master and the other payloads of the bundle get attached to the master.

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.

RejectBundledEqInYard

The business task rejects a gate transaction that includes a bundle if any of the equipment in the bundle is already present in the yard.

Functional Area

Pre-advise Vessel, Pre-advise Rail, Appointment, 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: Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)

Gate: Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)

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

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

The gate transaction must have a bundle.

Related Business Task(s)

RejectBundledEqNotInYard (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

RejectBundledEqNotInYard

Rejects a gate transaction

The business task rejects a gate transaction that includes a bundle if any of the equipment in the bundle is not present in the yard. In addition, the business task rejects a gate transaction if any of the equipment in the bundle is unknown or if the position of the equipment in the yard cannot be determined.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM)

Gate: Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM)

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.

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

RejectBundledEqInYard (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

RejectBundleCannotBeUsedByLine

Description

This business task rejects a Deliver Empty (DM) transaction when you are gating out bundled equipment if no equipment pooling agreement exists between the container/chassis owner or operator of the bundled container and, the line operator in the transaction. Similarly, this business task rejects a Receive Empty (RM) transaction when you are gating in bundled equipment if no equipment pooling agreement exists between the container/chassis owner or operator of the bundled container and, the line operator in the transaction.

Also, when you include this business task for the Deliver Chassis (DC) transaction type at the Outgate stage, N4 displays a line mismatch error message when you add a chassis belonging to a different line operator as a bundle to an existing chassis in the Outgate form. Lastly, if you include this business task at the Ingate for RC transaction type, N4 will not allow you to bundle equipment of different line operators which are not in a pool.

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.

RejectBundleNbrDuplicated

Rejects a gate transaction if there is a duplicate equipment number in a bundle created at the gate.