Configuration parameters

This reference contains all publicly-available configuration parameters, including configuration parameters for the site and spaces.

To set configuration parameters: 

* Unless otherwise indicated, the configuration parameter is customizable on the site level only, and not per space. *
Configuration parameter Description
ALLOW_HTTP_METHOD_OVERRIDE

Enables override method through HTTP header. This is not enabled for GET requests.

Type: boolean

Default: false

ALLOW_WORKSPACE_USERS_CREATION

Enables or prevents the admin from doing the following, using both the ALM Octane UI and from the REST API:

  • Adding workspace users.

  • Importing LDAP users at workspace level.

  • Including users from the space level into the workspace.

Type: boolean

Default: true

ATTACHMENTS_FILE_EXTENSION_BLACK_LIST

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

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 configuration parameter.

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

Customizable for: Both site and space

ATTACHMENTS_URL_DOMAIN_WHITE_LIST

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 extension with a semi-colon (;).

Type: string

ATTACHMENTS_URL_ENABLE_DOMAIN_WHITE_LIST

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

Defines the maximum size (in KB) of each audit log file.

Type: integer

Default: 10240

Minimum: 1024

Maximum: 102400

AUDIT_LOG_FILE_ROLLING_SIZE

Defines the number of audit log files that are retained.

Type: integer

Default: 10

Minimum: 10

Maximum: 100

AUTHENTICATION_DELAY_ACTIVE

On-premises: 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

On-premises: 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

On-premises: 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

CLUSTERING_MAX_TESTS_THRESHOLD

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

DEFAULT_GET_PAGE_SIZE

The default number of items to return.

Type: integer

Default: 1000

Maximum: 10000

DEFAULT_LANGUAGE

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.

Customizable for: Both site and space

ENABLE_AUDIT

Defines whether the audit log is used.

Type: boolean

Default: true

ENABLE_LEGACY_TECH_PREVIEW_CLIENT_TYPE

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: true

Customizable for: Both site and space

ENABLE_OUTPUT_SANITIZATION

Defines whether to sanitize the REST output.

Type: boolean

Default: true

ENABLE_SPRINTER_USAGE

Defines whether users see the toggle switch in Settings, which enables them to use Sprinter to run manual tests.

Type: boolean

Default: true

ENABLE_STORAGE_ MAX_SIZE_ VALIDATION

Defines whether the maximum size for storage of files should be validated.

Type: boolean

Default: true

EXTENSION_TO_MIME_TYPE

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.

NoteALM Octane supports all mime types defined as valid by Apache Tika: http://grepcode.com/file/repo1.maven.org/maven2/org.apache.tika/tika-core/0.6/org/apache/tika/mime/tika-mimetypes.xml

The value of this parameter is one or more mappings between a custom file extension and its mime type.

Format: <custom_extension>=text/plain [, <another_custom_extension>=text/plain]

Separate each mapping with a semi-colon (;).

To bypass the validation of if an attachment's mime type matches the file extension, enter the string value false. For security purposes, this is not recommended.

Type: string

Example
ext1=text/plain;
ext2=text/plain

Customizable for: Both site and space

EXTERNAL_HELP_URL

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

FILE_EXTENSION_WHITE_LIST_DOWNLOAD

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

FAILURE_ANALYSIS_INSIGHT_TEST_FAILURE_THRESHOLD

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_UPLOAD

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

FORGET_USER_ON_DELETE

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

Sets the interval for checking if Fortify on Demand has finished scanning (in minutes).

Type: integer

Default:  2

FORTIFY_POLLING_ TIMEOUT_HOURS

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

Sets how many issues ALM Octane should retrieve from Fortify on Demand.

Type: integer

Default 100

Maximum: 500

GDPR_NOTICE_BODY

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.

Customizable for: Both site and space

GDPR_NOTICE_TITLE

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

Customizable for: Both site and space

GDPR_REQUIRE_USER_CONSENT

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

Customizable for: Both site and space

IMPORT_TESTS_FUSE

Defines the maximum number of tests that can be imported in one import operation.

Type: integer

Default: 300

IMPORT_WORK_ITEMS_FUSE

Defines the maximum number of work items (epics, features, stories, defects) that can be imported in one import operation.

Type: integer

Default: 1000

LIST_NODE_CHILDREN_AMOUNT_PARAM_ID

Defines the maximum number of values that can be added to a user-defined list.

Default: 150

LOG_APPENDER_MAX_SIZE

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

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

  • WARN

  • FATAL

  • ERROR

  • TRACE

LOG_ROOT_LEVEL

Changes the log level for specific Apache Log4j appenders.

The format is: 

<log>Appender=<level>;<log>Appender=<level>;<log>Appender=<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

  • WARN

  • FATAL

  • ERROR

  • TRACE

LOGIN_PAGE_NOTICE

On-premises: 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

Customizable for: Both site and space

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

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

Customizable for: Both site and space

MAIL_ATTACH_MAX_SIZE

Sets the maximum file size (in KB) for attachments to mail sent from ALM Octane.

Type: integer

Default: 10485760

Minimum: 10240

Maximum: 10485760

MAIL_ATTACH_TOTAL_MAX_SIZE

Sets the total maximum file size (in KB) for all attachments to mail sent from ALM Octane.

Type: integer

Default: 10485760

Minimum: 10240

Maximum: 10485760

MAIL_FOOTER

Defines the footer (rich text) for emails. Can be blank.

Type: string

Customizable for: Both site and space

MAIL_FORMAT

Defines the format that mails are sent in.  

Type: string

Default: HTML

Valid values

  • HTML

  • TEXT

MAIL_HEADER

Defines the header (rich text) for emails. Can be blank.

Type: string

Customizable for: Both site and space

MAIL_MESSAGE_CHARSET

The characters set for sent emails.

Type: string

Default: UTF-8

MAIL_PROTOCOL

The mail protocol.

Type: string

Default: smtp

MAIL_SERVER_HOST

The mail server host.

You can also set the host in the ALM Octane UI: Settings > Site > Servers tab.

Type: string

MAIL_SERVER_PORT

The mail server port.

You can also set the port in the ALM Octane UI: Settings > Site > Servers tab.

Type: integer

Default: 25

MAX_ ACTIVE_USERS_PER_SHAREDSPACE

The maximum number of active users per shared space.

Type: integer

Default: 1000

MAX_ATTACHMENT_COUNT_PER_ENTITY

The maximum number of attachments that can be added to any one 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

Customizable for: Both site and space

MAX_CARDS_TO_DISPLAY

The maximum number of cards to display in the Board view of the board.

Type: integer

Default: 200

Customizable for: Both site and space

MAX_PAGE_SIZE

The maximum number of items that can be returned.

Type: integer

Default: 20000

Minimum: 5000

Maximum: 20000 

MEMO_UDFS_LIMIT

The maximum number of memo-type UDFs that can be defined per workspace.

Type: numeric

Default: 10

Maximum: 30

Customizable for: Both site and space

MINUTES_UNTIL_GLOBAL_SESSION_TIMEOUT

The maximum number of minutes that the session lasts even if the session is in use.

Type: integer

Default: 1440 minutes (24 hours)

MINUTES_UNTIL_IDLE_SESSION_TIMEOUT

The maximum number of minutes that the session lasts while the session is not in use.

Type: integer

Default: 180 minutes (3 hours)

ODATA_USE_SERVER_BASE_URL

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

SERVER_BASE_URL

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.

Type: string

Example:

http://host.domain:8080

SHARED_SPACES_LOG_LEVEL

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

Valid values

  • DEBUG

  • WARN

  • INFO

  • WARN

  • FATAL

  • ERROR

  • TRACE

SLACK_INTEGRATION_CLIENT_ID

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

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

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

Customizable for: Both site and space

SMTP_AUTHENTICATION

Defines whether the SMTP server needs to be authenticated.

Type: boolean

Default: false

SMTP_ENABLE_STARTTLS

Determines whether STARTTLS is used when connecting to the mail server.

Type: boolean

Default: false

SMTP_NOTIFICATION_SENDER_EMAIL

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.

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

Customizable for: Both site and space

SMTP_PASSWORD

Sets the password for connecting to the SMTP server.

Type: string

SMTP_SSL_SUPPORT

Defines whether to connect to the SMTP server using SSL

Type: boolean

Default: false

SMTP_USER

Sets the user for connecting to the SMTP server.

Type: string

STORAGE_MAX_FILE_SIZE

Sets the maximum size for storage files, including attachments (in bytes).

This parameter is set at the site level, and not at the shared space level.

Type: integer

Default: 10000000

Minimum: 10000

STORAGE_MAX_SIZE

Sets the maximum size for storage per shared space.

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: 10000 MB

Minimum: 6000 MB

Maximum: 1 TB

SUPPORTS_BASIC_AUTHENTICATION

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 HPECLIENTTYPE header with the value HPE_REST_API_TECH_PREVIEW in your requests to configure this parameter.

Type: boolean

Default: false

Example: See Configuration parameters.

Customizable for: Both site and space

TREE_COMPONENT_MAX_ITEMS_PER_PARENT

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)

Customizable for: Both site and space, by site admin only

VULNERABILITIES_PER_PIPELINE_RUN_LIMIT

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

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

Customizable for: Both site and space

WEBHOOK_REQUEST_TIMEOUT

On-premises: 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: