Database Reference

This section contains reference information on the K2 database. The K2 database is updated and maintained by the K2 Setup Manager.

  • Do not modify any database definition or database content unless specifically instructed to do so by K2. No changes to the K2 Database definition or content are supported unless specifically instructed by K2.
  • Direct read access or modification of the data in the K2 database is also not supported, unless specifically instructed by K2, except for the ServerLog schema where direct read access is supported.
  • Any modification of the K2 database or content may result in system instability or failure, therefore it is highly recommended to make backups of the K2 database prior to performing any modification, even when instructed to do so by K2.
  • This database schema reference is provided for informational purposes only. Note that database schemas may change between product versions, so if you have written custom queries against the K2 database, those queries may break between product versions.
  • Do not modify the 'k2_schema_owner' SQL account. For more information see Database modification: 'k2_schema_owner' SQL account.

The table below lists the various Databases or Schemas that make up the K2 data stores. Note that not all Databases or Schemas may be available, depending on your installed version of K2 and which K2 components have been installed. As of K2 4.7 a consolidated database is required. The schema below was generated with a consolidated database. If your K2 databases have been consolidated or only a single database has been installed, the schemas will reside in a database called by default "K2".

Schema Description and purpose
Authorization  
Category Used by the Category hosted server, which allows K2 objects to be managed and categorized.
CustomUM  
dbo While dbo is not a K2-specific Schema, note that SmartBox-based SmartObjects will store their data in tables residing in the dbo namespace. By default the table names match the system name of the SmartObject.
Dependency Used by the Dependency hosted service, which allows a K2 objects to register its dependencies on other objects. Also allows the server to discover an object's dependencies, such as a process that has a dependency on another process or SmartObject.
Designer Used by the web-based Workflow Design tool
Environment Used for managing and storing information in the Environment Library, such as templates and configured environments.
EnvironmentServices Used to store and retrieve environment data
EventBus Stores information about the Event Bus and configured notifications.
  Stores information about Event Bus Scheduler, which provides a mechanism to raise events to the Event Bus using a recurrent pattern.
Form Stores information used by K2 smartforms.
This Schema may not be available if you do not have SmartForms installed.
HostServer Stores information about the Host Server, which provides services and a common framework for each hosted server and service.
Identity Used by the Identity Management services to maintain and store identity data
MessageBus Used by the MessageBus component to manage and store MessageBus tasks
PackageDeploy Used by the K2 Package and Deployment tooling
Relationship Used in conjunction with the Dependency service
Server Stores information about processes including rights, instances, destinations, actions, active processes and other data.
ServerLog Stores logging and reporting data from the K2Server database.
SQLUM Stores information for the SQL user provider.
SmartBox Stores information and data for SmartBox-only SmartObjects. These are SmartObjects that do not connect to other line of business data sources but instead store data in the K2 database.
SmartBroker Stores information about SmartObjects that use Service Objects to retrieve and update data from line of business systems.
Utility Supports K2 internal functions and exposes certain utility stored procedures such as database maintenance stored procedures.
  Stores information about the K2 Designer for SharePoint 2007.
  Stores information about the K2 Web Workflow designer.
Workspace Stores information about the Workspace Web site.
(not applicable) This database is only available when K2 connect is installed and is used by K2 connect exclusively. This database is not included in the consolidated database collection and will exist as a separate database.