Configure VTS
VTS includes a number of settings that define certain aspects of how VTS operates.
Note: OpenText encourages you to ensure secure configuration and proper hardening of the VTS server—this is not provided by OpenText. You can use the useSSL configuration setting.
If you do not implement secure configuration and proper hardening, you may expose the system to increased security risks. You understand and agree to assume all associated risks and hold OpenText blameless for the same. It remains at all times solely the responsibility of the customer to assess their own regulatory and business requirements. OpenText does not represent or warrant that its products comply with any specific legal or regulatory standards applicable to the customer while conducting the customer's business.
Modify VTS configuration settings
The configuration settings are stored in the configure.json file that is saved with the standard JSON format.
You can update the configure.json file. By default, the file is located in C:\Program Files\OpenText\VTS\web.
Note: If you modify the configuration file to a non-valid format, or add comments to the file, the VTS Service will fail to start.
VTS configuration settings
The configure.json configuration file includes the following settings:
Setting Key | Explanation |
---|---|
dbPath |
The stored path of the VTS database. Default install path: C:/ProgramData/OpenText/VTS/db/data |
defaultDbName |
The name of the VTS database. The default name is Default. Recommended: Do not modify this setting. |
adminPort |
The TCP port that is used for Admin UI access to VTS. This port is used by the VTS UI to read and modify data in the VTS table. The default value is 4000. Note: The port used for Admin UI access must be different from the port used for Vuser script API access. |
defaultApiPort |
The default port that Vuser scripts use to access the VTS table using API functions. If you use the VTS UI to change the API access port, the new port number will override the default value. Default: 8888 |
defaultStart |
Specifies whether or not API access to the VTS table should be enabled when the VTS Service service is started. Default: false |
enableDiag |
Enables the VTS diagnosis feature. If set to true, you can access the following URL to view logs, apis, and meta data: http://vts_server_name:4000/data/diag Default: false |
autoRefreshGrid |
When the data is changed by an API or by another Admin UI, the Admin UI automatically refreshes itself to show the updated data. This is the default behavior. If this is affecting the performance of the load test, set this key to false. Default: true |
maxInstancesAllowed |
VTS supports multiple instances. Use this setting to configure the maximum number of instances that VTS should support. Default: 50 |
autoCreateIndexedColumn |
When set to true, each column is automatically indexed. Default: false |
normalizeCSV |
When set to true, VTS will normalize non-strict CSV files when the rows do not have the same separators. Default: false |
authentication |
Default: None |
users | When authentication=Basic, specify the list of users that are registered to access the VTS table from the VTS user interface.
Note: If multiple users are listed, insert a comma between each line in the list, as shown below:
|
role |
For both Basic or NTLM authentication, you can assign the user roles: full-control administrator, or read-only user. Example
Note:
|
requireBasicAuthForAPI |
When authentication is set to Basic, and requireBasicAuthForAPI is set to true, the user name and password are required when accessing VTS data from the API level. The setting does not affect VTS admin UI. Default: false |
domain | When authentication is set to NTLM, specify the domain. |
domaincontroller |
When authentication is set to NTLM, specify the domain controller. If the specified domain controller uses LDAPS: |
ldapsCert |
When domaincontroller is set to a value that uses LDAPS, specify the file path of the LDAPS client certificate (if required by the domain controller server). Use the format: |
ldapsCA |
When domaincontroller is set to a value that uses LDAPS, specify the file path of the LDAPS client CA (if required by the domain controller server). Use the format: |
useSSL |
Specifies whether or not HTTPS should be used to access the VTS table from the VTS user interface. By default, useSSL is set to false. Tip: Instead of copying the key files described below to the same folder as node.exe, you can specify an absolute path to specify the files in another location. For example, To use SSL communication, set useSSL to true, and define the following properties:
|
defaultLanguage |
Sets the VTS server language. You can set the following languages: en, zh-cn, ja, ko, it, es, pt-br, fr, ru Default: en |
dbInfo |
Defines database settings. connPool: VTS maintains a pool of connections, to avoid the resources wasted on TCP handshake and close, and to help restrict the concurrent connections to the database server.
dbServerPort:
dbCheck:
|
logger |
Contains the settings for VTS's logging options. level. Specifies the level of logging performed:
transports. Specifies certain output options for logging.
|