Section |
---|
Column |
---|
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/workflow designer toolbars via the Image Modified Edit Forms/Workflows properties icons. Specify Form Actions (what the user sees) and Document Actions (what happens to my data) on the associated tabs in these wizards. The action settings are summarized in the form/workflow properties Form Info tab. Image Modified An email notification is sent to all tenant administrators or the workflow 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/workflow 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/workflow: 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. Info |
---|
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/workflow 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. |
The Form/Workflow Action wizards help set up what the user sees when the form/workflow is submitted. You can access the Form/Workflow Action tabs in three ways: - Click the Image Modified Edit Form/Workflow Properties icon on the Forms/Workflow Designer toolbar. This will launch the Forms/Workflows Properties wizard. Click the Form/Workflow Actions tab.
- Click anywhere in the Form/Workflow Actions section in the Properties Navigator. This takes you directly to the Form/Workflow Actions tab.
- Click the Image Modified inside the Form/Workflow Actions section in the Properties Navigator. This takes you directly to the Form/Workflow Actions tab.
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. Hover over any field in the wizards for a helpful hint. You can only configure one Form action for a form/workflow. This is as designed. |
|
The Form Actions available on the Success tab are: Display Message when User Submits Form Forward Users to a web page of your choice Post Data and forward users to your web page Forward to Paypal to complete payment
Image Modified After the user submits the form/workflow, 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. Image Modified Another useful message is to display a link back to the form. For example the display message: Image Modified The display message would be written as follows. The URL back to the form is the share dialog Raw Form link. Code Block |
---|
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/workflow URL in the above HTML example can be constructed dynamically in a business rule. See this rule example. Note |
---|
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 Users to a web page of your choiceAfter the user submits the form/workflow, 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 project can have a Form Action Base URL which you set in the project properties. For example, you can have http://myhost.com/ in the project baseURL and simply “thankyou.html” in the Form Action URL field. You can use a form/workflow 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. Image Modified Note |
---|
Forwarding users to a web page that is located in a different domain will not work. |
Post Data and forward users to your web pageAfter 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:
- 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 Data checkbox. This checkbox is checked by default. Uncheck it to exclude the XML data document in the submission.
- Attachments uploaded to your form/workflow are included if the Attachments 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/workflows, choose the action you want to take from the Send Generated PDF Forms control: • Check All to send all the mapped PDFs. This is the default value. • Check None to send none of the mapped PDFs • Check Select to display a list of all the mapped PDFs associated with your form/workflow. Click the ones you want to be part of the submission. Click again to deselect. - POST responses must be displayed in the frevvo form frame.
Image Modified
Note |
---|
Forwarding users to a web page that is located in a different domain will not work. |
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... Image Modified 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: Code Block |
---|
&amount={amount} |
PayPal Sandbox: https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_xclick&business= business name>&amount=<Payment amount>&item_name=<Payment Description>¤cy_code=<Currency Code>&return=<Return URL>&cancel_return=<Cancel URL>&custom=<Custom Value>&invoice=<Invoice Value>¬ify_url=<Notification Url> Production: https://www.paypal.com/webscr/webscr?cmd=_xclick&business= business name>&amount=<Payment amount>&item_name=<Payment Description>¤cy_code=<Currency Code>&return=<Return URL>&cancel_return=<Cancel URL>&custom=<Custom Value>&invoice=<Invoice Value>¬ify_url=<Notification URL> 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 ChoiceOpen the workflow properties, and select the Workflow Actions tab. Click the Forward Users to a webpage of your choice radio button. Add the URL (configured like this example) to the URL field. Example: https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_xclick&business=mycompany@gmail.com&amount=2&item_name={BMyDesc}¤cy_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¬ify_url= Note |
---|
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. |
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}¤cy_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¬ify_url These wizards optionally allow you to customize what the user sees if an error occurs. You can either display a message or forward users to a web page of your choice. The wizards behave exactly like the corresponding Form Action wizards above. The Display message can be customized to display the actual error that occurred by adding the special {_frevvo_root_cause_msg} template to your message text. This is helpful for debugging, especially if your are using Online. Image Modified Forward users to an error page of your choiceImage Modified The document action wizards configure what happens to the entered data when a user submits your form/workflow. You can access the Document Actions tab in three ways: - Click the Image Modified Edit Form/Workflow Properties icon on the Forms/Workflow Designer toolbar. This will launch the Forms/Workflows Properties wizard. Click the Document Actions tab.
- Click anywhere in the Document Actions section in the Properties Navigator. This takes you directly to the Document Actions tab.
- Click the Image Modified inside the Form/Workflow Actions section in the Properties Navigator. This takes you directly to the Document Actions tab.
The wizards help guide you through the configuration process. Many of the wizards allow you to use form controls as templates for dynamic behavior. See the section on using templates in form/doc/error actions for full details. Hover over any field in the wizards for a helpful hint. See Doc URI Wizards below for details on using the wizards to configure doc URI settings. Please also refer to the processing submissions tutorial. This wizard has three tabs as shown in the screen image below: - Doc Actions
- Additional Email
- Doc URIs
Image Modified Using these wizards you can: - Do nothing with the data
- Email the data to an email address
- Post the form data to your web application
- Save the data to PaperVision®/ImageSilo®
- Save the data to a Google Document.
- Save the submissions to a local or remote filesystem using the Filesystem connector.
- Save submissions to a SharePoint site.
The wizards help guide you through connecting your forms/workflows to various destinations. Many of the wizards allow you to use form controls as templates to dynamically configuring wizard parameters. For example you can dynamically set the email address to send the data to instead of hard coding an email address. See the section on using templates in doc action/doc URI wizards for full details. Info |
---|
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/workflow 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
|
This is the default option, which simply stores the data in ' submissions repository. (The other options also store the data in the repository but provide additional functionality.) Do nothing is typically selected when you plan to do one or more of the following: Note |
---|
The form's save property controls whether or not your form submission data is also stored in ' submission repository |
When the form/workflow is submitted, will send an email message with the following selectable options attached. These include submission data, an XML document, an image of the filled form/workflow, attachments uploaded to the form/workflow and any, all or none of the Generated Forms (mapped PDFs) associated with your form/workflow. Image Modified Fill in the Send Email wizard with the following information: See Email Integration for further details. POST data to your web applicationWhen the form is submitted, POSTs the document set to the specified URI and ignores any returned XHTML or redirect. This option may be used for additional processing of data. Use form action post if you want to both submit data to your URI and forward to a web page or display returned XHTML. Image Modified Fill in the Post Data to your web 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 project can have a Form Action Base URL which you set in the project properties. For example, you can have http://myhost.com/services/ in the project 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 choices are PDF, PNG and JPG. Select the blank option from the dropdown to exclude this attachment in the submission.
- Attach an XML data document using the Data checkbox. This checkbox is checked by default. Uncheck it to exclude the XML data document in the submission.
- Attachments uploaded to your form/workflow are included if the Attachment 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/workflows, choose the action you want to take from the Send Generated PDF Forms control : •Check All to send all the mapped PDFs. This is the default value. •Check None to send none of the mapped PDFs •Check Select to display a list of all the mapped PDFs associated with your form/workflow. Click the ones you want to be part of the submission. Click again to deselect.
Info |
---|
If a form is configured to Post Data to a web application and it does not reach it's intended destination successfully, notifies the tenant admin of the failure via an email. If there are users given the workflow admin permission for the workflow, they will receive the email instead of the tenant admin. Image Modified |
integrates directly with Digitech Systems' PaperVision® and ImageSilo® document management products. This Wizard enables an easy way for you to save form/workflow submissions to your PaperVision® and ImageSilo® document management repository as PDF, PNG and .JPG format. The wizards walks you through simple steps to login to your PaperVision®/ImageSilo® account and select the items you want to include in the submission: Insert excerpt |
---|
| PaperVision or ImageSilo Connector |
---|
| PaperVision or ImageSilo Connector |
---|
nopanel | true |
---|
|
When a users fills and submits your form the selected items will automatically be stored into the selected PaperVision®/ImageSilo® project. The document's index fields will be set to the values the user entered into the form. The pve connector by default does not send handwritten signature images to ImageSilo. This can be overridden by setting frevvo.send.signature.xml parameter to true in web.xml in the pve.war. Info |
---|
If a form/workflow submission does not reach PaperVision®/ImageSilo® successfully, notifies the tenant admin of the failure via an email. If workflow administrator(s) are configured the workflow admin(s) will receive the email instead of the tenant admin. Image Modified |
See ImageSilo® integration for full details. Insert excerpt |
---|
| Save your documents to Google Drive |
---|
| Save your documents to Google Drive |
---|
nopanel | true |
---|
|
Warning |
---|
- Do not use spaces or special characters when creating submission folder names.
- If you want to save a pdf of your form/workflow to the Google folder, make sure you have Save PDF checked. An optional field that is used to name the pdfs displays. You can use templates in this field. For example, if you have a control called EmployeeName in your form, you can type {EmployeeName} into the PDF Name field and the pdf's in the Google folder will be named {EmployeeName}.pdf
|
Info |
---|
- If a form/workflow does not reach the specified folder in your Google drive successfully, notifies the tenant admin of the failure via an email. If workflow administrator(s) are configured, the workflow admin(s) receive the email instead of the tenant admin.
Image Modified
|
See Google Connector for full details. Also refer to the /wiki/spaces/frevvo91/pages/901491169 for step by step instructions. The Save to Filesystem wizard is used to connect forms/workflows to the frevvo Filesystem Connector. The connector saves submissions in a specified location and can be configured to create metadata files for importing your submissions into a document Management system. Insert excerpt |
---|
| Filesystem Connector |
---|
| Filesystem Connector |
---|
nopanel | true |
---|
|
Refer to the Filesystem Connector chapter for the installation and configuration details plus information about using the Save to File System wizard and generating metadata. Connecting your forms/workflows to your SharePoint site is easy with the Save to SharePoint wizard. Your tenant must be configured for SharePoint in order for this wizard to display. Insert excerpt |
---|
| SharePoint Connector |
---|
| SharePoint Connector |
---|
nopanel | true |
---|
|
Refer to the SharePoint Connector chapter for configuration details and more information on the Send to SharePoint wizard. Using these wizards you can: - Do Nothing
- Post submissions to a Google Spreadsheet
- Manually set document URIs - to connect to database and other back end systems
The Send Data wizards enable you to manually set a URI to which the data will be sent when your form is submitted. Image Modified This is the default option. If one of the other 2 options is set you can clear them by clicking this one. Post Submissions to a Google Sheet supports direct connectivity with Google Spreadsheets. This wizard allows you to save submissions directly into Google Spreadsheets. It also provides additional assistance in setting up the login to your Google account and in selecting the spreadsheet. After the user submits the form, the data will be written into a new row in the Google spreadsheet. This wizards steps you through the process of logging into your google account and locating the spreadsheet you where you want to save the submissions. Insert excerpt |
---|
| Save your Submissions to a Google Sheet |
---|
| Save your Submissions to a Google Sheet |
---|
nopanel | true |
---|
|
See the Save your Submissions to a Google Sheet for details. Here is an example Google spreadsheet that is updated with a new row each time the form is submitted. Image Modified Insert excerpt |
---|
| Creating a Form Connected to your Database |
---|
| Creating a Form Connected to your Database |
---|
nopanel | true |
---|
|
Info |
---|
If a form is configured to post data using a manually set document URI and it does not reach it's intended destination successfully, notifies the tenant admin of the failure via an email. If a workflow does not reach the web application successfully, the workflow administrator(s) - if configured - receive the email instead of the tenant admin. Image Modified |
See the chapter on connecting to your database for all the details. When the form is submitted, can send an additional email message with optional XML document(s) , an image of the filled form, attachments and Pixel Perfect PDFs (referred to as Generated Forms), Slide the Image Modifiedtoggle to the right to turn on the Additional Email wizard. The email can be sent to multiple comma separated email addresses. The "To:" email address is required. All other properties are optional. Enter destination email addresses in the To: Reply to: Cc;, Bcc: fields. The email can be sent to multiple addresses separated by a comma or a semicolon. The "To:" email address is required. All other email fields are optional. Tip |
---|
The tenant admin can configure the from email address on the tenant admin's Edit Tenant page. If you want an email to show a different From:address than what is configured on the Edit Tenant page, enter that address in the From: field. You can enter a static address or use templates to make the the address dynamic. The From address replaces the default no-reply@… , an address configured on the Edit Tenant screen or any settings in web.xml or frevvo.xml config files for In-house customers. You can even use the standard internet address convention, for example: From: frevvo Client Services <services@frevvo.com>, so that your emails appear in people's inboxes looking like this: Image Modified |
- Customize the email body and Subject text in the Message field. You can use HTML and templates.
- 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 Data checkbox. This checkbox is checked by default. Uncheck it to exclude the XML data document in the email.
- Files uploaded to your form/workflow are included if the Attachments 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/workflows, choose the action you want to take from the Send Gen PDF 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/workflow. Click the ones you want to be part of the submission.
Image Modified For example, consider a Vacation Request Approval workflow. When the workflow is complete, we want to send a PDF to the internal HR system (using the document action) but in addition, we want to notify the employee requesting the vacation by email. Use the Additional Email wizard for this scenario. The email to the employee will contain whatever documents are selected on the Additional Email wizard screen. To use the wizard, click the Doc Actions section in the left toolbar and select the Additional Email Tab. See Email Integration for further details on configuring the content of the email. It is important to remember that doc action wizards are single select by design. The Additional Email wizard can be used to send an email if you are configuring more than one doc action on a form/workflow.
Let's say you have a workflow where you want to - Save a copy of the form to Google Drive
- Email a copy of workflow pdf to the IT department
Set up the Save to Google wizard. Then use the Additional Email tab to configure the email to the IT department. The values/entries in all doc action/doc URI wizards can be customized with data entered in the form/workflow using templates. The values set in the following Form Action wizards can be customized with data from the form: - Display a message
- Forward users to a web page
- Post data and forward users to a web page
For instance, in the display message, you may wish to display a customized message with the user's name. You can use templates in the display message to do this. - Make sure you have two controls in the form called FirstName and LastName.
- Click on Form Action
- Click on Display a Message.
- In the Message area of the wizard, type: Thank You {FirstName} {LastName} for submitting my form.
- As a shortcut, you can also select the appropriate control from the drop down by clicking the Image Modified down arrow on the right side of the field.
- Click Finish.
Use the form by clicking on the Test button. Enter something into the First Name and Last Name controls. When you click submit, will display the above message with {FirstName} and {LastName} replaced by the values entered by you. Templates work the same way when used in URLs for forwarding to a web page or Post data. When referring to repeat controls you must use a special template syntax. See templates for repeat control for details. There are built-in templates you can use: - {_frevvo_root_cause_msg} - Add this to the Error Action Display Message to display the actual error that occurred.
Templates work the same way as documented above when used in Doc and Error Action Wizards. |