Knowledge: Setting up OAuth from iManage Work to Sysero
Back
    Title*Setting up OAuth from iManage Work to Sysero
    ManualAdministration
    Manual Level TwoIntegrations
    Manual Level ThreeiManage
    Created10/12/2018
    Detail

    iManage Work OAuth Configuration

    Even if you don't require iManage Work authentication for Sysero as you are say using Office365 as the authentication, you still need to configure this for user level access to iManage Work API's.  Which most of our integrations use.

    iManage Work Configuration

    On cloud instance this is achieved by sending a package zip in the required format to iManage, on premise instance can be configured manually.  See On Premise or Cloud instance section for type you require.

    Note : Need to check if id has replaced api_key and client_secret has replaced api_secret in manifest.yaml file for 10.3.  For now we recommend including both for backward compatability.

    On Premise Instance

    1. Go to iManage Work home /imcc (iManage Control Center).
    2. On the left under Settings section go to Applications.
    3. Click Add Application.
    4. Click Configure Manually (note if you do have a package zip like the cloud instance you can use it here.
    5. Set Name to Sysero OAuth Login.
    6. Set API Key, note this does not have to be a guid, but we randomly generate one for extra security.  Make a note of this for later.
    7. Set API Secret, use the auto-generate option and make a note of it for later.
    8. Click on the next page button labelled "Authentication".
    9. Set Application Type to Web.
    10. Set Client Type to Confidential.
    11. Set RedirectURL to <your sysero instance url>/login2.aspx.
    12. Leave Client Secret Expiry to Never, unless you are going to provide Sysero with a new on a schedule e.g. once a year, we recommend Never.
    13. If you want to reduce the numbe of times Sysero needs to re-authenticate with iManage then set Allow Refresh Token to true and set the days to whatever your security policy requires.
    14. Leave Access Token Expiry on 30mins.
    15. Click the next button labelled "Access".
    16. Leave on All Users unless you don't want this accessible to certain users yet.
    17. Click the next button labelled "Review".
    18. Click "Finish".

    Cloud Instance

    1. Either ask for our help creating the Package Zip, or see below:

      Note the below shows creation of the zip when you only require the authentication, if you also require iManage Browser Extensions please see seperate KB article.

      Save the below text in a file called manifest.yaml, then zip it into a file called Sysero<your client name>.zip.

      You will need 2 guid's, please remember to store these for later when configuring in Sysero.

      api_key: <replace with randomly generated guid>
      api_secret: <replace with randomly generated guid>

      # Details
      id: Sysero<replace with your client name>Extension
      name: Sysero <replace with your client name> Extension
      publisher: Sysero
      version: 1

      # Authentication
      redirect_url: https://<root url of your Client Sysero instance/login2.aspx

      # Web actions
      web_extensions:

    2. Follow the instructions in iManage Cloud Requesting new App Registration for Client

    Sysero

    1. Navigate to the Sysero instance.
    2. Go to Admin > System.
    3. Go to section Integration: iManage Work and set the iManage Work InstanceURL.
    4. On the same section set the iManage Work Default Library.
    5. Go to section OAuth Settings and scroll down to iManage Work.
    6. Change OAuth iManage Work Mode to Enabled, Visible means it will appear on login page, otherwise only be available with OAuth=worksite URL parameter or when using it with integration on Sysero Applicaiton / Data Room.
    7. If you want new internal System users to be automatically enabled for this authentication, check Auto Enable iManage Work Logon for new System Users.
    8. Set the OAuth iManage Work AppID to the API Key you stored earlier.
    9. Set the OAuth iManage Work Secret to the API Secret your stored earlier.
    10. Set the Instance Type to either Cloud or OnPrem as required.
    11. If just using for authentication, set the Token mode to Same Day Only.  It can be left on this mode for other uses, especially if you want highest security.  But if you want to reduce authentication with iManage e.g. if using it with extensions or Sysero applications, then you can set it to Standard to use the Refresh token and Use Auth Once to use any token passed if initiated from iManage Browser Extension.
    12. Any users must have Allow Logon using iManage Work Account set in Sysero Admin > Users
    13. Now go to the Sysero login page and click on the iManage Work icon to test everything is configured correctly.

    Sysero Job Scheduler

    The Job Scheduler for obvious reasons cannot use interactive user authentication to complete background tasks.  To resolve this for any application/data room where you need to run a background job, set Authentication Mode to "Own user account plus Service Account for Background Tasks (iManage Work)".  This will then give you option to set a username and password to complete these tasks as a service account.

    ManualManual Level TwoManual Level Three
    AdministrationIntegrationsOAuth
    AdministrationJob Scheduler
    Privacy Policy
    Cookies help us to improve your user experience. By using this site you consent to cookies being stored on your device. Read more...
    View or hide all system messages