Show
The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: ShowType
Properties: Global, Qualified, ID: oagis-id-b43875f89e364487997308fb0bffa3be
Content
- OriginalApplicationArea [0..1] A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.
- ResponseCriteria [0..*] ResponseCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.
from type ResponseVerbType
Attributes
Name | Occ | Type | Description | Notes |
---|---|---|---|---|
recordSetStartNumber | [0..1] | PositiveIntegerNumberType | ||
recordSetCount | [0..1] | PositiveIntegerNumberType | ||
recordSetTotal | [0..1] | PositiveIntegerNumberType | ||
recordSetCompleteIndicator | [0..1] | IndicatorType | ||
recordSetReferenceId | [0..1] | IDType_B3F14E |
Used in
- Type ShowActualLedgerDataAreaType (Element DataArea)
- Type ShowAllocateResourceDataAreaType (Element DataArea)
- Type ShowBOMDataAreaType (Element DataArea)
- Type ShowBatchCertificateOfAnalysisDataAreaType (Element DataArea)
- Type ShowBudgetLedgerDataAreaType (Element DataArea)
- Type ShowCarrierRouteDataAreaType (Element DataArea)
- Type ShowCatalogDataAreaType (Element DataArea)
- Type ShowChartOfAccountsDataAreaType (Element DataArea)
- Type ShowCommercialInvoiceDataAreaType (Element DataArea)
- Type ShowConfigurationDataAreaType (Element DataArea)
- Type ShowConfirmWIPDataAreaType (Element DataArea)
- Type ShowCostingActivityDataAreaType (Element DataArea)
- Type ShowCreditDataAreaType (Element DataArea)
- Type ShowCreditStatusDataAreaType (Element DataArea)
- Type ShowCreditTransferDataAreaType (Element DataArea)
- Type ShowCreditTransferISTDataAreaType (Element DataArea)
- Type ShowCurrencyExchangeRateDataAreaType (Element DataArea)
- Type ShowCustomerPartyMasterDataAreaType (Element DataArea)
- Type ShowDebitTransferDataAreaType (Element DataArea)
- Type ShowDebitTransferISTDataAreaType (Element DataArea)
- Type ShowDispatchListDataAreaType (Element DataArea)
- Type ShowEmployeeWorkScheduleDataAreaType (Element DataArea)
- Type ShowEmployeeWorkTimeDataAreaType (Element DataArea)
- Type ShowEngineeringChangeOrderDataAreaType (Element DataArea)
- Type ShowEngineeringWorkDocumentDataAreaType (Element DataArea)
- Type ShowFieldDataAreaType (Element DataArea)
- Type ShowFreightInvoiceDataAreaType (Element DataArea)
- Type ShowHazardousMaterialShipmentDocumentDataAreaType (Element DataArea)
- Type ShowInspectDeliveryDataAreaType (Element DataArea)
- Type ShowInventoryBalanceDataAreaType (Element DataArea)
- Type ShowInventoryConsumptionDataAreaType (Element DataArea)
- Type ShowInventoryCountDataAreaType (Element DataArea)
- Type ShowInvoiceDataAreaType (Element DataArea)
- Type ShowInvoiceLedgerEntryDataAreaType (Element DataArea)
- Type ShowIssueInventoryDataAreaType (Element DataArea)
- Type ShowItemCertificateOfAnalysisDataAreaType (Element DataArea)
- Type ShowItemMasterDataAreaType (Element DataArea)
- Type ShowItemNonconformanceDataAreaType (Element DataArea)
- Type ShowJournalEntryDataAreaType (Element DataArea)
- Type ShowLocationDataAreaType (Element DataArea)
- Type ShowLocationServiceDataAreaType (Element DataArea)
- Type ShowMaintenanceOrderDataAreaType (Element DataArea)
- Type ShowMatchDocumentDataAreaType (Element DataArea)
- Type ShowMergeWIPDataAreaType (Element DataArea)
- Type ShowMoveInventoryDataAreaType (Element DataArea)
- Type ShowMoveProductDataAreaType (Element DataArea)
- Type ShowMoveProductForecastDataAreaType (Element DataArea)
- Type ShowMoveWIPDataAreaType (Element DataArea)
- Type ShowOnlineOrderDataAreaType (Element DataArea)
- Type ShowOnlineSessionDataAreaType (Element DataArea)
- Type ShowOperationDataAreaType (Element DataArea)
- Type ShowOpportunityDataAreaType (Element DataArea)
- Type ShowPartyMasterDataAreaType (Element DataArea)
- Type ShowPartyScreenDataAreaType (Element DataArea)
- Type ShowPartyScreenResponseDataAreaType (Element DataArea)
- Type ShowPayableDataAreaType (Element DataArea)
- Type ShowPaymentStatusDataAreaType (Element DataArea)
- Type ShowPaymentStatusISTDataAreaType (Element DataArea)
- Type ShowPersonnelDataAreaType (Element DataArea)
- Type ShowPickListDataAreaType (Element DataArea)
- Type ShowPlanningScheduleDataAreaType (Element DataArea)
- Type ShowPriceListDataAreaType (Element DataArea)
- Type ShowProductAvailabilityDataAreaType (Element DataArea)
- Type ShowProductionOrderDataAreaType (Element DataArea)
- Type ShowProductionPerformanceDataAreaType (Element DataArea)
- Type ShowProductionScheduleDataAreaType (Element DataArea)
- Type ShowProjectAccountingDataAreaType (Element DataArea)
- Type ShowProjectMasterDataAreaType (Element DataArea)
- Type ShowPurchaseOrderDataAreaType (Element DataArea)
- Type ShowQuoteDataAreaType (Element DataArea)
- Type ShowRFQDataAreaType (Element DataArea)
- Type ShowReceivableDataAreaType (Element DataArea)
- Type ShowReceiveDeliveryDataAreaType (Element DataArea)
- Type ShowReceiveItemDataAreaType (Element DataArea)
- Type ShowRecoverWIPDataAreaType (Element DataArea)
- Type ShowRemittanceAdviceDataAreaType (Element DataArea)
- Type ShowRequireProductDataAreaType (Element DataArea)
- Type ShowRequisitionDataAreaType (Element DataArea)
- Type ShowRiskControlLibraryDataAreaType (Element DataArea)
- Type ShowRoutingDataAreaType (Element DataArea)
- Type ShowSalesLeadDataAreaType (Element DataArea)
- Type ShowSalesOrderDataAreaType (Element DataArea)
- Type ShowSequenceScheduleDataAreaType (Element DataArea)
- Type ShowShipmentDataAreaType (Element DataArea)
- Type ShowShipmentScheduleDataAreaType (Element DataArea)
- Type ShowShipmentUnitDataAreaType (Element DataArea)
- Type ShowShippersExportDeclarationDataAreaType (Element DataArea)
- Type ShowShippersLetterOfInstructionDataAreaType (Element DataArea)
- Type ShowSplitWIPDataAreaType (Element DataArea)
- Type ShowSupplierPartyMasterDataAreaType (Element DataArea)
- Type ShowTableDataAreaType (Element DataArea)
- Type ShowUOMGroupDataAreaType (Element DataArea)
- Type ShowWIPStatusDataAreaType (Element DataArea)
- Type ShowWarehouseShippingAdviceDataAreaType (Element DataArea)
- Type ShowWarehouseShippingOrderDataAreaType (Element DataArea)
- Type ShowWarrantyClaimDataAreaType (Element DataArea)
Sample instance
<Show> <OriginalApplicationArea> <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> </OriginalApplicationArea> <ResponseCriteria> <ResponseExpression actionCode="token">token</ResponseExpression> <ChangeStatus> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <StateChange>... </StateChange> <Extension>....................................... </Extension> </ChangeStatus> </ResponseCriteria> </Show>