Business Number Context

CAPACITY_LIMIT_CONTEXT

none

• CAPACITY_GROUP: Capacity group XID
• EQUIPMENT_TYPE: Equipment type XID
• XLANE: X Lane XID
• TIME_PERIOD_TYPE: Time period type XID
• EFFECTIVE_DATE: Effective date in YYYYMMDD format
• EXPIRATION_DATE: Expiration date in YYYYMMDD format

CAPACITY_OVERRIDE_LINE_CONTEXT

none

• CAPACITY_OVERRIDE: Capacity override XID.

CAPACITY_USAGE_CONTEXT

none

• CAPACITY_LIMIT: Capacity limit XID
• CAPACITY_GROUP: Capacity Group XID
• EQUIPMENT_TYPE: Equipment Type XID
• XLANE: X Lane XID
• START_DATE: Start date in YYYYMMDD format
• END_DATE: End date in YYYYMMDD format

COMPAT_RULE_CONTEXT

none

• TYPE: Compatibility Type Rule XID
• OBJECT: XID of the main object, the type of which is determined by the Compatibility Rule Type selected. For example, this could be the Driver XID, Equipment XID, or Power Unit XID.

• DOC_NUMBER: Document number for a consolidated document
• DOC_TYPE: Document Type XID
• DATA_QUERY_TYPE: Owner Data Query Type

CORPORATION_CONTEXT

none

• CORPORATION: Corporation ID
• NAME: Corporation ID

DOCUMENT_DEF_CONTEXT

none

• OWNER/ID: Owner XID (if owner data type query GID and owner GID is not null)
• OWNER/PARTY/: Owner object's involved party contact GID given an involved party qualifier.
• PREPARER: External system ID
• OWNER/REFNUM/: Owner object's reference number value given a reference number qualifier
• OWNER/TYPE: If the document has an owner, the owner’s business object type.
• SOURCE: For order release, shipment and shipment group documents, the source location GID is available under the SOURCE tag.
• DESTINATION: For order release, shipment and shipment group documents, the destination location GID under the DESTINATION tag.
• TYPE: Document definition XID

DRIVER_CALENDAR_EVENT_CONTEXT

n/a

• DRIVER: Driver XID
• EVENT_TYPE: Calendar event type XID
• START_DATE: date for the calendar  event in YYYYMMDD
• END_DATE: End date for the calendar event in YYYYMMDD

DRIVER_CONTEXT

Driver Reference Numbers

• FIRST_NAME: Driver's first name
• LAST_NAME: Driver's last name
• HOME_LOCATION: Home location XID
• RESOURCE_TYPE: Driver resource type E = Employee; I = Independent driver; T = Third Party Driver

EMPTY_CONTEXT

All

• EMPTY_CONTEXT has no replacement values. It provides a simple context that may be used to utilize the basic business number generator instructions such as dates and sequential numbers.

EQUIPMENT_CONTEXT

n/a

• EQUIPMENT_INITIAL: Equipment Initial
• EQUIPMENT_NUMBER: Equipment Number
• EQUIPMENT_INITIAL_NUMBER: Equipment Initial Number

FTP_CONTEXT

none

• GID: Object GID
• GID_NOSLASH: Remote file names may not support using the "/" character and so NOSLASH is used if you need to replace the "/" with an "_''. For example, you would use this setting when the domain part of the GID is a sub domain.
• INTERFACE: Interface type (SHIPMENT, LOCATION, etc.)
• XID: Object XID

GROUND_SERVICE_CONTEXT

n/a

• SERVPROV: REPETITION_SCHEDULE Service Provider XID. The Mandatory Service provider field in Ground service screen.
• REPETIONSCHEDULESERVICE: REPETITION_SCHEDULE Repetition schedule service XID. This field is only available from Ground Service

GTM_TRANSACTION_LINE_CONTEXT

GTM Transaction Line Qualification Reference Number

INV_PARTY_CONTEXT_FOR_ORDER_BASE

none

• DESTINATION: Location XID. The property glog.BNInvPartyForOrderBase.retrieveSourceDestInfo must be set to True for the value to be available.
• EXTERNAL: If the order base was brought in through integration, the external system ID.
• PARTY/: Contact XID given qualifier
• SOURCE: Location XID. The property glog.BNInvPartyForOrderBase.retrieveSourceDestInfo must be set to True for the value to be available.
• REFNUM/: Order base reference number given qualifier.

INVOICE_BILL_NUMBER_CONTEXT

none

You can use Invoice_Bill_Number_Context while generating invoice from a shipment or a shipment group.

For a shipment:

• BASE: order base XID.
• CHILD_CONSOL_TYPE: Distinguishes child invoices from all others. Values are either CHILD or PAR_STD.
• CONSOLIDATION_TYPE: PARENT,CHILD,STANDARD,JOB.
• CREDIT_NOTE: CN if it is a credit note
• MODE: mode GID.
• PARTY/: contact XID given qualifier.
• PERSPECTIVE: perspective (B or S).
• SERVPROV: servprov XID.
• SERVPROV_ALIAS: servprov alias value for AIR PREFIX qualifier.
• SERVPROVALIAS/: service provider alias for the given qualifier. Separate from the replacement value used only for AIR PREFIX.
• SHIPMENT: shipment XID.

For a shipment group:

 PERSPECTIVE: perspective, fetched from first shipment of the shipment group

 SERVPROV: servprov XID, fetched from shipment(s) of the shipment group

 INVOICE_PARTY:  invoice involved party contact XID for the given qualifier, fetched from shipment group's involved party

 REFNUM: reference number of given qualifier, are fetched from shipment group's reference numbers

 PARTY: contact XID given qualifier, fetched from shipment group's involved party

 SOURCE:  source location GID, fetched from shipment group's source.

 DEST: destination location GID, fetched from shipment group's destination

Note: When different service providers are associated with a Shipment Group, BNG will generate the invoice business number based on the invoice lines and shipment group’s service providers.

INVOICE_CONTEXT

Invoice reference number

• CORRECTION_CODE: Correction code
• INVOICE: Invoice XID
• INVOICE_NUMBER: Invoice number.
• REFNUM/: Invoice reference number
• SERPROV_ALIAS/: Alias for service provider on invoice when the service provider alias qualifier is specified.  For example, {r*:xml=SERPROV_ALIAS/SCAC}.
• SERVPROV: Service provider XID
• SERVPROV_ALIAS: Service provider alias on invoice

ITEM_CONTEXT

none

• ITEM: Item XID

JOB_XID_ORDER_MOVEMENT_CONTEXT

none

• BUYSHIPMENTDEST: Buy Shipment destination location XID.
• BUYSHIPMENTPARTY/: Buy shipment involved party contact GID given qualifier.
• BUYSHIPMENTPOD: Buy shipment Port of Discharge XID.
• BUYSHIPMENTPOL: Buy shipment Port of Load XID.
• BUYSHIPMENTSOURCE: Buy shipment source location XID.
• BUYSHIPMENTTRANSMODE: Buy shipment mode XID.
• CONSOLTYPE: Consol type XID (if generating from consol).
• CONSOLXID: Consol XID (if generating from consol).
• MOVEPERSPECTIVE: Move perspective XID.
• ORDERPARTY/: Order release involved party contact GID given qualifier.
• REFNUM/: Order release reference number given qualifier.
• SELLSHIPMENTPARTY/: Sell shipment involved party contact GID given qualifier. Not applicable when generating from consol.
• SELLSHIPMENTPOD: Sell shipment Port of Discharge XID. Not applicable when generating from consol.
• SELLSHIPMENTPOL: Sell shipment Port of Load XID. Not applicable when generating from consol.
• SELLSHIPMENTSOURCE: Sell shipment source location XID. Not applicable when generating from consol.
• SELLSHIPMENTTRANSMODE: Sell shipment mode XID.  Not applicable when generating from consol.

JOB_XID_ORDER_RELEASE_CONTEXT

none

• BUYSHIPMENTDEST: Buy Shipment destination location XID.
• BUYSHIPMENTPARTY/: Buy shipment involved party contact GID given qualifier.
• BUYSHIPMENTPOD: Buy shipment Port of Discharge XID.
• BUYSHIPMENTPOL: Buy shipment Port of Load XID.
• BUYSHIPMENTSOURCE: Buy shipment source location XID.
• BUYSHIPMENTTRANSMODE: Buy shipment mode XID.
• CONSOLTYPE: Consol type XID (if generating from consol).
• CONSOLXID: Consol XID (if generating from consol).
• MOVEPERSPECTIVE: Move perspective XID.
• ORDERPARTY/: Order release involved party contact GID given qualifier.
• REFNUM/: Order release reference number given qualifier.
• SELLSHIPMENTPARTY/: Sell shipment involved party contact GID given qualifier. Not applicable when generating from consol.
• SELLSHIPMENTPOD: Sell shipment Port of Discharge XID. Not applicable when generating from consol.
• SELLSHIPMENTPOL: Sell shipment Port of Load XID. Not applicable when generating from consol.
• SELLSHIPMENTSOURCE: Sell shipment source location XID. Not applicable when generating from consol.
• SELLSHIPMENTTRANSMODE: Sell shipment mode XID.  Not applicable when generating from consol.

LOGISTICS_GUIDE_TEMPLATE_CONTEXT

none

• CURRENCY: Currency ID
• LG_TEMPLATE: Template XID

OB_LINE_CONTEXT

none

• DEST: Destination location XID
• OBLINE: Order base line XID
• OBRELEASEINSTRUCTIONSEQ: Release instruction sequence number
• ORDERBASE: Order base XID
• SOURCE: Source location ID

OB_SHIP_UNIT_CONTEXT

none

• DEST: Destination location XID
• OBSHIPUNIT: Order base ship unit XID
• OBSURELEASEINSTRUCTIONSEQ : Release instruction sequence number
• ORDERBASE: Order base XID
• SOURCE: Source location XID

ORDER_BASE_CONTEXT

Order base reference number

• BASE: Order base XID.
• EXTERNAL: External system ID. For order base XIDs when they are entered via integration.
• PARTY/: order base involved party given qualifier.
• REFNUM/: order base reference number given qualifier.

ORDER_MOVEMENT_CONTEXT

Order movement reference number

• ORDER_RELEASE: Order release XID
• PARENT_ORDER_MOVEMENT: Parent order movent XID. Routable order movement will be the parent to non-routable OM. This is considered only when OM is created with out order release, such as when it is entered by a user.

ORDER_RELEASE_CONTEXT

Order release reference number

• BASE: Order base XID.
• DESTINATION: Order release destination location XID.
• LATEPICKUP: release late pickup time.
• PARTY/: Order base involved party contact XID given qualifier (not supported for Order Release Line ID).
• REFNUM/: Order base reference number given qualifier (not supported for Order Release Line ID).
• RELEASE: Order release XID.
• RELEASE_PARTY/: Order release involved party qualifier and contact GID (not supported for Order Release Line ID).
• RELEASE_REFNUM/: Order release reference number given qualifier (not supported for Order Release Line ID).
• SOURCE: Order release source location XID.

ORDER_RELEASE_FROM_BASE_CONTEXT

Should be used to generate the order release ID when it is released from an order base.

none

• BASE: Order base XID.
• DESTINATION: release destination location XID.
• EXTERNAL: If order base was brought in via integration, the external system ID.
• LATEPICKUP: release late pickup time.
• OBLINE: order base line XID.
• OBRELEASEINSTRUCTIONSEQ: order base line release instruction sequence number.
• OBSHIPUNIT: order base ship unit XID.
• OBSURELEASEINSTRUCTIONSEQ : order base ship unit release instruction sequence number.
• PARTY/: order base involved party given qualifier.
• REFNUM/: order base reference number given qualifier.
• SOURCE: release source location XID.

ORDER_RELEASE_LINE_CONTEXT

Order release line reference number

• ITEM: Item XID
• RELEASE_LINE: Order release line XID
• RELEASE: Order release XID
• PACKAGED_ITEM: Packaged Item XID
• REFNUM/: Order release line reference number

ORDER_RELEASE_SHIP_UNIT_CONTEXT

none

• OB_SHIP_UNIT_RELEASE: Order base ship unit XID if not null, otherwise, order release XID. Also see ORDER_RELEASE_CONTEXT for additional available replacement values.

POWER_UNIT_CONTEXT

Power unit reference numbers

• NUMBER: Power unit number
• PARK_LOCATION: Park location XID

RATE_OFFERING_CONTEXT

none

• RATEOFFERING: Rate offering XID. Not applicable when generating rate offering XID.
• MODE: Transport mode XID
• VERSION: Rate version XID
• SERVPROV: Service provider XID
• SERVPROVALIAS/: Service provider alias value given a qualifier
• SCAC: Service provider SCAC XID
• EFFECTIVE: Rate version effective date in the format YYYYMMDD
• EXPIRATION: Rate version expiration date in the format YYYYMMDD

ROUTE_INSTANCE_CONTEXT

Route instance reference number

• ROUTE_INSTANCE:Route instance XID

ROUTE_TEMPLATE_CONTEXT

Route template reference number

• ROUTE_TEMPLATE:Template XID

SHIPMENT_CONTEXT

Shipment reference number

• BASE:Order base XID, if the property glog.BNShipmentContext.retrieveOrderBaseInfo is set to True.
• DEST:Destination location GID.
• GROUND_SCHED_REFERENCE: Reference number field from ground schedule
• GROUND_SCHED_REFNUM: Ground schedule reference number value for the give qualifier.
• MODE: Mode GID.
• PARTY/: Qualifier and contact XID given qualifier.
• PERSPECTIVE: Perspective (B or S).
• REFNUM/: Reference number given qualifier.
• SERVPROV: Service provider XID.
• SERVPROV_ALIAS: Service provider alias value for AIR PREFIX qualifier.
• SERVPROVALIAS/: All service provider aliases given qualifier. This works for all service provider aliases since the SERVPROV_ALIAS is only for AIR PREFIX qualifiers.
• SHIPMENT: Shipment XID.
• SOURCE: Source location GID.

SHIPMENT_GROUP_CONTEXT

Shipment group reference number

• DESTINATION: Destination location XID.
• GROUP: Shipment group XID
• PARTY/: Group Involved party contact XID given qualifier.
• REFNUM/: Shipment group reference number given qualifier.
• SHIPMENT: GID of the first shipment queried from the set of shipments.
• SOURCE: Source location XID
• TYPE: Shipment group Type XID.

STRING_CONTEXT

none

• STRING: Various values for each business number type.

S_SHIP_UNIT_CONTEXT

none

• SHIP_UNIT: Order release ship unit XID

WORK_ASSIGNMENT_CONTEXT

none

• RESOURCE_SCHEDULE_INSTANCE: The XID for Resource Schedule Instance.