-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bafc17c
commit 9553b58
Showing
2 changed files
with
184 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,184 @@ | ||
# Axon Ivy Express | ||
|
||
Axon Ivy Express is an add-on module for Axon Ivy Portal. It enables you – as a business user – to create your own process applications and share them with your colleagues. These capabilities are also known as No-Code Application Platforms or Citizen Developer Platforms. Therefore, it is the perfect tool for you to digitize your processes and create standardization, reliability and traceability. Some of the key features of Axon Ivy Express are: | ||
|
||
* It is a No Coding Toolset, allowing business users without an IT background to create processes. | ||
* The Axon Ivy Portal Integration, allows business users to implement processes without IT department involvement. | ||
* The Seamless Integration into Axon Ivy allows you to make use of standard features like email notifications, task delegation, etc. | ||
* The Powerful Toolset allows you to create processes, define different task types, set responsibilities and due dates and define user dialogs for each task. | ||
|
||
![express-workflow-properties](images/express-workflow-properties.png) | ||
|
||
## Demo | ||
|
||
1. Login to the Axon Ivy Portal. | ||
2. Click **Processes** in the Axon Ivy Portal menu to open the **Full Process List** page. | ||
3. On the **Full Process List** page, click on **Create Express Workflow**. | ||
|
||
![create-express-workflow](images/create-express-workflow.png) | ||
|
||
4. The **Express Workflow** editor is opened. | ||
5. Define the **Type of process**: | ||
|
||
* Use the option *One time* if you want to execute the process only once. | ||
* Use the option *Repeatable* if you want to save the process for repetitive use. The process will automatically be deployed and added to the Full Process List page. | ||
|
||
6. Define your **User Interface** : | ||
|
||
* With the option Create own you can create your own user dialog for each process step | ||
* With the option Use default, the user dialogs will automatically be generated by Axon Ivy Express | ||
|
||
7. Provide a descriptive name under **Process name** | ||
8. You may add a description under **Process description**. We strongly encourage you to use the description to provide details about your process. | ||
9. Click on the link **Change** beside Icon to select the icon best suited for your process. | ||
|
||
![express-workflow-properties](images/express-workflow-properties.png) | ||
|
||
10. The first process step is already available for configuration. | ||
11. You may add further process steps using the button **Add process step** | ||
12. You may delete unnecessary process steps using the button **Remove process step** | ||
13. For each process step, | ||
|
||
* Select the **Task Type** see [Express Workflow task types](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/portal-user-guide/axon-ivy-express/index.html#express-workflow-task-types). | ||
* Provide a descriptive name in **Task Name** | ||
* Provide an optional description in **Task description.** | ||
|
||
14. For *One time* process type, the first process step defines the users or roles under **Able to start** who can start the process | ||
|
||
![able-to-start](images/able-to-start.png) | ||
|
||
15. For all other process steps define the user or roles who are responsible to execute the task in **Responsible**. | ||
|
||
![responsible](images/responsible.png) | ||
|
||
16. For each process step except the first define the time before the task expires in **Expiry in days** | ||
17. End the configuration of each process step by pressing **Next** | ||
|
||
![express-preview](images/express-preview.png) | ||
|
||
|
||
**Express Workflow task types** | ||
|
||
|**Task type**|**Description**| | ||
| ----------- | ------------- | | ||
|**User Task**|For this task the user can define a UI| | ||
|**User Task with Email**|In addition to the normal User Task, the user can send an Email directly from the Axon Ivy Portal, without the need to change to another system| | ||
|**Information Email**|This email can be defined by the creator of the Express Workflow and will be sent automatically without user action| | ||
|**Approval**|This task type creates a approval task| | ||
|
||
18. Depending on the task type of the first process step, a different editor is opened. For both user task and task with email, the dialog editor is opened. | ||
19. For each data item you need in your process, select an input element. | ||
20. Provide a descriptive name for the input in **Label**. | ||
21. Select the input type in **Input type**. | ||
22. Select if the input of this data item is required or not | ||
23. Use the button Create to create the input element | ||
24. The created element appears in the list Available form elements | ||
25. To delete input elements you don’t need, klick its trash button. | ||
26. Drag and Drop the input elements into one of the areas of the dialog editor | ||
27. To remove an input element from the dialog, use the **Delete** button | ||
28. To preview your dialog, press the **Preview** button to define an additional process step, klick the button **Next**. | ||
|
||
![express-add-input](images/express-add-input.png) | ||
|
||
The results of all previous tasks are included in follow-on tasks in a read-only view, so that the user sees the whole history. | ||
|
||
|
||
**Express Workflow input elements** | ||
|
||
|**Input element**|**Description and options**| | ||
| --------------- | ------------------------- | | ||
|**Input field**|Input field for text, numbers or dates <br> - Text field <br> - Number field <br> - Date picker| | ||
|**Input area**|Text input field between 1 and 10 rows| | ||
|**Checkbox**|List of elements which allows the user a multiple selection| | ||
|**Radio button**|List of elements which allows the user a single selection| | ||
|**File Upload**|Provides a file upload dialog to the user. You may define: <br> - Allowed file types <br> - Number of allowed attachments| | ||
|
||
29. For process steps with the task type user task with email/information email, the email editor is opened. | ||
30. Specify the addresses of the email recipients. Separate them by commas. | ||
31. The response email email address is optional. | ||
32. Specify the subject of the email. | ||
33. Specify the email text. | ||
34. Optionally, include attachments. | ||
35. Use the button **Next** to define the next process step | ||
|
||
|
||
**Express Business Summary** | ||
|
||
After you have completed an Express workflow, you can check its summary data by accessing its **Business Details** page. | ||
|
||
![express-business-case-detail](images/express-business-case-detail.png) | ||
|
||
|
||
**Axon Express Management** | ||
|
||
With Axon Express Management, an administrator can import/export Express workflows in JSON format. You find this feature in the *Admin Settings <settings-admin-settings>*. | ||
|
||
![express-management-setting](images/express-management-setting.png) | ||
|
||
To access this feature, you need to be granted the role **AXONIVY_PORTAL_ADMIN**. | ||
|
||
|
||
**HowTo: Export an Express Process** | ||
|
||
Select the workflows you want to export in Express workflows table. The selected workflows will be exported to a JSON file. | ||
|
||
![export-express](images/export-express.png) | ||
|
||
1. You can select multiple workflows by clicking the checkbox ALL. | ||
2. After you selected some workflows, click the **Export Express** button. | ||
|
||
The Export dialog will display and show the workflows selected for export. | ||
|
||
![export-express-detail](images/export-express-detail.png) | ||
|
||
Review your selection, then press the Download button to download the selected workflows. | ||
|
||
**Important**: The export file is a JSON file. It contains a version of Axon Ivy Express and Express process data. Don’t edit this file manually. | ||
|
||
|
||
**HowTo: Import an Express Process** | ||
|
||
The Import Express Process function allows the Administrator to import Express processes into the Portal from a backup file. | ||
Press the **Import Express** button, Import Express dialog will display. Once the **Import Express** dialog is open, press the Select button and choose the Express JSON file that contains the workflows you want to import. | ||
|
||
![import-express-dialog](images/import-express-dialog.png) | ||
|
||
Then, press the **Deploy** button and wait for the deployment process. | ||
|
||
![import-express-action](images/import-express-action.png) | ||
|
||
After the deployment process is completed, an output log panel will be displayed. You can see all the information collected during the deployment process. | ||
|
||
Now, if the deployment process is successful, your workflows are imported and an administrator can check and/or edit them before they are ready to use. | ||
|
||
![import-express-status](images/import-express-status.png) | ||
|
||
|
||
**Ad Hoc Process** | ||
|
||
Axon Ivy Express also provides an ad hoc process feature. Once Express is deployed, you can start an ad hoc process for any task. Ad hoc processes allow you to define more process steps and will be executed before the current task. | ||
|
||
Start an ad hoc process by clicking on the menu icon at the top right in your task, then click on **Start Adhoc**. | ||
|
||
![start-adhoc](images/start-adhoc.png) | ||
|
||
Save the data of your current task before you start the ad hoc process. | ||
Then, define your ad hoc process. | ||
|
||
![express-task-detail](images/express-task-detail.png) | ||
|
||
After starting the process, ad hoc tasks will be executed before your current task. | ||
|
||
![execute-adhoc-task](images/execute-adhoc-task.png) | ||
|
||
Finish all created ad hoc tasks to return to the original task | ||
|
||
![summary-adhoc-process](images/summary-adhoc-process.png) | ||
|
||
When you start your original task, you will see a summary of the ad hoc process in your task. | ||
|
||
![execute-original-task](images/execute-original-task.png) | ||
|
||
You can view the history again by clicking the menu icon, then click on **Adhoc history**. | ||
|
||
![adhoc-history](images/adhoc-history.png) |
File renamed without changes.