ProcessMaker API Documentation
Script Central

Create a New Collection

Create a new ProcessMaker Collection into which to add records.

Overview

A ProcessMaker Collection uses at least two Screens to create, edit, and view records in that Collection:

  • Create a record: Have available a Form-type ProcessMaker Screen to create a record in the Collection. Ensure that this ProcessMaker Screen contains all the appropriate Screen controls required for authorized Collection stakeholders to create a complete record.

  • Edit a record: Either use the same ProcessMaker Screen that creates a record, or have available a second Form-type Screen to edit any record in the Collection. Ensure that this ProcessMaker Screen contains all the appropriate Screen controls for authorized Collection stakeholders to edit or update particular content of a record in the Collection. In many cases, the controls to create a record may be identical to those to edit a record. If you want to use a second ProcessMaker Screen, optionally make a copy of the Screen intended to create a record, and then make changes to it without needing to design a new Screen.

  • View a record: Have available a Display-type ProcessMaker Screen to view any record in the Collection. This ProcessMaker Screen may serve two purposes:

    • Provide a read-only view of a complete record: This allows authorized Collection stakeholders to view complete contents of any record in the Collection, but not edit or update it.

    • Limit the information displayed in a record: This allows authorized Collection stakeholders to view limited content of any record in the Collection to comply with specific legal or privacy requirements.

Ensure these ProcessMaker Screens are available before creating a new ProcessMaker Collection. You are not required to have the controls in these ProcessMaker Screens finalized, as you or an authorized ProcessMaker designer may change these Screens at any time. Doing so updates all records within that ProcessMaker Collection automatically.

Create a New 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: Create Collections

  • Collections: View Collections

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

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

Follow these steps to create a ProcessMaker Collection:

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

  2. Click the +Collection button. The Create Collection screen displays.

  3. In the Title field, enter the name of the ProcessMaker Collection. This name must be unique from all other ProcessMaker Collections. This is a required field.

  4. In the Description field, enter the description of the ProcessMaker Collection. This is a required field.

  5. From the Create Screen drop-down menu, select the ProcessMaker Screen from which new records in this Collection are created. This must be a form-type ProcessMaker Screen. This is a required field.

  6. From the View Screen drop-down menu, select the ProcessMaker Screen from which to view records in this Collection. Use this ProcessMaker Screen to only display all or parts of a record in the Collection. For example, the ProcessMaker Screen selected from the View Screen drop-down menu may be designed to not display sensitive information that all Collection stakeholders should have access. This must be a display-type ProcessMaker Screen. This is a required field.

  7. From the Edit Screen drop-down menu, select the ProcessMaker Screen from which to edit or update records in this Collection. This can be the same or a different ProcessMaker Screen as selected from the Create Screen drop-down menu. This is a required field.

  8. Click Save. The ProcessMaker Collection displays an empty list of records for that Collection so you may create your first record. See Create a Collection Record. Furthermore, the Collection icondisplays access to the ProcessMaker Collection from the left sidebar of the Collections page. See View Records in a Collection.

The ProcessMaker Collection also creates a Data Connector that uses the ProcessMaker Collection name so that Collection records can be acted upon from ProcessMaker assets. See Endpoints for ProcessMaker Collections.

Related Topics