How to Import Data

For security and privacy concerns, only organization’s owner can import data. Also, the importer will only be available if you have HIPCHAT_IMPORTER_ENABLED set to 1.


You can find an entry on sidebar menu, right above the “go to chat” button:


After clicking on this item, you’ll the the import data page.

Select files


Besides the file, there are 3 options available:

  • exclude all data: removes all your organization data except your user and the organization itself. This should be enabled only if you have a fresh installation of Grape or want to reset your data;

  • NLP Processing: if enabled, all messages will be processed by our NLP algorithm. Grape’s natural language processing system annotates your messages, so you can browse – for example – all decisions, tasks and questions of a project with one click. This option must be enabled for your organization;


  • Link Preview: Generate link preview for all new messages. This feature must be enabled for your organization.

For the link preview generation and NLP, the process will only consider messages within one month from the last imported message and a maximum of 1000 messages

Follow the Process

After the process starts, you can either just close the window or follow the process:


In both cases, you’ll receive an email when the process is done.


If for any reason you need to abort the process, you can just click on the following button:


And confirm the action:


The process should stop immediately.

Past Import Processes

You can see a list of past imports, and the active import, on the initial screen where the file was uploaded and the process started. Just click on any process to see more details.


Command Line Interface (CLI)

The grape importer also comes with a command line interface that does exactly the same thing and can be followed either the terminal itself or on the GUI.

It takes the same options the GUI plus an extra option to detach the process from the terminal.

However, in this case, the compressed file must be given and not uploaded.

Step by step guide

  1. Copy the file to be imported (.tar.gz) to the media folder of Grape, so the Grape runtime container can access it. (/data/grape/data/application/media/<import_file.tar.gz>)

  2. Make sure there is enough diskspace: roughly the size of the import file × 2. df -h

  3. Open a shell in the runtime container: docker exec -it application_grape-runtime_1 bash

  4. Make sure that the hipchat importer is enabled: env | grep HIPCHAT_IMPORTER_ENABLED this must be True or 1. if this is not the case, add this variable in the websetup to the grape-extra.env and restart the Grape server.

  5. Start the import:

    1. source venv/bin/activate

    2. cd code

    3. ./ hipchat_importer -f /srv/media/<import_file.tar.gz> -o <ORG_ID> -c

      • <ORG_ID> - your organization id, usually 1.

      • -d to detach it from the shell (optional)

      • -u to generate link previews for all messages which contain links. (optional)

      • see all options below or with ./ hipchat_importer -h

CLI Importer Reference

./ hipchat_importer -h

usage: hipchat_importer [-h] -f FILE_PATH -o ORG_ID [-c] [-u] [-n]

optional arguments:
  -h, --help            show this help message and exit
  -f FILE_PATH, --file FILE_PATH
                        Path to compressed file
  -o ORG_ID, --organization ORG_ID
                        ID of the Organization
  -c, --clean           Completely clean the organization
  -u, --unfurl          Generate link preview for all new messages
  -n, --nlp             Apply NLP to all new messages
  -d, --detach          Detach process from terminal

User will see progress bars as on GUI: