Share this page

# Configuration parameters

Site and space admins can set configuration parameters that determine how ALM Octane works.

In this topic:

## Overview

Configuration parameters can be set to control the behavior of different areas in ALM Octane.

You can define parameters at two different levels:

Site-level parameters | Parameters that are set at the Site level affect all the spaces in the site. Site administrators can access the site-level parameters at Settings > Site > Parameters.
Space-level parameters | Parameters that are set at the Space level affect that space only and its workspaces. Space administrators, and site administrators with permissions on the space, can access the space-level parameters at Settings > Spaces > Parameters.

Tip: Admins can also set configuration parameters using the REST API. For details, see Setting configuration parameters with the REST API.

If the same parameter is set for the Site and for a given Space, the values of parameters set on the space level override the values of the same parameters set at the site level.

Changes to parameters are audited. You can retrieve the audit information via the REST API. For details, see Auditing entities (technical preview).

Back to top

## Parameters

ALM Octane includes the following configuration parameters:

Parameter | Scope | Description
--- | --- | ---
ALLOWED_EXTERNAL_EMAIL_DOMAINS | Site/Space | Allows admins to add external email addresses to the Send to list in a Send email business rule. Enter multiple domains as a comma-separated list without spaces. To allow any external domain, enter an asterisk, *. For details, see Rule actions. Example: gmail.com,yahoo.com Type: string
ADDITIONAL_ALLOWED_TLD | Site | ALM Octane validates that the top-level domain (TLD) entered in the SERVER_BASE_URL parameter is listed in https://www.iana.org/domains/root/db. If your URL includes a TLD that is not listed there, enter your TLD in this parameter. For example, if your SERVER_BASE_URL is http://a.b.corp, enter corp in the ADDITIONAL_ALLOWED_TLD parameter. You can enter multiple TLDs as a comma-separated list without spaces. Example: corp,corp1 Type: string
ALLOW_HTTP_METHOD_OVERRIDE | Site | Allows override method through HTTP header. This is not allowed for GET requests. Type: boolean Default: false
ALM_OCTANE_IMPROVEMENT_PROGRAM_AGREEMENT | Site | Provides ALM Octane R&D with the ability to collect Google Analytics data related to how users are using ALM Octane. Type: string Values: true, false, WAITING_FOR_DECISION Default: WAITING_FOR_DECISION
ATTACHMENTS_BULK_CREATE_MAX_SIZE | Space | When creating attachments in bulk, this number defines the maximum size of the request. Type: integer Default: 100
ATTACHMENTS_BULK_MAX_FILE_SIZE | Space | When creating attachments in bulk, this number defines the maximum file size of attachments in the request. Type: integer Default: 100
ATTACHMENTS_FILE_EXTENSION_BLACK_LIST | Site | Defines a list of prohibited file extensions for ALM Octane attachments. After saving this parameter, any extensions listed in this value are removed from the list of permitted extensions in the ATTACHMENTS_FILE_EXTENSION_WHITE_LIST configuration parameter. The extensions are removed for the entire site and all spaces. Separate each extension with a semi-colon (;). Type: string Default: empty
ATTACHMENTS_FILE_EXTENSION_WHITE_LIST | Site/Space | Defines a list of the permitted file-type extensions for ALM Octane attachments. To permit all attachments, regardless of file extension, enter an * (asterisk). For security purposes, this is not recommended. Separate each extension with a semi-colon (;). You cannot add extensions that are prohibited, as specified in the ATTACHMENTS_FILE_EXTENSION_BLACK_LIST configuration parameter. Note: You can also add additional, custom file extensions to the list of permitted extensions for ALM Octane attachments. The file types (mime types) must be one of ALM Octane's supported mime types, but you can choose any extension you like. For details, see the EXTENSION_TO_MIME_TYPE and the VALIDATE_MIME_TYPE_MATCH_TO_EXTENSION configuration parameters. Type: string Default: ngalink; links; jpg; bmp; png; pdf; word; doc; docx; msg; xml; xls; xlsx; ppt; pptx; zip; txt; wmv; mp4; m4p; mkv; vob; log; wrf; fbr; jpeg
ATTACHMENTS_PREVIEW_FILE_EXTENSIONS | Site/Space | Defines the file-type extensions that can be previewed in ALM Octane. The file types listed in this parameter are previewed in a protected mode. For example, any malicious scripts are blocked in the preview. To allow the unprotected preview of the files, also list the file extensions in the ATTACHMENTS_PREVIEW_LOW_SECURITY_FILE_EXTENSIONS parameter. To allow previewing Microsoft Office files, or other files for which browsers do not have embedded previews: Add Office or other file extensions to this parameter. Ensure that the file types are also listed in the ATTACHMENTS_FILE_EXTENSION_WHITE_LIST parameter. Note: To preview Office files, or other files for which browsers do not have embedded previews, every user should install a third-party browser extension. If the extension is not installed, the file preview does not open. Instead, when the user tries to preview the file, the file is automatically downloaded. Before installing any browser extension, ensure that the extension is safe and does not violate your company security policy. The default file types can be previewed without installing any browser extensions. Separate each extension with a semi-colon (;). Type: string Default: pdf;txt;log;html
ATTACHMENTS_PREVIEW_LOW_SECURITY_FILE_EXTENSIONS | Site/Space | Defines the file-type extensions that can be previewed in ALM Octane without any security protection. Malicious scripts could also run in the preview. Note: To allow previewing the file types, list the file extensions in the ATTACHMENTS_PREVIEW_FILE_EXTENSIONS parameter as well. Separate each extension with a semi-colon (;). Type: string Default: pdf;doc;docx;xls;xlsx
ATTACHMENTS_URL_DOMAIN_WHITE_LIST | Site | Defines a list of the permitted domains for ALM Octane attachment URLs. Used only if ATTACHMENTS_URL_ENABLE_DOMAIN_WHITE_LIST is set to true. Separate each domain with a semi-colon (;). Type: string
ATTACHMENTS_URL_ENABLE_DOMAIN_WHITE_LIST | Site | Activates or deactivates usage of the domain allow list validation of attachment URL, as defined by ATTACHMENTS_URL_DOMAIN_WHITE_LIST. Type: boolean Default: false
AUDIT_LOG_FILE_MAX_SIZE | Site | Defines the maximum size (in KB) of each audit log file. Type: integer Default: 10240 Minimum: 1024 Maximum: 102400
AUDIT_LOG_FILE_ROLLING_SIZE | Site | Defines the number of audit log files that are retained. Type: integer Default: 10 Minimum: 10 Maximum: 100
AUTHENTICATION_DELAY_ACTIVE | Site | Sets whether user login attempts are monitored for suspicious activity. By setting this, the AUTHENTICATION_DELAY_SECONDS, and the AUTHENTICATION_MAX_ATTEMPTS site configuration parameters, you can control if ALM Octane ignores or prevents suspicious login attempts. For details on how ALM Octane handled login attempts, see the audit log. Type: boolean Default: true
AUTHENTICATION_DELAY_SECONDS | Site | If AUTHENTICATION_DELAY_ACTIVE is set to true, the number of seconds after which ALM Octane stops checking entered login credentials. The counts starts after the first failed login attempt. After the number of seconds has lapsed, ALM Octane starts to check login credentials again. After setting this site configuration parameter, restart the ALM Octane server. Type: integer Default: 15 seconds
AUTHENTICATION_MAX_ATTEMPTS | Site | If AUTHENTICATION_DELAY_ACTIVE is set to true, the number of attempts after which ALM Octane locks out the user trying to log in. Type: integer Default: 3
AUTHENTICATION_TOKEN_GLOBAL_TIMEOUT | Site | Version 24.3 and later: The maximum number of minutes that the authentication token stays valid while a session is in use. After this timeout, the user must log in again. Applicable only for non-SSO environments and API keys. In SSO environments, the authentication timeout is defined in the SSO configuration. Type: integer Default: 1440 (24 hours)
AUTHENTICATION_TOKEN_IDLE_TIMEOUT | Site | Version 24.3 and later: The maximum number of minutes that the authentication token stays valid while a session is not in use. After this timeout, the user must log in again. Applicable only for non-SSO environments and API keys. In SSO environments, the authentication timeout is defined in the SSO configuration. Type: integer Default: 180 (3 hours)
AUTOMATIC_TIMING_OF_MANUAL_RUN_DURATIONS_TOGGLE | Site/Space | Determines whether the duration of manual and Gherkin test runs is measured automatically. The timer starts when the Manual Runner window is launched, and stops when the Manual Runner window is closed. The timing is stored in the test run's Duration field. Type: boolean Default: false
BASIC_AUTHENTICATION_CACHE_TTL_SECONDS | Site/Space | Defines how long the REST API basic authentication result is cached (in seconds). Subsequent requests are validated against the cache, rather than requiring full authentication. For details, see Basic authentication. Type: integer Default: 120 seconds
BDD_INJECT_SPECS_TYPE_BY_DEFAULT | Space | Determines whether new BDD content is automatically injected as a BDD specification. If false, it is injected as a Gherkin test. For details, see Automated scenario injection. Type: boolean Default: true
BLAME_COMMITTER_ANALYZERS_EXCLUDE_FILE_EXTENSIONS | Site/Space | The file extensions to exclude from the Commit Message and Commit Files analyzers. Files with these extensions are not analyzed as the main cause of failures. For example, you can add .md files to this list, along with other files that do not affect test failures. For details, see Find commits related to failures. Type: string (entries separated by commas). The strings are not case-sensitive.
BLAME_COMMITTER_ANALYZERS_EXCLUDE_WORDS | Site/Space | The words to exclude from the Commit Message and Commit Files analyzers. The analyzers won't trigger a blame report for the committer when it detects one of these words. For details, see Find commits related to failures. Type: string (entries separated by commas). The strings are not case-sensitive. Default: data, defect, feature, revert, fix, implement, service, review, tech, test, exception, graph, widget, entity, run, module, it, case, cases, tests, itcase, assert, add, remove, read, class, handler, getter, setter, error, check, pre, post, create, update, action, rest
BOARD_MAX_COLUMNS_TO_DISPLAY | Site/Space | The maximum number of columns to display in a Board view. Type: integer Default: 30
BOOLEAN_STRING_UDFS_LIMIT | Site/Space | The maximum number of boolean-type and string-type UDFs combined that can be defined per workspace. Boolean values are saved internally as strings, so their limit is a combined limit. If I have defined 98 UDFs of type string, I can add two more UDFs and they can be strings or booleans, or one of each. Type: integer Default: 100 Minimum: 0 Maximum: 100
BULK_DELETE_MAX_SIZE | Site | The maximum number of records that can be deleted in a bulk delete operation. Type: integer Default: 5000 entities. This is also the maximum value.
BULK_UPDATE_MAX_SIZE | Site | The maximum number of records that can be updated in a bulk update operation. Type: integer Default: 5000 entities. This is also the maximum value
CASE_INSENSITIVE_USER_NAME_IN_INTERACTIVE_AUTHENTICATION | Site | Defines whether the user name should be case insensitive in the interactive tools authentication. For details, see Interactive integration for ALM Octane authentication. Type: boolean Default: false
CD_SERVER_DA_READ_PAGE_SIZE | Site/Space | Determines the number of DA items that ALM Octane can obtain from a single request. Type: integer Default: 100 Minimum: 1 Maximum: 500 Configurable by site admin only.
CD_SERVER_HTTP_CLIENT_TIMEOUT | Site/Space | Determines the timeout period in seconds, for the deployment server HTTP client. Type: integer Default: 30 Minimum: 10 Maximum: 600 Configurable by site admin only.
CD_SERVER_MAX_COUNT_IN_TENANT | Site/Space | Determines the number of CD servers that can be integrated per tenant. Type: integer Default: 50 Minimum: 1 Configurable by site admin only.
CI_EXTERNAL_REQUEST_TIMEOUT_SECONDS | Site | Defines a timeout (in seconds) for sending a request to an external CI server. Type: integer Default: 30
CI_REQUEST_DEFAULT_TIMEOUT_IN_SECONDS | Site/Space | Defines a timeout (in seconds) for completing a request to the CI Server. Type: integer Default: 30
CLIENT_TYPES_ALLOWED_TO_ACCESS_REST_API | Space | Allowlist of client types that can access the REST API with a regular user, as opposed to an API key. Type: string Default: HPE_SWAGGER_API,OCTANE_IDE_PLUGIN,MF_QOT
CLUSTERING_MAX_TESTS_THRESHOLD | Site | Determines the number to be used as a threshold for test clustering analysis. For example, if this parameter is set to 200, and more than 200 tests fail for a pipeline run, ALM Octane does not analyze clustering. Type: integer Default: 200 Minimum: 0 Maximum: 50000
CONTINUE_RUN_WITHOUT_PERMISSION_GRACE_PERIOD | Site/Space | Determines the period, in minutes, during which users without the Modify Completed Run permission can edit a manual run and its steps, after the run is completed. Users can modify a completed run while the manual runner is still open. If the manual runner is closed, users cannot reopen it to edit the run, regardless of the provided grace period. Note: The parameter is applied only when the log-in session in which the run was completed is over. If the user has not logged out, and a manual runner is open, they can modify a completed run regardless of the provided grace period. Type: integer Default: 30 Minimum: 0
COPY_RUN_SUITE_UDFS_TO_RUNS | Site/Space | Determines whether user-defined field (UDF) values that are defined for a test suite run (or plan) are copied to the associated test runs. Type: boolean Default: true
COPY_SPRINT_AND_MILESTONE_FROM_RUN_TO_DEFECT | Site/Space | Determines whether the Milestone and Sprint fields of a new defect are automatically populated when the defect is created from a run. Version 24.1 and earlier: Auto-populate is supported from within the Manual Runner only. Type: boolean Default: true
CORS_ALLOW_ORIGIN | Site/Space | A list of domains that are allowed to connect to the ALM Octane server using browser CORS functionality. Syntax: http(s)://<yourdomain>.<ext> Type: string
CORS_AUTH_ALLOW_ORIGIN | Site | A list of domains that are allowed to perform authentication requests to establish authenticated sessions with the ALM Octane server using browser CORS functionality. Syntax: http(s)://<yourdomain>.<ext> Type: string
CORS_ENABLED | Site | Determines whether CORS support is active on ALM Octane. Type: boolean Default: true
CORS_MAX_AGE | Site/Space | Indicates how long (in seconds) the results of a pre-flight request can be cached. Type: integer Default: 7200
COVERAGE_MAX_SIZE_TO_FUSE | Site | The maximum size of a coverage file that may be injected to the system. Type: integer Default: 50 MB
CREATE_STEPS_DURING_RUN_CREATION | Site/Space | Determines whether manual test run steps are created together with a test run. If 'true': Test run steps are created when a manual test run is created. If 'false': Test run steps are created when the manual test run starts executing in Manual Runner. Type: boolean Default: false
DASHBOARD_WIDGETS_CACHE_DURATION_IN_SECONDS | Site/Space | Version 24.1 and later: The browser cache duration (in seconds) for dashboard widgets. After the specified duration passes, the browser cache for widgets is cleared. If the value is set at -1, the cache is never cleared. Type: integer Default: 3600 (one hour)
DATE_UDFS_LIMIT | Site/Space | The maximum number of date/time UDFs that can be defined per workspace. Type: integer Default: 20 Minimum: 0 Maximum: 20
DEFAULT_DB_SERVER | Site | The ID of the default database server. This value is used for tenant creation in a SaaS environment. Type: string
DEFAULT_GET_ODATA_PAGE_SIZE | Site | The maximum number of items that will be fetched in a single request. The request's "$top" parameter supersedes this limit. Type: integer Default: 1000
DEFAULT_GET_PAGE_SIZE | Site | The default number of items to return. Type: integer Default: 1000 Maximum: 10000
DEFAULT_LANGUAGE | Site/Space | The default language for the site or the shared space. Type: string Default: lang.en Values: English: lang.en French: lang.fr German: lang.de Japanese: lang.jpn Portuguese (Brazil): lang.ptb Russian: lang.ru Simplified Chinese: lang.chs Spanish: lang.esp
DELETE_WORKSPACE_REASON_REQUIRED | Site/Space | Determines whether the Delete reason field is required when deleting a workspace. Type: boolean Default: true
DENY_EXTERNAL_IMAGES | Site | Deny the embedding of external images inside HTML content. Type: boolean Default: false
DISABLED_ANALYZERS | Site | Defines a list of assignment recommendation analyzers to disable. Type: comma separated string Default: empty
DISPLAY_JQUERY_WARNINGS | Site | Displays the JavaScript exception stack trace for errors, reported to the user and sent back to the server. Type: boolean Default: false
DISPLAY_MAINTENANCE_PARAMS | Site | Display the maintenance site parameters in the list of site parameters. Type: boolean Default: false
DOC_REPORT_COLORED_TEST_SCRIPT | Site/Space | Allows the administrator to generate reports with color for scripts or steps in Gherkin and manual tests. Type: boolean Default: true
DOCUMENT_REPORT_AMOUNT_OF_ALLOWED_WIDGETS | Site/Space | The number of widgets allowed in Document reports. Default: 20
DOCUMENT_REPORT_ATTACHMENTS_SIZE_LIMIT | Site/Space | This maximum size of all of the report's attachments in MB. The default is 16 MB for the entire report.
DOCUMENT_REPORT_LINK_IMG_DOMAINS_ALLOWED_LIST | Site/Space | Defines a list of domains for which image URLs can be embedded in document reports as images. Example: Suppose you have an image: http://www.google.com/image1.jpg. To allow this image to be included in the document report, you would add the domain google.com in this parameter. If you want to have images from several domains available such as google.com and opentext.com, then you would enter google.com;opentext.com in the parameter. Note: Ensure that the image file extension that appears in the URL is listed in the ATTACHMENTS_FILE_EXTENSION_WHITE_LIST parameter. Separate each domain with a semi-colon (;). Type: string
DOCUMENT_REPORT_LOGO_FILE_EXTENSIONS | Site/Space | The allowed file extensions for document report logos. Type: string (multiple values separated by semicolons) Default: jpg, bmp, png, and jpeg.
DOCUMENT_REPORT_LOGO_MAX_SIZE | Site/Space | The maximum allowed size of a document report logo in MBs. Type: integer Default: 5
DOCUMENT_REPORT_READER_PAGE_SIZE | Space | The maximum number of pages allowed in a document report. Type: integer Default: 1000
DROPDOWN_MAX_ITEMS | Site/Space | The maximum number of items that are displayed in dropdown lists. Type: integer Default: 200 Minimum: 30 Maximum: 1000
EDITABLE_TEST_TYPE_FOR_RUN | Site/Space | Allows the editing the Test Type field of a test run. Type: boolean Default: true
ELASTIC_MAINTENANCE_MAX_WORKERS_PER_NODE | Site | After upgrade, changes are made to Elasticsearch indexes. Processes run per space that re-index the old space indexes created in an Elasticsearch version earlier than 6.x, and update them to the current Elasticsearch version. This parameter sets the number of concurrent re-index processes that can run on each cluster node. The total number of re-index processes cannot exceed 10. The recommendation is to set this number to a low value if you have many cluster nodes. Type: integer Default: 4 Minimum: 1 Maximum: Cannot exceed 10 for the entire cluster. For example, if you have 3 cluster nodes, you can set the maximum value to 2.
ELASTIC_ROUTING_ENABLED | Site | Type: boolean Default: false
ELASTIC_STOP_EXECUTE_REINDEX_POST_UPGRADERS | Site/Space | Stops the 'Elasticsearch index maintenance' post-upgrade job from running, or prevents it from running if it did not start yet. The job completes with the FAILURE status and can be re-run at a later time to complete the process for indexes that were not yet re-indexed. Type: boolean Default: false
EMAIL_LOGO_FILE_EXTENSIONS | Site/Space | A semicolon separated list of the allowed image file extensions, when uploading a picture as the email header. Type: string Default: jpg;bmp;png;jpeg
EMAIL_LOGO_MAX | Site | The maximum image file size allowed to upload as en email header. Type: integer Default: 5 MB
EMAIL_QUICK_REPLY | Site/Space | Determines whether users can reply to comments they are mentioned in via a slimmed down web page. The web page requires an initial user log in. For details, see Comment on items. Type: boolean Default: false
ENABLE_ASSIGN_USER_TO_RELEVANT_CONTEXT | Space | If true, allows to assign user to relevant tenant. Type: boolean Default: false
ENABLE_AUDIT | Site | Defines whether the audit log is used. Type: boolean Default: true
ENABLE_DUPLICATE_ENTITY | Site/Space | Activates the duplicate entity functionality in the ALM Octane UI. Type: boolean Default: true
ENABLE_FAVORITE_PUBLIC_LINKS_PER_SHARED SPACE | Space | Defines whether sharing public favorites is allowed on the shared space. For details, see Public favorite links. Type: boolean Default: false
ENABLE_FAVORITE_PUBLIC_LINKS_PER_SITE | Site | Defines whether sharing public favorites is enabled on the site. For details, see Public favorite links. Type: boolean Default: false
ENABLE_FORMS_AUTHENTICATION | Site | Allows the sign_in resource to be called with a regular HTML form, for integration with tools that require forms authentication. For details, see Authentication. Type: boolean Default: false
ENABLE_GENERATE_REPORT_WITH_LINK_IMAGE | Site/Space | Allows link images embedded in an entity's rich text fields, to be downloaded during document report generation. Type: boolean Default: false
ENABLE_INCLUDE_SITE_USERS | Site | Defines whether space admins can add site users to their shared space. Type: boolean Default: true (on-premises)
ENABLE_LEGACY_TECH_PREVIEW_CLIENT_TYPE | Site/Space | Defines whether the REST API still accepts the HPE_REST_API_TECH_PREVIEW value for the HPECLIENTTYPE request header. This request header is used for working with REST API resources that are a technical preview. Set this parameter to false, and use the ALM-OCTANE-TECH-PREVIEW request header instead, set to true. This is because the HPE_REST_API_TECH_PREVIEW value for the HPECLIENTTYPE request header will soon be deprecated. Type: boolean Default: false
ENABLE_OUTPUT_SANITIZATION | Site | Defines whether to sanitize the REST output. Type: boolean Default: true
ENABLE_SECURED_CONNECTION_VALIDATION | Site | When using SSL offloading via reverse proxy, this defines whether to enforce secure connections (HTTPS) when octane.conf settings are configured to use HTTPS. Type: boolean Default: true
ENABLE_SPRINTER_USAGE | Site | Defines whether users see the toggle switch in Settings, which allows them to use Sprinter to run manual tests. Type: boolean Default: true
ENABLE_STORAGE_ MAX_SIZE_ VALIDATION | Site | Defines whether the maximum size for storage of files should be enforced. Type: boolean Default: true
ENABLE_STRICT_TRANSPORT_SECURITY_HEADER | Site | Defines whether Strict-Transport-Security header is added to response. For details, see https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security. The header is added automatically when working with TLS, or if BASE_APP_URL parameter is Secure. Type: boolean Default: true
ENABLE_TEST_ASSIGNMENT_RULES_IN_SUITES | Site/Space | Defines whether test assignment rules affect future test runs in the testing framework. Type: boolean Default: true
ENABLE_WIDGETS_IN_DOCUMENT_REPORT_PER_SHARED_SPACE | Space | Let users add widgets to Document reports, on a shared space level. For details, see Document reports. Type: boolean Default: true
ENABLE_WIDGETS_IN_DOCUMENT_REPORT_PER_SITE | Site | Let users add widgets to Document reports on a site level. For details, see Document reports. Type: boolean Default: Default: true
ENTITIES_BULK_TRANSLATION_CACHE_THRESHOLD | Space | The bulk threshold. If the number of bulk entities is higher than the threshold, it skips the cache and read directly from the database. Default: 100
ENTITIES_CACHE_ACTIVE | Site | Type: boolean Default: true
ENTITIES_TO_RETURN_WITH_DEFAULT_VALUES | Site/Space | This parameter instructs ALM Octane to trim only the listed entities, when the TRIM_DEFAULT_VALUES_FOR_REST_API and MQM_CLIENT_UI are not set to false. Type: string Values: comma separated list of entities
ENTITY_EXTERNAL_ACTIONS_SUPPORTED_PROTOCOLS | Site/Space | Lists the additional protocols that custom external actions are allowed to invoke. By default, the following protocols are supported: http, https, mailto For details, see Create external actions. Type: string Values: comma delimited list
EXCLUDED_CLIENT_TYPES_FROM_DEFAULT_VALUE_TRIMMING | Site/Space | Excludes the specified client types, separated by commas, from the default value trimming. This is relevant when TRIM_DEFAULT_VALUES_FOR_REST_API is set to true. For details, see ENTITIES_TO_RETURN_WITH_DEFAULT_VALUES. Type: string Values: comma delimited list
EXPAND_HISTORY_RECORDS | Site | Allows the fetching of history records for OData in the change-per-record style using the history_record entity. For details, see OData for developers. Type: boolean Default: false
EXPORT_IMPORT_MULTIVALUE_DELIMITER | Site | Determines the character or string that ALM Octane recognizes as a delimiter between values when importing multi-value fields to and from Excel. Note: Consider the characters that are not used inside values. If the delimiter coincides with any character used inside a value, the value is not imported. Type: string Default: , (comma)
EXPOSE_SERVER_VERSION_HEADER | Site | Type: boolean Default: true
EXTENSION_TO_MIME_TYPE | Site/Space | Allows site admins to add additional, custom file extensions to the list of permitted extensions for ALM Octane attachments, as defined with configuration parameter ATTACHMENTS_FILE_EXTENSION_WHITE_LIST. The file types (mime types) must be one of ALM Octane's supported mime types, but you can choose any extension you like. Note: ALM Octane supports all mime types defined as valid by Apache Tika. The value of this parameter is one or more mappings between a custom file extension and its mime type. You can specify multiple mime types for each extension. Format: <custom_extension>=<mime_type>[,<another_mime_type>][; <another_custom_extension>=<mime_type>[,<another_mime_type>]] Separate each mapping with a semi-colon (;). Separate multiple mime types with commas (,). Do not add spaces between mappings. To bypass the validation of if an attachment's mime type matches the file extension, see the VALIDATE_MIME_TYPE_MATCH_TO_EXTENSION configuration parameter. Type: string Example of one mime type per extension: `ext1=text/plain;ext2=text/plain` Example with multiple mime types per extension: `har=text/plain,text/html;avi=video/x-msvideo,video/avi,video/msvideo`
EXTERNAL_ENTITY_ACTIONS_BUNDLE_MAX_SIZE |  | The maximum size (in megabytes) of zipped external action files that you can upload to ALM Octane. Type: integer Default: 20
EXTERNAL_ENTITY_ACTIONS_FILE_EXTENSION_WHITE_LIST |  | If you upload external actions to ALM Octane, you can restrict the file types that can be included in the uploaded zip file. Type: string Default: *
EXTERNAL_HELP_URL | Site | Whether the ALM Octane Help Center opens on the cloud or on the local server. true. The help center opens externally, at this location: `https://admhelp.microfocus.com/octane/` false or blank. The help center opens on the local server. Use this option only if users do not have internet access. For details, see Download Help Center. Type: boolean Default: true
FAILURE_ANALYSIS_INSIGHT_TEST_FAILURE_THRESHOLD | Site | Defines the percentage of failed tests above which the tests and their corresponding builds are displayed as failure analysis insight cards for a specific pipeline. This threshold is relevant only for quality insight issues, such as “QUALITY - Committers related to most test failures” and “QUALITY – Builds with most failed tests.” Type: integer Default: 20 Minimum: 0 Maximum: 100
FETCH_CI_JOB_LIST_TIMEOUT_IN_SECONDS | Site/Space | Defines a timeout in seconds, for fetching CI jobs from a CI server during creating new pipeline. Type: integer Default: 180 (3 minutes)
FILE_EXTENSION_WHITE_LIST_DOWNLOAD | Site | File extensions that are allowed to be downloaded via open attachments, the REST API, or FTP Explorer. Separate each extension with a semi-colon (;). Type: string Default: txt;doc;docx
FILE_EXTENSION_WHITE_LIST_UPLOAD | Site | File extensions that are allowed to be uploaded via open attachments, extended storage, the REST API, or FTP Explorer. Separate each extension with a semi-colon (;). Type: string Default: txt;doc;docx
FLAGGING_DAEMON_PERIOD_HOURS | Site | Determines the interval in hours between anomaly checks. Type: Integer Default: 24
FORGET_USER_ON_DELETE | Site | Determines if ALM Octane should erase all user details when a user is deleted, from this point forward. Internally, a user-specified reference code is used as a substitute for the details. After modifying this parameter, make sure to reload ALM Octane Settings before deleting users. Setting this parameter does not impact users already deleted. Type: boolean Default: false
FORTIFY_POLLING_ TIMEOUT_HOURS | Site | Determines when ALM Octane should stop checking to see if Fortify on Demand has finished scanning (in hours). Type: integer Default: 48
FORTIFY_POLLING_DELAY_MINUTES | Site | Sets the interval for checking if Fortify on Demand has finished scanning (in minutes). Type: integer Default: 2
FORTIFY_UPPER_LIMIT_OF_ ISSUES | Site | Sets how many issues ALM Octane should retrieve from Fortify on Demand. Type: integer Default 100 Maximum: 500
FTE_MODULE_VISIBLE | Space | Defines if the Execution module is visible. Type: boolean
GDPR_NOTICE_BODY | Site/Space | Defines the terms for personal data processing to display in a dialog box when first-time users log in to ALM Octane. The terms are only displayed if the GDPR_REQUIRE_USER_CONSENT configuration parameter is true. Basic html text is supported. The text cannot exceed 1000 characters, so for long notices, use a link to a different page. When linking to another page, we recommend you use the target="_blank" attribute to open the notice in a different window. Tip: You can set a title for the dialog box using the GDPR_NOTICE_TITLE configuration parameter. Type: string Default: blank Maximum number of characters: 1000 Examples: Welcome to ThisCompany.<br/>Only authorized users allowed. Welcome to ThisCompany.<br/>See <a href="https://www.thiscompany.com" target="_blank" > my terms.</a><br/>By logging in, you are acknowledging these terms and signifying your acceptance and willingness to use this product accordingly.
GDPR_NOTICE_TITLE | Site/Space | Defines the title of the dialog box that displays the terms for personal data processing when first-time users log in to ALM Octane. The title is only displayed if the GDPR_REQUIRE_USER_CONSENT parameter is true. Type: string Default: blank Maximum number of characters: 1000
GDPR_REQUIRE_USER_CONSENT | Site/Space | Determines if consent is required for first-time users logging in to ALM Octane. Terms of data usage are defined using the GDPR_NOTICE_TITLE and GDPR_NOTICE_BODY configuration parameters. If the user does not consent, the user cannot log in. If the user does consent, the date and time of the consent is stored in the user's GDPR consent time field at the site level. Type: boolean Default: false
GHERKIN_SCRIPT_DIALECT | Site/Space | Sets the default language for scenarios and scenario outlines in Gherkin tests and BDD specifications. For details, see Localization. Type: string Values: a language notation as described in the Gherkin documentation. Default: en
HIDE_HOURS_AND_MINUTES_IN_RELEASE_CONTROL | Site/Space | Determines whether the Start time and End time fields in release process items display the date and time, or the date only. Note: If the time is hidden, the system uses the time at which an item was created for the start and end times. Type: boolean Default: false
HIDE_LANGUAGE_DROPDOWN | Site/Space | Hides the language selection dropdown for the user. Type: boolean Default: false
HREF_PROTOCOLS_WHITE_LIST | Site | Provides a list of whitelisted protocols for the Link dialog box in memo fields. For details, see Memo fields. Type: string Default: http;https;td;testdirector;mailto
IGNORE_ALERT_RULE_WHEN_CREATE_IN_DRAFT_MODE | Site/Space | Determines whether to ignore the "Alert user" business rules when items are created in draft mode. If set to true, the "Alert user" business rule is ignored. As a result, users do not get errors when items defined in the rule are created in draft mode. If set to false, the "Alert user" business rule is not ignored when creating items in draft mode. As a result, when a rule is triggered, an error occurs. The item draft cannot be created. Type: boolean Default: true
IMPORT_DATA_SETS_FUSE | Site | The maximum number of data sets that can be imported in a single import operation. Type: integer Default and recommended value: 1000 Caution: Importing more items than the recommended value may cause performance and functional issues. If necessary, split large files into several smaller ones. This applies to all of the *_FUSE configuration parameters.
IMPORT_MODEL_ITEMS_FUSE | Site | Defines the maximum number of BPMN model items that can be imported in a single import operation. Type: integer Default and recommended value: 500
IMPORT_REQUIREMENTS_FUSE | Site | The maximum number of requirement documents that can be imported in a single import operation. Type: integer Default and recommended value: 1000
IMPORT_TASKS_FUSE | Site | The maximum number of tasks that can be imported in a single import operation. Type: integer Default: 1000
IMPORT_TESTS_FUSE | Site/Space | Defines the maximum number of tests that can be imported in a single import operation. At the space level, the parameter can be edited only by the site admin. Type: integer Default and recommended value: 300
IMPORT_WORK_ITEMS_FUSE | Site | Defines the maximum number of work items (epics, features, stories, defects) that can be imported in a single import operation. Type: integer Default and recommended value: 1000
INCLUDED_CLIENT_TYPES_IN_DEFAULT_VALUE_TRIMMING | Site/Space | Includes the specified client types, separated by commas, in default value trimming. The listed client types do not get default values, even if they have private access, unless they are specifically requested. This is relevant when TRIM_DEFAULT_VALUES_FOR_REST_API is set to false.
INTEGER_UDFS_LIMIT | Site/Space | The maximum number of integer UDFs that can be defined per workspace. Type: integer Default: 50 Minimum: 0 Maximum: 50
LICENSE_USAGE_CALCULATE_INTERVAL | Site | The number of minutes ALM Octane should wait before recalculating license usage, i.e. the interval between the CAPQ jobs that perform the calculations. Default: 360 minutes (6 hours)
LIMIT_AMOUNT_OF_AUTOCOMPLETE_SUGGESTIONS | Site/Space | Defines the maximum number of suggestions displayed in autocomplete for Gherkin steps. Type: integer Default: 20 Minimum: 0 Maximum: 20000
LIMIT_OF_SHARED_FAVORITES_IN_DOCUMENT_REPORT_WIDGET | Site | Defines the maximum number of shared favorites in the document report widget. Type: integer Default: 1000
LIMIT_TESTS_IN_RECOMMENDED_GRID | Site/Space | Defines the maximum number of tests that are recommended to reduce an application module's quality risk. Default: 30 Minimum: 0 Note: If the parameter is set to 0, the Reduce risk button is not available in the Quality Risk insights pane.
LINK_COVERAGE_ENTITIES_TO_RUN_DEFECT | Site/Space | Determines whether the Backlog items, Requirements, and Feature fields are automatically populated when a new defect is created from a run. Version 24.1 and earlier: Auto-populate is supported from within the Manual Runner only. Type: boolean Default: true
LIST_NODE_CHILDREN_AMOUNT_PARAM_ID | Site | Defines the maximum number of values that can be added to a user-defined list. Default: 150 Minimum: 20 Maximum: 1000
LOG_APPENDER_MAX_SIZE | Site | Defines the maximum size for each Apache Log4j appender (in MB). The format is: <log>Appender=#;<log>Appender=#;<log>Appender=# Where: appAppender is the name for the ALM Octane UI log. siteAppender is the name for the ALM Octane SiteAdmin and SharedSpace admin log. restAppender is the name for the ALM Octane REST API log. Each log setting is separated by a semi-colon (;). Types: string for the list of log appenders integer for each log size Example: appAppender=16; siteAppender=20; restAppender=11 Minimum size for each log: 1 Maximum size for each log: 100
LOG_LEVEL | Site | Changes the log level for specific log files. The format is: <log_file>=<level>; <log_file>=<level> Each log setting is separated by a semi-colon (;). Types: string for the list of logs string for each level Example: com.hp.mqm.dal=DEBUG; com.hp.mqm.test=WARN Valid values for log levels: DEBUG, WARN, INFO, FATAL, ERROR, TRACE
LOG_ROOT_LEVEL | Site | Changes the log level for specific Apache Log4j appenders. The format is: <log>appAppender=<level>; <log>siteAppender=<level>; <log>restAppender=<level> Where: appAppender is the name for the ALM Octane UI log. siteAppender is the name for the ALM Octane Settings log. restAppender is the name for the ALM Octane REST API log. Each log setting is separated by a semi-colon (;). Types: string for the list of logs string for each level Example: appAppender=WARN; siteAppender=ERROR; restAppender=TRACE Valid values for log levels: DEBUG, WARN, INFO, FATAL, ERROR, TRACE
LOGIN_PAGE_NAME_LABEL | Site | Sets the login Name label on the Login page. This can be used to clarify how the user should log in. For example, if the user needs to log in with an email address, set the value of this parameter to Email. Type: string Default: blank, in which case Name is displayed
LOGIN_PAGE_NOTICE | Site/Space | Sets html text to display at the bottom of the Login page under the Login button. Basic html text is supported. The text cannot exceed 1000 characters, so for long notices, use a link to a different page. When linking to another page, we recommend you use the target="_blank" attribute to open the notice in a different window. Type: string Default: blank Maximum number of characters: 1000 Examples: Welcome to ThisCompany.<br/>Only authorized users allowed. Welcome to ThisCompany.<br/>See <a href="https://www.thiscompany.com" target="_blank" > my terms.</a><br/>By logging in, you are acknowledging these terms and signifying your acceptance and willingness to use this product accordingly.
LOGO_TEXT | Site/Space | Sets the text to display at the top left of ALM Octane, such as the company name. Unicode emojis are supported. This parameter can be set both at the site level and at the shared space level. The shared space level parameter overrides the value set at the site level. Type: string Default: ALM OCTANE
LONGSTRING_UDFS_LIMIT | Site/Space | The maximum number of long string UDFs that can be defined per workspace. Type: integer Default: 5 Minimum: 0 Maximum: 20
MAIL_ATTACH_MAX_SIZE | Site | The maximum size (in KB) of entity files that can be included as attachments with emails sent from ALM Octane. Files larger than this size are not sent with ALM Octane emails. Type: integer Default: 10485760 Minimum: 10240 Maximum: 10485760
MAIL_ATTACH_TOTAL_MAX_SIZE | Site | The total size (in KB) of all the entity files that can be included as attachments with emails sent from ALM Octane. If the total size exceeds this value, none of the files are included as attachments. Type: integer Default: 10485760 Minimum: 10240 Maximum: 10485760
MAIL_FOOTER | Site/Space | Defines the footer (rich text) for emails. Can be blank. Type: string You can customize email footers in the Defaults tab. For details, see Customize email header and footer.
MAIL_FORMAT | Site | Defines the format that mails are sent in. Type: string Default: HTML Valid values: HTML, TEXT
MAIL_HEADER | Site/Space | Defines the header (rich text) for emails. Can be blank. Type: string
MAIL_MESSAGE_CHARSET | Site | The characters set for sent emails. Type: string Default: UTF-8
MAIL_PROTOCOL | Site | The mail protocol. Type: string Default: smtp
MAIL_RECIPIENTS_NUMBER_LIMIT | Site | Determines the maximum number of recipients per email. If this number is exceeded, the list of recipients is split into groups within the limit. The email is sent to each of the recipient groups separately. Type: integer Default: 10,000
MAIL_SERVER_HOST | Site/Space | The mail server host. You can also set the host in the ALM Octane UI: Settings > Site > Servers tab. Type: string
MAIL_SERVER_PORT | Site/Space | The mail server port. You can also set the port in the ALM Octane UI: Settings > Site > Servers tab. Type: integer Default: 25
MAIL_SUBJECT_SUFFIX | Space | A string that is added as a suffix to the subject line in all emails sent from ALM Octane. A subject suffix may be necessary in your organization as a classification tag, to ensure that the mail server allows ALM Octane emails. Type: string
MANUAL_TEST_SCRIPT_DEFAULT_VIEW | Site/Space | The default view of the manual test script editor for new users. For details, see Add steps to a test. Type: string Values: GRID, TEXT, LIST Default: TEXT
MAX_ATTACHMENT_COUNT_PER_ENTITY | Site/Space | The maximum number of attachments that can be added to any one entity. Caution: Attaching high numbers of files to an entity can cause performance and functional issues. It is recommended to allow up to 50 files per entity. Note that in some cases, the specified number of attachments may be marginally exceeded, for example when multiple uploads are processed simultaneously. Type: integer Default: 30 Maximum: 1000 Recommended to not exceed: 50
MAX_BUILD_LOGS_TO_KEEP | Site | The number of logs to save from each job. Type: integer Default: 10
MAX_CARDS_TO_DISPLAY | Site/Space | The maximum number of cards to display in the Board view of the board. Type: integer Default: 200
MAX_CONCURRENT_REPORTS_PER_USER | Site/Space | The maximum number of concurrent reports that can be generated per user. If the user exceeds the maximum, ALM Octane issues a notification. Type: integer Default: 5
MAX_COVERAGE_REPORTS_PER_PIPELINE_TO_KEEP | Site | The maximum number of coverage reports to store per pipeline. Type: integer Default: 10
MAX_DOCUMENT_REPORT_CONCURRENT_PAGES | Site | The overall maximum number of pages allowed for all concurrent exported documents on a single node. Type: integer Default: 1500
MAX_DOCUMENT_REPORT_PAGES | Site | The maximum number of pages allowed for a single exported document. A negative number instructs ALM Octane to use the value of MAX_VALUE. Type: integer Default: 1000
MAX_DUPLICATE_RUN_ENTITY | Site (hidden) | The maximum number of run entities that can be duplicated. For details, see Duplicate runs. Type: integer Default:10
MAX_EXCEL_ALLOWED_ENTITIES_FOR_AUTO_FIT | Site | The maximum number of entities to which auto-fit will be applied when exporting a widget to Excel. The greater the value, the higher the utilization of CPU resources. Note: This parameter applies only if the exported widget contains memo or long string type fields. To turn off auto-fit for any number of exported entities, set the value to 0. To turn on auto-fit for all exported entities, set the value to -1. Default: 500
MAX_NUMBER_OF_YEARS_IN_RELEASE | Site | The maximum number of years a release can have. Type: integer Default: 5 Minimum: 1 Maximum: 10
MAX_PAGE_SIZE | Site | The maximum number of items that can be returned. Type: integer Default: 20000 Minimum: 5000 Maximum: 20000
MAX_STEPS_IN_RUN_REPORT | Site/Space | The maximum number of steps that can be in a run report. Type: integer Default: 1000
MAX_TREE_DEPTH_APPLICATION_MODULE | Space only | The maximum number of hierarchical levels supported in the application modules tree, including the root. This means that if you specify the value 4, the tree contains the root plus three more levels. Type: integer Default: 4 Minimum: 4 Maximum: 20
MAX_TREE_DEPTH_REQUIREMENTS | Space only | Version 24.3 and later: The maximum number of hierarchical levels supported in the requirements tree, including the root. This means that if you specify the value 12, the tree contains the root plus 11 more levels. Type: integer Default: 12 Minimum: 3 Maximum: 30
MAX_TREE_DEPTH_SCM_RESOURCE | Space only | The maximum tree depth for the SCM resource tree. Type: integer Default: 12 Minimum: 4 Maximum: 20
MAX_VULNERABILITIES_UPSERT_SIZE | Site | The overall size of vulnerabilities injected data to block. Type: integer Default: 20
MAXIMUM_DOCUMENT_REPORT_PAGES | Site/Space | The maximum number of pages allowed for a single exported document. A negative number instructs ALM Octane to use the value of MAX_VALUE. Type: integer Default: 1000
MBT_DATA_TAB_FILTER_LRU_QUEUE_MAX_SIZE | Site/Space | The maximum number of filters that a user can define for all the existing datasets.
MBT_DIAGRAM_AVOIDS_NODES_ELEMENTS_THRESHOLD | Site/Space | Controls the threshold between the two modes. The threshold is applied on the total number of nodes and links. Type: integer Default: 500
MEMO_UDFS_LIMIT | Site/Space | The maximum number of memo-type UDFs that can be defined per workspace. Type: integer Default: 10 Minimum: 0 Maximum: 30
MENTION_IN_COMMENT_MAIL_DELAY_IN_SECONDS | Site | Mail delay (in seconds), so that all edits in a single comment during this period will only generate one mail. Type: integer Default: 60
MIGRATION_ELASTIC_REPOSITORY | Site | The name of the Elastic repository used to export data. For details, see Enable export and import of Elastic data. Type: string
MINUTES_UNTIL_GLOBAL_SESSION_TIMEOUT | Site | The maximum number of minutes that the session lasts even if the session is in use. Version 24.1 and earlier: In SSO environments: The maximum number of minutes that the session lasts when logged in with API keys. In all environments, after the timeout, the user must log in again. After setting this parameter, restart the ALM Octane server. Type: integer Default: 1440 minutes (24 hours)
MINUTES_UNTIL_IDLE_SESSION_TIMEOUT | Site/Space | The number of minutes for license consumption while the session is not in use (idle). If the number of minutes has elapsed, the session is considered expired and the license is released. The next request consumes a new license (if available). Version 24.1 and earlier: In non-SSO environments: The maximum number of minutes that the session lasts while the session is not in use (idle). After the timeout, the user must log in again. In all environments, the parameter can be set per site only. After setting this parameter at the site level, restart the ALM Octane server. Type: integer Default: 180 minutes (3 hours) Configurable by site admin only.
NUMBER_OF_ENTITIES_CONSIDERED_LARGE_REPORT | Site/Space | The number of entities to be considered a large report. Small reports take precedence over large reports. This value cannot exceed the maximum number of entities allowed in a report (NUMBER_OF_ENTITIES_PER_REPORT_PAGE multiplied by MAXIMUM_DOCUMENT_REPORT_PAGES). Type: integer Default: 1000
NUMBER_OF_ENTITIES_PER_REPORT_PAGE | Site/Space | The approximate number of entities we expect to see on one page of document report. Type: integer Default: 3
NUMBER_OF_RECENT_SEARCH_STRINGS_TO_KEEP | Site/Space | The number of search strings to store in the recent global search list. Type: integer Default: 10 Minimum: 3 Maximum: 20
ODATA_ENTITIES_RELATION_OVERWRITE | Site | Overwrites all relations between tables in the ALM Octane database to be one to one. This should be turned on when having performance issues in fetching OData queries with the expand option. Type: boolean Default: false
ODATA_HISTORY_INITIAL_PORTION_SIZE | Site | For history records, this sets the number of change sets initially fetched for parsing on records. Type: integer Default: 200
ODATA_MAX_PARAMETERS_FOR_DB_QUERY | Site | MSSQL is limited to 2100 parameters in IN query. Oracle is limited to 1000. This parameter defines that if there are more than the value specified, OData will query in bulks to avoid DB error. Type: integer Default: 1000
ODATA_NAME_ENCODED | Site/Space | Indicates whether OData should encode name fields. This can be relevant when returning non-english characters as part of an OData response. Type: boolean Default: false
ODATA_RESTRICT_EXPAND_DEPTH | Site | Controls the number of expansion levels. true. Sets the maximum expand depth defined by MAX_EXPAND_API_DEPTH (which currently also defines the depth for REST API). false. Removes the limit of the number of query expansion levels. It is not recommended to do more than 2 to 4 levels. Type: boolean Default: false
ODATA_RESTRICT_SELECTABLE | Site | Applies additional restriction for expanded items by determining if the field is selectable. A list of the non-selectable fields (this list is subject to change): ReleaseEntity: work_item_has_release, work_item_detect_in_release SprintEntity: work_item_planned WorkItemEntity and its subtypes: children true. Blocks users from fetching non-selectable fields. false. Allows users to fetch non-selectable fields. Type: boolean Default: false
ODATA_RESTRICT_SELECTABLE_IN_EXPAND | Site | Instructs data calls to check the selectable in expand and selectable fields. If a user selects a non-selectable field, it throws an exception. true. Throws an NonSelectableFieldException if a user tries to select a non-selectable field in an expanded field. false. Ignores the selectableInExpand property and only uses the field's selectable property. Type: boolean Default: false
ODATA_USE_SERVER_BASE_URL | Site | If ALM Octane does not respond successfully to an OData consumer request, it might be because the base URL used to refer to ALM Octane is different than expected. true. ALM Octane uses the URL specified in the SERVER_BASE_URL site configuration parameter. false. ALM Octane uses the original URL as requested from the consumer. Type: boolean Default: true
ODATA_XML_ENCODED | Site/Space | Indicates whether OData should encode memo fields. This can be relevant when returning non-english characters as part of an OData response. Type: boolean Default: false
ORACLE_DISABLE_MERGE_JOIN_CARTESIAN | Site/Space | Internal: Indicates if merge join cartesian should be disabled when using multiple crossfilters in Oracle. Type: boolean
ORPHAN_SESSIONS_CLOSURE_INTERVAL | Site | Version 24.3 and later: The frequency, in minutes, at which a closure job is triggered for orphan sessions. Orphan sessions can occur in a multinode environment when sessions are not synchronized across nodes. Lowering the value of this parameter results in higher resource utilization. Type: integer Default: 360 (6 hours) Minimum: Must be higher than the highest value of MINUTES_UNTIL_IDLE_SESSION_TIMEOUT for the site and any space in the site.
PHASE_SLOW_DOWN_THRESHOLD_PERCENT | Site/Space | Determines the threshold to calculate the slowdown for epic and feature phases, in percentage. The phase slowdown value is based on the average phase time for work items that were done in previous releases. For example, if an item remains in the same phase for more than 100% of the phase average time, ALM Octane displays a Slow phase icon in the timeline. Type: integer Default: 100
PIPELINE_RUN_CACHE_TIMEOUT_IN_SECONDS | Site | The length of time in seconds that a pipeline run is stored in the cache. Type: integer Default: 10
PR_PURGE_ MAX_NUM_DAYS_TO_KEEP | Site/Space | The number of days to keep pipeline runs and their data. Type: integer Default: 365 (1 year) Range: 7-728 (2 years) Note: Only relevant if PR_PURGE_ STRATEGY_TYPE is set to days_to_keep.
PR_PURGE_ MAX_NUM_RUNS_TO_KEEP | Site/Space | The number of pipeline runs to keep from each pipeline. Type: integer Default: 10,000 Range: 10-20,000 Note: Only relevant if PR_PURGE_ STRATEGY_TYPE is set to runs_to_keep.
PR_PURGE_ STATE_TYPE | Site/Space | The purge state for the shared space: None: Suspends both automatic and manual purging for the site (default) or shared space. Automatic: Purges the pipeline runs based on the policy indicated in the PURGE_ STRATEGY_TYPE site parameter. Manual: Allows a manual purge of the pipeline runs. Note: The values are not case-sensitive.
PR_PURGE_ STRATEGY_TYPE | Site/Space | Set up a purge strategy for removing pipeline runs from the site: days_to_keep: Purges the pipeline runs after the number of days specified in the PR_PURGE_ NUM_DAYS_TO_KEEP site parameter. (default) runs_to_keep: Purges the pipeline runs after the number of runs reaches the value of the PR_PURGE_NUM_RUNS_TO_KEEP site parameter. For details, see Purge policy.
PR_PURGE_DISABLE | Site/Space | Disallows all purging of pipeline runs. Type: boolean Default: false
PROPAGATE_SPEC_APP_MODULE_TO_SCENARIOS | Site/Space | Populates application module changes in the BDD specification to its scenarios. Type: boolean Default: true
PROPAGATE_SPEC_COVERAGE_TO_SCENARIOS | Site/Space | Determines whether BDD scenarios automatically inherit backlog item coverage from the parent BDD specification. Type: boolean Default: true
PUBLIC_LINK_MAX_CONCURRENT_REQUESTS_PER_SPACE | Site | The maximum number of public link requests that can be served concurrently per space. Type: integer Default: 2
PUBLIC_LINKS_ALLOW_EMBEDDING_RESPONSE | Site/Space | Determines whether favorite pubic links can be embedded in online pages. For details, see Public favorite links. Type: boolean Default: false
PUBLIC_LINKS_REQUIRE_SSO_AUTHENTICATION | Site | Determines whether external users can access pubic links of dashboard favorites with their organization single-sign-on authentication method. Invoking a public link request redirects users that are not authenticated in the organization SSO yet, to the authentication page. Once a user is authenticated, whether or not registered to ALM Octane, they receive the public link's response. Type: boolean Default: false
QUALITY_RISK_BUSINESS_IMPACT | Site/Space | When calculating quality risk, this parameter defines how critical an area is as part of the business flow, and what might be the impact of defects in this area. The business impact value is determined via the Business Impact system field per application module. For details, see Risk factors. Type: string Default: No Impact, Low, Medium, High, Critical
QUALITY_RISK_COMMITS_PERCENT | Site/Space | When calculating quality risk, this is the weight that determines the relative impact of number of commits on the final risk score. The higher this number, the greater the weight of this element in the calculation. For details, see Risk factors. Type: integer Default: 40 Minimum: 0 Maximum: 100 Configurable by site admin only.
QUALITY_RISK_FAILED_MANUAL_PERCENT | Site/Space | When calculating quality risk, this is the weight that determines the relative impact of failed manual runs on the final risk score. The higher this number, the greater the weight of this element in the calculation. For details, see Risk factors. Type: integer Default: 10 Minimum: 0 Maximum: 100 Configurable by site admin only.
QUALITY_RISK_RISKY_COMMITS_PERCENT | Site/Space | When calculating quality risk, this is the weight that determines the relative impact of risky commits on the final risk score. The higher this number, the greater the weight of this element in the calculation. For details, see Risk factors. Type: integer Default: 10 Minimum: 0 Maximum: 100 Configurable by site admin only.
QUALITY_RISK_TEST_COVERAGE_PERCENT | Site/Space | When calculating quality risk, this is the weight that determines the relative impact of number of manually run tests on the final risk score. The higher this number, the greater the weight of this element in the calculation. For details, see Risk factors. Type: integer Default: 40 Minimum: 0 Maximum: 100 Configurable by site admin only.
RC_AA_CHECK_EXECUTION_INTERVAL | Site/Space | Auto actions of the following types: CI server auto actions CD server auto actions Determines the interval at which ALM Octane checks for auto actions that are considered outdated to verify their execution status. Type: integer Default: 60 minutes Minimum: 5 minutes Configurable by site admin only.
RC_AA_REST_CALL_REQUEST_TIMEOUT | Site/Space | The maximum allowed time in seconds, for an auto action to send a REST Call request to a generic service. For details, see REST auto actions. Type: integer Default: 60 seconds
RC_AA_REST_CALL_ALLOWED_URL_LIST | Space | A comma separated list of URLs that can be specified by a user for a REST API call with a generic REST Call auto action. For details, see REST auto actions.
RC_AA_REST_POLL_MIN_INTERVAL, RC_AA_REST_POLL_MAX_INTERVAL | Site | The minimum or maximum REST Poll interval. For details, see REST auto actions. Type: integer Default: minimum=1, maximum=1440
RC_AA_REST_POLLING_MAX_ATTEMPTS | Site | The maximum number of polling attempts for REST Poll auto actions. For details, see REST auto actions. Type: integer Default: 30
RC_AA_RUN_CD_PROCESS_CHECK_EXECUTION_COUNT_PER_TASK | Site/Space | Determines the number of outdated CD server auto actions for a single execution check-up. An auto action is considered outdated if its status remains In Progress after the period defined in the RC_AA_RUN_CD_PROCESS_OUTDATE_TIME parameter is over. The most outdated auto actions are checked first. If the number of outdated auto actions exceeds the defined number, the remaining auto actions are examined during the next execution check-up. Note: The interval for execution check-ups is defined in the RC_AA_CHECK_EXECUTION_INTERVAL parameter. Type: integer Default: 100 Minimum: 0 Maximum: 200 Configurable by site admin only.
RC_AA_RUN_CD_PROCESS_OUTDATE_TIME | Site/Space | Determines the completion period, in minutes, for CD server auto actions. When the defined period is over, and an auto action is still In Progress, the auto action is considered outdated. ALM Octane then triggers the CD server polling to verify the auto action execution status. Note: ALM Octane does not check the status of auto actions that were completed or aborted within the defined period. Type: integer Default: 120 Minimum: 5 Maximum: 1440 Configurable by site admin only.
RC_AA_RUN_CI_JOB_CHECK_EXECUTION_COUNT_PER_TASK | Site/Space | Determines the number of outdated CI server auto actions for a single execution check-up. An auto action is considered outdated if its status remains "In Progress" after the period defined in the RC_AA_RUN_CI_JOB_STATUS_OUTDATE_TIME parameter is over. The most outdated auto actions are checked first. If the number of outdated auto actions exceeds the defined number, the remaining auto actions are examined during the next execution check-up. Note: The interval for execution check-ups is defined in the RC_AA_CHECK_EXECUTION_INTERVAL parameter. Type: integer Default: 100 Maximum: 200 Configurable by site admin only.
RC_AA_RUN_CI_JOB_STATUS_OUTDATE_TIME | Site/Space | Determines the completion period, in minutes, for CI server auto actions. When the defined period is over, and an auto action is still In Progress, the auto action is considered outdated. ALM Octane then triggers the CI server polling to verify the auto action execution status. Note: ALM Octane does not check the status of auto actions that were completed or aborted within the defined period. Type: integer Default: 120 minutes Minimum: 20 minutes Configurable by site admin only.
RC_AA_UPDATE_ENTITIES_MAX_SIZE | Site/Space | Determines the maximum number of items that can be updated by an auto action. Type: integer Default: 500 Minimum: 1 Maximum: 500
RC_CRITERIA_PER_GATE | Site/Space | Determines the number of criteria allowed in a single quality gate. Type: integer Default: 10 Maximum: 30
RC_QUERY_CRITERION_CALC_COUNT_PER_TASK | Site | Determines the maximum number of query criteria that can be calculated at once. Type: integer Default: 20 Minimum: 20
RC_QUERY_CRITERION_STATUS_CACHE_TTL_SECONDS | Site | Defines the time gap, in seconds, between repeated evaluations of quality gate query criteria. Type: integer Default: 10 Minimum: 10
RESTRICT_REST_API_TO_API_KEYS_ONLY | Site/Space | If true, restricts access to REST API to only API Keys (blocking access for regular users). Type: boolean Default: false
RETURN_ACTUAL_TOTAL_COUNT | Site/Space | Controls the returned total count value of the history log api. If false, 'total_count' is limited to the fetched result size. If true, it is the total number of matching results in the database or Elasticsearch. Type: boolean Default: false
RUN_BURNDOWN_EXECUTED_NATIVE_STATUSES | Site/Space | Defines the test run phases that ALM Octane considers executed. You can use this parameter to exclude test runs with certain phases, such as Blocked, Skipped, or In progress, from the Test runs burn-down widget. The excluded phases are added to the Planned line. Type: string Default: passed, failed, blocked, not_completed, skipped
RUNS_MAX_TOTAL_COUNT_REST | Site | The maximum number of runs that can be returned by the REST API. Type: integer Default: 2000
RUNS_MAX_TOTAL_COUNT_UI | Site | The maximum number of runs that can be displayed in the Runs grid. Type: integer Default: 2000
SAME_SITE_COOKIE_ATTRIBUTE | Site | To allow hosting external actions on ALM Octane, set to "None". Type: string Allowed values: Strict, Lax, None Default: Lax
SEARCH_ALL_SEARCHABLE_BY_DEFAULT | Site/Space | Version 24.3 and later: Determines the default setting for new users of the Include Searchable Fields option in the global search. For details, see Searchable fields. Note: If set to true, global search performance may be impacted, especially when using long or complex search phrases. Type: boolean Default: false
SEARCHABLE_UDFS_LIMIT_IN_SHARED_SPACE | Site/Space | The number of user-defined fields that can be marked as searchable in a shared space. The sum of all searchable UDFs (including the ones enabled in SEARCHABLE_UDFS_LIMIT_IN_WORKSPACE) may not exceed 20. For details, see Add a custom field. Type: integer Default: 14
SEARCHABLE_UDFS_LIMIT_IN_WORKSPACE | Site/Space | The number of user-defined fields that can be marked as searchable in a workspace. The sum of all searchable UDFs (including the ones allowed in SEARCHABLE_UDFS_LIMIT_IN_SHARED_SPACE) may not exceed 20. Type: integer Default: 0
SERVER_BASE_URL | Site | The base URL of the server. The ALM Octane server is often unaware of the base URL used to refer to it from the outside world, because the base URL is often set at the proxy server level. Use this parameter to manually specify the externally-used URL. This is especially useful for scenarios where the ALM Octane server needs to send the base URL to other applications that do not run inside the server's local network. To ensure that the change takes effect on all areas, restart the server. Type: string Example: http://host.domain:8080
SESSION_READ_RESULTS_IN_DAYS | Site | The number of days to show in session details, where no time or ID were specified. For details, see Manage the site. Type: integer Default: 7 Range: 0-365 Note: If set to 0, mandatory session filtering is inactive.
SHARED_SPACES_LOG_LEVEL | Site | Changes the log level for specific shared space logs. The format is: <shared_space_ID>=<level>;<shared_space_ID>=<level>;<shared_space_ID>=<level> Each level setting is separated by a semi-colon (;). Type: string Example: 1001=INFO;2001=WARN Allowed values: DEBUG, WARN, INFO, FATAL, ERROR, TRACE
SHOW_FIELD_TOOLTIP | Site/Space | Determines whether a custom field's description is displayed as tooltip when the user hovers over the field's name. Type: boolean Default: false
SHOW_LAST_USED_VALUES_IN_RUN_DIALOG | Site/Space | Allows the fields in the Run dialog box to show the values that were selected in previous runs. This applies to the Default Environment and Default Release fields in suite runs, and the Environment and Release fields in manual runs. Default: true
SHOW_NO_VALUE_AS_EMPTY_STRING_IN_EXCEL_REPORT | Site | In Excel document reports, empty values will be shown as empty strings if the parameter value is true, and as null if the parameter value is false. Type: boolean Default: true
SIMILAR_DEFECTS_MAX_RESULTS | Site |
SIMILAR_DEFECTS_SCOPE_CREATION_TIME_LAST_X_DAYS | Site |
SKYPE_INTEGRATION_TECH_PREVIEW | Site | Allows the tech preview integration of the ALM OctaneUI with Microsoft Skype. Type: boolean Default: false
SLACK_INTEGRATION_CLIENT_ID | Site | When enabling Slack integration with ALM Octane, this parameter sets the client ID for accessing Slack. You can find this in the Slack app's Basic Information > App Credentials area. Type: string
SLACK_INTEGRATION_SECRET | Site | When enabling Slack integration with ALM Octane, this parameter sets the client secret for accessing Slack. You can find this in the Slack app's Basic Information > App Credentials area. Type: string
SMTP_ADMIN_MAIL | Site/Space | Sets the "From" email address to be used when a user clicks the Send Email button on the toolbar for an entity. If blank, the mail is sent from the current user. Type: string Configurable by site admin only.
SMTP_AUTHENTICATION | Site/Space | Defines whether the SMTP server needs to be authenticated. Type: boolean Default: false
SMTP_ENABLE_STARTTLS | Site/Space | Determines whether STARTTLS is used when connecting to the mail server. Type: boolean Default: false
SMTP_NOTIFICATION_SENDER_EMAIL | Site/Space | Sets the "From" email address to be used when ALM Octane sends an email for notifications, such as "follow" notifications, notifications sent using API access key sessions, or notifications from rules. This parameter is relevant only if notifications are turned on: If this parameter is not specified, ALM Octane uses the value specified in SMTP_ADMIN_MAIL. If no values are specified for both this parameter and SMTP_ADMIN_MAIL, no notifications are sent. Type: string Configurable by site admin only.
SMTP_PASSWORD | Site/Space | Sets the password for connecting to the SMTP server. Type: string
SMTP_SSL_SUPPORT | Site/Space | Defines whether to connect to the SMTP server using SSL Type: boolean Default: false
SMTP_USER | Site/Space | Sets the user for connecting to the SMTP server. Type: string
STORAGE_MAX_FILE_SIZE | Site/Space | Sets the maximum size for storage files, including attachments (in megabytes). Type: integer Default: 100 Minimum: 0 Maximum: 100000 (100 GB)
STORAGE_MAX_SIZE | Site/Space | Sets the maximum size for storage per shared space. By default, no maximum storage size is set. The space storage size is set by the site admin. Available workspace storage is set on the space level, and not per workspace. This means the amount of total available workspace storage is shared between the workspaces in the space. Type: integer Default: 0 (unlimited) Minimum: 6000 MB
SUPPORT_EXTERNAL_ENTITY_ACTIONS_BUNDLE | Site/Space | Indicates whether external actions can be uploaded to ALM Octane. For details, see Host external actions in ALM Octane. Type: boolean Default: true
SUPPORTED_CI_PLUGIN_SDK_VERSION | Site | Sets the minimum SDK version of the CI plugin supported by ALM Octane. If you are using a lower version, incoming data is blocked. We recommend not changing this parameter without instructions from Support. If you change this to a lower version than default, performance and functionality may be impaired. Type: string Default: 2.0.67
SUPPORTS_BASIC_AUTHENTICATION | Site/Space | Allows your integration to use basic authentication when using an API key to authenticate with ALM Octane, instead of the ALM Octane authentication REST API. Note that basic authentication is not secured. Turning this parameter on reduces the security level of ALM Octane. When setting this configuration parameter: Make sure to specify the space ID. Send an ALM-OCTANE-TECH-PREVIEW header with the value true in your requests to configure this parameter. Type: boolean Default: false
SUPPORTS_BASIC_AUTHENTICATION_FOR_ODATA | Site/Space | Allows basic authentication for OData, per space. This allows OData integrations to connect to ALM Octane using basic authentication. Note that basic authentication is not secured. Setting this parameter to true reduces the security level of ALM Octane. When setting this configuration parameter: Make sure to specify the space ID. Send an ALM-OCTANE-TECH-PREVIEW header with the value true in your requests to configure this parameter. Type: boolean Default: false
SUPPRESS_NOTIFICATIONS | Site/Space | Turns off user notifications in My Work > Notification, and email notification by business rule. This is useful when you are performing massive bulk update operations. Type: boolean Default: false
TASK_SUPPORTS_FLOAT_VALUES | Space only | Determines whether the task Estimated hours can be whole numbers or decimal fractions. If set to false, only whole numbers are accepted. If set to true, decimal fractions are accepted. Caution: Setting this parameter to true is a permanent action. You cannot revert this parameter back to false. Type: boolean Default: false
TEST_RESULTS_MAX_TESTS_IN_SUITE | Site | The maximum number of test runs to be taken from the pushed test result that is injected to the suite. For the remainder of the runs, an exception is thrown. Type: integer Default: 1000
TEST_RESULTS_MAX_TOTAL | Site/Space | The maximum number of test runs to be taken from the pushed test result. For the remainder of the runs, an exception is thrown. Type: integer Default: 10000
TESTS_TO_RUN_PARAMETER_JSON_FORMAT | Site/Space | Indicates whether TestRunner uses the JSON format to pass the list of tests for execution on the CI server. Type: boolean Default: false
TR_INJECT_DUPLICATE_RUNS | Site | Indicates whether duplicate runs in the same injection are injected. Type: boolean Default: true
TREE_COMPONENT_MAX_ITEMS_PER_PARENT | Site/Space | Sets the limit for the number of items to display in the tree for the Backlog, Quality, and Requirement modules. Also sets the number of items to return using the REST API. If the tree contains a parent with more than this number of children, a message displays indicating that not all items are displayed. You can search for items by name if the one you need is not displayed. Type: integer Default: 500 (recommended, for performance reasons) Configurable by site admin only.
TRIM_DEFAULT_VALUES_FOR_REST_API | Site/Space | Defines whether shared spaces should return only client requested fields. Use this in conjunction with EXCLUDED_CLIENT_TYPES_FROM_DEFAULT_VALUE_TRIMMING to exclude specific client types from trimming, or Configuration parameters. Type: boolean Default:true
UPDATE_MY_WORK_RUN_ITEMS_ON_SYNC | Site/Space | When set to true, runs that are migrated or synchronized from other tools, are added to My Work. Enabling this parameter may affect performance. Type: boolean Default: false
USER_DETAILS_BOX_ENABLED | Site/Space | When set to true, hovering over a user's avatar shows contact details as defined in the USER_DETAILS_BOX_OPTIONS parameter. Type: boolean Default: true
USER_DETAILS_BOX_OPTIONS | Site/Space | Defines which user details are shown when USER_DETAILS_BOX_ENABLED is true. If empty, all contact information is displayed. When you enter one or more of the following values (comma separated), only the specified details are displayed: email, phone, chat, teams, team_leaders. Type: string
VALIDATE_MIME_TYPE_MATCH_TO_EXTENSION | Site/Space | Whether ALM Octane validates mime types. For details about which mime types are validated if set to true, see the EXTENSION_TO_MIME_TYPE configuration parameter. Type: boolean Default: false
VULNERABILITIES_PER_PIPELINE_RUN_LIMIT | Site | When injecting vulnerability issues into ALM Octane using the REST API, this number represents the maximum number of vulnerability issues that can be injected for each individual pipeline run: Type: integer Default: 100 Maximum: 500
WEBHOOK_ALLOW_HTTP | Site/Space | If the URL specified in Trigger webhook rules can use the http protocol in addition to the secure https protocol. When using HTTP, use only the standard port 80 for outgoing requests, Type: boolean Default: false
WEBHOOK_QUARANTINE_CACHE_TIME | Site | How long a URL should be ignored. If the URL is not accessible after a number of attempts, the URL is put in a quarantine cache for this number of seconds. To set the number of seconds to wait after each Trigger webhook attempt, see WEBHOOK_REQUEST_TIMEOUT. Type: integer Default: 300 seconds Minimum: 120 seconds Maximum: 1800 seconds
WEBHOOK_REQUEST_TIMEOUT | Site | The number of seconds to wait for the webhook response. Type: integer Default: 30 seconds Minimum: 10 seconds Maximum: 60 seconds
WORK_ITEM_FIELDS_ENABLED_FOR_SEQUENTIAL_RANKING | Site/Space | Determines the fields by which a user can rank backlog items. This applies to user-defined or system fields that are editable and of integer type. List only logical names of fields. Separate field names with a comma. Note: Logical field names should not contain any special characters other than underscores. Type: string Default: none
WORKFLOW_CUSTOMIZATION_IN_NEW_WORKSPACE | Space | Defines the default workflow customization setting in new workspaces. If set to phase_extension_only, phases can be extended, and transitions are automatic. If set to phase_and_transition, phases can be added, and transitions can be customized. Type: string Default: phase_extension_only

Back to top

See also:

- Setting configuration parameters with the REST API

https://admhelp.microfocus.com ALM Octane 8942
Tips to improve your search results... ALM Octane Help Center ALM Octane Help 23.4-24.3 All View Local Help Center View Online Help Center Version: