V3 OEM and Embedding
From Frevvodocs
frevvo Live Forms™ v3
Contents |
- frevvo supports a 100% embeddable forms designer/server for seamless integration with your application.
- frevvo provides a client API which supports a simple programmatic protocol for viewing and managing frevvo resources such as forms, applications, themes, schemas, etc.
Embedded Form Designer
frevvo enables simple, quick and easy embedding of the form designer and application, forms, themes, schemas and submission pages via a embedded property which can be set on any user. By setting embedded to true, users will no longer see the frevvo decoration around those pages. The frevvo header and footer areas are hidden. The pages can then be embedded in your own web site and appear integrated and branded by your company look & feel.
You can try the OEM version now. Select either Standard or Professional edition under the OEM column.
The embedded property is set by editing a user's profile page as the admin user. To do this, login to your download in-house installation of Live Forms as admin. Click on the users link and edit a user's profile.
Change the dropdown field from false to true.
Submit the user profile form. Now logout as admin and login as this user. You will see that the frevvo specific header and footer are hidden from view.
In order to logout your web page should provide a header with a link to the logout method. If your Live Forms server is running on localhost:8080 the URL to the logout method would be http://localhost:8080/frevvo/web/logout
frevvo API
The frevvo API adds programmatic access to Live Forms for OEM customer. The API provides a simple protocol for viewing and managing frevvo 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
Web Application
VAR and OEM customers can now easily brand frevvo Live Forms with their own company images and look. This is accomplished via frevvo web application parameters.
The frevvo.war file contains a web.xml with branding parameters. You can either edit the parameters directly in web.xml and repackage frevvo.war or at the web application container level. In the frevvo-tomcat bundle this file is located here:
c:\frevvo\tomcat\webapps\frevvo\WEB-INF\web.xml
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\tomcat\conf\Catalina\localhost\context.xml.default.
- 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/V3.0_Main_Page |
| frevvo.blog.url | URL to the blog | http://blog.frevvo.com/blog |
| frevvo.product.name | The Product Name | frevvo Live Forms |
| frevvo.copyright | Product Copyright One-liner | Copyright 2006-2008 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.contact.email | Contact Us email address | info@frevvo.com |
| frevvo.css.url | Custom Stylesheet URL | |
| frevvo.poweredby.markup | Logo in form footer when the Logo property set | Powered by frevvo™ |
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 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 ${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.
Hiding Url Menu Items
Certain menu items are links to external Urls. Two examples are Forum and Docs. It is possible to completely remove any of these menu items by deleting the Url. If no Url exists the menu item will be hidden.
For example if you wish to hide the Forum menu item and link at the top right corner, edit the frevvo.forum.url and delete the content:
<context-param> <param-name>frevvo.forum.url</param-name> <param-value></param-value> <description>No Url set will hide the forum menu and top link</description> </context-param>
The look & feel of the frevvo 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.
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. .
