ProcessMaker API Documentation
Script Central

Configure a Collection

Edit the configuration for a ProcessMaker Collection.

Configure 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 configure a ProcessMaker Collection unless your user account has the Make this user a Super Admin setting selected:

  • Collections: Edit Collections

  • Collections: View Collections

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

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

Follow these steps to configure a ProcessMaker Collection:

  1. View your ProcessMaker Collections. The Collections page displays.

  2. Click the Configure icon for your ProcessMaker Collection. The Configuration tab displays.

  3. Refer to the following sections to configure your ProcessMaker Collection. These configuration sections may be configured independently of one another:

Configure Basic Settings

Follow these steps to configure basic settings for your ProcessMaker Collection:

  1. Select the ProcessMaker Collection to configure. The Configuration tab displays. Use the Configuration tab to configure basic settings for your ProcessMaker Collection.

  2. Edit the following information in the Configuration tab about your ProcessMaker Collection as necessary:

    • Name: In the Name field, edit the name of your ProcessMaker Collection. Since this name displays in the left sidebar when the Collections top menu is selected, ensure that this is a descriptive name. This name is helpful for yourself and those with whom have access to this ProcessMaker Collection. This is a required field.

    • Description: In the Description field, edit the description of your ProcessMaker Collection. This is a required field.

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

    • From the View Screen drop-down menu, select a different 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.

    • From the Edit Screen drop-down menu, select a 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.

  3. Click Save.

Configure Record Permissions for ProcessMaker Users

Configure how ProcessMaker users have permission to access the records in your Collection. Permissions may be set differently for each ProcessMaker user. If a ProcessMaker user has the Make this user a Super Admin setting selected in his or her user account, then these settings have no effect on that user. ProcessMaker does not check permissions for ProcessMaker user accounts with this setting selected, allowing such users to administer and install packages which might otherwise require permissions be granted to a ProcessMaker user account to perform.

By default all ProcessMaker users do not have any access to records in your Collection unless a user has the Make this use a Super Admin setting selected.

Following are descriptions of each permission that specifies how a ProcessMaker user may access records in this Collection:

  • Create: A ProcessMaker user granted the Create permission is allowed to create records in this Collection. If a ProcessMaker user does not have the Create toggle key enabled, the +Record button used to create a record is not visible for that user.

  • Delete: A ProcessMaker user granted the Delete permission is allowed to delete records in this Collection. If a ProcessMaker user does not have the Delete toggle key enabled, the Delete iconused to delete a record is not available in all records for that user.

  • Edit: A ProcessMaker user granted the Edit permission is allowed to edit records in this Collection. If a ProcessMaker user does not have the Edit toggle key enabled, the Edit iconused to edit a record is not available in all records for that user.

  • View: A ProcessMaker user granted the View permission is allowed to view records in this Collection. If a ProcessMaker user does not have the View toggle key enabled, that user cannot access that Collection.

Follow these steps to configure how ProcessMaker users have access to your Collection:

  1. Select the ProcessMaker Collection to configure. The Configuration tab displays.

  2. Click the User Permissions tab.

  3. Enter in the Search field the text to filter ProcessMaker user accounts, if necessary.

  4. Toggle any of the permission settings for applicable ProcessMaker users to allow each user appropriate access to records in this Collection. By default all ProcessMaker users do not have any access to records in your Collection unless a user has the Make this use a Super Admin setting selected. If necessary, ensure to grant your own ProcessMaker user permissions to access records in your Collection. Follow these guidelines:

    • Create: Toggle the Create setting to grant or restrict permission for that ProcessMaker user to create records in this Collection.

    • Delete: Toggle the Delete setting to grant or restrict permission for that ProcessMaker user to delete records in this Collection.

    • Edit: Toggle the Edit setting to grant or restrict permission for that ProcessMaker user to edit records in this Collection.

    • View: Toggle the View setting to grant or restrict permission for that ProcessMaker user to view records in this Collection.

  5. Click Save.

Configure Record Permissions for ProcessMaker Groups

Configure how ProcessMaker groups have permission to access the records in your Collection. Permissions may be set differently for each ProcessMaker group. ProcessMaker users have access to records in this Collection under the following circumstances:

  • Record-level permissions are cumulative: permissions set for a specific ProcessMaker user apply regardless of whether that user is a member of a group with record permissions. If that ProcessMaker user is granted permissions not granted to a group, regardless of whether that user is a group member, that user maintains that record permission.

  • If a ProcessMaker user has the Make this user a Super Admin setting selected in his or her user account, then these settings have no effect on that user. ProcessMaker does not check permissions for ProcessMaker user accounts with this setting selected, allowing such users to administer and install packages which might otherwise require permissions be granted to a ProcessMaker user account to perform.

By default all ProcessMaker groups do not have any access to records in your Collection.

Following are descriptions of each permission that specifies how members of a ProcessMaker group may access records in this Collection:

  • Create: A ProcessMaker group granted the Create permission allows its members to create records in this Collection. If a ProcessMaker group does not have the Create toggle key enabled, the +Record button used to create a record is not visible for its members unless individual users in the group have this permission.

  • Delete: A ProcessMaker group granted the Delete permission allows its members to delete records in this Collection. If a ProcessMaker group does not have the Delete toggle key enabled, the Delete iconused to delete a record is not available in all records for members of this group unless individual users in the group have this permission.

  • Edit: A ProcessMaker group granted the Edit permission allows its members to edit records in this Collection. If a ProcessMaker group does not have the Edit toggle key enabled, the Edit iconused to edit a record is not available in all records for members of this group unless individual users in the group have this permission.

  • View: A ProcessMaker group granted the View permission allows its members to view records in this Collection. If a ProcessMaker group does not have the View toggle key enabled, members of that group do not see any records in that Collection unless individual users in the group have this permission.

Follow these steps to configure how ProcessMaker groups have access to your Collection:

  1. Select the ProcessMaker Collection to configure. The Configuration tab displays.

  2. Click the Group Permissions tab.

  3. Enter in the Search field the text to filter ProcessMaker groups, if necessary.

  4. Toggle any of the permission settings for applicable ProcessMaker groups to allow its members appropriate access to records in this Collection. By default all ProcessMaker groups do not have any access to records in your Collection unless a group member has this permission or has the Make this use a Super Admin setting selected for his or her user account. Follow these guidelines:

    • Create: Toggle the Create setting to grant or restrict permission for that ProcessMaker group to allow its members to create records in this Collection.

    • Delete: Toggle the Delete setting to grant or restrict permission for that ProcessMaker group to allow its members to delete records in this Collection.

    • Edit: Toggle the Edit setting to grant or restrict permission for that ProcessMaker group to allow its members to edit records in this Collection.

    • View: Toggle the View setting to grant or restrict permission for that ProcessMaker group to allow its members to view records in this Collection.

  5. Click Save.

Related Topics