ProcessMaker API Documentation
ProcessMaker Examples

Export a Collection

Export a Collection.

Overview

Export a Collection to your local computer. The exported Collection may then be imported to the same or another ProcessMaker instance of the same ProcessMaker version. An exported Collection may then be shared with others so they can import your Collection. If the Collection is a Saved Search of Collection records, it cannot be exported; export from the Collection itself.

When a Collection is exported, the following also exports:

  • Records: All records within that Collection export.

  • Screens: The Screens used to create, view, and edit records in that Collection also export.

The exported Collection has the .json file extension.

Export a Collection

ProcessMaker Package Required

The Collections package must be installed.

Permissions Required

Your user account or group membership must have the following permissions to export a Collection unless your user account has the Make this user a Super Admin setting selected:

  • Collections: Export Collections

  • Collections: View Collections

See the Collections permissions or ask your Administrator for assistance.

Follow these steps to export a Collection:

  1. View your Collections. The Collections page displays.

  2. Click the Export iconfor your Collection to export. If the Collection is a Saved Search of Collection records, it cannot be exported; export from the Collection itself. The Export Collection page displays.

  3. Click Export. ProcessMaker prepares the Collection for export and a Download button displays when the export file is ready.

  4. Click Download, then browse for the location on your local computer to save the exported Collection.

  5. By default, ProcessMaker exports the Collection using the original Collection name except spaces in the name are replaced with underscores (_). The file has the file extension .json. Rename the default file name if necessary, though do not change the file extension. As a best practice, specify in the file name that this is an exported Collection to distinguish it from other exported assets.

  6. Specify a directory location to save the file. ProcessMaker exports the .json file to your local computer. The following message displays when the Collection exports successfully: The collection was exported.

Related Topics