Creating library groups

Library groups provide a way to organize your libraries. You can create a library group by using the LibraryGroupCreate tool.

About this task

Library groups organize the libraries in the path-based model that is supported by IBM CMIS for Content Manager. You can create one or more libraries in a library group. You can choose to create all of your libraries in a single library group, each library in separate library groups, or group several libraries among several library groups. The library groups are used only for administration purposes. The library groups are not used by CMIS applications. Most library groups list all libraries in the repository regardless of library group. You can use the predefined default library group for all of your libraries.

When the path model is created, the following library groups are created for you:
A default group
  • The default group is an example library group that is used by the default library and repository root library
  • If you choose not to create your own library groups, you can create more libraries in the default group
  • Name: default group
  • Browse model path: /cmRoot/default group, The browse model path is the path that administrators see during library configuration or mounting
  • CMIS path: /default group
The all item types library group
  • A special library group that contains the all item types library
  • You cannot create more libraries in this library group
  • Path: /ALLITEMTYPES_APP, if cmisRoot=/cmRoot, or /$type, if cmisRoot is customized
  • When you browse, the all item types library is hidden by default. However, you can configure it by using the listAllItemTypesLibrary configuration setting in cmpathservice.properties file.

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

Procedure

To run the LibraryGroupCreate tool:

Run the Java command with the following format:java com.ibm.content.cm.tools.LibraryGroupCreate -options values.
Use the following command options for the LibraryGroupCreate 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.
l or label
The label or the short name of the library group that you create.
t or title
The title or the long name of the library group that you create.
d or desc
The description of the library group that you create.
a or acl
The ACL name that exists in Content Manager EE to give access to the library group that you create.
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 LibraryGroupCreate
Windows configure-repository.bat LibraryGroupCreate
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.LibraryGroupCreate -r icmnlsdb -u icmadmin -p password
 -o SCHEMA=ICMADMIN -l myLibGrp -t MyLibGrp -d MyDesc -a PublicReadACL -z true