Query tool

This code is used to identify a request.

Use this field to assign a description to each record.

This title, which describes the record, is used in some screens or records when there is not enough space to display the long title.

Select this checkbox to activate the current record.

Inactive records keep their content and configuration but cannot be used by recalling their code:

• On other records such as documents and settings
• On mass processes

Authorizations for a given function can restrict the creation of an active record. In this case, the checkbox is disabled by default. It can only be modified by an authorized user or through a signature workflow.

This indicator defines how data will be displayed on the screen. The available display modes are as follows:

• Character:  Data is displayed exclusively in a grid format.
• Character or Graph: Data can be displayed either as a grid or as a graph. You can select the position in the Default display field.
• Character and Graph:Data is displayed in both grid and graph formats simultaneously. You can define the graph’s position relative to the grid in the Graphical position field.
• Graph: Data is displayed exclusively in graphical format.

This setting defines how the graphical representation is positioned relative to the grid when the data display mode allows both formats.

• If the representation is Character or Graph, select the table or graph display.
• If the representation is Character and Graph, define the position of the graph relative to the data grid.

An activity code is used to:

• Make an element optional in the dictionary if the value associated with the activity code is null

• Identify the specific/custom elements if they are marked with a code starting with X, Y, or Z

This field specifies the name of the table from which the data will be extracted.

An entry is required, even if you intend to display an expression that combines fields from multiple tables or that is not directly tied to any table. In such cases, simply enter the code of one of the tables involved in the query.

This means that the first row of a user-defined inquiry cannot consist solely of such an expression.

This field represents the code of the data field to be displayed in the inquiry.

Your selection here depends on the specific table chosen in the previous field, as only fields belonging to that table are available.

If you leave the field blank, you will need to enter an expression in the next column.

This field defines the title of the column as it will display when the request is executed.

By default, if a field from a table is selected, its title (stored in the data dictionary) is automatically proposed. In a multilingual environment, this title is displayed in the user's connection language, as dictionary texts are maintained in all supported languages.

If you modify the title or use a calculated expression without a predefined translation, you can still provide translations manually.

For translatable fields like this one, you can enter a description in a language other than the current connection language by selecting Online translations from the Actions menu.

For further information, refer to the Online translation of descriptions documentation.

You can enter an expression written in Adonix language, typically with the help of the formula editor if needed.

An expression must be provided, if no field name has been specified, on the inquiry line.

The expression can include:

• Fields from any of the available tables

• Constants

• Operators

• Functions

• Other variables required for the calculation

Expressions are limited to 200 characters.

For complex expressions, you might need to use abbreviated syntax to stay within this limit. For example, instead of writing [F:SOH], you can use the shorter [SOH] form to reference the table.

This field defines the data type, which determines how the data will be displayed.

When referencing a field, the associated data type is proposed by default, but you can modify it if needed.

When using an expression, the data type must be explicitly specified. It can be a generic type such as:

• A: Alphanumeric string

• M: Local menu

• C: Short integer

• D: Date

• DCB: Decimal

• L: Long integer

For alphanumeric strings, the maximum length is defined in the Length field that follows.

For local menus, both the display length and the local menu number are specified.

If the selected data type is linked to an object, a tunnel to the object’s management screen is available during the inquiry execution.

Define here the length of a field that uses a generic data type where the length is not fixed. This applies particularly to alphanumeric and decimal types.

Defines the local menu number associated with the field on this line.

A field of type local menu corresponds to a predefined list of choices, identified by a number between 1 and 255. Each number refers to a title in a table called local menu, stored in the APLSTD messages table.

When entering or displaying data, the options can display in the user interface as:

• A drop-down list
• A set of buttons

The main advantage of this field type is that the list of choices displays in the user’s connection language.

Each local menu number defines a specific list of options. For example, local menu 1 corresponds to the No / Yes choice in this order. In this particular case, the user interface can also be a checkbox.

When you run a user-defined inquiry, you often need to refine the data selection criteria so that you see only the information you need, rather than all available data. To do this, simply enter Yes for the fields you want to use as filters.

When the inquiry runs, a criteria entry window displays. In this window, you can specify starting and ending values for the selected fields (or leave them blank). Because these criteria are linked to known fields, the selection window guides you in choosing valid values.

This option can only be assigned if the line contains a numeric data element. When set to Yes, it enables rolling up totals to higher-level groups in the inquiry display.

This field determines the sort order of the data elements displayed in the inquiry.

The sorting follows the order in which the fields appear in this table. You can choose to sort the data in ascending or descending order.

You need to set this field to a value other than No to enable data grouping.

Without grouping, the data remains unorganized.

However, in a simple inquiry with no grouping (and no roll-up capability), you can still sort the data without grouping it.

Example: A basic listing of sales orders.

Use this field to create a break level. When set to Yes, it creates a grouping based on the current field. You can then group all subsequent fields under this break, and any totals (if applicable) will be displayed at the group level.

You need to define a sort order (ascending or descending) for the current line before setting this option.

For example, if a list of users is defined by profile, you can use a break by profile to group on a single line all the users linked to a profile. Totals related to the group (such as the number of users, if there is a field with the 1 value that is accumulated) will also display.

Define the level of detail for displaying information.

• Level 1: Displays the information at the top aggregation level (the highest) and all subsequent levels.

• Level 2: Hides the information at level 1 but shows it at level 2 and all more detailed levels.

• The highest level corresponds to the most detailed view of the inquiry, which is displayed by default when the inquiry is launched.

Default behavior:

• The first line is assigned level 1 by default.

• Each time a break is defined (Group = Yes), the level increments automatically.

You can modify this level to display a value at a different aggregation level.

Example: If you sort and group by user code and want to display the user name in the next column, the name should appear at the same level as the code, not only at the most detailed level.

You can only modify this field if the representation mode in the header is not set to Character. It specifies how the field is used in the graphical representation.

Possible values:

• For alphanumeric fields:

  • None: The field is not used in the graph.

  • Label: The field is used as the graph title.

    Note: Only one line in the grid can have the value Label. To assign it to another line, you must set the existing Label line back to None.

• For numeric fields:

  • None: The field is never displayed in the graph.

  • Value: The field can be used as a data series in the graph.

  • Default:

    • If the graph (defined in the last tab) displays multiple series, all fields marked Default will display (unless already shown).

    • If the graph does not display multiple series, the column for the first field marked Default will display (or the first one encountered if none is declared).

You can only edit this field:

• if the representation method chosen in the header is not Character.
• on the numeric fields where a value will display.

Used to manage graph combinations when the selected graph type (defined in the graphical parameters) supports multiple series, even of different types.

If the graph type does not allow multiple series, this setting is ignored.

Available combinations include:

• Type = Multi graph, Default graph=Lines, Representation=Multi
• Type = Multi graph, Default graph=Bars, Representation=Multi

The rule is as follows :

• Defaultmeans that the series will use the default graph type defined in the last tab (Bars or Lines in this case).
• Bar or Line forces the series to use the corresponding presentation style.

Enter the setup value as a calculated expression that can include variables related to the launch context.

If the setup requires a start-end range, you need to enter two values. The first value goes in this field.

If the setup in the previous field requires a start-end range, you need to enter two values. The second value goes in this field.

Specify the maximum number of lines returned by the query. The default value is 0. The maximum number is 100.

Specify the maximum number of lines to return.

This corresponds to the query parameter maxrows, which stops the search once the specified number of rows meeting the conditions is found in the database.

These rows are then sorted, but the database does not guarantee that the retrieved rows are the first N in the final sort order.

This parameter is an optimization to reduce database load.

Use this field to fix the first X columns of a grid when horizontal paging is enabled.

Specify the maximum execution time for the search in seconds. If this time limit is reached, the search stops automatically.

This helps avoid long wait times, especially when setting up a new query.

Define the report code associated with the File / List function from the query inquiry.

If no report code is specified, the ALISTE report is used, which applies a standard page format.

You can duplicate this generic report and adjust the page format to create a custom report tailored to the inquiry.

The report code entered here can also be linked to a set of print codes using the dedicated function.

Define selection criteria as logical expressions applied to table fields.

These expressions can include constants, functions, and operators. Only rows that meet these conditions will be extracted.

To simplify writing these expressions, you can use the formula editor.

Use this field to define links that are not specified in the dictionary or that should take priority.

The link structure must match the key of the target table and include as many fields (separated by semicolons) as there are key parts.

Syntax:

[F:ABV1]CLE=expression1 ; expression2..., where:

• [F:ABV1]CLE is the key of the linked table.

  • Right-click to access the table selection window (Choose a table), which lists all tables from the first tab.

  • After selecting a table, the first index is displayed. To use another index, right-click and select Choose an index.

• expression1, expression2 represent the expressions used to give values to the various fields of the previously defined key.

  • If the key has one part, only one expression is needed. Otherwise, separate expressions with semicolons.

  • Use Choose a field to insert values from related tables.

  • Constant values can also be used for key parts.

From the database perspective, this syntax defines left outer joins. To create a strict join (which can improve performance), add a tilde (~) before the key:

[F:ABV1]CLE=expression1 ; expression2...

This field controls how the query behaves in inquiry mode. There are three possible modes:

• Normal: The result is displayed only if the user has already executed the query. If this option is not checked, each user who runs the query generates their own dataset, which is not visible to others.

• Shared: The result of a query executed by one user can be viewed by other users. This is useful for large queries, as it allows multiple users to access the same data without re-executing the query.

  Only one user should run the query. Others should have inquiry access. For very large queries, run in batch mode using the batch task code CALALH.

• Recalculated: The result is never displayed automatically. You need to click Refresh or enter criteria to reload data. This mode is useful when data becomes obsolete quickly, avoiding unnecessary reloads.

Makes a classification criterion available for requests.

Defines access control for the current record and query execution.

• Record access: If this field is populated, only users with the specified access code and the appropriate rights can:

  • Read the record (requires read rights)

  • Modify the record (requires write rights)

• Execution rights: Determines who can execute the query, either by refreshing it or by changing parameters and re-running it.

This field determines the authorization filters applied when building the query. These filters are by site, by role, and by access code.

Filtering principles:

• The object code determines which Access code and site Code fields the filter applies to.

• The filter is then applied based on the authorized sites and access rights assigned to the user for object management.

• Similarly, role-based filters defined by the object code are also applied.

The table on which the filters are applied must be included in the generated query. This refers to the table containing:

• The Access code field

• The Site code field

• If applicable, the field corresponding to the roles assigned to the user

This table is not necessarily the main table in the query.

Example: A query on document lines can still be filtered based on authorizations defined in the document header table.

This field links query access authorizations to the permissions granted for the associated function.

When a user opens a query, the system checks whether they are authorized to use the linked function. This is done for at least one site, if the function’s authorization is site-based. This check is performed only when the query is not shared.

If the query is shared, the permissions of the person who executed the query apply and are inherited by all users who have viewing rights. Therefore, extra caution is required when defining authorizations for shared queries, especially when they involve sensitive data. These permissions are managed using the access code available in this tab.

You can use this field when the grid contains multiple numeric values that can be displayed graphically. It supports two options:

• Single graph: Displays one column of values at a time, with a selector to choose the column.
• Multi-graph: Displays all columns together, combined according to the setting defined in the Representation parameter.

When multiple series are displayed in a graph, provided they share the same presentation style and are not of the sector type, you can define how their values are combined by selecting one of the following options

• Multi: Displays the values of each series side by side. Each series displays in a different color.

• Cumulative: Stacks the values vertically to show a total.

• Comparative: Displays the series in relative proportions, keeping the overall graph height constant.

This field defines the type of graphical representation used to display the data. Options include Bars, Lines, Area, or Sectors. An image displays based on the selected option.

If only one data series is available, the default representation is determined by this parameter.

If multiple series are present, you can mix presentation modes (for example, one series as bars, another as lines). In this case, each series uses the value specified in the Representation field in the grid:

• If set to Bar or Line, that mode is applied to the series, provided it is compatible with the default representation. Mixing Sectors with Bars or Lines is not allowed.
• If set to Default, the series uses the default graphical representation.

When only one series is displayed, a graph type selector is available, allowing the user to choose a different presentation mode.

Visual representation of the previously entered information.