1. Launch the configuration tool:

   axivion_config axivion\axivion_config.json
   

2. Set the following properties:

   • Project Directory (/Project/directory):

     Set this to your repository root directory.

     Example: C:\projects\MyProject or /home/user/projects/MyProject

   • Project Name (/Project/name):

     Set a unique name for your project.

     Example: MyProject

     Alternatively, you can set the project name using the AXIVION_PROJECT_NAME environment variable.

3. Configure Version Control System (VCS) integration:

   If your project is under version control, set the VCS type and repository URL to enable integration with the Axivion Dashboard.

   Go to /Project/VCSIntegration and enable the appropriate VCS (e.g., Git, Subversion). For many supported VCS, the necessary configuration will be automatically detected based on the project directory.

   In case of source code that is generated during the build and still relevant for analysis, you can enable Shadow in order to do automatic code versioning of generated code.

   For a description of the available VCS options, see VCSIntegration.

4. Decide whether to configure the analysis as a managed (recommended) or unmanaged dashboard project:

   In a managed project the build artifacts are automatically uploaded to the dashboard and managed by the dashboard. An unmanaged project requires file-system access to the dashboard database. For more information see the Dashboard Project Configuration.

   • To configure a managed project, set the /Results/Dashboard/database_mode property to managed_upload. You should supply the necessary dashboard credentials by setting the environment variables AXIVION_USERNAME and AXIVION_PASSWORD. If the variables are not properly set, the axivion_ci tool will prompt you to provide the credentials when the script is run.

   • To configure an unmanaged project, set the /Results/Dashboard/database_mode property to shared_database and set the AXIVION_DATABASES_DIR environment variable to the path of the dashboard’s databases directory.

   Note

   You can also set the dashboard credentials and database directory directly in the configuration file using the properties in /Results/Dashboard/ci_mode/authentication and /Results/Dashboard/ci_mode/directory.

5. Review the example defaults in /Analysis/GlobalOptions/global_excludes and add any paths that should be excluded from all analyses. For example, you may want to exclude generated code or third-party libraries. For more information on exclude options, see Exclude files from the Analysis.