- 06 Jan 2023
- 1 Minute to read
Creating Database Structures
- Updated on 06 Jan 2023
- 1 Minute to read
|Data Structure Quick Summary|
|Complexity?||Performance Impact?||Saves to Database?||Configuration Folder?||Entity Framework?||Folder Behavior?||Process Tracking?|
|Low||Low||Yes||Yes, but not by default||Yes||No||No|
A Database Structure defines an object that is stored in a database. The Database Structure exists only in the database, not in the Portal like an Entity or Folder Extension. The Database Structure can still be reported on and can have actions built into it if the Configuration Folder is turned on.
Create a Database Structure
- In a Designer Project, click CREATE DATATYPES/INTEGRATION and select Database Structure.
- In the Database Structure creation window, name the structure and provide it with data fields by specifying each one's name and data type. Click SAVE.Batch Load settingWhen enabled, this setting creates the data structure as a database-stored data type with an additional table that is a copy of the main table. By populating the copy table with data and then merging that data into the other, tables on the database allow for efficient storage and use of large sets of data.
Database Structure Creation Settings
Enables the Entity to be loaded into the cache
|Hide In Search||Hides the data type from appearing when being searched|
|Include ID In Flow Cache Key||Adds the GUID to the Cache Step Key for easier searching|
|Type Name Space||Creates the unique identifier for the Entity (namespace.typename) to generate the SQL table name for the Entity (namespace_typename)|
|Audit Changes||Saves changes to Entity data in the Audited Entities table. This option is used when data monitoring is required for this Entity|
|Category Order||Allows data field categories to be organized by the Designer|
|Enable Batch Load||Allows some batch inserting actions to be taken on the back end|
|Can Be Base Type||Allows the created type to be used as a super-class for sub-classes|
|Include Type Name In Description||This enables or disables the visibility of the Type namespace|
|Is Lookup List||Specifies if the data will be a Lookup List|
|Enable Actions||This will create the Configuration Folder of the Data Structure and allows additional actions to be taken.|