Add selectable outputs to an action card

This is an Early Access feature for existing Workflows users. To enable it, use the Early Access Feature Manager as described in Manage Early Access and Beta features.

Connector Builder provides the ability to inspect a list of output fields that can be selected by your connector's end user. As a developer of a connector, you can retrieve a list of output fields that can be selected by an end user when building a flow. This feature is particularly useful when building a connector against a third-party service that retrieves a large payload of data. Such third-party services may allow a developer of a connector to specify which fields should be returned in a response.

For example, Get Issue in the Jira REST API allows a developer to pass a fields array of comma-separated keys that can be included in a response. If no fields are provided, then all of them are returned by the service. However, since Jira issues can have hundreds of fields, a response that lacks filtering can be large, slow, and may impact performance. By specifying a subset of fields, a developer of a connector can reduce the size of a payload and decrease the time needed for a response from a third-party service.

Connector Builder provides a list of outputs that were selected by a user for your connector. This takes place regardless of whether the third-party service accepts a list of fields as requested in a response. If the list of selected outputs isn't used by your service, it can be safely ignored.

Selected output fields in action flow

Outputs are the fields on a card that return data during the execution of a flow. Such fields can be mapped (by drag-and-drop) to input fields of other cards in a flow.

When you create a new Action flow, a SELECTED OUTPUTS section is on the Connector Action card. Until you add a group of output fields, this section remains empty. Once a group of output fields is added to a card, a draggable output field is added to the section. A separate output field will be added for each output group that is created.

To add output fields using the Outputs dialog, see Add selectable outputs to an action card.

Object shape for selected outputs

When fields in the Selected Outputs section are returned from the third-party service, they are in the following format for each group:

{

"field A": {

"type": "string",

"collection": false

},

"field B": {

"type": "object",

"collection": true

},

"field C": {

"type": "boolean",

"collection": false

}

}

This list can be processed into a comma-delimited string of text by using the Object Keys and List to Text function cards. The list can then be properly formatted into a query object (should this be required) using the Object Construct function card.

For static fields, the top level key for Selected Outputs is the value for the Field ID field in the Outputs dialog that gets generated automatically for each output field.

For fields creating with the Dynamic Fields option, the top level keys are the name field that is used in the list of objects that represent the field list. For example:

[

{

"displayname":"Field A",

"name":"fieldA",

"type":"Text",

"collection":false

},

{

"displayname":"Field B",

"name":"fieldB",

"type":"Object",

"collection":true

},

{

"displayname":"Field C",

"name":"fieldC",

"type":"True/False",

"collection":false

}

]