This guide details the Export to Web Portal feature, which lets you send a Query Builder result set to the web portal as a background export package.
It explains how to run the export from Query Builder, what permissions are required, what happens after the export starts, and how to retrieve the generated package.
[!note] Note about the Web Portal
Before you begin, make sure to review the documentation about the Specify Web Portal! This is a standalone application, separate from Specify, that can either be self-hosted locally at your institution or managed by the SCC team on Specify Cloud.
You can export any query in Specify to a web-portal package ready to import using the Export To Web Portal button, available in the Query Builder:
Unlike CSV or KML export, this feature is specifically intended for the Specify Web Portal export workflow and produces a ZIP package in the background.
Notes
-
If the query contains duplicate record IDs, Specify will show a warning and prevent the export from starting. This is because each individual occurrence should be displayed once in the Web Portal and when exporting to other destinations.
-
The export is permission-aware and only appears when the user has access to both run queries and ‘Export to Web Portal’ permission. This needs to be given explicitly via a role or policy if the user is not already an Institution Admin.
Using Export to Web Portal
Opening Query Builder
Start by opening Query Builder and building or loading the query you want to export.
The feature is available from the Query Builder export controls once the query returns results.
Workflow
- Use an existing query or build a new one using the Query Builder.
- Verify the returned records are the ones you want to publish.
- Click Export to Web Portal.
- Wait for the completion notification.
- Download the generated ZIP package from the notification.
Once the generation beings, Specify:
- queues the export as a background task
- generates a ZIP export package based on the returned query results
- sends a notification when the export completes
- provides a download link in that notification
You can deposit the new ZIP export package in the specify_exports directory connected to your Web Portal instance. Once that is done, you can load the new data inside! If you need assistance, refer to the following:
For local installations: