Refreshing the Poetic resource files

About the resource files

Resource files contain the text displayed on the Poetic UI.

They also contain configuration for items such as search criteria, search results columns, and default values.

About customizing and localizing resource files

Poetic comes with a default set of resource files.

If you want to change the UI to use your own terminology, or be able to display the UI in different language, you can then create customized and localized versions of the files. See the Poetic Administrator's Guide for details on creating customized and localized files.

Whenever you create or update the customized and localized files, you need to:

  1. Post the files to the resource file directory on the File Share.
  2. Select the Tools menu option to refresh the files, so that the updates are reflected on the UI.

Posting your custom files to the File Share

Before you refresh the files, you must post them to the File Share directory set as the value of Poetic.inbound.ResourceFilesDir in FileShare.properties.

FileShare.properties is maintained from the configuration file maintenance page. See Managing configuration files for details.

Refreshing the files

After posting the updated files to the File Share, to refresh the files:

  1. On the Administration menu, click Tools.
  2. On the Tools menu, click Refresh UI resources.
  3. The Refresh UI Resources form contains a list of the WebApps. For each WebApp, the form lists:
    WebApp Instance Name The name of the WebApp instance.
    Web Server Node ID The last two digits of the IP address for the associated Poetic Web Server.
    Status Whether the UI resource files are in the process of being updated.

    If the cell is empty, then the resource files do not need to be updated.

    If the status is "UI resource refresh requested", then the resource files need to be updated, but the WebApp has not yet copied the files from the File Share to the Poetic Web Server.

    If the status is "UI resource refresh requested - files copied", then the WebApp has copied the updated resource files from the File Share to the Poetic Web Server, but the Poetic Web Server has not yet refreshed the cache to update the files.
    Last Update For WebApps, displays the date and time when the UI resources were last refreshed.
  4. To confirm the resource refresh, click Refresh. The form is updated with a message indicating that the resources will be refreshed.
  5. Click Close.

What happens when the resources are refreshed?

When the resources are refreshed, the WebApp copies the resource files from the File Share to the Poetic Web Server, to the directory configured as the value of the RESOURCES_DIRECTORY property in web.xml.

After the files are copied, the Poetic Web Server resets its cache so that the Poetic UI uses the updated files.

It takes about 5 minutes for the resources to be updated on all of the Poetic Web Servers.