Software Upgrade (EOS) - JSON Form

In this module, we will build a JSON form. A JSON form is just one of the ways an automation can be triggered.  For our use case today, this form is how users will submit the information needed when running our Software Upgrade automation.

JSON Form Video

Step 1

From the Itential Automation Dashboard, click Automation Studio in the left navigation panel.

Step 2

Click the + icon at the top of the left navigation panel.

Step 3

The Create window opens. Click the dropdown menu and select  JSON Form.

Step 4

Enter Lab - Software Upgrade - EOS Form - XX (XX represents your initials), and click CREATE.

Step 5

Click the Form Elements dropdown.

Step 6

JSON Forms utilize a drag and drop interface. By clicking the Form Elements found on the right panel you can select which types of fields appear in the form. 

There are seven Form Elements from which to choose from. We will use Checkbox, Dropdown and Text Input elements for our form.

Step 7

Click on the Checkbox form element and drag it onto the canvas. When the element reaches the canvas, a red box will appear indicating where the element will be placed.  

Step 8

Once the element has been added to the form, an ellipses icon will appear in the top-right corner. Hover the mouse over the ellipses to see the gear icon.

Click the gear icon to configure the form element.

Step 9

In Itential's Software Upgrade Pre-Built automation, there are a few manual approvals for the user to confirm.  In our form, we will create an Auto Approve checkbox that bypasses these manual approvals for scenarios in which we do not need a user to confirm that the automation should proceed.  For our Checkbox element, enter the name Auto Approve in the Label field. We will accept the default settings for the remaining options and click Save.

Step 10

Our next element will let the user determine our target device.  We will choose the Dropdown element for this field.

Step 11

Add a Dropdown element to the canvas. Place it below the Auto Approve Checkbox

Step 12

Hover your cursor over the ellipses in the upper right corner of the dropdown section and click the gear icon.

Step 13

Type Device in the Label field. Select Yes for Required, and enter Select a device in the Placeholder field. This time click + Options in the lower right corner to set another option.

Step 14

Within the Options section, we have the option to create a static dropdown in which we define the dropdown values or dynamic that would be populated by making an API call.  For the sake of simplicity, we will select Static. Click the + Option button.

Step 15

This is where we can add choices for our dropdown. We will add only one here, but multiple entries can be added. Add EOS and click Back.

Step 16 

Click the Save button.

Step 17 

Add a second Dropdown element to the canvas. Place it below the first dropdown.

Step 18

Hover your cursor over the ellipses in the upper right corner of the Dropdown section and click the gear icon.

Step 19

Type Image in the Label field. Select Yes for Required, and type Choose an image in the Placeholder field. Click the + Options button in the lower right corner to set additional options.

Step 20

For this element we will need two options. Click the Option Button twice.

Step 21

Enter the versions shown on the screen. 

• CloudEOS-4.24.swi
• CloudEOS-4.27.swi
  

Note: Ensure there are no extra spaces either before or after the version entries. An extra space can cause an error when running your automation. 

Click the Back button when finished.

Step 22

Click the Save button.

Step 23

Following the same previous steps, add a third Dropdown element to the canvas. Hover your cursor over the the ellipses and click the gear icon.

Step 24

Type Flash Memory in the Label field. Select Yes for Required, and type Choose the memory location in the Placeholder field. Click the + Options button in the lower right corner to set additional options.

Step 25

Click the Option button.

Step 26

Enter flash: for the option.

Note: You must include a colon (:) with this option or you may receive an error when running your automation.

Click the Back button when finished.

Step 27

Click the Save button.

Step 28

Drag a Text Input Element to the canvas. This is the final element needed for our form. 

Step 29

Hover your cursor over the ellipses in the upper right corner of the Text Input and click the gear icon.

Step 30

Type Version in the Label field. Select Yes for Required. Type Version after upgrade in the Placeholder field and then click Save.

Step 31

Your JSON Form is now complete and should look like the image shown. Click the Save button in the upper right corner of the screen.