Skip to main content
iManage integration

Setup and manage your integration

Ryan Turner avatar
Written by Ryan Turner
Updated over a week ago

This article will help you setup and manage your iManage integration

To understand how the integration works for users, read this article


Key information


How the integration works


Using iManage’s Universal API, a direct connection is created from Legatics to your iManage Work environment. This requires bi-directional network access to iManage. So the connection crosses your firewall.

If you need a technical understanding of how the integration works, consult our security whitepaper or our dedicated iManage overview document (both available by contacting your account manager).

You can connect multiple iManage servers to Legatics. So there's no issue if (for example) you've got an EMEA server for your EU users and a USA server for your USA users.


Connection options


We integrate with Cloud iManage and on-premise / older private iManage cloud severs. Learn about the differences below.

☁️ Cloud iManage

💽 On-premise

Explanation

iManage's new multi-tenanted cloud system

iManage's older "Work Servers" that are either hosted:

  • in the cloud

  • on-premise

URL endpoint

cloudimanage.com

imanage.work

(or something unique to your company)

Adding apps in iManage

Select from list of registered applications

Manually through a installation package


Limitations


Keep these in mind before you start the integration process

URLs can't be edited after creation

URLs are unique identifiers for your iManage server. After you add a URL for your on-premise iManage server, or a sub domain for your Cloud iManage server, you can't change the URL.

So, if you got it wrong, you'll need to remove the iManage server and start again.

URLs can't specify ports

If you're setting up an on-premise integration, then the integration won't work if you include arbitrary ports.

If you want to include a port in your URL, reach out to us as support@legatics.com

Firewall access

Your firewall may restrict external applications from accessing iManage. If it does, then you'll need to allow Legatics to access iManage (by reference to our IP address).

If you need this, reach out to us at support@legatics.com. We'll send you the IP address so your IT team can get this setup.


Connecting an iManage server


☁️ Cloud iManage

This section only applies if your iManage is hosted on Cloud iManage (ie cloudimanage.com)

If your iManage isn't located on Cloud iManage, then follow the "On premise" steps set out below.


Step 1: Add Legatics as an application in iManage


Your iManage help articles will help you understand how to add an application. We've also got step-by-step guidance below.

  1. Navigate to iManage Control Centre

  2. Navigate to Applications in Settings

  3. Select Add Application

  4. Find and select Legatics 2

  5. Select Authentication > Access > Review > Finish

There are more controls available to you at this point. Consult your iManage Administrator to understand if any such controls should be applied.


Step 2: Add your Cloud iManage server to Legatics


  1. Log into the Admin System, go to "Integrations" from the sidebar, then go to the "iManage" page and press "Add server"

  2. In the pop-up that appears, select "Cloud iManage" and:

    • Give your server a name

    • If you have one, add the subdomain

    • Press Add server

  3. Your server is now connected, but isn't available to users. At this point, you may want to make configurations (see below). If not, then to make the server available to users, toggle it on!


💽 On-premise


This section only applies if your iManage is not hosted on Cloud iManage (ie the endpoint isn't cloudimanage.com)

If your iManage is located on Cloud iManage, then follow the "Cloud iManage" steps set out above.


Step 1: Add Legatics as an application in iManage


This is a manual process. These iManage help articles will also help to understand how it works.

A - Generate a YAML file

1. Create a .txt file

2. Copy and paste the below into the .txt file and fill out the following placeholders:

  • API_key

  • legatics_URL

id: legaticsapp
name: Legatics 2
api_key: [INSERT HERE]
publisher: info@legatics.com
organization: Legatics Limited
version: '2'
redirect_url: https://api.{legatics_URL}/auth/v0/oauth2/authorized

You'll need to generate an API key. API keys must be unique and 32 digits long

The legatics_URL depends on what Legatics instance you are using. You can find your URL from the Accounts page (⚠️ make sure you exclude https://)

3. Save the .txt file as a YAML file

  • Click on the file

  • Select Save as from dropdown

  • Name the file legaticsapp.yaml

  • Save as type "select all files"

4. Save the txt file into a ZIP folder

Call the folder manifest.zip

B - Configure iManage with YAML file

Learn about how to do this by following this iManage support article

1. Navigate to iManage Control Centre

2. Navigate to Applications in Settings

3. Select Add Application > Upload package

4. Upload the YAML file you created above

5. Select Authentication > Access > Review > Finish

There are more controls available to you at this point. Consult your iManage Administrator to understand if any such controls should be applied.


Step 2: Add your on-premise server to Legatics


  1. Log into the Admin System, go to "Integrations" from the sidebar, then go to the "iManage" page and press "Add server"

  2. In the pop-up that appears, select "On-premise" and fill in each field, then press Add server. You will see the following fields.

    1. Name: This is shown to users, to help them differentiate the iManage servers you may have connected.

    2. URL: The base URL of your iManage server. For example legatics.imanage.work. We fix https:// in the URL, so don't include this. In addition, the URL you provide can't include arbitrary ports. If you want to include a port in your URL, reach out to us as support@legatics.com.

    3. API URL: Adding an API URL gives you the ability to make the REST API accessible to the Legatics backend, while having the iManage file picker and authentication endpoints accessible only from within your network (including any remote worker VPN provision).

      This can help to improve the security position of the integration. This is because the user must authenticate and initiate transfers when on your network and only after doing so can the Legatics backend communicate with the iManage API to undertake the transfers. Consult our dedicated guide for more information.

    4. Client ID: This is generated when you connected Legatics to iManage in step 1.

    5. Client secret: This is generated when you connected Legatics to iManage in step 1

  3. Your server is now connected, but isn't available to users. At this point, you may want to make configurations (see below). If not, then to make the server available to users, toggle it on!


Configuring your iManage server


Once your iManage server is connected, you can configure it in a number of ways. The section below sets out the configurations available.


✋ Restrict to specific Members


Your iManage server is only available to your Members (across the entire instance). You can further restrict what Members can use the iManage integration for a specific server.

If you restrict to specific Members, then no other Member can (for the restricted server) use any of the iManage functionality.

We only recommend using this feature when you're testing that the integration is working as expected.

To restrict a server to specific members

  1. Find the iManage server you want to edit and toggle Restrict to specific users

  2. Search for the Member(s) who want to restrict the server to (you can search by user name or email) and press on the Member. You can then repeat this for any additional Members. Press Save to apply your changes.


🛑 Disable


There may be times when you need to disable an iManage server

When you disable a server, users won't be able to use the iManage integration.

But the links to documents in iManage are retained. So if you re-enable the integration, the user will see those links again! Magic 🪄

To disable a server, press the "Enable" toggle


🗑️ Remove server


This can be helpful if you setup the integration incorrectly

If you remove a server, the links to those documents are lost. But the documents in Legatics are retained.

To remove a server, find the server you want to remove, then press the:

  • "Remove server" button at the bottom of the server page, then

  • the "Remove server" in the confirmation modal that appears.


Troubleshooting


You're unlikely to run into troubles when connecting with Cloud iManage. Issues are more likely to occur when you're connecting to an on-premise server.

Content is blocked

Issue

You try to get a file from iManage or save a file from iManage, a window opens and says "This content is blocked"

What causes it

Your internal security settings, such as a browser security setting, network firewall, or content filter.

How to fix it

  • Check with your network administrator and ensure that traffic from Legatics to your iManage server is not being blocked by a firewall or proxy

  • Ensure that necessary ports are open for communication between the Legatics and the iManage server.

  • We've got more technical details for your network administrator about the source and destination ports, and our IP address. Contact us at support@legatics.com to obtain this.

Something went wrong

Issue

You try to get a file from iManage or save a file from iManage, a window opens and says "error.somethingWentWrong"

What causes it

There's a few main causes:

  1. Incorrect URL settings

  2. Firewall or proxy blocking

How to fix it

  1. Verify that the URL is correct and points to the correct server and port, and ensure that any required paths or endpoints are correctly specified

  2. Check your firewall and proxy settings to ensure that traffic to and from the Legatics server is allowed.

We've got more technical details for your network administrator about the source and destination ports, and our IP address. Contact us at support@legatics.com to obtain this.

Did this answer your question?