IBM Support

Access to the IBM Case Manager runtime configuration items

Technote (FAQ)


When you are developing custom widgets to work along with IBM Case Manager widgets, they might need to be aware of some basic configuration items like the base URL for REST service and solution name or target object store name.


In IBM Case Manager Case Client, there are two types of configuration items:

  1. The Case Client scope configurations which are shared by all IBM Case Manager widgets in different IBM Mashup Center spaces, like base REST service URL.
  2. The configuration items about the solution. For example, the solution name might change when a space is switched.

The list of the exposed configuration items:

Property Name
API for access
IBM Case Manager Case Client scope configuration items
cmisServiceBaseURL CMIS REST base URL ecmwdgt.settings.cmisServiceBaseURL
bpmServiceBaseURL PE REST base URL ecmwdgt.settings.bpmServiceBaseURL
caseServiceBaseURL CASE REST base URL ecmwdgt.settings.caseServiceBaseURL
workplaceXTBaseURL WorkplaceXT base url ecmwdgt.settings.workplaceXTBaseURL
mashupServerURI The mashup server URL ecmwdgt.settings.mashupServerURI
cmdosName ADOS name ecmwdgt.settings.cmdosName
IBM Lotus Mashup Center space scope configuration
Solution The solution name for current working solution ecmwdgt.getBean("spaceConfig").getSolution()
TargetOS The target object store name for current working solution ecmwdgt.getBean("spaceConfig").getTargetOS()
EffectiveRole The effective role of current user. ecmwdgt.getBean("spaceConfig").getEffectiveRole()
PEConnectionPoint The PE connection point for current solution. ecmwdgt.getBean("spaceConfig").getPEConnectionPoint()
WebAppID The application id. ecmwdgt.getBean("spaceConfig").getWebAppID()

To access the configuration items by using the APIs, you must load and evaluate the Case Client code in the support.js file and your widget must be located in a page that belongs to a IBM Lotus Mashup Center space. The space is created during solution deployment either through the IBM Case Manager Case Builder or the IBM Case Manager Administration Client. The deployment configures the solution information as the space metadata.
Here is a sample widget code to list all the configuration items.

1. The sample widget definition file:

<iw:iwidget name="ACMConfiguration" xmlns:iw=" "
iScope="sample.widget.ICMConfiguration"  allowInstanceContent="true"
supportedModes="view" mode="view">
    <iw:resource uri="ICMConfiguration.js"/>
    <iw:content mode="view">
        <div id="_IWID_view">                

2. The code for sample widget's iScope definition file. The code in bold font is the key step to load the solution configuration items.


dojo.declare("sample.widget.ICMConfiguration", null, {
    onLoad: function() {

          //load and eval the support.js, user have to know the root context for the Case Widget application.
       //It's "/CaseWidget" by default.
       if( !dojo.getObject("ecmwdgt") || !ecmwdgt.settings){//if other widgets like IBM Case Manager Runtime widget already load the support.js

        //get the space config object for retrieving space scope configuration
        var spconfig = ecmwdgt.getBean("spaceConfig");
        var viewNode = dojo.byId("_" + this.iContext.widgetId + "_" + "view");
        var settings = "<div>";        
//read runtime scope configuration
        settings += "ICM Config cmisServiceBaseURL         :" + ecmwdgt.settings.cmisServiceBaseURL + "<br>";
settings += "ICM Config bpmServiceBaseURL          :" + ecmwdgt.settings.bpmServiceBaseURL + "<br>";
        settings += "ICM Config caseServiceBaseURL         :" + ecmwdgt.settings.caseServiceBaseURL + "<br>";
settings += "ICM Config workplaceXTBaseURL         :" + ecmwdgt.settings.workplaceXTBaseURL + "<br>";
settings += "ICM Config mashupServerURI            :" + ecmwdgt.settings.mashupServerURI + "<br>";
settings += "ICM Config cmdosName                  :" + ecmwdgt.settings.cmdosName + "<br>";
    settings += "<br>";

        //read space scope configuration
    settings += "Space Config solution: " + ecmwdgt.getBean("spaceConfig").getSolution() + "<br>";
settings += "Space Config targetOS: " + ecmwdgt.getBean("spaceConfig").getTargetOS() + "<br>";
settings += "Space Config effectiveRole: " + ecmwdgt.getBean("spaceConfig").getEffectiveRole() + "<br>";
settings += "Space Config peConnectionPoint: " + ecmwdgt.getBean("spaceConfig").getPEConnectionPoint() + "<br>";
settings += "Space Config webAppID: " + ecmwdgt.getBean("spaceConfig").getWebAppID() + "<br>";
settings += "</div>";

viewNode.innerHTML = settings;


3. Deploy the custom widget. You should now get the following configuration items displayed when running the widget.
ICM Configuration items

Cross reference information
Segment Product Component Platform Version Edition
Enterprise Content Management Case Manager Case Manager Client AIX, Linux, Linux on System z 5.0.0,

Document information

More support for: Case Manager
Case Manager Client

Software version: 5.0.0,

Operating system(s): AIX, Linux, Windows

Reference #: 1460118

Modified date: 04 April 2011

Translate this page: