Customer Support Training Manual

 

The Customer Support Training Manual document outlines the basics on how to use the system to create reports. The document contains the following components:

Introduction

 

MTech Systems Version 7 Application (Protein V7) is divided into seven principal modules: General, FMTS, BMTS, LMTS, TMTS, SMTS and Admin.

 

 

To Search and Execute Existing Reports

  1. From the main menu, select Reports.
  2. Select View all Layouts.
  3. It is possible to search a report using any column in the screen. It is necessary to filter the report name or a partial word at least. For example “KPI” (this filter will search all reports containing the word “KPI”. In the “Report ID” column, it is possible to type “BIM” this will start searching all reports starting with “BIM”. In this way, it is possible to do complex searching.
  4. Once the report has been selected, right-click the mouse and choose the `Edit` option, or double-click to execute the report. The next screen will allow the user to define the parameters to execute the report.

 

 

Favorites Folder – Short-cut Creation

  1. From the main menu, Select the option My Profile.

  2. Once “Show my Favorites Folder” has been selected, right-click and select “Add Reports”.

  3. On the layout screen, select all reports more frequently used in order to access them quickly. These reports will be saved in the “Favorites” folder.  

 

Report Builder

The Report Builder section contains the following components:

 

To create new reports, there are two options:

Option 1

  1. From the main menu, select Report Builder.

 

 

  1. From the report builder screen, click the File drop-down menu and select Definitions in order to create a new report.

 

  1. The next screen shows all existing reports available in the system.

  2. To create a new report press click on the “New” button.

 

 

  1. In the “Report Index” screen,  fill out the following fields:

    1. Base Class ID - select the appropriate class once the drop-down menu has been displayed (a list of all available classes will pop up, with each class showing the exposed granularity, ex. Detail, Summary or Master Detail).

    2. Report Name  - type the report name.

    3. Base Table Name - table/view name Identification.

    4. Report ID - unique identifier for system reports.

    5. Report Granularity Mode - depending on the class selected previously, this field will identify the granularity type to be used like detail, summary or Master Detail.

    6. Report Class Name - identifier for the selected class.

    7. Language -  select the language to be used (suggested to leave blank and the system will take the default language selected in configuration).

    8. System Flag - this option indicates if it is a system report or a user report.

    9. Print Tracking - this option is used to set PrintCounter, PrintUserId and LastPrintDate once the report has been printed. *Note: this option is not available in all reports. Sales invoice is an example where this property can be used).

 

*Note: All fields in yellow are mandatory field. Fields in grey are disabled and white fields are optional.

 

 

Option 2

  1. From any screen in the system, select the Reports button and then click Create New Reports. In the sample below, from the BIM Farms screen, a new report has been created, and the BIM Farm Class has been selected as a default to create the new report.

 

 

Below is a list of must-use classes to generate reports:

 

BIM:

 

BRIM:

 

HIM:

 

FMIM:

 

LHS:

 

BRPA:

 

BPA:

 

SIM:

 

GIM:

 

Report Builder Screen

The main report builder screen has the following sections:

 

 

 

The first step is to select the necessary fields to build the report, from the class browser. Those fields will be placed in the Report properties section. This section has the following columns:

 

  1. Class name - identify the class names where the fields belong to.

  2. Column Name - field Name.

  3. Column Alias - select the name of the field that will be used in the layout and output.

  4. Output - indicate if the field will be visible or not in the output.

  5. Prompt - select the fields that will be used as filter or parameter to execute the report. Available options are: None, optional or Required. 

  6. Filter Type - identify the filter type. Depending on the field, the following options will be available: Expression, Value, Lookup and Free from SQL.

  7. Filter Mode - identify if the field will be executed before or after the compilation is completed. Available options are PRE or POST.

  8. Aggregate Status - select the calculated function type to use to totalize the field. Available options are: None, Percentage, Count, Max, Min, Su,. Weighted Average and Weighted Average Excluded (these options will be available depending on the selected field).

  9. Weight Field - in the case that Weighted Average has been selected, the weighted field must be filled with the weighted value that will be used to calculate the weight.

  10. Percentage Numerator Field - in case that percentage has been selected, the Aggregate Status identifies the numerator field used to calculate percentage and will be shown in the output.

  11. Percentage Denominator Field - if Aggregate Status was selected, this column will identify the field to be used as the denominator in the calculate percentage and this will be displayed in the output.

  12. Edit Calculated Expression - this option only can be used for calculated fields. In that screen, all calculations will be entered.      

  13. Format US - American format will be used in numerical type fields.

  14. Format Metric - define the metric format to be used in numerical type fields.

  15. Date Time Mode - define the date format to use in date time fields. Available options are: Date Only, Time Only or Date and Time.

  16. Parent Table Name - specify the table’s path to search values used in the field. (FK Column Name: identify the Foreign Key of the field).

  17. Grid Category - typically used in vertical outputs in order to group fields.

 

Method Fields

When this field is selected from the Class Browsers, it is necessary to define the parameters to determinate the value from this method (yellow fields are mandatory).

 

Example:

 

 

Calculated Fields

To add calculated fields, select the Options button from the main menu and select Add Calculated Field.

 

 

From the Expression Builder screen, follow the next steps:

 

  1. Select the value type that will be returned as the operation result. The operations are: Boolean, date-time, Decimal, Int32, String, and GUID.

  2. In this section, the calculation fields will be entered.

  3. In this section, it is possible to select the functions, operators, fields and constants available to select the calculations that may be selected and used in the calculation section.

  4. This section will be displayed in a list with all options depending on what is selected in step 3.  For Example, if functions are selected, this section will display all available functions were deployed.

 

 

Edit Report Parameters

  1. From the main menu Options button, select Edit Report Parameters. This screen will display a number of parameters that can be configured for the current report. Different parameters can be used depending on the selected class.

 

 

  1. The following screen shows the parameters used in Class BIM Entity – Flock Profile.

 

 

  1. In the Argument column, it is possible to select the parameters that will be used to execute the report.

  2. In the Prompt column, defined fields can be used as filters for the report (optional or required).

  3. In the Filter Type column, the user may select the filter type that will be used. For example: Expression, Value, Lookup, None.

 

Layouts

The following screen displays the different layouts used to show the output report.

 

 

Report Types

There are three report types:

Pivot Report

Layout

Output

 

Tabular Report

Layout

Output

Vertical Report

Layout

Tabular design has the following available options:

 

Output

Report Groups

  1. To create a new report group,click the File drop-down menu and select Definitions Groups.

  2. In the Report Groups screen, click the New button and fill out the following fields:

    1. Group Name - name for the report group.

    2. Group ID - identification number for the report group

    3. Shared - select el tipo de compartimiento (Compartida de solo lectura, lectura y escritura compartida, Privada, sin establecer)

    4. System Flag - select to determine if the report is a system report or a user report.

    5. Report Group Type - identifies the type of group report for the user. Available options are:

      1. Correlation Report Group - permite agrupar diferentes reportes sin existir una relación entre ellos.

      2. Master-Detail Report Group - permite agrupar diferentes reportes que tienen alguna relación entre ellos a través de un o más campos.

Group Report Types

There are two types of group reports:

Master-Detail Report Group

  1. From the main menu, select the Options button.

  2. Select from one of the two options: Add Existing Report (Definition) or Add New Report (Definition).

  3. Once all reports have been added, it is necessary to select the main report.

  4. It will be necessary to identify the fields that will be used to establish the relation between the principal report and the sub reports.

  5. It is necessary that each report has the layout already previously created. The main report can only have one tabular layout previously created.

 

 

Example

The following output displays the (4) reports that have a relation to each other. The Entity Sold Report is the main report, and the other related reports are sub reports.

 

Correlation Report Group

  1. From the main menu, add existing reports or create new reports from the report group option.       

  2. Once all threads are added, a sequence to display the reports can be defined.

  3. It is necessary that each report has a layout previously created.

 

Dashboards

  1. To create a New Report Control Panel, select the following option in the main menu.

 

  1. Once the above option has been selected, click the New button and enter the following fields:

    1. Control Panel Name - enter the dashboard name.

    2. Control Panel Description - write a Brief description of the control panel.

    3. System Flag - select whether it will be a dashboard system or user.

    4. Auto Refresh Frequency - defined time auto refresh of the data.

 

  1. In the Options menu, click on Add a New Report or Add Existing Report to add a new report or new existing report, which will be used for the dashboard.

 

 

  1. Once the reports are added, using the section Layout Objects, layouts and graphics an be selected to be used for the dashboard.

 

  1. Use the right mouse button in the center area of the dashboard screen to display a menu and select the Customized layout option. This screen allows you to manage dashboard options such as labels, dividers splitters, etc.

 

 

Report User-Defined Views

  1. To create a new view (Views), select the following option in the File menu.

 

 

  1. After selecting  the New button, enter the following fields:

    1. View Name - name of the View.

    2. Database View Name - displays the name of the view you will level the database (MVU prefix followed by the name given in the previous step).

    3. Display Name - brief description of the view.

    4. Description - detailed description of the new view.

    5. Base table name - select the name of the base class to use. The new class to create will bring all related to these table base classes.

    6. Class Id - IRN automatically-generated identification code.

    7. Create/Edit View - displays a new screen to create/edit the query define for creating the view, as can be seen in the following screen:

 

 

  1. This section shows Tables and Vista Mtech, which may be used for the new view.

    1. Area Query Builder, which develops the new SQL Query.

    2. Displays selected tables and views as well as their relationships.

    3. Properties that can be used in the selected fields.

    4. Query Result Tab to run the query and display the results.

  1. Once the view has been created, this new class will be available as a Base Class ID in generating new reports (Report Definitions).