23. Setup Configuration

MQC provides the possibility of loading a setup configuration to easily setup a project. This is done via an Excel file in which the user can define

• files and directories containing reports of tools/data sources to be imported into MQC

• names and paths of MQC configuration files, e.g. project structure

• as well as almost all options, e.g. revision granularity.

23.1. How to use

After unziping sample data you can find an example for an setup configuration in it with the name of 00_SetupConfiguration.xlsx, configured for MQC showcase.

Figure 23.1 Sample of setup configuration file

For using this feature, first copy sample data anywhere in your local file system or network then open MQC and instead of choosing Create new Project, import 00_SetupConfiguration.xlsx by clicking on Open local file....

Figure 23.2 How to import Setup Configuration excel file for easy setup of MQC

Note

If you are using web version of MQC, before importing setup configuration you need to ensure that the MQC showcase is located on a network drive which is mounted at and can be accessed by the server. Open the 00_SetupConfiguration.xlsx and update the BasePath value with the network path of the directory where the MQC showcase is located.

23.2. Configuration

The setup configuration is an excel file with two columns named Type and Value. Contents of first column (Type) are constant and second column should be configured.

This configuration can be divided in three parts:

1. Set the paths of all files that can be imported in MQC. This contains:

• Project structure configuration (see Project Structures Configuration)

• Quality model configuration (see Quality Model Configuration)

• Target values configuration (see Target Values)

• Custom pages configuration (see Custom Pages)

• Files and directories containing reports of tools/data sources: for each of directories and single files to be imported, one row is added to the setup configuration file via type Data and path of them as value.

• Custom adapters: for each custom adapter, a separate row should be added with CustomAdapter as type and path of file as value. For more detailed information please see Developing a Custom Adapter.

Note

As Figure 23.1 shows, the first row of the setup configuration is for setting a BasePath. If all files are located under the same path, this can be defined one time as BasePath and all other path values may be configured as relative paths.

2. Set default values for MQC options. This contains:

• Automatic refresh: can be true or false (see Configuration)

• Propagation: can be None, All:Project or All:Milestone (see Data Propagation)

• Revision granualarity: can be Month, CalendarWeek or Day (see Revision granularity)

• Show empty revisions: can be true or false (see Project Milestone Structure)

• Enable context categories: can be true or false (see Configuration of Context Categories)

• Show target values: can be true or false (see Target Values)

• Show measure value labels: can be true or false (see Adapt Visualizations on Custom Pages)

• Adapters: list of base adapters which should be enabled in MQC, all entries are separated by comma (,), if empty or not defined all base adapters are enabled. For more detailed information please see Custom Adapters.

• ArtifactMappingPattern: there should be one excel row for each pattern (see Artifact Mapping) and in Value cell first line is Search RegEx and second line is Replace.

3. Set the pages, which should be shown in the analysis. For each row from a group of provided pages in MQC, chosen pages should be added and separated by comma (,). For more detaile information please see Pages

Note

All values may be left empty. MQC applies defaults for all values, which are not configured here.

Errors in configuration will be ignored. In any case an analysis is created and the user gets a notification via a validation dialog after the load of the intial configuration has been finished.

23.3. Export Setup Configuration

In MQC you can export setup configuration file which contains all the settings done in the current project in order to use it for creating other projects. For that please choose Export Setup Configuration button in Settings section of configuration menu.

Figure 23.3 How to export Setup Configuration excel file for current project