Create External API Form Fields

When the web service has been built and is available in GrantsConnect, form fields should be created to connect to the Response Fields provided for the service.

1. Navigate to the Program Setup > Custom Forms area.

2. From the Form Fields tab, select the Manage form fields button.

3. Select the Add new option.

4. In the Add New Form Field screen, provide the following information.

   1. Provide a name for the field that will be used to identify it in the Form Builder.

   2. Include a brief description of the field, if desired.

   3. Select External API from the Type field.

   4. The Key is automatically created when the Name is entered. This can be changed or a new unique key generated.

   5. Specify the audience (e.g., Applicant).

   6. Select a category to be used in filtering on custom forms and reporting.

   7. Enable additional options where needed:

      • Additional field encryption - Add an additional level of database encryption for responses. Encrypted fields are not available to filter or search.

      • Field masking - Hide responses to this field to internal users who do not have the Can view masked data permission. Response data will be hidden in all areas of GrantsConnect, including forms, reporting, email previews, and document templates.

5. Save all settings to create the new field.

Warning: The configuration for these fields will differ based on how they will be used. Learn more.