Skip to content

Commit dca3de2

Browse files
committed
Update README.md
1 parent b348b19 commit dca3de2

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
### Introduction
1010
**ActivFlow** is a generic, light-weight and extensible workflow engine for agile development and automation of complex Business Process operations.
1111

12-
Developers can emphasize towards mapping the Business Process model as ActivFlow workflow without having to worry about implementing the core workflow processing logic. The generic implementation of the workflow engine manages the automation of the Business Processes from start to finish as per the defined flow.
12+
Developers can emphasize towards mapping the Business Process model as ActivFlow workflow without having to worry about implementing the core workflow processing logic. The generic implementation of the workflow engine manages the automation of the Business Processes from start to finish in accordance with the defined flow.
1313

14-
What defines an ActivFlow workflow?
14+
What is an ActivFlow workflow?
1515
- Business Process flow mapped as ActivFlow configuration
16-
- Definition of data that needs to be captured for each activity (state)
16+
- Definition of data to be captured for each activity (state)
1717
- Business Roles mapped to workflow activities
18-
- Rules for transitioning between activities
18+
- Rules applied on transitions between activities
1919

2020
![alt tag](https://cloud.githubusercontent.com/assets/6130967/14062046/b055de98-f3a2-11e5-9d13-e74e4a9252f7.png)
2121

@@ -100,7 +100,7 @@ def validate_request(self):
100100
```
101101

102102
#### Step 5: Configure Field Visibility (Optional)
103-
- Include **config.py** in the workflow app and define **ACTIVITY_CONFIG** as Nested Ordered Dictionary if you want to have more control over what gets displayed on the UI
103+
- Include **config.py** in the workflow app and define **ACTIVITY_CONFIG** as Nested Ordered Dictionary to have more control over what gets displayed on the UI.
104104
- Define for each activity model, the visibility of fields, for display on templates and forms
105105
- **create:** field will appear on activity create/initiate form
106106
- **update:** field will be available for activity update/revise operation
@@ -118,25 +118,18 @@ ACTIVITY_CONFIG = odict([
118118
('creation_date', ['display']),
119119
('last_updated', ['display'])
120120
])),
121-
('ManagementApproval', odict([
122-
('approval_status', ['create', 'update', 'display']),
123-
('remarks', ['create', 'update', 'display']),
124-
('creation_date', ['display']),
125-
('last_updated', ['display'])
126-
])),
121+
...
122+
...
127123
])
128124

129125
```
130126

131127
#### Step 6: Access/Permission Configuration (Optional)
132-
The core logic to restrict the access is defined as **AccessDeniedMixin** under **core/mixins**
133-
This can be customized by the developer based on the requirements
128+
The core logic to restrict access is defined as **AccessDeniedMixin** under **core/mixins** which developers can customize depending on the requirements
134129

135130
#### Demo Instructions
136131
Execute the below command to configure ActivFlow for demo purpose
137132
```
138133
python demo.py
139-
140-
submitter: john.doe/12345
141-
reviewer: jane.smith/12345
142134
```
135+
**Submitter:** john.doe/12345, **Reviewer:** jane.smith/12345

0 commit comments

Comments
 (0)