From 6b8592be27825ed68332c225844ad154de6fd83c Mon Sep 17 00:00:00 2001 From: Phan Van Thai Date: Mon, 9 Oct 2023 11:52:25 +0700 Subject: [PATCH] test --- _sass/jekyll-theme-cayman.scss | 4 -- assets/css/style.scss | 27 +++++++++ developer-guide.md | 2 +- index.md | 12 ++-- user-guide.md | 102 ++++++++++++++++++++------------- 5 files changed, 97 insertions(+), 50 deletions(-) diff --git a/_sass/jekyll-theme-cayman.scss b/_sass/jekyll-theme-cayman.scss index 1e2db82..fb2e083 100644 --- a/_sass/jekyll-theme-cayman.scss +++ b/_sass/jekyll-theme-cayman.scss @@ -170,10 +170,6 @@ a { .main-content { word-wrap: break-word; - :first-child { - margin-top: 0; - } - @include large { max-width: 70rem; padding: 2rem 6rem; diff --git a/assets/css/style.scss b/assets/css/style.scss index 9b203aa..d0f4736 100644 --- a/assets/css/style.scss +++ b/assets/css/style.scss @@ -12,3 +12,30 @@ img { width: 100%; } table { display: table !important; } + +@mixin highlighted-box { + padding: 12px; + margin-bottom: 24px; +} + +@mixin highlighted-box-title { + font-weight: 700; + display: block; + color: #fff; + padding: 6px 12px; + margin: -12px -12px 12px; +} + +.important-box { + background-color: #dbfaf4; + @include highlighted-box; +} + +.important-title { + background: #1abc9c; + @include highlighted-box-title; +} + +.code { + color: #D23636; +} \ No newline at end of file diff --git a/developer-guide.md b/developer-guide.md index c2f790f..0f01b52 100644 --- a/developer-guide.md +++ b/developer-guide.md @@ -28,7 +28,7 @@ AxonIvyExpress. You can use them in your own applications. **Contains portal specific UI components, templates and pages** -The module `portal` provides a set of specific UI components that you +The module **portal** provides a set of specific UI components that you need to use and administer (or manage) the portal, templates for developer and portal pages. diff --git a/index.md b/index.md index a45b2fc..2ed71a8 100644 --- a/index.md +++ b/index.md @@ -11,13 +11,17 @@ So far, this document familiarized you with the Axon Ivy Portal and explained ho * 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. -You can reach Express by using the link `Processes` in the Portal menu. +You can reach Express by using the link Processes in the Portal menu. ![navigate-to-axon-ivy-express](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/navigate-to-axon-ivy-express.png) -Below the heading **Processes**, you see the link `Create Express Workflow`. Below, you find the process category **Express Workflows** with a list of predefined processes. +Below the heading **Processes**, you see the link Create Express Workflow. Below, you find the process category **Express Workflows** with a list of predefined processes. ->**Important:** Only users who have granted the role `EXPRESS_CREATE_WORKFLOW` can see and access the link `Create Express workflow`. To configure this permission, go to `Engine Cockpit`. In the -security area, you will find this permission in group **PortalPermissions** +
+

Important

+

+ Only users who have granted the role EXPRESS_CREATE_WORKFLOW can see and access the link Create Express workflow. To configure this permission, go to Engine Cockpit. In the security area, you will find this permission in group PortalPermissions +

+
![start-link-for-axon-ivy-express](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/start-link-for-axon-ivy-express.png) \ No newline at end of file diff --git a/user-guide.md b/user-guide.md index cd222dd..153979f 100644 --- a/user-guide.md +++ b/user-guide.md @@ -4,48 +4,48 @@ layout: default ## **HowTo: Create an Express Workflow** -1. Click on `Create Express Workflow`. +1. Click on Create Express Workflow. -2. The `Express Workflow` editor is opened. +2. The Express Workflow editor is opened. -3. Define the `Type of process`: +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` : +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 Express. -5. Provide a descriptive name under `Process name` +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. +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. +7. Click on the link Change beside Icon to select the icon best suited for your process. ![express-workflow-process-properties](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-workflow-process-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` +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` +10. You may delete unnecessary process steps using the button Remove process step 11. For each process step, - 1. select the `Task Type` (see [Express Workflow task types](#express-workflow-task-types)). - 2. provide a descriptive name in `Task Name` - 3. provide an optional description in `Task description`. + 1. select the Task Type (see [Express Workflow task types](#express-workflow-task-types)). + 2. provide a descriptive name in Task Name + 3. 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 +12. For *One time* process type, the first process step defines the users or roles under Able to start who can start the process ![express-able-to-start](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-able-to-start.png) -13. For all other process steps define the user or roles who are responsible to execute the task in `Responsible` . +13. For all other process steps define the user or roles who are responsible to execute the task in Responsible . ![express-task-responsible](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-task-responsible.png) -14. For each process step except the first define the time before the task expires in `Expiry in days` +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` +15. End the configuration of each process step by pressing Next ![define-express-workflow-process-steps](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/define-express-workflow-process-steps.png) @@ -64,30 +64,35 @@ layout: default 17. For each data item you need in your process, select an input element -18. Provide a descriptive name for the input in `Label` +18. Provide a descriptive name for the input in Label -19. Select the input type in `Input type` +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 +21. Use the button Create to create the input element -22. The created element appears in the list `Available form elements` +22. The created element appears in the list Available form elements 23. To delete input elements you don't need, click its 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 +25. To remove an input element from the dialog, use the Delete button -26. To preview your dialog, press the `Preview` button +26. To preview your dialog, press the Preview button -27. To define an additional process step, click the button `Next` +27. To define an additional process step, click the button Next ![express-workflow-dialog-editor](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-workflow-dialog-editor.png)
- >**Hint:** 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. +
+

Hint

+

+ 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** @@ -116,31 +121,31 @@ layout: default 33. Optionally, include attachments. -34. Use the button `Next` to define the next process step +34. Use the button Next to define the next process step ## **Define an Information Email** -> For the information email, you see an email client UI where you can add information related to the process. You need to define a comma-separated list of addresses. Optionally, you can define a `response to` address. +For the information email, you see an email client UI where you can add information related to the process. You need to define a comma-separated list of addresses. Optionally, you can define a response to address. ![express-workflow-email-editor](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-workflow-email-editor.png) ## **Express Business Summary** -After you have completed an Express workflow, you can check its summary data by accessing its `Business Details` page. +After you have completed an Express workflow, you can check its summary data by accessing its Business Details page. ![express-business-summary](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-business-summary.png) ### **HowTo: Show Business Summary** -1. Go to the `Case List ` page and open the link `Actions` , `Business details`. +1. Go to the Case List page and open the link Actions , Business details. ![express-case](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-case.png) -2. Then the `Express form` is shown in read-only mode. +2. Then the Express form is shown in read-only mode. ![express-business-summary](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-business-summary.png) ->**Note:** If your process is running, you will only see the data of the current Express task on the `Summary` page +>**Note:** If your process is running, you will only see the data of the current Express task on the Summary page ## **Express Management** @@ -148,7 +153,12 @@ With Express Management, an administrator can import/export Express workflows in ![express-management-tab](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-management-tab.png) ->**Note:** To access this feature, you need to be granted the role **AXONIVY_PORTAL_ADMIN**. +
+

Note

+

+To access this feature, you need to be granted the role AXONIVY_PORTAL_ADMIN. +

+
### **HowTo: Export an Express Process** @@ -156,26 +166,31 @@ Select the workflows you want to export in Express workflows table. The selected ![express-export-tab](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/express-export-tab.png) -1. You can select multiple workflows by clicking the checkbox `ALL`. -2. 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. ![export-list-summary](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/export-list-summary.png) -Review your selection, then press the `Download` button to download the selected workflows. +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 Express and Express process data. Don't edit this file manually. +
+

Important

+

+The export file is a JSON file. It contains a version of 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. +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-selection](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/import-selection.png) -Then, press the `Deploy` button and wait for the deployment process. +Then, press the Deploy button and wait for the deployment process. ![import-deployment](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/import-deployment.png) @@ -187,14 +202,19 @@ Now, if the deployment process is successful, your workflows are imported and an ## **Ad Hoc Process** -Express also provides an ad hoc process feature. Onc Express is deployed, you can start an ad hoc process from any task. Ad hoc processes allow you to define more process steps and will be executed before the current task. +Express also provides an ad hoc process feature. Once Express is deployed, you can start an ad hoc process from 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 an ad hoc process by clicking on the menu icon at the top right in your task, then click on Start Adhoc ![adhoc-start](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/adhoc-start.png)
->**Important:** Save the data of your current task before you start the ad hoc process. +
+

Important

+

+Save the data of your current task before you start the ad hoc process. +

+

Then, define your ad hoc process. @@ -213,6 +233,6 @@ When you start your original task, you will see a summary of the ad hoc process ![adhoc-process-history](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/adhoc-process-history.png) -You can view the history again by clicking the menu icon, then click on `Adhoc history`. +You can view the history again by clicking the menu icon, then click on Adhoc history. ![adhoc-show-history](https://market.axonivy.com/market-cache/portal/portal-guide/11.1.0/_images/adhoc-show-history.png) \ No newline at end of file