Using JSON Forms

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.

Accessing JSON Forms

You can access JSON Forms one of two ways:

• Navigate to Itential Platform → Studio → JSON Forms. JSON Forms is listed in the left navbar as its own subcategory (menu) in Studio.

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

Figure 1: JSON Forms

Collection View

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.

Figure 2: Collection View

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.

Creating a New JSON Form

To create a new JSON Form:

1. Navigate to the main 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.

Figure 3: Create JSON Form

Deleting a JSON Form

You can delete an existing JSON Form using the card menu or by selecting a specific JSON Form for deletion.

Figure 4: JSON Form Card Controls

To delete a JSON Form using the card menu:

1. Click the stacked dots icon inside the JSON Form card to display the menu options.

2. Click Delete to delete the JSON Form.

Figure 5: JSON Form Controls

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.

Exporting JSON Forms

You can also export a JSON file representation of a form:

1. After clicking the menu button, select the Export option from the menu that opens.
2. Click the Export JSON Form option to automatically download a JSON file representation of the form. Be sure to remember the location where the JSON file is saved on your system.

Using the Collection View

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

1. Open the Collection view of JSON Forms.
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 Export to export all selected forms to JSON files.

Figure 6: Export from Collection View

Importing JSON Forms

To import a form from a JSON file, click the Import icon from the top toolbar on the Studio homepage. 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.

Figure 7: Import from Studio Toolbar

Figure 8: Import JSON Form from Collection View

Cloning 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 the Clone button to save the JSON Form.

Figure 9: Clone Menu Option

Figure 10: Clone JSON Form

Previewing 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. The Preview Form dialog displays.
4. Click Show Form Data to display the JSON schema.
5. Click Close to return to the preview modal.

Figure 11: Preview Menu Option

Figure 12: Preview Form

Figure 13: JSON Form Schema

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.

Figure 14: Sort JSON Forms

Viewing & Updating JSON Form Details

Click the stacked dots menu in the top toolbar and select View metadata to open JSON form details.

Figure 15: Navigating to JSON Form Metadata

The metadata drawer displays information about who created the form and when, along with who last updated the form and when. From the form details drawer, the Name and Description fields can be changed.

Figure 16: View JSON Form Metadata