GetFieldProperties Overview

GetFieldProperties can be used within a process to access the properties of a particular field on the webpart canvas. Sometimes, if a developer wants a particular property or text to be used within a process, it will be done by adding a hidden input to the page and making the value the text that should be accessed. Then, from the process canvas, the input value can be accessed from the recommended values. However, with GetFieldProperties, this can be done without an additional field on the webpart canvas.

A single GetFieldProperties can retrieve many field properties from the webpart canvas by adding more fields. Each field requires a FieldName and PropertyName. If the field and property exist, it is returned in the output.

GetFieldProperties Use Examples

Basic GetFieldProperties Use

In this example, there is a list section that displays all the records in a table. Each record has an attribute “Active”. This is a hyperlink that is displayed, but it is also a value that we need to access from within the process canvas.

In an onload process, it pulls in the value of that Active attribute, then depending on the result takes different action.

Here are the logs after that service runs

Now we can use this “True” value to make decisions on the process should do next.

Retrieving a Field That Doesn’t Exist

Had the Active field or the Text attribute not existed, it would not return. See in this example, we added an field which doesn’t exist “Name123”.

When we load the page, the service runs, but only the Active Text is returned again: