Implementation Guideline
Show Standard Codes
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Show Standard Codes
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
This document is a guideline on how to use the Show Standard Codes Business Object Document (BOD). Show Standard Codes has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Show Standard Codes process for individual consumers who service their automobiles through their OEM’s authorized Dealers. The focus is on Dealer and OEM interactions, not third party organizations. NOTE: Although this is the traditional use of the Show Standard Codes, this BOD could be used to send Show Standard Codes information between any two business parties.
The Show Standard Codes Implementation Guidelines provide detailed information regarding the structure and meaning of the Show Standard Codes BOD and corresponds directly to the Show Standard Codes 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 Show Standard Codes Implementation Guidelines must be used in concert with the Show Standard Codes 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 Show Standard Codes 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 Business Object Document methodology to develop the Show Standard Codes BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Show Standard Codes BOD is unique to the Retail Automotive industry and is not an extension of any existing OAGIS BODs.
For more information on the Open Applications Group's BODs and related documentation please refer to the Open Applications Group’s Web site at www.openapplications.org.
STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Show Standard Codes except the Get verb. 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 be noted in the business rules.
The Standard Codes Binary Collaboration starts with the push of a Standard Code file from the OEM to the Dealer. After this occurs, the OEM may send updates to the Standard Codes files as many times as is needed. Alternatively, the Standard Codes Binary Collaboration could start with the request of Standard Codes from the Dealer to the OEM. In response, Standard Codes files would be sent from the OEM to the Dealer. This process could occur on demand as is needed. These scenarios are examples of how the Standard Codes BOD can be used. Implementations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Show Standard Codes 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.
| Target Namespace | http://www.starstandards.org/STAR |
|---|---|
| Element and Attribute Namespaces |
|
| Documentation | This 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/. |
| Prefix | Namespace |
|---|---|
| Default namespace | http://www.starstandards.org/STAR |
| xml | http://www.w3.org/XML/1998/namespace |
| xsd | http://www.w3.org/2001/XMLSchema |
| Name | ApplicationArea |
|---|---|
| Type | ApplicationArea |
| Nillable | no |
| Abstract | no |
| Documentation | 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. 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. |
| Name | Header |
|---|---|
| Type | StandardCodesHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | LineItems |
|---|---|
| Type | StandardCodesLineItems |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Show |
|---|---|
| Type | Show |
| Nillable | no |
| Abstract | no |
| Documentation | The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types. More information at: http://www.openapplications.org/oagis. |
| Name | ShowStandardCodes |
|---|---|
| Type | ShowStandardCodes |
| Nillable | no |
| Abstract | no |
| Name | StandardCodes |
|---|---|
| Type | StandardCodes |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ApplicationArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Sender | Identifies 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 | |
| CreationDateTime | is 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
|
| Signature | If 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 | |
| BODId | The 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 | |
| Destination | Information related to the receiver of the BOD | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | BusinessObjectDocument |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| revision | This 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 | |
| release | Indicates the OAGIS release that this BOD belongs. | Optional | |
| environment | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Optional | |
| lang | Indicates the language that the contents of the BOD is in unless otherwise stated. | Optional | |
| bodVersion | Deprecated 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 |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ApplicationArea | 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. | Required |
| Super-types: | xsd:string < Description (by extension) < CodeDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | CodeDescription |
|---|---|
| Abstract | no |
| Documentation | Description of Code More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < CodeSupplementalDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | CodeSupplementalDescription |
|---|---|
| Abstract | no |
| Documentation | Supplemental code description or definition More information at: http://www.starstandard.org. |
| Super-types: | Verb < ConfirmableVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | ConfirmableVerb |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| confirm | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required |
| Super-types: | xsd:string < Description (by extension) |
|---|---|
| Sub-types: | None |
| Name | Description |
|---|---|
| Abstract | no |
| Documentation | Description More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| language | The ISO language code that the description is written. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Destination |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DestinationNameCode | Code 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
|
| DestinationURI | Physical address of the destination | Optional | |
| DestinationSoftwareCode | Additional information about the destination application | Optional | |
| DestinationSoftware | For which software destination file is intended (may not be known). | Optional | |
| DealerNumber | Target Dealer Code receiving information | Optional | |
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Target Dealer country location | Optional | |
| PartyId | The 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 | |
| LocationId | The 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 | |
| ServiceId | The Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. | Optional |
| Super-types: | xsd:string < Id (by extension) < DocumentId (by extension) |
|---|---|
| Sub-types: | None |
| Name | DocumentId |
|---|---|
| Abstract | no |
| Documentation | Is the identifier for the document. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | HeaderBase |
|---|---|
| Abstract | no |
| Documentation | Used on all STAR BODs More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional |
| Super-types: | xsd:string < Id (by extension) |
|---|---|
| Sub-types: | None |
| Name | Id |
|---|---|
| Abstract | no |
| Documentation | Party Identification number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < LocationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | LocationId |
|---|---|
| Abstract | no |
| Documentation | Code identifying a physical location More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < PartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartyId |
|---|---|
| Abstract | no |
| Documentation | Party Identification Number More information at: http://www.starstandard.org. |
| Super-types: | Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | ResponseVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| OriginalBODId | Optional |
| Super-types: | xsd:string < Id (by extension) < SecondaryDealerNumber (by extension) |
|---|---|
| Sub-types: | None |
| Name | SecondaryDealerNumber |
|---|---|
| Abstract | no |
| Documentation | Identifies secondary dealer number if different than primary "Dealer Number" More information at: http://www.starstandard.org. |
| Super-types: | SenderBase < Sender (by extension) |
|---|---|
| Sub-types: | None |
| Name | Sender |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LogicalId | Provides 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 | |
| Component | Provides 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 | |
| Task | Describes 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 | |
| ReferenceId | Enables 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 | |
| AuthorizationId | Identifyies 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 | |
| CreatorNameCode | DCS Software Creator Code | Required | |
| SenderNameCode | Additional 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
|
| SenderURI | Physical address of the sender | Optional | |
| DealerNumber | Dealer Code of source of information | Optional | |
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Source Dealer country location | Optional | |
| Language | This code is used to define the language of the data used in this transaction | Optional | |
| DeliverPendingMailInd | Indicates 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 | |
| Password | Token for application specific authentication. Used to authenticate dealership/users through application specific security | Optional | |
| SystemVersion | The sender's software version number. | Optional | |
| PartyId | The 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 | |
| LocationId | The 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 | |
| ServiceId | The Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | SenderBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LogicalId | Provides 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 | |
| Component | Provides 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 | |
| Task | Describes 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 | |
| ReferenceId | Enables 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 | |
| AuthorizationId | Identifyies 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 |
| Super-types: | xsd:string < Id (by extension) < ServiceId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ServiceId |
|---|---|
| Abstract | no |
| Documentation | The 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. |
| Super-types: | Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) < Show (by extension) |
|---|---|
| Sub-types: | None |
| Name | Show |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| OriginalBODId | Optional |
| Super-types: | BusinessObjectDocument < ShowStandardCodes (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShowStandardCodes |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ApplicationArea | 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. | Required | |
| DataArea | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ShowStandardCodesDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Show | The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types. | Required | |
| StandardCodes | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Signature |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| qualifyingAgency | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | StandardCodes |
|---|---|
| Abstract | no |
| Documentation | STAR Version 3.0 - Draft More information at: http://www.starstandards.org. STAR Version 2.1, STAR approved 04/20/2005; effective date 07/04/2005 More information at: http://www.starstandards.org. STAR Version 2.0, STAR approved 05/07/2004; effective date 07/04/2004 More information at: http://www.starstandards.org. STAR Version 1.0 STAR approved 11/22/2002; OAGI approved 3/15/2003; effective date 01/01/2003 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required | ||
| LineItems | Optional |
| Super-types: | HeaderBase < StandardCodesHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | StandardCodesHeader |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | |
| DocumentId | Identifier of standard codes table being passed Ex: SSCDESC - Special Service Campaign Description; SSCVIN - Special Service | Optional | |
| EffectiveDate | Effective date of standard codes table action | Optional | |
| CodesAction | Type of Action for Standard Codes Table | Optional | |
| TableDescription | Description of standard codes table | Optional | |
| TableRights | Identifying the Standard code process access rights | Optional | |
| Language | Language used for the standard code file being transmitted | Optional | |
| Usage | represents information on how the Standard Codes would be used | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | StandardCodesLineItems |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Code | Unique table code associated with line item description and associated values | Optional | |
| CodeDescription | Description of Standard Code | Optional | |
| Values | represents additional information for the Standard Codes LineItems | Optional |
| Super-types: | xsd:string < Description (by extension) < TableDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | TableDescription |
|---|---|
| Abstract | no |
| Documentation | Description of table More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Usage |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| XMLNoun | Transfer interface code identifying which interface may use this standard code table. May be blank if not interface specific. (Would be the XML noun name) | Optional | |
| FieldUsage | STAR Field name utilizing this standard code table | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Values |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| CodeValue | Associated code value one | Optional | |
| CodeSupplementalDescription | Supplemental code description or definition | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:string < Code (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Code |
|---|---|
| Documentation | Unique code name More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < CodesAction (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CodesAction |
|---|---|
| Documentation | Type of Action forCodes - A= Add to existing table, D= Delete existing table by Code, DA = Delete total table, N = Intital table load, R = Replace existing table by Code, RA = Replace total table More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| A | "A" = Approved |
| D | "D" = Denied |
| DA | Delete total table |
| N | "N" = New |
| R | "R" = Preliminary |
| RA | Replace total table |
| Super-types: | xsd:string < Note (by restriction) < CodeValue (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CodeValue |
|---|---|
| Documentation | Code value More information at: http://www.starstandard.org. |
| Super-types: | xsd:NMTOKEN < ConfirmType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ConfirmType |
|---|
| Code Value | Description |
|---|---|
| Always | |
| OnChange | |
| Never |
| Super-types: | xsd:string < Country (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Country |
|---|---|
| Documentation | Country 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. |
| Code Value | Description |
|---|---|
| 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 |
| Super-types: | xsd:date < Date (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Date |
|---|---|
| Documentation | Date conforms to ISO 8601 format rules EX: \d\d\d\d-\d\d-\d\d More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) |
|---|---|
| Sub-types: |
|
| Name | DateTime |
|---|---|
| Documentation | Date and time conforms to ISO 8601format rules without offset EX:2003-11-05T13:15:30Z More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) < DocumentDateTime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DocumentDateTime |
|---|---|
| Documentation | Is 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. |
| Super-types: | xsd:date < Date (by restriction) < EffectiveDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EffectiveDate |
|---|---|
| Documentation | Effective date More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < FieldUsage (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FieldUsage |
|---|---|
| Documentation | STAR Field name utilizing this code table More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Indicator |
|---|---|
| Documentation | 0 = No, 1 = Yes More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Language (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Language |
|---|---|
| Documentation | Language 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. |
| Code Value | Description |
|---|---|
| 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 |
| Super-types: | xsd:string < Note (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Note |
|---|---|
| Documentation | A free form note. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < Reference (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Reference |
|---|---|
| Documentation | Reference notation More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) |
|---|---|
| Sub-types: |
|
| Name | ReferenceNumber |
|---|---|
| Documentation | Reference number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < SecondaryPassword (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SecondaryPassword |
|---|---|
| Documentation | Secondary password used to validate access to the dealer information More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ShortMfg (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShortMfg |
|---|---|
| Documentation | Short Manfacturer or RSP Codes More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < SystemVersion (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SystemVersion |
|---|---|
| Documentation | The sender's software version number . More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < TableRights (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TableRights |
|---|---|
| Documentation | Identifying the table process access rights More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
| Super-types: | xsd:anyURI < URI (by restriction) |
|---|---|
| Sub-types: | None |
| Name | URI |
|---|---|
| Documentation | URI More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < XMLNoun (by restriction) |
|---|---|
| Sub-types: | None |
| Name | XMLNoun |
|---|---|
| Documentation | Transfer interface code identifying which interface may use this standard code table. May be blank if not interface specific. (Would be the XML noun name) More information at: http://www.starstandard.org. |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: