IBM Enterprise Records, Version 5.1.+            

Creating a classification scheme

A ClassificationScheme object represents the highest-level container object in a file plan. It enables a hierarchical grouping of RM folders into record categories, record folders, and volumes within a file plan. This hierarchical folder structure represents the business functions of an organization, and allows you to aggregate records under different folders within a classification scheme based on business functions. In addition, a classification scheme provides a logical partitioning of objects within a file plan. You can perform various operations--such as relocate, inactivate, or delete--on objects that you create within a classification scheme.

You can create multiple ClassificationScheme objects in the Records Management folder, which represents the root folder for file plan entities. To create a ClassificationScheme object, call the createClassificationScheme method on an RMObjectStore object. You must specify a unique name for the ClassificationScheme object along with its properties and permissions. In addition, the name of the object cannot contain special characters such as \ / : * ? " < > |.

Note: You cannot create a classification scheme within another classification scheme.
In the following code fragment, a ClassificationScheme object with the specified name is created using the createClassificationScheme method.
// Creates a ClassificationScheme object 
public void createClassificationScheme(String asName, Properties aoProps, 
   Permissions aoACLs, RMObjectStore aoRMOS)

{
   ClassificationScheme loCS = aoRMOS.createClassificationScheme(asName, aoProps,
      aoACLs); 

}

The topics in this section describe how to apply a naming pattern to objects created under a classification scheme and how to retrieve ClassificationScheme objects within a file plan.

Enforcing a naming pattern

To enforce a generic naming rule on RecordCategory and RecordFolder objects to be created under a classification scheme at the required level, you can associate a Pattern object with the ClassificationScheme object. Enforcing a naming pattern ensures that there is consistency in the naming convention of the objects that are added to a classification scheme at the specified level. To enforce a naming pattern, perform the following steps:
  1. Creating a Pattern object
  2. Associating a Pattern object with a PatternLevel object
  3. Associating a Pattern object with a ClassificationScheme object

Creating a Pattern object

You can create a Pattern object by calling the createPattern method on an RMObjectStore object, passing in a Properties and a Permissions collection for the Pattern object as shown in the code below.
// Creates a Pattern object
public void createPattern(Properties aoProps, Permissions aoACLs, RMObjectStore aoRMOS)

{
   RMCustomObject loPattern = aoRMOS.createPattern(aoProps, aoACLs);

} 

Associating a Pattern object with a PatternLevel object

After creating a Pattern object, you associate it with a PatternLevel object to define a naming pattern rule. A pattern level specifies which entity and at which level in the file plan the Pattern object is applicable. To create a PatternLevel object, call the createPatternLevel method on an RMObjectstore object as shown in the code below.
//Associates a Pattern object with a PatternLevel object
public void createPatternLevel(Properties aoProps, Permissions aoACLs, 
   String asPatternGUID, RMObjectStore aoRMOS) 

{ 
   RMCustomObject loPatternLevel = aoRMOS.createPatternLevel(aoProps, aoACLs, 
      asPatternGUID); 

} 

Associating a Pattern object with a ClassificationScheme object

To associate the Pattern object with a ClassificationScheme object, call the setPatternValue method on a ClassificationScheme object. You specify an existing Pattern object in the aoPattern parameter. Alternatively, you can call the setProperties method and pass in a Properties collection containing the pattern property to the ClassificationScheme object.

Note: To retrieve the Pattern object associated with a classification scheme, call the getPatternValue method on a ClassificationScheme object.

Retrieving ClassificationScheme objects

You can retrieve ClassificationScheme objects present in an object store in the following ways:



Feedback

Last updated: August 2011


© Copyright IBM Corporation 2011.
This information center is powered by Eclipse technology. (http://www.eclipse.org)