Truck

• AdvanceTruckToStage    1

• CheckTruckOKAtStage    1

• CreateNewTruck    1

• RejectBadTruckPosition    1

• RejectPositionOnTruckRequired    1

• RejectROTsAft    1

• RejectTruckBanned    1

• RejectTruckHasNoTransactions    1

• RejectTruckLicenseExpired    1

• RejectTruckLicenseRequired    1

• RejectTruckTagIdRequired    1

• RejectTruckUnknown    1

• UpdateTruck    1

AdvanceTruckToStage

Description

When a truck arrives at a gate stage but is expected at an earlier gate stage, attempts to automatically advance the truck to the current gate stage by submitting the associated gate transactions and the truck visit for the earlier stage.

This functionality currently only covers the case where a truck is at an outgate stage but expected at a yard stage because of an incomplete receival transaction. This is a case that N4 can safely advance automatically.

Parameters

For the AdvanceTruckToStage business task, you can use the following parameters (on page 1):

• advanceFromStages: A comma-separated list of acceptable gate stages that the truck can be advanced from.

• advanceTransactions: When set to TRUE, True, true, YES, Yes, yes, Y, or y, N4 attempts to submit the associated gate transactions before trying to advance the truck visit. Otherwise, N4 only tries to advance the truck visit.

• advanceTranFromYardBlock: If set to TRUE, True, true, YES, Yes, yes, Y, or y, N4 advances the truck from any yard block to the outgate without processing at the yard gate. You must also set the advanceFromStages parameter to Yard and advanceTransactions parameter to True to ensure that the truck advances from the yard block.

If you set the parameter advanceTranFromYardBlock to any other values apart from the values specified above, N4 will advance the truck to the outgate only if the truck is coming from a wheeled area in the yard.

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.

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.

CheckTruckOKAtStage

Description

This business task checks to see if the truck that you are processing at the current gate stage has any errors from any of the previous gate stages where it was processed. If the truck does not have any errors from the previous gate stages, you can process the truck at the current gate stage. If this business task fails, you may have to send the truck to the Trouble desk.

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.

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.

CreateNewTruck

Description

The business task creates a new truck record using data, such as truck ID and truck license number, entered by a gate clerk. If the gate clerk enters both the Truck Safe Weight (on page 1) and the Truck Tare (on page 1) weight in the gate form, N4 validates to ensure that the truck tare weight is less than the truck safe weight. However, if either of the two values is not specified, N4 skips any truck weight validations.

If the master truck record already exists in the Trucks view (on page 1), this business task automatically fills in the truck details in the gate form, such as the trucking company and the driver name, using the Last Trucking Company and Last Truck Driver fields from the master truck record.

Parameters

isUpdateMasterTruckDetails: When set to NO, N4 does not update the Last Trucking Company and Last Truck Driver details entered in the gate form, to the master truck record (Trucks view). Otherwise, N4 updates the Last Trucking Company and Last Truck Driver details entered in the gate forms to the master truck record (Trucks view).

Dependencies

To successfully add a new truck record, you must include the Truck License form field in the appropriate Trk Visit form (on page 1) and the gate clerk must enter data in this field at the gate.

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 visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment 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.

RejectBadTruckPosition

The business task rejects a gate transaction if there is a conflict in the truck positions specified for multiple gate transactions for a truck visit, an appointment, or a truck visit appointment. For example, if more than one deliver or receive gate transaction refers to the same position on the truck, N4 rejects the gate transaction and displays an error message. This also applies to containers in adjacent positions when positions are overlapping. For example, if a 40' container is in position 2, then N4 rejects a gate transaction that specifies a 20' container in position 1 or 3.

N4 supports positions 1 to 11. For more information, see Supported truck positions (on page 1).

You can include the RejectBadTruckPosition business task for the:

• Truck Visit

• Individual gate transaction types at any inbound stage as well as for the yard stage.

• Appointments and truck visit appointments.

The RejectBadTruckPosition business task checks for inbound and outbound gate transactions. In addition, if an inbound gate transaction, such as Receive Empty (RM) is cancelled, the RejectBadTruckPosition business task ensures that the container position on the truck is considered filled when assessing the outbound gate transactions.

If no position is specified for a container, the RejectBadTruckPosition business task ignores the container.

To reject a gate transaction if no position is specified for a container, include the RejectPositionOnTruckRequired (on page 1) business task.

Functional Area

Appointment and Gate

Execution Level

Transaction/Truck Visit

Transaction Type(s)

Appointment: Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Export (RE), Receive Empty (RM), Through Container (TC)

Gate: Deliver Break-Bulk (DB), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Truck Visit IN, Truck Visit OUT

Timing

• For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

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

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

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

SequenceTransactions (on page 1)

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

RejectPositionOnTruckRequired

Rejects a gate transaction if the position of each container on the truck is not specified.

RejectROTsAft

Rejects a gate transaction if through containers on a truck are placed behind the containers being received or delivered. When using RejectROTsAft, you should also include the RejectPositionOnTruckRequired (on page 1) business task.

RejectTruckBanned

Rejects a gate transaction if the truck status is Banned.

RejectTruckHasNoTransactions

Description

Rejects a gate transaction if the truck visit does not have any associated gate transactions when processed at the trouble desk. Include this business task to ensure proper reprocessing of trouble transactions where the appointment may be created after the truck visit is created.

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.

RejectTruckLicenseExpired

The business task rejects a gate transaction if the truck license has expired.

Functional Area

Gate and Appointment

Execution Level

Transaction and Truck Visit

Transaction Type(s)

Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Unknown (UK)

Truck Visit IN

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

The License Expiration Date must be specified in the Configuration Gate Trucks Trucks view (on page 1) Truck form (on page 1).

Related Business Task(s)

None

Custom Code

None

Field(s)

Truck License

RejectTruckLicenseRequired

The business task rejects a gate transaction if a gate clerk does not enter a Truck License in the Truck Visit Details area at that gate stage.

Functional Area

Appointment and Gate

Execution Level

Transaction/Truck Visit

Transaction Type(s)

Appointment: 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)

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)

Truck Visit IN

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectTruckTagIdRequired

The business task rejects a gate transaction if N4 does not receive the RFID Tag ID for the truck from the Gate Operating System (GOS). In addition, if a gate clerk is using the gate forms in N4 to complete the gate transaction, the business task rejects the gate transaction if the Truck Id specified by the gate clerk does not have a Tag ID associated with it.

If you include the business task at the truck visit level, the business tasks prevents N4 from creating the truck visit and you cannot process the truck anymore or even send it to the Trouble Desk. If you include the business task at the gate transaction level, the business task prevents N4 from saving the gate transaction, but since the truck visit now exists, you can send the truck to the Trouble Desk to resolve the missing Tag ID issue.

Functional Area

Gate

Execution Level

Transaction, Truck Visit

Transaction Type(s)

Transaction: 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),

Truck Visit: Truck Visit IN, Truck Visit OUT

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

Truck License (on page 1)

Truck Id (on page 1)

Tag ID (on page 1)

RejectTruckUnknown

Description

The business task rejects a gate transaction if the truck specified at the gate does not exist in N4.

Parameters

None

Dependencies

None

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

• 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

None

UpdateTruck

Description

Updates the last trucking company, truck ID, tag ID, and truck license number for the truck specified in the truck visit.

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

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