Import HighBond Projects data

Concept Information

IMPORT GRCPROJECT command

You can create an Analytics table by importing data from the projects that you have permission to work with in HighBond Projects.

You can import a variety of different types of tables from Projects that collectively contain all the text-based information in all the active projects for a HighBond instance.

How the information can be useful

You can use the information imported from Projects to perform different types of analysis. For example:

Record length restriction

The maximum record length you can import into Analytics is 32,767 characters, or 16,383 Unicode characters.

If you try to import data from Projects that exceeds the maximum you get an error message and the import fails. Try removing large narrative fields from the import to reduce the record length.

Another approach is to perform the import using the IMPORT GRCPROJECT command in the Analytics command line. When you use the command, you can include the CHARMAX parameter, which allows you to specify a maximum number of characters in each imported field. For more information, see IMPORT GRCPROJECT command.

Steps

Note

You may be required to specify a password when you connect to HighBond. For more information, see Password requirement.

  1. Select Import > HighBond > Projects.
  2. In the Select data to import dialog box, double-click the organization folder.
  3. Double-click the folder for the table you want to import.

    Note

    You can import only one table at a time to Analytics. You can subsequently join tables imported from Projects if they have a common key field.

  4. Select the fields you want to import, or select Select All to import the entire table, and click OK.

    The data is imported from Projects. To improve usability of the imported table, any rich-text fields with HTML markup are positioned last.

  5. In the Save Data File As dialog box, enter a name for the Analytics data file, and if necessary modify the location where the file will be saved, and click Save.
  6. Enter a name for the Analytics table you are adding to the Analytics project, or keep the default name, and click OK.

    Note

    Analytics table names are limited to 64 alphanumeric characters, not including the .FIL extension. The name can include the underscore character ( _ ), but no other special characters, or any spaces. The name cannot start with a number.

Joining tables imported from Projects

After you have imported tables from Projects to Analytics, you can join them to assemble part, or all, of the text-based information in your projects.

The diagram below shows how the various tables in Projects are related, and provides the common key fields that you can use to join the tables once you have imported them.

The target_type field in the Issues and Time Entries table is not a key field. Instead, it identifies the particular type of table each issue or time entry is related to. You can use the target_type field to filter a join so that it includes only the table relations you are interested in.

Tip

When you construct the join in Analytics, make id the primary key, and <table>_id the secondary key.

Use the join type that includes all secondary records, or a many-to-many join. For more information, see Joining tables.

Password requirement

Password not required

You do not need to specify a password to import from HighBond if you used online activation to activate your copy of Analytics. The password is automatically created and sent to HighBond based on activation information stored on your computer.

Password required

You do need to specify a password to import from HighBond in either of these situations:

  • you used offline activation to activate your copy of Analytics

  • you use a script to import from HighBond, and you run the script in Robots

The required password value is a HighBond access token.

Acquire a HighBond access token

Caution

Safeguard your access token like any account password. It contains information unique to your HighBond account. You should not share access tokens.

Use an existing access token unless you have a reason for creating a new one. If the existing token does not work, create a new one. Using an existing token cuts down on the number of tokens you need to manage.

  1. Do one of the following:

    • From the Analytics main menu, select Tools > HighBond Access Token.

    • In the Script Editor, right-click and select Insert > HighBond Token.

    The Manage API tokens page opens in your browser. You may be required to first sign in to HighBond.

    Access to the Manage API tokens page through Analytics is a convenience feature. You can also sign in to HighBond and access the page through your user profile without using Analytics.

  2. Do one of the following:

    • Use an existing token

      1. In the Token column, click the partially masked token that you want to use.

      2. Enter your HighBond account password and click Confirm.

        The unmasked token is displayed.

      3. Click Copy to copy the token.

        Tip

        Do not close the dialog box containing the token until you have successfully pasted the token.

    • Create a new token

      1. Click Add token > Analytics.

      2. In the New Analytics token side panel, specify the following information:

        Field or option Description
        Description

        Enter a description that provides useful information, such as:

        • The purpose of the token
        • Where the token is used – for example, the name and location of the Analytics script, or the name and location of the robot task
        Token expiry
        • Enabled the token expires after the number of days that you specify
        • Disabled the token never expires

        Note

        Your organization may have a security policy that requires tokens to expire after a certain amount of time. Creating tokens with an expiry is a good practice. HighBond sends you an automated email notification in advance of the expiry date.

        Expires in Specify the number of days before the token expires (1 to 365).
        Password Enter your HighBond account password.

      3. Click Generate token.

      4. Click Copy to copy the token.

        Tip

        Do not close the side panel containing the token until you have successfully pasted the token.

  3. Depending on which data access and password definition method you are using, do one of the following:

    Analytics user interface

    Paste the copied token into a password prompt that appears when accessing HighBond manually.

    Analytics script

    • PASSWORD command Paste the copied token into a password prompt that appears during script execution.

    • SET PASSWORD command Paste the copied token at the appropriate point in the SET PASSWORD command syntax in a script.

  4. In Launchpad, close the dialog box or the side panel containing the token.

    If you created a new token, a partially masked version of the token is added to the top of your list of tokens.

    For more information, see Creating and managing HighBond access tokens.