Site Parameters

28/1/2019 https://admhelp.microfocus.com/alm/en/12.60/api_refs/site_params/metadata.
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
ADD_NEW_USERS_FROM_PROJECT parameter is set to Y, a New button is available
for adding new ALM users.
Default value: Y
Introduced in release: ALM 11.50
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
ALI_MAX_PROJECT_SYNC_JOB Min value: 1
Max value: 100
Introduced in patch: SP2
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
ALI_MIN_PROJECT_SYNC_PERIOD
Min value: 5
Max value: 9223372036854775807
System: true
Description: The interval between checks to
determine if any project requires
synchronization. The default value is 10
minutes.
Default value: 10
ALI_PROJECT_SYNC_DISCOVERY_INTERVAL Min value: 5
Max value: 9223372036854775807
System: true
ALLOW_HTTP_METHOD_OVERRIDE Description: Controls whether to allow REST
https://admhelp.microfocus.com/alm/en/12.60/api_refs/site_params/metadata.htm 1/47
28/1/2019 https://admhelp.microfocus.com/alm/en/12.60/api_refs/site_params/metadata.htm
API requests with X-HTTP-Method-Override

header.
Default value: N
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
ALLOW_MULTIPLE_VALUES is set to "Y", then the Allow Multiple Values
check box is available.
Default value: Y
System: false
Description: User details are set in Site
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,
ALLOW_UPDATE_USER_PROPERTIES_FROM_ the project administrator can then use the
CUSTOMIZATION 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
Introduced in release: QC 10.00
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 -
ASYNC_MAIL_ENABLED send mail asynchronously, N - send mail
synchronously.
Default value: Y
System: false
ATTACH_MAX_SIZE 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.
Default value: 3000
Min value: 1
Max value: 9223372036854775807
System: true
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.
ATTACH_TOTAL_MAX_SIZE Default value: 10000
Min value: 1
Max value: 9223372036854775807
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.
Default value: 10240
AUDIT_LOG_FILE_MAX_SIZE Min value: 1
Max value: 1048576
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
AUTO_LOGOUT_ON_SERVER_DISCONNECT automatically performs logout actions and
returns the user to the 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
System: false
Description: This parameter enables you to

customize the subject line of defect email sent
automatically to users. For example, you can
define a subject line such as Defect no. 4321
has changed by providing the value Defect no. ?
BG_BUG_ID has changed , where Defect no.
AUTO_MAIL_SUBJECT_FORMAT
and has changed are strings, and BG_BUG_ID
is an ALM field name.
System: false
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,
AUTO_MAIL_USER_NOTIFICATION is empty, or is set to Y, then automatic
notification is sent.
Default value: Y
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.
AUTO_MAIL_WITH_ATTACHMENT Default value: Y
System: true
(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
AUTO_MAIL_WITH_HISTORY purposes of backward compatibility.
Default value: Y
System: true
BACKWARD_SUPPORT_ALL_DOMAINS_PROJ Description: This parameter enables the use of
ECTS DomainsList and ProjectsList properties for the
purposes of backward compatibility. If this
parameter is set to Y, then the DomainsList and
ProjectsList properties are supported. If the
parameter does not exist or is empty, the default
value is N, and these properties are not
supported.
Default value: N
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
BASE_REPOSITORY_PATH is set during ALM server configuration. For more
information, refer to the Micro Focus Application
Lifecycle Management Installation and Upgrade
Guide.
System: true
Description:
siteparams.BPT_USE_ORIGINAL_VALUE_TYP
E.description
BPT_USE_ORIGINAL_VALUE_TYPE Default value: N
System: false
Description: Valuing this parameter with ‘Y?
bypasses checking that required fields are
valued before performing an update of multiple
entities.
BULK_ACTION_IGNORE_REQUIRED_FIELD Default value: N
Introduced in patch: 1
System: true
Description: This parameter defines the max
rows of a BV excel report.
Min value: 1
BV_EXCEL_REPORT_MAX_ROWS Max value: 9223372036854775807
System: false
Description: Site param for a list of BV field
names for hide on UI. The list is separated with
semicolon.
BV_FIELDS_HIDE_FIELDS Introduced in release: ALM 12.60
System: false
CLEAN_ORPHAN_ANALYSIS_DATA_JOB_SLE Description: This parameter is related to the
EP_INTERVAL "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).
Min value: 10080
Max value: 9223372036854775807
System: false
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_PASSPHRAS
E in the ALM server requires that the equivalent
value on other servers, such as the PC server
COMMUNICATION_SECURITY_PASSPHRASE 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.
System: true
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
COPY_CHANGES_USER_FIELDS BG_DETECTED_BY. Assume defect 10 is
detected 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.
System: false
CREATE_HTTP_SESSION 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 Lifecycle Management
Installation and Upgrade Guide.
Default value: N
System: true
Description: The parameter is to set the
customized message shown when LDAP login
failed.
CUSTOMIZED_LDAP_LOGIN_FAILED_MESSA
GE Introduced in release: ALM 12.60
System: false
Description: The parameter is to set the
customized message shown when LDAP login
failed.
CUSTOMIZED_LDAP_LOGIN_FAILED_URL Introduced in release: ALM 12.60
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
CUSTOM_HELP_MENU_LINK the value of the parameter to "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.
System: false
CUSTOM_PREREQUISITES_PAGE_URL 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 URL for each prerequisite is
not supported. The page must contain
information for all prerequisites.
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
DASHBOARD_PAGE_ITEM_LIMIT Min value: 1
Max value: 9223372036854775807
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
DATA_HIDING_MODE Allowed values: LEGACYON
Case sensitive: false
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
Max value: 1000
System: false
Description: per each project, or for the whole
domain set if the special closure log is enabled.
DEBUG_CLOSURE_LOG_DOM_PROJ Introduced in release: ALM 11.00
System: false
DENY_EXTERNAL_IMAGES Description: If this parameter is set to "Y",
images from external resources (images that
are not attachments in the project but are
references to resources outside ALM) will be
sanitized and will not be presented by clients.
WARNING: If value is set to “Y?and text field
containing images from external resources ?
those references will be saved as a sanitized
text in the database and not as URLs. Default
value is "N".
Default value: N
System: false
Description: This flag affects customization
loading by OTA Valid values: N - load
customization asynchronously, Y - load
customization synchronously.
DISABLE_ASYNC_CUSTOMIZATION_LOAD Default value: N
System: false
(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.
DISABLE_COMMAND_INTERFACE Default value: Y
Allowed values: YNAllReadOnly
Introduced in release: TD 8.21
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
DISABLE_CONSOLE_DEBUG_INFO http://<qcserver>/qcbin/debug.
Default value: Y
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.
DISABLE_DEFAULT_VALUES Default value: N
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
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
DISABLE_GET_CHILDREN_LISTS_WITH_VER controlled projects. The default is N.
SIONING
Default value: N
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.
DISABLE_HTTP_COMPRESSION
Default value: N
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
DISABLE_PASSWORD_OTA_ENCRYPTION server machine.
Default value: N
System: false
DISABLE_VERBOSE_ERROR_MESSAGES Description: This parameter is a security

feature that controls the level of detail that error
messages display. If the parameter is set to N,
the user can view system details connected to
the error. By default, this parameter is set to Y.
Default value: Y
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
DISPLAY_LAST_USER_INFO log in to ALM, log out, and log in again. If this
parameter is set to Y or does not exist, the last
user information is displayed.
Default value: Y
System: false
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
DOWNLOAD_REST_ATTACHMENTS downloads the attachment automatically
Default value: Y
System: false
Description: This parameter is to allow
automatically download embedded pictures in
memo fields of Design Steps.
DS_MEMO_FIELD_AUTO_DOWNLOAD_IMAG Default value: N
ES Introduced in release: ALM 12.60
System: true
Description: Enabling or disabling audit ALM
events
ENABLE_AUDIT Introduced in release: ALM 12.00
System: true
ENABLE_COLUMN_VISIBILITY_TRACKING 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).
Default value: N
System: false
Description: Enables/Disables the 'Document
Generator' menu item in Tools.
Default value: N
ENABLE_CREATE_DOCGEN Introduced in release: ALM 12.00
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
ENABLE_CREATE_DOCGEN_FAVORITE parameter is set to N.
Default value: N
System: false
Description: Determines whether legacy Excel
Reports should be included in the 'New Analysis
Item' menu.
ENABLE_CREATE_LEGACY_EXCEL_REPORT Default value: N
System: false
Description: Determines whether Standard
Reports should be included in the 'New Analysis
Item' menu.
ENABLE_CREATE_STANDARD_REPORT Default value: N
System: false
Description: Determines whether the "MoveTo"
work flow event will be thrown by the
requirement entity selection tree
ENABLE_ENTITY_SELECTION_TREE_REQ_M Default value: N
OVE_TO Introduced in release: ALM 11.00
System: true
ENABLE_JMX_CONSOLE 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
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
System: false
Description: Specifies the segments by which to
group the collected QC sense information in the
time frame that was defined by
PRODUCT_ASSESSMENT_QC_SENSE_DAY
S_BACK and
ENABLE_PERFORMANCE_MONITOR_BIRT_R PRODUCT_ASSESSMENT_QC_SENSE_END
EPORTS _DATE as part of Assessment collection flow.
Default value: N
System: false
Description: If this parameter is set to Y, user
can use quick field search feature. Default value
is N, which disables the quick field search
feature.
ENABLE_QUICK_FIELD_SEARCH Default value: Y
Introduced in release: 12.5
System: false
Description: This parameter enables/disables
validation for read-only entity fields via REST.
The default value of the parameter is 'Y' and it
means that validation is on and all entity fields
which have SF_IS_EDIT=Y are not editable via
ENABLE_REST_EDIT_FIELDS_VALIDATION REST.
Default value: N
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
System: false
ENTITYTREE_EXPORT_FETCH_LIMIT Description: The value of this parameter must

be an integer and bigger than 0 otherwise it will
be ignored. Its default value is 800.
Default value: 800
System: false
Description: This parameter enables you to set
the mail server host name used in the link to an
entity when ALM mails an entity. By default,
ALM uses the default host name specified
during installation. For details, see
ENTITY_LINK_HOST
MAIL_SERVER_PORT.
System: false
Description: This parameter enables you to set
the mail server port number used in the link to
an entity when ALM mails an entity. By default,
ALM uses the default port number specified
ENTITY_LINK_PORT during installation.
System: false
Description: Sets schema used in entity links in
mails and in other references.
ENTITY_LINK_SCHEMA Introduced in release: ALM 11.50
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
ENTITY_TABLE_NAMES_FOR_FIXING_UPDAT some fields of it, but doesn't have the
E_PERMISSIONS_INCONSISTENCY permission (TB_GRANT_MODIFY) to modify
the entity itself.
Default value:
System: false
EVENT_LOG_PURGE_PERIOD_DAYS 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
Min value: -1
Max value: 9223372036854775807

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.
EXCEL_ADDIN_GROUP Default value:
System: false
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 the number of memo-type
fields, set the parameter to Y.
EXTENDED_MEMO_FIELDS
Default value: N
System: false
Description: External Authentication: a path to a
file, where all the allowed client certificates are
listed
EXTERNAL_AUTH_CERTIFICATES_FILE Introduced in release: ALM 12.00
System: false
Description: External Authentication: Y/N
whether to enable the certificate CRL
verification
EXTERNAL_AUTH_CERTIFICATE_CRL_CHEC Default value: Y
K Introduced in release: ALM 12.00
System: false
Description: External Authentication: certificate
CRL folder
EXTERNAL_AUTH_CERTIFICATE_CRL_FOLD Introduced in release: ALM 12.00
ER
System: false
whether to verify certificate date
EXTERNAL_AUTH_CERTIFICATE_DATE_CHE Default value: Y
CK Introduced in release: ALM 12.00
System: false
EXTERNAL_AUTH_CERTIFICATE_LOCAL_CR Description: External Authentication: Y/N
L_CHECK whether to enable the certificate revocation
check
Default value: Y
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
EXTERNAL_AUTH_CERTIFICATE_OCSP_CHE certificates issuers; otherwise, all certificates will
CK be rejected.
Default value: N
System: false
Description: Specifies whether the client
certificate 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_REQ EXTERNAL_AUTH_CERTIFICATE_OCSP_CH
UIRED ECK documentation for details.
Default value: Y
System: false
whether to enable the certificate policy
verification
EXTERNAL_AUTH_CERTIFICATE_POLICY_CH Default value: Y
ECK Introduced in release: ALM 12.00
System: false
Description: External Authentication: stores the
certificate's valid policy
EXTERNAL_AUTH_CERTIFICATE_VALID_POL Introduced in release: ALM 12.00
ICY
System: false
Description: External Authentication: header
that holds the certificate
Default value: CERT
EXTERNAL_AUTH_CERT_HEADER_NAME Introduced in release: ALM 12.00
System: false
EXTERNAL_AUTH_EXECUTION_MODE_HEA Description: External Authentication: header
DER_NAME that holds the execution mode of client. Values
are enum ExecutionMode:
NOT_SPECIFIED(default), INTERACTIVE,
NON_INTERACTIVE
Default value: EXECUTION_MODE
System: false
Description: External Authentication: stores the
extended hardware keys
EXTERNAL_AUTH_EXTENDED_HARDWARE_ Introduced in release: ALM 12.00
KEYS
System: false
whether hardware card verification is required
EXTERNAL_AUTH_HARDWARE_CARD_IS_RE Default value: Y
QUIRED Introduced in release: ALM 12.00
System: false
Description: External Authentication: header
that holds the subject of certificate
Default value: SM_USER
EXTERNAL_AUTH_HEADER_NAME Introduced in release: ALM 12.00
System: false
whether a policy is required
Default value: N
EXTERNAL_AUTH_IS_POLICY_REQUIRED Introduced in release: ALM 12.00
System: false
whether to enable the match delta CRL by
issuer verification
EXTERNAL_AUTH_MATCH_DELTACRL_BY_I Default value: Y
SSUER Introduced in release: ALM 12.00
System: false
Description: External Authentication: Which
external authentication to use. Possible values
are: N - do not use external authentication, Y -
use external authentication
EXTERNAL_AUTH_MODE Default value: N
System: true
EXTERNAL_AUTH_USER_FIELD_PATTERN Description: External Authentication: regex to
find the username, email

System: false
Description: External Authentication: user field
type. I.e. email, username
EXTERNAL_AUTH_USER_FIELD_TYPE Introduced in release: ALM 12.00
System: false
Description: External Authentication: LDAP
attribute to validate user
EXTERNAL_VALIDATE_ATTR_IN_LDAP Introduced in release: ALM 12.55
System: false
Description: External Authentication: LDAP
attribute value indicate the user is active in ALM
EXTERNAL_VALIDATE_ATTR_TRUE_VALUE Introduced in release: ALM 12.55
System: false
whether to contact LDAP server (if exists) to
make sure that this user still active or not
EXTERN_AUTH_VALIDATE_USER_IN_LDAP Default value: N
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.
FAST_RECONNECT_MODE Default value: 100
Allowed values: 0100200
System: true
FAVORITES_DEPTH Description: Defines the number of most
recently used favorite views displayed on the
Favorites menu. By default, ALM displays the
four most recently used views on the menu. To
hide the list of recently used views completely,
set the parameter to 0.
Default value: 4
Min value: 0
Max value: 9223372036854775807

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.
FETCH_LIMIT
Default value: 500
Min value: 0
Max value: 9223372036854775807
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
FILE_EXTENSION_BLACK_LIST_DOWNLOAD 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.
System: false
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 restored
projects are not blocked even if their repository
contains files of blocked file types. * Projects
upgraded from previous versions still contain
FILE_EXTENSION_BLACK_LIST_UPLOAD
files of blocked file types that already exist in the
repository. * During optimized repository
migration, files of blocked file types are not
blocked.
System: false
FORCE_DH_FOR_QTP Description:
siteparams.FORCE_DH_FOR_QTP.description
Default value: N
Min value: -9223372036854775808
Max value: 9223372036854775807

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.
FORCE_LOGIN_SSL_MODE
Default value: N
System: false
Description: If this parameter is set to Y, you
can deploy a server to its own folder on the
client.
FORCE_SEPARATE_CLIENT_DEPLOYMENT Default value: N
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
enables you to change the email address in the
FROM_EMAIL_ADDRESS
email From field.
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
FTP_PORT parameter restarts the FTP service. Deleting the
parameter stops the FTP service.
Min value: 1
Max value: 9223372036854775807
System: false
GET_COVERAGE_FROM_BL_FOR_PINNED_TE Description: This parameter enables you to get
STSET 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.
Default value: N
Introduced in patch: Patch22

System: false
Description: The number of minutes a cached
graph result is valid.
Min value: 1
GRAPH_RESULT_LIFESPAN Max value: 9223372036854775807
System: false
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
GROUP_FETCH_LIMIT results are displayed for each group.
Default value: 100
Min value: 0
Max value: 9223372036854775807
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.
HIDE_EXECUTION_FLOW_VIEW Default value: N
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.
HIDE_TEST_BOARD_VIEW Default value: N
System: false
INHERIT_MODULE_ACCESS_TO_VIEWS 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. This
parameter affect only "BPM" views.
Default value: N
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: ONOFFLOG
System: false
Description: The interval between invalid logins.
It's used by the user lockout service.
INTERVAL_BETWEEN_INVALID_LOGINS_TO_ Min value: 1
LOCKOUT Max value: 9223372036854775807
System: true
Description: The Number of minutes before
automatically releasing a locked user.
Min value: 1
INTERVAL_TO_AUTO_RELEASE_LOCKOUT Max value: 9223372036854775807
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.
Default value: 100
LAB_MAX_DB_HANDLERS Min value: 1
Max value: 9223372036854775807
System: false
LDAP_IMPORT_ATTRIBUTE_MASK 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 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:
System: false
Description: This parameter indicates max
library size to handle it without performance hit
on the customer..
Default value: 2500
LIBRARY_FUSE Min value: -9223372036854775808
Max value: 9223372036854775807
System: false
Description: The period in days to purge old
sessions records from SESSION_HISTORY
table
Default value: 365
LICENSE_ARCHIVE_PERIOD Min value: -1
Max value: 9223372036854775807
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
LOCK_TIMEOUT Min value: 1
Max value: 9223372036854775807
System: true
LOGIN_SSL_PORT 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.
Default value: 443
Min value: 1
Max value: 65535

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.
Default value: HTML
MAIL_FORMAT Allowed values: HTMLTEXT
System: true
Description: This parameter show/hide entity
details in mail body
Default value: N
MAIL_HIDE_DETAILS_SECTION Introduced in release: ALM 11.50
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.
MAIL_INTERVAL Min value: 10
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.
MAIL_MESSAGE_CHARSET Default value: UTF-8
System: true
Description: Displays the mail service used to
send email messages to users. To configure the
mail protocol, use the Settings button.
MAIL_PROTOCOL Introduced in release: QC 10.00
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.
System: false
Description: The SMTP server port used by
ALM to send mail. By default, the value is set to
25.
Default value: 25
MAIL_SERVER_PORT Min value: 1
Max value: 65535
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
MAIL_SHOW_SITE_NAME considered. The default value is N.
Default value: N
System: false
Description: The SMTP server socket
connection timeout. By default, the value is set
to 5 minutes.
MAIL_SOCKET_CON_TIMEOUT Min value: -9223372036854775808
Max value: 9223372036854775807
System: false
Description: The SMTP server socket read
timeout. By default, the value is set to 1 minute.
Min value: -9223372036854775808
MAIL_SOCKET_READ_TIMEOUT Max value: 9223372036854775807
System: false
Description: The SMTP server socket write
timeout. By default, the value is set to 5
minutes.
MAIL_SOCKET_WRITE_TIMEOUT Min value: -9223372036854775808
Max value: 9223372036854775807
System: false
MAX_CONCURRENT_REPORTS 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 maximum is 3.
Min value: 1
Max value: 9223372036854775807
System: false
change the maximum size of the graph results,
as calculated by the number of cells in the
graph's Grid View. The size of a cell is 8 bytes.
MAX_GRAPH_RESULT_DATA_TABLE_VOLUM Min value: 1
E Max value: 9223372036854775807
System: false
Description: The number of max permitted
invalid login attempts. It's used by the user
lockout service.
Min value: 0
MAX_INVALID_LOGINS_ATTEMPT_TO_LOCK
OUT Max value: 9223372036854775807
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
System: false
MAX_MILESTONES_PER_RELEASE 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
Min value: 1
Max value: 9223372036854775807

System: false
Description: The maximum number of projects
that can be selected for BV Excel report.
Min value: 1
MAX_PROJECTS_IN_EXCEL_REPORT Max value: 9223372036854775807
System: false
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.
MAX_QUERY_LENGTH Default value: 1000000
Min value: 1
Max value: 9223372036854775807
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
MAX_SCOPE_ITEMS_PER_RELEASE
Min value: 1
Max value: 9223372036854775807
System: false
Description: This is a fuse that limits the max
steps can be fetched in each request, just to
protect the server from OutOfMemoryError.
MAX_STEPS_IN_PROJECT Min value: 1
Max value: 9223372036854775807
System: false
MAX_TESTS_IN_TEST_SET Description: The maximum number of tests in
test set in order to perform copy-paste or delete
test set operations
Min value: 1
Max value: 9223372036854775807
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.
MAX_TEST_INSTANCES Min value: 1
Max value: 9223372036854775807
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
System: false
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.
MEMO_FIELD_ADD_IMAGE_MODE
Default value: Y
Allowed values: YNAS_LINK
System: false
Description:
siteparams.MEMO_FIELD_AUTO_DOWNLOAD
_IMAGES.description
MEMO_FIELD_AUTO_DOWNLOAD_IMAGES Default value: N
System: false
MUTE_SERVER_FOR_OOME Description: This is a fuse that will not set the
server status to MUTED when the server is
OutOfMemoryError.
Default value: Y
Min value: -9223372036854775808

Max value: 9223372036854775807
System: false
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
NLS_SEARCH_LOCALE
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.
System: false
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
System: false
Description: This parameter is related to the
"Orphan 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
ORPHAN_ANALYSIS_DATA_FILE_INACTIVE_ minimum value is one hour (3600000 ms).
PERIOD
Min value: 3600000
Max value: 9223372036854775807
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
System: false
OUTPUT_SANITIZATION_BY_CLIENT_TYPE 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:
Allowed patterns: ^([^;=]+=[^;=]+;?)+$
System: false
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.
PASSWORD_RESET_DISABLE If LDAP or External authentication is enabled,
the Forgot Password link is not shown.
Default value: N
System: false
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
PASSWORD_RESET_ELAPSED_TIME Min value: -9223372036854775808
Max value: 9223372036854775807
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>.
PASSWORD_RESET_SERVER
Overrides both the default server and port.
<server>. Overrides the default server. <port>.
Overrides the default port.
System: false
PASSWORD_RESET_VALID_PERIOD 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
Max value: 9223372036854775807

System: false
Description: enable/disable using route table to
calculate coverage
Default value: 60
PPT_KPI_FAILURES_PERCENTAGE_PER_RELE Min value: 1
ASE_FUSE Max value: 9223372036854775807
System: false
Description: Rename of
QPM_RECENTLY_USED_PROJECTS_THRES
HOLD_MINUTES. 7 days (in minutes) of the
recently used projects threshold. Used by the
PP&T planning algorithm.
PPT_RECENTLY_USED_PROJECTS_THRESHO Default value: 10080
LD_MINUTES Min value: 1
Max value: 9223372036854775807
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.
PRODUCT_ASSESSMENT_QC_SENSE_DAYS_B Default value: -90
ACK Min value: -9223372036854775808
Max value: 9223372036854775807
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_D
ATE Max value: 9223372036854775807
System: false
PRODUCT_ASSESSMENT_QC_SENSE_GROUPI Description: Specifies the segments by which to
NG_SEGMENTS group the collected QC sense information in the
time frame that was defined by
PRODUCT_ASSESSMENT_QC_SENSE_DAY
S_BACK and
PRODUCT_ASSESSMENT_QC_SENSE_END
_DATE as part of Assessment collection flow.
Default value:
00:00:00,05:59:59,06:00:00,11:59:59,12:00:00,1
7:59:59,18:00:00,23:59:59
Allowed patterns: ((\d{2}\72){2}(\d{2}),)*
(\d{2}\72){2}(\d{2})
System: false
Description: Maximum number of projects that
ALM allows you to include in a graph. Default is
6.
Default value: 6
PROJECT_SELECTION_MAX_PROJECTS Min value: 1
Max value: 9223372036854775807
System: false
Description:
siteparams.QC_SENSE_AUTHORIZATION_DI
SABLED.description
QC_SENSE_AUTHORIZATION_DISABLED Default value: N
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:
QC_SENSE_REPORTS_USERS
<user1>;<user2>;<user3>
System: false
Description: This parameter changes the order
of events raised when the user enters the
TestSet module.
RAISE_TESTSET_MOVETO_EVENT_AFTER_E Default value: N
NTER_MODULE Introduced in release: ALM 11.50
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 following parameter value: <original
title1 singular>;<new title1 singular>; <original
title1 plural>;<new title1 plural>; <original title2
singular>;<new title2 singular>;... For example,
if you want to change the name of the Defects
module to Bugs, and the Requirements module
to Goals, enter the following:

Defect;Bug;Defects;Bugs;Requirement;Goal;Re
quirements;Goals Renaming the Releases
module does not change the module name in
the following locations: * The Releases
command in the Releases module menu bar. *
The New Release Folder menu command and
dialog box. * The New Release menu command
and dialogbox.
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
REPORT_MAX_ALLOWED_CONCURRENT_RE data has been generated up to that point.
NDERED_PAGES Min value: 0
Max value: 9223372036854775807
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.
REPORT_MAX_ALLOWED_SIZE
Min value: -1
Max value: 9223372036854775807
System: false
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.
REPORT_QUERY_RECORDS_LIMIT Min value: -1
Max value: 9223372036854775807
System: true
REPORT_QUERY_TIMEOUT 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
Min value: 1
Max value: 9223372036854775807
System: true
Description: The number of minutes a cached
project report result is valid.
Min value: 1
REPORT_RESULT_LIFESPAN Max value: 9223372036854775807
System: false
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
REPOSITORY_GC_DELAY_CANDIDATE_TIME
Cleanup. Default is 7 days.
Default value: 7
Min value: 0
Max value: 28
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.
REPOSITORY_GC_JOB_PRIORITY Default value: 3
Min value: 0
Max value: 10
System: false
REPOSITORY_GC_PROJECT_CLEANUP_INTER Description: This parameter defines the time
VAL 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.
Default value: 7
Min value: 1
Max value: 28
System: false
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.
REPOSITORY_MIGRATION_JOB_PRIORITY Default value: 3
Min value: 0
Max value: 10
System: false
Description: This parameter indicates max
requirements amount in library to handle it
without performance hit on the customer.
Min value: 1
REQUIREMENTS_LIBRARY_FUSE Max value: 9223372036854775807
Introduced in patch:
System: false
Description: This parameter indicates whether
rich text field will be used in author mode in web
client.
REQUIREMENT_AUTHOR_USE_RICHTEXT Default value: N
System: true
(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
REQUIREMENT_REVIEWED_FIELD_AUTOMA
field does not affect the value of the Reviewed
TIC_UPDATE
field.
System: false
RESTAPI_ACCESS_APIKEY_ONLY 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
System: false
Description: This parameter maintain client
types with which customer can use to login.
Default value:
RESTAPI_WHITELIST_APIKEY Introduced in release: ALM 12.60
System: false
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
RESTRICT_SA_SERVER_FOLDERS can access the Site Administration (SA)
directory using the
ExtendedStorage.ServerPath property only with
ALM admin users.
Default value: ANY
Allowed values: ANYNOADMIN
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.
Default value: Y
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.
Default value: 100
REST_API_DEFAULT_PAGE_SIZE
Min value: 1
Max value: 9223372036854775807
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
REST_API_DEFAULT_PAGE_SIZE_WITH_ANC be returned without ancestors.
ESTORS Default value: 30
Min value: 1
Max value: 50
System: false
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,cu
stomization/used-lists,customization/users. The
REST_API_HTTP_CACHE_ENABLED default is Y.
Default value: Y
System: false
REST_API_MAX_BULK_SIZE 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.
Default value: 2000
Min value: 1
Max value: 9223372036854775807
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:
REST_API_MAX_ENTITY_TREE_SIZE
higher values affect performance.
Default value: 100
Min value: 1
Max value: 9223372036854775807
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.
Default value: 2000
REST_API_MAX_PAGE_SIZE
Min value: 1
Max value: 9223372036854775807
System: false
the max page size with ancestors that the
consumer may ask. Default is 50 entities.
REST_API_MAX_PAGE_SIZE_WITH_ANCESTO Default value: 50
RS Min value: 1
Max value: 50
System: false
REST_API_PAGINATION_DEFAULT_LIMIT 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.
Default value: 100
Min value: 1
Max value: 9223372036854775807
System: false
the amount of entities that the consumer may
request. Default is 2000 entities.
Default value: 2000
REST_API_PAGINATION_MAX_LIMIT
Min value: 1
Max value: 9223372036854775807
System: false
Description: Specifies timeout for ALM Robot
operations.
Default value: 1200
Min value: 1
REST_SA_CLIENT_TIMEOUT Max value: 9223372036854775807
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
REST_SESSION_MAX_IDLE_TIME minutes.
Default value: 60
Min value: 1
Max value: 9223372036854775807
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
RUN_QUERY_MAX_RECORDS_COUNT Max value: 9223372036854775807
System: false
SA_MAX_DB_HANDLERS Description: Maximum number of database

connections for SA schema. Default is 50.
Default value: 50
Min value: 1
Max value: 9223372036854775807
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
SEARCH_SERVER_URL
name.
System: false
Description: This parameter holds the sites
Global Search User. Its value is the login name
of the dedicated Global Search user.
SEARCH_SERVER_USER Introduced in release: ALM 12.50
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.
SECURED_QC_URL
Default value: N
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
SEND_EXCEPTION_DEFAULT_TO Micro Focus Application Lifecycle Management
User Guide: Send Error Details Dialog Box.
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.
Default value: Y
System: false
(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.
SITE_ANALYSIS Default value: Y
System: true
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
SKIP_CLIENT_PREREQUISITES_CHECK Prerequisites Check checkbox.
Default value: N
System: false
Description:
siteparams.SKYPE_INTEGRATION_ENABLED.
description
SKYPE_INTEGRATION_ENABLED Default value: Y
System: true
Description: This parameter is used to enable
connection to an SMTP server that requires
Authentication. note: This site parameter was
added in one of QC 10 patches as an hidden
feature and is also a hidden feature in QC 11.
This feature will be provided by request to
SMTP_AUTHENTICATION customers through CSO. Default values is 'N'.
Default value: N
System: false
SMTP_SSL_SUPPORT Description: This parameter enables an SSL
tunnel to the SMTP server. The default value is
N.
Default value: N
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
SQL_QUERY_VALIDATION_BLACK_LIST parameter. The parameter's value must be a
comma-separated list of SQL 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.
System: false
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
SQL_QUERY_VALIDATION_ENABLED performed. If this parameter does not exist, is
empty, or is set to Y, this validation is performed.
Default value: Y
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
Max value: 9223372036854775807
System: false
SSO_SECURE_ONLY_COOKIE 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'.
Default value: N
Min value: 1
Max value: 9223372036854775807
System: false
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
STATIC_CONTENT_MAX_CACHED_FILE_SIZE
Min value: 0
Max value: 50
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
SUPPORT_TESTSET_END execution ends.
Default value: Y
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
SUSPEND_REPOSITORY_GC value to Y to temporarily stop the project
repository cleaning process. To restart the
cleaning process, set the parameter to N.
Default value: N
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
System: false
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
TEXT_ENCODING_BY_CLIENT_TYPE param is false.
Default value:
Allowed patterns: ^([^;=]+=[^;=]+;?)+$
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
TEXT_SEARCH_TIMEOUT minutes time out.
Default value: 1200
Min value: -1
Max value: 9223372036854775807
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.
Default value: 100
TOTAL_SIZE_ALLOWED_IMAGE_FILES
Min value: 0
Max value: 1000
System: false
UNIX_SERVER 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.
Default value: N
System: false
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,
UPGRADE_EXCEPTION_FILE and are not defined in the schema configuration
file. This instructs ALM to ignore these changes.
See documentation library for details.
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
UPLOAD_ATTACH_MAX_SIZE uploaded regardless of size).
Default value: -1
Min value: -1
Max value: 9223372036854775807
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 -1 (meaning, all avatars are
uploaded regardless of size).
UPLOAD_AVATAR_MAX_SIZE Default value: 2000
Min value: -9223372036854775808
Max value: 9223372036854775807
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.
Default value: 700
Min value: 1
Max value: 9223372036854775807
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.
UPLOAD_RESULTS_AFTER_RUN ALWAYS_EXCEPT_RUN_PASSED: Upload
results only when the status is not Passed.
Default value: ALWAYS
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
USE_LOCAL_HELP includes all the latest updates.
Default value: N
System: false
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
VERIFY_REPORT_FOLDER
your ALM server machine.
System: false
WAIT_BEFORE_DISCONNECT 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.

Min value: -1
Max value: 9223372036854775807
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.
WAIT_BEFORE_DISCONNECT_SA Default value: -1
Min value: -1
Max value: 9223372036854775807
System: false
Description: This parameter specifies a user
group name, only the users who is in this group
have permission to access the Word add-in.
WORD_ADDIN_GROUP Default value:
System: false

Site Parameters

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Site Parameters

Uploaded by

Copyright:

Available Formats

28/1/2019 https://admhelp.microfocus.com/alm/en/12.60/api_refs/site_params/metadata.

API requests with X-HTTP-Method-Override

specified value, the email is sent without the

Description: This parameter enables you to

EP_INTERVAL "Orphan Analysis Data File Cleanup Job"

parameter is set to N. For details, see the Micro

from TDConnection. Users can access the

DISABLE_VERBOSE_ERROR_MESSAGES Description: This parameter is a security

affect trees/grids and column selection (will

ENTITYTREE_EXPORT_FETCH_LIMIT Description: The value of this parameter must

Max value: 9223372036854775807

Introduced in release: ALM 12.00

Introduced in release: ALM 11.00

Introduced in release: ALM 11.00

Introduced in patch: Patch22

value you want to choose, and <regular

Introduced in release: QC 10.00

MAX_CONCURRENT_REPORTS Description: This parameter defines the

Max value: 9223372036854775807

Min value: -9223372036854775808

Introduced in release: QC 10.00

to Goals, enter the following:

subdirectory for a project If this parameter is set

SA_MAX_DB_HANDLERS Description: Maximum number of database

Micro Focus Application Lifecycle Management

makes the cookie less likely to be exposed to

entire site. Use this only in special

UNIX_SERVER Description: If this parameter is set to Y, it

jpg, png, tif, wmf) to memos whose size is

Default value: 36000000

You might also like