Customizing the BPF toolbar

This section describes modification of the toolbar in the IBM® FileNet® BPF Case user interface using Toolbar.xml.

Standard BPF Tools List

This section details the standard toolbar options included in the base BPF deployment. Some of these tools are configurable using the BPF Explorer configuration tool while others are configured by modifying the Toolbar.xml file. Still others (Action, Mode) are required and cannot be removed. Each standard tool is described in the table below

Structure of the Toolbar.xml file

The Toolbar.xml file contains a single primary section <Toolbar> sub-sections of <Item> contain each additional tool to be displayed on the toolbar. The Toolbar.xml is located in the /WEB-INF folder. By adding a <Item> section tools may be added to the toolbar. Toolbar item entries make reference to Javascript functions, generally located in Bp8InitMain.js in the /js folder. An example of a toolbar item entry is detailed below.

<Item Caption='Preferences' Name='Preferences' SearchMode='no'>
  <Description></Description>
  <Action>javascript:showUserPreferences()</Action>
</Item>

Important: After you modify the Toolbar.xml file, restart the BPF Web application to apply the changes to the toolbar and to ensure that the toolbar works correctly.

An included tool that is not activated is the SearchCases tool. Viewing the Toolbar.xml will show that this tool is commented out. By uncommenting the tool entry, and updating the GUID for the search being invoked (the parameter passed to the invokeWorkplaceObject function) to a valid GUID this tool can be activated. This tool utilizes the invokeWorkplaceObject function which simply executes the appropriate activity for the CE object specified in the GUID passed. In this Case, a stored search configured to locate cases with specific parameters will be executed.

• This search must be configured and tested in Workplace prior to utilization in BPF.
  
• The invokeWorkplaceObject function is located in the Bp8InitMain.js in the application root folder. More data on usage of this function may be located by examining this file. Bp8InitMain.js should not be altered with custom functions.


<Item Caption='Search Cases' Name='SearchCases' >
   <Description>Search Cases by their name</Description>
   <Action>javascript:invokeWorkplaceObject("{3FFD7AC9-7F44-4053-B34B-CF79AAA2B9AC}","searchtemplate")</Action>
</Item>

NOTE that, if the invokeWorkplaceObject method is used to invoke versionable content in CE (for example, if you choose to configure it to point to an actual Search Template or other document rather than a Folder in which Searches are stored), you will need to change the GUID value here whenever a new version of the content is created. Otherwise, invokeWorkplaceObject will continue to invoke the old (original) version.

Likewise, if you wish to restrict the use of toolbar items by BPF Security Profile (or Role), you can make use of the <Security-profile> node defined in Toolbar.xsd as follows:

        <xsd:element name="Security-profile" type="securityprofileType" minOccurs="0" maxOccurs="unbounded"/>

  ...

     <xsd:complexType name="securityprofileType">
        <xsd:simpleContent>
           <xsd:extension base="xsd:string">
              <xsd:attribute name="Id" type="xsd:ID"/>
           </xsd:extension>
        </xsd:simpleContent>
     </xsd:complexType>
  

The meaning of the security-profile here is the BPF Security Profile (or Role).

The following is an example of how to modify the Toolbar.xml to let only the BPF Roles Indexer and Approver see the "Search" tool. The id attribute has no special meaning other than being a unique and arbitrary value. But the correct Profile (or Role) name must be used as the text of the element.

  <Item Caption='Search' Name='Search' SearchMode='no'>
     <Description></Description>
     <Security-profile id="sp01">Indexer</Security-profile>
     <Security-profile id="sp02">Approver</Security-profile>
     <Action>javascript:invokeWorkplaceObject("{57271F98-3B75-459B-9DEE-A2061EE93454}","folder")</Action>
  </Item>

  

Bp8InitMain.js file and custom functions

The Bp8InitMain.js file contains functions related to the display of a Case in the Case user interface but should not be altered for customer functions. Functions called by custom tools added to the Toolbar.xml should be placed in the Bp8BusinessObjects.js file.

// Function to invoke Workplace commands 
function invokeWorkplaceObject(id,objectType){
	RemoteFunctions.keepSession();
	var id = id;
	var objectType = objectType;
	var urlCaseQuery = "ExtCommand.jsp?ExtTask=Search&id="+id+"&objectType="+objectType;
	var winFeatures = "resizable=yes, scrollbars=yes";
	var windowName = "winCaseQuery";
	var searchWindow = window.open(urlCaseQuery, windowName, winFeatures);

	openedWindows.dependent.push( searchWindow );
	try {searchWindow.focus();} catch (e) {;}
}


// Function to invoke Form Template from Workplace 
// NOTE: the two GUID parameter values passed here represent the OIID (object_id) and the vsId (version_series_id), 
// respectively, of the eForms Form Template (.itx) to be invoked from the CE ObjectStore.
 function invokeFormTemplate(id,vsId){
	RemoteFunctions.keepSession();
	var id = id;
	var vsId = vsId;
	var objectType = "document";
	var urlEForm = "ExtCommand.jsp?ExtTask=create_eform_case&id="+id+"&vsId="+vsId+"&objectType="+objectType;
	var winFeatures=centerWindow(400,500)+"resizable=yes, scrollbars=yes";
	var windowName = "winEForm";
	var eFormsWindow = window.open("", windowName, winFeatures);
	var msg=localize("LoadingTemplate","Loading...Please wait");
	eFormsWindow.document.write(' <table style="width:100%; height:100%;">'+
        '<tr><td style="text-align:center; vertical-align:middle;"> '+msg+
        '</td></tr> </table>');
	self.setTimeout(window.open(urlEForm, windowName, winFeatures), 5000);
	openedWindows.dependent.push( eFormsWindow );
	try {eFormsWindow.focus();} catch (e) {;}
}

// Function to invoke tools via toolbar.xml
//	1. Tool Name - Name of the tool displayed in the child window's title bar.
//	2. Handler URL - URL for the location of the tool code itself (JSP for example)
//	3. Width - Width of the child window raised for the tool.
//	4. Height - Height of the child window raised for the tool.
//	5. Resizable - Whether the child window raised for the tool is resizable.
//	6. Modal - Whether the child window raised for the tool is modal.
function executeToolFromToolbar(toolName, aHandlerURL, width, height, resizable, modal){
	
	RemoteFunctions.keepSession();
	aHandlerURL += (aHandlerURL.indexOf('?') > 0) ? '&' : '?';
	aHandlerURL += 'ToolName='+toolName;
	aHandlerURL += '&Inbasket='+getCurrentInbasket().id;
	
	var toolpath="plugins/tools/"+toolName;
	if (null != toolpath) {
		var pathnpos = aHandlerURL.indexOf('?');
		var urlval = aHandlerURL.substring(0, pathnpos);
		if (urlval.indexOf('/') < 0) {
			aHandlerURL = toolpath+'/'+aHandlerURL;
		}
	}

	if (currentCase != undefined) {
		aHandlerURL += '&' + paramCaseID + '=' + currentCase.caseId;
		aHandlerURL += '&workobjectNumber='+escape( currentCase.workobjectNumber );
	}
	if ('/' == aHandlerURL.substring(0, 1)) {
		aHandlerURL = getBaseURL() + aHandlerURL.substring(1);
	}
	if (modal==1) {
		return displayModalDialog( aHandlerURL, width, height, resizable, window );
	} else {
		return modelessToolWindows.openTool( toolName, aHandlerURL, window, width, height, resizable );
	}
	
}