Calyx RIM Viewing 5.5 Administrator Guide

Register Submissions: Auto Registration

You can configure  Calyx RIM Viewing to register submissions automatically.

A new submission should be registered whenever it is added or updated in the application. Registering a submission, either manually or automatically, enables Calyx RIM Viewing to recognize the submission. Submission registration is usually performed by the Administrator.

Auto registration requires an indicator file (also known as a "flag file") to signal that the submission associated with the application is either new or has been updated. Calyx RIM Viewing can then recognize that the Submission should be automatically registered or re-registered.

The indicator file is typically configured to be index.xml. If the indicator file is set to index.xml, Calyx RIM Viewing automatically detects the file and processes the new or updated submissions.

To access the Auto Registration option, configure the config.xml file:

  1. Stop the Apache Tomcat service(s) if it is running.
  2. Locate the config.xml file.
    For Tomcat, you can find the config.xml file in the \I4V\WEB-INF\config subfolder of your Tomcat installation directory.
  3. Open the config.xml file in a text editor, and modify it:
    1. To enable the auto-registration feature, modify the "register.txt" value on the property element for "fileNameForAutoRegister ": <property name="fileNameForAutoRegister" value="register.txt"/> where "register.txt" is the default value. Change the default value to "index.xml".
    2. To set the auto-registration time, modify the time (milliseconds) value on the property element for "threadSleepTimeForAutoRegister": <property name="threadSleepTimeForAutoRegister" value="7200000"/> where "7200000" is the default value in milliseconds.
      The system will check for updated index.xml files at the frequency determined by this value. The recommended minimum value is "600000" milliseconds (10 minutes).
      7200000 milliseconds = 120 minutes, which means that your system checks for a new or updated index.xml file in the repository every 2 hours.
  4. Save and close the file.
  5. Start the Apache Tomcat service(s).