CancelProductAvailability
The purpose of the CancelProductAvailability is to enable an application or component to request the reservations for products from another business application or component. The response to the CancelProductAvailability is the ListProductAvailability. The CancelProductAvailability also enables the retrieval of information across several documents by using selection fields. This type of functionality is limited to the capabilities of the responding application and needs to be determined during the implementation project.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: CancelProductAvailability.xsd
Type: CancelProductAvailabilityType
Properties: Global, Qualified, ID: oagis-id-dcece91d58194000ac04896b23a6b9b8
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 CancelProductAvailability. The information consists of a Verb and one or more Nouns. The verb (Cancel) indicates the action to be performed on the Noun (ProductAvailability ).
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
<CancelProductAvailability 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> <Cancel> <ActionCriteria>... </ActionCriteria> </Cancel> <ProductAvailability> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet>... </DocumentIDSet> <LastModificationDateTime></LastModificationDateTime> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <DocumentReference>... </DocumentReference> <Attachment>... </Attachment> <GLEntityID>normalizedString</GLEntityID> <Facility>... </Facility> <Status>... </Status> <ReasonCode>normalizedString</ReasonCode> <TransactionDateTime></TransactionDateTime> <ProductLineClassification>... </ProductLineClassification> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDateTime></RequiredDateTime> <PurchaseOrderReference>... </PurchaseOrderReference> <SalesOrderReference>... </SalesOrderReference> <ProductionOrderReference>... </ProductionOrderReference> <AvailableQuantity>1.0</AvailableQuantity> <AvailableDateTime></AvailableDateTime> <AllowSubstitutionIndicator>true</AllowSubstitutionIndicator> <SubstituteItemInstance>... </SubstituteItemInstance> <Extension>....................................... </Extension> </ProductAvailability> </DataArea> </CancelProductAvailability>