Project settings

You can view the project settings by selecting Project > Project Settings from the main HCL OneTest™ API menu. You can view and edit the properties for project, server settings, date formats, change management, quality management, permission settings, permissions, results publishers, and APM preferences. You can also create an email publisher or switch users on a project.

The following dialog box is displayed where you can view or edit various properties and settings for the current project.

Image of the Project settings window.
For project tasks, see these topics:

Project properties

The Project tab contains summary information about the current project.

Image of the Project properties tab.

The fields in the Project tab are described in the following table:

Location The full path where the project can be found.
Name A meaningful name to help identify the project.
Owner The project’s creator or owner
External Documentation Prefix The root directory where external documentation for HCL OneTest API artifacts is stored.
Rule Cache URI The location where validation rules are stored for the project (%%PROJECT/ROOT%%Rules, by default).
Inbuilt Certificate Authority The internal certificate authority for the project.
Comments User-defined comments that can be used to enter information that might be relevant to the project.

Server Settings

Use the Server Settings tab to manage JDBC connection details for the results database, which can be specified when you are creating the project, or the HCL Quality Server URL.

Use the fields under Results Database to create or modify a database connection. Select the provider, and enter the connection details about where and how the database is set up for HCL OneTest API. For more information on the specification of database URLs when using IP literal addresses, see IP literal address.

To test the provider and connection settings, click Test Connection. If the test is successful, no further configuration is required. If the test is unsuccessful, you must verify that the connection settings are correct and try again.

Under HCL Quality Server, specify the URL for the server. The server URL (https://localhost:5443/RTCP, by default) must point to the base URL of the server instance that runs published stubs and manage scheduled execution (for more information, see HCL OneTest Virtualization). Optionally, click Open to open an instance of the server.

The default domain name to use when publishing stubs to HCL Quality Server. Optionally, click SSL to specify SSL connection details for that server instance. The Server SSL Options dialog opens. Select one of the following options:
Trust all certificates
Use this option to accept any certificate that is presented by the server.
Trust certificates signed by the inbuilt certificate authority
Use this option to accept any certificate presented that was signed by the inbuilt certificate authority.
Trust specific trust store
Use this option to select a specific Java™ keystore within the project, which contains the trusted certificates that can be used to verify the certificate that is presented by the server.
If you configured a results database and a server URL, you can publish the details of your results database to the server. The results of your test suite can then be viewed on a web browser. To do so, click Publish results database connection. The results can be used in the Results Gallery of server.
Note: The server stores the results against individual project names. Hence, the results of two projects with the same name cannot be published to the server.

Date formats

By using the Date Formats tab, you can define the output format of certain date and datetime tags in HCL OneTest API (for example, TEST / START_DATE).

For more information, see Formatting and parsing date-time patterns.

v10 Tech Preview

Use the v10 Tech Preview tab to set up access to the v10 Tech Preview. For more information, see Accessing the v10 Tech Preview from HCL OneTest API.

Quality Management settings

The Quality Management tab is used to manage quality management systems that can be used with HCL OneTest API.

HCL OneTest API can be integrated with IBM® Rational® Quality Manager.

Quality Management settings

For more information about these project settings fields see, Configuring an Rational Quality Manager integration.

Change Management settings

The Change Management tab is used to manage change management systems that can be used with HCL OneTest API.

HCL OneTest API can be integrated with several change management tools including IBM Rational Team Concert™.

Change Management settings

For more information about these project settings fields see, Setting up the integration with the change management tools.

APM preferences settings

The APM preferences tab is used to manage connection to APM servers that can be used with HCL OneTest API.

HCL OneTest API can import service or transaction data from IBM Tivoli® Composite Application Manager for Transactions.

For more information about these project settings fields see, Using the HCL OneTest API UI to import data from Tivoli Composite Application Manager for Transactions.

Permission settings

The Permissions Settings tab is used to manage whether permissions are enabled for the project. You can select from three options: (none), HCL Quality Server, or Active Directory. If you choose HCL Quality Server, follow the instructions that are provided on that panel. If you choose Active Directory, then set values including the host information, and the password for the project administrator. You can add or modify the password of the project administrator by entering it in the Admin password and Confirm fields. The password that is entered in each field must match. Also see Specifying data masking permissions.

Note: After permissions are enabled on a project, only the project administrator has access to the Permissions Settings tab.
Note: You can use LDAP for HCL OneTest API project authentication, by configuring HCL Quality Server to use LDAP for authentication, then by using HCL Quality Server as the authentication provider in the project. (LDAP is not an option in the authentication provider list in project settings). For more information about how to configure LDAP, see Modifying security model settings after installation.


The Permissions tab is used to manage which users have access to the project and the areas of the project to which they have access.

Note: Only the project administrator has access to the Permissions tab.
Note: A valid domain login must be supplied before a project administrator can access the list of available users and groups. You are prompted to log in when you add users. You can log in to the project as a different user by selecting Switch user from the Project menu in HCL OneTest API.

Users can be added to the project by clicking Add and locating the users in the search dialog that is displayed.

Enter a search string (multiple strings can be used, separated by semicolons) and click Search. To add any of the located users or groups to the project, select them and click Add Selected.

Note: Users or groups that were added to the project are not displayed in the filtered list.

For users or groups that are added to the project, permission to perform certain actions must be explicitly allowed or denied. Use the appropriate check box to do so. Permissions can be set for multiple users at the same time.

Tip: To quickly allow or deny all available actions for the selected users or groups, right-click anywhere within the Actions table and select Allow All or Deny All from the menu.

To remove a user or group from the project, select its entry in the current list and click Remove.

Also see Specifying data masking permissions.

Results publishers

The Results Publishers tab is used to manage results publishers that can email test suite results or publish results to a configured CentraSite server. Details about configuration within a test suite can be found in Test suites: Overview and tasks. For more information, see Testing Software AG CentraSite.

Results publishers

For each publisher in the list, the following details are displayed:

  • Name: the name that is given to the publisher when it was created (the name cannot be modified once the publisher is created) and the publisher type
  • Default: which publisher (if any) is designated as the default for all test suites (the default publisher cannot be set here, but it can be removed)
  • Enabled: whether the selected publisher is enabled for use in test suites

Click Add to create a publisher. To modify the configuration of the selected publisher, click Edit (see Creating an email publisher for more information on publisher configurations). To delete the selected publisher, click Remove.

To modify the publication settings of the default publisher, select it and click Edit Defaults (see Results publisher settings for more information).

To remove the "default" designation of the default publisher, select it and click Remove Defaults.This action does not delete the publisher. To designate a new default publisher, use test suite editor.

Publishing can be enabled or disabled on a project-wide basis by toggling the results publishing icon HCL OneTest API main toolbar.

Results publishing icon