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.

- 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. For example, if a site admin sets a site-level parameter called DEFAULT_LANGUAGE to lang.en for English, and the space admin changes the same DEFAULT_LANGUAGE parameter on the site level to lang.de, the default language for the space will be English while the rest of the site will be in German.

Back to top

## Parameters A-L

Parameter | Scope | Description
--- | --- | ---
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 | Enables override method through HTTP header. This is not enabled for GET requests. Type: boolean Default: false
ATTACHMENTS_FILE_EXTENSION_BLACK_LIST | Site | Defines a list of prohibited extensions for file types 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 extensions for file types 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_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 | Enables or disables usage of the domain white list validation of attachment URL, as enabled as defined with 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
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
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 | The maximum number of columns to display in the Board view of the board. 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
CLUSTERING_MAX_TESTS_THRESHOLD | Site | Defines 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
COPY_RUN_SUITE_UDFS_TO_RUNS | Site/ Space | 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
CORS_ALLOW_ORIGIN | Site/ Space | A domain that ALM Octane can pull resources from. Syntax: http(s)://<yourdomain>.<ext> Type: string
CORS_ENABLED | Site | Determines whether CORS support is enabled on ALM Octane. Type: boolean Default: true
CORS_MAX_AGE | Site/ Space | Indicates how long (in seconds) the results of a preflight request can be cached. Type: integer Default: 7200
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
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
DEBUG_FLAGGING_DAEMON | Site | The when set to true, the FLAGGING_DAEMON_PERIOD_HOURS value will be applied as seconds instead of hours. The thresholds specified by the user as part of flag rule configuration, will also be applied in seconds. Type: boolean Default: false
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 Russian: lang.ru Simplified Chinese: lang.chs Spanish: lang.esp Note: These are the values are currently supported. Support for some of these languages may be discontinued, and support for others might be added.
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 | Space | Sets the maximum number of items to display in a drop-down list. The space admin can set this for spaces. Type: integer Default: 200 Minimum: 30 Maximum: 1000
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.
EMAIL_QUICK_REPLY | Site | Determines whether users are able to 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_AUDIT | Site | Defines whether the audit log is used. Type: boolean Default: true
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. We recommend that you 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 enables them to use Sprinter to run manual tests. 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
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 Add external actions. Type: comma delimited list
EXTENSION_TO_MIME_TYPE | Site/ Space | Enables 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
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 | The period of time to before starting a new flag rule process in the background. By default this value is in hours. If you set DEBUG_FLAGGING_DAEMON to true, the above period will be applied in seconds instead of hours, and the thresholds specified by the user as part of flag rule configurations, will also be applied in seconds. 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_DELAY_MINUTES | Site | Sets the interval for checking if Fortify on Demand has finished scanning (in minutes). Type: integer Default: 2
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_UPPER_LIMIT_OF_ ISSUES | Site | Sets how many issues ALM Octane should retrieve from Fortify on Demand. Type: integer Default 100 Maximum: 500
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
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
HREF_PROTOCOLS_WHITE_LIST | Site | Provides a list of whitelisted protocols for the Link dialog box in memo fields. For details, see Item attributes. Type: string Default: http;https;td;testdirector;mailto
IMPORT_TESTS_FUSE | Site | Defines the maximum number of tests that can be imported in one import operation. Type: integer Default: 300
IMPORT_WORK_ITEMS_FUSE | Site | Defines the maximum number of work items (epics, features, stories, defects) that can be imported in one import operation. Type: integer Default: 1000
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
LIST_NODE_CHILDREN_AMOUNT_PARAM_ID | Site | Defines the maximum number of values that can be added to a user-defined list. Default: 150
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

Back to top

## Parameters M-Z

Parameter | Scope | Description
--- | --- | ---
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 will not be 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 will be 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_SERVER_HOST | Site | 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 | The mail server port. You can also set the port in the ALM Octane UI: Settings > Site > Servers tab. Type: integer Default: 25
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_CARDS_TO_DISPLAY | Site/ Space | The maximum number of cards to display in the Board view of the board. Type: integer Default: 200
MAX_PAGE_SIZE | Site | The maximum number of items that can be returned. Type: integer Default: 20000 Minimum: 5000 Maximum: 20000
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 (3 levels in addition to the root) Minimum: 4 Maximum: 20
MAX_TREE_DEPTH_SCM_RESOURCE | Space only | The maximum tree depth for the SCM resource tree. Type: integer Default: 12 Minimum: 4 Maximum: 20
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
MINUTES_UNTIL_GLOBAL_SESSION_TIMEOUT | Site | Non-SSO environments: The maximum number of minutes that the session lasts even if the session is in use. After this timeout, the user must log in again. SSO environments: The maximum number of minutes that the session lasts when logged in with API keys. After this timeout, the user must log in again. Type: integer Default: 1440 minutes (24 hours)
MINUTES_UNTIL_IDLE_SESSION_TIMEOUT | Site | Non-SSO environments: The maximum number of minutes that the session lasts while the session is not in use. After this timeout, the user must log in again. SSO environments:The number of minutes for license consumption. If the number of minutes has elapsed, the license is considered expired. The next request consumes a new license (if available). Re-login is not required. Type: integer Default: 180 minutes (3 hours)
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
ONLY_SHOW_ACTIVE_RELEASES | Space | For ALM Octane and Jira synchronization mapping. If set to true, deactivated releases (in ALM Octane) and archived versions (in Jira) are hidden from value mapping, and you do not need to map them to pass the integrity check. Type: boolean Default: false
PR_PURGE_DISABLE | Site/ Space | Disables all purging of pipeline runs. Values: true or false Default: false
PR_PURGE_ NUM_DAYS_TO_KEEP | Site/ Space | The number of days to keep pipeline runs and their data. Type: integer Default:728 Range: 7-1092 (3 years) Note: Only relevant if PR_PURGE_ STRATEGY_TYPE is set to days_to_keep.
PR_PURGE_ NUM_RUNS_TO_KEEP | Site/ Space | The number of pipeline runs to keep. Type: integer Default: 30,000 Range: 10-30,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 | Manage the site (on-premises) 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) days_to_run: Purges the pipeline runs after the number of runs reaches the value of the PR_PURGE_NUM_RUNS_TO_KEEP site parameter.
RC_CRITERIA_PER_GATE | Site/ Space | For release processes, the number of criteria allowed in a single quality gate. Type: integer Default: 10 Maximum: 30
RC_QUERY_CRITERION_CALC_COUNT_PER_TASK | Site | For release processes, the maximum number of query criteria that can be calculated at once. Type: integer Default: 20 Minimum: 20
SAME_SITE_COOKIE_ATTRIBUTE | Site | To enable hosting external actions on ALM Octane, set to "None". Type: string Allowed values: Strict, Lax, None Default: Lax
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
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_LAST_USED_VALUES_IN_RUN_DIALOG | Space | Enables 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
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. On premises: Changes to the parameter at the space level can be made by site admins. SaaS: Submit a support ticket to change the parameter. Type: string
SMTP_AUTHENTICATION | Site | Defines whether the SMTP server needs to be authenticated. Type: boolean Default: false
SMTP_ENABLE_STARTTLS | Site | 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. On premises: Changes to the parameter at the space level can be made by site admins. SaaS: Submit a support ticket to change the parameter. Type: string
SMTP_PASSWORD | Site | Sets the password for connecting to the SMTP server. Type: string
SMTP_SSL_SUPPORT | Site | Defines whether to connect to the SMTP server using SSL Type: boolean Default: false
SMTP_USER | Site | Sets the user for connecting to the SMTP server. Type: string
STORAGE_MAX_FILE_SIZE | Site | Sets the maximum size for storage files, including attachments (in megabytes). This parameter is set at the site level, and not at the shared space level. Type: integer Default: 100 Minimum: 0 Maximum: 10000 (10 GB)
STORAGE_MAX_SIZE | 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 | Sets whether the basic authentication is activated for the REST API and OData per space. 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 Example: See Configuration parameters.
SUPPRESS_NOTIFICATIONS | Site | Disables 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
SYNC_BASE_URL | Site | If Synchronizer is on a different URL than ALM Octane, enter the public base URL of the Synchronizer. Type: string Example: http://sync-server.company.net:8080
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
TREE_COMPONENT_MAX_ITEMS_PER_PARENT | Site/ Space By site admin only | 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)
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
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_REQUEST_TIMEOUT | Site | The number of seconds to wait for the webhook response. Type: integer Default: 30 seconds Minimum: 10 seconds Maximum: 60 seconds

Back to top

See also:

- Synchronizer parameter reference
- 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 15.1.90 All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: