Creating/Editing an analysis

It is possible to create and edit analyses in SE Analytics through the File

Analysis panel menu.

To edit an analysis, select it from the list of records in the second quadrant and click on the

toolbar button. At this point, the analysis creation wizard will be opened, with the fields filled out. See a description of these fields below.

To record an analysis, access the "File

Analysis panel" menu and click on the

button on the main screen. If you wish to edit an existing analysis, locate and select the desired analysis and click on the

button on the main screen. See below the steps for configuring an analysis:

When editing an analysis, a message may be displayed to inform that the analysis is displaying slowness. In this case, access the "Construct query" step and revise the SQL and/or activate the materialization.

General data

In the "General data" step, enter the ID # and name of the analysis. If you wish to classify the analysis in a hierarchy, select the type, in the "Analysis type" field, that classifies this analysis. In the "Description" field, provide more details about the analysis.

It is worth remembering that the "Analysis type" field only displays the types that have been previously recorded in the "Configuration Analysis type" menu.

Construct query

The "Construct query" step consists of entering the SQL command that will define the data to be used by the analysis, among other configurations. Fill in the following fields:

Data source: Select the data source that contains the data to be used by the analysis. The data source establishes the connection with the database and must be previously configured in SE Administration. Remember that the "SE Suite" data source is the system default and displayed without need for prior configuration. This data source establishes the connection to the SE Suite database.

Materialize data: Check this option if you wish the data to be materialized, that is, the SQL command of the analysis will be executed from time to time, and the result will be stored in a temporary table. When this option is checked, the "Edit scheduling" option, which allows defining the materialization synchronization interval of the analysis, will be displayed.

Construct query: Enter the SQL command that will be used in the analysis. Next, click on the Execute button or press CTRL + ENTER to execute the SQL command defined in the field. If an error occurs, the screen will display it. It is also possible to configure one or more calculated fields to be displayed in the query execution result. The Calculated field feature allows displaying additional information in the query result, such as the subtraction between the values of two columns, for example. Refer to the Configuring a calculated field section for more information on how to use this resource in the analysis.

▪Access the "Constants" menu to view the constants that can be used in SQL. When a constant is clicked, it will be added to the SQL command.

▪Click on the "Data dictionary" button to visualize the tables of the "SE Suite" data source. The Data dictionary displays the standards for nomenclature and functions, as well as the SE Suite guidelines for database usage.

▪Click on the "Preview" button to preview the analysis of the data obtained in the query. If any adjustments are necessary, make the corrections to the entered SQL command and execute it again.

Fields

In the Fields step, configure the fields that will be displayed in the analysis:

Format: Use this field to edit the data type when the format of a field needs to be edited. Using this field, the user can edit the format of some data type, such as date (dd/mm/yyyy, mm/dd/yyyy, etc.), currency ($, €, £, etc.), among others.

Aggregation function: This column will be available only for numeric type data. An aggregation function processes a set of values from a single column of a table and returns a single value as a result. The following functions are available:

▪Sum: This function calculates the sum of the values of a single column and returns this result.

▪Maximum: This function analyzes a set of values and returns the biggest among them.

▪Minimum: This function analyzes a set of values and returns the smallest among them.

▪Average: This function calculates the arithmetic average of the values of a column and returns this result.

▪Count: This function returns the number of lines in a column, that is, the number of values in the field.

Security

To define the analysis security, on the screen that will be displayed, enable the desired option:

▪Private: Only the responsible parties(1) defined on this screen will be able to edit or view the analysis. To do that, in the Edit and View columns, define who will be able to perform these operations(2).

▪Public: All system users will be able to view the analysis, but only the responsible parties defined in the Edit column will be able to perform this operation(2) (3).

1 - Responsible parties are those that can be added to the security list, that is: a user, a team, a department, or a position.

2 - To add a responsible party to the security list, simply type the desired name in the available field and select the corresponding option in the list that will be displayed or press "Enter" on the keyboard. To delete a responsible party from the security list, click on the button located next to the desired record.

3 - If the analysis security is Public, the "View" column will be disabled, since the analysis can be viewed by any user.

▪For the vision to be used in a portal, it is important for the users who will access it to have at least the "View" permission configured.

▪It is important to point out that the security is by analysis, that is, when editing the security through the Vision editor, it is the security of the analysis that is being edited, rather than a security being configured for the vision.

After filling out all necessary fields, click on the Finish button to end the analysis configuration.

After creating an analysis, it is necessary to create its visions. Refer to the Creating/editing vision section for more details on how to create/edit a vision.