Technical documentation - Catalogue templates

This guide explains how to configure a template catalogue which is used when creating new catalogues and when using the Action on selected items - Add presentations function.

Version 4.5

This function is available in version 4.5 and later.

Overview

It is possible to configure a default node structure on catalogues. This default structure will be used when a new catalogue is created. This configuration will also be used to define where presentations are added when presentations are added to several catalogues using the Action on selected items - Add presentations function and when adding references to many catalogues using Action on selected items - Add reference.

Configuration

The configuration is located in catalogue.config in C:\ProgramData\Signifikant\Assert folder. A default configuration is generated automatically.

Tag	Usage

Tag	Usage
PresentationDescriptor	Defines a menu option in Add Presentation
PresentationBaseTypeCode	The menu option may be valid for a presentation base type or a presentation code. If it is valid for a presentation base type use this tag.
PresentationTypeCode	The menu option may be valid for a presentation base type or a presentation code. If it is valid for a presentation which is not a base type, refer to the code of the presentation type using this tag.
TargetNode	The presentation will be added to or under the node which has a persistent id matching regex in this tag.
CreateNewNodeOnEmptyTargetNode	If node does not exist, a new node will be created. node-image-file-name will point to an image in image storage, it will be added to the created node node-persistent-id-format is regex defining the persistent id to be added to the node. Need to match TargetNode regex as in example below. text-persistent-id-for-node-name will point to persistent id for the text which will be used for the added node

If user has selected to use template when creating new catalogues in the options dialogue, all new catalogues will get a set of nodes automatically. When creating a new catalogue one node will be created for each <PresentationDescriptor> block that meets the following criterions:

The <PresentationDescriptor> block has a <TargetNode> tag. If several <TargetNode> tags with the same content exist, the first <PresentationDescriptor>'s content will be used for the created node.
The <PresentationDescriptor> block has a <CreateNewNodeOnEmptyTargetNode> tag. The content of this tag will be used for name, image and persistent id of the created node.
The <PresentationDescriptor> block has a <PresentationBaseTypeCode> tag or a <PresentationTypeCode> tag which is not null.

Sample config

Catalogue.config

<?xml version="1.0" encoding="utf-8"?>
<MultiplePresentationList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PresentationDescriptor>
      <PresentationBaseTypeCode />
      <PresentationTypeCode>Product</PresentationTypeCode>
      <TargetNode>_Accesories</TargetNode>
      <CreateNewNodeOnEmptyTargetNode node-image-file-name="Accessories.png" node-persistent-id-format="{0}_Accesories" text-persistent-id-for-node-name="Node.Name.Accesories" />
    </PresentationDescriptor>
    <PresentationDescriptor>
      <PresentationBaseTypeCode />
      <PresentationTypeCode>Part</PresentationTypeCode>
      <TargetNode>_Accesories</TargetNode>
      <CreateNewNodeOnEmptyTargetNode node-image-file-name="Accessories.png" node-persistent-id-format="{0}_Accesories" text-persistent-id-for-node-name="Node.Name.Accesories" />
    </PresentationDescriptor>
    <PresentationDescriptor>
      <PresentationBaseTypeCode>Part assembly</PresentationBaseTypeCode>
      <PresentationTypeCode />
      <TargetNode>_SpareParts</TargetNode>
      <CreateNewNodeOnEmptyTargetNode node-image-file-name="SpareParts.png" node-persistent-id-format="{0}_SpareParts" text-persistent-id-for-node-name="Node.Name.SpareParts" />
    </PresentationDescriptor>
    <PresentationDescriptor>
      <PresentationBaseTypeCode />
      <PresentationTypeCode>Kit</PresentationTypeCode>
      <TargetNode>_Kit</TargetNode>
      <CreateNewNodeOnEmptyTargetNode node-image-file-name="Kits.png" node-persistent-id-format="{0}_Kit" text-persistent-id-for-node-name="Node.Name.Kits" />
    </PresentationDescriptor>
    <PresentationDescriptor>
      <PresentationBaseTypeCode />
      <PresentationTypeCode>Document</PresentationTypeCode>
      <TargetNode>_Documents</TargetNode>
      <CreateNewNodeOnEmptyTargetNode node-image-file-name="Documents.png" node-persistent-id-format="{0}_Documents" text-persistent-id-for-node-name="Node.Name.Documents" />
    </PresentationDescriptor>
  </Items>
</MultiplePresentationList>

Strategy for node name id important

Note that it is important to have a strategy for the persistent id of the texts in the nodes in root above. This persistent id also used in validation, and if several imports create data thy will need to use the same persistent id.

The convension typically used is as in the example above; Node.Name.Accessories for the accessories node, Node.Name.Documents for the documents node etc.