Versions Compared

Key

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

...

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

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 parameter 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 and with certificates from a security authority. Add this context parameter to the  web.xml file included in the frevvo.war zipfile. See Modifying the web.xml file for the instructions to unzip and rezip the war after modifications to the web.xml are completed or add the parameter to frevvo.xml.

Code Block
<context-param>
  <param-name>frevvo.certificate.signature</param-name>
  <param-value></param-value>
  <description>Set to true to accept self-signed certificates</description>
 </context-param>

This parameter in frevvo.xml should be:

Code Block
<Parameter name="frevvo.certificate.signature" value="true" override="false"/>

Check Database Encoding

The parameters, frevvo.db.check.encoding and frevvo.db.encoding.error, have been added to the web.xml file included in the <frevvo-home>\tomcat\webapps\frevvo.war. These parameters can be used to specify how to handle a check of database encoding and how to display the error if it is not UTF8. They are particularly useful for OEMs who may want to skip the fatal error by setting the frevvo.db.check.encoding parameter to false.

You can set up these parameters to accomplish the following: By default live forms does the check and will fail if not set correctly. 

1. Perform the utf8 check with a fatal error.

2. Disable the UTF db encoding check completely.

3. Perform the check but not fail and simply log the warning in the <frevvo-home>\.tomcat\logs\frevvo.log file.

 Here is how it works:

  • An error will not be displayed if either of the parameters are false. The license page is displayed.
  • Both parameters must be set to true for the error message "Users database schema, Database char set incorrectly configured. It must be utf8, but is instead: XXXXX"  to display:  

Follow these steps to set the parameters:

...

Code Block
 <!-- Database Schema checking on startup -->
    <context-param>
        <param-name>frevvo.db.check.encoding</param-name>
        <param-value>true</param-value>
        <description>Check the database encoding on startup</description>
    </context-param>
    <context-param>
        <param-name>frevvo.db.encoding.error</param-name>
        <param-value>true</param-value>
        <description>If encoding is checked and is wrong, then it is a fatal error, otherwise only a warning is logged</description>
    </context-param> 

These parameters in the frevvo.xml file would be:

Code Block
<Parameter name "frevvo.db.check.encoding" value="true" override="false"/>
<Parameter name "frevvo.db.encoding.error" value="true" override="false"/>

Customizing Runtime Messages and Labels in the Form Designer

You can modify the text of runtime messages and customize the labels in the Form/flow designers by changing string name/value pairs to the 'default' file found in the frevvo.war. You can customize the Form designer and most labels (but not all) in the flow designer.

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

For example, you would like to:

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

Both of these items can be customized by modifying the same file. Follow these steps:

...

Rezip all the files in the c:\tmp\frevvo-war directory, even the ones you did not edit — if you change directories or zip them differently, Live Forms may not load correctly:

This is the correct structure for the frevvo.war zipfile.

...

Make sure you create the zipfile with the directory structure as shown in the image above. It is an easy mistake to include the containing directory in the zipfile. If you do this, Live Forms may not load correctly. Zip will often give your zipfile a .zip extension. Make sure you change this to a .war extension. 

...

Customizing Runtime Messages and Labels in the Designers

You can modify the text of runtime messages and customize the labels in the Form/flow designers by changing string name/value pairs in the default file found in the frevvo.war. You can customize the Form designer and most labels (but not all) in the Flow designer.

The English version of the modified strings appear on the UI once 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 (Public in tenant).
  • Customize the labels of the Palette, Custom, Properties and Data Sources sections of the Forms designer.

The default file in the frevvo.war 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 it is running.
  2. Navigate to <frevvo-home>\tomcat\webapps directory.
  3. Copy the frevvo.war file to a temporary location of your choice: e.g. c:\tmp\frevvo-war. Change the file extension from .war to .zip if necessary.
  4. Edit c:\tmp\frevvo-war\WEB-INF\data\locales\default.
  5. 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 Live Forms
  6. 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.=
  7. Save the changes to the default file. 
  8. Rezip all the files in the c:\tmp\frevvo-war directory, even the ones you did not edit — if you change directories or zip them differently, Live Forms may not load correctly:

    This is the correct structure for the frevvo.war zipfile.

    Image Added

  9. Make sure you create the zipfile with the directory structure as shown in the image above. It is an easy mistake to include the containing directory in the zipfile. If you do this, Live Forms may not load correctly. Zip will often give your zipfile a .zip extension. Make sure you change this to a .war extension. 

  10. Copy the updated frevvo.war file to <frevvo-home>tomcat\webapps.
  11. Restart your  server.

    Section
    Column
    Image Added

    Customized "Access denied. Authentication required" message
    Column

     

    Image Added

    Customized Labels in the Forms Designer

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 parameter 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 and with certificates from a security authority. Add this context parameter to the  web.xml file included in the frevvo.war zipfile. See Modifying the web.xml file for the instructions to unzip and rezip the war after modifications to the web.xml are completed or add the parameter to frevvo.xml.

Code Block
<context-param>
  <param-name>frevvo.certificate.signature</param-name>
  <param-value></param-value>
  <description>Set to true to accept self-signed certificates</description>
 </context-param>

This parameter in frevvo.xml should be:

Code Block
<Parameter name="frevvo.certificate.signature" value="true" override="false"/>

Check Database Encoding

The parameters, frevvo.db.check.encoding and frevvo.db.encoding.error, have been added to the web.xml file included in the <frevvo-home>\tomcat\webapps\frevvo.war. These parameters can be used to specify how to handle a check of database encoding and how to display the error if it is not UTF8. They are particularly useful for OEMs who may want to skip the fatal error by setting the frevvo.db.check.encoding parameter to false.

You can set up these parameters to accomplish the following: By default live forms does the check and will fail if not set correctly. 

1. Perform the utf8 check with a fatal error.

2. Disable the UTF db encoding check completely.

3. Perform the check but not fail and simply log the warning in the <frevvo-home>\.tomcat\logs\frevvo.log file.

 Here is how it works:

  • An error will not be displayed if either of the parameters are false. The license page is displayed.
  • Both parameters must be set to true for the error message "Users database schema, Database char set incorrectly configured. It must be utf8, but is instead: XXXXX"  to display:  

Follow these steps to set the parameters:

  1. Unzip the frevvo.war as explained here. Rezip it after the modifications are made.
  2. The parameters are located in the Database Schema checking on startup section: 

Code Block
 <!-- Database Schema checking on startup -->
    <context-param>
        <param-name>frevvo.db.check.encoding</param-name>
        <param-value>true</param-value>
        <description>Check the database encoding on startup</description>
    </context-param>
    <context-param>
        <param-name>frevvo.db.encoding.error</param-name>
        <param-value>true</param-value>
        <description>If encoding is checked and is wrong, then it is a fatal error, otherwise only a warning is logged</description>
    </context-param> 

These parameters in the frevvo.xml file would be:

Code Block
<Parameter name "frevvo.db.check.encoding" value="true" override="false"/>
<Parameter name "frevvo.db.encoding.error" value="true" override="false"/>

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:

...