Calyx RIM Viewing 5.5 Administrator Guide

Submission Registration and Indexing

Submission registration is a Calyx RIM Viewing requirement that is performed by the user with the Administrator role. Registering your submissions, which can be done manually or automatically, allows Calyx RIM Viewing to recognize the submission.

If the automatic-registration feature is deployed, the user with the Administrator role can select one or both of the following options:

  • New: Automatic registration occurs when new submissions are added.
  • Update: Automatic registration occurs when the index.xml file updated. This typically occurs when there are changes to the existing submission.
Note: By enabling the auto registration option for newly created or updated submissions, you can choose to automatically index new or updated submissions. The auto register and auto index features help to avoid indexing and registering functionality conflicts, and are effective in both single or multiple server environments. To use these features, settings must be modified in the config.xml file.

The procedures that you follow to ensure that automatic registration functions properly are based on the scenario that applies to you. Although Scenario 1 may apply to you, if the submission type does not automatically generate an index.xml file, you may need to follow the procedures for Scenario 2. Configure the settings as applicable.

Scenario 1

The software application from which you are loading submissions is Calyx RIM Viewing and the repository from which you are loading submissions is the same location as that of the Calyx RIM Viewing repository.

For scenario 1, the indicator file is assumed to typically configured to be index.xml. If the indicator file is set to index.xml, Calyx RIM Viewing recognizes a change of the index.xml file and automatically registers new or updated submissions. This is an automated procedure and there are no specific manual procedures for you to follow.

Scenario 2

Either the software application from which you are loading submissions is not Viewing or the repository from which you are loading submissions is not the same location as that of the Viewing repository.

For scenario 2, the indicator file configured by the user with the Administrator role determines the procedures that you follow.

  • If the indicator file is set to index.xml, first copy over all files that you want Calyx RIM Viewing to recognize. When complete, copy over the index.xml file.
  • If the indicator file is set to a file other than index.xml (for example, register.txt), first copy over all files that you want Calyx RIM Viewing to recognize. Once complete, save the register.txt file in the applicable submission directory.