SyncLocation
The purpose of the Sync Location is to enable a mechanism to ensure that the physical location identifiers are synchronized between the business applications that require this to communicate clearly. This is particularly critical when only the codes that identify locations are used. Without the meaning of the codes clearly communicated, the integration is not effective. This BOD enables the Location codes to be synchronized among business applications. This BOD may also be initiated by the sending system upon some event occurring. There are many possible business applications in several environments that may use this capability. For example, a MRP, Inventory, or Manufacturing business application could use this to communicate Location information.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: SyncLocation.xsd
Type: SyncLocationType
Properties: Global, Qualified, ID: oagis-id-29cb638530c049d49af6ff12b1340704
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 SyncLocation. The information consists of a Verb and one or more Nouns. The verb (Sync) indicates the action to be performed on the Noun (Location).
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 |
Sample instance
<SyncLocation releaseID="normalizedString"> <ApplicationArea> <Sender> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <TaskID>normalizedString</TaskID> <ReferenceID>normalizedString</ReferenceID> <ConfirmationCodes>... </ConfirmationCodes> <AuthorizationID>normalizedString</AuthorizationID> </Sender> <Receiver> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <ID/> </Receiver> <CreationDateTime></CreationDateTime> <Signature> <!--any element--> </Signature> <ScenarioID>normalizedString</ScenarioID> <CorrelationID>normalizedString</CorrelationID> <BODID>normalizedString</BODID> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </ApplicationArea> <DataArea> <Sync> <ActionCriteria>... </ActionCriteria> </Sync> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> </DataArea> </SyncLocation>