Searchable Fields are controls in your form/flow used as search criteria for submissions and tasks. It is up to the form/flow designer to designate which controls should be set up as Searchable fields.

Forms/flows 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?

includes a web app (insight.war) that contains a batch process to extract all the latest submissions from  and create Insight Server documents for them. Indexed submission data is stored in <frevvo-home>\data\solr directory and is needed for the 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:

  • All forms/flows in all tenants or a specific tenant - must be initiated by the frevvo Cloud or customer in-house superuser administrator. Cloud customers must contact frevvo to request a refresh of Searchable fields for your entire tenant.  frevvo will run the Insight Batch job during a time when your users are NOT using . frevvo will run the Refresh job during a time when your users are NOT using .
  • An individual form or flow - can be initiated by Designers (owners), Tenant Admins or any designer user given permission to edit forms/flows for a Cloud or in-house installation. If refreshing production forms or flows, run the job during a time period when the forms or flows are not being used.

On This Page:

Run the Refresh Searchable Fields Process

Follow these steps to manually Refresh Searchable Fields for all forms/flows 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 initiate a refresh for a particular form/flow. See Admin Initiation of Refresh for a particular form or flow for the details.

Start the Refresh Searchable Fields Process

  1. Login as the server admin - admin@d
  2. Click the Refresh Searchable Fields link on the Manage Server screen. The chart shows the following information for the last 1000 batch runs:
    1. Date and time when the batch job was Started
    2. Date and time when the batch job completed/failed/stopped or was marked abandoned.
    3. Status of the batch jobs previously run - completed/failed/stopped/abandoned.
    4. The user id and name of the user who ran the process.
    5. Description of the process - was it run for all tenants, a specific tenant or a particular form/flow.



  3. Click the icon to initiate a new process. Use the Refresh icon to update the table with the most recent information.

    If refreshing production forms/flows, remember to run the process when the forms/flows are not being used!

  4. The Start Refresh of Searchable Fields screen displays.
  5. Select the tenant(s) for the batch job run. The choices are:
    1. All Tenants on the server
    2. A Specific Tenant
    3. If you select Specific Tenant then you must specify the tenant name. Type part of the tenant id into the search field and click the Search button. In the image, the Refresh Searchable Fields process will run for a tenant named mycompany. Notice only a partial portion of the tenant id was typed into the search box to display the list of tenants that meet the search criteria:



  6. Click Submit to start the process. The Refresh Insight Data Batch Job Status screen redisplays with a success message, the Date and time the batch job began, the user who initiated the process, a description of the process and the status of the process as Started.

Stop the Refresh Searchable Fields Process

Once you have initiated the Refresh Searchable Fields process, the 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:

  1. Click the Stop icon .



  2. Click Ok to confirm.



  3. When the process is stopped, the status column will update.

Restarting a Stopped Insight Data Batch Process

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.

Abandoning the Insight Data Batch Process

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:

  1. Stop the Refresh Searchable Fields Process
  2. Click the Abandon icon in the row in the Abandon column for the process you want to prevent from restarting.



  3. Click Ok to confirm.



  4. The Refresh Insight Data Batch Job Status screen will update.

Specify a Submission Start Date for the Insight Data Batch Process

If you are not interested in data before a certain date, configure the property index.submission.start.date   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.

Admin Initiation of Refresh for a particular form or flow

 

Troubleshooting

Additional information, about the Insight Batch Job can be found in the <frevvo-home>\tomcat\logs\insight.log file.

Insight Batch Job displays a status of UNKNOWN

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:

Failed to map Submission{id:16ce6738-a62a-48b2-826c-3d65be386ca2} Caused by: java.io.IOException: 
IO Error: Unexpected packet
Rolling back with transaction in unknown state
Application exception overridden by rollback exception
Non-skippable exception during read
Solution:

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.

Insight Batch Job log entries

The insight.war and insight.xml files are now embedded in the frevvo.war. You will not longer 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.