The page documents the TO-BE data model. The model of the current release does not necessarily match this one as long as the first major release is under development.
Overview
Description of the tables and fields
Common
TASKANA_SCHEMA_VERSION
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | |
| VERSION | VARCHAR(255) | The version of the TASKANA schema | 0.0.1 |
CONFIGURATION
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ENFORCE_SECURITY | BOOLEAN | Flag to determine if security is enforced for TASKANA | true |
TaskService
TASK
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | |
| EXTERNAL_ID | VARCHAR( | Id to correlate the task to a task in an external system. | |
| CREATED | TIMESTAMP | The creation timestamp of the task in the system. | "2017-12-01 13:39:20" |
| CLAIMED | TIMESTAMP | The timestamp of the last claim-operation on the task | |
| COMPLETED | TIMESTAMP | The timestamp of the completion of the task | |
| MODIFIED | TIMESTAMP | Timestamp of the last modification of the task | |
| PLANNED | TIMESTAMP | Planned start of the task. The actual completion of the task should be between PLANNED and DUE. | |
| DUE | TIMESTAMP | Timestamp when the task is due. The actual completion of the task should be between PLANNED and DUE. | |
| NAME | VARCHAR(255) | The name of the task | "Inspect application" |
| CREATOR | VARCHAR(32) | ||
| DESCRIPTION | VARCHAR(1024) | The description of the task | |
| NOTE | VARCHAR(4096) | ||
| PRIORITY | INT | The priority of the task | |
| STATE | VARCHAR(20) | The state of the task. See (...) | |
| CLASSIFICATION_CATEGORY | VARCHAR(32) | The category of the classification of the task | |
| CLASSIFICATION_KEY | VARCHAR(32) | The classified type of the task. Reference the classifications in the ClassificationService. | "Approval" |
| CLASSIFICATION_ID | VARCHAR(40) | The id of the classification of the task | |
| WORKBASKET_ID | VARCHAR(40) | The id of the workbasket the task is attached to | |
| WORKBASKET_KEY | VARCHAR(32) | The workbasket key of the workbasket, the tasks resides in. | "CLAIM_INBOUND" |
| DOMAIN | VARCHAR(32) | The current domain of the task (derived from the workbasket) | "DOMAIN_A" |
| BUSINESS_PROCESS_ID | VARCHAR(128) | The id of the business process the task belongs to | |
| PARENT_BUSINESS_PROCESS_ID | VARCHAR(128) | The id of the parent business process the task belongs to | |
| OWNER | VARCHAR(32) | The owner of the tasks. The owner is set upon claiming of the task. | |
| POR_COMPANY | VARCHAR(32) | The company referenced primary object belongs to. | "ABC" |
| POR_SYSTEM | VARCHAR(32) | The (kind of) system, the object resides in (e.g. SAP, MySystem A, ...) | "ERP" |
| POR_INSTANCE | VARCHAR(32) | The instance of the system, the object resides in. | "33" |
| POR_TYPE | VARCHAR(32) | The type of the reference (contract, claim, policy, customer, ...) | "VNR" |
| POR_VALUE | VARCHAR(128) | The value of the primary object reference | "1234567" |
| IS_READ | BOOLEAN | Indicator if the task has been read | |
| IS_TRANSFERRED | BOOLEAN | Indicator if the task has been transferred | |
| CALLBACK_INFO | CLOB | Callback information for usage with an adapter | |
| CALLBACK_STATE | VARCHAR(30) | Signals an adapter if a callback to an external system is necessary | |
| CUSTOM_ATTRIBUTES | CLOB | A container for all additional information on the task in JSON representation | |
| CUSTOM_1 | VARCHAR(255) | A custom property with name "1" | |
| CUSTOM_2 | VARCHAR(255) | A custom property with name "2" | |
| CUSTOM_3 | VARCHAR(255) | A custom property with name "3" | |
| CUSTOM_4 | VARCHAR(255) | A custom property with name "4" | |
| CUSTOM_5 | VARCHAR(255) | A custom property with name "5" | |
| CUSTOM_6 | VARCHAR(255) | A custom property with name "6" | |
| CUSTOM_7 | VARCHAR(255) | A custom property with name "7" | |
| CUSTOM_8 | VARCHAR(255) | A custom property with name "8" | |
| CUSTOM_9 | VARCHAR(255) | A custom property with name "9" | |
| CUSTOM_10 | VARCHAR(255) | A custom property with name "10" | |
| CUSTOM_11 | VARCHAR(255) | A custom property with name "11" | |
| CUSTOM_12 | VARCHAR(255) | A custom property with name "12" | |
| CUSTOM_13 | VARCHAR(255) | A custom property with name "13" | |
| CUSTOM_14 | VARCHAR(255) | A custom property with name "14" | |
| CUSTOM_15 | VARCHAR(255) | A custom property with name "15" | |
| CUSTOM_106 | VARCHAR(255) | A custom property with name "16" |
OBJECT_REFERENCE
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | |
| COMPANY | VARCHAR(32) | The name of the company the referenced business object belongs to | "ABC" |
| SYSTEM | VARCHAR(32) | The name of the system containing the object | "XYZ_CLAIM_SYSTEM" |
| SYSTEM_INSTANCE | VARCHAR(32) | The instance of the system (to distinguish between multiple installations of the same system | "33" |
| TYPE | VARCHAR(32) | The type of the referenced business object | "CLAIM" |
| VALUE | VARCHAR(128) | The id of the referenced business object | "1234567" |
ATTACHMENT
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | |
| TASK_ID | CHAR(40) | The task the attachment belongs to | |
| CREATED | TIMESTAMP | ||
| MODIFIED | TIMESTAMP | ||
| CLASSIFICATION_KEY | VARCHAR(32) | The classification of the attachment (if applicable) | |
| REF_COMPANY | VARCHAR(32) | The company referenced object belongs to. | |
| REF_SYSTEM | VARCHAR(32) | The (kind of) system, the object resides in (e.g. DMS, Archive, ...) | |
| REF_INSTANCE | VARCHAR(32) | The instance of the system, the object resides in. | |
| REF_TYPE | VARCHAR(32) | The type of the reference (Archived Document, ...) | |
| REF_VALUE | VARCHAR(128) | The value of the primary object reference | |
| CHANNEL | VARCHAR(64) | The channel through which the attachment has been received | |
| RECEIVED | TIMESTAMP | The timestamp on which the attachment has been received. This must not match the creation timestamp if for example a physical document is received on Friday but entered in the system on Monday. | |
| CUSTOM_ATTRIBUTES | CLOB | A container for all additional information on the attachment in JSON representation |
TaskCommentService
TASK_COMMENT
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | VARCHAR(40) | Unique ID | "TCI:000000000000000000000000000000000000" |
| TASK_ID | VARCHAR(40) | The task the task comment belongs to | "TKI:000000000000000000000000000000000000" |
| TEXTFIELD | VARCHAR(1024) | The actual comment | "This task is nice" |
| CREATOR | VARCHAR(32) | The creator of the task comment | "John Doe" |
| CREATED | TIMESTAMP | The creation timestamp of the task comment in the system. | "2020-12-01 13:39:20" |
| MODIFIED | TIMESTAMP | Timestamp of the last modification of the task comment | "2020-15-01 15:24:20" |
WorkbasketService
WORKBASKET
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | |
| CREATED | TIMESTAMP | The creation timestamp of the workbasket in the system. | "2017-12-01 13:39:20" |
| MODIFIED | TIMESTAMP | Timestamp of the last modification of the workbasket | |
| NAME | VARCHAR(255) | The name of the workbasket | |
| DESCRIPTION | VARCHAR(255) | The description of the workbasket | |
| OWNER | VARCHAR(32) | The owner of the workbasket. The owner is responsible for the on-time completion of all tasks in the workbasket. | |
| CUSTOM_ATTRIBUTES | BLOB | A container for all additional information on the task | |
| ORG_LEVEL_1 | VARCHAR(255) | The first Org Level (the top one) The Org Level is an association with an org hierarchie level in the organization. The values are used for monitoring and statistical purposes and should reflect the responsibility of the tasks in the workbasket. | |
| ORG_LEVEL_2 | VARCHAR(255) | The second Org Level | |
| ORG_LEVEL_3 | VARCHAR(255) | The third Org Level | |
| ORG_LEVEL_4 | VARCHAR(255) | The fourth Org Level (the lowest one). | |
| CUSTOM_1 | VARCHAR(255) | A custom property with name "1" | |
| CUSTOM_2 | VARCHAR(255) | A custom property with name "2" | |
| CUSTOM_3 | VARCHAR(255) | A custom property with name "3" | |
| CUSTOM_4 | VARCHAR(255) | A custom property with name "4" |
WORKBASKET_ACCESS_LIST
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | |
| WORKBASKET_ID | CHAR(40) | The workbasket | |
| ACCESS_ID | VARCHAR(255) | The access id, this ACL entry refers to. This could be either a userid or a full qualified group id (both lower case) | v12345, abcdefgh |
| PERM_READ | BOOLEAN | The permission to read the information about the workbasket | |
| PERM_OPEN | BOOLEAN | The permission to view the content (the tasks) of a workbasket | |
| PERM_APPEND | BOOLEAN | The permission to add tasks to the workbasket (required for creation and tranferring of tasks) | |
| PERM_TRANSFER | BOOLEAN | The permission to transfer tasks (out of the current workbasket) | |
| PERM_DISTRIBUTE | BOOLEAN | The permission to distribute tasks from the workbasket | |
| PERM_CUSTOM_1 | BOOLEAN | ||
| PERM_CUSTOM_2 | BOOLEAN | ||
| PERM_CUSTOM_3 | BOOLEAN | ||
| PERM_CUSTOM_4 | BOOLEAN | ||
| PERM_CUSTOM_5 | BOOLEAN | ||
| PERM_CUSTOM_6 | BOOLEAN | ||
| PERM_CUSTOM_7 | BOOLEAN | ||
| PERM_CUSTOM_8 | BOOLEAN |
DISTRIBUTION_TARGETS
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| SOURCE_ID | CHAR(40) | The workbasket ID of the workbasket which serves as source for the distribution | |
| TARGET_ID | CHAR(40) | The workbasket ID of the workbasket which serves as target for the distribution |
ClassificationService
CLASSIFICATION
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | CHAR(40) | Unique ID | CLI:000000000000000000000000000000000001 |
| KEY | VARCHAR(32) | The key of the classification. This is typically an externally known code or abbreviation of the classification | SD110 |
| PARENT_ID | VARCHAR(40) | The id of the parent classification. Empty string ("") if this is a root classification. | CLI:000000000000000000000000000000000001 |
| PARENT_KEY | VARCHAR(32) | The key of the parent classification. Empty string ("") if this is a root classification. | SD110 |
| CATEGORY | VARCHAR(32) | The category of the classification (MANUAL, EXTERNAL, AUTOMATIC, PROCESS) | MANUAL |
| TYPE | VARCHAR(32) | The type of classification (TASK, DOCUMENT) | DOCUMENT |
| DOMAIN | VARCHAR(255) | The domain for which this classification is specified. | |
| VALID_IN_DOMAIN | BOOLEAN | True, if this classification to objects in this domain. | |
| CREATED | TIMESTAMP | The creation timestamp of the workbasket in the system. | "2017-12-01 13:39:20" |
| NAME | VARCHAR(255) | The name of the classification | |
| DESCRIPTION | VARCHAR(255) | The description of the classification | |
| PRIORITY | INT | The priority of the classification | 5 |
| SERVICE_LEVEL | VARCHAR(32) | The service level of the classification. This is stated according to ISO 8601 | P5D |
| APPLICATION_ENTRY_POINT | VARCHAR(255) | The logical name of the entry point, the task list application should redirect to work on a atsk of this classification. | portal::customerDetails |
| CUSTOM_1 | VARCHAR(255) | A custom property with name "1" | |
| CUSTOM_2 | VARCHAR(255) | A custom property with name "2" | |
| CUSTOM_3 | VARCHAR(255) | A custom property with name "3" | |
| CUSTOM_4 | VARCHAR(255) | A custom property with name "4" | |
| CUSTOM_5 | VARCHAR(255) | A custom property with name "5" | |
| CUSTOM_6 | VARCHAR(255) | A custom property with name "6" | |
| CUSTOM_7 | VARCHAR(255) | A custom property with name "7" | |
| CUSTOM_8 | VARCHAR(255) | A custom property with name "8" |
HistoryService
HISTORY_EVENTS
| COLUMN | TYPE | DESCRIPTION | EXAMPLE VALUE |
|---|---|---|---|
| ID | LONG | Unique ID | 12345 |
| BUSINESS_PROCESS_ID | VARCHAR(128) | ||
| PARENT_BUSINESS_PROCESS_ID | VARCHAR(128) | ||
| TASK_ID | CHAR(40) | ||
| EVENT_TYPE | VARCHAR(32) | ||
| CREATED | TIMESTAMP | The timestamp of the event. | "2017-12-01 13:39:20" |
| USERID | VARCHAR(32) | The userid of the user who triggered this event. | X223344 |
| DOMAIN | VARCHAR(32) | The domain for which this classification is specified. | |
| WORKBASKET_KEY | VARCHAR(64) | The workbasket key of the workbasket, the tasks resides in. | "CLAIM_INBOUND" |
| POR_COMPANY | VARCHAR(32) | The company referenced primary object belongs to. | "ABC" |
| POR_SYSTEM | VARCHAR(32) | The (kind of) system, the object resides in (e.g. SAP, MySystem A, ...) | "ERP" |
| POR_INSTANCE | VARCHAR(32) | The instance of the system, the object resides in. | "33" |
| POR_TYPE | VARCHAR(32) | The type of the reference (contract, claim, policy, customer, ...) | "VNR" |
| POR_VALUE | VARCHAR(128) | The value of the primary object reference | "1234567" |
| TASK_CLASSIFICATION_KEY | VARCHAR(32) | True, if this classification to objects in this domain. | |
| TASK_CLASSIFICATION_CATEGORY | VARCHAR(32) | The category of the task classification | EXTERNAL |
| ATTACHMENT_CLASSIFICATION_KEY | VARCHAR(32) | The creation timestamp of the workbasket in the system. | |
| COMMENT | VARCHAR(4096) | Individual comment on this event | 5 |
| OLD_VALUE | VARCHAR(255) | The old value before the event occured. | X123456 |
| NEW_VALUE | VARCHAR(255) | The new (changed) value after the event occured. | X654321 |
| CUSTOM_1 | VARCHAR(128) | For individual usage | 123 |
| CUSTOM_2 | VARCHAR(128) | For individual usage | new |
| CUSTOM_3 | VARCHAR(128) | For individual usage | "2017-12-01 13:39:20" |
| CUSTOM_4 | VARCHAR(128) | For individual usage | CLAIMS |
| OLD_DATA | VARCHAR(4096) | For custom usage | |
| NEW_DATA | VARCHAR(4096) | For custom usage |