Customizing Standards for Layers and Filters

Standards for layers and filters are provided by default. As an administrator, you can customize the default values set in these samples to address your needs.

Standard files are identified by two runtime environment variables which are CATDefaultCollectionStandard and CATCollectionStandard:

  • CATDefaultCollectionStandard: indicates the name and path of the sub-directory (or sub-directories) containing the default standards provided by Dassault Systèmes. This variable is set by default to installation_folder\resources\standard during the installation procedure.
  • CATCollectionStandard: indicates the name and path of the sub-directory (or sub-directories) containing the standards customized by the administrator. This means that you should save your customized standards in these sub-directories.

Regarding layers and filters, two XML files are provided:

  • CATStdLayersAndFilters.xml and CATStdTypeLayerAndFilter.xml for part documents.
  • CATDftStdLayersAndFilters.xml for .CATDrawing documents.

This task shows you how to:

Before you begin:
  • Prior to modifying standards, you need to set the CATCollectionStandard environment variable to identify where you want to save your customized standards. For detailed information on how to set environment variables, see Installation and Administration: 3DEXPERIENCE Platform: 3DEXPERIENCE Platform Installation: Native Apps Installation: Configuring the Software: Configuring Environments.
  • You must run the software in administration mode.

Use the Interactive Editor

The Standard Definition dialog box lets you interactively define standards that are stored in a .xml file.

  1. Select Me > Preferences > Standards to access the interactive standard editor.
  2. Check that the General category is selected.
  3. From the File list, select the CATStdLayersAndFilters.xml file.
  4. Click the plus sign next to the CATStdLayersAndFilters node then repeat this step for each node.
    The complete XML tree structure with the values defined by your administrator is displayed.

    Standard properties have been defined for the following instances:

    • Current layer and filter
    • 2 layers named General and Basic geometry. See Using Layers for more information.
    • 2 filters named All and Current.

    Now let's suppose you want to add a new layer.

  5. Select the Layers List node from the tree structure then click Add to the right.
    This creates a new instance in the tree structure which is named "NoNameDefined" by default.
  6. Select the created instance, i.e. "Layer2" then assign a number (the value must be comprised between 0 and 999) to the layer, a name of your own choosing as well as a comment (if necessary) in the corresponding boxes.
  7. To create a new filter, select the Filter List node then click Add.
  8. Select the created instance then enter the name of your choice and the layer's visibility status.
    Tip: You can modify any box value anytime simply by selecting the desired instance then entering the new value in the corresponding box.
  9. Optional: If you are not satisfied with an instance, select the node under which you want to remove an instance then click Remove.
  10. Optional: In the Layer Remove dialog box, select the instance to be deleted then click OK to validate.
    The selected instance is removed.
  11. When finished, click OK to save the modifications in the CATStdLayersAndFilters.xml file. A pop-up message informs you that the modified standard file has been saved in the directory specified when setting the CATCollectionStandard variable.

    Important: When logged with the appropriate business role, the Save As New button is available to let you save your modifications in a new .xml file.

Edit the XML File

Standard files are stored in a format called XML (EXtensible Markup Language) used to exchange content. XML files can be customized in a simple way, for example to add new layers and filters, provided that you respect some syntax rules.

The CATStdLayersAndFilters.xml is taken as an example but the method is identical for editing the CATDftStdLayersAndFilters.xml file which is also available in the General category.

Be careful not to edit the CATStdTypeLayerAndFilter.xml file because it contains the layer and filter type definition used in the CATStdLayersAndFilters.xml file.

  1. Open the CATStdLayersAndFilters.xml file in your XML editor.

    This file is made up of the following parts:

    • XML starting tags indicating the format as well as the name and type of the file.
    • Information related to the "Current" layer and filter, i.e. the layer to which objects are assigned and the visualization filter set as current. We recommend that you leave this information unchanged to avoid any trouble or misunderstanding.
    • The list of layers declared in this standard file. This list is surrounded by <std:node name="Layers"> at the beginning and </std:node> at the end. Each layer definition contains a Number and a Name (a Comment may be added, if necessary).
    • The list of layer filters. This list is surrounded by <std:node name="LayersFilters"> at the beginning and </std:node> at the end. Each filter definition contains a Name and a Value.
    • The file ends with the tag </std:node>.

  2. To declare a new layer, add a <std:typeval name="CATLayer"> ... </std:typeval> sequence to the "Layers" node.

    Note that the layer number must be comprised between 0 and 999.

  3. To declare a new filter, add a <std:typeval name="CATLayersFilter"> ... </std:typeval> sequence to the "LayersFilters" node.

    A filter must be created using a layer number but there is no need to declare a layer for the filter value or the filter definition.

    For example, you can enter "Layer=0 + Layer=50 + Layer=100" even if "Layer 100" does not exist.

    You can even use more complex expressions such as "Layer=0 + (Layer>50 & Layer<100)" but the simpler, the better.

  4. When finished, save the modified .xml file.

The new standards for layers and filters are applied to any documents you create from now on.

Administer Standards

You can administer standards provided that the business role used when logging on allows you to do so.

A role is one of the components of the credentials used to log on. For content security purpose, each user is assigned to one or several secured collaborative spaces with a specific role, to manage the different categories of content.

For more information about business roles, see Collaborative Spaces.

If you logged as Administrator (internal name is VPLMAdmin) or Owner (internal name is VPLMProjectAdministrator), you are allowed to administer standards. In that case, the Save As New button is available to let you save your modifications in a new .xml file.

This opens the Save As dialog box which places you in the directory you specified when setting the CATCollectionStandard variable. You can access this file later on from the File list.

Important: You cannot change the default name of standard files in the General category. For these files, the Save As New button can only be used to generate a new file in another directory but still with the same name.