RadixWare Explorer User Guide/User Interface/Main Actions in Selector

From RadixWiki
Jump to: navigation, search

This section describes the standard actions to be executed in the selector and selector setup procedure:

Creating Object

To create a new object:

RadixWare Desktop Explorer

RadixWare Web Explorer

  • Click create_entity_1.jpg on the selector toolbar.
  • Use the Selector | Create "<Object name>" menu item

When working with the tree-like list of objects, the Create button contains the context menu:

  • Create Object "<Object name>" (create_entity_1.jpg). Creates the parent object in the objects list.
  • Create Subobject "<Subobject name>" (create_entity_2.jpg). Creates the sub-object of the selected parent object.

If the object class needs be specified, the Select Class of New Object dialog box appears. It is possible to use filter when selecting a class of new object.

Class new object TX .jpg

The dialog box also contains the Create several objects of different classes flag. If the flag is set, the user can use the multiple selection mode to select the classes of objects to be created:

Class new object 3 .jpg

After clicking the OK button, the dialog boxes of object creation will be sequentially displayed for each selected class. Once the class/type is selected, specify the object properties in the dialog box.

class_new_object_2.jpg

Opening Object in Explorer Tree

To open the current object of the selector and its sub-objects in the explorer tree:

RadixWare Desktop Explorer

RadixWare Web Explorer

  • Click the Open Object in Tree button (view_21.jpg) on the selector toolbar.

Select one of the following actions in the button context menu:

  • Open in Tree. Opens the object in the explorer tree (array_entity_19.jpg). As a result of this action, the object and its sub-objects will be shown in the explorer tree.
  • Auto Open in Tree. Opens the object automatically in the explorer tree (Auto open in tree.jpg). As a result of this action, the current object in the selector and its sub-objects will be shown in the explorer tree.
  • Replace. Replaces the last opened object with the current one (view_13.jpg). As a result of this action, the object will be shown in the explorer tree.
  • Click the Open Object in Tree button (array_entity_19.jpg) on the selector toolbar.
  • Use the Selector | Open in Tree menu item.
  • Double-click the first column of the required record in the table.

The Open button can be also located in the data entry field, thus making it possible to open the object in the current context of the explorer tree.

Searching for Object

The Find in dialog box is used to search for the required record in the selector by the known fragment of text. The search is performed through all objects in the selector.

To open the Find in dialog box:

  • click view_18.jpg on the toolbar
  • select the Selector | Find menu item
  • use hot keys Ctrl + F

find_1.jpg

The dialog box header displays the name of the selector table where the search will be performed.


The search parameters are as follows:

  • Find. The text or a fragment of text to search for.
  • In Column. The table column to search in. The required column is selected from the drop-down list.
  • Options area. The search additional parameters. Define the parameters by setting the respective flags:
    • Match Case
    • Whole Word
  • Direction area. Define the search direction (forward/backward) by setting the required flag.


The search is performed starting from the next/previous row (depending on the search direction). Click the Find button to move to the fist found line, at that the respective record in the selector will be marked as current. To continue the search, use the Selector | Find Next menu item or the F3 hot key

note.jpgThe time required for object search depends on the number of objects.

Filtering and Sorting Options

Filtering Option

The filtering option allows to display only those objects that satisfy the filtering conditions.

The RadixWare Desktop Explorer application supports the following types of filters:

  • Base filter. This filter is predefined in the system and it does not require any additional settings.
  • User-defined filter. This filter is created by the RadixWare Desktop Explorer application user. This type of filter is available only to the user who created it. To create a user-defined filter and edit the filtering conditions, use the filter editor.
  • Complex filter. This filter is created by the RadixWare Desktop Explorer user by adding some specific conditions to the base filter. This type of filter is available only to the user who created it. To create a complex filter and edit the filtering conditions, use the filter editor.
  • Common filter. This filter is created by the system administrator (or by the user with the respective rights); it is available to all system users. The common filter is stored in the database. For common filter description, refer to the documentation of the respective product.

To create a list of filters to be used in the selector, use the Filters Manager.

note.jpgThe RadixWare Web Explorer application supports only Base and Common filters. The Filter Editor and Filter Manager are not provided.


Sorting Option

The sorting option allows to display the selector objects in a certain order. The selector objects can be sorted by a single or several properties.

The RadixWare Desktop Explorer application supports the following types of sorting:

  • Base sorting. This sorting is predefined in the system; it does not require any additional settings.
  • User-defined sorting. This sorting is created by user of the RadixWare Desktop Explorer application. This type of sorting is available only to the user who created it.

The user-defined sorting can be created by:

  • Using the Sorting Manager.
  • By clicking the name of the required column in the object selector (to sort the objects by a single property).
  • By clicking the names of the required columns in the object selector while holding Shift key (to sort the objects by several object properties). At that, the order of the columns affects the order in which the sorting is applied to the objects: initially, the objects are sorted by the property indicated first, after that the sorting by the second property is applied to the group of sorted objects, etc.


The created sorting is available on the filter and sorting panel of the RadixWare Desktop Explorer application (the Sorting field, see below).


To edit and view the user-defined sorting parameters, use the sorting editor.

note.jpgThe RadixWare Web Explorer application supports only Base Sorting. The Sorting Editor and Sorting Manager are not provided.


Filter and Sorting Panel

To work with the filters and sortings, use the respective panel that can be opened:

  • by clicking view_24.jpg on the toolbar
  • by using the Selector | Filter and Sorting Panel menu item

The Filter and Sorting Panel looks as follows:

Filter entity 1 .jpg

The panel consists of the following elements:

  • Filter field. From the drop-down list, it is possible to select:
    • the filter to be applied to the selector. The filter is selected from the list of filters defined for a certain selector. The list can contain different types of filters: pre-defined, user-defined, complex or common. Filters can be divided into groups. In the list, the filters are indicated by the following icons depending on the filter type:

Icon

Filter Type

filter_entity_5.jpg

Base Filter

filter_entity_4.jpg

User-Defined Filter, Complex Filter

filter_entity_6.jpg

Common Filter

When selecting the filter, the filtering parameters area displays the parameters defining the object selection conditions.

  • the <none> value that deselects the filter to be applied to the objects.
  • the Filters manager value. Selecting the value opens the Filters Manager editor used to work with the filters.
  • Filtering parameters area containing a set of parameters for the objects selection. When defining the parameter values, the selector table is not available. The filtering parameters may be absent.
  • Commands used to work with the filters:

Button

Command

Function

filter_entity_2.jpg

Clear Value

Deselects the filter to be applied to the objects. The <none> value is set in the Filter field.

filter_entity_8.jpg

Open Filters Manager

The operation executed by the command depends on the value selected in the Filter field:

note.jpgViewing / editing of the common filter filtering conditions is not available.

  • Sorting field. From the drop-down list, it is possible to select:
    • the sorting to be applied to the selector. The list can contain different types of sortings: base, user-defined. In the list, the sortings are indicated by the following icons depending on the sorting type:

Icon

Sorting Type

sorting_entity_2.jpg

Base Sorting

sorting_entity_1.jpg

User-Defined Sorting

  • the Sortings manager value. Selecting the value opens the Sortings Manager editor used to work with the sortings of a certain selector.
  • Commands used to work with the sortings:

Button

Command

Function

filter_entity_8.jpg

View Sorting / Edit Sorting

The operation executed by the command depends on the value selected in the Sorting field:

  • Save Settings in Explorer Tree command (array_entity_19.jpg). It is used to create an explorer tree user-defined item with the current filtering and sorting settings. For the operation details, refer to Creating User-Defined Item in Explorer Tree.


Filter Application

To apply a filter:

  1. Select the required filter in the Filter field.
  2. Define the objects filtering parameters in the filtering parameters area.
  3. Click the Apply Filter button located under the sorting and filtering panel or execute the Refresh command (view_23.jpg). The list of objects will be updated according to the selected filter conditions. If the selected filter does not have filtering parameters, the objects are filtered directly at the filter selection. Once the filter is applied, the View 24.jpg icon is changed to View 24 activ.jpg.

note.jpgThe standard operations, for example, Delete All Objects (view_27.jpg) are executed only for the objects that meet the current filter conditions.

Once the filter is applied, the Hide Filter Parameters and Show Filter Parameters buttons become available on the panel. It is possible to change the size of the filtering area by pressing the left mouse button and moving the splitter located under the Hide Filter Parameters and Show Filter Parameters buttons.

HideParam.jpg

It is also possible to save the selector object filters after hiding the filter and sorting panel. For this, set the Filters and sortings panel button behaviour parameter to the Keep filtering when hiding panel value in the selector settings (see section Application Appearance Setup).


Sorting Application

Sorting can be applied to the list of objects by:

  • Selecting the required sorting in the Sorting field of the filter and sorting panel.
  • Clicking the name of the required column in the object selector. The direction of the arrow right to the column name indicates the sorting order: up - ascending, down - descending.


After the sorting is applied, the list of objects is updated according to the sorting parameters.

note.jpgFor some columns, the sorting option can be unavailable.

Creating User-Defined Item in Explorer Tree

The user-defined items of the explorer navigation tree are created on the basis of the object selector opened in the tree and are used as additional navigation tool. The filtering and sorting parameters of the source item are inherited in the user-defined item at creation and can be further edited.

To create a user-defined item, use the Save Settings in Explorer Tree button (array_entity_19.jpg) that is available on the filter and sorting panel only after the filter in the object selector is applied. Clicking the button opens the dialog box used to specify the explorer item header. By default, the item header is as follows: <Source item name> with filter <Filter name>. The user-defined item is inserted into the tree under the source one.

If the user-defined item is created on the basis of the item opened in the context of the object (inserted into the tree from the object selector by using the Open in Tree button), a user-defined item with the same settings will be created when inserting an object from the same selector into the tree.

The user-defined item can be created on the basis of another user-defined item.

Exporting Selector Content

When executing the Export Selector Content command, the selector objects and their properties are saved to a file of the CSV or XLSX format.

To open the dialog box used for the export setup:

  • click export_selector.jpg on the selector toolbar
  • select the Selector | Export Selector Content in CSV Format on the menu
  • select the Selector | Export Selector Content in XLSX Format on the menu

exp_dialog.jpg

The export parameters are as follows:

  • File path. The path to the file to save the export result. The parameter is displayed only in RadixWare Desktop Explorer. In RadixWare Web Explorer, the file path is defined in a separate dialog box that is displayed after the CSV file is created.
  • File character set. The encoding in which the export file will be saved. The value is selected from the pre-defined list. The parameter is available when exporting the data to the CSV file.
  • Open file after export. If the flag is set, the file will be automatically opened after export. The parameter is available in RadixWare Desktop Explorer only when exporting the data to the XLSX file. The flag is set, by default.
  • Maximum rows. The maximum number of selector rows to be unloaded to a file. The default value is <unbounded>.
  • Time zone. The parameter is used to export data in the time zone different from the server time zone. The parameter is available when exporting the data to the XLSX file and if the data of Date format is present in the selector. The value is selected from the pre-defined list. By default, the time zone of the database is used.
  • The area used to create the list of columns to be exported is presented as a table with the following columns:
  • Column. The name of the column for which the export parameters are defined.
  • Output Format. The format in which the values of the current column will be saved. Available values:
  • Value. The value of the object property.
  • Base64. The object property value in the Base64 encoding. It is displayed for the following data types: binary, string and XML.
  • Displayed text. The text displayed in the selector field.
  • Enumeration item description. It is displayed for the Value from Set data type only.
  • Number '0' or '1' . It is displayed for the Boolean data type only.
  • String 'false' or 'true' . It is displayed for the Boolean data type only.
  • Export. The flag defines whether it is necessary to export the current column. By default, the flag is set for the columns that are displayed in the selector.

To set the order of saving the selector columns in the export file, use button_up.jpg / button_down.jpg (move a line one position up / down).

  • Export column headers. If the flag is set, the first line of the export file will contain the names of the selector columns.

Calculating Statistics

The Statistics command is used to calculate the statistics by the selector columns. When executing this command, a user is offered to calculate the information on values in the selector columns presented as real or integer numbers.

Note.jpg The command is not available in a tree-like selector.

To open the dialog box used to calculate statistics:

  • click Statistics.jpg on the selector toolbar
  • select the Selector | Statistics on the menu

Statistics dialog.jpg

In the opened dialog box, select the columns for which the statistics is calculated and values that must be calculated:

  • The Column includes the list of columns for which the statistics is calculated.
  • The following values can be calculated for each column:
    • Minimum value
    • Maximum value
    • Sum of values
    • Average value
If the flag is set in the header row of these columns, the values will be calculated for all columns included in Column. To calculate the value for a particular column, set the flag in the respective row.
  • Values accuracy. The precision (number of decimal places) of average value. The column is available and editable if the Average value flag is set.
  • Calculate number of rows. If the flag is set, the number of objects in the current selector will be calculated.

The dialog box containing the calculation results looks as follows:

Statistics dialog result.jpg

Click the Save button to save the statistics calculation result to the HTML file.


Selector Appearance

The selector is presented as a table with objects. The table has the following settings:

RadixWare Desktop Explorer

RadixWare Web Explorer

  • Columns Visibility. To customize the columns visibility, right-click the column header.

Context menu example:

adjustment_view_table.jpg

Example of the dialog box used for the columns visibility setup:

adjustment_view_table_web.jpg

The menu (dialog box) provides a set of available selector columns. If the flag is set, the respective column is displayed in the selector. The column whose visibility cannot be changed is highlighted gray.

  • Column Width. To change the column width, drag the boundary on the right side of the column.

The column-width policy mechanism is as follows:

  • The column-width policy defined in the software is effective until the user changes the column width manually.
  • When changing the column width manually, the last visible column becomes stretch and fills the space remaining.
  • The user can change the column width configured to fit to the content (the column-width policy defined for these columns in the software is By content). In this instance, the policy will change from By content to Manual. To revert the By content policy, double click the borderline between the columns.
  • The width adjusted by the user and the column-width policy settings changed due to this are saved between the explorer sessions.
  • Columns Arrangement. The selector columns can be interchanged. For this purpose, left-click and drag the column header to the required position. At that, the column being moved is placed right of the selected column.

To autofit the column width, left-click the required column while holding the Ctrl key.


To reset the settings of column visibility, width and arrangement (available only in RadixWare Desktop Explorer) to those defined by default, execute the Restore Default Settings command in the dialog box used to set up the selector columns visibility.

Note.jpg The user-defined settings of the RadixWare Web Explorer application, including the selector appearance settings (column visibility and width), are applied only to the current session if the local DB with the user-defined settings is not used. This DB is defined in the settingsDatabasePath parameter of section [WebPresentationServer] of the configuration file used to start up RadixWare Web Presentation Server.

For details on the parameter, refer to RadixWare Web Presentation Server. Administrator Guide / Configuration File Parameters.

In the RadixWare Desktop Explorer application, it is possible to add and set up the additional columns in the selector in the branch System Settings | Additional Selector Columns.