™ v5
- supports a 100% embeddable forms designer/server for seamless integration with your application.
- provides a client API which supports a simple programmatic protocol for viewing and managing resources such as forms, applications, themes, schemas, etc.
On This Page:
Live Forms API
The Live Forms API adds programmatic access to Live Forms for OEM customers. The API provides a simple protocol for viewing and managing Live Forms resources such as forms, applications, themes, schemas, etc.
You will need to install a client library in order to use the API. Please contact us for assistance.
Branding
OEM Partners can brand the product for customers by modifying web application configuration parameters in the<frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file or in the web.xml file. If you decide to make the changes to the Live Forms web.xml file - it is now packaged as part of the <frevvo-home>\tomcat\webapps\frevvo.war.file To edit the web.xml file, the frevvo,war file must be unzipped to a temporary directory, the changes made, and then the files must be rezipped into an updated frevvo.war. Refer to Installation Tasks for the details. Examples of other configuration parameters that might need to be modified when branding can be found on that page as well.
Individual configuration parameters can be modified or customization can be accomplished using the oem branding class parameter. See , Customizing using the OEM branding class parameter below for information.
Web Application
VAR and OEM customers can now easily brand Live Forms with their own company images and look. This is accomplished via Live Forms web application parameters.
Set branding parameters in web.xml
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, 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.
For example, the parameter, frevvo.menu.bar, if added to the web.xml file, will prevent the menu bar from being rendered.. This might be desired if a customer requests the Downloads,Templates,Help,Docs,Forum and Contact menu items be removed. In this case, the menu bar would not be needed.
<context-param> <param-name>frevvo.menu.bar</param-name> <param-value>true</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: c:\<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:
Parameter | Description | Default |
---|---|---|
frevvo.home.url | Home page for the Company Logo link | ${context.path} |
frevvo.logo.url | URL to the Company Logo image | ${context.path}/images/bright/TransparentLogo-NoBeta.png |
frevvo.help.url | URL to the Help page | ${context.path}${servlet.path}/static/help/designer |
frevvo.docs.url | URL to the Documentation | http://docs.frevvo.com/docs/index.php/V4_Main_Page |
frevvo.forum.url | URL to the Forum | http://http://forum.frevvo.com/forum/ |
frevvo.blog.url | URL to the blog | http://blog.frevvo.com |
frevvo.product.name | The Product Name | Live Forms |
frevvo.copyright | Product Copyright One-Liner | Copyright 2006-2012 frevvo Inc. All rights reserved. |
frevvo.license.url | URL to License Agreement | ${context.path}${servlet.path}/static/termsDL |
frevvo.contact.menu | Show Contact menu item | true |
frevvo.downloads.menu | Show Downloads menu item | true |
frevvo.gallery.menu | Show Gallery (Examples) menu item | true |
frevvo.templates.menu | Show Templates menu item | true |
frevvo.contact.email | Contact Us email address | mailto:info@frevvo.com |
frevvo.css.url | Custom Stylesheet URL | |
frevvo.poweredby.markup | Logo in form footer when the Logo property set | Powered by Live Forms™ |
frevvo.page.title | HTML title prefix for all Live Form pages | frevvo |
frevvo.menu.bar | Show menu bar | true |
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 the empty string no logo will appear on any form. The logo can still be turned of on any given form via the Show Logo form property.Refer to Installation Tasks for the steps to repackage frevvo.war after parameters in web.xml have been edited
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>\frevvo\tomcat\webapps frevvo.war. <frevvo-home>\WEB-INF\web.xml. Refer to Installation Tasks for the steps to 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.
- 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.
- Add the "?_method=post&edit=true" parameter to the end of the link.
- Add the "&showDS=false" parameter to hide Data Sources or "&showPalette=false" to hide the control palette.
- 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 using the OEM branding class parameter
OEM partners can use the context parameter, “frevvo.oem.branding.class” that can be set (in web.xml) to name a css class. This css class will be placed onto the body of the ui pages (form designer, etc.). CSS file(s) with rules based on the body having the oem branding class can be in order to customize the app.
In addition to the context parameter being placed into web.xml, OEMs (or frevvo acting for the OEM) would be responsible for creating the CSS file(s) and putting them into the WAR file. To do this, the OEMs would also have to edit /css/form.pac.css (in the exploded WAR) and add one or more lines like the following: @IMPORT url(“oem_branding.css”); where oem_branding.css is the name of the css file containing the specific oem rules.
If the OEMs do not want to create a new CSS from scratch, they may also simply edit the oem-branding.css file added as part of v5.0. This file is intended as a starter file for any OEM and the OEM can change any aspect of this file. The default oem-branding.css relies on the context parameter “frevvo.oem.branding.class” being set to “oem”. OEMs would get oem-branding.css from the WAR file and re-WAR it after editing it.
Disabling Submission Repository
Submission now can be disabled on any specific form by unchecking the Save form property. Submission metadata is still logged but no form field data is persisted.
.