Implementation Guideline
Get Repair Order
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Get Repair Order
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 Get Repair Order Business Object Document (BOD). Get Repair Order has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Get Repair Order 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 Get Repair Order, this BOD could be used to send Get Repair Order information between any two business parties.
The Get Repair Order Implementation Guidelines provide detailed information regarding the structure and meaning of the Get Repair Order BOD and corresponds directly to the Get Repair Order 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 Get Repair Order Implementation Guidelines must be used in concert with the Get Repair Order 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 Get Repair Order 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 Get Repair Order BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Get Repair Order 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 Get Repair Order 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 Repair Order Binary Collaboration starts with the sending of Vehicle Service information from the Dealer to the OEM. This process occurs on demand as is needed. Note: This scenario is an example of how the Financial Statement BOD can be used. Implementations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Get Repair Order 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 | Detail |
|---|---|
| Type | VehicleServiceHistoryRetrievalDetail |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Get |
|---|---|
| Type | Get |
| Nillable | no |
| Abstract | no |
| Documentation | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. More information at: http://www.openapplications.org/oagis. |
| Name | GetRepairOrderRetrieval |
|---|---|
| Type | GetRepairOrderRetrieval |
| Nillable | no |
| Abstract | no |
| Name | Header |
|---|---|
| Type | VehicleServiceHistoryRetrievalHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | VehicleServiceHistoryRetrieval |
|---|---|
| Type | VehicleServiceHistoryRetrieval |
| 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 |
Optional. "qualifyingAgency" attribute.
|
| 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: | 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: | 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: | None |
| Name | ExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SelectExpression | Allows the 1-n number of selection expressions for the information to be returned. | Required |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) < Get (by extension) |
|---|---|
| Sub-types: | None |
| Name | Get |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| show | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | BusinessObjectDocument < GetRepairOrderRetrieval (by extension) |
|---|---|
| Sub-types: | None |
| Name | GetRepairOrderRetrieval |
|---|---|
| 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 | GetRepairOrderRetrievalDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Get | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. | Required | |
| VehicleServiceHistoryRetrieval | Required |
| 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 | (INACTIVE)
DocumentDateTime is the same as the BOD
CreationDateTime (i.e., the date and time the RO
data was extracted).
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets. EX:
2003-11-05T13:15:30Z
|
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | (INACTIVE) |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | (INACTIVE) |
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | IndividualOwnerRetrieval |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PersonName | name | Optional | |
| Address | state | Optional |
| 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 | OrganizationalOwnerRetrieval |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Name | Company name of organizational | Optional | |
| Address | state | Optional |
| 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) < RequestVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | RequestVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RetrievalAddress |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| StateOrProvince | Is the State or Province. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RetrievalPersonName |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| FamilyName | Last Name of business party | 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 |
1 - Receive Pending Mail. 0 - Do not receive pending
mail.
|
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | VehicleRetrieval |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| VIN | Federally defined 17 position vehicle identification number | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VehicleServiceHistoryRetrieval |
|---|---|
| Abstract | no |
| Documentation | STAR Version 4.0 - Draft More information at: http://www.starstandards.org. STAR Version 3.0, 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 7/31/2002; OAGI approved 8/16/2002; effective date 1/01/2003 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required | ||
| Detail | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VehicleServiceHistoryRetrievalDetail |
|---|---|
| Abstract | no |
| Documentation | Dates for history retrieval More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| RepairOrderCompletedDate | The date the last line was closed on the repair order | Optional | |
| DocumentId | The Repair Order Number to retrieve | Optional |
| Super-types: | HeaderBase < VehicleServiceHistoryRetrievalHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleServiceHistoryRetrievalHeader |
|---|---|
| Abstract | no |
| 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 | (INACTIVE)
DocumentDateTime is the same as the BOD
CreationDateTime (i.e., the date and time the RO
data was extracted).
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets. EX:
2003-11-05T13:15:30Z
|
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | (INACTIVE) |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | (INACTIVE) |
| IndividualOwner | Owner name and State | Optional | |
| OrganizationalOwner | Organization name and state | Optional | |
| Vehicle | VIN | 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 < Name (by restriction) < CompanyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CompanyName |
|---|---|
| Documentation | Company name of customer 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: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 < Name (by restriction) < FamilyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FamilyName |
|---|---|
| Documentation | Last Name of business party 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 < Name (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Name |
|---|---|
| Documentation | Name of the Party. 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 < 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:date < Date (by restriction) < RepairOrderCompletedDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RepairOrderCompletedDate |
|---|---|
| Documentation | The date the last line was closed on the repair order 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 < StateOrProvince (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StateOrProvince |
|---|---|
| Documentation | Is the State or Province of a given Address. 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:anyURI < URI (by restriction) |
|---|---|
| Sub-types: | None |
| Name | URI |
|---|---|
| Documentation | URI More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < VIN (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VIN |
|---|---|
| Documentation | Federally defined 17 position vehicle identification number More information at: http://www.starstandard.org. |
|
Identification Record |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
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 |
Application Area - Sender/SystemVersion |
|
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 or Destination/DealerNumber |
|
7 |
Store Number |
Dealer code store number (DMS assigned) |
100240 |
Application Area - Sender or Destination/StoreNumber |
|
8 |
Area Number |
Dealer code area number (DMS vendor assigned) |
100200 |
Application Area - Sender or 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/DealerContry |
|
13 |
Reference ID |
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 origination transaction |
112260 |
Application Area - 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 Area - 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. |
11262 |
Application Area - Sender/LocationId |
|
16 |
SenderServiceId |
The Service Id field identifies the particular service to which a message is being sent from, e.g., an inventory service. |
11263 |
Application Area - 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. |
11264 |
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. |
11265 |
Application Area - Destination/LocationId |
|
19 |
DestinationServiceId |
The Service Id field identifies the particular service to which a message is being sent to, e.g., an inventory service. |
11266 |
Application Area - Destination/ServiceId |
|
Header Record |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Repair Order Number |
Identification number of repair order assigned by dealer or DMS |
105150 |
Header/DocumentId |
|
2 |
Repair Order Opened Date |
System date when Repair Order was opened |
105130 |
Header/ RepairOrderOpenedDate |
|
3 |
Repair Order Completed Date |
The date the last line was closed on the repair order |
105120 |
Header/ RepairOrderCompletedDate |
|
4 |
Repair Order Invoice Date |
The date the repair order transaction moves to accounting |
105140 |
Header /RepairOrder InvoiceDate |
|
5 |
Repair Order Comment |
Free form text for general repair order comment, which will be printed on the invoice - This comment could be used for any general comments that the dealer would like to have rcorded for the overall repair order |
105110 |
Header/OrderNotes |
|
6 |
Repair Order Customer Pay Total Price |
Total Price of all Customer Pay parts, labor and sublet charged to this Repair Order |
105160 |
Header - Price(Customer) /TotalAmount |
|
7 |
Service Advisor Emp ID Code |
Employee Identification number of service advisor assigned to Repair Order |
105180 |
Header - Service Advisor/ PartyId |
|
8 |
Service Advisor Name |
Name of service advisor assigned to RO |
105170 |
Header - Service Advisor/ ServiceAdvisorName |
|
9 |
Service Advisor SSN |
Social security number of service advisor assigned to Repair Order |
105190 |
Header - Service Advisor - AlternatePartyIds/Id & AssigningPartyId = "NationalId" |
|
10 |
Labor Rate |
Dealer Posted Hourly Retail Labor Rate |
105090 |
Header/ LaborRate |
|
11 |
Department Type |
Identifies the internal department |
105050 |
Header/ DepartmentType |
|
13 |
Repair Order Internal Remarks |
Free form text for internal repair order remarks that will NOT be printed on the invoice - These remarks could be used for any general comments that the dealer would like to have recorded for the overall arepair order, but not viewed by customer |
106860 |
Header/ OrderInternalNotes (Inactive) |
|
14 |
Repair Order Warranty Total Price |
Total Price of all Warranty parts, labor and sublet charged to this Repair Order |
106870 |
Header - Price(Claim) /TotalAmount |
|
15 |
Repair Order Internal Total Price |
Total Price of all Internal Pay parts, labor and sublet charged to this Repair Order |
106880 |
Header- Price(Internal) /TotalAmount |
|
16 |
Data Collection Status |
Indicates status of data for the record it appears on |
107210 |
Header/DataCollectionStatus |
|
17 |
ESC Franchise Flag |
Extended Service Competitive (ESC) flag indicates if dealer has franchise for Extended Service Program (ESP) repair for competi |
110130 |
Header/ ESCFranchiseInd (Inactive) |
|
18 |
Currency Code |
Currency used for transaction |
107940 |
Currency code is an attribute of each field that is defined as an Amount |
|
19 |
Tread Act Ind |
Indicates if there has been fire damage |
110900 |
Header/ TreadActInd |
|
20 |
Location ID |
Code identifying the physical location of a dealer. |
110910 |
Header/ LocationId |
|
Vehicle |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Repair Order VIN |
Manufacturer Vehicle identification number associated with repair order |
105525 |
Vehicle/VIN |
|
2 |
DMS Make Code |
DMS make code is usually available in the VIN number (use NCIC code) or already on manufacturer host. If available in DMS or e |
105450 |
Vehicle/Make |
|
3 |
Model Year |
Vehicle designated model year is usually available in the VIN number (use NCIC code) or already on manufacturer host - If avail |
105520 |
Vehicle/ModelYear |
|
4 |
Vehicle Model |
Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) or already on manufacturer ho |
105540 |
Vehicle/Model |
|
5 |
Warranty Start Date |
Start date of vehicle warranty - Usually available on the manufacturer host or from prior DMS service history |
105570 |
Warranty/ WarrantyStartDate |
|
6 |
Warranty Start Mileage |
Mileage at start date of vehicle warranty - Usually available on the manufacturer host or from prior DMS service history |
105580 |
Warranty/ WarrantyStartMileage |
|
7 |
Warranty Expiration Date |
Last date of vehicle warranty coverage for warranty currently in force at time of repair -Date is usually available on the manu |
105550 |
Warranty/ WarrantyExpirationDate (Inactive) |
|
8 |
Warranty Expiration Mileage |
Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair - Usually available on the manufa |
105560 |
Warranty/ WarrantyExpirationMileage (Inactive) |
|
9 |
License Number |
State license plate number of vehicle |
105490 |
Vehicle/LicenseNumber (Inactive) |
|
10 |
Delivery Date |
The date of original retail vehicle sale. May be after warranty start date if demo. |
105430 |
Vehicle/ DeliveryDate |
|
11 |
Mileage In |
Odometer reading of vehicle when repair order was opened |
105500 |
Header/ Mileage In |
|
12 |
Mileage Out |
Odometer reading of vehicle when repair order was closed |
105510 |
Header/ Mileage Out |
|
13 |
Vehicle Demo Flag |
Indicates whether vehicle was ever a demo |
105440 |
Vehicle/ VehicleDemoInd |
|
14 |
Non US Vehicle Flag |
A flag that indicates whether the vehicle was produced for the United States or not |
105530 |
Vehicle/ NonUSVehicleInd |
|
15 |
Engine Number |
Serial number of the engine if vehicle not made for US sale |
105480 |
Vehicle/ EngineNumber |
|
16 |
Engine Light Flag |
Check engine light indicator |
105470 |
Job - Diagnostics/ EngineLightInd |
|
17 |
PCM Failure Code |
Powertrain Control Module failure code |
105460 |
Job - Diagnostics/ PCMFailureCode |
|
19 |
Insurance Company Name |
Memo field for Carrier covering extended service contract, not necessarily for this Repair Order |
106450 |
Header - Service Contract/ InsuranceCompanyName (Inactive) |
|
20 |
Mileage Type |
Mileage measurement type |
103560 |
Vehicle/MilageIn(uom) & MileageOut(uom) |
|
Customer |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Service Customer Salutation |
Customer title greeting of vehicle owner (if vehicle owned by an individual) - Not used for Company owned. Ex - Mr., Ms., etc. |
103870 |
IndividualOwner - PersonName/Salutation |
|
2 |
Service Customer Name |
Intended to be the driver/person who brought vehicle in for service, if other than the owner - This data may appear in RO comme |
103840 |
IndividualOwner - PersonName/FormattedName |
|
3 |
Company Name |
Company name, if owner of the vehicle. If an individual owns vehicle, this data element would not be used for repair order or |
103720 |
OrganizationalOwner/Name |
|
4 |
Service Customer Sort Name |
Index name used as a sort for report purposes |
103880 |
IndividualOwner - PersonName/SortName (Inactive) |
|
5 |
Service Customer Last Name |
Last name of vehicle owner, if vehicle owned by an individual - Not used for Company owned |
103820 |
IndividualOwner - PersonName/FamilyName |
|
6 |
Service Customer First Name |
First name of vehicle owner, if vehicle owned by an individual - Not used for Company owned |
103790 |
IndividualOwner - PersonName/GivenName |
|
7 |
Service Customer Middle Initial or Name |
Middle Initial or Name of vehicle owner, if vehicle owned by an individual - Not used for Company owned |
103830 |
IndividualOwner - PersonName/MiddleName |
|
8 |
Service Customer Name Suffix |
Customer name suffix designation (if vehicle owned by an individual) - Not used for Company owned. Ex. Sr, Jr, III, etc. |
103850 |
IndividualOwner - PersonName/Suffix |
|
9 |
Service Customer SSN |
Social security number of vehicle owner, if owned by an individual |
103890 |
IndividualOwner/AlternatePartyIds/Id & AssigningPartyId = "NationalId" |
|
10 |
Service Customer Address1 |
Vehicle owner address information |
103730 |
IndividualOwner - Address/AddressLine |
|
11 |
Service Customer Address2 |
Vehicle owner supplemental address information |
103740 |
IndividualOwner - Address/AddressLine |
|
12 |
Service Customer City |
Vehicle Owner's city of residence |
103750 |
IndividualOwner - Address/City |
|
13 |
Service Customer State Code |
Vehicle Owner's state or province of residence |
103900 |
IndividualOwner - Address/StateOrProvince |
|
14 |
Service Customer Zip Code |
Vehicle Owner's zip or postal code |
103920 |
IndividualOwner - Address/PostalCode |
|
15 |
Service Customer Country |
Vehicle Owner's country of residence |
103760 |
IndividualOwner - Address/Country |
|
16 |
Service Customer Language |
Vehicle Owner's native language |
103810 |
IndividualOwner - Contact - Demographics/Language |
|
17 |
Service Customer Evening Phone |
Vehicle Owner's evening phone number |
103800 |
IndividualOwner - Contact/Telephone(Evening Phone) |
|
18 |
Service Customer Day Phone |
Company Telephone number or Vehicle Owner's day phone number |
103910 |
IndividualOwner - Contact/Telephone(Day Phone) |
|
19 |
Day Phone Extension |
Company telephone number extension or Individual's day telephone number extension |
107480 |
IndividualOwner - Contact/Telephone - "exten" attribute |
|
20 |
Service Customer Email |
Vehicle Owner's email address |
103770 |
IndividualOwner - Contact/Email(Home) |
|
21 |
Customer Cell Phone |
Customer cell phone number |
107490 |
IndividualOwner - Contact/Telephone(Cell Phone) |
|
22 |
Customer Mail Flag |
Flag to note customers whom have requested no marketing mail |
107500 |
IndividualOwner/MarketingMailInd |
|
23 |
Primary Driver Flag |
Identifies customer as primary driver |
102150 |
IndividualOwner/ PrimaryDriverInd (Inactive) |
|
24 |
Customer Change Flag |
Indicates whether customer information has changed |
106940 |
IndividualOwner/ CustomerChangeInd (Inactive) |
|
25 |
Customer Pager Number |
Vehicle Owner's contact pager number |
106950 |
IndividualOwner - Contact/Telephone(Pager) |
|
26 |
Service Customer Fax Number |
Vehicle Owner's contact fax number |
103780 |
IndividualOwner - Contact/Fax(Home) |
|
27 |
Customer Preferred Contact Method |
Customer's preferred method of contact |
106970 |
IndividualOwner - Contact/ PreferredContactMethod |
|
28 |
Data Collection Status |
Indicates status of data for the record it appears on |
107210 |
IndividualOwner/ DataCollectionStatus (Inactive) |
|
29 |
Customer ID |
Manufacturer specific customer identifier - Assigned by the manufacturer for each customer |
106930 |
IndividualOwner (Deleted from the schema - replaced by DMS Customer Number) |
|
30 |
Customer Gender |
Gender of customer |
107520 |
IndividualOwner - Contact - Demographics/Gender |
|
31 |
Customer Birthdate |
Birthdate of customer |
107530 |
IndividualOwner - Contact - Demographics/BirthDate |
|
32 |
DMS Customer ID |
The system assigned number associated with a customer entity |
112150 |
IndividualOwner/PartyId |
|
Rental/Loaner |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Rental Loaner Code |
Identifies rental/loaner vehicle |
104930 |
RentLoaner/RentLoanerCode |
|
2 |
Rental Loaner Out |
Date rental/loaner vehicle provided to customer |
104970 |
RentLoaner/RentOutDate |
|
3 |
Rental Loaner In |
Date rental/loaner vehicle turned in by customer |
104940 |
RentLoaner/RentInDate |
|
4 |
Rental Loaner Number Of Days |
Number of days rental/loaner was out - Can be calculated from in and out date |
104960 |
RentLoaner/RentDaysQuantity |
|
5 |
Rental Loaner Vehicle Model |
Model description of rental/loaner vehicle |
104980 |
RentLoaner/Model |
|
6 |
Rental Loaner Invoice Number |
Rental/loaner accounting identifier - the Rental Loaner Invoice # from either the DMS or rental company |
104950 |
RentLoaner/ RentLoanerInvoiceNumber |
|
7 |
Rental Loaner Price |
Total Price paid for rental/loaner Including tax |
104920 |
RentLoaner - Price(RentLoaner)/TotalAmount |
|
8 |
Rent Loaner Comments |
Rent Loaner Comments |
106720 |
RentLoaner/RentNotes |
|
9 |
Rental Loaner Hours |
Number of hours the rental loaner was used by the customer. |
109300 |
RentLoaner/RentLoanerHours |
|
10 |
Rental Loaner VIN |
Rental Loaner Vehicle Identification Number |
109310 |
RentLoaner/VIN |
|
Accessory |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Original Serial Number |
The serial number of the part that is being replaced |
103690 |
ReplacementSerialNumber/ OriginalSerialNumber |
|
2 |
Replacement Serial Number |
The serial number of the part that is used to replace another part |
103710 |
ReplacementSerialNumber/ ReplacementSerialNumber |
|
3 |
Replacement Part |
The Part Number or Manufacturer Code of the part used to replace another part |
103700 |
ReplacementSerialNumber/ItemId |
|
4 |
Part Type |
Specifies whether the parts are indicated by manufacturer part code or Part Number |
105100 |
ReplacementSerialNumber/PartType |
|
Sublet |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Sublet Parts Labor Tax Desc |
Freeform text description of sublet tax amount |
105360 |
Sublet - Tax(Amount) /TaxDescription |
|
2 |
Sublet Parts Labor Tax Price |
Sublet tax price on associated parts and labor |
105350 |
Sublet - Tax(Amount) /TaxAmount. |
|
3 |
Sublet Handling |
Sublet handling charges |
105330 |
Sublet |
|
4 |
Sublet Invoice Price |
Sublet invoice price |
105325 |
Sublet - Price(Sublet) /TotalAmount |
|
5 |
Sublet Authorization Number |
Third party purchase order number for work |
105310 |
Sublet/ AuthorizationNumber |
|
6 |
Sublet Code |
Type of sublet work |
105320 |
Sublet/SubletCode |
|
7 |
Sublet Work Description |
Free form text comments relating to sublet |
105370 |
Sublet/ SubletWorkDescription |
|
8 |
Sublet Invoice Number |
Third party invoice number for work |
105340 |
Sublet/ SubletInvoiceNumber |
|
9 |
Sublet Price After Split |
Sublet price charged to job after split (Null if no split) |
107070 |
Sublet - Splits(Sublet) - Price(Splits)/TotalAmount |
|
10 |
Sublet Split Percentage |
Sublet split percentage |
107080 |
Sublet - Splits(Sublet)/SplitPercent |
|
11 |
Appeal Action Code |
Defines action to be taken on appeal |
110180 |
Sublet/ AppealActionCode (Inactive) |
|
Miscellaneous |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Miscellaneous Code |
Miscellaneous code defined by manufacturer |
104610 |
ServiceComponent(Miscellaneous)/ServiceCode |
|
2 |
Miscellaneous Description |
Free form text description of miscellaneous Price |
104620 |
ServiceComponent(Miscellaneous)/ServiceDescription |
|
3 |
Miscellaneous Price |
Miscellaneous charged to job |
104600 |
ServiceComponent(Miscellaneous) - Price(Miscellaneous)/TotalAMount |
|
4 |
Miscellaneous Price After Split |
Miscellaneous charged to job after split (Null if no split) |
107090 |
ServiceComponent(Miscellaneous) - Splits(Miscellaneous) -Price(Splits)/TotalAmount |
|
5 |
Miscellaneous Split Percentage |
Miscellaneous split Percentage |
107100 |
ServiceComponent(Miscellaneous) - SplitsMiscellaneous)/SplitPercent |
|
6 |
Miscellaneous Expense Hours |
Time allotted for administrative work |
110140 |
ServiceComponent(Miscellaneous)/ ExpenseHours (Inactive) |
|
7 |
Appeal Action Code |
Defines action to be taken on appeal |
110180 |
ServiceComponent(Miscellaneous)/ AppealActionCode (Inactive) |
|
Gas, Oil, Grease |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
GOG Code |
Manufacturer assigned code for gas, oil and grease associated with job |
104030 |
ServiceComponent(GasOilGrease)/ServiceCode |
|
2 |
GOG Description |
Free form text description of gas, oil and grease associated with job |
104040 |
ServiceComponent(GasOilGrease)/ServiceDescription |
|
3 |
GOG Total Price |
Gas, oil and grease extended cost amount + markup |
104070 |
ServiceComponent(GasOilGrease) - Price(GasOilGrease)/TotalAmount |
|
4 |
GOG Total Cost |
Total Gas, oil and grease at unit cost times quantity (Before any split) |
104050 |
ServiceComponent(GasOilGrease) - Price(GasOilGrease)/TotalCost |
|
5 |
GOG Quantity |
Gas, oil and grease quantity used |
104090 |
ServiceComponent(GasOilGrease)/ItemQuantity |
|
6 |
GOG Unit Cost |
Gas, oil and grease unit cost at inventory value (Before any split) |
104110 |
ServiceComponent(GasOilGrease) - Price(GasOilGrease)/UnitCost |
|
7 |
GOG Unit Cost After Split |
Gas, oil and grease cost at inventory value after split (Null if no split) |
104120 |
ServiceComponent(GasOilGrease) - Splits(GasOilGrease) - Price(Splits)/UnitCost |
|
8 |
GOG Total Cost After Split |
Gas, oil and grease value at unit cost times quantity (Null if no split) |
104060 |
ServiceComponent(GasOilGrease) - Splits(GasOilGrease) - Price(Splits)/TotalCost |
|
9 |
GOG Total Price After Split |
Gas, oil and grease total price (cost + markup) after split. (Null if no split) |
104080 |
ServiceComponent(GasOilGrease) - Splits(GasOilGrease) - Price(Splits)/TotalPrice |
|
10 |
GOG Split Percentage |
Cost split percentage |
104100 |
ServiceComponent(GasOilGrease) - Splits(GasOilGrease)/SplitPercent |
|
11 |
GOG Unit Price |
GOG unit price (Cost + Markup) Will be null if split |
107110 |
ServiceComponent(GasOilGrease) - Price(GasOilGrease)/UnitPrice |
|
12 |
GOG Unit Price After Split |
GOG unit price (Cost + Markup) after split Will be null if no split |
107120 |
ServiceComponent(GasOilGrease) - Splits(GasOilGrease) - Price(Splits)/UnitPrice |
|
13 |
GOG Unit of Measure |
Unit of measure for GOG used |
107220 |
ServiceComponent(GasOilGrease)/ItemQuantity(uom) |
|
Paint, Materials |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
PM Code |
Manufacturer assigned code for paint and materials |
104630 |
ServiceComponent(PaintMaterials)/ServiceCode |
|
2 |
PM Description |
Free form text description of paint and materials associated with job |
104640 |
ServiceComponent(PaintMaterials)/ServiceDescription |
|
3 |
PM Total Price |
Paint and materials total price (cost + markup) Will be null if split |
104670 |
ServiceComponent(PaintMaterials) - Price(PaintMaterials)/TotalAmount |
|
4 |
PM Total Cost |
Paint and materials value at unit cost times quantity (Before any split) |
104650 |
ServiceComponent(PaintMaterials) - Price(PaintMaterials)/TotalCost |
|
5 |
PM Quantity |
Paint and materials quantity |
104690 |
ServiceComponent(PaintMaterials)/ItemQuantity |
|
6 |
PM Unit Cost |
Paint and materials unit cost at inventory value (Before any split) |
104710 |
ServiceComponent(PaintMaterials) - Price(PaintMaterials)/UnitCost |
|
7 |
PM Unit Cost After Split |
Paint and materials unit cost at inventory value after split (Null if no split) |
104720 |
ServiceComponent(PaintMaterials) - Splits(PaintMaterials) - Price(Splits)/UnitCost |
|
8 |
PM Total Cost After Split |
Paint and materials value at unit cost times quantity after split (Null if no split) |
104660 |
ServiceComponent(PaintMaterials) - Splits(PaintMaterials) - Price(Splits)/TotaCost |
|
9 |
PM Total Price After Split |
Paint and materials total price (cost + markup) after split (Null if no split) |
104680 |
ServiceComponent(PaintMaterials) - Splits(PaintMaterials) - Price(Splits)/TotalPrice |
|
10 |
PM Split Percentage |
Paint and Material Cost split percentage |
104700 |
ServiceComponent(PaintMaterials) - Splits(PaintMaterials)/SplitPercent |
|
11 |
PM Unit Price |
Paint and Material unit price (Cost + Markup) Will be null if split |
107130 |
ServiceComponent(PaintMaterials) - Price(PaintMaterials)/UnitPrice |
|
12 |
PM Unit Price After Split |
Paint and Material unit price (Cost + Markup) after split Will be null if no split |
107140 |
ServiceComponent(PaintMaterials) - Splits(PaintMaterials) - Price(Splits)/UnitPrice |
|
13 |
PM Unit of Measure |
Unit of measure for Paint and Material used |
107230 |
ServiceComponent(PaintMaterials)/ItemQuantity(uom) |
|
Shop Supplies |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
SS Code |
Manufacturer assigned code for shop supplies |
105210 |
ServiceComponent(ShopSupplies)/ServiceCode |
|
2 |
SS Description |
Free form text description of shop supplies associated with job |
105220 |
ServiceComponent(ShopSupplies)/ServiceDescription |
|
3 |
SS Total Price |
Shop supplies total price (cost + markup) Will be null if split |
105250 |
ServiceComponent(ShopSupplies) - Price(ShopSupplies)/TotalAmount |
|
4 |
SS Total Cost |
Total shop supplies value at unit cost times quantity (Before any split) |
105230 |
ServiceComponent(ShopSupplies) - Price(ShopSupplies)/TotalCost |
|
5 |
SS Quantity |
Shop supplies quantity used |
105270 |
ServiceComponent(ShopSupplies)/ItemQuantity |
|
6 |
SS Unit Cost |
Shop supplies unit cost at inventory value (Before any split) |
105290 |
ServiceComponent(ShopSupplies) - Price(ShopSupplies)/UnitCost |
|
7 |
SS Unit Cost After Split |
Shop supplies cost at inventory value after split (Null if no split) |
105300 |
ServiceComponent(ShopSupplies) - Splits(ShopSupplies) - Price(Splits)/UnitCost |
|
8 |
SS Total Cost After Split |
Shop supplies value at unit cost times quantity after split (Null if no split) |
105240 |
ServiceComponent(ShopSupplies) - Splits(ShopSupplies) - Price(Splits)/TotalCost |
|
9 |
SS Total Price After Split |
Shop supplies total price (cost + markup) after split (Null if no split) |
105260 |
ServiceComponent(ShopSupplies) - Splits(ShopSupplies) - Price(Splits)/TotalPrice |
|
10 |
SS Split Percentage |
Shop Supplies Cost split percentage |
105280 |
ServiceComponent(ShopSupplies) - Splits(ShopSupplies)/SplitPercent |
|
11 |
SS Unit Price |
Shop Supplies unit price (Cost + Markup) Will be null if split |
107150 |
ServiceComponent(ShopSupplies) - Price(ShopSupplies)/UnitPrice |
|
12 |
SS Unit Price After Split |
Shop Supplies unit price (Cost + Markup) after split Will be null if no split |
107160 |
ServiceComponent(ShopSupplies) - Splits(ShopSupplies) - Price(Splits)/UnitPrice |
|
13 |
SS Unit of Measure |
Unit of measure for Shop Supplies used |
107240 |
ServiceComponent(ShopSupplies)/ItemQuantity(uom) |
|
Freight |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Freight Code |
Manufacturer assigned code for Freight |
103930 |
ServiceComponent(Freight)/ServiceCode |
|
2 |
Freight Description |
Free form text description of Freight associated with claim |
103940 |
ServiceComponent(Freight)/ServiceDescription |
|
3 |
Freight Total Price |
Freight total price (cost + markup) Null if split |
103970 |
ServiceComponent(Freight) - Price(Freight)/TotalAmount |
|
4 |
Freight Total Cost |
Total freight cost at unit cost times quantity (Before any split) |
103950 |
ServiceComponent(Freight) - Price(Freight)/TotalCost |
|
5 |
Freight Quantity |
Freight quantity |
103990 |
ServiceComponent(Freight)/ItemQuantity |
|
6 |
Freight Unit Cost |
Freight unit cost at inventory value (Before any split) |
104010 |
ServiceComponent(Freight) - Price(Freight)/UnitCost |
|
7 |
Freight Unit Cost After Split |
Freight cost at inventory value after split (Null if no split) |
104020 |
ServiceComponent(Freight) - Splits(Freight) - Price(Splits)/UnitCost |
|
8 |
Freight Total Cost After Split |
Freight value at unit cost times quantity after split (Null if no split) |
103960 |
ServiceComponent(Freight) - Splits(Freight) - Price(Splits)/TotalCost |
|
9 |
Freight Total Price After Split |
Freight total price (cost + markup) after split (Null if no split) |
103980 |
ServiceComponent(Freight) - Splits(Freight) - Price(Splits)/TotalPrice |
|
10 |
Freight Split Percentage |
Freight split percentage |
104000 |
ServiceComponent(Freight) - Splits(Freight)/SplitPercent |
|
11 |
Freight Unit Price |
Freight unit price (Cost + Markup) Will be null if split |
107170 |
ServiceComponent(Freight) - Price(Freight)/UnitPrice |
|
12 |
Freight Unit Price After Split |
Freight unit price (Cost + Markup) after split Will be null if no split |
107180 |
ServiceComponent(Freight) - Splits(Freight) - Price(Splits)/UnitPrice |
|
13 |
Freight Document Number |
Free form entry for document associated with Freight (i.e., Shipper, BOL, Invoice, etc.) |
107300 |
ServiceComponent(Freight) - DocumentId |
|
14 |
Carrier Code |
Carrier code related to transportation of vehicle |
110150 |
ServiceComponent(Freight)/CarrierId |
|
Job |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
DMS Job Number |
DMS assigned job or line identification number |
104220 |
Job/JobNumber |
|
2 |
DMS Operation Code |
Dealer or DMS assigned operation code identifier |
104230 |
Job/OperationId |
|
3 |
DMS Operation Description |
Dealer or DMS assigned operation description |
104250 |
Job/OperationName |
|
4 |
Add On Repair Flag |
Added to repair order after customer came in for appointment |
104135 |
Job/AddOnRepairInd |
|
6 |
Job Total Tax |
Portion of sales tax per job for sale type being reported |
104300 |
Job - Tax(Total)/TaxAmount |
|
7 |
Job Labor Rate |
The actual labor rate for this job only, typically the posted rate |
104290 |
Job/ JobLaborRate |
|
8 |
Job Total Price |
Line total for sale type portion of job |
104400 |
Job - Price(Job)/TotalAmount |
|
11 |
Labor Flat Hours |
Manufacturer approved billable flat rate hours |
104310 |
Job/LaborAllowanceHours |
|
12 |
Actual Hours |
Actual hours required to complete job |
104130 |
Job/LaborActualHours |
|
13 |
Job Labor Price |
Labor total for sale type portion of job |
104150 |
Job - Price(Labor)/TotalAmount |
|
14 |
Job Parts Price |
Parts total for sale type portion of job |
104160 |
Job - Price(Parts)/TotalAmount |
|
15 |
Job Sublet Price |
Sublet total for sale type portion of job |
104190 |
Job - Price(Sublet)/TotalAmount |
|
17 |
Legal Case Number |
Identification number assigned to court case |
104320 |
Job - CASE(Legal)/CaseNumber (inactive) |
|
18 |
Technical Analysis Case Number |
Identification number assigned to technical analysis case |
104360 |
Job - CASE(Technical Analysis)/CaseNumber (Inactive) |
|
19 |
Customer Relations Case Number |
Identification number assigned to customer relations case |
104180 |
Job - CASE(Customer Relations)/CaseNumber (Inactive) |
|
20 |
Better Business Bureau Case Number |
Identification number assigned to Better Business Bureau case |
104140 |
Job - CASE(Better Business)/CaseNumber (Inactive) |
|
21 |
Job Goodwill Flag |
Indicates if Dealer Goodwill has been applied to this job (complete or partial) |
104260 |
Job/JobGoodwillInd (Inactive) |
|
25 |
Repeat Repair Flag |
Identifies repair as having been performed previously on the vehicle |
104385 |
Job/RepeatRepairInd (Inactive) |
|
26 |
Diagnostic Codes |
One or more Manufacturer Diagnostics Codes taken during the Repair Process for this job - Multiple codes should be separated by |
106460 |
Job - Diagnostics/DiagnosticCodes |
|
27 |
Hazmat Indicator Flag |
Indicator that Hazmat Was Used and Disposed Of as Part of the Repair |
106470 |
Job/HazmatInd |
|
28 |
Battery Voltage |
Reading from a battery check service. If not tracked in DMS, dealer may enter the information in Job comments |
106690 |
Job - Diagnostics/BatteryVoltage |
|
29 |
Job Miscellaneous Price |
Total miscellaneous for sale type portion of job |
106990 |
Job - Price(Miscellaneous)//TotalAmount |
|
30 |
Job GOG Price |
Total GOG for sale type portion of job |
107000 |
Job - Price(GasOilGrease)/TotalAmount |
|
31 |
Job Paint Price |
Total Paint for sale type portion of job |
107010 |
Job - Price(PaintMaterial)/TotalAmount |
|
32 |
Job Shop Price |
Total Shop for sale type portion of job |
107020 |
Job - Price(ShopSupplies)/TotalAmount |
|
33 |
Job Freight Price |
Total Freight for sale type portion of job |
107030 |
Job - Price(Freight)/TotalAmount |
|
34 |
Job Denial Code |
Dealer / Manufacturer defined code identifying the reason the customer denied service on a repair order line |
109280 |
Job - CodesAndComments/JobDenialCode |
|
35 |
Origin Code |
Indicates source of repair order- Examples: D - Dealer Entered; T - Teleservice (Car phones in for service); K - Key Reader (Codes read from car's key indicates need for service) |
110700 |
Job/OriginCode (Inactive) |
|
36 |
Towed In Indicator |
Indicates that this job led to the need to have this car towed in. Valid Values -= Y/N |
110710 |
Job/TowedInIndicator (Inactive) |
|
37 |
Battery Warranty Code |
Any warranty covered battery replacement or recharging (if covered) |
110890 |
Job - Diagnostics/BatteryWarrantyCode |
|
38 |
Tread Act Ind |
Indicates if there has been fire damage |
110900 |
Job/ TreadActInd |
|
39 |
Defect Code |
Manufacturer assigned code that defines failed component for this job |
105040 |
Job - CodesAndComments/DefectCode |
|
Job Comments |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Customer Complaint Code |
Customer complaint category either entered or selected by dealer and passed through to manufacturer |
104440 |
Job - CodesAndComments/ComplaintCode |
|
2 |
Cause Description |
Dealer explanation of vehicle malfunction cause ( |
104410 |
Job - CodesAndComments/CauseDescription |
|
3 |
Complaint Description |
Customer explanation of vehicle malfunction |
104420 |
Job - CodesAndComments/ComplaintDescription |
|
4 |
Correction Description |
Dealer explanation of vehicle repair |
104430 |
Job - CodesAndComments/CorrectionDescription |
|
5 |
Technician Notes |
Free form technician comments |
104460 |
Job - CodesAndComments/TechnicianNotes |
|
6 |
Miscellaneous Notes |
Free form miscellaneous comments |
104450 |
Job - CodesAndComments/MiscellaneousNotes |
|
7 |
Job Denial Description |
Text description of the reason a customer denied service on a repair order line |
109290 |
Job - CodesAndComments/JobDenialDescription |
|
Parts |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Part Number |
Part number identifier - Part number, unless part type designates a manufacturer code |
104780 |
ServiceParts/ItemId |
|
2 |
Part Description |
Part number detail description |
104770 |
ServiceParts/ItemIdDescription |
|
3 |
Group Number |
Part group number |
104740 |
ServiceParts/GroupNumber |
|
4 |
Count |
Quantity of Part number used on repair |
104730 |
ServiceParts/ItemQuantity |
|
7 |
Part Unit Cost |
Part cost at inventory value. |
104840 |
ServiceParts - Price(Parts)/UnitCost |
|
8 |
Part Total Cost |
Total part cost at inventory value (Before any split) |
104800 |
ServiceParts - Price(Parts)/TotalCost |
|
9 |
Part Unit Price |
Part unit price (Cost + Markup) Will be null if split |
104850 |
ServiceParts - Price(Parts)/UnitPrice |
|
10 |
Part Total Price |
Part total price (Cost + Markup) Will be null if split |
104810 |
ServiceParts - Price(Parts)/TotalAmount |
|
11 |
Part Unit Return Core Price |
Unit Price dealer paid for return core |
107750 |
ServiceParts - Price(ReturnCore)/UnitPrice |
|
12 |
Part Total Return Core Price |
Total price dealer paid for return cores |
104830 |
ServiceParts - Price(ReturnCore)/TotalAmount |
|
13 |
Manufacturer Unit Cost After Split |
Part cost at inventory value after split (Null if no split) |
104760 |
ServiceParts - Splits(Parts) - Price(Splits)/UnitCost |
|
14 |
Manufacturer Total Cost After Split |
Part unit cost times count after split (Null if no split) |
104750 |
ServiceParts - Splits(Parts) - Price(Splits)/TotalCost |
|
15 |
Part Unit Price After Split |
Part unit price (Cost + Markup) after split Will be null if no split |
104860 |
ServiceParts - Splits(Parts) - Price(Splits)/UnitPrice |
|
16 |
Part Total Price After Split |
Part total price (Cost + Markup) after split Will be null if no split |
104820 |
ServiceParts - Splits(Parts) - Price(Splits)/TotalAmount |
|
17 |
Part Split Percentage |
Cost split percentage |
104790 |
ServiceParts - Splits(Parts)/SplitPercent |
|
18 |
Part Type |
Specifies whether the parts are indicated by manufacturer part code or Part Number |
105100 |
ServiceParts/PartType |
|
19 |
Part Unit Sales Tax |
Part Unit sales tax |
107050 |
ServiceParts - Tax(Parts)/UnitSalesTaxAmount |
|
20 |
Part Total Sales Tax |
Part Total sales tax |
107060 |
ServiceParts - Tax(Parts)/TaxAmount |
|
21 |
Appeal Action Code |
Defines action to be taken on appeal |
110180 |
ServiceParts/ AppealActionCode |
|
Recall |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Recall Campaign Number |
Manufacturer assigned recall/campaign number |
104900 |
ServiceCampaign/CampaignNumber |
|
2 |
Recall Campaign Option Code |
Manufacturer assigned recall/campaign option code |
104910 |
ServiceCampaign/CampaignOptionCode (Inactive) |
|
3 |
Supplemental Campaign Flag |
Denotes whether claim is actual campaign service or additional service, but still related to the campaign |
106700 |
ServiceCampaign/SupplementalCampaignInd (Inactive) |
|
4 |
Campaign Disposition Code |
A campaign related field specifying the disposition of a campaign Ex: completed, open, etc. |
106705 |
ServiceCampaign/CampaignDispositionCode (Inactive) |
|
5 |
Campaign Reimbursement Code |
A campaign related field specifying the reimbursement code for a campaign service. Reimbursement codes denote the mix of part |
106710 |
ServiceCampaign/CampaignReimbursementCode (Inactive) |
|
Labor |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Labor Operation Code |
Currently assigned code for this operation (preferably manufacturer code) |
104490 |
ServiceLabor/LaborOperationId |
|
2 |
Labor Operation Code Type |
Labor operation category code |
104500 |
ServiceLabor/LaborOperationIdType |
|
3 |
Labor Operation Description |
Description of a particular operation code |
104510 |
ServiceLabor/LaborOperationDescription |
|
4 |
Labor Hours |
Flat rate labor hour allowance for this operation |
104480 |
ServiceLabor/LaborAllowanceHours |
|
5 |
Additional Labor Hours |
Additional labor hours above flat rate allowance |
104470 |
ServiceLabor/LaborAdditionalHours |
|
6 |
Labor Quantity Of Operation |
Number of times this operation was performed for this labor line |
104540 |
ServiceLabor/LaborOperationQuantity |
|
7 |
Labor Split Percentage |
Labor cost split percentage |
104550 |
ServiceLabor - Splits(Labor)/SplitPercent |
|
8 |
Labor Part Name Code(PNC) |
Part identifier which is comprised of a system and component code that caused the failure |
104520 |
ServiceLabor/PartNameCode |
|
9 |
Labor Symptom Code |
Manufacturer-assigned code to describe how customer experiences problem |
104560 |
ServiceLabor - Diagnostics/SymptomCode |
|
10 |
Labor Trouble Failure Code |
Manufacturer-assigned code to describe the reason that a fault or symptom occurred (i.e., Reason Code) |
104590 |
ServiceLabor - Diagnostics/FailureCode |
|
11 |
Labor Part Name Code Desc |
Description of Part identifier (PNC) that caused the failure |
104530 |
ServiceLabor/PartNameCodeDescription |
|
12 |
Labor Symptom Code Desc |
Description of labor symptom code |
104570 |
ServiceLabor - Diagnostics/SymptomCodeDescription |
|
13 |
Labor Trouble Code Desc |
Description of labor trouble code |
104580 |
ServiceLabor - Diagnostics/FailureCodeDescription |
|
14 |
Labor Op Position Code |
Code Indicating Position/Location on Vehicle where labor was performed |
106480 |
ServiceLabor/LaborOperationLocation (Inactive) |
|
15 |
Labor Rate of Operation |
Labor Rate for this operation code |
105095 |
ServiceLabor/LaborRate |
|
16 |
Labor Price |
Labor Price for labor operation code |
106760 |
ServiceLabor - Price(Labor)/TotalAmount |
|
17 |
Labor Action Code |
Manufacturer-assigned code to describe type of labor performed (i.e., Repair, Replace, Adjust) |
106920 |
ServiceLabor/LaborActionCode |
|
18 |
Additional Hours Labor Comment |
Explanation for the need for the additional labor hours |
106725 |
ServiceLabor/AdditionalHoursLaborComment (Inactive) |
|
19 |
Appeal Action Code |
Defines action to be taken on appeal |
110180 |
ServiceLabor/AppealActionCode |
|
Coupon |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Coupon Description |
Text identification of Coupon |
104597 |
Coupon/CouponDescription (Inactive) |
|
2 |
Coupon Discount Price |
Credit Price for coupons |
104595 |
Coupon/CouponDiscountPrice (Inactive) |
|
Technician |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Technician Emp ID Code |
Employee Identification code of technician assigned to RO (Assigned by dealer) |
105400 |
Technician/PartyId |
|
2 |
Technician Name |
Name of technician assigned to RO |
105390 |
Technician/TechnicianName |
|
3 |
Team Name |
Team assigned to Repair Order |
105380 |
Technician/TeamName |
|
4 |
Technician SSN |
Social security number of technician assigned to Repair Order |
105410 |
Technician - AlternatePartyIds/Id & AssigningPartyId = "NationalId" |
|
Claim |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Claim Number |
Identifier of claim |
105020 |
WarrantyClaim/ClaimNumber |
|
2 |
Claim Type |
Identifier of the type of claim - Claim type is usually 1 - 4 characters |
105030 |
WarrantyClaim/ClaimType |
|
3 |
Accessory Claim Type |
Manufacturer identifier of the type of accessory claim |
104990 |
WarrantyClaim/AccessoryClaimType |
|
4 |
Authorization Number |
Assigned authorization number for claim |
105010 |
WarrantyClaim/AuthorizationNumber |
|
5 |
Authorization Code |
Assigned authorization code or additional authorization number for claim |
105000 |
WarrantyClaim/AuthorizationCode |
|
6 |
Part Type |
Specifies whether the parts are indicated by manufacturer part code or Part Number |
105100 |
WarrantyClaim/PartType |
|
7 |
Defect Code |
Manufacturer assigned code that defines failed component that caused the claim |
105040 |
WarrantyClaim/DefectCode |
|
8 |
Failed Part |
Primary part responsible for vehicle failure |
105060 |
WarrantyClaim/ItemId |
|
9 |
Freight Claim Number |
The claim number of the freight claim associated with the current warranty claim |
105080 |
WarrantyClaim/GreightClaimNumber |
|
10 |
Total Freight Price |
Total Freight Price for claim number |
105070 |
WarrantyClaim - Price(Freight)/TotalAmount |
|
11 |
Authorization Pay Maximum |
Maximum Price covered by Authorization |
106490 |
WarrantyClaim/AuthorizationPayMaximum (Inactive) |
|
12 |
Authorization Pay Percentage |
Payment Percentage covered by Authorization |
106500 |
WarrantyClaim/AuthorizationPayPercent (Inactive) |
|
13 |
Authorization Pay Type |
Payment Type covered by Authorization |
106510 |
WarrantyClaim/AuthorizationPayType (Inactive) |
|
14 |
Cause Code |
Manufacturer assigned reason the part failed |
106520 |
WarrantyClaim - CodesAndComments/CauseCode |
|
16 |
Spare Part Date |
The date the part was purchased - If the retailer installed the part, the date would be the same as the RO date |
106540 |
WarrantyClaim/ SparePartDate |
|
17 |
Spare Part Invoice No |
The invoice number on which the part was sold over the counter - If installed, the number would be the same as the RO # |
106550 |
WarrantyClaim/SparePartInvoiceNumber |
|
18 |
Spare Part Mileage |
Mileage at which the failed part was originally installed |
106715 |
WarrantyClaim/SparePartMileage |
|
19 |
Claim Total Price |
Total Price of all parts, labor and sublet for claim number |
106765 |
WarrantyClaim - Price(Claim)/TotalAmount |
|
20 |
Claim Taxable Labor Price |
Total taxable labor Price for claim number |
106770 |
WarrantyClaim - Price(Labor)TaxableAmount |
|
21 |
Claim Non-taxable Labor Price |
Total non-taxable labor Price for claim number |
106775 |
WarrantyClaim - Price(Labor)NonTaxableAmount |
|
22 |
Claim Taxable Part Price |
Total taxable part Price for claim number |
106780 |
WarrantyClaim - Price(Parts)/TaxableAmount |
|
23 |
Claim Non-taxable Part Price |
Total non-taxable part Price for claim number |
106785 |
WarrantyClaim - Price(Parts)/NonTaxableAmount |
|
24 |
Claim Return Core Price |
Total return core Price for claim number |
106790 |
WarrantyClaim - Price(ReturnCore)/TotalAmount |
|
25 |
Claim Sublet Labor Price |
Total sublet labor Price for claim number |
106795 |
WarrantyClaim - Price(SubletLabor)/TotalAmount |
|
26 |
Claim Sublet Part Price |
Total sublet part Price for claim number |
106800 |
WarrantyClaim - Price(SubletParts)/TotalAmount |
|
27 |
Claim Gas, Oil, Grease Price |
Total Gas, Oil, Grease Price for claim number |
106805 |
WarrantyClaim - Price(GOG)/TotalAmount |
|
28 |
Claim Paint and Materials Price |
Total Paint and Materials Price for claim number |
106810 |
WarrantyClaim - Price(Paint)/TotalAmount |
|
29 |
Claim Shop Supplies Price |
Total Shop Supplies Price for claim number |
106815 |
WarrantyClaim - Price(Shop)/TotalAmount |
|
30 |
Claim Miscellaneous Price |
Total Miscellaneous Price for claim number |
106820 |
WarrantyClaim - Price(Miscellaneous)/TotalAmount |
|
31 |
Claim Tax Price |
Total tax price for claim number |
106825 |
WarrantyClaim -Tax(Claim)/TotalAmount |
|
32 |
Warranty Appeal Flag |
Warranty Appeal Flag |
106910 |
WarrantyClaim/WarrantyAppealInd (Inactive) |
|
33 |
Data Collection Status |
Indicates status of data for the record it appears on |
107210 |
WarrantyClaim/DataCollectionStatus (Inactive) |
|
34 |
Claim Submission Count |
Tracks number of times claim has been submitted to manufacturer (i.e., Value will be 0 or null if claim is not ready to be sent |
107040 |
WarrantyClaim/ClaimSubmissionCount (Inactive) |
|
35 |
Fleet Purchase Order Number |
Fleet Purchase Order Number vehicle was purchased under |
109470 |
Header - Vehicle/FleetPurchaseOrderNumber (Inactive) |
|
36 |
Manual Review Code |
Code to signal requirement for manual review by claim analyst |
110110 |
WarrantyClaim/ManualReviewCode (Inactive) |
|
37 |
Warranty Program Code |
Code for manufacturer Warranty special programs |
110120 |
WarrantyClaim/WarrantyProgramCode |
|
38 |
Original Repair Order Number |
References Original Repair Order number |
110160 |
WarrantyClaim/OriginalRepairOrderNumber (Inactive) |
|
39 |
Appeal Reason Code |
Code defining reason for appeal |
110170 |
WarrantyClaim/AppelaReasonCode (Inactive) |
|
40 |
Tread Act Ind |
Indicates if there has been fire damage |
110900 |
WarrantyClaim/TreadActInd |
|
Job Referback |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Job Referback Number |
Refer-back to a job that has already appeared within the same "pay-group" presently being processed (Customer, Claims or Intern |
107190 |
JobReferback/JobReferbackNumber (Inactive) |
|
Internal Pay |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Internal Department |
Identifies the internal department who is paying for work - Commas may separate multiple departments as long as data element is |
107200 |
InternalPay/DepartmentType |
|
2 |
Internal Department Description |
Description of the internal department paying for work - Commas may separate multiple department descriptions as long as data e |
107290 |
InternalPayDepartmentDescription |
|
3 |
Data Collection Status |
Indicates status of data for the record it appears on |
107210 |
InternalPay/DataCollectionStatus (Inactive) |
|
Trailer |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Number of Records |
Number of detail records contained in this file |
110500 |
Not Applicable - Not used in XML BOD |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: