The Analytical module is a comprehensive data mining and analysis solution which allows turning raw data into useful information.

The module is used to analyze relationships and patterns in data based on what users request. For example, a company can use data mining to analyze the amount of years each crew member has worked on a vessel. The module processes the data it has collected and presents the analysis results in an easy-to-use format, such as a graph or a table.

Before starting to work with the Analytical module, make sure the access rights to the 990 Analytical Module routine are granted to you in Adonis Control Centre.

Example: Retention Rate Diagram:

User Interface

The section is an overview of the Analytical module interface, its commands and basic usage.
To get started, click the Analytical Module button on the Modules tab. The module becomes active from the Manage tab where you can start managing it.

On the left-hand side of the module window, you can find the Views panel from which you can get access to all the condition statements used for data mining. For more information, see Define Data Mining View.

Grid Layout

In this section, you will get to know how to You can customize the grid layout. The following options are available:

Filter Column

You can filter records to view only the data that you want to be displayed in a column. To do this:

Hover the mouse cursor over the header of the column in which you want to filter records.
Click the filter button
to the right of the column header.
In the drop-down list, check the option by which to filter the column records:Hover the mouse cursor over the header of the column in which you want to filter records.

For more information on records filtering, see Filter Records.

Sort Column

You can sort column records using one of the following methods:

Click a column header. Each click makes the switch between ascending and descending records orders.

or

Next to the column header, click an arrow up
or an arrow down
indicating ascending and descending sort orders, accordingly.

Set Columns Order

You can reorganize grid columns by moving columns so that they change the originalare in a different order than they were originally:

Select a column by clicking its header.
Hold down the left mouse button and drag the cursor to the column before which you want to place the selected column.
Drop the selected columncolumn when an insertion pointer appears.

There is another way you can use to change the columns order. The option is available only within the framework of the report customization.

Right-click a column header you want to move.
In the menu, select Order and define the location of the column:

Set Columns Width

You can adjust the column width that is up to your needs. To do this, proceed as described below:

Select the column that you want to change.
Drag the boundary of the selected column header.

Housekeeping

When first launched, the module does not contain any records. This section provides step-by-step instructions how to get everything setup.

Define Data Mining Query

You can set up a view by creating a data mining query.
To do this, follow the steps below:

Go to the Setup ribbon tab > General Codes > Analytical Module > Data Mining Codes.
Click the New button on the ribbon to make the dialog appear:
Enter a Code (mandatory field), a unique alpha-numeric APM code.
In the Text field, specify a code name and an alternative name, if needed, in the Alternative field.
In the Sort field, define the order number of a record (where 0 means the first record in the list). Besides, you can indicate a number for sorting layouts by the datamining view groups. For more information on datamining groups, see Define Data Mining View.
In the Is Passive field, specify whether the code is to be active or passive. Passive codes appear as disabled.
In the Options tab, set the SQL statement based on what you want the query to show. For example:

PIN, NUMORGID, EMPLOYMENTSTARTDATE, EMPLOYMENTENDDATE fields are mandatory.
Switch to the Fields Definition tab. Confirm the update of field definitions when you are prompted:

On confirming, the fields used in the SQL statement are fetched to the Fields Definition tab. For more information on how to edit the Fields Definition grid, see Fields Definition.
Click OK to save the changes.

As a result, a new data mining query code is added to the list of codes.

Fields Definition

Once an SQL statement is specified, switch to the Fields Definition tab to view the fields used in a certain query:

Field Name. The value is automatically defined, it is intended for binding a database field to an SQL query field.
Caption. Define the field names you want to be displayed in the module. By default, the system duplicates the values specified in the Field Name column.
Display Format. Define the formatting pattern used to display field values.
Grid Area. From the drop-down menu, select an area in which a specific field is displayed by default. A field may be positioned in one of the available areas: column header area / row header area / data header area / filter header area (default).
Group Interval. From the drop-down menu, select the way for combining the values of the current column or row field. By default, the grid doesn't group the field values and displays unique values along its top and left edges.
For example, for a field displaying date/time values, you can set the Group Interval property to DateMonth. As a result, the values will be grouped in a few categories (months), combining different values that belong to the same month. All the available grouping modes are listed below:

DefaultGroups combine unique field values.
Date combines values by a date component. The time component is ignored.
DateDay combines values by a day component. The following groups may be created: 1, 2, 3, ... 31.
DateDayOfWeek combines values by the week days. The actual names of the week days are determined by the system's regional settings.
DateDayOfYear combines values by a day number in which they take place during a year. The following groups may be created: 1, 2, 3, ... 365 (366 for a leap year).
DateWeekOfMonth combines values by a day number in which they take place during a month. The following groups may be created: 1, 2, 3, 4, 5. The first week includes from 1 to 7 days, the second week -from 8 to 14 days, the third week - from 15 to 21 days, the fourth week - from 22 to 28 days, the fifth week – from 29 to 31 days.
DateWeekOfYear combines values by a week number in which they take place during a year. The following groups may be created: 1, 2, 3, ... 52, 53.
DateMonth combines values by a month component. The month names are determined by the system's regional settings.
DateQuarter combines values by the quarterly intervals. Each quarter includes three months.
DateYear combines values by a year component. Examples of the groups: 2003, 2004, 2005.
YearAge combines values by the number of years that have elapsed until the current date. The GroupIntervalRange property determines the intervals according to which the values are grouped.
MonthAge combines values by the number of months that have elapsed until the current date. The intervals are determined by the GroupIntervalRange property.
WeekAge combines values by the number of weeks that have elapsed until the current date. The intervals are determined by the GroupIntervalRange property.
DayAge combines values by the number of days that have elapsed until the current date. The interval is determined by the GroupIntervalRange property.

The above-mentioned options are relevant only for fields that store date/time values.

Alphabetical combines field values into categories according to the first character of values.
Numeric is relevant only for fields that store numeric values. Field values are grouped according to the intervals specified in the GroupIntervalRange property.

Summary Type. From the drop-down menu select the function to be used for the current values. For numeric data fields, you can use any function listed in the drop-down menu. For non-numeric values, use the following functions: Count, Min and Max. The following functions are available in the Summary Type column:

Count returns the count of values.
Sum returns the total of numeric values.
Min returns the lowest value.
Max returns the highest value.
Average returns the average of numeric values.
StdDev returns the sample standard deviation of numeric values.
StdDevP returns the population standard deviation of numeric values.
Variance returns the sample variance of numeric values.
VarianceP returns the population variance of numeric values.

In case field values are not defined, the system sets the default values.

Define Data Mining View

You can define groups for combining the defined queries (identified as layouts).
To create a group, follow the steps below:

Go to the Setup ribbon tab > General Codes > Analytical Module > Data Mining View.
Click New on the ribbon to make the dialog appear:
Enter a Code (mandatory field), a unique alpha-numeric APM code.
In the Sort field, define the order number of a record (where 0 means the first record in the list).
In the Is Passive field, specify whether the code is to be active or passive. Passive codes appear as disabled.
In the Security Code field, enter a number larger than 0 to define the permission levels to the record.
In the Text field, provide the name of the code and its alternative name, if needed, in the Alternative field.
In the Include Groups field, specify a Sort number defined in Data Mining Codes for a certain layout view. This allows storing layout views in different view groups.
In the Options tab, set the fields you want to display in the data mining view. For this, use the Add Column button to display an additional column and select a value for the column heading.
Click OK to save the changes.

As a result, a new data mining view code is added to the list of codes:

Once completed, click Close on the ribbon to exit the General Codes Data Mining View.

Functionality

Based on the defined DataMining Codes in General Codes, you can create various datamining layouts.
In this section, you will find out how to manage the defined datamining layouts.

Add Layout

To open a layout created in DataMining General Code, follow the steps below:

Switch to Analytical Module on the Manage tab.
Click New on the ribbon
or
Right-click anywhere in the working area and select New from the context menu.

The Create data mining layout dialog appears on the screen:
Within the dialog, from the Code drop-down list, select the layout you want to open.
In the Description box, enter a short description.
Click OK to confirm.

As a result, the selected layout appears in the Data Mining Views list:

Design Layout

You can customize the layout by specifying values and conditions based on which the analysis is to be performed.
To get started, select a data mining layout you want to customize in the Data Mining Views list. On selecting, do one of the following tips:

Double click the selected layout.
Click the Open button on the ribbon.
Right-click the selected layout and select Open from the menu.

As a result, the module shows the details of the selected layout, i.e. different fields with the help of which you can create a custom analysis report:

The layout has a drag-and-drop interface that allows you to create or edit your analysis reports using only the mouse.
Drag the field names to the various sections of the working area. The following sections are available:

Row Field is a row data considered in the calculation.
Column Field is a column data considered in the calculation.
Data Field is a value that is to be calculated.

The example below calculates the number of hours users spent on a vessel. To set the calculation fields, choose one of the methods below:

Drag and drop the UserName field to the Row Field section and Hours to the Data Field section.
or

Click the Field List button in the Actions group of the ribbon. Within the PivotGrid Field List dialog, drag the UserName and Hours fields to the Row Area and Data Area sections, respectively:

The calculation results are then displayed in the Details group:

To get details on data processed by the system when calculating the datamining records, select a result record and click Drill Down on the ribbon. For example, selecting 4 in the Grand Total column displays all the records considered in the calculation based on the SQL query. With the help of the drill-down function, you can check time and date a person spent 4 hours on a vessel:

When finished designing the layout, click the Save Layout button on the ribbon to confirm the changes.

Visualize Layout

On creating a layout report, you can choose a display form of a report.
There are several visualization forms in the Analytical Module. They are located on the right-most border of the working area.

Tabular is a grid-based number representation where the emphasis is in seeing the exact values of the report. This display form is set by default.
Graphical is a graphical presentation of information. It is better to use the Graphical form to analyze the relationship between the report data. When working with a diagram, you can define a preferable type of a diagram. For this, click Diagram Type in the Actions group and select a type:

Source is a standard grid view containing all the field data defined in a query. This view offers numerous possibilities for data-processing, including the export to an external file. For more information, see Export.

Layout Tools

In this section, you will get to know about the tools intended for the report customization.

Print

To print the current report, click Print in the Actions group and select one of the following commands:

Data Mining Grid Report to print the active report without any changes.
Printing Designer to format the active report before printing, i.e. change its view, formatting and style. For more information, see Format Report.

Format Report

Before printing a report, you can change the current report view, formatting and styles. Based on the selected visualization form, different options are available within printing options. For more information on visualization forms, see Visualize Layout.
In this section, you will get to know about printing options for the visualization forms: Tabular and Graphical. To access the feature, click Print in the Actions group and select the Printing Designer option.

The following options are available in the Format Report dialog:

On the View tab, you can define which data you want to hide/display in the printable copy of the report.
On the Behaviors tab, you can define whether you want to expand/reduce columns and rows for the printable copy of the report.
On the Formatting tab, you can define the formatting preferences for graphical elements which may be available in the report. For example, to present graphical elements in a textual form, modify checkbox style, make graphics background transparent or opaque.
On the Styles tab, first select Use Native Styles to enable the options allowing to customize the appearance of a printable copy:

Now, select a report element for which you want to make changes to color, font and/or background texture and choose to click one of the buttons, accordingly:

Font… to change the font family, style, size and font color.
Color… to change a background color.
Texture… to apply a background texture. Adding a texture enables the Clear button which allows removing a texture.

You can save the text edit changes. To do this, click Save As… and define its name. On saving, the style sheet appears in the Style Sheets drop-down list.
Besides, at the bottom of the Format Report dialog, you can find the following commands: Title Properties… and Footnote Properties… The commands allow you to define/edit a report title and/or footnote as well to set their properties, i.e. background color, font size and alignment.

Export

The Analytical module allows you to convert the reports to various formats: HTML, XML, XLS.
On the Manage ribbon tab, click the Export button and select the file format into which you want to convert the file:

On selecting, the Save As… dialog enables you to specify the exact location of the file on your computer.

Filter records

You can establish compound criteria for filtering. To do this, follow the steps below:

Select the (Custom…) option from the drop-down list to make the Custom Filter dialog appear:

In the Actions group, click the Pre-Filter button to make the Filter builder dialog appear.
Within the dialog, click Filter and select Add Condition. Combine filtering conditions using the AND/OR operators:
Click OK to close the dialog and apply filtering in the layout or Apply to apply filtering without closing the dialog.

As a result, you will get the list of records meeting the preset criteria. The criteria for filtering appear at the bottom of the application window.
To save the current filter to your file system, click Save As... and define the exact location of the file.
To open an existing filter, click Open… and select the file.
For more information on records filtering, see Filter Column.

Customize

The customization settings apply to a user account.
Within the layout, you can change the location of some elements as well as choose whether you want to display/hide them. Based on the display form you are working in, different elements are available for customization.
Being in the Tabular layout view, click Customize on the ribbon and select one of the following options:

Totals Location allows defining the location of the Grand Total field, both for a column and a row.
Totals Visibility allows showing/hiding the totals for single values and for a variety of values.
Elements Visibility allows showing/hiding the grid elements.
Selection allows manipulating the selections.
For the Graphical layout view, you can customize the toolbox:

Toolbox allows you to show/hide a toolbox in a diagram.
Toolbox Position allows defining the location of a toolbox in a diagram.
If a toolbox is enabled, the Customize Chart button appears at the bottom or at the top of the diagram. Click the button to view the Customization pane where you can adjust the alignment and position of a diagram title and legend:

Graphics and diagrams

In the Graphical tab it is possible to get various graphics and diagrams, just click Graphical to the right:

You can select the diagram type that suits you best:

Here is a couple of examples how analytical view result can look in a diagram: