GetItemMaster schema, example, validation rules, validation stylesheet |
GetItemMaster type: GetItemMaster | |
The purpose of the GetItemMaster is to enable a business application module to request information concerning a specific ITEM from another business application. The reply to this BOD is the ShowItemMaster. There are many possible business applications in several environments that may use this capability. For example, an MRP, Inventory, or Manufacturing business application could use this to request item information. |
GetItemMaster extends: BusinessObjectDocument | |||||||
Structure: |
![]() |
||||||
Elements: |
|
GetItemMasterDataArea extends: DataArea | ||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
GetItemMaster 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: |
|
ItemMaster schema |
ItemMaster type: ItemMaster | |
Represents any unique purchased part or manufactured product. Item, as used here, refers to the basic information about an item, including its attributes, cost, and locations. It does not include item quantities. Compare to the noun InventoryBalance, which includes all quantities and other location-specific information. Item is used as the Item Master. |
Header type: ItemHeader | |
Identifies everything know about an item. Information at the header level applies to all locations unless indicated differently at a given location. |
ItemLocation type: ItemLocation | |
Identifies the Item information that is specific to a location. For example a plant or site may keep different information about an item than the corporate office. |
Value type: ItemValue | |
Identifies the cost or value of the item. |
UnitPackaging type: Packaging | |
Identifies the packaging that the company generally references the Item in. Identifies the Packaging information for a given item. Note: The UPC here is the UPC of the packaging for a given item. |
AlternateUOM | ||||||||||||||||
Structure: |
![]() |
|||||||||||||||
Elements: |
|
ItemDetails | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Captures the common item information that is shared between the header and Item Location. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Elements: |
|
ItemHeader extends: ItemDetails | ||||||||||||||||||||||||||||
Identifies everything know about an item. Information at the header level applies to all locations unless indicated differently at a given location. |
||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||
Elements: |
|
ItemLocation extends: ItemDetails | ||||||||||
Identifies the Item information that is specific to a location. For example a plant or site may keep different information about an item than the corporate office. The ItemId in the ItemLocation is the Id by which the Item is referred to within this location, if applicable |
||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
ItemMaster extends: Noun | ||||||||||
Represents any unique purchased part or manufactured product. Item, as used here, refers to the basic information about an item, including its attributes, cost, and locations. It does not include item quantities. Compare to the noun InventoryBalance, which includes all quantities and other location-specific information. Item is used as the Item Master. |
||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
ItemValue | ||||||||||||||||||||||||||||||||||
Identifies the cost or value of an item. |
||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||
Elements: |
|
SerialNumberSpecification restricts: xs:string | |
Verb Common Files |
Verb.xsd schema |
AcknowledgableVerb extends: ConfirmableVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
AcknowledgementType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
ConfirmableVerb extends: Verb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
ConfirmType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
Expression restricts: xs:string | |
ExpressionCriteria | |||||||||
Structure: |
![]() |
||||||||
Elements: |
|
||||||||
Attributes: |
|
RequestVerb extends: ConfirmableVerb | |||||||
Structure: |
![]() |
||||||
Elements: |
|
VerbBase.xsd schema |
Verb type: Verb | |
Verb | |
Structure: |
![]() |
Noun Common Files |