Trace:
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
workflow:documentation [2022/03/30 21:12] robot |
workflow:documentation [2022/03/30 22:14] (current) robot |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ~~Title: Workflow engine Documentation~~ | ~~Title: Workflow engine Documentation~~ | ||
| - | Version: 1.0 / 2022-03-30 | + | Version: 1.0 / 2022-03-31 |
| ====== Introduction ====== | ====== Introduction ====== | ||
| Line 65: | Line 65: | ||
| Example: In our example, we created a new folder named 'E-mail' and added the workflow 'Send email'. | Example: In our example, we created a new folder named 'E-mail' and added the workflow 'Send email'. | ||
| - | {{:workflow:documentation:workflowerstellen.png?nolink|}} | + | {{:workflow:documentation:workflowcreate.png?nolink|}} |
| === Add/Delete functions === | === Add/Delete functions === | ||
| Line 174: | Line 174: | ||
| We assign 'get Users' as the label and get our admin user via a database query. We just have to write the SQL statement in the query text field. | We assign 'get Users' as the label and get our admin user via a database query. We just have to write the SQL statement in the query text field. | ||
| - | {{:workflow:documentation:workflowerstellenstatement.png?nolink|}} | + | {{:workflow:documentation:workflowcreatestatement.png?nolink|}} |
| If you have not yet entered an e-mail address for the admin user of your application, please open the "User Management" screen on the "Admin" menu in VisionX and enter an email address, so that it can be used it for this example. | If you have not yet entered an e-mail address for the admin user of your application, please open the "User Management" screen on the "Admin" menu in VisionX and enter an email address, so that it can be used it for this example. | ||
| Line 184: | Line 184: | ||
| We can now press the 'Run Test' button (2) to test the current workflow step. In this case, we get the result of the SQL-Statement displayed under the "USERS" key. | We can now press the 'Run Test' button (2) to test the current workflow step. In this case, we get the result of the SQL-Statement displayed under the "USERS" key. | ||
| - | {{:workflow:documentation:workflowerstellensendemail3.png?nolink|}} | + | {{:workflow:documentation:workflowcreatesendemail3.png?nolink|}} |
| Our next step is to configure the "Send E-mail" step we added earlier. | Our next step is to configure the "Send E-mail" step we added earlier. | ||
| Line 192: | Line 192: | ||
| Double click on the "Send E-mail" step to configure the parameters. | Double click on the "Send E-mail" step to configure the parameters. | ||
| - | {{:workflow:documentation:workflowerstellensendemailkonfiguration.png?nolink|Designer}} | + | {{:workflow:documentation:workflowcreatesendemailconfiguration.png?nolink|Designer}} |
| We label the workflow step 'send email' and add our e-mail address to the ‘From’ field. | We label the workflow step 'send email' and add our e-mail address to the ‘From’ field. | ||
| Line 204: | Line 204: | ||
| //Note: Fixed values can also be used for parameters, as in the "From" text field.// | //Note: Fixed values can also be used for parameters, as in the "From" text field.// | ||
| - | {{:workflow:documentation:workflowerstellenparamater.png?nolink|Designer}} | + | {{:workflow:documentation:workflowcreateparameter.png?nolink|Designer}} |
| We then test the Workflow Step using the 'Run Test' button. An exception occurs. This is because we have not yet configured the email server parameters. | We then test the Workflow Step using the 'Run Test' button. An exception occurs. This is because we have not yet configured the email server parameters. | ||
| Line 709: | Line 709: | ||
| A function is the code block behind a task. It is very simple to create a new function because a function is defined as a simple Java interface: | A function is the code block behind a task. It is very simple to create a new function because a function is defined as a simple Java interface: | ||
| - | <code> | + | <code java> |
| public interface IFunction | public interface IFunction | ||
| { | { | ||
| Line 728: | Line 728: | ||
| /** | /** | ||
| * Runs the function. | * Runs the function. | ||
| - | * If the function returns <code>true</code>, the function is fully done, and the workflow jumps to the next step. | + | * If the function returns {@code true}, the function is fully done, and the workflow jumps to the next step. |
| * In case there are more than one next step, the finish function of IWorkflowStep has to be called. | * In case there are more than one next step, the finish function of IWorkflowStep has to be called. | ||
| * Otherwise, an exception will be thrown. | * Otherwise, an exception will be thrown. | ||
| - | * If finish is already called, it does not matter whether <code>true</code> or <code>false</code> is returned. | + | * If finish is already called, it does not matter whether {@code true} or {@code false} is returned. |
| * | * | ||
| - | * @return <code>true</code>, if the function is done. | + | * @return {@code true}, if the function is done. |
| * @throws Throwable if function fails. | * @throws Throwable if function fails. | ||
| */ | */ | ||
| Line 748: | Line 748: | ||
| The interface already has an abstract implementation, so it is really simple to create a new function. Our example will send an email, so it's the EmailFunction: | The interface already has an abstract implementation, so it is really simple to create a new function. Our example will send an email, so it's the EmailFunction: | ||
| - | <code> | + | <code java> |
| public class EmailFunction extends AbstractFunction | public class EmailFunction extends AbstractFunction | ||
| { | { | ||
| Line 795: | Line 795: | ||
| The email settings will be read from the application configuration (config.xml file). | The email settings will be read from the application configuration (config.xml file). | ||
| - | <code> | + | <code xml> |
| <application> | <application> | ||
| ... | ... | ||