The business task assigns scanned chassis number at the ingate to an active gate appointment that has a suitable matching criterion for the truck visit.
The AssignScannedChassisNbrsToAppointments business task matches the scanned Chassis Number with the appointments and integrates the information into the transaction record and the unit record. This business task considers 'is-owners' and 'on-chassis-id' attributes from the chassis element in order to match the chassis numbers to the appointments.
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)
AssignScannedContainerNbrsToAppointments (on page 1)
ReadGateAppointment (on page 1)
Custom Code
None
Field(s)
None
|
Functional Area |
Pre-advise Vessel, Pre-advise Rail, Appointment, IFT, and Gate |
|
Execution Level |
Transaction/Truck Visit |
|
Transaction Type(s) |
Pre-advise Vessel: Pre-advise Rail: Appointment: IFT: 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), Unknown (UK) Truck Visit IN, Truck Visit OUT, Truck Visit APPTTV |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
RejectScannedChassisNbrMismatch (on page 1) |
|
Field(s) |
None |
Description
The business task assigns scanned chassis numbers at the outgate to active deliver and through container gate transactions for the truck visit. If both the business tasks, AssignScannedChassisNbrsToPickups and RejectScannedChassisNbrMismatch are included and the chassis ID at the outgate does not match the scanned chassis ID, N4 rejects the gate transaction and does not allow the chassis to pass through the outgate.
Parameters
None
Dependencies
To ensure that only the expected chassis are associated with the truck at the outgate, you must include the RejectScannedChassisNbrMismatch business task.
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:
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.
The business task attempts to match and assign the container number scanned at the ingate to appointments that do not contain the contain numbers thus integrating the scanned container and appointment details.
This business task matches the scanned containers to the appointments, first by the Container Number and then by the ISO Type, with the order item specified in the appointment.
You must include this business task in your gate configuration if the following are true:
You do not always receive containers by specific container numbers, but instead sometimes receive the container by container type.
You scan containers at the ingate.
You use either the process-truck or the record-scan web service API to send scanned data to N4.
The AssignScannedContainerNbrsToAppointments business task is similar to the AssignScannedContainerNbrsToPickups (on page 1) business task.
Functional Area
Gate
Execution Level
Truck Visit
Transaction Type(s)
Truck Visit IN
Client Type(s)
UI and Gate API
Parameters
matchRandomlyForUnmatchedCtrs: If the matchRandomlyForUnmatchedCtrs parameter is set to false (No), the AssignScannedContainerNbrsToAppointments business task attempts to match scanned containers as follows:
If the receive transaction appointment contains a container number that matches a scanned container received via the process-truck API, N4 proceeds with the truck visit level workflow.
If the receive transaction appointment does not contain a container number but the ISO code matches the ISO code of a scanned container received via the process-truck API, N4 proceeds with the truck visit level workflow.
If the receive transaction appointment contains a container number but N4 receives only the ISO code of the scanned container via the process-truck API, N4 proceeds with the truck visit level workflow only if the ISO codes match.
If a match is found, N4 uses the matching container. However, all validations performed for the matching container are done per the other included business tasks. If no matches are found, N4 moves the truck visit to Trouble.
When the matchRandomlyForUnmatchedCtrs parameter is set to true (Yes), N4 matches the scanned container with the appointments at random. Therefore, this parameter must be set to false (No) if you do not want N4 to match random containers with the appointment.
Dependencies
N4 executes the AssignScannedContainerNbrsToAppointments business task before the RejectScannedContainerNbrMismatch (on page 1) business task to indicate that the containers matching the appointment are expected.
Related Business Task(s)
AssignScannedChassisNbrsToAppointments (on page 1)
ReadGateAppointment (on page 1)
Custom Code
None
Field(s)
None
The business task assigns scanned container numbers at the outgate to active deliver and through container gate transactions for the truck visit. Use this business task if the following are true:
You do not always pickup containers by specific container numbers, but instead sometimes pickup by order item or container type.
You scan containers at the outgate.
You use either the process-truck or record-scan web service API to send scanned data to N4.
If you use the AssignScannedContainerNbrsToPickups business task, then the CopyContainerAssignedToNbr (on page 1) is no longer required to prevent errors from the RejectScannedContainerNbrMismatch (on page 1) business task at the outgate.
The AssignScannedContainerNbrsToPickups business task attempts to match scanned containers as follows:
If a specific container was requested at the ingate, or if it is a through container gate transaction, then N4 searches for the scanned container that matches the requested or through container.
If the gate transaction has an associated order item, then N4 searches for scanned containers that match the order item, such as scanned containers with the same line operator, size, and type as the order item.
If the gate transaction does not have an associated order item, then N4 searches for scanned containers that match the gate transaction's container length, height, ISO group, material, grade, and condition. N4 scores any matching containers, giving a higher score to containers with more matches and weighting matches for container length, height, and ISO group higher than for material, grade, and condition. N4 selects the matching container with the highest score.
If no matches are found, N4 does not produce an error. The purpose of this business task is to attempt to match and assign scanned containers to deliver and through container gate transactions.
If a match is found, N4 uses the matching container. However, all validations performed for the matching container are done per the other included business tasks.
Functional Area
Gate
Execution Level
Truck Visit
Transaction Type(s)
Truck Visit OUT
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
To ensure that the expected containers are on the truck at the outgate, you must include the RejectScannedContainerNbrMismatch (on page 1) business task.
Related Business Task(s)
CopyContainerAssignedToNbr (on page 1)
RejectScannedContainerNbrMismatch (on page 1)
Custom Code
None
Field(s)
None
|
Functional Area |
Gate |
|
Execution Level |
Truck Visit |
|
Transaction Type(s) |
Gate: Truck Visit OUT |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
None |
|
Field(s) |
None |
Description
The business task rejects a truck visit at the outgate when the scanned accessory number(s) received from the record-scan web service API does not match the expected accessory number(s) for all of the gate transactions associated with the truck visit.
For example, for a receive gate transaction, any accessories dropped off should be present when the truck is scanned at the outgate, and for a deliver gate transaction, any accessories picked up should be present when the truck is scanned at the outgate.
Parameters
None
Dependencies
You must include this business task only for gate automation with the record-scan web service API.
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:
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.
|
Functional Area |
Gate |
|
Execution Level |
Truck Visit |
|
Transaction Type(s) |
Gate: Truck Visit OUT |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
AssignScannedChassisNbrsToPickups (on page 1) |
|
Field(s) |
None |
Description
The business task rejects a truck visit at the outgate stage when the scanned chassis number(s) received from the record-scan web service API does not match the expected chassis number(s) for all of the gate transactions associated with the truck visit.
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:
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.
You must use this business task only for gate automation with the record-scan web service API.
This business task rejects a truck visit at the ingate or outgate when the scanned container number(s) received from the record-scan web service API do not match the expected container number(s) for all of the gate transactions associated with the truck visit.
For example, for a receive gate transaction, any containers dropped off should not be present when the truck is scanned at the outgate, and for a deliver gate transaction, any containers picked up should be present when the truck is scanned at the outgate.
You can also include the RejectScannedContainerNbrMismatch business task at the ingate to reject gate transactions when the container number mismatch occurs for a receival or through container.
If you want to use the RejectScannedContainerNbrMismatch business task at a gate stage before N4 creates gate transactions, such as a pre-stage gate stage, you must use appointments and set the Compare Scans To parameter to appointments.
Functional Area
Gate
Execution Level
Truck Visit
Timing
Validation
Transaction Type(s)
Truck Visit IN, Truck Visit OUT
Client Type(s)
Gate API
Parameters
Ignore ROT's: By default, N4 validates through containers for a container number mismatch. If you want N4 to ignore through containers, select this check box.
includeCanceledReceives:
False - By default, this parameter is 'False'. N4 does not include the canceled receive transactions for validation by this business task.
True - If you set it as 'True', all receive transactions that get canceled without processing yard stage also get included for validation by this business task. The container numbers associated to the canceled receive transactions also get added to the expected list at outgate. N4 behavior at the outgate with the parameter set to ‘True’:
When a truck associated to a canceled receive transaction arrives at the outgate with a container, N4 validates and successfully processes truck exit if the scanned container number matches with the expected number.
When a truck associated to a canceled receive transaction arrives at the outgate with a container, and that container number does not match the expected number, N4 validates and displays error message ‘Unexpected Container <ctrnbr> was scanned’.
When a truck associated to a canceled receive transaction arrives at the outgate without a container, N4 validates and displays error message ‘Expected Container <ctrnbr> was not scanned’.
Compare Scans To: By default, N4 tries to compare the scanned container numbers to the container numbers associated to the truck visit's gate transactions. Valid options are:
transactions: This is the default behavior. N4 compares scanned container numbers to gate transactions.
appointments: N4 compares scanned container numbers to the container numbers associated with the appointments. This includes checking used appointments for subsequently processed or re-submitted gate transactions against the same truck visit.
Set the Compare Scans To parameter to appointments only if you use appointments and want to use the RejectScannedContainerNbrMismatch business task at a gate stage before N4 creates gate transactions, such as a pre-stage gate stage. Otherwise, you do not need to set the Compare Scans To parameter.
If the Compare Scans To parameter is not relevant for a gate transaction, the gate workflow skips the RejectScannedContainerNbrMismatch business task. For example, if you include the RejectScannedContainerNbrMismatch business task in your gate configuration and set the Compare Scans To parameter = appointments, the gate workflow skips the business task if an appointment number is not provided.
Dependencies
If included in the gate configuration, N4 executes the AssignScannedContainerNbrsToAppointments business task before the RejectScannedContainerNbrMismatch (on page 1) business task to indicate that the containers matching the appointment are expected.
N4 does not support appointments for bundled containers. The bundle information must be passed through the process-truck API to link the transaction appointment with the appointment data and scanned bundled data.
Related Business Task(s)
AssignScannedContainerNbrsToAppointments (on page 1)
Custom Code
None
Field(s)
None
Rejects a truck visit if the truck details on an existing truck visit, found using a scanned container number, does not match the truck details provided by a gate clerk.
For terminals that use scanners to read truck license numbers to find existing truck visits, when N4 cannot find a truck visit based on the scanned truck license number N4 searches for a truck visit using the scanned container number. Therefore, if N4 finds a truck visit using the scanned container number, but the truck details on the existing truck visit do not match those provided by a gate clerk, then this business task rejects the truck visit.
Use only for gate automation with the record-scan web service API.
|
Gate stage |
|
Truck Visit IN Truck Visit OUT |
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Receive Export (RE), Dray In (RI), Receive Empty (RM), and Deliver Import (DI) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
None |
|
Field(s) |
None |
Description
Updates the ISO type of a pre-advised container to the ISO type scanned at the gate if the ISO type scanned at the gate has the same archetype as the pre-advised container.
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.
See also, RejectContainerTypeFromScan (on page 1).