Live Forms v5.1 is no longer supported. Click here for information about upgrading to our latest GA Release.

Skip to end of metadata
Go to start of metadata

 

Live Forms™ v5

The Live Forms product installation can be customized in many ways. For example OEM partners can brand Live Forms with their own company images and look.

Live Forms properties make it easy to implement many of the common customizations that all customer and OEM partners will want to consider.

Live Forms Data API provides a programmatic protocol for viewing and managing resources such as tenants, users, applications, forms, themes, schemas, etc.

Customization properties can be changed in the Live Forms web.xml or the frevvo.xml files. Any parameter in web.xml can be duplicated in frevvo.xml and the value in frevvo.xml takes precedence over the value in web.xml. We suggest making changes to the context parameter values in the frevvo.xml if you are using the tomcat bundle. This keeps all your modified parameters in one place and makes it easy to upgrade Live Forms to newer releases. See Installation Tasks for more information.

<!-- 
        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"/> 

On This Page:

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 Live Forms.

API

The Live Forms Data API enables programmatic access to the all resources and data stored in the Live Forms server. The API provides a simple protocol for viewing and managing resources such as forms, applications, themes, schemas, etc. OEM partners as well as end user customers can use the API to extend the features and provide tigher 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 Live Forms 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 editied.

For example, the parameter, frevvo.menu.bar,  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>

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"/>

These are the brandable parameters and their defaults:

ParameterDescription Default
frevvo.home.urlHome page for the Company Logo link ${context.path}
frevvo.logo.urlURL to the Company Logo image. Also applies to Spaces${context.path}/images/bright/TransparentLogo-NoBeta.png
frevvo.help.urlURL to the Help page${context.path}${servlet.path}/static/help/designer
frevvo.docs.urlURL to the Documentationhttp://docs.frevvo.com/d/display/frevvo/frevvo+v5+Documentation+Home
frevvo.forum.urlURL to the Forumhttp://forum.frevvo.com/forum/
frevvo.blog.urlURL to the bloghttp://blog.frevvo.com
frevvo.product.nameThe Product NameLive Forms
frevvo.copyrightProduct Copyright One-LinerCopyright 2006-2012 frevvo Inc. All rights reserved.
frevvo.license.urlURL to License Agreement${context.path}${servlet.path}/static/termsDL
frevvo.contact.emailContact Us email addressmailto:info@frevvo.com
frevvo.downloads.menuShow Downloads menu itemtrue
frevvo.gallery.menuShow Gallery (Examples) menu itemtrue
frevvo.templates.menuShow Templates menu item true
frevvo.css.urlCustom Stylesheet URL 
frevvo.poweredby.markupLogo in form footer when the Logo property setPowered by Live Forms™
frevvo.page.titleHTML title prefix for all Live Form pagesfrevvo
frevvo.menu.barShow menu bartrue
frevvo.oem.branding.classNames css class applied to body of UI pagesempty
frevvo.certificate.signature Ignore SSL Security when posting to an https endpointempty

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 paramters 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>

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 Palette Controls

The Live Forms designer can be customized by applying a custom theme. See the chapter on Customizing Themes for general information. 

For example, you can hide palette controls that you might not want your customers to use by adding the following css to form-edit.css. This can also be accomplished by editing configuration parameters in the web.xml or frevvo.xml files. See Configuring Palette Controls in the Designer for instructions.

/* Hide specific palette controls */
#palette .f-palette-list.Upload,
#palette .f-palette-list.Video{
display: none; 
}

Here are several other examples that hide various designer features:

/* Hide Data Source Section */
#documentTypes {
display: none !important; 
}
/* Hide Submit/Reset buttons */
.s-edit .f-submit.s-submit, .s-edit .f-submit.s-cancel {
display: none; 
}
/* Hide Rules Button*/
#e-edit-form, #e-rules-form {
/*display: none !important;*/
}

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>

Any parameter in web.xml can be duplicated in frevvo.xml and the value in frevvo.xml takes precedence over the value in web.xml. If you plan to override the web.xml context parameter values and you are using the frevvo Tomcat bundle, we suggest doing so in frevvo.xml. This keeps all your modified parameters in one place and makes it easy to upgrade frevvo to newer releases.

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/user/designer/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/user/designer/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 Live Forms 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 Live Forms.

Adding a Custom Button to the Designer Tool Bar

Adding a custom button to the Live Forms 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);
	}
}

 

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 param 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. This parameter does not work with certificates from a security authority. Add this context parameter to the Live Forms web.xml file included in the frevvo.war zipfile. See Installation Tasks for the instructions to unzip and rezip the war after modifications to the web.xml are completed.

<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>

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 Live Forms UI pages (form designer, etc.). Follow the steps below to do this:

  1. Stop Live Forms, 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 Live Forms. 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 Live Forms.
  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>

It is recommended that you modify the default oem-branding.css file to make the desired changes to the Live Forms application. Any aspect of this file can be changed.

3rd Party Licenses

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

 

 

  • No labels