GetItemCrossReference schema, example, validation rules, validation stylesheet

GetItemCrossReference type: GetItemCrossReference

The purpose of the GetItemCrossReference is to enable a business application module or system to request information concerning an Item cross-reference. Cross-references may be to other item identifiers to the same form fit and function, as well as references to item identifiers of other items (form fit and function). In this document item relationships is used to refer to where the "to item" identifier, identifies a different form, fit and function to the "from item" identifier. It should be noted that the item identifier that is "Primary" in one system may be a secondary identifier in another system. For example, in the Application Integration space, the manufacturing system may regard the "Item Number" as the primary identifier. The Order Management System may regard the Catalog number as the primary identifier. A company that manufacture hand held multi-meters may identify a given item in manufacturing with a 12 digit numeric code, 5432 123 12345. The marketing and sales department may refer to the same item by it’s catalog number of FL 30/4. In the Business to Business case a supplier of hand held multi-meters may market their products through a catalog provider. The supplier has an item identifier with a corresponding party specific cross reference to the catalog providers identifier for the same item. The catalog provider has a item identifier for hand held multi-meters and a corresponding party specific cross reference to the suppliers item number. This BOD may be necessary to address Manufacturers, Distributor Resellers business ordering scenarios in a Order Management to Manufacturing application integration scenario. It may also be necessary to address Component Supplier Management scenarios. There are many possible business applications in several environments that may use this capability. For example, a PDM, MRP, Inventory, or Manufacturing business application could use this to communicate the requirement to synchronize an Item cross-reference. Item cross-references may be specific to a given party. Examples may include, (but are not limited to): · Customers · Suppliers · Manufacturers · Carriers · Standards Associations Party specific cross-references include: · Customer Part Number · Supplier Part Number · Manufacturers Part Number Cross-reference types may also be universal. Universal item cross-reference types may include, (but are not limited to) · Universal Packaging Code (UPC) · European Article Number (EAN) · Harmonized Schedule B number · GTIN Number · ISBN Number for Books The BOD may be used to relate item identifiers for item identifiers that identify different items (form fit and function). The Relationship types may also be universal. Universal item relationship types may include, (but are not limited to) · Accessories · Spares · Consumables An example of this in a business to business context might be a customer letting a supplier know the valid substitutes that a supplier may supply to fulfill an order for a specific item number. An example of this in a application integration context might be between a Product Data Management (PDM) system and an Order Management system for accessories that may be offered to a customer with the sales of a major item. For example, if a designers of a video camera, have designed it to work with the following accessories; · tripod, · extended life battery pack · external microphone · Head Cleaner The video camera may be designed to have the following spares replaced by the consumer · Lens Cover · Strap · Handle The video camera may need the following consumable items on a recurring basis · Video Cassettes · Batteries · Lens Cleaners the relationship between these items and the video camera may need to represented to the Customer in Web Based ordering or Customer Service Rep (CSR), in desk based order entry.

GetItemCrossReference extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetItemCrossReferenceDataArea

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

GetItemCrossReferenceDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
ItemCrossReference reference

GetItemCrossReference Scenario Diagram

Get schema

Get type: 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.

Get extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
show xs:string

ItemCrossReference schema

ItemCrossReference type: ItemCrossReference

Item Cross References describe both alternate and related items. Alternate items could specify items that have alternative universal identifiers such as EAN, UPC, or party specific identifiers such as supplier part number or customer part number. Related items could be spares, accessories or substitutes. Substitute items could be items that were validated by a development department for use as a substitute for the regular item.

RelatedItemReference type: RelatedItemReference

This identifies an item or a group of items that are related to the primary item. For a given relationship, there may be one or more than one item identified. Examples of replationships are spares, substitutes, accesories, consumables etc

AlternateItemIdReference type: AlternateItemIdReference

This identifies an Alternate ItemId for the item. The type of ItemId is identified by the AlternateIdQualifier. Examples of Alternate ItemIds are UPC, EAN, Customer Assigned Part Number, Manufacturer Assigned Part Number etc.

AlternateItemIdReference
Structure:
Elements:
Name Type Description
ItemIds reference

Identifies the Alternate ItemId

Is the ItemId of the indicated Assigning Party. This ItemId is the primary for this instance of the cross-reference. Alternate ItemIds are provided in the AlternateReferences.

Site reference
UserArea reference

ItemCrossReference extends: Noun
Structure:
Elements:
Name Type Description
AlternateItemIdReference reference
ItemId Id

Is the ItemId of the indicated PublisherParty. This ItemId is the primary for this instance of the cross-reference. Alternate ItemIds are provided in the AlternateReferences.

Is the ItemId of the indicated Assigning Party. This ItemId is the primary for this instance of the cross-reference. Alternate ItemIds are provided in the AlternateReferences.

Generic identifier type with open qualifyingAgency.

Property reference
PublisherParty reference
RelatedItemReference reference
Revision Revision

Is the Revision Number related to the ItemId

Is the revision code that can be associated with an Item, an order, a Bill of Material. The revision code indicates that the say item has been modified or updated in some way.

Site reference
UserArea reference

RelatedItem
Structure:
Elements:
Name Type Description
ItemId ItemIdType

Is the ItemId of the indicated Assigning Party. This ItemId is the primary for this instance of the cross-reference. Alternate ItemIds are provided in the AlternateReferences.

Is the ItemId of the indicated Assigning Party. This ItemId is the primary for this instance of the cross-reference. Alternate ItemIds are provided in the AlternateReferences.

Parties reference
Preference Preference

Determines the ranking or rating of otherwise equal candidates within a given list. Examples of the use of preference are: Preference for a substitute item from a demanded item. Preference for a given supplier for a required item.

Identifies the preference.

Property reference
Site reference
UserArea reference

RelatedItemReference
Structure:
Elements:
Name Type Description
RelatedItem RelatedItem
Relationship Relationship

This identifies the relationship of the item to the parent item. Examples of relationships are spares, substitutes, accesories, consumables, Alternate, Replacement etc

UserArea reference

Verb Common Files

Verb.xsd schema

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

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

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

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

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

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

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

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

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files