Occurrence Indicator
|
Description
|
---|---|
None
|
The element must appear once and only once. Neither optional nor repeatable.
|
?
|
The element (or group of elements) may appear zero or one time. The element is optional, but is only allowed to appear once. Optional but not repeatable.
|
+
|
The element (or group of elements) must appear one or more times. The element is required to appear at least once, but multiple consecutive occurrences may be present. Repeatable but not optional.
|
*
|
The element (or group of elements) may appear zero or more times. The element can appear as many times consecutively as needed. Repeatable and optional.
|
Element | Description |
---|---|
ControlData | Always provided. Contains the overall transaction data. |
Part | Optional. The repeatable structure for part data. |
Document | Optional. The repeatable structure for document data. |
DocumentReference | Optional. Document Link structures. DocumentLinks are at the top-level of the CBO because the CBO is intended to be neutral and not specific to a particular distribution target, and there is no consistency in which object, such as part or document, owns the link from one distribution target to another. |
BOM | Optional. The repeatable structure for BOM data. |
ECN | Optional. The repeatable structure for ECN data. |
Resource | The repeatable structure for Resource data. |
Routing | The repeatable structure for process plan references data. |
CBOUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
Class | The object class value for the object being published. For example, com.ptc.windchill.esi.Part |
LastModifiedBy | Optional. Unique identifier of the last user to modify the object. |
ActionFlag | The action to be performed on the object such as create, change, update, delete or unchange. |
Destination | Destination contains TargetNumber and Plant from TargetId. The TargetID of each element in ESIResponse contains values in the format of <<TargetNumber>>:<<Plant>> For a distribution target with no plant the value of TargetID would be <<TargetNumber>>: Where: TargetID represents a distribution target in Windchill and Plant represents a plant in the SAP system. |
Element | Description |
---|---|
ObjectID | A Windchill unique federation identifier for the object that is ready to be published. |
TransactionNumber | The unique identifier for each transaction published from Windchill PDMLink. |
Locale | Locale for the data published from Windchill PDMLink. The locale describes the language in which the data is in as well as the formatting for values within that language. For instance, English in the USA (EN-US) and English in England are in different locales since some of the formatting for dates and measures are different in each locale. |
UserID | Unique identifier for the Windchill PDMLink user who published the data. |
ESITarget | Identifies the target system ESITarget/System is mapped with, with child element destinations coming from the Release/Transaction element of ESIResponse. For SAP the destination format is <SAPSystem ID>.<SAP Client>. For example, PR1.800. The value of ESITarget/ERP is SAP. ESITarget/AdapterInstanceID is the subject name pattern used for customization. For more information on the AdapterInstanceID refer to the section “How to configure a single Process archive for multiple instances” in the 《Windchill Enterprise Systems Integration Customizer's Guide - SAP R/3》. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for part; internal to Windchill PDMLink. |
Part | Unique identifier to be used as part number in the distribution target. This is the number displayed in Windchill PDMLink when the part is being looked at. |
Description | Descriptive text provided with the part. |
UnitOfMeasure | Units in which the part is measured. For example, liter, inches. |
Type | Type of part. For example, finished good, semi-finished. |
Source | Indicates if the part is bought or made internally by the business organization. |
Effectivity | Values used to determine planning. Contains the following sub-elements: StartDate: Date when the part becomes effective within the organization. EndDate : Date when the part effectivity ends. |
Version | The part version. Indicates a major change to the part. Version maps to Part/Version. If Version contains “.” then the first element before the period is considered to be the most significant and is mapped. |
PreviousVersion | The part previous version. Indicates whether the same version was published before or not. This helps to determine whether to publish the version or not. If the version and previous version is same then new version will not be created. If version and previous version are not equal then version gets created in SAP. PreviousVersion maps to Part/PreviousVersion. If PreviousVersion contains “.” then the first element before the period is considered to be the most significant and is mapped. |
ChangeNumber | Value for the Engineering Change Number for creating, deleting, or updating the part. |
CurrentAUMs | Contains the Alternate unit of measure for the Part. For more information, see the section AUM Schema. |
PartUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
ObjectID | Unique Identifier of the Associated Object |
Numerator | Numerator for the Alternate unit of measurement. |
Denominator | Denominator for the Alternate unit of measurement. |
Unit | Unit of measurement. |
AssociatedObjectNumber | Associated Object number |
AssociatedObjectType | Associated Object Type |
Element | Description |
---|---|
Object Header | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the BOM; internal to Windchill PDMLink. |
AssemblyPartNumber | Part number for the BOM header. |
Effectivity | Values used to determine planning. Contains the following subelements: StartDate: Date when the BOM becomes effective within the organization. EndDate : Date when the BOM effectivity ends. |
Version | Current version number of document being published. |
ChangeNumber | Value for the enterprise change notice (CN) for creating, deleting, or updating the BOM. |
Usage | The value is mapped using the cross referencing of BOMHeader/Usage value of ESIResponse. If the cross referenced values is blank then the value of BOMHeader/Usage in ESI Response is mapped. |
Alternate | The value is mapped using cross the referencing of BOMHeader/Alternate value of ESIResponse. This value is cross referenced from ESILookups.properties. If the cross referenced values is blank then the value of BOMHeader/Alternate in ESI Response is mapped. |
Children | Structure containing ChildLinks which detail the children of the BOM. |
Substitutes | Structure containing SubstituteLinks which detail the substitutes of the BOM. |
ReferenceDesignators | Structure containing ReferenceLinks. |
BOMUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the BOM children; internal to Windchill PDMLink. |
ChildPartNumber | Part number for child in the distribution target. |
AssemblyPartNumber | Part number for BOM header in the distribution target. |
AlternateItemGroup | Value in the distribution target which is used to group children with their substitutes. |
Quantity | Number of children on the BOM. |
Unit | Unit of Measurement. |
LineNumber | Value, which when used, allows the same part to be on multiple lines of a BOM, as long as the multiple lines have different LineNumbers. |
OldLineNumber | If the element DeletedSubstitutes/substitute exists in the response then the element DeletedSubstitutes/substitute/LineNumber is mapped to OldLineNumber. |
ChildLinkUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the BOM children; internal to Windchill PDMLink. |
ChildPartNumber | Part number for the child in the distribution target. |
AssemblyPartNumber | Part number for the BOM header in the distribution target. |
SubstitutePartNumber | Part number for the substitute in the distribution target. |
AlternateItemGroup | The value in the distribution target used to group children with their substitutes. |
Quantity | Number of children on the BOM. |
LineNumber | The value, when used, allows the same part to be on multiple lines of a BOM as long as the multiple lines have different LineNumbers. |
OldLineNumber | If the element DeletedSubstitutes/substitute exists in the response then the element DeletedSubstitutes/substitute/LineNumber is mapped to OldLineNumber. |
SubstituteLinkUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the CN; internal to Windchill PDMLink. |
ChangeNumber | The CN identifier in the distribution target. |
Description | Text describing the change. |
ReasonForChange | Text describing the reason for the change. |
ECNUserArea | Optional. Stores all user-defined data used for customization. |
As delivered, standard Windchill ESI does not support the publication of documents from Windchill PDMLink to Oracle Applications and does not map the Document portion of the CBO to Oracle Applications. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the alternate part; internal to Windchill PDMLink. |
DocumentNumber | The document number displayed in Windchill PDMLink and the unique ID number for the distribution target. |
Type | The type of document. For example, techDesign. |
Name | Text to appear as name of the document instead of a weblink or file name. |
File | File location; usually a web address. |
Version | Current version number of document being published. |
PreviousVersion | Previous version number of document being published. |
Effectivity | Values used to determine planning. Contains the following subelements: StartDate: Date when the document becomes effective within the organization. EndDate : Date when the document effectivity ends. |
ChangeNumber | Value for the engineer change notice (CN) for creating, deleting, or updating the document. |
DocumentUserArea | Optional. Stores all user-defined data used for customization. |
As delivered, standard Windchill ESI does not support the publication of documents from Windchill PDMLink to Oracle Applications and does not map the Document portion of the CBO to Oracle Applications. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the document link; internal to Windchill PDMLink. |
AssociatedObjectNumber | The number for the business object in the distribution target to which the document is being linked. |
AssociatedObjectClass | The class of the business object in the distribution target to which the document is being linked. |
DocumentNumber | Identifier for the document in the distribution target. |
DocumentVersion | Version for the document in the distribution target. |
DocumentLinkUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plans; internal to Windchill MPMLink. |
Version | Process Plan (Routing in SAP) revision. Does not map in SAP. |
ProcessPlanNumber | Process Plan Number. Maps to Group Number of Routing in SAP. |
GroupCounter | In SAP to duplicate a group number you must have a unique group counter. For example for each plant group the numbers will be the same. TIBCO generates a unique group counter for each plant so that Windchill MPMLink process plans can be published to more than one plant. |
ChangeNumber | Value for the enterprise change notice (CN) for creating or updating the Process Plan. |
IsStandard | By default set to false. If set to true then becomes a Standard Process Plan that can be referred to from other Process Plan. |
ComponentAllocation | The operation's BOM allocated part. Maps to component allocation inside the operation. |
MaterialTaskAllocation | Contains the Process plan and its' Part allocation link details. |
Operations | Contains the operations of a process plan. This operation contains sequence operations or operations in a standard sequence. |
ProducResources | Contains details about the associations between Operations in a Process Plan and the associated consumable resources in a Process Plan. |
Sequences | Contains the sequences in a process plan. |
SubOperations | Contains SubOperation for the operation in a Process plan. |
Tasks | Contains Process Plan header information. |
RoutingUserArea | Optional. Stores all user-defined data used in customizations. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan; Internal to Windchill MPMLink. |
ValidFrom | Process Plan's (Routing in SAP) start effective date. In SAP it goes to alternate date's valid from date in ECN and Routing object gets assigned this Alternate date in ECN. |
ValidToDate | Process plan's end effectivity date. Not mapped in SAP. |
TaskListUsage | In SAP it is must to have Task List usage for Routing. It is cross-referenced from ESILookups.properties based on Process Plan category. |
TaskListStatus | In SAP it is must to have Task List status for Routing. It is defaulted from ESIDefaults.properties. |
TaskMeasureUnit | Process plan's base unit of measure. |
LotSizeFrom | Process Plan From lot size |
Description | Description of the process plan |
RoutingTaskUserArea | Optional. Stores all user-defined data used in customizations. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan Sequence; Internal to Windchill MPMLink. |
SequenceNumber | Sequence line number defined on the sequence. It maps to Sequence Number in SAP. |
WNC_Sequence | Sequence Number in Windchill Process plan. Does not map in SAP. Here it is taken for filter purpose. |
ValidFrom | Sequence Start Effectivity date. Does not map in SAP. Note: Process Plan's (Routing in SAP) start effective date. In SAP it goes to alternate date's valid from date in ECN and Routing object gets assigned this Alternate date in ECN. |
ValidToDate | Sequences’s end effectivity. It does not map in SAP. |
SequenceCategory | Category of Sequence. Cross references from ESILookups.properties based on the category of sequence in Windchill Process plan. It decides whether to have alternate or parallel sequence. |
ReferenceSequence | Defaulted from ESIDefaults.properties. It is always "000000". |
Description | Sequence name. |
TaskMeasureUnit | Cross referenced from ESILookups.properties for Unit of measurement of sequence in Windchill Process Plan. |
BranchOperation | Branching operation defined for the sequence |
ReturnOperation | Return Operation defined for the sequence |
RoutingSequenceUserArea | Optional. Stores all user-defined data used in customizations. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan; Internal to Windchill MPMLink. |
Material | Material number. |
Usage | BOM usage of the Assembly of the component. |
Alternate | BOM alternate of the Assembly of the component. |
RoutingComponentAllocationUserArea | Optional. Stores all user-defined data used for customization. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan Operation; Internal to Windchill MPMLink. |
SequenceNo | Sequence line number defined for the sequence of Process plan. In SAP it maps to sequence number of the Routing sequence. For the operation of standard sequence it is defaulted to "000000" |
HolderNo | Process plan number for operation in standard sequence. Sequence number for operation in sequence. Operation number for sub operation. For internal filter purpose. |
Category | To determine whether this is operation in standard sequence or sub operation or sequence operation. For internal filter purpose. |
Activity | Operation label of the Operation. In SAP it maps to Operation/Activity |
OldActivity | Old Operation label of the Operation. Used to identify the operation label change. |
OperationId | Unique identifier for the Operation, that is operation number. Internal to Windchill MPMLink. In CBO it maps for internal filtering purposes. |
ControlKey | ERP Validation code. Cross referenced in ESILookups.properties file based on ERPValidation code in Operation. |
WorkCntr | Work center value specified for the work center associated with the Operation. |
Plant | Plant of the associated work-center or process plan. |
Description | Description of the Operation |
OperationMeasureUnit | Cross-reference for Operation unit of measure. |
Denominator | 1 |
Nominator | 1 |
BaseQuantity | Quantity mentioned in operation. |
StdValue01 | Set upTime defined on the operation |
StdUnit01 | Unit of measure of SetupTime defined on the operation |
StdValue02 | ProcessingTime defined on the Operation. |
StdUnit02 | Unit of measure of ProcessingTime defined on the Operation |
StdValue03 | LaborTime defined on the operation |
StdUnit03 | Unit of Measure LaborTime defined on the operation |
MaxWaitTime | WaitingTime defined on the operation |
MaxWaitTime Unit | Unit of WaitingTime defined on the operation |
StandardQueue Time | QueueTime defined on the operation |
StandardQueue TimeUnit | QueueTime defined on the operation |
StandardMove Time | MoveTime defined on the operation |
StandardMove TimeUnit | Unit of MoveTime defined on the operation |
RoutingOperationUserArea | Optional. Stores all user-defined data used in customizations. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan Sub Operation; Internal to Windchill MPMLink. |
SequenceNo | Sequence Line Number of the Sequence. Under which the operation and it's sub operation is defined. |
HolderNo | Parent Operation Number for which the Sub operation defined. |
ValidFrom | Sub-operation Start Effectivity date. It does not map to SAP. Note: Process Plan's (Routing in SAP) start effective date. In SAP it goes to alternate date's valid from date in ECN and Routing object gets assigned this Alternate date in ECN. |
ValidToDate | Process plan's end effectivity date. Not mapped in SAP. |
SubActivity | Operation label of the sub operation. It maps to SubOperation/Activity of suboperation in SAP Routing. |
SubOperationId | Unique identifier for the Sub Operation, that is sub operation number. Internal to Windchill MPMLink. In CBO it maps for internal filter purpose. |
Activity | Parent Operation's Operation Label which maps to Operation/Activity of the Sub operation in SAP Routing. |
OperationId | Unique identifier for the Parent Operation of sub operation, that is operation number. Internal to Windchill MPMLink. In CBO it maps for internal filter purpose. |
ControlKey | ERP Validation code. Cross referenced in ESILookups.properties file based on ERPValidation code in sub Operation. |
WorkCntr | Work center value specified for the work center associated with the sub Operation. |
Plant | Plant of the associated work-center or process plan. |
Description | Description of the sub Operation |
OperationMeasureUnit | Cross-reference for sub Operation unit of measure. |
Denominator | 1 |
Nominator | 1 |
BaseQuantity | Quantity mentioned in operation. |
StdValue01 | Set upTime defined on the operation |
StdUnit01 | Unit of measure of SetupTime defined on the operation |
StdValue02 | ProcessingTime defined on the Operation. |
StdUnit02 | Unit of measure of ProcessingTime defined on the Operation |
StdValue03 | LaborTime defined on the operation |
StdUnit03 | Unit of Measure LaborTime defined on the operation |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan Consumable Resource like Process Material, Tooling, document; Internal to Windchill MPMLink. |
ChangeNumber | Value for the enterprise change notice (CN) for creating, updating the Process Plan. |
SequenceNumber | Sequence line number of the associated Operation's sequence. In case of operation is from standard sequence it is "000000" |
ValidFrom | Production Resource Start Effectivity date. It does not map to SAP. Note: Process Plan's (Routing in SAP) start effective date. In SAP it goes to alternate date's valid from date in ECN and Routing object gets assigned this Alternate date in ECN. |
ValidToDate | Process plan's end effectivity date. Not mapped in SAP. |
Activity | Associated operation's operation label |
OperationId | Associated Operation number. Does not map to SAP. Internal filter purpose. |
ItemNoOfProductionResource | Allocation number in case of consumable resources allocation. |
CtrlKey | Default value for Resource allocation from ESIDefaults.properties file. |
StdValueForPrtQty | Associated operation's quantity attribute. |
Description | Resource number in case of consumable resources. |
PrtCategory | It is decided based on type and category of associated consumable resource to operation. Cross referenced from ESILookups.properties based on type and category. In case of Document/work instructions associated to operation, PrtCategory becomes 'D'. |
PrtPlant | Process plan Plant |
Material | In case of Process Material as consumable resource then Resource number becomes Material. |
DocumentType | In case of Document/work instructions associated to operation, it is document type from document link. It gets cross referenced from ESILookup.prioperties |
DocumentNumber | In case of Document/work instructions associated to operation, it is document number from document. |
DocumentPart | Cross referenced from ESILookups.properties in case of document/work instructions associated with operation. |
DocumentVersion | In case of Document/work instructions associated to operation, it is document number from document. |
Equipment | Checks using Cross referenced based on the category of associated consumable resource if it is equipment then Resource number maps to equipment. |
RoutingProductionResourceUserArea | Optional. Stores all user-defined data used in customizations. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Process Plan OprBomAllocatedParts link; Internal to Windchill MPMLink. |
ChangeNumber | Same as BOM schema |
TaskListGroup | Process plan number. TaskListGroup is group the group number in SAP. |
GroupCounter | In SAP to duplicate a group number you must have a unique group counter. For example for each plant group the numbers will be the same. TIBCO generates a unique group counter for each plant so that Windchill MPMLink process plans can be published to more than one process plan. |
SequenceNo | Associated operation's sequence line number. |
ValidFrom | Process Plan's (Routing in SAP) start effective date. In SAP it goes to alternate date's valid from date in ECN and Routing object gets assigned this Alternate date in ECN. |
ValidToDate | Process plan's end effectivity date. Not mapped in SAP. |
Activity | Associated Operation's Operation Label. |
OperationID | Associated Operation's Operation number. Internal to Windchill. Here it is used for filtering purposes. |
BomType | BOM type of the BOM header. BOM header will be considered the Material, which is associated to the process plan. |
CompOty | Associated component quantity |
CompUnit | Associated component unit of measure |
Plant | Process Plan Plant |
Material | Component number |
RoutingComponentAllocationUserArea | "Optional. Stores all user-defined data used in customizations. |
Element | Description |
---|---|
ObjectHeader | The system information for the current object. For more information, see Common Business Object Schema: Object Header. |
WCID | Unique identifier for the Resource; Internal to Windchill MPMLink. |
ResourceNumber | Resource Number maps to Material Number of type PRT or Equipment Number of Equipment. |
ResourceType | Type of Resource. For example, material or equipment. |
CategoryType | Category of Resource. Based on the category that is obtained from the file ESILookups.properties by cross referencing, the resource is published to SAP either as a PRT material or as an equipment. Out of the box, if the value fetched for category is Tool, the resource is published as a PRT material; if the value is Fixture, it is published as an equipment. |
Description | Name of resource. |
UnitOfMeasure | Default Unit of Resource. |
Source | Source of Resource. It maps to SAP as PROC_TYPE. It gets cross referenced from ESILookups.properties based on Source value of Resource. |
Effectivity | Values used to determine planning. Contains the following sub-elements: StartDate Date when the part becomes effective within the organization. EndDate Date when the part effectivity ends. Does not map in SAP. |
Version | Version of Process Material. It maps to the revision level of Material in SAP. |
ChangeNumber | Value for the Engineering Change Number for creating, deleting, or updating the part. |
Alternates | Contains data on alternate Resource, which can be used if the current resource is out of stock. |
CurrentAUM | Contains the Alternate unit of measure for the resource. See Current AUM schema for details. |
ResourceUserArea | Optional. Stores all user-defined data used in customizations. |