External Entities

Last Updated: 12/05/2018 Introduced in Version:

An External Entity will take in data that is not stored in Decisions and create an object that is used in the same way an Internal Decisions object is used. This allows the object to be configured and actions to be built in the same way. After the Structure is configured a Configuration Folder is auto-generated. Inside the Configuration Folder, a list of Flows will display in the Designer View. Each Flow represents a different action that can be set up with a simple flow. The External Entity will work properly when each flow has been built. Each flow has been built to demonstrate how to complete the External Entity setup. Depending on how the External Entity is structured, the flows will be unique and may have other variations, depending on what is being configured.

 

Example

From a designer Folder navigate to Create DataTypes/Integration located on the blue action panel across the bottom of the designer Folder and select User Defined Types/ Integration> External Entity and select Create (Figure 1)

Figure 1

Define the External Entity, give the Structure Type a Name and add desired data names. 

  • Structure Type Name:
    • Name the data structure, (ToolEntity).
  • Name:
    • ProductName (String)
    • ProductNumber (String)

Figure 2

 

Configuration Folder

After the External Entity is created a list of flows that do specific actions appear in the Configuration Folder. There are six flows that need to be build to perform the actions as follows; Delete, Fetch All, Fetch, Get ID, Save and Search. These Flows are build for example purposes only and are not specific to every External Entity (Figure 3).

Figure 3

1.

Example

Steps

  • Delete from dbo.ProductData: Integration> Database> dbo.productData 

 

Delete Flow Example (Figure 4)

Figure 4

Configure the Steps:

On the Delete From dbo.ProductData step, in the Environment section, check the Run In Defined Environment box. In the Inputs section next to Product Number choose Select From Flow and then Pick under Entity> Product Number (Figure 5).

Figure 5

 

2. 

Example

Steps

  • Start Step:
  • Get all from dbo.ProductData:  Integration> Database> dbo.productData 
  • List Mapping Step:
  • End Step:

 

Fetch All Flow Example (Figure 6)

 

 

Figure 6

Configure the steps:

On the Get all From dbo.ProductData Step in the Input section next to Limit count set to Ignore (Figure 7).

Figure 7

 

In the Get All Fro dbo.ProductData Step in the Inputs section next to Limit Count select Ignore. On the List Mapping Step in the Inputs section next to Inputs choose Select From Flow (Figure 8).

Figure 8

 

On the End Step in the Data section under Output, there will be an output name called Entity. Map the data from the flow to the Entity. Under the Inputs section next to Entity choose Select From Flow and select OUTPUTS (Figure 9).

Figure 9

 

3.

Example

Get by Id from dbo.ProductData Flow (Figure 10)

Steps 

  • Get by Id from dbo.ProductData:  Integration> Database> dbo.productData 
  • End Step

 

Figure 10

 

 

Configure the Steps

On the Get by Id from dbo.ProdcutData Step under Inputs next to Product Number choose Select From Flow and then pick ID (Figure 11).

Figure 11

 

End Step 

In the Inputs section next to the Entity choose Build Data. Map the input data, in this example next to Product Name choose Select From Flow and pick dbo.ProductData_Result.ProductName. Next to the Product Number choose Select From Flow and pick dbo.ProductData_Result.ProductNumber (Figure 12).

Figure 12

 

4.

Example

Steps

  • End Step:

 

Get ID Flow Example (Figure 13 )

 

 

Figure 13

 

Configure the Steps

On the End Step under the Data section and under Output select Show Editor. Add an Output for Id (string). In the Inputs section next to Id choose Select From Flow and pick Product Number (Figure 14).

Figure 14

 

5.

Example

Steps

  • Selective Update dbo.ProductData:  Integration> Database> dbo.productData 

Save Flow Example (Figure 15 )

Figure 15

 

Configure the Steps 

On the Selective Update dbo.ProductData under the Data section next to ProductName choose Select From Flow and then pick from Entity>ProductName (Figure 16).

Figure 16

 

6.

Example

Steps

  • End Step

 

Search Flow Example (Figure 17)

 

Figure 17

Configure the Steps 

On the End Step in the Data section under Output, there will be an output name called Entity. Map the data from the flow to the Entity. Under the Inputs section next to Entity choose Select From Flow and select OUTPUTS (Figure 18).

Figure 18

After the Flows are configured for the External Entities Step, a Flow can be created and the Flows are now steps that can be found in the Flow designer. In the Steps Tab locate the Steps by navigating to, Integration> User Defined Types> External Entities. Each step can be now be dragged and dropped into the flow designer and used in a flow (Figure 19).

Figure 19

After the flows in the configuration folder are built, actions can also be added and used inside the Configuration Folder. For example create a User Action, Validation Rule, Entity Events, State Triggers, Action Visibility Rule and Create Reporting Data Flow (Figure 20). 

Figure 20

 

This completes the example for setting up an External Entity. 

Additional Resources