Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
  • 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
  • Refresh process during a time when your users are NOT using
Column

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?

Frevvoproduct
includes a web app (insight.war) in the tomcat bundle and is embedded in the <frevvo-home>\tomcat\webapps\frevvo.war file.The war that contains a batch process that extracts to extract all the latest submissions from 
Frevvoproduct
and creates create Insight Server documents for them. Indexed submission data is stored in <frevvo-home>\data\solr directory and is needed for the
Frevvoproduct
Reports feature and Submission and Task searches. This web app is embedded in the <frevvo-home>\tomcat\webapps\frevvo.

The batch process

war file in the tomcat bundle.


Searchable fields can be run refreshed for:

  • All tenants
  • A specific tenant
  • An individual form or flow.
Warning
Frevvoproduct
.Designers and Tenant Admins can Refresh Searchable fields for a specific form/flow
  • 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
    Frevvoproduct
    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.
 

Image Added

Image Removed

Column
width300px

On This Page:

Table of Contents
maxLevel3

Run the

...

Refresh Searchable Fields Process

In-house customers can follow Follow these steps to manually run the batch process to refresh the Insight data if necessary.

...

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 Manage Insight Data  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.
      Image Removed.
    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.

      Image Added

  3. Click the Image Modifiedicon to initiate a new

    batch job.

    process. Use the Image Added Refresh icon to update the table with the most recent information.

    Warning

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

  4. The Start Refresh of Insight Data 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 Insight Data batch 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:
      Image Removed
      Image Added

  6. Click Submit to start the batch 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 batch job process as Started.
    Image Removed

    Image Added

  7. Click the Back to Manage Server link to return to the Manage Server screen.

Stop the

...

Refresh Searchable Fields Process

Once you have initiated the Insight Data Batch Refresh Searchable Fields process, the

Frevvoproduct
UI allows for the job to be stopped or aborted. The batch 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 .
    Image Removed
    Image Added
  2. Click Ok to confirm.



  3. When the batch job process is stopped, the status column will update.
    Image Removed

    Image Added

Note

The tenant admin can stop any Refresh Searchable Fields process running in the tenant.

Restarting a Stopped Insight Data Batch Process

When the batch job 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.

...

Abandoning the Insight Data Batch Process

The Insight Data Batch Process Refresh Searchable Fields process can be abandoned if it is not in the STARTING or STARTED state. The batch job 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 Insight Data Batch Refresh Searchable Fields Process
  2. Click the Abandon icon in the row in the Abandon column for the batch job process you want to prevent from restarting.
    Image Removed
    Image Added

  3. Click Ok to confirm.



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

Specify a Submission Start Date for the Insight Data Batch Process

If you are not interested in data before a certain date, configure the properyproperty 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

The frevvo Cloud or in-house superuser and the tenant admin can Refresh Searchable Fields for a particular form/flow. Follow these steps:

Superuser Admin

Troubleshooting

...

  1. Login as the superuser admin.
  2. Click Manage Tenants.
  3. Select the tenant containing the designer account for the form/flow you want to update by clicking on the Image Addedicon.
  4. Click Manage Users.
  5. Login to the Home page of the designer user account that contains the form/flow you want to update by clicking on the Image Added icon.
  6. Navigate to the Application Home page where the form/flow is located.
  7. Navigate to the Forms or Flows Home page. Click the Image Added icon to run the Refresh Searchable Fields process for the form/flow you want to update.

    Image Added

Tenant Admin

  1. Login as the tenant admin.
  2. Click Manage Users.
  3. Login to the Home page of the designer user account that contains the form/flow you want to update by clicking on the Image Added icon.
  4. Navigate to the Application Home page where the form/flow is located.
  5. Navigate to the Forms or Flows Home page. Click the Image Added icon to run the Refresh Searchable Fields process for form/flow you want to update.

    Image Added

Multiple Refresh Processes

When the Tenant Admin clicks the Image Added icon, the list of Refresh Searchable Fields processes that were run for the tenant and for specific forms/flows displays in the table. The Tenant Admin has the ability to stop/abandon a process but they cannot initiate a refresh for the entire tenant.

Frevvoproduct
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.

Image Added

Troubleshooting

The web app that runs the Refresh Searchable Fields process (insight.war) and it's configuration file (insight.xml) are embedded in the frevvo.war. 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\logsconf\insightfrevvo-config.log properties file.

...

Refresh Searchable Fields process 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.
Image Removed
Image Added

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.

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.