/
Form and Doc Action Wizards

Live Forms v7.4 is no longer supported. Please visit Live Forms Latest for our current Cloud Release. Earlier documentation is available too.

Form and Doc Action Wizards

Apr 02, 2020

Wizards make it easier to configure what happens to the data when a user submits your form and what the users see after submitting the form. The wizards are accessible from the form/flow designer toolbar via the icon labeled what does the user see for Form Actions or the  icon labeled what happens to my data for Doc Actions. The action settings are summarized in the form properties Form Info tab.

An email notification is sent to all tenant administrators or the flow administrator(s) (if configured) when a Form Action post, DOC URI or DOC Action fails and the submission does not reach it's intended destination. When the form/flow is submitted, the user sees the message "Thank You! Your submission has been received." and then the appropriate admin is notified via email. The email is sent when the following Form/Doc actions are configured in a form/flow:

This is not applicable to the email doc action since it is asynchronous and the notification would fail if the service were unavailable. Refer to each topic for more information.

Doc action wizards are single select. If you set up one of the wizards then configure an action using a second wizard, the information configured on the first wizard will no longer display. This is as designed.

Let's say you want to send an email after your form/flow is submitted but you are also using the Filesystem connector to save your submissions to a directory on a local server. You configure the Filesystem connector wizard to do this. Then your configure the Email data to a specified address wizard to send the email. If you return to the Filesystem connector wizard, after configuring the email wizard, the information that you entered on the Filesystem connector screens will no longer display. In this situation, you can use the email wizard on the Additional Email tab to configure your email. Refer to How to setup Multiple Document Actions for an example.

Form Action Wizards

The form action wizards configure what users will see when they submit your form.

Using these wizards you can:

  • Close the form window
  • Display a message to the user in the existing form windows
  • Forward to a nicely formatted web page that you have created elsewhere
  • Forward to Paypal if your form has sold items to the user
  • Post the form data to a service and then forward the user to a web page 

The wizards help guide you through the configuration process. Many of the wizards allow you to use form controls as templates to dynamically create what the users sees rather than hard coding this. See the section on using templates in form/doc/error actions for full details.

You can only configure one Form action for a form/flow. This is as designed.

On this page:

Close the Window

After the user submits the form, if the form was shared via "Full Page/Popup" or "Link (Email/Web page)", the window containing the form will be closed.

Display Message

After the user submits the form, the browser will display a standard 

page with a text message. For example, the message might say, “Thank you for completing our form.” You supply the specific text in the Message field. This option works best for relatively brief messages. It can be tricky to enter or edit large amounts of text in the wizard's Message field, so for verbose messages consider creating a simple HTML page for your message and choosing the Forward User to your Web Page wizard.

The message can be customized, using the wizard's control dropdown, with values the user enters into the form. For example if your form contains a fields named firstName and lastName, you can set your message to "Thank you {firstName} {lastName}". Now when a user submits the form the controls templates {firstName} and {lastName} will automatically be replaced with field values "Thank you Joe Smith". See using templates in form/doc/error actions for full details.

Another useful message is to display a link back to the form. For example the display message:

The display message would be written as follows. The URL back to the form is the share dialog Raw Form link.

Thank You!<br/><br/> {Company}'s account will be created within 24 hours.<br/> A "A New Account" email will be sent to {Email}.<br/><br/> <i>RedStone Customer Support</i><br/><br/> Click <a href="http://test.frevvo.com/frevvo/web/tn/redstone/user/designer/app/_OLlAYUouEd-0jOS-XMShUg/formtype/_YRsQYEyBEd-OltN4g8wchQ?_method=post &embed=true&locale=">here</a> to request another demo account

The form/flow URL in the above HTML example can be constructed dynamically in a business rule. See this rule example.

Javascript is not allowed in the display message. Plain text, html and control templates are allowed. Anything else will break the message and nothing will be displayed.

Show In

Both the display message wizard and the forward to web page wizard allow you to select where the message is displayed on the page using the "Show In" dropdown. There are three choices: Frame, Parent and Top. This tells the browser where to show the text (if you chose Display Message) or the new Web page (if you chose the Forward to Web Page).

  • Frame means inside the form's iframe

  • Parent means inside the form iframe’s immediate parent

  • Top means at the top of the page, regardless of how many parents are outside the iframe.

Forward to Web Page of Your Choice

After the user submits the form, the browser will be redirected to another URL, which you supply in the  URL field. You must include the http:// prefix (e.g., http://myhost.com/thankyou.html). The application can have a Form Action Base URL which you set in the application properties. For example, you can have http://myhost.com/ in the application  baseURL and simply “thankyou.html” in the Form Action URL field.

You can use a form field template in the URL field. Ex: http://localhost:8082/URL!encode=false}. The encode=false template parameter is important to avoid mangling the URL. See Templatized String Parameters for details.

Show In

These are the same options as described under the display message wizard above. Unless you have created a special page that you know will fit correctly within the form’s iframe you should not choose iframe. Choose the Parent or Top option instead. 

Forwarding users to a web page that is located in a different domain will not work.

Forward to Paypal

When the form is submitted, users will be forwarded to Paypal to complete payment. This multi-step wizard guides you through configuration:

  • Paypal account login

  • Paypal invoice description based on form values

  • Paypal payment amount from form values

and more...

Paypal for Workflows

Workflows do not have a corresponding "Forward to PayPal to complete Payment" action. However, you can configure either the Workflow Action: Forward users to a webpage of your choice or a link control in an individual step to connect to PayPal from a workflow. 

Replace the values in the <> brackets in the examples with your values. (These parameters are explained below.) You can also substitute the value of a form control in below URLs using templates, for example: to use a control named "amount" in the URL, configure it as:

&amount={amount}

PayPal Sandbox: https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_xclick&business=<Paypal business name>&amount=<Payment amount>&item_name=<Payment Description>&currency_code=<Currency Code>&return=<Return URL>&cancel_return=<Cancel URL>&custom=<Custom Value>&invoice=<Invoice Value>&notify_url=<Notification Url>

Production: https://www.paypal.com/webscr/webscr?cmd=_xclick&business=<Paypal business name>&amount=<Payment amount>&item_name=<Payment Description>&currency_code=<Currency Code>&return=<Return URL>&cancel_return=<Cancel URL>&custom=<Custom Value>&invoice=<Invoice Value>&notify_url=<Notification URL>

URL Parameters

  • Paypal business name: Paypal business name. Typically, this is the email address you use to sign in to Paypal.

  • Payment amount: The payment amount.

  • Payment Description: The payment description is what your users will see when paying.

  • Currency Code: The currency code used in payment. Example: USD, CAD, INR

  • Return URL: A user will be redirected to this page after payment is complete. If you leave this blank, users will be redirected to a standard platform URL. 

  • Cancel URL: A user will be redirected to this page if payment is cancelled. If you leave this blank, users will be redirected to a standard platform URL.

  • Custom Value: PayPal will return this custom value in the IPN as well as the acknowledgement email.

  • Invoice Value: PayPal will return this invoice value (such as an Invoice Number) in the IPN as well as the acknowledgement email.

  • Notification URL: A notification URL. If you enter a URL here, PayPal will notify you using Instant Payment Notification. Please see the PayPal documentation for details.

Workflow Action: Forward Users to a Webpage of Your Choice

Add the URL (configured like this example) to the URL field. After the last step is submitted, the user will be redirected to PayPal for payment processing.

Example: https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_xclick&business=mycompany@gmail.com&amount=2&item_name={BMyDesc}&currency_code=USD&return=http://localhost:8080/frevvo/web/tn/t1/u/53f402db-5ef2-4052-95a0-a44a2d000832/app/_JuJjkWogEeq1EfoSPaFbFA/formtype/_6Vmn0G02EeqEf75e1_YeJg?_method=post&embed=true&cancel_return=http://localhost:8080/frevvo/web/tn/t1/u/53f402db-5ef2-4052-95a0-a44a2d000832/app/_JuJjkWogEeq1EfoSPaFbFA/formtype/_6Vmn0G02EeqEf75e1_YeJg?_method=post&embed=true&custom=123&invoice=123&notify_url=

This example uses the raw share link for the workflow in the &return= and &cancel_return= URLs. These will redirect the user to a new instance of the workflow. 

Individual Step

If you need PayPal integration in specific step of a workflow, add a link control in that step with above URL and set return URL pointing back to current step of the workflow using built-in data. They can then submit the step and the workflow will continue as designed.

Example: https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_xclick&business=mycompany@gmail.com&amount=2&item_name={BMyDesc}&currency_code=USD&return=http://localhost:8080/frevvo/web/tn/{form.tenant.id}/u/{form.user.uuid}/app/{form.application.id}/flow/{flow.id}/current?typeId={flow.type.id}&cancel_return=http://localhost:8080/frevvo/web/tn/{form.tenant.id}/u/{form.user.uuid}/app/{form.application.id}/flow/{flow.id}/current?typeId={flow.type.id}&custom=123&invoice=123&notify_url

 

Post Data then Forward to Web Page

After the user submits the form, the browser will POST the user’s data to the URL you specify in the wizard’s URL field and display whatever is returned—the next page to display.

Fill in the Post Submission to your Application wizard with the following information:

  • Enter the URL to the application where you want to post data:

    • Your URL field must include the http:// prefix (e.g., http://myhost.com/services/processPayment). The application can have a Form Action Base URL which you set in the application properties. For example, you can have http://myhost.com/services/ in the application baseURL and simply “processPayment” in the Form Action URL field.

    • The URL can also include control templates. This can be useful when you wish to specify a production versus a test server. For example: http://{serverURL}/services/processPayment/{customerId}. Using this form URL, you can specify serverURL using &_data=(serverURL:'testhost'). This makes switching from a test server to a production server a matter of setting the form URL parameter "serverURL" rather than editing the form itself. See Initializing Forms with Data for more details on _data usage.

    • You can use a form field template in the URL field. The encode=false template parameter is important to avoid mangling the URL. See Templatized String Parameters for details.

  • Send the data as a PDF attachment or other image type using the Send Snapshot dropdown. The image type options are PDF, PNG or JPG.  Select the blank option from the dropdown to exclude this attachment in the submission.

  • Attach an XML data document using the Send Data checkbox. This checkbox is checked by default. Uncheck it to exclude the XML data document in the submission.

  • Attachments uploaded to your form/flow are included if the Send Files checkbox is checked. This checkbox is checked by default. Uncheck it to exclude attachments in the submission.

  • If you have Pixel Perfect mapped PDFs (ex: W-4, I-9 etc…) associated with your forms/flows, choose  the action you want to take from the Send Gen Forms control:

    • Check All to send all the Pixel Perfect PDFs. This is the default value.

    • Check None to send none of the PDFs

    • Check Select to display a list of all the PDFs associated with your form/flow. Click the ones you want to be part of the submission. Hold down the Shift key then click the files in the list to select all PDFs or hold the control key and click specific PDFs.

  • POST responses must be displayed in the frevvo form frame. It is not possible to modify the Show In dropdown.