Inside Activate
Connectors
Schema Definition
5 min
each connector defines a schema that tells activate how to build and manage its database tables the schema is stored in the connector schema parameter example \<schema> \<datatable>department\</datatable> \<importtable>department import\</importtable> \<historytable enable="true">department history\</historytable> \<deletecondition>$import$ status = 'deleted'\</deletecondition> \<columns> \<column name="departmentcode" type="varchar(12)" default="''" key="1" /> \<column name="department" type="varchar(40)" default="''" /> \<column name="parentcode" type="varchar(12)" default="''" /> \</columns> \</schema> element reference path required example description datatable ✅ department stores current data importtable ✅ department import temporary staging table for imports historytable ✅ department history audit trail of changes use enable="false" to disable deletecondition optional $import$ status = 'deleted' marks rows for deletion when using flagged deletes columns/column/@name ✅ departmentcode column name in sql columns/column/@type ✅ varchar(12) sql data type columns/column/@default ✅ '' or 0 default value when none provided columns/column/@columnname optional departmentcode physical column name override; defaults to @name columns/column/@key optional 1 marks the key column only one per schema columns/column/@display optional 0/1 hide from ui if 0 columns/column/@multivalue optional 1 multi value support (requires varchar(max), values delimited by \r\n) columns/column/@foreignkey optional asset assetid links to other activate objects columns/column/@noimport optional 1 excluded from import; stored only in the data table safe schema changes append new columns at the end do not change data types in the schema directly — first apply the sql change, then align the schema avoid reordering or removing columns; this breaks the definition schema regeneration when the connector schema definition changes, you must regenerate the schema in activate studio to apply those changes to regenerate the schema in activate studio , right click the connector select connector tasks → regenerate schema… this will apply any new columns added at the end of the schema as per schema rules columns must always be appended at the end existing column types cannot be changed — these must be altered directly in sql first dropping the schema deletes all connector data after regeneration, reimport and commit all changes to prevent triggering unnecessary create, update, move, or delete actions troubleshooting schema issues if regeneration fails, review the schema xml for syntax or ordering errors if the connector structure is corrupted, use connector tasks → drop schema… to remove existing tables, then regenerate after regeneration, re run the connector’s import workflow to rebuild data