Creating External Entities
  • 20 Jul 2022
  • 1 Minute to read
  • Dark
    Light

Creating External Entities

  • Dark
    Light

Overview

Data Structure Quick Summary
Complexity?Performance Impact?Saves to Database?Configuration Folder?Entity Framework?Folder Behavior?Process Tracking?
HighVariesYesYesNoNoNo

An External Entity is used to treat data that does not exist in Decisions as if it were a Decisions object. This can help to build actions and reports on external data such as the results of an API call or an external database. After creating the External Entity, a list of Flows (Get, Delete, Fetch, Save, etc) will be generated inside of the Configuration Folder. 

The Flows that are generated in the folder need to be configured correctly to ensure that the External Entity works as required.



Example

  1. From a Designer Project, click CREATE DATATYPES/INTEGRATION, select User Defined Types/Integration, and click External Entity

  2. Enter a name in the Structure Type Name field and add the desired data names and types. Click SAVE.


External Entity Data Structure Settings

Advanced

Setting NameDefaultFunction
Hide In SearchFalseThis hides the data type from appearing when it is searched
Type Name Space[DataStructureLocation]Creates the unique identifier for the External Entity (namespace.typename) and is used to generate the SQL table name for the External Entity (namespace_typename)
Category OrderBlankAllows data field categories to be organized in a certain way. For example, grouping required data fields together
Can Be Base TypeFalseAllows the created type to be used as a super-class for sub-classes
Include Type Name in DescriptionTrueThis enables or disables the visibility of the Type namespace
Is Lookup ListFalseEnables the data structure to contain a lookup list

Actions

Selecting the checkbox next to the following actions allows the user to Delete and Edit the External Entity. However, Custom Folder Entity Actions can also be created.

Action SettingDefaultFunction
Default Edit Category LabelDataPrompts or name of the default label when editing a category
Show Edit ActionTrueThis action gives users the ability to show an edit action on created Entities. Upon clicking this External Entity action, a default Form will appear. It will contain all of the current stored values for that External Entity. Any properties that are changed will be stored to that Entity upon clicking the save on the Form.
Show Delete ActionTrueThis action gives a Delete option to stored External Entities. When this action is clicked, a user will get a confirmation prompt to confirm this is the selected External Entity for deletion.
Add Category NameBlankPrompts for any name(s) of categories within the External Entity if at all
Add Sub Category NameBlankPrompts for any name(s) of subcategories within the External Entity if at all

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

Was this article helpful?