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

Creating libraries

Libraries are the starting points for collaboration in some client applications, and contain documents and folders. You can create a library by using the LibraryCreate tool.

About this task

Making a folder into a library adds information, such as a default document type to use when a user adds a document to a folder without specifying a document type. You can either map a library to a new empty folder to create a new empty library, or map it to an existing folder in the system. Unless your system already has existing folders that can be used as libraries, you might want to create empty libraries for various collaboration projects and teams.

When the path model is created, the following libraries are created for you:
A repository root library
  • The repository root library maps to the Content Manager EE hierarchical root folder available in Content Manager EE Version 8.4.3 or later and mounts it as a library.
  • The access is controlled by the access control list for the hierarchical root folder by default. You can change the ACL on the library by using the Browser tool to restrict user access.
  • You can delete the library that maps the repository hierarchical root.
  • You can use the LibraryCreate tool to browse and mount the repository hierarchical root folder or folders that are filed under it.
  • The browse model path is the path that administrators see during library configuration or mounting. Browse model path: /cmRoot/default group/repository root
  • CMIS path: /default group/repository root
A blank default library
  • You can use the default library for your initial IBM® CMIS for Content Manager configuration so that you can get started without having to create more libraries.
  • This library is a default choice for configuring IBM CMIS for Content Manager.
  • The default Document Type is CmisDocument.
  • The browse model path is the path that administrators see during library configuration or mounting. Browse model path: /cmRoot/default group/default library
  • CMIS path: /default group/default library.
    Example

    CMIS users can configure their CMIS root folder so that it hides all or part of these libraries. By default, the cmpathservice.properties file is configured as cmisRoot = /cmRoot. This configuration causes the CMIS root folder to point to /cmRoot. As a result, the users see a subfolder of the root folder that is called default group, and a subfolder of the default group folder that is called default library.

    CMIS users with a default configuration can create documents in the /default group/default library folder or its sub folders. You can also hide the two folders by setting: cmisRoot = /cmRoot/default group/default library. As a result, the CMIS folder is mapped to /cmRoot/default group/default library path, and users can create folders and documents directly without seeing the default group/default library folder. If you create other libraries, you can map them to the CMIS root in the same way.

    You can also map the CMIS root to Content Manager EE folders under libraries. For example, to map a folder that is named MyCMISRoot to the CMIS root folder, specify: cmisRoot = /cmRoot/default group/default library/MyCMISRoot. In this case, documents and folders that are contained in the MyCMISRoot folder are in the IBM CMIS for Content Manager root folder.

The all item types library
  • The all item types library is a special item type-based library that ensures a path to every item in the system. The library allows limited browsing by accessible item types. It is restricted to a subset of items that can be browsed when the item types contain many items.
  • When you add documents directly into an item type folder under the all item types library, you can add documents only of the same type as that item type folder. An item type folder cannot contain documents of other types. However, if an application created an existing folder for a particular item type, there are no type restrictions on subfolders. The only restriction is that the item type folder itself can only directly contain items (documents or folders) of that specific item type.
  • You cannot create folders directly in the item type folders through some client applications.
  • Default Document Type: Uses the type that is referenced by the particular itemType folder that is traversed in the first level of subfolders underneath the All Item Types library.
  • Path: /ALLITEMTYPES_APP/ALLITEMTYPES_LIB, 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.LibraryCreate -? or java com.ibm.content.cm.tools.LibraryCreate -help.

Procedure

To run the LibraryCreate tool:

Run the Java command with the following format: java com.ibm.content.cm.tools.LibraryCreate -options values.
Use the following command options for the LibraryCreate 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 that you create.
t or title
The title or the long name of the library that you create.
d or desc
The description of the library that you create.
g or grp
The existing parent library group under which the library is created.
i or defaultType
The default document type for the library, which is the Content Manager EE root item type.
f or folder
Map the library to a folder by specifying one of three choices:
  1. A new blank folder.
  2. An existing folder by using the absolute path. (For UNIX, the absolute path starts with the / character.)
  3. An existing folder by using the item ID defined by Content Manager EE.
b or block
This option blocks the deletion of the underlying mapped folder where this library exists and is mapped to it. The option can be set to true or false.
a or acl
The ACL name that exists in Content Manager EE to give access to the library 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 and UNIX systems ./configure-repository.sh LibraryCreate
Windows configure-repository.bat LibraryCreate
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.LibraryCreate -r calvin -u icmadmin -p Passw0rd
 -o SCHEMA=ICMADMIN -g myLibGrp -l MyLib -t MyLib -d MyDesc -a PublicReadACL
 -i CmisDocument -z true -b false -f /cmRoot/default group/repository root/
folder1/folder2
End of change