Recommended Reading:
ProcessShipmentUnit
The purpose of the ProcessShipmentUnit is to enable an application to provide a ShipmentUnit information from another business application module in order for that module to perform the task at hand.. The ProcessShipmentUnit is typically published from the business application that is is requesting that the master or owner of the ShipmentUnit information to process the contained update. This may also occur across enterprises. The respons to the ProcessShipmentUnit is the AcknowledgeShipmentUnit to indicate success or failure. If the receiving system needs to make changes to the ShipmentUnit then the ChangeShipmentUnit can be used a coresponding RespondShipmentUnit accepts the changes or indicates additional changes.
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/BODs/ProcessShipmentUnit.xsd
Type: ProcessShipmentUnitType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- ApplicationArea [1..1] Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
- DataArea [1..1] Is where the information that the BOD message carries is provided, in this case ProcessShipmentUnit. The information consists of a Verb and one or more Nouns. The verb (Process) indicates the action to be performed on the Noun (ShipmentUnit).
from type BusinessObjectDocumentType
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| releaseID | [1..1] | NormalizedStringType | OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on. | from type BusinessObjectDocumentType |
| versionID | [0..1] | NormalizedStringType | Indicates the version of the given BOD definition. | from type BusinessObjectDocumentType |
| systemEnvironmentCode | [0..1] | SystemEnvironmentCodeContentType | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Default value is "Production". from type BusinessObjectDocumentType |
| languageCode | [0..1] | LanguageCodeContentType | Indicates the language that the contents of the BOD is in unless otherwise stated. | Default value is "en-US". from type BusinessObjectDocumentType |
Used in
- Type OAGIS9BODsType (Element OAGIS9BODs)
Sample instance
<ProcessShipmentUnit releaseID="normalizedString"> <ApplicationArea> <Sender> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <TaskID>normalizedString</TaskID> <ReferenceID>normalizedString</ReferenceID> <ConfirmationCode>Always</ConfirmationCode> <AuthorizationID>normalizedString</AuthorizationID> </Sender> <Receiver> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <ID>normalizedString</ID> </Receiver> <CreationDateTime>2000-01-01</CreationDateTime> <Signature> <!--any element--> </Signature> <BODID>normalizedString</BODID> <UserArea> <!--any element--> </UserArea> </ApplicationArea> <DataArea> <Process> <ActionCriteria>... </ActionCriteria> </Process> <ShipmentUnit> <TrackingID>normalizedString</TrackingID> <ShipUnitSequenceID>normalizedString</ShipUnitSequenceID> <ShipUnitTotalID>normalizedString</ShipUnitTotalID> <ContainerGroupID>normalizedString</ContainerGroupID> <ContainerID>normalizedString</ContainerID> <RFID>normalizedString</RFID> <SealID>normalizedString</SealID> <CarrierParty>... </CarrierParty> <ShipFromParty>... </ShipFromParty> <DeclaredValueAmount currencyID="AED">1.0</DeclaredValueAmount> <ShipmentDateTime>2000-01-01</ShipmentDateTime> <ExportLicenseRequiredIndicator>true</ExportLicenseRequiredIndicator> <ImportLicenseRequiredIndicator>true</ImportLicenseRequiredIndicator> <ScheduledDeliveryDateTime>2000-01-01</ScheduledDeliveryDateTime> <ActualDeliveryDateTime>2000-01-01</ActualDeliveryDateTime> <SpecialHandlingNote>string</SpecialHandlingNote> <Status>... </Status> <TareWeightMeasure unitCode="normalizedString">1.0</TareWeightMeasure> <NetWeightMeasure unitCode="normalizedString">1.0</NetWeightMeasure> <GrossWeightMeasure unitCode="normalizedString">1.0</GrossWeightMeasure> <TotalVolumeMeasure unitCode="normalizedString">1.0</TotalVolumeMeasure> <DistributedCharge>... </DistributedCharge> <EstimatedFreightChargeAmount currencyID="AED">1.0</EstimatedFreightChargeAmount> <FreightChargeAmount currencyID="AED">1.0</FreightChargeAmount> <SalePriceAmount currencyID="AED">1.0</SalePriceAmount> <ShipmentTotalAmount currencyID="AED">1.0</ShipmentTotalAmount> <LoadingDateTime>2000-01-01</LoadingDateTime> <EstimatedWeightMeasure unitCode="normalizedString">1.0</EstimatedWeightMeasure> <LoadingWeightMeasure unitCode="normalizedString">1.0</LoadingWeightMeasure> <Dimensions>... </Dimensions> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <DestinationCountryCode>normalizedString</DestinationCountryCode> <TransportationMethodCode>normalizedString</TransportationMethodCode> <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode> <PointOfStagingCode>normalizedString</PointOfStagingCode> <TransportationTerm>... </TransportationTerm> <ShipToLocation>... </ShipToLocation> <PackingMaterial>... </PackingMaterial> <ShippingMaterial>... </ShippingMaterial> <ShipmentUnitContainer>... </ShipmentUnitContainer> <ShipmentUnitItem>... </ShipmentUnitItem> <ContainerQuantity>1.0</ContainerQuantity> <UserArea> <!--any element--> </UserArea> </ShipmentUnit> </DataArea> </ProcessShipmentUnit>