Customization Points
Extendable classes
If the renderer classes described in the Publishing Resources 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:
• ESIResourceRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”java.lang.Object” selector=”RESOURCE” serviceClass=” com.ptc.windchill.esi.mpml.resource.ESIResourceRenderer”
• ESIProcessMaterialRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.resource.MPMProcessMaterial” selector=”PROCESSMATERIAL” serviceClass=”com.ptc.windchill.esi.mpml.resource.ESIProcessMaterialRenderer”
• ESIToolingRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.resource.MPMTooling” selector=”TOOLING” serviceClass=”com.ptc.windchill.esi.mpml.resource. ESIToolingRenderer”
• ESISkillRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=”com.ptc.windchill.mpml.resource.MPMSkill” selector=”SKILL” serviceClass=”com.ptc.windchill.esi.mpml.resource.ESISkillRenderer”
• ESIPlantStructureRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=“java.lang.Object” selector=“PLANT” serviceClass=“com.ptc.windchill.esi.mpml.resource.ESIPlantStructureRenderer”
• ESIResourceGroupStructureRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=“java.lang.Object” selector=“RESOURCEGROUP” serviceClass=“com.ptc.windchill.esi.mpml.resource.ESIResourceGroupStructureRenderer”
• ESIWorkCenterRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=“java.lang.Object” selector=“WORKCENTER” serviceClass=“com.ptc.windchill.esi.mpml.resource.ESIWorkCenterRenderer”
• ESIResourceUsageLinkRenderer
Service Property name: com.ptc.windchill.esi.rnd.ESIRenderer
Default values of attributes of the <Option> element: cardinality=“duplicate” requestor=“java.lang.Object”selector=“RESOURCEUSAGELINK”serviceClass=“com.ptc.windchill.esi.mpml.resource.ESIResourceUsageLinkRendere”
• 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”
Configurable Options
Windchill ESI preferences control several configurable options that play a role in the publication of a resource and its associated objects. The options are:
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the tooling being published.
Preference name: Query Tooling Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the release class attribute on the release activity object that is created for the tooling being published.
Preference name: Tooling Release Class
Default value: com.ptc.windchill.esi.mpml.Tooling
• Defines the fully qualified name of the Java class that represents a tooling.
Preference name: Tooling Class
Default value: com.ptc.windchill.mpml.resource.MPMTooling
• Defines the fully qualified name of the Java class that represents a tooling master.
Preference name: Tooling Master Class
Default value: com.ptc.windchill.mpml.resource.MPMToolingMaster
• Defines the lifecycle state values at which publication of a tooling will be triggered.
Preference name: Tooling Configuration Specification State
Default value: RELEASED
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the process material being published.
Preference name: Query Process Material Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the release class attribute on the release activity object that is created for the process material being published.
Preference name: Process Material Release Class
Default value: com.ptc.windchill.esi.mpml.ProcessMaterial
• Defines the fully qualified name of the Java class that represents a process material.
Preference name: Process Material Class
Default value: com.ptc.windchill.mpml.resource.MPMProcessMaterial
• Defines the fully qualified name of the Java class that represents a process material master.
Preference name: Process Material Master Class
Default value: com.ptc.windchill.mpml.resource.MPMProcessMaterialMaster
• Defines the lifecycle state values at which publication of a process material will be triggered.
Preference name: Process Material Configuration Specification State
Default value: RELEASED
• Defines the name of the I*E task to be used for querying the Windchill database for attributes on the skill being published.
Preference name: Query Skill Task
Default value: com/ptc/windchill/esi/QueryObject.xml
• Defines the name of the release class for a skill.
Preference name: Skill Release Class
Default value: com.ptc.windchill.esi.mpml.Skill
• Defines the fully qualified name of the Java class that represents a skill.
Preference name: Skill Class
Default value: com.ptc.windchill.mpml.resource.MPMSkill
• Defines the fully qualified name of the Java class that represents a skill master.
Preference name: Skill Master Class
Default value: com.ptc.windchill.mpml.resource.MPMSkillMaster
• Defines the lifecycle state values at which publication of a skill will be triggered.
Preference name: Skill Configuration Specification State
Default value: RELEASED
For more information on publishing resource structure, see the following sections for the respective objects in topic Distribution Target Attributes.
• Attributes Pertaining to a Change Notice
• Attributes Pertaining to a BOM
• Attributes Pertaining to a Process Plan
• Attributes Pertaining to a Manufacturing Resource
See the Other Configurable Attributes section of the Windchill Enterprise Systems Integration Installation and Configuration Guide – SAP for information on these attributes.
Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response.
Steps to configure:
1. Update ESI ResponseMetaInfo.xml for rendering EnterpriseData object separately. Refer to the section Modify the ESI Response Meta Information File in this guide for more information on how to modify this file.
2. Out of the box code has two maps added. For example - EnterpriseData object types viz. ‘Common Enterprise Data’ and ‘View Specific Enterprise Data’ as ESICommonEnterpriseData and ESIPlantSpecificEnterpriseData. User can create map object for the types as required similar to other objects.
<!-- ESI Common Enterprise Data Mapping -->
<esi:Map id="ESICommonEnterpriseDataEx1">
<esi:attributeMapping sourceAttribute="obid">ObjectID</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="xxxx" defaultValue="com.ptc.windchill.esi.CommonEnterpriseData">Class</esi
:attributeMapping>
<esi:attributeMapping sourceAttribute="versionInfo.identifier.versionId">Version</esi:attr ibuteMapping>
<esi:attributeMapping sourceAttribute="iterationInfo.identifier.iterationId">Iteration</es i:attributeMapping>
<esi:attributeMapping sourceAttribute="PreviousVersion">PreviousVersion</esi:attributeMapp ing>
<esi:attributeMapping sourceAttribute="MaterialGroup">MaterialGroup</esi:attributeMapping>
</esi:Map>
<!-- ESI Plant Specific Enterprise Data Mapping -->
<esi:Map id="ESIPlantSpecificEnterpriseDataEx1">
<esi:attributeMapping sourceAttribute="obid">ObjectID</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="xxxx" defaultValue="com.ptc.windchill.esi.PlantSpecificEnterpriseData">Cla ss</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="view">View</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="StorageLocation">StorageLocation</esi:attributeMapp ing>
</esi:Map>
<esi:Map id="ESICommonEnterpriseDataEx1">
<esi:attributeMapping sourceAttribute="obid">ObjectID</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="xxxx" defaultValue="com.ptc.windchill.esi.CommonEnterpriseData">Class</esi
:attributeMapping>
<esi:attributeMapping sourceAttribute="versionInfo.identifier.versionId">Version</esi:attr ibuteMapping>
<esi:attributeMapping sourceAttribute="iterationInfo.identifier.iterationId">Iteration</es i:attributeMapping>
<esi:attributeMapping sourceAttribute="PreviousVersion">PreviousVersion</esi:attributeMapp ing>
<esi:attributeMapping sourceAttribute="MaterialGroup">MaterialGroup</esi:attributeMapping>
</esi:Map>
<!-- ESI Plant Specific Enterprise Data Mapping -->
<esi:Map id="ESIPlantSpecificEnterpriseDataEx1">
<esi:attributeMapping sourceAttribute="obid">ObjectID</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="xxxx" defaultValue="com.ptc.windchill.esi.PlantSpecificEnterpriseData">Cla ss</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="view">View</esi:attributeMapping>
<esi:attributeMapping sourceAttribute="StorageLocation">StorageLocation</esi:attributeMapp ing>
</esi:Map>
3. Modify MapInformation object to specify different ‘elementMetaName’ for example ‘CommonData’ and ‘ViewSpecificData’.
<!-- ESI Enterprise Data Mapping Information -->
<esi:MapInformation id="ESICommonEnterpriseDataInfoEx01">
<esi:typedef>com.ptc.windchill.enterprise.data.EnterpriseData|com.ptc.windc hill.enterprise.data.enterpriseData.CommonEnterpriseData</esi:typedef>
<esi:elementMetaName>CommonData</esi:elementMetaName>
<esi:keyAttribute>ObjectID</esi:keyAttribute>
<esi:keyAttribute>Version</esi:keyAttribute>
<esi:mapRef>ESICommonEnterpriseDataEx01</esi:mapRef>
</esi:MapInformation>
<!-- ESI Enterprise Data Mapping Information -->
<esi:MapInformation id="ESIPlantSpecificEnterpriseDataInfoEx01">
<esi:typedef>com.ptc.windchill.enterprise.data.EnterpriseData|com.ptc.windc hill.enterprise.data.enterpriseData.PlantSpecificEnterpriseData</esi:typedef>
<esi:elementMetaName>ViewSpecificData</esi:elementMetaName>
<esi:keyAttribute>ObjectID</esi:keyAttribute>
<esi:keyAttribute>Version</esi:keyAttribute>
<esi:mapRef>ESIPlantSpecificEnterpriseDataEx01</esi:mapRef>
</esi:MapInformation>
<esi:MapInformation id="ESICommonEnterpriseDataInfoEx01">
<esi:typedef>com.ptc.windchill.enterprise.data.EnterpriseData|com.ptc.windc hill.enterprise.data.enterpriseData.CommonEnterpriseData</esi:typedef>
<esi:elementMetaName>CommonData</esi:elementMetaName>
<esi:keyAttribute>ObjectID</esi:keyAttribute>
<esi:keyAttribute>Version</esi:keyAttribute>
<esi:mapRef>ESICommonEnterpriseDataEx01</esi:mapRef>
</esi:MapInformation>
<!-- ESI Enterprise Data Mapping Information -->
<esi:MapInformation id="ESIPlantSpecificEnterpriseDataInfoEx01">
<esi:typedef>com.ptc.windchill.enterprise.data.EnterpriseData|com.ptc.windc hill.enterprise.data.enterpriseData.PlantSpecificEnterpriseData</esi:typedef>
<esi:elementMetaName>ViewSpecificData</esi:elementMetaName>
<esi:keyAttribute>ObjectID</esi:keyAttribute>
<esi:keyAttribute>Version</esi:keyAttribute>
<esi:mapRef>ESIPlantSpecificEnterpriseDataEx01</esi:mapRef>
</esi:MapInformation>
4. Modify MapInformation object for appropriate MPMResources to specify ‘isEnterpriseDataMergeWithElement’ tag as false. This indicates the ESI renderer to render EnterpriseData as a saperate object. Default value of this attribute is ‘true’, that will merge EnterpriseData object attribute to Resource element.
For example, In case of Tooling ‘ToolingInfo’ can be updated as follows :
<!-- ESI Tooling Mapping Information -->
<esi:MapInformation id="ToolingInfo">
<esi:typedef>com.ptc.windchill.mpml.resource.MPMTooling</esi:typedef>
<esi:elementMetaName>Tooling</esi:elementMetaName>
<esi:keyAttribute>ObjectID</esi:keyAttribute>
<esi:mapRef>Tooling</esi:mapRef>
<esi:isEnterpriseDataMergeWithElement>false</esi:isEnterpriseDataMergeW ithElement>
</esi:MapInformation>
<esi:MapInformation id="ToolingInfo">
<esi:typedef>com.ptc.windchill.mpml.resource.MPMTooling</esi:typedef>
<esi:elementMetaName>Tooling</esi:elementMetaName>
<esi:keyAttribute>ObjectID</esi:keyAttribute>
<esi:mapRef>Tooling</esi:mapRef>
<esi:isEnterpriseDataMergeWithElement>false</esi:isEnterpriseDataMergeW ithElement>
</esi:MapInformation>
 |
With respect to above example Enterprise Data will be rendered as a separate element for Tooling resources only. For other resources Enterprise Data will be rendered by merging attributes in appropriate resource element. Thus, if it is needed to render Enterprise Data associated with Part, Resources separately, Then respective MapInformation object in ESIResponseMetaInfo.xml must be updated appropriately.
|
5. Specify this new modified meta information file for new or existing target by using ‘Create/Edit Distribution Target’ UI as required.
6. When Enterprise Data object is rendered as a separate object, associated objects like WTDocument or EPMDocuments, their links will also be rendered to refer to data from these new elements. Otherwise by default documents links for Enterprise Data will be rendered to describe association with the part to which Enterprise Data is associated.