Home Features 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 providing configuration options will be 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 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 that has been specified in token (or passed to it via Flow Connector), will be 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're translating a field called somefield into the JSON document below:

{
	"somefield":"{somevalue}"
}

If the field contains a double quote character (for example 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 escaping dropdown.

(Note that we don't actually recommend using this approach to prepare a document. QuickMap will generally be a better option).

Note that you can't 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 on 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 them as SQL parameters. 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 Properties that explicitly support Custom Properties.