GetWIPConfirm schema, example, validation rules, validation stylesheet

GetWIPConfirm type: GetWIPConfirm

The purpose of the GetWIPConfirm is to enable the requesting of data necessary to perform a confirmation of the movement of WIP (Work in Progress).

GetWIPConfirm extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetWIPConfirmDataArea

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

GetWIPConfirmDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
WIPConfirm reference

GetWIPConfirm 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

WIPConfirm schema

WIPConfirm type: WIPConfirm

Work-in-Progress confirmation represents confirmation of the movement of WIP materials. The noun refers to general information about the entire WIP transaction, as well as line item detail about the specific WIP operation or routing step. This may apply to the movement of raw materials or finished products.

Header type: ShopFloorControlHeader

Line type: ShopFloorControlLine

ShopFloorControlResource type: ShopFloorControlResource

Information concerning the resources associated with a particular WIP operation or sub-operation within a routing.

ShopFloorControlActivity type: ShopFloorControlActivity

Provides information about the steps or tasks that a resource performs during an operation.

ShopFloorControlSubLine type: ShopFloorControlSubLine

Information concerning a sub operation within a routing

ShopFloorControlActivity extends: ShopFloorControlResourceBase
Structure:
Elements:
Name Type Description
UserArea reference

ShopFloorControlHeader

Provides information that is relavent for the entire WIPConfirm. DocumentReferences allow this document to reference other documents that this Work-in-Process is being performed to satisfy. This can be the result ot PurchaseOrders, MaintenanceOrders, SalesOrders, etc.

Structure:
Elements:
Name Type Description
Description Description

Describes the WIPConfirm 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 timestamp that the WIPConfirm document was created on the sending system.

DocumentId reference
DocumentReferences reference
TransferType TransferType

TransferType to be “Complete” or a return by specifying “Return” to indicate that the items are to be returned to inventory. The Return is a very similar function to the Complete and just reserves the process. When left unspecified, the default for this field is Complete.

Is used to describe the item transfer.

UserArea reference

ShopFloorControlLine extends: ShopFloorControlLineBase
Structure:
Elements:
Name Type Description
ProductionOrderReference reference
ShopFloorControlSubLine reference
UserArea reference

ShopFloorControlLineBase
Structure:
Elements:
Name Type Description
Attachments reference
CompletedQuantity Quantity

Is the quantity of resulting items from the operation that were completed.

A decimal value.

Description Description

Decsribes the WIPConfirm Line.

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

Item reference
Kanban Kanban

Identifies the associated kanban information.

Is the reference number associated with in-plant routing information.

OperationId OperationId

Is the Operation identifier that the WIP Confirm is reporting against.

Uniquly identifies an operation.

OperationName OperationName

Is the name of the operation being reported against.

Is the formal name of a Manufacturing Shop Floor Operation.

OperationPeriod TimePeriod

Is the timeperiod in which the operation ran.

OperationSequence OperationSequenceCode

Is the sequence code of the operation being reported against.

Is the sequence code associated with a operation.

ReasonCode ReasonCode

Is a code that indicates the reason for the event.

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

ReturnedQuantity Quantity

Is the quantity of items returned to inventory.

A decimal value.

ScrapQuantity Quantity

Indicates the quantity of items scrapped.

A decimal value.

ShopFloorControlResource reference
Status reference
StepId StepId

Identifies the step of the operation being reported against.

Uniquily identifies the Step of an Operation. (typically am Manufacturing Operation).

StepType StepType

Indicates the type of step that the WIP Confirm is reporting against.

Identifies the type of step with in an Operation. (typically am Manufacturing Operation).

SuffixId Id

This identifies a sub-component of the Production Order, Job Order, or Work Order, etc. being performed. The sub-component may have been split from the original Order. For Example:An order for 30 widgets, where 20 can be billed as "completed" and the remaining 10 can be moved to a sub-component of the same Order to be finished and billed for at a later time. The sub-component may identify one of many sub-components (each an Order in its own right) that may make up a "master" Order. Kind of a parent/child relationship related collection

Generic identifier type with open qualifyingAgency.

ShopFloorControlResource extends: ShopFloorControlResourceBase
Structure:
Elements:
Name Type Description
ShopFloorControlActivity reference
UserArea reference

ShopFloorControlResourceBase
Structure:
Elements:
Name Type Description
ExecutionPeriod TimePeriod

TimePeriod indicating when the resource executes the operation.

ForecastPeriod TimePeriod

Forecasted start and finishing TimePeriod.

Item reference
Labor reference
LaborPeriod TimePeriod

TimePeriod indicating the labor times.

Machine reference
PrintInd Indicator

Indicates whether or not to print the resource requirements.

Indicates if the semantic name is needed or not.

ReasonCode ReasonCode

Indicates the reason code for the event.

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

ResourceDownPeriod TimePeriod

ResourceDown TimePeriod indicating the starting and finishing datetimes.

ResourceQuantity Quantity

Number or resources needed for the operation.

A decimal value.

SetupPeriod TimePeriod

TimePeriod indicating setup time for the resource.

TearDownPeriod TimePeriod

Timestamp indicating that teardown of the resource.

Tool reference
WorkCenter WorkCenter

Workcenter in which the work is performed.

ShopFloorControlSubLine extends: ShopFloorControlLineBase
Structure:
Elements:
Name Type Description
UserArea reference

WIPConfirm extends: Noun
Structure:
Elements:
Name Type Description
Distribution reference

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

Header reference
Line 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