<!-- 
        frevvo war settings 
-->    
    <Parameter name="frevvo.mail.from.email" value="" override="false"/>
    <Parameter name="frevvo.mail.bounce.email" value="" override="false"/>
    <Parameter name="frevvo.mail.debug" value="false" override="false"/>
    <Parameter name="frevvo.actions.debug" value="true" override="false"/>
    <Parameter name="frevvo.rule.debug" value="true" override="false"/> 

Common Customizations

For the most common configuration customization tasks that every customer and OEM partner will want to consider see Installation Tasks. Also see the web.xml and frevvo.xml files for all of the context parameters that can be changed in . 

API

The  Data API enables programmatic access to the all resources and data stored in the  server. The API provides a simple protocol for viewing and managing resources such as forms, applications, schemas, etc. OEM partners as well as end user customers can use the API to extend the features and provide tighter integration with other applications.

You will need to install a client library in order to use the API.

Branding

VAR and OEM partners can brand Live Forms with their own company images and look. This is accomplished via  web application parameters.

Set Branding Parameters

The frevvo.war file contains a web.xml with branding parameters. In the frevvo-tomcat bundle, frevvo.war is located in: <frevvo-home>\tomcat\webapps - when the war file is unzipped to a temporary directory, the web.xml file will be found in <tmp>\WEB-INF.  Refer to Installation Tasks for the steps to repackage frevvo.war after parameters in web.xml have been edited.

Modifying the frevvo.xml file

Follow these steps to add/modify context parameters in the frevvo.xml file. If you are using tomcat, making your configuration changes here, will make it easier when you upgrade :

1. Stop if it is running.
2. Navigate to <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml.
3. Open the file with a text editor.
4. The installation tasks listed below will reference the frevvo.xml and web.xml files when appropriate. You can configure anything in frevvo.xml that you can configure in web.xml. When you add parameters to the file, use the same syntax as the ones already there. Here is an example of a parameter to control the Maximum Size of Attachments that users can upload.

<Parameter name="frevvo.attachment.maxsize" value="10485760" override="false"/> 

      5. Save the file after all your changes are made. Restart .

Modifying the web.xml file

The web.xml file is included in the <frevvo-home>\tomcat\webapps\frevvo.war. The frevvo.war must be unzipped/rezipped after modifications have been made as outlined in the steps below:

1. Stop  if it is running. 
2. Unpack the frevvo.war file to a temporary location of your choice: e.g. c:\tmp\frevvo-war. Change the file extension from .war to .zip if necessary.
3. Edit c:\tmp\frevvo-war\WEB-INF\web.xml.
4. Make the desired configuration changes - see appropriate sections of this page for information on specific parameters. Save the changes to the web.xml file. 

5. Rezip all the files in the c:\tmp\frevvo-war directory, even the ones you did not edit — if you change directories or zip them differently, Live Forms may not load correctly:

   This is the correct structure for the frevvo.war zipfile.

   
   
   

6. Make sure you create the zipfile with the directory structure as shown in the image above. It is an easy mistake to include the containing directory in the zipfile. If you do this, Live Forms may not load correctly. Zip will often give your zipfile a .zip extension. Make sure you change this to a .war extension. 

7. Copy the updated frevvo.war file to <frevvo-home>tomcat\webapps.
8. Restart your  server.

Consider the frevvo.menu.bar parameter,  if added to the web.xml file, prevents the menu bar from being rendered.  Any of the menu items (Downloads,Templates, Help, Docs, Forum, Contact) can be removed from the menu bar via configuration parameters in the web.xml or frevvo.xml files.  If all of the menu items are disabled, the menu bar should be removed.  

<context-param>
        <param-name>frevvo.menu.bar</param-name>
        <param-value>false</param-value>
        <description>Show menu bar. Set to false if all menu items are disabled</description>
</context-param>

The parameter in the frevvo.xml file would be:

<Parameter "frevvo.menu.bar" value="false" override="false"/>

Set branding parameters at container level

If you choose to brand at your web container level, note the web configuration changes at the container level take precedence over (override) those in the frevvo.war web.xml file. Again using Tomcat as an example:

• Open the file: <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml.
• Create a parameter with the same name as you see in frevvo.war's web.xml file. For instance, for the logo image:
  
  

<Parameter name="frevvo.logo.url" value="<url to your image>" override="false"/>

The override="false" prevents the values in the configuration parameters in frevvo.xml from being overridden.

These are the brandable parameters and their defaults:

Branding External Urls 

Notice that several of the parameters use Url templates. For example, frevvo.help.url references a help file named designer.xsl that is part of frevvo.war and is located in the directory <frevvo-home>\WEB-INF\xsl\main\help after the war file has been unzipped . You may wish to bundle up a replacement help file and store your replacement file in that same directory. In that case you will keep the templates ${context.path}${servlet.path}/static that are part of the default path and append your own help file name. It can be an html file, myAppHelp.html. Or if your help is an external file you can replace the entire default value ${context.path}${servlet.path}/static/help/designer with a Url such has http://mycompany/myapp/help.html. Refer to Installation Tasks for the steps to repackage frevvo.war after parameters in designer.xsl have been editied.

Hiding Url Menu Items 

The frevvo.war file contains a web.xml with branding parameters. In the frevvo-tomcat bundle frevvo.war is located in: <frevvo-home>\frevvo\tomcat\webapps - when the war file is unzipped, the web.xml file will be found in <frevvo-home>\WEB-INF.  Refer to Installation Tasks for the steps to repackage frevvo.war after parameters in web.xml have been editied. Certain menu items are links to external Urls. Examples are Downloads, Forum, Docs etc. It is possible to completely remove any of these menu items by deleting the URL or setting the appropriate property. If no URL exists the menu item will be hidden.These parameters are found in the web.xml file. 

For example, if you want to hide the Downloads menu item:

<context-param>
        <param-name>frevvo.downloads.menu</param-name>
        <param-value>false</param-value>
        <description>No Downloads menu</description>
</context-param>

For example if you wish to hide the Docs menu item, edit the frevvo.docs.url and delete the content:

<context-param>
        <param-name>frevvo.docs.url</param-name>
        <param-value></param-value>
        <description>No URL set will hide the Docs menu and top link</description>
</context-param>

These parameters in the frevvo.xml file would be :

<Parameter name="frevvo.downloads.menu" value="false" override="false"/>
<Parameter name="frevvo.docs.url" value="" override="false"/>

The look & feel of the Live Forms application is controlled via css. frevvo.css.url gives you the ability to add your own style sheet if you need to customize the look & feel of the page itself such as the background colors and sizes of the items on the pages. You can use a tool such as firebug to learn how the page is styled with css and thus how to override the default styling. 

Forms

The Powered by frevvo™ logo can be customized via the frevvo.poweredby.markup branding parameter. If this branding parameter is an empty string no logo will appear on any form. The logo can still be turned off on any given form via the Show Logo form property.

Hiding Form/Doc Action Wizards

The Live Forms designer form and doc action  buttons can be customized via the web.xml configuration file. Web.xml  is contained in the <frevvo-home>\tomcat\webapps frevvo.war. It is located in <frevvo-home>\WEB-INF\web.xml after the frevvo.war is unzipped to a temporary directory. Refer to Installation Tasks for the steps to unzip and repackage frevvo.war after parameters in web.xml have been edited. By default all wizards are visible in the form & doc action buttons page. To hide a wizard, remove it from the associated context parameter below.

<!-- Wizards -->
<context-param>
        <param-name>frevvo.formaction.wizards</param-name>
        <param-value>closePage,displayMessage,goToPage,goToPaypal,formPost,echoUsingGoogleDocument,createConfluencePage,mergeToConfluencePage</param-value>
        <description>Which form action wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.erroraction.wizards</param-name>
        <param-value>displayErrorMessage,goToErrorPage</param-value>
        <description>Which error action wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.docaction.wizards</param-name>
        <param-value>doNothing,emailDocumentDefault,docPost,emailDocumentGoogle,saveToPaperVision,saveToGoogleDocuments</param-value>
        <description>Which doc action wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.docuri.wizards</param-name>
        <param-value>unsetDocUris,saveToGoogleSpreadsheets,manualDocUris</param-value>
        <description>Which doc uri wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.flows.formaction.wizards</param-name>
        <param-value>closePage,displayMessage,goToPage,formPost,createConfluencePage,mergeToConfluencePage</param-value>
        <description>Which form action wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.flows.erroraction.wizards</param-name>
        <param-value>displayErrorMessage,goToErrorPage</param-value>
        <description>Which error action wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.flows.docaction.wizards</param-name>
        <param-value>doNothing,emailDocumentDefault,docPost,saveToPaperVision,saveToGoogleDocuments</param-value>
        <description>Which doc action wizards are displayed</description>
</context-param>
<context-param>
        <param-name>frevvo.flows.docuri.wizards</param-name>
        <param-value>unsetDocUris,manualDocUris</param-value>
        <description>Which doc uri wizards are displayed</description>
</context-param>

Hiding Data Sources/Palette

Hiding Data Sources on the designer screen can be accomplished by adding the ?_method=post&edit=true and &showDS=false parameter to the edit link of a form.  Create the URL using the steps below:

Then copy and paste it in another tab of the browser. You have to add it to the Edit link, you cannot click Edit first and then add this parameter to the link that appears in your browser.

1. Click the Share icon  of a form on the Forms Home page and copy the "Raw Url" of the form into another tab of your broswer.
2. Add the "?_method=post&edit=true" parameter to the end of the link.
3. Add the "&showDS=false" parameter to hide Data Sources or "&showPalette=false" to hide the control palette.
4. When the form displays, either the Data Source section or the palette will be hidden.

Here are examples of the URl:

test.wlselb.frevvo.com/frevvo/web/tn/nancy.com//u/a700f434-969e-432a-9779-655f9fc30259/app/_EVHJUIP-EeG1bcc-I8Sq_w/formtype/_cm3dAIP-EeG1bcc-I8Sq_w?_method=post&edit=true&showDS=false

test.wlselb.frevvo.com/frevvo/web/tn/nancy.com//u/a700f434-969e-432a-9779-655f9fc30259/app/_EVHJUIP-EeG1bcc-I8Sq_w/formtype/_cm3dAIP-EeG1bcc-I8Sq_w?_method=post&edit=true&showPalette=false

Customizing the HTML Page Title Prefix

You can use the frevvo.page.title context parameter in the frevvo.xml file to  change the HTML prefixes of the titles of all Live Form pages. The Preview Page in the designer will display with value of the the frevvo.page. title  parameter  - <browser name>.  For example, to change the HTML page prefix to a company name, follow the steps below:

1. Ensure that  is not running.
2. Navigate to <frevvo-home>\tomcat\conf\catalina\localhost. Open the frevvo.xml with a text editor.
3. Add the information below to the frevvo war setting section of the file

<Parameter name="frevvo.page.title" value="Company Name" override="false"/>

      4. Save the file and restart .

Adding a Custom Button to the Designer Tool Bar

Adding a custom button to the  tool bar can be accomplished with the frevvo.form.edit.toolbar.buttons context parameter in the web.xml file. The value of the parameter is a JSON string that determines which buttons are visible in the toolbar. This context parameter is not optional - if it is not present there will be no buttons in the designer toolbar. 

Here is an example of how to edit the web.xml file to add the configuration parameter to add a custom Test Form button to the toolbar. The comment shows example JSON to add a new button. You can specify an id, a class and a title.  Be sure to rezip the frevvo.war file, as described above, when the changes are complete. 

<context-param>
		<param-name>frevvo.form.edit.toolbar.buttons</param-name>
		<param-value>{"buttons":[{"id":"e-preview-form"},{"id":"e-edit-form"},{"id":"e-rules-form"},{"id":"e-formactions-form"},{"id":"e-docactions-form"},{"id":"cancel-top"},{"id":"commit-top"}]}</param-value>
		<!--
		Example JSON to add a new toolbar button.
		<param-value>{"id":"e-test-form","class":"e-test-form e-toolbar-icon","title":"click to test the form"}</param-value>
		-->
		<description>Which edit mode toolbar buttons are rendered in the form designer</description>
</context-param>

This will generate something like this:

<a id="{id}" title="{title}" class="{class}" href="#" onclick="return CustomWizard.show('{id}');"></a>

CustomWizard.show(id) calls your code. Make sure it is defined. The FrevvoCustomActions, as shown below, is an example:

var CustomWizard = {
	show: function (id) {
		if (parent.FrevvoCustomActions)
			parent.FrevvoCustomActions.doAction (id);
		else if (FrevvoCustomActions)
			FrevvoCustomActions.doAction (id);
	}
}

Customizing Runtime Messages and Labels in the Form Designer

You can modify the text of runtime messages and customize the labels in the Form/flow designers by changing string name/value pairs in the 'default' file found in the frevvo.war. You can customize the Form designer and most labels (but not all) in the flow designer.

The English version of the modified strings appear on the UI once is restarted.

For example, you would like to:

• Change the text of the "Access denied. Authentication reguired" message that the user sees when accessing a form that requires logging into (Public in tenant).
• Customize the labels of the Palette, Custom, Properties and Data Sources sections of the Forms designer.

The default file in the frevvo.war contains all of the runtime and designer strings that can be customized. Both requirements listed above can be accomplished by modifying this file.

Follow these steps:

1. Stop  if it is running.
2. Navigate to <frevvo-home>\tomcat\webapps directory.
3. Copy the fevvo.war file to a temporary location of your choice: e.g. c:\tmp\frevvo-war. Change the file extension from .war to .zip if necessary.
4. Edit c:\tmp\frevvo-war\WEB-INF\locales\default.

5. To change the text of the "Access denied. Authentication required" message locate the Error messages section in the file. Notice that the strings on the left side of the '=' have spaces escaped with the '\' character. This is needed so do not remove that. The escape character is not needed on the right side of the '='. Enter the text that you want on the right side of the '='

   # Error messages
   Access\ Denied.\ Authentication\ required.= Please Sign into Live Forms

6. To change the labels in the Forms designer, locate the Form Designer toolbox section of the file. Enter the labels that you want to display to the right of the '='

   # Form Designer Toolbox
   Palette=My Palette
   Custom=My Custom Controls
   Properties=Control Properties    
   Data\ Sources=Schemas
   Drag\ and\ drop\ controls\ from\ the\ form\ into\ the\ header\ above.\ You\ can\ then\ re-use\ them\ in\ other\ forms.=
   Drop\ Submit\ buttons\ from\ the\ palette\ to\ add\ to\ the\ form.=
   Drop\ controls\ from\ the\ palette\ to\ add\ to\ the\ form.=
   Drag\ and\ drop\ controls\ from\ the\ palette\ into\ the\ form.=
   Drag\ and\ drop\ controls\ from\ the\ palette\ or\ from\ the\ form.=

7. Save the changes to the default file. 

8. Rezip all the files in the c:\tmp\frevvo-war directory, even the ones you did not edit — if you change directories or zip them differently, Live Forms may not load correctly:

   This is the correct structure for the frevvo.war zipfile.

   
   
   

9. Make sure you create the zipfile with the directory structure as shown in the image above. It is an easy mistake to include the containing directory in the zipfile. If you do this, Live Forms may not load correctly. Zip will often give your zipfile a .zip extension. Make sure you change this to a .war extension. 

10. Copy the updated frevvo.war file to <frevvo-home>tomcat\webapps.

11. Restart your  server.

12. 
    
    Customized "Access denied. Authentication required" message

    

    Customized Labels in the Forms Designer

frevvo.certificate.signature context parameter

When a form's doc action is configured to post to an https endpoint, you can ignore ssl security using the frevvo web.xml parameter frevvo.certificate.signature. Services that accepts https and do not have a security certificate setup might generate an error like this:

INFO: 11:09:51,062 INFO DocumentSetUtil:539 - notifyDocumentSet_POST: POSTing document set to https://fortisapp1.som.w2k.state.me.us/FormItConnector/save.aspx 11:09:51,062 ERROR DocumentSetUtil:615 - Could not POST document set to URI: https://fortisapp1.som.w2k.state.me.us/FormItConnector/save.aspx javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

 You can tell frevvo to ignore this error using the frevvo.certificate.signature context parameter . This should work with services that have self-signed certificates that aren't installed in jvm certificate file and with certificates from a security authority. Add this context parameter to the  web.xml file included in the frevvo.war zipfile. See Modifying the web.xml file for the instructions to unzip and rezip the war after modifications to the web.xml are completed or add the parameter to frevvo.xml.

<context-param>
  <param-name>frevvo.certificate.signature</param-name>
  <param-value></param-value>
  <description>Set to true to accept self-signed certificates</description>
 </context-param>

This parameter in frevvo.xml should be:

<Parameter name="frevvo.certificate.signature" value="true" override="false"/>

Check Database Encoding

The parameters, frevvo.db.check.encoding and frevvo.db.encoding.error, have been added to the web.xml file included in the <frevvo-home>\tomcat\webapps\frevvo.war. These parameters can be used to specify how to handle a check of database encoding and how to display the error if it is not UTF8. They are particularly useful for OEMs who may want to skip the fatal error by setting the frevvo.db.check.encoding parameter to false.

You can set up these parameters to accomplish the following: By default live forms does the check and will fail if not set correctly. 

1. Perform the utf8 check with a fatal error.

2. Disable the UTF db encoding check completely.

3. Perform the check but not fail and simply log the warning in the <frevvo-home>\.tomcat\logs\frevvo.log file.

 Here is how it works:

• An error will not be displayed if either of the parameters are false. The license page is displayed.
• Both parameters must be set to true for the error message "Users database schema, Database char set incorrectly configured. It must be utf8, but is instead: XXXXX"  to display:  

Follow these steps to set the parameters:

1. Unzip the frevvo.war as explained here. Rezip it after the modifications are made.
2. The parameters are located in the Database Schema checking on startup section: 
   
   

 <!-- Database Schema checking on startup -->
    <context-param>
        <param-name>frevvo.db.check.encoding</param-name>
        <param-value>true</param-value>
        <description>Check the database encoding on startup</description>
    </context-param>
    <context-param>
        <param-name>frevvo.db.encoding.error</param-name>
        <param-value>true</param-value>
        <description>If encoding is checked and is wrong, then it is a fatal error, otherwise only a warning is logged</description>
    </context-param> 

These parameters in the frevvo.xml file would be:

<Parameter name "frevvo.db.check.encoding" value="true" override="false"/>
<Parameter name "frevvo.db.encoding.error" value="true" override="false"/>

Branding CSS

OEM partners can use the context parameter, frevvo.oem.branding.class to name a css class that will be placed onto the body of the  UI pages (form designer, etc.). Follow the steps below to do this:

1. Stop , if it is running.
2. Unzip <frevvo-home>\tomcat\webapps\frevvo.war file to a temporary directory. You may have to change the file extension from .war to .zip to unzip it. See Installation Tasks for instructions.
3. Edit \your temporary directory\WEB-INF\web.xml to set  the context parameter, frevvo.oem.branding.class to oem. 
4. Edit \your temporary directory\css-XXXXX\themes\oem\oem-branding.class file to make your changes. The XXXXX in the directory path represents the Revision Number of . For example, the oem-branding.css file will be located in \your temporary directory\css-19498\themes\oem for a revision number of  5.0.1.19498.
5. Recreate the oem-branding.css file to include the modified oem-branding.css file.
6. Repackage frevvo.war. Refer to Installation Tasks for instructions.
7. Copy the modified frevvo.war file to the <frevvo-home>\tomcat\webapps directory.
8. Start .
9. Clear the cache before restarting your browser to see the changes.

<context-param>
 <param-name>frevvo.oem.branding.class</param-name>
 <param-value>oem</param-value>
 <description>This css class will be placed onto the body of the frevvo ui pages. OEMs can then edit the included oem-branding.css file with rules based on the body having the oem branding class in order to customize the frevvo app.</description> 
</context-param>

3rd Party Licenses

builds upon several 3rd party products. The frevvo.war file contains a WEB-IN\licenses with all the 3rd party licenses.