RadixWare Explorer User Guide/User Interface/Standart Dialog Boxes

From RadixWiki
Jump to: navigation, search

Introduction

A dialog box is a type of window used to enable communication between a user and control elements within the dialog boxes. The RadixWare Explorer provides a set of frequently used dialog boxes.

This section describes the standard dialog boxes:

Standard Dialog Box

Dialog Box in RadixWare Desktop Explorer

Dialog Box in RadixWare Web Explorer

Selecting Value from Set

+

-

Array Editor

+

+

Fixed Value Array Editor

+

+

Date and Time Editor

+

+

File Selection Dialog Box

+

+

Date and Time Format Editor

+

-

SQML Editor

+

-

Filters Manager

+

-

Filter Editor

+

-

Sortings Manager

+

-

Sorting Editor

+

-

XSLT Editor

+

-

XML Editor

+

-

Edit Mask Editor

+

-

MSDL Editor

+

-

Selecting Value from Set

The dialog box is used to edit the object properties that can have only the set of values predefined by the system. The field where the predefined values can be entered has the Array entity 21.jpg button.

The dialog box used to select the value from the set looks as follows:

Value from set.jpg

The dialog box contains the following elements:

  • Filter area. The filter for the available values of the object property.
  • Set of available values. The list of the object property values predefined by the system.
  • Sort flag. If the flag is set, the elements in the list are sorted in the alphabetical order by names. The flag is not available for elements sorted by default.


Array Editor

The value array entry field contains array_entity_3.jpg button.

The dialog box of the array editor looks as follows:

array_edit_3.jpg

The dialog box header displays the name of the parameter being edited.


The dialog box of the array editor contains:

  • the field with the list of array items
  • the buttons used to edit the array items and change the array state

To work in the array editor, use the following buttons:

Button

Command

Function

array_edit_4.jpg

Insert New Item

Inserts a new item to the array. The item entry method depends on the type of data being entered (refer to Data Entry Fields).

array_edit_1.jpg

Insert Empty Item

Inserts an item with the <none> value to the array

note.jpgThe button is available not in all the array editors.

array_edit_5.jpg

Delete Current Item

Deletes the selected item from the list

array_edit_6.jpg

Delete All Items

Deletes all array items from the list

array_edit_7.jpg

Clear Value

Deletes all array items and changes the array state to <not defined> (see below). The button changes to the Define Value button (array_edit_8.jpg).

array_edit_8.jpg

Define Value

Changes the array state to Empty (see below). The button changes to the Clear Value button (array_edit_7.jpg).

button_up.jpg

Move Item Up

Moves the selected array item one position up

button_down.jpg

Move Item Down

Moves the selected array item one position down

To edit the selected array item, double-click on it. At that, the field will contain the respective data entry control element.

To complete the array editing and save all the changes, click OK. To exit the dialog box without saving the changes, click Cancel.


The value array can have several states. Depending on the array state, certain commands are available in the array editor.

The table below describes the array states and available actions that can be executed in the array editor in each state:

Array State

Description

Available Actions

Not defined

The array is not defined.

The value in the data entry field of the array is <not defined>.

  • Adding new items to the array (array_edit_4.jpg). At that, the array state changes to Defined.
  • Adding an empty item (array_edit_1.jpg).
  • Changing the array state to Empty (array_edit_8.jpg).
Empty

The array is defined but does not contain a single item.

The data entry field is empty or has the <not defined> value.

  • Adding new items to the array (array_edit_4.jpg). At that, the array state changes to Defined.
  • Adding an empty item (array_edit_1.jpg).
  • Changing the array state to Not defined (array_edit_7.jpg).

Defined

The array is defined and contains at least one item.

The data entry field contains the array values separated by semi-colon.

  • Adding new items to the array (array_edit_4.jpg).
  • Adding an empty item (array_edit_1.jpg).
  • Deleting an item (array_edit_5.jpg).
  • Deleting all the items (array_edit_6.jpg). At that, the array state changes to Empty.
  • Changing the array state to Not defined ( array_edit_7.jpg).
  • Moving items up / down (button_up.jpg / button_down.jpg).

Fixed Value Array Editor

The fixed value array editor is a sub-type of the array editor. It is used to define the array for the object properties that can take on the values from the set of fixed (pre-defined in the system) values only. The value array entry field contains array_entity_3.jpg button.

The dialog box of the fixed value array editor looks as follows:

array_edit_9.jpg

The dialog box of the array editor contains:

  • the Available Items area with the list of available values for an object property
  • the Selected Items area with the list of object property values defined by the user
  • the array item control elements:

Button

Command

Function

view_16.jpg

Select Item(s)

Adds the selected item to the array. The command moves the item from the Available Items area to the Selected Items area.

It is also possible to add the selected item to the array by double-clicking on it.

view_15.jpg

Unselect Item(s)

Deletes the selected item from the array. The command moves the item from the Selected Items area to the Available Items area.

It is also possible to delete the selected item from the array by double-clicking on it.

view_39.jpg

Select All Items

Adds all the items to the array. The command moves all the items located in the Available Items area to the Selected Items area.

view_40.jpg

Unselect All Items

Deletes all the items from the array. The command moves all the items located in the Selected Items area to the Available Items area.

button_up.jpg

Move Item Up

Moves the selected array item one position up

button_down.jpg

Move Item Down

Moves the selected array item one position down

array_edit_6.jpg

Delete All Items

Deletes all array items from the list

array_edit_7.jpg

Clear Value

Deletes all array items and changes the array state to Not defined. The button changes to the Define Value button.

array_edit_8.jpg

Define Value

Changes the array state to Empty. The button changes to the Clear Value button.

Date and Time Editor

Clicking the array_entity_11.jpg button in the data entry field opens the dialog box used to specify the date and/or time:

Dateandtime 1 .jpg

Dateandtime 1 web .jpg

RadixWare Desktop Explorer

RadixWare Web Explorer


The dialog box contains the following elements:

  • Date. When opening the dialog box the editor displays either the current date or the date specified in the data entry field: the month and year are displayed at the top of the dialog box, the date is highlighted in the table of dates.

The first column in the table contains the week numbers (in the RadixWare Desktop Explorer application only). The days of the month are arranged according to the week days from Sunday (Sun) to Saturday (Sat).

Clicking dateandtime_2.jpg / dateandtime_3.jpg button moves one month backward / forward respectively with regard to the month specified at the top of the dialog box. At that, the table of dates is updated automatically. It is also possible to change the month by hovering over the month name to transform it to dateandtime_4.jpg button. Clicking the button opens the drop-down list of months.

When hovering over the year, dateandtime_5.jpg field is displayed. The field is used to enter the required value either from keyboard or by searching through the list of values. After the required value of the year is entered, the table of dates is updated automatically.

To select the date, click the respective value in the table of dates.

  • Time. The time parameters (hours/minutes/seconds) are entered from keyboard. For the RadixWare Desktop Explorer, the values can be entered by searching through the values of each parameter. To enter/edit the parameter, select it using the cursor.

Searching through the parameter values has no periodicity, i.e.:

  • hours are searched for within the range from 00 to 23
  • minutes - from 00 to 59
  • seconds - from 00 to 59
  • Time zone. The time zone of the date and time in the current modal dialog box. Available values:
  • Server time zone (default value)
  • Client time zone
  • Other time zone. If this value is specified, the system displays the list of available time zones for selection.


To work in the dialog box, use the following buttons:

Button

Function

dateandtime_6.jpg

Closes the dialog box and sets the specified date and time

dateandtime_7.jpg

Closes the dialog box without setting the specified date and time

dateandtime_8.jpg

Closes the dialog box and deletes the specified date and time (in the RadixWare Desktop Explorer only)

dateandtime_9.jpg

Sets the current date and time

dateandtime_10.jpg

Cancels all the changes made in the dialog box

It is possible to set the current date and time without using the date/time editor, by clicking the Set Current Date and Time button (Button now.jpg) next to the button used to open the date/time editor.

File Selection Dialog Box

The file selection dialog box is used to select the file the information will be saved to or loaded from. The dialog box appearance depends on the operating system (OS) and is the OS standard dialog box.

For Windows OS, the dialog box looks as follows:

Date and Time Format Editor

The editor is available in the RadixWare Desktop Explorer.

Clicking Array entity 15.jpg button in the data entry field opens the editor dialog box used to set up the date and time display format. For example, in the report settings, the editor is used to define the format for the name of the file being saved.

The formats supported by the SimpleDateFormat Java library are used in the editor.

The dialog box of the editor looks as follows:

Datetimeformateditor.jpg

The dialog box contains the following elements:

  • Format. The parameter field is used to define the format.
  • Result. The parameter field displays the current date and time in the format defined in the Format parameter.
  • Format description. The area contains the table describing the characters that can be used when defining the format, as well as the format examples.

SQML Editor

The editor is available in the RadixWare Desktop Explorer.

The SQML editor is used:

  • in the data entry fields to define the conditions for objects selection from the database
  • in the filter editor to define the selector objects filtering conditions


The object selection conditions are defined by means of the SQML language (Structured Query Markup Language) that is a text written in the SQL language with the inserted tags. For details on the tags usage, refer to Appendix А. JML and SQML Tags.


The SQML editor looks as follows:

RedactorSQML 13 .jpg

The editor contains the following elements:

Editing Area

The area is used to describe the objects selection condition in the SQML language.

To create / edit the condition text, use the following toolbar buttons:
Commands for tag insertion: When executing the command of this type, the definition selection dialog box opens. The dialog box contains:

  • the list of definitions. For each definition, the name of the module / table the definition belongs to is displayed.
  • the Find field used to search for the required definition.

The inserted tag is editable. For this purpose, open the editor dialog box by one of the following ways:

  • by double-clicking the inserted tag
  • by means of the Edit Tag context menu (see below)

Button

Command

Function

add_id.jpg

Insert ID

The button contains the following context menu:

  • Table. The command inserts a tag referring to the table ID. When executing the command, the definition selection dialog box displays the list of database tables.
  • Property. The command inserts a tag referring to the table property ID. When executing the command, the definition selection dialog box displays the list of database tables and the list of columns for each table.
  • Class. The command inserts a tag referring to the class ID. When executing the command, the definition selection dialog box displays the list of classes.
  • Domain. The command inserts a tag referring to the domain ID. When executing the command, the definition selection dialog box displays the list of domains.

redactorsqml_6.jpg

Insert Table

Inserts a tag referring to the table definition. When executing the command, the definition selection dialog box displays the list of database tables.

To edit the tag, use the Table Tag Editor dialog box with the following parameters:

  • Table. The table definition. The table can be re-selected.
  • Table alias. The alias for the table definition can be entered.

redactorsqml_7.jpg

Insert Column

Inserts a tag referring to the table column. When executing the command, the definition selection dialog box displays the list of database tables and the list of columns for each table.

To edit the tag, use the Property Tag Editor dialog box with the following parameters:

  • Property. The table column. The column can be re-selected.
  • Property alias. The column alias can be entered.

redactorsqml_8.jpg

Insert Constant

Inserts a tag referring to the constant. When executing the command, the definition selection dialog box displays the list of constants grouped into sets.

To edit the tag, use the Constant Set Item dialog box with the following parameters:

  • Constant set. The constant set definition. The parameter is not editable.
  • Constant set item. The constant can be re-selected from the list of items of the current set.

add_func.jpg

Insert SQL Function Call

Inserts an SQL function call tag. When executing the command, the SQL Function Call Tag dialog box opens. The dialog box contains the following parameters:

  • Function. Clicking array_entity_15.jpg button opens the SQL function selection dialog box.
  • Define parameters flag. If the flag is set, it is possible to define the function parameters. The defined parameters are presented as a table with the following columns:
    • Name. The parameter name. The value is not editable.
    • Value. The parameter value can be entered.

The SQL Function Call Tag dialog box looks as follows:

redactorsqml_20.jpg

redactorsqml_9.jpg

Insert Context Table Reference

Inserts a tag referring to the context table.

To edit the tag, use the Context Table Reference Tag dialog box where the PID translation area contains the following parameters:

  • PID translation mode. The value is selected from the drop-down list. Available values:
    • PK string representation
    • Primary key column(s)
    • Secondary key column(s)
  • Secondary key. The secondary key value. The value can be re-selected by means of the drop-down list.

redactorsqml_10.jpg

Insert Entity Reference Value

Inserts a tag referring to the entity object. When executing the command, the following dialog boxes open sequentially: database table definition selection dialog box, selector with the list of objects for the selected database table.

To edit the tag, use the Entity Object Reference dialog box with the following parameters:

  • Referenced object. The object can be re-selected.
  • Name displayed. The object name to be displayed in the editor. The display format is as follows: <specified name>.PID.
  • PID translation mode. The value is selected from the drop-down list. Available values:
    • PK string representation
    • Primary key column(s)
  • Secondary key. The secondary key value. The value can be re-selected by means of the drop-down list.

redactorsqml_21.jpg

Insert Event Code

Inserts a tag referring to the event code. When executing the command, the definition selection dialog box displays the list of available event codes.

When editing the tag, the definition selection dialog box opens.

Export 1.jpg

Export Condition

Exports the condition text to the XML file.

Import 1.jpg

Import Condition

Imports the condition text from the XML file.


Command for SQL code preview:

Button

Command

Function

redactorsqml_23.jpg

View Translation Result

Allows viewing the condition of the SQL query generated on the basis of the current SQML code. The command execution result is displayed as an SQL query of the following format:

SELECT * FROM table WHERE <object selection condition>

Commands for tags visual representation change:

Button

Command

Function

filters_manager_13.jpg

Display Mode

The button contains the context menu with the following display modes:

  • Display short object names. The constant tag is displayed as follows: DialogType:Error.
  • Display full object names. The object name contains the name of the module / table the definition belongs to. The constant tag is displayed as follows:: Radix::Client.Resources::DialogType:Error. When selecting this display mode, the button appearance changes to filters_manager_12.jpg.
  • Display object names. The constant tag is displayed as follows: DialogType:Error.

Command for table attachment:

Button

Command

Function

redactorsqml_22.jpg

Attach Table

Creates an alias for the selected table. When executing the command, the Attaching Table dialog box opens. The dialog box contains the following parameters:

  • Table. The table definition.
  • Alias. The table alias can be entered.

After the command is executed, the branch with the list of properties for the selected table is inserted into the properties tree (the Properties page). The tag inserted from the branch will contain the table alias.


To edit the condition text, use the context menu with the following commands:

Context Menu Item

Function

Edit Tag

Opens the tag editor dialog box (see above)

Undo

Undoes the last executed action - Ctrl+Z

Redo

Redoes the last undone action - Ctrl+Y

Cut

Cuts the text selection, and stores it in clipboard - Ctrl+X

Copy

Copies the text selection to clipboard - Ctrl+C

Paste

Pastes the text from clipboard - Ctrl+V

Delete

Deletes the text selection

Select All

Selects all the text - Ctrl+A

Copy as Xml Text

Copies the text in the XML format

"Properties" Page

The Properties page of the SQML editor contains the list of properties for a context entity and the respective control elements. The page presence in the SQML editor depends on the editor usage context.

To work with the properties, use the following buttons:

Button

Command

Function

redactorsqml_11.jpg

Add Tag

Inserts a tag referring to the selected property of an object into the editor

redactorsqml_12.jpg

Add Condition

Inserts a selection condition by the context object property value into the editor. When executing the command, the Edit Condition dialog box opens. The dialog box contains the following parameters:

  • Property. The value is set automatically depending on the selected property.
  • Operation. The operator type. The value is selected from the drop-down list containing the following operator:
    • = , <>, <, >, <=, >= - comparison operators
    • is null - operator comparing the current value of the property with the null value
    • is not null - operator negating the is null operator
    • in - operator defining the values list to which the property values must be included
    • not in - operator negating the in operator
    • like - operator comparing the property character value with the pattern
    • between - operator defining the property value range

The list of operators differs depending on the property type.

  • Value. The parameter is used to specify the value of the property for the selection condition. The possibility to enter the value depends on the operator used in the condition:
  • is null

–The value cannot be entered.

  • is not null

–The value cannot be entered.

  • =

–The property value can be entered by means of the control element that depends on the type of data being entered.

  • <>

–The property value can be entered by means of the control element that depends on the type of data being entered.

  • in

–The property value can be entered by means of the array editor.

  • not in

–The property value can be entered by means of the array editor.

  • <

–The property value can be entered by means of the control element that depends on the data being entered.

  • >

–The property value can be entered by means of the control element that depends on the type of data being entered.

  • <=

–The property value can be entered by means of the control element that depends on the type of data being entered.

  • >=

–The property value can be entered by means of the control element that depends on the type of data being entered.

  • like

–The property value can be entered. Depending on the data type, the value can be defined:

  • as text. The following special characters can be used:
    • underline character (_) that replaces a single character
    • percent sign (%) that replaces a sequence of any number of characters
  • as number
  • the value can be selected from the drop-down list if the object property has the list of values pre-defined in the system.
  • between

–When selecting the between operator, the current parameter name is changed to Range. The start and end values of the property must be entered into the parameter field. The values are entered by means of the control element that depends on the type of data being entered.

The described condition is displayed in the following format: <Property tag> <Operator> <Value>.

The value can be edited in the Edit Value dialog box opened by double-clicking on the defined value. The dialog box contains the following parameters:

  • Property. The property can be re-selected.
  • Value. The property value can be re-defined.

"Parameters" Page

The Parameters page presence in the SQML editor depends on the editor usage context. In particular, the page is available if the SQML editor is used to create / edit filters (in the context of the filter editor). In this case, the page is used to create, edit, and view the object filtering parameters. The parameters are used to describe the object selection conditions and are available in the filter parameters area of the filter and sorting panel.

The Parameters page contains the list of parameters for the current SQML condition and the respective control elements:

Button

Command

Function

array_entity_14.jpg

Create Parameter

Opens the Condition Parameter Creation Wizard that allows creating:

  • parameters whose attributes are derived from the context object property
  • parameters with the user-defined attributes

The procedure of creating a parameter in the wizard consists of several stages that are described below. To move between the stages, use the Next, Back and Cancel buttons.

filters_manager_5.jpg

Delete Parameter

Deletes the parameter selected in the list

filters_manager_11.jpg

Edit Parameter

Opens the dialog box for editing the selected parameter. The dialog box contains the attributes defined at the parameter creation. The attribute values are editable.

button_up.jpg / button_down.jpg

Move Parameter Up / Move Parameter Down

Moves the parameter one position up / down in the list. The buttons are used to change the filtering parameters order on the filter and sorting panel.

redactorsqml_11.jpg

Add Tag

Inserts a tag referring to the filter parameter into the editor area

RedactorSQML 24.jpg

Add Count of Values in Parameter

Inserts a tag calculating the number of values in the parameter. The tag is translated to the parameter of SQL request as follows:

  • If the parameter value is null, the value of SQL parameter is -1.
  • If the parameter value is an array, the value of SQL parameter is equal to the number of array elements.
  • In other cases, the value of SQL parameter is 1.


Creating Parameter with Derived Attributes

To create a parameter with the derived attributes, follow the steps:

1.Set the Property-based parameter flag:

redactorsqml_14.jpg

2.Select the property / column the parameter will be based on. For this purpose, use the respective dialog box containing:

  • the list of columns and properties for the context table
  • the Find field to search for the required column / property

The dialog box looks as follows:

redactorsqml_16.jpg


3.Define the following parameter attributes:

  • Name. The parameter name. The parameter is mandatory.
  • Value must be defined. If the flag is set, the parameter being created will be mandatory.
  • Additional condition. The condition is defined in the SQML editor and is available only when creating a parameter of Object reference type.
  • Editing mode for filter parameter value. The parameter is available only for the parameters of Object reference type. Available values:
    • Inherit from property (Modal dialog)
    • Modal dialog
    • Drop-down list
  • Default value. The parameter value to be used by default. The value is defined by means of the control element that depends on the type of data being entered. The attribute may be absent.
  • Constant value defined. If the flag is set, the parameter will have the constant value specified in the Constant value parameter.
  • Constant value. The constant value of the parameter. The value is defined by means of the control element that depends on the property data type. The parameter is available if Constant value defined flag is set, and is mandatory if the Value must be defined flag is set.

The dialog box looks as follows:
RedactorSQML 17 .jpg

4.Click the Finish button.


Creating Parameter with User-Defined Attributes

To create a user-defined parameter in the Condition Parameter Creation Wizard dialog box, follow the steps:

1.Set the User-defined parameter flag:

redactorsqml_15.jpg

2.Select the type of the parameter value from the list of available types:

RedactorSQML 18.jpg

3.Define the following parameter attributes:

  • Name. The parameter name. The parameter is mandatory.
  • Value must be defined. If the flag is set, the parameter being created will be mandatory.
  • Enumeration. The set of constants that will be used as the predefined parameter values. The set is selected in the dialog box for the constants set definition selection. The parameter is available only for the following parameter value types: string, character, integer.
  • Edit mask. The parameter is used to define the parameter value input mask. The mask is defined in the Edit Mask Editor dialog box. The parameter is available only for the following parameter value types: string, character, date/time, integer, decimal.
  • Display instead of '<Not defined>' . The text to be displayed in the parameter field if the parameter value is set to <not defined>.
  • Presentation. The selector presentation that will be available in the parameter for the entity object selection. The presentation is selected in the Selector Presentation dialog box. The parameter is mandatory and available only for the object reference parameter value type.
  • Additional condition. The condition is defined in the SQML editor and is available only when creating a parameter of Object reference type.
  • Editing mode for filter parameter value. The parameter is available only for the parameters of Object reference type. Available values:
    • Modal dialog
    • Drop-down list
  • Default value. The parameter value to be used by default. The value is defined by means of the control element that depends on the parameter value type. If the type of the parameter value and the data type of the specified constant set do not match, the attribute field displays an error message. The parameter is available for all parameter value types except for object reference.
  • Constant value defined flag. If the flag is set, the parameter will have the constant value specified in the Constant value parameter.
  • Constant value. The constant value of the parameter. The value is defined by means of the control element that depends on the parameter type. The parameter is available if Constant value defined flag is set, and is mandatory if the Value must be defined flag is set.

The dialog box looks as follows:

RedactorSQML 19 .jpg

4.Click the Finish button.

Filters Manager

The editor is available in the RadixWare Desktop Explorer.


The Filters Manager editor is used to create the list of filters and view filtering conditions.

To open the editor, use the filter and sorting panel:

  • in the Filter field, select the Filters manager value from the drop-down list
  • in the Filter field, select the <none> value from the drop-down list

The Filters Manager dialog box looks as follows:

filters_manager_2.jpg

The dialog box contains the following elements:

Area Containing Filters List

The area contains the list of filters applied in the current selector and the respective control commands.

The list of filters can be arranged by the user in the following way: filters can be visible at the first level in the list or included into the group of filters.

The names of base and common filters are highlighted in bold. The filters in the list 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 and complex filters

filter_entity_6.jpg

Common filter

To manage the list of filters, use the following buttons:

Button

Command

Function

filters_manager_3.jpg

Create Filter

Creates a user-defined filter. During the command execution, the filter editor opens. It is used to define the filtering conditions. In this case, the editor operates in the user-defined filter editing mode. The created filter is automatically added to the filters list.

Depending on the context, the filter can be created:

  • at the first level if the cursor is outside the filters group
  • in the filters group if the cursor is inside the group

filters_manager_4.jpg

Create Filters Group

Creates a group of filters.

The group name can be edited by double-clicking on it.

filters_manager_8.jpg

Create Filter in Current Group

Creates a user-defined filter in the current group. During the command execution, the filter editor opens. The editor operates in the user-defined filter editing mode.

If the cursor is hovered over the group name, the command contains the context menu with the following commands: Create Filter (creates a first-level filter) and Create Filter in Current Group.

filters_manager_10.jpg

Qualify Predefined Filter

Creates a complex filter on the basis of the base one. During the command execution, the filter editor opens. It is used to define the refining conditions. The editor operates in the complex filter editing mode. The command is available for the base filters only.

The command execution result is a filter containing the base filter conditions and user-defined conditions joined by the AND logical operator.

filters_manager_6.jpg

Export Filter

Unloads the current filter to a file of the XML format. During the command execution, the standard file selection dialog box opens.

filters_manager_7.jpg

Import Filter

Loads the filters from a file of the XML format. During the command execution, the standard file selection dialog box opens.

Filters manager 7 5.jpg

Convert to Common Filter

Converts the current user-defined filter to a common one.

filters_manager_5.jpg

Remove

Removes the filter / group of filters selected in the list. The command is available for the user-defined and complex filters only.

button_up.jpg / button_down.jpg

Move Up / Move Down

Moves the filter / group of filters up / down the list

View Area

The area displays filtering conditions described in the SQML language.

note.jpgFor common filters, the filtering condition is not displayed.

The area provides the following commands:

Button

Command

Function

filters_manager_11.jpg

Edit

The command is available for the user-defined and complex filters only. During the command execution, the filter editor opens. Depending on the filter type, the editor operates in one of the following modes:

  • user-defined filter editing mode
  • complex filter editing mode

The editor can be also opened by double-clicking the filter name.

filters_manager_13.jpg

Display Mode

The button contains the context menu with the list of tag display modes:

  • Display short object names. The condition is displayed as follows: undoState = UndoState:Undo.
  • Display full object names. The condition is displayed as follows: undoState = TX::Tran:: UndoState:Undo. When the mode is selected, the button appearance changes to filters_manager_12.jpg.
  • Display object names. The condition is displayed as follows: Undo state = UndoState:Undo.

Filter Editor

The editor is available in the RadixWare Desktop Explorer.

The filter editor is used to view / edit the object filtering conditions.

Depending on the filter type, the editor can operate in one of the following modes:

  • Filter view mode that is used to work with the base filter type.
  • User-defined filter editing mode that is used to work with the user-defined filter type.
  • Complex filter editing mode that is used to work with the complex filter type.

The editor dialog box elements for each mode are described below.


Filter View Mode

In this mode, the filter editor looks as follows:

zoom out

The editor dialog box contains the following elements:

  • Name parameter. The name of the base filter. The value is not editable.
  • Predefined Condition area displaying the base filter condition. The filtering conditions are not editable. To change the tags visual representation, use the Display Mode command (filters_manager_13.jpg). For the command description, refer to Filters Manager.


User-Defined Filter Editing Mode

This mode is used to define / adjust the user-defined filter conditions.

The editor dialog box looks as follows:

zoom out

The editor dialog box contains the following elements:

  • Name parameter. The name of the user-defined filter. The value is editable.
  • User-Defined Condition area. The area is a standard SQML editor used to describe the filtering condition in the SQML language.


Complex Filter Editing Mode

This mode is used to define / adjust the user-defined conditions of the complex filter type.

The editor dialog box looks as follows:

zoom out

The editor dialog box contains the following elements:

  • Name parameter. The filter name. The value is editable.
  • Predefined Condition area displaying the base filter condition. The filtering conditions are not editable. To change the tags visual representation, use the Display Mode command (filters_manager_13.jpg). For the command description, refer to Filters Manager.
  • User-Defined Condition area. The area is a standard SQML editor used to describe the filtering condition in the SQML language.

The Parameters page of the SQML editor contains the list of filtering parameters used in the base filter. It is possible to use properties of the parent object when creating a filter for the child object using the following predefined parameters:

  • parentEntityPid – identifier of the parent entity in DB.
  • parentEntityId – identifier of the parent entity table.
  • explorerItemId – identifier of the explorer object where the selector is opened.

It is also possible to create own parameters on this page. The base filter parameters can have constant values that will be used by default when working with the complex filter. To set the constant value, use the Constant value defined, Constant value attributes in the dialog box for the parameter editing (filters_manager_11.jpg).

Sortings Manager

The editor is available in the RadixWare Desktop Explorer.

The Sortings Manager editor is used to create the list of sortings and view sorting parameters.

To open the editor, use the filter and sorting panel. For this purpose, in the Sorting field, select the Sortings manager value from the drop-down list.

The Sortings Manager dialog box looks as follows:

sortings_manager_1.jpg

The dialog box contains the following elements:

Area Containing Sortings List

The area contains the list of sortings applied in the current selector and the respective control commands.

The names of base sortings are highlighted in bold. The sortings in the list 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

To manage the list of sortings, use the following buttons:

Button

Command

Function

create_entity_1.jpg

Create Sorting

Creates a user-defined sorting. During the command execution, the sorting editor opens. It is used to define the parameters of the selector objects sorting. The editor operates in the editing mode. The created sorting is automatically added to the sortings list.

filters_manager_5.jpg

Remove

Removes the sorting selected in the list. The command is available for the user-defined sortings only.

array_entity_3.jpg

Edit Sorting

The command is available for the user-defined sortings only. During the command execution, the sorting editor opens. The editor operates in the editing mode.

The editor can be also opened by double-clicking on the sorting name.

View Area

The area displays the parameters used to sort the objects in the selector. The parameters are presented as a table listing the selector columns and the sorting order for each column. The parameters are not editable.

Sorting Editor

The editor is available in the RadixWare Desktop Explorer.

The sorting editor is used to view / edit the object sorting parameters. Depending on the sorting type, the editor can operate in one of the following modes:

  • View mode that is used to work with the base sorting type.
  • Editing mode that is used to work with the user-defined sorting type.

The editor dialog box elements for each mode are described below.

View Mode

In this mode, the sorting editor looks as follows:

Sortings Editor.jpg

The editor dialog box contains the following elements:

  • Sorting By parameter. The name of base sorting. The value is not editable.
  • Selected Columns area displaying the sorting parameters presented as a table. The table lists the columns by which the objects are sorted in the selector and the sorting order for each column. The sorting parameters are not editable.

Editing Mode

In this mode, the sorting editor looks as follows:

Sortings editor 1.jpg

The editor dialog box contains the following elements:

  • Sorting By parameter. The name of user-defined sorting. When creating a sorting, the default value is New Sorting. The value is editable.
  • Available Columns area displaying the list of object properties (selector columns) by which the objects can be sorted, and the respective control elements:
Button Function
View 16.jpg Adds the column selected in the Available Columns area to the sorting parameters
View 15.jpg Removes the column selected in the Selected Columns area from the sorting parameters
  • Selected Columns area displaying the sorting parameters presented as a table with the following columns:
    • Column. The name of the column by which the objects will be sorted.
    • Sorting Order. To select the value, double-click on the table cell. Available values:
      • Ascending
      • Descending

It is possible to set up sorting by several columns. At that, the columns order in the table affects the sequence of applying sorting to the objects: first, the objects are sorted by the property specified in the first row, then each group of sorted objects is sorted by the next property, etc. To specify the sequence of applying sorting to the objects, use the following control elements:

Button Function
Button up.jpg Moves the selected column one position up
Button down.jpg Moves the selected column one position down

It is possible to link the user-defined sorting to a certain selector column. This facility allows to apply the user-defined sorting to a column by clicking the left mouse button on the required column name. For this, define the following parameters in the dialog box used to edit the user-defined sorting:

  • Associated selector column. The list of names of selector columns for which the user-defined sorting is created/edited. The default value is <not defined>.
  • Selection column sorting order. The parameter is available if the Associated selector column parameter is defined. The available values include: Ascending (default value), Descending.

XSLT Editor

The editor is available in the RadixWare Desktop Explorer.

The XSLT editor is used to create the XSLT style sheets (eXtensible Stylesheet Language Transformations) to convert XML documents to HTML documents. The XSLT editor looks as follows:

XSLT-redactor.jpg

The editor contains the area used for the XSLT style sheet creation. The area content is presented as text.

XML Editor

The editor is available in the RadixWare Desktop Explorer.

The editor is used to view, create and edit the documents written in the XML language (eXtensible Markup Language).

The XML editor looks as follows:

xml_redactor_16.jpg

The XML editor contains the following elements:

  • Menu
  • Toolbar
  • Editing area used to view / edit the XML document

Depending on the context, the XML editor operates in one of following modes:

  • View mode. The RadixWare Desktop Explorer opens the XML editor in this mode if the XML document cannot be edited by the user. In this mode, the menu item commands and toolbar buttons for the XML document editing are not available.
  • Editing mode. The RadixWare Desktop Explorer opens the XML editor in this mode if the XML document can be edited by the user.

In addition, the XML editor supports several modes of the XML document representation in the editing area:

To switch between the modes, use the respective buttons on the XML editor toolbar (see below).

note.jpgThe facility to change the XML document representation mode is available in any of the XML editor operation modes.


Editor Menu and Toolbar

To work in the editor, use the menu item commands and toolbar buttons.

The editor menu contains the following items and commands:

Menu Item

Menu Item Command

Command Icon

Function

General

Validate

xml_redactor_1.jpg

Validates the following:

  • XML document formatting, i.e. the document content compliance with the XML specification.
  • document compliance with the XML schema (note.jpg XML schema defines the set of available nodes and their content, set of available attributes, data types for the attribute values).

If an error is detected, the XML editor displays the Error table in the editing area. The Code and Message columns of the table contain the information on each error: the error code and description respectively.

Edit

Contains the commands to work with the XML document presented as text. The commands are available if the following conditions are met simultaneously:

  • the XML editor operates in the editing mode
  • the text-like representation mode is enabled (xml_redactor_3.jpg button is clicked)

Tree

Contains the commands to work with the XML document presented as tree. The commands are available if the following conditions are met simultaneously:

  • the XML editor operates in the editing mode
  • the tree-like representation mode is enabled (xml_redactor_2.jpg button is clicked)

The editor toolbar contains the following buttons:

Button

Command

Function

xml_redactor_1.jpg

Validate

Validates the XML document. The command is similar to the Validate menu item command.

Buttons used to manage the XML document representation mode in the editing area:

xml_redactor_2.jpg

Tree Mode

Enables the tree-like representation mode

xml_redactor_3.jpg

Text Mode

Enables the text-like representation mode

xml_redactor_4.jpg

Formatted Text

Enables the formatted text representation mode

Buttons used to work with XML files:

xml_redactor_5.jpg

Open Document from File

Loads the XML document from a file. When executing the command, the file selection dialog box is displayed.

xml_redactor_6.jpg

Save Document to File

Saves the XML document to a file. When executing the command, the file selection dialog box is displayed.

To display the available values in the commands of adding nodes/attributes, the Maximum number of items in drop-down list parameter of appearance settings is used: if the number of available nodes/attributes exceeds the parameter value, the modal dialog box for selecting the value from the list is displayed instead of the drop-down list.

Tree-Like Representation Mode

The editing area in this mode is presented as a table with the following columns:

  • Name. The column contains the XML document elements and attributes arranged as a tree.
  • Value. The column contains the values of the respective attributes included into the XML document. If the XML editor operates in the editing mode, the attribute values in this column can be entered / edited. To enter the value, use the respective control element. The control element appearance depends on the type of data being entered.

To work with the XML document (if the XML editor is in the editing mode), use the Tree menu item commands, toolbar buttons and commands of the editing area context menu.

The table below describes the Tree menu item commands, toolbar buttons and context menu commands:

Command of Menu Item / Toolbar / Context Menu

Command Icon in Menu Item / Toolbar Button

Function

Add Node

xml_redactor_12.jpg

Adds a node to the current level of the tree-like structure. To select the node, use the button/command context menu containing the list of available nodes.

note.jpgThe set of available nodes is defined by the XML schema.

The button/command is available if the cursor is over the second or lower level of the tree-like structure, and if not all of the available nodes are defined for the parent one.

To change the node tag, use the Change Tag to command (see below) in the editing area context menu.

Add Child Node

xml_redactor_13.jpg

Adds a child node to the current one. To select the node, use the button/command context menu containing the list of available nodes.

note.jpgThe set of available nodes is defined by the XML schema.

The button/command is available if the cursor is over the node, and if not all of the child nodes are defined for a certain node.

To change the node tag, use the Change Tag to command (see below) in the editing area context menu.

Add Attribute to Parent

xml_redactor_14.jpg

Adds an attribute to the node that is parent in relation to the current node/attribute, that is:

  • If the cursor is over the node, the button/command adds an attribute to the parent node (the node located one level higher).
  • If the cursor is over the attribute, the button/command adds an attribute to the current node.

To select the attribute, use the button/command context menu containing the list of available attributes.

note.jpgThe set of available attributes is defined by the XML schema.

The button/command is not available if all of the available attributes are defined for the parent node.

Add Attribute to Child

xml_redactor_15.jpg

Adds an attribute to the current node.

To select the attribute, use the button/command context menu containing the list of available attributes.

note.jpgThe set of available attributes is defined by the XML schema. The button/command is available if the cursor is over the node, and if not all of the available attributes are defined for a certain node.

Delete Node

view_28.jpg

Deletes the selected node/attribute from the XML document.

note.jpgThe command is available only in the editing area context menu and if the cursor is over the node.

Change Tag to

-

Changes the tag of the selected node. The command contains the context menu with the list of available tag names.

note.jpgThe command is available only in the editing area context menu and if the cursor is over the node.

Text-Like Representation Mode

The editing area in this mode contains the XML document presented as text.

To work with the XML document (if the XML editor is in the editing mode), use the Edit menu item commands and toolbar buttons.

The table below describes the Edit menu item commands and the respective toolbar buttons:

Command of Menu Item / Toolbar

Command Icon in Menu Item / Toolbar Button

Function

Cut Selected Text

xml_redactor_7.jpg

Cuts the text selection, and stores it in clipboard - Ctrl+X.

Copy to Clipboard

xml_redactor_8.jpg

Copies the text selection to clipboard - Ctrl+C.

Paste from Clipboard

xml_redactor_9.jpg

Pastes the text from clipboard - Ctrl+V.

Undo Last Operation

xml_redactor_10.jpg

Undoes the last executed action - Ctrl+Z.

Redo Last Operation

xml_redactor_11.jpg

Redoes the last undone action - Ctrl+Y.

Format Text

format_text.jpg

Converts the text to a readable format.

The editing area in this mode contains the context menu with the commands used to manage the text data. The context menu commands duplicate the commands described above.

Formatted Text Representation Mode

The editing area in this mode contains the XML document presented as text formatted for visibility purpose. In this mode, the XML document is not available for editing.

Edit Mask Editor

The editor is available in the RadixWare Desktop Explorer.

The edit mask editor is used to define the filtering parameter value input mask with the user-defined attributes (for the filtering parameter details, refer to SQML Editor). The edit mask with the user-defined attributes can be defined only for the following types of parameters:

  • string
  • character
  • integer
  • decimal
  • date and time

The editor appearance depends on the parameter type.

Edit Mask Editor for String and Character Parameter Types

The edit mask editor for the string / character parameter types looks as follows:

Redactor mask edit 2.jpg

In the dialog box, select the Mask type parameter value from the drop-down list. Available values:

  • Default. The value input mask with the default settings.
  • String. The value input mask with the following user-defined attributes:
    • Password. If the flag is set, the parameter field will display the asterisk character (\*) when entering the parameter value. The attribute is used for the values containing passwords or other confidential data.
    • Allow empty string. The set flag indicates that the empty string can be an available value.
    • Maximum length. If the flag is set, the maximum number of characters for the parameter value being entered can be specified.
    • Value control. To select the method of controlling the parameter value being entered, use the drop-down list:
      • Default. The attribute defines the string input format according to the specified Qt mask pattern.

The characters used to define the Qt mask are listed in the pop-up hint:

Qt mask zoom95.jpg

When entering the Qt mask, it is possible to specify the pad character. For this purpose, after the Qt mask, enter the semicolon character (;) and specify the pad character. By default, the mask is padded with the space character.

Example.jpgThe mobile phone input mask pattern: Qt mask: +7-999-999-99-99;_ The parameter entry field: +7-___-___-__-__ The underline character (_) is used as a pad character, the dash character (-) - as a separator.

  • Do not use blank separators. If the flag is set, spaces can be used as separators. If the flag is not set, blank characters are used as separators.
  • Keep separators. If the flag is set, the string can be saved with the separators.

Example.jpgExample of saving the Qt mask field value: The Qt mask is ddd-dd-dd. The entered value is 328-12-43. If the Keep separators flag is set, the value is saved as follows: 328-12-43. If the Keep separators flag is not set, the value is saved as follows: 3281243.

  • Integer. The integer input control. It is possible to specify the minimum and maximum values.
  • Number. The real number input control. It is possible to specify the minimum and maximum values as well as precision (number of decimal places).
  • Regular expression (the value is available if the Maximum length flag is not set). The attribute defines the string input format according to the specified regular expression pattern. For details on the regular expression patterns, refer to http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html. For case matching, set the respective flag.
  • List. The parameter value is selected from the drop-down list created in the Edit Mask Editor table with the following columns: Name (parameter name) and Value (parameter value).

To work with the table, use the following buttons:

Button

Function

Create entity 1.jpg Adds a parameter value
Array edit 5.jpg Deletes the selected parameter value
Button up.jpg Moves the selected item one position up
Button down.jpg Moves the selected item one position down


Edit Mask Editor for Integer Parameter Type

The edit mask editor for the integer parameter type looks as follows:

Redactor mask edit.jpg

In the dialog box, select the Mask type parameter value from the drop-down list. Available values:

  • Default. The value input mask with the default settings.
  • Integer. The value input mask with the following user-defined attributes:
    • Number base. The number system.
    • Minimum length. If the flag is set, the minimum length of the parameter value and pad character can be specified. If the length of the entered parameter value is less than minimum, the value is left padded with a pad character to the required length (by default, the pad character is 0).
    • Minimum value. If the flag is set, the parameter minimum value can be specified.
    • Maximum value. If the flag is set, the parameter maximum value can be specified.
    • Step size. The size of the parameter value change step (the value by which the parameter value is increased / decreased when clicking Array entity 9.jpg button).
    • Thousands separator type. Available values:
      • None. The thousands separator is not used.
      • Use locale defaults. The thousands separator corresponding to the user locale is used (for the Russian language, it is a space character, for the English language - a comma).
      • Specify. The separator specified in the Thousands separator parameter is used.
    • Thousands separator. The character that is used as a thousands separator.
  • List. The parameter value is selected from the drop-down list created in the Edit Mask Editor table.
  • Time interval. The time interval input mask. The mask has the following user-defined attributes:
    • Scale. The attribute defines the way the integer is interpreted in the edit field (as a number of hours, minutes, etc.). The value is selected from the drop-down list of available values:
      • Hour
      • Minute
      • Second
      • Millisecond
    • Auto mask. If the flag is set, the Qt mask is as follows: ddd hh. If the flag is not set, the Qt mask can be defined. The expressions used to define the Qt mask are listed in the pop-up hint:

Redactor mask edit 4.jpg

  • Minimum value in <measurement unit>. If the flag is set, it is possible to enter the parameter minimum value in the measurement unit selected for the time interval (the flag name changes respectively with regard to the Scale attribute value).
  • Maximum value in <measurement unit>. If the flag is set, it is possible to enter the parameter maximum value in the measurement unit selected for the time interval (the flag name changes respectively with regard to the Scale attribute value).


Edit Mask Editor for Decimal Parameter Type

The edit mask editor for the decimal parameter type looks as follows:

Redactor mask edit 3.jpg

In the dialog box, select the Mask type parameter value from the drop-down list. Available values:

  • Default. The value input mask with the default settings.
  • Real number. The value input mask with the following user-defined attributes:
    • Precision. If the flag is set, the number of decimal places can be specified.
    • Minimum value. If the flag is set, the parameter minimum value can be specified.
    • Maximum value. If the flag is set, the parameter maximum value can be specified.
    • Scale. The attribute is used to specify the number by which the initial value of the parameter is multiplied when being displayed in the edit field.
    • Decimal separator. If the flag is set, it is possible to enter a character to separate the integral and fractional parts. If the flag is not set, the separator corresponding to the user locale is used.
    • Thousands separator type. The method used to separate digits in the integral part. Available values:
    • None. The digits in the integral part are not separated.
      • Use locale defaults. The separator corresponding to the user locale is used (for the Russian language, it is a space character, for the English language - a comma).
      • Specify. The separator specified in the Thousands separator parameter is used.
    • Thousands separator. The character that is used to separate digits in the integral part.
  • List. The parameter value is selected from the drop-down list created in the Edit Mask Editor table.


Edit Mask Editor for Date/Time Parameter Type

The edit mask editor for the date/time parameter type looks as follows:

Redactor mask edit 6.jpg

If the Use default mask flag is set, the default date/time mask is used. If the Use default mask flag is not set, the editor dialog box contains the following attributes:

  • Date style. The date display format. Available values:
  • Do not show. The date is not displayed.
  • Default. The default date format corresponding to the user locale is used.
  • Short. The short date format corresponding to the user locale is used.
  • Medium. The medium date format corresponding to the user locale is used.
  • Long. The long date format corresponding to the user locale is used.
  • Full. The full date format corresponding to the user locale is used.
  • User-defined. The date/time format described in the Qt mask is used.
  • Time style. The time display format. Available values:
  • Do not show. The time is not displayed.
  • Default. The default time format corresponding to the user locale is used.
  • Short. The short time format corresponding to the user locale is used.
  • Medium. The medium time format corresponding to the user locale is used.
  • Long. The long time format corresponding to the user locale is used.
  • Full. The full time format corresponding to the user locale is used.
  • User-defined. The date/time format described in the Qt mask is used.
  • Use Qt date/time mask. If the flag is set, the Qt mask can be defined. The default mask is as follows: dd.MM.yyyy hh:mm:ss. The expressions used to define the Qt mask are listed in the pop-up hint:

Qt mask 3 zoom95.jpg

  • Minimum value and Maximum value. If the flags are set, the parameter minimum and maximum values can be specified by means of the standard Date and Time dialog box.


Edit Mask Editor for Parameters with Defined Set of Constants

If the Enumeration attribute is preliminary defined in the [Condition Parameter Creation Wizard-sqml_redactor.htm] dialog box, the edit mask editor displays the table with all the items of the constant set. The editor looks as follows:

Redactor mask edit 5.jpg

If the Use default mask flag is set, the default mask is used. If the Use default mask flag is not set, the editor dialog box contains the following attributes:

  • Sort by. To define the parameter value sorting condition, use the drop-down list with the following values:
    • Order. The sorting order defined at the constant set creation.
    • Value. Sorting by constant value.
    • Description. Sorting by constant name.
  • Item list correction. To define the items list correction condition, use the drop-down list with the following values:
    • None. The items list correction is not used.
    • Exclude. To select the items of the constant set to be excluded from the list, set the respective flags in the table.
    • Include. To select the items of the constant set to be included into the list, set the respective flags in the table.

MSDL Editor

The editor is available in the RadixWare Desktop Explorer.

The MSDL editor is used to convert the input data and edit the MSDL schemas (binary messages of the MSDL format).

The MSDL editor looks as follows:

Msdl-redactor.jpg

The MSDL Editor of the RadixWare Desktop Explorer is an administration tool. It is similar to the MSDL schema editor of the RadixWare Designer. For the MSDL Editor details, refer to RadixWare.Programmer Guide/Definition Types/MSDL Schemas/MSDL Schema Editor.