Overview
ProcessMaker offers an Audit Log which provides chronological records so that administrators can monitor the security of their ProcessMaker installation and view a history of the actions performed by users under the ADMIN menu, which includes the Settings, Plugins, Users and Logs tabs.
The records of the log can be used to check what actions users have executed in each tab under the ADMIN menu, when these actions were executed and from which IP address. The Audit Log currently shows a list with these details beside a brief description of the action. For example, if a PM Table was created and deleted:
The Audit Log records all possible actions under the menu, except accessing logs (e.g. the Events Log), some information windows (e.g. PHP Information), the actions of some additional plugins (e.g. FTP Monitor) and the changes inside the User Experience.
This feature is available with the acquisition of your ProcessMaker Enterprise Edition license. To check if your instance has this feature installed, go to Admin > Plugins > Enterprise Manager and click on the Enterprise Features tab where it should be listed as installed and enabled.
Enabling the Audit Log
In order to start logging users' actions, the Audit Log must first be enabled by going to ADMIN > Settings > Audit Log:
Check the option Enable Audit Log to enable it and then click on Save Settings.
After saving the configuration, a message is displayed at the bottom of the page:
Disabling the Audit Log
If the Audit Log need to be disabled, go to ADMIN > Settings > Audit Log and uncheck the option Enable Audit Log. After saving, a message will be shown at the bottom of the page.
Accessing the Audit Log
Access the records in the Audit Log by going to ADMIN > Logs > Audit Log.
In the panel that opens on the right, all actions will be listed which were executed while the plugin was enabled:
1. Action: Select a type of action to filter the Audit Log. To see all types of actions, select All.
- The list immediately refreshes after selecting a filter of the actions.
2. Description: Enter a phrase to search for all log records which contain that phrase. After entering a phrase click on the Search button to show all matching records. Note that the search is case insensitive and will search in all columns in the Audit Log.
3. From - To: Use these two fields to filter the log records starting from a specified date to a specified date. See all records up to a specified date, enter a date in the To field, but leave the From field blank . To see all records after a specified date, enter a date in the From field but leave the To field blank. To remove the date filter, delete both the From and To dates. Then click on the Search button.
4. Reset Filters: Click on this button to clear the Description, From and To fields. Then click on the Search button to refresh the list in the Audit Log.
5. Search: Click on this button to search the records log according the criteria set in the Description, From and To fields.
6. Date: Shows the date and time when the Action was recorded in the format YYYY-MM-DD HH:MM:SS.
7. User: Lists the last and first name of the user who performed the recorded Action .
8. IP Client. Shows the IP address of the user who performed the action.
9. Action. Shows the type of action, which was performed in the admin section in the Settings, Plugins, Users and Logs tabs.
10. Description. Shows a brief description of the action.
The columns Date, Action and Description can be ordered alphabetically in ascending or descending order by clicking in the column header, which will show an arrow indicating the direction of the sort. To reverse the sort order, click on the header again.
Actions Type
The actions type for Audit logs are the following:
Designer Actions
The Designer Log records the following actions under the Designer ProcessMaker tab.
| Process Elements | Process Element Properties | Process Objects |
|---|---|---|
| * Add Sub-Process * Add Task * Add Text * Add Vertical Line * Add horizontal line * Delete All Lines * Delete Line * Delete Sub-Process * Delete Task * Delete Text * Save Line Position * Save Text Position * Save Task Position * Save Task Properties |
* Assign Group Task * Assign Trigger * Assign User Task * Assign user * Delete Group Task * Delete User Task * Derivation Rule * Down Trigger * Edit Event * Edit Text * Event deleted * New Condition From Step * Options Menu Task * Save New Step * Step Delete * Step Down * Step Up * Up Trigger * Web Entry |
* Assign Supervisor Dynaform * Assign Supervisor Input * Case trackers * Create Dynaform * Create New Database connection * Create New Input Document * Create New trigger * Create new Case Scheduler * Create new Output Document * Delete Case Scheduler * Delete Data from PM Table * Delete Database Connection * Delete Dynaform * Delete Input Document * Delete Output Document * Delete Routes * Delete Trigger * Process File Manager * Remove Group * Remove Supervisor Dynaform * Remove Supervisor Input * Update Case Scheduler * Update Database Connection * Update Dynaform add/deleted fields * Update Input Document * Update Output Document * Updated conditions editor in dynaform |
| Process Actions | ||
| * Delete Process * Export Process * Import Process * Process Edited * Process Permissions |
||
Example
These are the steps to assign a user to a task and then check it on the Audit Log:
-
Right click on the Task to show its options.
-
Assign the user to the Assigned user list.
-
Enter to Admin > Logs > Audit Log to check the action recorded inside the Audit Log. The action described in this case is Assign user to Task..
Log Actions
The Audit Log records the following actions under ADMIN > Logs
| Cron |
|---|
| * Clear Cron |
Note: The options: "Events", "Case Scheduler" and Emails are not recorded inside the log.
Example
Clear the Cron log inside Admin > Logs > Cron
View the action registered inside the Audit Log by going to Admin > Logs > Audit Log:
The description for this action when clearing the Cron is Clear Cron.
Plugins Actions
The Audit Log records the following actions under Admin > Plugins:
| Enterprise Manager | Plugins Manager |
|---|---|
| * Install Plugin * Enable Plugin * Disable Plugin |
* Install Plugin * Enable Plugin * Disable Plugin |
Example
Enable and disable a plugin by going to Admin > Plugins > Plugins Manager.
The action described for disabling a plugin inside the Audit Log is: "Disable Plugin".
Settings Actions
The Audit Log records the following actions executed under ADMIN > Settings:
| Logo | Calendars | Process Categories | |
|---|---|---|---|
| * Apply - Replace Logo * Upload Logo * Delete Logo * Restore the default logo |
* Update Email Settings * Create Email Settings |
* Create Calendar * Update Calendar * Delete Calendar |
* Create Category * Update Category * Delete Category |
| Languages | Skins | Heart Beat | Environment |
| * Upload Language * Export Language * Delete Language |
* Create Skin * Import Skin * Export Skin * Delete Skin |
* Enable Heart Beat * Disable Heart Beat * Contribute to the ProcessMaker project enabling heart beat anonymous usage data |
* Update Environment Settings |
| Cases List Cache Builder | Clear Cache | PM Tables | Web Services Test |
| * Build Cache | * Clear Cache | * Create PM Table * Update PM Table * Delete PM Table * Add Data in a PM Table * Update Data from PM Table * Delete Data of a PM Table * Import Table * Export Table |
No action is recorded in the log as it is just testing. |
| Login | Dashboard | System | System Information |
| * Update Login Settings | * Create Dashlet Instance * Update Dashlet Instance (include Deactivate and Activate) * Delete Dashlet Instance |
* Upload System Settings | No action is recorded in the log since this is only an Information screen. |
| Check PM Requirements | PHP Information | Audit Log | Cases List |
| No action is recorded in the log since this is only a test. | No action is recorded in the log as this is only an Information screen. | * Enable Audit Log * Disable Audit Log |
Set Columns |
| Google Service Settings | SAML plugin | ||
| * Disconnect G Suite * G Suite Configuration Saved * Request G Suite connection * Update G Suite groups |
* SAML Authentication Enable * SAML Authentication Provider * Syncing Users |
||
Example
Create a new Process Category by going to Admin > Settings > Process Categories.
Create the category: "RRHH"
View the action recorded in the Audit Log by going to Admin > Logs > Audit Log:
The description for creating a new category inside the Audit Log is: "Create Category".
Users Actions
The Audit Log records the following actions executed under Admin > Users:
| Users | Groups | Departments |
|---|---|---|
| * Create User * Update User * Delete User * Enable User * Disable User *Remove User * Authentication Source |
* Create New Group * Update Group * Assign Users To Group |
* Create Department * Create Sub Department * Update Department * Update Sub Department * Delete Department * Assign Manager to Department * Assign Users to Department * Remove Users from Department |
| Roles | Authentication Sources | User Experience |
| * Create New Role * Update Role * Delete Role * Assign Users To Role * Delete User To Role * Add Permission to a Role * Delete Permission To Role *Delete Permissions |
* Create Authentication Source * Update Authentication Source * Delete Authentication Source * Assign Authentication Source |
The User Experience is not recorded in the log |
Example
Create a new user by going to Admin > Users > Users
Fill in information about the new user and save it.
View the action recorded inside the Audit Log by going to Admin > Logs > Audit Log. The action described for creating a new user inside the Audit Log is: "Create User".
