10. Menu with Actions and Configuration¶
Per default the menu is enabled on all MQC pages. You can simply
switch it on or off by clicking the Menu icon within the MES Quality
Commander banner in the top-left.
Figure 10.1 Enable the menu within the MES Quality Commander banner¶
The MQC Menu is divided into Actions and Configuration.
10.1. Actions¶
10.1.1. Refresh Data¶
Once you have configured Data Sources and imported data, your MQC project will be gradually updated, whenever e.g. new report files appear in the configured directories. To consider newly added files and/or file changes, press the “Refresh Data” button (see Figure 10.2).
Note
If no changes were detected by MQC, the “Refresh Data” button is greyed out and can’t be clicked.
Each time you update Adapters configuration, to consider your changes (e.g. adding custom adapter or disabling base adapter), you have to press the “Refresh Data” button as well.
MQC searches all configured files and subdirectories recursively. Changes inside the added directories (new files, removal of files or even changes within the files) are automatically detected.
Figure 10.2 The “Needs refresh” status message appears due to changes within the monitored directories.¶
When clicking on the “Refresh Data” button, the message will switch to the “Data is up-to-date” status message, after the data has been refreshed.
Alternatively, you can enable the Automatic Refresh checkbox, so that MQC refreshes automatically when changes are detected in the specified directories and files.
Note
The import of new files and the associated re-execution of the necessary data and quality transformations block the usage of the tool. Therefore, it is recommended, not to use the automatic refresh while working with MQC, but to manually update the project with the “Refresh Data” button once MQC has notified the user via the status message that a refresh is needed.
To ensure that an MQC project is always kept up to date while it is not opened by a user, MQC offers an automatic server update for projects stored within the MQC server library (see Automatic server refresh).
10.1.2. Dashboard Customization¶
This action is available on the Dashboard page only. The dialog provides different options to customize your Dashboard (see Dashboard). Clicking on this option makes the Dashboard editable. In other words, the tiles become volatile and the visualizations can be changed.
Figure 10.3 View of Dashboard in customizable mode.¶
The different customization options once the dashboard is in edit mode are as follows:
Resize, by hovering over the boundary of the visualization and drag it to obtain the desirable size. There is however a limit to the minimum size a visualization can get.
Remove, by hovering the visualization and clicking the red button at the top right corner.
Rearrange, by dragging and dropping the visualization to another empty space of the same or larger size.
Additionally, a menu of options is present below the Customize Dashboard.
Figure 10.4 Menu options for customizing dashboard.¶
The Add Tile button opens a new dialog with different groups of tiles
(Project, Quality, Availability, Action and Tool) that can be added.
Simply select the tile of your choice and click on the Add button to
include it in the dashboard. If the minimum size of the tile cannot fit to the
available empty spaces then the tile cannot be added. If you would still like
to add another tile then close the “Add Tile” dialog and resize, rearrange or
remove existing tiles and try again.
Figure 10.5 Add Tile dialog with tabs for different visualizations grouped by type.¶
The Remove all tiles button provides an easy way to get an empty dashboard
by removing all tiles so that you can add the tiles of your choice later.
Finally, the Reset to Default button will undo all the changes made and
reset the dashboard with the default tiles.
Note
All the customizations made to the dashboard are persistent when the dxp is saved.
10.1.3. Show Diff View¶
This navigates to the Diff Page of the current page (see Quality Diff and Availability Diff). It is only available for the Quality pages and for the Data Availability page.
10.1.4. Show Data Details¶
In this dialog you get a drill down from Quality to Data (see Data Details Drill Down). This is only available for Quality pages.
10.1.5. Show Data Origins¶
This dialog allows you to directly access the data reports imported by MQC (see Data Origins).
10.1.6. Manage Pages¶
This section contains all pages that exist in MQC, categorized in five groups (Quality, Data, Tool, Action and Custom pages) and additionally the Dashboard page. You can add or remove them by selecting or deselecting the checkboxes.
Figure 10.6 Pages dialog¶
The Dashboard checkbox allows you to select or deselect the creation of the dashboard in your project. Currently only one dashboard page can be enabled.
Quality pages include Quality Status, Quality Status(Diff), Quality Sunburst, Quality Sunburst(Diff), Quality HeatMap, Quality HeatMap(Diff), Quality Trend, Quality Trend(Diff), and Quality Model pages.
Data pages include Data Availability, Data Availability(Diff), Data Availability(Treemap), Data Status, Data Trend pages.
Action pages include the Action List and Action Treemap pages.
Custom pages: are defined in Custom Pages.
10.1.7. Create Report¶
In this dialog you can create a Status Report (see Status Report).
10.2. Configuration¶
The bottom of menu contains all configurations of the analysis.
10.2.1. Adapters¶
In this dialog you manage adapters (see Custom Adapters).
10.2.2. Data Sources¶
Users can import either single files or directories by clicking on the Data Sources section and select files or directories that contain file reports. For more information about data sources, refer to chapter Data Sources.
Figure 10.7 Configure Data Sources by adding files and/or directories¶
10.2.3. Project Structures and Artifact Mapping¶
Users can load, export or reload Project Structures source files (please refer to Project Structure Configuration for more information).
Figure 10.8 Configure Project Structures and Artifact Mappings¶
By pressing the Create button, a new dialog Create Artifact Mapping Pattern is opened. Here, you can define the Search RegEx and Replace values and the effective result can also be directly seen on the pageable list.
For example in Figure 10.9,
the pattern is defined as: Search RegEx: ^(.*)_demo_.*$ , Replace: $1, which means the
artifact name is the substring of artifact path before _demo_.
Figure 10.9 Define new pattern for artifact mapping¶
As you can see in Figure 10.8, more than one pattern can be defined. The first matching pattern from the list will be applied to the artifact path. The order of the patterns can be changed in the list. The result of these patterns are also present in the export of artifact structure.
Note
These artifact patterns will be applied until there is no project structure imported otherwise artifact mapping in project structure configuration has more priority.
10.2.4. Quality Model and Quality Bin Configuration¶
Users can load, export or reload Quality Model source files. See chapter Quality Model Configuration for more information.
Figure 10.10 Dialog to load, export or reload Quality Model source files and to change the quality bin configuration¶
Additionally, it is possible to adapt the Quality Bin Configuration via this dialog (see Figure 10.10). Bins are used to group quality aspects of a project, i.e. a quality property per artifact for a certain point in time (revision), into categories (see Quality Bins). As per default, MQC uses the calculated quality value to assign a quality property to a quality bin.
You can define project specific quality bins by assigning a color, name, and an upper quality boundary. After creating/editing a quality bin it will be added to the list of already existing quality bins. There is no limit of quality bins you can configure for your project, but be aware there can be only one quality bin for the same upper quality boundary value.
With the given upper quality boundary values MQC is able to define the value ranges for the configured quality bins. Quality values are between 0 % and 100 %. Therefore it is required to define an upper quality boundary of 100 % for the highest quality bin. Then MQC automatically takes the upper quality boundary of the next quality bin as the lower boundary (where the quality bins will be automatically sorted according to the given quality boundary values).
For the default configuration the resulting value ranges are as follows:
Good (green): ]80%, 100%]
Acceptable (yellow): ]20%, 80%]
Bad (red): [0%, 20%]
10.2.5. Target Values¶
Users can load, reload or remove Target Values source files (please refer to Target Values for more information).
Figure 10.11 Configure Target values¶
10.2.6. Annotations¶
Users can justify the calculated quality to document deviations of expected values. Additionally it is also possible to change a quality bin (i.e. from bad to acceptable) or the quality value directly if necessary (please refer to Annotation Configuration for more information).
Figure 10.12 Add Annotations to justify the quality of the quality properties and artifacts in your project¶
10.2.7. Settings¶
This section contains a group of settings:
Figure 10.13 Settings dialog¶
10.2.7.1. Revision granularity¶
Can be used to change the degree of compactions of the revisions for which data exists to better visualize your trend line charts. The revision granularity can be selected depending on your needs (see Figure 10.14).
Figure 10.14 The default revision granularity is Days, but it might be useful to change it to CalendarWeeks or Months¶
10.2.7.2. Context Categories¶
10.2.7.3. Propagation of data¶
(see Data Propagation)
10.2.7.4. Calendar week definition¶
The calendar week definition shows the culture information that was used during the creation of the current project. The culture defines, when the first calendar week of a year actually begin, which is relevant for the calculation of revision names (see Revisions).
Figure 10.15 Select the culture to be used for the calculation of calendar weeks for your project¶
Note
If an MQC project is shared between areas with different culture information, the calendar week definition, which was initially determined during the creation of the project, is kept. This allows a consistent view on data and quality.
Nevertheless, the initial setting can be adapted with this dialog, if necessary.
10.2.7.5. Revisions without data¶
10.2.7.6. Target values in visualization¶
10.2.7.7. Measure values as labels in visualizations¶
10.2.7.8. Automatic server refresh¶
MQC projects stored within the MQC server library are updated periodically to fetch the latest data changes. Background server-side updates are only executed if new or changed data was detected. This ensures that all projects are always kept up to date.
The setting allows the user to control the automatic update of each project separetely. After disabling this check box, the update job running on the MQC server skips the corresponding project.
See Update Projects on Server for details on how to add a job to the “Automation Services” on the MQC Server, which periodically checks and updates MQC projects stored within the server library.