GetInventoryIssue schema, example, validation rules, validation stylesheet

GetInventoryIssue type: GetInventoryIssue

The purpose of the GetInventoryIssue is to request inventory issue information against an order, from an ERP system into a PDC system to confirm the InventoryIssue transaction (BOD).

GetInventoryIssue extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetInventoryIssueDataArea

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

GetInventoryIssueDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
InventoryIssue reference

GetInventoryIssue 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

InventoryIssue schema

InventoryIssue type: InventoryIssue

The InventoryIssue can be used to request an application to process an issue or request information about an issue

Header type: InventoryIssueHeader

Identifies the common elments of the InventoryIssue.

Line type: InventoryIssueLine

Identifies the lie items and quantities that are issued the InventoryIssue.

InventoryIssue extends: Document

The InventoryIssue can be used to request an application to process an issue or request information about an issue

Structure:

InventoryIssueHeader
Structure:
Elements:
Name Type Description
DocumentDateTime DateTime

Is the timestamp that the InventoryIssue document was created on the sending system.

DocumentId reference

Is the identifier of the InventoryIssue.

DocumentReferences reference
UserArea reference

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

GLEntity GLEntity

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

IssueType IssueType

This can be used to indicate if the Issue transaction is an ISSUE or a RETURN. When left unspecified, the default for this field is assumed to be ISSUE

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 given Line Coponent within the document. LineNumbers are assigned by the sending system.

Identifies the instance of a Line within a given document.

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

OperationReference reference
PrintControlInformation Indicator

Indicates whether the control information about the transfer should be printed.

Indicates if the semantic name is needed or not.

PrintInd Indicator

Indicates whether the InventoryTransfer should be printed at the source.

Indicates if the semantic name is needed or not.

ReasonCode ReasonCode

Is the reason for the issue

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

Site reference
UnitValue Amount

This identifies the unit value of the item transaction

Simple content with the currency as an attrbute

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

Document.xsd schema

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

DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

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

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

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.

Status reference

DocumentLine
Structure:
Elements:
Name Type Description
LineNumber LineNumber

Is the Line Number of the given Line Coponent within the document. LineNumbers are assigned by the sending system.

Identifies the instance of a Line within a given document.

DocumentOrderHeader restricts: DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

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

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

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.