Rejects a truck visit at the ingate from going into the Yard stage, if the outbound reefer units are plugged in (powered on), even if the Exchange Area capacity opens up.
N4 derives the user context at the yard level for the road call up job.
Functional Area
Gate
Execution Level
Truck Visit
Transaction Type(s)
Truck Visit IN
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:
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).
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
You must include the RejectReeferNotUnpluggedForDelivery business task at the Truck Visit IN level for a call-up gate stage.
Related Business Task(s)
SetStagingIfRequired (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
This business task notifies the gate operating system (GOS) about truck callups into the staging area by sending out a callup message to a device such as a pedestal or display board to indicate that a truck may advance.
Functional Area
Gate
Execution Level
Truck Visit
Timing
on-submit: When the truck is sent to next stage, but only after successful execution of the Validation tasks.
Transaction Type(s)
Truck Visit IN
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
None
Related Business Task(s)
None
Custom Code
By default, the business task sends the message via the outbound webservice to the URL specified in the setting ROADGOS001 (on page 1). You can customize the message content, the message delivery mechanism, or both, using a code extension of type SEND_TRUCK_CALLUP_MSG_INTERCEPTOR.
The callup message could look like the following example:
<gos>
<truck-callup>
<truck-visit tv-key="739" gos-tv-key="903" is-internal="false" next-stage-id="yard" next-exchange-area-id="205" exchange-lane-id="205.06" bat-nbr="Z0903" status="OK" gate-id="DCT" entered="2013-03-11T10:59:04">
<trucking-co id="TRKC-903" />
<truck id="Z0903" license-nbr="903" />
</truck-visit>
<truck-transactions>
<truck-transaction tran-key="971" tran-nbr="679" tv-key="739" seq-nbr="1" tran-type="DOE" category="EXPRT" freight-kind="FCL" exchange-area-id="205" exchange-lane-id="205.06" mission="205" next-stage-id="yard" gate-id="DCT" order-nbr="DCT-903" status="OK" notes="QAPOS#903.1;QAXAREA#205;" is-hazard="false">
<container eqid="DCTU903.1" type="2200" truck-position="1" is-sealed="false" gross-weight="7500.0" line-id="MOL" carrier-visit-id="GEN_VESSEL" departure-order-nbr="DCT-903" has-documents="false" planned-slot="903.1" owner-id="MOL" operator-id="MOL">
<accessory />
<routing pol="OAK" pod="HKG" />
</container>
<eq-order order-nbr="DCT-903" order-type="BOOK" line-id="MOL" freight-kind="FCL">
<eq-order-items>
<eq-order-item eq-length="20.0" eq-length-name="20'" eq-iso-group="GP" eq-iso-group-name="General purpose container without ventilation" eq-height="8.500656167979002" eq-height-name="8'6"" />
</eq-order-items>
</eq-order>
</truck-transaction>
</truck-transactions>
</truck-callup>
</gos>
To test the callup message, you can use the GOS sample in the argoservice Tester view (Administration Debug
argoservice Tester
Request
GOS
truck-callup).
Field(s)
None
This business task evaluates the staging requirements at the gate to allow trucks to bypass the staging area when not necessary. When a truck completes an exchange area visit, it either proceeds directly to its next area or to staging, or determines if staging is required based on lane availability. If all transactions have passed the current stage and the current stage is of a higher order than the staging area, the business task has no effect; this means that the truck is a candidate for staging on completion of the ingate stage, but not on completion of the yard stage.
Functional Area
Gate
Execution Level
Truck Visit
Transaction Type(s)
Truck Visit IN, Truck Visit OUT
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:
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).
area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.
This gate work flow is executed when either of the following conditions is true:
N4 receives an area-done message through the API.
A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.
As the final step in a process-truck API message when all transactions have been submitted.
Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.
Client Type(s)
UI and Gate API
Parameters
stagingId: Specify the ID of the gate stage that is marked as 'the staging' stage in the gate configuration. This is the gate stage for which the Supports Callup check box in the Gate Stage form (on page 1) is selected.
performCheck: Specify to have the staging requirements evaluated, where:
EVALUATE causes the business task to check if an exchange area has the capacity to serve a truck (if an exchange lane is available, and if it is unavailable, then if the buffer is not yet full). If an exchange area has capacity and if no trucks are waiting at the 'staging' stage for this exchange area, the business task skips the 'staging' stage for this truck and sets its next stage as the next stage of the 'staging' stage as specified in the gate configuration.
ALWAYS causes the business task to always set a truck visit's next stage as the 'staging' stage.
NEVER causes the business task to always set a truck visit's next stage as the next stage of the 'staging' stage as specified in the gate configuration. For example, if the staging stage is called 'callup' and the next stage to 'callup' is 'yard,' then the business task sets a truck visit's next stage to 'yard.'
Dependencies
None
Related Business Task(s)
None
Custom Code
None
Field(s)
None