sartography
/
cr-connect-workflow
mirror of https://github.com/sartography/cr-connect-workflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Aaron Louie 2020-01-02 11:36:32 -05:00
parent 5f3887256e
commit 36bc3461b2
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Home.md

@ -1,7 +1,11 @@
# CR Connect Workflow Engine # CR Connect Workflow Engine
## Workflow Configuration ## Workflow Configuration
### Form Field Types in Camunda Modeler ### Form Field Types in Camunda Modeler
By default, Camunda Modeler supports a very limited set of form field types. To provide more complete support on the front end, we use the form field Property attributes. By default, Camunda Modeler supports a very limited set of form field types. To provide more complete support on the front end, we use the form field Property attributes.
You will need to add the following custom types (select `custom type` in the Type dropdown): You will need to add the following custom types (select `custom type` in the Type dropdown):
@ -26,7 +30,10 @@ Then to display each of the following types of form fields, set the type and, in
| Telephone number | `tel` (Custom Type) | n/a | n/a | | Telephone number | `tel` (Custom Type) | n/a | n/a |
| Email address | `email` (Custom Type) | n/a | n/a | | Email address | `email` (Custom Type) | n/a | n/a |
### Form Field Configuration ### Form Field Configuration
#### Hiding fields #### Hiding fields
Fields can be hidden and shown conditionally with a Javascript expression, which will be parsed on the front end by [Formly](https://formly.dev/guide/expression-properties). You can reference any other fields in the form using the prefix `model` in front of its Form Field ID. For example, if you have a `boolean` field with ID of `hasUploadedFile`, you can access its value with `model.hasUploadedFile` in the Formly expression. Fields can be hidden and shown conditionally with a Javascript expression, which will be parsed on the front end by [Formly](https://formly.dev/guide/expression-properties). You can reference any other fields in the form using the prefix `model` in front of its Form Field ID. For example, if you have a `boolean` field with ID of `hasUploadedFile`, you can access its value with `model.hasUploadedFile` in the Formly expression.
@ -35,6 +42,7 @@ Fields can be hidden and shown conditionally with a Javascript expression, which
| ------------- | -------------------------- | | ------------- | -------------------------- |
| `hide_expression` | `!(model.someBooleanFieldName && (model.enumFieldName === 'Other'))` | | `hide_expression` | `!(model.someBooleanFieldName && (model.enumFieldName === 'Other'))` |
#### Required fields #### Required fields
To make a field required by default, add the following Validation Constraint: To make a field required by default, add the following Validation Constraint:
@ -45,19 +53,20 @@ To make a field required by default, add the following Validation Constraint:
If a field needs to be filled out based on the value of some other field(s) in the form, you can use a Formly Javascript expression (see above). If a field needs to be filled out based on the value of some other field(s) in the form, you can use a Formly Javascript expression (see above).
| Property > Id | Property > Value (example) | | Property > Id | Property > Value (example) |
| ------------- | -------------------------- | | ------------- | -------------------------- |
| `required_expression` | `!(model.someBooleanFieldName && (model.enumFieldName === 'Other'))` | | `required_expression` | `!(model.someBooleanFieldName && (model.enumFieldName === 'Other'))` |
#### Help text #### Help text
There are three places where help text will be displayed on the front end when the form is rendered: There are three places where help text will be displayed on the front end when the form is rendered:
- Placeholder text: appears within the field if it is empty - Placeholder text: appears within the field if it is empty
- Description text: appears below the field - Description text: appears below the field
- Help dialog text: appears in a pop-up when the `?` button next to the field is clicked. [Markdown formatting code](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links) is supported for this field, but you will need to replace all line breaks with `\n` (for now). - Help dialog text: appears in a pop-up when the `?` button next to the field is clicked. [Markdown formatting code](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links) is supported for this field, but you will need to replace all line breaks with `\n` (for now).
To display each type of help text, add a custom property: To display each type of help text, add a custom property:
| Type of help text | Property > Id | Property > Value (example) | | Type of help text | Property > Id | Property > Value (example) |
| ----------------- | ------------- | -------------------------- | | ----------------- | ------------- | -------------------------- |
| Placeholder text | `placeholder` | `Enter your email address here` | | Placeholder text | `placeholder` | `Enter your email address here` |