Implementation Guideline
Process Parts Inventory
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Process Parts Inventory
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 Process Parts Inventory Business Object Document (BOD). Process Parts Inventory has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Process Parts Inventory 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 Process Parts Inventory, this BOD could be used to send Process Parts Inventory information between any two business parties.
The Process Parts Inventory Implementation Guidelines provide detailed information regarding the structure and meaning of the Process Parts Inventory BOD and corresponds directly to the Process Parts Inventory 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 Process Parts Inventory Implementation Guidelines must be used in concert with the Process Parts Inventory 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 Process Parts Inventory 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 Process Parts Inventory BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Process Parts Inventory 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 Process Parts Inventory 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 Parts Inventory Binary Collaboration starts with the transmission of an extracted Parts Inventory file from the dealer to the OEM. In response, the OEM may send Parts Inventory information back to dealer. This process occurs on demand as is needed. Note: This scenario is an example of how the Parts Inventory BOD can be used. Implementations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Process Parts Inventory 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 | PartsInventoryHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Line |
|---|---|
| Type | PartsInventoryLine |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | PartsInventory |
|---|---|
| Type | PartsInventory |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Process |
|---|---|
| Type | Process |
| Nillable | no |
| Abstract | no |
| Documentation | The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowlegdes with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfil the agreement, unless of course other BODs are allowed to cancel or change the original order. More information at: http://www.openapplications.org/oagis. |
| Name | ProcessPartsInventory |
|---|---|
| Type | ProcessPartsInventory |
| Nillable | no |
| Abstract | no |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) < AcknowledgableVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | AcknowledgableVerb |
|---|---|
| Abstract | yes |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| acknowledge | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| Criteria | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ActionExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Expression | Required |
| Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | ActionVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| Criteria | Optional |
| Super-types: | xsd:decimal < Amount (by extension) |
|---|---|
| Sub-types: | None |
| Name | Amount |
|---|---|
| Abstract | no |
| Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| currency | Required |
| 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: | xsd:decimal < Quantity (by extension) < AverageWeeklyUsage (by extension) |
|---|---|
| Sub-types: | None |
| Name | AverageWeeklyUsage |
|---|---|
| Abstract | no |
| Documentation | The average weekly usage of a part as calculated by the dealer's DMS. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < BackOrderQuantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | BackOrderQuantity |
|---|---|
| Abstract | no |
| Documentation | Quantity of part on back order More information at: http://www.starstandard.org. |
| 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: | 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:integer < Count (by extension) |
|---|---|
| Sub-types: | None |
| Name | Count |
|---|---|
| Abstract | no |
| Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
| 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: | 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) < ItemId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ItemId |
|---|---|
| Abstract | no |
| Documentation | Item part number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < LastSentInventoryBODId (by extension) |
|---|---|
| Sub-types: | None |
| Name | LastSentInventoryBODId |
|---|---|
| Abstract | no |
| Documentation | BOD Id of the last inventory message received. 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: | None |
|---|---|
| Sub-types: | None |
| Name | MinimumAcknowledgementStatus |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| StatusType | Defines the type of status that occured. EX: S-Success, E-Error, W-Warning, I-Info, A-Abort | Optional | |
| StatusCode | A code identifying the reason for the status message. | Optional | |
| StatusText | Descriptive status text. | Optional |
| Super-types: | xsd:integer < Count (by extension) < MonthsNoSale (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MonthsNoSale |
|---|---|
| Abstract | no |
| Documentation | The number of months that a part has gone without a recorded sale - calculated on a calendar month basis. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | PartsInventory |
|---|---|
| Abstract | no |
| Documentation | STAR Version 2.0 - Draft More information at: http://www.starstandards.org. STAR Version 1.0, STAR approved 04/20/2005; OAGI approved 03/03/2005; effective date 07/04/2005 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required | ||
| Line | Optional |
| Super-types: | HeaderBase < PartsInventoryHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartsInventoryHeader |
|---|---|
| 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 | |
| PartType | Specifies whether the parts are identified by manufacturer part code or part number. | Optional |
Values: H - Manufacturer Part Code, P - Part number
is used
|
| FileSequenceNumber | Sequence for sent files. The first file is 1. | Optional | |
| InventoryType | Identifies the type of inventory being transmitted, either full or incremental. Full inventory is an extract of the entire parts inventory. Incremental is the change in inventory since the last reported inventory (identified by BODId). | Optional |
Please note that although the schema shows this as
an Optional field, in this BOD usage it should be
Required
|
| LastSentInventoryBODId | BOD id of the last inventory message received. | Optional | |
| Status | The Status component represents the type of status message that has occurred for the entire Parts Inventory. This could contain information related to errors that have occurred within the Parts Inventory, whether or not the Parts Inventory was successfully processed in the Receiver’s application, etc. Please note that this status message is NOT used to identify structure and syntax errors that occur during parsing. These types of errors should be reflected in the STAR Confirm BOD. The status component is strictly used for “Noun†specific errors. | Optional | (INACTIVE) Only to be used in:
AcknowledgePartsInventory
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | PartsInventoryLine |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ItemId | Identification of part in inventory. | Required | |
| QuantityOnHand | Quantity of part currently in inventory. | Optional | |
| QuantitySold | Quantity of part sold since last inventory. | Optional | |
| QuantityOfLostSale | Potential quantity of sales lost due to non-inventory since last inventory. | Optional | |
| PartClass | Gifts, literature, keys regular parts inventory class code (if any) used in DMS system. | Optional | |
| QuantityOnOrder | Quantity of all outstanding orders not received into inventory. | Optional | |
| QuantityReOrderPoint | Quantity that triggers dealers' reordering or part. | Optional | |
| QuantityTwelveMonthSales | Quantity sold over last 12 months (rolling). | Optional | |
| BinLocation | Dealer specific location of part. | Optional | |
| QuantityTwelveMonthLostSales | Quantity of lost sales over last 12 months (rolling) | Optional | |
| BackOrderQuantity | Quantity of part on back order. | Optional | |
| QuantityOfReturn | Quantity of part returned since last inventory. | Optional | |
| QuantityReserved | Quantity of part reserved for service. | Optional | |
| UnitPrice | Part unit retail price (cost + markup). | Optional | |
| QuantityDealerPartStocking | Dealer defined quantity that is to be stocked above the manufacturer recommended stocking level of the part. | Optional | |
| MonthsNoSale | The number of months that a part has gone without a recorded sale - calculated on a calendar month basis. | Optional | |
| QuantityAvailable | The quantity the dealer has available to release from inventory. It is traditionally defined as QuantityOnHand minus reserved or encumbered parts. | Optional | |
| ReplenishmentCode | Alphanumeric code that signals the manufacturer application if replenishment for the part is controlled by the manfucturer (value 2) or by the DMS (value 3). | Optional | |
| LastSoldDate | Last date this item was sold. | Optional | YYYY-MM-DD |
| QuantityUserMin | User-defined minimum stocking quantity for a part. | Optional | |
| QuantityUserMax | User-defined maximum stocking quantity for a part to be held in inventory. | Optional | |
| PartSourceCode | Dealer-specified part grouping indicates the dealer's source code assignment for a part. | Optional | |
| StockingStatus | Code indicating if this is a normally stocked part for this dealer. | Optional | |
| SystemSetupDate | Date the part was first added to the dealer's inventory file. | Optional | |
| QuantityBestStockingLevel | The optimal quantity of a part to keep on-hand based on dealer-specified parameters. | Optional | |
| AverageWeeklyUsage | The average weekly usage of a part as calculated by the dealer's DMS. | Optional | |
| Status | Defines the type of status message that has occurred for the individual Parts Inventory line item. This could contain information related to errors associated with invalid part numbers, etc. | Optional | (INACTIVE) Only to be used in:
AcknowledgePartsInventory
|
| 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) < ActionVerb (by extension) < AcknowledgableVerb (by extension) < Process (by extension) |
|---|---|
| Sub-types: | None |
| Name | Process |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| Criteria | Optional |
| Super-types: | BusinessObjectDocument < ProcessPartsInventory (by extension) |
|---|---|
| Sub-types: | None |
| Name | ProcessPartsInventory |
|---|---|
| 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 | ProcessPartsInventoryDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Process | The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowlegdes with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfil the agreement, unless of course other BODs are allowed to cancel or change the original order. | Required | |
| PartsInventory | Required |
| Super-types: | xsd:decimal < Quantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | Quantity |
|---|---|
| Abstract | no |
| Documentation | A decimal value with uom More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| uom | Required |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityAvailable (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityAvailable |
|---|---|
| Abstract | no |
| Documentation | The quantity the dealer has available for release from inventory. It is traditionally defined as Quantity On Hand minus reserved or encumbered parts. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityBestStockingLevel (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityBestStockingLevel |
|---|---|
| Abstract | no |
| Documentation | The optimal quantity of a part to keep on-hand based on dealer specified parameters. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityDealerPartStocking (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityDealerPartStocking |
|---|---|
| Abstract | no |
| Documentation | Dealer defined quantity that is to be stocked above the manufacturer recommended stocking level of the part. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityOfLostSale (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityOfLostSale |
|---|---|
| Abstract | no |
| Documentation | Potential quantity of sales lost due to non-inventory since last inventory. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityOfReturn (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityOfReturn |
|---|---|
| Abstract | no |
| Documentation | Quantity of part returned since last inventory. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityOnHand (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityOnHand |
|---|---|
| Abstract | no |
| Documentation | The quantity of part currently in inventory. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityOnOrder (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityOnOrder |
|---|---|
| Abstract | no |
| Documentation | Quantity of all outstanding orders not received into inventory. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityReOrderPoint (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityReOrderPoint |
|---|---|
| Abstract | no |
| Documentation | Quantity that triggers dealer's reordering of part. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityReserved (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityReserved |
|---|---|
| Abstract | no |
| Documentation | Quantity of part reserved for service. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantitySold (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantitySold |
|---|---|
| Abstract | no |
| Documentation | Quantity of part sold since last inventory. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityTwelveMonthLostSales (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityTwelveMonthLostSales |
|---|---|
| Abstract | no |
| Documentation | Quantity of lost sales over last 12 months (rolling). More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityTwelveMonthSales (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityTwelveMonthSales |
|---|---|
| Abstract | no |
| Documentation | Quantity sold over last 12 months (rolling). More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityUserMax (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityUserMax |
|---|---|
| Abstract | no |
| Documentation | User-defined maximum stocking quantity for a part to be held in inventory. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < QuantityUserMin (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityUserMin |
|---|---|
| Abstract | no |
| Documentation | User-defined minimum stocking quantity for a part. More information at: http://www.starstandard.org. |
| 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 |
Please note that although the schema shows this as
an Optional field, in this BOD usage it should be
Required.
|
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | Signature |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| qualifyingAgency | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:decimal < Amount (by extension) < UnitPrice (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitPrice |
|---|---|
| Abstract | no |
| Documentation | UnitPrice More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:NMTOKEN < AcknowledgementType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AcknowledgementType |
|---|
| Code Value | Description |
|---|---|
| Always | |
| OnChange | |
| Never |
| Super-types: | xsd:string < Action (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Action |
|---|
| Code Value | Description |
|---|---|
| Add | |
| Delete | |
| Change | |
| Replace | |
| A | |
| D | |
| C | |
| R |
| Super-types: | xsd:string < LocationDescription (by restriction) < BinLocation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BinLocation |
|---|---|
| Documentation | Dealer specific location of part. More information at: http://www.starstandard.org. |
| 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: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:string < Currency (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Currency |
|---|---|
| Documentation | The ISO code identifying the type of currency in use. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| USD | |
| ADP | |
| AED | |
| AFA | |
| ALL | |
| ANG | |
| AOK | |
| ARA | |
| ATS | |
| AUD | |
| AWG | |
| BBD | |
| BDT | |
| BEF | |
| BGL | |
| BHD | |
| BIF | |
| BMD | |
| BND | |
| BOB | |
| BRC | |
| BSD | |
| BTN | |
| BUK | |
| BWP | |
| BZD | |
| CAD | |
| CHF | |
| CLF | |
| CLP | |
| CNY | |
| COP | |
| CRC | |
| CSK | |
| CUP | |
| CVE | |
| CYP | |
| DDM | |
| DEM | |
| DJF | |
| DKK | |
| DOP | |
| DZD | |
| ECS | |
| EGP | |
| ESP | |
| ETB | |
| EUR | |
| FIM | |
| FKP | |
| FRF | |
| GBP | |
| GHC | |
| GIP | |
| GMD | |
| GNF | |
| GRD | |
| GTQ | |
| GWP | |
| GYD | |
| HKD | |
| HNL | |
| HTG | |
| HUF | |
| IDR | |
| IEP | |
| ILS | |
| INR | |
| IQD | |
| IRR | |
| ISK | |
| ITL | |
| JMD | |
| JOD | |
| JPY | |
| KES | |
| KHR | |
| KMF | |
| KPW | |
| KRW | |
| KWD | |
| KYD | |
| LAK | |
| LBP | |
| LKR | |
| LRD | |
| LSL | |
| LUF | |
| LYD | |
| MAD | |
| MGF | |
| MNT | |
| MOP | |
| MRO | |
| MTL | |
| MUR | |
| MVR | |
| MWK | |
| MXN | |
| MYR | |
| MZM | |
| NGN | |
| NIC | |
| NLG | |
| NOK | |
| NPR | |
| NZD | |
| OMR | |
| PAB | |
| PEI | |
| PGK | |
| PHP | |
| PKR | |
| PLZ | |
| PTE | |
| PYG | |
| QAR | |
| ROL | |
| RWF | |
| SAR | |
| SBD | |
| SCR | |
| SDP | |
| SEK | |
| SGD | |
| SHP | |
| SLL | |
| SKK | |
| SOS | |
| SRG | |
| STD | |
| SUR | |
| SVC | |
| SYP | |
| SZL | |
| THB | |
| TND | |
| TOP | |
| TPE | |
| TRL | |
| TTD | |
| TWD | |
| TZS | |
| UGS | |
| UYP | |
| VEB | |
| VND | |
| VUV | |
| WST | |
| YDD | |
| YER | |
| YUD | |
| ZAR | |
| ZRZ | |
| ZWD | |
| Other |
| 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:string < Expression (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Expression |
|---|
| Super-types: | xsd:string < ExpressionLanguage (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExpressionLanguage |
|---|
| Super-types: | xsd:string < ReferenceNumber (by restriction) < FileSequenceNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FileSequenceNumber |
|---|---|
| Documentation | Sequence for sent files. The first file is 1. 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 < InventoryType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InventoryType |
|---|---|
| Documentation | Identifies the type of inventory being transmitted, either full or incremental. Full inventory is an extract of the entire parts inventory. Incremental is the change in inventory since the last reported inventory (identifed by BOD Id). More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Full | Full inventory transmission |
| Incremental | Incremental inventory transmission |
| 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:date < Date (by restriction) < LastSoldDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LastSoldDate |
|---|---|
| Documentation | Last date this item was sold. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < LocationDescription (by restriction) |
|---|---|
| Sub-types: |
|
| Name | LocationDescription |
|---|---|
| Documentation | Location Description More information at: http://www.starstandard.org. |
| 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 < Code (by restriction) < PartClass (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartClass |
|---|---|
| Documentation | Gifts, literature, keys, regular parts Inventory Class code (if any) used in DMS system. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < PartSourceCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartSourceCode |
|---|---|
| Documentation | Indicates the source of the part (e.g. M - Manufacturer) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < PartType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartType |
|---|---|
| Documentation | Specifies whether the parts are indicated by manufacturer part code or Part Number - H = Manufacturer Part Code, P = Part Number More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| H | Manufacturer Part Code |
| P | "P" = Pending |
| 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 < Code (by restriction) < ReplenishmentCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ReplenishmentCode |
|---|---|
| Documentation | Alphanumeric code that signals manufacturer application if replenishment for the part is controlled by manufacturer (value 2) or by DMS (value 3). 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 < StatusCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusCode |
|---|---|
| Documentation | A code identifying the reason for the status message. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Success | The 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. |
| Unspecified | An unspecified error occurred. The StatusText field contains the complete text. |
| Not In Inventory | Inventory is not currently available and back ordering was not requested. |
| Discontinued | The part has discontinued. |
| Invalid Part | Invalid part number. |
| Not Yet Available | The part is scheduled for a future release date and is not available at this time. |
| Not Authorized | The part is not authorized for your product line. |
| Under Development | The part is under development and not ready for sale. |
| Assembly Only | The part is a component part and is only available as an assembly. |
| Component Only | The part is an assembly part and is only available as a component. |
| Internal Use Only | The part is reserved for manufacturing and supplier internal use; it is not a service replacement part. |
| Recalled | The part has been recalled. |
| Cannot Sell | The part is not available for sale for an unspecified reason. |
| Export Only | The part is not available for sale in the United States; it is for export vehicles only. |
| Credit Limit Exceeded | Credit limit exceeded. |
| Credit Card Denied | Credit card transaction denied by creditor. |
| Account On Hold | The dealer's account has been put on hold. |
| Invalid Unit Of Measure | The unit of measurement was invalid for this part number. |
| Invalid Promotion Code | The promotion code is invalid. |
| Invalid Shipping Method | The shipping method is invalid, for example, shipping by ground to Puerto Rico. |
| Duplicate Line Number | The line number is the same as another line within this transaction. |
| No Drop Shipment | Drop shipments are not allowed. |
| No Will Call | Will-call pickups are not allowed. |
| Minimum Quantity Not Met | There is a minimum quantity purchase requirement for this part and the quantity has not been met. The minimum quantity is: NN |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Text (by restriction) < StatusText (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusText |
|---|---|
| Documentation | Descriptive status text. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < StatusType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusType |
|---|---|
| Documentation | Defines the type of status that occurred. EX: S-Success, E-Error, I-Info, A-Abort More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Success | The 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. |
| Error | The operation resulted in error and did not succeed. |
| Warning | The operation completed a warning. |
| Informational | The provided StatusText is informational. |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Code (by restriction) < StockingStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StockingStatus |
|---|---|
| Documentation | Code indicating if this is a normally stocked part for this dealer. More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < SystemSetupDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SystemSetupDate |
|---|---|
| Documentation | Date the part was first added to the dealer's inventory file. 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 < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < UOM (by restriction) |
|---|---|
| Sub-types: | None |
| Name | UOM |
|---|---|
| Documentation | Units of Measure - ea=Each; bx=Box; case=Case; ctn=Carton; gal=Gallon; qt=Quart; pt=Pint; ft=Feet; yd=Yard; in=Inch; L=Liter; m=Meter; cm=Centimeter; kg=Kilograms; g=grams; other=Other More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| ea | Each |
| bx | Box |
| case | Case |
| ctn | Carton |
| gal | Gallon |
| qt | Quart |
| pt | Pint |
| ft | ft = feet |
| yd | yd = yard |
| in | in = inch |
| L | "L" = Canceled |
| m | m = meter |
| cm | cm = centimeter |
| kg | Kilogram |
| g | Gram |
| other | |
| tn | Ton |
| km | kilometers |
| mi | miles |
| hp | horsepower |
| kw | kilowatt |
| Super-types: | xsd:anyURI < URI (by restriction) |
|---|---|
| Sub-types: | None |
| Name | URI |
|---|---|
| Documentation | URI More information at: http://www.starstandard.org. |
|
IDENT |
||||
|
Pos. |
Data Element Name |
Data Element Description |
DE Number |
Mapping To BOD |
|
1 |
Creator Name Code |
DCS software creator code |
100242 |
Application Area / Sender –CreatorNameCode |
|
2 |
Creator Software Code |
DCS software code name |
100244 |
Application Area / Sender – Component |
|
3 |
Interface Version |
Software release version |
100220 |
N/A |
|
4 |
Transaction Create Date |
Date the transaction was created |
100430 |
Application Area – CreationDateTime |
|
5 |
Transaction Create Time |
Time the transaction was created |
100440 |
Application Area – CreationDateTime |
|
6 |
Dealer Number |
Dealer code number |
100210 |
Application Area / Sender & Destination – DealerNumber |
|
7 |
Store Number |
Dealer code store number (DMS assigned) |
100240 |
Application Area / Sender & Destination – StoreNumber |
|
8 |
Area Number |
Dealer code area number (DMS vendor assigned) |
100200 |
Application Area / Sender & Destination – AreaNumber |
|
9 |
Destination Name Code |
Code for destination of file - Short Manufacturer or Short DSP code |
106190 |
Application Area / Destination – DestinationNameCode |
|
10 |
Destination Software |
For which software destination file is intended (May not be known) |
106200 |
Application Area / Destination – DestinationSoftware |
|
11 |
Transaction Type Code |
Transaction type code indicates action to be taken for all records in this transaction set (Will not be in the BODs. Will be handled by OAGI verb) |
106210 |
Not Needed in BOD - Transaction type is specified by OAGI XML verb |
|
12 |
Dealer Country |
Dealer country location |
108430 |
Application Area / Sender – DealerCountry |
|
13 |
ReferenceId |
Enables the sending application to indicate the instance identifier of the event or task that caused the transaction to be created. This is used to correlate a response transaction to an originating transaction. |
112260 |
Application / Sender – ReferenceId |
|
14 |
SenderPartyId |
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. |
112261 |
Application / Sender – PartyId |
|
15 |
SenderLocationId |
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. |
112262 |
Application / Sender – LocationId |
|
16 |
SenderServiceId |
The Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. |
112263 |
Application / Sender – ServiceId |
|
17 |
DestinationPartyId |
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. |
112264 |
Application Area / Destination – PartyId |
|
18 |
DestinationLocationId |
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. |
112265 |
Application Area / Destination – LocationId |
|
19 |
DestinationServiceId |
The Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. |
112266 |
Application Area / Destination - ServiceId |
|
HEADER |
||||
|
Pos. |
Data Element Name |
Data Element Description |
DE Number |
Mapping To BOD |
|
1 |
Inventory Date |
Date of count (year, month & day) |
100570 |
Header – DocumentDateTime |
|
2 |
Inventory Part Type |
Specifies whether the parts are identified by manufacturer part code or Part Number |
100610 |
Header – PartType |
|
3 |
Inventory Type Code |
Code for type of inventory being reported. |
100615 |
Header - InventoryType |
|
4 |
File Sequence Number |
Sequence for sent files. The first file is 1. |
110650 |
Header – FileSequenceNumber |
|
LINE |
||||
|
Pos. |
Data Element Name |
Data Element Description |
DE Number |
Mapping To BOD |
|
1 |
Inventory Part Number |
Identification of part in inventory. |
100600 |
Line – ItemId |
|
2 |
On Hand Quantity |
Quantity of part currently in inventory. |
100630 |
Line – QuantityOnHand |
|
3 |
Sold Quantity |
Quantity of part sold since last inventory. |
100640 |
Line – QuantitySold |
|
4 |
Lost Sale Quantity |
Potential quantity of sales lost due to non-inventory since last inventory. |
100620 |
Line – QuantityOfLostSale |
|
5 |
Inventory Part Class |
Gifts, literature, keys, regular parts – Inventory Class code (if any) used in DMS system. |
100580 |
Line – PartClass |
|
6 |
Inventory Part Code |
INACTIVE – DO NOT USE – Format indicator for part |
100590 |
N/A |
|
7 |
On Order Part Quantity |
Quantity of all outstanding orders not received into inventory. |
107760 |
Line – QuantityOnOrder |
|
8 |
ReOrder Point |
Quantity that triggers dealer’s reordering of part |
106730 |
Line – QuantityReOrderPoint |
|
9 |
Twelve Month Sales |
Quantity sold over last 12 months (rolling) |
106735 |
Line - QuantityTwelveMonthSales |
|
10 |
Order Bin Location |
Dealer specific location of part. |
101250 |
Line – BinLocation |
|
11 |
Twelve Month Lost Sales |
Quantity of lost sales over last 12 months (rolling). |
106740 |
Line - QuantityTwelveMonthLostSales |
|
12 |
Back Order Quantity |
Quantity of part on back order. |
100752 |
Line - BackOrderQuantity |
|
13 |
Returns Quantity |
Quantity of part returned since last inventory |
107260 |
Line – QuantityOfReturn |
|
14 |
Reserved Quantity |
Quantity of parts reserved for service. |
107270 |
Line – QuantityReserved |
|
15 |
Part Unit Retail Price |
Part unit retail price (cost + markup) |
104870 |
Line – UnitPrice |
|
16 |
Part Stocking Dealer Quantity |
Dealer defined quantity that is to be stocked above the manufacturer recommended stocking level of the part. |
109320 |
Line – QuantityDealerPartStocking |
|
17 |
Months No Sale |
The number of months that a part has gone without a recorded sale – calculated on a calendar month basis. |
110630 |
Line – MonthsNoSale |
|
18 |
Quantity Available |
The quantity the dealer has available to release from inventory. It is traditionally defined as Quantity On Hand minus reserved or encumbered parts. |
110640 |
Line – QuantityAvailable |
|
19 |
Replenishment Code |
Alphanumeric code that signals manufacturer application if replenishment for the part is controlled by manufacturer (value 2) or by DMS (value 3). |
110660 |
Line – ReplenishmentCode |
|
20 |
Last Sold Date |
Last date this item was sold. |
110690 |
Line – LastSoldDate |
|
21 |
MinUserQty |
User-defined minimum stocking quantity for a part. |
112240 |
Line – QuantityUserMin |
|
22 |
MaxUserFullBinQty |
User-defined maximum stocking quantity for a part to be held in inventory. |
112250 |
Line – QuantityUserMax |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: