- 11 Sep 2023
Using JSON Forms
- Updated on 11 Sep 2023
This guide introduces how to navigate JSON Forms in Itential Automation Platform (IAP) 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 IAP. 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
To access JSON Forms navigate to IAP → Automation Studio → JSON Forms.
JSON Forms is listed in the left navbar as its own subcategory (menu) in Automation Studio.
Figure 1: JSON Forms
To open the Collection view of JSON Forms, click the Find A Workflow link under Quick Start on the main welcome page of Automation Studio.
Figure 2: Find an Automation
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 3: Collection View
The following actions can be taken from the Collection page.
|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:
- Navigate to the main Automation Studio application page.
- Click the + Create a Workflow link to open the Create dialog.
- Select JSON Form from the dropdown list.
- Enter a JSON Form name (required) and brief description (optional).
- Click Create to save. The JSON Form is added to the Collection page.
Figure 4: Create JSON Form
Delete a JSON Form
You can delete an existing JSON Form using the card menu or by selecting a specific JSON Form.
Figure 5: JSON Form Card Controls
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.
Click Delete to delete the JSON Form.
Figure 6: Delete JSON Form
Select/Deselect a JSON Form
To select a JSON Form (or multiple JSON Forms) for deletion:
Select the checkbox to mark the JSON Form as selected.
Click the trashcan icon to delete all selected forms.
Click the deselect button icon to unselect all selected forms.
Export Forms to JSON Files
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 the Forms application:
Go to the main page of Automation Studio.
Go to the left navbar and click the dropdown arrow to open the Forms menu.
Figure 7: Forms
Click any form in the list to navigate to the Form Builder for that particular form.
Figure 8: Forms List
Click the stacked dots icon in the top toolbar of the Form to display more options. From the menu that opens, you can view metadata, clone a form, revert changes made to a form, export a form to a JSON file, or delete a form.
Figure 9: Form Toolbar and Menu Options
Click the Export form option to open the export modal.
Figure 10: Export Form
Select Save File to download a JSON file representation of the form. Be sure to remember the location where the JSON file is saved.
Figure 11: Save Export File
Using the Collection View
You can also export a form into a JSON file from the Collection view:
Open the Collection view of JSON Forms.
Select the checkbox to select multiple Forms for bulk export.
Click the stacked dots icon to display the Export menu options.
Click Export to export all selected forms to JSON files.
Figure 12: Export from Collection View
Import JSON Files
To import a form from a JSON file:
Click the Import icon from the top toolbar on the Automation Studio homepage.
Figure 13: Import from Automation Studio Toolbar
Alternately, you can go to the Collection view of JSON Forms and select the Import icon.
Figure 14: Import JSON Forms
One or more JSON files (forms) can be imported at a time.
Clone a JSON Form
To clone (copy) a JSON Form:
Click the stacked dots menu icon inside of the card.
Select the Clone menu option to create a copy of the JSON Form.
Figure 15: Clone Menu Option
The Clone Form dialog displays. Input a different name in the Save Form as text field.
Click the Clone button to save the JSON Form.
Figure 16: Clone JSON Form
Preview a JSON Form
To preview a JSON Form:
Click the stacked dots menu icon.
Select the Preview menu option to show a preview of the JSON Form.
Figure 17: Preview Menu Option
The Preview Form dialog displays.
Figure 18: Preview Form
Click Show Form Data to display the JSON schema.
Click Close to return to the preview modal.
Figure 19: JSON Form Schema
Sort JSON Forms
To sort JSON Forms by name, date created, last modified, or by tags:
Click the sort icon (on the left) to modify the sort order (ascending or descending).
Use the dropdown menu icon (on the right) to change the property the sort is performed on.
Figure 20: Sort JSON Forms
View and Update JSON Form Details
Click the stacked dots menu in the top toolbar and select View metadata to open JSON form details.
Figure 21: 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 22: View JSON Form Metadata