Unable to deploy the Workshare iManage Work 10 plugin

If you're using the iManage Work 10 for Office add-on, you can change the Compare option on the iManage ribbon to access Workshare's comparison functionality.



To direct the iManage Compare button to Workshare, you have to upload the Workshare iManage plugin to your iManage Work 10 server, which will then push the plugin out to your Work 10 client machines.

From iManage 10.0.2, the plugin is simply uploaded from iManage Control Center. For earlier versions of iManage, the upload process is less straightforward and the following guidelines may be useful.

Note: The Workshare plugin is called iManageOfficeAddin.zip and it's located in the Modules subfolder in the Workshare installation folder. By default, this is C:\Program Files\Workshare\Modules or C:\Program Files(x86)\Workshare\Modules.​

1. Check if DB schema is right

1. Launch SQL Management and connect as the admin user (typically the username for this is sa)
2. Expand the Database node and then the Tables node in the tree in the left column.
3. Check if CLIENT_APP_EXT table is present.
4. If it is not, the database is in the wrong schema.
5. If the table is present, check if there is a column named "CommentS" in the CLIENT_APP_EXT table. If it says "Comment", it is the wrong schema.

2. If schema is wrong

It is possible that the schema is wrong if the dbUpgrade tool that came with a pre-released version of Work 10.0.1.150 was used.

To attempt a fix of this:

1. Run cmd.exe in Administrator mode.
2. Navigate to the iManage installation folder.
3. Run DBUPGRADE.exe.
4. Check schema again.
5. If the schema is still wrong, create a new database.

3. Creating new DB

1. Launch SQL Management Studio and login with the admin user (usually sa).
2. Create a new database in SQL. (Set the initial size to 500 for file type = ROWS Data. Set Initial size to 100 for file type = LOG )
3. Create new ODBC connection via the ODBC manager in Windows. Ensure you are using the architecture (64 bit or 32 bit) of the ODBC manager that matches the architecture of the iManage version installed.
4. Create new DB via DBADMIN.
5. In DBADMIN, ensure:
6. flat space filing is off
7. Web Content is checked
8. Primary DB is checked
9. Restart services in Service Manager.
10. Create a new user, add this user to the 'NRTADMIN' Group, the 'ADMIN' Role, and add the 'ZIP' Type.
11. Check schema again.

4. Publishing plugin

1. Download Postman from here: https://www.getpostman.com/
2. Install and run it.
3. Go to File -> Settings and ensure that the SSL certificate verification option is disabled and the Always Open Requests in New Tab is Enabled.
4. Click on the Import Button and Import the Plugin.postman_collection.json file attached here:Plugin.postman_collection.json.
5. Click on Collections.

Obtaining the Auth Token

1. Modify Server URL in the address bar for the first PUT plugin request in address bar.
2. Enter the userid and password in the Body of the Request. This is for the admin user that was created in DBADMIN earlier.
3. Send the login PUT in Postman and copy the X-Auth Token that appears in the response.

Obtaining the Client App ID

1. Modify the body of the POST request to match the name of the Workshare iManage Plugin (in this case iManageOfficeAddin.zip)
2. Modify Server URL in the address bar.
3. Add the X-Auth token in the Header for the Request.
4. Send the POST request copy the client App-ID from the Response.

Uploading the Plugin

1. Run notepad.exe in administrator mode and open the profile.json file here: profile.json
2. Edit the profile.json file to replace all the text that says "jonathanc" to the userid of the user created in DBADMIN earlier.
3. Save this file, ensuring you choose "All Files" in Notepad when you save it.
4. Ensure the ZIP type exists in DBADMIN, if not, create it.
5. Modify Server URL in the address bar.
6. Add the App-ID in the Header of the response.
7. Add the X-Auth token in Header of the response.
8. In the Body of the Request, click the "choose file" button next to "profile". Browse to the profile.json file you saved earlier.
9. In the Body of the Request, click the "choose file" button next to "file". Browse to the plugin file. In this case, iManageOfficeAddin.zip Run the second PUT.
10. Send the Put request and the response should now contain a download URL. This indicates the plugin was successfully uploaded to the Work 10 server.

5. Check if plugin downloaded

1. Launch Word on a client machine which has iManage Work 10 for Office installed.
2. If prompted, log in to the iManage Server that was used above.
3. Ensure it’s connected to the same iManage server that was used above. Do this by clicking on the down arrow on the "Connect" button in the iManage ribbon in Word.
4. Check if plugin functionality exists.
5. If not, check if the plugin has been downloaded by going to %appdata%\iManage\Work\Plug_ins
6. If it is not there, it could be because Work 10.0.1 for Office checks with the Work Server for new plugins every 12 hours. To force Work 10.0.1 for Office to check with Work Server, try the following:

• Go to the following folder ( %localappdata%\iManage\Work\Downloads\
• Plug_ins\<your server name here> )
• Delete download.manifest file which contains the timestamp of when it last downloaded a plugin
• Restart Word
• See if the plugin gets loaded in Word

If you've followed the steps above and are still experiencing issues, please log a case with Workshare Support.