ProcessMaker API Documentation
Script Central

Delete a Collection

Delete a ProcessMaker Collection.

Delete a ProcessMaker Collection

ProcessMaker Package Required

The Collections package must be installed in your ProcessMaker instance. The Collections package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Collections package can be installed in your ProcessMaker instance.

Permissions Required

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

  • Collections: View Collections

  • Collections: Delete Collections

These permissions are different than record permissions in a ProcessMaker Collection that allow you to view or delete records in that Collection.

See the ProcessMaker Collections permissions or ask your ProcessMaker Administrator for assistance.

When a ProcessMaker Collection is deleted, all records in that Collection are also permanently deleted. However, the ProcessMaker Screens used in that Collection are not affected.

Deleting a ProcessMaker Collection from the Collections page cannot be undone.

Follow these steps to delete a ProcessMaker Collection:

  1. ‚ÄčView your ProcessMaker Collections. The Collections page displays.

  2. Click the Delete iconfor your ProcessMaker Collection to delete. The Caution screen displays to confirm the deletion of the ProcessMaker Collection.

  3. Click Confirm.

Related Topics