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:
Name Type Description
DataArea GetItemMasterDataArea

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

GetItemMasterDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
ItemMaster reference

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:
Name Type Usage Description
show xs:string

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:
Name Type Description
Multiplier Factor

Is the multiple to make the conversion from the Inventory UOM to the the alternate UOM.

UnitPackaging reference
UOM UOM

The UOM here represents the alternate UOM. The the Mulitplier determines the conversion between the parent UOM and the UOM specified here in the allternate UOM.

Standard values from ISO / SI ????

UserArea reference

ItemDetails

Captures the common item information that is shared between the header and Item Location.

Structure:
Elements:
Name Type Description
AlternateUOM AlternateUOM

Identifies alternate unit of measures for an item that may be used.

GLEntitySource GLEntity

Identifies the owning entity of the Item.

The primary balancing segment of the G/L Account structure. P and L statements are required at this level. A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law.

Synonyms: Business Unit, Fund, General Ledger Company, Joint Venture, Non-Profit Association Name

GLNominalAccount GLAccount

GL Account associated with the Item in the Item Master.

GL Account is an entry in the GL chart of accounts. It is the "what", not the "who" or "where".

Examples Include: Assets, Office Supplies, Revenues, Salaries, Travel

SYNONYMS: Account Number, GL Natural Account, Object Account

HazardousMaterial reference

Provides the Hazardous Material Code and description.

ItemId reference

Identifies Item code. This can be a UPC or an EAN or a company assigned Id. Along with a revision number of the Item.

LastModifiedDateTime DateTime

Is the timestamp of the last modification to the Item Master for this Item.

Note Note

Free form notes describing the item.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

OrganizationalUnit OrganizationalUnit

A fully generic means of identifying an organizational unit. Can be an actual business unit (at any level) or an area of responsibility. Each is described with respect to others, via the ProximalUnit construct.

OwnershipCode OwnershipCode

Is used to identify who or which organization owns the item or part. The content is user defined based on a specific Customer or Supplier. SYNONYMS: Vendor Consignment ID Supplier Consignment ID

Idenifies who owns the associated entity.

Property reference
RoutingDisposition reference
SerialNumberSpecification SerialNumberSpecification

Indicates the business rules used to specify what constitutes a serial number

Status reference
Type ItemType

Indicates whether the item is a good, a service, or a resource. This is used to describe inventoried items. Examples of this value include documents, jigs, fixtures, tools, or bulk items.

UnitPackaging reference
UOM UOM

Is the default UOM that the business refers to the item in. This is sometimes different from the unit of measure that is used to count a product as it is consumed, sold or accounted for. EXAMPLES: Generic Quantity (Each, Pair, Dozen, Gross, etc); Weight (Ounce, Pound, Ton, Kilogram, etc); Volume (Cup, Pint, Gallon, Liter, etc); Length (Inch, Foot, Yard, Meter, etc)

Standard values from ISO / SI ????

UOMGroupId Id

Is a UOMGroup Identifier, that identifies a set of related UOM's and their conversions from the Item's UOM

Generic identifier type with open qualifyingAgency.

UOMType UOMType

Identifies the type of the Unit-of-Measure.

Value reference
Variation Variation

Is used to distinguish Items that have the same Item identifier. It is intended to identify a lower level variation of the Item from the Item Revision. This is usually used to describe a property of the Item that is most distinguishable.This is not meant to describe detail configurations of an Item or Bill of Material. They are to be described in each of those BODs. This is to be used for slight variations on a particular Routing.

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:
Name Type Description
CatchWeightInd Indicator

Indicates that an ITEM requires special processing to determine the actual net or gross weight during certain inventory operations.

Indicates if the semantic name is needed or not.

Description Description

Describes the Item.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDateTime DateTime

Identifyies the timestamp that the Item Master record was created.

ExpirationControlType ControlType

Indicates the type of control used to determine whether or not an item has expired or is no longer considered good to sale or consume.

Describes the type type of control used for the associated component.

FreightClass FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

LotControlInd Indicator

Indicates if the item is a lotted item. Valid values are 0 for no, and 1 for yes

Indicates if the semantic name is needed or not.

SerialControlInd Indicator

Indicates if the item is a serialized item i.e. unique instances of the item are identified by unique serial numbers. Valid values are 0 for no, and 1 for yes

Indicates if the semantic name is needed or not.

UserArea reference

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:
Name Type Description
Site reference
UserArea reference

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:
Name Type Description
Header reference
ItemLocation reference

ItemValue

Identifies the cost or value of an item.

Structure:
Elements:
Name Type Description
CostType CostType

Is the methodology by which the value of an item is determined. Values are: Standard Moving Average LIFO - For last in first out. FIFO - For first in first out.

Is the methodology by which the value of an item is determined. Values are: Standard Moving Average LIFO - For last in first out. FIFO - For first in first out.

Description Description

Description of the Item Value.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

EffectivePeriod TimePeriod

Is the starting date for effectivity period for the item value indicated by this occurance of Item Value.

GLEntity GLEntity

Indicates the owning organzation of the item.

The primary balancing segment of the G/L Account structure. P and L statements are required at this level. A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law.

Synonyms: Business Unit, Fund, General Ledger Company, Joint Venture, Non-Profit Association Name

GLNominalAccount GLAccount

The General Ledger Nominal Account that indicates what the item shows up on the accounting books as.

GL Account is an entry in the GL chart of accounts. It is the "what", not the "who" or "where".

Examples Include: Assets, Office Supplies, Revenues, Salaries, Travel

SYNONYMS: Account Number, GL Natural Account, Object Account

ItemCost AmountPerQuantity

Indicates the cost per unit to the owning organization that the item represents.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

ItemValue AmountPerQuantity

Indicates the value per quantity of the item. Represents the value of the item to the owning organization.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

Note Note

Free form note about the Item Value.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

UserArea reference
ValueClass ValueClass

Is a grouping used to determine the General Ledger accounting effect. These are user defined values, with the exception of the values TOTAL, MATERIAL, LABOR, BURDEN, OVERHEAD, SUBCONTRACT.

Is a grouping used to determine the General Ledger accounting effect. These are user defined values, with the exception of the values TOTAL, MATERIAL, LABOR, BURDEN, OVERHEAD, SUBCONTRACT.

SerialNumberSpecification restricts: xs:string

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