Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Section
Column

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

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

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 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 to newer releases. See Installation Tasks for more information.

Code Block
<!-- 
		        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"/>
	<Parameter name="frevvo.attachment.maxsize" value="1000000000" override="false"/>
Column
width240px350px

On This Page:

Table of Contents
maxLevel2

...

menuShow menu item frevvo
ParameterDescription Default
frevvo.home.urlHome page for the Company Logo link ${context.path}
frevvo.logo.urlURL to the Company Logo image image. Also applies to Spaces${context.path}/images/bright/TransparentLogo-NoBeta.png
frevvo.help.url URL URL to the Help page${context.path}${servlet.path}/static/help/designer
frevvo.docs.urlURL to the Documentationhttp://docs.frevvo.com/d/docsdisplay/index.php/V4_Main_Pagefrevvo/frevvo+v5+Documentation+Home
frevvo.forum.urlURL to the Forumhttp://http://forum.frevvo.com/forum/
frevvo.blog.urlURL to the blog http://blog.frevvo.com
frevvo.product.nameThe Product NameLive Forms
frevvo.copyrightProduct Copyright One-LinerCopyright 2006-2012 frevvo Inc. All rights reserved.
frevvo.license.url URL URL to License Agreement${context.path}${servlet.path}/static/termsDL
frevvo.contact.emailContact trueUs email addressmailto:info@frevvo.com
frevvo.downloads.menuShow Downloads menu itemtrue
frevvo.gallery.menuShow Gallery (Examples) menu itemtrue
frevvo.templates.menuShow Templates menu item truefrevvo.contact.emailContact Us email address
mailto:info@frevvo.comfrevvo.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.

...

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

Image RemovedImage Added

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. 

...

The Powered by frevvo™ logo can be customized via the frevvo.poweredby.markup branding parameter. If this branding parameter is the an empty string no logo will appear on any form. The logo can still be turned of off 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 editedImage Removed

Image Added

Hiding Palette Controls

...

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

 

Branding CSS

...

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:

Code Block
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  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.

Code Block
<context-param>
 <param  <param-name>frevvo.oemcertificate.branding.class<signature</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 create their own private CSS file(s) with rules based on the body having the oem branding class in order to customize the frevvo app.</description> 
</context-param>

CSS file(s) with rules based on the body having the oem branding class can be created in order to customize the  application. You can create css files from scratch or use the default oem-branding.css file as a guide. Any aspect of this file can be changed. The  oem-branding-.css file  is located in <\tmp>\css-XXXXX, where XXXXX=version number\themes\oem directory of the unzipped WAR. 

OEM partners are responsible for creating the CSS file(s) and putting them into the WAR file. To do this, edit <\tmp>\css-XXXXX\form.pac.css (in the exploded WAR) and add one or more lines like the following:

Code Block
@IMPORT url(“oem_branding.css”); where oem_branding.css is the name of the css file containing the specific oem rules. XXXXX = the  version number.

 

 

 

...

  <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  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.
Code Block
<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>
Note

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

3rd Party Licenses

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