Customization Points
Extendable classes
Some extendable Windchill ESI classes described in the VDB Builder section of this document must be defined in Windchill ESI preferences if they are extended. The following classes are designed to permit extensions by customizers:
◦ ESIEffectivityHandlerImpl
Preference name: Effectivity Handler
Default value: com.ptc.windchill.esi.rnd.ESIEffectivityHandlerImpl
◦ VdbBuilder
Preference name:Virtual Database Builder
Default value: com.ptc.windchill.esi.rnd.VdbBuilderImpl
Configurable Options
Windchill ESI preferences control several configurable options for Windchill ESI renderers and the Windchill ESI VDB builder. The options are:
◦ Define the format for effectivity start and end dates when sending date effectivity information with the ESI response. The value is used by a java.text.SimpleDateFormat instance for formatting the start and end dates as required.
Preference name: Effectivity Format
Default value: yyyy-MM-dd HH:mm:ss
 |
There is a certain distribution target attribute named Effectivity Format that appears in the General Parameters section of the Create/Edit Distribution Target UI. In order for ESI services to use this attribute instead, the above described preference should be set to an empty string as value.
|
◦ Define the source XML element name that contains effectivity start date.
Preference name: Source XML Element Name for Effectivity Start Date
Default value: StartEffectivity
◦ Define the source XML element name that contains the effectivity end date.
Preference name: Source XML Element Name for Effectivity End Date
Default value: EndEffectivity
◦ Declare the name of the class that defines the date effectivity that is supported by Windchill ESI renderers.
Preference name: Effectivity Class
Default value: wt.effectivity.WTDatedEffectivity
◦ Define the source XML element name that contains the serial number effectivity start value.
Preference name: Source XML Element Name for Serial Number Effectivity Start Value
Default value: StartSerialNumberEffectivity
◦ Define the source XML element name that contains the serial number effectivity end value.
Preference name: Source XML Element Name for Serial Number Effectivity End Value
Default value: EndSerialNumberEffectivity
◦ Define the XML element name that contains the serial number effectivity context part number.
Preference name: XML Element Name for Context Part for Serial Effectivity
Default value: SerialNumberEffectivityCxtPartNumber
◦ Declare the name of the class that defines the serial number effectivity that is supported by Windchill ESI renderers.
Preference name: Serial Effectivity Class
Default value: wt.part.ProductSerialNumberEffectivity
◦ Define the source XML element name that contains the lot number effectivity start value.
Preference name: Source XML Element Name for Lot Number Effectivity Start Value
Default value: StartLotNumberEffectivity
◦ Define the source XML element name that contains the lot number effectivity end value.
Preference name: Source XML Element Name for Lot Number Effectivity End Value
Default value: EndLotNumberEffectivity
◦ Define the source XML element name that contains the lot number effectivity context part number.
Preference name: Source XML Element Name for Context Part for Lot Effectivity
Default value: LotNumberEffectivityCxtPartNumber
◦ Declare the name of the class that defines the lot number effectivity that is supported by Windchill ESI renderers.
Preference name: Lot Effectivity Class
Default value: wt.part.ProductLotNumberEffectivity
◦ Specify whether or not to include the Effectivity Context assembly part implicitly in the given transaction when publishing serial or lot number effectivity using a Change Notice.
Preference name: Include Effectivity Context
Default value: No
◦ Specify whether or not to validate the Effectivity Context object when publishing serial or lot number effectivity using a Change Notice. If set to Yes, ESI services will allow publishing a part with serial or lot effectivity, provided the effectivity context object is the immediate parent of the part being published.
Preference name: Validate Effectivity Context
Default value: Yes