Configuration parameters

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

Overview

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

Space administrators 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.

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

ValueEdge includes the following configuration parameters:

Parameter Description
ALLOWED_EXTERNAL_EMAIL_DOMAINS

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

ATTACHMENTS_BULK_CREATE_MAX_SIZE

When creating attachments in bulk, this number defines the maximum size of the request.

Type: integer

Default: 100

ATTACHMENTS_BULK_MAX_FILE_SIZE

When creating attachments in bulk, this number defines the maximum file size of attachments in the request.

Type: integer

Default: 100

ATTACHMENTS_FILE_EXTENSION_WHITE_LIST

Defines a list of the permitted file-type extensions for ValueEdge 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 ValueEdge attachments. The file types (mime types) must be one of ValueEdge'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

Defines the file-type extensions that can be previewed in ValueEdge.

The file types listed in this parameter are previewed in a protected mode. For example, any malicious scripts are blocked in the preview.

To enable the unprotected preview of the files, also list the file extensions in the ATTACHMENTS_PREVIEW_LOW_SECURITY_FILE_EXTENSIONS parameter.

To enable 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.

    Example of Google Chrome extension for Office files: Office Editing for Docs, Sheets & Slides.

  • 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

Defines the file-type extensions that can be previewed in ValueEdge without any security protection. Malicious scripts could also run in the preview.

Note: To enable 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

AUTOMATIC_TIMING_OF_MANUAL_RUN_DURATIONS_TOGGLE

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

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

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

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

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

The maximum number of columns to display in a Board view.

Type: integer

Default: 30

BOOLEAN_STRING_UDFS_LIMIT

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

CD_SERVER_DA_READ_PAGE_SIZE

Determines the number of DA items that ValueEdge can obtain from a single request.

Type: integer

Default: 100

Minimum: 1

Maximum: 500

Configurable by site admin only.

CD_SERVER_HTTP_CLIENT_TIMEOUT

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

Determines the number of CD servers that can be integrated per tenant.

Type: integer

Default: 50

Minimum: 1

Configurable by site admin only.

CI_REQUEST_DEFAULT_TIMEOUT_IN_SECONDS

Defines a timeout (in seconds) for completing a request to the CI Server.

Type: integer

Default: 30

CLIENT_TYPES_ALLOWED_TO_ACCESS_REST_API

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

CONTINUE_RUN_WITHOUT_PERMISSION_GRACE_PERIOD

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

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

Determines whether the Milestone and Sprint fields of a new defect are automatically populated when the defect is created from the Manual Runner.

Type: boolean

Default: true

CORS_ALLOW_ORIGIN

A list of domains that are allowed to connect to the ValueEdge server using browser CORS functionality.

Syntax: http(s)://<yourdomain>.<ext>

Type: string

CORS_MAX_AGE

Indicates how long (in seconds) the results of a pre-flight request can be cached.

Type: integer

Default: 7200

CREATE_STEPS_DURING_RUN_CREATION

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

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

The maximum number of date/time UDFs that can be defined per workspace.

Type: integer

Default: 20

Minimum: 0

Maximum: 20

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
Portuguese (Brazil): lang.ptb
Russian: lang.ru
Simplified Chinese: lang.chs
Spanish: lang.esp

DELETE_WORKSPACE_REASON_REQUIRED

Determines whether the Delete reason field is required when deleting a workspace.

Type: boolean

Default: true

DOC_REPORT_COLORED_TEST_SCRIPT

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

The number of widgets allowed in Document reports.

Default: 20

DOCUMENT_REPORT_ATTACHMENTS_SIZE_LIMIT 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

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 enable this image to be available 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 microfocus.com, then you would enter google.com;microfocus.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

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

The maximum allowed size of a document report logo in MBs.

Type: integer

Default: 5

DOCUMENT_REPORT_READER_PAGE_SIZE

The maximum number of pages allowed in a document report.

Type: integer

Default: 1000

DROPDOWN_MAX_ITEMS

The maximum number of items that are displayed in dropdown lists.

Type: integer

Default: 200

Minimum: 30

Maximum: 1000

EDITABLE_TEST_TYPE_FOR_RUN

Allows the editing the Test Type field of a test run.

Type: boolean

Default: true

ELASTIC_STOP_EXECUTE_REINDEX_POST_UPGRADERS

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

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_QUICK_REPLY

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_ASSIGN_USER_TO_RELEVANT_CONTEXT

If true, enables to assign user to relevant tenant.

Type: boolean

Default: false

ENABLE_DUPLICATE_ENTITY

Enables the duplicate entity functionality in the ValueEdge UI.

Type: boolean

Default: true

ENABLE_FAVORITE_PUBLIC_LINKS_PER_SHARED SPACE

Defines whether sharing public favorites is enabled on the shared space.

For details, see Public favorite links.

Type: boolean

Default: false

ENABLE_GENERATE_REPORT_WITH_LINK_IMAGE

Allows link images embedded in an entity's rich text fields, to be downloaded during document report generation.

Type: boolean

Default: false

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.

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_TEST_ASSIGNMENT_RULES_IN_SUITES

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

Let users add widgets to Document reports, on a shared space level. For details, see Document reports.

Type: boolean

Default: true

ENTITIES_BULK_TRANSLATION_CACHE_THRESHOLD

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_TO_RETURN_WITH_DEFAULT_VALUES

This parameter instructs ValueEdge to trim only the listed entities, when the TRIM_DEFAULT_VALUES_FOR_REST_API and MQM_CLIENT_UI are not disabled.

Type: string

Values: comma separated list of entities

ENTITY_EXTERNAL_ACTIONS_SUPPORTED_PROTOCOLS

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

Excludes the specified client types, separated by commas, from the default value trimming. This is relevant when TRIM_DEFAULT_VALUES_FOR_REST_API is enabled. For details, see ENTITIES_TO_RETURN_WITH_DEFAULT_VALUES.

Type: string

Values: comma delimited list

EXTENSION_TO_MIME_TYPE

Enables site admins to add additional, custom file extensions to the list of permitted extensions for ValueEdge attachments, as defined with configuration parameter ATTACHMENTS_FILE_EXTENSION_WHITE_LIST.

The file types (mime types) must be one of ValueEdge's supported mime types, but you can choose any extension you like.

NoteValueEdge 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 ValueEdge.

Type: integer

Default: 20

EXTERNAL_ENTITY_ACTIONS_FILE_EXTENSION_WHITE_LIST

If you upload external actions to ValueEdge, you can restrict the file types that can be included in the uploaded zip file.

Type: string

Default: *

FEATURE_END_DATE_PREDICTION_ENABLED

Defines if feature predictive end date is calculated and displayed. For details, see Predictive analytics.

Type: boolean

Default: true

FETCH_CI_JOB_LIST_TIMEOUT_IN_SECONDS

Defines a timeout in seconds, for fetching CI jobs from a CI server during creating new pipeline.

Type: integer

Default: 180 (3 minutes)

FTE_MODULE_VISIBLE

Defines if the Execution module is visible.

Type: boolean

GDPR_NOTICE_BODY

Defines the terms for personal data processing to display in a dialog box when first-time users log in to ValueEdge.

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

Defines the title of the dialog box that displays the terms for personal data processing when first-time users log in to ValueEdge.

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

Determines if consent is required for first-time users logging in to ValueEdge. 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

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

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

Hides the language selection dropdown for the user.

Type: boolean

Default: false

HIDE_MARKETING_LINKS_VE_MENU

Enables to hide promotional links from the ValueEdge menu.

Type: boolean

Default: false

IGNORE_ALERT_RULE_WHEN_CREATE_IN_DRAFT_MODE

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_TESTS_FUSE

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

INCLUDED_CLIENT_TYPES_IN_DEFAULT_VALUE_TRIMMING

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

The maximum number of integer UDFs that can be defined per workspace.

Type: integer

Default: 50

Minimum: 0

Maximum: 50

LIMIT_AMOUNT_OF_AUTOCOMPLETE_SUGGESTIONS

Defines the maximum number of suggestions displayed in autocomplete for Gherkin steps.

Type: integer

Default: 20

Minimum: 0

Maximum: 20000

LIMIT_TESTS_IN_RECOMMENDED_GRID

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

Determines whether the Backlog items, Requirements, and Feature fields are automatically populated when a new defect is created from the Manual Runner.

Type: boolean

Default: true

LOGIN_PAGE_NOTICE

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

Sets the text to display at the top left of ValueEdge, 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

The maximum number of long string UDFs that can be defined per workspace.

Type: integer

Default: 5

Minimum: 0

Maximum: 20

MAIL_FOOTER

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_HEADER

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

Type: string

MAIL_SERVER_HOST

The mail server host.

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

Type: string

MAIL_SERVER_PORT

The mail server port.

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

Type: integer

Default: 25

MAIL_SUBJECT_SUFFIX

A string that is added as a suffix to the subject line in all emails sent from ValueEdge.

A subject suffix may be necessary in your organization as a classification tag, to ensure that the mail server allows ValueEdge emails.

Type: string

MANUAL_TEST_SCRIPT_DEFAULT_VIEW

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

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

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

Type: integer

Default: 200

MAX_CONCURRENT_REPORTS_PER_USER

The maximum number of concurrent reports that can be generated per user. If the user exceeds the maximum, ValueEdge issues a notification.

Type: integer

Default: 5

MAX_EXCEL_ALLOWED_ENTITIES_FOR_AUTO_FIT

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.

  • To disable auto-fit for any number of exported entities, set the value to 0.

  • To enable auto-fit for all exported entities, set the value to -1.

Default: 500

Note: This parameter only applies to Excels with memo or long string type fields.

MAX_EXPORT_TESTS_WITH_STEPS

The maximum number of manual and Gherkin test steps that can be exported to Excel per space.

Customizable by space admins only.

Type: integer

Default: 20

Minimum: 0

Maximum: 255

MAX_STEPS_IN_RUN_REPORT

The maximum number of steps that can be in a run report.

Type: integer

Default: 1000

MAX_TREE_DEPTH_APPLICATION_MODULE

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

The maximum tree depth for the SCM resource tree.

Type: integer

Default: 12 

Minimum: 4

Maximum: 20

MAXIMUM_DOCUMENT_REPORT_PAGES

The maximum number of pages allowed for a single exported document. A negative number instructs ValueEdge to use the value of MAX_VALUE.

Type: integer

Default: 1000

MBT_DATA_TAB_FILTER_LRU_QUEUE_MAX_SIZE

The maximum number of filters that a user can define for all the existing datasets.

MBT_DIAGRAM_AVOIDS_NODES_ELEMENTS_THRESHOLD

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

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

Type: integer

Default: 10

Minimum: 0

Maximum: 30

NUMBER_OF_ENTITIES_CONSIDERED_LARGE_REPORT

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

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

The number of search strings to store in the recent global search list.

Type: integer

Default: 10

Minimum: 3

Maximum: 20

ODATA_NAME_ENCODED

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_XML_ENCODED

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

Internal: Indicates if merge join cartesian should be disabled when using multiple crossfilters in Oracle.

Type: boolean

PHASE_SLOW_DOWN_THRESHOLD_PERCENT

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, ValueEdge displays a Slow phase icon in the timeline.

Type: integer

Default: 100

PR_PURGE_ MAX_NUM_DAYS_TO_KEEP

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

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

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

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

Disables all purging of pipeline runs.

Values: true or false

Default: false

PROPAGATE_SPEC_APP_MODULE_TO_SCENARIOS

Populates application module changes in the BDD specification to its scenarios.

Type: boolean

Default: true

PROPAGATE_SPEC_COVERAGE_TO_SCENARIOS

Determines whether BDD scenarios automatically inherit backlog item coverage from the parent BDD specification.

Type: boolean

Default: true

PUBLIC_LINKS_ALLOW_EMBEDDING_RESPONSE

Determines whether favorite pubic links can be embedded in online pages.

For details, see Public favorite links.

Type: boolean

Default: false

QUALITY_RISK_COMMITS_PERCENT

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

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

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

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

Auto actions of the following types:

  • CI server auto actions
  • CD server auto actions

Determines the interval at which ValueEdge 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

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

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

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

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

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

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. ValueEdge then triggers the CD server polling to verify the auto action execution status.

Note: ValueEdge 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

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

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. ValueEdge then triggers the CI server polling to verify the auto action execution status.

Note: ValueEdge 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

Determines the maximum number of items that can be updated by an auto action.

Type: integer

Default: 500

RC_CRITERIA_PER_GATE

Determines the number of criteria allowed in a single quality gate.

Type: integer

Default: 10

Maximum: 30

RESTRICT_REST_API_TO_API_KEYS_ONLY

If true, restricts access to REST API to only API Keys (blocking access for regular users).

Type: boolean

Default: false

RETURN_ACTUAL_TOTAL_COUNT

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

Defines the test run phases that ValueEdge 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

SEARCHABLE_UDFS_LIMIT_IN_SHARED_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

The number of user-defined fields that can be marked as searchable in a workspace. The sum of all searchable UDFs (including the ones enabled in SEARCHABLE_UDFS_LIMIT_IN_SHARED_SPACE) may not exceed 20.

Type: integer

Default: 0

SHOW_FIELD_TOOLTIP

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

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

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.

Submit a support ticket to change the parameter.

Type: string

Configurable by site admin only.

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 ValueEdge 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, ValueEdge 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.

 Submit a support ticket to change the parameter.

Type: string

Configurable by site admin only.

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 megabytes).

Type: integer

Default: 100

Minimum: 0

Maximum: 500M per file

STORAGE_MAX_SIZE

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

Indicates whether external actions can be uploaded to ValueEdge. For details, see Host external actions in ValueEdge.

Type: boolean

Default: true

SUPPORTS_BASIC_AUTHENTICATION

Enables your integration to use basic authentication when using an API key to authenticate with ValueEdge, instead of the ValueEdge authentication REST API.

Note that basic authentication is not secured. Turning this parameter on reduces the security level of ValueEdge.

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

Enables basic authentication for OData, per space. This allows OData integrations to connect to ValueEdge using basic authentication.

Note that basic authentication is not secured. Setting this parameter to true reduces the security level of ValueEdge.

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

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

TASK_SUPPORTS_FLOAT_VALUES

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_TOTAL

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

Indicates whether TestRunner uses the JSON format to pass the list of tests for execution on the CI server.

Type: boolean

Default: false

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)

Configurable by site admin only.

TRIM_DEFAULT_VALUES_FOR_REST_API

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

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

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

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

Whether ValueEdge 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

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

WORK_ITEM_FIELDS_ENABLED_FOR_SEQUENTIAL_RANKING

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

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: