Article last updated on the 12th of April, 2024.
The contents of this article may be subject to change due to ongoing development of the WorkPoint Automate.
The Entity form allows you to create or edit entity data which is then stored in the context of your process. This data can then be used in subsequent steps of the process.
A general use case for the Entity input form is to use the form to create entity data, store the output from the form in the process context, and then load the data as input for a Create entity step. Another example is to use Entity forms to edit the meta data of existing entities by using "Business Module Entity" from the process context as Step Input for this form.
This will in effect allow you to create a process which appears as a form where you can input meta data for an entity, like Title, Project ID (for projects) and Description, and which then creates a business module entity using the data you put in.
This process might look something like the following:
The following image shows an empty Entity input form in the Process Builder:
Parameters
| Parameter name | Type | Required | Description |
|---|---|---|---|
| General | |||
| Title | String | Yes | The title of the step as it is displayed in the process builder and to the end user when running the process. |
| Description | String |
No | Use this field to type in a description for the step. This description is shown both in the process builder (below the step in the overview) and to the end user when running the process (below the step name in the main section of the process). |
| Name | String |
Yes | The name used to refer to this specific step in the process. Must be unique for each step. This name is not displayed to the end user. Default value is "EntityForm". |
| Continue button title | String | No | The text on the Continue button in the bottom right of the process window. Default value is "Continue", but can be customized. |
| Step Input | String |
No | Use this field to specify an initial input for this entity form. This can e.g. be used if you want to edit the meta data of an existing entity by adding "Business Module Entity" from the process context in this field. If this form should be blank when running the process, leave this field blank. |
| Options | |||
| Business module | String |
Yes | Use this field to select a business module. |
| Content type (stage) | String |
No | Use this field to select the content type to use for the Entity Form. Can be a hard-coded content type from the selected business module, or e.g., the "stage" property from a Stage Form, or a reference to a current entity's content type by using Entity.ContentTypeId from the process context. If the selected business module uses staging, any stage as well as any other content type defined on the business module, can be selected in this field. |
| Enable content type (stage) selection | Boolean | No | Use this field to select whether the user should be able to select between allowed content types in the form. If this option is set to "Yes", all stage relevant fields (e.g., Stage model, Content type (stage), Substage) applicable for the selected business module will be available to users of the form. |
Fields
In the "Fields" tab, you can configure options for the fields being displayed in the Entity form.
Depending on the value set in the "Business module" option, the fields being displayed will either be the ones from the selected content type as shown in this picture:
Or the fields which you have modified, including fields which are set as hidden, if a dynamic value is selected in the Business module field, as shown in this picture:
If displaying the fields using a dynamic business module value, the fields will not be shown anywhere, but a value can still be passed to them and used in subsequent steps. Note that the fields are shown using their internal field names.
This means that you could e.g., initially set the "Business module" field on the Entity Form to a specific module, configure some settings for one or more hidden fields, and then change the Business module field to a dynamic value, such as "BusinessModule.Id" from the context. In that scenario, the "Fields" tab of the Entity form will display only the fields which you previously configured, and data can be passed into it and out from it. Note however, that hidden fields displayed in the Entity form configuration in the Process Builder will not be displayed when the form is shown in a running process.
Here's an example of an Entity Form in use in a process:
Note that, due to the fact that in this example, we have selected a business module which uses multiple stage models and substages and have enabled content type selection, the "Project Size" field (mapping field from stage settings), "Stage", and "Substage" fields are available.
Comments
0 comments
Please sign in to leave a comment.