GetListInventoryCount schema, example, validation rules, validation stylesheet

GetListInventoryCount type: GetListInventoryCount

The purpose of the GetListInventoryCount is to to enable a business application to request several occurrences of summary Inventory Count information from an ERP system. This count may be a cycle count or a physical count. This BOD may also apply to planned or unplanned inventory counts.

GetListInventoryCount extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetListInventoryCountDataArea

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

GetListInventoryCountDataArea extends: DataArea
Structure:
Elements:
Name Type Description
GetList reference
InventoryCount reference

GetListInventoryCount 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

InventoryCount schema

InventoryCount type: InventoryCount

InventoryCount represents the results of a physical inventory or cycle count of the actual on-hand quantities of each item in each location. Compare to the noun InventoryBalance, which represents system-maintained on-hand quantities.

Header type: InventoryCountHeader

Is the header of the InventoryCount document.

Line type: InventoryCountLine

Provides the detail for each count entry.

InventoryCount extends: Noun
Structure:
Elements:
Name Type Description
Header reference
Line reference

InventoryCountHeader

Structure:
Elements:
Name Type Description
DocumentDateTime DateTime

Is the timestamp when the document was created on the sending system.

DocumentId reference
UserArea reference

InventoryCountLine
Structure:
Elements:
Name Type Description
Business reference
Description 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..

EffectiveDateTime DateTime

This is the date on which the count has been carried out

GLEntity GLEntity

Idenitifies GLEntity owns the item and takes the credit or debit for the item on the balance sheet.

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

Item reference
ItemQuantity Quantity

The quantity of items that are involved in the transaction

A decimal value.

LineNumber LineNumber

Is the line number of the InventoryCount.

Identifies the instance of a Line within a given document.

Note Note

Is a note about the source location of the transfer.

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.

ReasonCode ReasonCode

Is the reason for the transfer.

Used as a reason indicator for any type of business event or activity.

Site reference
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