Files in the sample external data service

You can use the sample service as an example and as a starting point for your own external data service. The sample service consists of a GetObjectTypes servlet, an UpdateObjectTypes servlet, the object types resource JSON file, JSON files as the data source, and the web.xml deployment file.

The sample service consists of the following files:
GetObjectTypesServlet.java servlet
This servlet gets the list of all classes to handle in the external data service.
UpdateObjectTypeServlet.java servlet
For each class, this servlet gets the current attributes or values and returns that information in the response payload.
ObjectTypes.json file
This JSON file determines which classes you are using for the external data service.
JSON files as the data source
These JSON files are the external data sources for the sample EDS, and can be used to understand the required format of the JSON. The ECMClient_installdir\samples\sampleEDSService\WEB-INF\classes directory contains the following sample JSON data source files:
  • Article
  • Book
  • Document
  • Email
  • Folder
  • Invoice
  • NOINDEX
  • DefaultApplication*
  • Data_Field_*
Important: These files are provided primarily to help you understand the expected JSON format and to help you start creating the JSON for your own external data service. To use the sample files for EDS deployment, extensive configuration is required.

The JSON needs to match the classes, item types, and the corresponding custom properties on your system. To use the provided JSON files in the sample, the JSON files need to be modified so that the correct custom properties are aligned with the actual classes and custom properties in your IBM FileNet® P8 or IBM Content Manager repository.

Similarly, to use the workflow JSON files (IBM FileNet P8), the JSON must be modified to match your IBM Content Navigator workflows, including the appropriate steps, step names, workflow data fields, and other custom properties.

To apply the sample EDS on a workflow filter, the Application Space, Role, Inbasket, and filter criteria must be set up accordingly.

A sample localized file is included in the sample to help illustrate that the EDS can send locale information in the request. The EDS developer can specify for the EDS to look at the locale information in the request and return the response JSON in the proper correct translation.

web.xml file
The web.xml file provides configuration and deployment information for the web application. This file must reside in the WEB-INF directory under the context of the hierarchy of directories that exist for the external data service.