Article published on the 18th of January, 2023.
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". |
| 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 | String |
No | Use this field to select which fields to specify the ID of the content type whose fields you want to show in the Entity Form. Can be a hard-coded content type from the selected business module, or e.g., the "stage" output from a Stage Form, or a reference to a current entity's content type by using Entity.ContentTypeId from the process context. |
| Enable content type selection | Bool | No | Use this field to select whether the user should be able to select between allowed content types in the form. |