CDP 4 User Manual

Rules

Plugin: Basic Reference Data Module

Introduction

A Rule defines relationships between concepts in ECSS-E-TM-10-25:

representation of a validation or constraint rule for CategorizableThings and relations between them1

Categories are used to define the rules and the relationships between concepts these describe. The rules are defined and managed in the RDL, and can be applied to most concepts in the CDP4™.

This section describes how categories can be managed, and a high level description of how categories can be used.

Managing Rules

Open the Rules Browser by selecting the Rules img icon on the Reference Data tab. This browser contains a list of all the Rules contained in all the RDLs that are opened at that moment for the selected data source. Rules are shown with a Short Name, a Name, Container RDL and Type.

The list is grouped by the type of Rule. Types are distinguished by their own icons. The possible types are:

Persons with a role that has the permission Modify on the ClassKind Site Reference Data Library are able to access the Basic RDL to create, edit or delete categories.

Various types of rules can be setup that use one or more defined categories to express relationships between various modelling concepts. For the use of categories in rules, and setup the correct and meaningful relationships between modelling concepts in these rules using the categories, it is important to set these up properly. It is advisable to have the RDL management available for a limited group of users only.

A description of the available functionalities is given below. Next to these it is possible to use the generic functionality using the Search img and Help img icons. To make sure the latest data is shown in the browser, it is always possible to refresh it using the Refresh img icon. The rules modal dialogs further have the generic functionality on the Aliases, Definitions and HyperLinks tabs, described in the topic standard tabs.

Create Rule

To create a new rule, select the Create Rule img icon or in the context menu select Create a Rule for each of the available types.

On the Basic tab, provide the mandatory fields for Name and Short Name. Furthermore, it is required to provide the Container RDL, see the management and usage of RDLs.

Further provide the additional required fields for the different rule types:

img

img

img

Edit Rule

To edit a rule, select the Edit Rule imgicon or in the context menu select Edit. Depending on the type of rule, it is possible to edit most of the available fields on the Basic tabs, as well as optional items on the other tabs for Aliases, Definitions, and Hyperlinks.

After making the required changes, click Ok.

It is only possible to edit the Container RDL to promote an item from a model-specific RDL into a higher level Site Directory RDL.

Please note that editing rules should be handled with extreme care, as this may have a large impact on all engineering models that use concepts that depend on it. It is advisable to only edit rules to fix apparent mistakes.

On the Advanced tab, a Revision Number is given, see the description of Revision Number for details.

Inspect Rule

To inspect a rule, select the Inspect Rule imgicon or in the context menu select Inspect. In the Inspect modal dialog, all the details can be seen on the Basic tabs, as well as optional tabs for Aliases, Definitions, and Hyperlinks. Additionally the status of the Parameter Type is given by the check box for Deprecated, see the description of Delete below.

The Advanced tab provides information that may be useful mostly to CDP™ database administrators. Given are the UniqueID and the Revision Number.

Delete Rule

A rule should not be deleted from the CDP™.

To delete a rule, select the Delete Parameter Type imgicon or in the context menu select Delete. Items from the CDP™ are never completely deleted, but they are marked as Deprecated. This Deprecated status is an indication to users that it should not be used anymore.

Export Rule

To export rules, select the Export Rules img icon or in the context menu select Export.

Applying and Using Rules

Rules are created assist in a correct modelling approach according to industry- or organization-specific standards and methods. Applying categories to modelling concepts, such as Element Definitions, Element Usages, Parameter Types or Requirements, and using rules to define the relationships between these concepts, allow to provide a backbone structure to an engineering model, provide real meaning to the objects and parameters used in the modelling, and enable validation of model.

Applying rules and categories further provide a powerful mechanism to work with the various concepts in the CDP™ Data Model, setting up links, providing meaning, and allowing filtering and combining various sources of information. This can help to setup basic calculations for users, upto providing useful entry points for automation to retrieve information, e.g. for the integration of Domain Specific Tools (DSTs).

Using decomposition rules, a hierarchical description of the model can be defined, specifying a containment tree of possible categories. The categories by themselves are defined to be applicable to specific modelling concepts, e.g. the categories "SYS", "ELE" and "EQT" have permissible classes Element Definitions and Element usages. The decomposition rules can now specify the hierarchical ordering of these categories, by defining containing and contained categories. As an example, a rule can be setup for the Sytem as Containing Category will hold at a next lower level an Element as Contained Category, and similar for the Equipment as Contained Category for the containing Element. This combination of rules can then be used to check and validate the setup of an engineering model, checking if an element usage is placed at the correct level.

Parameterized rules can e.g. be used to check an engineering model setup for completeness. As an example, it can be used to setup a rule that any element definition or element usage that has the specified category applied to it, e.g. "EQT", should have at least a parameter "mass" associated with it.

Related Topics


  1. Source ECSS-E-TM-10-25-Annex-A, v2.4.1, ToC Reference Manual, section 4.110 

Last modified 1 year ago.

^ Top