Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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. The Live Forms web.xml file is 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 can 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 below for information. 

 

Web Application

VAR and OEM customers can now easily VAR and OEM partners can brand Live Forms with their own company images and look. This is accomplished via Live Forms web  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 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.

...

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

...

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. 

...

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. 

...

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

...

Info

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:

...

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:

...

      4. Save the file and restart .

 

...

Branding CSS

OEM partners can use the context parameter, “frevvo.oem.branding.class”  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 created in order to customize the  application. If you do not wish to create css files from scratch, the default oem-branding.css file is a good place to start.. Any aspect of this file can be changed. The context parameter “frevvo.oem.branding.class”  must be set to “oem". Unzip the frevvo.war file to a temporary directory. The  oem-branding-.css file  is located in <\tmp>\css-XXXXX, where XXXXX=version number\oem. Rezip the frevvo.war file after editing is completed. See Installation Tasks for more information.

...