HCL Marketing Platform system table reference

This section provides details on each of the HCL® Marketing Platform system tables.

The data types shown in the tables are generic types that may be different in your Marketing Platform installation, depending on the database used for the system tables.

USM_USER

Stores information about users.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the user.
NAME VARCHAR2 256 false User's login name.
PASSWORD VARCHAR2 100 true User's password hash.
FIRST_NAME VARCHAR2 128 true User's first name.
LAST_NAME VARCHAR2 128 true User's last name.
TITLE VARCHAR2 128 true Title of the user
DEPARTMENT VARCHAR2 128 true Department of which the user is a member.
ORGANIZATION VARCHAR2 128 true Organization of which the user is a member.
COUNTRY VARCHAR2 128 true Country of the user
EMAIL VARCHAR2 128 true Email address of the user
ADDRESS1 VARCHAR2 128 true First line of the user's address.
ADDRESS2 VARCHAR2 128 true Second line of the user's address.
PHONE1 VARCHAR2 20 true First phone number of the user
PHONE2 VARCHAR2 20 true Second phone number of the user
PHONE3 VARCHAR2 20 true Third phone number of the user
STATUS INT32 true Flag that distinguishes among the states of a user account. Valid values are:
  • 1: Active
  • 2: Disabled
  • 3: Deleted from LDAP
ALT_LOGIN VARCHAR2 256 true UNIX alternate login, used by Campaign to control access to local system resources. It must correspond to a valid user account on the local UNIX machine.
PW_EXPIRATION_DATE DATETIME true Expiration date of the user's password. This works in conjunction with the Validity (in days) configuration property.
PW_EXPIRATION_POLICY INT32 true Unused field.
PW_FAILED_TRIES INT32 true Records the number of consecutive failed login attempts. This works in conjunction with the Maximum failed login attempts allowed property.
PW_RESET INT32 true Field used to force a user to choose a new password. Valid values are:
  • 0: No reset is required
  • 1: Reset is required
PARTITION_ID INT32 true The partition the user belongs to.
SYSTEM_DEFINED INT32 true Flag that distinguishes between the types of users. Valid values are:
  • 0: User-defined users (created by Marketing Platform users)
  • 1: System-defined users (present when Marketing Platform is first installed)
  • 2: Synchronized users (imported from an external system))
CREATE_BY INT64 false Numeric identifier of the user that created this user account.
CREATE_DATE DATETIME false Date on which the user account was created.
UPDATE_DATE DATETIME true Date on which the user was last updated.
COREMETRICS_USER VARCHAR2 256 true Stores the IBM Digital Analytics (formerly Coremetrics) login name associated with the user

USM_ROLE

Stores roles used for Role-Based Access Control (RBAC). Note that not all HCL Marketing Software applications use RBAC.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the role.
NAME VARCHAR2 64 false Name of the role.
DESCRIPTION VARCHAR2 512 true Description of the role.
DISPLAY_NAME VARCHAR2 256 true Display name of the role in the HCL Marketing Software user interface.
TYPE INT32 true Flag that distinguishes among the types of roles. Valid values are:
  • 0: User-defined role
  • 1: Object owner
  • 2: Folder owner
  • 100: Partition
  • 101: Global Policy
  • 102: Policy
  • 103: Group
Both object owner and folder owner are system-defined roles. Note that even when a role is system-defined, an administrator can still specify what privileges are associated with each role. These roles support the folder/object pattern of organizing data that is used by many HCL Marketing applications.
APPLICATION INT32 true Flag that distinguishes among the types of containers in which a role can be defined. Valid values are:
  • 100: Marketing Platform
  • 101: Campaign
  • 102: Marketing Operations
  • 103: eMessage
  • 104: Contact Optimization
  • 105: Interact
  • 107: Leads
  • 108: Reports
  • 110: Distributed Marketing
  • 111: CustomerInsight
  • 112: Digital Analytics for On Premises
PARTITION_ID INT32 true The partition to which the role belongs.
STATE INT32 false State.
NODE_PATH VARCHAR 4000 true Path to the node in the Roles hierarchy (ancestors).
SYSTEM_DEFINED INT32 true Flag that distinguishes between the types of roles. Valid values are:
  • 0: User-defined roles (created by HCL Marketing Software users)
  • 1: System-defined roles (present when Marketing Platform is first installed)
CREATE_BY INT64 false Numeric identifier of the user who created the role.
CREATE_DATE DATETIME false Date on which the role was created.
UPDATE_DATE DATETIME true Date on which the role was last updated.

USM_ROLE_ROLE_MAP

Stores data that supports the roles hierarchy.

Field Type Length Null? Description
ROLE_ID INT64 false ID of the role.
PARENT_ROLE_ID INT64 false ID of the parent role.
CREATE_DATE DATETIME false Date on which the role hierarchy was created.
UPDATE_DATE DATETIME true Date on which the role hierarchy was updated.

USM_USER_ROLE_MAP

Stores the relationship between users and roles. Note that the permissions implied in roles are not specific to the Marketing Platform but apply to all HCL Marketing Software applications that use granular security. Marketing Platform stores assigned permissions, but each application enforces the permissions.

Field Type Length Null? Description
USER_ID INT64 false ID of the user being assigned a role.
ROLE_ID INT64 false ID of the role being assigned to the user.
CREATE_DATE DATETIME false Date on which the assignment was created.
UPDATE_DATE DATETIME true Date on which the assignment was updated.

USM_PERMISSION

Stores permissions.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the permission.
NAME VARCHAR2 322 false Name of the permission.
DESCRIPTION VARCHAR2 512 true Description of the permission.
DISPLAY_NAME VARCHAR2 256 true Display name of the permission in the user interface.
TYPE INT32 false Flag that distinguishes among the types of permissions. Valid values are:
  • 1: Partition-level permission
  • 2: Policy-level permission
APPLICATION INT32 true Flag that distinguishes among the types of containers in which a role can be defined. Valid values are:
  • 100: Marketing Platform
  • 101: Campaign
  • 102: Marketing Operations
  • 103: eMessage
  • 104: Contact Optimization
  • 105: Interact
  • 106: Predictive Insight
  • 107: Leads
  • 108: Reports
  • 110: Distributed Marketing
  • 111: CustomerInsight
  • 112: Digital Analytics for On Premises
PARTITION_ID INT32 true The partition this permission belongs to. Used mostly by dynamic permissions in the reporting feature.
CATEGORY VARCHAR2 256 true Category
PERMISSION_ORDER INT32 true The order of the permissions.
OBJECT_NAME VARCHAR 100 true The object name.
OPERATION_NAME VARCHAR 256 true The operation name.
PERMISSION_MASK INT32 true The permission mask.
OBJECT_INSTANCE_CHECK INT32 false Whether to check for an object instance.
VALID_MEMBER_ROLE_TYPES INT32 true The valid member role types for this permission.
SYSTEM_DEFINED INT32 true Flag that distinguishes between the types of permissions. Valid values are:
  • 0: User-defined roles (created by HCL Marketing Software users)
  • 1: System-defined roles (present when Marketing Platform is first installed)
CREATE_BY INT64 false Numeric identifier of the user who created the role.
CREATE_DATE DATETIME true Date on which the role was created.
UPDATE_DATE DATETIME true Date on which the role was last updated.

USM_ROLE_PERMISSION_MAP

Stores the relationship of permissions to roles.

Field Type Length Null? Description
ROLE_ID INT64 false ID of the role being assigned a permission.
PERMISSION_ID INT64 false ID of permission being assigned to the role.
PERMISSION_STATE INT32 false Permission states.
  • 0: Denied
  • 1: Allowed
  • 2: Inherited
CREATE_DATE DATETIME false Date on which the assignment was created.
UPDATE_DATE DATETIME true Date on which the assignment was last updated.

USM_CONFIGURATION

Stores configuration properties managed through Marketing Platform on the Configuration page.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the configuration element.
ELEMENT_TYPE INT32 false Type of the configuration element. Valid values are:
  1. suite
  2. application
  3. category
  4. section
  5. string_property
  6. numeric_property
  7. time_property
  8. text_property
  9. multivalue_property
  10. checkbox_property
  11. dropdown_property
  12. radio_property
  13. file_property
  14. url_property
  15. integer_property
INTERNAL_NAME VARCHAR2 64 false Internal name of the configuration element.
PARENT_ID INT64 true Identifier of the containing element. This enables the organization of configuration properties into a hierarchy.
CONFIGURATION_ORDER INT32 true Position of this element in the parent.
HIDDEN INT8 false Flag that controls visibility of the configuration element Valid values are:
  • 0: False
  • 1: True
READ_ONLY INT8 false Flag that controls whether the configuration element may be updated. Valid values are:
  • 0: False
  • 1: True
REMOVABLE INT8 false Flag that controls whether the configuration element can be removed. Valid values are:
  • 0: False
  • 1: True
ALLOW_BLANK INT8 false Flag that controls whether the value of the element can be empty. Valid values are:
  • 0: False
  • 1: True
PREFERENCE INT8 false Flag that controls whether the configuration element represents a user preference. Valid values are:
  • 0: False
  • 1: True
TEMPLATE INT8 false Flag that controls whether this configuration element is intended as a template for creating new configuration elements. Valid values are:
  • 0: False
  • 1: True
DISPLAY_NAME_KEY VARCHAR 64 true Key used to look up an internationalized name.
DISPLAY_NAME VARCHAR2 256 true Default display name if an internationalized name cannot be found.
DISPLAY_WIDTH INT32 true Maximum number of characters for display.
DESCRIPTION_KEY VARCHAR 256 true Key used to look up an internationalized description.
DEFAULT_KEY VARCHAR 64 true Key used to look up a localized default value for a string property.
DEFAULT_VALUE FLOAT true Default value for numeric types.
USAGE_NOTE VARCHAR2 256 true Documentation on usage (not localized or displayed).
VALIDATION_CLASS VARCHAR 256 true Optional custom class to be used for validation.
OWNER VARCHAR 64 true Owner of the configuration element.
UPDATE_DATE DATETIME true Date on which the configuration was last updated.
NS_THREAD INT32 false The nested set thread.
NS_LEFT INT32 false The nested set left pointer.
NS_RIGHT INT32 false The nested set right pointer.
VERSION INT32 true The field used for Hibernate optimistic locking.

USM_CONFIGURATION_VALUES

Stores the values of configuration properties managed through Marketing Platform on the Configuration page.

Field Type Length Null? Description
CONFIGURATION_ID INT64 false ID of the containing configuration.
CONFIGURATION_ORDER INT32 false Order of this value in the parent.
ENVIRONMENT_ID INT32 false Identifier that enables different values to be specified for different environments.
USER_ID INT64 false Identifies a user preference override (and the user to which it applies).
PREDEFINED INT8 false Flag that distinguishes between the types of configuration values. Valid values are:
  • 0: User-defined values (created by HCL Marketing Software users)
  • 1: System-defined values (present when Marketing Platform is first installed)
SELECTED INT8 false Flag that determines whether a value is selected. Valid values are:
  • 0: Unselected choice
  • 1: Selected
STRING_VALUE VARCHAR2 1024 true String value, applicable to string value property types.
NUMERIC_VALUE FLOAT true Numeric value, applicable to numeric property types.
DATE_VALUE DATETIME true Date value, applicable to date property types.
VERSION INT32 true The field used for Hibernate optimistic locking.

USM_AUDIT

Stores data about audit events.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier of the audit entry.
EVENT VARCHAR 100 false The audit event.
DESCRIPTION VARCHAR2 1024 true Description of the audit event.
DETAILS VARCHAR2 2000 true Additional details for the audit event.
TYPE INT32 true Type of the audit event.
HOST_NAME VARCHAR2 256 true Name of the host machine used to access the application.
BROWSER VARCHAR2 256 true Details of the browser used to access the application.
REQUEST VARCHAR 4000 true The URL of the request that generated an audit event. For example, a password change can be initiated from the login page the first time a user logs in, or from the user's detail page by clicking the Change Password link).
USER_NAME VARCHAR2 256 true Login name of the user who performed the action.
PARTITION_ID INT64 false Partition identifier for an audit event.
SEVERITY VARCHAR2 50 false Severity of an audit event.
AUDIT_DATE DATETIME true Date the audit event occurred.

USM_AUDIT_BACKUP

Stores audit event data for backups.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier of the audit entry.
EVENT VARCHAR 100 false The audit event.
DESCRIPTION VARCHAR2 1024 true Description of the audit event.
DETAILS VARCHAR2 2000 true Additional details for the audit event.
TYPE INT32 true Type of the audit event.
HOST_NAME VARCHAR2 256 true The name of the machine used to access the application.
BROWSER VARCHAR2 256 true Browser used to access the application.
REQUEST VARCHAR 4000 true The URL of the request that generated an audit event. For example, a password change can be initiated from the login page the first time a user logs in, or from the user's detail page by clicking the Change Password link).
USER_NAME VARCHAR2 256 true Login name of the user who performed the action.
PARTITION_ID INT64 false Partition identifier for an audit event.
SEVERITY VARCHAR2 50 false Severity of an audit event.
AUDIT_DATE DATETIME true Date the audit event occurred.

USM_DB_ACCESS

Stores the data sources accessible to a user of an HCL Marketing Software application, and system-level access to data sources accessible to HCL Marketing Software applications (such as LDAP connectivity information). Note that Marketing Platform does not use this table to store connection information for its own system tables.

Field Type Length Null? Description
USER_ID INT64 false Internal ID of a user.
PARTITION_ID INT64 false The partition from which this data source is accessible.
DATA_SOURCE VARCHAR2 256 false Name of the data source
DB_LOGIN VARCHAR2 256 true User name used to log into the data source.
DB_PASSWORD VARCHAR 255 true Encrypted password used to log into the data source.
CREATE_DATE DATETIME false Date that this data source entry was defined.
UPDATE_DATE DATETIME true Date that this data source entry was last updated.

USM_APPLICATION

Stores the HCL Marketing Software applications registered with Marketing Platform.

Field Type Length Null? Description
APP_ID INT32 false Internal numeric identifier for an HCL Marketing Software application registered with Marketing Platform.
APP_NAME VARCHAR 64 false String identifier for an HCL Marketing Software application registered with the Marketing Platform. If no display name is specified in the DISPLAY_NAME field in this table, it also serves as the display name in the Marketing Platform user interface.
APP_DESC VARCHAR 256 true Description of the application, displayed in the Marketing Platform user interface.
APP_TOKEN VARCHAR 100 true Public string identifier for an HCL Marketing Software application. Used by HCL Marketing Software applications to identify themselves when invoking services through the Marketing Platform API.
DISPLAY_NAME VARCHAR2 256 false Display name for an HCL Marketing Software application in the Marketing Platform user interface. If the display name is not specified here, the APP_NAME field is used in its place.

USM_TOKEN

Stores information that supports single sign-on through the use of short-lived tokens.

Field Type Length Null? Description
TOKEN_ID VARCHAR 128 false Token value
USER_ID INT32 false ID of the user requesting the token.
CREATE_DATE DATETIME false Date on which the token was created.
DEST_APP INT32 false The application to which the user is navigating.

USM_PW_HISTORY

Stores user password history to limit re-use of passwords. The number of passwords stored is based upon the value of the Password history count property.

Field Type Length Null? Description
USER_ID INT32 false ID of the user who recently used this password.
SEQ_NUM INT32 false When this password was used, relative to the other passwords for the user. Higher numbers represent more recently used passwords.
PASSWD VARCHAR 255 true Encrypted password
ARCHIVE_DATE DATETIME false Date and time that the password was last chosen by the user.

USM_DB_RESOURCE_BUNDLE

Stores information about resource bundles.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the resource bundle.
NAME VARCHAR 256 false Resource bundle's name.
LOCALE VARCHAR 16 true Resource bundle's locale.
APPLICATION INT32 true Resource bundle's application ID.
BUNDLE_PROPERTIES CLOB true Resource bundle's properties.

USCH_TASK

Stores the metadata about all the scheduled tasks (event-triggered and time-based).

Field Type Length Null? Description
TASKID INT64 false Internal numeric identifier for the scheduled task.
NAME VARCHAR2 150 false Name the user entered for a scheduled task.
DESCRIPTION VARCHAR2 512 true Description the user entered for a scheduled task.
GROUPID VARCHAR 100 false ID of the throttling group with which the task is associated.
OBJECTTYPE VARCHAR2 256 true The type of the scheduled object.
OBJECTID VARCHAR 256 true The ID of the scheduled object in the client application.
OBJECTNAME VARCHAR2 256 true The name of the scheduled object in the client application.
PRODUCTID VARCHAR 100 true ID of the product to which the scheduled object belongs.
PAYLOAD VARCHAR 4000 true The runtime parameters required by the client application to run the scheduled process.
SCHEDULENAME VARCHAR2 256 true Name of the recurrence pattern.
SCHEDULE VARCHAR 100 true Cron expression string for the recurrence pattern.
SCHEDULESTART DATETIME true Date and time when the recurrence pattern should start.
SCHEDULEEND DATETIME true Date and time beyond which the recurrence pattern should stop.
LISTENINGTRIGGER VARCHAR2 100 true Trigger string for which the task listens to start the task (Used only by event-based tasks).
CREATEDBY INT64 false ID of the user who created the task.
PARTITIONID INT64 false ID of the partition of the user who created the task.
CREATEDTIME DATETIME false Date and time when the task was created.
MODIFIEDBY INT64 false ID of the user who last modified the task.
MODIFIEDTIME DATETIME false Date and time when the task was last modified.
STATUS VARCHAR 100 false Internal status of the schedule. Valid values are:
  • Scheduled
  • Triggered
TIMEZONE VARCHAR2 100 false The time zone of the user who is scheduling a task.
OCCURRENCES INT64 false Occurrences specified by user.
SOURCE VARCHAR2 50 false API versus server created task.
ISHIDDEN VARCHAR2 12 false Specifies whether this task appears or is hidden on the Task list page.
TAG VARCHAR2 256 true User entered tag for a scheduled task.
SCHEDULESTATE INT32 false Specifies whether this task is enabled or disabled.

USCH_TASK_DEPENDANCY

Stores the task ID and its dependant tasks.

Field Type Length Null? Description
TASK_ID INT64 false The task ID, from the Tasks table, for which the dependency is being defined.
DEPENDS_ON_TASK_ID INT64 false The task ID, from the Tasks table, on which the task identified in the TASK_ID field depends.

USCH_TRIGGER

Stores information about the triggers associated with SUCCEEDED or FAILED events for the Scheduler.

Field Type Length Null? Description
TASKID INT64 false ID of the task with which the trigger is associated.
EVENT VARCHAR 100 false Event type of the trigger (SUCCEEDED or FAILED).
TRIGGERSTRING VARCHAR2 100 true Outgoing trigger string used to trigger waiting tasks.

USCH_RUN

Stores information for current and completed Scheduler runs.

Field Type Length Null? Description
RUNID INT64 false Internal ID of the run.
TASKID INT64 false ID of the task to which the run belongs.
STARTDATE DATETIME false Date and time when the run started.
STATUS_CHANGED_DATE DATETIME true Date and time when the last run status was changed.
LASTUPDATE DATETIME true Date and time when the last run status was received from the product to which the scheduled object belongs.
TASKSTATE VARCHAR 100 false One of the following, based on the status received from the client application:
  • QUEUED
  • RUNNING
  • COMPLETED
  • UNKNOWN
  • CANCELED
STATUS VARCHAR2 100 true Status of the process initiated by the task, reported by the product to which the scheduled object belongs. At a minimum, the product must report SUCCEEDED or FAILED. The product could report additional statuses, for informational purposes only.
STATUSDETAIL VARCHAR 4000 true Additional details about the run, reported by the product to which the scheduled object belongs.
PAYLOAD VARCHAR 4000 true The runtime parameters required by the client application to run the scheduled process.

USM_ID_TABLE

Stores information that supports allocation of unique identifiers for classes of object types. For example, when a new user is created, the unique internal ID is generated based on the contents of this table.

Field Type Length Null? Description
TABLE_NAME VARCHAR 32 false Logical name of a table for which unique identifiers are needed.
TABLE_KEY VARCHAR 32 false Logical name of a key field in the table for which unique values are needed. This allows multiple unique key sets to be defined for a single table.
MAX_ID INT32 false Last unique value allocated.

USM_ATTRIBUTE

Stores metadata about attributes.

Field Type Length Null? Description
ID INT64 false The surrogate key.
NAME VARCHAR2 256 false The attribute name.
DATATYPE INT32 false The attribute data type.
CREATE_DATE DATETIME false The date when this attribute was registered.
UPDATE_DATE DATETIME true The date when this attribute was updated.

USM_ALERT_TYPE

Stores notice types for the known applications and for the scheduler.

Field Type Length Null? Description
ID INT64 false The surrogate key.
APP_ID INT32 false The application registering the alert type.
NAME VARCHAR2 256 false The alert type name.
DISPLAY_NAME_KEY VARCHAR 256 true The display name key for the alert type name.
GROUP_DISPLAY_NAME_KEY VARCHAR 256 true The group name.
DEFAULT_SUBSCRIPTION INT32 true The default subscription mask for the alert type.
CREATE_DATE DATETIME false The date when this alert type was registered.
UPDATE_DATE DATETIME true The date when this alert type was updated.

USM_ALERT_TYPE_ATTR

Stores notice type attribute mapping information.

Field Type Length Null? Description
ID INT64 false The surrogate key.
ALERT_TYPE_ID INT64 false The reference to the alert type.
ATTRIBUTE_ID INT64 false The reference to the attribute.
IS_MANDATORY INT8 true Indicates whether the attribute is mandatory.
CREATE_DATE DATETIME false The date when this alert type was registered.
UPDATE_DATE DATETIME true The date when this alert type was updated.

USM_NOTIFICATION_MESSAGE

Stores the locale-specific message content.

Field Type Length Null? Description
ID INT64 false The surrogate key.
SEVERITY INT32 false The message severity.
HEADER VARCHAR2 1000 false The message header for the locale.
BODY VARCHAR2 2000 false The message content for the locale.
HEADER_MARKUP VARCHAR2 1000 true The message header markup for the locale.
BODY_MARKUP VARCHAR2 2000 true The message body markup for the locale.

USM_ALERT

Stores the notification message content, such as message importance and message date and time.

Field Type Length Null? Description
ID INT64 false The surrogate key.
MESSAGE_ID INT64 false the reference to USM_NOTIFICATION_MESSAGE.
CATEGORY_NAME VARCHAR2 128 false Category of the alert message, used in routing.
ALERT_TYPE_ID INT64 true References the alert type for this alert.
IMPORTANCE INT32 true The importance of the alert being delivered.
APP_ID INT32 true The application that generated this alert.
NOTE VARCHAR2 512 true Internal note for tracking updates or the source event, determined by the product that issues the alert. The note should also be useful for support purposes.
SEND_DATE DATETIME false The date and time when the message was sent.
ON_BEHALF INT64 true The ID of the user on behalf of whom this alert is being sent. Optional.

USM_USER_SUITE_ALERT

Stores the user-specific notice details.

Field Type Length Null? Description
USER_ID INT64 false The ID of the user who may be one of many recipients for an alert.
ALERT_ID INT64 false Reference to the USM_ALERT record.
IS_READ INT32 true A flag that indicates whether the message has been read from the HCL Marketing Software inbox.

USM_USER_EMAIL_ALERT

Stores information about the delivery of notifications through the email channel, such as pending emails and the number of retries.

Field Type Length Null? Description
USER_ID INT64 false The ID of a user who may be one of many recipients for an alert message.
ALERT_ID INT64 false Reference to the USM_ALERT record.
STATUS INT32 true A flag that indicates whether the message has been delivered.
NUM_RETRY INT32 true The number of retries attempted for delivery.
UPDATE_DATE DATETIME true The date and time when the message delivery was last retried.
DELIVERY_INFO VARCHAR2 512 true The information message about message delivery.

USM_ALERT_SUBSCRIPTION

Stores information about user alert subscriptions.

Field Type Length Null? Description
ID INT64 false The surrogate key.
USER_ID INT64 false Identifier for the user.
ALERT_TYPE_ID INT64 false The alert type for which subscription is being stored.
SUBSCRIBED_CHANNEL INT32 true Identifies the channel through which the alert is sent.
CREATE_BY INT64 false Numeric identifier of the user who set the subscriptions. This can be either the owner of the user account or an admin user.
CREATE_DATE DATETIME false Date on which the subscription was created.
UPDATE_BY INT64 true Numeric identifier of the user who updated the subscription. This can be either the owner of the user account or an admin user.
UPDATE_DATE DATETIME true Date on which the subscription was last updated.

USM_NOTICE

Stores the alerts to be displayed either immediately to all logged-in users, or to users when they log in.

Field Type Length Null? Description
ID INT64 false Surrogate key.
DESCRIPTION VARCHAR2 512 true Internal note for administrative tracking only.
EXPIRY_DATE DATETIME true The date and time when the alert expires.
IS_ACTIVE INT32 true A flag that indicates whether the alert is still active.
APP_ID INT32 true The application that issued the system alert.
APP_TOKEN VARCHAR 256 true Keeps track of a token that the issuing product uses for lookup when checking for updates.
SHOW_ON INT32 false A flag that indicates whether the alert is shown only when a user logs in, or to logged-in users as well.
CREATE_BY INT64 true Numeric identifier of the user who created the alert.
CREATE_DATE DATETIME false Date on which the alert was created
UPDATE_BY INT64 true Numeric identifier of the user who updated the alert.
UPDATE_DATE DATETIME true Date on which the alert was last updated.

USM_NOTICE_MESSAGE_MAP

Stores the mapping information for the system alerts to messages.

Field Type Length Null? Description
NOTICE_ID INT64 false The ID of the system alert.
LOCALE VARCHAR2 20 false The locale for the referenced message.
MESSAGE_ID INT64 false A reference to the message in USM_NOTIIFICATION_MESSAGE table.

USM_NOTICE_TARGET

Stores the type and ID of the alert recipients.

Field Type Length Null? Description
NOTICE_ID INT64 false A reference to the system alert (a record in the USM_NOTICE table).
TGT_ACCESS_CLASS INT32 false This can be one of the following:
  • 1 - partition
  • 2 - application
  • 3 - group
  • 4 - permission
TGT_ACCESS_CLASS_ID INT64 false Identifies the audience for the system alert.

DF_CONFIG

One of several tables for data filtering. Defines data filter configurations. Each data filter configuration establishes a scope for a set of objects sharing a common access criterion.

Field Type Length Null? Description
CONFIG_ID INT64 false Internal numeric identifier for the configuration.
CONFIG_NAME VARCHAR 64 false Name of the configuration.

DF_FIELDCONSTRAINT

One of several tables for data filtering. Defines single-field predicates for all filters.

Field Type Length Null? Description
FILTER_ID INT64 false Identifies the filter to which the field constraint applies.
LOGICAL_FIELD_ID INT64 false Field to which filter criteria are applied.
EXPRESSION VARCHAR 64 false Filter criteria to be applied to the field.

DF_FILTER

One of several tables for data filtering. Defines a set of criteria to which users and groups can be assigned.

Field Type Length Null? Description
FILTER_ID INT64 false Numeric identifier of the filter.
CONFIG_ID INT64 false The data filter configuration to which the filter is associated. Data filter configurations are defined in the DF_CONFIG table.
CONSTRAINT_HASH INT32 false A hash code representation of the filter, used to look up filters quickly.

DF_LOGICAL_FIELD

One of several tables for data filtering. Defines the logical fields used to create data filters. This table maps these logical fields to the physical fields of actual tables.

Field Type Length Null? Description
LOGICAL_FIELD_ID INT64 false Numeric identifier of the logical field.
LOGICAL_NAME VARCHAR 64 false Name of the logical field.
TYPE VARCHAR 64 false Type of the logical field. Valid values are:
  • java.lang.String
  • java.lang.Long
  • java.lang.Double
  • java.lang.Boolean
  • java.util.Date

DF_TABLE

One of several tables for data filtering. Identifies physical tables that may be secured by association with a data filter configuration as defined in the DF_CONFIG table

Field Type Length Null? Description
TABLE_ID INT64 false Numeric identifier for the physical table.
TABLE_NAME VARCHAR 64 false Actual name of the database table.

DF_TABLE_FIELD

One of several tables for data filtering. Maps fields in an actual table to the corresponding logical fields.

Field Type Length Null? Description
TABLE_ID INT64 false Table identifier.
LOGICAL_FIELD_ID INT64 false Logical field corresponding to the actual table field.
PHYSICAL_NAME VARCHAR 64 false Name of the actual table field.

DF_AUDIENCE

One of several tables for data filtering. Defines audiences in the sense used by Campaign. Audience is a mechanism for supporting multiple logical sets of data in a single table (that is, de-normalized data).

Field Type Length Null? Description
AUDIENCE_ID INT64 false Numeric identifier for the audience.
AUDIENCE_NAME VARCHAR 64 false Name of the audience.

DF_AUDIENCE_FIELD

One of several tables for data filtering. Identifies the fields of a table that distinguish between audiences contained in the table. This concept is not currently used by data filtering, but was added for consistency with Campaign catalogs.

Field Type Length Null? Description
AUDIENCE_ID INT64 false Audience for which distinguishing fields are being identified.
LOGICAL_FIELD_ID INT64 false One of the logical fields that identify records belonging to this audience.
FIELD_ORDER INT32 false Orders the set of fields used to identify records belonging to this audience. This is present for consistency with Campaign catalogs.

DF_AUDIENCE_TABLE

One of several tables for data filtering. Associates a set of data filters with a particular audience-table pair. Note that a set of data filters is identified by a data filter configuration as defined in the DF_CONFIG table.

Field Type Length Null? Description
AUDIENCE_ID INT64 false Audience being associated with the set of data filters.
TABLE_ID INT64 false Table being associated with the set of data filters.
CONFIG_ID INT64 false The set of data filters being associated with the audience-table pair.

OLS_ASSIGNMENT

Associates a principal (that is, a user or group) with a particular object identity, in a particular namespace. This table has a broader application than data filtering. Data filtering uses it as follows.
  • NAMESPACE_ID corresponds to a particular data filter configuration as defined in the DF_CONFIG table (that is, a set of data filters).
  • DATAOBJECT_ID corresponds to a particular data filter with the configuration.
Field Type Length Null? Description
NAMESPACE_ID INT64 false Identifies a set of objects in which the DATAOBJECT_ID field applies.
DATAOBJECT_ID INT64 false Object to which the assignment is being made.
PRINCIPAL_ID INT64 false User or group being assigned to the object.
PRINCIPAL_TYPE INT32 false Flag that distinguishes between the types of principals. Valid values are:
  • 1 - User
  • 2 - Group

OLS_DATAOBJECT

Stores objects to which user and group assignments can be made. Note the following:
  • Only the identifier for the object is represented in this table - not the object state.
  • The identifier must be unique within the namespace (that is, the primary key is a composite of NAMESPACE_ID and DATAOBJECT_ID).
  • In the context of data filtering, NAMESPACE_ID corresponds to a CONFIG_ID in the DF_CONFIG table and DATAOBJECT_ID corresponds to FILTER_ID in the DF_FILTER table.
Field Type Length Null? Description
DATAOBJECT_ID INT64 false Unique identifier for the object (within the namespace).
NAMESPACE_ID INT64 false Represents a scope within which the set of objects have unique identifiers.
DATAOBJECT_TAG VARCHAR 128 false Optional string that can be associated with the object ID for application-specific purposes.

OLS_NAMESPACE

Stores namespaces, each of which represents a set of objects. The set of object IDs within a namespace must be unique.

Field Type Length Null? Description
NAMESPACE_ID INT64 false Numeric identifier for the namespace.
NAMESPACE_NAME VARCHAR 64 false Name of the namespace.

UAR_COMMON_SQL

Stores SQL fragments used by the reporting feature's schema generator to build reporting schemas.

Field Type Length Null? Description
SQL_NAME VARCHAR 99 false Internal name for the SQL fragment.
PRODUCT_CODE VARCHAR 256 false Code of the product the SQL fragment is for.
SELECT_CLAUSE VARCHAR 2048 true The SELECT part of the SQL statement.
FROM_CLAUSE VARCHAR 4000 true The FROM part of the SQL statement.
GROUP_BY_CLAUSE VARCHAR 1024 true The GROUP BY part of the SQL statement.

USM_ACTIVE_PORTLET

Stores information about dashboard pre-defined portlets.

Field Type Length Null? Description
APP_ID INT32 false ID of the application from which the pre-defined portlet is derived.
PORTLET_ID VARCHAR 60 false Internal numeric identifier for the pre-defined portlet.
PARTITION_ID INT32 false The partition to which the portlet belongs.
IS_ENABLED INT32 false Flag that denotes whether the pre-defined portlet is enabled for inclusion in dashboards.

USM_DASHBOARD

Stores dashboard information.

Field Type Length Null? Description
ID INT64 false Surrogate key.
DISPLAY_NAME VARCHAR2 100 true Display name of the dashboard in the HCL Marketing Software user interface.
DESCRIPTION VARCHAR2 512 true Description of the dashboard in the HCL Marketing Software user interface.
STATUS INT32 false Status of the dashboard. Valid values are:
  • Enable
  • Disable
DASHBOARD_TYPE INT32 false A flag that indicates whether a dashboard is public or private.
MAIN_DASHBOARD INT32 false A flag that indicates whether a dashboard is the global dashboard for a partition. There can be only one global dashboard per partition.
PARTITION_ID INT32 true The partition to which the dashboard belongs.
SYSTEM_DEFINED INT32 false A flag that indicates whether a dashboard is system defined. Valid values are:
  • 0 - system defined
  • 1- user defined
ALLOW_USER_LAYOUT INT32 true A flag that indicates whether the user is allowed to modify the dashboard layout.
  • 0 - not allowed
  • 1 - allowed
CREATE_BY INT64 false ID of the user who created the dashboard.
CREATE_DATE DATETIME false Date and time when the dashboard was created.
UPDATE_BY INT64 true ID of the user who updated the dashboard.
UPDATE_DATE DATETIME true Date and time when the dashboard was updated.

USM_DASHBOARD_PORTLET

Stores attributes of dashboard portlets.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the portlet.
DISPLAY_NAME VARCHAR2 100 true Display name of the portlet in the HCL Marketing Software user interface.
DESCRIPTION VARCHAR2 512 true Description of the portlet in the HCL Marketing Software user interface.
ACTIVE_SYSTEM_PORTLET_REF VARCHAR2 1000 true A reference to the PORTLET_ID of the USM_ACTIVE_PORTLET table.
PORTLET_TYPE INT32 false Type of the portlet. Valid values are:
  • Public
  • Private
SYSTEM_DEFINED INT32 false A flag that indicates whether a portlet is system defined or user created. Valid values are:
  • System defined
  • User defined
STATUS INT32 false Status of the dashboard. Valid values are:
  • 1 - Enabled
  • 0 - Disabled
IFRAME_PORTLET_ID INT64 true ID of the iframe portlet.
PARTITION_ID INT32 true The ID of the partition to which the portlet belongs.
CREATE_BY INT64 false The ID of the user who created the portlet.
CREATE_DATE DATETIME false Date and time when the portlet was created.
UPDATE_BY INT64 true ID of the user who updated the portlet.
UPDATE_DATE DATETIME true Date and time when the portlet was updated.

USM_DASH_PORT_IFRAME_DET

Stores configuration settings for portlets.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the portlet.
SOURCE_URL VARCHAR2 2000 true URL for the portlet.
RELATIVE_PATH_TO_CONTEXT INT32 false This field is not used.
AUTHENTICATE INT32 false This field is not used.
AUTHENTICATION_TYPE INT32 false A flag that indicates whether the portlet URL uses SSL. Valid values are:
  • 0 - does not use SSL
  • 1 - does use SSL
FORM_SUBMIT_METHOD INT32 false The form submit method for the portlet. Valid values are:
  • 0 - GET
  • 1 - POST
USER_NAME VARCHAR2 200 true User name for portlet authentication.
PASSWORD VARCHAR2 1000 true Password for portlet authentication.
HIDDEN_VARIABLES VARCHAR2 2000 true Other hidden variables to be submitted in the portlet URL.
HTML_ATTRIBUTES VARCHAR2 2000 true Other HTML attributes in the portlet URL.
ARCHIEVE INT32 true This field is not used.
ARCHIEVE_NAME VARCHAR2 20 true This field is not used.
ARCHIEVE_DATE DATETIME true This field is not used.
ARCHIEVE_BY INT64 true ID of the user who archived the record.
CREATE_BY INT64 false ID of the user who created the portlet.
CREATE_DATE DATETIME false Date and time when the portlet was created.
UPDATE_BY INT64 true ID of the user who updated the portlet.
UPDATE_DATE DATETIME true Date and time when the portlet was updated.

USM_DASH_PORT_PREF_MAP

Stores details of portlet and dashboard preferences.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the preference.
DASHBOARD_ID INT64 true ID of the dashboard.
PORTLET_ID INT64 true ID of the portlet.
STATUS INT32 false Status of the dashboard. Valid values are:
  • Enable
  • Disable
PORTLET_LAYOUT_DETAILS VARCHAR2 400 true Portlet layout details.
PORTLET_HEIGHT INT64 true Height of the portlet.
PORTLET_WIDTH INT64 true Width of the portlet.
LEFT_POSITION INT64 true Left position of the portlet.
TOP_POSITION INT64 true Top position of the portlet.
PREFERANCE_USER_TYPE INT32 true Role of the user who created the dashboard. Valid values are:
  • 0 - user
  • 1 - administrator
MODIFIED_PORTLET_NAME VARCHAR2 100 true Name of the portlet within the related dashboard.
MODIFIED_DASHBOARD_TITLE VARCHAR2 100 true This field is not used.
PREF_DASH_PORTLET_TYPE INT32 false Flag that indicates whether a preference applies to a portlet or a dashboard. Valid values are:
  • 0 - portlet
  • 1 - dashboard
PREF_DASH_COGNOS_IS_VIEW INT32 true Cognos report portlets can be configured to execute a live report each time the portlet is accessed (isview:false), or a saved view can be displayed if an administrator has enabled this on the Cognos server (isview:true).
CREATE_BY INT64 false The ID of the user who placed the portlet on the dashboard.
CREATE_DATE DATETIME false Date and time when the portlet was added to the dashboard.
UPDATE_BY INT64 true ID of the user who updated the dashboard or portlet.
UPDATE_DATE DATETIME true Date and time when the dashboard or portlet was updated.

USM_DASHBOARD_USER_MAP

Stores user viewing rights to dashboards.

Field Type Length Null? Description
DASHBOARD_ID INT64 false ID of the dashboard.
USER_ID INT64 false ID of the user with view rights for the dashboard.
CREATE_BY INT64 false ID of the user who assigned the user to the dashboard.
CREATE_DATE DATETIME false Date and time when the user was assigned to the dashboard.

USM_DASH_MANAGE_RIGHTS

Stores the permission that allows a user to manage a dashboard.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the user permission.
USER_ID INT64 false ID of the user delegated to administer the dashboard.
PERMISSION_TYPE INT32 false Flag that indicates what the user can manage. Valid values are:
  • 0 - portlet
  • 1 - dashboard
  • 2 - dashboard and portlet
CREATE_BY INT64 true ID of the user who created the dashboard or portlet.
CREATE_DATE DATETIME true Date and time when the dashboard or portlet was created.

USM_DASHBOARD_ADMIN_USER_MAP

Stores the users who are allowed to administer dashboards.

Field Type Length Null? Description
DASHBOARD_ID INT64 false ID of the dashboard.
USER_ID INT64 false ID of the user delegated to administer the dashboard.
CREATE_BY INT64 false ID of the user who delegated the admin rights.
CREATE_DATE DATETIME false Date and time when the dashboard admin rights were delegated.

USM_DASHBOARD_GROUP_MAP

Stores mappings of admin users to dashboards.

Field Type Length Null? Description
DASHBOARD_ID INT64 false Dashboard ID
ROLE_ID INT64 false ID of the role of the group given access to the dashboard.
CREATE_BY INT64 false ID of the user who granted access to the dashboard.
CREATE_DATE DATETIME false Date and time when the access was granted to the dashboard.

USM_PORT_QUICKLINK_PREF

Stores the quick links for a portlet.

Field Type Length Null? Description
ID INT64 false Surrogate key.
PORTLET_ID INT64 false ID of the referenced portlet.
PREFERENCE CLOB false The quick links the user selected for the portlet.
CREATE_BY INT64 true ID of the user who created the portlet.
CREATE_DATE DATETIME true Date and time when the portlet was created.
UPDATE_BY INT64 true ID of the user who updated the portlet.
UPDATE_DATE DATETIME true Date and time when the portlet was updated.

USM_PERSONALIZATION

Stores the personalization data for different object types.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the personalization.
USER_ID INT64 false ID of the user to whom the personalization belongs to
OBJECT_TYPE_ID INT64 true Object type for the personalization
OBJECT_ID INT64 false Object ID for the personalized item
PERSONALIZATION_DATA NCLOB false The data used for the personalization
CREATE_DATE DATETIME true Date and time when the personalization was created.
LAST_MODIFIED_DATE DATETIME true Date and time when the personalization was last modified.

USM_OBJECT_TYPE

Stores object types used for personalization.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the object type.
APP_ID INT32 false ID of the application to which the object type belongs
NAME VARCHAR2 128 false Name of the object type
DESCRIPTION VARCHAR2 256 true Description of the object type
CREATE_DATE DATETIME true Date on which the object type was created.
LAST_MODIFIED_DATE DATETIME true Date and time when the object type was last modified.

USM_OBJECT_ATTR

Stores attributes for object types.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the object type.
OBJECT_TYPE_ID INT64 false Object type the attribute belongs to
ATTRIBUTE_NAME VARCHAR2 128 false Name of the attribute
ATTRIBUTE_DATA_TYPE VARCHAR2 128 false Data type for the attribute
IS_MANDATORY INT8 true Indicates whether the attribute is mandatory.
DEFAULT_VALUE VARCHAR2 128 false Default value for the attribute
CREATE_DATE DATETIME true Date on which the object type was created.
LAST_MODIFIED_DATE DATETIME true Date and time when the object type was last modified.

USCH_TASK_NOTIFICATION

Stores notifications for the Scheduler.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the notification.
TASK_ID INT64 false The schedule task ID that this notification is created for.
USER_ID INT64 false The user who creates the notification.
TITLE VARCHAR2 128 false The title of the task notification.
CONDITION VARCHAR2 24 true The condition that should be monitored for to send notifications.
NO_OF_HOURS INT8 true The number of hours after which the notification should be sent.
STATUS VARCHAR2 16 false Whether the notification is active or inactive.
PROCESSING VARCHAR2 16 false Used internally for multi threading.
DELIVERY VARCHAR2 16 false The delivery channel for the notification.
CREATE_DATE DATETIME true Date on which the notification was created.
LAST_MODIFIED_DATE DATETIME true Date and time when the notification was last modified.

USCH_RUN_NOTIFICATION

Stores Scheduler notifications already sent.

Field Type Length Null? Description
ID INT64 false Internal numeric identifier for the sent notification.
USCH_TASK_NOTIFICATION_ID INT64 false The ID of the notification in the USCH_TASK_NOTIFICATION table.
RUN_ID INT64 false The run ID for which the notification was sent.
SENT_DATE DATETIME true Date and time when the notification was sent.

USCH_RUN_EXCLUSION

Stores the metadata about all the run exclusions.

Field Type Length Null? Description
RUNEXCLUSIONID INT64 False Internal numeric identifier for the run exclusion.
RUNEXCLUSIONNAME VARCHAR2 150 False The Name that the user entered for a run exclusion.
DESCRIPTION VARCHAR2 512 True Description that the user entered for a run exclusion.
STARTDATE DATETIME True Date and time when the run exclusion will come into effect.
ENDDATE DATETIME True Date and time when the run exclusion will stop.
TIMEZONE VARCHAR2 100 False The time zone of the user who is creating a run exclusion.
DATETYPE INT32 False Run exclusion date type.
Valid values:
  • 0-Absolute date type
  • 1-Relative date type
RELATIVEOCCURRENCE VARCHAR2 100 True Relative occurrence value when relative date type is selected.
RELATIVEDAY INT32 True Relative day value when relative date type is selected.
RELATIVEMONTH INT32 True Relative month value when relative date type is selected.
CREATEDBY INT64 False ID of the user who created the run exclusion.
CREATEDTIME DATETIME False Date and time when the run exclusion was created.
MODIFIEDBY INT64 False ID of the user who last modified the run exclusion.
PARTITIONID INT64 False ID of the partition of the user who created the run exclusion.
MODIFIEDTIME DATETIME False Date and time when the run exclusion was last modified.
STATUS INT32 False Status of the run Exclusion.
Valid values are:
  • 1 - Enabled
  • 0 - Disabled
OCCURENCES INT64 TRUE Number occurrences specified by user for relative Run Exclusion Schedule.
SCHEDULE VARCHAR100 100 TRUE Cron expression string for the recurrence pattern defined for Relative Run Exclusion
SCHEDULE_NAME VARCHAR(2)256 256 TRUE Name of the recurrence pattern defined for Relative Run Exclusion
EX_START_TIME VARCHAR10 10 TRUE Relative Run Exclusion Start Time
EX-END_TIME VARCHAR10 10 TRUE Relative Run Exclusion End Time
UI_DATA VARCHAR100 100 TRUE Custom pattern data to be rendered on the UI
EX_START_MODE VARCHAR15 15 TRUE Relative Run Exclusion Schedule start mode. String Value : possible values: 1. now, 2.on a Date and Time
STOP_TYPE INT32 TRUE 1. stop by a date and Time 0. occurrences

USCH_TASK_RUNEXCLUSION

Stores the Run exclusion ID and task ID.

Field Type Length Null? Description
RUNEXCLUSION_ID INT64 false The run exclusion ID from the USCH_RUN_EXCLUSION table.
TASK_ID INT64 false The task ID from the Tasks table on which the run exclusion is applied.