You can create custom editors and controls to use with
properties views. For example, you might create a custom editor and
controller to display a record from an external data source such as
a customer relationship management system.
About this task
To use your custom editors and controllers, you must create
and add an extensions package to your
IBM® Case Manager environment. The following
procedure provides an overview of the steps that are required to create
a custom property editor and controller and the extensions package.
For detailed instructions on creating the editor and controller, see
Creating custom property editors and controllers
in IBM Case Manager V5.2.1 on the IBM developerWorks® website.
Procedure
To create an extensions package for a custom property
editor and controller:
- Create a web project that contains the following folders
for your extensions package:
Folder |
Content |
ProjectName/ProjectNamePlugin |
Contains the files that are used to create the
JAR file for the IBM Content Navigator plug-in. |
ProjectName/ProjectNamePlugin/src/PackageName |
Contains the files that are used to create the
JAR file for the IBM Content Navigator plug-in. |
ProjectName/ProjectNamePlugin/src/PackageName/WebContent |
Contains the main JavaScript plug-in file and the root folder
of your custom editors and controller code. It can have subfolder
structures to organize the code packages. |
ProjectName/ICMRegistry |
Contains the Extension.json file
that are used to register the extensions package and optionally the
translated Extension.json in the nls subfolder. |
- Create the registry files and place them in the ICMRegistry folder:
- Create a file called Extension.json. This JSON-format file indicates the ID, title, description,
type, packages, CSS, and a bootstrap class of the extensions.
- Optional: For a different locale, you can
create the translated Extension.json files, and
put them in the corresponding language folders under the nls subfolder.
For example, create ICMRegistry/nls/fr/Extension.json for
a French locale.
- Create a standard Content Navigator plug-in
in the ProjectName/ProjectNamePlugin folder,
to hold the source code for your custom editors and controllers. Create the following items in the WebContent folder
of the plug-in:
- Create a self-contained Dojo widget to represent the
customer editor that you want to use in the properties view.
- Create a registry file to describe the custom editor, and specify the types of the properties
that are suitable to use with the editor in the registry. This registry file is used to register the editor into Properties View Designer.
- Optional: If you want to interact with custom
data types, you can create a custom controller to use with the editor
and the custom data type. You must also create a custom
integration configuration file to ingest the custom controller in
the integration configuration.
- Create a bootstrap class to register the custom editor
and custom controllers.
- Create a extensions package that contains the custom the
custom plug-in and registration file:
- Create a build.xml script that
builds the following components:
- The ICMRegistry folder that includes the
extension definitions
- A JAR file that contains the IBM Content Navigator plug-in
- In the IBM Case Manager configuration
tool, run the Deploy and Register Extensions Package task to register
and deploy your extensions package.
- In Case Manager Builder,
use Properties View Designer to choose the custom properties editor
for a property in a properties view.
- Deploy and test your solution.