Classifications Administration Guide
Classifications Administration Guide
LLESCLS230100-AGD-EN-01
Classifications Administration Guide
OpenText™ Content Server
LLESCLS230100-AGD-EN-01
Rev.: 2022-Nov-15
This documentation has been created for OpenText™ Content Server CE 23.1.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 Classifications ........................................................................... 5
For example, if the items in your Enterprise Workspace are organized according to
departments such as Human Resources and Marketing, adding Classifications lets
you organize these items in the Classification Workspace according to other criteria
(such as date, subject, and item type), in addition to the departments.
For more information about using Classifications (for example, classifying items and
searching Classifications), see OpenText Content Server - Classifications User Guide
(LLESCLS-UGD).
Note: Although Classifications does not suggest or build taxonomies for you, it
allows you to import and export the XML taxonomy definitions that you
provide. For more information, see “Classification Taxonomies” on page 29.
There are three approaches you can use to create Classifications and Classification
Trees in Content Server:
• Manually add them in the Classifications Workspace. For more information, see
“Adding Classifications” on page 6.
• Construct and import an XML Taxonomy. For more information, see
“Constructing an XML Taxonomy” on page 29.
• Export an existing Classifications Taxonomy from another Content Server. For
more information, see “Classification Taxonomies” on page 29.
If Intelligent Classification is enabled, you must set the management type for a
Classification for managed objects such as Documents, Compound Documents, Text
Documents, and Folders. There are three management types:
• Manual, which means that the system will not automatically assign the
Classification to an item. Only administrators and users with the appropriate
permissions will be able to assign this Classification.
• Assisted, which means that the system will suggest this Classification for items
that satisfy the Classification's Profile and place them on the Manage Pending
Objects page (Tools > Content Server Administration > Classifications Administration).
There they can be accepted or rejected by Content Server Administrators and
users with the appropriate permissions.
• Automatic, which means that the system will automatically assign this
Classification to items that satisfy the Classification's Profile.
You must also decide if you want the Classification to be selectable by users.
For more information on how to configure object privileges, see OpenText Content
Server - Content Server Administration Guide (LLESWBA-AGD).
For more information on how to configure usage privileges, see OpenText Content
Server - Content Server Administration Guide (LLESWBA-AGD)
• Compound Documents
• Documents
• Text Documents
• Folders
For example, if you make the Documents item type a managed object, Content Server
users can manually classify Documents, or you can configure Content Server to
automatically classify or suggest Classifications for Documents using the Intelligent
Classifications functionality. For more information about automatic and assisted
Classifications, see “Adding Classifications” on page 6.
2. Clear or select the Managed check box for any of the following object types:
• Compound Document
• Document
• Folder
• Text Document
• For information about configuring widgets using Edit Page mode in Smart View,
see the Help available in Smart View.
• For information about configuring widgets using the Perspective Manager tool,
see the Help available in the Perspective Manager.
• For information about the Classifications widget, see OpenText Content Server -
Widget Configuration Guide (CSAV-CWG).
Note: You cannot set a profile for a Classification whose management type is
manual.
For more information about managed objects, see “Configuring Item Types as
Classifiable” on page 8. For more information about accepting or rejecting system-
suggested Classifications for items, see “Maintaining Classifications” on page 15.
For more information about setting a Classifications management type, see OpenText
Content Server - Classifications User Guide (LLESCLS-UGD).
Profile Tab
If the management type is assisted or automatic, the Profile tab will be visible when
you view a Classification's Properties page, and you will be able to:
Each of these criteria are used to determine if a managed object meets the
Classification's profile and to determine if it should be automatically classified or if
the Classification should be suggested.
Note: You must click the Construct Profile Query button on the Profile tab,
and the Save as Profile button on the Search page, before a change to the
relevance score threshold takes effect.
Once you add the Exemplar Documents, you must construct the Profile Query to
store the key phrases in the profile. A Profile Query is a set of search criteria that
defines the parameters for automatic and assisted Classifications.
Note: Content Server can extract key phrases from only the latest major version
of an Exemplar Document that contains both major and minor versions.
Although you can add Documents without a major version as Exemplar
Documents, these documents cannot contribute key phrases to the
Classification profile.
Note: You can edit the key phrases in the fields for Exemplar Documents and
complex queries from imported Classification taxonomies; however, Content
Server will not save your edits.
• Click the Use Default radio button to use the default relevance score
threshold value.
• Click the Use Specific radio button to enter a custom value, and then type a
value from 1 to 100 in the input field.
3. On the Select Exemplar Document page, navigate to the document that you
want to add, and then click the associated Select link.
4. Repeat steps 2 and 3 for all Exemplar Documents that you want to add.
5. Click the Construct Profile Query button. For instructions on constructing the
Profile Query, see “To Construct the Profile Query” on page 13.
• In the first text field, type any user-defined phrases you want to use to
define the Classification.
• In the second text field, edit the Exemplar Document key phrases (if you
have used an Exemplar Document or Documents, and you want to edit the
automatically extracted key phrases).
• In the third text field, edit the key phrases from the imported Classification
complex query (if you have imported a Classification complex query, and
you want to edit the automatically extracted key phrases).
4. In the System Attributes section, specify the search criteria you want.
Note: You cannot add advanced options to the Classification Profile Query
page (for example, Natural Language Query and Scope). Content Server will
ignore these additional criteria. However, you may narrow the Profile Query
using the Categories, Browse Content Server, and XML Types links.
Note: The Indexing Processes (Update Distributors and Index Engines) of each
Enterprise Data Source must be running to receive and execute commands.
When you use the Classify Existing Content options, Content Server issues
Classification Profile Queries against all managed items, and then imports the
resulting IPools and processes the results, either assigning or recommending
Classifications.
Important
Executing general Classification Profile Queries against large amounts of
content at one time may increase the load on the Import Agent, slowing the
server and the Classification process.
On the Set Auditing Interests page, you can specify which events are audited. You
can also view information about using the Classify Existing Content functionality on
all objects by selecting the appropriate criteria on the Query Audit Log page. For
information about the query audit log, see OpenText Content Server - Content Server
Administration Guide (LLESWBA-AGD).
3. Click Continue.
The processing of automatic and assisted Classifications will be completed with
the next scheduled Consumer Five Minute Agent execution.
When managed objects are added to Content Server, they are evaluated based on the
rule definition. You can create a complex expression for multiple Classifications
connected with And, Not, or Or modifiers. When using the storage provider rules,
Content Server evaluates the classified items in ascending order, and then stores the
items based on your specified criteria. For more information about flexible storage,
see OpenText Content Server - Content Server Administration Guide (LLESWBA-AGD).
2. On the Configure Storage Rules page, click the Add new rule before this one
icon.
3. On the Add New Rule page, click Node assigned classifications '?' in the Select
a Rule drop-down list.
• Browse Classifications
• My Favorites
6. Click the storage provider for the rule in the Logical Storage Provider drop-
down list.
7. Click Submit.
In the following cases, you must regenerate the Classification Query File so that it
contains the latest Profile Query information:
profile of each assisted Classification. If the item fits the profile for an assisted
Classification, Content Server suggests the Classification for the item. You can either
accept or reject the Classification, or you can defer the decision by leaving the item's
status as pending.
By purging the database of rejected Classifications, you remove entries based on the
specified number of days that they have been in the database. The default value is 45
days. Entries that are 45 days and older are purged.
Note: If you purge entries from the Content Server database, Classifications
that have been rejected for objects might be automatically suggested again.
2. On the Regenerate Classification Query File page, click Regenerate Query File.
1. In the Classification Workspace, click the Functions menu for the Classification
Tree or Classification that you want to manage, and then choose Manage
Classification.
Tip: You can leave an object's status as pending if you do not want to accept or
reject its suggested Classification. After you click the Submit Status Changes
button, the system displays either a list of pending objects that have not
already been displayed, or, if none remain, an empty list. To view pending
objects that have already been displayed, return to the Content Server
Administration page, and then click the Manage Pending Objects link.
2. On the Purge Rejected Classifications for Objects page, specify how many
days old the entries that you want to purge must be in the Days Old field.
For information about the opentext.ini file, see OpenText Content Server - Content
Server Administration Guide (LLESWBA-AGD).
For example, if
siblingCompressRatio is
set to 75, lowScoreThres is
set to 40, and three of the
four assisted Classifications
within the automatic
Classification named Reports
match a document with
relevance scores greater than
or equal to 40, Content Server
assigns the Reports
Classification to the
document instead of the
three assisted Classifications.
If the
bulkClassDisplayNum
setting is set to a number of
Classifications that is less
than the number that is
assigned to an item, a view
all link is displayed.
Clicking this link displays all
Classifications that are
assigned to the item. If
assigned Classifications are
displayed for multiple items,
you can click a link at the top
of the page to show all
Classifications assigned to all
items.
You can export and import the entire Classification Workspace, a Classification Tree,
or a Classification. When you export the Classification Workspace, all Classification
Trees and Classifications in the Workspace are exported. When you export a
Classification, it becomes a Classification Tree when imported. For example, if you
have a Classification named Project Schedules that is currently stored in the Product
Development Classification Tree, you can export the Project Schedules Classification
and import it into another Content Server installation. In this case, the Product
Schedules Classification is imported as a Classification Tree.
Note: If you have not enabled the Intelligent Classification functionality, when
you import any Classification Trees, the management type is set to manual and
any associated profiles are disabled. For more information about enabling
Intelligent Classifications, see “Enabling Intelligent Classification
Functionality” on page 9.
XML Classification Taxonomies are composed of a series of XML tags that define a
hierarchy of Classifications, including the names of all the Classifications and their
profile information.
Header Section
The first part of an XML Classification taxonomy is a header section that defines the
XML file and the Classification Tree in general. This section begins with the
following XML declaration, which defines the XML version and the character
encoding used in the file:
Next, the Classification Tree must be defined with the importexport start tag:
Attribute Value
applanguage The language of the application, for example,
USA.
appname The name of the application, for example,
Content Server. This is a required
attribute.
appversion The version number of the application, for
example, 16.2.0. This is a required
attribute.
dtdversion The version number of the DTD that defines
XML Classification taxonomies.
exportdate The date and time that the Classification Tree
was exported from Content Server. The
format of this attribute is <yyyy>-<mm>-
<dd>T<hh>:<nn>:<ss> (for example,
2018-04-12T21:31:48), where:
<yyyy> is the year,
<mm> is the month,
<dd> is the day,
<hh> is the hour,
<nn> is the number of minutes,
and <ss> is the number of seconds.
This attribute is optional. When you
construct an XML Classification taxonomy
manually, you do not need to include this
attribute.
Tag Description
classificationtree Defines a list of Classifications. Its attributes
contain settings for the list of Classifications.
classification Defines a Classification. Its attributes contain
all of the Classification's settings.
query Defines the Profile Query for a Classification
when it has been exported from Content
Server. Do not enter a value in this field.
Attribute Value
managementtype The management type of the Classification
Tree or Classification. Valid values are
manual, automatic, and assisted.
name The name of the Classification Tree or
Classification. This value is a string (for
example, Annual Reports).
selectable Whether or not the Classification Tree or
Classification is selectable. Valid values are
true and false.
Attribute Value
subtype The subtype number of the Content Server
object. Valid values are 196 for the
Classification Tree tags and 199 for the
Classification tags.
Attribute Value
score The number entered by the user. Valid
values are 1-100 (inclusive).
description The node description entered by the user.
</classification>
</classification>
1. At the root level of the hierarchy, there can be no more than one
classificationtree element.
2. Each classificationtree and classification element can contain other
classification elements.
At the end of this section, you must include the end tag </classificationtree>
for the classificationtree element .
Tag Description
query This tag defines the profile query for a
classification when it has been exported from
Content Server. Do not enter a value in this
field.
rsi This tag identifies the RSI that is assigned to
the RM Classification. If the RM
Classification does not require an RSI, this
tag need not appear. The RSI cannot exceed
20 characters. This tag is optional.
filenumber This tag identifies the unique file number
assigned to the RM Classification. If a tree of
RM classifications is being created, the full
file number is the concatenation of all the file
numbers up the XML tree. The full file
number cannot exceed 64 characters,
including file number separators.
Furthermore, the File Number must be
unique at any given level. This tag is
required.
filestatus This tag identifies the status of the RM
Classification. This value cannot exceed three
characters and must exist in the Status table
in the Table Maintenance area of the Records
Management Workspace. This tag is
required.
createdate This tag identifies the creation date of the
RM Classification. This value must be of the
form yyyymmdd, where yyyy is the four-digit
year, mm is the two-digit month, and dd is
the two-digit day. This tag is required.
filestatusdate This tag identifies the status date of the RM
Classification. This value must be of the form
yyyymmdd, where yyyy is the four-digit
year, mm is the two-digit month, and dd is
the two-digit day. This tag is required.
essential This tag identifies the Essential code
assigned to the RM Classification. This value
cannot exceed three characters and must
exist in the Essential Record table in the
Table Maintenance area of the Records
Management Workspace. This tag is
required.
Tag Description
storage This tag identifies the Storage Medium code
assigned to the RM Classification. This value
cannot exceed three characters and must
exist in the Storage Medium table in the
Table Maintenance are of the Records
Management Workspace. This tag is
required.
keywords An optional set of keywords that can be
assigned to an RM Classification. This value
cannot exceed 65K characters in MSSQL
Server and 2000 characters in Oracle. This tag
is optional.
subject An optional subject that can be assigned to
an RM Classification. This value cannot
exceed 65K characters in MSSQL Server and
2000 characters in Oracle. This tag is
optional.
dispauthority An optional Disposition Authority that can
be assigned to an RM Classification. This
value cannot exceed 64 characters. This tag is
optional.
cycleperiod The optional update cycle period of the RM
Classification. Valid values are 1, 2, 3, and 12,
which identify the number of months
between review periods of RM Classified
objects. If the Essential code for the RM
Classification is identified as a Vital Record
Code (see the Records Management
administration pages), this tag must be
populated with one of the valid values. This
tag is optional.
closedflag The optional closed flag indicator. Valid
values are 0 and 1. 1 indicates that the RM
Classification is Closed, while a 0 indicates
that the RM Classification is not closed. A
closed RM Classification cannot be assigned
to Content Server objects. If the RM
Classification is closed, this tag must be
populated with a value of 1. This tag is
optional.
Example Files
The following example is an empty Classification Tree named Test Classification
Tree. It is selectable and its management type is set to automatic:
<?xml version="1.0" encoding="ISO-8859-1"?>
</classificationtree>
</importexport>
The following example is a more typical Classification Tree. The name of the tree is
Corporate Information, and it contains three Classifications: About Us, Annual
Reports, and News. Inside News, there are two further Classifications: Press Releases
and Newsletters. At the root level, Corporate Information is non-selectable and its
management type is set to manual, while all the Classifications it contains are
selectable with their management types set to assisted.
<?xml version="1.0" encoding="ISO-8859-1"?>
<query></query>
<query></query>
</classification>
<query></query>
</classification>
<query></query>
<query></query>
</classification>
<query></query>
</classification>
</classification>
</classificationtree>
</importexport>
Note: If you have not enabled the Intelligent Classification functionality, when
you import any Classification Trees, the management type is set to manual. For
more information on Intelligent Classification, see “Enabling Intelligent
Classification Functionality” on page 9.
Note: Depending on system activity, the XML file containing each exported
Classification Tree and the Classifications might not appear in the My
Workspace immediately.
When you import a Classification taxonomy, you can also apply Categories. The
Categories are applied to all new Classification Trees and the Classifications created
by the import process. By default, when specify the import settings, any Categories
that have been applied to the Classifications Volume will appear in the Categories
field.
You can remove these Categories, add additional Categories, or change the
Categories to be applied to the imported Classifications. For more information on
Categories, see OpenText Content Server - Categories and Attributes User Guide
(LLESWAT-UGD).
After a Classification Tree has been imported, you can enable its assisted and
automatic Classifications by regenerating the Classification Query File. For more
information, see “Maintaining Classifications” on page 15.
2. On the Taxonomy Export page, click in the Browse Content Server button, and
then do one of the following:
• Click the Select link for the Classification Workspace to export all
Classification Trees in the Classification Workspace.
• Navigate to a Classification Tree or Classification, and then click its Select
link.
3. Type a name for the XML file in the Export File Name field (for example,
classtree.xml).
4. Click Export.
5. On the Taxonomy Export page, click OK when the export process is complete.
Note: If you click the OK button before the export process is complete, you
will return to the Content Server Administration page and the export process
continues to run in the background.
• To select an XML file that is stored in your computer's file system, click the
Browse button, navigate to the XML file that contains each Classification
Tree that you want to import, and then double-click its name.
• To select an XML file that is stored in Content Server, click the Browse
Content Server button, navigate to the XML file that contains each
Classification Tree that you want to import, and then click its Select link.
3. Click the level of error messaging you want to apply from the Alert Level drop-
down list:
For more information about error messaging, see OpenText Content Server -
Search Administration Guide (LLESWBS-AGD).
4. Optional Click the Edit button in the Categories area to apply or change the
Categories to be applied to the Classification Tree and its Classifications.
5. Click Import.
6. On the Taxonomy Import page, click OK when the import process is complete.
You perform an XML export by adding parameters to the end of the basic Content
Server URL in a Web browser. An example of an XML export URL is:
http://<content_server_URL>?func=ll&objId=<[DataID]>&objAction=xmlexport&<optionalparame
, where:
The XML export query always starts with &xmlexport. Multiple parameters can be
added and are connected with an ampersand (&).
You can use any of the standard XML Export API optional parameters when you use
the XML Export API with Classifications. You can also use other parameters that are
specific to Classifications. The tables below provide information about some
standard XML Export API optional parameters (scope and callbackhandlername)
and the parameters that are specific to Classifications (xmlclassifieditems and
xmlclassificationstatus). For more information about other standard XML
Export API optional parameters, see the OpenText Content Server - XML Import and
Export Guide (LLESCOR-PGD).
“Optional Parameters” on page 39 lists some optional parameters that you can use
in an XML export.
Note: When you use the XML Export API, you must have the See and See
Contents permissions for a Classification object (Classification Workspace,
Classification Tree, or Classification) to be exported and all subitems within the
object. In addition, you must have the System Administration Rights privilege to
set certain optional parameters. “Optional Parameters” on page 39 below also
outlines which optional parameters require this privilege.
You can combine optional parameters to make an XML export more specific. “XML
Export Examples” on page 41 below provides examples of URLs containing
optional parameters that you can combine.
URL Description
<content_server_URL>?func=ll& Exports the contents of the Classification
objId=4962&objAction=xmlexport& Workspace object with object ID 4962 and all
scope=sub&xmlclassifieditems=true associated classified items with “accepted”
status
<content_server_URL>?func=ll& Exports a Classification with object ID 2040
objId=2040&objAction=xmlexport& and all associated classified items, regardless
scope=base&xmlclassifieditems=all of their status
<content_server_URL>?func=ll& Exports a Classification Tree with object ID
objId=2001&objAction=xmlexport& 2001, three levels of child Classifications in
scope=3&xmlclassifieditems= the Classification Tree, and classified items
pending with “pending” status
<content_server_URL>?func=ll& Appends to the export of the object with
objId=2245&objAction=xmlexport& object ID 2245 and its immediate children all
scope=one&callbackhandlername= Classifications with “accepted” status that
classifications& are assigned to the object and its children
xmlclassificationstatus=accepted
<content_server_URL>?func=ll& Appends to the export of the object with
objId=2401&objAction=xmlexport& object ID 2401 all Classifications that are
callbackhandlername= assigned to the object. Also appended to the
classifications& export are the classified items with
xmlclassifieditems=true “accepted” status that have been assigned
the Classifications that are assigned to the
object.