ProcessMaker Documentation
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search…
ProcessMaker 4.2
ProcessMaker Documentation
Quick Links
ProcessMaker Home
Give Us Feedback
Contact Sales
Start Here
How to Use This Document
Get Started with ProcessMaker
Use ProcessMaker
Web Browser Requirements
Log On to ProcessMaker
Profile Settings
View File Manager
View ProcessMaker Product Documentation
View ProcessMaker Version Information
Session Timeout Warning
Log Out of ProcessMaker
Requests
Task Management
File Management
Search ProcessMaker Data Using ProcessMaker Query Language (PMQL)
Saved Searches
Notifications
Control How Tabular Information Displays
JSON: The Foundation of Request Data
What is Request Data?
What is a Request Variable?
What is JSON?
Manage and Model Processes
Process Management
Script Management
Screen Management
Reference Magic Variables in ProcessMaker Assets
Environment Variable Management
Signal Management
Data Connector Management
Vocabularies Management
Process Modeling
ProcessMaker Administration
User Management
Group Management
Permission Descriptions for Users and Groups
Manage Saved Searches
Settings
Client Authentication Management
Customize the User Interface
Queue Management
Script Executor Management
ProcessMaker Collections
User Interface Language Management
Download for On-Premises Installation
On-Premises Server Requirements
Download the Open-Source Edition for On-Premises Installation
Open-Source Edition Installation Instructions
Packages
What is a Package?
ProcessMaker Packages
Actions By Email Package
Advanced Screens Package
Advanced User Package
Auth Package
C# Package
Collections Package
Comments Package
Conversational Forms Package
Data Connector Package
Documentation Package
DocuSign Package
Dynamic UI Package
File Manager Package
Google Places Package
Java Package
PDF Generator Package
Process Optimization Package
Python Package
R Package
Saved Searches Package
Send Email Package
Signature Package
Slack Notification Package
Translations Package
Versioning Package
Vocabularies Package
Web Entry Package
ProcessMaker API Documentation
Access ProcessMaker RESTful API Documentation
ProcessMaker Examples
Collections Examples
Data Connector Examples
Screen Design Examples
Script Executor Examples
Deprecation Notices
Advanced Screens Package
Other Links
Download ProcessMaker Open-Source Edition
ProcessMaker Open-Source Edition Installation Instructions
Privacy Statement
Powered By GitBook
Collections Package
Create multiple sets of schema-less data records using Screens that do not require an external database.

Overview

The Collections package must be installed.
Use the Collections package to maintain sets of schema-less data records using Screens, each referred to as a Collection. The Collections package has the following features:
  • An external database is not required to store Collections. Collections are maintained in the ProcessMaker instance.
  • A Collection is composed of a set of records. Similar to a relational database, a record is a grouping of fields that represent related data. Design the grouping of fields using Screens to represent this data, thereby making it easy for any user to view, create, or edit record data if they have the appropriate permission(s) to do so. Within a Collection, potentially use different Screens to create a record, edit a record, or view a record within that Collection. This provides greater control in how information within a Collection is consumed by various stakeholders in the Collection. Consider the following use case:
    • Create a record: Allow an assistant to create a record using Screen for this purpose, such as in a medical practice.
    • Edit a record: In the same medical practice, a dedicated Screen allows a nurse to edit patient information after the new patient has granted legal permission for medical staff to edit sensitive medical information (in compliance with HIPAA standards).
    • View a record: Use a third Screen that references identical record information, but limits the content and editing so that the medical practice complies with patient legal protections.
  • Collections are schema-less, meaning that any type or format of data may be stored in a Collection. Because Collections are schema-less, changing the Screen(s) that are used to create, edit, and view records in each Collection thereby changes the types of information or data to all records within that Collection. You are not constrained by how you define a Collection when you create it. For example, if you want to allow Collection stakeholders to attach a file that becomes associated with a record, add a File Upload control in the applicable Screen(s) that represent information in that Collection; the new File Upload control becomes available in all records in that Collection.
  • Determine which users and/or groups have permission to view, create, edit, or delete Collections by setting Collection permissions. These permissions are different than record permissions that specify which users and/or groups can manage records within an individual Collection.
  • ​Import a CSV file into a Collection to simultaneously create multiple records from the CSV file's data records.
  • The Collections package integrates with the Saved Searches package. Use the Saved Searches package to save and share searches associated with a Collection. See Saved Searches Package. Use ProcessMaker Query Language (PMQL) parameters to compose queries to search for record information in a Collection. Furthermore, changes to a Collection may then be applied to Saved Searches associated with that Collection.
  • Establish relationships between records in one Collection with those in a second. A Collection relationship links two Collections by designating one Collection as a parent Collection, the other as a child Collection, and defining data keys or columns linking both Collections. The Collection from which this relationship is created is automatically designated as the parent Collection. The relationship is a one-to-many relationship such that a record in the parent Collection can have multiple matching records in the child Collection.
  • An external database is not required to store Collections. Collections are maintained in the ProcessMaker instance.
  • The Collections package integrates with the Saved Searches and Data Connector packages:
    • Saved Searches package: Use the Saved Searches package to save and share searches. See Saved Searches Package.
    • Data Connector package: Access both Collection records and third-party data sources from any ProcessMaker asset, including Screens, Scripts, and Process models. See Data Connector Package.

Related Topics

Previous
C# Package
Next
Comments Package
Last modified 11mo ago
Export as PDF
Copy link
Edit on GitHub
Contents
Overview
Related Topics