Create External Form Reference

Last Updated: 04/11/2018 Introduced in Version: 4.0

This tutorial demonstrates how to use External Form Reference in Decisions. External Form Reference feature introduced in Decisions 4.0. This feature allows workflow designers to create a setup for External Form and save it as an Entity. Then, this External Form Reference may be reused in different Flows.

Example:

In this example we are going to create an External Form Reference and demonstrate how to use it in a Workflow process.

Note: in this example we are going to use a simple External Form from the following document.

We begin in the Designer Folder with clicking Create Form > Create External Form Reference on the Folder Actions Panel.

In the resulting window we Name our External Form Reference.

From the URL Source drop-down we may pick Specified (hard-coded URL), FlowInput (URL from Flow Data), or FlowConstant (URL from System Constants). In this example we pick Specified.

Then, we provide Default URL for our External Form.

Under Service Definition we can check Generate Service checkbox if we need system to generate Service for the Form.

Under Service Outcomes we need to define at least one outcome from our External Form. We may also provide several outcomes. We click Add New to define Service Outcome. In the resulting window we provide Outcome Name. Mention, we may define Parameters for the Outcome if we expect our External Form to return some data. When finished we click Ok to save the Outcome and continue.

Under Expose Data On Service we can define data that we need to send to the External Form from the Workflow. In this example we simply define Test (String) to send to the External Form.

From Return URL Type we can pick Html, Auto or Silverlight.

Finally we have the following check-box settings:

  • Set Custom Callback URL Parameter Name
  • URL Encode the Callback URL
  • Open In New Window

When finished, we click Ok to save our External Form Reference and continue.

Back in the Designer Folder we can see that system created External Form Reference entity.

Next, we are going to demonstrate how to use External Form Reference in the Workflow process.

We click Create Flow on the Folder Actions Panel.

In the resulting window we Name the Flow and click Ok to proceed to the Flow Designer.

In the Flow Designer we add our Simple External Form (External Form Reference) from Flows, Rules, Forms and Reports > Forms [Interaction] > [Current Folder] category on the outcome from the Start Step in our Flow.

Then, we define Constant Test Input to send to our External Form.

Finally, we connect the outcome from Simple External Form step to the End Step in our Flow. This completes our Flow. We can save the Flow and close Flow Designer.

In the Designer Folder we locate our Flow and click Run Flow from Action menu on the thumbnail.

Our External Form opens in a new window. We submit the form…

externalformpopsup

…And this completes our Flow.

flowcompletioninstructions

 

Additional Resources