The business task applies the accessory number and type of accessories, such as genset, recorded during an inspection to the gate transaction.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Unknown (UK)
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).
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
None
Related Business Task(s)
ApplyInspectionBundles (on page 1)
ApplyInspectionDamages (on page 1)
ApplyInspectionOOG (on page 1)
ApplyInspectionPhysicalDetails (on page 1)
ApplyInspectionPlacards (on page 1)
ApplyInspectionReeferDetails (on page 1)
ApplyInspectionSeals (on page 1)
ApplyInspectionUnitFlexFields (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)
Chassis Accessory Number (on page 1)
Container Accessory Nbr (on page 1)
Chassis Accessory Type (on page 1)
Container Accessory Type (on page 1)
The business task applies bundle data recorded as part of the gate inspection to the gate transaction.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Unknown (UK)
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).
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
If you check the bundle data at the same gate stage as the gate inspection, you must also include the WaitForContainerInspection (on page 1) business task.
Related Business Task(s)
ApplyInspectionBundles (on page 1)
ApplyInspectionDamages (on page 1)
ApplyInspectionOOG (on page 1)
ApplyInspectionPhysicalDetails (on page 1)
ApplyInspectionPlacards (on page 1)
ApplyInspectionReeferDetails (on page 1)
ApplyInspectionSeals (on page 1)
ApplyInspectionUnitFlexFields (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
The business task applies the damages recorded during an inspection to the gate transaction. Since during an inspection you can record the damages for equipment (Container, Chassis) and accessories (Genset), N4 separates the recorded Inspection damages based on the Damage Component/Type. The business task sets the damages in the gate transaction depending on whether the recorded damage is for a container, chassis, or accessory. When the damages are copied to the units, the All Equipment tab in Unit Inspector displays the recorded damages, accordingly.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Gate: Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Unknown (UK)
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).
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
To copy these damages recorded as part of an inspection from the gate transaction to the unit, you must include the following business tasks:
ApplyContainerDamages (on page 1)
ApplyCtrAccessoryDamages (on page 1)
ApplyChassisDamages (on page 1)
ApplyChsAccessoryDamages (on page 1)
Related Business Task(s)
None
Custom Code
Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.
Field(s)
None
Applies Is OOG as well as individual out of gage dimension values recorded during an inspection to the gate transaction.
|
Gate stage |
|
Receive Export (RE) Dray In (RI) Receive Empty (RM) Through Container (TC) Unknown (UK) |
The business task applies the physical details recorded against a unit during an inspection, to the gate transaction.
For a container, it applies the following fields to the gate transaction:
Grade
Material
Safe Weight
Tare Weight
CSC Date
Notes
Door Direction
Truck Position
Container Type ID
Tank Rails
M&R
For a chassis, it applies the following fields to the gate transaction:
Chassis Safe Weight
Chassis Tare Weight
Chassis Type ID
Notes
N4 does not execute this business task if you submit the gate transaction at the trouble desk (Trouble Transactions tab (on page 1)).
If you do not enter any of the above fields during the inspection, the business task does not overwrite or remove any of those values that N4 may have already saved against the gate transaction.
To copy the notes from the gate transaction to the container or bare chassis unit, you must also include the ApplyContainerNotes (on page 1) business task for the gate transaction type.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Unknown (UK)
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
You must include the WaitForContainerInspection business task for this business task to apply the container details from the gate inspection to the gate transaction record. If you do not include the WaitForContainerInspection business task, N4 does not apply the inspection details to the gate transaction.
You must include the WaitForChassisInspection business task for this business task to apply the chassis details from the gate inspection to the gate transaction record. If you do not include the WaitForChassisInspection business task, N4 does not apply the inspection details to the gate transaction.
If a gate clerk updates unit information, such as Equipment Grade or Condition, at a gate stage after the creation of the unit, then you must also include the ApplyPhysicalDetails business task in the gate configuration to update the changes to the selected unit.
Related Business Task(s)
ApplyContainerNotes (on page 1)
WaitForChassisInspection (on page 1)
WaitForContainerInspection (on page 1)
Custom Code
None
Field(s)
None
The business task applies hazard placards recorded during an inspection to the gate transaction.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Export (RE), Dray In (RI), Receive Empty (RM), Unknown (UK)
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
You must include the WaitForContainerInspection business task for this business task to apply the container hazard placard details from the gate inspection to the gate transaction record. If you do not include the WaitForContainerInspection business task, N4 does not apply the hazard placard details to the gate transaction.
Related Business Task(s)
WaitForContainerInspection (on page 1)
Custom Code
None
Field(s)
None
Applies the Temp Observed, Temp Setting, Vent Setting, and Vent Unit values recorded during an inspection to the gate transaction.
|
Gate stage |
|
Receive Export (RE) Dray In (RI) Receive Empty (RM) Through Container (TC) Unknown (UK) |
Applies seal data recorded as part of the gate inspection to the gate transaction. If you check the seals at the same gate stage as the gate inspection, you must also include the WaitForContainerInspection (on page 1) business task.
|
Gate stage |
|
Receive Export (RE) Dray In (RI) Receive Empty (RM) Unknown (UK) |
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Unknown (UK) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
None |
|
Field(s) |
None |
Description
The business task applies unit flex field data recorded during an inspection to the gate transaction.
Parameters
None
Dependencies
Include this field in your gate configuration only if you have flex fields configured in the Inspection form (on page 1). If you do not configure any flex fields in the Inspection form, this business task clears out any unit flex fields during the gate transaction.
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.
The business task applies inspection data, such as seals, damages, MNR date, container CSC, notes, container grade, and material details, recorded as part of a yard inspection to a gate transaction.
Use this business task if you perform yard inspections after you initiate a delivery gate transaction. You can include this business task at an outgate stage or at a gate stage involving a yard inspection.
If the container and chassis included in a gate transaction exist as separate units in the yard, the business task includes the damages recorded against the chassis and the container in the gate transaction. As a result, you can include both container and chassis damages in any XML payloads and include them in the printed gate tickets.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
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).
Client Type(s)
UI and Gate API
Parameters
mergeRequiredWithEqDamages: Set it to Y, YES, or TRUE to ensure that the damages added at the gate stage are merged with any damages recorded at part of the gate inspection and then added to the gate transaction. If you do not set the parameter, N4 adds only the inspection damages to the gate transaction and does not allow the user to add, edit, or save the damages added at the gate stage.
For more information on setting parameters, see Business Tasks form (on page 1).
Dependencies
None
Related Business Task(s)
None
Custom Code
None
Field(s)
None
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Unknown (UK) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
StopOnChsInspectionNotFound (on page 1) StopOnCtrInspectionNotFound (on page 1) WaitForChassisInspection (on page 1) WaitForContainerInspection (on page 1) |
|
Field(s) |
None |
Description
The business task rejects a gate transaction if the container inspection data is not available. However, the RejectInspectionNotFound business task does not stop the gate workflow from continuing to process the gate transaction. This will result in more errors that are all related to the missing inspection record. To stop the gate workflow from further processing the gate transaction if the container inspection data is not available, you must include the StopOnCtrInspectionNotFound (on page 1) and the StopOnChsInspectionNotFound (on page 1) business tasks in the gate configuration.
Parameters
messageLevel: Specifies the level of error message that the business task must return. You can select one of the following values for this parameter:
ERROR: Returns an error message.
WARNING: Returns a warning message.
INFO: Logs the problem but does not display an error message in the User Interface.
NONE: Does not return any error.
This has the same effect as not including the business task in the gate configuration.
isChsInspectionReqdForCntrOnChs: Determines whether the chassis inspection is required or not when the container specified in the gate transaction is mounted on a chassis. If set to yes, the RejectInspectionNotFound business task rejects the gate transaction if a chassis inspection is not found.
Dependencies
You must include the WaitForChassisInspection (on page 1) (if isChsInspectionReqdForCntrOnChs is set as yes) and the WaitForContainerInspection (on page 1) business tasks and set the chsInspectionAgeMins parameter and the ctrInspectionAgeMins parameter, respectively, to specify the time in minutes for which an inspection record should stay valid.
You must include the StopOnChsInspectionNotFound (on page 1) and the StopOnCtrInspectionNotFound (on page 1) business tasks in the gate configuration to stop the gate workflow from further processing the gate transaction if the container inspection data is not available. This will help prevent N4 from generating more errors that are simply a result of missing inspection data.
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: When the truck is sent to next stage, but only after successful execution of the Validation tasks.
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.
Rejects a gate transaction when an inspector selects the Has Trouble check box in the Inspection form (on page 1) or handheld device.
You should set the failure action (on page 1) for RejectInspectorSentToTrouble business task to Trouble - Desk.
|
Gate stage |
|
Receive Chassis (RC) Receive Export (RE) Dray In (RI) Receive Empty (RM) Unknown (UK) |
Rejects a gate transaction and generates an error when inspections associated with a truck license number include equipment without an active transaction or include equipment that is not part of a known bundle.
|
Gate stage |
|
Truck Visit IN |
|
Functional Area |
Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Gate: Deliver Chassis (DC), Receive Chassis (RC) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
RejectInspectionNotFound (on page 1) WaitForChassisInspection (on page 1) |
|
Field(s) |
None |
Description
If the RejectInspectionNotFound (on page 1) business task returns an error for a missing gate inspection, this business task stops any further processing of the gate transaction. The StopOnChsInspectionNotFound business task prevents additional error messages from being logged for missing inspection data. The StopOnChsInspectionNotFound business task stops any further processing of the gate transaction but does not return any error. You must include the RejectInspectionNotFound (on page 1) to get an error stating that the inspection record is missing.
To enable N4 to retry to process the gate transaction, you must include the WaitForChassisInspection (on page 1) business task and set the Failure Action for the WaitForChassisInspection business task as No Inspection.
Parameters
None
Dependencies
You must include the RejectInspectionNotFound and WaitForChassisInspection business tasks. In addition, set the Failure Action for the WaitForChassisInspection business task if N4 does not find an inspection record when processing a gate transaction.
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.
If the RejectInspectionNotFound (on page 1) business task returns an error for a missing gate inspection, this business task stops any further processing of the gate transaction. The StopOnCtrInspectionNotFound business task prevents additional error messages from being logged for missing inspection data, such as an error message for a missing seal number. The StopOnCtrInspectionNotFound business task stops any further processing of the gate transaction but does not return any error. You must include the RejectInspectionNotFound (on page 1) to get an error stating that the inspection record is missing.
To enable N4 to retry to process the gate transaction, you must include the WaitForContainerInspection (on page 1) business task and set the Failure Action for the WaitForContainerInspection business task as No Inspection.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
You must include the RejectInspectionNotFound and WaitForContainerInspection business tasks. In addition, set the Failure Action for the WaitForContainerInspection business task if N4 does not find an inspection record when processing a gate transaction.
Related Business Task(s)
RejectInspectionNotFound (on page 1)
WaitForContainerInspection (on page 1)
Custom Code
None
Field(s)
None
The business task validates that a chassis inspection is complete before N4 continues to process an automated gate transaction. If you submit a gate transaction using a gate form in N4, you must include the RejectInspectionNotFound (on page 1) business task to display any missing inspection error messages on the screen. To add an inspection record, see Inspections view (on page 1).
The WaitForChassisInspection business task checks for inspections, instantaneously. If you do not know whether an inspection is ready for the client, the recommended approach is to poll the status by attempting to submit the gate transaction and setting the Failure Action for the WaitForChassisInspection business task as No Inspection.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Deliver Chassis (DC), Deliver Import (DI), Delivery Empty (DM), Dray Off (DE), Unknown (UK)
Client Type(s)
UI and Gate API
Parameters
chsInspectionAgeMins: Specifies the time in minutes for which an inspection record should stay valid. Use this parameter to prevent N4 from using an old inspection from a previous visit if a current inspection is not available. For example, to ensure that an inspection is valid for 24 hours, set this parameter as 1440.
It is recommended that you specify the value of the chsInspectionAgeMins parameter as at least 30 minutes. If the chsInspectionAgeMins parameter is null (not used), then N4 uses the default value of 30 minutes.
Dependencies
You must include the StopOnChsInspectionNotFound (on page 1) business task to stop any further processing of the gate transaction if a gate inspection record is not found. The StopOnChsInspectionNotFound (on page 1) business task only stops the processing of the gate transaction but does not display any errors. To display an error, you must include the RejectInspectionNotFound (on page 1) business task.
The WaitForChassisInspection business task does not apply inspection details to a gate transaction. To apply the inspection values to the gate transaction, you must include the appropriate apply business tasks:
ApplyInspectionAccessories (on page 1)
ApplyInspectionDamages (on page 1)
ApplyInspectionPhysicalDetails (on page 1)
ApplyInspectionUnitFlexFields (on page 1)
If the WaitForChassisInspection and the ApplyInspection... business tasks are included in your gate configuration and inspection data exists for a gate transaction, the inspection data has a higher priority over any updates made by a gate clerk. If the gate clerk enters a value that overwrites the inspection data, N4 does not save that overwrite and the gate transaction record is saved with the values from the inspection data.
Related Business Task(s)
CreateNewAccessory (on page 1)
RejectInspectionNotFound (on page 1)
StopOnChsInspectionNotFound (on page 1)
Custom Code
None
Field(s)
None
The business task validates that a container inspection is complete before N4 continues to process an automated gate transaction. If you submit a gate transaction using a gate form in N4, you must include the RejectInspectionNotFound (on page 1) business task to display any missing inspection error messages on the screen. To add an inspection record, see Inspections view (on page 1).
The WaitForContainerInspection business task checks for inspections, instantaneously. If you do not know whether an inspection is ready for the client, the recommended approach is to poll the status by attempting to submit the gate transaction and setting the Failure Action for the WaitForContainerInspection business task as No Inspection.
Functional Area
Gate
Execution Level
Transaction
Transaction Type(s)
Receive Export (RE), Dray In (RI), Receive Empty (RM), Deliver Import (DI), Delivery Empty (DM), Dray Off (DE), Unknown (UK)
Client Type(s)
UI and Gate API
Parameters
ctrInspectionAgeMins: Specifies the time in minutes for which an inspection record should stay valid. Use this parameter to prevent N4 from using an old inspection from a previous visit if a current inspection is not available. For example, to ensure that an inspection is valid for 24 hours, set this parameter as 1440.
It is recommended that you specify the value of the ctrInspectionAgeMins parameter as at least 30 minutes. If the ctrInspectionAgeMins parameter is null (not used), then N4 uses the default value of 30 minutes.
Dependencies
You must include the StopOnCtrInspectionNotFound (on page 1) business task to stop any further processing of the gate transaction if a gate inspection record is not found.
The WaitForContainerInspection business task does not apply inspection details to a gate transaction. To apply the inspection values to the gate transaction, you must include the appropriate apply business tasks:
ApplyInspectionAccessories (on page 1)
ApplyInspectionBundles (on page 1)
ApplyInspectionDamages (on page 1)
ApplyInspectionOOG (on page 1)
ApplyInspectionPhysicalDetails (on page 1)
ApplyInspectionPlacards (on page 1)
ApplyInspectionReeferDetails (on page 1)
ApplyInspectionSeals (on page 1)
ApplyInspectionUnitFlexFields (on page 1)
If included, N4 executes the CreateNewAccessory (on page 1) business task before the WaitForContainerInspection business task. Since you can add an accessory in an inspection, the WaitForContainerInspection business task checks whether the CreateNewAccessory business task is included in the gate configuration and re-executes it to ensure that the accessory record is associated with the container.
If the WaitForChassisInspection and the ApplyInspection... business tasks are included in your gate configuration and inspection data exists for a gate transaction, the inspection data has a higher priority over any updates made by a gate clerk. If the gate clerk enters a value that overwrites the inspection data, N4 does not save that overwrite and the gate transaction record is saved with the values from the inspection data.
Related Business Task(s)
CreateNewAccessory (on page 1)
RejectInspectionNotFound (on page 1)
StopOnCtrInspectionNotFound (on page 1)
Custom Code
None
Field(s)
None