IBM Content Manager for Multiplatforms Version 8 Release 2: System Control Tables

WARNING: This set of views is for temporary use only until the next version that supports Content Manager tables. Applications should not presume that these views exist in every database and should consider that these tables may not be provided in future versions.

(C) Copyright International Business Machines Corporation 2003. All rights reserved.
U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.


Contents

ACL related database tables and pre-configured settings

  • System Control Table (ICMSTSysControl)
  • Administration Domain Table (ICMSTAdminDomains)
  • Privilege Definition Table (ICMSTPrivDefs)
  • Privilege Set Code Table (ICMSTPrivSetCodes)
  • Privilege Set Table (ICMSTPrivSets)
  • Domain Privilege Set Table (ICMSTDomainPrivSet)
  • Privilege Group Code Table (ICMSTPrivGroupCode)
  • Privilege Group Table (ICMSTPrivGroups)
  • User Table (ICMSTUsers)
  • User Group Table (ICMSTUserGroups)
  • Access Control List Code Table (ICMSTAccessCodes)
  • Domain Access Control List Code Table (ICMSTDomainAccess)
  • Access Control List Table (ICMSTAccessLists)
  • Compiled ACL Table (ICMSTCompiledACL)
  • Compiled Permission Table (ICMSTCompiledPerm)
  • Item related database tables and pre-configured settings

  • Attribute Definitions Table (ICMSTATTRDEFS)
  • Attribute Group Definitions Table (ICMSTATTRGROUP)
  • NLS Keywords Table (ICMSTNLSKEYWORDS)
  • NLS Languages Table (ICMSTNLSLANGUAGES)
  • Item Type Definition Table (ICMSTITEMTYPEDEFS)
  • Item Type View ID Table (ICMSTITVIEWID)
  • Item Type View Definitions Table (ICMSTITVIEWDEFS)
  • Component Definition Table (ICMSTCOMPDEFS)
  • Component Tables

  • Component Root Tables (ICMUTnnnnnsss)
  • Component Child Tables (ICMUTnnnnnsss)
  • Component Attributes Table (ICMSTCOMPATTRS)
  • Component Attributes Foreign Key Table (ICMSTCOMPATTRSFK)
  • Component View Definitions Table (ICMSTCOMPVIEWDEFS)
  • Component View Attributes Table (ICMSTCOMPVIEWATTRS)
  • |Component View Access Table (ICMSTVIEWACCESS)
  • Item Auto Link Table (ICMSTITEMAUTOLINK)
  • Items Table (ICMSTITEMSnnnsss)
  • Item Versions Table (ICMSTITEMVERnnnsss)
  • Item To Be Deleted Table (ICMSTItemsToDelete)
  • Item Links Table (ICMSTLINKSnnnsss)
  • Item Type Relation Table (ICMSTITEMTYPEREL)
  • Checked Out Table (ICMSTCHECKEDOUT)
  • Transaction Logging Table (ICMSTTXLT)
  • Resource Table (ICMUTnnnnnsss)
  • Resource Manager Table (ICMSTRESOURCEMGR)
  • Resource Manager Access Types Table (ICMSTRMACCESSTYPES)
  • Collection Names Table (ICMSTCOLLNAME)
  • MIME Types Table (ICMSTMIMETYPES)
  • Item Events Table (ICMSTITEMEVENTS)
  • System Administration Events Table (ICMSTSYSADMEVENTS)
  • Text Search Table (ICMSTTEXINDEXCONF)
  • XDO Objects Table (ICMSTXDOOBJECTS)
  • XDO Object Factory Table (ICMSTXDOOBJFACTORY)
  • Reference Integrity Table (ICMSTRInnnsss)
  • Replicas Rules Table (ICMSTREPLICARULES)
  • Replicas Table (ICMSTREPLICAS)
  • Document routing tables

  • Item type: Routing Process (200)
  • Item type: Work Node (202)
  • Item Type: Work List (206)
  • Resource manager tables

  • RMVERSION
  • RMACCESS
  • RMSERVER
  • RMOBJECTS
  • RMDEVMGR
  • RMSTORAGEGROUP
  • RMMGTCLASS
  • RMCOLLECTIONS
  • RMSTORAGECLASS
  • RMSTRINGS
  • RMCNTL
  • RMREPLICATION
  • RMSTAGING
  • RMVOLUMES
  • RMSTGGRPVOLUME
  • RMSTGGRPCLASS
  • RMMGTTRANSITION
  • RMTABLES
  • RMSYNCSCHED
  • RMSYNCSTATUS
  • RMSYNCREPORT
  • RMSYNCVOL
  • RMSYNCVOL
  • RMPARTS
  • RMTRACKING
  • Trademarks


    ACL related database tables and pre-configured settings


    System Control Table (ICMSTSysControl)

    This table stores system configuration parameters for the Content Manager library server.

    Table 1.

    Column Name Data Type Attribute
    LibraryServerID INTEGER NOT null
    LanguageCode CHAR(3) NOT null
    SysSegmentID SMALLINT NOT null
    SysSegmentThreshld INTEGER NOT null
    ACLBindingLevel SMALLINT NOT null
    LibraryACLCode INTEGER NOT null
    PubAccessEnabled SMALLINT NOT null
    DfltACLChoice SMALLINT NOT null
    SMSChoice SMALLINT NOT null
    TraceLevel SMALLINT NOT null
    MaxUsers INTEGER NOT null
    MaxUserAction SMALLINT NOT null
    CurrentUsers INTEGER NOT null
    MaxLogonRetry SMALLINT NOT null
    PasswordDuration SMALLINT 180 (days)
    SysAdminEventFlag SMALLINT NOT null
    SystemFlag SMALLINT NOT null
    DatabaseType SMALLINT NOT null
    MaxTxDuration INTEGER NOT null
    MaxResultSetSize INTEGER NOT null
    AllowTrustedLogon SMALLINT NOT null
    DocRoutingUpdate INTEGER NOT null
    DocRoutingFreq SMALLINT NOT null
    Platform SMALLINT NOT null
    SysTimeout SMALLINT NOT null
    TIEUserID CHAR(32) nullable
    TIEPassword CHAR(72) FOR BIT DATA nullable
    DatabaseName VARCHAR(128) NOT null
    DBSchemaName VARCHAR(128) NOT null
    TraceFileName VARCHAR(128) nullable
    EncryptionKey VARCHAR(128) FOR BIT DATA NOT null
    KeepTraceOpen SMALLINT NOT null
    MultipleTraceFiles SMALLINT NOT null
    MaxTraceFileSize INTEGER NOT null
    PathICMRoot VARCHAR(128) NOT null
    PathICMDLL VARCHAR(128) NOT null
    SuspendServerTime TIMESTAMP nullable
    RMStatusInterval SMALLINT NOT null
    RMStatusTimeout SMALLINT NOT null
    TIEInterval SMALLINT0 NOT null
    LSCurrentVersion VARCHAR(128) NOT null
    TraceUser CHAR(32)

    Primary Key
    LibraryServerID.

    Indexes
    None.

    Referential Constraints
    Foreign Key = (LibraryACLCode)
      references ICMSTAccessCodes (ACLCODE)
        on delete restrict
    

    Column Definitions

    LibraryServerID
    User defined library server ID during installation. The default is 1. Valid values are 1 to 99. You must maintain single rows in this table. If you have more than one library server in your enterprise, you should consider assigning a different value to each library server. This value is a part of item ID, and cannot be updated.

    LanguageCode
    The 3-character language code assigned to each written language. The language codes are assigned to the written languages of the world by IBM(R). The language codes are documented in a new spec document of the IBM National Language Design Guide: National Language Support Reference Manual, Volume 2. It is an Installation parameter.

    Implementation: When a user is logged on to ICM system, if the LanguageCode is not provided, the logon SP(TM) (ICMlogon) will extract LanguageCode from System Control table (ICMSTSYSCONTROL) as a default language and save it to both structures ICMUSERINFO_STRUCT and ICMSESSION_STRUCT. You can get the language code from the struct ICMUSERINFO_STRUCT returned by API ICMLogon for subsequent calls. If the language code is omitted, the ICM system (for each API documented) will provide it through the struct ICMSESSION_STRUCT at the time that the parameter language code is validated in the API level.

    SysSegmentID
    SysSegmentID of a physical system table (ICMSTITEMSnnnsss, ICMSTITEMVERnnnsss, and ICMSTLINKSnnnsss). The default is 1. Valid values are 1 to 999. If a segment size has exceeded the SysSegmentThreshld, a new segment is created and the SysSegmentID is incremented by one. Reserved for future implementation.

    SysSegmentThreshld
    Maximum number of rows per segment. Reserved for future implementation.

    ACLBindingLevel
    The access control level. (See "ACLBindingLevel" of the section "Configuration" for details.) Can be updated. Valid values are:

    0
    At Item Type level. (default).

    1
    At Item level.

    2
    Mixed (Item & Item Type). This is the default.

    3
    At entire Library level.

    LibraryACLCode
    This parameter contains the ACL to be associated with all CM Item Types and Items if the parameter ACLBindingLevel is configured at Library level. Can be updated.

    PubAccessEnabled
    Indicates whether the capability of opening a bound entity public to public is enabled. Can be updated. If any of the columns ACLBINDINGLEVEL, PUBACCESSENABLED, LIBRARYACLCODE are updated, the system recreates all CM user and base views. If PubAccessEnabled is updated, the system rebuilds the compiled ACL table. Valid values are:

    1
    True, enabled.

    0
    False, disabled.

    DfltACLChoice
    The default ACL code. Can be updated. Valid choices are:

    0
    Use the Item Type's ACL, stored in ICMSTItemTypeDefs.ItemTypeACLCode.

    1
    Use the user profile's ACL, stored in ICMSTUsers.DfltACLCode.

    2
    Use the Library's ACL, stored in ICMSTSysControl.LibraryACLCode.

    SMSChoice
    When a value is not provided for both the object server and the collection name, SMSChoice indicates which default values to use for these parameters when creating an item part. Valid values are:

    0
    Uses the defaults associated with the user for both the collection name and the object server.

    1
    Uses the defaults associated with the item type for both the collection name and the object server.

    2
    Uses the defaults associated with the item type for the collection name and defaults associated with the user for the object server.

    TraceLevel
    The identifier that indicates what level of trace data to log in the file.
       0 - 0x000000  ICMTRACE_OFF
       1 - 0x000001  ICMTRACE_BASIC
       2 - 0x000002  ICMTRACE_DETAILED
       4 - 0x000004  ICMTRACE_DATA
       8 - 0x000008  ICMTRACE_PERFORMANCE
      16 - 0x000010  ICMTRACE_PARSEBUILD
      32 - 0x000020  ICMTRACE_MEMDEBUG
     256 - 0x000100  ICMTRACE_CACHE_TRACE
     512 - 0x000200  ICMTRACE_CACHE_ALLOC
    1024 - 0x000400  ICMTRACE_CACHE_MGT      
    

    MaxUsers
    The maximum number of concurrent users as specified by the administrator. Zero means no limit. No checking will be done, and user counts will not be maintained.

    MaxUserAction
    The action to take when the maximum number of concurrent users is reached. Valid values are:

    0
    Allow the logon but return a "warning" message. (default)

    1
    Reject the logon.

    2
    Allow the logon without a warning.

    CurrentUsers
    An "estimate" of the number of users that are currently logged on. This is incremented by ICMlogon and decremented by ICMlogoff. When ICMlogon finds that the current number of users has reached the maximum, it calls ICMCountUsers. This function will:
    1. Update ICMSTUSERS, replacing any LASTACCESS times older than 30 minutes with 0.
    2. SELECT COUNT for LASTACCESS != 0 to get the count of users.
    3. Store the new count in the system control table. This approach might clean up the counts when the maximum number of concurrent users is reached.

    MaxLogonRetry
    The maximum number of logon failures allowed due to invalid password. For no limit, set to 0.

    PasswordDuration
    The number of days that a password is valid. For no limit, set to 0.

    SysadminEventFlag
    Indicates whether the logging of SystemAdmin events is enabled. Valid values are:

    1
    True, enabled.

    0
    False, disabled. (default)

    System Flag
    The value of SystemFlag should be interpreted in a BIT WISE mode. Bit positions are counted from right to left. Counting starts with number 0, so the rightmost bit is bit number 0 and the leftmost bit is bit number 15. If a particular bit is enabled (set to 1), then the corresponding function in the database is enabled.


    Table 2. SystemFlag bit assignments

    Bit What the bit enables
    0 TIE is enabled.
    1 EIP Advanced WF is enabled.
    2 Information mining (IKF) is enabled.
    3 LDAP is enabled.
    4 Administrative Domain is enabled.
    5 Database is enabled for Content Manager.
    6 Database is enabled for EIP.
    If all bits are 0, it means that nothing is enabled.More bits have been assigned.

    DatabaseType
    The type of the database. Valid values are:

    0
    DB2(R)

    1
    ORACLE

    MaxTxDuration
    The limit on the duration for all explicit CM transactions. When set to 0 (default), the server does not impose a limit. Reserved for future implementation.

    MaxResultSetSize
    Allows an end user to control the size of the result set (number of Items returned from the server). When set to 0 (default) the server does not impose a limit.

    AllowTrustedLogon
    Allows users to log on without a password. The AllowTrustedLogon flag is a feature controlled ONLY by SysAdmin, and must be ON to allow logon without password. The valid values are:

    0
    AllowTrustedLogon is not allowed. (default)

    1
    AllowTrustedLogon is allowed.

    DocRoutingUpdate
    The UNIX(R) time when Suspend or Notify state for Document Routing was last checked.

    DocRoutingFreq
    The frequency of DocRoutingUpdate. Set to 10 minutes, with no interface to change it. Primarily changed for testing purposes.

    Platform
    Identify the platform of the library server. Valid values are:

    0
    Windows(R)

    1
    AIX(R)

    2
    Solaris

    3
    OS/390(R)

    SysTimeout
    Reserved.

    TIEUserID
    The UserID must be defined in the ICMSTUSERS table and must match a DBMS user ID. The CM uses this value for connecting to database before creating TIE index.

    TIEPassword
    The password of the TIEUserID.

    DatabaseName
    The database name of the library server. It is an Installation parameter. Can not update.

    DBSchemaName
    The database schema name of the library server. It is an Installation parameter. Can not update.

    TraceFileName
    Full name including path and file name of trace file used for the server trace and error log For example: C:\ICMSERVER.LOG.

    EncryptionKey
    Use to generate object tokens which access the resources.

    KeepTraceOpen
    Reserved.

    MultipleTraceFiles
    If set to 1, "0" is appended to the trace file name. When that file is full, the "0" is replaced by "1", continuing through "9". Existing trace files are re-used.

    MaxTraceFileSize
    The maximum size for trace files when MULTIPLETRACEFILES is set. If not specified, the default is 10,000,000 so that up to 100 MB of server trace is captured.

    PathICMRoot
    The directory path value of ICMROOT. On Windows or Unix, the path where the library server is installed. Does not apply to MVS(TM).

    PathICMDLL
    The directory path value of ICMDLL. On Windows: same as PATHICMROOT. On Unix: the path to be used for the system generated DLLs. This should be under the fenced UDFs UserID associated with the DB2 instance. Does not apply to MVS.

    SuspendServerTime
    The time that the System Administrator requests transaction blocking for Library Server and resource manager database backup. The utility ServerPause.bat updates this column. The default is NULL.

    This can "pause" the library server to stop all new transactions, and at the same time, allow transactions which are in progress to complete. When that time is greater than the current time, any new transactions are rejected. If an application is storing an object to a resource manager, those operations are allowed to complete as long as they do not exceed the time specified in MAXTXDURATION in ICMSTSYSCONTROL. After that time, any request to the library server is rejected. |

    |RMStatusInterval
    |The duration to wait before checking the status of the resource |managers. The default is 60 seconds. |

    |RMStatusTimeout
    |The duration to wait before marking a resource manager as |unavailable. Then for replication, Content Manager bypasses this RM |whenever another RM is available. The default is 15 |seconds. |

    |TIEInterval
    |The duration to wait before processing the TIELOG table (only for Oracle |usage). The default value is 0 seconds. |

    |LSCurrentVersion
    |The current release version of the library server. The default |value is 8.2.0.00. |

    |TraceUser
    |When TraceUser is set, trace records are written only for that |UserID. This can be used to trace specific problems in a production |system.

    |

    |Table 3. CM Pre-configured System Control Settings

    Column Name Value
    LibraryServerID 1
    LanguageCode ENU
    SysSegmentID 1
    SysSegmentThreshld 0
    ACLBindingLevel 2 (mixed - item type and item)
    LibraryACLCode 3 (PublicReadACL)
    PubAccessEnabled 1 (enabled)
    DfltACLChoice 0 (Item Type)
    SMSChoice 0
    TraceLevel 0
    MaxUsers 0
    MaxUserAction 2
    CurrentUsers 0
    MaxLogonRetry 0
    PasswordDuration 180 (days)
    SysAdminEventFlag 0
    SystemFlag 32 (2^5)
    DatabaseType 0 (DB2)
    MaxTxDuration 86400
    MaxResultSetSize 0
    AllowTrustedLogon 0
    DocRoutingUpdate 0
    DocRoutingFreq 10
    Platform %ICMCRLSDBPLATFORM%
    TIEUserID %ICMCRLSDBUSER%
    TIEPassword %ICMCRLSDBENCRYPTPWD%
    DatabaseName %ICMCRLSDBDBNAME%
    DBSchemaName %ICMCRLSDBSCHEMA%
    TraceFileName %ICMCRLSDBTraceFileName%
    EncryptionKey reserved
    KeepTraceOpen 0
    MultipleTraceFiles 0
    MaxTraceFileSize 0
    PathICMRoot %ICMCRLSDBICMROOT%
    PathICMDLL %ICMCRLSDBICMDLL%
    SuspendServerTime NULL
    RMStatusInterval 60
    RMStatusTimeout 15
    TIEInterval 0
    LSCurrentVersion 8.2.0.00
    TraceUser NULL

    Administration Domain Table (ICMSTAdminDomains)

    This table maintains the administration domain identifier.

    Table 4.

    Column Name Data Type Attribute
    DomainID INTEGER not null

    Primary Key
    DomainID.

    Indexes
    None.

    Referential Constraints
    None.

    Column Definitions

    DomainID
    The CM system-generated administration domain identifier. Cannot be updated.

    Table 5. CM System-defined Administration Domain identifier

    DomainID DomainName* DomainDesc*
    0 AdminDomain ICM system reserved
    1 SuperDomain Super System Administration Domain.
    2 PublicDomain Public Domain.
    1000 DefaultDomain Default User Sub Domain.
    *For illustration only. Name and description are defined in the NLS Keywords table.

    Privilege Definition Table (ICMSTPrivDefs)

    This table maintains the unlimited number of CM privilege definitions, including both CM System-defined and User-defined. All the System-defined Privileges cannot be modified. Each privilege has a system-generated unique code. Codes 0 to 999 are reserved to store CM System-defined Privileges. For User-defined Privileges, 1000 and up are open. When defining or updating Privilege Sets, this table can be first queried to list all defined privileges. Applications can also query this table at runtime to get the definitions of the connected user's privileges and customize the application menu selections specifically suitable for that user. Privilege name and description are defined in the NLS Keywords Table (ICMSTNLSKEYWORDS).

    Table 6.

    Column Name Data Type Attribute
    PrivDefCode INTEGER not null

    Primary Key
    PrivDefCode.

    Indexes
    None.

    Referential Constraints
    None.

    Column Definitions

    PrivDefCode
    The CM system-generated privilege identifier. Cannot be updated.

    Privilege Set Code Table (ICMSTPrivSetCodes)

    This table maintains the Privilege Set definitions. A Privilege Set consists of unlimited number of privileges. Each set is uniquely identified by a CM system-generated code. Its set-member associations are stored in the table ICMSTPrivSets. Privilege set name and description are defined in the NLS Keywords Table (ICMSTNLSKEYWORDS).

    Table 7.

    Column Name Data Type Attribute
    PrivSetCode INTEGER not null

    Primary Key
    PrivSetCode.

    Indexes
    None.

    Referential Constraints
    None.

    Column Definitions

    PrivSetCode
    The CM system-generated administration domain identifier. Cannot be updated.

    Privilege Set Table (ICMSTPrivSets)

    This table maintains associations of CM Privileges with the Privilege Sets. Rows with the same PrivSetCode form a Privilege Set. Rows in this table can only be deleted, not updated.

    Table 8.

    Column Name Data Type Attribute
    PrivSetCode INTEGER not null
    PrivDefCode INTEGER not null

    Primary Key
    None.

    Indexes
    Unique Index = (PrivSetCode ascending, PrivDefCode ascending)
    

    Referential Constraints
    Foreign Key = PrivSetCode
      references ICMSTPrivSetCodes (PrivSetCode)
        on delete cascade
     
    Foreign Key = PrivDefCode
      references ICMSTPrivDefs (PrivDefCode)
        on delete restrict
    

    Column Definitions

    PrivSetCode
    Privilege Set identifier.

    PrivDefCode
    Privilege definition identifier.

    Domain Privilege Set Table (ICMSTDomainPrivSet)

    This table maintains associations of CM Privilege sets with the domain. Rows with the same DomainID form a domain's privilege set. Rows in this table can only be deleted, not updated.

    Table 9.

    Column Name Data Type Attribute
    DomainID INTEGER not null
    PrivSetCode INTEGER not null

    Primary Key
    None.

    Indexes
    Unique Index = (DomainID ascending, PrivSetCode ascending)
    

    Referential Constraints
    Foreign Key = DomainID
      references ICMSTAdminDomains (DomainID)
        on delete restrict
     
    Foreign Key = PrivSetCode
      references ICMSTPrivSetCodes (PrivSetCode)
        on delete cascade
    

    Column Definitions

    DomainID
    Domain identifier.

    PrivSetCode
    Privilege set identifier.

    Privilege Group Code Table (ICMSTPrivGroupCode)

    This table maintains the Privilege Group definitions. A Privilege Group consists of one or more privileges. Each group is uniquely identified by a CM system-generated code. Its group-member associations are stored in the table ICMSTPrivGroups. There is no direct relationship between privilege set and privilege group. Privilege group name and description are defined in the NLS Keywords Table (ICMSTNLSKEYWORDS).

      Privilege Group versus Privilege Set

    1. Privilege Group is a subset of Privilege Set (not great than).
    2. Privilege Group is on purpose for System Administrator to ease grouping multiple (or large amount of) privileges to same category in order to improve performance.
    3. Privilege Set is used (as usual) for user's general privileges (it can include privileges in Controlled Entities and/or System Entities), or for ACL privileges (basically for Controlled Entities, but not restricted currently) when an ACL rule is set for a individual user, a user group, or entire ICM users (ICM_USERID_PUBLIC).
    4. A privilege can be used only when it is set to a typical (or more) Privilege Set(s), but not necessary to a Privilege Group.

    Table 10.

    Column Name Data Type Attribute
    PrivGroupCode INTEGER not null

    Primary Key
    PrivGroupCode.

    Indexes
    None.

    Referential Constraints
    None.

    Column Definitions

    PrivGroupCode
    The CM system-generated identifier. Cannot be updated.

    Privilege Group Table (ICMSTPrivGroups)

    This table maintains associations of CM Privileges with the Privilege Groups. Rows with the same PrivGroupCode form a Privilege Group. Rows in this table can only be deleted, not updated.

    Table 11.

    Column Name Data Type Attribute
    PrivGroupCode INTEGER not null
    PrivDefCode INTEGER not null

    Primary Key
    None.

    Indexes
    Unique Index = (PrivGroupCode ascending, PrivDefCode ascending)
    

    Referential Constraints
    Foreign Key = PrivGroupCode
      references ICMSTPrivGroupCode (PrivGroupCode)
        on delete cascade
     
    Foreign Key = PrivDefCode
      references ICMSTPrivDefs (PrivDefCode)
        on delete restrict
    

    Column Definitions

    PrivGroupCode
    Privilege Group identifier.

    PrivDefCode
    Privilege definition identifier.

    User Table (ICMSTUsers)

    This table maintains a catalog of individual users and user groups.

    Individual users can belong to none or any number of groups. Users must be assigned a number of privileges, stored in UserPrivSetCode. Defining new CM users does not guarantee their existence in the DBMS and the operating system. It is the system administrator's responsibility to ensure the usefulness of the CM users he creates.

    A group is a number of zero or more users, usually with the same job description, and assigns them the same Privilege Set. A group cannot belong to other groups. A group does not hold default privileges for its members. CM groups do not relate to DBMS or operating system groups. Defining groups merely minimizes the effort required to administer ACLs.

    Table 12.

    Column Name Data Type Attribute
    UserID CHAR(32) not null
    DomainID INTEGER not null
    UserKind SMALLINT not null
    UserPrivSetCode INTEGER not null
    GrantPrivSetCode INTEGER not null
    DfltACLCode INTEGER not null
    DfltRMCode SMALLINT not null
    DfltCollCode SMALLINT not null
    RetryCount SMALLINT not null
    LoggedOn SMALLINT not null
    LastAccess INTEGER not null
    Password CHAR(8) FOR BIT DATA nullable
    PasswordExpiration DATE nullable
    UserName VARCHAR(128) not null
    LDAPInfo VARCHAR(1024) nullable

    Primary Key
    UserID.

    Indexes
    None.

    Referential Constraints
    Foreign Key = DomainID
      references ICMSTAdminDomains (DomainID)
        on delete restrict
     
    Foreign Key = (UserPrivSetCode)
      references ICMSTPrivSetCodes  (PrivSetCode)
        on delete restrict
     
    Foreign Key = (GrantPrivSetCode)
      references ICMSTPrivSetCodes  (PrivSetCode)
        on delete restrict
     
    Foreign Key = DfltACLCode
      references ICMSTAccessCodes  (ACLCode)
        on delete restrict
     
    Foreign Key = (DfltRMCode, DfltCollCode)
      references ICMSTCOLLNAME (RMCode, SmsCollCode)
        on delete restrict
    

    Column Definitions

    UserID
    The ID of the individual user or group (the length is platform dependent). For an individual user, UserID should match his DBMS user ID. The CM uses this value for user authentication and access control. For a group, UserID contains the group name. Your application assigns a unique ID and cannot be updated.

    DomainID
    Domain identifier.

    UserKind
    Indicates whether this entry represents an individual user or a group. Cannot be updated. The valid values are:

    1
    Indicates that UserID represents a group.

    0
    Indicates that UserID represents an individual user.

    UserPrivSetCode
    The User Privileges. The Privilege Set must be defined first. This value is not valid for groups. The CM system for groups sets this to 1. Can be updated.

    GrantPrivSetCode
    If a user is authorized to create users but does not grant privileges to the new users, this value is assigned to those new users. This value is not valid for groups. The CM system for groups sets this to 1. Can be updated.

    The System Administrator GUI for creating a user must have an entry field for that user's GrantPrivSetCode.

    DfltACLCode
    When the CM access control is configured at Item level, this ACL Code associates with the Items that the user did not provide control for. This value is not valid for groups. It is set to 1 by the CM system for groups. Can be updated.

    DfltRMCode
    The default resource manager, where item resources pertaining to this user are to be stored.

    Your application provides the code of the resource manager that is to contain item resources pertaining to this user.

    DfltCollCode
    The default collection, where item resources pertaining to this user are to be stored.

    Your application provides the code of the collection that is to contain item resources pertaining to this user.

    RetryCount
    The number of times that the user has tried to log on with an invalid password. This field is reset to 0 when the password is valid. If the limit specified in MAXLOGONRETRY in ICMSTSYSCONTROL is reached for a user, a new password must be specified by the administrator, and the RETRYCOUNT field must be set to 0.

    LoggedOn
    Indicates whether a user has logged on or off. This field is set to 0 when a new user is defined. It is set to 1 when the user logged on, and set back to 0 when the user logged off.

    LastAccess
    Indicates the time (expressed as seconds) when the user called a stored procedure, and the table was updated. The token validation macro (called by every stored procedure) calls a function to see how long since ICMSTUSERS was updated. If more than 30 minutes elapsed (defined in ICM_CONCURRENT_USER_TIME) the LASTACCESS field is updated. This function isn't called if the last access time passed from the caller is -1.

    Password
    An encrypted form of the password.

    PasswordExpiration
    The date on which the password expires. CM does not keep password and password expiration for CM System Administrators.

    UserName
    The full name of the individual user or group.

    LDAPInfo
    The place to hold the user's LDAP data.

    Table 13. CM Pre-configured User and Group

    Column Name Value
    UserID %ICMCRLSDBUSER%
    DomainID 1
    UserKind 0
    UserPrivSetCode 1 (AllPrivSet)
    GrantPrivSetCode 6 (ItemReadPrivSet, not used)
    DfltACLCode 3 (PublicReadACL)
    DfltRMCode 1
    DfltCollCode 1
    RetryCount 0
    LoggedOn 0
    LastAccess 0
    Password NULL
    PasswordExpiration 2099-12-31
    UserName ICM Super System Administration
    LDAPInfo NULL


    UserID %ICMCRLSDBDB2CONNECTID%
    DomainID 1000
    UserKind 0
    UserPrivSetCode 7
    GrantPrivSetCode 7
    DfltACLCode 3
    DfltRMCode 1
    DfltCollCode 1
    RetryCount 0
    LoggedOn 0
    LastAccess 0
    Password NULL
    PasswordExpiration 2099-12-31
    UserName Database connection userid
    LDAPInfo NULL
    UserID ICMPUBLC
    DomainID 2
    UserKind 1
    UserPrivSetCode 1 (not used)
    GrantPrivSetCode 1 (not used)
    DfltACLCode 1 (not used)
    DfltRMCode 0 (not used)
    DfltCollCode 0 (not used)
    RetryCount 0
    LoggedOn 0
    LastAccess 0
    Password ' '
    PasswordExpiration 2099-12-31
    UserName ICM Public
    LDAPInfo NULL

    User Group Table (ICMSTUserGroups)

    This table maintains associations of individual users with the groups. An individual user can belong to none or any number of groups. A group cannot belong to other groups. When an individual user is associated with a group, the user is said to be a member of that group.

    Associating individual users with groups simplifies the access control management. When defining access control specifications, a group can be granted a number of privileges instead of granting the same set of privileges to each user in the group.

    The individual user and the group must be defined in the ICMSTUsers table before an association can be made between the user and the group.

    Rows in this table can only be deleted, not updated.

    Table 14.

    Column Name Data Type Attribute
    UserID CHAR(32) not null
    GroupUserID CHAR(32) not null

    Primary Key
    None.

    Indexes
    Unique Index = (UserID ascending, GroupUserID ascending)
    

    This index is designed to optimize the access control algorithm's frequently querying all groups a particular user belongs to.

    Referential Constraints
    Foreign Key = (UserID)
      references ICMSTUsers (UserID)
        on delete cascade
     
    Foreign Key = (GroupUserID)
      references ICMSTUsers (UserID)
        on delete cascade
    

    Column Definitions

    UserID
    The unique ID of a user. A user must be defined in the ICMSTUsers table before that user can be associated with a group.

    GroupUserID
    The unique ID of the group. The GroupUserID must be defined in the ICMSTUsers table before users can belong to the group.

    CM Pre-configured User Groups: n/a


    Access Control List Code Table (ICMSTAccessCodes)

    This table maintains the access control list identifiers. Each list is uniquely identified by the AccessListCode. The list specifications are stored in the access control list table (ICMSTAccessLists). ACL name and description are defined in the NLS Keywords Table (ICMSTNLSKEYWORDS).

    Table 15.

    Column Name Data Type Attribute
    ACLCode INTEGER not null

    Primary Key
    ACL Code.

    Indexes
    None.

    Referential Constraints
    None.

    Column Definitions

    ACLCode
    The ID of an access control list. The value is generated by CM system. Cannot be updated.

    Table 16. CM Pre-configured ACL Codes

    ACLCode ACLName* ACLDesc*
    1 SuperUserACL ACL allows the first user from installation to perform all CM functions on the bound entities.
    2 NoAccessACL ACL specifies, for all CM users, no actions are allowed on the bound entities.
    3 PublicReadACL ACL allows all CM users to read the bound entities.
    4 DocRouteACL Document Routing ACL.
    *For illustration only. Name and description are defined in the NLS Keywords table.

    Domain Access Control List Code Table (ICMSTDomainAccess)

    This table maintains associations of CM Access Control List Code with the domain. Rows with the same DomainID form a domain's access control list code. Rows in this table can only be deleted, not updated.

    Table 17.

    Column Name Data Type Attribute
    DomainID INTEGER not null
    ACLCode INTEGER not null

    Primary Key
    None.

    Indexes
    Unique Index = (DomainID ascending, ACLCode ascending)
    

    Referential Constraints
    Foreign Key = DomainID
      references ICMSTAdminDomains (DomainID)
        on delete restrict
     
    Foreign Key = ACLCode
      references ICMSTAccessCodes (ACLCode)
        on delete cascade
    

    Column Definitions

    DomainID
    Domain identifier.

    ACLCode
    The ID of an access control list.

    Table 18. CM Pre-configured Domain Access Control List Codes

    DomainID ACLCode DomainName* ACLName*
    1 1 SuperDomain SuperUserACL
    1 2 SuperDomain NoAccessACL
    1 3 SuperDomain PublicReadACL
    1 4 SuperDomain DocRouteACL
    2 1 PublicDomain SuperUserACL
    2 2 PublicDomain NoAccessACL
    2 3 PublicDomain PublicReadACL
    2 4 PublicDomain DouRouteACL
    1000 1 DefaultDomain SuperUserACL
    1000 2 DefaultDomain NoAccessACL
    1000 3 DefaultDomain PublicReadACL
    1000 4 DefaultDomain DocRouteACL
    *For illustration only. Name is defined in the NLS Keywords table.

    Access Control List Table (ICMSTAccessLists)

    This table maintains the access control list specifications. A list can contain more than one control. Each control is composed of two elements: who (UserID, UserKind) can perform what (PrivSetCode). Each CM data entity (Item) must be bound to a control list. The control specifications then will be enforced whenever Items are accessed.

    Table 19.

    Column Name Data Type Attribute
    ACLCode INTEGER not null
    UserID CHAR(32) not null
    UserKind SMALLINT not null
    PrivSetCode INTEGER not null

    Primary Key
    None.

    Indexes
    Unique index = (ACLCode ascending, UserID ascending)
    

    Referential Constraints
    Foreign Key = ACLCode
      references ICMSTAccessCodes (ACLCode)
        on delete cascade
     
    Foreign Key = UserID
      references ICMSTUsers (UserID)
        on delete cascade
     
    Foreign Key = PrivSetCode
      references ICMSTPrivSetCodes (PrivSetCode)
        on delete restrict 
    

    Column Definitions

    ACLCode
    The ID of an access control list. Access control lists are used by the access control algorithm to determine a user's access rights for an item. Cannot be updated.

    UserID
    Contains ID for an individual user or for a group. Cannot be updated.

    UserKind
    Interpretation for the UserID column. The valid values are described as follows:

    2
    Indicates public (all users). In this case, the value in the UserID column is ignored.

    1
    Indicates that UserID represents a user group.

    0
    Indicates that UserID represents an individual user.

    PrivSetCode
    The Privilege Set identifier, indicates the operations allowed for the bound item. Can be updated.

    Table 20. CM Pre-configured Access Control Lists

    ACLCode UserID UserKind PrivSetCode
    1 (SuperUserACL) %ICMCRLSDBUSER% 0 1 (AllPrivSet)
    3 (PublicReadACL) ICMPUBLC 2 (public) 6 (ItemReadPrivSet)

    Compiled ACL Table (ICMSTCompiledACL)

    This table contains the compiled access control information. The UserID contains only individual users. The PrivDefCode represents a single Privilege for Item access. For incremental refresh on this table, please refer to section "Access Control Compilation" paragraph "Incremental Refresh".

    Table 21.

    Column Name Data Type Attribute
    ACLCode INTEGER not null
    PrivDefCode INTEGER not null
    PrivSetCode INTEGER not null
    UserID CHAR(32) not null
    GroupUserID CHAR(32) null
    UserKind SMALLINT not null

    Primary Key
    None.

    Indexes
    |Index = (UserID asc, PrivDefCode asc, ACLCode asc, UserKind asc)
    |Index = (PrivDefCode asc, ACLCode asc, UserKind asc, UserID asc)
    |Index = (ACLCode asc, UserKind asc, PrivDefCode asc, UserID asc, )
    
    

    Referential Constraints
    None.

    Column Definitions

    ACLCode
    The Access Control List code.

    PrivDefCode
    The Privilege Definition Code, indicates the operation allowed for the bound Item.

    PrivSetCode
    The Privilege Set Code that the resolved privilege is derived from. This is a maintenance field, designed for incremental refresh on this table. For example, when a Privilege Set is modified, only rows with that PrivSetCode are affected.

    UserID
    Contains the authorized user's user ID.

    GroupUserID
    Contains the group's UserID if this entry is derived from an ACL Rule For Group. This is a maintenance field, designed for incremental refresh. It contains null if the ACL rule is not for group.

    UserKind
    This column is not necessary if view definition constraints for public access use UserID='ICMPUBLC' instead of UserKind=2. Indicates which ACL rule type this row is derived from. Valid values are:

    2
    Indicates this row is derived from an ACL Rule for Public.

    1
    Indicates this row is derived from an ACL Rule for Group.

    0
    Indicates this row is derived from an ACL Rule for User.

    Compiled Permission Table (ICMSTCompiledPerm)

    This table contains the compiled individual user's User Privileges. The UserID contains only individual users. The PrivDefCode represents a single Privilege for Item access.

    Table 22.

    Column Name Data Type Attribute
    UserID CHAR(32) not null
    PrivDefCode INTEGER not null
    PrivSetCode INTEGER not null

    Primary Key
    None.

    Indexes
    |Unique index = (UserID ascending, PrivDefCode ascending)
    |Unique index = (PrivDefCode ascending, UserID ascending)
    
    

    Referential Constraints
    None.

    Column Definitions

    UserID
    The authorized user's user ID.

    PrivDefCode
    The Privilege Definition Code, indicates the operation allowed for the bound Item.

    PrivSetCode
    The Privilege Set Code that the resolved privilege is derived from. This is a maintenance field so that if a Privilege Set is modified, only rows with that PrivSetCode are affected.

    Item related database tables and pre-configured settings


    Attribute Definitions Table (ICMSTATTRDEFS)

    The ICMSTATTRDEFS table identifies all system and user defined base attributes. These attributes are associated to a database data type, defined in the database. You must define a base attribute before you can associate it to a table or a view. The content manager checks this table to ensure that the AttributeID is unique to the content manager system. The DB2 table column name has the form "ATTR", and two numeric representations of the attribute group ID and attribute ID (example: ATTR0000300002) where 00003 is an attribute group ID and 00002 is an attribute ID.

    Each base attribute defined in the table can have one and only one display name. All display names are defined in the KeywordName in the NLS Keywords table. Attribute ID is represented by the KeywordCode where the KeywordClass is equal to 1.

    Table 23.

    Column Name Data Type Attribute
    AttributeID INTEGER NOT null
    AttrSQLType SMALLINT NOT null
    AttrLength INTEGER NOT null
    AttrScale INTEGER NOT null
    AttrFlags INTEGER NOT null

    Primary Key
    AttributeID.

    Indexes
    None.

    Referential Constraints
    None.

    Column Definitions

    AttributeID
    System-assigned unique ID for the base attribute.

    The content manager generates a unique value for each base attribute when it is defined. The content manager assigns numeric values, starting at 1, and increments this value by 1 for each base attribute defined. An installation can have 99,999 base attributes at most that can be associated with item components.

    The value is last five digits of DB2 column name. For example, ATTR0000000001 (base attribute 1), ATTR0000000002 (base attribute 2), ATTR0000100002 (attribute group 1 and base attribute 2)...

    AttrSQLType
    The data type of the attribute. Most SQL data types are supported. The following supported data types are: CHAR, VARCHAR, DECIMAL, BLOB, CLOB, DBCLOB, INTEGER, SMALLINT, DATE, TIME, TIMESTAMP, and FLOAT.

    AttrLength
    Length of the column or, in case of a decimal column, its precision. AttrLength defines the total number of digits allowable in any decimal value to save for the attribute, and AttrScale defines the number of digits allowable to the right of the decimal point. Or, if it is an integer or smallint, it is a minimum value.

    AttrScale
    Scale of decimal data. For variable length character fields, this parameter specifies the minimum allowable string length to save for the attribute. For example, an attribute named Password, defined as a variable character field with a minimum length of 6 ensures that all saved passwords are at least 6 characters long. If it is an integer or smallint, it is a maximum value. Zero for all other field types.

    AttrFlags
    This field is used by application. For Content Manager Version 8, it is used for decision making (selectable or not) by System Admin and (modifiable or not) by client applications. It indicates that the system-defined attribute is selectable or modifiable by the system. The valid values for system-defined attributes are:

    0
    Not selectable, not modifiable.

    1
    Selectable, not modifiable.

    2
    Not selectable, modifiable.

    3
    Selectable, modifiable.

    Your application cannot update this field if it's a system-defined attribute. It's value is controlled by your application if it's a user-defined attribute.


    Attribute Group Definitions Table (ICMSTATTRGROUP)

    The ICMSTATTRGROUP table identifies attribute groups in the content manager. The content manager checks this table to ensure that the CompositeAttrID and AttributeID is unique to the content manager system.

    All attribute group names are defined in the NLS Keywords table.

    Nested attribute groups are not allowed. It means that attribute group can not contain another attribute group.

    When user defines a attribute group, a CompositeAttrID (next sequential number in the ICMSTATTRGROUP table) and an attribute group name (KeywordName, KeywordCode = CompositeAttrID with the KeywordClass = 6 in the MSTNLSKEYWORDS table) will be generated.

    The user can delete a specific attribute if it has not been used. The user can also delete any attribute group if the attribute group is not referenced.

    Table 24.

    Column Name Data Type Attribute
    AttributeGroup INTEGER NOT null
    AttributeID INTEGER NOT null
    SequenceNum SMALLINT NOT null

    Primary Key
    None.

    Indexes
    Unique Index
    (AttributeGroup asc, AttributeID asc, SequenceNum asc)
    Index
    None
    

    Referential Constraints
    Foreign Key = AttributeID
      references ICMSTATTRDEFS (AttributeID)
        on delete restrict
    

    Column Definitions

    AttributeGroup
    System-assigned unique ID for the attribute group.

    The content manager generates a unique value for each attribute group when it is defined. The content manager assigns numeric values, starting at 1, and increments this value by 1 for each attribute group defined. An installation can have 99,999 attribute groups at most, that can be associated with item components.

    The value is first five digits of DB2 column name. For example, ATTR0000100002 (attribute group 1 and base attribute 2)...

    AttributeID
    The value of this column must be the attribute ID. The ID is stored in the KeywordCode column in the ICMSTNLSKEYWORDS table where KeywordClass = 1.

    SequenceNum
    The order of an attribute within the attribute group. This helps your application display attributes in order of preference.

    NLS Keywords Table (ICMSTNLSKEYWORDS)

    The ICMSTNLSKEYWORDS table provides the national language translations for all keyword strings that are language sensitive. Each entry contains the translated version of the string in a given national language. When the keyword string is initially created, the content manager assigns it a code: the KeywordCode (e.g. ComponentTypeID). This code remains the same for all translations of the string in multiple languages. The language code must be defined in the ICMSTNLSLANGUAGES table before an entry for it can be created in this table.

    Table 25.

    Column Name Data Type Attribute
    KeywordClass SMALLINT NOT null
    LanguageCode CHAR(3) NOT null
    KeywordCode INTEGER NOT null
    KeywordName VARCHAR(32) NOT null
    KeywordDescription VARCHAR(254) NOT null

    Primary Key
    None.

    Indexes
    Unique Indexes
    (LanguageCode asc, KeywordClass asc, KeywordCode asc)
    (LanguageCode asc, KeywordClass asc, KeywordName asc)
    Index
    None.
    

    Referential Constraints
    Foreign key = LanguageCode
      references ICMSTNLSLANGAUGES (LanguageCode)
        on delete cascade
    

    Column Definitions

    KeywordClass
    The type of keyword. The classification types are defined by the content manager. The following values have been defined:

    1
    Indicates an attribute. The length of the KeywordName must less than or equal to 15 bytes long for database view column name.

    2
    Indicates an item type. The length of the KeywordName must less than or equal to 15 bytes long for database base view name.

    3
    Indicates a component type view. The length of the KeywordName must less than or equal to 15 bytes long for database view name.

    4
    Indicates a link type.

    5
    Indicates a component type. The length of the KeywordName must less than or equal to 15 bytes long for database base view name.

    6
    Indicates an attribute group.

    7
    Indicates an item type classification.

    8
    Indicates library server (LibraryServerID in the ICMSTSYSCONTROL). A library server ID maintains 1 to 99 library servers.

    9
    Indicates a library. A library ID (library ID in the ITEMID) maintains 1 to 999 libraries.

    10
    Indicates a privilege.

    11
    Indicates a privilege set.

    12
    Indicates a privilege group.

    13
    Indicates an ACL.

    14
    Indicates a semantic type.

    15
    Indicates a RM access type.

    16
    Indicates an event code.

    17
    Indicates an admin domain.

    18
    Indicates an item type view.

    32
    Indicates a mime type.

    < 999
    Reserved.

    1000+
    Indicated a user-defined keyword.

    LanguageCode
    The 3-character language code assigned to each written language. The language codes are assigned to the written languages of the world by IBM. The language codes are documented in the IBM National Language Design Guide: National Language Support Reference Manual, Volume 2.

    KeywordCode
    The code assigned to the keyword string by the content manager. When a new keyword string is created, the content manager assigns it a unique code. The uniqueness is scoped within a keyword classification (KeywordClass). All translated versions of the keyword string maintain the same KeywordCode.

    KeywordName
    The actual name in the designated national language, represented by LanguageCode.

    KeywordDescription
    The description of the KeywordName in the designated national language, represented by LanguageCode.

    NLS Languages Table (ICMSTNLSLANGUAGES)

    The ICMSTNLSLANGUAGES table identifies all national languages used within the content manager. All languages must be identified in this table before language-specific textual strings can be created in the ICMSTNLSKEYWORDS table.

    When a new language is added, all the keywords are duplicated for that language. Although you cannot update the keyword name, you can update the newly generated keyword description. An asterisk (*) is added at the beginning of a newly generated keyword description.

    Table 26.

    Column Name Data Type Attribute
    LanguageCode CHAR(3) NOT null
    LanguageName VARCHAR(32) NOT null

    Primary Key
    LanguageCode.

    Indexes
    Unique Index
    LanguageName asc
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    LanguageCode
    The 3-character language code assigned to each written language.

    The language codes are assigned to the written languages of the world by IBM. The language codes are documented in Chapter 8 of the IBM National Language Design Guide: National Language Support Reference Manual, Volume 2.

    LanguageName
    The textual name of the language. Please refer to Chapter 8 of the National Language Design Guide: Volume 2 for language names and the codes assigned to them.

    Item Type Definition Table (ICMSTITEMTYPEDEFS)

    The ICMSTITEMTYPEDEFS, ICMSTCOMPDEFS, Item Root, and Component system tables are used to build the complex object. When the user defines a new Item Type, the CM content manager inserts a row into the ICMSTITEMTYPEDEFS table. The ItemTypeID is an unique sequential number to be managed by the system. The name of the Item Type is defined in the ICMSTNLSKEYWORDS table for NLS support. The system will also insert rows into ICMSTCOMPDEFS table. One item root table and either zero or many item child tables will be created.

    When an item type is defined, the installation can specify the following for the new item type:

    Default resource manager
    The resource manager where all item resources (for items that belong to the item type) are stored by default. The default resource manager is maintained in the DfltRMCode column. The application can override the default value when an item is created.

    Default collection name
    Collection name that is associated with all item resources for items that belong to the item type by default. The default collection name is maintained in the DfltCollCode column. The application can override the default value when an item is created.

    Default prefetch collection name
    Prefetch collection name that is associated with all item resources for items that belong to the item type by default. The default prefetch collection name is maintained in the DfltPrefchCollCode column. The application can override the default value when an item is created.

    Default item retention
    The life of the item that belongs to the item type by default. The application can override the default value when an item is created. If the value is set to zero, there is no retention period. The unit of measure is defined in the DfltRetentionUnit (day, week, month, or year).

    Resource is a special type of Item Type. You can define an Item Type for a resource.

    Table 27.

    Column Name Data Type Attribute
    ItemTypeID INTEGER NOT null
    ItemTypeClass SMALLINT NOT null
    ItemLevelACLFlag SMALLINT NOT null
    ItemTypeACLCode INTEGER NOT null
    DfltRMCode SMALLINT NOT null
    DfltCollCode SMALLINT NOT null
    DfltPrefchCollCode SMALLINT NOT null
    DfltRetentionUnit SMALLINT NOT null
    DfltItemRetention INTEGER NOT null
    DfltXDOClassID INTEGER NOT null
    AutoLinkEnabled SMALLINT NOT null
    AutoLinkSMS SMALLINT NOT null
    SegmentID SMALLINT NOT null
    SegmentThreshold INTEGER NOT null
    PartitionID SMALLINT NOT null
    PartitionThreshold INTEGER NOT null
    VersionControl SMALLINT NOT null
    VersionMax SMALLINT NOT null
    ItemEventFlag SMALLINT NOT null
    UserID CHAR(32) NOT null
    Changed TIMESTAMP NOT null
    ProcessName CHAR(32) nullable
    DFLTPRIORITY INTEGER nullable

    Primary Key
    ItemTypeID.

    Indexes
    None.

    Referential Constraints
    Foreign Key = ItemTypeACLCode
      references ICMSTACCESSCODES (ACLCode)
        on delete restrict
     
    Foreign Key = (DfltRMCode, DfltCollCode)
      references ICMSTCOLLNAME (RMCode, SmsCollCode)
        on delete restrict
     
    For 390 only:
    Foreign Key = (DfltRMCode, DfltPrefchCollCode)
      references ICMSTCOLLNAME (RMCode, SmsCollCode)
        on delete restrict
    

    Column Definitions

    ItemTypeID
    A unique identifier for the item type.

    When a new item type is defined, the content manager generates this value. At the same time, the library inserts a row into the ICMSTCOMPDEFS table and generates a component root table for the item type.

    ItemTypeClass
    The type of item type. The classification types are defined by the content manager. The following values have been defined:

    0
    Indicates a non-resource type.

    1
    Indicates a resource type.

    2
    Indicates ICMDocument.

    3
    Indicates ICMPart.

    ItemLevelACLFlag
    This column indicates whether this Item Type's ACL binding is configured at Item level. It is used in conjunction with the system parameter ACLBindingLevel (ICMSTSysControl.ACLBindingLevel) when the latter is set to 'M' (Mixed Item and Item Type level), in order to configure the control level individually for each Item type. It is only used if the ACLBindingLevel is set to Mixed. The valid values are:

    1
    True, this Item Type ACL binding is at Item level.

    0
    False, this Item Type ACL binding is at Item Type level.

    ItemTypeACLCode
    This column stores the ACL setting for the entire Item Type. It is used in two ways: ACL binding enforcement or the default ACL resolving, depending on system configuration (ICMSTSysControl.ACLBindingLevel, ICMSTItemTypeDefs.ItemLevelACLFlag). When the Item Type ACL binding is configured at:

    1
    Type level. This value is enforced so that all Items in this type are bound to this ACL.

    2
    Item level. This value is used as default ACL if the parameter DfltACLChoice (ICMSTSysControl.DfltACLChoice) is configured at Item Type.

    DfltRMCode
    The default resource manager where item resources pertaining to this item type are to be stored.

    Your application provides the code of the resource manager that contains item resources pertaining to this item type.

    DfltCollCode
    The default collection where item resources pertaining to this item type are to be stored.

    Your application provides the code of the collection that is to contain item resources pertaining to this item type.

    DfltPrefchCollCode
    The default prefetch collection where item resources pertaining to this item type are to be stored.

    Your application provides the code of the prefetch collection that is to contain item resources pertaining to this item type.

    DfltRetentionUnit
    The default unit of measure of retention period of item pertaining to this item type: Valid values are:

    3
    Day.

    2
    Week.

    1
    Month.

    0
    Year (default).

    DfltItemRetention
    The default life of item pertaining to this item type:

    0
    Do not expire.

    else
    Number of days, weeks, months, or years before expiration since the item is created.

    Your application provides number of days, weeks, months, or years of item pertaining to this item type.

    DfltXDOClassID
    The default XDO Class ID. Cannot update if the component table has been defined.

    AutoLinkEnabled
    Indicates whether the auto linking (auto foldering) is enabled. Can be updated. Valid values are:

    1
    |True, enabled. Ignore if the ItemTypeClass = 3 |(ICMPart).

    0
    False, disabled.

    AutoLinkSMS
    When a value is not provided for both the resource manager and the collection name and the auto link is enabled, AutoLinkSMS indicates which default values to use for these parameters when creating a resource item. The application must specify the target non-resource item type whenever auto linking is used (during create resource item), and if linkOption is 1 (link to a new non-resource item) or 2 (link to an existing non-resource item). Valid values are:

    0
    Uses the defaults associated with the target item type for both the collection name and the resource manager.

    1
    Uses the defaults associated with the target item type for the collection name and defaults associated with the user for the resource manager.

    2
    Uses the defaults associated with the user for the collection name and defaults associated with the target item type for the resource manager.

    3
    Uses the defaults associated with the target item type for the collection name and defaults associated with the item type for the resource manager.

    4
    Uses the defaults associated with the item type for the collection name and defaults associated with the target item type for the resource manager.

    5
    Uses the defaults associated with the user for both the collection name and the resource manager.

    6
    Uses the defaults associated with the item type for both the collection name and the resource manager.

    7
    Uses the defaults associated with the item type for the collection name and defaults associated with the user for the resource manager.

    8
    Uses the defaults associated with the user for the collection name and defaults associated with the item type for the resource manager.

    SegmentID
    The current component segment ID. Default is 1. If a segment size has exceeded the SegmentThreshold, a new segment is created and the SegmentID is incremented by one. Valid values are 1 to 999. Reserved for future implementation.

    SegmentThreshold
    Maximum number of rows per segment. Because root and child tables are segmented at the same time, only tje root table is controlled by the threshold. The root table may not have the largest segment size. Reserved for future implementation.

    PartitionID
    The current component partitonID. Default is 1. If a partition size has exceeded the PartitionThreshold, the PartitionID is incremented by one. Reserved for future implementation.

    PartitionThreshold
    Maximum number of rows per partition. Since root and child tables are partitioned at the same time, only the root table is controlled by the threshold. The root table may not have the largest partition size. Reserved for future implementation.

    VersionControl
    This column controls the way versioning is performed:

    1
    Always. Always create a new version.

    0
    Never. Versioning is not supported under this item type (default).

    2
    Application specified. Application determines to create a new version or just perform replacement.

    VersionMax
    Maximum number of versions for all items in the item type.

    ItemEventFlag
    Indicates whether the logging of Item CRUD (create, read, update, delete) events is enabled. Valid values are:

    0
    False, CRUD disabled (default).

    1
    Create, enabled.

    2
    Read, enabled.

    3
    Create & Read, enabled.

    4
    Update, enabled.

    7
    Create, Read & Update, enabled.

    8
    Delete, enabled.

    15
    Create, Read, Update & Delete, enabled.

    UserID
    The ID of the user who inserted this row or changed it last.

    Changed
    The timestamp when the entry was created or when it was last updated.

    ProcessName
    The process name of the document routing.

    DFLTPRIORITY
    The default priority which is used in the document routing.

    Item Type View ID Table (ICMSTITVIEWID)

    The ICMSTITVIEWID table identifies component views defined on item type views. Item type view consists of one or more item component views. When the system administrator defines item type view on an item type, one view is selected from each component table which is defined in the item type. Once the view is selected, it becomes unavailable to the other item type view.

    The ICMSTITVIEWID table identifies component views defined on item type views. When the system administrator defines item type view, a row per component view is inserted into this table.

    Item type views are defined to control access to sensitive data contained in all component views defined in the item type view. An installation can have multiple views defined on the item type. You should not delete the item type view that has the same ID as the item type. This is the base view, which includes all base views for the components.

    Table 28.

    Column Name Data Type Attribute
    ItemTypeViewID INTEGER NOT null
    ComponentViewID INTEGER NOT null

    Primary Key
    None.

    Indexes
    |Unique Index
    |(ComponentViewID asc)
    |Index
    |(ComponentViewID asc, ItemTypeViewID desc)
    
    

    Referential Constraints
    ComponentViewID must exist in the ComponentViewId column in the ICMSTCOMPVIEWDEFS table.
    Foreign key = ItemTypeViewID
      references ICMSTITVIEWDEFS (ItemTypeViewID)
        on delete restrict
    

    Column Definitions

    ItemTypeViewID
    An item type view, which is a view defined on an item type.

    An ItemTypeViewID is generated by the content manager when a new view is created.

    ComponentViewID
    A component type view, which is a view defined on an item type's Component table.

    A ComponentViewID is generated by the content manager when a new view is created.


    Item Type View Definitions Table (ICMSTITVIEWDEFS)

    An item type consists of one or more component tables. Each component table can have one (base) or more views. A group of views (one from each component table) are included in an item type view.

    The ICMSTITVIEWDEFS table identifies item type views defined on item type. When the system administrator defines item type view on an item type, a row is inserted into this table.

    Item type views are defined to control access to sensitive data contained in all component views defined in the item type view. An installation can have multiple views defined on the item type. You should not delete the view that has the same ID as the item type. This is the base view, which includes all base views for the components.

    Table 29.

    Column Name Data Type Attribute
    ItemTypeViewID INTEGER NOT null
    ItemTypeID INTEGER NOT null
    ACLCode INTEGER NOT null
    UserID CHAR(32) NOT null
    Created TIMESTAMP NOT null

    Primary Key
    ItemTypeViewID.

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    Foreign key = ItemTypeID
      references ICMSTITEMTYPEDEFS (ItemTypeID)
        on delete restrict
     
    Foreign Key = ACLCode
      references ICMSTACCESSCODES(ACLCode)
        on delete restrict
    

    Column Definitions

    ItemTypeViewID
    An item type view, which is a view defined on an item type.

    An ItemTypeViewID is generated by the content manager when a new view is created.

    ItemTypeID
    A unique identifier for the item type.

    ACLCode
    The access list code to associate with this view.

    UserID
    The ID of the user who inserted this row or changed it last.

    Created
    The timestamp when the entry was created. Your application cannot update this field.

    Component Definition Table (ICMSTCOMPDEFS)

    When the user defines an Item Type, the CM content manager inserts rows into the ICMSTCOMPDEFS table for a root and either zero or many descendant (child) tables. The ComponentTypeID is a unique sequential number which will be managed by the system. The user must provide an ItemTypeID for all component types which associated to the Item Type. The Item Type is the default parent of all component type tables associate to it. Each component type could have many children, but the child can have only one component type parent. Both the ItemTypeID and the component parent ID must exist in the ICMSTITEMTYPEDEFS table and ICMSTCOMPDEFS table respectively. The component type cannot be shared by different item type.

    When an item type is defined, the content manager performs the following tasks on behalf of the application:

    1. It creates a table and a base view to store the attribute values for items that the item type stores. The name of that view is maintained in the ComponentViewName column in the ICMSTCOMPVIEWDEFS table. The table is also referred to as the Component Table (ICMUTnnnnnsss where nnnnn is the ComponentTypeID and sss is the SegmentID).
    2. It creates an access module to insert, delete, and modify data from the Component Table. The name of that access module is maintained in the AccessModuleName column in the ICMSTCOMPVIEWDEFS table.

    Table 30.

    Column Name Data Type Attribute
    ComponentTypeID INTEGER NOT null
    ItemTypeID INTEGER NOT null
    ParentCompTypeID INTEGER NOT null
    CardinalityMin SMALLINT NOT null
    CardinalityMax SMALLINT NOT null
    DeleteRule SMALLINT nullable
    CompTypeClass SMALLINT NOT null
    UserID CHAR(32) NOT null
    Changed TIMESTAMP NOT null

    Primary Key
    ComponentTypeID.

    Indexes
    |Unique Index
    |None
    |Index
    |ItemTypeID
    |(ComponentTypeID asc, ItemTypeID asc)
    
    

    Referential Constraints
    Foreign key = ItemTypeID
      references ICMSTITEMTYPEDEFS (ItemTypeID)
        on delete restrict
    

    Column Definitions

    ComponentTypeID
    A unique identifier for the component type.

    When a new component table is defined, the content manager generates this value. A component cannot be shared by different item type. An installation can have 46,655 component type views at most.

    ItemTypeID
    A unique identifier for the item type.

    When a new item type is defined, the content manager generates this value. At the same time, the library inserts a row into the ICMSTCOMPDEFS table and generates a component root table for the item type.

    ParentCompTypeID
    The ParentCompTypeID is used to build the type hierarchy among the component types (tables). If the component type is not the child of another component type, the value 0 is stored in this column by the content manager. It points to a component root table if this column is zero.

    CardinalityMin
    Minimum number of rows for the component type. This number is valid only for ParentCompTypeID is non-zero.

    CardinalityMax
    Maximum number of rows for the component type. This number is valid only for ParentCompTypeID is non-zero. There is no maximum if CardinalityMax is zero. If both CardinalityMin and CardinalityMax are not zero, CardinalityMax must be equal to or greater than CardinalityMin.

    DeleteRule
    Specifies what action is to take place on the dependent tables when a row of the target table is deleted. The root component ignores this column. The valid values are:

    1
    CASCADE

    0
    RESTRICT (default)

    CompTypeClass
    The type of component type. The classification types are defined by the content manager. The following values have been defined:

    0
    Indicates a non-resource component type.

    1
    Indicates a resource component type (for optimized model only).

    2
    Indicates a reference resource component type.

    For the root component:

    For the child component:

    UserID
    The ID of the user who inserted this row or changed it last.

    Changed
    The timestamp when the entry was created or last updated.

    Component Tables

    The Component table identifies all items belonging to the table. The content manager represents an Component table as a single, distinct table known as an ICMUT, or Component Table. The table name has the form "ICMUT" and a numeric representation of the ComponentTypeID and SegmentID (e.g. ICMUT00001001). The two types of Component Tables are Component Root Table and Component Child Table. Each item type is represented by a Component root table and either zero or more Component child tables.

    A Component table can be dropped when there are no Items stored in it.

    An attribute can be added to a Component at any time. The administrative client should first search to determine whether any components are actually using that attribute. If so, a warning message should be displayed. The alternative (which is used in VI/400) is to remove an attribute only if it is not used by any items. The access module will be modified accordingly.


    Component Root Tables (ICMUTnnnnnsss)

    There is only one Component Root Table per Item Type.

    Table 31.

    Column Name Data Type Attribute
    CompClusterID INTEGER NOT null
    ComponentID CHAR(18) NOT null
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    ACLCode INTEGER NOT null
    Expiration date DATE nullable
    SemanticType INTEGER nullable
    CompKey VARCHAR(23) NOT null
    CreateTS TIMESTAMP NOT null
    CreateUserID CHAR(32) NOT null
    LastChangedTS TIMESTAMP NOT null
    LastChangedUserID CHAR(32) NOT null
    ... User Defined Attributes

    Primary Key
    CompKey.

    Indexes
    Unique Index
    (ItemID asc, VersionID asc)
    (ComponentID, VersionID)
    (ItemID asc, ComponentID, VersionID asc)
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    CompClusterID
    Component cluster identification. This column maintains the physical organization of the tables (transparent to the user). This is the current PartitionID in the Item Type Definition table concatenate with part of ItemID timestamp.

    Example:

    PartitionID               ItemID Timestamp
    001                             2000-04-07-20.22.43.123987
    |______________________                       ------------
                             |       _______________________| reversed
                             |      |
    CompClusterID         0017893213
    

    This column cannot be updated by your application.

    ComponentID
    Current timestamp when the item is created.

    This column cannot be updated by your application.

    ItemID
    A unique key to identify the item.

    The value for ItemID is generated in content manager the application requests to create an item.

    This column cannot be updated by your application.

    VersionID
    The version ID of the item. The default is 1. If a new version is created, then the VersionID is incremented by one.

    ACLCode
    The ACL code that the Item binds to. This column is replicated from the Items table (ICMSTITEMSnnnsss) for performance reasons.

    SemanticType
    The semantic type of the item, which describes its basic classification. It can be used to indicate the type of item, such as a folder, document, resource, memo, picture, and contract.

    For example, suppose you have a book that is available in both the English and the French language. You might set the SemanticType to 'book' in the Items table. Then you could set the RepType (could be selected by user as an user defined attribute) in the Item Resources table to 'English' for the resource that represents the English version of the book, and to 'French' for the resource that represents the French version of the book.

    This field is set and interpreted by your application.

    This field has set definitions that are used by the system. Your application can use these values with the defined meanings.

    Table 32.

    Definition Value
    Document 1
    Folder 2
    WorkBasket 3
    Annotation 4
    History 5
    Workflow 6
    Note 7
    Base 8
    All 9
    ACL 10
    Folder_Doc 11
    MGDS 12
    System 13
    User 14
    Container 15
    ... 16-999
    user defined 1000+

    ExpirationDate
    The date when the entry expires. When retrieved by an application, the ItemType shows the number of days/weeks/months/years (DfltItemRetention). The application can either set a date or leave it null. If set to null, the library server sets the date based on DfltItemRetention.

    CompKey
    Concatenates ComponentID (18 bytes timestamp) and VersionID (5 digits number) to form a single column in order to support TIE's single column index.

    This column cannot be updated by your application.

    CreateTS
    The timestamp when the entry was created.

    CreateUserID
    The user who created the entry.

    LastChangedTS
    The timestamp when the entry was last updated.

    LastChangedUserID
    The user who last updated the entry.

    UserDefined Attributes
    The user can define a set of attributes which are associated to the item component. When an item is inserted into the content manager, the values of the attributes are assigned by the application.

    Component Child Tables (ICMUTnnnnnsss)

    Each item type can define zero or more Component child tables. A Component Child Table can be the parent of another Component Child Table. The top of the hierarchy must be the Component Root Table.

    Table 33.

    Column Name Data Type Attribute
    CompClusterID INTEGER NOT null
    ComponentID CHAR(18) NOT null
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    ParentCompID CHAR(18) NOT null
    CompKey CHAR(23) NOT null
    ParentCompKey CHAR(23) NOT null
    ... User Defined Attributes

    Primary Key
    CompKey.

    Indexes
    |Unique Index
    |(ComponentID, VersionID)
    |Index
    |(ItemID asc, ComponentID, VersionID asc)
    | 
    |(ItemID asc, VersionID asc)
    |(ParentCompID, VersionID)
    
    

    Referential Constraints
    Foreign key = ParentCompKey
      references parent table ICMUTnnnnnsss CompKey
        on delete
        cascade or restrict depends on DeleteRule in the Component Definition Table (ICMSTCOMPDEFS) 
    

    Column Definitions

    CompClusterID
    Component cluster identification. This column maintains the physical organization of the tables (transparent to the user). This is the current PartitionID in the Item Type Definition table concatenate with part of ItemID timestamp.

    Example:

    PartitionID               ItemID Timestamp
    001                             2000-04-07-20.22.43.123987
    |______________________                       ------------
                             |       _______________________| reversed
                             |      |
    CompClusterID         0017893213
    

    This column cannot be updated by your application.

    ComponentID
    Current timestamp when the item is created.

    This column cannot be updated by your application.

    ItemID
    A unique key to identify the item.

    The ItemID and VersionID must exist in the Component Root table.

    This column cannot be updated by your application.

    VersionID
    The version ID of the item.

    The ItemID and VersionID must exist in the Component Root table.

    This column cannot be updated by your application.

    ParentCompID
    The ParentCompID is a back pointer points to the parent table. The value of this column is the ComponentID of the Component parent table.

    This column cannot be updated by your application.

    CompKey
    Concatenates ComponentID (18 bytes timestamp) and VersionID (5 digits number) to form a single column in order to support TIE's single column index.

    This column cannot be updated by your application.

    ParentCompKey
    The ParentCompKey is a back pointer points to the parent table. The value of this column is the CompKey of the Component parent table.

    This column cannot be updated by your application.

    UserDefined Attributes
    The user can define a set of attributes which are associated to the item component. When an item is inserted into the content manager, the application assigns the values of the attributes.

    Component Attributes Table (ICMSTCOMPATTRS)

    The ICMSTCOMPATTRS table associates attribute display names with component tables. An attribute can be associated with more than one component table. In this case, one row is created for each AttributeID/ComponentTypeID combination.

    The item type and each attribute that is to be associated with the item type must be defined before an association can be made. The Component Type is defined in the ICMSTCOMPDEFS, and attribute display names are defined in the ICMSTNLSKEYWORDS table.

    Table 34.

    Column Name Data Type Attribute
    ComponentTypeID INTEGER NOT null
    AttributeID INTEGER NOT null
    AttributeGroup INTEGER NOT null
    SequenceNum SMALLINT NOT null
    AttrFlags SMALLINT NOT null
    DefaultType SMALLINT NOT null
    MinimumValue INTEGER NOT null
    MaximumValue INTEGER NOT null
    DefaultValue VARCHAR(512) nullable

    Primary Key
    None.

    Indexes
    Unique Indexes
    (ComponentTypeID asc, AttributeID asc, AttributeGroup asc)
    (ComponentTypeID asc, SequenceNum asc)
    Index
    None
    

    Referential Constraints
    Foreign Key = ComponentTypeID
      references ICMSTCOMPDEFS (ComponentTypeID)
        on delete restrict
     
    Foreign Key = AttributeID
      references ICMSTATTRDEFS (AttributeID)
        on delete restrict 
    

    Column Definitions

    ComponentTypeID
    A unique identifier for the component type.

    This column represents the component type ID that is associated with the attribute. The component type must be defined in the Component definition (ICMSTCOMPDEFS) before attribute display names can be associated with it.

    AttributeID
    System-assigned unique ID for the attribute display name.

    This column represents the ID of the attribute display name that is associated with the component type. The attribute display name or attribute group name must be defined in the NLS Keywords table (ICMSTNLSKEYWORDS) before it can be associated with the component type.

    AttributeGroup
    System-assigned unique ID for the attribute group name.

    When you add an attribute group to the component, the system will add one row for each base attribute in the attribute group and assign the AttributeGroup. If the AttributeID is a base attribute then the attribute group ID is set to zero.

    SequenceNum
    The order of an attribute within the component type. This helps your application display attributes in order of preference.

    This column is for use by your application exclusively. The content manager does not set or interpret this column.

    AttrFlags
    Treatment of the attribute in this component type. Currently, the system provides four bit assignments only. Other bits are reserved for future use.

    All attributes in the attribute group are either required or not required. If there is a mixed situation, all attributes in the attribute group must be presented in this table separately.

    Bit positions are counted from right to left. Counting starts with number 0, so the rightmost bit is bit number 0 and the leftmost bit is bit number 15.

    Each item type can define zero or more Component child tables. A Component Child Table can be the parent of another Component Child Table. The top of the hierarchy must be the Component Root Table.

    Table 35. Bit assignments

    Bit 0 1
    0 Indicates that a value for the attribute is required (NOT NULL). Indicates that a value for the attribute is not required (nullable).
    1 Indicates that a value for the attribute is unique. Indicates that a value for the attribute is not unique.
    2 Indicates that a value for the attribute is a regular (not resource manager) attribute. Indicates that a value for the attribute is a resource manager attribute. This bit is set on by LS if it is a system-defined resource attribute for OO API XDO uses. If it is user-defined attribute, it's up to application to set it on/off.
    3 Indicates that a value for the attribute is XML-Element. Indicates that a value for the attribute is XML-attribute.
    4 Indicates that a value for the attribute is a regular (not text searchable) attribute. Indicates that a value for the attribute is a text searchable attribute.

    Your application provides a value for this column.

    DefaultType
    The type of default value. The valid values are:

    6
    The default value depends on the data type of the attribute, the bit 0 of AttrFlags, and the value of the DefaultValue column.

    If the value of the DefaultValue column is not null, the default is the value in the DefaultValue.

    If the value of the DefaultValue column is null, the default depends on the bit 0 of AttrFlags.

    If bit 0 of AttrFlags is 0 (not null), the default value depends on the data type of the attribute:

    Table 36.

    Data type Default value
    Numeric 0
    Fixed-length string blanks
    Varying-length string A string length of 0
    Date The current date
    Time The current time
    Timestamp The current timestamp

    If bit 0 of AttrFlags is 1 (nullable), the attribute has a default value of null.

    0
    The attribute has no default value (default).

    MinimumValue
    The minimum value for the SMALLINT/INTEGER attribute.

    MaximumValue
    The maximum value for the SMALLINT/INTEGER attribute.

    There is no maximum if MaximumValue is zero. If both MinimumValue and MaximumValue are not zero, MaximumValue must be equal to or greater than MinimumValue.

    DefaultValue
    When the DefaultType 6, this field may contain the default value of the attribute.

    Component Attributes Foreign Key Table (ICMSTCOMPATTRSFK)

    The ICMSTCOMPATTRFK table identifies all foreign key definitions. Each row identifies both dependent attribute information (attribute ID and Attribute Group ID) and parent attribute information and/or external table column name. Assume this is a small table so it is not normalized. If the foreign key has multiple columns, then there are multiple rows to represent the foreign key.

    Table 37.

    Column Name Data Type Attribute
    SourceCompTypeID INTEGER NOT null
    SrcAttributeID INTEGER NOT null
    SrcAttrGroupID INTEGER NOT null
    ColumnSeq SMALLINT NOT null
    TargetCompTypeID INTEGER NOT null
    TargetAttributeID INTEGER NOT null
    TargetAttrGroupID INTEGER NOT null
    ColumnName VARCHAR(18) nullable
    DeleteRule SMALLINT nullable
    UpdateRule SMALLINT nullable
    ConstraintName VARCHAR(18) nullable
    TabSchema VARCHAR(128) nullable
    TargetTblName VARCHAR(128) nullable

    Primary Key
    None.

    Indexes
    Unique Indexes
    (SourceCompTypeID asc, ColumnSeq asc, SrcAttrGroupID asc, SrcAttributeID asc, 
    ConstraintName asc)
    Index
    None
    

    Referential Constraints
    Foreign Key = SourceCompTypeID
      references ICMSTCOMPDEFS (ComponentTypeID)
        on delete restrict
     
    Foreign Key = SrcAttributeID
      references ICMSTATTRDEFS (AttributeID)
        on delete restrict
    

    Column Definitions

    SourceCompTypeID
    This column represents the component type ID that has foreign key(s). The component type must be defined in the Component definition (ICMSTCOMPDEFS) table.

    SrcAttributeID
    This column represents the foreign key column (attribute ID) in dependent table. This column may combine with SrcAttrGroupID to represent the column.

    SrcAttrGroupID
    This column represents the foreign key column (attribute group ID or composite attribute ID) in dependent table. This column may combine with SrcAttributeID to represent the column.

    ColumnSeq
    Numeric position of the column in the key. The sequence must start with 0 and be incremented by one for each column of the key.

    TargetCompTypeID
    This column represents the component type ID that is the parent component. The component type must be defined in the Component definition (ICMSTCOMPDEFS) table. This column and TargetTblName are mutually exclusive.

    TargetAttributeID
    This column represents the parent key column (attribute ID) in target table. This column may combine with TargetAttrGroupID to represent the column.

    TargetAttrGroupID
    This column represents the parent key column (attribute group ID or composite attribute ID) in target table. This column may combine with TargetSrcAttributeID to represent the column.

    ColumnName
    Name of the column if it is a non-CM external table. This column and (TargetAttributeID and TargetAttrGroupID) are mutually exclusive. If it is an external table, then Column name must be filled in. Otherwise it must be null.

    DeleteRule
    Specifies what action is to take place on the dependent tables when a row of the target table is deleted. The valid values are:

    3
    NO ACTION

    2
    SET NULL

    1
    CASCADE

    0
    RESTRICT (default)

    UpdateRule
    Specifies what action is to take place on the dependent tables when the content of the reference target column(s) of the target table is updated. The valid values are:

    3
    NO ACTION

    0
    RESTRICT (default)

    ConstraintName
    Name of the constraint. When alter table with drop foreign key must have the constraint name.

    TabSchema
    The schema name of the external table. The qualified name of the table containing the column.

    TargetTblName
    The table that contains the parent key. This is an external (non-CM) table. This column and TargetCompTypeIDare mutually exclusive.

    Component View Definitions Table (ICMSTCOMPVIEWDEFS)

    The ICMSTCOMPVIEWDEFS table identifies views defined on components. Item type consists of one or more item component tables. All views are created on the Component tables. When the system administrator defines views on a component table, a row is inserted into this table. In addition, one or more rows are inserted in the ICMSTCOMPVIEWATTRS table, one for each attribute included in the view.

    An installation can have multiple views defined on the item components. You should not delete the view that has the same ID as the item component. This is the base view, which includes all columns for the item component.

    Table 38.

    Column Name Data Type Attribute
    ComponentViewID INTEGER NOT null
    ComponentTypeID INTEGER NOT null
    SegmentID SMALLINT NOT null
    ItemTypeID INTEGER NOT null
    ComponentViewName CHAR(18) NOT null
    AccessModuleName CHAR(8) NOT null
    AccessModuleStatus SMALLINT NOT null
    AccessModuleResult INTEGER NOT null
    AccessModuleVers SMALLINT NOT null
    PrevAccessModule CHAR(8) NOT null
    UserID CHAR(32) NOT null
    Created TIMESTAMP NOT null

    Primary Key
    |(ComponentViewID asc, SegmentID asc).

    Indexes
    |Unique Indexes
    |None
    |Index
    |(ComponentViewID asc, ComponentTypeID asc)
    
    

    Referential Constraints
    Foreign Key =ComponentTypeID
      references ICMSTCOMPDEFS(ComponentTypeID)
        on delete cascade
     
    Foreign Key = ItemTypeID
      references ICMSTITEMTYPEDEFS(ItemTypeID)
        on delete restrict 
    

    Column Definitions

    ComponentViewID
    A component type view, which is a view defined on an item type's Component table.

    A ComponentViewID is generated by the content manager when a new view is created. An installation can have 46,655 component views at most.

    ComponentTypeID
    A unique identifier for the component type.

    When a new component table is defined, the content manager generates this value.

    SegmentID
    The component segment ID.

    ItemTypeID
    A unique identifier for the item type.

    When a new item type is defined, the content manager generates this value. At the same time, the library inserts a row into the ICMSTCOMPDEFS table and generates a component root table for the item type.

    ComponentViewName
    Name of the view or table that includes attributes of the component view. The view name is the name of the view concatenate with SegmentID, for example: CLAIM001.

    AccessModuleName
    The access module that is created by the content manager to insert, retrieve, delete, and modify data from the ICMUTnnnnnsss.

    The content manager generates this name. Your application cannot provide or update this column.

    AccessModuleStatus
    The status of the access module generation process. The valid values are:

    A negative value
    Indicates that the access module has not yet been generated.

    0
    Indicates that the access module has been generated and is available for use.

    A positive value
    Indicates that an error occurred when generating the access module. The value is the return code from the access module generation process.

    The access module generation process goes through five phases:

    1. Generate the code
    2. PREPARE
    3. Compile
    4. Link
    5. BIND

    AccessModuleResult
    When AccessModuleStatus contains a positive value, this column indicates the type of error that occurred when generating the access module.

    AccessModuleVers
    This column maintains the version number of the last access module generated for this component type. When a component type definition is changed by the installation, the content manager uses this column to generate a new access module.

    PrevAccessModule
    The name of the access module that was active (working) before an attempt to create a new access module.

    When the access module is created for the first time, the PrevAccessModule is the same as the AccessModuleName. Subsequently, if a request to create a new access module is made and the new access module cannot be created for some reason, then the content manager uses the previously active access module. The AccessModuleStatus column indicates this situation, and identifies the previously active access module.

    UserID
    The ID of the user who inserted this row or changed it last.

    Created
    The timestamp when the entry was created. Your application cannot update this field.

    Component View Attributes Table (ICMSTCOMPVIEWATTRS)

    The ICMSTCOMPVIEWATTRS table associates attribute display names with component type views. When the system administrator defines views on component types, the content manager inserts a row for each attribute display name included in the view. The content manager server also inserts a row for the defined view in the ICMSTCOMPVIEWDEFS table. The view and the attributes must be defined before an association can be made between the view and the attributes.

    Table 39.

    Column Name Data Type Attribute
    ComponentViewID INTEGER NOT null
    AttributeID INTEGER NOT null
    AttributeGroup INTEGER NOT null
    SequenceNum SMALLINT NOT null
    AttributeFlags SMALLINT NOT null
    ViewOperator SMALLINT NOT null
    ViewCompareValue VARCHAR(254) nullable

    Primary Key
    None.

    Indexes
    Unique Indexes
    (ComponentViewID asc, AttributeID asc, AttributeGroup asc)
    (ComponentViewID asc, SequenceNum asc)
    Index
    (AttributeID)
    (AttributeGroup)
     
    

    Referential Constraints
    Foreign Key = AttributeID
      references ICMSTATTRDEFS (AttributeID)
        on delete restrict
    

    Column Definitions

    ComponentViewID
    A component type view, which is a view defined on an item type's Component table.

    A ComponentViewID is generated by the content manager when a new view is created.

    AttributeID
    System-assigned unique ID for the attribute display name.

    This column represents the ID of the attribute display name that is associated with the component type. The attribute display name must be defined in the NLS Keywords table (ICMSTNLSKEYWORDS) before it can be associated with the component type.

    AttributeGroup
    System-assigned unique ID for the attribute group name.

    When you add an attribute group to the component view, the system will add one row for each base attribute in the attribute group and assign the AttributeGroup. If the AttributeID is a base attribute then the attribute group ID is set to zero.

    SequenceNum
    The order of an attribute within the component view. This helps your application display attributes in order of preference.

    This column is for use by your application exclusively. The content manager does not set or interpret this column.

    AttributeFlags
    The attribute bit flags.

    Bit positions are counted from right to left. Counting starts with number 0, so the rightmost bit is bit number 0 and the leftmost bit is bit number 15. Flags using multiple bits are read from left to right within the bit positions they occupy. For example, if bits 0 and 1 are said to have the value 10, that indicates that bit 1 is 1 and bit 0 is 0.

    The bit settings are as follows:

    0000
    Reserved.

    0001
    Indicates a readable attribute.

    0010
    Indicates a writeable attribute.

    0011
    Indicates a readable and writeable attribute.

    0100
    Indicates that this attribute is used to represent the component. This is specifically for the client to be able to display the "name" of a document or folder on the title bar of a dialog, when a document is printed, faxed, etc.

    1000
    Indicates that this attribute is used to exclude unwanted rows. The Operator and Value columns must have data. Only one attribute in the same component view can be set to 1.

    All other bits are reserved for future use.

    If an attribute is set for read access only, even users who have privileges to update the view cannot update this attribute. The attribute flag setting overrides the privileges of the user over the view.

    Exception: In this context, writeable has the same meaning as readable and writeable.

    Your application sets values for this column.

    ViewOperator
    The code assigned to the operator used in the predicate. This release only supports an equal sign.

    0
    Not applicable.

    1
    ICM_Equal.

    ViewCompareValue
    This field contains the value of the attribute (column) equals to.

    |Component View Access Table (ICMSTVIEWACCESS)

    |The ICMSTVIEWACCESS table is empty and will be used for future |reference.
    |

    |Table 40.

    Column Name Data Type Attribute
    ComponentViewID INTEGER NOT null
    SegmentID SMALLINT NOT null
    VIEWACCESSINFO BLOB(100K) NOT null
    ACLSUBSELECT VARCHAR(1000) NOT null
    LASTCHANGEDTS TIMESTAMP NOT null

    Item Auto Link Table (ICMSTITEMAUTOLINK)

    The ICMSTITEMAUTOLINK table predefines container of items in one or more item types. If you set 1 on the AutoLinkEnable column in the ICMSTITEMTYPEDEFS table, then when an item in the item type is created, the item will be automatically added to the predefined container or containers.

    Table 41.

    Column Name Data Type Attribute
    SourceItemTypeID INTEGER NOT null
    SourceCompTypeID INTEGER NOT null
    TargetItemTypeID INTEGER NOT null
    TargetCompTypeID INTEGER NOT null
    LinkType INTEGER NOT null
    AttributeID INTEGER NOT null
    AttributeGroup INTEGER NOT null
    SequenceNum SMALLINT NOT null

    Primary Key
    None.

    Indexes
    Unique Indexes
    (SourceItemTypeID asc, SourceCompTypeID asc, TargetItemTypeID asc, 
    TargetCompTypeID asc, AttributeID asc, AttributeGroup asc)
    Index
    None
    

    Referential Constraints
    Foreign Key = SourceItemTypeID
      references ICMSTITEMTYPEDEFS (ItemTypeID)
        on delete cascade
     
    Foreign Key = SourceCompTypeID
      references ICMSTCOMPDEFS(ComponentTypeID)
        on delete cascade
     
    Foreign Key = TargetItemTypeID
      references ICMSTITEMTYPEDEFS (ItemTypeID)
        on delete cascade
     
    Foreign Key = TargetCompTypeID
      references ICMSTCOMPDEFS(ComponentTypeID)
        on delete cascade 
    

    Column Definitions

    SourceItemTypeID
    A unique identifier for the item type.

    This column represents the source item type ID that is associated with the item.

    SourceCompTypeID
    This column represents the source component type ID that is associated with the item.

    TargetItemTypeID
    This column represents the target item type ID that is associated with the automatical linking.

    TargetCompTypeID
    This column represents the target component type ID that is associated with the automatical linking.

    LinkType
    This column indicates the type of relationship. The valid values are:
    1. Contains - Is the containment relationship.
    2. DKFolder - Is the DK folder and document relationship.

    AttributeID
    System-assigned unique ID for the attribute display name.

    This column represents the ID (KeywordCode in the ICMSTNLSKEYWORDS) of the attribute display name that is associated with the mapping. The attribute display name must be defined in the NLS Keywords table (ICMSTNLSKEYWORDS) before it can be associated with the component type.

    AttributeGroup
    System-assigned unique ID for the attribute group name.

    When you map an attribute group, the system will add one row for each base attribute in the attribute group and assign the AttributeGroup. If the AttributeID is a base attribute then the attribute group ID is set to zero.

    SequenceNum
    The order of an attribute within the source. This helps your application display attributes in order of preference.

    This column is for use by your application exclusively. The content manager does not set or interpret this column.


    Items Table (ICMSTITEMSnnnsss)

    The ICMSTITEMSnnnsss table (where nnn is LibraryID and sss is SysSegmentID) identifies all items within the content manager. If the item has different versions, this table will only keep the current version of the item.

    Table 42.

    Column Name Data Type Attribute
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    ComponentID CHAR(18) NOT null
    SegmentID SMALLINT NOT null
    ACLCode INTEGER NOT null
    SemanticType INTEGER NOT null
    ItemTypeID INTEGER NOT null
    ComponentTypeID INTEGER NOT null
    Changed TIMESTAMP NOT null
    InProgress SMALLINT NOT null

    Primary Key
    ItemID.

    Indexes
    Unique Indexes
    None
    Index
    None
    

    Referential Constraints
    Foreign key = ACLCode
      references ICMSTACCESSCODES (ACLCode)
        on delete restrict
     
    Foreign key = ItemTypeID
      references ICMSTITEMTYPEDEFS (ItemTypeID)
        on delete restrict
     
    Foreign key = ComponentTypeID
      references ICMSTCOMPDEFS (ComponentTypeID)
        on delete restrict
    

    Column Definitions

    ItemID
    A unique key to identify the item. The value for ItemID is generated in content manager the application requests to create an item.

    The ItemID is composed of four fields:


    Table 43.

    Position Description
    1 The first digit of the library server ID: A-0, B-1, C-2, D-3, E-4, F-5, G-6, H-8, I-92
    2 The second digit of the library server ID.
    3-5 The library ID.
    6-8 The segment ID.
    9 A if the first two digits of the year are 20. B if the first two digits of the year are 21.
    10-11 The last two digits of the year.
    12 The character (A-L) representation of the month: A-01, B-02, C-03, D-04, E-05, F-06, G-07, H-08, I-09, J-10, K-11, L-12
    13-14 The day of the month.
    15 A if the first digit of the hour is 0. B if the first digit of the hour is 1. C if the first digit of the hour is 2.
    16 The second digit of the hour.
    17-18 The minutes (mm).
    19-20 The seconds (ss).
    21 The first digit of the microseconds. A-0, B-1, C-2, D-3, E-4, F-5, G-6, H-8, I-9
    22-26 The rest of microseconds (nnnnn).

    This column cannot be updated by your application.

    VersionID
    The current version id of an item. Default is 1. If a new version is created and the VersionID is incremented by one. The old version of the item will be moved to the Item Versions Table.

    This column cannot be updated by your application.

    ComponentID
    The item's component ID.

    SegmentID
    The item's component segment ID. Reserved for future implementation.

    ACLCode
    The ACL code that the Item binds to.

    SemanticType
    The basic classification of an item. For example, a folder, document, resource, memo, picture, or contract.

    ItemTypeID
    A unique identifier for the item type.

    ComponentTypeID
    A unique identifier for the component type.

    Changed
    The last time a change was made to the system-defined or user-defined attributes of the item.

    InProgress
    For any value other than zero, this means that the item is being created or updated.

    Item Versions Table (ICMSTITEMVERnnnsss)

    The ICMSTITEMVERnnnsss table (where nnn is LibraryID and sss is SysSegmentID) identifies old item versions within the content manager. The current version of the item is kept in the Items Table.

    Table 44.

    Column Name Data Type Attribute
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    ComponentID CHAR(18) NOT null
    SegmentID SMALLINT NOT null
    ACLCode INTEGER NOT null
    SemanticType INTEGER NOT null
    ItemTypeID INTEGER NOT null
    ComponentTypeID INTEGER NOT null
    Changed TIMESTAMP NOT null
    InProgress SMALLINT NOT null

    Primary Key
    (ItemID asc, VersionID asc).

    Indexes
    None.

    Referential Constraints
    Foreign key = ACLCode
      references ICMSTACCESSCODES (ACLCode)
        on delete restrict
     
    Foreign key = ItemTypeID
      references ICMSTITEMTYPEDEFS (ItemTypeID)
        on delete restrict
     
    Foreign key = ComponentTypeID
      references ICMSTCOMPDEFS (ComponentTypeID)
        on delete restrict
    

    Column Definitions

    ItemID
    A unique key to identify the item. The value for ItemID is generated in content manager the application requests to create an item.

    This column cannot be updated by your application.

    VersionID
    The version ID of an item.

    This column cannot be updated by your application.

    ComponentID
    The item's component ID.

    SegmentID
    The item's component segment ID.

    ACLCode
    The ACL code that the Item binds to.

    SemanticType
    The basic classification of an item. For example, a folder, document, resource, memo, picture, or contract.

    ItemTypeID
    A unique identifier for the item type.

    ComponentTypeID
    A unique identifier for the component type.

    Changed
    The last time a change was made to the system-defined or user-defined attributes of the item.

    This column value is updated by the content manager (by default) whenever a change (insert, update, delete) is made to the properties, links, names, descriptions or attributes of the item. The installation can change the default value to not update this field by setting the ItemReferenceFlag in the ICMSTSYSCONTROL to 0.

    InProgress
    For any value other than zero, this means that the item is being created or updated.

    Item To Be Deleted Table (ICMSTItemsToDelete)

    The ICMSTItemsToDelete table identifies all items in resource managers to be deleted by asynchronous recovery.

    Table 45.

    Column Name Data Type Attribute
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    RMCode SMALLINT NOT null
    RMAccessType INTEGER NOT null
    SmsCollCode SMALLINT NOT null
    RepType CHAR(8) NOT null
    UserID CHAR(32) NOT null
    Created TIMESTAMP NOT null
    URLAddress VARCHAR(512) nullable

    Primary Key
    |(ItemID asc, VersionID asc, RMCode asc, SMSCollCode).

    Indexes
    None.

    Referential Constraints
    Foreign key = (RMCode, SmsCollCode)
      references ICMSTCOLLNAME (RMCode, SmsCollCode)
        on delete restrict
     
    

    Column Definitions

    ItemID
    A unique key to identify the item.

    The value for ItemID is generated in content manager the application requests to create an item.

    VersionID
    The version id of an item.

    RMCode
    A unique identifier of the resource manager where the BLOB is stored.

    RMAccessType
    Type of the resource manager. It determines the access method.

    SmsCollCode
    The systems management criteria used to manage the BLOB on resource manager storage.

    RepType
    The representation type of the item.

    UserID
    The ID of the user who inserted this row.

    Created
    |The timestamp when the object was last updated, before it was |inserted into the table.

    URLAddress
    URL.

    Item Links Table (ICMSTLINKSnnnsss)

    The ICMSTLINKSnnnsss table maintains relationships between Items. Links can be used to support various functionality. One example use is to support folder and document capability. For support of folder/document, each link represents a folder-document relationship. The TargetItemID represents the document Item, and the SourceItemID represents the folder Item. The LinkType indicates the functionality.

    Table 46.

    Column Name Data Type Attribute
    LinkItemID CHAR(26) nullable
    TargetItemID CHAR(26) NOT null
    SourceItemID CHAR(26) NOT null
    LinkType INTEGER NOT null
    Changed TIMESTAMP NOT null

    Primary Key
    None.

    Indexes
    Unique index = (TargetItemID asc, SourceItemID asc, LinkType asc)
    Index = (SourceItemID asc)
    

    Referential Constraints
    None.

    Column Definitions

    LinkItemID
    The link between two items could be represented by another item. This column contains the item ID that represents the link between two items. This item must exist before it can be used in the link relationship.

    TargetItemID
    The document Item ID if the LinkType contains 2.

    SourceItemID
    The folder Item ID if the LinkType contains 2.

    LinkType
    This column indicates the type of relationship. The valid values are:
    1. Contains: Is the containment relationship.
    2. FolderContains: Is the folder and document relationship.
    3. ContainResource: Is the document and resource relationship.

    System administrator can define user-defined link type.

    Changed
    The timestamp when the entry was created or when it was last updated.

    Item Type Relation Table (ICMSTITEMTYPEREL)

    The ICMSTITEMTYPEREL table uses to define relationships between any two ItemTypes. In Version 8, used to model document to part relationships using references from a child component. This can be extended later to include allowable LinkTypes for modelling link relationships. Nothing is built in which would prevent definition of a hierarchy of related ItemTypes.

    Table 47.

    Column Name Data Type Attribute
    SourceItemTypeID INTEGER NOT null
    TargetItemTypeID INTEGER NOT null
    DfltRMCode SMALLINT NOT null
    DfltCollCode SMALLINT NOT null
    DfltACLCode INTEGER NOT null
    DfltPrefchCollCode SMALLINT NOT null
    VersionControl SMALLINT NOT null

    Primary Key
    None.

    Indexes
    Unique index
    (SourceItemTypeID,TargetItemTypeID)
     
    Index
    (TargetItemTypeID asc)
    

    Referential Constraints
    FOREIGN KEY (SourceItemTypeID)
      REFERENCES ICMSTItemTypeDefs (ItemTypeID)
        ON DELETE RESTRICT,
     
    FOREIGN KEY   (TargetItemTypeID)
      REFERENCES ICMSTItemTypeDefs (ItemTypeID)
        ON DELETE RESTRICT,
     
    FOREIGN KEY  (DfltRMCode)
      REFERENCES ICMSTResourceMgr (RMCode)
        ON DELETE RESTRICT,
     
    FOREIGN KEY  (DfltRMCode, DfltCollCode)
       REFERENCES ICMSTCOLLNAME (RMCode, SmsCollCode)
         ON DELETE RESTRICT,
     
    FOREIGN KEY   (DfltACLCode)
      REFERENCES ICMSTACCESSCODES (ACLCode)
        ON DELETE RESTRICT,
     
    FOREIGN KEY  (DfltRMCode, DfltPrefchCollCode)
      REFERENCES ICMSTCOLLNAME (RMCode, SmsCollCode)
        ON DELETE RESTRICT
    

    Column Definitions

    SourceItemTypeID
    The source Item Type ID.

    TargetItemTypeID
    The target Item Type ID.

    SourceItemID
    The folder Item ID if the LinkType contains 2.

    DfltRMCode
    The default resource manager where item resources pertaining to the target item type are to be stored.

    Your application provides the code of the resource manager that is to contain item resources pertaining to the target item type.

    DfltCollCode
    The default collection where item resources pertaining to the target item type are to be stored.

    Your application provides the code of the collection that is to contain item resources pertaining to the target item type.

    DfltACLCode
    The default ACL code where item resources pertaining to the target item type are to be stored.

    Your application provides the code of the ACL that is to contain item resources pertaining to the target item type.

    DfltPrefchCollCode
    The default prefetch collection where item resources pertaining to the target item type are to be stored.

    Your application provides the code of the prefetch collection that is to contain item resources pertaining to the target item type.

    VersionControl
    This column controls the way versioning is performed on the target item type:

    1
    Always. Always create a new version.

    0
    Never. Versioning is not supported under this item type (default).

    2
    Application specified. Application determines to create a new version or just perform replacement.

    Checked Out Table (ICMSTCHECKEDOUT)

    The ICMSTCHECKEDOUT table maintains a list of all items that have been checked out. When a user check in a locked item, the row will be deleted from this table. The content manager pays attention to rows that reflect currently active checkout locks.

    Table 48.

    Column Name Data Type Attribute
    ItemID CHAR(26) NOT null
    UserID CHAR(32) NOT null
    GroupID CHAR(16) NOT null
    Created TIMESTAMP NOT null

    Primary Key
    None.

    Indexes
    Unique Index
    (UserID, ItemID)
     
    (ItemID)
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    ItemID
    A unique key to identify the item.

    The value for ItemID is generated in content manager the application requests to create an item.

    This column cannot be updated by your application.

    UserID
    The ID of the user who has checked out the item.

    GroupID
    The application-defined ID for grouping related checked out items. It is subsequently used to check in groups of items.

    Your application cannot update this field.

    Created
    The timestamp when the entry was created. Your application cannot update this field.

    Transaction Logging Table (ICMSTTXLT)

    The ICMSTTXLT table contains CM explicit transaction information for asynchronous recovery.

    Table 49.

    Column Name Data Type Attribute
    TxId CHAR(26) NOT null
    ExpireTime TIMESTAMP NOT null
    RMCode SMALLINT NOT null
    Status SMALLINT NOT null
    UserId CHAR(26) NOT null

    Primary Key
    (TxId, RMCode)

    Indexes
    |Unique Index
    |None
    |Index
    |(Status asc, RMCode asc, ExpireTime asc)
    |(RMCode asc, ExpireTime asc)
    
    

    Referential Constraints
    None.

    Column Definitions

    TxId
    Identifies the transaction.

    ExpireTime
    The timestamp which the transaction expires.

    RMCode
    Assigns the resource manager identifier at the end of a transaction. Initially set to -1.

    Status
    Valid values are: 0 = inprogress; 1 = complete.

    UserID
    The ID of the user who inserted this row.

    Resource Table (ICMUTnnnnnsss)

    Component type 300 series are special types of Item Types. These are the sample Component root tables (ICMUTnnnnnsss) for parts. Each row describes a single part. It is possible for a resource belongs to zero, one , or more items. The associations of items and resources are defined in the ICMSTLINKSnnnsss table. It is possible for an item to have zero resources; therefore, there can be an item entry that has no corresponding resources entry in the ICMSTLINKSnnnsss table. However, a resource can belong to multiple items.

    Table 50. ICMBASE (ICMUT00300001 table) and ICMANNOTATION (ICMUT00304001 table)

    Column Name Data Type Attribute
    CompClusterID INTEGER NOT null
    ComponentID CHAR(18) NOT null
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    ACLCode INTEGER NOT null
    SemanticType INTEGER NOT null
    CompKey VARCHAR(23) NOT null
    CREATETS TIMESTAMP NOT null
    CREATEUSERID CHAR(32) NOT null
    LASTCHANGEDTS TIMESTAMP NOT null
    LASTCHANGEDUSERID CHAR(32) NOT null
    RMCODE SMALLINT NOT null
    SMSCOLLCODE SMALLINT NOT null
    RESOURCELENGTH FLOAT NOT null
    MIMETYPEID INTEGER NOT null
    OBJECTUPDATED TIMESTAMP NOT null
    RESOURCEFLAG SMALLINT NOT null
    XDOCLASSID INTEGER NOT null
    EXTOBJECTNAME VARCHAR(128) NOT null
    OBJECTCREATED TIMESTAMP NOT null

    Primary Key
    (CompKey).

    Indexes
    Unique Index
    (ComponentID, VersionID) 
    (ItemID, VersionID)
    (ItemID, ComponentID, VersionID)
    Index
    None
    

    Referential Constraints
    Foreign key = (RMCode, SmsCollCode)
      references ICMSTCOLLNAME
        on delete restrict
     
    Foreign key = MIMETYPEID
      references ICMSTMIMETYPES
        on delete restrict
    

    Column Definitions

    CompClusterID
    Component cluster identification. This column maintains the physical organization of the tables (transparent to the user). This is the current PartitionID in the Item Type Definition table concatenate with part of ItemID timestamp.

    Example:

    PartitionID               ItemID Timestamp
    001                             2000-04-07-20.22.43.123987
    |______________________                       ------------
                             |       _______________________| reversed
                             |      |
    CompClusterID         0017893213
    

    This column cannot be updated by your application.

    ComponentID
    Current timestamp when the item is created.

    This column cannot be updated by your application.

    ItemID
    A unique key to identify the item.

    The value for ItemID is generated in the content manager that the application requests to create an item.

    This column cannot be updated by your application.

    VersionID
    The version ID of the item. Default is 1. If a new version is created, the VersionID is incremented by one.

    ACLCode
    The ACL code that the Item binds to. This column is replicated from Items table (ICMSTITEMSnnnsss) for performance reasons.

    SemanticType
    The semantic type of the item, which describes its basic classification. It can be used to indicate the kind of thing the item is; such as folder, document, resource, memo, picture, and contract.

    For example, suppose you have a book that is available in both the English and the French language. You might set the SemanticType to be 'book' in the Items table. Then you could set the RepType (could be selected by user as an user defined attribute) in the Item Resources table to 'English' for the resource that represents the English version of the book and to 'French' for the resource that represents the French version of the book.

    This field is set and interpreted by your application.

    This field has set definitions that are used by the system. Your application can use these values with the defined meanings.

    Table 51. SemanticType definitions

    Column Name Value
    Document 1
    Folder 2
    WorkBasket 3
    Annotation 4
    History 5
    Workflow 6
    Note 7
    Base 8
    All 9
    ACL 10
    Folder_Doc 11
    MGDS 12
    System 13
    User 14
    Container 15
    ... 16-999
    user defined 1000+

    CompKey
    Concatenate ComponentID (18 bytes timestamp) and VersionID (5 digits number) to form a single column in order to support TIE's single column index.

    This column cannot be updated by your application.

    RMCode
    A unique identifier of the resource manager where the BLOB is stored.

    SmsCollCode
    The systems management criteria used to manage the BLOB on resource manager storage.

    Your application cannot update this field.

    ResourceLength
    The BLOB size in bytes.

    Your application cannot update this field.

    MIMETypeID
    The MIME type of the resource. When you store an object, your application can update this field.

    OBJECTUPDATED
    The timestamp when the object was last updated.

    ResourceFlag
    The internal status of the resource.

    Bit positions are counted from right to left. Counting starts with number 0, so the rightmost bit is bit number 0 and the leftmost bit is bit number 15. Flags using multiple bits are read from left to right within the bit positions they occupy. For example, if bits 0 and 1 are said to have the value 10, that indicates that bit 1 is 1 and bit 0 is 0.

    |The default value is only CM Managed on (0x00000002). Your |application cannot update this field except as a side effect of other |actions. The bit settings are as follows:
    |

    Bit Name Description
    Bit 0 Non CM Managed Indicates that the entry in this ICMUTnnnnnsss table is managed by the external system. It is stored externally to the system, and exists in some external location (pointed to by the ExtObjectName column in this table). The value 01 indicates that the resource is NOT Content Manager managed. The values 00 and 11 are reserved.
    Bit 1 CM Managed Indicates that the resource represented by this entry in this ICMUTnnnnnsss table is managed by the Content Manager subsystem. Meaning, it is stored within the library and managed by a resource manager known to the library. A value of 10 indicates that the resource is Content Manager managed. The values 00 and 11 are reserved.
    Bit 2 No Content Currently has no actual data containing object associated with it yet (no object with an underlining itemID / versionID on this RM/Coll). Resources in this state have placeholders in the library and resource managers and SMS collections associated with them, however an actual object has not yet been stored in an resource manager. Resources in this state are later replaced with actual data objects while retaining all other information given when the resource was stored with no content.
    Bit 3 Waiting Replicator This RM/Coll is waiting for the replicator, which has the latest object to copy or replace over.
    Bit 4 Asynchronous Copy Pending Used for the AsyncStore process. The OOAPI sets it on for an RM AsyncStore start, and the RM turns it off whenever AsyncStore completes (regardless success or failure). During the time between the asynchronous store request and its actual completion, no other actions can be performed on this resource.
    Bit 5 Asynchronous Replace Pending CM toggles this on for an RM AsyncReplace start, and the RM turns it off whenever AsyncReplace completes (regardless success or failure). During the time between the asynchronous replace request and its actual completion, no other actions can be performed on this resource.
    Bit 6 External Object Indicates that the object name cannot be derived from ItemID, ResourceNum and VersionNum. the actual name of the object can be found in ExtObjectName column.
    Bit 7 Replicas Exist The RM contains replicas.
    Bit 8 Asynchronous Failure The AsyncStore or AsyncReplace process failed.

    XDOClassID
    The XDO class ID. Your application provides this ID. The name and description are defined in the XDO Objects table.

    ExtObjectName
    The external object name.

    For resources that are migrated from other image products and do not follow the Content Manager naming convention, the value is the original object name from the migrated products.

    For resources that are not stored in an resource manager defined to the content manager, the value is any user-defined location specified by your application.

    For OS/390, the value is the object name stored in OAM.

    OBJECTCREATED
    The timestamp when the object was created.

    In addition to ICMBBASE columns:

    Table 52. ICMBASETEXT (ICMUT00301001 table) and ICMNOTELOG (ICMUT00303001 table)

    Column Name Data Type Attribute
    TIEFlag SMALLINT NOT null
    TIERef VARCHAR(512) nullable
    CCSID INTEGER nullable
    LANGUAGECODE CHAR(5) nullable
    FORMAT VARCHAR(30) nullable

    Both TIEFlag and TIERef are only included if the XDO Class is set to Text:

    TIEFlag
    This flag indicates that this item is TIE enabled or not. The valid values are:

    0
    Indicates TIERef will always be set to NULL.

    1
    Indicates TIE is enabled and TIERef must has value.

    TIERef
    The TIE reference is a reference to an object stored in a resource manager. This column is used exclusively to allow TIE to fetch and index objects. This field is set by the system and is not updatable by the user.

    In addition to ICMBBASE columns:

    Table 53. ICMBASESTREAM (ICMUT00302001 table)

    Column Name Data Type Attribute
    MediaTimeStamp TIMESTAMP nullable
    MediaState INTEGER nullable
    MediaNVDCmds INTEGER nullable
    MediaDurSeconds INTEGER nullable
    MediaDurFrames INTEGER nullable
    MediaFrameRate INTEGER nullable
    MediaBitRate INTEGER nullable
    MediaCopyRate INTEGER nullable
    MediaNumUsers INTEGER nullable
    MediaType VARCHAR(16) nullable
    MediaResolution VARCHAR(16) nullable
    MediaStandard VARCHAR(16) nullable
    MediaFormat VARCHAR(16) nullable
    MediaAssetGrp VARCHAR(120) nullable

    Resource Manager Table (ICMSTRESOURCEMGR)

    The ICMSTRESOURCEMGR table contains one entry for each resource manager defined to the system.

    Column Name Data Type Attribute
    RMCode SMALLINT NOT null
    RMPlatform SMALLINT NOT null
    UserID CHAR(32) NOT null
    Changed TIMESTAMP NOT null
    RMFlags SMALLINT NOT null
    TokenDuration INTEGER NOT null
    DomainID INTEGER NOT null
    RMUserID CHAR(32) nullable
    RMPassword CHAR(72) FOR BIT DATA nullable
    RMName VARCHAR(128) NOT null
    INetAddr VARCHAR(128) NOT null
    CurrentVersion VARCHAR(128) NOT null
    CacheObjSizeLimit FLOAT NOT null

    Primary Key
    RMCode.

    Indexes
    Unique Index
    RMName
    Index
    None
    

    Referential Constraints
    Foreign Key = DomainID
      references ICMSTAdminDomains (DomainID)
        on delete restrict
    

    Column Definitions

    RMCode
    A unique resource manager identifier. The value for this column is generated by the content manager when a new resource manager is defined.

    RMPlatform
    Identify the RM platform. Valid values are:

    0
    Windows

    1
    AIX

    2
    Solaris

    3
    OS/390

    UserID
    The ID of the user who inserted this row or changed it last.

    Changed
    The timestamp when the entry was created or when it was last updated.

    RMFlags
    |Resource Manager flags. The settings are interpreted in a |bitwise mode, starting from right to left: |

    |Bit 0
    |Indicates that the LAN CACHE for the resource manager is on. 1 |indicates that the LAN CACHE is on. 0 indicates that the LAN CACHE is |off.

    |Bit 1
    |Resource manager is unavailable (set by the library server |watchdog).

    |Bit 2
    |Resource manager is offline (set by the SysAdmin). |

    TokenDuration
    The default life of object token pertaining to this resource manager:

    0
    Do not expire.

    else
    Number of seconds before expiration since the object token is created.

    Your system administrator provides number of seconds of object token pertaining to this resource manager.

    DomainID
    Domain identifier.

    RMUserID
    The ID of the user who will logon on to RM.

    RMPassword
    The pssword of the user who will logon on to RM.

    RMName
    A unique name for the resource manager. The resource manager name should not contain national characters. It should consist of characters from the syntactic character set only.

    INetAddr
    A unique Internet Protocol (IP) address or hostname. It consists of 4 decimal numbers separated by dots; for example, 129.126.178.99 or hostname. |

    |CurrentVersion
    |The resource manager server version, such as 8.1.0.00 |or 8.2.0.00. The default value is |8.2.0.00. |

    |CacheObjSizeLimit
    |The limit size of cached objects. The default value is |0.

    Resource Manager Access Types Table (ICMSTRMACCESSTYPES)

    The ICMSTRMACCESSTYPES table contains one entry for each access protocol type that the resource manager supports in the system.

    Column Name Data Type Attribute
    RMCode SMALLINT NOT null
    RMAccessType INTEGER NOT null
    Port INTEGER NOT null
    AccessData VARCHAR(128) nullable

    Primary Key
    (RMCode, RMAccessType).

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    Foreign key = (RMCode)
      references ICMSTRESOURCEMGR
        on delete cascade
    

    Column Definitions

    RMCode
    A unique resource manager identifier. The value for this column is generated by the content manager when a new resource manager is defined.

    RMAccessType
    The access protocol type of the resource manager. It determines the access method (ex. HTTP, FTP etc.). The name and description of the access type are defined in the NLS Keywords table. Currently, there are five different access types:

    1
    http

    2
    ftp

    3
    rtp

    4
    jdbc

    5
    LSRM

    6
    https

    Port
    A unique port number; identifies the port on which the resource manager listener will be listening.

    AccessData
    For HTTP, this column stores "Directive".

    Your application can provide or update this column.


    Collection Names Table (ICMSTCOLLNAME)

    The ICMSTCOLLNAME table maintains all collection names that can be used by each resource manager. It contains one entry for each collection name used within an resource manager. Thus, if a collection name is used within 2 different resource managers, 2 entries must be created, one for each resource manager.

    Column Name Data Type Attribute
    RMCode SMALLINT NOT null
    SmsCollCode SMALLINT NOT null
    UserID CHAR(32) NOT null
    Created TIMESTAMP NOT null
    PrefetchInd SMALLINT NOT null
    DomainID INTEGER NOT null
    SmsCollName VARCHAR(254) NOT null

    Primary Key
    (RMCode, SmsCollCode).

    Indexes
    Unique Index
    (RMCode asc, SmsCollName asc)
    Index
    None
    

    Referential Constraints
    Foreign key = RMCode
      references ICMSTRESOURCEMGR
        on delete restrict
     
    Foreign Key = DomainID
      references ICMSTAdminDomains (DomainID)
        on delete restrict
    

    Column Definitions

    RMCode
    A unique identifier of the resource manager for which the collection is defined.

    SmsCollCode
    The systems management criteria used to manage the BLOB (an item resource) on resource manager storage.

    Your application cannot update this field.

    UserID
    The ID of the user who inserted this row or changed it last.

    Created
    The timestamp when the entry was created.

    PrefetchInd
    Indicates that the collection name is a prefetch collection name. The valid values are:

    1
    True, prefetch collection name.

    0
    False, collection name.

    DomainID
    Domain identifier.

    SmsCollName
    The collection name.

    MIME Types Table (ICMSTMIMETYPES)

    The ICMSTMIMETYPES table contains one entry for each MIME type defined to the system.

    Column Name Data Type Attribute
    MIMETypeID INTEGER NOT null
    MIMETypeFlags INTEGER NOT null
    MIMEType VARCHAR(254) nullable
    Application VARCHAR(512) nullable
    ApplicationFlags VARCHAR(512) nullable
    Suffixes VARCHAR(512) nullable

    Primary Key
    MIMETypeID.

    Indexes
    Unique Index
    MIMEType     ASC
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    MIMETypeID
    A numeric value representing a particular MIME type.

    MIMETypeFlags
    An indicator indicates whether the MIMEType is null or not or use as argument on not.

    Bit positions are counted from right to left. Counting starts with number 0, so the rightmost bit is bit number 0 and the leftmost bit is bit number 31. Flags using multiple bits are read from left to right within the bit positions they occupy. For example, if bits 0 and 1 are said to have the value 10, that indicates that bit 1 is 1 and bit 0 is 0.

    The bit settings are as follows:

    Bits 0
    Indicate whether the MIMEType is text-searchable.

    Bits 1
    Indicate whether the contents is streamable.

    Bits 7-31
    Reserved.

    MIMEType
    A type of the Multipurpose Internet Mail Extension (MIME). For example, image/tiff, text/plain, and so forth.

    Application
    The name of the application. For example, notepad.

    ApplicationFlags
    Support launching the named application.

    Suffixes
    The suffix (file extension) used by the file type. If there are more than one suffix, separated them by space. For example, txt.

    Item Events Table (ICMSTITEMEVENTS)

    The ICMSTITEMEVENTS table contains records of item CRUD events logged by server depends on the ItemEventFlag in the Item Type Definition Table (ICMSTITEMTYPEDEFS). Events may relate to actions of library users when working on items. After data for an event is created, it cannot be updated.

    Column Name Data Type Attribute
    EventCode INTEGER NOT null
    Created TIMESTAMP NOT null
    ItemID CHAR(26) NOT null
    UserID CHAR(32) NOT null
    EventData1 VARCHAR(254) nullable
    EventData2 VARCHAR(254) nullable
    EventData3 VARCHAR(254) nullable
    EventData4 VARCHAR(254) nullable
    EventData5 VARCHAR(254) nullable

    Primary Key
    None.

    Indexes
    Unique Index
    None
    Index
    Index = (ItemID asc, Created desc, EventCode asc)
    

    Referential Constraints
    None.

    Column Definitions

    EventCode
    Classification of events with similar purposes into groups. Only positive values are allowed. Your application cannot update this field.

    Created
    The timestamp when the entry was created. Your application cannot update this field.

    ItemID
    A unique key to identify the item.

    The value for ItemID is generated in content manager the application requests to create an item.

    This column cannot be updated by your application.

    UserID
    The ID of the user who inserted this row.

    EventData1
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData2
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData3
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData4
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData5
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    System Administration Events Table (ICMSTSYSADMEVENTS)

    The ICMSTSYSADMEVENTS table contains records of System Administration events logged by server depends on SysAdminEventFlag in the System Control table (ICMSTSYSCONTROL). Events may relate to actions of library system administrator. After data for an event is created, it cannot be updated.

    Column Name Data Type Attribute
    EventCode INTEGER NOT null
    Created TIMESTAMP NOT null
    UserID CHAR(32) NOT null
    EventData1 VARCHAR(254) nullable
    EventData2 VARCHAR(254) nullable
    EventData3 VARCHAR(254) nullable
    EventData4 VARCHAR(254) nullable
    EventData5 VARCHAR(254) nullable

    Primary Key
    None.

    Indexes
    |Unique Index
    |None
    |Index
    |Index = (Created desc, EventCode asc)
    
    

    Referential Constraints
    None.

    Column Definitions

    EventCode
    Classification of events with similar purposes into groups. Only positive values are allowed. Your application cannot update this field.

    Created
    The timestamp when the entry was created. Your application cannot update this field.

    UserID
    The ID of the user who inserted this row.

    EventData1
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData2
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData3
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData4
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    EventData5
    System-defined event data. Your application cannot update data in this field that is associated with system-defined event codes.

    Text Search Table (ICMSTTEXINDEXCONF)

    The ICMSTTEXINDEXCONF table contains text search information of each text searchable column. Rows are inserted into this table be defineCompType. These values are used by defineTIEIndex SP to create and update indexes.

    Column Name Data Type Attribute
    ComponentTypeID INTEGER NOT null
    CCSID INTEGER nullable
    ModelCCSID INTEGER nullable
    MinChanges INTEGER nullable
    CommitCount INTEGER nullable
    LanguageCode CHAR(5) nullable
    Format VARCHAR(30) nullable
    ColumnName VARCHAR(18) NOT null
    IndexName VARCHAR(18) NOT null
    SchemaName VARCHAR(128) NOT null
    UpdateFeq VARCHAR(300) nullable
    IndexDir VARCHAR(254) nullable
    WorkingDir VARCHAR(254) nullable
    ModelName VARCHAR(254) nullable
    ModelFile VARCHAR(254) nullable
    UDFName VARCHAR(18) nullable
    UDFSchema VARCHAR(18) nullable

    Primary Key
    (ComponentTypeID, ColumnName).

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    Foreign key = (ComponentTypeID)
      references ICMSTCompDefs (ComponentTypeID)
        on delete cascade
    

    Column Definitions

    ComponentTypeID
    A unique identifier for the component type.

    CCSID
    The Coded Character Set Identifier to be used when indexing text documents.

    ModelCCSID
    The Coded Character Set Identifier to be used for interpreting the contents of the model file.

    MinChanges
    The minimum number of changes to the text column before the index is updated.

    CommitCount
    For update processing a commit count can be specified.

    LanguageCode
    The language that determines the end-of-sentence and end-of-paragraph detection when indexing documents. This is the TIE Language code, not the CM Language code. The TIE Lanaguage code is 5 characters and has the form EN_US.

    Format
    The format of text documents in the column, such as HTML. DB2 Text Information Extender needs this information when indexing documents different from the defaults. The document formats supported for structured documents are:

    For these formats, you can specify the structure information in a document model file, If not specified, the whole document's text is indexed.

    ColumnName
    This is the column name in the base table for the attribute that is being made text searchable.

    IndexName
    This is the name of the TIE index. This is generated by define_CompType.

    SchemaName
    This is the schema name for the index. For CM this is always ICMADMIN.

    UpdateFeq
    The index update frequency in terms of when the update is to be made. If there are not enough text documents in the log table at the day and time given, the index is not updated. If you do not specify UPDATE FREQUENCY, the default frequency specified in the database configuration settings is used, if not specified, no further index updates are made. This may be useful for a text column in which there will be no further changes.

    D
    The days of the week when the index is updated. An asterisk (*) means everyday. The values from 0 to6 represent days of the week (0 equals Sunday).

    H
    The hours of the specified days when the index is updated. An asterisk (*) means every hour. The values from 0 to 23 represent hours in a day (0 equals midnight).

    M
    The minutes of the specified hours when the index is updated. The values from 0 to 59 represent the minutes in an hour.

    NONE
    No further index updates are made. The update has to be started manually.
    Example: An update frequency of D(*)H(*)M(10) means that the index is updated on all days, in each hour, at 10 minutes after the hour.

    IndexDir
    The directory path in which the text index is to be stored. This is a directory on the system where the index data are stored. If the directory does not as yet exist, you should create one for the DB2 instance owner user ID. If it already exists, ensure on UNIX platforms that the directory has read/write permissions for the instance owner

    WorkingDir
    A separate work directory may be specified optionally, that will be used to store temporary files during index search and administration operations. If the directory does not yet exist, it is created for the DB2 instance owner user ID. If it already exists, ensure on UNIX platforms that the directory has read/write permissions for the instance owner.

    ModelName
    Specifies the name of the model.

    ModelFile
    Specifies the location of a model file that contains a model definition for the format in the FORMAT clause. It must be readable for the DB2 instance owner. A document model allows to index and search specific sections of a document. The markup tags and section names can be defined in a document model.

    A document model is bound to a document format that supports structures (HTML, XML, GPP). Only one document model may be specified in a model file. Document models need not to be referenced in search conditions, all section names in the model file can be used in search conditions. The document model will only be read during the creation of the text index. Any later changes are not recognized for this index.

    UDFName
    The schema and name of a user-defined function to be used by DB2 Text Information Extender to access text documents that are in a column that is not of a supported type. The function has one input parameter of an arbitrary column type and returns a value of one of the DB2 Text Information Extender supported types. Its task is to perform a column type conversion.

    This is used by CM to handle the indexing of documents stored in the resource manager. When indexing the content of resource manager documents, the UDF name is set to ICMFetchContent.

    UDFSchema
    The UDF's schema name. For the CM predefined UDF this will be set to ICMADMIN.

    For more details on these fields see the TIE Reference.


    XDO Objects Table (ICMSTXDOOBJECTS)

    The ICMSTXDOOBJECTS table contains XDO class definitions and Java(TM) XDO class name in the system.

    Column Name Data Type Attribute
    XDOClassID INTEGER NOT null
    AttributeGroup INTEGER NOT null
    XDOClassName VARCHAR(254) NOT null
    XDOClassDesc VARCHAR(254) nullable
    JavaXDOClassName VARCHAR(254) nullable

    Primary Key
    XDOClassID.

    Indexes
    Unique Index
    XDOClassName
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    XDOClassID
    A numeric value representing a particular XDO class.

    AttributeGroup
    System-assigned unique ID for the attribute group name.

    ResourceBlob (AttributeGroup=3)
    Assigned to XDO for BLOB.

    ResourceText (AttributeGroup=4)
    Assigned to XDO for text.

    ResourceImage (AttributeGroup=5)
    Assigned to XDO for image

    ResourceMedia (AttributeGroup=6)
    Assigned to XDO for media.

    XDOClassName
    The XDO class name.

    XDOClassDesc
    The description of the XDO class.

    JavaXDOClassName
    The Java class name in the Java environment.

    XDO Object Factory Table (ICMSTXDOOBJFACTORY)

    The ICMSTXDOOBJFACTORY table contains XDO object factories in the system.

    Column Name Data Type Attribute
    XDOClassID INTEGER NOT null
    SystemType SMALLINT NOT null
    CompileOption SMALLINT NOT null
    CPPXDOFactory VARCHAR(254) nullable

    Primary Key
    (XDOClassID, SystemType, CompileOption).

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    Foreign Key = XDOClassID
      references ICMSTXDOOBJECTS (XDOClassID)
        on delete cascade
    

    Column Definitions

    XDOClassID
    A numeric value representing a particular XDO class.

    SystemType
    The type of the system. The following values have been defined:

    1
    Windows

    2
    AIX

    CompileOption
    The compile option is used to generate the XDO factoried. The following values have been defined:

    0
    Non-Debug compile option

    1
    Debug compile option

    CPPXDOFactory
    The DLL name to be loaded dynamically in order to create the XDO object on the Window C++ environment or the SO name to be loaded dynamically in order to create the XDO object on the UNIX C++ environment.

    Reference Integrity Table (ICMSTRInnnsss)

    The ICMSTRI0nnnsss table (where nnn is LibraryID and sss is SysSegmentID) maintains the Referential Integrity of all the references exist within the content manager.

    Column Name Data Type Attribute
    SourceItemID CHAR(26) NOT null
    SourceItemTypeID INTEGER NOT null
    SourceCompID CHAR(18) NOT null
    SourceCompTypeID INTEGER NOT null
    SourceVersionID SMALLINT NOT null
    TargetItemID CHAR(26) NOT null
    TargetItemTypeID INTEGER NOT null
    TargetCompID CHAR(18) NOT null
    TargetCompTypeID INTEGER NOT null
    TargetVersionID SMALLINT NOT null
    RRIID CHAR(26) NOT null
    Status SMALLINT NOT null

    Primary Key
    RRIID.

    Indexes
    (SourceItemID ASC,  SourceCompID ASC, SourceVersionID ASC, SourceCompTypeID ASC)
    (TargetItemID ASC, TargetVersionID ASC, TargetCompID ASC, TargetCompTypeID ASC)
     
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    SourceItemID
    Identifies the Item ID of the source row.

    SourceItemTypeID
    Identifies the ItemType ID of the source row.

    SourceCompID
    Identifies the Component ID of the source row.

    SourceCompTypeID
    Identifies the Component Type ID of the source table.

    SourceVersionID
    Identifies the version ID information of a source row

    TargetItemID
    Identifies the Item ID of the target row.

    TargetItemTypeID
    Identifies the ItemType ID of the target row.

    TargetCompID
    Identifies the Component ID of the target row.

    TargetCompTypeID
    Identifies the Component Type ID of the target table

    TargetVersionID
    Identifies the version ID information of a target row.

    RRIID
    Uniquely identifies a reference.

    Status
    The status of the RI row.The valid values are:

    0
    Active RI row

    1
    Inactive RI row which the source row has been deleted

    2
    Inactive RI row which the reference of the source row has been set to null.

    Replicas Rules Table (ICMSTREPLICARULES)

    The ICMSTREPLICARULES table contains all source and target replication relationships information.

    Column Name Data Type Attribute
    SourceRMCode SMALLINT NOT null
    SourceSmsCollCode SMALLINT NOT null
    TargetRMCode SMALLINT NOT null
    TargetSmsCollCode SMALLINT NOT null
    Priority SMALLINT NOT null

    Primary Key
    (SourceRMCode, SourceSmsCollCode,TargetRMCode, TargetSmsCollCode).

    Indexes
    |Unique Index
    |(SourceRMCode, SourceSmsCollCode, Priority)
    |Index
    |None
    
    

    Check
    CHECK (NOT (SourceRMCode = TargetRMCode
      AND SourceSMSCollCode = TargetSmsCollCode))
     
    CHECK (SourceRMCode> 0  AND SourceSmsCollCode > 0
      AND TargetRMCode > 0 AND TargetSmsCollCode > 0)
    

    Referential Constraints
    |FOREIGN KEY (SourceRMCode, SourceSmsCollCode)
    |  REFERENCES ICMSTCOLLNAME (RMCode, SmsCollCode)
    |    ON DELETE CASCADE,
    | 
    |FOREIGN KEY (TargetRMCode, TargetSmsCollCode)
    |  REFERENCES ICMSTCOLLNAME (RMCode, SmsCollCode)
    |    ON DELETE CASCADE
    
    

    Column Definitions

    SourceRMCode
    The source resource manager to be replicated.

    SourceSmsCollCode
    The source collection to be replicated.

    TargetRMCode
    The target resource manager to which the target collection should be replicated.

    TargetSmsCollCode
    Collection in the target resource manager where replication occurs. |

    |Priority
    |Priority number for the target pair of resource managers. When a |source pair is unavailable at run-time, Content Manager attempts to access |objects on the target pairs based on their priority order. The smaller |the number, the higher the priority.

    Replicas Table (ICMSTREPLICAS)

    The ICMSTREPLICAS table contains items with the replica rules applied. As long as a replica is inserted, it can't be deleted unless this item is removed by deleteItem function. Moreover, no replicas are added or removed during updateItem time.

    Column Name Data Type Attribute
    ItemID CHAR(26) NOT null
    VersionID SMALLINT NOT null
    RMCode SMALLINT NOT null
    SmsCollCode SMALLINT NOT null
    ResourceFlag SMALLINT NOT null
    ResourceLength FLOAT NOT null
    ObjectCreated TIMESTAMP NOT null
    ObjectUpdated TIMESTAMP NOT null
    Priority SMALLINT NOT null

    Primary Key
    (ItemID, VersionID, RMCode, SmsCollCode).

    Indexes
    |Unique Index
    |(ItemID, VersionID, Priority)
    |Index
    |None
    
    

    Referential Constraints
    FOREIGN KEY (RMCode, SMSCollCode)
      REFERENCES  ICMSTCOLLNAME (RMCode, SmsCollCode)
        ON DELETE RESTRICT
    

    Column Definitions

    ItemID
    A unique key to identify the item. The ItemID must exist in the Component Root table. This column cannot be updated by your application.

    VersionID
    A version ID assigned by the system. Your application cannot update this field.

    RMCode
    A unique identifier of the resource manager where the object is stored.

    SmsCollCode
    The systems management criteria used to manage the object on resource manager storage. |

    |ResourceFlag
    |The internal status of the resource.

    |Bit positions are counted from right to left. Counting starts with |number 0, so the rightmost bit is bit number 0 and the leftmost bit is bit |number 15. Flags using multiple bits are read from left to right within |the bit positions they occupy. For example, if bits 0 and 1 are said to |have the value 10, that indicates that bit 1 is 1 and bit 0 is 0.

    |The default value is only CM Managed on (0x00000002). Your |application cannot update this field except as a side effect of other |actions. The bit settings are as follows:
    |

    Bit Name Description
    Bit 0 Non CM Managed Indicates that the entry in this table is managed by the external system. It is stored externally to the system, and exists in some external location (pointed to by the ExtObjectName column in this table). The value 01 indicates that the resource is NOT Content Manager managed. The values 00 and 11 are reserved.
    Bit 1 CM Managed Indicates that the resource represented by this entry in this table is managed by the Content Manager subsystem. Meaning, it is stored within the library and managed by a resource manager known to the library. A value of 10 indicates that the resource is Content Manager managed. The values 00 and 11 are reserved.
    Bit 2 No Content Currently has no actual data containing object associated with it yet (no object with an underlining itemID / versionID on this RM/Coll). Resources in this state have placeholders in the library and resource managers and SMS collections associated with them, however an actual object has not yet been stored in an resource manager. Resources in this state are later replaced with actual data objects while retaining all other information given when the resource was stored with no content.
    Bit 3 Waiting Replicator This RM/Coll is waiting for the replicator, which has the latest object to copy or replace over.
    Bit 4 Asynchronous Copy Pending Used for the AsyncStore process. The OOAPI sets it on for an RM AsyncStore start, and the RM turns it off whenever AsyncStore completes (regardless success or failure). During the time between the asynchronous store request and its actual completion, no other actions can be performed on this resource.
    Bit 5 Asynchronous Replace Pending CM toggles this on for an RM AsyncReplace start, and the RM turns it off whenever AsyncReplace completes (regardless success or failure). During the time between the asynchronous replace request and its actual completion, no other actions can be performed on this resource.
    Bit 6 External Object Indicates that the object name cannot be derived from ItemID, ResourceNum and VersionNum. the actual name of the object can be found in ExtObjectName column.
    Bit 7 Replicas Exist Indicates that this is a Replica RM. By default, this bit is on.
    Bit 8 Asynchronous Failure The AsyncStore or AsyncReplace process failed.

    ResourceLength
    The replicated object size in bytes.

    ObjectCreated
    The timestamp when the entry was created. Your application cannot update this field.

    ObjectUpdated
    The last time a change was made of the item. |

    |Priority
    |Priority number for the target pair of resource managers. When a |source pair is unavailable at run-time, Content Manager attempts to access |objects on the target pairs based on their priority order. The smaller |the number, the higher the priority.

    Document routing tables


    Item type: Routing Process (200)

    Before calling ICMCreateItem to create the process, you must define process name, process description, menu name, menu description to get the process ID, menu ID. A Process consists of a root row and child rows which define the route.

    Table 54. Root table: RoutingProcess (200)

    Attr ID Attribute SQL type Attribute flag BaseView
    200 ProcessName Char(32) Not Null Unique Yes
    201 ProcessDescription Char(256) Not Null Yes

    ProcessName
    The name of the process.

    LastChanged
    The timestamp of when this process is modified. As in: its name, description in NLSKeywords table, the menu name, menu description in NLSKeywords table, and its routing steps.

    Table 55. Child table: RoutingSteps (201)

    Attr ID Attribute SQL type Attribute flag BaseView
    202 FromWNItemID Char(26) nullable Yes
    203 ToWNItemID Char(26) nullable Yes
    204 MenuName Char(32) nullable No

    FromWNItemID
    The itemID for the From work node (NULL if this is the start node). This is the foreign key to the itemID column in the WorkNode table. You cannot declare the foreign key for this column.

    ToWNItemID
    The itemID for the To work node (NULL if this is the end node). This is the foreign key to the itemID column in the WorkNode table (see below for WorkNode table). You cannot declare the foreign key for this column.

    MenuName
    A menu is the name of the routing step.

    Item type: Work Node (202)

    Before calling ICMCreateItem to create a work node, you must define work node name and work node description to get the work node ID. A work node item consists of a root row (that defines the work nodes characteristic) and child rows in several tables (to define work packages currently located at this work node).

    Table 56. Root table: WorkNode (202)

    Attr ID Attribute SQL type Attribute flag BaseView
    205 WorkNodeName Char(32) not null unique Yes
    206 WorkNodeDescription Char(256) not null Yes
    207 WorkNodeType smallint not null Yes
    208 MaxNodeTime Integer not null Yes
    209 OverloadLimit Integer not null Yes
    210 OverloadDllPath varchar(256) nullable No
    211 OverloadFunc varchar(128) nullable No
    212 EnterDllPath varchar(256) nullable No
    213 EnterFunc varchar(128) nullable No
    214 LeaveDllPath varchar(256) nullable No
    215 LeaveFunc varchar(128) nullable No

    WorkNodeName
    The name of the work node.

    WorkNodeType
    Type of the work node: 0 represents work basket and 1 represents Collection point.

    MaxNodeTime
    Specifies the maximum time that a work package is expected to be at a work node. When that time has been reached, the notify flag is set. Each work node can optionally have a time limit of how long a work package can stay. If the work package stays longer, the notify flag for that work package is raised. 0 means not used.

    OverloadLimit
    The maximum number of work packages can be in this work node at a time. 0 means not used. The maximum number is expected. When the maximum is reached, the overload exit enables special processing, and the routing does not fail.

    OverloadDllPath
    The full path to the user DLL file (and the file name). For example, C:\foo\myOverLoad.dll. The library server loads this DLL, and invokes a function defined in the OverloadFunction column. This performs the user exit function when you route a work package to the work node that already reached its maximum capacity.

    OverloadFunc
    The user function name defined inside Overload file to be used for overload notification purposes.

    EnterDllPath
    The full path to the user DLL file (and the file name). For example, C:\foo\myEnter.dll. The library server loads this DLL, and invokes a function defined in the EnterFunction column. This performs the user exit function when you route a work package and enter this work number.

    EnterFunc
    The user function name defined inside the Enter DLL file, to be used for entering the notification purpose.

    LeaveDllPath
    The full path to the user DLL file (and the file name). For example, C:\foo\myLeave.dll. The library server loads this DLL and invokes a function defined in the LeaveFunction column. This performs the user exit function when you route a work package and leave this work node.

    LeaveFunc
    The user function name defined inside the Leave DLL file, to be used for leaving notification purposes.


    Table 57. Child table: CollectionResumeList (203)

    Attr ID Attribute SQL type Attribute flag BaseView
    216 FolderITID Integer Not Null Yes
    217 RequiredITID Integer Not Null Yes
    218 QuantityNeeded Integer Not Null Yes

    If a work node is a collection point, then it must have a resume list. This table is used for this purpose. Since different folder types (such as Item type) can come to a collection point, this table should identify the resume list each folder type. Each resume list identifies which item type the folder needs, and how many documents you need to satisfy the collection point requirement.

    FolderITID
    Identifies the folder item type. 0 means any folder item type.

    RequiredITID
    Identifies which item type this folder type needs. 0 means any item type.

    QuantityNeeded
    Identifies how many documents of the associated RequiredItemTypeID needed to satisfy the requirement. 0 means optional. However, if N rows (N >=1) have this 0, then at least one row among them must have a document to pass the collection point requirement.


    Table 58. Child table: WorkPackage (204)

    Attr ID Attribute SQL type Attribute flag BaseView
    219 Priority Integer Not Null Yes
    220 ProcessItemID Char(26) Not Null Yes
    221 ProcessLastChg TimeStamp Not Null Yes
    222 LastAccUserID Char(32) Not Null Yes
    223 LastAccTime TimeStamp Not Null Yes
    217 NotifyFlag Smallint Not Null Yes
    225 NotifyTime TimeStamp Nullable Yes
    226 SuspendFlag Smallint Not Null Yes
    227 ResumeTime TimeStamp Nullable Yes
    228 AssignedUserID Char(32) Nullable Yes
    100 Attribute 100 Char(26) Not Null Yes
    101 Attribute 101 Integer Not Null Yes
    105 Attribute 105 TimeStamp Not Null Yes
    110 Attribute 110 Integer Not Null Yes
    115 Attribute 115 SmallInt Not Null Yes
    120 Attribute 120 Char(26) Not Null Yes

    Each work node contains work packages. A work package is modeled as a child component of a work node. This child component has two direct child components: ItemResumeList to hold the item resume list, and ContainerData to hold the container data information

    Priority
    Specifies the priority of a work package. 0 means top priority. The bigger the number is, the lower priority the work package has.

    ProcessItemID
    The item ID of the process that this package is routing on. It is a foreign key to the itemID column of the RoutingProcess table mentioned above.

    ProcessLastChg

    LastAccUserID
    User ID of the last user to move the work package.

    LastAccTime
    The timestamp that specifies when the work package was last moved.

    NotifyFlag
    0 represents off. 1 represents on.

    NotifyTime
    A future timestamp that specifies when to set the work package to notify state. Specify NULL if not used. For example, if the work node does not enable the notify feature by setting NotifyTimeInHour to 0.

    SuspendFlag
    Suspends the work package if set to 1. 0 represents off. If the work package comes to a collection point and fails the collection point requirement, the SuspendFlag is automatically set to 1.

    ResumeTime
    A future timestamp that specifies when to clear the suspend flag. It is used in suspend for time case. Specify NULL if not used. For example, if the work package is not in the suspended state, or if either a collection point or user forced this work package into suspended state.

    The following reference attributes refer to the item ID that is being routed by this work package.

    Attribute ID = 100
    Target item ID: the item ID of the target component.

    Attribute ID = 101
    Target item type ID: the item type ID of the target component.

    Attribute ID = 105
    Target component ID: the component ID of the target component.

    Attribute ID = 110
    Target component type ID: the target component type ID of the target component.

    Attribute ID = 115
    Target version ID: the target version ID of the target component. If this attribute is set to 0, that implies that this reference is pointing to the newest version.

    Attribute ID = 120
    RRIID: this attribute is maintained by the system, and is hidden from the user.

    Table 59. Child table: ItemResumeList (205)

    Attr ID Attribute SQL type Attribute flag BaseView
    217 RequiredITID Integer Not Null Yes
    218 QuantityNeeded Integer Not Null Yes

    Content Manger Version 7 supports a feature called suspend. This forces folder items into a non-collection point work node and suspends the arrival of other items. This table is used for this purpose.

    RequiredITID
    Identifies which item type this folder type needs. 0 means any item type.

    QuantityNeeded
    Identifies how many documents of the associated RequiredItemTypeID that are needed to satisfy the requirement. 0 means optional. However, if N rows (N >=1) have this 0, then at least one row among them must have a document to satisfy the resume requirement.

    Table 60. Child table: ContainerData (208)

    Attr ID Attribute SQL type Attribute flag BaseView
    238 ContainerDataName Char(32) nullable Yes
    239 ContainerDataVal Varchar(254) nullable Yes

    Holds container data for a work package. Carries name and value pairs as provided by client applications (for example, LastAction/Approve).

    ContainerDataName
    Name of container data.

    ContainerDataVal
    Container data value.

    Item Type: Work List (206)

    Before calling ICMCreateItem to create a work list, you must define work list name and work list description to get the WorkListID.

    Table 61. Child table: ContainerData (208)

    Attr ID Attribute SQL type Attribute flag BaseView
    238 ContainerDataName Char(32) Not Null Yes
    239 ContainerDataVal Varchar(254) Not Null Yes

    ContainerDataName
    Name of container data.

    ContainerDataVal
    Container data value.

    Table 62. Root table: WorkList (206)

    Attr ID Attribute SQL type Attribute flag BaseView
    229 WorkListName Char(32) Not Null Unique Yes
    230 WorkListDescription Char(256) Not Null Yes
    231 SelectionOrder smallint Not Null Yes
    232 SuspendedFilter smallint Not Null Yes
    233 NotifiedFilter smallint Not Null Yes
    234 ReturnSize integer Not Null Yes
    235 AssignFilter smallint Not Null Yes

    WorkListName
    The name of the work list.

    WorkListDescription
    Describes the work list.

    SelectionOrder
    Specifies the retrieval order of all work packages from the work list.

    0
    Order by priority.

    1
    Order by last access time ascending.

    2
    Order by last access time descending.

    SuspendedFilter
    If set to 1 (yes), this filters out the suspended work package. 0 means no.

    NotifiedFilter
    If set to 1 (yes), this filters out the work package currently in notify state. 0 means no.

    ReturnSize
    The maximum number of work packages that you can fetch from this work list.

    0
    Return all.

    1
    System assigned. Usually, you need to call getWorkList to get a list of available work package, select one work package, and call getWork with the work package item ID in order to check out the document associated with this work package. However, when the work list ReturnSize is 1, then the user can provide the WorkList item ID in getWork instead of the work package item ID and be able to check out the document as if.

    >1
    A specific limit.

    Table 63. Child table: WorkNodeList (207)

    Attr ID Attribute SQL type Attribute flag BaseView
    236 WorkNodeItemID Char(26) Not Null Yes
    237 WorkNodeOrder smallint Not Null Yes

    WorkNodeItemID
    The item ID of the work node that this work list spans. If the WorkList root row contains no row in the WorkNodeList child table, then this work list spans all available work nodes.

    WorkNodeOrder
    Order of worknodes within a worklist.

    Resource manager tables


    RMVERSION

    This table holds information that describes level and history and platform. It is currently only used to aid migrations from level to level.

    Table 64.

    Column Name Data Type Attribute
    Platform CHAR(17) NOT null
    Version INTEGER NOT null
    LastUpdated TIMESTAMP NOT null
    Created TIMESTAMP NOT null

    Column Definitions

    Platform
    Platform specifier. Values include AIX, NT, and SUN.

    Version
    Incremented version number. The values are:

    Table 65. Content Manager versions

    Version Product
    1 Content Manager Version 6
    2 Content Manager Version 7
    3 Content Manager Version 8

    LastUpdated
    House keeping values for history of last update.

    Created
    Creation date of this database.

    RMACCESS

    This table holds user information (one for each RMServer entry). It is not designed to hold multiple users for any given server.

    Table 66.

    Column Name Data Type Attribute
    ACC_USERID SMALLINT NOT null
    ACC_USERNAME CHAR(32) NOT null
    ACC_PASSWORD CHAR(128) FOR BIT DATA NOT null
    ACC_PUBLIC_KEY VARCHAR(3800) FOR BIT DATA NOT null WITH DEFAULT '',

    Primary Key
    (ACC_USERID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    ACC_USERID
    An ID number for reference from the RMServer table. The next highest number is always used for inserts.

    ACC_USERNAME
    A user name.

    ACC_PASSWORD
    A password. If necessary, this field can be updated with an unencrypted password. The server will automatically encrypt it the first time it is used. Each server has its own key. If the key is lost, then it cannot be recovered. The encryption mechanism is distinctly different from Content Manager Version 7.

    ACC_PUBLIC_KEY
    Meant to hold a X509 certificate. Currently only used to hold the pre-key parts for the LS Token.

    RMSERVER

    This table holds server information including itself. It extends use of Content Manager Version 6, and replaces the FRNOLINT.

    Table 67.

    Column Name Data Type Attribute
    SVR_SERVERID SMALLINT NOT null
    SVR_SERVERTYPE CHAR(4) NOT null
    SVR_SERVERNAME CHAR(32) NOT null
    SVR_PROTOCOL CHAR(5) NOT null
    SVR_USERID SMALLINT NOT null
    SVR_HOSTNAME VARCHAR(254) NOT null
    SVR_PORT INTEGER NOT null
    SVR_SCHEMA CHAR(32) NOT null
    SVR_PATH CHAR(254) NOT null
    SVR_SERPLATFORM CHAR(17) NOT null

    Primary Key
    (SVR_SERVERID)

    Indexes
    Unique Index
    IDX_BOS_NAME ON RMSERVER (SVR_SERVERNAME ASC);
    Index
    None
    

    Referential Constraints
    FOREIGN KEY (SVR_USERID)
      REFERENCES RMACCESS
        ON DELETE RESTRICT
        ON UPDATE RESTRICT
    

    Trigger
    CREATE TRIGGER RMSERVER_CASECHECK
    NO CASCADE BEFORE INSERT ON RMSERVER
    REFERENCING NEW AS N
    FOR EACH ROW MODE DB2SQL
    WHEN (LCASE(N.SVR_SERVERNAME) = (SELECT LCASE(SVR_SERVERNAME)
    FROM RMSERVER WHERE LCASE(N.SVR_SERVERNAME) = LCASE(SVR_SERVERNAME)))
    SIGNAL SQLSTATE '75000' ('Servername already exists') ;
    

    Column Definitions

    SVR_SERVERID
    An ID number for reference by the RMVolumes table. The next highest number is always used for inserts.

    SVR_SERVERTYPE
    Describes the server class. Allowed values are RM, LS, TSM, VC, MA.

    SVR_SERVERNAME
    DataBase name or a user specified identifier if dbname is not relevent. All dbnames in the enterprise must be unique.

    SVR_PROTOCOL
    Protocol used to talk to server, one per server. Allowed values: http, jdbc. Future values: https, ftp, rtp.

    SVR_USERID
    An ID that maps to an RMAccess row.

    SVR_HOSTNAME
    Fully qualified hostname. Should not be an IP number.

    SVR_PORT
    Port number used for the protocol. Currently only valid for HTTP.

    SVR_SCHEMA
    Schema name for databases.

    SVR_PATH
    Server pathname for HTTP access. |

    |SVR_SERPLATFORM
    |Server platform. The currently accepted values are: |WIN, AIX, SUN, and |S390.

    RMOBJECTS

    This table holds one row for each physical file managed or referencable.

    Table 68.

    Column Name Data Type Attribute
    OBJ_LIBRARYID SMALLINT NOT null
    OBJ_ITEMID CHAR(26) NOT null
    OBJ_VERSION SMALLINT NOT null WITH DEFAULT 1
    OBJ_COLLECTIONID INTEGER NOT null
    OBJ_MGTCLASSID SMALLINT NOT null
    OBJ_STGCLASSID SMALLINT NOT null
    OBJ_ATTRIBUTES SMALLINT NOT null WITH DEFAULT 0
    OBJ_RETENTION INTEGER NOT null WITH DEFAULT 0
    OBJ_VOLUMEID INTEGER NOT null
    OBJ_STAGEDVOLUMEID INTEGER NOT null WITH DEFAULT -1
    OBJ_PATH INTEGER NOT null
    OBJ_STATUS CHAR NOT null
    OBJ_SIZE BIGINT NOT null
    OBJ_CREATEDATE TIMESTAMP NOT null WITH DEFAULT CURRENT TIMESTAMP
    OBJ_UPDATEDATE TIMESTAMP NOT null WITH DEFAULT CURRENT TIMESTAMP
    OBJ_REFERENCEDDATE TIMESTAMP NOT null WITH DEFAULT CURRENT TIMESTAMP
    OBJ_ACTIONDATE DATE NOT null
    OBJ_MGTCLASSDATE DATE NOT null
    OBJ_STGCLASSDATE DATE NOT null
    OBJ_PLAYSTATUS CHAR NOT null
    OBJ_VOLSTATUS CHAR NOT null
    OBJ_OBJECTNAME VARCHAR(128) NOT null WITH DEFAULT ''
    OBJ_ORGFILENAME VARCHAR(128) NOT null WITH DEFAULT ''
    OBJ_FILENAME VARCHAR(128) NOT null WITH DEFAULT ''
    OBJ_MIMETYPE VARCHAR(128) NOT null WITH DEFAULT 'text/html'

    Primary Key
    (OBJ_LIBRARYID,OBJ_ITEMID,OBJ_VERSION,OBJ_COLLECTIONID)

    Indexes
    Unique Index
    None
    Index
    IDX_OBJ_ACTION ON RMOBJECTS ( OBJ_ACTIONDATE ASC );
    IDX_OBJ_VOLUME ON RMOBJECTS ( OBJ_VOLUMEID ASC );
    

    Referential Constraints
     (OBJ_LIBRARYID) REFERENCES RMSERVER
       ON DELETE RESTRICT
       ON UPDATE RESTRICT
     ) IN OBJECTS;
    

    Column Definitions

    OBJ_LIBRARYID
    An ID value that maps to the RMServer table. The currently single Library server is expected to be ID 1.

    OBJ_ITEMID
    LS Item ID.

    OBJ_VERSION
    LS Version number.

    OBJ_COLLECTIONID
    An ID value that maps to the RMCollections table. ID's may not match between LS and RM. Collections are accessed externally by name.

    OBJ_MGTCLASSID
    An ID value that maps to the RMManagementClass table.

    OBJ_STGCLASSID
    An ID value that maps to the RMStorageClass table.

    OBJ_ATTRIBUTES
    Not currently used.

    OBJ_RETENTION
    Not currently used. Retention managed by LS.

    OBJ_VOLUMEID
    An ID value that maps to the RMVolumes table.

    OBJ_STAGEDVOLUMEID
    An ID value that maps to the RMVolume that is VideoCharger(TM).

    OBJ_PATH
    An ID value that maps to the RMStrings table. Used as the first part of the path to an object.

    OBJ_STATUS
    A character that denotes the objects status. The objects are:

    "A" object
    Resides on a SMS volume.

    "B" object
    Resides on a SMS volume and one on a cache volume (staging or VideoCharger).

    "C" object
    LAN cache pending.

    "D" object
    Ready to be deleted from a SMS volume.

    "G" object
    Staged discarded.

    "L" object
    LAN cached object.

    "P" object
    Delete pending.

    "R" object
    Store pending.

    "S" object
    Resides in staging.

    "U" object
    Has been updated. Update is not complete. Old and new objects exist.

    OBJ_SIZE
    Object size in bytes. Current practical limit is still 2 GB.

    OBJ_CREATEDATE
    TIMESTAMP object created.

    OBJ_UPDATEDATE
    TIMESTAMP object updated.

    OBJ_REFERENCEDDATE
    TIMESTAMP object last referenced.

    OBJ_ACTIONDATE
    Date of the next migrator activity.

    OBJ_MGTCLASSDATE
    Date placed in this mgt class.

    OBJ_STGCLASSDATE
    Date placed in this storage class.

    OBJ_PLAYSTATUS
    Not currently used.

    OBJ_VOLSTATUS
    Not currently used.

    OBJ_OBJECTNAME
    Not currently used.

    OBJ_ORGFILENAME
    Name (if provided by the client) or name of the FTP imported file.

    OBJ_FILENAME
    The file name as stored in the file system. New object names are not randomly generated, but have a format similar to the old name as referenced by LS. LSid.ItemID.Version.possible-name-extension-for-uniqueness.

    OBJ_MIMETYPE
    MIME type provided by the user. Returned to the accessor. No conversions or checking is done at this time.

    RMDEVMGR

    This table holds the device manager information.

    Table 69.

    Column Name Data Type Attribute
    DEV_DEVMGRID SMALLINT NOT null
    DEV_DEVMGRNAME CHAR(32) NOT null
    DEV_ENABLE CHAR NOT null
    DEV_DESCRIPTION VARCHAR(80) NOT null
    DEV_PARAMETERS VARCHAR(254) NOT null
    DEV_CLASS VARCHAR(254) NOT null

    Primary Key
    (DEV_DEVMGRID)

    Indexes
    Unique Index
    IDX_DEV_DEVMGRNAME ON RMDEVMGR  (DEV_DEVMGRNAME ASC);
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    DEV_DEVMGRID
    An ID value to reference this row. The next highest number is always used for inserts.

    DEV_DEVMGRNAME
    A name given to this device manager.

    DEV_ENABLE
    "Y" or "N" for enabled or NOT enabled.

    DEV_DESCRIPTION
    Short description of a device manager.

    DEV_PARAMETERS
    String containing DM specific information (not currently used).

    DEV_CLASS
    The Java class name of the implementing Java class.

    RMSTORAGEGROUP

    This table holds the name of this storage group. See RMStgGrpClass and RMStgGrpVolume.

    Table 70.

    Column Name Data Type Attribute
    STG_STGGROUPID SMALLINT NOT null
    STG_STGGROUPNAME CHAR(32) NOT null

    Primary Key
    (STG_STGGROUPID)

    Indexes
    Unique Index
    IDX_STG_STGGRPNAME ON RMSTORAGEGROUP ( STG_STGGROUPNAME  ASC );
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    STG_STGGROUPID
    An ID value to reference this row. The next highest number is always used for inserts.

    STG_STGGROUPNAME
    The user name for this storage group.

    RMMGTCLASS

    This table holds the name of the management class.

    Table 71.

    Column Name Data Type Attribute
    MGC_MGTCLASSID SMALLINT NOT null
    MGC_MGTCLASSNAME CHAR(32) NOT null

    Primary Key
    (MGC_MGTCLASSID)

    Indexes
    Unique Index
    IDX_MGC_MGTCLSNAME ON RMMGTCLASS (MGC_MGTCLASSNAME ASC);
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    MGC_MGTCLASSID
    An ID value to reference this row. The next highest number is always used for inserts.

    MGC_MGTCLASSNAME
    The name of this management class.

    RMCOLLECTIONS

    This table defines a collection. A collection is a storage endpoint for the LS.

    Table 72.

    Column Name Data Type Attribute
    COL_COLLID INTEGER NOT null
    COL_COLLNAME CHAR(44) NOT null
    COL_STGGROUPID SMALLINT NOT null
    COL_MGTCLASSID SMALLINT NOT null

    Primary Key
    (COL_COLLID)

    Indexes
    Unique Index
    IDX_COL_COLLNAME ON RMCOLLECTIONS ( COL_COLLNAME  ASC );
    Index
    None
    

    Referential Constraints
    FOREIGN KEY (COL_STGGROUPID) REFERENCES RMSTORAGEGROUP
      ON DELETE RESTRICT
      ON UPDATE RESTRICT,
     
    FOREIGN KEY (COL_MGTCLASSID) REFERENCES RMMGTCLASS
      ON DELETE RESTRICT
      ON UPDATE RESTRICT
    

    Column Definitions

    COL_COLLID
    An ID value to reference this row. The next highest number is always used for inserts.

    COL_COLLNAME
    A user name for this collection.

    COL_STGGROUPID
    An ID that references the RMStorageGroup table.

    COL_MGTCLASSID
    An ID that references the RMManagementClass Table.

    RMSTORAGECLASS

    This table defines a Storage Class.

    Table 73.

    Column Name Data Type Attribute
    STC_STGCLASSID SMALLINT NOT null
    STC_STGCLASSNAME CHAR(32) NOT null
    STC_ATTRIBUTES INTEGER NOT null
    STC_DEVMGRID SMALLINT NOT null
    STC_OBJECTSERVERID SMALLINT NOT null
    STC_REMOTECOLLNAME VARCHAR(44) NOT null

    Primary Key
    (STC_STGCLASSID)

    Indexes
    Unique Index
    IDX_STC_STGCLSNAME ON RMSTORAGECLASS ( STC_STGCLASSNAME ASC );
    Index
    None
    

    Referential Constraints
    FOREIGN KEY (STC_OBJECTSERVERID) REFERENCES RMSERVER
      ON DELETE RESTRICT
      ON UPDATE RESTRICT
     
    FOREIGN KEY (STC_DEVMGRID) REFERENCES RMDEVMGR
      ON DELETE RESTRICT
      ON UPDATE RESTRICT
    

    Column Definitions

    STC_STGCLASSID
    An ID value to reference this row. The next highest number is always used for inserts.

    STC_STGCLASSNAME
    The user name for this storage class.

    STC_ATTRIBUTES
    1 for Local, 2 for a remote storage class.

    STC_DEVMGRID
    An ID that references the RMDeviceManager table.

    STC_OBJECTSERVERID
    An ID that references the RMServer table.

    STC_REMOTECOLLNAME
    <Needs definition>

    RMSTRINGS

    This table defines strings used as first part of path to documents.

    Table 74.

    Column Name Data Type Attribute
    STR_STRINGID INTEGER NOT null
    STR_USECNT INTEGER NOT null
    STR_STRING VARCHAR(254) NOT null

    Primary Key
    (STR_STRINGID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    STR_STRINGID
    An ID value to reference this row.

    STR_USECNT
    Use count, not used. Should not update/delete if value > 0.

    STR_STRING
    The string itself.

    RMCNTL

    This table holds the customer configuration information.

    Table 75.

    Column Name Data Type Attribute
    CTL_CONFIGID CHAR(16) NOT null
    CTL_CONFIGACTIVE CHAR NOT null
    CTL_DESCRIPTION CHAR(80) NOT null
    CTL_LIBTIMEOUT INTEGER NOT null
    CTL_CLIENTTIMEOUT INTEGER NOT null
    CTL_PURGERTIMEOUT INTEGER NOT null
    CTL_MOUNTTIMEOUT INTEGER NOT null
    CTL_PURGERCYCLE SMALLINT NOT null
    CTL_MIGRATORCYCLE SMALLINT NOT null
    CTL_MIGTHRESHCYCLE SMALLINT NOT null
    CTL_STAGERCYCLE SMALLINT NOT null
    CTL_PURGERBATCHSIZE SMALLINT NOT null
    CTL_STAGEBATCHSIZE SMALLINT NOT null
    CTL_MIGRABATCHSIZE SMALLINT NOT null
    CTL_MIGSTARTMON CHAR(4) NOT null
    CTL_MIGMONMINS SMALLINT NOT null
    CTL_MIGSTARTTUE CHAR(4) NOT null
    CTL_MIGTUESMINS SMALLINT NOT null
    CTL_MIGSTARTWED CHAR(4) NOT null
    CTL_MIGWEDMINS SMALLINT NOT null
    CTL_MIGSTARTTHURS CHAR(4) NOT null
    CTL_MIGTHURSMINS SMALLINT NOT null
    CTL_MIGSTARTFRI CHAR(4) NOT null
    CTL_MIGFRIMINS SMALLINT NOT null
    CTL_MIGSTARTSAT CHAR(4) NOT null
    CTL_MIGSATMINS SMALLINT NOT null
    CTL_MIGSTARTSUN CHAR(4) NOT null
    CTL_MIGSUNMINS SMALLINT NOT null
    CTL_REPLICATECYCLE SMALLINT NOT null
    CTL_REPBATCHSZE SMALLINT NOT null
    CTL_REPSTARTMON CHAR(4) NOT null
    CTL_REPMONMINS SMALLINT NOT null
    CTL_REPSTARTTUE CHAR(4) NOT null
    CTL_REPTUESMINS SMALLINT NOT null
    CTL_REPSTARTWED CHAR(4) NOT null
    CTL_REPWEDMINS SMALLINT NOT null
    CTL_REPSTARTTHURS CHAR(4) NOT null
    CTL_REPTHURSMINS SMALLINT NOT null
    CTL_REPSTARTFRI CHAR(4) NOT null
    CTL_REPFRIMINS SMALLINT NOT null
    CTL_REPSTARTSAT CHAR(4) NOT null
    CTL_REPSATMINS SMALLINT NOT null
    CTL_REPSTARTSUN CHAR(4) NOT null
    CTL_REPSUNMINS SMALLINT NOT null

    Primary Key
    (CTL_CONFIGID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    CTL_CONFIGID
    A unique name provided by the customer.

    CTL_CONFIGACTIVE
    Y or N, and only one row can be marked active.

    CTL_DESCRIPTION
    Space for a short customer description.

    CTL_LIBTIMEOUT
    Internal time out value specified in milliseconds. This value must not be greater than the db2 timeout. Specifies how long to wait for a response from the LS.

    CTL_CLIENTTIMEOUT
    Internal time out value specified in milliseconds. Specifies how long to wait for a response from a client.

    CTL_PURGERTIMEOUT
    Internal time out value specified in milliseconds. Specifies how long to wait for a response from the Purger.

    CTL_MOUNTTIMEOUT
    Internal time out value specified in milliseconds. Not used.

    CTL_PURGERCYCLE
    Minutes that the purger pauses before its next cycle.

    CTL_MIGRATORCYCLE
    Minutes that the migrator pauses before its next cycle.

    CTL_MIGTHRESHCYCLE
    Minutes the migrator pauses before its threshold cycle check.

    CTL_STAGERCYCLE
    Minutes the stager pauses before its next cycle.

    CTL_PURGERBATCHSIZE
    Maximum number of items in a purger batch.

    CTL_STAGEBATCHSIZE
    Maximum number of items in a stager batch.

    CTL_MIGRABATCHSIZE
    Maximum number of items in a migrator batch.

    CTL_MIGSTARTMON
    Start time as 'HHMM'..

    CTL_MIGMONMINS
    Number of minutes to allow for migration max=1440.

    CTL_MIGSTARTTUE
    Start time as 'HHMM'..

    CTL_MIGTUESMINS
    Number of minutes to allow for migration max=1440.

    CTL_MIGSTARTWED
    Start time as 'HHMM'..

    CTL_MIGWEDMINS
    Number of minutes to allow for migration max=1440.

    CTL_MIGSTARTTHURS
    Start time as 'HHMM'..

    CTL_MIGTHURSMINS
    Number of minutes to allow for migration max=1440.

    CTL_MIGSTARTFRI
    Start time as 'HHMM'..

    CTL_MIGFRIMINS
    Number of minutes to allow for migration max=1440.

    CTL_MIGSTARTSAT
    Start time as 'HHMM'..

    CTL_MIGSATMINS
    Number of minutes to allow for migration max=1440.

    CTL_MIGSTARTSUN
    Start time as 'HHMM'..

    CTL_MIGSUNMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPLICATECYCLE
    Value in minutes the stager will pause before its next cycle.

    CTL_REPBATCHSZE
    Maximum number of items in a purger batch.

    CTL_REPSTARTMON
    Start time as 'HHMM'..

    CTL_REPMONMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPSTARTTUE
    Start time as 'HHMM'..

    CTL_REPTUESMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPSTARTWED
    Start time as 'HHMM'..

    CTL_REPWEDMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPSTARTTHURS
    Start time as 'HHMM'..

    CTL_REPTHURSMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPSTARTFRI
    Start time as 'HHMM'..

    CTL_REPFRIMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPSTARTSAT
    Start time as 'HHMM'..

    CTL_REPSATMINS
    Number of minutes to allow for migration max=1440.

    CTL_REPSTARTSUN
    Start time as 'HHMM'.

    CTL_REPSUNMINS
    Number of minutes to allow for migration max=1440.

    RMREPLICATION

    This table holds work records for the replication to be done.

    Table 76.

    Column Name Data Type Attribute
    REP_LIBRARYID SMALLINT NOT null
    REP_ITEMID CHAR(26) NOT null
    REP_VERSION SMALLINT NOT null
    REP_COLLID INTEGER NOT null
    REP_COLLNAME CHAR(26) NOT null
    REP_OBJSERVERID SMALLINT NOT null
    REP_REPLICATETYPE CHAR(1) NOT null
    REP_SIZE BIGINT NOT null
    REP_UPDATEDATE TIMESTAMP NOT null

    Primary Key
    (REP_LIBRARYID,REP_ITEMID,REP_VERSION,REP_COLLID,REP_COLLNAME,REP_OBJSERVERID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    REP_LIBRARYID
    An Identifier that maps to the RMServer table.

    REP_ITEMID
    An ItemID.

    REP_VERSION
    A version number.

    REP_COLLID
    A collection number.

    REP_COLLNAME
    A collection name on REP_OBJSERVERID.

    REP_OBJSERVERID
    An Identifier that maps to the RMServer table. For the target server.

    REP_REPLICATETYPE
    A code used for replication status. codes E, L, R, S, A.

    REP_SIZE
    The objects size in bytes.

    REP_UPDATEDATE
    The update date of this replica. The tuple (REP_LIBRARYID,REP_ITEMID,REP_VERSION,REP_COLLID) describes the object that is the replication source in RMObjects.

    RMSTAGING

    This table holds the definition of the staging area. This table only contains one row.

    Table 77.

    Column Name Data Type Attribute
    STA_ID SMALLINT NOT null
    STA_SIZE BIGINT NOT null
    STA_SPACEUSED BIGINT NOT null
    STA_PERCENTSTART SMALLINT NOT null
    STA_PERCENTSTOP SMALLINT NOT null
    STA_SERVERACTIVE CHAR NOT null
    STA_PATH VARCHAR(1023) NOT null

    Primary Key
    (STA_ID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column Definitions

    STA_ID
    An Identifier, always 0.

    STA_SIZE
    The size of the staging area in bytes.

    STA_SPACEUSED
    The space used by objects in the staging area in bytes.

    STA_PERCENTSTART
    The percent of used space that indicates when the purger should begin removing parts from the staging area.

    STA_PERCENTSTOP
    The percent of used space that indicates when the purger can stop (after clearing sufficient space).

    STA_SERVERACTIVE
    This is set to Y. Its value is no longer used.

    STA_PATH
    The absolute path to be used as the staging area.

    RMVOLUMES

    This table holds volume information on system and virtual volumes.

    Table 78.

    Column Name Data Type Attribute
    VOL_VOLUMEID INTEGER NOT null
    VOL_SERIAL INTEGER NOT null
    VOL_STGCLASSID SMALLINT NOT null
    VOL_ATTRIBUTES SMALLINT NOT null
    VOL_MEDIATYPE SMALLINT NOT null
    VOL_SERVERID SMALLINT NOT null
    VOL_SIZE BIGINT NOT null
    VOL_FREESPACE BIGINT NOT null
    VOL_STATUS CHAR NOT null
    VOL_THRESHOLD SMALLINT NOT null
    VOL_NUMBUCKETS SMALLINT NOT null
    VOL_REFERENCEDDATE DATE NOT null
    VOL_LOGICALNAME CHAR(254) NOT null
    VOL_MOUNTPOINT VARCHAR(1023) NOT null
    VOL_PATH VARCHAR(1023) NOT null
    VOL_OFFLINELOC VARCHAR(128) NOT null

    Primary Key
    (VOL_VOLUMEID)

    Indexes
    Unique Index
    IDX_VOL_VOLSER ON RMVOLUMES ( VOL_LOGICALNAME ASC );
    Index
    None
    

    Referential Constraints
    FOREIGN KEY (VOL_STGCLASSID) REFERENCES RMSTORAGECLASS
      ON DELETE RESTRICT
      ON UPDATE RESTRICT,
     
    FOREIGN KEY (VOL_SERVERID) REFERENCES RMSERVER
      ON DELETE RESTRICT
      ON UPDATE RESTRICT
    

    Column Definitions

    VOL_VOLUMEID
    An ID value used to access this row.

    VOL_SERIAL
    Not used, set to -1.

    VOL_STGCLASSID
    ID value of the storage class assigned this volume.

    VOL_ATTRIBUTES
    Not used default 0.

    VOL_MEDIATYPE
    The media type of this volume Local, TSM, VC or MA.

    VOL_SERVERID
    ID value of the server that owns this volume.

    VOL_SIZE
    The volume size in bytes for local volumes.

    VOL_FREESPACE
    The volume space free for local volumes.

    VOL_STATUS
    The volume status. A, U, O.

    VOL_THRESHOLD
    The threshold percent full. If exceeded, it causes the migrator to migrate objects early to ensure space for incoming stores.

    VOL_NUMBUCKETS
    The number of intended subdirectories for a volume.

    VOL_REFERENCEDDATE
    The last referenced date for this volume.

    VOL_LOGICALNAME
    The System Disk Label (NT), Logical volume name (UNIX), Management Class name (TSM), or user name VC and MA.

    VOL_MOUNTPOINT
    The mount point of the volume.

    VOL_PATH
    The volume path to be used on the volume.

    VOL_OFFLINELOC
    A user specified location, to be used if a volume is taken offline, or put on the shelf.

    RMSTGGRPVOLUME

    This table holds links of storage group to volume.

    Table 79.

    Column Name Data Type Attribute
    SGV_STGGROUPID SMALLINT NOT null
    SGV_VOLUMEID INTEGER NOT null

    Primary Key
    (SGV_STGGROUPID, SGV_VOLUMEID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    FOREIGN KEY (SGV_STGGROUPID) REFERENCES RMSTORAGEGROUP
      ON DELETE RESTRICT
      ON UPDATE RESTRICT,
     
    FOREIGN KEY (SGV_VOLUMEID) REFERENCES RMVOLUMES
      ON DELETE RESTRICT
      ON UPDATE RESTRICT
    

    Column Definitions

    SGV_STGGROUPID
    The ID of a row in the RMSTORAGEGROUP table.

    SGV_VOLUMEID
    The ID of a row in the RMVOLUMES table.

    RMSTGGRPCLASS

    This table holds links of storage group to storage class.

    Table 80.

    Column Name Data Type Attribute
    SGC_STGGROUPID SMALLINT NOT null
    SGC_STGCLASSID SMALLINT NOT null

    Primary key
    (SGC_STGGROUPID, SGC_STGCLASSID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
       FOREIGN KEY (SGC_STGGROUPID) REFERENCES RMSTORAGEGROUP
          ON DELETE RESTRICT
          ON UPDATE RESTRICT,
     
       FOREIGN KEY (SGC_STGCLASSID) REFERENCES RMSTORAGECLASS
          ON DELETE RESTRICT
          ON UPDATE RESTRICT
    

    Column Definitions

    SGC_STGGROUPID
    The ID of a row in the RMSTORAGEGROUP table.

    SGC_STGCLASSID
    The ID of a row in the RMSTORAGECLASS table.

    RMMGTTRANSITION

    This table holds links of storage group to storage class.

    Table 81.

    Column Name Data Type Attribute
    MGP_MGTCLASSID SMALLINT NOT null
    MGP_SEQUENCENUM SMALLINT NOT null
    MGP_STGCLASSID SMALLINT NOT null
    MGP_SINCEENTER INTEGER NOT null

    Primary key
    (MGP_MGTCLASSID, MGP_SEQUENCENUM)

    Indexes
    Unique Index
    IDX_MGP_MGTSTGCLS ON RMMGTTRANSITION ( MGP_MGTCLASSID ASC, MGP_STGCLASSID ASC );
    Index
    None
    

    Referential Constraints
        FOREIGN KEY (MGP_MGTCLASSID) REFERENCES RMMGTCLASS
          ON DELETE RESTRICT
          ON UPDATE RESTRICT,
     
        FOREIGN KEY (MGP_STGCLASSID) REFERENCES RMSTORAGECLASS
          ON DELETE RESTRICT
          ON UPDATE RESTRICT
    

    Column Definitions

    SGC_STGGROUPID
    The ID of a row in the RMSTORAGEGROUP table.

    SGC_STGCLASSID
    The ID of a row in the RMSTORAGECLASS table.

    RMMGTTRANSITION
    Table that defines the management class transitions.

    MGP_MGTCLASSID
    An ID that references a row in the RMMGTCLASS table.

    MGP_SEQUENCENUM
    A sequence number of the defined transition.

    MGP_STGCLASSID
    An ID that references a row in the RMSTORAGECLASS table.

    MGP_SINCEENTER
    Number of days that the object must remain in the storage class before being evaluated by migrator.

    RMTABLES

    This table holds one row for each table in the RM system.

    Table 82.

    Column Name Data Type Attribute
    LastReorgTS TIMESTAMP NOT null
    ReorgIndicator SMALLINT NOT null
    ServerType CHAR(4) NOT null
    TableName VARCHAR(27) NOT null
    IndexName VARCHAR(27) NOT null

    Column Definitions

    LastReorgTS
    Not used, usable by a reorg script.

    ReorgIndicator
    Not used, usable by a reorg script.

    ServerType
    Always LBOS.

    TableName
    Table name.

    IndexName
    Index name to be used for reorg.

    RMSYNCSCHED


    Table 83.

    Column Name Data Type Attribute
    SCH_SYNCSCHEDID INTEGER NOT null
    SCH_SYNCENABLE CHAR NOT null
    SCH_SYNCATTRIBUTES INTEGER NOT null
    SCH_SYNCSHEDYY SMALLINT NOT null
    SCH_SYNCSHEDMM SMALLINT NOT null
    SCH_SYNCSHEDDD SMALLINT NOT null
    SCH_SYNCSTARTTIME CHAR(4) NOT null
    SCH_SYNCSHEDMINUTE SMALLINT NOT null

    Primary key
    ( SCH_SYNCSCHEDID )

    RMSYNCSTATUS


    Table 84.

    Column Name Data Type Attribute
    STS_SYNCSTATUSID INTEGER NOT null
    STS_SYNCATTRIBUTES INTEGER NOT null
    STS_SYNCERRMSG VARCHAR(300) NOT null

    RMSYNCREPORT


    Table 85.

    Column Name Data Type Attribute
    RPT_SYNCREPORTID INTEGER NOT null
    RPT_SYNCATTRIBUTES INTEGER NOT null
    RPT_SYNCTOTALCOUNT INTEGER NOT null
    RPT_SYNCERRORCOUNT INTEGER NOT null
    RPT_SYNCSTARTDATE VARCHAR(35) NOT null
    RPT_SYNCENDDATE VARCHAR(35) NOT null

    Primary key
    ( RPT_SYNCREPORTID )

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    RMSYNCVOL


    Table 86.

    Column Name Data Type Attribute
    SVL_SYNCVOLID SMALLINT NOT null
    SVL_VOLUMEID SMALLINT NOT null

    Primary key
    ( SVL_SYNCVOLID )

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
        FOREIGN KEY (SVL_VOLUMEID) REFERENCES RMVOLUMES
          ON DELETE RESTRICT
          ON UPDATE RESTRICT
    

    RMSYNCVOL


    Table 87.

    Column Name Data Type Attribute
    SPM_SYNCPARMID SMALLINT NOT null
    SPM_SYNCMETHOD INTEGER NOT null
    SPM_SYNCSTARTDATE TIMESTAMP NOT null
    SPM_SYNCENDDATE TIMESTAMP NOT null

    Primary key
    ( SPM_SYNCPARMID )

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    RMPARTS


    Table 88.

    Column Name Data Type Attribute
    PTS_LIBRARYID SMALLINT NOT null
    PTS_ITEMID CHAR(26) NOT null
    PTS_VERSION SMALLINT NOT null WITH DEFAULT 1
    PTS_COLLID INTEGER NOT null WITH DEFAULT 0
    PTS_OBJECTNAME CHAR(128) NOT null
    PTS_SIZE BIGINT NOT null
    PTS_CREATEDATE TIMESTAMP NOT null
    PTS_CHANGEDATE TIMESTAMP NOT null

    Primary key
    (PTS_LIBRARYID,PTS_ITEMID,PTS_VERSION,PTS_COLLID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Primary key
    (BLOB_LIBRARYID,BLOB_ITEMID,BLOB_VERSION,BLOB_COLLID)

    Indexes
    Unique Index
    None
    Index
    None
    

    Referential Constraints
    None.

    Column definitions

    BLOB_LIBRARYID
    An ID that references a row in the RMSERVER table.

    BLOB_ITEMID
    An item ID.

    BLOB_VERSION
    A version number.

    BLOB_COLLID
    An ID that references a row in the RMCOLLECTIONS table.

    BLOB_DATA
    The BLOB (10 M).

    RMTRACKING

    This table holds state information on a transaction.

    Table 89.

    Column Name Data Type Attribute
    TT_LIBRARYID SMALLINT NOT null
    TT_ITEMID CHAR(26) NOT null
    TT_VERSION SMALLINT NOT null WITH DEFAULT 1
    TT_COLLID INTEGER NOT null
    TT_TMP_ITEMID CHAR(26) NOT null
    TT_TMP_VERSION SMALLINT NOT null
    TT_TMP_COLLID INTEGER NOT null
    TT_TXID CHAR(26) NOT null
    TT_TS TIMESTAMP NOT null WITH DEFAULT CURRENT TIMESTAMP
    TT_STATUS CHAR(1) NOT null
    TT_ACTION CHAR(1) NOT null
    TT_LSSTATUS CHAR(1)
    TT_INFO VARCHAR(128)

    Primary key
    (TT_LIBRARYID,TT_ITEMID,TT_VERSION,TT_COLLID)

    Indexes
    Unique Index
    None
    Index
    IDX_TT_TXID ON RMTRACKING ( TT_TXID ASC );
    

    Referential Constraints
    None.

    Column definitions

    TT_LIBRARYID
    An ID that references a row in the RMSERVER table.

    TT_ITEMID
    An item ID.

    TT_VERSION
    A version number.

    TT_COLLID
    An ID that references a row in the RMCOLLECTIONS table.

    TT_TMP_ITEMID
    A temporary ID used to point to an uncommitted object.

    TT_TMP_VERSION
    A temporary version number for an uncommitted object.

    TT_TMP_COLLID
    A temporary collection ID for an uncommitted object.

    TT_TXID
    A transaction ID.

    TT_TS
    A transaction timestamp.

    TT_STATUS
    The status of the transaction as last known.

    TT_ACTION
    An action code for end trans and async recovery.

    TT_LSSTATUS
    A LS status code.

    TT_INFO
    Holds additional information.

    Trademarks

    The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both:

    AIX DB2 IBM
    MVS OS/390 SP
    VideoCharger

    Approach, Domino, Lotus, Lotus 1-2-3, Lotus Notes and SmartSuite are trademarks or registered trademarks of the Lotus Development Corporation in the United States, other countries, or both.

    Intel and Pentium are trademarks or registered trademarks of Intel Corporation in the United States, other countries, or both.

    Microsoft, Windows, and Windows NT are registered trademarks of Microsoft Corporation in the United States, other countries, or both.

    Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

    UNIX is a registered trademark of The Open Group in the United States and other countries.

    Other company, product, and service names may be trademarks or service marks of others.