Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create a new record in a Collection.
Optionally, import a Comma-Separated Values (CSV) file from which to create multiple Collection records simultaneously from the CSV's data records.
Follow these steps to create a new record in a Collection:
View the records for the Collection in which you want to add a record.
Click the +Record button. The Create Record page displays the Screen configured to create a record in this Collection.
Enter information for the new record as indicated in the Screen.
Submit the new record as indicated in the Screen. The new record displays in the list of records for that Collection.
If this Collection is a parent to another Collection, create a child Collection record from this Collection.
Create multiple Collection records simultaneously by importing a Comma-Separated Values (CSV) file's data records.
Create multiple Collection records simultaneously by importing a Comma-Separated Values (CSV) file into its Collection. A CSV file is a plain-text file that contains data records in tabular format by separating the content of each item in each data record with a comma (,
): the first data record represents the fields, or columns, of the data set while each following data record contains the same number of items in each record as separated by commas.
Map the relationship between which CSV column corresponds with which Screen control that your Collection uses to create records in that Collection, thereby indicating which Screen control contains which column's value for each data record after importing the CSV file.
Each field in the CSV file does not need to map to a Screen control; controls that are not mapped to a CSV field contain no values after the CSV file is imported. Inversely, CSV fields that are not mapped to a Screen control are ignored when the CSV file is imported.
The Collection creates one record for each data record in the imported CSV file.
Consider importing the following CSV file into a Collection to simultaneously create multiple records in that Collection. This example uses a CSV file that contains all company employee names, employee IDs, start date, and leave date if applicable.
The Collection uses the following Screen to create new records in that Collection.
The data records in the CSV file map to the Screen controls as follows.
The image below indicates how the CSV file maps to the Screen control labels. Note that the First row contains column names (this row will not be imported) toggle key is enabled so that the first row in the CSV file that indicates the columns in this file.
Follow these steps to create multiple Collection records at once from a CSV file:
View the records for the Collection in which you want to add records.
Map from which CSV column, or field, the value of each item in each data record in the CSV file corresponds with which Screen control by selecting that control and then selecting the CSV column. If the CSV file does not contain column/field names, then remember which sequential item in the comma-separated values corresponds with items in each data record that control receives data when the CSV file imports.
Enable the First row contains column names (this row will not be imported) toggle key if the first row of the CSV file contains the column names so that row is not imported into the Collection. This toggle key is disabled by default.
Click the Import button. The following message displays if the the CSV file imports correctly: CSV imported into collection successfully.
Manage the records in a Collection.
ProcessMaker displays all the records in a Collection in one table.
Follow these steps to view all records in a Collection:
View your Collections. The Collections page displays.
Do one of the following to view the list of records for a Collection:
View a Collection from the left sidebar:
Click the Collection name to view its records.
The list of records display for the selected Collection.
The following information displays by default in tabular format about records in the Collection:
#: The # column displays the ID for the record. Use record IDs to search for records in the Collection. ProcessMaker Platform 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 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 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 Platform 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 Platform instance unless your user profile's Time zone setting is specified.
Optionally, change the label or order of the displayed columns, and/or add new columns using the Columns tab in the Collection Configuration. The list of records display for the Collection showing the customized columns.
If no records exist in this Collection, or you do not have permission to view any, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Edit the contents of a record in a Collection.
Follow these steps to edit a record in a Collection:
Edit information for the record as indicated in the Screen.
Submit the revised record as indicated in the Screen.
Optionally, do any of the following:
If this Collection is configured to have a relationship with another Collection, click the Relationships tab to view the child Collection Records related to the selected record.
Follow these steps to edit a Collection record as a JSON object:
Optionally, edit that record's content directly by editing the JSON object, and then clicking the Update button.
Access the contents of a view-only record in a Collection.
Click the Import CSV icon. The Import CSV screen displays.
Click the Browse button, and then locate and open the CSV file to import. The Import CSV screen displays the controls in the Screen this Collection uses to create records in this Collection. Below is a Screen used in this example.
Click the ProcessMaker logo in the left sidebar to expand the sidebar. The name displays for each Collection in which you have access.
View a Collection from the Collections page: Click the Records iconfor the Collection to view its records.
Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the following from a Collection's configuration that control how records in that Collection are accessed:
See or ask the manager of that Collection for assistance.
in which you want to edit a record.
Click the Edit iconfor the record you want to edit. The record displays using the Screen configured to .
Above the Edit Record tab, click the Edit iconor View iconbeside the child Collection name to edit Collection records in the child Collection that have a relationship with this Collection record. A child Collection does not display above the Edit Record tab if this Collection is not or if your user account is not configured to edit records in the child Collection.
Click the JSON tab to.
in which to edit it as a JSON object.
Click the JSON tab for that record. This tab will not be visible if you user account does not have for the records in this Collection.
Use the Search function to filter all from the Collections page based on your entered text.
Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.
that you want to search.
In the PMQL field, enter your ProcessMaker Query Language () parameters that compose your record search. See .
Click the Search buttonto search the Collection's records based on your entered criteria. If there is no search criteria in the PMQL field when the Search button is clicked, the following message displays: Search query is empty. Please add search attributes or PMQL before saving.
Optionally, save and share the record search by clicking the Save Search button. See .
Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.
in which you want to view a record.
Click the View iconfor the record you want to view. The record displays in the View Record tab using the Screen configured to . Below is an example of a viewed record.
Click the Edit iconbeside the View Record tab to edit this record. The Edit icon does not display if your user account is not configured to edit records in this Collection.
Above the View Record tab, click the View iconbeside the child Collection name to view Collection records in the child Collection that have a relationship with this Collection record. A child Collection does not display above the View Record tab if this Collection is not or if your user account is not configured to view records in the child Collection.
Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.
Use the Saved Searches package to save and share search parameters associated with , Tasks and Collections. In doing so, you manage the search parameters for your Saved Searches. You may share your own Saved Searches with other and/or . Recipients of your shared Saved Searches can only use your Saved Search to view its search results, but cannot modify your Saved Searches' parameter settings you configured.
See .
Source CSV File Column
Screen Control Label
Employee First Name
First Name
Employee Last Name
Last Name
Employee ID
Employee ID Number
Start Date
Start Date
Leave Date
Leave Date
Delete a record in a Collection.
When deleting a record from a Collection, the information in that record is a also permanently deleted.
Deleting a record from a Collection cannot be undone.
Follow these steps to delete a record in a Collection:
View the records for the Collection in which you want to delete a record.
Click the Delete iconfor the record you want to delete.