Using JSON Forms

This guide introduces how to navigate JSON Forms in Itential Platform Studio and how to use the Forms application to generate a JSON Schema representation of a form. There are two main components to the JSON Forms application that enable management of forms, a forms collection view and a form builder. Forms can be used throughout Itential Platform. At a high level, this is achieved by the JSON Forms builder providing the functionality to generate a JSON Schema representation of a form via drag-and-drop user interface.

Access JSON Forms

To access JSON Forms navigate to Itential Platform → Studio → JSON Forms.

JSON Forms is listed in the left navbar as its own subcategory (menu) in Automation Studio.

Collection View

To open the Collection view of JSON Forms, click the Find A Workflow link under Quick Start on the main welcome page of Studio.

The Collection page displays in a card-based layout with tabs located across the top. To access a specific JSON Form, workflow, or other automation, select the corresponding tab at the top to see the card view (collection) of all the available workflows, automations, etc.

The following actions can be taken from the Collection page.

Action	Icon	Description
Refresh		Refreshes the page.
Import		Imports a workflow.
Select All		Selects all the workflows on the active tab and page.
Delete		Permanently removes a selected workflow.
Export		Exports a selected workflow.
Sort		Sort by name, date created, last modified, or by tags.
Search		Search for a workflow by name or other criteria.

Create a New JSON Form

To create a new JSON Form:

1. Navigate to the main Automation Studio application page.
2. Click the + Create a Workflow link to open the Create dialog.
3. Select JSON Form from the dropdown list.
4. Enter a JSON Form name (required) and brief description (optional).
5. Click Create to save. The JSON Form is added to the Collection page.

Delete a JSON Form

You can delete an existing JSON Form using the card menu or by selecting a specific JSON Form, then clicking Delete.

Using the Card Menu

To delete a JSON Form using the card menu, click the stacked dots icon inside the JSON Form card to display the menu options and then click Delete to delete the JSON Form.

Select/Deselect a JSON Form

To select a JSON Form (or multiple JSON Forms) for deletion:

1. Select the checkbox to mark the JSON Form as selected.

2. Click the trashcan icon to delete all selected forms.

3. Click the deselect button icon to unselect all selected forms.

Export Forms to JSON Files (2023.2 and earlier)

You can also export a JSON file representation of a form using Forms in the left sidenav menu or from the Collections view.

Using the Forms Menu

To access JSON Forms:

1. Go to the main page of Studio.
2. Go to the left navbar and click the dropdown arrow to open the Forms menu.
3. Click any form in the list to navigate to the Form Builder for that particular form.
4. Click the stacked dots icon in the top toolbar of the Form to display more options. From the menu that opens, you can view the current form's JSON schema, edit the current form’s details, clone the current form, revert changes made to the current form, export the current form to a JSON file, or delete the current form form.
5. Click the Export form option to open the export modal.
6. Select Save File to download a JSON file representation of the form. Be sure to remember the location where the JSON file is saved.

Using the Collection View

You can also export a form into a JSON file from the Collection view:

1. Open the Collection view.
2. Select the checkbox to select multiple Forms for bulk export.
3. Click the stacked dots icon to display the Export menu options.
4. Click the Export icon to export all selected forms to JSON files.

Import JSON Files

To import a form from a JSON file:

1. Click the Import icon from the top toolbar on the Studio homepage.
2. Alternately, you can go to the Collection view of JSON Forms and select the Import icon. One or more JSON files (forms) can be imported at a time.

Clone a JSON Form

To clone (copy) a JSON Form:

1. Click the stacked dots menu icon inside of the card.
2. Select the Clone menu option to create a copy of the JSON Form.
3. The Clone Form dialog displays. Input a different name in the Save Form as text field.
4. Click Clone to save the JSON Form.

Preview a JSON Form

To preview a JSON Form:

1. Click the stacked dots menu icon.
2. Select the Preview menu option to show a preview of the JSON Form.
3. Click Preview Form to display a form preview.
4. Click Show Form Data to display the JSON schema.
5. Click Close to return to the preview modal.

Sort JSON Forms

To sort JSON Forms by name, date created, last modified, or by tags:

1. Click the sort icon (on the left) to modify the sort order (ascending or descending).
2. Use the dropdown menu icon (on the right) to change the property the sort is performed on.

View and Update JSON Form Details

Click the stacked dots menu in the top toolbar and select Edit details to open JSON form details. Here you can view creation and update time, and you can edit Name and Description.