Chassis

• ApplyBareChassisEmptyGoods    1

• ApplyChassisDamages    1

• CopyChassisAssignedToNbr    1

• CreateBareChassisVisit    1

• CreateNewChassis    1

• IncrementChassisTripCount    1

• PlaceBareChassisOnTruck    1

• OnHireChassisToMatchLine    1

• OnHireChassisIfOperatorUnknown    1

• PlaceDismountedChassisIntoYard    1

• PlanDismountedChassisIntoYard    1

• ReturnSwappedChassisToYard    1

• RejectChassisCannotBeUsedByLine    1

• RejectChassisDamaged    1

• RejectChassisEquipmentHold    1

• RejectChassisInYard    1

• RejectChassisNotAtFacility    1

• RejectChassisNotInYard    1

• RejectChassisRequired    1

• RejectChassisSubstitution    1

• RejectChassisTripCountExceeded    1

• RejectChassisUnknown    1

• RejectOwnChassisNotAllowed    1

• RejectOwnChassisNotLeaving    1

• RejectOwnChassisOwnedByLine    1

• RejectOwnChassisTypeMismatch    1

• ResetChassisTripCount    1

• SelectBareChassis    1

• SelectBareChassisForSwap    1

ApplyBareChassisEmptyGoods

Sets the Freight Kind of a bare chassis unit as MTY. This ensures that the chassis can then be delivered against an EDO.

ApplyChassisDamages

This business task applies damages recorded for a chassis, at the gate, to the chassis unit. You may not include this business task if you have already included the CreateBareChassisVisit (on page 1) business task at the selected gate stage.

Functional Area

Gate

Execution Level

Transaction

Transaction Type(s)

Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

If you provide chassis damages in the process-truck API for the gate transaction and want to apply this information to the chassis unit, you must include the ApplyContainerExportGoods business task in your gate configuration.

Related Business Task(s)

CreateContainerVisit (on page 1)

Custom Code

None

Field(s)

Chassis Damages - Add/Edit

CopyChassisAssignedToNbr

Copies the value entered in the Chassis Number Requested field to the Chassis Number field.

In N4, there are two chassis number fields:

• Chassis Number: Used at the ingate to record the chassis being received, and at the outgate to record the chassis being delivered.

• Chassis Number Requested: Used at the ingate for deliver gate transaction types when a specific chassis is requested for delivery.

Include the CopyChassisAssignedToNbr business task for deliver gate transactions, if:

• You want the chassis number requested at the ingate displayed in the Chassis Number field for the gate clerk at the outgate.

Do not include this business task if you require the gate clerk at the outgate to do a blind entry of the actual chassis being delivered.

• The gate you are configuring does not have an outgate stage for deliver gate transaction types.

Since there is no outgate stage to record the chassis number being delivered, the chassis number entered in the Chassis Number Requested field at the ingate must be copied to the Chassis Number field.

If you want to prevent chassis substitution at the outgate and the Chassis Number field is editable in the outgate form, use the RejectChassisSubstitution (on page 1) business task.

CreateBareChassisVisit

Creates a new chassis unit for a bare chassis arriving at the ingate. This business task also applies data, such as any damages recorded at the gate, to the new chassis unit.

If you include this business task, you may not include the ApplyChassisDamages (on page 1) business task.

CreateNewChassis

Description 

The business task creates a new chassis using the information you provided in an appointment or, based on information you provided at the gate.

If you receive two or more containers on the same chassis, N4 creates a new chassis as part of the first gate transaction. However, for the subsequent gate transactions for the same chassis, N4 does not create another chassis unit; instead, it uses the chassis unit create d as part of the first gate transaction.

Parameters

None

Dependencies

You must include the Chassis Type (on page 1) field in the gate form. For more information, see Tran Type form (on page 1).

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.

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.

IncrementChassisTripCount

Increases the trip count of a pooled chassis by one. N4 increments the trip count of a chassis only once per truck visit regardless of the number of transactions in the truck visit.

Include the IncrementChassisTripCount business task in the first inbound gate stage to ensure that the completion of the first stage increments the trip count.

If N4 increments the trip count of a chassis for a truck visit which is then canceled, N4 also decreases the trip count of the chassis by one.

The Trip Count field is displayed in the Equipment Status view and the Equipment Details form.

See also ResetChassisTripCount (on page 1), RejectChassisTripCountExceeded (on page 1).

PlaceBareChassisOnTruck

Places an arriving bare chassis on a truck.

OnHireChassisToMatchLine

Description

The business task updates the Chassis Operator (on page 1) to match the line ID specified in the gate transaction. You can use the business tasks to change the Chassis Operator to match the using Line. The using Line is the Line ID of the Export Booking or the Equipment Receive Order (for empties) specified for the gate transaction. You can include the business task at the In-gate. When you receive a chassis at the gate, the business task updates the Chassis Operator to match the line ID specified in the Gate Transaction.

The business task works for both the existing chassis and the new ones being received. For new ones, any chassis operator specified at the in-gate is ignored and the line ID is persisted as the Chassis Operator for the new chassis created. If there is no line ID specified, the business task uses the Chassis Operator specified in the gate transaction.

The business task is similar to the one for Containers – OnHireContainerToMatchLine (on page 1).

Parameters

None

Dependencies

If your site allows creating new chassis at the gate, ensure that the CreateNewChassis (on page 1) business task is included.

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.

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.

OnHireChassisIfOperatorUnknown

Description

The business task updates the Chassis Operator (on page 1) to match the line ID specified in the gate transaction when you receive a chassis with Chassis Operator Unknown. You can use the business task to update the Chassis Operator to match the using Line, if the Chassis Operator is currently Unknown (UNK). The using line is the Line ID of the Export Booking or the Equipment Receive Order (for empties) specified in the gate transaction. You can include the business task at the In-gate stage. When you receive a chassis with Chassis Operator as Unknown (UNK), the business task updates the Chassis Operator to match the line ID specified in the gate transaction.

The business task works for both the existing chassis and the new ones being received. For new ones, if the Chassis Operator is specified as Unknown (UNK), the business task updates the Chassis Operator to match the line ID specified in the gate transaction. If there is no line ID specified, the business task sets the Chassis Operator as Unknown (UNK).

The business task is similar to the one for Containers – OnHireContainerIfOperatorUnknown (on page 1).

Parameters

None

Dependencies

If your site allows creating new chassis at the gate, ensure that the CreateNewChassis (on page 1) business task is included.

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.

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.

PlaceDismountedChassisIntoYard

The business task creates a work instruction to place the bare chassis in the yard when you place a container that arrived on a chassis in a stack, instead of a wheeled area.

When N4 executes the business task, it separates the chassis from the existing unit, and creates a new unit for the bare chassis.

Functional Area

Gate

Execution Level

Transaction/Truck Visit

Transaction Type(s)

Gate: Receive Export (RE), Dray In (RI), Receive Empty (RM)

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)

PlanDismountedChassisIntoYard (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

PlanDismountedChassisIntoYard

Description

When you place a container that arrived on a chassis in a stack (instead of a wheeled area), you need to separate the chassis and park it in an appropriate place.

If your site uses XPS, include the PlanDismountedChassisIntoYard business task to create a work instruction for XPS to plan a position for the separated chassis. If you use full chassis tracking, XPS assigns a specific location for the separated chassis; otherwise, it assigns a very generic location for the separated chassis.

If your site uses Equipment Control, you should include this business task at the Yard stage because this is where the CHE lifts the container off the chassis. If your site does not use Equipment Control, you should include this business task at an ingate stage because N4 is not aware when the CHE lifts the container off the chassis.

When N4 executes the business task, it separates the chassis from the existing unit, and creates a new unit for the bare chassis.

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

Parameters

• truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. Use this parameter to specify the logical block queue where XPS must position the truck visit.

• workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road.

To configure a work queue to auto-complete road receivals to wheels, where there is no equipment to handle the move, set the workQueue parameter to WHEELS.

• defaultPositionId: Specify a default location for all received units. This enables you to continue gate processing even when XPS is down.

Dependencies

If your site does not use XPS, include the PlaceDismountedChassisIntoYard (on page 1) business task.

Related Business Task(s)

PlaceDismountedChassisIntoYard (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

ReturnSwappedChassisToYard

Description

When you include this business task, N4 allows you to swap one chassis with another at the outgate gate stage. You must include the Chassis Number and Chassis Number Requested fields in the Gate form and provide these value to enable the swap.

Parameters

• yardSlot: Specify the yard slot where the rejected chassis must be placed.

• useLastYardPosition: Set to TRUE, True, true, YES, Yes, yes, Y, or y to return the swapped chassis to the last known yard position.

The useLastYardPosition parameter always takes precedence. If you do not set the useLastYardPosition parameter or set it to a value other than the values listed above, the rejected chassis is returned to the position specified in the yardSlot parameter. If you do not set values in any of the parameters, the rejected chassis is placed in the Y-MAIN position by default.

• useGenTruckAsObVisit: Set to TRUE, True, true, YES, Yes, yes, Y, or y to update the outbound value of the swapped chassis to GEN_TRUCK.

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.

RejectChassisCannotBeUsedByLine

Description

The business task rejects a gate transaction if the specified chassis cannot be used by the line operator specified in the equipment order.

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.

Custom Code

None

RejectChassisDamaged

Rejects a gate transaction if the chassis has any recorded damages.

When including this business task in your gate configuration, you can use the following parameters (on page 1) to configure the type of damages N4 must check to reject a transaction:

• checkTransactionDamages: When set to true (default), N4 rejects a gate transaction only if the chassis damages are recorded as part of the gate transaction.

• checkEquipmentDamages: When set to true (default), N4 rejects a gate transaction only if the chassis damages are a part of the equipment record.

• includeMinorDamage: When set to true (default), N4 checks for both minor and major damages. When set to false, N4 only checks for major damages.

To change the value of these parameters from the default, you need to specify NO. A null value will not change the value to NO. 

Notes

• For a Deliver Chassis (DC) gate transaction, if an Equipment Delivery Order (EDO) associated with a transaction has the Ignore Damages check box selected, this business task does not reject the gate transaction.

• If the RejectChassisDamaged business task is included but no parameter values are set, this business task rejects the transaction if either the transaction or the equipment have any damages recorded against the chassis (including minor damages).

RejectChassisEquipmentHold

Rejects a gate transaction if the chassis has an equipment hold that prevents the gate transaction.

RejectChassisInYard

Description

The business task rejects an appointment or a gate transaction if the specified chassis already exists in the yard.

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.

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.

RejectChassisNotAtFacility

Rejects a gate transaction if the specified chassis is not at the facility.

RejectChassisNotInYard

The business task rejects a gate transaction if the specified chassis is not in the yard.

Functional Area

Appointment and Gate

Execution Level

Transaction

Transaction Type(s)

Appointment: Deliver Chassis (DC)

Gate: Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), 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

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectChassisRequired

Description

The business task rejects a gate transaction if a chassis number is not specified. You can include this business task in your gate configuration to ensure that N4 returns an error if the Chassis Number is not specified.

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

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.

RejectChassisSubstitution

Rejects a gate transaction if the chassis requested at the ingate is substituted by a different chassis at the outgate.

This business task compares the values in the Chassis Number Requested and the Chassis Number fields at the outgate stage. For more information about the two fields, see CopyChassisAssignedToNbr (on page 1).

RejectChassisTripCountExceeded

Returns one of the following messages depending on the current trip count of a pooled chassis and the values of the tripWarnCount and tripRejectCount parameters (on page 1):

• When the Trip Count for a chassis is equal to or greater than the tripWarnCount but less than the tripRejectCount, N4 generates the following message:

Trip Count is {current trip count}, there are {rejectCount - current trip count - 1} trips remaining before equipment {chassisID} needs to return to the depot for inspection

If a value is not specified for the tripWarnCount parameter, N4 logs a message that the RejectChassisTripCountExceeded business task was executed but the tripWarnCount parameter was not specified.

• When the Trip Count for a chassis is equal to or greater than the tripRejectCount, N4 generates the following message:

Trip Count has reached rejection limit for equipment {chassisID}

If a value is not specified for the tripRejectCount parameter, N4 logs a message that the RejectChassisTripCountExceeded business task was executed but the tripRejectCount parameter was not specified.

It is up to the gate clerk to decide to send the transaction to trouble or not.

It is recommended that you not include the ResetChassisTripCount (on page 1) and the RejectChassisTripCountExceeded business tasks for the same gate transaction.

The same chassis trip count limits apply to all pooled chassis. Different chassis pools cannot have different trip count limits.

The trip count limits do not apply to other equipment, such as containers and accessories.

See also IncrementChassisTripCount (on page 1).

RejectChassisUnknown

Rejects a gate transaction if the chassis does not exist in N4.

The RejectChassisUnknown business task rejects a gate transaction only if the CreateNewChassis (on page 1) business task:

• Is unable to create a new chassis using the information provided by the clerk, or

• Is not included in the gate configuration

•  

N4 does not execute the RejectChassisUnknown business task if the Chassis IsOwners check box is selected. Same is true when using the process-truck API and the ROADGATE009 (DEFAULT_CHS_IS_OWNERS) (on page 1) configuration setting is true.

RejectOwnChassisNotAllowed

Rejects a transaction when a truck has a trucker-owned chassis (Chassis IsOwners check box is selected in a gate form).

RejectOwnChassisNotLeaving

Rejects a transaction when a truck that entered the facility with a trucker-owned chassis leaves with a different one.

RejectOwnChassisOwnedByLine

Rejects a transaction if a truck has a trucker-owned chassis (Chassis IsOwners check box is selected in a gate form) and the Chassis Number entered already exists in N4 with a valid owner or operator.

RejectOwnChassisTypeMismatch

Reject transaction if shipper-owned chassis does not have enough space for, or if the chassis equipment type does not support, the delivery container's nominal length.

As a pre-requisite, you must include the Chassis Type field in the <GateStage> tab (on page 1) configuration or send a value for chassis type via API.

This task rejects a transaction under the following conditions:

• The chassis type is not specified or does not exist in the system.

• The chassis has no space available for another container

• The chassis type cannot accommodate a container of the length being delivered.

If the Chassis Number field in a gate form is blank (null), then the RejectOwnChassisTypeMismatch business task uses the Chassis Number Requested field.

ResetChassisTripCount

Resets the trip count of a pooled chassis to zero.

See also, IncrementChassisTripCount (on page 1).

SelectBareChassis

Sends a request to XPS to select a bare chassis based on the equipment delivery order (EDO) requirements.

The SelectBareChassis business task uses the following parameters:

• truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a chassis in the yard. Generally, the settings at the first ingate stage for truckPostition are TQ and at the gate stage just before the yard are TIP.

• workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road Queue.

For more information on setting parameters, see Business Tasks form (on page 1).

If you also include the SequenceTransactions (on page 1) business task, when the gate stage is completed, N4 sorts the gate transactions in the order in which they must be executed and assigns a sequence number to each gate transaction.

SelectBareChassisForSwap

Description

You can use this business task to swap a chassis at the outgate. If you include this business task at the gate stage, enter the old chassis number in the Chassis Number Requested field in the ingate Gate form and another chassis number in the Chassis Number field in the outgate Gate form, N4 sends a request to XPS to validate if the chassis is available:

• If the chassis is available in XPS, N4 swaps and gates out the chassis.

• If the chassis is not available, XPS sends an error to N4.

If you enter the bundled chassis number at the outgate, N4 swaps and gates out the chassis as a bundle, but if you enter the payload chassis number N4 always displays an error message.

You must exclude the DetatchPayloadFromBundle (on page 1) business task if you are including the SelectBareChassisForSwap business task for Deliver Chassis (DC) transactions.

Parameters

• truckPosition: For XPS operations only, enter an existing logical block in XPS per the configuration of your settings.xml file. This parameter indicates where XPS should select a chassis in the yard. Generally, the settings at the first ingate stage for truckPostition are TQ and at the gate stage just before the yard are TIP.

• workQueue: For XPS operations only, enter an existing work queue in XPS to indicate where to place the work instruction generated from the gate transaction, such as Road Queue.

• setExchangeAreaIfNotNull: When you set this parameter to true,  when you swap a chassis, N4 saves the new values for the exchange area and lane at the truck visit level and displays the same in XPS and at the yard stage.

If you do not set the setExchangeAreaIfNotNull parameter or set it to 'false', when you swap a chassis, N4 updates the new values for the exchange area and lane at the truck visit level but also displays an error message and does not save the new exchange area and lane in XPS or at the yard stage.

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.