Automation manager module for Perfex CRM

Table of contents

• Introduction
• Instalation
• How to use
• FAQ
• Changelog

Module adds "Automation" menu subtab in Utilities tab. In this tab you can add, edit and delete your automations.

For each automation you can set:

• name
• conditional joining type (and/or)
• conditions with parameters
• effects with parameters

• when due date is today, change task status to Finished
• when task status is Finished or when finish date is today, add comment "Good Job!"
• and much more

1. Extract your downloaded file contents. You will notice a folder called "documentation" and a new zip file, called upload.zip. Since "documentation" folder contains this readme file and helpful instructions that are not needed in your Perfex CRM's installation, we will focus on the upload.zip file.
2. File upload.zip contains the module files (in a module format) that you upload in Perfex CRM's Modules installation section. Extract this folder (no contents of this folder, but only this zip).
3. Go to your Perfex CRM's Admin area and select the following menu item: SETUP > MODULES
   
4. Select the extracted upload.zip at Module installation selection prompt and press INSTALL
5. Find the newly installed module and press ACTIVATE.
6. You will be told that module is successfully activated. On the setting menu you will see "Automation" tab in the Utilities tab. That's it! You are now ready to start using the module.

1. Go to the Utilities -> Automation tab
2. Here you see all of your automations
3. In order to add new automation lick ADD AUTOMATION button For each automation you can set:
   • name
   • conditional joining type (and/or)
   • triggers with parameters
   • effects with parameters
   
   

   We can specify following triggers:

   • task status has been changed to {value }
   • start date is today
   • finish date is today
   • priority has been changed to {value }
   • start date has changed
   • finish date has changed
   • task was created
   • task is inactive for {value } days
   
   

   We can specify following effects:

   • change task status to {value }
   • add comment {value }
   • add timer to {value } with comment {additional parameter }
   • change priority to {value }
   • add person {value } as follower (you can select multiple people)
   • set person {value } as only follower (you can select multiple people)
   • add person {value } as assignee (you can select multiple people)
   • set person {value } as only assignee (you can select multiple people)
   • set {value } as content of custom field {additional param}
   • add/remove/remove_all_and_add tag {value }
   • change due date by {value } days
   • add reminder from {value } days of event with comment {additional parameter } (reminder assigned to person who created that task)
   Then click "Submit" button
4. If you want to edit already created status click "Edit" button
5. Then you can edit all the informations you want. After that click "Submit" to save changes
6. If you want to delete task status click "Delete" button and confirm your choice.

• How are due_date and start_date triggers checked (Once a day cron query all task where duedate or startdate is today and applies actions)
• How days of inactivity are calculated? (Days since last comment or days since last time, whichever is shortest)
• Can I add multiple actions to one trigger? (Yes)
• Can I add multiple tags? (Yes, tags are split by ',' character)
• What happens if i add 2 contradicting conditions (for ex. status must be In progress AND Completed)? (Nothing, actions assigned to this automation will never be called. We recommend changing the condition join type to OR)
• Can i subtract for ex. 5 days from due date (Yes, just select action "Change due date" and write -5 days)
• Can I add my own translations. (Yes, in modules->automation_manager->lang folder. Copy english folder and name it with your language. Then you can write your own translations.)

Version 1.2.0 (05.03.2023 r.)

- [NEW] Added action for task automation: Add reminder

Version 1.1.0 (16.08.2022 r.)

- [NEW] From now on you can toggle automation activity (set to active / not active)
- [NEW] New column in activation table informig for which task (task ID) the Automation was recently triggered
- [NEW] Added rule for task automation: Due Date Changed
- [NEW] Added rule for task automation: Start date changed
- [NEW] Added rule for task automation: Task created
- [NEW] Added action for task automation: Change custom field value
- [NEW] Added action for task automation: Add all/Remove all/Add/Remove Tag
- [FIX] Added Backward compatibility for PHP 7.4
- [FIX] Minor bugfix in recently added automation rules and actions>

Version 1.0.0 (08.08.2022 r.)

- Initial Release