Creating a path-based data model

You can create definitions for path-based extensions by using the PathModelCreate tool, which defines a minimum set of item types that enable the path-based model and other Clb-enabled model features.

About this task

The PathModelCreate tool defines the data model extensions in the repository. The IBM Content Navigator Configuration and Deployment tool runs the PathModelCreate tool automatically, but you can also run the PathModelCreate tool manually. The tool detects and creates any data model extensions that are missing in the repository, defines the required database indexes, and creates an example library. If the data model is up to date, running the tool again validates that the required data model extensions are defined. When you run the PathModelCreate tool, you can view progress and messages directly.

The PathModelCreate tool creates the following definitions:
  • Attribute definitions
  • Attribute group definitions
  • Reference attribute definitions
  • Item type definitions
  • Initial default application
  • Initial default library
  • All item types application (virtual)
  • All item types library (virtual)
  • User-defined function IN_TREE(), which allows users to restrict query results to only the items in a specified folder
The PathModelCreate tool defines the following item types:
  • ClbApplication
  • ClbLibrary
  • CmisDocument (if exists for IBM CMIS for Content Manager)
  • ClbFolder
  • ClbDraft
  • ClbSavedSearch
Important: The PathModelCreate tool creates the definitions and item types that did not previously exist. The existing item types are not modified, but they work with the new path-based services. If you prefer to modify your existing item types to store the new optional field data, you can add extra fields by using the DocumentTypeEnable tool. The DocumentTypeEnable tool adds new attribute groups, depending on which extra fields you want to enable, and adds important indexes for performance and scaling. If an error occurred and you run the tool again, it resumes from where it stopped when the error occurred. If all definitions are present by name only and you run the tool again, it does not create any definitions. If the model changes, the tool does not update the existing models.

If text search is enabled for Content Manager EE, the CmisDocument item type is also enabled for text search. The default value for updating the text index is every 10 minutes. If the value is unchanged, then all new and updated documents that accumulate during the interval and are indexed in batches at the next 10-minute interval. If you want a different interval, the frequency can be updated by using the Content Manager EE system administration client. The updated frequency interval is effective immediately on the Content Manager EE server without restarting your IBM CMIS for Content Manager server. When the repository is configured for deferred DDL, you must run some additional steps.

In an interactive mode, the tool prompts you for all required options. You can also run the tool in a silent mode by specifying the options and values. You can use either the single character or the full name of the option.

To display a list of available options, enter java com.ibm.content.cm.tools.PathModelCreate -? or java com.ibm.content.cm.tools.PathModelCreate -help.

Procedure

To run the PathModelCreate tool:

Run the Java command with the following format: java com.ibm.content.cm.tools.PathModelCreate -options values.
Use the following command options for the PathModelCreate tool:
r or repository
The Content Manager EE database name or the alias name.
u or user
The Content Manager EE user ID that you use to log in.
p or password
The Content Manager EE password that you use to log in.
o or options
The Content Manager EE connection options that you can use to connect to Content Manager EE. For more information about connection options, see the DKDatastoreICM::connect() method or the SConnectDisconnectICM.java sample.
z or throwExc
The exception message. The value can be either true or false. The default value is false.

Example

The following code sample shows how to run the tool in an interactive mode:
Operating system Code sample
Linux or UNIX systems ./configure-repository.sh PathModelCreate
Windows configure-repository.bat PathModelCreate
The following code sample shows how to run the tool in a silent mode. You must enter the command in one line.
java com.ibm.content.cm.tools.PathModelCreate -r icmnlsdb -u icmadmin -p password
 -o SCHEMA=ICMADMIN -z true