Skip to main content

Get help for ARIS Process Mining functions and services

SourceTableDefinition

Example 235.

Only in list form, either standalone as presented here or as part of a data ingestion cycle (DataIngestionCycle) (see below). Properties can be mandatory or optional, depending on if a table should be created or replaced.



[
{
"key": "prq_some_namespace_e",
"name": "example_table_o",
"namespace": "some_namespace",
"fullyQualifiedName": "some_namespace.example_table_o",
"persistenceMode": "OVERWRITE|APPEND",
"mergeKey": ["PROCESSOR_GROUP", "PROCESSOR"],
"columns": [
{
"dataType": "DOUBLE",
"name": "CATEGORY"
},
{
"dataType": "STRING",
"name": "CATEGORY_NAME"
},
{
"dataType": "FORMATTED_TIMESTAMP",
"name": "CREATED",
"format": "yyyy/MM/dd HH:mm:ss"
},
{
"dataType": "STRING",
"name": "PROCESSOR"
},
{
"dataType": "STRING",
"name": "PROCESSOR_GROUP"
}
]
}
]
Example 236.

Only in list form, either standalone as presented here or as part of a data ingestion cycle (DataIngestionCycle) (see below).



[
{
"key": "prq_some_namespace_e",
"name": "example_table_o",
"namespace": "some_namespace",
"fullyQualifiedName": "some_namespace.example_table_o",
"persistenceMode": "OVERWRITE",
"mergeKey": ["PROCESSOR_GROUP", "PROCESSOR"],
"columns": [
{
"dataType": "DOUBLE",
"name": "CATEGORY"
},
{
"dataType": "STRING",
"name": "CATEGORY_NAME"
},
{
"dataType": "FORMATTED_TIMESTAMP",
"name": "CREATED",
"format": "yyyy/MM/dd HH:mm:ss"
},
{
"dataType": "STRING",
"name": "PROCESSOR"
},
{
"dataType": "STRING",
"name": "PROCESSOR_GROUP"
}
]
}
]

  • Keys will be generated on the server.

  • The fully qualified name (fullyQualifiedName) consists of the name and namespace, separated by '.'.

  • The persistence mode (persistenceMode) can either be OVERWRITE or APPEND. See chapter Persistence mode for more details.

  • Columns can be of type DOUBLE, LONG, STRING, and FORMATTED_TIMESTAMP.

  • The merge key (mergeKey) is optional. The merge key is only required for merging new data with existing data.

Note

When a source table definition is created or updated, an _ARIS_lastChanged column of timestamp type is always automatically added to the uploaded table. The _ARIS_ prefix is reserved for internal use. You must not specify columns whose names begin with _ARIS_, and requests to create tables containing such a column name will fail.

When a source table definition is retrieved from the API, columns whose names begin with _ARIS_ are omitted. If you updated a source table definition using the API (as opposed to replacing it) a subsequent GET will only return the columns configured by that update and omit the "removed" columns. However, these columns and their existing data are of course still present and are still processed within ARIS Process Mining. This is to ensure that an API client always receives the table in its most recent form (using its most recent schema), and contains only columns that are known to it.