Start of changeIBM Content Navigator, Version 2.0.3     Supports:  CMIS for Content Manager

Extending document types

You can extend, optimize, and enable document types and folder types with optional metadata extensions for better behavior and performance with some client applications. The document types that are enabled and optimized for CMIS support performance, scaling, and fields, such as name, title, and description. You can use the DocumentTypeEnable tool to determine and extend document types and folder types.

About this task

The DocumentTypeEnable tool helps you:
  • List which item types are extended and optimized for CMIS.
  • Determine which extensions are enabled for a document type or folder type.
  • Add optional metadata extensions to existing item types to support more fields.
  • Optimize folder types and document types.
  • Create new item types with support for hierarchical folders only.
  • Find incorrectly enabled or incomplete item types without indexes.

The DocumentTypeEnable tool checks for incorrectly enabled document types or folder types and prompts you correct the document types or folder types. If you confirm, the DocumentTypeEnable tool automatically corrects the document types to document types that are optimized for CMIS.

You can extend the document types and folder types to support the standard name attribute or label with indexes that are added by the DocumentTypeEnable tool. Your item type then becomes optimized for CMIS for behavior, performance, and scaling.

Important: Do not add extended metadata manually to the document types ICM$NAME (the standard name attribute), or the ClbContent group with label attribute (the standard attribute for saving a file name). The metadata extensions are defined as attribute groups in Content Manager EE. For core fields that start with Clb, do not add the attribute groups that define metadata extensions to the item types by using any method other than the DocumentTypeEnable tool. Adding the attribute groups for core fields without the correct indexes results in improperly enabled document types that cause performance or scaling problems. The applications that use unrevised path values must query all document types, so any document type without indexes reduces the performance of locating an item by name. If you created improperly enabled document types without indexes, even if you do not use those document types, their existence affects performance and scalability.

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.DocumentTypeEnable -? or java com.ibm.content.cm.tools.DocumentTypeEnable -help.

Procedure

To run the DocumentTypeEnable tool:

Run the Java command with the following format: java com.ibm.content.cm.tools.DocumentTypeEnable - options values.
Use the following command options for the DocumentTypeEnable 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.
f or fix
This option fixes any incorrectly enabled document types if detected. This option can be set to true or false.
t or type
The Content Manager EE document type or the folder type.
a or add
The digit series that represents the extensions to be added to enable the specified document type. Choose one or more digit values to add in the order you want them to be added. (For example, 1234 adds the first, second, third, and fourth extensions, and 51 adds the fifth extension and the first extension.) The extension numbers vary depending on the document type, and the actual digits that represent each extension vary depending on the repository. To display a list of extensions and corresponding extension numbers, run the tool with the help parameter by entering java com.ibm.content.cm.tools.DocumentTypeEnable -?.
Table 1. Example extensions for document types
Client application fields Content Manager EE attributes
Universal name ICM$Name (Available in Content Manager EE version 8.4.3 fix pack 1 or later)
Content standard metadata Label (deprecated), title, description, authors, categories, effective date, Is Hidden, language, owners
Data state Current state
Version Version comments, version labels
Client application archived details and original taxonomy Date filed, filed by, source document type ID, library ID, path, place ID, server, UUID
force or nowarn
Ignores the warning prompt for changes that cannot be reverted. The value can be either true or false. The default value is false.
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 DocumentTypeEnable
Windows configure-repository.bat DocumentTypeEnable
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.DocumentTypeEnable -r icmnlsdb -u icmadmin -p password
 -o SCHEMA=ICMADMIN -f true -t MyDocumentType -a 1234 -force true -z true
Parent topic: Administering IBM CMIS for Content Manager
End of change