GetListRouting schema, example, validation rules, validation stylesheet

GetListRouting type: GetListRouting

The purpose of the GetListRouting is to communicate to a business application component or module a request for a summary list of a Routing structure or structures to be returned in a ListRouting.

GetListRouting extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetListRoutingDataArea

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

GetListRoutingDataArea extends: DataArea
Structure:
Elements:
Name Type Description
GetList reference
Routing reference

GetListRouting 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

Routing schema

Routing type: Routing

Routing is the description of all of the resources, steps, and activities associated with a path or routing associated with a manufacturing or production process. Typically, a routing contains people, machines, tooling, operations, and steps.

Header type: RoutingHeader

AssignedOperationGroups type: OperationGroup

Information specifying a grouping of operations and their relationships.

RouteOperation type: RouteOperation

Information specifying the operations and there order for the specified routing.

PreviousOperation type: PreviousOperation

Information specifying the previous operation. This provides the immediate preceding operation of the current operation defined in RouteOperation. The RouteOperation of the operations of the potential first operations will not have an associated PreviousOperation, however all others must contain one.

GroupMember type: GroupMember

Information specifying the occurrence of the operations within an OperationGroup. At least one occurrence of the GroupMember component is required for each occurrence of the OperationGroup component. Except for the request BODs which use the verbs Get and GetList.

GroupMember
Structure:
Elements:
Name Type Description
OperationId OperationId

Is the identifier of a specific operation. Possible examples of use are in the Manufacturing Routing or the Maintenance Order. or WorkINProcessOperation.

Uniquly identifies an operation.

OperationName OperationName

Is the name of the operation.

Is the formal name of a Manufacturing Shop Floor Operation.

OperationSequence OperationSequenceCode

Identifies the operation sequence.

Is the sequence code associated with a operation.

UserArea reference

OperationGroup

In a manufacturing environment where a CNC Lathe or a Manual Lathe may be alternative operations used in the production of a finished good. In the example above the Manual Lathe OperationGroup Name would be Alternate OperationGroupType.

Structure:
Elements:
Name Type Description
GroupMember reference
OperationGroupName OperationName

Identifies a grouping of Operations together.

Is the formal name of a Manufacturing Shop Floor Operation.

OperationGroupType OperationGroupType

Identifies the grouping of operations.

Is the operational grouping type. Examples: Alternate – any of these may be used, Parallel – non-sequential – all must be done but order does not matter, Sequential – these items must be done one after the other and time is critical

UserArea reference

PreviousOperation extends: WIPOperationBase
Structure:
Elements:
Name Type Description
PlannedOverrunPercent Percent

Is the percentage of the planned number of items that can be produced. Typically, in a manufacturing environment stopping the manufacturing of an item at an exact number is difficult this allows the specification that an operator may overrun the planned number by a certain percentage.

Indicates the percentage.

Status reference
TimeInQueue Duration

Is the duration of time that a job may remain in the queue before being run.

UserArea reference

RouteOperation extends: WIPOperationBase
Structure:
Elements:
Name Type Description
ItemData reference
PreviousOperation reference
UserArea reference

Routing extends: Noun
Structure:
Elements:
Name Type Description
Header reference
Operation reference

RoutingHeader
Structure:
Elements:
Name Type Description
AssignedOperationGroups reference
Charges reference
Description Description

Description of the Routing.

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

Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DocumentId RouteIdType

Is the contains the unique routing document identifier information.

EffectivePeriod TimePeriod

Indicates the effectivity of the Routing Document.

Item reference

Is the Item Identifier in which the Routing is being used to create.

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