{"id":409,"date":"2016-08-28T17:35:50","date_gmt":"2016-08-28T15:35:50","guid":{"rendered":"http:\/\/h2916922.stratoserver.net:8084\/?page_id=409"},"modified":"2016-08-28T18:22:52","modified_gmt":"2016-08-28T16:22:52","slug":"central-configuration-plugin-manual","status":"publish","type":"page","link":"https:\/\/www.ivojonker.nl\/?page_id=409","title":{"rendered":"Central Configuration-plugin manual"},"content":{"rendered":"

This is a short manual on how to use the Central Configuration plugin for IBM Content Navigator & IBM Case Manager.<\/p>\n

For updates please see:<\/p>\n

The introductory blogpost at ivojonker.nl<\/a><\/p>\n

Also available in .docx<\/a> and .pdf<\/a><\/p>\n

Contents<\/p>\n

Introduction 1<\/a><\/p>\n

1. Preparing and installing the plugin 1<\/a><\/p>\n

1.1. Preparing the .jar file for use in your environment. 1<\/a><\/p>\n

1.2. Installing the .jar file as navigator plugin \/ for use within navigator 1<\/a><\/p>\n

1.3. Adding and removing configuration entries using the ICN Plugin manager 1<\/a><\/p>\n

1.4. Installing the .jar for global use within java EE applications (WebSphere) 1<\/a><\/p>\n

1.5. Using the .jar in a single java EE application (running on WebSphere) 1<\/a><\/p>\n

2. Accessing the plugin from your code. 1<\/a><\/p>\n

2.1. From dojo\/JavaScript. 1<\/a><\/p>\n

2.2. From java 1<\/a><\/p>\n

<\/a>Preparing and installing the plugin<\/h1>\n

<\/a>Preparing the .jar file for use in your environment.<\/h2>\n
    \n
  1. Download the CentralConfiguration.jar plugin file.<\/li>\n
  2. Open the CentralConfiguration.jar plugin file with an archive browser (e.g. WinRAR, or 7zip)<\/li>\n
  3. Within the CentralConfiguration.jar open the \u2018config.properties\u2019 file for editing.
    \nThree properties need to be specified, although the defaults may probably work, please take into account the following:<\/p>\n
      \n
    1. DATASOURCEJNDI<\/strong>: The configuration plugin relies on a datasource to be available within the JNDI. While you may re-use the navigator\u2019s datasource (default ECMClientDS), it is probably better to define a new \u2013 specific datasource for architectural reasons.<\/li>\n
    2. CONFIGTABLENAME<\/strong>: A database table will be created within the datasource. Be sure not to pick an existing table-name.<\/li>\n
    3. CREATETABLEQUERY<\/strong>: When creating the table to store the configuration, this query will be used. Update the data-types as needed by your database provider.<\/li>\n<\/ol>\n<\/li>\n
    4. Save the updated \u2018config.properties\u2019 file within the \u2018CentralConfiguration.jar\u2019.<\/li>\n<\/ol>\n

      <\/a>Installing the .jar file as navigator plugin \/ for use within navigator<\/h2>\n
        \n
      1. Login as an administrative user on the admin desktop (navigator?desktop=admin). Then navigate to the \u2018Plug-ins\u2019 page and press the \u2018New Plugin-button\u2019.<\/li>\n<\/ol>\n

        <\/p>\n

          \n
        1. Fill in the path to the JAR file and press load; <\/li>\n
        2. After loading, look at the field \u201cConfiguration status\u201d, if all was configured well there\u2019s probably a notice that the configuration table does not yet exist. Click on the [create table] button. The following message should appear:
          \n<\/li>\n<\/ol>\n

          And the status becomes \u2018ready\u2019
          \n<\/p>\n

            \n
          1. All is set.<\/li>\n<\/ol>\n

            <\/a>Adding and removing configuration entries using the ICN Plugin manager<\/h2>\n
              \n
            1. To add an entry, simply type in your key in the \u2018Add new property\u2019 textfield, and press add.<\/li>\n
            2. The new entry will be automatically grouped with other entries sharing the same namespace.
              \n<\/li>\n<\/ol>\n

              Each entry has the following attributes:
              \nKey<\/strong>: The identification attribute that will be used to retrieve the property.
              \nValue<\/strong>: The value of the attribute which can be any (multiline) string.
              \nDescription<\/strong>: (click on the information icon) A description of the property so other administrators can understand it\u2019s purpose without consulting documentation.
              \nExpose to frontend<\/strong>: Whether or not this entry should be accessible on the frontend. Warning<\/strong>: please note that any properties exposed to the frontend will be accessible to all authenticated users. Its discouraged to expose any passwords or api-keys.
              \nEvaluate at frontend<\/strong>: Whether or not to call javascript-eval() on the content when accessing the content via JavaScript. This can be useful if you want to have JSON objects desterilized, or functions as configuration objects.<\/p>\n

                \n
              1. Finally press the \u201csave\u201d button to persist the changes. If all goes well, no messages will be shown.<\/li>\n<\/ol>\n

                An entry can be removed by entering its full canonical name in the \u2018Add new property field\u2019 followed by pressing the \u2018Delete\u2019 button.<\/p>\n

                <\/a>Installing the .jar for global use within java EE applications (WebSphere)<\/h2>\n

                I personally prefer to make the configuration plugin accessible to all the applications running on WebSphere. Only one instance will exist per JVM and only one .jar has to be maintained. The way I usually achieve this is my creating a shared library and connect it to JVM\u2019s class loader.<\/p>\n

                After taking these steps, don\u2019t forget to reference a copy of the configuration.jar during design\/build-time.<\/p>\n

                  \n
                1. Copy the plugin .jar to newly made directory accessible to the WebSphere server. For example, \u2018c:\\IBM\\shared libraries\\\u2019.<\/li>\n
                2. Open the WebSphere console (https:\/\/localhost:9043\/ibm\/console<\/a>) and navigate to Environment -> Shared Libraries. Press \u201cNew\u201d to create a new Shared Library.<\/li>\n
                3. Choose a meaningful name (e.g. \u201cCentral Configuration\u201d, or \u201c<Project name>Shared libraries\u201d if you\u2019re intended on having multiple jars available for general use). Enter your path (from step 1) in the class path.<\/li>\n<\/ol>\n

                  <\/p>\n

                    \n
                  1. Press apply, followed by Save.<\/li>\n
                  2. Next navigate to Servers-> WebSphere application servers-><server name>->Java and Process Management->Class loader.<\/li>\n
                  3. Select the class loader already available (if no available, create one). Navigate to \u201cShared library references\u201d.
                    \n<\/li>\n
                  4. Add the newly created shared library, then press save.
                    \n<\/li>\n
                  5. Finally restart WebSphere to effectuate.<\/li>\n<\/ol>\n

                    <\/a>Using the .jar in a single java EE application (running on WebSphere)<\/h2>\n

                    Simply copy the jar file within your <app.war>\\web-inf\\lib directory; or your <ear>\\lib directory and you\u2019re set to go.<\/p>\n

                    <\/a>Accessing the plugin from your code.<\/h1>\n

                    <\/a>2.1. From dojo\/JavaScript.<\/h2>\n

                    Assuming you\u2019re trying to access specific properties from within the IBM Content Navigator context, the following snippet is all you need to get started.<\/p>\n

                    require(\"CentralConfiguration\").get(\"filenet.ce.iiop\")<\/pre>\n
                    A second parameter can be provided to return a default value if the key ends up to be null or not present in the configuration repository.<\/p>\n
                    <\/a>2.2. From java<\/h2>\n
                    Please take into account that the Central Configuration plugin requires the application to be run within a WebSphere context. <\/em><\/p>\n
                    package nl.ivojonker.sample;\r\n\r\nimport nl.ivojonker.icn.configuration.Configuration;\r\n\r\npublic class SampleUsage {\r\n\t\r\n\tpublic static void doStuff(){\r\n\t\t\r\n\t\tboolean useCache = false;\r\n\t\t\r\n\t\t\/\/Retrieves the singleton with default useCache = true Simply re-uses earlier collected configuration \r\n\t\tConfiguration config = Configuration.getInstance();\r\n\t\t\r\n\t\t\/\/Retrieves the singleton with the option to provide useCache=false\r\n\t\tconfig = Configuration.getInstance(useCache);\r\n\t\t\r\n\t\t\/\/Retrieves the singleton, but will not throw exceptions upon failure - might sometimes be convenient.\r\n\t\t\/\/The risk of not having a configuration available might be mitigated by using the following .getProperty(key,default) function.\r\n\t\tconfig = Configuration.getInstanceSupressExceptions(useCache)\r\n\r\n\t\t\/\/retrieves the value for filenet.ce.defaultobjectstore.\r\n\t\tconfig.getProperty(\"filenet.ce.defaultobjectstore\");\r\n\t\t\r\n\r\n\t\t\/\/retrieves the value for filenet.ce.defaultobjectstore, but returns default if the value does not exist.\r\n\t\tconfig.getProperty(\"filenet.ce.defaultobjectstore\",\"TARGET\");\r\n\t}\r\n\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
                    This is a short manual on how to use the Central Configuration plugin for IBM Content Navigator & IBM Case Manager. For updates please see: The introductory blogpost at ivojonker.nl […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"page_fullwidth.php","meta":{"footnotes":""},"class_list":["post-409","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=\/wp\/v2\/pages\/409","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=409"}],"version-history":[{"count":8,"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=\/wp\/v2\/pages\/409\/revisions"}],"predecessor-version":[{"id":446,"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=\/wp\/v2\/pages\/409\/revisions\/446"}],"wp:attachment":[{"href":"https:\/\/www.ivojonker.nl\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=409"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}