Accessing the v10 Tech Preview from HCL OneTest API

You can access the v10 Tech Preview from HCL OneTest™ API so that you can retrieve the secrets configured for a project and stored on the v10 Tech Preview.

Before you begin

Before you use the HCL OneTest API to access the v10 Tech Preview, certain tasks must be completed:
  • You must have installed and configured the v10 Tech Preview.
  • You must have set up your project and created a secrets collection in that project.
  • You must have logged in to the v10 Tech Preview and copied the offline token generated by using the Offline Token option from the Overflow menu in the v10 Tech Preview Header. You must have retained the token copy because this offline token is used in HCL OneTest API. See Generating an offline token.

About this task

After you have generated an offline token in the v10 Tech Preview, you must configure HCL OneTest API to access the v10 Tech Preview.

Procedure

  1. Open your project. From the HCL OneTest API window, click Browse to browse to the location of your project, select the project, and click OK.

Adding the offline token by using the Project Settings option

  1. Open the v10 Tech Preview tab from Project > Project Settings > v10 Tech Preview. In the v10 Tech Preview tab window, complete the following steps:
    1. Click the Enable v10 Tech Preview support check box.
    2. Enter the Host name of the server hosting the v10 Tech Preview in the Secure host field.
      Note: Enter the Host name and not the URL. The default port configured is 5443. If you have configured a different port, enter that port number.
    3. Paste the offline token you copied that you generated by using the Offline Token option from the Overflow menu in the v10 Tech Preview Header.
    4. Click SSL, select an option if different from the one selected and then click OK.
    5. Test the connection to the v10 Tech Preview by clicking Test.

      A Connection OK dialog box is displayed for a successful connection. An error dialog box is displayed for an unsuccessful connection.

    6. Select the project on the v10 Tech Preview that you want to access by completing the following steps:
      1. Click Select under the Project panel.
        Note: The projects on the v10 Tech Preview that you can access are displayed implying that the connectivity to the v10 Tech Preview is enabled with the use of the offline token.
      2. In the Select Project window, click the project you want from the list.
      3. Click OK.
      4. Click OK to save the v10 Tech Preview settings.

Adding the offline token by using the Project Preferences option

  1. Click Project > Preferences > Server Settings. In the Server Settings window, complete the following steps:
    Note: You can add the offline token using this option to enable the access to the v10 Tech Preview in methods that require an offline token, for example, when running tests from the command-line client.
    1. Click the Show server URL validation failed dialog check box.
    2. Paste the offline token in the v10 Tech Preview Offline Token field.
    3. Click Apply and then click OK to apply, save, and exit from the dialog.
    Note: If you have added the v10 Tech Preview offline token by using the Project Settings option, the same token is displayed in the Preferences for the Server Settings.

    You can view the offline token that you added, which gets stored in the .userProfile file located in .integrationtester subdirectory of the User's home directory. See Locating the used offline token.

Results

You have configured HCL OneTest API to access the v10 Tech Preview.

What to do next

You can retrieve the secrets created and stored in a secret collection on the v10 Tech Preview from HCL OneTest API. For instructions, see Retrieving secrets from the v10 Tech Preview.

Feedback