Configure the Document Repository

Configuring the Document Repository is performed via the administration utilities.  When used, this needs users to have appropriate permissions to the security permission key named SR_REPORT_REPOSITORY_ACCESS.

By default, the repository stores documents within the database, but in a similar manner to attachments, documents held within the repository may be stored on the file system.  This is controlled with the behavior settings named DOCUMENT_REPOSITORY_OPT, DOCUMENT_REPOSITORY_DMAX and DOCUMENT_REPOSITORY_ROOT.

If you initially store documents internally, and wish to move them to the file system, the Java utility program named doRepositoryDocumentMigration performs that task.  There are versions of this utility to run on Linux (doRepositoryDocumentMigration.sh) and on Windows (doRepositoryDocumentMigration.bat).

You must set the correct values for the settings DOCUMENT_REPOSITORY_OPT, DOCUMENT_REPOSITORY_DMAX and DOCUMENT_REPOSITORY_ROOT before running this utility.

The following parameters are required when running the utility:

  • JAVA_HOME - the path to your Java installation
  • TOMCAT_HOME - the path to your Apache Tomcat installation
  • EV_BASE - The path to your ExtraView installation

The following parameters are optional:

  • -testOnly - this runs the utility without any modifications being made to the database.  The documents are created on the file system, but not deleted from the database
  • -doOne - this will migrate a single repository document and then stop.  Use this parameter to validate that the document is created in the correct place and that all metadata is correctly updated
  • -migrate - this migrates the documents in their entirety, unless -doOne is specified in which case only a single document is migrated
  • -delete - deletes the document from the database if it was successfully migrated.