Knowledge: Sysero iManage Integrations
Back
File:
    Title*Sysero iManage Integrations
    Created27/09/2018
    Detail

    iManage Worksite 10 Integration Details

    We integrate with iManage Worksite 10 in the following ways:

    1. Login to Sysero via Worksite OAuth.
    2. Upload of assembled and attached documents from Sysero to Worksite Workspace.
    3. Right Click Application Extension from Worksite.  Pass through Worksite document / profile information to Sysero forms.
    4. Lookup of values using REST calls.

    Worksite OAuth Configuration

    OAuth configuration is also required for the uploading of documents to worksite from Sysero, if you have set Authentication Mode of the Dataroom to "Own User Account", as it will use the users Access Token to connect to the Worksite API.

    OAuth can be set in three modes, by default it is disabled:

    1. Disabled
    2. Enabled Hidden (not shown on Login page, but can be used by upload etc.)
    3. Enabled Visible

    Please see the following instructions for setting up OAuth Setting up OAuth from Worksite to Sysero

    Uploading of Documents from Sysero to Worksite

    This is done via what are known as Data Actions in Sysero.  Data Actions can be run as buttons on the form or as part of an automated workflow step.

    To configure you need to go to Settings for the Data Room that will be using this feature and follow the steps below:

    1. Go to Office Integration Settings.
    2. Click on the Worksite Integration Settings tab.
    3. Select the Outbound integration type:
      • Worksite Submit Only : Original document stays as is in Sysero, copied only to Worksite.
      • Worksite Submit and Replace with Worksite IWL : Document uploaded then replaced with IWL link.
      • Worksite Submit and Link to Worksite Document : Document uploaded then when accessed passed via REST API from Worksite to Sysero for download.
    4. Set Database Name, Server Name, Worksite URL and one of the Authentication Modes:
      • Use Service Account
      • Use Impersonation Account
      • Own User Account (strongly recommended).
    5. If using Own User Account no need to fill out username or password.
    6. If using Own User Account got to Admin > Data Room > Advanced Settings > Feature Settings and tick OAuth : Validate Worksite token on access.  This will make sure the Access Token is valid before someone starts completing a form.

    Next step is to setup the Data Action, Admin > Data Actions.  When creating new data action choose type "Upload Documents", then set DM System to Worksite 10.  There is guidance on using these on the admin page, for more information please contact Sysero support or Reseller.

    Right Click Extension

    Below is just an example further details are available in iManage Developer Documentation.

    First you need to upload the extension to worksite, this details how to create the zip (zipped example attached):

    1. Create a temporary folder called SyseroExtension.
    2. In that folder create a sub folder called web_extensions.
    3. In that sub folder create a text file named something like SyseroTest.yaml.
    4. File needs to contain the following:
      1. id: SyseroTest (match file name without extension)
      2. title: Sysero Test (what will appear in iManage)
      3. type: window
      4. url: http://www.example.com/worksite/url.aspx?id=demo
      5. menu: [folder, workspace]
    5. In the SyseroExtension folder create a file called mainfest.yaml.
    6. File needs to contain the following:
      1. api_key: copy your own GUID here (note down)
      2. api_secret: copy your own GUID here (note down)
      3. # Details
      4. name: SyseroTest
      5. publisher: Sysero
      6. version: 1
      7. # Authentication
      8. redirect_url: http://www.example.com/login2.aspx
      9. # Web actions
      10. web_extensions:
      11. - SyseroTest
    7. Note there can be multiple lines of web_extensions in same zip, just use unique name.
    8. Zip file up.
    9. Go to Worksite home /imcc.
    10. Go to Configure > System Setup > Applications.
    11. Click Add Application.
    12. Upload zip file.

    How the extension works:

    1. You configure the iManage extension to point to a URL on the Sysero server e.g. http://www.example.com/worksite/url.aspx?id=demo
    2. The ID will match a setting in Sysero > Admin > System > Worksite Settings.
    3. App setting may look something like one of these:
    4. The process the above and replace the Psuedo values between [] with the correct values from Worksite.
    5. You can always use the External field name if set as an alternative to the static database field name.
    6. Note : When using the worksiteupload.aspx you can map fields to form data using Admin > Data Room > Advanced Settings > Worksite Integration > Inbound Field Mappings.

    REST Value Lookup

    Please note when using the data action it is recommended the data room using it has the feature "OAuth: Validate Worksite token on access" enabled.  Also that it has any Worksite Settings required to be set.

    Creating the data action:

    1. Choose data action type of RESTOAuth.
    2. Target site example of client matter lookup, libraries/devws10/customs/custom1/[!ClientID!]/custom2/search.  iManage / Worksite API reference will provide others.  [!!] values are input values that are swapped out
    3. Node XPath of //data is required in this case.
    4. Set OAuth type to Worksite10
    5. Select correct data room.
    6. Input mappings, in this case add ClientID pointing to a field on the form containing it as the lookup value.
    7. Output mappings, in the case of this it will find id and description that you can map to fields or just show on selection grid.
    8. Additional settings, set JSON to True.

    Known Issues

    • 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.
    ManualManual Level TwoManual Level Three
    AdministrationIntegrationsiManage
    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...
    Back to Top
    View or hide all system messages