GetListUnitOfMeasureGroup schema, example, validation rules, validation stylesheet

GetListUnitOfMeasureGroup type: GetListUnitOfMeasureGroup

The purpose of the GetListUnitOfMeasure is to communicate to a business application component or module a request for a summary list of a UnitOfMeasure Groups to be returned in a ListUnitOfMeasure. 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 alternate UOM information for one or more items.

GetListUnitOfMeasureGroup extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetListUnitOfMeasureGroupDataArea

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

GetListUnitOfMeasureGroupDataArea extends: DataArea
Structure:
Elements:
Name Type Description
GetList reference
UnitOfMeasureGroup reference

GetListUnitOfMeasureGroup Scenario Diagram

GetList schema

GetList type: GetList

The purpose of the GetList verb is to enable a business software component to request summary information for one or more occurrences of a specific noun from another business software component. The GetList may be paired with most of the nouns in the OAGIS specification.The response to this request is a BOD using the List verb. The GetList is designed to retrieve multiple occurrences of data such as all of the sales orders or all of the purchase orders within a requested range. It does not require an exact match of the key fields in order to retrieve information. It may use a range selection criteria with a "from" and "to" selection capability. This behavior is quite different from the Get verb, which is designed to retrieve a specific noun using a specific key field.The GetList verb also enables the retrieval of information across several documents by using selection fields. An example of this could be requesting all sales order lines for a specific item. This type of functionality is limited to the capabilities of the responding application and needs to be determined during the implementation project. More details on this capability will be described below. GetList attributes: o maxitems attribute is a number that indicates the number of maximum items to be returned. o rssave attribute is a Boolean flag that indicates whether the result set should be saved on the sending system if maxitems is exceeded. o rsstart attribute is a number of the starting record for the next section of the result set. If it is omitted, it is to be assumed the first of the maxitems. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests. Selection Criteria: There are two types of selection capabilities enabled by the BODs that use the GetList verb. 1) Field-Based Selection Allows the requesting system to ask for information that matches the data provided. It also allows the requestor to indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb. 2) Range Selection Allows the requesting system to provide a range of values for known data. This is accomplished by providing two occurances of the Noun. The first occurance indicates the "From" the second occurance indicates the "To" occurance. Again the requestor can indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb.

GetList extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
list xs:string optional
maxItems xs:positiveInteger optional
rsRef xs:string optional
rsSave xs:boolean optional
rsStart xs:positiveInteger optional

UnitOfMeasureGroup schema

UnitOfMeasureGroup type: UOMGroup

Unit-of-Measure Group is a set of related Units-of-Measure (UOMs). A UOMGROUP is typically defined by inventory control systems and assigned to many different ITEMs that otherwise share common handling, packaging or other physical inventory attributes.

Header type: UOMGroupHeader

Idenitifies the base UOM for this UOMGroup that the AlternateUOMs can be converted from.

AlternateUOM type: AlternateUOM

Identifies the n number of different UOM that a given item's UOM may have.

AlternateUOM

Unit-of-Measure conversion flexibility permits alternate UOMs to be defined in terms relative to the ITEM's stocking UOM or relative to other alternate UOMs. Note that these conditions further require the first alternate UOM occurrence to always be expressed in terms relative to the stocking UOM. This declaration methodology permits applications to construct a linked UOM conversion hierarchy and calculate a conversion factor between any given alternate and stocking UOM.

Structure:
Elements:
Name Type Description
MultiplierQuantity Quantity

Specifies both the quantity and UOM which are equivalent to the alternate Unit-of-Measure. The value of the MultiplierQuantity compound may be any whole or fractional numeric value. The UOM field within the MultiplierQuantity compound must contain either one of the following values: The ITEM's stocking UOM (as declared in the UOMGroup Header Component) or a previously declared alternate UOM.

A decimal value.

UnitPackaging UnitPackaging

Descibes the packaging of the AlternateUOM.

UOM UOM

Represents an alternate Unit-of-Measure for the item.

Standard values from ISO / SI ????

UOMType UOMType

Identifies the type of the Unit-of-Measure.

UPC reference
UserArea reference

UnitPackaging
Structure:
Elements:
Name Type Description
Description Description

Description of the unit packaging.

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..

Height Quantity

A decimal value.

Length Quantity

A decimal value.

PackingCode Code

Is a code to identify the packing material

Base type for a Code of any kind

ShippingMaterialDescription Description

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..

ShippingMaterialIdentifier Id

Generic identifier type with open qualifyingAgency.

UPCPackagingLevel Code

Base type for a Code of any kind

UserArea reference
Volume Quantity

A decimal value.

Weight Quantity

A decimal value.

Width Quantity

A decimal value.

UOMGroup extends: Noun

Unit-of-Measure conversion flexibility permits alternate UOMs to be defined in terms relative to the ITEM's stocking UOM or relative to other alternate UOMs. Note that these conditions further require the first alternate UOM occurrence to always be expressed in terms relative to the stocking UOM. This declaration methodology permits applications to construct a linked UOM conversion hierarchy and calculate a conversion factor between any given alternate and stocking UOM.

Structure:
Elements:
Name Type Description
AlternateUOM reference
Header reference

UOMGroupHeader
Structure:
Elements:
Name Type Description
Description Description

Is a drescription of the Unit-of-Measure relationship.

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..

UnitPackaging UnitPackaging

Descripes the packaging unit of the UOM in the UOM Group.

UOM UOM

Refers to the base or inventory stocking Unit-of-Measure and represents the smallest Unit-of-Measure that can be tracked by an inventory control application.

Standard values from ISO / SI ????

UOMGroupId Id

Is the UOMGroup Identifier, that uniquely identifies the UOM relationship for the integrated environment.

Generic identifier type with open qualifyingAgency.

UOMType UOMType

Identifies the type of the Unit-of-Measure.

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