ProcessMaker API Documentation
Script Central

View All Records in a Collection

View all records in a ProcessMaker Collection.

View All Records in a Collection

ProcessMaker displays all the records in a ProcessMaker Collections in one table.

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 "Collections: View Collections" permission to view the list of ProcessMaker Collections unless your user account has the Make this user a Super Admin setting selected. See the ProcessMaker Collections permissions or ask your ProcessMaker Administrator for assistance.

Furthermore, your ProcessMaker user account or group membership must have the View record permission from a Collection's configuration to view that Collection's records. See Configure a Collection or ask the manager of that ProcessMaker Collection for assistance.

Follow these steps to view all records in a ProcessMaker Collection:

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

  2. Do one of the following to view the list of records for a ProcessMaker Collection:

    • View a ProcessMaker Collection from the left sidebar:

      1. Click the ProcessMaker logo in the left sidebar to expand the sidebar. The name displays for each ProcessMaker Collection in which you have access.

      2. Click the ProcessMaker Collection name to view its records.

    • View a ProcessMaker Collection from the Collections page: Click the Records iconfor the ProcessMaker Collection to view its records.

The list of records display for the selected ProcessMaker Collection.

Table of records in a ProcessMaker Collection

The following information displays in tabular format about records in the ProcessMaker Collection:

  • #: The # column displays the ID for the record. Use record IDs to search for records in the ProcessMaker Collection. ProcessMaker automatically generates the ID value when the record is created and represents a sequential number of how many total records in that Collection have been created to that time.

  • Modified By: The Modified By column displays the ProcessMaker user who last modified the record. Hover your cursor over the user's avatar to view that person's full name.

  • Created By: The Created By column displays the ProcessMaker user who created the record. Hover your cursor over the user's avatar to view that person's full name.

  • Modified: The Modified column displays the date and time the record was last modified. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.

  • Created: The Created column displays the date and time the record was created. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.

Search for a Record in the ProcessMaker Collection

Use the PMQL field to filter records that display in the ProcessMaker Collection.

Create a New Record in the ProcessMaker Collection

Click the +Record button. See Create a New Collection Record.

Edit a Record in the ProcessMaker Collection

Click the Edit icon. See Edit a Collection Record.

View a Record in the ProcessMaker Collection

Click the View icon. See View a Collection Record.

Delete a Record from the ProcessMaker Collection

Click the Delete icon. See Delete a Collection Record.

No Records in this ProcessMaker Collection?

If no records exist in this ProcessMaker Collection, or you do not have permission to view any, the following message displays: No Data Available.

Display Information the Way You Want It

Control how tabular information displays, including how to sort columns or how many items display per page.

Related Topics