{"id":2111,"date":"2019-07-14T13:52:32","date_gmt":"2019-07-14T03:52:32","guid":{"rendered":"https:\/\/docassist.com.au\/?p=2111"},"modified":"2022-09-07T17:18:22","modified_gmt":"2022-09-07T07:18:22","slug":"imanage-work10-from-the-developers-perspective","status":"publish","type":"post","link":"https:\/\/docassist.com.au\/imanage-work10-from-the-developers-perspective\/","title":{"rendered":"iManage Work10 from the Developer’s Perspective"},"content":{"rendered":"

by Nissy Abraham<\/a>, Developer<\/strong><\/p>\n

The previous versions of iManage up to 9.x provided us with the ability to add dll references for iManage which enabled us to customise word in VBA to use iManage functionalities. We could capture iManage events in Word VBA using the corresponding references. \u00a0But this is not the case in Work 10, where there is no possibility to get those Worksite events and properties in VBA unless through the plugins and RESTAPI\u2019s.<\/p>\n

The iManage Work extensibility framework enables you to create .NET plugins for iManage Work 10 for Office. \u00a0Using these plugins, you can extend and customize the functionality of the iManage Work 10 for Office add-in.<\/p>\n

iManage Work 10 for Office plugins are .NET assemblies loaded by the iManage Work 10 for Office add-in to extend and customise its functionality. \u00a0The plugins are downloaded automatically from the Work 10 application Server for each distribution. They can catch the events when an action is performed on the application or a form is about to load, modify the document metadata, retrieve the Office document object, and so on.<\/p>\n

Creating a Sample Plugin for Microsoft Word<\/h2>\n

Sample: Hello World<\/p>\n

This plugin displays a “Hello World” message whenever Microsoft Word starts.<\/p>\n

    \n
  1. Install iManage Work 10 for Office (version 10.0.1 or later).<\/li>\n
  2. In Microsoft Visual Studio, create a new Visual C# project with unique Class Library (.NET Framework) namespace, for example,<\/li>\n
  3. Add references to iManage Work 10 for Office libraries iwto.dll and IWInterfaces.dl. These DLLs are available in the install directory of iManage Work 10 for Office.<\/li>\n
  4. Add a reference to System.Windows.Form under Work10OfficePlugin <\/em>by right-clicking\n
      \n
    1. References-> Add Reference ->Assemblies ->Framework ->select System.Windows.Forms.<\/li>\n<\/ol>\n<\/li>\n
    2. Rename the default C# file cs<\/em> to HelloWorld.cs<\/em><\/li>\n
    3. Create a .NET class for the plugin in cs<\/em>, for example, WordPlugin1.<\/em> This class must derive from iManage.Work.Tools.PlugInBase<\/em><\/li>\n<\/ol>\n

      Include the following in the plugin host event in the Initialize method.<\/p>\n

      HelloWorld.cs<\/strong><\/p>\n

      \u00a0<\/strong>using System;<\/p>\n

      using iManage.Work.Tools;<\/p>\n

      namespace Work10OfficePlugins<\/p>\n

      {<\/p>\n

      public class WordPlugin1 : PlugInBase<\/p>\n

      {<\/p>\n

      public override bool Initialize(IPlugInHost host)<\/p>\n

      {<\/p>\n

      PlugInHost = host;<\/p>\n

      PlugInId = “myId”;<\/p>\n

      host.Startup += this.onStartup;<\/p>\n

      return true;<\/p>\n

      }<\/p>\n

      private void onStartup(object sender, EventArgs args)<\/p>\n

      {<\/p>\n

      System.Windows.Forms.MessageBox.Show(“Hello World!”);<\/p>\n

      }<\/p>\n

      }<\/p>\n

      }<\/p>\n

      Sideload the plugin in the Development environment:<\/p>\n

        \n
      1. Create a resource file by right-clicking the project txt <\/em>by right-clicking the project Work10OfficePlugins<\/strong>-> Add -> New<\/strong> Item<\/strong> -> Text File<\/strong> -> Add<\/strong>.<\/li>\n
      2. Specify the MAC address of the development machine. Up to 20 MAC addresses can be provided in this config file.<\/li>\n
      3. Right-click sideload_config.txt and select ->Properties<\/strong> -> Build Action<\/strong> -> Embedded Resource<\/strong><\/li>\n<\/ol>\n

        sideload_config.txt<\/strong><\/p>\n

        {<\/p>\n

        data: {<\/p>\n

        “macaddresses” : [ “00-0C-29-D4-BD-92”, “C1-12-83-07-3D-4C” ]<\/p>\n

        }<\/p>\n

        }<\/p>\n

          \n
        1. Digitally sign the assembly:<\/li>\n
        2. Right click the project Work10OfficePlugins -> Properties -> Signing -> Sign the assembly ->. Choose a strong name key file -> \u00a0New<\/li>\n
        3. Add a Key file name of your choice, for example, plugin<\/li>\n
        4. Protect my key file with a password<\/li>\n
        5. Enter a password and select OK<\/strong><\/li>\n
        6. Build the project by right-clicking the Work10OfficePlugins project and selecting Build. Ensure that there are no errors in the build.<\/li>\n
        7. Navigate to the project directory where the compiled assembly Work10OfficePlugins.dll is.<\/li>\n
        8. Copy Work10OfficePlugins.dll to %localappdata%\/iManage\/Work\/plug_ins.If the plug_ins directory is not available, create it and then copy the assembly into it.<\/li>\n
        9. Register the plugin:<\/li>\n
        10. Add the wplugins.manifest file by right-clicking Work10OfficePlugins and selecting Add -> New Item-> Application Manifest File -> Add<\/li>\n
        11. Add the following assembly details in the wplugins.manifest file<\/li>\n<\/ol>\n

          \u00a0wplugins.manifest<\/strong><\/p>\n

          <?xml version=”1.0″ encoding=”utf-8″ ?><\/p>\n

          <configuration><\/p>\n

          <word><\/p>\n

          <entrypoints><\/p>\n

          <entrypoint class=”Work10OfficePlugins.WordPlugin1″ resource=”<\/p>\n

          Work10OfficePlugins.sideload_config.txt”><\/p>\n

          <assemblyIdentity name=”Work10OfficePlugins” version=”1.0.0.0″<\/p>\n

          publicKeyToken=”” language=”neutral” processorArchitecture=”msil” \/><\/p>\n

          <provider name=”iManage”>iManage Office Plug In #1<\/provider><\/p>\n

          <\/entrypoint><\/p>\n

          <\/entrypoints><\/p>\n

          <\/word><\/p>\n

          <\/configuration><\/p>\n

            \n
          1. Copy the file to wplugins.manifest %localappdata%\/iManage\/Work\/plug_ins.<\/li>\n
          2. Start Microsoft Word. The “Hello World ” message is displayed.<\/li>\n<\/ol>\n

            Deploying the plugins<\/h2>\n

            In the development environment, plugins are loaded to iManage Work Server using a sideloading mechanism as shown in the above example. Sideloaded plugins are authorized to run on up to twenty computers, identified by the MAC addresses of their network cards<\/p>\n

            In the production environment, the plugins can be registered and uploaded to iManage Work Server by the administrator using REST APIs or iManage Control Center<\/p>\n

            Using iManage Control Center<\/h3>\n

            iManage Control Center (iCC) enables the administrators to upload iManage Work for Office plugins to iManage Work Server.<\/p>\n

            The developer creates a zip file which contains the plugin assembly files and manifest file and sends it to the administrator. Using iCC application, the administrator defines security settings on the plugin, and uploads it to iManage Work Server.<\/p>\n

            Creating Manifest File<\/strong><\/p>\n

            You need to provide the information about your Office plugin to iManage Work server in file manifest.yaml. Identify a unique ID for your plugin and create the following manifest file in the YAML format as<\/p>\n

            manifest.yaml<\/p>\n

            # Information about Office plugin<\/p>\n

            id:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 UniqueIDForMyProject<\/p>\n

            name:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Sample Office plugin<\/p>\n

            publisher:\u00a0\u00a0\u00a0 XYZ Inc.<\/p>\n

            version:\u00a0\u00a0\u00a0\u00a0\u00a0 ‘1’<\/p>\n

            # Name of the extensions<\/p>\n

            desktop_extensions:<\/p>\n

            – iwtoTestPlugIn.WordPlugin<\/p>\n

            – iwtoTestPlugIn.ExcelPlugIn<\/p>\n

            – iwtoTestPlugIn.PowerPointPlugIn<\/p>\n

            – iwtoTestPlugIn.OutlookPlugI<\/p>\n

            iManage Work REST APIs<\/h3>\n

            The iManage Work REST APIs enable users to perform operations such as viewing documents, browsing workspaces, and searching for documents on the iManage Work server through the HTTP protocol. Several operations that are performed through the iManage Desktop client applications can be performed and\/or automated using iManage Work REST APIs.<\/p>\n

            More information regarding Work 10 upgrade is available from<\/p>\n

            https:\/\/imanage.com\/support<\/a><\/p>\n

            Need Help?<\/h1>\n

            Please get in touch with us should you need any help with your Work 10 upgrade.<\/p>\n

            We have years of experience with this product and know the intricate details of how to go about your upgrade.<\/p>\n","protected":false},"excerpt":{"rendered":"

            by Nissy Abraham, Developer The previous versions of iManage up to 9.x provided us with the ability to add dll references for iManage which enabled us to customise word in VBA to use iManage functionalities. We could capture iManage events in Word VBA using the corresponding references. \u00a0But this is not the case in Work […]<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[28],"tags":[31,32],"_links":{"self":[{"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/posts\/2111"}],"collection":[{"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/comments?post=2111"}],"version-history":[{"count":4,"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/posts\/2111\/revisions"}],"predecessor-version":[{"id":2589,"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/posts\/2111\/revisions\/2589"}],"wp:attachment":[{"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/media?parent=2111"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/categories?post=2111"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docassist.com.au\/wp-json\/wp\/v2\/tags?post=2111"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}