GetInventoryCount schema, example, validation rules, validation stylesheet

GetInventoryCount type: GetInventoryCount

The purpose of the GetInventoryCount is to request an occurrences of a 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.

GetInventoryCount extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetInventoryCountDataArea

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

GetInventoryCountDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
InventoryCount reference

GetInventoryCount 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

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