Export definitions and export files
Export definitions record export settings, such as the layout options and the file type of the export data. If you save an export definition, users can run an export with those settings again, either as an action or with the Anaplan Integrations API
Any time you run an export, it creates a file containing the exported data that you can download. When you run the export as an action in the model, the export file downloads automatically.
With the API, you can:
- Get a list of available export definitions.
- Run an export from a definition.
- Monitor the export as it runs.
- Download the export file when it's ready.
When you configure the privacy level for your export, you can choose for the file the export generates to save as private. If you do this, other users can run the export from the saved definition to generate an export file. However, the data that exports is determined by each user's access rights, and only the user who runs the export can download the file that export generates.
If you set an export to share with administrators only, then only workspace administrators can download the file. Other users who try to download the file with the API receive an empty file.
If you set an export to share with everyone, any user can download the file.
Private files expire after 48 hours. If an API user tries to download a private export file and it's expired, but there's a shared file available, they receive the shared file instead.
Configure the privacy level
When workspace administrators run an export, they can select the Save Export Definition checkbox in the bottom left of the Export dialog. They then have the option to name the export and choose whether it generates a private file or a shared file. In the Set as default file for dropdown you can select:
- Myself (keep private) to generate a private file.
- Administrators only to generate a file that workspace administrators can download.
- Everyone to generate a file anyone with user access to the model can download.
The export generates private files by default.
Recommended privacy level
We recommend that you always set export files as for Administrators only.
Export files shared with Everyone are available to all users in your Anaplan environment via the Anaplan API. When a workspace administrator generates an export, the export ignores selective access. This means, if you do not limit access to administrators, non-workspace administrators could download data they cannot access to in the model.