Configure the tutorial system

Prepare your system so that you can complete the tutorial.

Before you begin

Before you begin the tutorial, make sure that you review the Prerequisites.

About this task

To complete the tutorial, you must have access to an installation of HCL Accelerate 1.3 or later. You can complete the tutorial using any edition of the product.

Your user ID must have sufficient permissions to access the API and create dashboards. The products, including HCL Accelerate, use team- and role-based security. Teams own user-created objects, such as value streams and deployment plans. All team members can access team-owned objects, although team members might have different permissions. Some users might only be able to view team objects while others can create and edit them. Permissions are granted to roles. When an administrator assigns a user to a role, the user inherits the permissions granted to the role. Users can be in multiple team roles. For example, it's typical for a team member to be in the Team Administrator role in addition to any other role that they might be assigned. Users can also be on multiple teams and be in different roles on each one. On the tutorial team, your user ID should be assigned to a role with the required permissions, such as Lead Developer.

Note: If you are the HCL Accelerate administrator, you can use the Default team. The system admin role is automatically assigned to this team, and it has all permissions.

In addition to a team and a role, you need a user access token, and the tenant ID for your HCL Accelerate installation.

Finally, you need the curl utility, or a another tool that manages HTTP requests. The tutorial examples use curl.

To prepare the tutorial teams, complete the following steps:


  1. Create a team that you can use throughout the tutorial.
    If you do not have administrative privileges, ask your administrator to create a Tutorials team for you.
  2. On the Tutorials team, assign your user ID to the Lead Developer role or a group that has this role.
    A Tutorials team is ideal for new users who are onboarding by working through the tutorials. You might want to create an user ID that is only assigned to the Tutorials team, and can be used by all new users.
  3. Generate a user access token for the user ID that you will use to complete the tutorial.
  4. To obtain the tenant ID of your HCL Accelerate installation, complete the following steps:
    1. On the Value Streams page, create a value stream.
      All your value streams have the same tenant ID so if you already have a value stream, you can use that one instead.
    2. On the value stream detail page, click Download Sample.
      The value_stream_name.json file is downloaded to your computer.
    3. Open the JSON file and copy the value for the tenantId property.
      Save the tenant ID in a safe location. You use it whenever you upload data to HCL Accelerate.
  5. Create an Insights dashboard that you can use in the tutorial.


The team is ready to begin the tutorial.