Resource Classes
The following classes create the GetResource RPC output:
BasicESIRenderer
This is the abstract class implementing the interface ESIRenderer and is extended by all the resource renderer classes provided by ESI services. For more information, see section
BasicESIRenderer.
| Each of the resource renderer classes described below is an extension of the abstract class BasicESIRenderer, unless explicitly stated otherwise. |
ESIResourceRenderer
This class is instantiated and used (i) upon releasing a standalone resource (such as a tooling, process material or skill) in object-centric mode (ii) by an ESIWTChangeOrder2Renderer instance when the Change Notice being rendered has a resource associated to it or (iii) by an ESIOperationRenderer instance, for rendering the resources associated to the operation being rendered.
This is the main resource renderer class which invokes appropriate resource renderer to render resoures or resource structure.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIToolingRenderer
This class is instantiated and used by an ESIResourceRenderer instance for rendering the MPMTooling objects that figure in its collection named resources. The renderer is responsible for rendering MPMToolling and its structure which can have MPMTooling or WTPart as child of this resource. This renderer will render resource structure when “Number of Levels to Publish” attribute on distribution target under “Resource Settings” is set to a value greater than ‘0’. When resource structure is being rendered then “Saved Filter to be used when Publishing a Manufacturing Resource Structure” and “Publish Related Documents when Publishing a Manufacturing Resource” will be used from “Resource Settings” group and for part structure the rest of the settings will be used from “BOM Settings” or “Change Notice Settings” depending upon how the object is published.
When EnterpriseData is rendered as attributes on a resource specific element then the element can be adjusted in this adjustElement API or even in new adjustEnterpriseDataElement API. Similar to Part EnterpriseData rendering can be customized for MPMResource object. Refer to the section Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response in this guide to see how EnterpriseData rendering can be customized.
Refer to the Windchill release specific Java documentation for more details on available methods in the class.
ESIProcessMaterialRenderer
This class is instantiated and used by an ESIResourceRenderer instance for rendering the MPMProcessMaterial objects that figure in its collection named resources. Renderer is responsible for rendering MPMProcessMaterial and its structure which can have MPMProcessMaterial or WTPart as child of this resource. This renderer will render resource structure when “Number of Levels to Publish” attribute on distribution target under “Resource Settings” is set value more than ‘0’. When resource structure is being render then “Saved Filter to be used when Publishing a Manufacturing Resource Structure” and “Publish Related Documents when Publishing a Manufacturing Resource” will be used from “Resource Settings” group and for part structure rest of the settings will be used from “BOM Settings” or “Change Notice Settings” depending upon how object is published.
When EnterpriseData is rendered as attributes on a resource specific element then the element can be adjusted in this adjustElement API or even in new adjustEnterpriseDataElement API. Similar to Part EnterpriseData rendering can be customized for MPMResource object. Refer to the Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response in this guide to see how EnterpriseData rendering can be customized.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
SISkillRenderer
This class is instantiated and used by an ESIResourceRenderer instance for rendering the MPMSkill objects that figure in its collection named resources. Renderer is responsible for rendering MPMSkill and its structure which can have MPMSkill or WTPart as child of this resource. This renderer will render resource structure when “Number of Levels to Publish” attribute on distribution target under “Resource Settings” is set to a value greater than ‘0’. When resource structure is being render then “Saved Filter to be used when Publishing a Manufacturing Resource Structure” and “Publish Related Documents when Publishing a Manufacturing Resource” will be used from “Resource Settings” group. For the part structure the rest of the settings will be used from “BOM Settings” or “Change Notice Settings” depending upon how object is published.
When EnterpriseData is rendered as attributes on a resource specific element then the element can be adjusted in this adjustElement API or even in new adjustEnterpriseDataElement API. Similar to Part EnterpriseData rendering can be customized for MPMResource object. Refer to the section Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response in this guide to see how EnterpriseData rendering can be customized.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIPlantStructureRenderer
This class is instantiated and used by an ESIResourceRenderer instance for rendering the MPMPlant objects that figure in its collection named resources. Renderer is responsible for rendering MPMPlant and its structure which can have resource or WTPart as child of this resource. This renderer will render resource structure when “Number of Levels to Publish” attribute on distribution target under “Resource Settings” is set to a value greater than ‘0’. When resource structure is being rendered then “Saved Filter to be used when Publishing a Manufacturing Resource Structure” and “Publish Related Documents when Publishing a Manufacturing Resource” will be used from “Resource Settings” group. For the part structure the rest of the settings will be used from “BOM Settings” or “Change Notice Settings” depending upon how the object is published.
When EnterpriseData is rendered as attributes on a resource specific element then the element can be adjusted in this adjustElement API or even in new adjustEnterpriseDataElement API. Similar to Part EnterpriseData rendering can be customized for MPMResource object. Refer to the section Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response in this guide to see how EnterpriseData rendering can be customized.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIResourceGroupStructureRenderer
This class is instantiated and used by an ESIResourceRenderer instance for rendering the MPMResourceGroup objects that figure in its collection named resources. Renderer is responsible for rendering MPMResourceGroup and its structure which can have resource or WTPart as child of this resource. This renderer will render resource structure when “Number of Levels to Publish” attribute on distribution target under “Resource Settings” is set to a value greater than ‘0’. When resource structure is being render then “Saved Filter to be used when Publishing a Manufacturing Resource Structure” and “Publish Related Documents when Publishing a Manufacturing Resource” will be used from “Resource Settings” group. For the part structure the rest of the settings will be used from “BOM Settings” or “Change Notice Settings” depending upon how object is published.
When EnterpriseData is rendered as attributes on a resource specific element then the element can be adjusted in this adjustElement API or even in new adjustEnterpriseDataElement API. Similar to Part EnterpriseData rendering can be customized for MPMResource object. Refer to the section Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response in this guide to see how EnterpriseData rendering can be customized.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIWorkCenterRenderer
This class is instantiated and used by an ESIResourceRenderer instance for rendering the MPMWorkCenter objects that figure in its collection named resources. Renderer is responsible for rendering MPMWorkCenter and its structure which can have MPMWorkCenter or WTPart as child of this resource. This renderer will render resource structure when “Number of Levels to Publish” attribute on distribution target under “Resource Settings” is set value more than ‘0’. When resource structure is being render then “Saved Filter to be used when Publishing a Manufacturing Resource Structure” and “Publish Related Documents when Publishing a Manufacturing Resource” will be used from “Resource Settings” group. For part structure rest of the settings will be used from “BOM Settings” or “Change Notice Settings” depending upon how object is published.
When EnterpriseData is rendered as attributes on a resource specific element then the element can be adjusted in this adjustElement API or even in new adjustEnterpriseDataElement API. Similar to Part EnterpriseData rendering can be customized for MPMResource object. Refer to the section Configure MPMResource rendering to render Enterprise Data object in a separate element in ESI Response in this guide to see how EnterpriseData rendering can be customized.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIBOMRenderer
This class extends the abstract class ESIAbstractStructureRenderer, thereby inheriting the capabilities of this and the other classes that it extends. The ESIBOMRenderer class is intended to be extended by customizers. It has several attributes that are accessible to subclasses in read-only mode. The attributes have protected getter methods. Because the renderer state is expected to be established by the setData() method, the attributes do not have setter methods.
| When a resource structure is rendered, this renderer renders ‘ResourceBOMHeader’ element. |
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIResourceUsageLinkRenderer
This is the default extension of ESIBOMComponentRenderer, and is meant for building the renderer output for resource usages. The class is intended to be extended by customizers.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIWTPartRenderer
This class is the default extension of BasicESIRenderer. Renders part included in the resource structure.
Refer to the Windchill release specific Java documentation for more details on available methods in the class
ESIAlternateUnitOfMeasureRenderer
This class is instantiated and used by the following renderers – ESIToolingRenderer, ESIProcessMaterialRenderer and ESISkillRenderer. These use this class for rendering the Alternate Unit of Measure information associated with the following types of objects - MPMToolingMaster, MPMProcessMaterialMaster and MPMSkillMaster respectively. See section
ESIAlternateUnitOfMeasureRenderer for more information.