Versions Compared

Key

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

...

...

...

...

...

...


Section


Column

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

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

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

Info

frevvo only supports/certifies  running certifies frevvo running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.


Customization properties can be changed in the <frevvofrevvo <frevvo-home>/tomcat/conf/frevvo-config.properties file. This keeps all your modified parameters in one place and makes it easy to upgrade to frevvo to newer releases.

Code Block
# SMTP Settings 
frevvo.mail.from.email=
frevvo.mail.bounce.email=
frevvo.mail.debug=false
frevvo.actions.debug=true
frevvo.rule.debug=true

# frevvo schema name settings - needed for 6.0 upgrade only
frevvo.users.schemaName=users
# SQL Server schema name 
#frevvo.users.schemaName=users.dbo

# HTTP Proxy Configuration for licensing
#frevvo.proxy.host=
#frevvo.proxy.port=
#frevvo.proxy.username=
#frevvo.proxy.password=
#frevvo.proxy.ntlm=false

# Insight settings 
insight.enabled=true
insight.server-url=http://localhost:8983/solr

# File Connector settings
frevvo.filesystem.connector.url=http://localhost:8082/filesystem

# Box Connector settings
#frevvo.box.connector.client.id=
#frevvo.box.connector.client.secret=

# Sharepoint Connector settings
frevvo.sharepoint.connector.url=http://localhost:8082/sharepoint



Column
width350px

On This Page:

Table of Contents
maxLevel2


...

For the most common configuration customization tasks that every customer and OEM partner will want to consider see Installation Tasks

API

The  The frevvo Data API enables programmatic access to the all resources and data stored in the  serverfrevvo 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.

...

VAR and OEM partners can brand frevvo with their own company images and look. This is accomplished via  web frevvo web application branding properties.

...

The configuration properties follow a simple property name=value syntax. Follow these steps to convert configuration parameters from previous releases to properties in the frevvo-config.properties file.

  1. Stop if frevvo if it is running
  2. Navigate to <frevvo-home>/tomcat/conf directory.
  3. Edit the frevvo-config.properties file.

  4. The Parameter name becomes the property name.
  5. Add an equal sign.
  6. Add the value after the equal sign.
  7. Repeat this for all custom parameters.
  8. Save the file.
  9. Restart frevvo.

Consider the frevvo.menu.bar property. If added to the frevvo-config.properties file, with a value of false, 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 properties. If all of the menu items are disabled, the menu bar should be removed.  

...

ParameterDescription Default
frevvo.home.urlHome page for the Company Logo link #{servletContext.contextPath}
frevvo.logo.urlURL to the Company Logo image. Also applies to Spaces#{servletContext.contextPath}/images/bright/TransparentLogo-NoBeta.png
frevvo.help.urlURL to the Help page#{servletContext.contextPath}${servlet.path}/static/help/designer
frevvo.docs.urlURL to the Documentationhttp://docs.frevvo.com/d/display/<frevvo docs version>
frevvo.forum.urlURL to the Forumhttp://forum.frevvo.com/forum/
frevvo.blog.urlURL to the bloghttp://blog.frevvo.com
frevvo.product.nameThe Product Namefrevvo
frevvo.copyrightProduct Copyright One-LinerCopyright 2006-2012 frevvo Inc. All rights reserved.
frevvo.license.urlURL to License Agreement#{servletContext.contextPath}${servlet.path}/static/termsDL
frevvo.contact.emailContact Us email addressmailto:info@frevvo.com
frevvo.downloads.menuShow Downloads 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 frevvo™
frevvo.page.titleHTML title prefix for all Live Form frevvo pagesfrevvo
frevvo.menu.barShow menu bartrue
frevvo.oem.branding.cssNames css class applied to body of UI pagesempty
frevvo.certificate.signature Ignore SSL Security when posting to an https endpointempty

...

Notice that several of the parameters use Url templates. For example, frevvo.help.url references a help file named designer.xsl that is located in the directory <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\xsl\main\help. 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 #{servletContext.contextPath}${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 #{servletContext.contextPath}${servlet.path}/static/help/designer with a Url such has http://mycompany/myapp/help.html. Refer to Installation Tasks for the steps to replace the file after parameters in designer.xsl have been editied.

...

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

...

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 frevvo 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 that frevvo is not running.
  2. Navigate to <frevvo-home>\tomcat\conf. Open the frevvo-config.properties file with a text editor.
  3. Add the frevvo.page.title property with your company name as the value.

...

      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 frevvo-config.properties 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 frevvo-config.properties 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 replace the original file, as described above, when the changes are complete. 

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

...

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

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

...

restart frevvo.

Customizing Runtime Messages and Labels in the Designers

You can modify the text of runtime messages and customize the labels in the Form/flow workflow designers by changing string name/value pairs in the default file found in the directory <frevvo home>\tomcat\webapps\frevvo. You can customize the Form designer and most labels (but not all) in the Flow workflow designer.

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

For example, if you wanted to:

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

The default file 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 Stop frevvo if it is running.
  2. Navigate to <frevvo-home>\tomcat\webapps\frevvo directory.
  3. Copy the \WEB-INF\data\locales\default directory to a temporary location.
  4. 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 '='

    Code Block
    # Error messages
    Access\ Denied.\ Authentication\ required.= Please Sign into frevvo


  5. 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 '='

    Code Block
    # Form Designer Toolbox
    Palette=Palette Controls
    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.=


  6. Save the changes to the default file. 
  7. Replace the original file with the updated version.

  8. Restart your  serveryour frevvo server.

    Section


    Column


    Customized "Access denied. Authentication required" message


    Column

    Customized Labels in the Forms Designer



...

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

  1. Stop frevvo, if it is running.
  2. Open <frevvo-home>\tomcat\conf and edit the frevvo-config.properties file. See Installation Tasks for instructions.
  3. Add the context parameter frevvo.oem.branding.css=oem to the frevvo-config.properties file
  4. Edit <frevvo-home>\tomcat\webapps\frevvo\css-xxxx\themes\oem\oem-branding.css file to make your changes.
  5. Add your custom CSS to the oem-branding.css file.
  6. Start frevvo.
  7. Clear the cache before restarting your browser to see the changes.
Note

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

3rd Party Licenses

builds frevvo builds upon several 3rd party products. The <frevvo-home>\tomcat\webapps\frevvo file contains a WEB-IN\licenses with all the 3rd party licenses.

...