Customization Points
Extendable classes
If the renderer classes described in the Publishing Process Plans section of this document are extended, the extensions must be defined in the ESI service properties file. The following classes are designed to be extended by customizers:
• ESIProcessPlanRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”PROCESSPLAN” serviceClass=”com.ptc.windchill.esi.mpml.processplan.ESIProcessPlanRenderer”
• ESIProcessPlanHeaderRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”PROCESSPLANHEADER” serviceClass=”com.ptc.windchill.esi.mpml.processplan.ESIProcessPlanHe aderRenderer”
• ESIPartToProcessPlanLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”PROCESSPLANPARTLINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.ESIPartToProcess PlanLinkRenderer”
• ESIOperationUsageLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”OPERATIONUSAGELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOper ationUsageLinkRenderer”
• ESISequenceUsageLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”SEQUENCEUSAGELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.sequence.ESISequ enceUsageLinkRenderer”
• ESISequenceRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”SEQUENCE” serviceClass=”com.ptc.windchill.esi.mpml.processplan.sequence.ESISequenceRenderer”
• ESIOperationRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”OPERATION” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationRenderer”
• ESIOperationToPartLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.operation.MPMOperatio n” selector=”OPRBOMALLOCATEDPART” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationToPartLinkR enderer”
• ESIOperatedOnPartLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=” com.ptc.windchill.mpml.processplan.operation.MPMOperation” selector=”OPROPERATEDONPART” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOper atedOnPartLinkRenderer”
• ESIOperationWorkCenterRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.operation.MPMOperatio n” selector=”WORKCENTERLINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationWorkCenter Renderer”
• ESIOperationConsumableResourceRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.operation.MPMOperatio n” selector=”CONSUMABLERESOURCELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationConsumable ResourceRenderer”
• ESIOperationUsageLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.operation.MPMOperatio n” selector=”OPERATIONUSAGELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationUsageLinkRe nderer”
• ESIOperationRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.operation.MPMOperatio n” selector=”OPERATION” serviceClass=”com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationRenderer”
• ESIStandardProcedureLinkRenderer (For Process Plan)
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.MPMProcessPlan” selector=”STANDARDPROCEDURELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.ESIStandardProcedureLinkRenderer”
• ESIStandardProcedureLinkRenderer (For Operation)
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.operation.MPMOperatio n” selector=”STANDARDPROCEDURELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.ESIStandardProcedureLinkRenderer”
• ESIStandardProcedureLinkRenderer (For Sequence)
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.processplan.sequence.MPMSequence” selector=”STANDARDPROCEDURELINK” serviceClass=”com.ptc.windchill.esi.mpml.processplan.ESIStandardProcedureLinkRenderer”
• ESIAlternateUnitOfMeasureRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate”requestor=”java.lang.Object” selector=”AUM”serviceClass=”com.ptc.windchill.esi.aum.ESIAlternateUnitOfMeasureRenderer”
• ESIControlCharacteristicRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=”duplicate” requestor=”java.lang.Object”selector=” CONTROLCHARACTERISTIC” serviceClass=”com.ptc.windchill.esi.mpml.pmi.ESIControlCharacteristic Renderer”
• ESIQualityLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=”duplicate” requestor=”java.lang.Object” selector=” QUALITYLINK” serviceClass=”com.ptc.windchill.esi.mpml.pmi.ESIQualityLinkRenderer”
 |
The classes ESIControlCharacteristicRenderer and ESIQualityLinkRenderer are used for rendering the control characteristics associated to a process plan (and to its operations) and the corresponding model items and quality links. Also, an ESIStandardCCLinkRenderer instance is used for rendering standard control characteristic links that associate a process plan or an operation to a standard control characteristic.
|
Configurable Options
Preferences and Target attributes based configuration
Windchill ESI preferences control several configurable options that play a role in the publication of a process plan and its associated objects. The options are:
• Defines the release class attribute on the release activity object that is created for the process plan being published.
Preference name: Process Plan Release Class
Default value: com.ptc.windchill.esi.mpml.ProcessPlan
• Defines the lifecycle state values at which publication of a process plan will be triggered.
Preference name: Process Plan Configuration Specification State
Default value: RELEASED
• Defines the fully qualified name of the Java class that represents a process plan.
Preference name: Process Plan Class
Default value: com.ptc.windchill.mpml.processplan.MPMProcessPlan
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the process plan being published.
Preference name: Query Process Plan Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the fully qualified name of the Java class that represents a process plan master.
Preference name: Process Plan Master Class
Default value: com.ptc.windchill.mpml.processplan.MPMProcessPlanMaster
• Defines the name of the release class for a process plan.
Preference name: Process Plan Release Class
Default value: com.ptc.windchill.esi.mpml.ProcessPlan
• Defines the allocation type values for setting negative quantity.
Preference name: Allocation Types
Default value: produced, disassembled, destroyed
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the operation being published.
Preference name: Query Operation Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the release class for an operation.
Preference name: Operation Release Class
Default value: com.ptc.windchill.esi.mpml.Operation
• Defines the fully qualified name of the Java class that represents an operation master.
Preference name: Operation Master Class
Default value: com.ptc.windchill.mpml.processplan.operation.MPMOperationMaster
• Defines whether to throw an exception when no qualifying version was found for a part or (an operation) master.
Preference name: Show No Qualifying Version Found Error
Default value: Yes
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the link that exists between a process plan and a part.
Preference name: Query Part Link Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the sequence being published.
Preference name: Query Sequence Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the release class for a sequence.
Preference name: Sequence Release Class
Default value: com.ptc.windchill.esi.mpml.Sequence
• Defines the fully qualified name of the Java class that represents a sequence master.
Preference name: Sequence Master Class
Default value: com.ptc.windchill.mpml.processplan.sequence.MPMSequenceMaster
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the link that exists between an operation and a consumable resource.
Preference name: Query Operation Consumable Resource Link Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the link that exists between an operation and a work center.
Preference name: Query Operation Work Center Link Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the link that exists between an operation and a BOM allocated part.
Preference name: Query Operation Part Link Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the link that exists between an operation and an operated on part.
Preference name: Query Operated On Part Link Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the link that exists between a standard procedure holder and a standard procedure.
Preference name: Query Standard Procedure Link Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Specifies whether or not ESI services should ignore control characteristics that are no longer associated to their owners but are being consumed by operations in a process plan. When set to No, ESI services will throw an exception (thereby aborting the response generation) when the process plan being published has an operation consuming a control characteristic that is no longer associated to its owner. When set to Yes, such control characteristics (and the associated quality links and model items) will be ignored.
Preference name: Ignore Orphaned Control Characteristics
Default value: No
There are several configurable attributes on the distribution target that impact the contents of the ESI response message when publishing a process plan.
For more information, see Attributes Pertaining to a Process Plan.
Change Object Comparison to Consider additional attributes.
Process Plan related object during publication process uses object comparison to calculate incremental changes for ESIresponse. This comparison logic can be configured for various attributes which are added by customizers on the MPMLink object.
Steps
1. Open object comparison configuration used for MPMLink objects from following file using XML or text file editor.
2. Update object specific configuration to add attributes to be considered for finding incremental changes.
Example: Add custom attributes say CustomAttr1, CustomAttr2 to consider incremental changes for MPMOperationToConsumableLink
<type id="com.ptc.windchill.mpml.processplan.operation.MPMOperationToConsumableLi nk" comparator="default" assembly="mpml">
<attrs comparator="default">
<ids>description,usageRate,stepUsageRate1,stepUsageRate2,stepUsageRate3,stepUs ageRate4,stepUsageRate5,stepUsageRate6,stepUsageRate7,stepUsageRate8,schedule d,CustomAttr1,CustomAttr2</ids>
</attrs>
<role comparator="default">references</role>
<roleTargetsToCompare/>
</type>
<attrs comparator="default">
<ids>description,usageRate,stepUsageRate1,stepUsageRate2,stepUsageRate3,stepUs ageRate4,stepUsageRate5,stepUsageRate6,stepUsageRate7,stepUsageRate8,schedule d,CustomAttr1,CustomAttr2</ids>
</attrs>
<role comparator="default">references</role>
<roleTargetsToCompare/>
</type>
Similarly customizer can modify this for attributes on other objects.
3. Save the file.
4. Restart Windchill services.