GetDispatchList schema, example, validation rules, validation stylesheet

GetDispatchList type: GetDispatchList

The purpose of the GetDispatchList is to enable a business application module to request this information from another business application. The reply to this BOD is the ShowDispatchList.

GetDispatchList extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetDispatchListDataArea

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

GetDispatchListDataArea extends: DataArea
Structure:
Elements:
Name Type Description
DispatchList reference
Get reference

GetDispatchList 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

DispatchList schema

DispatchList type: DispatchList

A dispatch list shows the manufacturing or production supervisor or foreman a prioritized detail status of orders and operations scheduled or in-process at a specific work center.

Header type: DispatchListHeader

Line type: DispatchListLine

ResourceLevel type: ResourceLevel

DispatchResource type: DispatchResource

This identifies information concerning the resources associated with a particular WIP operation

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

DispatchListHeader

This provides information about the entire WIP transaction. It can refer to a WorkCenter, a work location or a machine

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

Id Id

Is the dispatch list identtifier.

Generic identifier type with open qualifyingAgency.

Machine reference
Note Note

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.

Site reference
UserArea reference
WorkCenter WorkCenter

Identifies the work center in which the machine resides in which the work is being diapatched to.

DispatchListLine

This refers to Dispatch List Operation/Line information or it could represent a step in a routing

Structure:
Elements:
Name Type Description
Description Description

Description of the DispatchListLine.

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

DispatchResource reference
ForecastTime TimePeriod

Forecasted start and finishing TimePeriod.

ItemQuantity Quantity

Number of items in the Line.

A decimal value.

LineNumber LineNumber

Identifies the instance of a Line within a given document.

MfgDocumentReferences reference
OperationReference reference
ProductionOrderReference reference
ResourceLevel reference
SetupTime TimePeriod

TimePeriod indicating setup time for the resource.

TearDownTime TimePeriod

Timestamp indicating that teardown of the resource.

UserArea reference

DispatchResource
Structure:
Elements:
Name Type Description
ActivityType Type

This describes the type of activity produced by a cost center in an operation. In this context, it indicates that the resources being reported here are performing one of the following types of activities: Setup, Execution or Teardown

ForecastTime TimePeriod

Forecasted start and finishing TimePeriod.

Resources reference

AW: In the future xs:All would be very helpful; still unbounded works here

AW: not using Subs group with Resource so names can be local

SetupTime TimePeriod

TimePeriod indicating setup time for the resource.

TearDownTime TimePeriod

Timestamp indicating that teardown of the resource.

UserArea reference

ResourceLevel 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