Application Note - Schema Companion and Reference Guide For Content Server
Application Note - Schema Companion and Reference Guide For Content Server
Contents
Revision History .......................................................................................................... 3
Abstract........................................................................................................................ 4
Overview ...................................................................................................................... 4
Application................................................................................................................... 4
Background ................................................................................................................. 4
Non-Disclosure Agreement .............................................................................. 4
Securing a Copy of the Schema Reference Document ................................... 4
Content Server Node SubTypes ................................................................................ 5
Online Help ............................................................................................................. 5
SysReport ............................................................................................................... 7
System Report Sections of Interest ................................................................. 7
WebReport using Custom SubTags ....................................................................... 8
OScript Registry ................................................................................................... 13
DAuditNew & Values of Auditable Events .............................................................. 14
DAuditNew table ............................................................................................ 14
Definitive List of Audit Events using CSIDE for Developers .......................... 15
Nodes Stored to the External File Store (EFS)....................................................... 17
Node Versions ................................................................................................ 17
Storage Provider Rules .................................................................................. 19
Nodes stored to the EFS by default ........................................................ 21
A working example of finding a document on the EFS............................ 22
Content Server Volumes .......................................................................................... 25
TIPS ......................................................................................................... 27
Agent Schedule and Agent IDs ................................................................................ 28
Content Server Access Control and DTreeACL ..................................................... 32
Dtree ACL Type .............................................................................................. 32
Dtree ACL See ............................................................................................... 33
Content Server Users and Groups and KUAF ....................................................... 34
KUAF.Type ..................................................................................................... 34
User Privileges .......................................................................................................... 35
KUAF.UserPrivileges...................................................................................... 35
Notifications .............................................................................................................. 36
DTreeNotify NType......................................................................................... 36
General Interest Settings with NotifyInterests2.............................................. 37
Event IDs and Bit Masked Values .................................................................. 38
EventIDMask .................................................................................................. 38
Agent Schedule and Bit Masked Values ........................................................ 40
AgentSchedule ............................................................................................... 40
Where are all the email Addresses Stored? ......................................................... 42
Attributes ................................................................................................................... 43
Revision History
Version 1: Original Document
Version 2: Minor corrections and added section on Official Schema Document Errata.
Version 3: Added LPAD-17904 and LPAD-17905 to Official Schema Document Errata.
Version 4: Added General Interest Settings in NotifyInterests2. Added note on LPAD-
20438
Version 5: Updated WorkAudit_Status and Added new table for undocumented
WorkAudit_Status Codes (ITSM 501199), LPAD-17463
Version 6: Intermediate updates, not published
Version 7: Updated and revised for Content Server versions 20.x and 21.x
Version 8: Updated to comply with the Accessibility for Ontarians with Disabilities Act
Abstract
Application Note dealing with Content Server providing ancillary reference information
and schema companion information to assist system administrators and users creating
and editing LiveReports or WebReports.
Overview
This application note was written to enhance product information that may not be
covered in documentation to date and to expand on information that is presently
provided either in Content Server Training Courses or Customer Support materials.
Application
The purpose of this Application Note document is to provide ancillary or companion
information to what is provided in the official Content Server SDK System Schema
Reference, which is the official Schema guide describing the database tables and
columns for Content Server.
IMPORTANT:
Some of the schema table values described in this document may
not be present in all Content Server software versions, due to the
evolution of the database schema and software.
Background
Non-Disclosure Agreement
For those readers with previous experience with databases, understanding the schema
of a system provides most of the keys to understanding how it is implemented. As a
result of this, the official Content Server Schema Documentation is considered
confidential and to obtain a copy of this document, it is necessary sign an NDA or Non-
Disclosure Agreement.
Online Help
One of the first resources or references that is available is the Online Help, specifically
searching the Admin Help for the exact phrase: node type number.
Just be mindful that while the Online Help provides a good resource, it is not
exhaustive, nor does it include all the modules that may be installed against your
system.
The search results will provide a listing for the Node Type Number to Name Mapping
help page, as illustrated in the following figure:
IMPORTANT:
Remember this static help page will not be fully representative of
Node Types in your Content Server system, so the information in
the help is not exhaustive and is intended only as a help resource.
SysReport
Another excellent resource to utilize for subtype reference information is the System
Report or sysreport (e.g., C:\OTHOME\logs\sysreport.txt).
One part of the comprehensive report generated by the Admin user account, produces
a section of the report entitled Node Types which identifies the node ID, node
description, and a count of the number of those nodes in the system (at the time the
report was run).
NOTE:
The System Report or sysreport must be run while logged in with
the Admin user account.
The report generation can be triggered by either using:
(a) ?func=admin.sysreport
(b) navigating to the Global Menu Bar >> Admin >> Content
Server Administration to reach the Administration pages.
Scroll to the Core System – Server Configuration section
and click the System Report link.
Choose either a lite or a full report from the radio button. The full
report will include ‘Table Column Information’ that is not provided
in the lite report.
Remember to click Generate at the bottom of the page.
IMPORTANT:
The list of Node Types will be representative of your Content
Server system at the time the report was run, however, as modules
are installed or uninstalled, you will need to run the report again to
get an accurate list of Node Types.
The same is true of when the system is upgraded or updated.
{
"fMinParms":0,
"fMaxParms":10,
Figure 5 "fShowInTagGuide":false,
Example of nodelist.txt..json
"OverrideRule": "UPVERSION",
file
"Version": "1.0.1",
"Documentation":"<p>Custom Subtag for Node Subtype
Listing.</p>"
}
Refer to Appendix B for the output generated by this WebReport with custom subtags.
IMPORTANT:
The list of Node Types will be representative of your Content
Server system at the time the WebReport was run, however, as
modules are installed or uninstalled, you will need to run the
WebReport again to get an accurate list of Node Types.
The same is true when you upgrade or update your Content
Server version.
A ‘clone’ of the previously discussed WebReport can also be created but instead has
a destination of spreadsheet. With versioning enabled, you can run the WebReport
and add a new version of the spreadsheet, each time you upgrade or update your
Content Server. This provides an efficient way for an administrator to keep track of the
Content Server’s Node Types each time the system is updated, or modules are
installed or uninstalled throughout the lifecycle of the system.
Example of the Webreport destination tab (as a spreadsheet) with versioning
configured is illustrated in the following figure:
Figure 7
Example of WebReport with
a spreadsheet destination
and using versioning
Figure 8
Example of WebReport
generated spreadsheet,
added as a new document
version
OScript Registry
Another resource is located on the My Support, formerly the Knowledge Center (or KC
for short), is called the OScript Registry. This resource would be suitable if you were
using modules produced by OpenText Partners or those produced by OpenText’s
Services group and wished to identify the subtypes that these modules were using.
Figure 9
OScript Registry available
via My Support and
registered objects for
OpenText Partners or
Services group
Figure 10
Users can search for various
registered number using the
OScript Registry
DAuditNew table
The first place Content Server administrators can look for common audit ID [numbers]
and corresponding audit event [names] is the DAuditNew database table.
IMPORTANT:
Keep in mind that the DAuditNew table will NOT contain a
comprehensive list of audit IDs/audit events. This is especially true
of newly installed or ‘young’ Content Server installations.
For an event to be logged to the DAuditNew table, the event must
be enabled (i.e., Global Menu Bar >> Admin >> Content Server
Administration >> Core System – Feature Configuration >> Event
Auditing >> Set Auditing Interests).
The following [Microsoft] SQL statement can be used to obtain a representative list of
common audited events for your system, based on its current configuration (i.e., Set
Auditing Interests).
Figure 11
Example of a DAuditNew
table query to generate a list select distinct auditid, auditstr from dauditnew order by
of common audit events for auditid
your Content Server system
Figure12
Example of inspecting the
Content Serve’s
AuditSubsystem’s fRegistry
object using CSIDE
IMPORTANT:
A discussion of the Content Server IDE or CSIDE is outside the
scope of this document, however, for those interested in learning
how to use this Content Server developer product, you can refer to
the 4-0140 Content Server IDE (CSIDE) Fundamentals course.
https://www.opentext.com/products-and-
solutions/services/training-and-learning-services/course-
catalog/opentext-content-suite-training-offerings
There is also a developer community forum available at the
following URL:
https://forums.opentext.com/forums/developer/discussion/294672
/where-can-i-find-information-about-cside-and-how-to-use-it
Refer to Appendix C for the information retrieved from the fRegistry object. Please
keep in mind that this list of audit IDs and events is [only] representative of this
particular Content Server system and version.
Node Versions
The following table illustrates typical nodes that are versioned and is therefore stored
to the EFS. This Node version information can be secured from the same System
Report that was previously discussed.
Activeview 30309
Blog 356
BlogEntry 357
Category 131
CustomView 146
CustomViewTemplate 844
Document 144
Email 749
Form 223
HTMLFormView 226
LLNodeForum 123469
LLNodeForumEntry 123470
Perspective 957
ProjectTemplate 543
ProspectorQueries 380
QueryFile 296
Rule 958
SearchBroker 258
SearchReport 278
SearchTemplate 292
SupportAssetDocument 1307
Task 206
Template 230
TransportBox 531
TransportItemPart 527
WebFormDatabaseConnection 235
WebFormLookup 234
WebReports 30303
WIKIPAGE 5574
WorkflowAttachments 154
Figure 13
Illustration of the Content
Server Storage Provider
Settings section on the
Administration pages
Clicking the Configure Storage Rules [link] displays the Configure Storage Rules
page, as illustrated in the following figure:
Figure 14
Example of the Configure
Storage Rules page
Clicking the Edit icon opposite the Provider rule for the storage of objects without
contents will reveal the rule editor, as illustrated in the following figure:
Figure 15
Example of the Storage
Provider rule editor
WARNING:
New installation of Content Server 20.x or 21.x will have the default
EFS node configuration just discussed, however, systems that
were upgraded to 20.x or 21.x from a previous version like 9.7.x,
10.x or 16.x will not have their previous EFS node configurations
updated during the upgrade/update.
If this is a concern to a Content Server administrator, they should
review these configuration settings as part of their investigative
efforts before performing the upgrade/update.
IMPORTANT:
A discussion of the Content Server database schema is outside
the scope of this document, however, for those interested in
learning how to write SQL queries, LiveReports or WebReports
against the Content Server database tables, you can refer to the
3-0127 – Content Server Schema and Report Fundamentals
course.
https://www.opentext.com/TrainingRegistry/course/details/2889
For this example, the following SQL query statements are required:
The SQL queries were run using Microsoft SQL Server Management Studio, as
illustrated in the following figure. What is important to note is that node 17952
corresponds to the sleeping bag document and the information returned from the last
SQL query corresponds to the EFS location where the document is stored.
Figure 17
Example of the SQL queries
run against the OTCS162
database
The result of the last SQL query returned the external file storage (EFS) location of the
document, as illustrated in the following figure:
Figure 18
A<1,?,'providerInfo'='0000\\017\\17952.dat','storageProviderName'='
Example of the storage
ExtShared','subProviderName'='Default'>
location of a document
Figure 19
EFS location of a document
stored externally
You should be able to open the 17952.dat file using Microsoft Word, as illustrated in
the following figure, thus demonstrating the ability to locate a document stored to the
EFS with Content Server.
Figure 20
Example of Microsoft Word
document stored to the EFS
with Content Server
NOTE:
If using the previously discussed WebReport with custom subtags,
you could use a name input filter to generate a list of node subtypes
that pertains only to volumes (that is how the following list was
generated).
The following table provides a representation of common Content Server volumes, and
their node subtype values:
201 Project
31069 CM Workspace
TIPS
• DTree.OwnerID is a foreign key to the DataID of a volume.
• For personal workspaces, DTree.DataID is equal to the Kuaf.ID for the user to
whom the personal workspace belongs; the items in the personal workspace store
the inverse of the user's ID number in DTree.OwnerID.
• DTree.OwnerID is sometimes the inverse of the DataID of the volume. This is the
case when the item is in one of the ‘behind-the-scenes’ volumes, such as items in
the LiveReports, Categories, or System Object Volumes.
1000 LateEventProducer Agent runs at midnight, creates events for tasks, workflows
that are late and for closing polls
3502 SOVSystemManagement Livelink records the status or condition of the system objects
and reports this information to the system object alert e-mail
Adding E-Mail Recipients
3601 Pstage ItemAdded Agent Agent processes, processed itemes added to pstage
4101 MonitorPwdExpiration Notifies users that their passwords will soon expire
5000 eLink (inbound) Agent to process inbound email for eLink module
5001 eLink (outbound) Agent to process outbound email for eLink module
5858 Recommender Agent, which tracks user behavior, and to view and purge
data from the agent's database tables
7900 BestBets Best Bets expiry agent is used to expire best bets entries
8010 RecycleBin Purge Agent Recycle Bin Module, to provide similar functionality as the
undelete purge agent
8999 ClearNotifyEvents Processes events from the NotifyEvents table, inserts them
into LLEventQueue and assigns them to individual
consumer IDs (5001: eLink, 9001: Content Server).
9052 RCQueueInsert 9052 clears out old data from the RCQueue table, then adds
items to it that need to be added
9120 QuotaManagementAgent Quota module: Sends emails when users are over their
quota or their threshold
For a comprehensive list of your Content Server agent IDs and events, a CSIDE
developer would want to review or inspect the following object:
Modules >> webnotify >> LLAgent >> LLAgentSubsystem >> #190038e4 (or temp
object) >> fRegistry then Inspect fRegistry, as illustrated in the following figure:
Figure 21
Example of inspecting the
Content Serve’s
AgentSubsystem’s fRegistry
object using CSIDE
Owner 1
Owner Group 2
Public Access 3
System Administrators 4
NOTE:
IMPORTANT:
Beginning with Content Server 16.2.4, there was an
additional dtreeacl permission where a document has
advanced version control enabled (i.e., major/minor
versioning for a document).
None 0
See 1
See Contents 2
Modify 3
Delete 4
NOTE:
User 0
Group 1
Domain 5
X_Domain_Group 6
Warehouse System 10
OT Explorer Users 13
User Privileges
KUAF.UserPrivileges
User privileges such as system administration rights are stored to the Content Server
database as bit masked values.
The following table illustrates bitmask information for the KUAF.UserPrivileges
column:
IMPORTANT:
A detailed discussion regarding the eDiscovery privileges is
outside of the scope of this document. However, 8206 (200 hex)
is associated with the enabling of the eDiscovery user privilege,
but a 12302 (300 hex) value is associate with the enabling of the
privilege and the user turning on eDiscovery mode, as illustrated
by the following pair of OScript lines of code:
Notifications
DTreeNotify NType
The following reference table may be useful when constructing SQL statements or
Reports:
NType Description
DTreeNotify NType
Value
EventIDMask
The following table illustrates common EventIDMask values for General Interest
Settings in the NotifyInterests2 table:
1 2 A topic is added
2 4 A reply is added
3 8 An item is added
4 16 A version is added
5 32 I am added to a group
6 64 A task is assigned to me
AgentSchedule
The following table illustrates common AgentSchedule values:
Sun 12 am 00 1 1 0
Mon 1 am 05 2 10 1
Tues 2 am 10 4 100 2
Wed 3 am 15 8 1000 3
Thurs 4 am 20 16 10000 4
Fri 5 am 25 32 100000 5
Sat 6 am 30 64 1000000 6
7 am 35 128 10000000 7
8 am 40 256 100000000 8
9 am 45 512 1000000000 9
10 am 50 1024 10000000000 10
11 am 55 2048 100000000000 11
12 am 4096 1000000000000 12
1 pm 8192 10000000000000 13
2 pm 16384 100000000000000 14
3 pm 32768 1000000000000000 15
4 pm 65536 10000000000000000 16
5 pm 131072 100000000000000000 17
6 pm 262144 1000000000000000000 18
7 pm 524288 10000000000000000000 19
8 pm 1048576 100000000000000000000 20
9 pm 2097152 1000000000000000000000 21
10 pm 4194304 10000000000000000000000 22
11 pm 8388608 100000000000000000000000 23
AgentConfig DftMsgFromAddress
email address to use as the from address when notification emails are
sent.
DftMsgReplyTo
email address to use as the Reply to address when Notification emails
are sent
DftMsgSubject
email subject to use when Notification emails are sent
OnErrAddress
email address to send message about any notification errors that might
occur
OnErrSubject
email subject on any message sent to onerraddress
SMTPHELOHostName
Address of the server that sends the email
DftTransportIDSMTP
default is 200
AgentSchedule Enabled
0==not enabled; 1==enabled; personal schedules 0==viewed;
1==emailed
MsgAddress
email address of the user
ReportID
type of report; 100=mailable; 101=non-mailable
KUAF MailAddress
users email
PersonalEmail
personal email address
NotifyMessages Table stores notification messages that are emailed to other users
ELINKALIAS elinkalias.emailalias
elink subscribed discussions etc. and its email to alias
Attributes
LLAttrData Attr Type
The following reference table may be useful when constructing SQL statements or
Reports:
Category -18
Date field -7
Date popup 13
Flag checkbox 5
Integer field 2
Integer popup 12
Text field -1
Text multiline 11
Text popup 10
User field 14
Workflow
WMapTask and MapTask_Priority
WMapTask contains the column MapTask_Priority. This column contains a value that
denotes a workflow step’s priority, which is manually assigned by a Content Server
user.
Low 0
Medium 50
High 100
WorkAudit_Status Values
Work started 1
Work suspended 2
Work resumed 3
Work stopped 4
Work done 5
Work archived 6
Sub-work started 11
Sub-work done 12
Sub-work updated 13
Task ready 21
Task accepted 22
Task reassigned 23
Task started 24
Task cancelled 25
Task killed 26
Task suspended 27
Task resumed 28
WorkAudit_Status Values
Task done 29
Task finished 30
TBD 31
User data 41
NOTE:
The following SQL query can be used to create a similar list of
status values.
select distinct workaudit_status from
WWorkAudit order by workaudit_status asc
WWork.Work_Status
Workflow Status Codes for WWork.Work_Status: Overall workflow Status Code
Meaning.
WWork.Work_Status Value
WSubWork.SubWork_Status
Workflow Status Codes for WSubWork.SubWork_Status: Sub-workflows within a
Workflow.
WWork.SubWork_Status Value
WSubWorkTask.SubWorkTask_Status
Workflow Status Codes for WSubWorkTask.SubWorkTask_Status: Each Task within
a Sub-workflow.
WSubWorkTask.SubWorkTask_Status Values
Finished; User worked on step and saved changes, but didn't send -3
workflow on
Appendix A
0 Folder Folder
1 Shortcut Alias
2 Generation Generation
NOTE:
The table in Appendix A contained a tabulated copy of the
information contained in the Node Type Info section of a sysreport.
The information from the UI Only Node Type Info also appearing
in the sysreport was not included in Appendix A.
Appendix B
0 Folder Folder
1 Shortcut Alias
2 Generation Generation
31069 CMWorkspaceVirtualLLContainer
Appendix C
Event ID and Audit Events
The following table was derived using CSIDE.
1
The term Alias was used in earlier versions of Livelink/Content Server and has been replaced with the term
SHORTCUT.
2
The term Fetched was used in earlier versions of Livelink//Content Server and has been replaced with the
term OPEN
3
The term CD refers to a Compound Document within the Content Server context.
4
Value1 in the DAuditNew will hold the identifier for the configuration value that has been changed
5 Value1 in the DAuditNew will hold the identifier for the function that has been executed. Example of the
functions that are being audited: (Database verification, Module upgrade, Module Installation, module un-
installation, Database upgade, Testing email transport)
46 Restore
124 PO - Borrowed
126 PO – Request
127 PO – Pass
130 PO – Returned
220 Send document copy via email A document node has been sent
via e-Link as a copy
221 Send document link via email A document node has been sent
via e-Link as a URL link
6
When a document is edited with a WebDAV-aware application directly through WebDAV, the application
may save the document several times throughout the editing session. When WebDAV version management
is enabled, intemediate document versions that are not stored, are reported by the auditing event "Version
Superseded"
5001 ActiveViewConfig
5002 ArchiveStorageProviderConfig
5004 CollectionsConfig
5005 CommunitiesAdminConfig
5006 DocViewerConfig
5007 DPSConfig
5008 eLinkAdministrationConfig
5009 LanguagesConfig
5010 NotificationChanged
5011 OfficeOnlineAdminConfig
5012 ProspectorConfig
5013 PulseConfig
5014 RecommenderConfig
5015 RenditionConfig
5016 ServerConfigurationConfig
5017 SystemAdminConfig
5018 TransportConfig
5019 WebSBrokerConfig
5020 WebUserConfig
5024 MetaDataConfig
5027 WorkFlowConfig
5029 DirectoryServicesConfig
5030 WebFormsDBLookupAdminConfig
5031 ContentServerApplicationsConfig
5032 WebReportsConfig
5033 LiveReportConfig
5034 AuditInterestConfig
5035 FamilyHintConfig
5036 AttributeRequiredConfig
5037 WebReportsWFConfig
587 WR WF Step
About OpenText
OpenText enables the digital world, creating a better way for organizations to work with
information, on premises or in the cloud. For more information about OpenText (NASDAQ:
OTEX, TSX: OTC) visit opentext.com.
Connect with us:
Copyright © 2021 Open Text. All rights reserved. Trademarks owned by Open Text.