Bulk importing frameworks

Bulk import frameworks if you need to avoid time-consuming manual data entry or migrate data from another system.

You can also update multiple frameworks at once using sessions in Bulk Importer. For more information, see Update existing frameworks in bulk.

How it works

You open a new Bulk Importer session and download the Excel template from the Bulk Importer page in the Launchpad. You prepare data in the template and then you upload the template in the Bulk Importer page.

Where are the uploaded frameworks?

Once you upload frameworks, the data is available in:

the Frameworks app

Workflow

Permissions

Only System Admins can bulk upload HighBond resources from Bulk Importer.

Upload new frameworks in bulk

Note

Interface terms are customizable, and fields and tabs are configurable. In your instance of HighBond, some terms, fields, and tabs may be different.

Open a new Bulk Importer session and download the Excel template

  1. Open Launchpad.

    Note

    If your company uses more than one instance in Launchpad, make sure the appropriate instance is active.

  2. Select Options > Organization.

    If you do not see Organization as an option, the account you used to sign in does not have Admin privileges.

  3. Under Bulk Importer, click Manage bulk resources.

    A new Bulk Importer session begins, with the session ID appended to the URL.

    Caution

    Always begin a new session to add new resources, else you may lose previously uploaded data.

    Note

    You can use previous sessions to update previously uploaded data. For more information, see Update functionality in the Bulk Importer.

  4. Under Select resource, select one of the following options in the resource type:

    • Frameworks > Project types To create frameworks by project type. The template is dynamic and has built-in configurations of the selected project type. Using this option, you can create multiple HighBond resources (projects, frameworks, objectives, risks, controls, and mitigations), based on a project type.
    • All resources To bulk import all resources at once: projects, frameworks, objectives, risks, controls, mitigations, issues, actions, requests, entities, and compliance maps. The template is static and it takes some effort to complete, as you will have to figure out the configuration of the resources manually.
  5. Click Download .xlsx Template.

    The Excel template saves to your local machine.

Prepare data in the template

  1. Open the downloaded template and go to the Frameworks worksheet. If it is a dynamic template, the name of the worksheet is a combination of the resource and its project type ID. For example: Frameworks-85692.
  2. Copy and paste or enter your data into the template. For help with entering data, see Tips for preparing content.
    Note
    • If you use Add-In for Excel, ensure the ACL Add-In option is disabled before modifying the Excel template. To learn how to do it, see Configuring Add-In for Excel.
    • Do not change the name of the worksheet or the fields. These are case sensitive and must not be modified.
    • The maximum number of rows that can be uploaded at once is 2000 (including all the worksheets).
    FieldDescription

    referenceId

    mandatory

    Specifies a unique ID for the resource. This must be unique for each row in the worksheet.

    It can contain a combination of text and numbers, and the maximum length is 255 characters.

    This field is the primary key for each row in the template. You will need this key if you want to update this resource again.

    Important

    You can use reference IDs to associate resources to one another, on the fly. For example, you can create a new project and a new objective associated to that project in the same upload. You can do this by creating a link between the project and the objective by providing referenceId in the required field.

    To learn more about associating HighBond resources in Bulk Importer, see Using reference IDs to link resources in Bulk Importer.

    Note

    Reference IDs are required when you add or update resources using the Bulk Importer. They are not available when you add / update resources from the user interface of HighBond.

    name

    mandatory

    Specifies a descriptive name for the framework.

    The maximum length is 120 characters.

    For information about frameworks, see Managing information using frameworks .

    description

    Specifies detailed description of the framework.

    Tip

    Use HTML tags to format text. For example: <b>, <i>, <ol>, <ul>.

    background

    Specifies contextual circumstances of the framework.

    purpose

    Specifies the intended results, aims, or goals of the framework.

    projectTypeId

    mandatory

    (static template only)

    Specifies the project type associated with the framework.

    The project type ID is available in the URL when you navigate to that project type.

    For example:

    https://stark.projects.highbond.com/
    audit_types/36245/description
    , where 36245 is the project type ID.

    For more information, see Workflows and project types.

    scope

    Specifies things that are covered by the framework

    riskAssurance

    Specifies the status of the Risk Assurance feature for the framework.

    • True: Enabled.
    • False: Disabled.

    The default is false.

    For more information, see Getting started with assurance for risk.

    entities

    Specifies entity IDs of the entities that are tagged to the framework items.

    You can find entity ID in the URL when you navigate to an entity.

    For example: 

    https://stark.projects.highbond.com/
    auditable_entities/33055
    , where 33055 is the entity ID.

    You can provide multiple IDs separated by commas.

    Note

    Alternatively, in this field, you can provide reference ID of a new entity that you have added in the current template. This will associate the framework with the entity when you upload the template.

    To learn more about associating HighBond resources in Bulk Importer, see Using reference IDs to link resources in Bulk Importer.

    For more information about entities, see Setting up entity tagging.

    folderName

    Specifies the folder name of the framework.

    customAttributes_1_term - customAttributes_n_term

    Specifies custom attribute fields 1 through n.

    The custom attributes in the Excel template depend on the type of template, as follows:

    • Frameworks > Project types: By default, the template will contain the custom attribute fields defined in the project type.
    • All resources: You have to manually check and enter the custom attribute fields, both the term and the value. The template will have one pair of custom attribute term and value, and you can add four more pairs if required. To add, follow the same naming convention by adding a counter, for example: customAttributes_2_term, customAttributes_2_value, etc.

    The custom attributes of a project, framework, and their components are defined in the project type. For more information about custom attributes, see Customizing terms, fields, and notifications.

    customAttributes_1_value - customAttributes_n_value

    Specifies custom attribute values 1 through n.

    The custom attributes in the Excel template depend on the type of template, as follows:

    • Frameworks > Project types: By default, the template will contain the custom attribute fields defined in the project type.
    • All resources: You have to manually check and enter the custom attribute fields, both the term and the value. The template will have one pair of custom attribute term and value, and you can add four more pairs if required. To add, follow the same naming convention by adding a counter, for example: customAttributes_2_term, customAttributes_2_value, etc.

    The custom attributes of a project, framework, and their components are defined in the project type. For more information about custom attributes, see Customizing terms, fields, and notifications.

    Note
    • If a value begins with a square bracket or contains a comma, semicolon, or a line break, enclose the value in double quotation marks (" ").
      For example: "[2021]", "First, second asset", "This is important; this too".
    • For a multiple choice field, you can add multiple values by separating each value with a comma.
    • For a drop-down or a multiple choice field, ensure the values are exactly the same as provided in the options.
    Note

    In the dynamic template, for a drop-down field, the options in the drop-down list appear only for the first row. To get those options for more rows, copy the first row and paste it to the rows required.

  3. Save and close the template.

Tips for preparing content

Preparing content involves:

  • copying and pasting your source data into the Excel template
  • entering data, where applicable, in the Excel template
  • saving the template in preparation for bulk upload

Using reference IDs to link resources in Bulk Importer

Reference ID is a field in the Bulk Importer Excel template. It is the first field in all the worksheets and is available for all the resources. It is a unique identifier for each record in the worksheet.

Using reference IDs, you can associate HighBond resources to each other, on the fly. For example, you can create a project and an objective that is associated to the project in the same import. You can do this by providing referenceId in the required field.

Upload data

Do one of the following:

  • Drag and drop the template into the browser window.
  • Click Choose from your computer and select the updated template from your computer.

    Only one Excel template can be uploaded at a time (each file is validated separately).

  • Result A success or failure message appears depending on the outcome of the process, and the latest session is updated in the Sessions table.

Sessions in Bulk Importer

A session is a series of user interactions to import HighBond resources using the Bulk Importer.

Each user session is recorded in the Sessions table. You can view the Sessions table in the Bulk Importer page when you scroll down.

Update existing frameworks in bulk

You can update multiple items at once in Bulk Importer using sessions.

Note

You can only update resources that you have uploaded using Bulk Importer.

Troubleshooting

You can download and check the error log from the Sessions table. Understand common bulk upload errors and learn how to fix errors.

The following table provides a list of possible errors that may occur when uploading the template.

Error Solution(s)
There may be more than 2000 rows in the uploaded file (including all the worksheets). Remove the extra rows from the template and re-upload.
Mandatory fields may be blank or missing in the uploaded file. Ensure that all mandatory fields (marked with red and orange column names in the template) are completed.
Note

If you do not provide data in the mandatory fields, the row is not processed.

Data format may be incorrect.

Ensure that data in text fields is valid and does not exceed the maximum field length: 255 characters.

Rich text fields do not have a character limit.

Data values may be invalid or may not match the drop-down values.

For example: The value for received and sendRecurrentNotifications fields in the Requests sheet must be True or False.

Invalid fields in the template.
  • Do not add new fields to the template.
  • Do not remove fields from the template.
Template may not be in expected format.

Ensure the file format is .xlsx.

Invalid worksheet names.

Do not change the name of the worksheet.

Session may have expired.

Refresh the page and try uploading again.

Session ID may be invalid. Ensure you are using a web session ID.