Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes the setup of an independent OCR appliance for use with the Extended DMS environment. DMS will access the OCR appliance and issue commands so that OCR is performed. The advantages are that the DMS appliance's resources (CPU, RAM) are thus not consumed by the OCR processing.

OCRKit Professional is a low cost multi language OCR utility with good performance and output quality. While . Given it's multi core architecture, it has also good performance. While OCRKit is available for MacOS  and Windows, the current guide only explains a setup using the MacOS version given the current Windows version does not include CLI access. Get OCRKit Professional from here: http://www.ocrkit.com.

Components and setup required:

  1. Recent version of MacOS X running in VM or on bare metal and recent version of OCRKit installed. Sharing setup Professional installed in /Applications/ ("OCRKit appliance")
  2. OCRKit appliance must be set up to allow remote administration using ssh from the DMS appliance's console .

 

 

 

 

 

Scripts:

  1. by public key authentication (Sharing setup: Remote administration)
  2. DMS appliance needs /<storagepath>/nuxeo/data/ and /<storagepath>/nuxeo/tmp/ NFS-exports
  3. OCRKit appliance must mount these NFS-shares to /var/lib/nuxeo/data/ and /opt/nuxeo/server/tmp/ respectively and make suer these mounts will be auto mounted (kept alive)
  4. In DMS appliance, place the below script "ocrKit" in /<storagepath>/nuxeo/scripts/ and make executable (chmod +x)
  5. In DMS appliance, place the DMS appliance's public key files "id_rsa" and "id_rsa.pub" in /<storagepath>/nuxeo/ssh/ 
  6. Set key "ocr.engine.name" in PAT_DMS_SETTINGS table of Patricia db to "ocrkitmac"

 

 

 

 

 

Scripts:

  1. Make sure you replace <<OCRKit.appliance.name>> with proper FQND or IP address:
    Code Block
    languagebash
    #!/bin/bash
    echo "variables $1 $2"
    ssh admin@<<OCRKit.appliance.name>> "/Applications/OCRKit\ Pro.app/Contents/MacOS/OCRKit\ Pro --format text --output $1 $2"
  2. Make sure in "commands.conf" file of auto-deploy client specific repository, the following commands are added to the nuxeo container definition:

    Code Block
      add_volume "/var/data/nuxeo/ssh" "/home/nuxeo/.ssh"
      add_volume "/var/data/nuxeo/scripts/ocrKit" "/usr/bin/ocrKit"
  1. Fork Default template to client specific repository with <clientname>;
  2. Edit configuration files in client specific git repository as required for specific client’s DMS environment – make sure changes are pushed to repository;

     

    git clone ssh://git@stash.practiceinsight.io:7999/dmsclient/${clientname}.git ~/deploy/config
  3. Clone deploy script repository to ~/deploy/deploy_script/ to store deploy script logic files;

     

    git clone ssh://git@stash.practiceinsight.io:7999/dmsclient/deploy_script.git ~/deploy/deploy_script
  4. Clone restore script repository to ~/deploy/restore_script/ to store restore script logic files;

     

    git clone ssh://git@stash.practiceinsight.io:7999/dmsclient/restore_script.git ~/deploy/restore_script

Steps to create empty nuxeo repository:

Go to the  ~/deploy/restore_script/ and run "./create.sh" script.

After successful finish of the script you will have an empty nuxeo repository with Patricia workspace created with proper permissions and a settings.xml template for client environment specific modification.

The DMS containers can now be deployed and the DMS started up by cd'ing into  ~/deploy/deploy_script/ folder and running "./deploy.sh" with necessary options. For options, see here.

Steps to restore from backup (Transfer from non-zc to zc):

Go to ~/deploy/restore_script/ to modify config.sh configuration file to specify the paths to the backup files, and run "./create.sh" script.

After successful finish of the script you will have a DMS restored from the backup.

The DMS containers can now be deployed and the DMS started up by cd'ing into  ~/deploy/deploy_script/ folder and running "./deploy.sh" with necessary options. For options, see here.