LMOutlookAddInConfig Usage Guide

This usage guide provides the information necessary to understand and use the LMOutlookAddInConfig utility. This utility should be used to be able to support centralised management of the options available in the LawMaster Outlook Addin. 

This document contains the following sections: 

• Utility Description: this section provides general details on the utility, where it can be obtained from and introduces the utilities capabilities. 
• Command Line Arguments: this section describes the different arguments of the utility and the options that can be used with the utility. 
• Configure Subject Rules: this section provides more detail on the command line argument that is used to define the rules that can be applied to the subject of an email. 
• Exit Codes: the codes that will be returned when running the utility.

Utility Description

Outlook Add-In options for LawMaster are stored in a per-user and per-machine file "user.config". The location of this configuration file differs depending on the Add-In name and Outlook version.

A command-line configuration utility called LMOutlookAddinConfig.exe is available To enable centralised management of the options available in the LawMaster OutLook addin. This utility should be run as part of user login scripts, and will locate any relevant "user.config" files on the system and apply the settings specified using this utility. 

The program can be downloaded from: http://www.lawmaster.com.au/members/downloads/LMOutlookAddInConfig.exe

The characteristics of this utility are: 

• It is a command-line utility. 
• It must be run on the PC that is running Outlook, and will update settings only for the user executing the utility. 
• The utility will only work if the Outlook Add-In has already been run once to create the configuration file. 

Running the utility with no arguments will present usage documentation, including all input arguments, and some examples. This utility provides access to the Outlook Add-In configuration that is also accessible through the "LAWMASTER" ribbon in Outlook. It is a utility that is intended to manage deployment of changes to those settings. 

The "Subject Rules" in particular, are more easily configured or "developed" using the Outlook Addin user interface, given the ability to "test" rules on sample input. 

So a settings development scenario might work as follows: 

1. Use the "Configure Subject Rules" button in the LawMaster Outlook Add-In to create and test one or more email subject rules. 
2. Run "LMOutlookAddInConfig.exe -outputfilepaths" to find the location of the Outlook Add-In config file. If Outlook has been updated, there will be more than one folder containing a config file, the folder for the highest version number will be the one in use. 
3. Open the user.config file identified at step #2 and examine the settings, particularly those in the "MailSubjectReaderRules" setting, the "value" in this case, is one that can be passed directly to LMOutlookAddInConfig.exe using the -outboundsubjectrules argument. 

Command-Line Arguments 

This section describes all of the command-line arguments that can be used with the utility. The table names the argument and then provides a description of how this argument can be used. The arguments are presented in alphabetical order for ease of reference.

For example, the command:

"LMOutlookAddInConfig.exe -DEFAULTSERVER "PracticeManagement Production" -OUTBOUNDSHOWSAVE false -COMPENSATEONLINEMODE false" 

Sets the following options for the current user on the current computer: 

• The default server becomes PracticeManagement Production 
• The user will not be shown the dialogue to save the email when an email is sent 
• The Outlook client has been configured to operate in cached mode, LawMaster’s recommended option, so there is no need to compensate for the potentially slower response from the mail data store that may be experienced in direct mode.

These options will be shown in the LawMaster ribbon in Outlook as follows: 

Any property not specified as part of running the utility will remain configured with its existing value. Any change to the settings in the LawMaster ribbon from within Outlook will be saved in the user.config file. 

If no argument is provided to the utility a basic usage guide will be output summarising the information in this document. 

Another Example with Subject Rules:

C:\>LMOutlookAddInConfig.exe -OUTBOUNDSUBJECTRULES [{'FileType':'Matter','RuleType':'Regex','Rule':'matter.{0,3}[0-9]+'}] 

Configure Subject Rules 

The option to specify outbound subject rules is provided using the "-OUTBOUNDSUBJECTRULES" argument. Content for this input is a JSON serialised array of settings objects as shown in the following table.

"Contains" Rule

• Ignores the punctuation characters , : ; - 
• Is not case sensitive. 
• The next whole number representation *after* the keyword in the subject determines file number. 
• Regular expression. 
• Case-sensitive. 
• *All* numeric digits included in the regex result are converted to file number. e.g. if a regex matches "matter 12 44", the file number will be 1244.

"Regex" Rule

Any regular expression that .NET is capable of processing is valid. Microsoft’s documentation is at https://msdn.microsoft.com/en-us/library/hs600312 (v=vs.110).aspx

Example Imput

[ 

        { 

            'FileType':'Matter', 

            'RuleType':'Regex', 

            'Rule':'matter.{0,3}[0-9]+' 

        }, 

        { 

            'FileType':'Request', 

            'RuleType':'Contains', 

            'Rule':'request' 

        } 

]

Exit Codes

This section briefly describes the codes that may be returned from executing this utility in the %errorlevel% variable. The codes are shown in the following table. 

Appendix: Sample Outlook Addin Configuration File Layout 

This appendix contains a typical configuration XML file that will be located in a directory within a user’s local windows AppData directory. The name of the directory is generated by the LawMaster Outlook Addin can be identified by using the following command: 

LMOutlookAddInConfig –OUTPUTFILEPATHS 

If more than one version of the Outlook Addin has been used there will be more than one file path returned. The directory showing the latest version number will be the version of the file currently in use in configuring the Addin. 

A typical user.config file in this directory will look similar to the following: