Sample Configurable Links Collection Definitions File
This topic contains sample code for CustomCollectionComponentConfig.xml file. The CustomCollectionComponentConfig.xml file must be located at {Install_Home}/codebase/com/ptc/core/htmlcomp/collection/.
<?xml version="1.0" encoding="UTF-8"?>
<CollectionComponentConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation=".\CustomCollectionComp.xsd">
<CollectionToolsDefinition>
<!-- Configure custom collection tools here. -->
<!-- This tools configuration is same as OOTB tools that defined in CollectionComponentConfig.xml -->
</CollectionToolsDefinition>
<CollectionInstances>
<!-- Configure custom collection component instances here. -->
<!-- This collection component instances configuration is different than that of configured in OOTB -->
<!-- In CollectionComponentInstance collectionComponentID and preferencesRoot is restricted. -->
<!-- Instead inn CollectionComponentInstance parentCollectionComponentID is mandatory in which this custom configuration to be pushed. -->
<!-- parentCollectionComponentID is ID of the OOTB Collection Component in which these additional tools to be pushed. -->
<!-- How to find the correct collectionComponentID please refer the help document -->
<!-- Example 1 : Starts here -->
<!-- Example 1 : For Commonspace Save As Add four Collection Tools i.e.
1. Collect Decribe links Children
2. Collect Decribe links Parents
3. Collect Revision links Children
4. Collect Revision links Parents
For Commonspace Save As UI collectionComponentID is SaveAsInCommonspace. Refer it in parentCollectionComponentID
and add CollectionToolUsage references.
-->
<CollectionComponentInstance parentCollectionComponentID="SaveAsInCommonspace">
<description>
This collection additional component instance is used by the Save As in Commonspace command
</description>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
</CollectionComponentInstance>
<!-- Example 1 : Ends here -->
<!-- For Another UIs create CollectionComponentInstance here with appropriate parentCollectionComponentID and CollectionToolUsage list. -->
<CollectionComponentInstance parentCollectionComponentID="SaveAsInWorkspace">
<description>
This collection additional component instance is used by the Workspace Save As command
</description>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
</CollectionComponentInstance>
<!-- Example 1 : Ends here -->
<!-- For Another UIs create CollectionComponentInstance here with appropriate parentCollectionComponentID and CollectionToolUsage list. -->
<CollectionComponentInstance parentCollectionComponentID="ContainerMove">
<description>
This collection additional component instance is used by the Move command
</description>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
</CollectionComponentInstance>
<!-- Example 1 : Ends here -->
<!-- For Another UIs create CollectionComponentInstance here with appropriate parentCollectionComponentID and CollectionToolUsage list. -->
<CollectionComponentInstance parentCollectionComponentID="CollectItemsFromChangeItem_AffectedItems">
<description>
This collection additional component instance is used by the affected objects UI command
</description>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
</CollectionComponentInstance>
<!-- Example 1 : Ends here -->
<!-- For Another UIs create CollectionComponentInstance here with appropriate parentCollectionComponentID and CollectionToolUsage list. -->
<CollectionComponentInstance parentCollectionComponentID="CollectItemsFromChange_ResultingItems">
<description>
This collection additional component instance is used by the Resulting objects UI command
</description>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_DESCRIBE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REVISION_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_REFERENCE_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_CHILDREN" defaultCollectionToolOptionId="None"/>
<CollectionToolUsage id="COLLECT_CONFIG_MASTERS_LINK_PARENTS" defaultCollectionToolOptionId="None"/>
</CollectionComponentInstance>
<!-- Example 1 : Ends here -->
<!-- For Another UIs create CollectionComponentInstance here with appropriate parentCollectionComponentID and CollectionToolUsage list. -->
</CollectionInstances>
</CollectionComponentConfig>
Parent topic
Related information