CommonFeaturesCustom Properties
Custom Properties

Custom Properties

Custom Properties provide additional data to Nodes.

Click the + button at the bottom of the Node to add a Custom Property. An overlay with configuration options is displayed.

Custom Properties handling is either implicit or explicit.

Implicit Custom Property Support

When a Node does not explicitly work with Custom Properties, implicit handling applies. In implicit mode, Custom Property values can be string-templated into non-custom Properties.

Let's look at an example for the Web Request 2 Node.

  1. Add a Custom Property called token to a Web Request 2 Node.
  2. Click the Headers Property.
  3. Set the value to Authorization: {token}.

When the Node runs, the value specified in token or passed to it via a Flow Connector is translated into the {token} element in the Headers Property.

When providing implicit Custom Properties, consider what form of escaping to use. For example, consider a case where you are translating a field called somefield into the JSON document below:

{
	"somefield":"{somevalue}"
}

If the field contains a double quote character, e.g. example"value, the resulting document will be:

{
	"somefield":"example"value"
}

This is an invalid document. To work around this, you can choose JSON Escaping from the escaping dropdown.

Note that we do not actually recommend using this approach to prepare a document. QuickMap will generally be a better option.

You cannot connect a Data Flow Connector to any Property that you want to template. In the example above, if a Data Flow Connector was connected to the Headers Property, string templating would not be supported.

Explicit Custom Property Support

Some Nodes explicitly support Custom Properties, which means that the Node decides how to handle Custom Properties. Refer to the help article for a specific Node to see how it uses Custom Properties.

One example of a Node that explicitly handles Custom Properties is Microsoft SQL Query. When a Custom Property is added to this Node, it treats it as a SQL parameter. This is important for this scenario because if string templating was used, it would be vulnerable to SQL injection attacks.

Here are some other examples of Nodes that explicitly support Custom Properties.