frevvo Latest - This documentation is for frevvo v10.0. Not for you? Earlier documentation is available too.
Searchable Fields are controls in your form/workflow used as search criteria for submissions and tasks. It is up to the form/workflow designer to designate which controls should be set up as Searchable fields.
Forms/workflows can be a work in progess - requirements change over time. What happens if you need to add or delete Searchable fields and you want your previous submissions to reflect your changes?
frevvo includes a web app (insight.war) that contains a batch process to extract all the latest submissions from frevvo and create Insight Server documents for them. Indexed submission data is stored in <frevvo-home>\data\solr directory and is needed for the frevvo Reports feature and Submission and Task searches. This web app is embedded in the <frevvo-home>\tomcat\webapps\frevvo.war file in the tomcat bundle.
Searchable fields can be refreshed for:
On This Page:
Follow these steps to manually Refresh Searchable Fields for all forms/workflows in all tenants or a specific tenant. This process is initiated by the frevvo cloud and in-house superuser administrators.
The in-house superuser or the tenant admin can also Admin Initiation of Refresh for a particular form or workflow for the details.. See
Click the icon to initiate a new process. Use the Refresh icon to update the table with the most recent information.
The Start Refresh of Searchable Fields screen displays.
Select what Searchable Data is to be refreshed:
Select the tenant(s) for the batch job run. The choices are:
A Specific Tenant
Once you have initiated the Refresh Searchable Fields process, the frevvo UI allows for the job to be stopped or aborted. The process can be stopped if it is in the STARTING or STARTED state.
You will notice a Stop column in the row in the table for the process that was started. To stop the job:
The tenant admin can stop any Refresh Searchable Fields process running in the tenant.
When the Refresh process runs, tables that store the state of the job are created in the frevvo database. By default, if a job were to fail or be stopped, starting the job again would restart the failed/stopped job from where it failed/stopped.
To restart a Stopped/Failed batch job, simply start the batch job again with same tenant and it will resume the last stopped job.
To prevent the last stopped job from restarting, change the status to Abandoned.
The Refresh Searchable Fields process can be abandoned if it is not in the STARTING or STARTED state. The process must be stopped to mark it as abandoned. This prevents it from being restarted. You may want to abandon a batch job if it failed and restarting it would result in another failure. Abandoning the batch job allows you to start over again with a new process.
When you stop a batch process, you will notice Stop and Abandon columns in the row in the table for the process that was started. To abandon the job:
If you are not interested in data before a certain date, configure the property to a date in the YYYY-MM-DD format in the <frevvo-home>\tomcat\conf\frevvo-config.properties file. The batch will then exclude any submissions before this date.
The frevvo Cloud or in-house superuser and the tenant admin can Refresh Searchable Fields for a particular form/workflow. Follow these steps:
frevvo only allows one process to run at a time. If a process is running and another process is initiated, the process that is running shows a status of STARTED while the queued process appears in the table with a status of STARTING. A Start date/time for the queued process does not get assigned until the job is actually running.
The web app that runs the Refresh Searchable Fields process (insight.war) and it's configuration file (insight.xml) are embedded in the <frevvo-home>\tomcat\webapps\frevvo file. In-house customers will not see the insight.war in the <frevvo-home>\tomcat\conf\webapps directory or the insight.xml files in the <frevvo-home>\tomcat\conf\catalina\localhost directory if you are using the frevvo tomcat bundle. Log messages formerly in the insight logfiles are now captured in the <frevvo-home>\tomcat\logs\frevvo.YYYY-MM-DD file. Default Configuration properties for the Insight Server are now located in the <frevvo-home>\tomcat\conf\frevvo-config.properties file.
If you are using Oracle 12c as your database, you may see a batch job that displays a status of Unknown . This status indicates that the batch job did not complete.
If you see this status, you may see the following errors in the <frevvo-home>\tomcat\logs\frevvo.log:
The version of the Oracle thin JDBC driver must be ojdbc7. Update your existing driver to the ojdbc7.jar. in the <frevvo-home>\tomcat\lib directory.