Create Form Action

Description

This Action creates a new Form to be used in a Task.

Java Class

The Action is implemented by the Java class de.ecm4u.faw.api.impl.CreateFormAction.

Parameters

Mandatory parameters:

• CreateFormAction.formTemplateId: The name of the Form Template to create the Form from.

Optional parameters:

• CreateFormAction.postCreateHookScript: The name of the script textresource that will be run after the Form has been created.
• CreateFormAction.saveHookScript: The name of the script textresource that will be run when the Form is saved.
• CreateFormAction.submitHookScript: The name of the script textresource that will be run when the Form is submitted.
• CreateFormAction.taskPropertiesOnSave: A list of form property names whos values shall be persisted as Task Properties on save.
• CreateFormAction.flowPropertiesOnSave: A list of form property names whos values shall be persisted as Flow Properties on save.
• CreateFormAction.taskPropertiesOnSubmit: A list of form property names whos values shall be persisted as Task Properties on submit.
• CreateFormAction.flowPropertiesOnSubmit: A list of form property names whos values shall be persisted as Flow Properties on save.

For an alternative way to to configure the formData values to be saved on save or submit, see the documentation for Forms.

Prepared formData values:

• formData.*: Any number of parameters using the formData. prefix can be used to preset formData properties of the Form.
• formDataOriginal.*: Any number of parameters using the formDataOriginal. prefix can be used set original values for properties of the Form. Some widgets (smFlow) make use of this value.

Example Parameters

These parameters create a Form and store the IDs.

args:
  CreateFormAction.formTemplateId": Collect And Store

These parameters run scripts.

args:
    CreateFormAction.formTemplateId: Collect And Store
    CreateFormAction.postCreateHookScript: ecm4uBizDocs_selectFilingCase_postCreateHookScript.js
    CreateFormAction.saveHookScript: ecm4uBizDocs_selectFilingCase_saveHookScript.js
    CreateFormAction.submitHookScript: ecm4uBizDocs_selectFilingCase_submitHookScript.js

These parameters create a Form with preset formData values.

args:
    CreateFormAction.formTemplateId: Collect And Store
    formData.formStringProperty: string value for property
    formData.formNumberProperty: 12.34
    formData.formBooleanProperty: true

These parameters create a Form with current and default values for a smFlow widget.

args
    CreateFormAction.formTemplateId: Collect And Store
    formData.MY_STATUS: CURRENT_VALUE
    formDataOriginal.MY_STATUS: DEFAULT_VALUE