Install & Configure the Case Browser

Prerequisite

Before installing and configuring the case browser, need to make sure:

  • Nuxeo server has been installed and configured correctly
  • Patricia workspace has been created on Nuxeo server, the Nuxeo path will be used as nuxeo.firm.root in a case browser configuration file
  • Patricia SQL Server database has been configured correctly
  • You have completed the previous step of creating a Patricia XML configuration file (step 6)


On Linux/Posix system, please make sure the system encoding is set to UTF-8.


Most of the time it works to set all of these to the same value. Instead of setting all LC_ variables separately, you can set the LC_ALL. If you use bash as your shell, you can put these lines in your ~/.bashrc and ~/.profile files:


export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8
export LANGUAGE=en_US.UTF-8


To make these changes active in the current shell, source the .bashrc:


$ source ~/.bashrc


All newly started interactive bash processes will respect these settings.
To check, please run the following command:

Encoding
$ locale
LANG="en_US.UTF-8"
LC_COLLATE="en_US.UTF-8"
LC_CTYPE="en_US.UTF-8"
LC_MESSAGES="en_US.UTF-8"
LC_MONETARY="en_US.UTF-8"
LC_NUMERIC="en_US.UTF-8"
LC_TIME="en_US.UTF-8"
LC_ALL="en_US.UTF-8"


Download Case Browser zip file

Download the latest stable version of case browser:

http://www.practice-insight.com/dst/casebrowser-latest.zip
replace the actual version number in the command above.


Configure Case Browser

1. Unpack the Case Browser zip file.

For example:


unzip casebrowser-x.x.x.zip


2. Prepare settings folder and settings.xml file


In the "Patricia" workspace created previously on Nuxeo server, create a new folder named "Settings" (not including quotes). If the "nuxeo.settings.dir" property in PAT_DMS_SETTINGS database table has a different value then a different settings folder needs to be created. This can be done via Nuxeo web interface, mapped Webdav folder, or mapped samba drive.

In the "Settings" folder, create a new file and three folders:

  • settings.xml - copy from settings-sample.xml file and modify
  • 'Letterheads' folder - where letterhead files need to be stored
  • 'EmailOptions' folder - where email option templates need to be stored
  • 'Signatures' folder - where signature files need to be stored


Put letterhead files, email option template files, and signature files into the corresponding folders.

 
Lastly, check that settings.xml and make sure "letterheads", "emailOptions" and "smtpConfig" are configured according to your installation requirements. If needed, configure other items as well.


Further information about "smtpConfig", including Exchange Server 2013 configuration tips can be found here.


Here is a sample settings.xml file:

 

<!--
  This file should be renamed to 'settings.xml', and put in the
  'nuxeo.settings.dir' Nuxeo folder as configured in cb-config.xml
  The following folders are expected in the settings directory:
  Letterheads - where letterhead files are located
  EmailOptions - where email options are located
  Signatures - where signature files are located
-->
<caseBrowser>
  <letterheads>
    <letterhead name="GHF Letterhead"
                file="GHF020_Letterhead.pdf"
                pageApply="FIRST"
                applySignature="yes"
                signatureMaxWidth=""
                signatureMaxHeight=""
                default="yes"/>
    <letterhead name="Draft"
                file="Draft_Letterhead.pdf"
                pageApply="ALL"
                applySignature="no"
                signatureMaxWidth=""
                signatureMaxHeight=""/>
  </letterheads>
  <emailOptions>
    <fromOption displayName="Current User: @{CURRENT_FIRST_NAME} @{CURRENT_LAST_NAME}"
                name="@{CURRENT_FIRST_NAME} @{CURRENT_LAST_NAME}"
                email="@{CURRENT_USER_EMAIL}"
                footer="FooterOfCurrentUser.html"/>
    <fromOption displayName="Firm: mailroom@ghfip.com.au"
                name="Golja Haines Friend"
                email="mailroom@ghfip.com.au"
                footer="FooterOfFirm.html"/>
    <contentOption name="Current User Content"
                   bcc="thomas@practice-insight.com"
                   subject="Our Ref: @{OUR_REF}"
                   subject_ZH="????: @{OUR_REF}"
                   file="EmailFromCurrentUser.html"
                   file_ZH="EmailFromCurrentUser.html"
                   recipientId="4"/>
    <contentOption name="GHF Content"
                   bcc="thomas@practice-insight.com"
                   subject="Our Ref: @{OUR_REF}"
                   file="EmailFromGHF.html"
                   recipientId="7"/>
    <replyOption subjectPrefix="Re (@{OUR_REF}): "/>
    <compulsoryBccList>optionalAddressCanGoHere@yourFirm.com</compulsoryBccList>
  </emailOptions>
  <editableFileTypes>doc,docx</editableFileTypes>
  <smtpConfig host="smtp.sendgrid.net" port="465" auth="true"
              user="nuxeosmtp" pass="ten4lab9ew"/>
  <categoriesDisplay>1(0),2(1),3(0),20001(0),20002(1),20005(1),20006(1),20007(1)</categoriesDisplay>
</caseBrowser>

 

  • compulsoryBccList - Configure default BCC email addresses here, separated by comma, or semi-colon, or space.
  • editableFileTypes - Configure editable file types here. Only editable file types will be monitored by DocIntegrate. (since DMS version 1.9.5)

  • categoriesDisplay - Configure category IDs here which specifies the order of the categories to be shown in case browser. The value in the bracket indicates the category is by default expanded or not. Use 0 (zero) for uncategorised documents. Use this SQL query to retrieve the needed codes: 

    select * from PAT_CASE_LETTER_CATEGORY order by label



Exchange Configuration
In Exchange, the users whose email will be set in the From field of outgoing emails must be granted the Send-As permission on the user that is configured in smtpConfig.
See the article below for details:
http://technet.microsoft.com/en-us/library/bb676368%28v=exchg.141%29.aspx

Example Usage of categoriesDisplay node

For example, many firms they may have an 'acknowledgement' category for example, which is only useful in case of dispute but other irrelevant to case. You can put this category at the bottom of the ordering, with default to contracted.
Another example is uncategorised documents: a firm may put this at the top with a default of expanded, to prompt staff to sort any uncategorised documents when they open the case.



3. Copy Fonts from a Windows Machine

Create a new folder on Linux machine: $HOME/.windows_fonts, and then copy .TTF and .TTC files from the C:\Windows\Fonts directory on a Windows machine to the $HOME/.windows_fonts directory on your Linux machine.


For more information, please refer to http://www.aspose.com/docs/display/wordsjava/How+to++Install+True+Type+Fonts+on+Linux

4. Start case browser


Go to the unpacked case browser folder:


cd casebrowser-x.x.x

./bin/startup.sh
or, on Windows, execute:
bin\startup.bat


To verify if case browser is running in standalone mode, simply go to http://nuxeo.mycompany.com:9080/, and there should be a login page displayed.


Logging

On Windows OS, the logs will be stored in:

  • C:\ProgramData\Nuxeo\logs
  • C:\ProgramData\Nuxeo\logs\casebrowser.log

 

  • No labels