Appointment

• CreateIftAppointmentForDestFacility    1

• ReadGateAppointment    1

• ReadTruckVisitAppointmentByDetails    1

• ReadActiveUnitFlexFields    1

• RejectAppointmentAlreadyUsed    1

• RejectAppointmentForDifferentCtr    1

• RejectAppointmentForDifferentDriver    1

• RejectAppointmentForDifferentTranType    1

• RejectAppointmentIDOExpired    1

• RejectAppointmentForDifferentTruckLicenseNbr    1

• RejectAppointmentLaneRequired    1

• RejectAppointmentNbrRequired    1

• RejectAppointmentNotMatchingGate    1

• RejectAppointmentNotMatchingTVAppointmentDriver    1

• RejectAppointmentNotMatchingTVAppointmentTrkCo    1

• RejectAppointmentNotMatchingTVAppointmentTruck    1

• RejectAppointmentNotOnTime    1

• RejectAppointmentOrderItemQtyExceeded    1

• RejectAppointmentNotCheckedIn    1

• RejectAppointmentOrderItemTallyExceeded    1

• RejectAppointmentUnknown    1

• RejectAppointmentUpdateEquipmentTypeMismatch    1

• RejectApptQuotaForYardBlockExceeded    1

• RejectDuplicateTranAppointment    1

• RejectNoAppointmentForTruck    1

• RejectTvaIfNotAssociatedToTransactions    1

• RejectTVAppointmentAlreadyUsed    1

• RejectTVAppointmentNbrRequired    1

• RejectTVAppointmentNotMatchingDriver    1

• RejectTVAppointmentNotMatchingGate    1

• RejectTVAppointmentNotMatchingTruck    1

• RejectTVAppointmentNotMatchingTruckingCompany    1

• RejectTVAppointmentNotOnTime    1

• RejectAppointmentLineMismatch    1

• RejectTVAppointmentUnknown    1

• RemoveUnusedAppointment    1

• RejectReferenceNbrRequired    1

• StopOnAppointmentFailure    1

• UpdateAppointmentStateToUsed    1

• RejectAppointmentForDifferentTruckCo    1

• RejectDriverCardExpired    1

CreateIftAppointmentForDestFacility

Creates a transaction appointment for the destination facility when delivering an inter-facility transfer container at the outgate of the origin facility. N4 creates the new appointment for a transaction type to receive the same container departing the origin facility. For example, for the delivery of an empty container, N4 creates an appointment for a Receive Empty (RM) transaction type to receive the empty container at the destination facility.

For 2x20 inter-facility transfers, N4 creates two transaction appointments, one for each container.

The departing container must be associated with a group that has Next Facility = the destination facility and Group Order Purpose = IFT in the Group form (on page 1). In addition, when the CreateIftAppointmentForDestFacility business task creates an appointment, it enters IFT and the origin and destination facility IDs in the new appointment's Notes field, replacing any notes that a gate clerk entered at the outgate.

For the CreateIftAppointmentForDestFacility business task, you can use the following parameter (on page 1):

• maxIftTransportTime: To specify the maximum transport time, in minutes, for the new transaction appointment end time. For example, if you specify 60, N4 creates the transaction appointment with a start time equal to the current time and the end time 60 minutes after the current time.

The destination facility's gate must have an appointment rule and appointment stage defined for all transaction types needed to process inter-facility transfers from the origin facility.

ReadGateAppointment

Description

The business task uses the truck license number to read the data from the appointment and automatically fills in the data in the <GateStage> tab (on page 1).

Parameters

None

Dependencies

If you want N4 to use the data, such as an ISO Type, specified in the gate API request, such as submit-transaction, and not in the appointment, you must not include this business task for the pre-stage timing.

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.

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

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.

ReadTruckVisitAppointmentByDetails

The business task reads the truck visit details and tries to find the truck visit appointment by either the Driver Card ID, Truck ID or Truck License Number.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Truck Visit IN

Timing

• pre-stage: When a truck visit is created and before processing the truck at a stage. If a pre-stage business task fails at the first gate stage, N4 does not create a truck visit and does not allow the user to send the truck to trouble.

Client Type(s)

UI and Gate API

Parameters

If you want the business task to search using multiple criteria, you can use the following parameters to specify the search priority order for the various fields:

• driverCardSearchOrder: Specify the search Priority Order for the Driver Card ID. You can specify the Priority Order as 1, 2, or 3.

• truckIdSearchOrder: Specify the search Priority Order for the Truck ID. You can specify the Priority Order as 1, 2, or 3.

• truckLicenseSearchOrder: Specify the search Priority Order for the Truck License Number. You can specify the Priority Order as 1, 2, or 3.

You can specify the value of one or more of these parameters. A low value represents a lower priority. If two parameters have the same values, N4 assigns the same search Priority Order to both the fields.

If you do not specify any value for a parameter, N4 does not include that field in the search.

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

ReadActiveUnitFlexFields

Description

The business task reads the flex field values for the unit specified in the appointment and copies the same to the unit and appointment flex fields when you save an appointment. N4 also validates the appointment filters included against this business task before executing it.

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.

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

RejectAppointmentForDifferentCtr

Rejects a gate transaction if a container number field is defined in either the appointment form or the gate form, the gate clerk enters a valid appointment number, but the container number specified in the gate form is different from the container number specified for the appointment.

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

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.

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

RejectAppointmentIDOExpired

Description

When included in the appointment stage at the transaction level, the business task rejects the appointment if the appointment requested date is after the IDO expiry date of the associated unit.

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.

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

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.

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

RejectAppointmentNotMatchingTVAppointmentDriver

Rejects the association of the transaction appointment with a truck visit appointment if the driver card ID does not match. If the driver card ID is not specified in either the transaction or truck visit appointment, this business task does not check for a driver mismatch.

The RejectAppointmentNotMatchingTVAppointmentDriver business task replaces the truck visit level RejectAppointmentForDifferentDriver business task.

To run this business task, you must select Actions Include Dispatch Business Task. This ensures that N4 executes this business task when a user associates a transaction appointment with a truck visit appointment.

RejectAppointmentNotMatchingTVAppointmentTrkCo

Rejects the association of the transaction appointment with a truck visit appointment if the trucking company does not match. If the trucking company is not specified in either the transaction or truck visit appointment, this business task does not check for a trucking company mismatch.

To run this business task, you must select Actions Include Dispatch Business Task. This ensures that N4 executes this business task when a user associates a transaction appointment with a truck visit appointment.

RejectAppointmentNotMatchingTVAppointmentTruck

Rejects the association of the transaction appointment with a truck visit appointment if the truck license number does not match. If the truck license number is not specified in either the transaction or truck visit appointment, this business task does not check for a truck mismatch.

To run this business task, you must select Actions Include Dispatch Business Task. This ensures that N4 executes this business task when a user associates a transaction appointment with a truck visit appointment.

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

RejectAppointmentOrderItemQtyExceeded

Rejects a gate transaction or appointment when the order item's Tally In plus all existing receival appointments for that order item match or exceed the order item's Qty.

For this business task to work properly, you must also include the UpdateAppointmentStateToUsed (on page 1) business task at the same gate stage.

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.

RejectAppointmentOrderItemTallyExceeded

Rejects a gate transaction or appointment when the order item's Tally Out plus all existing delivery appointments for that order item match or exceed the order item's Qty.

For this business task to work properly, you must also include the UpdateAppointmentStateToUsed (on page 1) business task at the same gate stage.

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

RejectAppointmentUpdateEquipmentTypeMismatch

Description

The business task rejects a gate transaction or an appointment if the appointment equipment type does not match the equipment type of the pre-advised container specified in the gate transaction or the appointment, respectively.

Parameters

validateTranISOType: If you select this parameter, N4 validates the container equipment type in the Appointment form with the container's equipment type in the API instead of the booking item in the Appointment form or the transaction’s booking item and displays an error message if there is a mismatch in the ISO types.

Dependencies

The pre-advised container must exist so that the workflow can match the equipment type of the container with the equipment types specified for the appointment.

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

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.

RejectApptQuotaForYardBlockExceeded

The business task rejects an appointment for a deliver gate transaction type if the container is located in a yard block for which the yard block quota has already been met. For more information on setting up the yard block quota, see Yard Block Quota tab (on page 1).

The business task rejects an appointment only if the Loc Type of the container position is Yard. For all the other values of Loc Type, it allows you to create the appointment without validating the appointment quota.

Functional Area

Appointment

Execution Level

Transaction

Transaction Type(s)

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

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

You must define the yard block quota for the Appointment Rule Set (on page 1).

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectDuplicateTranAppointment

The business task displays an error when you add an appointment that has the same container number, transaction type, and gate as an existing appointment.

Functional Area

Appointment

Execution Level

Transaction

Transaction Type(s)

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

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

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectNoAppointmentForTruck

Rejects a truck visit if no appointments exist for the truck visit.

RejectTvaIfNotAssociatedToTransactions

The business task prevents you from adding truck visit appointments without associating any transaction level appointments with it. When you include this business task at the Truck Visit APPTTV stage, you cannot use the Truck Visit Appointments view (on page 1) or the API to add a truck visit appointment without associating any transaction level appointments with it. However, you can use the Appointments view (on page 1) Actions Create Truck Visit Appointments (on page 1) action to add a new truck visit appointment for the selected transaction appointment.

Functional Area

Truck Visit Appointment

Execution Level

Truck Visit

Transaction Type(s)

Truck Visit APPTTV

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectTVAppointmentAlreadyUsed

Rejects a truck visit if a user enters a truck visit appointment number that exists in the system but has already been used (State = Used, Canceled, or Expired).

RejectTVAppointmentNbrRequired

Rejects a truck visit if a user does not enter a truck visit appointment number for the truck visit.

RejectTVAppointmentNotMatchingDriver

Rejects a truck visit if the driver specified in the truck visit appointment does not match the driver for the truck visit. The driver details, such as driver card ID, must be specified in both the truck visit appointment and truck visit to validate this business task. If truck details are missing, this business task does not reject the truck visit.

RejectTVAppointmentNotMatchingGate

Rejects a truck visit if the gate for a truck visit appointment does not match the current gate where the truck visit is being processed.

RejectTVAppointmentNotMatchingTruck

Rejects a truck visit if the truck details specified in the truck visit appointment do not match the truck details for the truck visit. The truck details, such as truck ID and truck license, must be specified in both the truck visit appointment and truck visit to validate this business task. If the truck details are missing, this business task does not reject the truck visit.

RejectTVAppointmentNotMatchingTruckingCompany

Rejects a truck visit if the trucking company specified in the truck visit appointment does not match the trucking company for the truck visit.

RejectTVAppointmentNotOnTime

The business task rejects a truck visit if the current date and time does not fall within the time slots for the specified truck visit appointment, including any tolerances. When included, the business displays an error if a trucker comes in too early or too late for a truck visit appointment.

You can include the business task for both the pre-stage and on-submit timings. For more information on timing, see Business Tasks form (on page 1).

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

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

RejectAppointmentLineMismatch

Description

The business task rejects a gate transaction if the container line operator specified at the gate does not match the line operator specified in the 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).

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.

RejectTVAppointmentUnknown

Rejects a truck visit if a user enters a truck visit appointment number that does not exist in the system.

RemoveUnusedAppointment

Removes any appointments that were not used so that they can be re-used against another truck visit.

RejectReferenceNbrRequired

Description

When you include the business task in the Gate stage of any transaction type, N4 validates that the Reference Number field in the Gate form is not null even if it is not a required field.

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.

StopOnAppointmentFailure

Stops the gate transaction processing if one of the appointment business task fails.

UpdateAppointmentStateToUsed

Description

The business task updates the specified appointment state to Used when a gate clerk processes a gate transaction with an appointment. If your terminal uses Appointments, it is mandatory that you add this business task in the Ingate stage (or the first gate stage) to avoid errors when canceling appointments.

Parameters

cancelOtherApptsForSameEquip: Use this parameter (on page 1) to specify whether N4 should cancel other appointments for the same equipment or not.

• By default (null), or when set to YES, N4 cancels other appointments for the same equipment and records the APPT_CANCEL event.

• When set to NO, N4 does not cancel the other appointments for the same equipment.

This parameter is not available at the truck visit level.

Dependencies

• You must add the Appointment Number field to the Tran Type form.

• To reject a gate transaction if a gate clerk enters a Used appointment, also include the RejectAppointmentAlreadyUsed (on page 1) business task at the selected gate stage.

• If you are using Appointments, it is mandatory that you include the UpdateAppointmentStateToUsed business task at Ingate stage (or the first gate stage ). If you do not do so, N4 may display error messages when you cancel and create new appointments.

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-trouble: The business task is executed when the truck is sent to Trouble.

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

• on-trouble: The business task is executed when the truck is sent 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.

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

RejectDriverCardExpired

Description

Rejects a gate transaction if the current date is past the Driver Card Expiration date specified in the Driver form (on page 1).

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.

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

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.