This documentation supports the 20.02 version of BMC Helix Platform. 
To view an earlier version, select 19.11 from the Product version menu.

Updating centralized tenant configuration settings

Centralized tenant configuration refers to storing the tenant's configuration data at a common location that can be accessed across multiple servers. The Centralized Tenant Configuration ensures consistency by communicating changes to the global properties across servers in a cluster. When a tenant-specific property is modified on one server, the Centralized Tenant Configuration automatically sends the notification to other servers that have the same tenant added, so that these configuration changes are also synchronized on each server in the same cluster.

Centralized tenant configuration contains configuration settings for the following components: 

  • Approval
  • Assignment
  • Shared

To configure centralized tenant configuration settings

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Configure My Server > Centralized Configuration Settings > Centralized Tenant Configuration
  3. From Component Type, select the component for which you want to configure the setting:
    • To configure a new setting, click Add Setting.
    • To edit a setting, select the setting that you want to edit, and click Edit
  4. From the Setting Name list, select the setting to be configured.
  5. In Setting Value, provide the appropriate value for the selected setting.
  6. Click Save

Centralized Tenant Configuration settings

The following table describes the centralized tenant configuration settings in BMC Helix Innovation Studio and provides example values for each setting:

Tip

  • If you cannot view all the columns, click Full screen in the upper-right corner of the page or press F to open the page in full screen mode. Alternatively, use the scroll bar at the bottom of the table. Press Esc to exit full screen mode.
  • To easily search for a specific parameter in the table, select the parameter from the Setting Name list. Alternatively, type the name of the parameter in the Setting Name text box.
    For example, to search for the Full-Text-Case-Option parameter, select it from the Setting Name list, or type the parameter name in the Setting Name text box.

Audit settings

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Setting NameDescriptionValues

Disable-Audit-Only-Changed-Fields

Flag indicating whether to audit all records, or to audit only those records whose field values have changed.


T—Audit all the records.

F(Default) Audit only those records whose field values have changed.

Full-Text-Case-Option

Flag indicating whether full text searching is case sensitive or case insensitive. This setting affects all fields indexed for full text search and affects how the indexes are built. Therefore, any changes to this setting trigger an automatic re-index.


0— Full text search is case sensitive

1—(Default) Full text search is case insensitive

Full-Text-Disable-Indexing

Flag indicating whether the server processes the pending indexing tasks.


T—Disable indexing. Pending indexing tasks are recorded for processing later when indexing is enabled.

F(Default) Do not disable indexing.

Full-Text-Disable-SearchingFlag indicating whether the server uses the full text search engine for searching.

T—Disable the full text search engine.

Note: The database search capability continues to work even after the full-text search engine is disabled.

F(Default) Use the full text search engine.

Use-FTS-In-WorkflowControls whether the server will use full text searches when executing queries during workflow that have full text indexed fields in the qualification. If this option is not used, the server will use the search capability of the database.

T(Default) Use FTS in workflow.

F—Do not use FTS in workflow.

Full-Text-Collection-DirectoryLocation in the file system where the full-text search index files are stored.

Following is the default location where the files are created:

<tenantDirectory>/ftsconfiguration/collection

Full-Text-Configuration-DirectoryLocation in the file system where full-text search configuration files are stored.

Following is the default location where the files are created:

<tenantDirectory>/ftsconfiguration/conf

Full-Text-Indexer-Log-File

Location of the directory where the full-text search index log files are stored.

Following is the default file where the log entries are created:

arftindx.log

Full-Text-Match-Option

Indicates the way the FTS server modifies qualifications from the client.

0—Force leading and trailing wildcards.
1—Ignore leading and force trailing wildcards.
2—Ignore leading wildcards.
3—Remove leading and trailing wildcards.
4(Default) Leave query unchanged.
Full-Text-Exclude-List

Space separated list of attachment file extensions which must be excluded from FTS indexing.

For example, if the value to this parameter is set to .xla, .xls, .xlsm, .xlsx, .xlt and if you have enabled FTS or MFS for the attachment field, all the attachments with these extensions are ignored while creating FTS index.

If there are other fields that have enabled FTS or MFS index, the entry still gets indexed.

If you change this option, you must restart the BMC Helix Platform server for the change to take effect.


MFS-Title-Field-Weight

Defines the relevancy weight for Title Field. This setting relates to the fields for which the application business analyst has defined the relevancy when Enabling full-text search capabilities in your application.


0 - 0.9—Reduces the relevancy weight of the Title Field.

1—No change to the relevancy weight.

1.1 - 2.0—Increases the relevancy weight of the Title Field.

(Default) 4.0

MFS-Keywords-Field-WeightDefines the relevancy weight for the Keyword Field. This setting relates to the fields for which the application business analyst has defined the relevancy when Enabling full-text search capabilities in your application.

0 - 0.9—Reduces the relevancy weight of the Keywords field.

1—No change to the relevancy weight.

1.1 - 2.0(Default) Increases the relevancy weight of the Keywords field.

MFS-Environment-Field-Weight

Defines the relevancy weight for the Environment Field. This setting relates to the fields for which the application business analyst has defined the relevancy when Enabling full-text search capabilities in your application.

0 - 0.9—Reduces the relevancy weight of the Environment field.

1(Default) No change to the relevancy weight.

1.1 - 2000—Increases the relevancy weight of the Environment field.

Full-Text-Ignore-Word-ListContains words to be ignored during FTS. Search results will not contain the words that are added in this list.

Articles (a, an, the), prepositions (in, on, from, front, beside), and so on.

Press Enter to add a new word in this list.

Full-Text-SynonymsContains synonyms so that when the end user searches for any of these words, resources related to its synonyms also appear in the search results.

PC workstation laptop desktop computer

slow sluggish

bright shiny

Type a word followed by its synonyms separated by a space. Press Enter to add a new list of synonyms.

Full-Text-ReIndexInitiates the re-indexing of all FTS-enabled fields.

0(Default) Re-indexing is not performed.

1Starts re-indexing.

API-Log-FileFull path name of the file to use if API logging is on.

Following is the default file where the log entries are created:

arapi.log

Escalation-Log-FileFull path name of the file to use if escalation logging is on.

Following is the default file where the log entries are created:

aresc.log

Archive-Log-File

Full path name of the file to use if archiving is on.

Following is the default file where the log entries are created:

ararchive.log

Filter-Log-FileFull path name of the file to use if filter logging is on.

Following is the default file where the log entries are created:

arfilter.log

SQL-Log-FileFull path name of the file to use if SQL logging is on.

Following is the default file where the log entries are created:

arsql.log

Thread-Log-FileFull path name of the file to use if thread logging is on

Following is the default file where the log entries are created:

arthread.log

User-Log-FileFull path name of the file to use if user logging is on

Following is the default file where the log entries are created:

aruser.log

Process-Log-FileFull path name of the file to use if PROCESS logging is on.

Following is the default file where the log entries are created:

arprocess.log

Service-Log-FileFull path name of the file to use if service tracing is on.

Following is the default file where the log entries are created:

arservice.log

Flush-Log-LinesFlag indicating whether logged lines are buffered or written directly to disc. 

T(Default) Logged lines are written to disc.

F—Logged lines are buffered.

Locked-Workflow-Log-ModeMode that causes the server to record locked workflow actions in workflow logs. These actions are written as encrypted strings.

(Default) 0

1

Log-File-AppendFlag indicating whether to create a separate *.bak file or to append to the existing log file. 

T—Append new log information to the existing file.

F(Default) Create a *.bak file.

Max-Log-File-SizeMaximum size in bytes for system log files. If the maximum is reached, the logging cycle restarts at the beginning of the file, overwriting the existing information. This option does not apply to the Arfork-Log-File.0(Default) No limit
Max-Log-HistoryMaximum number of backup (.bak) log files to be allowed when the log file reaches the Max-Log-File-Size value and a new log file is created.

1— (Default) Minimum number of backup log files allowed.

999—Maximum number of backup log files allowed.

Log-Form-SelectedControls whether to record logs in a specific form or to a common log form.

0(Default) Log records to a specific form.

1—Log records to a common log form.

Preferred-User-Locale

Sets the global locale for all users of the tenant. It takes precedence over User Locale set through User Preference as well as Browser locale.

When the global locale is not set, the user's locale from the My Preferences setting is applied, If none of the preferences are defined, then the browser locale is used for the user session.

Default—Browser locale

English—en

French—fr

German—de

Italian—it

Chinese—zh_cn

Korean—ko

Portugese—pt_br

Russian—ru

Japanese—ja

Spanish—es

Dutch—nl

Swedish—sv

Debug-Mode

Bitmask indicating the server logging modes. To activate one bit, set this option to its value. To activate two or more bits, add their values, and set this option to the total.

For example, to activate bits 1 and 3, set this option to 5 because bit 1 has a value of 1 and bit 3 has a value of 4. To deactivate a bit, subtract its value from the value of this option.

Unless otherwise specified in the following list, this option turns on logging for the arserverd process. Default log files are in the directory specified by the Server-directory option.

0(Default) Nothing enabled

1—SQL

2—FLTR

4–-USER

16—API

1048576—PROCESS

1048598—All but SQL

1048599—Turn on all of the above components

Enable-Unlimited-Log-Line-Length

Flag indicating whether log files display full SQL statements or not.

For more information, see Knowledge Base article ID 000024691.

T—The BMC Helix Platform server captures complete SQL statements into the log files without truncation.

F—(Default) BMC Helix Platform server captures only 4093 characters per line, including the header information.

VersionControl-Object-Modification-Log-Mode

Controls whether the object modification log is enabled or disabled. When the log is enabled, it records every change to BMC Helix Platform objects in your system.

0—(Default) Disabled

10—Enabled

VersionControl-Object-Modification-Save-Definition-Files

Controls whether the BMC Helix Platform server writes a definition file each time an object is created or changed. This option is effective only when the object modification log is enabled.

0—(Default) Yes, a definition file is created.

10—No, a definition file is not created.

Restrict logging settings

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Setting NameDescriptionValues

Restrict-Logging

Controls which type of logging restriction is enabled. The value of the Restrict-Logging parameter depends on the combination of logging restrictions that you select. Possible values of the restriction parameters are as follows:

  • Users — 1
  • Client Type — 2
  • RPC Queues — 8

You can have combinations of Users, Client Type, and RPC Queues restrictions. For example, if you select Users and Client Type restrictions, the value of the Restrict-Logging parameter is set to 9 (1+8).

The default value of Restrict-Logging parameter is 0
The Restrict-Logging parameter has an additional reserved value of 4.
Restrict-Log-Users

A list of semicolon-separated user names. Restricts the logging only for specified users.

For example, Allen;Mike


Restrict-Process-Name-Log

A list of semicolon separated process names for which logging is restricted.


Session-Idle-Timeout

The maximum time for which a user can remain idle in BMC Helix Innovation Studio. If a user does not perform any activity within the Session-Idle-Timeout interval, Innovation Studio prompts a message (if the user wants to continue or not).

(Default) 3600 milliseconds

Session-Absolute-Timeout

The maximum time after which the current session expires in BMC Helix Innovation Studio. The default value is 86400 seconds (24 hours). When the session exceeds this time interval, you must log in to BMC Helix Innovation Studio again.

(Default) 86400 seconds (24 hours)

Attachment security settings

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Setting NameDescriptionValues

Attachment-Ext-Filter

Enables users from uploading or viewing files with certain extensions. This setting helps prevent users from viewing and uploading malicious attachments.

0— No filter.

1—Allow users to attach files that have the extensions specified in Attachment-Ext-List setting.

2(Default) Disallow users to attach files that have extensions specified in Attachment-Ext-List setting.

Attachment-Ext-List

A list of comma separated attachment extensions that you want to allow to be uploaded.

For example, sh, pl, dll, exe, dmg, jar, vbs, js, bat, ksh


Attachment-Exception-List

Enables you to override the Attachment Security specified in the related configuration, such as Attachment-Ext-Filter and Attachment-Ext-List. To override the attachment restrictions, you can specify the Form name with Field ID and upload attachments only for that field ID.

Note: Field ID is the numeric value of the field that contains an attachment on the form. You can get the value for a Field ID from BMC Helix Innovation Studio. 

For example, AR System Resource Definitions (41103).

For multiple forms and field ID entries, enter a comma separated list, for example, AR System Publish Report (90104), AR System Resource Definitions(41103).


Attachment-System-Exception-ListDefines the attachments that cannot be attached in an entry operation.
Display-FilterAllows display of attachments in a browser

0— No filter.

1—Allow users to view the attached files that have the extensions specified in Display-Ext-List setting.

2(Default) Disallow users to view attached files that have extensions specified in Display-Ext-List setting.

Display-Ext-ListA list of comma separated attachment extensions that you want to allow to be displayed.


Email-Max-Attachment-Size

Defines the maximum combined size limit for all attachments in an outgoing email.

Example: 5000000 bytes

(Default) 0


Email-Max-Num-Of-Attachments

Defines the maximum number of attachments that can be added to an outgoing email.

Example: 5

(Default) 0

Other settings

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Setting NameDescriptionValues
Classification-Service-ProviderEnables you to define the classification service provider that should be used for the cognitive classification service.

WATSON(Default) Enables auto classification by using the IBM Watson Assistant service.

NATIVE—Enables auto classification by using the BMC Native (Google) classification service.

Gcp-Project-Id

The unique identifier for your Google Cloud Platform project.

The Gcp-Project-Id can be any alphanumeric string that is unique across the platform and is provided by the user while creating a project.

The project id created while setting up the Google Cloud Platform account.

For more information, see Configuring cognitive service for a custom application by using BMC Native (Google) classification.

Gcp-Region

The geographical location where you want to execute your Google Cloud Platform machine learning jobs.

The value of the region provided while setting up the Google Cloud Platform account.

For more information, see Configuring cognitive service for a custom application by using BMC Native (Google) classification.

Enforce-Password-Policy

Specifies whether the password policy must be enforced.

BMC Helix Platform ensures that passwords are always encrypted. To ensure that the passwords are validated and encrypted, a password policy is enforced and forces the users to set a password that cannot be blank. For information about the password policy, see Enforcing a password policy.

T—(Default) Enforces the password policy. You must create users and define the password according to the guidelines defined in the password policy.

F—Does not enforce the password policy, and you can create users without a password.

IFrame_Allowed_Sites

A list of URL strings of trusted sites for embedding the BMC Helix Platform views in external applications.

For multiple URL strings, enter the list separated by a space.

For example, https://coke.com https://pepsi.com


FieldId-Range

The FieldId-Range specifies the limit for values that you can assign (or are assigned automatically if you do not assign any value) to the Field ID. You can assign the value to Field ID within the Field ID range.

You cannot assign the lower limit value of the Field ID range to a field.

For example, if the FieldId-Range is 1000:2000, the minimum value that you can assign to a Field ID is 1001. 


Developer-Id

Unique string that identifies the organization creating the smart bundle. Each organization developing a Digital Service application must have a Developer ID. When you create a Bundle project by using an archetype, a Developer ID is assigned to the smart bundle by the archetype.
Every definition deployed with the smart bundle has a Developer ID property which is used to identify the organization that creates the definition.

For example: com.bmc.arsys


Process-History-LevelControls whether to enable or disable the activity history of a process instance.

0—None

1—Enable at activity level

2—(Default) Enable at audit level


Translation-Service-Provider

Specifies the provider that you want to use for real-time-translation in a chatbot or custom application.
  • MICROSOFT—Microsoft Azure Translator Speech API
  • GOOGLE—Google Cloud Translation Services
Trust-Insecure-Connection

Flag indicating whether or not self-signed sites can register for BMC Helix Digital Workplace Advanced, BMC Helix Digital Workplace Catalog, and Skype for Business.

T—Self-signed sites can register

F—(Default) Self-signed sites cannot register

Default-Order-By 

Flag indicating whether to apply the default sort order to search results.


T — (Default) Use the default sort order, which is to sort by request ID.

F — No default sort order exists, and no order by clause is added to the command if a sort order is not specified.

GetListEntry-Server-Date-FormatFlag indicating where to format the GetListEntry date. This option is used mainly for backward compatibility purposes.

T — Format date on server.

F — (Default) Format date on client.

GUID-PrefixCharacter string used as a prefix for GUID strings generated by filters.
Allow-Guest-UsersFlag indicating whether the BMC Remedy AR System server accepts guest users (users not registered with BMC Remedy AR System in a User form).

T — (Default) Allow guest users. Unregistered users have no permissions but can perform some basic operations. For example, they can submit requests to forms to which the Public group has access and whose fields allow any user to submit values.

F — Do not allow guest users. Unregistered users have no access to the system.

The default value is set to F.

Guest-Restricted-ReadFlag indicating whether guest users receive a restricted read license when they log in to BMC Remedy AR System.
  • T
  • F

If this option is not specified, guest users receive a read license.

Max-Password-AttemptsMaximum number of consecutive bad password retries a user can make. If this option is set to 3, the user has 3 chances to log in. If all 3 attempts have bad passwords, the user account is marked INVALID. Values are 0 (which turns this feature off) and all positive integers.
Multiple-Assign-GroupsFlag indicating whether multiple assignee groups can be stored in row-level security field ID 112. This enables users from multiple groups to access the same request. In the past, only one group could be stored in Field 112.
  • T — (Default) Allow multiple groups in field ID 112.
  • F — Do not allow multiple groups in field ID 112.
External-Authentication-Group-MappingMapping of LDAP groups to BMC Remedy AR System groups for external authentication. The value of this option consists of one or more pairs of group names separated by semicolons. For example:"LDAP-1" "ARS-1";"LDAP-2" "ARS-2";"LDAP-3" "ARS-3" Use mapping as an alternative to creating an BMC Remedy AR System group corresponding to each LDAP group. You can map each LDAP group to an BMC Remedy AR System group (as in the example) or multiple LDAP groups to a single BMC Remedy AR System group. If you try to map a single LDAP group to multiple BMC Remedy AR System groups, only the first mapping expression is valid. This option can be used with the External-Authentication-Ignore-Excess-Groups option.
External-Authentication-Ignore-Excess-GroupsFlag used by AR System during external authentication. 
  • 0 — (Default) Users are authenticated when a match exists between every LDAP group to which a user belongs and a corresponding group in AR System.
  • 1 — Users are authenticated when any single LDAP group to which a user belongs matches a group in BMC Remedy AR System. Excess LDAP groups are ignored.

This option can be used with the External-Authentication-Group-Mapping option.

External-Authentication-Return-Data-CapabilitiesBit mask that specifies the return data capabilities for the current AREA plug-in. This option does not control the AREA plug-in; it merely describes the behavior of the plug-in, enabling server optimization.
  • 0 — (Default) The server tries to retrieve this information from AREA.
  • Bit 1 (value = 1 ) — No email address is provided.
  • Bit 2 (value = 2 ) — No notify mechanism is provided.
  • Bit 3 (value = 4 ) — No group identifiers are provided.
  • 7--The server potentially can reduce the number of AREA related calls during notification processing.
  • Bit 4 (value = 8 ) — No license information is provided.
  • Bit 5 (value = 16 ) — No notification user validation should occur. This enables the server to avoid using AREA for notification user validation and information retrieval. Use this setting for sites using a form of AREA that applies user names as email addresses and where accessing an authentication database provides no benefit.

By default, bit 1 to 5 are set.

External-Authentication-Sync-TimeoutInternal timeout (in seconds) that the BMC Remedy AR System server uses to invoke the external authentication server's AREANeedToSyncCallback() function periodically. This function instructs the BMC Remedy AR System server to renew its internally stored user information in case the source used to authenticate users is changed. A value of 0 means that the BMC Remedy AR System server does not invoke the call to the AREA server. The default value is 3600 seconds.

Default-Allowable-Currencies

Default allowable currency types for currency fields in clients.
Default-Functional-CurrenciesDefault functional currency types for currency fields in clients.
Currency-Ratio-Client-Refresh-IntervalNumber of minutes between each refresh of currency conversion ratios on the client.
Email-Notify-FromSender name to use for filter-generated email notifications in which no subject is specified. The value is limited to 29 characters.
Max-Notify-Mail-Line-LenMaximum number of bytes that can be in a line of a mail notification.
Per-Thread-LoggingFlag indicating whether to create per-thread log files.
  • T — Create per-thread log files.
  • F — (Default) Do not create per-thread log files.

Was this page helpful? Yes No Submitting... Thank you

Comments