Carrier

• RejectCarrierVisitBeforeBeginReceive    1

• RejectCarrierVisitBeforeEmptyPickup    1

• RejectCarrierVisitLineNotAllowed    1

• RejectCarrierVisitNotMatchingBooking    1

• RejectObCvVesselLocked    1

• RejectCarrierVisitNotProvided    1

• RejectCarrierVisitPastCutoff    1

• RejectCarrierVisitPhaseDeparted    1

• RejectDateNotMatchingEarlyOrLatestDate    1

• RejectDischargePointBeforeLoadPoint    1

• RejectDischargePointNotInRotation    1

• RejectCarrierVisitWrongFacility    1

• RejectDischargePointNotProvided    1

• RejectLoadPointNotInRotation    1

• RejectUnitPastTrainETDCutoff    1

RejectCarrierVisitBeforeBeginReceive

The business task rejects a gate transaction if the current date is before the Begin Receive date for the specified outbound carrier.

Functional Area

Pre-advise Vessel, Pre-advise Rail, Appointment, IFT, and Gate

Execution Level

Transaction

Transaction Type(s)

Pre-advise Vessel: Receive Export (RE), Dray In (RI)

Pre-advise Rail: Receive Export (RE), Dray In (RI)

Appointment: Receive Break-Bulk (RB), Receive Export (RE)

IFT: Receive Export (RE)

Gate: Receive Break-Bulk (RB), Receive Export (RE)

Timing

• on-submit: When the truck is sent to next stage, but only after successful execution of the Validation tasks.

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

The Begin Receive date must be specified for the vessel visit. For more information on setting the Begin Receive date for a vessel visit, see the Timing tab in the Edit Vessel Visit Details form.

Related Business Task(s)

RejectCarrierVisitBeforeEmptyPickup (on page 1)

Custom Code

None

Field(s)

None

RejectCarrierVisitBeforeEmptyPickup

The business task rejects a gate transaction if the current date is before the Empty Pickup date for the specified outbound carrier.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Empty (DM)

Gate: Deliver Empty (DM)

Timing

on-submit: When the truck is sent to next stage, but only after successful execution of the Validation tasks.

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

The Empty Pickup date must be specified for the vessel visit or the line operator for the vessel visit. For more information on setting the Empty Pickup date for a vessel visit, see the Timing tab in the Edit Vessel Visit Details form and to set up the Empty Pickup date for the line operator, see Line Operator Using the Vessel form.

The values specified in the Line Operator Using the Vessel form override the values specified in the Timing tab in the Edit Vessel Visit Details form.

Related Business Task(s)

RejectCarrierVisitBeforeBeginReceive (on page 1)

Custom Code

None

Field(s)

None

RejectCarrierVisitLineNotAllowed

Rejects a transaction if the specified line operator is not included in the carrier visit schedule.

RejectCarrierVisitNotMatchingBooking

Rejects a gate transaction if the vessel visit specified in the user interface (Appointment form (on page 1) or <GateStage> tab (on page 1)) does not match the vessel visit specified for the selected booking.

RejectObCvVesselLocked

Description

The business task must be included at the appointment and ingate stages for export containers if you are using the vessel 'locked' option in N4. For details, see Locking a vessel visit.

When you include this business task, you cannot-

• Create a drop-off appointment for a non-preadvised container if the booking is associated with a locked vessel visit.

• Gate-in a non-preadvised unit by associating it with vessel visit that is locked.

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 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 pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectCarrierVisitNotProvided

Rejects a transaction if an outbound carrier visit cannot be determined from the specified carrier information, equipment order number, or Container ID.

RejectCarrierVisitPastCutoff

Description

The business task rejects a gate transaction if the current date is past the Dry Cutoff date specified for the outbound carrier and the line operator does not allow containers to automatically roll to the next vessel visit in the service. However, if the line operator allows containers to automatically roll to the next vessel visit in the service and another vessel visit for the same service and line operator exists, N4 ignores the business task. For more information on rolling specifications for a line operator, see Booking Rules tab.

For rail operations, the business task rejects a gate transaction if the current date is past the Cutoff date specified for the train visit.

To prevent a user from creating an appointment for an outbound carrier where the Requested Appointment Date is past the vessel visit's Dry Cutoff date, include this business task at the appointment stage too.

Parameters

To determine if the RejectCarrierVisitPastCutoff business task checks the hazard check box when validating hazardous containers against a carrier visit's hazardous cutoff, you can use the useTranHazardFlag parameter (on page 1). If you set it as:

• YES: N4 validates hazardous cutoffs when a user either selects the hazard check box or records hazard classes against a container in a gate form.

• NO: (Default) N4 validates hazardous cutoffs only when a user records hazard classes against a container in a gate form.

Dependencies

• For vessel operations, specify the Dry Cutoff date on the Timing tab in the Edit Vessel Visit Details form.

• For rail operations, specify the Cutoff date on the Timing tab in the Edit Train Visit form.

• For containers arriving at the current facility (facility A) but departing another facility (facility B) against a facility relay, this business task rejects a transaction if the current date is past the Dry Cutoff date at the departing facility (facility B) minus the Dry Cutoff lead time specified in the facility relay. For more information, see Facility Relay form.

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

• For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectCarrierVisitPhaseDeparted

The business task rejects a gate transaction if both the following conditions are true:

• The outbound carrier of the container is in any one of the following phases:

• COMPLETE

• DEPARTED

• CLOSED

• CANCELLED

• ARCHIVED

• And the line operator does not allow containers to automatically roll to the next visit in the service.

However, if the line operator allows containers to automatically roll to the next vessel in the service and another vessel visit for the same service and line operator exists, N4 ignores the business task. For more information on rolling specifications for a line operator, see Booking Rules tab.

You must include this business task at the appointment stage too if you want to prevent a user from creating an appointment for an outbound carrier that is in any one of the above phases.

Functional Area

Pre-advise Vessel, Pre-advise Rail, IFT, Appointment, and Gate

Execution Level

Transaction

Transaction Type(s)

Pre-advise Vessel: Receive Export (RE), Dray In (RI)

Pre-advise Rail: Dray In (RI)

IFT: Receive Export (RE)

Appointment: Deliver Empty (DM), Receive Break-Bulk (RB), Receive Export (RE)

Gate: Deliver Empty (DM), Receive Break-Bulk (RB), Receive Export (RE)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectDateNotMatchingEarlyOrLatestDate

Description

Rejects a transaction if the current date is not within the range defined by the Earliest Date and Latest Date fields for the equipment receive or delivery order. For more information, see Equipment Receive Order form or Equipment Delivery Order form.

Parameters

useAppointmentRequestedDate: If set to TRUE, True, true, YES, Yes, yes, Y, or y, N4 allows you to validate the appointment requested date instead of the current system date against the Earliest/Latest date and creates an appointment. This parameter is applicable to all the gate and appointment transaction types pertaining to the 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).

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

RejectDischargePointBeforeLoadPoint

Rejects a gate transaction if the discharge point is before the load point in the itinerary for the carrier visit.

RejectDischargePointNotInRotation

Description

The business task rejects a gate transaction if the POD (Port of Discharge) specified for the export unit is not in the itinerary for the specified carrier visit. This can happen if the booking has a POD that was later taken out of the carrier's rotation.

If you want to allow the gate clerk to receive a container where the POD is not in the carrier's service rotation and then let the vessel planner assign the appropriate POD to the unit at a later point, do not include this business task.

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 appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

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

• For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> 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.

RejectCarrierVisitWrongFacility

Rejects a transaction if the specified export container is pre-advised at a facility that does not match the facility for the specified booking.

RejectDischargePointNotProvided

Rejects a transaction if the discharge point cannot be determined due to any or all of the following reasons:

• Not entered by the user

• Not found on the export booking for the specified unit

• Not specified for the pre-advised unit

RejectLoadPointNotInRotation

Rejects a gate transaction if the load point is not in the itinerary for the carrier visit.

RejectUnitPastTrainETDCutoff

Rejects a gate transaction if the unit arrives past the cutoff time for the train visit specified as the outbound carrier for the unit.

Use the minutesBefore parameter (on page 1) to specify the cutoff time for the units with train as the outbound carrier. The unit must arrive at the gate no later than the specified number of minutes before the estimated time of departure (ETD) of the train visit.

For example, if you specify the cutoff time as 30 minutes and the ETD for the train visit is 13:30, all units intended to go out on the train must arrive at the gate no later than 13:00.