Project Export & Import

Project Export & Import#

This page provides instructions on how to export and import Squirro projects using both the Squirro user interface (UI) and the SquirroClient.

Export Project#

You can use the Export Project feature within your project settings to create a full downloadable export of a Squirro project.

Export via the UI#

To export a Squirro project via the UI, follow the steps below:

  1. Open your Squirro project in your browser.

  2. Navigate to the Setup space using the Spaces Navigation menu in the top-right of the page.

  3. Click the Settings tab.

  4. Click Export Project from the left sidebar menu.

At this point, many options are provided that can be selected or deselected to fine-tune the export as shown in the image below:

image1

After clicking Export Project, a project archive is created that can be downloaded in the browser.

Note: By default, everything will be included except e-mail templates and Squirro Items.

Caution: For larger projects, the archiving process may take a few seconds. Allow the process to complete without clicking away from the screen.

Export via SquirroClient#

Alternatively, the Export Project studio plugin is backed by Squirro serverside APIs. This means that you can also use the SquirroClient to export a project.

When exporting a project, make sure to set the write_to_disk flag to True. This will ensure that the exported project will be directly written on your local file system in the current folder.

Also note that the Squirro objects to export can be controlled by setting the corresponding boolean flags to True or False.

Export with the SquirroClient using the following code:

squirro_client.export_project(project_id=PROJECT_ID, write_to_disk=True)

File Format#

Files are downloaded in a sqproj format. The sqproj file type is simply a tar.gz file consisting mostly of JSON files.

Import Project#

Note

Importing a project file is not the same as importing a project template. If you would like to create a project template from your exported file before uploading, see Project Templates Overview.

Squirro Project archives created via the Export Project process discussed earlier can be imported through the Squirro user interface (UI) in your browser.

Tip: Although importing projects through the Squirro UI is recommended, it is possible to extract the file and manipulate the contents manually.

How To Import a Project#

To import a Squirro project, follow the steps below:

  1. Open your Squirro project in your browser.

  2. Navigate to the Setup space using the Spaces Navigation menu in the top-right of the page.

  3. Click the Settings tab.

  4. Click Import Project from the left sidebar menu.

At this point, the screen shown below will appear:

image3

  1. Using the file browser, select your downloaded project template (sqproj file) from your machine.

  2. Click Import.

After clicking Import, your project will load.

Caution: For larger projects, the import process may take a few seconds. Allow the process to complete without clicking away from the screen.

Contents