Star Logo

Implementation Guideline

Confirm BOD
Repository Version Rev4.5.4












Copyright 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved












Confirm BOD

Table of Contents

top

Overview

This document is a guideline on how to use the Confirm Business Object Document (BOD). The Confirm BOD has been defined in the context of STAR for the Automotive Retail Industry. The ConfirmBOD reports on the outcome of processing a BOD. Only one BODOutcome will be returned, corresponding to a previously transmitted BOD that was earmarked for returning an outcome notification.

The Confirm BOD Implementation Guidelines provide detailed information regarding the structure and meaning of the Confirm BOD and corresponds directly to the Confirm BOD schema. In addition to structure and meaning, the Implementation Guidelines identify various business rules for specific fields/components that due to their nature, i.e. field interdependence, are not possible to express using schema. Please note that although these business rules are not included in the schema, they MUST be followed to be STAR compliant. Therefore, the Confirm BOD Implementation Guidelines must be used in concert with the Confirm BOD schema during development and should NOT be considered a supplement or substitution to the schema. For more information regarding STAR XML data compliance, please review the STAR Data Compliance Guidelines document located on the STAR Web site.

For a copy of the corresponding Confirm BOD schema, please download the appropriate STAR schema repository from the XML portion of the STAR website (www.starstandard.org). Prior to downloading the schema, users are encouraged to download the STAR XML Reference/Implementation document also located on the XML portion of the STAR website. This document provides an overview of the STAR BOD development methodology, how to download and read STAR schema, and various frequently asked questions related to the implementation of STAR BODs.

STAR has followed the Open Application Group's BOD methodology to develop the Confirm BOD. Where possible STAR has mapped to existing OAGI Confirm BOD fields and components.

For more information on the Open Applications Group's BODs and related documentation please refer to the Open Applications Group's website at www.openapplications.org.

Schema Field Usage

STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Confirm BOD. Please refer to each Noun/Verb combination within this document to understand the requirements for each specific BOD. Although the Noun will always have every field defined for the Noun in the schema, each Noun/Verb combination may not use all of the fields. If a field is not used by a BOD, it will not be shown in the detail within this document.

Business Scenario

The ConfirmBOD Binary Collaboration starts with the request of for Confirmation from the Initiator of the original BOD. In response, a ConfirmBOD is sent to report on the outcome of processing the original BOD. This process occurs on demand as is needed. Note: This scenario is an example of how the ConfirmBOD can be used. Implementations may vary.

ConfirmBOD Usage

The ConfirmBOD is used to respond to a request to confirm the receipt of information by a receiving system. The ConfirmBOD indicates whether or not the receiving system was able to process the original message. In order to process the original message successfully, the receiving system must be able to successfully process every line of code necessary to complete the original message. This processing includes all units of work from parsing the message to processing the message through a backend legacy system.

The request for confirmation is set by the sending application in the verb field of the BOD. All STAR BODs require one Verb element that can be found in the DataArea of the BOD. The Verb indicates the action to be performed on the Noun.

All Verb elements contain a confirm attribute. The confirm attribute has three possible settings:
1. Always - The ConfirmBOD should always be sent.
2. Never - The ConfirmBOD should never be sent.
3. OnChange - The ConfirmBOD should be sent on change (i.e., only be sent when there are errors).

In order for a ConfirmBOD to be sent, the Sender of the original message must select one of the three confirm attribute values. If the Sender does not elect to receive a Confirm, a ConfirmBOD should not be sent. This is because the Sender, not expecting the ConfirmBOD, would have no way of handling the BOD. For simplicity, STAR suggests as a best practice that the OnChange attribute be used when requesting a ConfirmBOD.

Types of Errors Covered

The ConfirmBOD covers syntactical as well as business content-related errors that are not specific to a particular BOD. If an error code is defined in the ConfirmBOD as well as a response-type message (e.g., AcknowledgePartsOrder) it is recommended that the ConfirmBOD be used for implementation consistency. The ConfirmBOD may also be used to indicate that the receiver of the original message was not able to generate a successful response message. Example scenarios include the receiver is not able to properly validate the outbound message, the outbound message could not be properly compressed, etc. In scenarios such as these, the ConfirmBOD would be sent to the original sender indicating the failure on the part of the receiving system to generate a valid response. For the sender's reference, the ConfirmBOD would contain the original ApplicationArea of the original message sent.

Relationship Diagram

The relationship diagram identifies all of the various components or building blocks of information used in the Confirm BOD BOD. This diagram visually depicts the relationships of the components using symbolic indentation and their occurrence in the BOD. Note: That this is an approximation of the Components, and may not reflect the exact implementation. Also, some fields are displayed in the diagram. This diagram should only be used as a starting point and not an absolute reference. Relationship Diagram for BOD

top

Schema Document Properties

Target Namespacehttp://www.starstandards.org/STAR
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
DocumentationThis schema is made available under an Eclipse Public Licenses 1.0. This license may be found in the STAR/License directory as well as the STAR BOD Guidelines.
More information at: http://www.starstandard.org/.

Declared Namespaces

PrefixNamespace
Default namespacehttp://www.starstandards.org/STAR
xmlhttp://www.w3.org/XML/1998/namespace
xsdhttp://www.w3.org/2001/XMLSchema

Schema Component Representation
<xsd:schema targetNamespace="http://www.starstandards.org/STAR" elementFormDefault="qualified" attributeFormDefault="unqualified">
...
</xsd:schema>
top

Global Declarations

Element: ApplicationArea

NameApplicationArea
TypeApplicationArea
Nillableno
Abstractno
DocumentationProvides 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.
More information at: http://www.openapplications.org/oagis.

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.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<ApplicationArea>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</ApplicationArea>
Schema Component Representation
<xsd:element name="ApplicationArea" type="ApplicationArea"/>
top

Element: BOD

  • This element can be used wherever the following element is referenced:

NameBOD
TypeBOD
Nillableno
Abstractno
DocumentationThe 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.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<BOD>
<Header> ... </Header> [1]
<NounOutcome> ... </NounOutcome> [0..*]
</BOD>
Schema Component Representation
<xsd:element name="BOD" type="BOD" substitutionGroup="Noun"/>
top

Element: BODFailure

  • This element can be used wherever the following element is referenced:

NameBODFailure
TypeProcessingFailure
Nillableno
Abstractno
DocumentationThe 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.
More information at: http://www.starstandards.org.

XML Instance Representation
<BODFailure>
<ErrorMessage> ... </ErrorMessage> [0..*]
</BODFailure>
Schema Component Representation
<xsd:element name="BODFailure" type="ProcessingFailure" substitutionGroup="BODOutcomeValue"/>
top

Element: BODOutcomeValue

NameBODOutcomeValue
TypeOutcomeValue
Nillableno
Abstractyes
DocumentationThe possible BOD-level outcomes; an extensible list.
More information at: http://www.starstandards.org.

XML Instance Representation
<BODOutcomeValue/>
Schema Component Representation
<xsd:element name="BODOutcomeValue" type="OutcomeValue" abstract="true"/>
top

Element: BODPartialSuccess

  • This element can be used wherever the following element is referenced:

NameBODPartialSuccess
TypeProcessingFailure
Nillableno
Abstractno
DocumentationThe 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.
More information at: http://www.starstandards.org.

XML Instance Representation
<BODPartialSuccess>
<ErrorMessage> ... </ErrorMessage> [0..*]
</BODPartialSuccess>
Schema Component Representation
<xsd:element name="BODPartialSuccess" type="ProcessingFailure" substitutionGroup="BODOutcomeValue"/>
top

Element: BODSuccess

  • This element can be used wherever the following element is referenced:

NameBODSuccess
TypeProcessingSuccess
Nillableno
Abstractno
DocumentationThe 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.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<BODSuccess>
</BODSuccess>
Schema Component Representation
<xsd:element name="BODSuccess" type="ProcessingSuccess" substitutionGroup="BODOutcomeValue"/>
top

Element: Confirm

  • This element can be used wherever the following element is referenced:

NameConfirm
TypeConfirm
Nillableno
Abstractno
DocumentationThe 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.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<Confirm/>
Schema Component Representation
<xsd:element name="Confirm" type="Confirm" substitutionGroup="Verb"/>
top

Element: ConfirmBOD

NameConfirmBOD
TypeConfirmBOD
Nillableno
Abstractno

XML Instance Representation
<ConfirmBOD
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> ConfirmBODDataArea </DataArea> [1]
</ConfirmBOD>
Schema Component Representation
<xsd:element name="ConfirmBOD" type="ConfirmBOD"/>
top

Element: ErrorMessage

NameErrorMessage
TypeErrorMessage
Nillableno
Abstractno
DocumentationError message encountered during processing.
More information at: http://www.starstandards.org.

XML Instance Representation
<ErrorMessage>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
<ErrorType> ErrorType </ErrorType> [0..1]
<ReferenceName> ReferenceName </ReferenceName> [0..1]
<ReferenceValue> ReferenceValue </ReferenceValue> [0..1]
</ErrorMessage>
Schema Component Representation
<xsd:element name="ErrorMessage" type="ErrorMessage"/>
top

Element: Header

NameHeader
TypeBODHeader
Nillableno
Abstractno
DocumentationInformation about the BOD that was processed, including identifying information and a summary-level indication of the outcome of processing the BOD.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<Header>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
<OriginalApplicationArea> ApplicationArea </OriginalApplicationArea> [1] ?
<OriginalBODReference> GenericDocumentReference </OriginalBODReference> [0..1] ?
</Header>
Schema Component Representation
<xsd:element name="Header" type="BODHeader"/>
top

Element: Noun

  • The following elements can be used wherever this element is referenced:

NameNoun
TypeNoun
Nillableno
Abstractyes

XML Instance Representation
<Noun/>
Schema Component Representation
<xsd:element name="Noun" type="Noun" abstract="true"/>
top

Element: NounFailure

  • This element can be used wherever the following element is referenced:

NameNounFailure
TypeProcessingFailure
Nillableyes
Abstractno
DocumentationIndicates that the processing of this noun has failed, and provides error and warning messages that arose during the processing of the noun.
More information at: http://www.starstandards.org.
Business Rule: If this component is used, either the ErrorMessage or the WarningMessage component must be used.

XML Instance Representation
<NounFailure>
<ErrorMessage> ... </ErrorMessage> [0..*]
</NounFailure>
Schema Component Representation
<xsd:element name="NounFailure" type="ProcessingFailure" substitutionGroup="NounOutcomeValue" nillable="true"/>
top

Element: NounOutcome

NameNounOutcome
TypeNounOutcome
Nillableno
Abstractno
DocumentationEach NounOutcome captures the outcome of processing each noun of the BOD.
More information at: http://www.starstandards.org.

XML Instance Representation
<NounOutcome>
<DocumentId> DocumentId </DocumentId> [0..1]
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
</NounOutcome>
Schema Component Representation
<xsd:element name="NounOutcome" type="NounOutcome"/>
top

Element: NounOutcomeValue

NameNounOutcomeValue
TypeOutcomeValue
Nillableno
Abstractyes
DocumentationThe specific outcome of processing the noun, with supporting detail.
More information at: http://www.starstandards.org.

XML Instance Representation
<NounOutcomeValue/>
Schema Component Representation
<xsd:element name="NounOutcomeValue" type="OutcomeValue" abstract="true"/>
top

Element: NounSuccess

  • This element can be used wherever the following element is referenced:

NameNounSuccess
TypeProcessingSuccess
Nillableyes
Abstractno
DocumentationIndicates that the processing of this noun has succeeded; may provide non-fatal warning messages that arose during the processing of the noun.
More information at: http://www.starstandards.org.
Business Rule: If this component is used, either the WarningMessage or the SuccessMessage component must be used.

XML Instance Representation
<NounSuccess>
</NounSuccess>
Schema Component Representation
<xsd:element name="NounSuccess" type="ProcessingSuccess" substitutionGroup="NounOutcomeValue" nillable="true"/>
top

Element: SuccessMessage

NameSuccessMessage
TypeSuccessMessage
Nillableno
Abstractno
DocumentationMessage indicating a success.
More information at: http://www.starstandard.org.

XML Instance Representation
<SuccessMessage>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
</SuccessMessage>
Schema Component Representation
<xsd:element name="SuccessMessage" type="SuccessMessage"/>
top

Element: Verb

  • The following elements can be used wherever this element is referenced:

NameVerb
TypeVerb
Nillableno
Abstractyes

XML Instance Representation
<Verb/>
Schema Component Representation
<xsd:element name="Verb" type="Verb" abstract="true"/>
top

Element: WarningMessage

NameWarningMessage
TypeWarningMessage
Nillableno
Abstractno
DocumentationNon-fatal warning message encountered during processing.
More information at: http://www.starstandards.org.

XML Instance Representation
<WarningMessage>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
</WarningMessage>
Schema Component Representation
<xsd:element name="WarningMessage" type="WarningMessage"/>
top

Global Definitions

Components (Complex Type): ApplicationArea

Super-types:None
Sub-types:None

NameApplicationArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SenderIdentifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. Required 
CreationDateTimeis the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. Required
DateTime fields must be formatted as XML Schema Datetimes in UTC/GMT format without offsets. Example: 2003-11-05T13:15:30Z
 
SignatureIf the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature. This element supports any digital signature specification that is available today and in the future. This is accomplished by not actually defining the content but by allowing the implementation to specify the digital signature to be used via an external XML Schema namespace declaration. The Signature element is defined to have any content from any other namespace. This allows the user to carry a digital signature in the xml instance of a BOD. The choice of which digital signature to use is left up to the user and their integration needs. Optional 
BODIdThe BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security. Optional 
DestinationInformation related to the receiver of the BOD Required 

XML Instance Representation
<...>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="ApplicationArea">
<xsd:sequence>
<xsd:element name="Sender" type="Sender"/>
<xsd:element name="CreationDateTime" type="DateTime"/>
<xsd:element name="Signature" type="Signature" minOccurs="0"/>
<xsd:element name="BODId" type="Code" minOccurs="0"/>
<xsd:element name="Destination" type="Destination"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): BOD

Super-types:Noun < BOD (by extension)
Sub-types:None

NameBOD
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Noun Required 
HeaderInformation about the BOD that was processed, including identifying information and a summary-level indication of the outcome of processing the BOD. Required 
NounOutcomeEach NounOutcome captures the outcome of processing each noun of the BOD. Optional 

XML Instance Representation
<...>
<Header> ... </Header> [1]
<NounOutcome> ... </NounOutcome> [0..*]
</...>
Schema Component Representation
<xsd:complexType name="BOD">
<xsd:complexContent>
<xsd:extension base="Noun">
<xsd:sequence>
<xsd:element ref="Header"/>
<xsd:element ref="NounOutcome" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): BODHeader

Super-types:HeaderBase < BODHeader (by extension)
Sub-types:None

NameBODHeader
Abstractno
DocumentationInformation about the BOD that was processed, including identifying information and a summary-level indication of the outcome of processing the BOD.
More information at: http://www.starstandards.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentDateTimeIs the date and time the document was last created. This is not the date and time that the BOD message instance was created. Optional 
SecondaryPasswordSecondary password used to validate access to the dealer information Optional 
SecondaryDealerNumberIdentifies secondary dealer number if different than primary "Dealer Number" Optional 
OriginalApplicationAreaA 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. Required 
OriginalBODReferenceReference to the original BOD that was processed. Optional
(INACTIVE)
 
BODOutcomeValueThe possible BOD-level outcomes; an extensible list. Optional 

XML Instance Representation
<...>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
<OriginalApplicationArea> ApplicationArea </OriginalApplicationArea> [1] ?
<OriginalBODReference> GenericDocumentReference </OriginalBODReference> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="BODHeader">
<xsd:complexContent>
<xsd:extension base="HeaderBase">
<xsd:sequence>
<xsd:element name="OriginalApplicationArea" type="ApplicationArea"/>
<xsd:element name="OriginalBODReference" type="GenericDocumentReference" minOccurs="0"/>
<xsd:element ref="BODOutcomeValue" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): BusinessObjectDocument

Super-types:None
Sub-types:

NameBusinessObjectDocument
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
revisionThis should contain the STAR repository version in the following recommended format. 4.2.1_M20080416. Where the first part indicates the version of the STAR repository and anything after the _ indicates the Milestone build that is being used. If referring to an official published version then only the STAR Repository version is required. Optional 
releaseIndicates the OAGIS release that this BOD belongs. Optional 
environmentIndicates 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). Optional 
langIndicates the language that the contents of the BOD is in unless otherwise stated. Optional 
bodVersionDeprecated as of STAR 4.2.2. It is recommended to use the revision attribute to identify the repository and the noun. May be removed in a new major version of the STAR repository. Optional 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides 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. Required 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="BusinessObjectDocument">
<xsd:sequence>
<xsd:element ref="ApplicationArea"/>
</xsd:sequence>
<xsd:attribute name="revision" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="release" type="Text" use="optional" fixed="8.1-Lite"/>
<xsd:attribute name="environment" use="optional" default="Production">
<xsd:simpleType>
<xsd:restriction base="Text">
<xsd:enumeration value="Test"/>
<xsd:enumeration value="Production"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="lang" type="Language" use="optional"/>
<xsd:attribute name="bodVersion" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Components (Complex Type): Confirm

Super-types:Verb < Confirm (by extension)
Sub-types:None

NameConfirm
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 

XML Instance Representation
<.../>
Schema Component Representation
<xsd:complexType name="Confirm">
<xsd:complexContent>
<xsd:extension base="Verb"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ConfirmBOD

Super-types:BusinessObjectDocument < ConfirmBOD (by extension)
Sub-types:None

NameConfirmBOD
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides 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. Required 
DataArea Required 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> ConfirmBODDataArea </DataArea> [1]
</...>
Schema Component Representation
<xsd:complexType name="ConfirmBOD">
<xsd:complexContent>
<xsd:extension base="BusinessObjectDocument">
<xsd:sequence>
<xsd:element name="DataArea" type="ConfirmBODDataArea"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ConfirmBODDataArea

Super-types:None
Sub-types:None

NameConfirmBODDataArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ConfirmThe 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. Required 
BODThe 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. Required 

XML Instance Representation
<...>
<Confirm> ... </Confirm> [1]
<BOD> ... </BOD> [1..*]
</...>
Schema Component Representation
<xsd:complexType name="ConfirmBODDataArea">
<xsd:sequence>
<xsd:element ref="Confirm"/>
<xsd:element ref="BOD" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Description

Super-types:xsd:string < Description (by extension)
Sub-types:None

NameDescription
Abstractno
DocumentationDescription
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
languageThe ISO language code that the description is written. Optional 

XML Instance Representation
<...
language="Language [0..1] ?"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Description">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="language" type="Language" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Destination

Super-types:None
Sub-types:None

NameDestination
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DestinationNameCodeCode for destination of file (i.e.Short Manufacturer or DSP code) Optional
Must use a valid code from the ShortMfg/RSP list on http://www.starstandards.org
 
DestinationURIPhysical address of the destination Optional 
DestinationSoftwareCodeAdditional information about the destination application Optional 
DestinationSoftwareFor which software destination file is intended (may not be known). Optional 
DealerNumberTarget Dealer Code receiving information Optional 
StoreNumberDealer code store number (DMS assigned) Optional 
AreaNumberDealer code area number (DMS vendor assigned) Optional 
DealerCountryTarget Dealer country location Optional 
PartyIdThe Party Id field uniquely identifies the Receiver of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. Optional 
LocationIdThe Location Id field uniquely identifies the location of the Receiver of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. Optional 
ServiceIdThe Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. Optional 

XML Instance Representation
<...>
<DestinationNameCode> ShortMfg </DestinationNameCode> [0..1] ?
<DestinationURI> URI </DestinationURI> [0..1] ?
<DestinationSoftwareCode> Text </DestinationSoftwareCode> [0..1] ?
<DestinationSoftware> Text </DestinationSoftware> [0..1] ?
<DealerNumber> PartyId </DealerNumber> [0..1] ?
<StoreNumber> Text </StoreNumber> [0..1] ?
<AreaNumber> Text </AreaNumber> [0..1] ?
<DealerCountry> Country </DealerCountry> [0..1] ?
<PartyId> PartyId </PartyId> [0..1] ?
<LocationId> LocationId </LocationId> [0..1] ?
<ServiceId> ServiceId </ServiceId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Destination">
<xsd:sequence>
<xsd:element name="DestinationNameCode" type="ShortMfg" minOccurs="0"/>
<xsd:element name="DestinationURI" type="URI" minOccurs="0"/>
<xsd:element name="DestinationSoftwareCode" type="Text" minOccurs="0"/>
<xsd:element name="DestinationSoftware" type="Text" minOccurs="0"/>
<xsd:element name="DealerNumber" type="PartyId" minOccurs="0"/>
<xsd:element name="StoreNumber" type="Text" minOccurs="0"/>
<xsd:element name="AreaNumber" type="Text" minOccurs="0"/>
<xsd:element name="DealerCountry" type="Country" minOccurs="0"/>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
<xsd:element name="LocationId" type="LocationId" minOccurs="0"/>
<xsd:element name="ServiceId" type="ServiceId" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): DocumentId

Super-types:xsd:string < Id (by extension) < DocumentId (by extension)
Sub-types:None

NameDocumentId
Abstractno
DocumentationIs the identifier for the document.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="DocumentId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DocumentReference

Super-types:None
Sub-types:

NameDocumentReference
Abstractno
DocumentationIdentifies another document within the scope of the OAGIS specification, such as a PurchaseOrder or Invoice that maybe associated with a particular Business Object Document.
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules

XML Instance Representation
<.../>
Schema Component Representation
<xsd:complexType name="DocumentReference"/>
top

Components (Complex Type): ErrorMessage

Super-types:ProcessingOutcomeMessage < ErrorMessage (by extension)
Sub-types:None

NameErrorMessage
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ProcessingOutcomeMessage Required 
ErrorType Optional 
ReferenceName Optional 
ReferenceValue Optional 

XML Instance Representation
<...>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
<ErrorType> ErrorType </ErrorType> [0..1]
<ReferenceName> ReferenceName </ReferenceName> [0..1]
<ReferenceValue> ReferenceValue </ReferenceValue> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="ErrorMessage">
<xsd:complexContent>
<xsd:extension base="ProcessingOutcomeMessage">
<xsd:sequence>
<xsd:element name="ErrorType" type="ErrorType" minOccurs="0"/>
<xsd:element name="ReferenceName" type="ReferenceName" minOccurs="0"/>
<xsd:element name="ReferenceValue" type="ReferenceValue" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): GenericDocumentReference

Super-types:DocumentReference < GenericDocumentReference (by extension)
Sub-types:None

NameGenericDocumentReference
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentReferenceIdentifies another document within the scope of the OAGIS specification, such as a PurchaseOrder or Invoice that maybe associated with a particular Business Object Document. Required 
DocumentId Optional 
DocumentDateTimeThe Datetime of the referenced document. Optional 

XML Instance Representation
<...>
<DocumentId> DocumentId </DocumentId> [0..1] ?
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="GenericDocumentReference">
<xsd:complexContent>
<xsd:extension base="DocumentReference">
<xsd:sequence>
<xsd:element name="DocumentId" type="DocumentId" minOccurs="0"/>
<xsd:element name="DocumentDateTime" type="DocumentDateTime" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): HeaderBase

Super-types:None
Sub-types:

NameHeaderBase
Abstractno
DocumentationUsed on all STAR BODs
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentDateTimeIs the date and time the document was last created. This is not the date and time that the BOD message instance was created. Optional 
SecondaryPasswordSecondary password used to validate access to the dealer information Optional 
SecondaryDealerNumberIdentifies secondary dealer number if different than primary "Dealer Number" Optional 

XML Instance Representation
<...>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="HeaderBase">
<xsd:sequence>
<xsd:element name="DocumentDateTime" type="DocumentDateTime" minOccurs="0"/>
<xsd:element name="SecondaryPassword" type="SecondaryPassword" minOccurs="0"/>
<xsd:element name="SecondaryDealerNumber" type="SecondaryDealerNumber" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Id

Super-types:xsd:string < Id (by extension)
Sub-types:None

NameId
Abstractno
DocumentationParty Identification number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Id">
<xsd:simpleContent>
<xsd:extension base="xsd:string"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LocationId

Super-types:xsd:string < Id (by extension) < LocationId (by extension)
Sub-types:None

NameLocationId
Abstractno
DocumentationCode identifying a physical location
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="LocationId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Noun

Super-types:None
Sub-types:
  • BOD (by extension)

NameNoun
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules

XML Instance Representation
<.../>
Schema Component Representation
<xsd:complexType name="Noun"/>
top

Components (Complex Type): NounOutcome

Super-types:None
Sub-types:None

NameNounOutcome
Abstractno
DocumentationEach NounOutcome captures the outcome of processing each noun of the BOD.
More information at: http://www.starstandards.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentId Optional 
NounOutcomeValueThe specific outcome of processing the noun, with supporting detail. Optional 
DocumentDateTimeThe date and time the document was last created. This is not the date and time that the BOD message instance was created. Optional 

XML Instance Representation
<...>
<DocumentId> DocumentId </DocumentId> [0..1]
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="NounOutcome">
<xsd:sequence>
<xsd:element name="DocumentId" type="DocumentId" minOccurs="0"/>
<xsd:element ref="NounOutcomeValue" minOccurs="0"/>
<xsd:element name="DocumentDateTime" type="DocumentDateTime" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OutcomeValue

Super-types:None
Sub-types:

NameOutcomeValue
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules

XML Instance Representation
<.../>
Schema Component Representation
<xsd:complexType name="OutcomeValue"/>
top

Components (Complex Type): PartyId

Super-types:xsd:string < Id (by extension) < PartyId (by extension)
Sub-types:None

NamePartyId
Abstractno
DocumentationParty Identification Number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="PartyId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ProcessingFailure

Super-types:OutcomeValue < ProcessingFailure (by extension)
Sub-types:None

NameProcessingFailure
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OutcomeValue Required 
ErrorMessageError message encountered during processing. Optional 
WarningMessageNon-fatal warning message encountered during processing. Optional 

XML Instance Representation
<...>
<ErrorMessage> ... </ErrorMessage> [0..*]
</...>
Schema Component Representation
<xsd:complexType name="ProcessingFailure">
<xsd:complexContent>
<xsd:extension base="OutcomeValue">
<xsd:sequence>
<xsd:element ref="ErrorMessage" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="WarningMessage" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ProcessingOutcomeMessage

Super-types:None
Sub-types:

NameProcessingOutcomeMessage
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationReasonCode Required 
Description Required 
MessageReasonCode Required 
Description Optional 
MessageReasonCode Optional 

XML Instance Representation
<...>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
</...>
Schema Component Representation
<xsd:complexType name="ProcessingOutcomeMessage">
<xsd:choice>
<xsd:sequence>
<xsd:element name="ApplicationReasonCode" type="ApplicationReasonCode"/>
<xsd:element name="Description" type="Description" maxOccurs="unbounded"/>
<xsd:element name="MessageReasonCode" type="MessageReasonCode"/>
</xsd:sequence>
<xsd:sequence>
<xsd:element name="Description" type="Description" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="MessageReasonCode" type="MessageReasonCode" minOccurs="0"/>
</xsd:sequence>
</xsd:choice>
</xsd:complexType>
top

Components (Complex Type): ProcessingSuccess

Super-types:OutcomeValue < ProcessingSuccess (by extension)
Sub-types:None

NameProcessingSuccess
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OutcomeValue Required 
WarningMessageNon-fatal warning message encountered during processing. Optional 
SuccessMessageMessage indicating a success. Optional 

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="ProcessingSuccess">
<xsd:complexContent>
<xsd:extension base="OutcomeValue">
<xsd:sequence>
<xsd:element ref="WarningMessage" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="SuccessMessage" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ReferenceName

Super-types:xsd:string < Description (by extension) < ReferenceName (by extension)
Sub-types:None

NameReferenceName
Abstractno
DocumentationThe name of the field/tag that references/idenitifies the key data elements the senders request/response bod.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="ReferenceName">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): SecondaryDealerNumber

Super-types:xsd:string < Id (by extension) < SecondaryDealerNumber (by extension)
Sub-types:None

NameSecondaryDealerNumber
Abstractno
DocumentationIdentifies secondary dealer number if different than primary "Dealer Number"
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="SecondaryDealerNumber">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Sender

Super-types:SenderBase < Sender (by extension)
Sub-types:None

NameSender
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
LogicalIdProvides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network Optional 
ComponentProvides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name Required 
TaskDescribes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. Required 
ReferenceIdEnables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD Optional 
AuthorizationIdIdentifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. Optional 
CreatorNameCodeDCS Software Creator Code Required 
SenderNameCodeAdditional information about the sending platform (i.e., Short MFG or DSP code). Required
Must use a valid code from the ShortMfg/RSP list on http://www.starstandards.org
 
SenderURIPhysical address of the sender Optional 
DealerNumberDealer Code of source of information Optional 
StoreNumberDealer code store number (DMS assigned) Optional 
AreaNumberDealer code area number (DMS vendor assigned) Optional 
DealerCountrySource Dealer country location Optional 
LanguageThis code is used to define the language of the data used in this transaction Optional 
DeliverPendingMailIndIndicates if the user requests to receive pending mail that has been stored and has yet not been delivered yet. By selecting 0, the user will only receive the response for the current transaction the user is performing. Optional 
PasswordToken for application specific authentication. Used to authenticate dealership/users through application specific security Optional 
SystemVersionThe sender's software version number. Optional 
PartyIdThe Party Id field uniquely identifies the Sender of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. Optional 
LocationIdThe Location Id field uniquely identifies the location of the Sender of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. Optional 
ServiceIdThe Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. Optional 

XML Instance Representation
<...>
<LogicalId> Text </LogicalId> [0..1] ?
<Component> Text </Component> [1] ?
<Task> Text </Task> [1] ?
<ReferenceId> Reference </ReferenceId> [0..1] ?
<AuthorizationId> Id </AuthorizationId> [0..1] ?
<CreatorNameCode> Text </CreatorNameCode> [1] ?
<SenderNameCode> ShortMfg </SenderNameCode> [1] ?
<SenderURI> URI </SenderURI> [0..1] ?
<DealerNumber> PartyId </DealerNumber> [0..1] ?
<StoreNumber> Text </StoreNumber> [0..1] ?
<AreaNumber> Text </AreaNumber> [0..1] ?
<DealerCountry> Country </DealerCountry> [0..1] ?
<Language> Language </Language> [0..1] ?
<DeliverPendingMailInd> Indicator </DeliverPendingMailInd> [0..1] ?
<Password> Text </Password> [0..1] ?
<SystemVersion> SystemVersion </SystemVersion> [0..1] ?
<PartyId> PartyId </PartyId> [0..1] ?
<LocationId> LocationId </LocationId> [0..1] ?
<ServiceId> ServiceId </ServiceId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Sender">
<xsd:complexContent>
<xsd:extension base="SenderBase">
<xsd:sequence>
<xsd:element name="CreatorNameCode" type="Text"/>
<xsd:element name="SenderNameCode" type="ShortMfg"/>
<xsd:element name="SenderURI" type="URI" minOccurs="0"/>
<xsd:element name="DealerNumber" type="PartyId" minOccurs="0"/>
<xsd:element name="StoreNumber" type="Text" minOccurs="0"/>
<xsd:element name="AreaNumber" type="Text" minOccurs="0"/>
<xsd:element name="DealerCountry" type="Country" minOccurs="0"/>
<xsd:element name="Language" type="Language" minOccurs="0"/>
<xsd:element name="DeliverPendingMailInd" type="Indicator" minOccurs="0"/>
<xsd:element name="Password" type="Text" minOccurs="0"/>
<xsd:element name="SystemVersion" type="SystemVersion" minOccurs="0"/>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
<xsd:element name="LocationId" type="LocationId" minOccurs="0"/>
<xsd:element name="ServiceId" type="ServiceId" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): SenderBase

Super-types:None
Sub-types:

NameSenderBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
LogicalIdProvides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network Optional 
ComponentProvides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name Required 
TaskDescribes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. Required 
ReferenceIdEnables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD Optional 
AuthorizationIdIdentifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. Optional 

XML Instance Representation
<...>
<LogicalId> Text </LogicalId> [0..1] ?
<Component> Text </Component> [1] ?
<Task> Text </Task> [1] ?
<ReferenceId> Reference </ReferenceId> [0..1] ?
<AuthorizationId> Id </AuthorizationId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="SenderBase">
<xsd:sequence>
<xsd:element name="LogicalId" type="Text" minOccurs="0"/>
<xsd:element name="Component" type="Text"/>
<xsd:element name="Task" type="Text"/>
<xsd:element name="ReferenceId" type="Reference" minOccurs="0"/>
<xsd:element name="AuthorizationId" type="Id" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ServiceId

Super-types:xsd:string < Id (by extension) < ServiceId (by extension)
Sub-types:None

NameServiceId
Abstractno
DocumentationThe Service Id field identifies the particular service to or from which a message is being sent, e.g., an inventory service.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="ServiceId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Signature

Super-types:None
Sub-types:None

NameSignature
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
qualifyingAgency Optional 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules

XML Instance Representation
<...
qualifyingAgency="Text [0..1]"
>
Allow any elements from any namespace (strict validation). [0..1]
</...>
Schema Component Representation
<xsd:complexType name="Signature">
<xsd:sequence>
<xsd:any namespace="##any" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="qualifyingAgency" type="Text" use="optional"/>
</xsd:complexType>
top

Components (Complex Type): SuccessMessage

Super-types:ProcessingOutcomeMessage < SuccessMessage (by extension)
Sub-types:None

NameSuccessMessage
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ProcessingOutcomeMessage Required 

XML Instance Representation
<...>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
</...>
Schema Component Representation
<xsd:complexType name="SuccessMessage">
<xsd:complexContent>
<xsd:extension base="ProcessingOutcomeMessage"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): Verb

Super-types:None
Sub-types:

NameVerb
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules

XML Instance Representation
<.../>
Schema Component Representation
<xsd:complexType name="Verb"/>
top

Components (Complex Type): WarningMessage

Super-types:ProcessingOutcomeMessage < WarningMessage (by extension)
Sub-types:None

NameWarningMessage
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ProcessingOutcomeMessage Required 

XML Instance Representation
<...>
Start Choice [1]
<ApplicationReasonCode> ApplicationReasonCode </ApplicationReasonCode> [1]
<Description> Description </Description> [1..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [1]
<Description> Description </Description> [0..*]
<MessageReasonCode> MessageReasonCode </MessageReasonCode> [0..1]
End Choice
</...>
Schema Component Representation
<xsd:complexType name="WarningMessage">
<xsd:complexContent>
<xsd:extension base="ProcessingOutcomeMessage"/>
</xsd:complexContent>
</xsd:complexType>
top

Simple Type: ApplicationReasonCode

Super-types:xsd:string < Code (by restriction) < ApplicationReasonCode (by restriction)
Sub-types:None

NameApplicationReasonCode
DocumentationA software application specific reason code. Used for indicating numeric or text encoded error, success, and warning messages.
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="ApplicationReasonCode">
<xsd:restriction base="Code"/>
</xsd:simpleType>
top

Simple Type: Code

Super-types:xsd:string < Code (by restriction)
Sub-types:

NameCode
DocumentationUnique code name
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="Code">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
top

Simple Type: Country

Super-types:xsd:string < Country (by restriction)
Sub-types:None

NameCountry
DocumentationCountry in which the Address is in. Conforms to ISO 3166-2. AF -AFGHANISTAN AL -ALBANIA DZ -ALGERIA AS -AMERICAN SAMOA AD -ANDORRA AO -ANGOLA AI -ANGUILLA AQ -ANTARCTICA AG -ANTIGUA AND BARBUDA AR -ARGENTINA AM -ARMENIA AW -ARUBA AU -AUSTRALIA AT -AUSTRIA AZ -AZERBAIJAN BS -BAHAMAS BH -BAHRAIN BD -BANGLADESH BB -BARBADOS BY -BELARUS BE -BELGIUM BZ -BELIZE BJ -BENIN BM -BERMUDA BT -BHUTAN BO -BOLIVIA BA -BOSNIA AND HERZEGOVINA BW -BOTSWANA BV -BOUVET ISLAND BR -BRAZIL IO-BRITISH INDIAN OCEAN TERRITORY BN -BRUNEI DARUSSALAM BG -BULGARIA BF -BURKINA FASO BI -BURUNDI KH -CAMBODIA CM -CAMEROON CA -CANADA CV -CAPE VERDE KY -CAYMAN ISLANDS CF -CENTRAL AFRICAN REPUBLIC TD -CHAD CL -CHILE CN -CHINA CX -CHRISTMAS ISLAND CC -COCOS (KEELING) ISLANDS CO -COLOMBIA KM -COMOROS CG -CONGO CD -CONGO, THE DEMOCRATIC REPUBLIC OF THE CK -COOK ISLANDS CR -COSTA RICA CI -Cƒ”TE D'IVOIRE HR -CROATIA CU -CUBA CY -CYPRUS CZ -CZECH REPUBLIC DK -DENMARK DJ -DJIBOUTI DM -DOMINICA DO -DOMINICAN REPUBLIC EC -ECUADOR EG -EGYPT SV -EL SALVADOR GQ -EQUATORIAL GUINEA ER -ERITREA EE -ESTONIA ET -ETHIOPIA FK -FALKLAND ISLANDS (MALVINAS) FO -FAROE ISLANDS FJ -FIJI FI -FINLAND FR -FRANCE GF -FRENCH GUIANA PF -FRENCH POLYNESIA TF -FRENCH SOUTHERN TERRITORIES GA -GABON GM -GAMBIA GE -GEORGIA DE -GERMANY GH -GHANA GI -GIBRALTAR GR -GREECE GL -GREENLAND GD -GRENADA GP -GUADELOUPE GU -GUAM GT -GUATEMALA GN -GUINEA GW -GUINEA-BISSAU GY -GUYANA HT -HAITI HM -HEARD ISLAND AND MCDONALD ISLANDS VA -HOLY SEE (VATICAN CITY STATE) HN -HONDURAS HK -HONG KONG HU -HUNGARY IS -ICELAND IN -INDIA ID -INDONESIA IR -IRAN, ISLAMIC REPUBLIC OF IQ -IRAQ IE -IRELAND IL -ISRAEL IT -ITALY JM -JAMAICA JP -JAPAN JO -JORDAN KZ -KAZAKHSTAN KE -KENYA KI -KIRIBATI KP -KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KR -KOREA, REPUBLIC OF KW -KUWAIT KG -KYRGYZSTAN LA -LAO PEOPLE'S DEMOCRATIC REPUBLIC LV -LATVIA LB -LEBANON LS -LESOTHO LR -LIBERIA LY -LIBYAN ARAB JAMAHIRIYA LI -LIECHTENSTEIN LT -LITHUANIA LU -LUXEMBOURG MO -MACAO MK -MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF MG -MADAGASCAR MW -MALAWI MY -MALAYSIA MV -MALDIVES ML -MALI MT -MALTA MH -MARSHALL ISLANDS MQ -MARTINIQUE MR -MAURITANIA MU -MAURITIUS YT -MAYOTTE MX -MEXICO FM -MICRONESIA, FEDERATED STATES OF MD -MOLDOVA, REPUBLIC OF MC -MONACO MN -MONGOLIA MS -MONTSERRAT MA -MOROCCO MZ -MOZAMBIQUE MM -MYANMAR NA -NAMIBIA NR -NAURU NP -NEPAL NL -NETHERLANDS AN -NETHERLANDS ANTILLES NC -NEW CALEDONIA NZ -NEW ZEALAND NI -NICARAGUA NE -NIGER NG -NIGERIA NU -NIUE NF -NORFOLK ISLAND MP -NORTHERN MARIANA ISLANDS NO -NORWAY OM -OMAN PK -PAKISTAN PW -PALAU PS -PALESTINIAN TERRITORY, OCCUPIED PA -PANAMA PG -PAPUA NEW GUINEA PY -PARAGUAY PE -PERU PH -PHILIPPINES PN -PITCAIRN PL -POLAND PT -PORTUGAL PR -PUERTO RICO QA -QATAR RE -Rƒ‰UNION RO -ROMANIA RU -RUSSIAN FEDERATION RW -RWANDA SH -SAINT HELENA KN -SAINT KITTS AND NEVIS LC -SAINT LUCIA PM -SAINT PIERRE AND MIQUELON VC -SAINT VINCENT AND THE GRENADINES WS -SAMOA SM -SAN MARINO ST -SAO TOME AND PRINCIPE SA -SAUDI ARABIA SN -SENEGAL CS -SERBIA AND MONTENEGRO SC -SEYCHELLES SL -SIERRA LEONE SG -SINGAPORE SK -SLOVAKIA SI -SLOVENIA SB -SOLOMON ISLANDS SO -SOMALIA ZA -SOUTH AFRICA GS -SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS ES -SPAIN LK -SRI LANKA SD -SUDAN SR -SURINAME SJ -SVALBARD AND JAN MAYEN SZ -SWAZILAND SE -SWEDEN CH -SWITZERLAND SY -SYRIAN ARAB REPUBLIC TW -TAIWAN, PROVINCE OF CHINA TJ -TAJIKISTAN TZ -TANZANIA, UNITED REPUBLIC OF TH -THAILAND TL -TIMOR-LESTE TG - TOGO TK -TOKELAU TO -TONGA TT -TRINIDAD AND TOBAGO TN -TUNISIA TR -TURKEY TM -TURKMENISTAN TC -TURKS AND CAICOS ISLANDS TV -TUVALU UG -UGANDA UA -UKRAINE AE -UNITED ARAB EMIRATES GB -UNITED KINGDOM US -UNITED STATES UM -UNITED STATES MINOR OUTLYING ISLANDS UY -URUGUAY UZ -UZBEKISTAN VU -VANUATU VE -VENEZUELA VN -VIET NAM VG -VIRGIN ISLANDS, BRITISH VI -VIRGIN ISLANDS, U.S. WF -WALLIS AND FUTUNA EH -WESTERN SAHARA YE -YEMEN ZM -ZAMBIA ZW -ZIMBABWE
More information at: http://www.starstandard.org.
Enumerations
Code ValueDescription
US
AF
AL
DZ
AS
AD
AO
AI
AQ
AG
AR
AM
AW
AU
AT
AZ
BS
BH
BD
BB
BY
BE
BZ
BJ
BM
BT
BO
BA
BW
BV
BR
IO
BN
BG
BF
BI
KH
CM
CA
CV
KY
CF
TD
CL
CN
CX
CC
CO
KM
CG
CD
CK
CR
CI
HR
CU
CY
CZ
DK
DJ
DM
DO
EC
EG
SV
GQ
ER
EE
ET
FK
FO
FJ
FI
FR
GF
PF
TF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP
GU
GT
GN
GW
GY
HT
HM
VA
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IL
IT
JM
JP
JO
KZ
KE
KI
KP
KR
KW
KG
LA
LV
LB
LS
LR
LY
LI
LT
LU
MO
MK
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
MD
MC
MN
MS
MA
MZ
MM
NA
NR
NP
NL
AN
NC
NZ
NI
NE
NG
NU
NF
MP
NO
OM
PK
PW
PS
PA
PG
PY
PE
PH
PN
PL
PT
PR
QA
RE
RO
RU
RW
SH
KN
LC
PM
VC
WS
SM
ST
SA
SN
CS
SC
SL
SG
SK
SI
SB
SO
ZA
GS
ES
LK
SD
SR
SJ
SZ
SE
CH
SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
UM
UY
UZ
VU
VE
VN
VG
VI
WF
EH
YE
ZM
ZW

Schema Component Representation
<xsd:simpleType name="Country">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="US"/>
<xsd:enumeration value="AF"/>
<xsd:enumeration value="AL"/>
<xsd:enumeration value="DZ"/>
<xsd:enumeration value="AS"/>
<xsd:enumeration value="AD"/>
<xsd:enumeration value="AO"/>
<xsd:enumeration value="AI"/>
<xsd:enumeration value="AQ"/>
<xsd:enumeration value="AG"/>
<xsd:enumeration value="AR"/>
<xsd:enumeration value="AM"/>
<xsd:enumeration value="AW"/>
<xsd:enumeration value="AU"/>
<xsd:enumeration value="AT"/>
<xsd:enumeration value="AZ"/>
<xsd:enumeration value="BS"/>
<xsd:enumeration value="BH"/>
<xsd:enumeration value="BD"/>
<xsd:enumeration value="BB"/>
<xsd:enumeration value="BY"/>
<xsd:enumeration value="BE"/>
<xsd:enumeration value="BZ"/>
<xsd:enumeration value="BJ"/>
<xsd:enumeration value="BM"/>
<xsd:enumeration value="BT"/>
<xsd:enumeration value="BO"/>
<xsd:enumeration value="BA"/>
<xsd:enumeration value="BW"/>
<xsd:enumeration value="BV"/>
<xsd:enumeration value="BR"/>
<xsd:enumeration value="IO"/>
<xsd:enumeration value="BN"/>
<xsd:enumeration value="BG"/>
<xsd:enumeration value="BF"/>
<xsd:enumeration value="BI"/>
<xsd:enumeration value="KH"/>
<xsd:enumeration value="CM"/>
<xsd:enumeration value="CA"/>
<xsd:enumeration value="CV"/>
<xsd:enumeration value="KY"/>
<xsd:enumeration value="CF"/>
<xsd:enumeration value="TD"/>
<xsd:enumeration value="CL"/>
<xsd:enumeration value="CN"/>
<xsd:enumeration value="CX"/>
<xsd:enumeration value="CC"/>
<xsd:enumeration value="CO"/>
<xsd:enumeration value="KM"/>
<xsd:enumeration value="CG"/>
<xsd:enumeration value="CD"/>
<xsd:enumeration value="CK"/>
<xsd:enumeration value="CR"/>
<xsd:enumeration value="CI"/>
<xsd:enumeration value="HR"/>
<xsd:enumeration value="CU"/>
<xsd:enumeration value="CY"/>
<xsd:enumeration value="CZ"/>
<xsd:enumeration value="DK"/>
<xsd:enumeration value="DJ"/>
<xsd:enumeration value="DM"/>
<xsd:enumeration value="DO"/>
<xsd:enumeration value="EC"/>
<xsd:enumeration value="EG"/>
<xsd:enumeration value="SV"/>
<xsd:enumeration value="GQ"/>
<xsd:enumeration value="ER"/>
<xsd:enumeration value="EE"/>
<xsd:enumeration value="ET"/>
<xsd:enumeration value="FK"/>
<xsd:enumeration value="FO"/>
<xsd:enumeration value="FJ"/>
<xsd:enumeration value="FI"/>
<xsd:enumeration value="FR"/>
<xsd:enumeration value="GF"/>
<xsd:enumeration value="PF"/>
<xsd:enumeration value="TF"/>
<xsd:enumeration value="GA"/>
<xsd:enumeration value="GM"/>
<xsd:enumeration value="GE"/>
<xsd:enumeration value="DE"/>
<xsd:enumeration value="GH"/>
<xsd:enumeration value="GI"/>
<xsd:enumeration value="GR"/>
<xsd:enumeration value="GL"/>
<xsd:enumeration value="GD"/>
<xsd:enumeration value="GP"/>
<xsd:enumeration value="GU"/>
<xsd:enumeration value="GT"/>
<xsd:enumeration value="GN"/>
<xsd:enumeration value="GW"/>
<xsd:enumeration value="GY"/>
<xsd:enumeration value="HT"/>
<xsd:enumeration value="HM"/>
<xsd:enumeration value="VA"/>
<xsd:enumeration value="HN"/>
<xsd:enumeration value="HK"/>
<xsd:enumeration value="HU"/>
<xsd:enumeration value="IS"/>
<xsd:enumeration value="IN"/>
<xsd:enumeration value="ID"/>
<xsd:enumeration value="IR"/>
<xsd:enumeration value="IQ"/>
<xsd:enumeration value="IE"/>
<xsd:enumeration value="IL"/>
<xsd:enumeration value="IT"/>
<xsd:enumeration value="JM"/>
<xsd:enumeration value="JP"/>
<xsd:enumeration value="JO"/>
<xsd:enumeration value="KZ"/>
<xsd:enumeration value="KE"/>
<xsd:enumeration value="KI"/>
<xsd:enumeration value="KP"/>
<xsd:enumeration value="KR"/>
<xsd:enumeration value="KW"/>
<xsd:enumeration value="KG"/>
<xsd:enumeration value="LA"/>
<xsd:enumeration value="LV"/>
<xsd:enumeration value="LB"/>
<xsd:enumeration value="LS"/>
<xsd:enumeration value="LR"/>
<xsd:enumeration value="LY"/>
<xsd:enumeration value="LI"/>
<xsd:enumeration value="LT"/>
<xsd:enumeration value="LU"/>
<xsd:enumeration value="MO"/>
<xsd:enumeration value="MK"/>
<xsd:enumeration value="MG"/>
<xsd:enumeration value="MW"/>
<xsd:enumeration value="MY"/>
<xsd:enumeration value="MV"/>
<xsd:enumeration value="ML"/>
<xsd:enumeration value="MT"/>
<xsd:enumeration value="MH"/>
<xsd:enumeration value="MQ"/>
<xsd:enumeration value="MR"/>
<xsd:enumeration value="MU"/>
<xsd:enumeration value="YT"/>
<xsd:enumeration value="MX"/>
<xsd:enumeration value="FM"/>
<xsd:enumeration value="MD"/>
<xsd:enumeration value="MC"/>
<xsd:enumeration value="MN"/>
<xsd:enumeration value="MS"/>
<xsd:enumeration value="MA"/>
<xsd:enumeration value="MZ"/>
<xsd:enumeration value="MM"/>
<xsd:enumeration value="NA"/>
<xsd:enumeration value="NR"/>
<xsd:enumeration value="NP"/>
<xsd:enumeration value="NL"/>
<xsd:enumeration value="AN"/>
<xsd:enumeration value="NC"/>
<xsd:enumeration value="NZ"/>
<xsd:enumeration value="NI"/>
<xsd:enumeration value="NE"/>
<xsd:enumeration value="NG"/>
<xsd:enumeration value="NU"/>
<xsd:enumeration value="NF"/>
<xsd:enumeration value="MP"/>
<xsd:enumeration value="NO"/>
<xsd:enumeration value="OM"/>
<xsd:enumeration value="PK"/>
<xsd:enumeration value="PW"/>
<xsd:enumeration value="PS"/>
<xsd:enumeration value="PA"/>
<xsd:enumeration value="PG"/>
<xsd:enumeration value="PY"/>
<xsd:enumeration value="PE"/>
<xsd:enumeration value="PH"/>
<xsd:enumeration value="PN"/>
<xsd:enumeration value="PL"/>
<xsd:enumeration value="PT"/>
<xsd:enumeration value="PR"/>
<xsd:enumeration value="QA"/>
<xsd:enumeration value="RE"/>
<xsd:enumeration value="RO"/>
<xsd:enumeration value="RU"/>
<xsd:enumeration value="RW"/>
<xsd:enumeration value="SH"/>
<xsd:enumeration value="KN"/>
<xsd:enumeration value="LC"/>
<xsd:enumeration value="PM"/>
<xsd:enumeration value="VC"/>
<xsd:enumeration value="WS"/>
<xsd:enumeration value="SM"/>
<xsd:enumeration value="ST"/>
<xsd:enumeration value="SA"/>
<xsd:enumeration value="SN"/>
<xsd:enumeration value="CS"/>
<xsd:enumeration value="SC"/>
<xsd:enumeration value="SL"/>
<xsd:enumeration value="SG"/>
<xsd:enumeration value="SK"/>
<xsd:enumeration value="SI"/>
<xsd:enumeration value="SB"/>
<xsd:enumeration value="SO"/>
<xsd:enumeration value="ZA"/>
<xsd:enumeration value="GS"/>
<xsd:enumeration value="ES"/>
<xsd:enumeration value="LK"/>
<xsd:enumeration value="SD"/>
<xsd:enumeration value="SR"/>
<xsd:enumeration value="SJ"/>
<xsd:enumeration value="SZ"/>
<xsd:enumeration value="SE"/>
<xsd:enumeration value="CH"/>
<xsd:enumeration value="SY"/>
<xsd:enumeration value="TW"/>
<xsd:enumeration value="TJ"/>
<xsd:enumeration value="TZ"/>
<xsd:enumeration value="TH"/>
<xsd:enumeration value="TL"/>
<xsd:enumeration value="TG"/>
<xsd:enumeration value="TK"/>
<xsd:enumeration value="TO"/>
<xsd:enumeration value="TT"/>
<xsd:enumeration value="TN"/>
<xsd:enumeration value="TR"/>
<xsd:enumeration value="TM"/>
<xsd:enumeration value="TC"/>
<xsd:enumeration value="TV"/>
<xsd:enumeration value="UG"/>
<xsd:enumeration value="UA"/>
<xsd:enumeration value="AE"/>
<xsd:enumeration value="GB"/>
<xsd:enumeration value="UM"/>
<xsd:enumeration value="UY"/>
<xsd:enumeration value="UZ"/>
<xsd:enumeration value="VU"/>
<xsd:enumeration value="VE"/>
<xsd:enumeration value="VN"/>
<xsd:enumeration value="VG"/>
<xsd:enumeration value="VI"/>
<xsd:enumeration value="WF"/>
<xsd:enumeration value="EH"/>
<xsd:enumeration value="YE"/>
<xsd:enumeration value="ZM"/>
<xsd:enumeration value="ZW"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: DateTime

Super-types:xsd:dateTime < DateTime (by restriction)
Sub-types:

NameDateTime
DocumentationDate and time conforms to ISO 8601format rules without offset EX:2003-11-05T13:15:30Z
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="DateTime">
<xsd:restriction base="xsd:dateTime"/>
</xsd:simpleType>
top

Simple Type: DocumentDateTime

Super-types:xsd:dateTime < DateTime (by restriction) < DocumentDateTime (by restriction)
Sub-types:None

NameDocumentDateTime
DocumentationIs the date and time the document was last created. This is not the date and time that the BOD message instance was created.
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="DocumentDateTime">
<xsd:restriction base="DateTime"/>
</xsd:simpleType>
top

Simple Type: ErrorType

Super-types:xsd:string < Type (by restriction) < ErrorType (by restriction)
Sub-types:None

NameErrorType
DocumentationDefines the type of error that occurred.
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="ErrorType">
<xsd:restriction base="Type"/>
</xsd:simpleType>
top

Simple Type: Indicator

Super-types:xsd:string < Indicator (by restriction)
Sub-types:None

NameIndicator
Documentation0 = No, 1 = Yes
More information at: http://www.starstandard.org.
Enumerations
Code ValueDescription
0
1

Schema Component Representation
<xsd:simpleType name="Indicator">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="0"/>
<xsd:enumeration value="1"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: Language

Super-types:xsd:string < Language (by restriction)
Sub-types:None

NameLanguage
DocumentationLanguage conforms to ISO 639-2 rules. Note the format for this field is language-Country (see Country data type for the list of countries with definitions). AA "Afar", AB "Abkhazian", AF "Afrikaans", AM "Amharic", AR "Arabic", AS "Assamese", AY "Aymara", AZ "Azerbaijani", BA "Bashkir", BE "Byelorussian", BG "Bulgarian", BH "Bihari", BI "Bislama", BN "Bengali" "Bangla", BO "Tibetan", BR "Breton", CA "Catalan", CO "Corsican", CS "Czech", CY "Welsh", DA "Danish", DE "German", DZ "Bhutani", EL "Greek", EN "English" "American", ES "Spanish", ET "Estonian", EU "Basque", FA "Persian", FI "Finnish", FJ "Fiji", FO "Faeroese", FR "French", FY "Frisian", GA "Irish", GD "Gaelic" "Scots Gaelic", GL "Galician", GN "Guarani", GU "Gujarati", HA "Hausa", HI "Hindi", HR "Croatian", HU "Hungarian", HY "Armenian", IK "Inupiak", IN "Indonesian", IS "Icelandic", IT "Italian", IW "Hebrew", JA "Japanese", JI "Yiddish", JW "Javanese", KA "Georgian", KK "Kazakh", KL "Greenlandic", KM "Cambodian", KN "Kannada", KO "Korean", KS "Kashmiri", KU "Kurdish", KY "Kirghiz", LA "Latin", LN "Lingala", LO "Laothian", LT "Lithuanian", LV "Latvian" "Lettish", MG "Malagasy". MI "Maori", MK "Macedonian", ML "Malayalam", MN "Mongolian", MO "Moldavian", MR "Marathi", MS "Malay", MT "Maltese", MY "Burmese", NA "Nauru", NE "Nepali", NL "Dutch", NO "Norwegian", OC "Occitan", OM "Oromo" "Afan", OR "Oriya", PA "Punjabi", PL "Polish", PS "Pashto" "Pushto", PT "Portuguese", QU "Quechua", RM "Rhaeto-Romance", RN "Kirundi", RO "Romanian", RU "Russian", RW "Kinyarwanda", SA "Sanskrit", SD "Sindhi", SG "Sangro", SH "Serbo-Croatian", SI "Singhalese", SK "Slovak", SL "Slovenian", SM "Samoan", SN "Shona", SO "Somali", SQ "Albanian", SR "Serbian", SS "Siswati", ST "Sesotho", SU "Sudanese", SV "Swedish", SW "Swahili", TA "Tamil", TE "Tegulu", TG "Tajik", TH "Thai", TI "Tigrinya", TK "Turkmen", TL "Tagalog", TN "Setswana", TO "Tonga", TR "Turkish", TS "Tsonga", TT "Tatar", TW "Twi", UK "Ukrainian", UR "Urdu", UZ "Uzbek", VI "Vietnamese", WO "Wolof", XH "Xhosa", YO "Yoruba", ZH "Chinese", ZU "Zulu"
More information at: http://www.starstandard.org.
Enumerations
Code ValueDescription
en-US
en-CA
aa-ET
ab-GE
af-ZA
am- ET
ar-SA
as-IN
ay-BO
az-AZ
ba-RU
be-BY
bg-BG
bh-IN
bi-VU
bn-BD
bo-BT
br-FR
ca-ES
co-FR
cs-CZ
cy-GB
da-DE
de-DE
dz-BT
el-GR
es-ES
et-EE
eu-ES
fa-AF
fi-FI
fj-FJ
fo-FO
fr-CA
fr-FR
fy-NL
ga-IE
gd-GB
gl-ES
gn-PY
gu-IN
ha-NG
hi-IN
hr-HR
hu-HU
hy-AM
ik-GL
in-ID
is-IS
it-IT
iw-IL
ja-JP
ji-IL
jw-ID
ka-GE
kk-KZ
kl-GL
km-KH
kn-IN
ko-KP
ko-KR
ks-IN
ku-IQ
ky-CN
la-VA
ln-CD
lo-LA
lt-LT
lv-LV
mg-MG
mi-NZ
mk-MK
ml-IN
mn-MN
mo-MO
mr-IN
ms-MY
mt-MH
my-MM
na-NR
ne-NP
nl-NL
no-NO
oc-FR
om- ET
or-IN
pa-IN
pl-PL
ps-PK
pt-PT
qu-PE
rm-CH
rn-BI
ro-RO
ru-RU
rw-RW
sa-IN
sd-PK
sg-CF
sh-HR
si-LK
sk-SK
sl-SI
sm-WS
sn-ZW
so-SO
sq-AL
sr-CS
ss-ZA
st-ZA
su-SD
sv-SE
sw-TL
ta-IN
te-IN
tg-TJ
th-TH
ti-ET
tk-TM
tl-PH
tn-ZA
to-TO
tr-TR
ts-ZA
tt-RU
tw-GH
uk-UA
ur-PK
uz-UZ
vi-VN
wo-SN
xh-ZA
yo-NG
zh-CN
zu-ZA

Schema Component Representation
<xsd:simpleType name="Language">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="en-US"/>
<xsd:enumeration value="en-CA"/>
<xsd:enumeration value="aa-ET"/>
<xsd:enumeration value="ab-GE"/>
<xsd:enumeration value="af-ZA"/>
<xsd:enumeration value="am- ET"/>
<xsd:enumeration value="ar-SA"/>
<xsd:enumeration value="as-IN"/>
<xsd:enumeration value="ay-BO"/>
<xsd:enumeration value="az-AZ"/>
<xsd:enumeration value="ba-RU"/>
<xsd:enumeration value="be-BY"/>
<xsd:enumeration value="bg-BG"/>
<xsd:enumeration value="bh-IN"/>
<xsd:enumeration value="bi-VU"/>
<xsd:enumeration value="bn-BD"/>
<xsd:enumeration value="bo-BT"/>
<xsd:enumeration value="br-FR"/>
<xsd:enumeration value="ca-ES"/>
<xsd:enumeration value="co-FR"/>
<xsd:enumeration value="cs-CZ"/>
<xsd:enumeration value="cy-GB"/>
<xsd:enumeration value="da-DE"/>
<xsd:enumeration value="de-DE"/>
<xsd:enumeration value="dz-BT"/>
<xsd:enumeration value="el-GR"/>
<xsd:enumeration value="es-ES"/>
<xsd:enumeration value="et-EE"/>
<xsd:enumeration value="eu-ES"/>
<xsd:enumeration value="fa-AF"/>
<xsd:enumeration value="fi-FI"/>
<xsd:enumeration value="fj-FJ"/>
<xsd:enumeration value="fo-FO"/>
<xsd:enumeration value="fr-CA"/>
<xsd:enumeration value="fr-FR"/>
<xsd:enumeration value="fy-NL"/>
<xsd:enumeration value="ga-IE"/>
<xsd:enumeration value="gd-GB"/>
<xsd:enumeration value="gl-ES"/>
<xsd:enumeration value="gn-PY"/>
<xsd:enumeration value="gu-IN"/>
<xsd:enumeration value="ha-NG"/>
<xsd:enumeration value="hi-IN"/>
<xsd:enumeration value="hr-HR"/>
<xsd:enumeration value="hu-HU"/>
<xsd:enumeration value="hy-AM"/>
<xsd:enumeration value="ik-GL"/>
<xsd:enumeration value="in-ID"/>
<xsd:enumeration value="is-IS"/>
<xsd:enumeration value="it-IT"/>
<xsd:enumeration value="iw-IL"/>
<xsd:enumeration value="ja-JP"/>
<xsd:enumeration value="ji-IL"/>
<xsd:enumeration value="jw-ID"/>
<xsd:enumeration value="ka-GE"/>
<xsd:enumeration value="kk-KZ"/>
<xsd:enumeration value="kl-GL"/>
<xsd:enumeration value="km-KH"/>
<xsd:enumeration value="kn-IN"/>
<xsd:enumeration value="ko-KP"/>
<xsd:enumeration value="ko-KR"/>
<xsd:enumeration value="ks-IN"/>
<xsd:enumeration value="ku-IQ"/>
<xsd:enumeration value="ky-CN"/>
<xsd:enumeration value="la-VA"/>
<xsd:enumeration value="ln-CD"/>
<xsd:enumeration value="lo-LA"/>
<xsd:enumeration value="lt-LT"/>
<xsd:enumeration value="lv-LV"/>
<xsd:enumeration value="mg-MG"/>
<xsd:enumeration value="mi-NZ"/>
<xsd:enumeration value="mk-MK"/>
<xsd:enumeration value="ml-IN"/>
<xsd:enumeration value="mn-MN"/>
<xsd:enumeration value="mo-MO"/>
<xsd:enumeration value="mr-IN"/>
<xsd:enumeration value="ms-MY"/>
<xsd:enumeration value="mt-MH"/>
<xsd:enumeration value="my-MM"/>
<xsd:enumeration value="na-NR"/>
<xsd:enumeration value="ne-NP"/>
<xsd:enumeration value="nl-NL"/>
<xsd:enumeration value="no-NO"/>
<xsd:enumeration value="oc-FR"/>
<xsd:enumeration value="om- ET"/>
<xsd:enumeration value="or-IN"/>
<xsd:enumeration value="pa-IN"/>
<xsd:enumeration value="pl-PL"/>
<xsd:enumeration value="ps-PK"/>
<xsd:enumeration value="pt-PT"/>
<xsd:enumeration value="qu-PE"/>
<xsd:enumeration value="rm-CH"/>
<xsd:enumeration value="rn-BI"/>
<xsd:enumeration value="ro-RO"/>
<xsd:enumeration value="ru-RU"/>
<xsd:enumeration value="rw-RW"/>
<xsd:enumeration value="sa-IN"/>
<xsd:enumeration value="sd-PK"/>
<xsd:enumeration value="sg-CF"/>
<xsd:enumeration value="sh-HR"/>
<xsd:enumeration value="si-LK"/>
<xsd:enumeration value="sk-SK"/>
<xsd:enumeration value="sl-SI"/>
<xsd:enumeration value="sm-WS"/>
<xsd:enumeration value="sn-ZW"/>
<xsd:enumeration value="so-SO"/>
<xsd:enumeration value="sq-AL"/>
<xsd:enumeration value="sr-CS"/>
<xsd:enumeration value="ss-ZA"/>
<xsd:enumeration value="st-ZA"/>
<xsd:enumeration value="su-SD"/>
<xsd:enumeration value="sv-SE"/>
<xsd:enumeration value="sw-TL"/>
<xsd:enumeration value="ta-IN"/>
<xsd:enumeration value="te-IN"/>
<xsd:enumeration value="tg-TJ"/>
<xsd:enumeration value="th-TH"/>
<xsd:enumeration value="ti-ET"/>
<xsd:enumeration value="tk-TM"/>
<xsd:enumeration value="tl-PH"/>
<xsd:enumeration value="tn-ZA"/>
<xsd:enumeration value="to-TO"/>
<xsd:enumeration value="tr-TR"/>
<xsd:enumeration value="ts-ZA"/>
<xsd:enumeration value="tt-RU"/>
<xsd:enumeration value="tw-GH"/>
<xsd:enumeration value="uk-UA"/>
<xsd:enumeration value="ur-PK"/>
<xsd:enumeration value="uz-UZ"/>
<xsd:enumeration value="vi-VN"/>
<xsd:enumeration value="wo-SN"/>
<xsd:enumeration value="xh-ZA"/>
<xsd:enumeration value="yo-NG"/>
<xsd:enumeration value="zh-CN"/>
<xsd:enumeration value="zu-ZA"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: MessageReasonCode

Super-types:xsd:string < MessageReasonCode (by restriction)
Sub-types:None

NameMessageReasonCode
DocumentationCode indicating reason for message.
More information at: http://www.starstandard.org.
Enumerations
Code ValueDescription
SuccessThe operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success.
AcceptedThe BOD was received, validated, and accepted. However, it may not have yet been processed. The client should expect to receive a response once process is complete. If no response will be generated, use the "Success" code instead. This is typically used for batch processing. Type of Response Code: Success.
ReceivedThe BOD was received. However, it has not yet been validated or processed yet. The client may receive a response or a ConfirmBOD at a later time. Type of Response Code: Success.
OtherOther
Duplicate DocumentThis code refers to a document that already exists. This may happen for a BOD such as ProcessPartsOrder where the document identifiers to another existing parts order from the same dealer. Type of Response Code: Error, Warning.
Invalid Required ValueOne or more required data elements have invalid values. Type of Response Code: Error.
Invalid Optional ValueOne or more optional data elements have invalid values. Type of Response Code: Warning.
Already PerformedThis code refers to an operation that has already been performed on a document. This may happen for a BOD such as CancelPartsOrder where the document identifier refer to a parts order that has already been cancelled. Type of Response Code: Error.
Cannot PerformThis code refers to an operation that cannot be performed such as Change or Cancel based on the receiver's business rules and the condition of the document. For example, the part order has already been shipped therefore the order cannot be cancelled. Type of Response Code: Error.
Required Field MissingThis occurs when one or more required fields are missing. Type of Response Code: Error.
Optional Field MissingThis occurs when one or more optional fields are missing. Type of Response Code: Warning.
Not PermittedThis code occurs when the client attempts to perform an operation that is not permitted. An example of when this may occur is if the dealer attempts to order a part when their account is placed on hold. This is to be used for authorization errors. Type of Response Code: Error.
Server ErrorAn error (e.g. database server is down) on the server prevented the execution of the BOD. The client will have to resend the BOD at a later time. Type of Response Code: Error.
BOD Not SupportedThe received BOD or BOD version is not supported b the receiver. Type of Response Code: Error.
Invalid StructureThe structure of the BOD is not valid. For example, the BOD failed schema validation. Type of Response Code: Error.

Schema Component Representation
<xsd:simpleType name="MessageReasonCode">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Success"/>
<xsd:enumeration value="Accepted"/>
<xsd:enumeration value="Received"/>
<xsd:enumeration value="Other"/>
<xsd:enumeration value="Duplicate Document"/>
<xsd:enumeration value="Invalid Required Value"/>
<xsd:enumeration value="Invalid Optional Value"/>
<xsd:enumeration value="Already Performed"/>
<xsd:enumeration value="Cannot Perform"/>
<xsd:enumeration value="Required Field Missing"/>
<xsd:enumeration value="Optional Field Missing"/>
<xsd:enumeration value="Not Permitted"/>
<xsd:enumeration value="Server Error"/>
<xsd:enumeration value="BOD Not Supported"/>
<xsd:enumeration value="Invalid Structure"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: Note

Super-types:xsd:string < Note (by restriction)
Sub-types:

NameNote
DocumentationA free form note.
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="Note">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
top

Simple Type: Reference

Super-types:xsd:string < Text (by restriction) < Reference (by restriction)
Sub-types:None

NameReference
DocumentationReference notation
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="Reference">
<xsd:restriction base="Text"/>
</xsd:simpleType>
top

Simple Type: ReferenceNumber

Super-types:xsd:string < ReferenceNumber (by restriction)
Sub-types:

NameReferenceNumber
DocumentationReference number
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="ReferenceNumber">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
top

Simple Type: ReferenceValue

Super-types:xsd:string < Note (by restriction) < ReferenceValue (by restriction)
Sub-types:None

NameReferenceValue
DocumentationThe value associated with a field.
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="ReferenceValue">
<xsd:restriction base="Note"/>
</xsd:simpleType>
top

Simple Type: SecondaryPassword

Super-types:xsd:string < Note (by restriction) < SecondaryPassword (by restriction)
Sub-types:None

NameSecondaryPassword
DocumentationSecondary password used to validate access to the dealer information
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="SecondaryPassword">
<xsd:restriction base="Note"/>
</xsd:simpleType>
top

Simple Type: ShortMfg

Super-types:xsd:string < Code (by restriction) < ShortMfg (by restriction)
Sub-types:None

NameShortMfg
DocumentationShort Manfacturer or RSP Codes
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="ShortMfg">
<xsd:restriction base="Code"/>
</xsd:simpleType>
top

Simple Type: SystemVersion

Super-types:xsd:string < ReferenceNumber (by restriction) < SystemVersion (by restriction)
Sub-types:None

NameSystemVersion
DocumentationThe sender's software version number .
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="SystemVersion">
<xsd:restriction base="ReferenceNumber"/>
</xsd:simpleType>
top

Simple Type: Text

Super-types:xsd:string < Text (by restriction)
Sub-types:

NameText
DocumentationIndicates generic text type
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="Text">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
top

Simple Type: Type

Super-types:xsd:string < Type (by restriction)
Sub-types:

NameType
DocumentationType
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="Type">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
top

Simple Type: URI

Super-types:xsd:anyURI < URI (by restriction)
Sub-types:None

NameURI
DocumentationURI
More information at: http://www.starstandard.org.

Schema Component Representation
<xsd:simpleType name="URI">
<xsd:restriction base="xsd:anyURI"/>
</xsd:simpleType>
top

Copyright 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved

Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: