ALM Site Parameters
ALM Site Parameters
htm
Site Parameters
Parameter Comments
Description: If this parameter is set to N, you can add
new ALM users from Site Administration (Site Users
tab) only. If this parameter is set to Y (default), new
ALM users can also be added from Project
Customization. In the Project Users page, click Add
User. The Add User to Project dialog box opens. If this
parameter is set to Y, a New button is available for
ADD_NEW_USERS_FROM_PROJECT adding new ALM users.
Default value: Y
Introduced in patch: GA
System: true
Description: The maximum number of
synchronization jobs that can run at the same time. The
default value is 5.
Default value: 5
Min value: 1
ALI_MAX_PROJECT_SYNC_JOB
Max value: 100
System: true
Description: The minimum time interval between
synchronizations for a project. The actual run time
depends on the number of synchronized projects and
synchronization jobs. The default value is 60 minutes.
Default value: 60
System: true
ALI_PROJECT_SYNC_DISCOVERY_INTERVAL Description: The interval between checks to
determine if any project requires synchronization. The
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 1/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: 10
Min value: 5
System: true
Description: Controls whether to allow REST API
requests with X-HTTP-Method-Override header.
Default value: N
ALLOW_HTTP_METHOD_OVERRIDE
Introduced in release: ALM 12.20
Introduced in patch: GA
System: false
Description: This parameter determines whether the
Allow Multiple Values check box is visible in the
Project Entities page in Project Customization. If this
parameter is set to N, then the Allow Multiple Values
check box is unavailable. If this parameter does not
exist or is set to "Y", then the Allow Multiple Values
check box is available.
ALLOW_MULTIPLE_VALUES
Default value: Y
Introduced in patch: GA
System: false
ALLOW_UPDATE_USER_PROPERTIES_FROM_C Description: User details are set in Site
USTOMIZATION Administration. A project administrator cannot change
details of project users in Project Customization. If this
parameter is set to Y, the project administrator is able
to change the details of project users in Project
Customization. This option may cause a security risk,
as it allows the project administrator to replace a user's
e-mail address with his own. By doing so, the project
administrator can then use the Forgot Password link to
reset and change a user's password. If this parameter
does not exist, or is set to N, only the user can change
his details in Project Customization.
Default value: N
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 2/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This parameter define the global
expiration time of API Key.
Default value: -1
Min value: -1
APIKEY_EXPIRE_DAYS
Max value: 1000000
Introduced in patch: 0
System: false
Description: This parameter defines the maximum
number of API keys each user is allowed to create.
The default value is 10.
Default value: 10
Min value: 0
APIKEY_MAX_NUM_PER_USER
Max value: 9223372036854775807
Introduced in patch: GA
System: false
Description: This parameter defines the self-service
level of API keys. If it's set to "admin_only", basic
users cannot view or manage their ApiKeys. Only
admin users can. If it's set to "user_read_only", basic
users can only view their ApiKeys. If it's set to
"user_full_control", basic users have the admin
permission to view and manage their ApiKeys. The
default value is "admin_only".
Introduced in patch: GA
System: true
ARCHIVE_BASE_FOLDER Description: Specifies the base folder where archived
projects are stored. ALM Robot exports projects to and
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 3/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value:
Introduced in patch: GA
System: false
Description: This flag affects mailing services
behavior in ALM UI/WorkFlow and OTA. By default
all mails sent are delivered asynchronously. The site
administrator can override this behavior and set the
mailing services to be synchronous. Valid values: Y -
send mail asynchronously, N - send mail
synchronously.
ASYNC_MAIL_ENABLED
Default value: Y
Introduced in patch: GA
System: false
Description: The value is the semicolon delimited
string with the file extensions that are not allowed to
be downloaded via open attachments or REST API.
Note: *Imported or restored projects are not blocked
even if their repository contains files of blocked file
types. * Projects upgraded from previous versions still
ATTACHMENT_FILE_EXTENSION_BLACK_LIST contain files of blocked file types that already exist in
_DOWNLOAD the repository. * During optimized repository
migration, files of blocked file types are not blocked.
Introduced in patch: GA
System: false
ATTACHMENT_FILE_EXTENSION_BLACK_LIST Description: The value is the semicolon delimited
_UPLOAD string with the file extensions that are not allowed to
be uploaded via open attachments or REST API. Note:
* Imported or restored projects are not blocked even if
their repository contains files of blocked file types. *
Projects upgraded from previous versions still contain
files of blocked file types that already exist in the
repository. * During optimized repository migration,
files of blocked file types are not blocked.
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 4/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: Specify the file extensions that are
allowed to be downloaded via open attachments or
REST API. Separate values with semicolons. The
white list has a higher priority than black list.
ATTACHMENT_FILE_EXTENSION_BLACK_LIST
_DOWNLOAD is ignored when
ATTACHMENT_FILE_EXTENSION_WHITE_LIST ATTACHMENT_FILE_EXTENSION_WHITE_LIST
_DOWNLOAD _DOWNLOAD is specified.
Introduced in patch: P4
System: false
Description: Specify the file extensions that are
allowed to be uploaded via open attachments or REST
API. Separate values with semicolons. The white list
has a higher priority than black list.
ATTACHMENT_FILE_EXTENSION_BLACK_LIST
_UPLOAD is ignored when
ATTACHMENT_FILE_EXTENSION_WHITE_LIST ATTACHMENT_FILE_EXTENSION_WHITE_LIST
_UPLOAD _UPLOAD is specified.
Introduced in patch: P4
System: false
Description: The maximum size (in kilobytes) of an
attachment that can be sent with email from ALM. If
the attachment size is greater than the specified value,
the email is sent without the attachment. By default,
the maximum email attachment size is 3,000 KB.
Introduced in patch: GA
System: true
ATTACH_TOTAL_MAX_SIZE Description: The maximum size (in kilobytes) of all
attachments that can be sent with email from ALM
(takes in account ATTACH_MAX_SIZE). If the total
attachments size is greater than the specified value, the
email is sent without the attachments.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 5/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
Introduced in patch: GA
System: false
Description: Max audit log file size in kilobytes
(Maximum size is 1GB). When audit log file will
reach this size next audit log file will be created.
Min value: 1
AUDIT_LOG_FILE_MAX_SIZE
Max value: 1048576
Introduced in patch: GA
System: true
Description: The file location of the audit log file
System: true
Description: The ALM server can disconnect an ALM
client session. This occurs if: * The site administrator
disconnects the session. * The session is automatically
disconnected, according to the inactivity time interval
setting. For more information on setting a timeout, see
WAIT_BEFORE_DISCONNECT. The ALM client
machine displays a message, informing the user that
the session has been disconnected. If this parameter is
set to Y, the client machine also automatically
performs logout actions and returns the user to the
AUTO_LOGOUT_ON_SERVER_DISCONNECT ALM Login window. This ensures that the user does
not continue to work in a session which is no longer
connected to the server. If this parameter is set to N, no
logout action is performed on disconnect.
Default value: N
Introduced in patch: GA
System: false
AUTO_MAIL_SUBJECT_FORMAT Description: This parameter enables you to customize
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 6/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This parameter enables you to prevent
ALM sending automatic email notification to project
administrators when users are assigned or removed
from a project in Site Administration. If this parameter
is set to N, then automatic notification is not sent to
project administrators. If this parameter does not exist,
is empty, or is set to Y, then automatic notification is
AUTO_MAIL_USER_NOTIFICATION sent.
Default value: Y
Introduced in patch: GA
System: false
Description: If this parameter is set to Y (default),
defect email is sent with attachments. This applies
only if you select Send mail automatically in the Site
Projects tab.
Introduced in patch: GA
System: true
Description: If this parameter is set to Y (default),
defect email is sent with the history. This applies only
if you select Send mail automatically in the Site
Projects tab. Note: The former parameter name
(SAQ_MAIL_WITH_HISTORY) is supported for
purposes of backward compatibility.
AUTO_MAIL_WITH_HISTORY
Default value: Y
Introduced in patch: GA
System: true
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 7/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: N
Introduced in patch: GA
System: false
Description: The base repository path. The ALM and
Site Administration repositories are sub-folders of this
repository. If you change this parameter value, new
projects you create are stored in this location. After
you change the value of this parameter, you must
restart all servers in the cluster. The initial repository
path is set during ALM server configuration. For more
BASE_REPOSITORY_PATH information, refer to the Micro Focus Application
Lifecycle Management Installation and Upgrade
Guide.
Introduced in patch: GA
System: true
Description:
siteparams.BPT_USE_ORIGINAL_VALUE_TYPE.de
scription
Default value: N
BPT_USE_ORIGINAL_VALUE_TYPE
Introduced in release: ALM 11.00
Introduced in patch: GA
System: false
Description: Valuing this parameter with ‘Y?bypasses
checking that required fields are valued before
performing an update of multiple entities.
Default value: N
BULK_ACTION_IGNORE_REQUIRED_FIELD
Introduced in release: ALM 12.50
Introduced in patch: 1
System: true
BV_EXCEL_REPORT_MAX_ROWS Description: This parameter defines the max rows of a
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 8/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
BV excel report.
Min value: 1
Introduced in patch: GA
System: false
Description: Site param for a list of BV field names
for hide on UI. The list is separated with semicolon.
Introduced in patch: GA
System: false
Description: This parameter is related to the "Orphan
Analysis Data File Cleanup Job" scheduled job,
responsible to delete generated data files (graphs or
project reports) left in the server repository due to
client crashes during the report generation. The
parameter defines the duration in minutes between
executions of the job. The default value is 30 days
(43200 minutes), and the minimum value is one week
(10080 minutes).
CLEAN_ORPHAN_ANALYSIS_DATA_JOB_SLEEP
_INTERVAL Default value: 43200
Introduced in patch: GA
System: false
COMMUNICATION_SECURITY_PASSPHRASE Description: Communication between the ALM
server and other Micro Focus BTO applications is
enabled after authentication by a Single Sign-On
(SSO) token. Changing the
COMMUNICATION_SECURITY_PASSPHRASE in
the ALM server requires that the equivalent value on
other servers, such as the PC server and the host
machine for PC, must be updated as well. An ALM
server restart is needed when changing this parameter
for all the nodes in a cluster.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 9/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: true
Description: This parameter enables you to specify
that the user who copies a record is listed in the
specified User List fields of the copy. For more
information on fields that have User List as their Field
Type, see Customizing Project Entities. The value of
this parameter is a comma-separated list of User List
fields. For example, set the value of the parameter to
BG_DETECTED_BY. Assume defect 10 is detected
COPY_CHANGES_USER_FIELDS by user Cecil_qc, and user Shelly_qc copies defect 10.
ALM creates a copy of the defect with Shelly_qc as
the user who detected the defect, not Cecil_qc.
Introduced in patch: GA
System: false
Description: You can use this parameter if you are
working with load balancing over a cluster of
application servers. If the parameter is set to Y, ALM
creates an HTTP session. This causes the load balancer
to operate in sticky mode, meaning that after a request
sent by a client is directed to a particular node in the
cluster, all subsequent requests sent by that client are
directed to the same node. By default, this parameter is
set to N. For details, see the Micro Focus Application
CREATE_HTTP_SESSION Lifecycle Management Installation and Upgrade
Guide.
Default value: N
Introduced in patch: GA
System: true
Description: The parameter is to set the customized
message shown when LDAP login failed.
System: false
CUSTOMIZED_LDAP_LOGIN_FAILED_URL Description: The parameter is to set the customized
URL shown when LDAP login failed.
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 10/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: This parameter enables you to add a
custom entry to the Help menu that links to a URL
address. For example, if you want to allow users local
access to ALM product movies, you can save the
movies on the server, and create a link to a movies
index page. Use the following syntax to enter a
parameter value: <link alias>;<URL>, where the
values of both <link alias> and <URL> are surrounded
by quotation marks, and separated by a semicolon. For
example, set the value of the parameter to
CUSTOM_HELP_MENU_LINK "MyBusiness - Online Help
Page";"http://mybusiness/ALMHelp". The above
example adds the MyBusiness - Online Help Page
entry to the Help menu. Clicking the entry opens a
custom Web page located at
http://mybusiness/ALMHelp.
Introduced in patch: GA
System: false
Description: This parameter enables you to handle
missing prerequisites during the deployment phase of
starting the ALM client. The value of this parameter is
either: * A valid URL to a page that contains links for
downloading alternate prerequisites. * NO_URL or
blank. The deployment phase opens the default URL.
The default value is blank. Note: Setting a separate
CUSTOM_PREREQUISITES_PAGE_URL URL for each prerequisite is not supported. The page
must contain information for all prerequisites.
Introduced in patch: 5
System: false
Description: This parameter specifies the limitation of
number of items per dash board page. This parameter
is used when other limit than the default is needed.
Default value: 4
Min value: 1
DASHBOARD_PAGE_ITEM_LIMIT
Max value: 9223372036854775807
Introduced in patch: GA
System: false
DATA_HIDING_HIDE_EMPTY_FOLDERS Description: If this parameter is set to Y, the data
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 11/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: Y
Allowed values: Y, N
Introduced in patch: GA
System: false
Description: Server side data hiding mode. (ON - data
hiding is enabled, LEGACY - data hiding is enabled
but certain clients may skip data hiding)
Default value: ON
Introduced in patch: GA
System: false
Description: This parameter will determine time
period of image attachment files' storage on Client
machine. This parameter is used together with
parameter
TOTAL_SIZE_ALLOWED_IMAGE_FILES.
Default value: 30
DAYS_TO_KEEP_IMAGE_FILES Min value: 0
Introduced in patch: GA
System: false
Description: per each project, or for the whole domain
set if the special closure log is enabled.
Introduced in patch: GA
System: false
DENY_EXTERNAL_IMAGES Description: If this parameter is set to "Y", images
from external resources (images that are not
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 12/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: N
Introduced in patch: GA
System: false
Description: This flag affects customization loading
by OTA Valid values: N - load customization
asynchronously, Y - load customization synchronously.
Default value: N
DISABLE_ASYNC_CUSTOMIZATION_LOAD
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: If this parameter is set to "Y", user is not
allowed to clear history via UI or API call; If this
parameter is set to "N" (by default), user can clear
history via UI or API call.
Default value: N
Introduced in patch: GA
System: false
DISABLE_COMMAND_INTERFACE Description: If this parameter is set to Y (default),
only users belonging to the TDAdmin group can use
the OTA Command object. If it is set to N, any user
can use it. If it is set to ALL, no users can use it. For
more information, refer to the Micro Focus ALM
Open Test Architecture API Reference.
Default value: Y
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 13/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: Enables/disables access to the QC debug
console. The console, when enabled, is accessible
using http://<qcserver>/qcbin/tdservlet?
method=debuginfo URI or
http://<qcserver>/qcbin/debug.
DISABLE_CONSOLE_DEBUG_INFO Default value: Y
Introduced in patch: 1
System: false
Description: If this parameter is set to Y, default
values for certain entities (such as defects, tests, and
test configurations) cannot be set per user per project.
Default value: N
DISABLE_DEFAULT_VALUES
Introduced in release: ALM 11.00
Introduced in patch: GA
System: false
DISABLE_EXTENDED_STORAGE Description: This parameter controls user access to
the OTA ExtendedStorage object. This is a security
feature that can be used to limit access to the file
system of the project. If this parameter is set to Y
(default), the ExtendedStorage object cannot be
accessed from TDConnection. Users can access the
object from a specific entity for read-only, but no
changes can be made. If it is set to N, the
ExtendedStorage object can be accessed by all users,
from a specific entity or from TDConnection. For
more information about the ExtendedStorage object,
refer to the Micro Focus ALM Open Test Architecture
API Reference. Note: This parameter can impact how
certain add-ins run, such as the Micro Focus Screen
Recorder. For details, see the documentation for the
individual add-ins, available from the Micro Focus
Application Lifecycle Management Add-ins page
(Help > Add-ins) or the Micro Focus Application
Lifecycle Management Tools page (Help > Tools).
Default value: Y
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 14/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: If this parameter is set to Y, this
parameter disables certain performance enhancements
that improve the speed at which various modules
display data (such as entity trees). This parameter is
relevant for version controlled projects. The default is
N.
DISABLE_GET_CHILDREN_LISTS_WITH_VERSI
ONING Default value: N
Introduced in patch: 5
System: false
Description: By default, the data transferred from the
ALM server to clients is compressed to improve
performance. If this parameter exists and is set to Y,
the data compression is disabled.
Introduced in patch: GA
System: false
Description: By default, the OTA
TDConnection.Password property is encrypted. If this
parameter exists and is set to Y, encryption for this
property is disabled. Note: Setting this parameter has
no effect on password encryption during transport to
the server machine.
DISABLE_PASSWORD_OTA_ENCRYPTION
Default value: N
Introduced in patch: GA
System: false
Description: It controls whether or not to disable
using default web browser for shared login. If it's set to
N, your default web browser is used for shared login.
If it's set to Y, the embedded web browser is used for
shared login. The default value is N.
DISABLE_SLM_WITH_DEFAULT_WEBBROWSE
R Default value: N
Introduced in patch: GA
System: false
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 15/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: Y
Introduced in patch: GA
System: true
Description: This parameter enables you to add
additional security to the client ALM Login window.
By default, ALM displays the last user login
information (user name, domain and project). If this
parameter is set to N, the last user login information is
not saved on the client machine and is not displayed in
the ALM Login window. To activate this parameter,
you must log in to ALM, log out, and log in again. If
DISPLAY_LAST_USER_INFO this parameter is set to Y or does not exist, the last user
information is displayed.
Default value: Y
Introduced in patch: GA
System: false
Description: This parameter determines whether
attachments are downloaded automatically in REST. If
the value is Y, attachments are downloaded only after
the browser prompts the user to open or save the
attachment. If the value is N, the browser downloads
the attachment automatically
DOWNLOAD_REST_ATTACHMENTS
Default value: Y
Introduced in patch: GA
System: false
DS_MEMO_FIELD_AUTO_DOWNLOAD_IMAGE Description: This parameter is to allow automatically
S download embedded pictures in memo fields of
Design Steps.
Default value: N
Introduced in patch: 1
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 16/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: true
Description: This site parameter is only for archive, it
determines whether to enable checksum when
exporting/importing. The default value of the
parameter is 'N' and it means that the checksum will
not be enabled.
ENABLE_ARCHIVE_CHECKSUM Default value: N
Introduced in patch: GA
System: false
Description: Enabling or disabling audit ALM events
System: true
Description: The default value is N, which enables the
new graph view. If this parameter is set to Y, user can
use classic graph view.
Default value: N
Introduced in patch: GA
System: false
Description: If this parameter is set to "Y" then
column visibility changes made via workflow will
affect trees/grids and column selection (will cause the
relevant fields to be hidden).
Introduced in patch: 13
System: false
ENABLE_CREATE_DOCGEN Description: Enables/Disables the 'Document
Generator' menu item in Tools.
Default value: N
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 17/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This parameter defines whether new
project documents can be added to your favorites list.
The available options are: Y. Project documents can be
added to the favorites list. N. Project documents
cannot be added to the favorites list. By default, the
parameter is set to N.
ENABLE_CREATE_DOCGEN_FAVORITE
Default value: N
Introduced in patch: GA
System: false
Description: Determines whether legacy Excel
Reports should be included in the 'New Analysis Item'
menu.
Default value: N
ENABLE_CREATE_LEGACY_EXCEL_REPORT
Introduced in release: ALM 11.50
Introduced in patch: GA
System: false
Description: Determines whether Standard Reports
should be included in the 'New Analysis Item' menu.
Default value: N
ENABLE_CREATE_STANDARD_REPORT
Introduced in release: ALM 11.50
Introduced in patch: GA
System: false
Description: This parameter enables a simplified
approach of authentication for automated clients.
Default value: Y
ENABLE_CSE_V1
Introduced in release: ALM 15.00
Introduced in patch: GA
System: true
ENABLE_ENTITY_SELECTION_TREE_REQ_MO Description: Determines whether the "MoveTo" work
VE_TO flow event will be thrown by the requirement entity
selection tree
Default value: N
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 18/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: 10
System: true
Description: By default JMX-console is disabled. For
debugging purposes, it could be enabled by setting this
site param to the value 'Y'
Default value: N
ENABLE_JMX_CONSOLE
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: Y/N value for enable or disable the
REST Output Sanitization. Default value is Y.
Default value: Y
ENABLE_OUTPUT_SANITIZATION
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: If this parameter is set to Y, user can use
quick field search feature. Default value is Y, which
enables the quick field search feature.
Default value: Y
ENABLE_QUICK_FIELD_SEARCH
Introduced in release: 12.5
Introduced in patch: GA
System: false
Description: This parameter enables/disables
validation for read-only entity fields via REST. The
default value of the parameter is 'N' and it means that
validation is off and all entity fields which have
SF_IS_EDIT=Y are editable via REST.
Introduced in patch: GA
System: false
ENABLE_TEAMS_INTEGRATION Description: The parameter is to enable or disable
teams integration, default is 'N'.
Default value: N
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 19/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This site param enables / disables the
XSRF token validation sent from client on request.
Possible values: Y / N. When this site param is set to
''N'', the entire site is exposed to security risk. Default
value: Y.
ENABLE_XSRF_VALIDATION Default value: Y
Introduced in patch: GA
System: false
Description: The value of this parameter must be an
integer and bigger than 0 otherwise it will be ignored.
Its default value is 800.
Introduced in patch: GA
System: false
Description: Set the hostname that ALM server uses
to generate user-oriented URL when necessary. You
are recommended to use this hostname when load
balancer/reverse proxy is used in front of the ALM
server.
ENTITY_LINK_HOST
Introduced in release: QC 10.00
Introduced in patch: GA
System: false
Description: Set the port that ALM server uses to
generate user-oriented URL when necessary. You are
recommended to use this port when load
balancer/reverse proxy is used in front of the ALM
server.
ENTITY_LINK_PORT
Introduced in release: QC 10.00
Introduced in patch: GA
System: false
ENTITY_LINK_SCHEMA Description: Set the schema that ALM server uses to
generate user-oriented URL when necessary. You are
recommended to use this schema when load
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 20/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: Sets DB tables that will be checked by
the verifier, to find the potential permission
inconsistencies, which will be later fixed by the
repairer. The permission inconsistencies means that for
an entity, a specific user group has the permission
(SF_GRANT_MODIFY) to modify some fields of it,
but doesn't have the permission
ENTITY_TABLE_NAMES_FOR_FIXING_UPDATE (TB_GRANT_MODIFY) to modify the entity itself.
_PERMISSIONS_INCONSISTENCY
Default value:
Introduced in patch: 14
System: false
Description: The time interval in days that deletable
events remain in the EVENT_LOG database table. By
default, the value is set to 60. If you set the value to -1,
the events period is unlimited.
Default value: 60
Introduced in patch: GA
System: true
Description: This parameter specifies a user group
name, only the users who is in this group have
permission to access the Excel add-in.
Default value:
EXCEL_ADDIN_GROUP
Introduced in release: 12.2
Introduced in patch: GA
System: false
EXTENDED_MEMO_FIELDS Description: This parameter extends the maximum
number of memo-type user-defined fields per entity to
15 instead of five. The default value is N. To extend
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 21/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: N
Introduced in patch: 24
System: false
Description: This parameter sets the mapping
relations between extensions and file mime types. The
format is
extention=mimetype1,mimetype2,....;extention2=mime
type1,mimetype2,....; When
VALIDATE_MIME_TYPE_MATCH_TO_EXTENSI
ON is enabled, if a correct mapping can be detected
during parsing attachments, the attachment will be
uploaded or it will be rejected. Note if you only put
extension here without the value part(mimes and the
'='), it means any file with the extension will be
uploaded without checking its content. If you want to
EXTENSION_TO_MIME_TYPE upload file with no extension, you should set the value
of FILE_EXTENSION_WHITE_LIST_UPLOAD to
'*'.
Default value:
Introduced in patch: GA
System: true
Description: External Authentication: a path to a file,
where all the allowed client certificates are listed
Introduced in patch: GA
System: false
Description: External Authentication: Y/N whether to
enable the certificate CRL verification
Default value: Y
EXTERNAL_AUTH_CERTIFICATE_CRL_CHECK
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 22/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: External Authentication: Y/N whether to
verify certificate date
Default value: Y
EXTERNAL_AUTH_CERTIFICATE_DATE_CHEC
K Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: External Authentication: Y/N whether to
enable the certificate revocation check
Default value: Y
EXTERNAL_AUTH_CERTIFICATE_LOCAL_CRL_
CHECK Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: Specifies whether the server will perform
a client certificate status check using the "Online
Certificate Status Protocol" (OCSP). The
EXTERNAL_AUTH_CERTIFICATES_FILE has to
be defined as a file with allowed client certificates
issuers; otherwise, all certificates will be rejected.
EXTERNAL_AUTH_CERTIFICATE_OCSP_CHEC
K Default value: N
Introduced in patch: GA
System: false
EXTERNAL_AUTH_CERTIFICATE_OCSP_REQUI Description: Specifies whether the client certificate
RED must contain "Authority Info Access extensions" to
perform an online certificate status check (OCSP).
This extension is required only if OCSP check is
enabled. See the
EXTERNAL_AUTH_CERTIFICATE_OCSP_CHEC
K documentation for details.
Default value: Y
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 23/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: External Authentication: Y/N whether to
enable the certificate policy verification
Default value: Y
EXTERNAL_AUTH_CERTIFICATE_POLICY_CHE
CK Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: External Authentication: stores the
certificate's valid policy
System: false
Description: External Authentication: header that
holds the certificate
Introduced in patch: GA
System: false
Description: External Authentication: header that
holds the execution mode of client. Values are enum
ExecutionMode: NOT_SPECIFIED(default),
INTERACTIVE, NON_INTERACTIVE
EXTERNAL_AUTH_EXECUTION_MODE_HEADE Default value: EXECUTION_MODE
R_NAME
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: External Authentication: stores the
extended hardware keys
System: false
EXTERNAL_AUTH_HARDWARE_CARD_IS_REQ Description: External Authentication: Y/N whether
UIRED hardware card verification is required
Default value: Y
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 24/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: External Authentication: header that
holds the subject of certificate
Introduced in patch: GA
System: false
Description: External Authentication: Y/N whether a
policy is required
Default value: N
EXTERNAL_AUTH_IS_POLICY_REQUIRED
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: External Authentication: Y/N whether to
enable the match delta CRL by issuer verification
Default value: Y
EXTERNAL_AUTH_MATCH_DELTACRL_BY_ISS
UER Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: External Authentication: Which external
authentication to use. Possible values are: N - do not
use external authentication, Y - use external
authentication
Introduced in patch: GA
System: true
EXTERNAL_AUTH_USER_FIELD_PATTERN Description: External Authentication: regex to find
the username, email
Introduced in patch: GA
System: false
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 25/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: External Authentication: LDAP attribute
to validate user
Introduced in patch: 2
System: false
Description: External Authentication: LDAP attribute
value indicate the user is active in ALM
System: false
Description: External Authentication: Y/N whether to
contact LDAP server (if exists) to make sure that this
user still active or not
Default value: N
EXTERN_AUTH_VALIDATE_USER_IN_LDAP
Introduced in release: ALM 12.00
Introduced in patch: GA
System: false
Description: Controls the Session Reconnect mode: 0
- Session Reconnect is disabled, Only Logout button is
enabled when Session Reconnect dialog appears, 100 -
Session Reconnect is enabled, password is required.
200 - Session reconnect is enabled, no password is
required.
Introduced in patch: GA
System: true
FAVORITES_DEPTH Description: Defines the number of most recently
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 26/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: 4
Min value: 0
Introduced in patch: 1
System: false
Description: To optimize performance, the maximum
number of records retrieved and displayed in ALM
grids is limited. This parameter enables you to change
the default limit. If this parameter does not exist, the
maximum number of records displayed is limited to
500. If the value of this parameter is set to 0, all results
are displayed.
Introduced in patch: 1
System: false
Description: The value is the semicolon delimited
string with the file extensions that are not allowed to
be downloaded via open attachments, REST API, or
FTP Explorer. Note: *Imported or restored projects are
not blocked even if their repository contains files of
blocked file types. * Projects upgraded from previous
versions still contain files of blocked file types that
FILE_EXTENSION_BLACK_LIST_DOWNLOAD already exist in the repository. * During optimized
repository migration, files of blocked file types are not
blocked.
Introduced in patch: GA
System: false
FILE_EXTENSION_BLACK_LIST_UPLOAD Description: The value is the semicolon delimited
string with the file extensions that are not allowed to
be uploaded via open attachments, extended storage,
REST API, or FTP Explorer. Note: * Imported or
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 27/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description:
siteparams.FORCE_DH_FOR_QTP.description
Default value: N
Introduced in patch: 19
System: false
Description: If this parameter is set to Y, only the
login process is sent over SSL (HTTPS). All other
communication is sent without SSL (using HTTP).
Note: ALM must be configured to work with SSL.
Introduced in patch: GA
System: false
Description: If this parameter is set to Y, you can
deploy a server to its own folder on the client.
Default value: N
FORCE_SEPARATE_CLIENT_DEPLOYMENT
Introduced in release: ALM 12.50
Introduced in patch: GA
System: false
FROM_EMAIL_ADDRESS Description: If a user clicks the Forgot Password link
in the ALM Login window, an email notification is
sent to the user with a link to specify a new password.
This parameter enables you to change the email
address in the email From field.
Introduced in patch: GA
System: false
Description: The port number of the FTP service that
enables you to browse ALM project repositories. For
more information, see Browsing the Project
Repository. Recommended values are 21 or 2121.
Note: Defining the parameter starts the FTP service on
the specified port. Reconfiguring the parameter restarts
the FTP service. Deleting the parameter stops the FTP
service.
FTP_PORT
Min value: 1
Introduced in patch: 1
System: false
Description: This parameter enables you to get
coverage from the baseline (and not from current
view) when selecting tests for a requirement to be
added to a pinned test set. The default value is N.
System: false
Description: The number of minutes a cached graph
result is valid.
Min value: 5
Introduced in patch: GA
System: false
GROUP_FETCH_LIMIT Description: To optimize performance, the maximum
number of records retrieved and displayed per group
when a group by filter is applied to ALM grids is
limited. This parameter enables you to change the
default limit. If this parameter does not exist, the
maximum number of records displayed per group is
limited to 100. If the value of this parameter is set to 0,
all results are displayed for each group.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 29/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 0
Introduced in patch: 1
System: false
Description: The default value is N, which displays
the email address in Send By Email dialogs. If this
parameter is set to Y, the email address will be hidden
in Send By Email dialogs.
Introduced in patch: 2
System: false
Description: If this parameter is set to Y, then we will
hide the Execution Flow view for Test Sets. It's default
value is N.
Default value: N
HIDE_EXECUTION_FLOW_VIEW
Introduced in release: ALM 11.00
Introduced in patch: 18
System: false
Description: If this parameter is set to Y, then we will
hide the Flat View for Test Folders. It's default value is
N.
Default value: N
HIDE_TEST_BOARD_VIEW
Introduced in release: ALM 12.55
Introduced in patch: GA
System: false
HOMEPAGE_ENABLED Description: This parameter is used to control
whether or not the homepage is automatically
displayed after users log into an ALM project. If the
parameter is set to 'Y', the homepage is automatically
displayed after users login. If the parameter is set to
'N', the homepage is not displayed. The default value is
'Y'.
Default value: Y
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 30/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: There are modules that have logically
connected views in other modules, for example - BPM
module and Business linkage views in Requirements
and Test plan. Project manager may hide access to
modules for some users/groups. This parameter
indicate whether such logically -connected views
should hidden if their "parent" modules also invisible.
INHERIT_MODULE_ACCESS_TO_VIEWS This parameter affect only "BPM" views.
Default value: N
Introduced in patch: 5
System: false
Description: Controls Input Validation framework
mode and has 3 possible values: OFF - no validation
LOG - perform hidden validation (never throw
exceptions but log all the found errors) ON - full
validation (default value)
Default value: ON
INPUT_VALIDATION_MODE Allowed values: ON, OFF, LOG
Introduced in patch: GA
System: false
Description: The interval between invalid logins. It's
used by the user lockout service.
Min value: 1
INTERVAL_BETWEEN_INVALID_LOGINS_TO_L
OCKOUT Max value: 9223372036854775807
Introduced in patch: 01
System: true
INTERVAL_TO_AUTO_RELEASE_LOCKOUT Description: The Number of minutes before
automatically releasing a locked user.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 31/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
Introduced in patch: 01
System: true
Description: Enables you to define the maximum
number of connections to the database allowed for
LAB_PROJECT. By default, the value is set to 100.
Min value: 1
LAB_MAX_DB_HANDLERS
Max value: 9223372036854775807
Introduced in patch: GA
System: false
Description: This parameter enables you to define a
regular expression that can be used to distinguish
between different values for an LDAP attribute when
importing users from an LDAP directory. When
importing users, ALM chooses a value for the attribute
that matches the regular expression. The parameter
should be of the format: <LDAP attribute name> =
<regular expression>, where <LDAP attribute name>
is the name of the LDAP attribute whose value you
want to choose, and <regular expression> is a regular
expression. This regular expression should conform to
LDAP_IMPORT_ATTRIBUTE_MASK the standard Java syntax for regular expressions. For
example, a parameter value uid=^Dw+$ would choose
values for the LDAP attribute uid consisting of a non-
digit followed by any number of word characters
(letters, numerals or the underscore character).
Default value:
Introduced in patch: GA
System: false
LIBRARY_FUSE Description: This parameter indicates max library size
to handle it without performance hit on the customer..
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 32/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: The period in days to purge old sessions
records from SESSION_HISTORY table
Min value: -1
LICENSE_ARCHIVE_PERIOD
Max value: 9223372036854775807
Introduced in patch: GA
System: true
Description: The maximum number of hours that
ALM objects can remain locked. After this time, the
lock is removed. By default, the value is set to 10
hours.
Default value: 10
Introduced in patch: GA
System: true
Description: If the FORCE_LOGIN_SSL_MODE
parameter exists and is set to Y, this parameter enables
you to configure the port used for SSL login. By
default, the value is 443.
Introduced in patch: GA
System: false
MAIL_CONTENT_CLASSIFICATION Description: Specify the content you want to insert
into the beginning of the email body. E.g. classification
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 33/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value:
Introduced in patch: 2
System: false
Description: Specify the content you want to insert
into the end of the email body. E.g. classification to
comply mandatory security policy. This parameter can
be set at the project and site level. If you want to insert
the sender's username and email, use "
<sender_name>" and "<sender_mail>". The default
value is blank.
MAIL_FOOTER_CLASSIFICATION
Default value:
Introduced in patch: 2
System: false
Description: The format ALM uses to send email. By
default, the format is set to HTML. To instruct ALM to
send email as plain text, change the value to Text.
Introduced in patch: GA
System: true
MAIL_HEADERS_CLASSIFICATION Description: Specify the content you want to insert
into the email headers. E.g. classification to comply
mandatory security policy. The specified headers
should follow the RFC 2822 standards. Use '\r\n' to
separate multiple headers. This parameter can be set at
the project and site level. If you want to insert the
sender's email into the Reply-To header, use "
<sender_mail>". The default value is blank.
Default value:
Introduced in patch: 2
System: false
Description: This parameter show/hide entity details
in mail body
Default value: N
MAIL_HIDE_DETAILS_SECTION
Introduced in release: ALM 11.50
Introduced in patch: GA
System: false
Description: The time interval in minutes for sending
defect email according to your mail configuration
settings. Note that this applies only if you select Send
mail automatically in the Site Projects tab.
Min value: 10
MAIL_INTERVAL
Max value: 9223372036854775807
Introduced in release:
Introduced in patch:
System: false
Description: The character set used by ALM to send
email to users. By default, the value is set to UTF-8.
Introduced in patch: GA
System: true
Description: Displays the mail service used to send
email messages to users. To configure the mail
protocol, use the Settings button.
Introduced in patch: GA
System: false
MAIL_SERVER_HOST Description: Displays the server name used by the
SMTP mail service. To configure the server name, use
the Settings button.
Introduced in patch: 13
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 35/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: The SMTP server port used by ALM to
send mail. By default, the value is set to 25.
Default value: 25
Min value: 1
MAIL_SERVER_PORT
Max value: 65535
Introduced in patch: 13
System: false
Description: Indicates whether the site name is
displayed in the subject of the mail. This parameter
can be either a project parameter or a site parameter. If
the parameter is defined in both site and project tables,
the project value is considered. The default value is N.
MAIL_SHOW_SITE_NAME Default value: N
Introduced in patch: 2
System: false
Description: The SMTP server socket connection
timeout. By default, the value is set to 5 minutes.
Introduced in patch: 2
System: false
MAIL_SOCKET_READ_TIMEOUT Description: The SMTP server socket read timeout.
By default, the value is set to 1 minute.
Introduced in patch: 2
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 36/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: The SMTP server socket write timeout.
By default, the value is set to 5 minutes.
Introduced in patch: 2
System: false
Description: Specify the content you want to insert
into the end of the email subject. E.g. classification to
comply mandatory security policy. This parameter can
be set at the project and site level. If you want to insert
the sender's username and email, use "
<sender_name>" and "<sender_mail>". The default
value is blank.
MAIL_SUBJECT_CLASSIFICATION
Default value:
Introduced in patch: 2
System: false
Description: This parameter defines the maximum
number of project reports that can be generated
concurrently. Define any value where the minimum is
1. Where the maximum number has been reached, and
you choose to generate an additional report, the report
generation only begins once one of the original reports
finishes generating. For example, if the maximum
number is 5, and you try generate an additional report,
the sixth report only begins generating once one of the
original five concludes generating. The default
MAX_CONCURRENT_REPORTS maximum is 3.
Min value: 1
Introduced in patch: GA
System: false
MAX_GRAPH_RESULT_DATA_TABLE_VOLUME Description: This parameter enables you to change
the maximum size of the graph results, as calculated
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 37/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
Introduced in patch: GA
System: false
Description: The number of max permitted invalid
login attempts. It's used by the user lockout service.
Min value: 0
Introduced in patch: 01
System: true
Description: The number of KPIs allowed under a
single milestone.
Default value: 30
Min value: 1
MAX_KPIS_PER_MILESTONE
Max value: 9223372036854775807
Introduced in patch: GA
System: false
Description: The number of Milestones allowed under
the same Release. The default Value is 20. we limit the
number of Milestones under the same release due to
performance considerations.
Default value: 20
Introduced in patch: GA
System: false
MAX_PROJECTS_IN_EXCEL_REPORT Description: The maximum number of projects that
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 38/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
System: false
Description: This parameter enables you to change
the maximum query length (number of letters). It
includes the parameters and is valid for Oracle and for
SQL. The default value is 1000000. Some reports are
too large for the default limit query size to handle. In
such cases, this parameter should be set to 100000000.
Introduced in patch: GA
System: false
Description: The number of Scope items allowed
under the same Release. The default Value is 20. we
limit the number of Scope Items under the same
release due to performance considerations.
Default value: 20
Introduced in patch: GA
System: false
MAX_STEPS_IN_PROJECT Description: This is a fuse that limits the max steps
can be fetched in each request, just to protect the
server from OutOfMemoryError.
Min value: 1
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 39/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: 9
System: false
Description: The maximum number of tests in test set
in order to perform copy-paste or delete test set
operations
Min value: 1
Introduced in patch: 06
System: false
Description: The maximum number of test instances
that server will handle per call, if there is a call with
more test instances than this value, an exception will
be threw causing this operation to fail.
Min value: 1
MAX_TEST_INSTANCES
Max value: 9223372036854775807
Introduced in patch: 12
System: false
Description: The number of different threshold values
allowed under a single KPI.
Default value: 12
Min value: 1
MAX_THRESHOLD_VALUES_PER_KPI
Max value: 9223372036854775807
Introduced in patch: GA
System: false
MEMO_FIELD_ADD_IMAGE_MODE Description: This parameter is to control users' ability
to add images into memo fields. The optoins are: Y -
Users are allowed to add images into memo fields; N -
Users are not allowed to add images into memo fields;
AS_LINK - Users are allowed to add images into
memo fields but only as a link to an image available in
the entity's attachments.
Default value: Y
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 40/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This parameter determines whether
images are downloaded automatically into memo
fields. If the value is "Y", ALM downloads the images
automatically. If the value is "N", images are
downloaded only after clicking the Download Images
button inside the memo fields. To disable automatic
download for a single client, click the "Download
MEMO_FIELD_AUTO_DOWNLOAD_IMAGES images on demand" option from the Tools menu.
Default value: N
Introduced in patch: GA
System: false
Description: This is a fuse that will not set the server
status to MUTED when the server is
OutOfMemoryError.
Default value: Y
Introduced in patch: 19
System: false
NLS_SEARCH_LOCALE Description: The language used by the Find Similar
Defects command to tokenize the defect summary.
This parameter is needed only if the default locale on
the server does not match the language in which the
defect summary is written, in terms of whether spaces
are used to separate words. The value should be a
string value that matches a language code listed in ISO
639 (http://www.w3.org/WAI/ER/IG/ert/iso639.htm).
If this parameter is not defined or is invalid, the default
locale of the server is used.
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 41/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: This parameter is to enable the
integration between ALM and ALM Octane. If this
parameter is set to "Y", ALM will push the run results
to ALM Octane. By default this parameter is set to
"N".
OCTANE_INTEGRATION_ENABLED Default value: N
Introduced in patch: GA
System: true
Description: This parameter defines Octane
Integration Job interval. The interval is in minutes. The
minimum value is 10.
Default value: 30
Min value: 10
OCTANE_INTEGRATION_JOB_INTERVAL
Max value: 9223372036854775807
Introduced in patch: GA
System: true
Description: This parameter must be set to Y to
enable RAC support on Oracle database servers. For
more information, refer to the Micro Focus
Application Lifecycle Management Installation and
Upgrade Guide.
ORACLE_RAC_SUPPORT Default value: N
Introduced in patch: GA
System: false
ORPHAN_ANALYSIS_DATA_FILE_INACTIVE_PE Description: This parameter is related to the "Orphan
RIOD Analysis Data File Cleanup Job" scheduled job. It
defines a period in miliseconds. The job deletes data
files older than this period, comparing to current time.
The default value is one day (86400000 ms), and the
minimum value is one hour (3600000 ms).
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 42/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: If set to N, it behaves like before, and
default would be N.
Default value: N
OTA_ACCESS_APIKEY_ONLY
Introduced in release: ALM 12.60
Introduced in patch: GA
System: false
Description: Configures output sanitization on/off by
client type. Format: <client type name>=true/false;
<client type name>=true/false; Default value for any
client type that is not defined specifically in this site
param is true.
Default value:
OUTPUT_SANITIZATION_BY_CLIENT_TYPE
Allowed patterns: ^([^;=]+=[^;=]+;?)+$
Introduced in patch: GA
System: false
Description: This parameter determines whether
ALM users can reset their passwords using the Forgot
Password link in the ALM Login window. If this
parameter is not defined or if the parameter is set to
'N', users can reset their passwords using the Forgot
Password link. If LDAP or External authentication is
enabled, the Forgot Password link is not shown.
PASSWORD_RESET_DISABLE
Default value: N
Introduced in patch: GA
System: false
PASSWORD_RESET_ELAPSED_TIME Description: Defines the minimum time in minutes
user should wait before he will get new Forgot
Password e-mail. Default is 5 minutes.
Default value: 5
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 43/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: If a user clicks the Forgot Password link
in the ALM Login window, an email notification is
sent to the user with a link to specify a new password.
This parameter allows you to override the default
URL, or parts of the URL, that is embedded in the
reset link. Use one of the following syntaxes:
<server>:<port>. Overrides both the default server and
PASSWORD_RESET_SERVER port. <server>. Overrides the default server. <port>.
Overrides the default port.
Introduced in patch: GA
System: false
Description: Defines the maximum time in hours that
the link in the Forgot Password e-mail is valid. Default
is 24 hours.
Default value: 24
Min value: 0
PASSWORD_RESET_VALID_PERIOD
Max value: 9223372036854775807
Introduced in patch: GA
System: false
Description: enable/disable using route table to
calculate coverage
Default value: 60
Min value: 1
PPT_KPI_FAILURES_PERCENTAGE_PER_RELEA
SE_FUSE Max value: 9223372036854775807
Introduced in patch: GA
System: false
PPT_RECENTLY_USED_PROJECTS_THRESHOL Description: Rename of
D_MINUTES QPM_RECENTLY_USED_PROJECTS_THRESHOL
D_MINUTES. 7 days (in minutes) of the recently used
projects threshold. Used by the PP&T planning
algorithm.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 44/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
Introduced in patch: GA
System: false
Description: Specifies the number of days to subtract
from the ending time frame of which to record QC
Sense information into the file as part of Assessment
collection flow. In other words, this defines the starting
time frame.
Introduced in patch: GA
System: false
Description: Specifies the ending time frame of which
to record QC Sense information into the file as part of
Assessment collection flow.
Min value: 0
PRODUCT_ASSESSMENT_QC_SENSE_END_DAT
Max value: 9223372036854775807
E
Introduced in release: ALM 11.51
Introduced in patch: GA
System: false
PRODUCT_ASSESSMENT_QC_SENSE_GROUPIN Description: Specifies the segments by which to
G_SEGMENTS group the collected QC sense information in the time
frame that was defined by
PRODUCT_ASSESSMENT_QC_SENSE_DAYS_BA
CK and
PRODUCT_ASSESSMENT_QC_SENSE_END_DAT
E as part of Assessment collection flow.
Default value:
00:00:00,05:59:59,06:00:00,11:59:59,12:00:00,17:59:5
9,18:00:00,23:59:59
Introduced in patch: GA
System: false
Description: Maximum number of projects that ALM
allows you to include in a graph. Default is 6.
Default value: 6
Min value: 1
PROJECT_SELECTION_MAX_PROJECTS
Max value: 9223372036854775807
Introduced in patch: GA
System: false
Description:
siteparams.QC_SENSE_AUTHORIZATION_DISAB
LED.description
Default value: N
QC_SENSE_AUTHORIZATION_DISABLED
Introduced in release: ALM 11.50
Introduced in patch: GA
System: false
Description: By default, only site administrator users
have access to QC Sense reports. This parameter
enables you to grant permissions to additional users
who are not site administrators. Enter user names
using the following syntax: <user1>;<user2>;<user3>
QC_SENSE_REPORTS_USERS
Introduced in release: ALM 11.50
Introduced in patch: GA
System: false
Description: This parameter changes the order of
events raised when the user enters the TestSet module.
Default value: N
RAISE_TESTSET_MOVETO_EVENT_AFTER_EN
TER_MODULE Introduced in release: ALM 11.50
Introduced in patch: GA
System: false
REPLACE_TITLE Description: This parameter enables you to change
the names of ALM modules across all your projects.
Rename one or more modules by entering the
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 46/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: Limits the total size of all reports being
generated concurrently. The size is counted by pages.
When the limit is exceeded, generation of the largest
report is discontinued and it is saved as is, i.e., it will
include whatever data has been generated up to that
point.
REPORT_MAX_ALLOWED_CONCURRENT_REN Min value: 0
DERED_PAGES
Max value: 9223372036854775807
Introduced in patch: GA
System: false
Description: This parameter defines the estimated
maximum number of pages that can be included in a
project report. when the value is set to -1 the size is
unlimited, which is strongly unrecommended.The
minimum page value should 1.
Min value: -1
REPORT_MAX_ALLOWED_SIZE
Max value: 9223372036854775807
Introduced in release:
com.hp.alm.platform.Version.ALM_115_NAME
Introduced in patch: GA
System: false
REPORT_QUERY_RECORDS_LIMIT Description: The maximum number of records that
can be retrieved from the database for an Excel report.
If you set the value to -1, the number is unlimited.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 47/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: -1
Introduced in patch: GA
System: true
Description: The maximum length of time in seconds
that ALM waits for an SQL query for an Excel report
to be executed. If the query takes longer than this time
to be executed, the query is canceled.
Default value: 60
Introduced in patch: GA
System: true
Description: The number of minutes a cached project
report result is valid.
Min value: 1
Introduced in patch: GA
System: false
REPOSITORY_GC_DELAY_CANDIDATE_TIME Description: This parameter enables you to create a
delay between the time of the cleaning processes of
each project repository and the time the files without
references are actually deleted. Set a value in days
between 0 and 28. If the parameter does not exist,
ALM delays the deletion of obsolete files in the file
system for seven days. For details on the project
repository cleanup process, see Project Repository
Cleanup. Default is 7 days.
Default value: 7
Min value: 0
Max value: 28
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 48/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: 3
System: false
Description: The parameter determines the speed at
which the repository cleanup process is performed. Set
a value between 0 (fastest) and 10 (slowest). If the
parameter does not exist, the speed is set to 3. For
more details on the project repository cleanup process,
see Project Repository Cleanup.
Default value: 3
REPOSITORY_GC_JOB_PRIORITY
Min value: 0
Max value: 10
Introduced in patch: 3
System: false
Description: This parameter defines the time interval
in days between cleaning processes of each project
repository. Set a value in days between 1 and 28. If the
parameter does not exist, ALM scans project
repositories once every seven days. For more details
on the project repository cleanup process, see Project
Repository Cleanup.
Max value: 28
Introduced in patch: 3
System: false
REPOSITORY_MIGRATION_JOB_PRIORITY Description: The parameter determines the speed at
which files are copied from the old to the new project
repository. Set a value between 0 (fastest) and 10
(slowest). If the parameter does not exist, the speed is
set to 3. For more details on the project repository
migration process,see Migrating the Repository.
Default value: 3
Min value: 0
Max value: 10
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 49/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This parameter indicates max
requirements amount in library to handle it without
performance hit on the customer.
Min value: 1
Introduced in patch:
System: false
Description: This parameter indicates whether rich
text field will be used in author mode in web client.
Default value: N
REQUIREMENT_AUTHOR_USE_RICHTEXT
Introduced in release: ALM 12.00
Introduced in patch: GA
System: true
Description: If this parameter is set to Y (default),
then any change to a requirement field automatically
sets the Reviewed (RQ_REQ_REVIEWED) field to
Not Reviewed. If it is set to N, then a change to a
requirement field does not affect the value of the
REQUIREMENT_REVIEWED_FIELD_AUTOMATI Reviewed field.
C_UPDATE
Introduced in release: ALM 11.00
Introduced in patch: GA
System: false
Description: If set to Y, then only Micro Focus
internal tools and applications in a white list can login
with username + password by below Login Resources.
Default value: N
RESTAPI_ACCESS_APIKEY_ONLY
Introduced in release: ALM 12.60
Introduced in patch: GA
System: false
RESTAPI_WHITELIST_APIKEY Description: This parameter maintain client types
with which customer can use to login.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 50/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value:
Introduced in patch: GA
System: false
Description: This parameter enables you to access
restricted-access SA server directories using the OTA
ExtendedStorage.ServerPath property. If this
parameter is set to NO, you can't access the Site
Administration (SA) directory using the
ExtendedStorage.ServerPath property. If this
parameter is set to ANY, you can access the Site
Administration (SA) directory using the
ExtendedStorage.ServerPath property. If this
parameter is set to ADMIN, you can access the Site
Administration (SA) directory using the
ExtendedStorage.ServerPath property only with ALM
RESTRICT_SA_SERVER_FOLDERS admin users.
Introduced in patch: 2
System: true
RESTRICT_SERVER_FOLDERS Description: This parameter enables you to access
restricted-access server directories using the OTA
ExtendedStorage.ServerPath property. If this
parameter does not exist, or is set to Y, you can only
use the ExtendedStorage.ServerPath property to access
the following directories: * the Site Administration
(SA) directory * the root directory for a project * the
attach subdirectory for a project * the baseline
snapshot of a library at a specific point in time. It
includes all the entities defined in the library and the
relationships between them, such as coverage and
requirements traceability. You can compare baselines
to track changes in a project over time, or use a
baseline to reuse or share the entities in a library.
subdirectory for a project * the checkouts subdirectory
for a project * the components subdirectory for a
project * the hist subdirectory for a project * the
resources subdirectory for a project * the StyleSheets
subdirectory for a project * the tests subdirectory for a
project If this parameter is set to N, you can access all
server directories using the
ExtendedStorage.ServerPath property.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 51/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: Y
Introduced in patch: GA
System: true
Description: The number of entities per page returned
by default with each GET operation on a collection
using the REST API (unless the API consumer
specifies a different page size for retrieval). The
default is 100 entities.
Introduced in patch: GA
System: false
Description: The number of entities to extract
ancestors returned by default with each GET operation
on a collection using the REST API with ancestors-
needed=y query parameter (unless the API consumer
specifies a different page size for retrieval). The
default is 30 entities. If page is bigger remaining
entities will be returned without ancestors.
Max value: 50
Introduced in patch: GA
System: false
REST_API_HTTP_CACHE_ENABLED Description: This parameter enables REST API
support for server side HTTP caching. If enabled, the
server supports caching using an ETag for the
following resources:
customization/entities,customization/relations,customi
zation/used-lists,customization/users. The default is Y.
Default value: Y
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 52/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: The maximum number of entities
allowed for a single bulk operation. A bulk operation
over REST means to be able to POST, PUT, or
DELETE a collection of entities of the same type. The
default is 2000 entities.
Introduced in patch: GA
System: false
Description: REST API provides a tree sub-resource
for hierarchical entities. It retrieves an entity collection
sorted as an expanded tree. REST API uses this
parameter to limits the max collection size that may be
retrieved in a single request. Note that the tree sub-
resource does not support paging, therefore the
REST_API_MAX_PAGE_SIZE parameter is
irrelevant for it. Default is 100 entities. Note: higher
values affect performance.
REST_API_MAX_ENTITY_TREE_SIZE Default value: 100
Min value: 1
Introduced in patch: GA
System: false
Description: REST API supports paging capabilities
for most of the entity collection retrieval. REST API
uses this parameter to limits the max page size that the
consumer may ask. Default is 2000 entities.
Introduced in patch: GA
System: false
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 53/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: 50
Min value: 1
Max value: 50
Introduced in patch: GA
System: false
Description: The number of entities per page returned
by default with each GET operation on a collection
using the REST API (unless the API consumer
specifies a different entities page limit for retrieval).
The default is 100 entities.
Introduced in patch: GA
System: false
Description: REST API supports paging capabilities
for most of the entity collection retrieval. REST API
uses this parameter to limits the amount of entities that
the consumer may request. Default is 2000 entities.
Introduced in patch: GA
System: false
REST_SA_CLIENT_TIMEOUT Description: Specifies timeout for ALM Robot
operations.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 54/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
Introduced in patch: GA
System: true
Description: This parameter sets the REST API
session maximum idle time (in minutes). The idle time
is the amount of time a REST API session token
remains valid if there is no activity in the session.
After this period, the session (including the licenses
and locks that it holds) expire. On the next call, the
REST API recreates a new session. The default value
is 60 minutes.
Min value: 1
Introduced in patch: GA
System: false
Description: This is a fuse that limits the max queries
can be fetched in each request, just to protect the
server from OutOfMemoryError.
Min value: 1
Introduced in patch: 18
System: false
SA_MAX_DB_HANDLERS Description: Maximum number of database
connections for SA schema. Default is 50.
Default value: 50
Min value: 1
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 55/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: This parameter determines if Global
search is Enabled on site and for getting the Search
server URL. If the parameter does not exist then the
Global search is disabled. IF it does then it's value is
the Global Search server name.
SEARCH_SERVER_URL
Introduced in release: ALM 12.50
Introduced in patch: 31
System: false
Description: This parameter holds the sites Global
Search User. Its value is the login name of the
dedicated Global Search user.
Introduced in patch: 31
System: false
Description: When ALM generates email, it includes
a link to ALM in the email. If this parameter is set to
Y, the ALM URL uses an SSL connection (starting
with https:). If it is set to N (default), SSL is not used.
Introduced in patch: GA
System: false
Description: This parameter defines the default email
address for sending an error report in ALM. For
information on a related parameter, see
SEND_EXCEPTION_ENABLED. For more
information on sending error details, see the Micro
Focus Application Lifecycle Management User Guide:
SEND_EXCEPTION_DEFAULT_TO Send Error Details Dialog Box.
Introduced in patch: GA
System: false
SEND_EXCEPTION_ENABLED Description: If this parameter is set to Y, the Send
Error Details option is available on the Help menu in
ALM, enabling you to send details of an error as
attachments to an email. For information on a related
parameter, see SEND_EXCEPTION_DEFAULT_TO.
For more information on sending error details, see the
Micro Focus Application Lifecycle Management User
Guide: Send Error Details Dialog Box.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 56/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: Y
Introduced in patch: GA
System: false
Description: Show/Hide date format in the Comments
panel. If this parameter is set to "N", the format would
not show behind the date in the comments panel. By
default it's enabled.
Introduced in patch: 2
System: false
Description: If this parameter is set to Y (default), you
can track ALM license usage over time from the Site
Analysis tab. If this parameter is set to N, the Site
Analysis tab is unavailable.
Introduced in patch: GA
System: true
Description: This parameter enables you to bypass the
prerequisites check performed in the deployment phase
of starting the ALM client. The default value is N. Tip:
For similar functionality in MSI Generator, check the
Skip Prerequisites Check checkbox.
SKIP_CLIENT_PREREQUISITES_CHECK Default value: N
Introduced in patch: 5
System: false
Description:
siteparams.SKYPE_INTEGRATION_ENABLED.desc
ription
Default value: Y
SKYPE_INTEGRATION_ENABLED
Introduced in release: ALM 12.55
Introduced in patch: GA
System: true
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 57/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: 10
System: false
Description: This parameter enables an SSL tunnel to
the SMTP server. The default value is N.
Default value: N
SMTP_SSL_SUPPORT
Introduced in release: ALM 11.00
Introduced in patch: GA
System: false
Description: By default, ALM checks that SQL
queries for an Excel reports do not include any of the
following commands: INSERT, DELETE, UPDATE,
DROP, CREATE, COMMIT, ROLLBACK, ALTER,
EXEC, EXECUTE, MERGE, GRANT, REVOKE,
SET, INTO, or TRUNCATE. This ensures that you do
not inadvertently modify or delete records in the
project database. You can modify which commands are
on this list by adding this parameter. The parameter's
value must be a comma-separated list of SQL
SQL_QUERY_VALIDATION_BLACK_LIST commands that ALM should verify are not included in
SQL queries for an Excel report. Note that this
verification is not performed if the
SQL_QUERY_VALIDATION_ENABLED parameter
exists and is set to N.
Introduced in patch: GA
System: false
SQL_QUERY_VALIDATION_ENABLED Description: By default, ALM checks SQL queries in
Excel reports to ensure that they are valid and do not
alter the project database. For more information on this
validation, see the Micro Focus Application Lifecycle
Management User Guide: How to Generate an Excel
Report. If this parameter is set to N, this validation is
not performed. If this parameter does not exist, is
empty, or is set to Y, this validation is performed.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 58/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value: Y
Introduced in patch: GA
System: false
Description: Expiration time of the LWSSO token
(the authentication token of the REST API) in minutes.
After this period of inactivity, the REST API consumer
is required to re-authenticate. The default value is 11
minutes.
Default value: 11
SSO_EXPIRATION_TIME Min value: 1
Introduced in patch: GA
System: false
Description: Mark the http cookie which contains
LWSSO token (the authentication token of the REST
API) with the Secure attribute. It is meant to keep
cookie communication limited to encrypted
transmission, directing browsers to use cookies only
via secure/encrypted connections. This makes the
cookie less likely to be exposed to cookie theft via
eavesdropping. Default value is 'N'.
Min value: 1
Introduced in patch: GA
System: false
STATIC_CONTENT_MAX_CACHED_FILE_SIZE Description: The maximum file size in MB that can
be cached in the Jetty static content cache. You can
reduce the cache file size, or cancel the cache by
setting the parameter value to 0. Default value is 2
MB.
Default value: 2
Min value: 0
Max value: 50
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 59/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: If this parameter is set to "Y" (the
default), the testing tool will be closed after test set
execution. This parameter is sent from the Automatic
Runner to the Remote Agent of the testing tool. QTP
requested that it will be on by default so they can close
QTP after test set execution ends.
SUPPORT_TESTSET_END
Default value: Y
Introduced in patch: GA
System: true
Description: This parameter relates to the project
repository cleaning process. For more details, see
Project Repository Cleanup. The parameter stops the
cleanup process on the entire site. Use this only in
special circumstances. For example, to check if the
cleanup process is impacting system performance.
Define this parameter and set its value to Y to
temporarily stop the project repository cleaning
SUSPEND_REPOSITORY_GC process. To restart the cleaning process, set the
parameter to N.
Default value: N
Introduced in patch: GA
System: false
SUSPEND_REPOSITORY_MIGRATION Description: This parameter relates to the project
repository migration process. For more details, see
Configure Migration Priority. The parameter stops the
migration process on the entire site. Use this only in
special circumstances. For example, to back up
projects, or to check if the migration is affecting
system performance. Define this parameter and set its
value to Y to temporarily stop the migration of project
files. To restart the migration, set the parameter to N.
Default is 'N'
Default value: N
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 60/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: The parameter defines the client id of
teams app.
Default value:
TEAMS_APP_CLIENT_ID
Introduced in release: ALM 16.00
Introduced in patch: GA
System: false
Description: The parameter defines the tenant id of
teams app.
Default value:
TEAMS_APP_TENANT_ID
Introduced in release: ALM 16.00
Introduced in patch: GA
System: false
Description: This parameter prevents the upload of
test resources whose size is greater than the integer
value specified for this parameter. The size is in
kilobytes. Note: The default value is 102400.When the
value is set to -1, test resources are uploaded
regardless of size.
Introduced in patch: GA
System: false
TEXT_ENCODING_BY_CLIENT_TYPE Description: Configures text encoding on/off by client
type. Meaning, when output sanitization is on, the
feature can be fine grained to disable only the TEXT
encoding. Format: <client type name>=true/false;
<client type name>=true/false; Default value for any
client type that is not defined specifically in this site
param is false.
Default value:
Introduced in patch: GA
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 61/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
System: false
Description: The length of time, in seconds, that ALM
waits before canceling the operation of enabling and
rebuilding the text search indexes. This operation is
activated by clicking the Enable/Rebuild Text Search
button in the Site Projects tab of the Site
Administration. The default timeout value is 20
minutes (20*60 = 1200 seconds). Setting to -1 also
results in a 20 minutes time out.
Min value: -1
Introduced in patch: GA
System: true
Description: This parameter will determine total size
(in megabytes) of image attachment files stored on
Client machine. This parameter is used together with
parameter DAYS_TO_KEEP_IMAGE_FILES.
Introduced in patch: GA
System: false
Description: If this parameter is set to Y, it enables
direct file access from a testing tool on a Windows
machine to a UNIX based repository. This parameter
applies to Micro Focus LoadRunner.
Introduced in patch: GA
System: false
UPGRADE_EXCEPTION_FILE Description: If you have made changes to a project
database user schema such as the addition of tables or
columns, the verification, repair, or upgrade processes
may fail. You can define an exception file for objects
that are added manually to the database user schema,
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 62/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Introduced in patch: GA
System: false
Description: This parameter prevents the upload of
attachments whose size is greater than the integer
value specified for this parameter. The size is in
kilobytes. Note: This parameter does not affect
uploads of attachments in integration tools. The default
value is -1 (meaning, all attachments are uploaded
regardless of size).
Default value: -1
UPLOAD_ATTACH_MAX_SIZE
Min value: -1
Introduced in patch: GA
System: false
Description: This parameter prevents the upload of
avatars whose size is greater than the integer value
specified for this parameter. The size is in kilobytes.
Note: This parameter does not affect uploads of
avatars in integration tools. The default value is 2000.
Setting it to -1 means all avatars are uploaded
regardless of size.
Introduced in patch: GA
System: false
UPLOAD_MEMO_IMAGE_FILES_MAX_SIZE Description: This parameter prevents the upload of
image attachments (bmp, emf, gif, ico, jpg, png, tif,
wmf) to memos whose size is greater than the integer
value specified for this parameter. The size is in
kilobytes.
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 63/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Min value: 1
Introduced in patch: GA
System: false
Description: Determines if run results should be
uploaded to the server repository. Possible values:
ALWAYS: Always upload the results. NEVER: Never
upload the results. ON_RUN_FAIL: Upload results
only when the status is Failed.
ALWAYS_EXCEPT_RUN_PASSED: Upload results
only when the status is not Passed.
UPLOAD_RESULTS_AFTER_RUN
Default value: ALWAYS
Introduced in patch: GA
System: false
Description: If this parameter is set to Y, all help links
and buttons will open the local Help Center, installed
with your server. If undefined or set to N, all help links
and buttons will open the online Help Center. The
online Help Center includes all the latest updates.
USE_LOCAL_HELP Default value: N
Introduced in patch: 1
System: false
Description:
siteparams.USE_RELATIVE_WIDTH_IN_TABLE.de
scription
Introduced in patch: 07
System: false
VALIDATE_MIME_TYPE_MATCH_TO_EXTENSI Description: Set this parameter to 'Y' to enable file
ON content and file extension validation on
attachments.Default value is 'N'.
Default value: N
Introduced in patch: GA
System: true
Description: This parameter determines where the
verification report is saved when the project
verification process completes. By default, the output
is saved in <ALM repository path>\sa\DomsInfo
\MaintenanceData\out on your ALM server machine.
VERIFY_REPORT_FOLDER
Introduced in release: ALM 11.00
Introduced in patch: GA
System: false
Description: The time interval in minutes that the
ALM client can be inactive before it is disconnected
from the ALM server machine. Disconnecting the
client enables the license to be used by another ALM
user. By default, the value is set to 600 minutes. For
performance reasons, it is recommended to set a value
of at least 60 minutes. If you set the value to -1, ALM
is not disconnected, regardless of how long the client
is inactive.
WAIT_BEFORE_DISCONNECT Default value: 36000000
Min value: -1
Introduced in patch: GA
System: true
Description: The time interval in minutes that the
ALM SA can be inactive before it is disconnected
from the ALM server machine. By default, the value is
set to -1, ALM is not disconnected, regardless of how
long the client is inactive.
Default value: -1
WAIT_BEFORE_DISCONNECT_SA Min value: -1
Introduced in patch: 2
System: false
WORD_ADDIN_GROUP Description: This parameter specifies a user group
name, only the users who is in this group have
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 65/66
4/20/22, 3:43 PM https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm
Default value:
Introduced in patch: GA
System: false
https://admhelp.microfocus.com/alm/api_refs/site_params/metadata.htm 66/66