Step Details |
| Introduced in Version | --- |
| Last Modified in Version | 7.12.0 |
| Location | Designer Entities > Forms [Interaction] |
The External Form step was designed in Decisions to interact with forms using HTML methods or service calls. This method can also pass data into the external form and retrieve data from the External Form.
Properties
Assignment
| Property | Description | Data Type |
|---|
| Assignment Type | Link to Assignment doc | --- |
Service Definition
| Property | Description | Data Type |
|---|
| External System Is Form Based |
| Boolean
|
| Generate Service |
| Boolean |
| Service Name
|
| String |
| Service Outcomes | Add Outcomes; the Outcome Name is important because the Form needs to know the Outcome path. If desired, parameters may be added. | --- |
| Return URL Type | HTML, Auto, Silverlight | --- |
| Expose Data On Service | Adds desired inputs. | --- |
| Open in New Window | Will open the External Form in a new window. | Boolean |
| Exclude All URL Parameters | Removes the need for the Set Custom Callback URL Parameter Name and URL Encode the Callback URL settings. | Boolean
|
| Set Custom Callback URL Parameter Name | Adds Callback URL Parameter Name as an input. | Boolean
|
| URL Encode the Callback URL |
| Boolean
|
On Step Run
| Property | Description | Data Type |
|---|
| Step Start Flow Type | This setting allows for additional options for Runtime behaviors via the On Step Run section. Such options allow users to define the Step Start Flow Type as either None, SharedFlow, or Private. Triggering one of these options will allow the user to define which Flow To Run and the URL Parameter Name, the Assignment ID, Step Tracking ID, and Flow Tracking Parameters for the Assignment.
| --- |
| Specify Queue for Running the Start Flow |
| Boolean |
| Queue Name for Running the Start Flow |
| --- |
Inputs
| Property | Description | Data Type |
|---|
| URL | Enter the Form's URL. The URL should be formatted as http://[PortalBaseUrl]/[Name of virtual directory]/
| String |
Email
| Property | Description | Data Type |
|---|
| Email Notifications |
| Notification Policy | Select the Default notification policy, choose no policy or create a custom policy. | --- |
| Email Response Handling |
| Get Email Address From Inputs | Retrieve the Email Address from the Inputs of the step. | Boolean |
| Email Template
| Email Templates are HTML documents that define the look and feel of Emails sent from a Flow.
| --- |
Auto Resume
| Property | Description | Data Type |
|---|
| Make Auto Resume | The Expiration and Auto Resume Form properties allow Forms to be suspended, tasked for continuation, and automatically resolved with specified Flow outcomes.
| Boolean |
| Save Data | Choose to save data Immediately or OnAssignment. | --- |
| Make Auto Resume Delay |
|
|
| Auto Resume Expires | Expire Type and Expire Auto Resume Delay settings will be available when set to True. Add an "Auto Resume Timeout" outcome path to the External Form step. | Boolean |
Email Retry
| Property | Description | Data Type |
|---|
| Show Fail on Path | Displays an outcome path labeled "On Error." | Boolean |
| Retry on Fail | Sets the step to send an email again if it fails. | Boolean |
| Retry Count | Limits the number of times that the step will retry sending the email. The default number is "3". | Int32 |
| Retry Delay In Seconds | Delays retrying sending the email. | Int32 |
