Adding Applications (On-Premises)

Based on the type of application to add, use the appropriate method to add the application in iManage Control Center:

  • Adding an application package: T hird-party application developers or internal developers provide an application as a zip file package. This application package extends or customizes iManage Work and must contain the following:

    • A manifest file manifest.yaml that contains the information about the client application to be uploaded to iManage Work. For more information about the format and contents of the manifest file, refer to Extensions for iManage Work in iManage Work V2 API Developers Guide.

      NOTE:

      As a best practice, an application developer should provide all the information required for OAuth 2.0 configuration in the manifest file to the administrator. This streamlines the registration process for an administrator.

    • The collection of all files needed to run the application or web page.

  • Adding an application manually: The application developer provides the information for registering an application to the iManage Control Center administrator. This application just accesses data from iManage Work and does not have a package to upload.

    An application that just accesses data from iManage Work and does not have a package to upload must also be registered on iManage Work Server before it is available to the users. The information to register such applications is provided by the application developer to the iManage Control Center administrator through an email or any other communication mode.

Adding an application package

NOTE:

For on-premises iManage Work environments:

  • A WebDB (also known as a web database or a configuration library) must be configured in iManage Work to store the applications.

  • A DOC class must be defined in iManage Work before adding an application. When adding an application, iManage Control Center generates a document profile that uses DOC class. If no DOC class is defined in iManage Work, the application cannot be added. See Classes / Subclasses for more information.

  1. Navigate to Settings > Applications to view the list of applications currently registered.

  2. Select + Add Application to upload a new application. The page to upload a package appears.

    Figure: Add Application

    images/download/attachments/61278449/Register_with_package.png

  3. Select Upload Package, browse to the local directory, and select the package. The Configuration page appears which contains the basic information about the application.

    Figure: Configuration

    images/download/attachments/61278449/image2020-2-10_9-1-7.png

    The information on the Configuration page is retrieved automatically from the application package provided by the application developer. If required, you can edit the Name and Description. All the other properties are read-only and cannot be edited.

    Table: Configuration details

    Field

    Description

    Name

    Application name.

    Description

    Additional information about the application.

    API Key

    Application key.

    API Secret

    Secret key for an API. Select Auto-Generate to generate the key.

    Publisher

    Name of the organization publishing the application.

    Website

    Web address of the publisher.

    Type

    Type of connectivity

  4. Select Authentication to open the Authentication page which contains the information required for authorizing the application.
    Figure: Authentication
    images/download/attachments/61278449/image2020-2-10_9-1-54.png
    If the application requires the user to authenticate to iManage Work, set iManage Work Authentication Required? to Yes.
    The following information is retrieved automatically from the package provided by the application developer.

    CAUTION:

    Change the editable properties in Authentication details only if instructed by the application developer or iManage support team.

    Table: Authentication details

    Field

    Description

    Application Type

    • Native: Application installed and accessed on a user’s computer or device.

    • Web - Application running on a web server and accessed through a website.

    Client Type

    • Public: Application NOT capable of protecting its client secret. For example, a desktop or mobile phone application that cannot securely store the client secret.

    • Confidential: Application capable of protecting its client secret from users and performing secured authentication on iManage Work Server. For example, a web application that has the client ID and secret stored on its own web server.

    Redirect URL

    URL to redirect the user to the client application after iManage Work Server successfully authorizes the application. You can add multiple redirect URLs by selecting +. For more information, see OAuth 2.0 authentication.

    Client Secret

    Secret key generated during the application registration process to authenticate with iManage Work Server.
    Click Generate to auto-generate a secret the first time for registering the application.

    Client Secret Expires

    Enter a date when the client secret will expire.
    Select Never Expires if you want no expiry date for the secret.
    If the client secret expires during a session, the current session continues. New authentication attempts will fail after the secret has expired. To resolve an expired client secret, either the application developer should provide a new client secret or update its date of expiry.

    Allow Refresh Token

    When set to Yes, allows the application to obtain a new access token when the existing access token expires, without prompting the user for authentication.
    Default: No

    Refresh Token Expiry

    Duration in days for which a refresh token remains valid.

    NOTE:

    To configure this field, you must enable the Allow Refresh Token option.

    Default: 365 days

    Access Token Expiry

    Duration of inactivity allowed in minutes before invalidating an access token of a user.
    Default: 30 minutes.

  5. Select Access to configure the access privileges.

    You can secure an application to selected users in the organization. This is helpful when you have a pilot group who is testing a new functionality or if you have an application that is specifically meant for a certain users. For example, an application for tracking patent deadlines that only an IP group uses. images/download/attachments/61278449/Screen_Shot_2019-09-25_at_3.34.17_PM.png

  6. Select one of the following application access options:

    • All users: Select this option to provide access to all the available users.

    • Custom: Search and add the specific users and groups to provide the access.

  7. Select Review to review the configurations for application package.

  8. Select Finish to complete the application upload.

Adding a package manually

NOTE:

For on-premises iManage Work environments, you must have a WebDB (also known as a web database or a configuration library) configured on iManage Work to store the applications.

  1. Navigate to Settings > Applications page; the list of applications registered on iManage Work Server appears.

  2. Select +Add Application to register a new application. The page to add a new application appears.

  3. Select Configure Manually to configure the application settings.

  4. Enter the configuration details provided by the application developer. For more information, see Configuration Details.

  5. Select Authentication and enter the information on this page per the application developer's instructions.
    If the application requires to be authenticated to iManage Work Server, select Yes and refer the table Authentication Details and enter the information.

  6. Select Access to configure access privileges for the users.

  7. Select one of the following application access option.

    • All users - To provide access to all the available users.

    • Custom - T o search and add the specific users and groups.

  8. Select Review to review the configurations for application package.

  9. Select Finish to complete registration of the application.