|
Functional Area |
Appointment, IFT, and Gate |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Appointment: 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) 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) IFT: Deliver Import (DI) |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
RejectOrderHold (on page 1) |
|
Field(s) |
None |
Description
The business task rejects a gate transaction if the following conditions are true:
An active hold/permission exists for the unit (container or chassis) specified in the appointment or gate form
An active hold/permission exists for a guardian, such as equipment, export booking, or bill of lading, of the unit specified in the gate form.
The hold/permission is associated with a service business rule that prevents the gate transaction from occurring.
For example, if you include the RejectUnitServiceRules business task at the appointment stage, N4 returns an error if the unit specified in the appointment has a ‘Hold On Guardian’.
If a permission is required for the bill of lading specified in the gate form, and the permission is associated with a service business rule that prevents a UNIT_DELIVER event for the unit (guarded entity) requested at the gate, N4 rejects the deliver gate transaction.
If you include the RejectUnitServiceRules business task in your gate configuration, the business task covers the following scenarios for a gate transaction including a chassis:
If you are delivering a chassis that has a hold, the business task returns an error.
If you are delivering a container on a chassis that has a hold, the business task returns an error.
If you are delivering a container on a chassis and both the container and the chassis have a hold, the business task returns two separate errors, one for the container hold and the other for the chassis hold.
If you are delivering a container on a chassis, and only the container has a hold, the container and the chassis gates out without any errors.
The business task does not return any errors if the gate transaction is using an Owner chassis.
For Break-Bulk Cargo
For the Break-Bulk gate transaction types, N4 checks the Bill of Lading specified at the gate and not the Cargo Lot. N4 rejects a gate transaction only if the Bill of Lading has a hold for the UNIT_DELIVER event and the RejectUnitServiceRules business task is included for the Deliver Break-Bulk (DB) gate transaction type.
We recommend that you include the RejectUnitServiceRules business task in at least one gate stage for each gate transaction type.
Parameters
IncludeCovertHold: Determines whether covert holds are evaluated at the ingate and outgate. By default, this is set to True for both the ingate and the outgate. It is recommended that you set this to False for each gate transaction type at the ingate stage. This enables the truck driver to come into the terminal unawares but prevents them from leaving due to the active covert hold. See also How do I create covert holds?
Event Type Override: Determines if N4 evaluates the RejectUnitServiceRules business task against the default event types or a specific event type. The default event types are UNIT_DELIVER for delivery gate transactions and UNIT_RECEIVE for receival gate transactions. When this parameter is not set or null, N4 uses the default event types. To define a specific event type, select the event type from the drop-down list.
The RejectUnitServiceRules business task does not support custom events. If the task is NOT parameterized with an event, N4 considers the UNIT_RECEIVE for receival transactions and UNIT_DELIVER and UNIT_OUT_GATE events for delivery transactions. To include custom events, you can add a groovy code for this business task.
Dependencies
None
Timing
For appointments, N4 processes business tasks on two occasions:
If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).
If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.
For 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.
|
Functional Area |
Appointment |
|
Execution Level |
Transaction |
|
Transaction Type(s) |
Appointment: Receive Export (RE), Receive Import (RI), Receive Empty (RM), Deliver Empty (DM), Deliver Import (DI), Deliver Export (DE), ( Receive Chassis (RC) and Delivery Chassis (DC). |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
RejectUnitServiceRules (on page 1) |
|
Field(s) |
None |
Description
The business task rejects an appointment for a container with an equipment hold.
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.