Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initiate Axonivy-express on market #4

Merged
merged 44 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
6b275c1
IVYPORTAL-14577: Remove test project
pvthai-axonivy Jul 11, 2023
cb6e532
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
36d9148
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
2756ee6
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
5d47ea2
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
a79e2e9
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
a6c7197
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
1bb453d
IVYPORTAL-14577: improve doc
pvthai-axonivy Jul 11, 2023
63a5974
IVYPORTAL-14577: fix install failed
pvthai-axonivy Jul 11, 2023
276c32e
IVYPORTAL-14577: fix install failed
pvthai-axonivy Jul 12, 2023
90551dd
IVYPORTAL-14577: fix install failed
pvthai-axonivy Jul 12, 2023
48b1bde
IVYPORTAL-14577: Add express jenkinfile
pvthai-axonivy Jul 13, 2023
30286c8
IVYPORTAL-14577: Add express dockerfile
pvthai-axonivy Jul 13, 2023
2ced7a9
IVYPORTAL-14577: Add express dockerfile
pvthai-axonivy Jul 13, 2023
419105b
IVYPORTAL-14577: Add express dockerfile
pvthai-axonivy Jul 13, 2023
f6ea26d
IVYPORTAL-14577: Add express dockerfile
pvthai-axonivy Jul 13, 2023
b2dd61c
IVYPORTAL-14577: Always build express
pvthai-axonivy Jul 14, 2023
aa7b355
IVYPORTAL-14577: fix portal version
pvthai-axonivy Jul 14, 2023
a22d2a0
IVYPORTAL-14577: fix portal version
pvthai-axonivy Jul 14, 2023
e35ec3a
IVYPORTAL-14577: update portal version
pvthai-axonivy Jul 14, 2023
f759b02
IVYPORTAL-14577: update portal version
pvthai-axonivy Jul 17, 2023
88bdefa
IVYPORTAL-14577: update portal version
pvthai-axonivy Jul 17, 2023
186fc35
IVYPORTAL-14577 Make express an independent marketplace item
lttung-axonivy Jul 17, 2023
d0c088c
Revert "IVYPORTAL-14577 Make express an independent marketplace item"
lttung-axonivy Jul 17, 2023
5cee14b
Revert "Revert "IVYPORTAL-14577 Make express an independent marketpla…
lttung-axonivy Jul 17, 2023
1d2c420
IVYPORTAL-14577: change repo to maven
pvthai-axonivy Jul 17, 2023
b361308
IVYPORTAL-14577: remove update version
pvthai-axonivy Jul 17, 2023
27f7bfc
IVYPORTAL-14577: merge code
pvthai-axonivy Jul 18, 2023
b13e384
IVYPORTAL-14577: test failed
pvthai-axonivy Jul 18, 2023
bbca1bc
IVYPORTAL-14577: handle feedback update doc
pvthai-axonivy Jul 24, 2023
ddd4d4d
IVYPORTAL-14577: handle feedback update doc
pvthai-axonivy Jul 26, 2023
86486cd
IVYPORTAL-15364: fix Express end page not work properly
pvthai-axonivy Jul 31, 2023
0d12147
Revert "IVYPORTAL-15364: fix Express end page not work properly"
pvthai-axonivy Aug 4, 2023
aa4fdaa
IVYPORTAL-15454: Various or urgent requests in IVYPORTAL - S246
mnhnam-axonivy Aug 17, 2023
db0925d
IVYPORTAL-14577: Update Portal version to m245
pvthai-axonivy Aug 23, 2023
268d9ef
IVYPORTAL-14577: Update document
pvthai-axonivy Aug 24, 2023
4f4b30a
IVYPORTAL-15557: fix compile error related to mail config
pvthai-axonivy Aug 28, 2023
7b8ba17
IVYPORTAL-14577: Update Portal version to snapshot
pvthai-axonivy Sep 7, 2023
3854b2d
IVYPORTAL-15211 Migrate old portal customization step 2 callable appr…
pvthai-axonivy Sep 8, 2023
3b6c12c
IVYPORTAL-14577: Revert Portal version to m245
pvthai-axonivy Sep 8, 2023
64b9491
IVYPORTAL-14577: handle feedback
pvthai-axonivy Sep 26, 2023
c418f92
IVYPORTAL-14577: handle feedback
pvthai-axonivy Oct 9, 2023
9cca2b7
Revert "IVYPORTAL-15211 Migrate old portal customization step 2 calla…
pvthai-axonivy Oct 9, 2023
f744136
IVYPORTAL-14577: handle feedback
pvthai-axonivy Oct 10, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

[![CI Build](https://github.com/axonivy-market/axonivy-express/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/axonivy-express/actions/workflows/ci.yml)

Axon Ivy Express is an ad-on module for Axon Ivy Portal
The Express GUI test is located in Portal's infrastructure. The Portal's GUI test will also take care of Express's tests. If there are any changes in the Portal that impact the Express, then a new version of the Express will be released after releasing the Portal.

Read our [documentation](axonivy-express-product/README.md).
How to use the [Axon Ivy Express](axonivy-express-product/README.md).
120 changes: 69 additions & 51 deletions axonivy-express-product/README.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,116 @@
# Axon Ivy Express

Axon Ivy Express is an ad-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.
Axon Ivy Express is an add-on module for the Axon Ivy Portal. As a business user, it enables you to create and share your process applications with your colleagues. These capabilities are also known as No-Code Application Platforms or Citizen Developer Platforms. Therefore, it is the perfect tool to digitize your processes and create standardization, reliability, and traceability. Axon Ivy Express:

* Allows business users to create processes without an IT background.
* Automates business processes without IT department involvement.
* Supports all standard features such as email notifications, task delegation, etc.
* Features an importer tool to hand over your No-Code business processes to Low-Code or Pro-Code developers.

<br>

![express-workflow-properties](images/express-workflow-properties.png)

## Demo

1. Click on **Create Express Workflow**.
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)

2. The **Express Workflow** editor is opened.
3. 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.
4. 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
5. Provide a descriptive name under **Process name**
6. You may add a description under **Process description**. We strongly encourage you to use the description to provide details about your process.
7. Click on the link **Change** beside Icon to select the icon best suited for your process.
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)

8. The first process step is already available for configuration.
9. You may add further process steps using the button **Add process step**
10. You may delete unnecessary process steps using the button **Remove process step**
11. 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.**
12. For *One time* process type, the first process step defines the users or roles under **Able to start** who can start the process
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)

13. For all other process steps define the user or roles who are responsible to execute the task in **Responsible**.
15. For all other process steps define the user or roles who are responsible to execute the task in **Responsible**.

![responsible](images/responsible.png)

14. For each process step except the first define the time before the task expires in **Expiry in days**
15. End the configuration of each process step by pressing **Next**
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|

16. 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.
17. For each data item you need in your process, select an input element.
18. Provide a descriptive name for the input in **Label**.
19. Select the input type in **Input type**.
20. Select if the input of this data item is required or not
21. Use the button Create to create the input element
22. The created element appears in the list Available form elements
23. To delete input elements you don’t need, klick its trash button.
24. Drag and Drop the input elements into one of the areas of the dialog editor
25. To remove an input element from the dialog, use the **Delete** button
26. To preview your dialog, press the **Preview** button to define an additional process step, klick the button **Next**.
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__..*Text field__..* Number field_..*Date picker|
| --------------- | ------------------------- |
|**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:__..*Allowed file types __..*Number of allowed attachments|
|**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

27. For process steps with the task type user task with email / information email, the email editor is opened.
28. Specify the addresses of the email recipients. Separate them by commas.
29. The response email email address is optional.
30. Specify the subject of the email.
31. Specify the email text.
32. Optionally, include attachments.
33. 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>*.
Expand All @@ -104,14 +119,15 @@ With Axon Express Management, an administrator can import/export Express workflo

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)

8. You can select multiple workflows by clicking the checkbox ALL.
9. After you selected some workflows, click the **Export Express** button.
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.

Expand All @@ -121,6 +137,7 @@ Review your selection, then press the Download button to download the selected w

**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.
Expand All @@ -138,6 +155,7 @@ Now, if the deployment process is successful, your workflows are imported and an

![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.
Expand Down
2 changes: 1 addition & 1 deletion axonivy-express-product/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.axonivy.portal</groupId>
<artifactId>axonivy-express-product</artifactId>
<version>10.0.0-SNAPSHOT</version>
<version>11.1.0-SNAPSHOT</version>
<packaging>pom</packaging>

<properties>
Expand Down
35 changes: 0 additions & 35 deletions axonivy-express-test/.classpath

This file was deleted.

19 changes: 0 additions & 19 deletions axonivy-express-test/.gitignore

This file was deleted.

49 changes: 0 additions & 49 deletions axonivy-express-test/.project

This file was deleted.

12 changes: 0 additions & 12 deletions axonivy-express-test/.settings/.jsdtscope

This file was deleted.

5 changes: 0 additions & 5 deletions axonivy-express-test/.settings/ch.ivyteam.ivy.designer.prefs

This file was deleted.

10 changes: 0 additions & 10 deletions axonivy-express-test/.settings/org.eclipse.jdt.core.prefs

This file was deleted.

10 changes: 0 additions & 10 deletions axonivy-express-test/.settings/org.eclipse.wst.common.component

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 0 additions & 2 deletions axonivy-express-test/.settings/org.eclipse.wst.css.core.prefs

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading