Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Column | |||||||||||||
Section | |||||||||||||
|
...
- Expand the war, edit/create the /WEB-INF/config.properties re-zip the war. This is essentially the same as editing the web.xml directly.
- Create the file in the current working directory of the container you are using. will pick it up by default. For example, <frevvo-home>/tomcat is the current working directory for the tomcat container.
Place the config.properties somewhere in the file system (outside the frevvo.war) and then add -Dfrevvo.config=file:Drive:/path to config.properties in the java executable call. For example, add it to <frevvo-home>\tomcat\bin\setenv.bat, setenv.sh or service.bat if you are using the tomcat container. Here is an example of the <frevvo-home>\tomcat\bin\setenv.bat file with the added parameter:
Code Block |
---|
set JAVA_OPTS=-Xms256m -Xmx1024m -XX:MaxPermSize=156m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -Dfile.encoding=UTF-8 -Djava.awt.headless=true -Dfrevvo.config=file:C:/frevvo/tomcat/frevvo-config.properties |
The value of frevvo.config can be a full path (e.g. Drive:/pathtomyconfig.properties), a path in the war (e.g. /WEB-INF/myconfig.properties) or a url (e.g. http://config/cluster1/myconfig.properties). Be sure to include the config.properties file name in the path statement.
...
- Login to your server as user "adminadmin@d", password "admin".
- On the page that is displayed, click the "Manage Tenants" link.
- Click the icon to manage tenant named "d (Default tenant)"
- Click "Manage Users"
- Click the icon for the admin user. This displays a profile form.
- Change the password as desired and submit the form.
...
- Unable to contact license server
- Unable to renew license. Your license will expire in <n> day(s)
External URLs
Sometimes running behind running behind a proxy server can cause unintended changes to the form server's external URLs. The following configuration parameters address this issue. These parameters can be added to frevvo war settings section of the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file.
frevvo.forms.server.external.url - If set, all share dialogs for
forms and flows will use this as the external URL.forms and flows will use this as the external URL. Use the syntax shown in the example. change the <myexternalhost>and <port> to your external server name and the port that you are using for on this server.
Code Block <Parameter name="frevvo.forms.server.external.url" value="http://<myexternalhost>:<port>" override="false"/>
frevvo.internal.baseurl - If set, all URLs used internally by the form server will use this base url. This may be needed when using frevvo.forms.server.external.url if that external url is not also accessible from the form server machine.
...
Use the syntax shown in the example. change the value "http://localhost:8082" to the server name and port of your server.
Code Block <Parameter name="frevvo.
...
internal.baseurl" value="http://
...
localhost:8082" override="false"/>
Default Port
By default the tomcat bundle is configured to bind to port 8082. You can change the port by:
...
Additional info on how to use SSL on tomcat can be found on the Apache/Tomcat website. Also refer to this article: How to solve javax.net ssl. SSLHandshakeException?
Currently you must not disable 's http port. In a future release this will be allowed. Disabling ' http port will cause your form server to malfunction as requires this port. For most cases it is sufficient to share the https version of your form/flow's Url and leave http open. However, if you want to force all form usage to be over https and feel it is not enough to simply share the https form Urls (as a user can switch to http as long as that port is open), we recommend that you deploy behind an Apache or IIS server. Close the http port on Apache or IIS but leave tomcat's http port open so that can POST back to itself when needed over http but no one outside can access it.
...
Note |
---|
If you plan to run the Tomcat bundle on IBM J9 JVM and you want to have the HTTPS connector enabled, you will need to change the encryption algorithm to IBM's X509 from the default Sun Oracle X509 implementation. |
To run HTTPS on IBM J9 JVM, add algorithm="IbmX509" attribute to the HTTPS connector:
...
Tip |
---|
Java 7 will throw a "SEVERE: java.net.SocketException: Invalid argument: no further information" error in the <frevvo-home>/tomcat/logs/catalina.YYYY-MM-DD.log when used on a Windows 2003 system with Tomcat version 7.0.29 or earlier and the NIO http connector. If you should encounter this error, check the version of Tomcat. If it is below 7.0.30, upgrade to that version. Run the <frevvo-home>\tomcat\version.bat (Windows) or <frevvo-home>/tomcat/version.sh (UNIX) files to determine the version of Tomcat installed on your system. |
Tomcat Logfiles
By default, the server writes useful logging information to a daily logging file located here: <frevvo-home>/tomcat/logs/frevvo.log. You will see the logfiles listed below in <frevvo-home>/tomcat/logs. The current date appends to the logfile name for all the files except the frevvo log:
...
Code Block |
---|
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="${catalina.base}/logs" prefix="localhost_access_log." suffix=".txt" pattern="%h %l %u %t "%r" %s %b "%{Referer}r" "%{User-Agent}r" [%I %{JSESSIONID}c]" /> |
- host-manager.MM-DD-YYYY.log - this logfile is part of the tomcat distribution and is empty by default. It is a log file for the host-manager web application that is used to manage virtual hosts in tomcat. The host manager web-app is typically not needed because is preconfigured. Messages are written to this log only if the host-manager web application is being used.
- manager.MM-DD.YYYY.log - this logfile is part of the tomcat distribution and is empty by default - this is the log file for the tomcat manager web application which is used to check the status of web apps, memory usage etc. Messages are written to this log only if the manager web app is being used.
Note |
---|
There will be three additional logfiles when running Tomcat as a Windows service:
|
...
The logging levels used by can be fine-tuned by editing the <frevvo -home>/tomcat/lib/logback.xml file. By default log level is set to INFO. The logging infrastructure will scan this file every 60 secs so you can live-change the log level. Here
is more configuration information . Stop to delete the logfiles. They will be recreated on start up.
...
The tomcat bundle install will automatically rotate log files daily. The logfile is the only one affected. Let's say the current date is 6 - 19 - 2013. The current days logging is saved to the frevvo.log file located in <frevvo-home>/tomcat/logs. On the next day, 6 - 20 - 2013, the log from the previous day is copied to a logfile stamped with the previous day's date. (frevvo_2013-06-19). This date stamped frevvo.log is moved into located in the <frevvo-home>\tomcat\logs\old directory. Logging for 6 - 20 - 2013 is saved in the frevvo.log in <frevvo-home>/tomcat/logs.
...
Code Block | ||
---|---|---|
| ||
<session-config>
<session-timeout>480</session-timeout>
</session-config> |
The default server session
...
The default server session timeout can be overridden for each tenant. See the Edit Tenant topic for more information.
Tip |
---|
Tomcat session-config parameters can not be overridden in frevvo.xml. |
When a session times out, for example when a person is using a form and then pauses for longer than the configured <session-timeout>, they will see the following error the next time they enter a value into the form.
The following screen displays when a user tries to submit a form from a timed out session.
Editing Submissions
Submissions can be edited via the Submissions Page. This feature is disabled by default for in-house users. To enable this feature, add the frevvo.submissions.edit.link configuration parameter to the <frevvo-home>/WEB-INF/web.xml. For more
details on the feature that this parameter controls see Editing Submissions. The web.xml file must be unzipped from the frevvo.war before it can be edited. See above for the details.
timeout can be overridden for each tenant. See the Edit Tenant topic for more information.
Tip |
---|
Tomcat session-config parameters can not be overridden in frevvo.xml. |
When a session times out, for example when a person is using a form and then pauses for longer than the configured <session-timeout>, they will see the following error the next time they enter a value into the form.
The following screen displays when a user tries to submit a form from a timed out session.
Editing Submissions
Designer users can view/edit submissions by clicking the edit link on the submissions panel. Non designer users can view/edit submissions by clicking on the Shared Items tab if they have been granted permission to do so by the designer via the Access Control feature. The frevvo.submission.edit .link parameter must be set to the default value of true, for the edit link to be visible to any user. To disable the edit link on the submission panel, change the default value of true to false for the frevvo.submissions.edit.link configuration parameter in <frevvo-home>/WEB-INF/web.xml file. The web.xml file must be unzipped from the frevvo.war before it can be edited. Follow the instructions above to unzip, modify and rezip the war file.
Code Block |
---|
<context-param>
<param-name>frevvo.submission.edit.link</param-name>
<param-value>false</param-value>
<description>Show a link to edit the submission.</description>
</context-param> |
You can add the frevvo.submission.edit.link configuration property to the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file instead of the web.xml file as discussed above. Here is an example that will disable submission editing when added to the frevvo war settings section of frevvo.xml:
Code Block |
---|
<Parameter name="frevvo.submission.edit.link" value="false" override="false"/> |
When the frevvo.submission.edit.link parameter has a value of false, the edit link is not visible on on form submission panels.
Hardware Requirements
The minimum recommended hardware configuration for your Live Forms server is:
...
Code Block | ||
---|---|---|
| ||
<Parameter name="frevvo.xforwarded.protocol.header" value="X-Forwarded-Protocol" override="false"/>
<Parameter name="frevvo.xforwarded.host.header" value="X-Forwarded-Host" override="false"/>
<Parameter name="frevvo.xforwarded.port.header" value="X-Forwarded-Port" override="false"/> |
Moving users to a different tenant
This section describes how to move a user to a different tenant. In the steps below, we will move the user john from a source tenant (will use tenant d) to a target tenant (will use mytenant as the target name).
- If the target tenant does not exist, create it by following these steps. For the sake of this document, I will assume the target tenant id to be mytenant.
- Login to the target tenant as an admin and create a user with the same id as the user in the original tenant. In this example, the user id is john in the tenant mytenant.
- Transfer the applications to the new user account in the target tenant
- Login to the source tenant as a tenant admin. For instance admin@d.
- Navigate to Manage > Manage Users.
- Login as the user you want to move.
- Navigate to the user's applications page.
- Download each application for that user and save to a folder in your file system.
- Logout
- Login as the user in the new tenant: john@mytenannt.
- Upload the applications you've downloaded in the previous steps.
- Move the submissions in the submissions repository. You need to run these steps in the database where you persist the submissions. Please back up your database before moving forward.
- Login to your database.
- Edit the script shown below to:
- Replace the word johnwith the id of the user you are migrating.
- Replace the tenant id d with the id of the source tenant. The default tenant in is called d so if you are moving the user as part of an upgrade from 3.4.x chances are that your source tenant is d.
- Replace the word mytenant with the name of your target tenant
- Run the script shown below in your submissions database.
Code Block |
---|
update formsubmission
set tenantid='mytenant'
where id in (
select fs.id from formsubmission fs, formsubmissiontype fst
where
fs.formsubmissiontype_formtype_id = fst.id
and fst.ownerid='john'
and fs.tenantid='d'
)update formsubmissiontype
set tenantid='mytenant'
where ownerid='john'
and tenantid='d' |
...
" override="false"/>
<Parameter name="frevvo.xforwarded.port.header" value="X-Forwarded-Port" override="false"/> |
Moving users to a different tenant
This section describes how to move a user to a different tenant. In the steps below, we will move the user john from a source tenant (will use tenant d) to a target tenant (will use mytenant as the target name).
- If the target tenant does not exist, create it by following these steps. For the sake of this document, I will assume the target tenant id to be mytenant.
- Login to the target tenant as an admin and create a user with the same id as the user in the original tenant. In this example, the user id is john in the tenant mytenant.
- Transfer the applications to the new user account in the target tenant
- Login to the source tenant as a tenant admin. For instance admin@d.
- Navigate to Manage > Manage Users.
- Login as the user you want to move.
- Navigate to the user's applications page.
- Download each application for that user and save to a folder in your file system.
- Logout
- Login as the user in the new tenant: john@mytenannt.
- Verify that the submissions are properly being loaded for all forms. In the submissions repository page make sure to adjust the initial and end dates to a window of time that you know have submissions for that specific form.
- Update references to the forms. After going trough the steps above, the URL to the forms owned by the user will be different than what they were originally. You need to update all references to the forms in published links and pages where the form should be embedded.
Show/Hide Tenant Login
is a multi-tenant application. See the administration section on Manage Tenants. However, it is possible that all you need is a single tenant. If this is your case it simplifies server login if you hide the tenant input on the login page.
This can be changed by editing <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml. Uncomment the frevvo.default.login.tenent.id parameter and set the param-value to the name of your one tenant. Next set the param-value of frevvo.login.show.tenant to false.
Here is how the parameters appear after editing:
Code Block |
---|
<context-param>
<param-name>frevvo.default.login.tenant.id</param-name>
<param-value>ssotest</param-value>
<description>Default Tenant</description>
</context-param>
<context-param>
<param-name>frevvo.login.show.tenant</param-name>
<param-value>false</param-value>
<description>Show Tenant Box on Login Page</description>
</context-param> |
Restart your server and the next time you login you will only need to enter your username and password.
Note |
---|
These two config parameters can also be overridden in <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml. This keeps all your modified parameters in one place and makes it easy to upgrade to newer releases. |
Code Block |
---|
<Parameter name="frevvo.default.login.tenant.id" value="mytenant" override="false"/> |
...
- Upload the applications you've downloaded in the previous steps.
- Move the submissions in the submissions repository. You need to run these steps in the database where you persist the submissions. Please back up your database before moving forward.
- Login to your database.
- Edit the script shown below to:
- Replace the word johnwith the id of the user you are migrating.
- Replace the tenant id d with the id of the source tenant. The default tenant in is called d so if you are moving the user as part of an upgrade from 3.4.x chances are that your source tenant is d.
- Replace the word mytenant with the name of your target tenant
- Run the script shown below in your submissions database.
Code Block |
---|
update formsubmission
set tenantid='mytenant'
where id in (
select fs.id from formsubmission fs, formsubmissiontype fst
where
fs.formsubmissiontype_formtype_id = fst.id
and fst.ownerid='john'
and fs.tenantid='d'
)update formsubmissiontype
set tenantid='mytenant'
where ownerid='john'
and tenantid='d' |
Verification:
- Login as the user in the new tenant.
- Verify that the submissions are properly being loaded for all forms. In the submissions repository page make sure to adjust the initial and end dates to a window of time that you know have submissions for that specific form.
- Update references to the forms. After going trough the steps above, the URL to the forms owned by the user will be different than what they were originally. You need to update all references to the forms in published links and pages where the form should be embedded.
Show/Hide Share Dialog Options
...
3. Replace the value,102400 in this example, with the maximum size of the attachment that you want. The value must be entered in bytes. The default value is 10485760 bytes.
4. Restart .
Info |
---|
Now that you can take pictures using your mobile device camera and/or upload images to your , the default value of If you are using MySQL, and you upload a large image or you are using a workflow that contains a large pdf, , you may see this error: The default value of the max_allowed_packet parameter in your MySQL server may not be large enough if you are using MySql. Refer to this website for detailed information about the MySql configuration parameter. Increasing the max_allowed_packet variable setting in your MySQL Server from the default (1M) to something like 16M (16777125) fixes the issue. To fix the issue temporarily, run the following commands: |
...
To permanently set it, choose one of the two methods listed below:
mysqld --max_allowed_packet=16M
On Mac OS, you can access the my.cnf file by typing
The location of the my.ini/my.cnf file varies by configuration.