Creating Custom Descriptions

Last Updated: 03/28/2018 Introduced in Version: 2.0

Overview

You can create custom descriptions for default or user-defined datatypes (for example, the account datatype) in the Decisions tool. Each datatype by default has a long and short description, which may help you identify data quickly. When you set a custom description for a datatype, that description will apply to all future instances of that datatype.


Example

In this example we create a custom short description for the accounts datatype.

 

To begin, in the Decisions tool click on a designer folder, then click Create DataTypes/Integrations > Configuration Extension > Add Entity Actions and Configuration.

 

Search for datatype “account” and click the Account [DecisionsFramework.ServiceLayer.Services.Accounts.Account] datatype, then click SAVE.

 

An Entity Configuration folder is added in the tool.

 

Right-click on the Account Configuration Extension folder and click Generate Description > Text Merge for Custom Short Description.

 

In the Generate Custom Short Description dialog, type a name and click OK.

 

TextMerge designer opens. In the PROPERTIES panel define Input Data by clicking the Add New button. In our example we define the Input Data Name  to be “Entity” and change the Type  to Account. Click OK. Then on the left panel, expand Entity. Under Authentication Type hover over CreatedBy then click Add.

 

 

Save and close the TextMerge designer. Now the short description for the accounts datatype will include the CreatedBy value (username of the person who created the account).

 
In this example we used the Text Merge for Custom Short Description option. The options are:
 
Flow for Custom Long Description   Lets you create a flow to fetch data you want to use in the long description
Flow for Custom Short Description   Lets you create a flow to fetch data you want to use in the short description
Flow for Entity Description   Lets you create a flow to fetch data you want to use in entity description
Text Merge for Custom Long Description   Opens a TextMerge designer that lets you merge text into the long description
Text Merge for Custom Short Description   Opens a TextMerge designer that lets you merge text into the short description
Text Merge for Entity Description   Opens a TextMerge designer that lets you merge text into the entity description

 

 
 

Additional Resources