Groups of Elements: Dictionaries

A group of elements is a repository object used in dictionaries to limit the list of available elements. Groups of elements are created as dictionary child objects and are not shown in the object navigator.

Groups of elements can be used in Foresight Analytics Platform tools to select elements of the dimension based on the specified dictionary.

A selection type is a collection of dictionary elements combined by some common characteristic.

NOTE. Adding and deleting MDM dictionary elements included in the groups of elements and the use of groups of elements in various operations do not depend on whether the default hierarchy is selected. Groups of elements of MDM dictionaries work only with main dictionary elements. It is not available to create a group of elements on default alternative hierarchies.

Web application Desktop application

Open the Groups of Elements dialog box

To add a new group of elements:

In the web application:

Click the Add button in the Groups area. The New Group of Elements dialog box opens:

Set the parameters:

Name. Enter group name. The default name: Dictionary elements group.
Identifier. Enter unique group 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 Group] element in the Group of Elements drop-down list.

After executing the operations the new group is added to the groups of elements list.

To edit an existing group of elements:

In the web application select the group of elements in the Groups area.
In the desktop application select the group of elements in the Group of Elements drop-down list.

After executing the operations the list of selection types according to the selected group of elements is displayed.

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

Elements from List. Selected list elements will be included to the group.
Level Elements. Elements of selected dictionary levels should be included to the group.
Elements with Common Owner. Both selected elements and their child elements will be included to the group.
Use Application Macro. The element group contents is dynamically based on macro execution result.

Several selection types can be added for one group of elements.

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

To set up selection type:

Select selection type.
Open the selection type editing dialog box:

In the web application click the Edit button next to the selection type.
In the desktop application select the selection type and click the Edit button or double-click on it.

After executing the operations the editing dialog box opens. Dialog box appearance depends on the selected selection type:

Elements from List. When this selection type is selected, the editing dialog box differs in the web application and in the desktop application.

The Leave Elements in the List dialog box in the web application:

The Set Up Primitive dialog box in the desktop application:

The dialog boxes contain lists of dictionary elements. Select required elements. Use the standard context menu to select elements.

Level Elements. When this selection type is selected, the editing dialog box differs in the web application and in the desktop application.

The Level Elements dialog box in the web application:

The Set Up Primitive dialog box in the desktop application:

Select checkboxes next to names of the required levels.

Elements with Common Owner. When this selection type is selected, the editing dialog box differs in the web application and in the desktop application.

The Leave Child Elements together with Parent Element dialog box in the web application:

The Set Up Primitive dialog box in the desktop application:

The dialog boxes contain lists of dictionary elements. Select required elements. Use the context menu to select elements.

Click the Apply button in the web application or click the OK button in the desktop application.

After executing the operations the selection type is set up.

If the dictionary contains parameters, for the Elements in the List and Elements with Common Owner selection types, before opening the editing dialog box the Determine Parameter Values dialog box opens to create a list of elements by specified parameter values.

The group of elements contents is created based on macro execution result, in this case:

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

Public Class <class name>: Object
    Public Shared Function <group name> (Dimension: IDimInstance): IDimSelection;
    Var
        GroupSelection: IDimSelection;
    Begin
        GroupSelection := Dimension.CreateSelection;
        //Creating selection GroupSelection
        Return GroupSelection;
    End Function <group name>;
End Class <class name>;

Parameters:
Dimension. Opened dictionary instance.

Result: selection of elements, which should be used to form a group.

To edit the selection type that uses application macro to select group of dictionary elements, open the Create Elements from Macro dialog box in the web application or the Method of Element Selection dialog box in the desktop application.

To open the Create Elements from 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 Create 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.

Double-click the method to select it and close the dialog box.

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 in the method list.
In the method list the only one method is displayed.

The final collection of dictionary elements is created by uniting or intersecting the elements contained in single selection types.

After adding selection types select their interaction type in the drop-down list located in the Groups area next to the group of elements in the web application or above the list of selection types in the desktop application:

Union. In case of selections interaction the list includes all elements obtained as a result of selection types work (a single copy).
Intersection. In case of selection types interaction the list includes the elements contained in the result of each selection type.

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

To delete the selected selection type from the group of elements:

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 group of elements.

To delete the selected group of elements:

In the web application click the Delete button in the Groups area.
In the desktop application click the Delete button at the same level with the Group of Elements drop-down list.

After executing the operations the confirmation dialog box opens. If the answer is positive, the group of elements is deleted.