![]() |
The contents of the ESI response meta information file impact the structure of the ESI response message only when generating the message in ESI XML format (i.e., when the distribution target attribute ESI Response Output Format is set to ESI XML).
|
![]() |
A fourth element in the ESI response is the one named Release, holding release and transaction related information for a given message. This element is not described here, since the contents of the ESI response meta information file have no impact whatsoever on this element.
|
![]() |
The <GroupInformation> element has an optional XML attribute named isUnchanged, which takes a boolean value. The attribute specifies whether or not the given group would hold unchanged data in the ESI response. A default value of false is assumed when the attribute is not specified for the element. You will find that this attribute has a value true for each of the elements representing unchanged content in the default response meta information file – for example., the <GroupInformation> element for unchanged parts. When adding custom groups to the response meta information file, be sure to set this attribute to true for those groups that are meant to hold unchanged data.
|
![]() |
The sample elements in the above illustration determine the structure of portions of the ESI response message that contain WTPart related information. This may be understood from the value of the <typedef> element that occurs within the <MapInformation> element.
|
Response XML Element
|
MapInformation Element
|
Map Element
|
---|---|---|
AlternateLink
|
ESIAlternateLinkInfo
|
ESIAlternateLink
|
AUM
|
AlternateUnitOfMeasureInfo
|
AlternateUnitOfMeasure
|
BOMComponent
|
BOMComponentInfo
|
BOMComponent
|
BOMHeader
|
BOMHeaderInfo
|
BOMHeader
|
Document
|
DocumentInfo
ESIEPMDocumentInfo
|
Document
ESIEPMDocument
|
DocumentLink
|
DocumentLinkInfo
|
DocumentLink
|
ECNHeader
|
ChangeHeaderInfo
|
ChangeHeader
|
EPMMemberLink
|
ESIEPMMemberLinkInfo
|
ESIEPMMemberLink
|
EPMReferenceLink
|
ESIEPMReferenceLinkInfo
|
ESIEPMReferenceLink
|
EPMRepresentation
|
ESIEPMRepresentationInfo
|
ESIEPMRepresentation
|
Part
|
ESIPartInfo
|
ESIPart
|
ReferenceLink
|
RefDesignatorInfo
|
RefDesignator
|
Substitute
|
SubstituteInfo
|
Substitute
|
ProcessPlan
|
ProcessPlanHeaderInfo
|
ProcessPlanHeader
|
Sequence
|
SequencesInfo
|
Sequences
|
Operation
|
OperationInfo
|
Operation
|
ProcessPlanPartLink
|
ProcessPlanPartLinkInfo
|
ProcessPlanPartLink
|
StandardProcedureLink
|
StandardProcedureLinkInfo
|
StandardProcedureLink
|
ConsumableResourceLink
|
OperationToConsumableResourceLinkInfo
|
OperationToConsumableResourc
eLink
|
WorkCenterLink
|
OperationToWorkCenterLinkInfo
|
OperationToWorkCenterLink
|
OprBomAllocatedPart
|
OperationToPartLinkInfo
|
OperationToPartLink
|
OprOperatedOnPart
|
OperationToOperatedOnPartLinkInfo
|
OperationToOperatedOnPartLink
|
Tooling
|
ToolingInfo
|
Tooling
|
ProcessMaterial
|
ProcessMaterialInfo
|
ProcessMaterial
|
Skill
|
SkillInfo
|
Skill
|
ControlCharacteristic
|
ControlCharacteristicInfo
|
ControlCharacteristic
|
PartToControlCharacteristicLink
|
PartQualityLinkInfo
|
PartQualityLink
|
ProcessPlanToControlCharacteristicLink
|
ProcessQualityLinkInfo
|
ProcessQualityLink
|
OperationToControlCharacteristicLink
|
OperationQualityLinkInfo
|
OperationQualityLink
|
ModelItem
|
ModelItemInfo
|
ModelItem
|
ProcessPlanLocalizationLink
|
ProcessPlanLocalizationLinkInfo
|
ProcessPlanLocalizationLink
|
PlantLocalizationLink
|
PlantLocalizationLinkInfo
|
PlantLocalizationLink
|
ResourceBOMHeader
|
ResourceBOMHeaderInfo
|
ResourceBOMHeader
|
ResourceUsageLink
|
ResourceUsageLinkInfo
|
ResourceUsageLink
|
*Part/CommonEnterpriseData
|
ESICommonEnterpriseDataInfo
|
ESICommonEnterpriseData
|
*Part/ViewSpecificEnterpriseData
|
ESIPlantSpecificEnterpriseDataInfo
|
ESIPlantSpecificEnterpriseData
|
XML elements described below will be population when ESI Options and Variants is installed At 11.0 release intergration of options and variants to Oracle ERP is not supported.
|
||
Product_class
|
ESIOptionSetInfo
|
ESIOptionSet
|
Specification_category
|
ESIOptionInfo
|
ESIOption
|
Specification
|
ESIChoiceInfo
|
ESIChoice
|
Class_category_association
|
OptionSetOptionLinkInfo
|
OptionSetOptionLink
|
Class_specification_association
|
OptionSetMemberLinkInfo
|
OptionSetMemberLink
|
Class_structure_relationship
|
AssociatedOptionSetLinkInfo
|
AssociatedOptionSetLink
|
Class_condition_association
|
OptionSetRuleLinkInfo
|
OptionSetRuleLink
|
Condition
|
RuleInfo
|
Rule
|
Condition_member_association
|
RuleMemberLinkInfo
|
RuleMemberLink
|
Condition_action_member_association
|
RuleMemberActionLinkInfo
|
RuleMemberActionLink
|
Specification_expression
|
ExpressionInfo
|
Expression
|
Elements indicated with * can be customized to render as merged or as separate. For more information, see Publishing Option Sets.
|
![]() |
The values seen in the columns titled MapInformation Element and Map Element in the above table are actually the values of the id attribute of the said elements as they occur in the response meta information file. It is the contents of these elements that actually determine the structure of the response XML elements. Note that multiple values appear in these columns for the Document row – these are for a WTDocument and a CAD document respectively. This allows sending different sets of attributes for these types, while using the same XML element name in the ESI response viz., Document.
|
![]() |
The Info*Engine VDB is populated by the VdbBuilder APIs, which in turn make use of the output generated by the mapping APIs of class ESIMapper. See section Mapper Classes for a description of class ESIMapper and its methods.
|
![]() |
Do not modify the response meta information file that was provided when you installed Windchill ESI. This file may be replaced by future software releases. If you wish to modify it, copy it to a new location.
|
![]() |
1. The value entered for the ESI Response Meta Information File Path field may begin with $CODEBASE$ to indicate that the file resides under the Windchill codebase. For e.g., if the file resides under <Windchill>/codebase/com/ptc/windchill/esi/modified/, the value may take the form: $CODEBASE$/com/ptc/windchill/esi/modified/ESIResponseMetaInfoModified.xml
2. Releasing an object to the edited distribution target will cause the response message to be generated per the modified version of the response meta information file.
|
![]() |
Changing the contents of the response meta information file can change the structure of the ESI response. Changing the structure causes the XML schemas in Windchill and the EAI software components to become out of sync. If you change the response meta information file, you must modify the XML schema as described in the Create/Modify XML Schema section of this document. You must also modify the EAI software components to use the new schema. See the XML schemas section of this document for details.
|
![]() |
The Map element shown above is for illustration purpose only, and may or may not be identical to the one in the file ESIResponseMetaInfo.xml that comes with the ESI Services CD.
|
![]() | The above illustrated Map element is different from the default version in that (i) its id attribute has a different value and (ii) it has an additional attributeMapping element for the traceCode attribute. As for (i), it is imperative that the id attribute of a given Map element has a unique value for a given ESI installation. If on the other hand, the same value is shared between two or more versions of the response meta information file (where the Map elements that share the id are different), only one of the Map element versions will be used for response generation which is clearly not what is expected. Also, when changing the value of the id attribute for a given Map element, it should be accompanied by a change to the corresponding MapInformation element. The modified version of the MapInformation element for the above Map element is provided below: |
![]() | The mapRef element has a value that matches the value of the id attribute of the Map element. |
![]() | Alternatively, the New Distribution Target dialogue may be brought up from the Manage Distribution UI, and the value of the said field may be set to point to the file ESIResponseMetaInfoExample1.xml. A WTPart may then be associated to this newly created target and released. |
![]() | Changing the contents of the response meta information file can change the structure of the ESI response. Changing the structure causes the XML schema in Windchill and the EAI software components to become out of sync. If you change the response meta information file, you must modify the XML schema as described in the Create/Modify XML Schema section of this document. You must also modify the EAI software components to use the new schema. See the XML schemas section of this document for details. |
![]() | You will find that the Part element in the response file above does not have the child elements View and StorageLocation, although they figure in the response meta information and schema files. This is only expected when the preference Publish Plant Specific Attributes is set to the default value (of No). Set this preference to Yes in order that the said child elements are sent with the ESI response. More information on this topic appears in a later section of this document. |
![]() | A user may want to release a part after associating multiple distribution targets (that typically belong in multiple Oracle Applications instances) to it. In such a case, a response message will be generated for each set of targets belonging in a given Oracle Applications instance. The structure of the message that is generated for a given target will be determined by the contents of the response meta information file that is used for that target. Thus, a target can choose to receive the response message the way it wants, by having its responseMetaInfoPath attribute set to point to an appropriately customized version of the response meta information file. |
![]() | Make sure you follow the procedure described in section Modify the ESI response meta information file while modifying the contents of the ESI response meta information file. |
![]() | Changing the contents of the response meta information file (to cater to the added attributes) can change the structure of the ESI response. Changing the structure causes the XML schema in Windchill and the EAI software components to become out of synch. If you change the response meta information file, you must modify the XML schema as described in the Create/Modify XML Schema section of this document. You must also modify the EAI software components to use the new schema. See the XML schemas section of this document for details. |