| This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation. |
Difference between revisions of "Workflow"
From Group-Office Groupware and CRM Documentation
(→Accept or Decline) |
|||
| (20 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Overview== | ==Overview== | ||
| + | [[Image:workflow.png|right|thumb|workflow]] | ||
| + | With this module you can add steps that need approval to almost every item inside Group-Office. | ||
| − | == | + | ===Simple example usage (homework)=== |
| − | === | + | A student needs to create homework and that needs to be checked by the teacher: |
| + | |||
| + | The teacher can set a workflow process for a folder in the files module. | ||
| + | |||
| + | If the student uploads a file to the folder, the authorized teacher need to approve the file. | ||
| + | |||
| + | If the teacher finds that the document is OK, then he can approve the file and add a comment to it or if the document is NOT OK, then the teacher can add a comment to it and decline the document. | ||
| + | |||
| + | The student can see if the document is approved or declined and he can see the reason of it. | ||
| + | |||
| + | If it was declined, then the student can upload a new file to the folder and then the checking of the teacher begins again. | ||
| + | |||
| + | ===Simple example usage (billing)=== | ||
| + | A employee can make invoices for the customers of the company where he is working. | ||
| + | |||
| + | You can set up a workflow process for the invoices so that the invoice may not be send to the customer before a manager has approve it to be OK. | ||
| + | |||
| + | So the employee is creating an invoice. | ||
| + | |||
| + | After he has saved the invoice, the manager will get a reminder that he must check the invoice. | ||
| + | |||
| + | The manager can approve or decline the invoice and add a comment to it so the employee knows thar it is right or wrong. | ||
| + | |||
| + | If the invoice was declined(wrong) then the employee can edit it and save it again. | ||
| + | |||
| + | ==Add workflow process (For workflow administrators)== | ||
The administrators of the workflow module can create "Workflow processes". | The administrators of the workflow module can create "Workflow processes". | ||
Below is described how this works: | Below is described how this works: | ||
| + | |||
| + | ===Create workflow processes=== | ||
| + | [[Image:new_workflow_process.png|right|thumb|New workflow process]] | ||
# Go to the "Workflow" tab inside Group-Office. | # Go to the "Workflow" tab inside Group-Office. | ||
# Click on the "Administration" button. | # Click on the "Administration" button. | ||
| Line 11: | Line 41: | ||
# Fill in a name for the new workflow process and click on "Apply" to save it. (After you have clicked on "Apply" the other tabs ("Steps", "Permissions") will be enabled. | # Fill in a name for the new workflow process and click on "Apply" to save it. (After you have clicked on "Apply" the other tabs ("Steps", "Permissions") will be enabled. | ||
## In the "Steps" tab you can add the required steps that need to be followed in this workflow process. (See "Add steps to workflow processes" for an explanation) | ## In the "Steps" tab you can add the required steps that need to be followed in this workflow process. (See "Add steps to workflow processes" for an explanation) | ||
| − | ## In the "Permissions" tab, you can set the permission for who can administer this particular workflow process. | + | ## In the "Permissions" tab, you can set the permission for who can administer this particular workflow process. |
| − | + | ||
===Add steps to workflow processes=== | ===Add steps to workflow processes=== | ||
| + | [[Image:new_workflow_step.png|right|thumb|New workflow step]] | ||
To add a step in a workflow process you need to go to the "Edit workflow" window. | To add a step in a workflow process you need to go to the "Edit workflow" window. | ||
Go to the "Workflow" tab inside Group-Office. | Go to the "Workflow" tab inside Group-Office. | ||
| Line 22: | Line 52: | ||
# To add a new step click on "Add", if you want to edit an existing step double click on it. | # To add a new step click on "Add", if you want to edit an existing step double click on it. | ||
# In the step edit window fill in the fields. | # In the step edit window fill in the fields. | ||
| − | #* Name: This is the Name/Label for the current step. | + | #* '''Name''': This is the Name/Label for the current step. |
| − | #* Description: Here you can add a short description so you can clarify this step to the users. | + | #* '''Description''': Here you can add a short description so you can clarify this step to the users. |
| − | #* Due in (hours): Here you need to fill in how long this step will take. (The number of hours) | + | #* '''Due in (hours)''': Here you need to fill in how long this step will take. (The number of hours) |
| − | #* Email alert: If you enable this checkbox, every Authorized user will get an email when the workflow process is starting with the current step. (So they are notified by email that there is an step for them to take a look at) | + | #* '''Email alert''': If you enable this checkbox, every Authorized user will get an email when the workflow process is starting with the current step. (So they are notified by email that there is an step for them to take a look at) |
| − | #* Popup alert: If this one is enabled the authorized users will get a reminder automatically for the current step. | + | #* '''Popup alert''': If this one is enabled the authorized users will get a reminder automatically for the current step. |
| − | #* Approve needed by all: With this checkbox you can toggle if every or just one authorized user needs to approve the current step. | + | #* '''Approve needed by all''': With this checkbox you can toggle if every or just one authorized user needs to approve the current step. |
| + | # If you have filled in all the fields, click on "Apply" to save the Step. | ||
| + | # Now the "Authorized groups" and "Authorized users" tabs will become available. | ||
| + | #* '''Authorized groups''': Here you can add the groups that can authorize this step. | ||
| + | #* '''Authorized users''': Here you can add individual users that can authorize this step. | ||
| + | '''Note''': If you have checked the "Approve needed by all" checkbox in the "Properties" panel then every user in the Groups ans in the Users tab needs to approve this step. | ||
| + | |||
| + | |||
| + | ===Attach workflow to item=== | ||
| + | Attaching a workflow process to an item inside Group-Office can be done as described in the steps below. | ||
| + | ====Attach to single item==== | ||
| + | [[Image:add_process.png|right|thumb|Add a workflow process]] | ||
| + | # Click on the item where you want to attach the workflow process on. | ||
| + | # In the panel on the right side click on "New"->"Workflow". | ||
| + | # A small window will appear on the screen. | ||
| + | # Select the workflow process that you want to attach and fill in the "Shift due time (hours)". | ||
| + | # Click on "OK". | ||
| + | |||
| + | Now the workflow process is attached to the item. You can see the workflow process in the right panel. | ||
| + | |||
| + | ====Attach workflow processes automatically==== | ||
| + | For files you can let the system automatically attach a workflow. | ||
| + | To set this up you need to follow the steps below: | ||
| + | # Go to the "Files" module. | ||
| + | # Right click on the desired folder where to store the items with a workflow process. | ||
| + | # Choose "Properties". | ||
| + | # In the folder properties window click on the "Workflow" tab. | ||
| + | # Select a workflow process that needs to be attached to each file that is added to this folder. | ||
| + | # Click on "OK" or "Apply" to save it. | ||
| + | |||
| + | Now the selected workflow process will be automatically added to each file that is put inside this folder. | ||
| + | |||
| + | ==Accept or Decline== | ||
| + | [[Image:before_approve_reminder.png|right|thumb|Approval needed reminder]] | ||
| + | [[Image:before_approve.png|right|thumb|Approval needed]] | ||
| + | [[Image:approved.png|right|thumb|Approved]] | ||
| + | If you have permission to administer a step then you can approve or decline items that have that step. | ||
| + | |||
| + | Each item that has a step that you can administer is displayed in the workflow grid. | ||
| + | |||
| + | If you doubleclick on an item in the grid(or just double click on the item itself) a popup will come up in wich you can approve or decline the step. | ||
| + | |||
| + | After you have clicked on "Approve" or "Decline" a small window will appear on the screen in where you need to add some comments. | ||
| + | |||
| + | This comment is needed to clarify your approval or decline back to the user(owner) of the file. | ||
Latest revision as of 15:18, 16 July 2012
Overview
With this module you can add steps that need approval to almost every item inside Group-Office.
Simple example usage (homework)
A student needs to create homework and that needs to be checked by the teacher:
The teacher can set a workflow process for a folder in the files module.
If the student uploads a file to the folder, the authorized teacher need to approve the file.
If the teacher finds that the document is OK, then he can approve the file and add a comment to it or if the document is NOT OK, then the teacher can add a comment to it and decline the document.
The student can see if the document is approved or declined and he can see the reason of it.
If it was declined, then the student can upload a new file to the folder and then the checking of the teacher begins again.
Simple example usage (billing)
A employee can make invoices for the customers of the company where he is working.
You can set up a workflow process for the invoices so that the invoice may not be send to the customer before a manager has approve it to be OK.
So the employee is creating an invoice.
After he has saved the invoice, the manager will get a reminder that he must check the invoice.
The manager can approve or decline the invoice and add a comment to it so the employee knows thar it is right or wrong.
If the invoice was declined(wrong) then the employee can edit it and save it again.
Add workflow process (For workflow administrators)
The administrators of the workflow module can create "Workflow processes".
Below is described how this works:
Create workflow processes
- Go to the "Workflow" tab inside Group-Office.
- Click on the "Administration" button.
- The "Workflow process" grid will be showed in a new window. Click on "Add" to start creating a new workflow Process.
- Fill in a name for the new workflow process and click on "Apply" to save it. (After you have clicked on "Apply" the other tabs ("Steps", "Permissions") will be enabled.
- In the "Steps" tab you can add the required steps that need to be followed in this workflow process. (See "Add steps to workflow processes" for an explanation)
- In the "Permissions" tab, you can set the permission for who can administer this particular workflow process.
Add steps to workflow processes
To add a step in a workflow process you need to go to the "Edit workflow" window. Go to the "Workflow" tab inside Group-Office.
- Click on the "Administration" button.
- The "Workflow process" grid will be showed in a new window. Doubleclick on an existing workflow process or click on "Add" to start creating a new workflow Process.
- Click on the "Steps" tab.
- To add a new step click on "Add", if you want to edit an existing step double click on it.
- In the step edit window fill in the fields.
- Name: This is the Name/Label for the current step.
- Description: Here you can add a short description so you can clarify this step to the users.
- Due in (hours): Here you need to fill in how long this step will take. (The number of hours)
- Email alert: If you enable this checkbox, every Authorized user will get an email when the workflow process is starting with the current step. (So they are notified by email that there is an step for them to take a look at)
- Popup alert: If this one is enabled the authorized users will get a reminder automatically for the current step.
- Approve needed by all: With this checkbox you can toggle if every or just one authorized user needs to approve the current step.
- If you have filled in all the fields, click on "Apply" to save the Step.
- Now the "Authorized groups" and "Authorized users" tabs will become available.
- Authorized groups: Here you can add the groups that can authorize this step.
- Authorized users: Here you can add individual users that can authorize this step.
Note: If you have checked the "Approve needed by all" checkbox in the "Properties" panel then every user in the Groups ans in the Users tab needs to approve this step.
Attach workflow to item
Attaching a workflow process to an item inside Group-Office can be done as described in the steps below.
Attach to single item
- Click on the item where you want to attach the workflow process on.
- In the panel on the right side click on "New"->"Workflow".
- A small window will appear on the screen.
- Select the workflow process that you want to attach and fill in the "Shift due time (hours)".
- Click on "OK".
Now the workflow process is attached to the item. You can see the workflow process in the right panel.
Attach workflow processes automatically
For files you can let the system automatically attach a workflow. To set this up you need to follow the steps below:
- Go to the "Files" module.
- Right click on the desired folder where to store the items with a workflow process.
- Choose "Properties".
- In the folder properties window click on the "Workflow" tab.
- Select a workflow process that needs to be attached to each file that is added to this folder.
- Click on "OK" or "Apply" to save it.
Now the selected workflow process will be automatically added to each file that is put inside this folder.
Accept or Decline
If you have permission to administer a step then you can approve or decline items that have that step.
Each item that has a step that you can administer is displayed in the workflow grid.
If you doubleclick on an item in the grid(or just double click on the item itself) a popup will come up in wich you can approve or decline the step.
After you have clicked on "Approve" or "Decline" a small window will appear on the screen in where you need to add some comments.
This comment is needed to clarify your approval or decline back to the user(owner) of the file.
