IBM Support

Introduction to Datacap Navigator customization

Product Documentation


Abstract

Datacap Navigator is based on IBM Content Navigator. hence, you can customize it with some common ICN customization features, such as ICN plug-in and EDS. You can also customize field panels using Datacap custom panel feature.

Content

Notice:  The purpose of this document is to provide a general introduction to Datacap Navigator customization. It is not intended for documenting/updating differences for different versions. Refer the IBM Documentation for detailed information.

Customizing Datacap Navigator with new ICN plug-in

In the ICN plug-in, you can create new actions and some other features.

Step by step guide for creating a new action

1. Action definition
It is defined in a java file, and getActionFunction() returns its JavaScript function name.

1


 

Figure 1. Action definition

2. Action registration
Register the action, so that ICN knows which actions are defined in this plug-in.

2
 

Figure 2. Action registration

3. Function definition
Create a JavaScript function, and add your code here, so when users click the Action in ICN toolbar, this function is executed. The function accepts some parameters.

3
 

Figure 3. Function definition

4. Build
Build the plug-in with Ant
4


 

Figure 4. Build

5. Output

A jar file is created, and it is ready to deploy to ICN.

5

Figure 5. Output

Customizing Datacap Navigator with EDS

For customizing EDS, refer https://www.ibm.com/support/knowledgecenter/SSZRWV_9.1.4/com.ibm.dc.admin.doc/dcnav004.htm
For customizing Job Monitor columns, refer
https://www.ibm.com/support/knowledgecenter/SSZRWV_9.1.4/com.ibm.dc.admin.doc/dcnav006.htm

Customizing Datacap Navigator field panels with custom panel

You can create your own layouts by creating custom panels for verify tasks, start batch panels, and batch editor panels. You can arrange the fields and change the appearance and behavior of the panels as required.
Refer the below link for details:
https://www.ibm.com/support/knowledgecenter/SSZRWV_9.1.4/com.ibm.dc.install.doc/dcnvi004.htm

Using actions of built plug-in in Datacap Navigator

1. Add plug-in to ICN

Add newly built DCSamplePlugin.jar to ICN in ICN admin desktop as shown in the figure below.

1


2. Adding actions defined in DCSamplePlugin.jar to Datacap Navigator menu
  • Create a copy of selected task menu (here, verify task) where you wish to add custom action button.
  • Under available, you can see “Refresh Image” action of DCSamplePlugin.jar. Add the action to menu, save and close.
2

3. Use customized menu for Datacap Navigator client
In Menu settings of desktop, you can select newly created menu for the task.
(In the following figure, we have selected newly created menu VerifyWithRefreshImage for verify
task)

3

4. You can use new custom action as button.

4

Document Location

Worldwide


[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSZRWV","label":"IBM Datacap"},"Component":"","Platform":[{"code":"PF033","label":"Windows"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

More support for:
IBM Datacap

Software version:
All Versions

Operating system(s):
Windows

Document number:
793839

Modified date:
28 February 2022

UID

ibm10793839

Manage My Notification Subscriptions