How to configure additional fields in the Outreach Blueprint

Owned by Aravindhan Vijayakumar (Deactivated), created
Last updated: Oct 11, 2022
4 min read

This document will help us to understand how to configure additional fields for the Channels in the Outreach Blueprint.

These configured fields will be available along with the default fields for all the channels.

 Instructions

Additional fields can be configured in the Blueprint while creating the Blueprint and they can also be configured in the existing Blueprints on the Blueprint edit page.

  1. In the Blueprint edit screen or create Blueprint screen, additional fields can be configured using the Outreach Properties Editor field

    Outreach Properties Editor

  2. We can use the predefined templates for each field

  3. Click on the help icon near the field name

    Help icon

  4. On the help window, click on the field type that has to be added to the Channels

    For example, if we want to add a text field, click on the Text type from the region highlighted in the above screenshot

  5. Copy the code from the pop-up window

     

  6. Close the pop-up and paste the contents into the Outreach Properties Editor. The contents should to be pasted inside the fields array.

  7. To add extra fields copy the object structure within the "fields" array and add it with the comma-separated values before the end of the fields array(]).

  8. Change the label and key values to identify the fields. The key should be unique.

  9. Example: The below Outreach Properties Editor code has a Text Field and a Text Area Field included in the fields array

    { "fields": [ { "label": "Text Field", "key": "TextKey1", "isDefault": false, "validation": [ { "required": false } ], "options": [], "multiple": false, "ref": "", "fieldType": "text", "type": "String" }, { "label": "Text Area Field", "key": "TextAreaKey1", "isDefault": false, "validation": [ { "required": true, "maxlength": 250 } ], "options": [], "multiple": false, "ref": "", "fieldType": "textarea", "type": "String" } ] }

     

  10. Save the Blueprint.

Field Property

Description

Field Property

Description

label

Enter a label for the field.

key

Use lowercase alphabetic letters without spaces.

isDefault

Boolean (true or false). This feature has been deprecated. The default value is false.

validation

An array with the “required” object, which can be true or false.

options

This array will be used when you use fields such as checkbox, file, dropdown and so on.

multiple

This field accepts boolean value. This is useful to configure the dropdown field to accept single value or multiple values

ref

This field is used to refer another schema within this schema. See,

fieldType

Represents the type of field you are going to add. You can see the list of supported field types from the help window.

type

Represents the datatype of the field. (values the field can take). For example, string, boolean, integer, and so on.

es

Elasticsearch Supported types are available at https://www.elastic.co/guide/en/elasticsearch/reference/6.8/mapping-types.html

comment

You can add comments using this property.

The fields configured here will be available for all the channels on the Outreach Manager page.

The fields configured in the example code will be available in the Outreach Manager as shown in the screenshot below.