onPhase Forms latest - This documentation is for onPhase Forms v11.3. Not for you? Earlier documentation is available too.
Installation Customizations
The frevvo product installation can be customized in many ways. For example OEM partners can brand frevvo with their own company images and look. frevvo properties make it easy to implement many of the common customizations that all 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.
frevvo only supports/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 frevvo <frevvo-home>/tomcat/conf/frevvo-config.properties file. This keeps all your modified parameters in one place and makes it easy to upgrade frevvo to newer releases.
# 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
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.
API
The frevvo Data API enables programmatic access to the all resources and data stored in the frevvo 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.
You will need to install a client library in order to use the API.
Branding
VAR and OEM partners can brand frevvo with their own company images and look. This is accomplished via frevvo web application branding properties.
In the frevvo-tomcat bundle, the frevvo-config.properties file is located in: <frevvo-home>\tomcat\conf.
Modifying the frevvo-config.properties file
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.
Stop frevvo if it is running
Navigate to <frevvo-home>/tomcat/conf directory.
Edit the frevvo-config.properties file.
The Parameter name becomes the property name.
Add an equal sign.
Add the value after the equal sign.
Repeat this for all custom parameters.
Save the file.
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.
frevvo.menu.bar=falseSet branding parameters at container level
If you choose to brand at the tomcat container level,
Open the file: <frevvo-home>\tomcat\conf\frevvo-config.properties.
Add any of the properties listed in the table below that you want to customize: For example, the frevvo.logo.url property configures the URL to your company logo:
frevvo.logo.url=<url to your image>These are the brandable parameters and their defaults:
Parameter | Description | Default |
|---|---|---|
frevvo.home.url | Home page for the Company Logo link | #{servletContext.contextPath} |
frevvo.logo.url | URL to the Company Logo image. Also applies to Spaces | #{servletContext.contextPath}/images/bright/TransparentLogo-NoBeta.png |
frevvo.help.url | URL to the Help page | #{servletContext.contextPath}${servlet.path}/static/help/designer |
frevvo.docs.url | URL to the Documentation | http://docs.frevvo.com/d/display/<frevvo docs version> |
frevvo.forum.url | URL to the Forum | http://forum.frevvo.com/forum/ |
frevvo.blog.url | URL to the blog | http://blog.frevvo.com |
frevvo.product.name | The Product Name | frevvo |
frevvo.copyright | Product Copyright One-Liner | Copyright 2006-2012 frevvo Inc. All rights reserved. |
frevvo.license.url | URL to License Agreement | #{servletContext.contextPath}${servlet.path}/static/termsDL |
frevvo.contact.email | Contact Us email address | mailto:info@frevvo.com |
frevvo.downloads.menu | Show Downloads menu item | true |
frevvo.templates.menu | Show Templates menu item | true |
frevvo.css.url | Custom Stylesheet URL | |
frevvo.poweredby.markup | Logo in form footer when the Logo property set | Powered by frevvo™ |
frevvo.page.title | HTML title prefix for all frevvo pages | frevvo |
frevvo.menu.bar | Show menu bar | true |
frevvo.oem.branding.css | Names css class applied to body of UI pages | empty |
frevvo.certificate.signature | Ignore SSL Security when posting to an https endpoint | empty |