ProcessMaker API Documentation
ProcessMaker Examples

Edit Screens for a Collection

Update the Screens that a Collection uses for its records, thereby affecting all records in that Collection.

Overview

The records in a Collection are composed from the Screens to create, edit, and view those records. These Screens may be revised at any time as needs for the Collection change. When any Screen used in a Collection changes, those changes automatically propagate to all records in any Collection that references that Screen.

For example, suppose that when the Collection was created, the Screens to create and edit a record in that Collection are identical. However, a need arises that when any record in that Collection is edited or updated, the record revision date must be recorded in the Screen. To address this, change the Screen used to edit records in that Collection by adding a new Date Picker control from which authorized users/groups can select the record revision date. After the Screen is saved with changes, this new Date Picker control automatically propagates to all records in that Collection. There will be no selected date in this control; the appropriate user(s) must then open each record and select the date each record was revised.

If your user account or group membership does not have the appropriate permissions to edit a Screen, consult with a person in your organization who can edit your ProcessMaker asset(s).

Edit a Screen for 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 view configuration settings for a 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-level permissions in a Collection that allow you to view or create records in that Collection.

Furthermore, your user account or group membership must have the following permissions to edit a Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the Collections and Screens permissions or ask your Administrator for assistance.

Follow these guidelines to edit any Screen referenced from a Collection:

  1. View your Collections. The Collections page displays.

  2. Click the Configure iconfor your Collection in which to edit one of its referenced Screens. The Configuration tab displays.

  3. Make note of the appropriate Screen(s) to edit:

    • Create Screen: The Create Screen drop-down menu references the Screen from which new records in this Collection are created.

    • Edit Screen: The Edit Screen drop-down menu references the Screen from which records in this Collection are edited.

    • View Screen: The View Screen drop-down menu references the Screen from which records in this Collection are viewed.

  4. View your Screens. The Screens page displays.

  5. Edit the appropriate Screen(s). Ensure to save your changes.

After saving your Screen changes, the records in that Collection automatically update with the Screen changes.

Reference a Collection Record with the _collection.id Variable

The _collection.id variable can be used in "view" or "edit" Screens of a Collection to show a unique identifier number for that record in its Collection. The variable must be used in mustache syntax and its value can only be displayed and should not be edited. Use _collection.id in a Screen in the following ways:

  • Rich Text controls: Reference the _collection.id variable in a Rich Text control through the Content setting.

  • Computed Properties: Reference the _collection.id variable from a computed Property. Use JavaScript to return the variable's value, then store it in a computed Property.

  • Watchers: Reference the _collection.id in a Watcher to access a Collection record using a Data Connector for that Collection. Display Collection data returned by the Watcher in a Screen control.

Related Topics