ConfirmBOD schema, example, validation rules, validation stylesheet

ConfirmBOD type: ConfirmBOD

Replacement for ConfirmBOD. This BOD reports on the outcome of processing a BOD. Only one BODOutcome noun will be returned, corresponding to a previously transmitted BOD that was earmarked for returning outcome notification. Summaary BOD-level outcome is reported in the Header, with noun-specific errors or warnings reported for each noun instance that accompanied the original BOD.

ConfirmBOD extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea ConfirmBODDataArea

Is where the information that the BOD message carries is provided, in this case ConfirmBOD. The information consists of a Verb and one or more Nouns. The verb (Confirm) indicates the action to be performed on the Noun (BOD).

ConfirmBODDataArea extends: DataArea
Structure:
Elements:
Name Type Description
BOD reference
Confirm reference

ConfirmBOD Scenario Diagram

Confirm schema

Confirm type: Confirm

The Confirm verb is used to respond to a request to confirm the receipt of information by the receiving system. The request for confirmation is set by the sending application in the ApplicationArea\Sender\Confirmation field of the original BOD. The Confirm conveys the result of the original request i.e. whether or not the message was understood and was successfully processed. An example of this is CONFIRM BOD.

Confirm extends: Verb
Structure:

BOD schema

BOD type: BOD

The outcome of processing a specific BOD. Describes overall/summary outcome, plus the outcome of processing each noun of the BOD. Includes noun-specific error and/or warning messaages encountered during processing. May include summary and/or roll-up messages at the BOD level.

Header type: BODHeader

Information about the BOD that was processed, including identifying information and a summary-level indication of the outcome of processing the BOD.

NounOutcome type: NounOutcome

Each NounOutcome captures the outcome of processing each noun of the BOD.

NounOutcomeValue type: OutcomeValue

The specific outcome of processing the noun, with supporting detail.

NounSuccess type: ProcessingSuccess

Indicates that the processing of this noun has succeeded; may provide non-fatal warning messages that arose during the processing of the noun.

NounFailure type: ProcessingFailure

Indicates that the processing of this noun has failed, and provides error and warning messages that arose during the processing of the noun.

BODOutcomeValue type: OutcomeValue

The possible BOD-level outcomes; an extensible list.

BODSuccess type: ProcessingSuccess

The processing of the BOD was a success. Possible, non-fatal warning messages may appear here. Specific outcomes of processing each noun are reported in each of the NounOutcome elements.

BODPartialSuccess type: ProcessingFailure

The processing of at least one noun in the BOD has failed. Error and warning messages may explain the failure. Specific outcomes of processing each noun are reported in each of the NounOutcome elements.

BODFailure type: ProcessingFailure

The processing of the BOD has failed. Provides a list of error and warning messages that explain the failure. Specific outcomes of processing each noun are reported in each of the NounOutcome elements.

BODOutcomeSummary

Could make this an enum, if we're absolutely certain that no user would want to extend it.

ErrorMessage type: ErrorMessage

Error message encountered during processing.

WarningMessage type: WarningMessage

Non-fatal warning message encountered during processing.

BOD extends: Noun

The outcome of processing a specific BOD. Describes overall/summary outcome, plus the outcome of processing each noun of the BOD. Includes noun-specific error and/or warning messaages encountered during processing. May include summary and/or roll-up messages at the BOD level.

The general-purpose noun used only in the "ConfirmBOD." This noun carries back the status resulting from the sending of another BOD. The ConfirmBOD could be thought of as "ConfirmTransaction"

Structure:
Elements:
Name Type Description
Header reference
NounOutcome reference

BODHeader

Information about the BOD that was processed, including identifying information and a summary-level indication of the outcome of processing the BOD.

Structure:
Elements:
Name Type Description
BODOutcomeValue reference
OriginalApplicationArea ApplicationArea

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.

OriginalBODReference GenericDocumentReference

Reference to the original BOD that was processed.

ConfirmationStatus restricts: xs:string
Enumerations:
Accepted

The BOD is "Valid" and has been processed.

Invalid

The BOD is syntactically or structurally incorrect.

Rejected

The BOD is "Valid" but not processed.

Valid

The BOD has been received and can be processed. It has passed syntax validation, but not content validation.

ErrorMessage extends: ProcessingOutcomeMessage
Structure:

NounOutcome

Each NounOutcome captures the outcome of processing each noun of the BOD.

Structure:
Elements:
Name Type Description
DocumentIds reference
NounOutcomeValue reference
UserArea reference

NounOutcomeValue
Structure:

NounStatus
Structure:

OutcomeValue
Structure:

ProcessingFailure extends: OutcomeValue

The processing has failed. Provides a list of error and warning messages that explain the failure.

Structure:
Elements:
Name Type Description
ErrorMessage reference
WarningMessage reference

ProcessingOutcomeMessage
Structure:
Elements:
Name Type Description
Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

ReasonCode ReasonCode

Used as a reason indicator for any type of business event or activity.

UserArea reference

ProcessingSuccess extends: OutcomeValue

The processing was a success. Possible, non-fatal warning messages may appear here.

Structure:
Elements:
Name Type Description
UserArea reference
WarningMessage reference

WarningMessage extends: ProcessingOutcomeMessage
Structure:

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files