Aviator setup

This section details how to install your license and configure Aviator to work with your preferred large language model (LLM).

Relevant for: Web Client on-premises

Upload your license

To work with Aviator, you require a valid license.

To upload your Aviator license:

  1. Go to Site Admin > Licenses > License Management.

  2. In the toolbar, click Modify Licenses >  Upload Licenses.

  3. Upload your Aviator license file.

Assign licenses to projects

Before you can start using Aviator, you need to assign licenses to projects.

To assign a license to a project:

  1. Go to Site Admin > Licenses > License Management.

  2. In the  License Assignments tab, view the list of domains and projects.

  3. Assign Aviator licenses to the domains and projects you want to enable.

Configure site parameters

To use Aviator, you need your own LLM. Add a site parameter for the LLM provider.

To add the custom LLM provider parameter:

  1. Go to Site Admin > Site Configuration > Parameters.

  2. Configure your LLM provider by adding the CUSTOM_AI_CONFIG site parameter.

    The following table details the parameter values.

    Model Values
    Mistral {"customAiConfig":[{"customAIModelName":"MISTRAL_AI","configData":{"baseUrl":"","modelName":"","apiKey":""}}]}
    OpenAI {"customAiConfig":[{"customAIModelName":"OPEN_AI","configData":{"modelName":"","apiKey":""}}]}
    Gemini {"customAiConfig":[{"customAIModelName":"VERTEX_GEMINI_AI","configData":{"projectId":"","location":"","modelName":"","createScoped":"","mediaBucketName":"","credFile":true}}]}

For more details on adding site parameters, see Configure parameters and mail settings

Configure prompt chips

The prompt chips displayed in the Aviator Smart Assistant are controlled by a site parameter.

Use the AVIATOR_CHIPS_IN_REQUIREMENT parameter to control which chips are displayed. By default, all three chips are displayed. For more details on site parameters, see Site Parameters.

Choose from the following options.

Chip Value
Generate Tests Tests
Generate Sub-Requirements Sub-Requirements
Summarize Requirement Summarize

To display chips for users in the Viewer group, set the SKIP_PERMISSION_CHECK_PARMLIST_LIST site parameter to its default value of AVIATOR_CHIPS_IN_REQUIREMENT. Without this setting, users in the Viewer group cannot see the Aviator chips. The default value also allows users who lack permissions to create test folders, tests, or test coverage to create tests from Aviator-generated suggestions

Aviator configuration

After adding the site parameter for your custom LLM, configure Aviator.

To configure your AI model to work with Aviator:

  1. In Site Admin, select ALM Aviator from the menu.

  2. Select your domain and click on a project to configure AI settings. Only Aviator-licensed projects can be configured.

  3. Choose your LLM model provider.

  4. Enter the configuration details required for your LLM.

    These vary depending on the LLM provider and include settings such as model name and API key or credentials file.

  5. Click Save.

Copy the configuration to multiple projects

After configuring one project, you can assign the same configuration to other projects.

To copy the LLM configuration to other projects:

  1. In Site Admin > ALM Aviator, select the configured project.

  2. Click Assign Configuration to Projects.

  3. In the list of projects in the Domain, select the projects to which you want to assign the configuration. Click Assign.

  4. The configuration is copied automatically to the selected projects.

Back to top