Selection Schemas: Dictionaries

A selection schema is a repository object used in dictionaries to automatically select elements based on specified criteria. Selection schemas are created as dictionary child objects and are not displayed in the object navigator but can be used in all the objects that use the parent dictionary.

TIP. For details about applying of selection schemas, see the Using Selection Schema article.

A selection type is a rule, based on which elements are selected. All selection types are applied in the order of their creation.

NOTE. MDM dictionaries and composite MDM dictionaries always work with the principal elements of the dictionary. The user cannot create a selection schema based on elements of default alternative hierarchies.

Web application Desktop application

Open the Selection Schemas dialog box

To add a new selection schema:

In the web application:

Click the Add button in the Schemas area. The New Schema dialog box opens:

Set the parameters:

Name. Enter schema name. The default name: Dictionary element selection schema.
Identifier. Enter unique schema identifier. The identifier must contain only Latin characters, numbers, the _ character, it must not contain spaces and must not begin with the number.

Click the Apply button.

In the desktop application select the [New Schema] element in the Schema drop-down list.

After executing the operations a new schema is added to the list of selection schemas.

To edit an existing selection schema:

In the web application select the selection schema in the Schemas area.
In the desktop application select the selection schema in the Schema drop-down list.

After executing the operations, the list of selection schemas opens according to the selected selection schema.

To add a selection type, click the Add button in the Selection Type area and select selection type in the drop-down list:

In the web application:

Select all elements.
Select elements in the list.
Select descendant elements.
Select level elements.
Select entire level.
Select parent elements.
Select child elements.
Select macro elements.

In the desktop application:

Select all.
Select by list.
Select descendants by level.
Select level.
Always select level.
Always select with parents.
Always select with descendants.
Use application macro.

Several selection types can be added for one selection schema.

The setup is suitable for all selection types, except for Select Macro Elements. The setup of the Select Macro Elements selection type is given in the Using Application Macro section..

To set up selection type in the web application:

Select selection type.
Click the Actions button and select the action in the drop-down list:

Select all elements.
Deselect all elements.

Click the Edit button if it is available. The selection type editing dialog box opens:

NOTE. The dialog box is displayed for the Select Elements in the List selection type.

Dialog box name depends on the selection type to be set up.

In the dialog box that opens in the element tree or in the dictionary levels list specify, for which elements or levels this rule is applied.

Use the standard context menu to select elements.

Click the Apply button.

After executing the operations the selection type is set up.

If the dictionary contains parameters, for the Select Elements in the List and Select Descendant Elements selection types, before opening the editing dialog box the Determine Parameter Values dialog box opens, in which one should specify a list of elements by specified parameter values.

The setup is described for all selection types, except for the Use Application Macro type. The setup of the Use Application Macro selection type is given in the Using Application Macro section.

To set up selection type in the desktop application:

Select the selection type and click the Edit button.
Double-click the selection type.

The Set Up Primitive dialog box opens:

In the dialog box:

Select the action in the drop-down list:

Selects chosen elements.
Deselects chosen elements.

Specify the elements, for which the rule is applied, in the dictionary elements tree. Use the standard context menu to select elements.

Click the OK button.

After executing the operations the selection type is set up.

If the dictionary contains parameters, for the Select by List and Select Descendants by Level selection types, before opening the editing dialog box the Determine Parameter Values dialog box opens, in which one should specify a list of elements by specified parameter values.

The selection schema contents is dynamically based on macro execution result:

Macro must be a static (Shared) method of a class.
Macro signature must look as follows:

Public Class <class name>: Object
    Public Shared Sub <schema name>(<SelectionParam>, <GroupParam>: IDimSelection);
    Begin
        ...
    End Sub <schema name>;
End Class <class name>;

Parameters:
SelectionParam. The dimension selection, in which it is required to edit elements (select or deselect).

GroupParam. A group of elements, where selection schema is applied. If this parameter is equal to Null, all elements of the selection are handled.

To edit the selection type which uses an application macro to select dictionary elements, open the Select Macro Elements dialog box in the web application or the Method of Element Selection dialog box in the desktop application.

To open the Select Elements in Macro dialog box in the web application, click the Settings button next to the Use Application Macro selection type:

To open the Method of Element Selection dialog box in the desktop application, select the Form Elements from Macro selection type and click the Edit button or double-click the selection type:

The Assembly, Unit or Form area displays available assemblies, units and forms. The Methods area displays the class tree of the object selected in the repository list.

The Methods area displays the child elements (methods) for each class if they correspond with the required signature. If no methods are available, the class is not displayed.

To add a macro, click the Apply button in the web application or the OK button in the desktop application. The button is available if:

The method is selected from the method list.
The only one method is displayed in the method list.

To view result of applying all selection schema types:

In the web application click the View button. The <selection schema name> dialog box opens:

In the desktop application click the View Result button. The Selection Schema dialog box opens that is similar to the dialog box in the web application.

Saving selection schema is available only in the desktop application. To save the selected selection schema, click the Save As button displayed on the same level with the Schema box. In the dialog box that opens specify name and identifier of the selection schema.

To delete the selected selection schema type:

In the web application click the Delete button in the Selection Type area.
In the desktop application click the Delete button below the list of selection types.

After executing the operations the selection type is deleted from the schema.

To delete the selected selection schema:

In the web application click the Delete button in the Schemas area.
In the desktop application click the Delete button at the same level with the Schema drop-down list.

After executing the operations the confirmation dialog box opens. If the answer is positive, the selected schema is deleted.