Creating Database Structures
  • 06 Jan 2023
  • 1 Minute to read
  • Dark

Creating Database Structures

  • Dark

Article Summary


Data Structure Quick Summary
Complexity?Performance Impact?Saves to Database?Configuration Folder?Entity Framework?Folder Behavior?Process Tracking?
LowLowYesYes, but not by defaultYesNoNo

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.

Default Text Length
The default setting for all text stored in the database is 255 characters; however, this can be modified.

Create a Database Structure

  1. In a Designer Project, click CREATE DATATYPES/INTEGRATION and select Database Structure.
  2. 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 setting
    When 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

Setting NameDescription

Enable Caching

Enables the Entity to be loaded into the cache

Hide In SearchHides the data type from appearing when being searched

Include ID In Flow Cache KeyAdds the GUID to the Cache Step Key for easier searching

Type Name SpaceCreates the unique identifier for the Entity (namespace.typename) to generate the SQL table name for the Entity (namespace_typename)

Audit ChangesSaves changes to Entity data in the Audited Entities table. This option is used when data monitoring is required for this Entity

Category OrderAllows data field categories to be organized by the Designer

Enable Batch LoadAllows some batch inserting actions to be taken on the back end

Can Be Base TypeAllows the created type to be used as a super-class for sub-classes

Include Type Name In DescriptionThis enables or disables the visibility of the Type namespace

Is Lookup ListSpecifies if the data will be a Lookup List

Enable ActionsThis will create the Configuration Folder of the Data Structure and allows additional actions to be taken.

For further information on Data Structures, visit the Decisions Forum.

Was this article helpful?