About preview in Connector Builder

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.

When adding authentication configuration settings, options, input, or output, for your connector in the dialog, the Preview window displays the fields that will be required to create a connection for your connector (in the case of authentication) or the action card itself as you are adding them in the dialog. This feature allows you to preview the New Connection dialog or the action card for your connector without having to deploy it first.

Preview for authentication

For basic authentication, the Preview section displays the Connection Nickname, Username, and Password fields.

For OAuth and custom authentication types, only the Connection Nickname field is displayed.

As you add fields in the Parameters or Config Values sections, the field labels and text boxes automatically appear in the Preview section.

If you add dynamic values for authentication using Config Values or for input fields, then they will not be displayed in the Preview section.

If you call a helper flow to generate fields in the Config Values section, a static Dynamically generated label will appear in the Preview section. The fields themselves will not appear. If the Visible toggle is turned off for a field in Config Values, it will not appear in the Preview section. Similarly, if fields are removed from the Parameters or Config Values sections, those fields are removed from Preview.

All fields in Preview are not editable.

Preview for options, input and output fields

As you add fields in the Options, Inputs or Outputs dialogs, the field labels and text boxes automatically appear in the Preview section. A field will appear with a blank label until you start entering a string value.

If you change the type for a field to Dropdown, the Preview section will indicate the change and add the default string Choose an option....

If the Required toggle is turned on for an options or input field, it will appear with a red asterisk in the Preview section.

If you add dynamic inputs, a single Text-type field will appear in the Preview section under the group name Dynamic Fields.

If the number of fields on a card are sufficient in number to require a scroll bar on the card, the scroll bar will appear in the Preview section.

Static and dynamic dropdown fields will not appear in the Preview section.

If a field is dependent on another field, it will appear as disabled in the Preview section.

All fields in Preview are not editable.

Validation of field names for preview

While validation rules are in place to prevent the use of prohibited characters in field names (see Connector Builder deployment validation errors), the values that you enter will appear in the Preview section. However, you will not be able to save your updates if the value for a field name will cause a validation error. For example, if you enter Domain$ (in the Authentication dialog) or Input*_$ as a label for an input field, it will appear, but you will have to change it before you can save your settings.

Related topics

Create and edit connector settings

Build basic authentication

Build authentication with OAuth 2.0

Build custom authentication