GetEngineeringChangeDocument schema, example, validation rules, validation stylesheet

GetEngineeringChangeDocument type: GetEngineeringChangeDocument

The purpose of the Get EngineeringChangeDocument is to communicate to a business application module or system the need to request a Show EngineeringChangeDocument for the Engineering Change Document specified in the Message. This BOD may be necessary to address the Make to Order, Assemble to Order, or Mixed Mode business ordering scenarios in a Order Management to Manufacturing application integration scenario. There are many possible business applications in several environments that may use this capability. For example, a PDM, MRP, Inventory, or Manufacturing business application could use this to communicate the requirement to synchronize a Engineering Change Document.

GetEngineeringChangeDocument extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetEngineeringChangeDocumentDataArea

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

GetEngineeringChangeDocumentDataArea extends: DataArea
Structure:
Elements:
Name Type Description
EngineeringChangeDocument reference
Get reference

GetEngineeringChangeDocument 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

EngineeringChangeDocument schema

EngineeringChangeDocument type: EngineeringChangeDocument

An EngineeringChangeDocument can be used to request a change to an manufactured item. This document allows the Change to progress through the different states from being a request and going through the review process to becoming an approved EngineeringChangeOrder.

RevisedRouteOperation type: RevisedRouteOperation

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

Reviewer type: Employee

Identifies the Reviewer of the EngineeringChangeDocument.

RevisedBOMComponent type: RevisedBOMComponent

Describes any Bill of Material that may be impacted by a given Engineering Change

RevisedItemRevision type: RevisedItemRevision

RevisedSubstitute type: RevisedSubstitute

Describes the changes to valid substitution that can be made for any Bill of Material Component.

RevisedReferenceDesignator type: RevisedReferenceDesignator

Describes the Location on the Drawing or Blueprint that the Bill of Material Component item is used.

Header type: EngineeringChangeDocHeader

Engineering Change Header information.

EngineeringChangeRevision type: EngineeringChangeRevision

Engineering Change Revision information.

EngineeringChangeReviewer type: EngineeringChangeReview

Describes the reviewers of the engineering change. It is these peoples responsiblity to either approve or reject the engineering change document.

RevisedBOM type: RevisedBOM

Describes the components of a Bill of Material that will be effected by a given engineering Change.

RevisedRouteHeader type: RevisedRouteHeader

Information that generally describes the routing.

EngineeringChangeDocHeader

This information applies to the entire Engineering Change Document.

Structure:
Elements:
Name Type Description
ApprovalDate DateTimeAny

Is the date in which the order is approved.

ApprovalRequiredByDate DateTimeAny
Description Description

Free-form Description of teh Engineering Change 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..

DocumentId GenericIdType

Is the Engineering Change Document Identifier. The revision here allows for different revisions ot this document. While the EngineeringChangeRevision Component allows a revision to be discussed and modified as need with in a single document and revision.

EngineeringChangeReviewer reference
EngineeringChangeRevision reference
EstimatedEngineeringCost Amount

The esitmated cost to engineering to make the proposed change.

Simple content with the currency as an attrbute

EstimatedManufacturingCost Amount

The estimated cost to manufacturing to make the proposed change.

Simple content with the currency as an attrbute

ImplementationDateTime DateTime

Is the date on which the changes will be implemented,

Note Note

Free form Note on the Engineering Change Document. These can be used by the reviewers to provide comments about the Engineering Change Document.

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.

Priority Priority

Indicates the Priority in which the Engineering Change should receive.

Requester Someone

Identifies who requested the change. Often times an end user may indicate the need to change an item. This request must be approved by an employee of the company. In these instances there may be multiple requesters.

Site reference
Status reference
UserArea reference
UserId Id

Generic identifier type with open qualifyingAgency.

EngineeringChangeDocument extends: Noun

Is the Engineering Change Document.

Structure:
Elements:
Name Type Description
Attachments reference
Header reference
RevisedBOM reference
RevisedRouteHeader reference

EngineeringChangeReview
Structure:
Elements:
Name Type Description
ApprovalEffectivePeriod TimePeriodAny

Identifies the time period in which the approval is valid.

Description Description

Description of EngineeringChangeAppover.

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

Note Note

Free-form note from the EngineeringChange Approver about the Engineering Change.

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.

Reviewer reference
Status reference
UserArea reference

EngineeringChangeRevision
Structure:
Elements:
Name Type Description
ApprovalDateTime DateTime

Timestamp indicating when the revision was approved.

CreationDateTime DateTime

Is the timestamp for when the revision was created.

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

Note Note

Free-form Note or comments about the revision.

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.

ProposedBy Someone

Identifies who proposed this revision. This maybe someone with in the company or from someone in the companies Supply Chain.

RejectedDateTime DateTime

Timestamp indicating when the revision was rejected.

Revision Revision

Is the unique revision number of the Engineering Change Document. This allows for different options to be proposed for the change.

Is the revision code that can be associated with an Item, an order, a Bill of Material. The revision code indicates that the say item has been modified or updated in some way.

Site reference
UserArea reference

RevisedBOM
Structure:
Elements:
Name Type Description
BOMDocumentReference reference
CancelDateTime DateTime

Is the date and tme in which the Bill-Of-Material was canceled.

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

Disposition reference

Determines the receipt routing of an item or part. Examples of values include: Customer consignment Inspection Vendor consignment Blocked Bonded User defined SYNONYMS Receipt Routing Material Status Material Condition Code

EffectiveDateTime DateTime

Is the datetime when the Bill-Of-Material becomes effective

ImplementationDateTime DateTime

Is the timestamp in which the revised Bill-Of-Material.

IncludeInPlanInd Indicator

Indicates whether the MRP planning process should plan for an ECO revised item. This lets you order material and plan resources that you need to build a future revision in advance.

Indicates if the semantic name is needed or not.

InMRPPlanInd Indicator

Indicates that the changed BOM is in the MRP system plan or not.

Indicates if the semantic name is needed or not.

NewItemRevision Revision

Is the new revision code for an ITEM. The revision code is commonly used to indicate engineering changes to the item or product.

Is the revision code that can be associated with an Item, an order, a Bill of Material. The revision code indicates that the say item has been modified or updated in some way.

NewRevisionInd Indicator

Is used to indicate that whether this change represents a new revision on the BOM.

Indicates if the semantic name is needed or not.

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.

OldItemRevision Revision

Is the old revision code for an ITEM. The revision code is commonly used to indicate engineering changes to the item or product.

Is the revision code that can be associated with an Item, an order, a Bill of Material. The revision code indicates that the say item has been modified or updated in some way.

RevisedBOMComponent reference
RevisedItemStatus Status

Is a classification you can use to track and control a revised item's life cycle. Revised item statuses include Open, Released, Scheduled, Hold, Implemented and Cancelled.

Site reference
UpdateWIPInd Indicator

Indicate whether to update WIP requirements for unreleased jobs or schedules when the revised item is implemented.

Indicates if the semantic name is needed or not.

UserArea reference
UseUpInventoryInd Indicator

Indicates whether it is possible to use up the existing inventory before replaceing with items for the new revision of the BOM and resulting Item.

Indicates if the semantic name is needed or not.

UseUpItemId ItemIdType

Is a revised component whose MRP-planned order date and lead time offset determine the effective date of the revised item. Indicates the component or raw-material that is to be used up before the new component or raw-material can be used.

RevisedBOMComponent
Structure:
Elements:
Name Type Description
EffectivePeriod TimePeriod

Indicates when this Component item is effective.

ImplementationDateTime DateTime

Is the Implementation Date of this change.

Item reference

Identifies the Item in the BOM.

OperationSequence OperationSequenceCode

Is the operation sequence code for the item.

Is the sequence code associated with a operation.

RevisedItemRevision reference
RevisedReferenceDesignator reference
RevisedSubstitute reference
UserArea reference

RevisedItemRevision
Structure:
Elements:
Name Type Description
EffectivePeriod TimePeriod

Is the effective time period of the change.

ImplementationDateTime DateTime

is the timestamp that the revision will be made.

Item reference

Identifies the item record of the proposed change.

OperationSequence OperationSequenceCode

Is the operation sequence code of where the change is being made.

Is the sequence code associated with a operation.

UserArea reference

RevisedReferenceDesignator

Describes the Location on the Drawing or Blueprint that the Bill of Material Component item is used.

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

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.

ReferenceDesignatorId Id

Is the reference designator on a Drawing or BluePrint where the BOM is used.

Generic identifier type with open qualifyingAgency.

UserArea reference

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

EffectivePeriod TimePeriod

The effective time period of the Routing being referenced.

ImplementationDateTime DateTime

The implementation date of the Route being referenced.

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.

RevisedRouteOperation reference
RouteDocumentReference reference

Identifies the Routing

UserArea reference

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

EffectivePeriod TimePeriod

Effective Time Period of the revised operation.

ImplementationDateTime DateTime

Date and time in which the operation is implemented.

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.

OperationReference reference
UserArea reference

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

EffectivePeriod TimePeriod

Is the effective time period for the subsittiution.

Item reference

Is the Revised Substitute Item.

ItemQuantity Quantity

Number of Items.

A decimal value.

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.

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