# Server parameters

In this topic, you will find some server parameters, which can be added to configure your server more individually.&#x20;

To add one of these you will need to open the Web.config, which can be found by default here: *<mark style="color:blue;">**C:\Programm Files\andagon GmbH\aqua for IIS\Web\Webservice\Web.config**</mark>*&#x20;

In order to add a parameter, you need to find the "\<appSettings>" section in the Web.config file and insert a new line (or edit an existing one)&#x20;

```
<add key="<yourParameter>" value="<yourValue>" /> 
```

Below you will find a list of available server parameters.&#x20;

{% hint style="warning" %}
Changing these parameters is at your own risk.&#x20;
{% endhint %}

| Parameter          | Allowed / sample values                                                             | Default         | Meaning                                                                                                                                                           |
| ------------------ | ----------------------------------------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ServerIdentity     | e.g. aqua                                                                           | None(required)  | Identifies the server instance                                                                                                                                    |
| Database           | e.g. Data Source=localhost\sqlexpress;Initial Catalog=AQUA;Integrated Security=True | None (required) | Database connection string                                                                                                                                        |
| ServerAddress      | e.g. aqua.company.local                                                             | None (required) | Address of the server as included in the new user notification                                                                                                    |
| LocalServerBaseDir | e.g. c:\aquaWebserviceConfig                                                        | None (required) | Parent folder where additional config files are located (in a subdirectory named after ServerIdentity). Contains, for example, subfolders with licenses and logs. |

&#x20;

### Parameters for Notifications <a href="#parameters_for_notifications" id="parameters_for_notifications"></a>

| Parameter                      | Allowed / sample values | Default      | Meaning                                                                                                     |
| ------------------------------ | ----------------------- | ------------ | ----------------------------------------------------------------------------------------------------------- |
| NotificationEmailSmtpHost      | e.g. mail.company.local | Not existing | Address of SMTP server. If not defined then notifications functionality is disabled.                        |
| NotificationEmailSmtpPort      |                         | 25           | SMTP server's port                                                                                          |
| NotificationEmailSmtpUserName  |                         | none         | ...                                                                                                         |
| NotificationEmailSmtpPassword  |                         | none         | ...                                                                                                         |
| NotificationEmailSmtpEnableSSL | true / false            | false        | If true then SSL communication is enabled. Only STARTTLS is supported. (-> SMTPS (port 465) does not work). |
| NotificationEmailSmtpRetries   |                         | 1            | How many times to try to send a single message.                                                             |
| NotificationEmailFrom          | <aqua@andagon.com>      | None         | 'From' address of notifications send by aqua server                                                         |
| NotificationEmailTimeout       | number (in ms)          | 60000        | SMTP timeout                                                                                                |
| NotificationSubjectMaxLength   |                         | 4000         | Maximum length of generated subject. If exceeds, then will be cut (using ellipsis)                          |
| NotificationPeriod             | number of ms            | 3000         |                                                                                                             |
| DisableDefaultNotifications    | true/false              | false        | Can be used to disable sending default notifications (e.g. about new items) to all members of a project.    |

&#x20;

### Parameters for Dependecies <a href="#parameters_for_dependecies" id="parameters_for_dependecies"></a>

| Parameter                    | Allowed / sample values | Default | Meaning                                                                |
| ---------------------------- | ----------------------- | ------- | ---------------------------------------------------------------------- |
| CreateCopyDependencies       | true/false              | true    | If false then no dependency created on copying an item                 |
| CreateNewVersionDependencies | true/false              | true    | If false then no dependency created on creating new version of an item |

&#x20;

### Parameters for Attachments <a href="#parameters_for_attachments" id="parameters_for_attachments"></a>

| Parameter                                        | Allowed / sample values | Default         | Meaning                                                                                                                                                                                                                                                                             |
| ------------------------------------------------ | ----------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| MaximumAllowedAttachmentSizeInBytes              | Number, in bytes        | 10485760 (10MB) | <p>Maximum size (in bytes) of attachments that can be stored in aqua.<br>Note: the <a href="https://aquacloudio.zohodesk.eu/portal/en/kb/articles/modify-maximum-attachment-size">following</a> additional adjustments need to be configured, depending on the server settings.</p> |
| MaximumAllowedImageInRTFSizeInBytes              |                         |                 |                                                                                                                                                                                                                                                                                     |
| MaximumAllowedQTPScriptFileSizeInBytes           |                         |                 |                                                                                                                                                                                                                                                                                     |
| MaximumAllowedScriptAttachmentSizeInBytes        |                         |                 |                                                                                                                                                                                                                                                                                     |
| MaximumAllowedOverallScriptAttachmentSizeInBytes |                         |                 |                                                                                                                                                                                                                                                                                     |

&#x20;

### Parameters for Performance Log <a href="#parameters_for_performance_log" id="parameters_for_performance_log"></a>

| Parameter                     | Allowed / sample values | Default | Meaning                                                                        |
| ----------------------------- | ----------------------- | ------- | ------------------------------------------------------------------------------ |
| DbLogEnabled                  | true/false              | false   | If enabled, long running db queries are logged                                 |
| DbLogLimit                    | number                  | 1000    | Limit in milliseconds for the execution time of single db query or transaction |
| DbLogAll                      | true/false              | false   | If enabled, all db queries are logged. This produces lots of log entries!      |
| RequestStatisticsEnabled      | true/false              | true    | If enabled, long running requests are logged                                   |
| RequestStatisticsWindowSize   | number                  | 600000  | Time window in milliseconds to consider for the overall limit                  |
| RequestStatisticsOverallLimit | number                  | 30000   | Overall limit in milliseconds for the execution time used by a session.        |
| RequestStatisticsRequestLimit | number                  | 2000    | Limit in milliseconds for the execution time of a single request               |
| RequestStatisticsLogAll       | true/false              | false   | If enabled, all requests are logged                                            |

&#x20;

### Parameters for numbers of elements <a href="#parameters_for_numbers_of_elements" id="parameters_for_numbers_of_elements"></a>

| Parameter                                  | Allowed / sample values | Default | Meaning                                                                                                                                                                |
| ------------------------------------------ | ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| NumberOfElementsInTestCaseExecutionHistory |                         |         | How many elements to show in the execution history ("sparkline") of a test case. Old data is not updated after changing this.                                          |
| MaximumAllowedNumberOfItemsInOneUpdate     |                         |         | How many items can be updated in single operation (by context's menu "Change" operation)                                                                               |
| NumberOfItemsInOneUpdateWarningLevel       |                         |         | How many items selected for updated in single operation (by context's menu "Change" operation) causes a warning (because selecting too many items can take long time). |
| MaximumNumberOfTestJobsInTestScenario      | number                  | 2000    | Maximum number of test jobs allowed in a test scenario.                                                                                                                |

&#x20;

### Miscellaneous parameters <a href="#miscellaneous_parameters" id="miscellaneous_parameters"></a>

| Parameter                          | Allowed / sample values | Default | Meaning                                                                                                                   |
| ---------------------------------- | ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| SingleSignOn                       | true/false              | false   | Activates SSO functionality. Requires AD plugin.                                                                          |
| EnableStopWatchForManualExecutions | true/false              | true    | If false then timer in execution window will not be shown (useful when legal regulations prevent from using such a timer) |
| ActiveDirectory.Domain             | domain name             | None    |                                                                                                                           |
| Reports.MaxExecutionsTC            | number                  | 100     | specifies maximum number of (test job-) executions to be included in test case report                                     |
| Reports.MaxExecutionsTS            | number                  | 1000    | specifies maximum number of (test job-)executions to be included in test scenario report                                  |

&#x20;

### Parameters WebClient <a href="#parameter_webclient" id="parameter_webclient"></a>

The following parameters can be configured in the aquaWebNG.config for the WebClient, which can be found in the following default path: &#x20;

*<mark style="color:blue;">**C:\Program Files\andagon GmbH\aquaWebNG\aquaWebNG**</mark>*&#x20;

In order to add a parameter, you need to find the "\<aquaWebNGConfig>" section in the aquaWebNG.config file and insert a new line (or edit an existing one)

```
<addKey="<YourParameter>" value="<YourValue>" />
```

| Parameter                     | Allowed / sample values | Default | Meaning                                                                                                                                                                                                                                    |
| ----------------------------- | ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| AQUA\_REPORT\_SCRIPTING\_MODE | Deny/Allow              | Deny    | Allows to create Reports in WebClient that contain Scripts. Attention: Not trusted users might use this to compromise your server. Thus, please make sure that only trusted users are able to create/import reports to your aqua instance. |
| IEAllowed                     | true/false              | false   | Enables Internet Explorer, if set to true.                                                                                                                                                                                                 |
| AQUA\_FORCE\_HTTPS            | true/false              | false   | Forces forwarding to https in the Web client if the value is TRUE.                                                                                                                                                                         |

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aqua-cloud.io/documentation/installation-for-on-premise/server-parameters.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
