Saving Assembled Documents into iManage
Saving Assembled Documents into iManage
XpressDox offers the functionality of saving documents which have been assembled from either the Desktop or the Web into iManage, using OAuth authentication and the mechanism of a Foreign File System.
Before saving any documents, XpressDox must be registered as an Application in iManage, and a Foreign File System must be configured.
Register XpressDox as an Application in iManage:
In the iManage Control center, register XpressDox as an Application. This needs to be done in order for iManage to accept login requests from XpressDox.
During this registration, a Client ID and Client Secret will be generated – you will need to enter these into XpressDox in the next section.
Enter your redirect URLs; for both Desktop and Web.
Note that the Web URL is specific to your instance of XpressDox e.g. https://us.xpressdox.com/Public/OAuthResult.aspx or https://ca.xpressdox.com/Public/OAuthResult.aspx if you are using XpressDox on one of our cloud hosted servers. Alternatively enter your custom URL if it is a locally hosted server.
Note that these URL’s are case sensitive.
Add XpressDox file types into iManage
In the iManage Control Center, click on File Types and then on Add File Type.
Add 2 new file types:
- XpressDox with an xdtpx extension
- XpressDoxM with an xdtpm extension
Note that these file types need to be setup in iManage in order for them to be opened in Word.
How to configure a Foreign File System
XpressDox>Settings>Configure>Foreign File Systems
Whenever you work in the Configuration, take note of the path at the top. You are applying settings to this folder, as well as its sub-folders. And if you intend on using this functionality in the cloud, you would need to upload the Config file from this location.
Click on New.
Then supply a Name and select a Drive letter. The name is purely a description and the drive letter is not a local or network drive, but a drive known only to XpressDox. We will use it in the auto naming of files a little bit later on.
Select iManage, and then click Use File System’s Editor.
Now fill in the OAuth details on the next dialog and click Save.
After saving the configuration, you can then press the Test button to make sure the information has been configured correctly.
Setting the path / filename in the template:
Now that XpressDox has been saved as an Application in iManage, and the Foreign File System has been configured, the next step in the process is to define how the assembled documents and datasets will be saved.
This can be done in either the configuration, or on the template.
Method A (Configuration):
Setting the save folders and file names in the Configuration will apply the settings to all templates run in that folder, as well as any sub-folders.
Go to the Standard Folders tab.
The Document Save, and Data Save folders and file names are what need to be set here; to determine both the location and file names of assembled document and file names. An example might be:
Where the L: is what was configured in the Foreign File System and represents the iManage Settings.
Method B (Template commands):
Put the document and data save settings in the template, perhaps in an included template in order to avoid having. Even if there are settings in the configuration, anything done at a template level will override config settings. These are the commands to use, and the above settings put in a template would look like this:
«Comment(Save assembled documents into iManage)» «SetSavedDocumentFolder(L:\Workspace 5\XpressDox Documents)» «SetSavedDocumentFileName(<MatterName>-<TemplateName>)» «Comment(Save assembled data sets into iManage)» «SetSavedDataFolder(L:\Workspace 5\XpressDox Datasets)» «SetSavedDataFileName(<MatterName>-<TemplateName>)»
Saving metadata with custom properties:
There are many “profile properties” that can be set for a document in the iManage system. XpressDox will default some of them, but all of the defaults, plus the custom properties, can be set inside the template using the SetCustomDocumentProperty command, as in the following examples, that set the custom1 and custom3 properties for the document:
«CreateDataElement('Custom1','MYCUSTOM1-2')» … «SetCustomDocumentProperty(XDFsProf-custom1,<Custom1>-1)» «SetCustomDocumentProperty(XDFsProf-custom3,MYCUSTOM3-1)»
Note that XpressDox will regard custom document properties with the name starting with XDfsProf- as being applied to document management systems, and the part of the name following that prefix is the name of the DMS profile property.
Run the template:
Now you are ready to save assembled documents and data sets into iManage from XpressDox.
If you are using the cloud environment, your updated config file (DocumentAssembly.config.xml) would need to be uploaded to the cloud.
Navigate to a template and click Run. The first time you do so, iManage will open. The OAuth negotation is done pre-interview, and only needs to be done. The next time you run a template you won’t see this interface appear again.
Enter your iManage credentials.
Complete the XpressDox interview and assemble the document.
The assembled document will open in Word, and the document and dataset will both have been saved into iManage following the pattern determined by the config or the template.
The assembled document will now be displayed on the XpressDox result page, and is already saved in the location determined either by the config or by the template. Clicking on the context menu will allow you to Save to Foreign File System – that indicates that you can save it to a different location in iManage.