My First Custom Utility Command

Last updated: April 15, 2025

1. Navigate to the Utility Commands module.

   

   1. Click on the Configuration navigation link.

   2. Click on the menu option.

2. Click on the + button.

   

3. Add a Replace Spaces with Underscores in Top Level JSON Keys command.

   

   1. Enter Replace Spaces with Underscores in Top Level JSON Keys in the first field.

   2. Click on the + Add button.

4. Replace the auto-generated custom command stub function with the following code:

   Python

   def ReplaceSpacesWithUnderscoresInTopLevelJsonKeys(*args):
       """
         Replaces spaces with underscores in the top-level keys of JSON objects within a JSON array.
       """
       modified_array = []       # Initializes an empty list to store modified JSON objects
       json_array = args[0]      # Retrieves the JSON array from the first argument
       resultData = "Successful" # Sets the initial result status to "Successful"
       returnData = ""           # Initializes variables to store return data and error information
       error = ""
   
       try:
           for item in json_array: # Iterates over each JSON object in the input JSON array
               modified_item = {}  # Creates an empty dictionary to store the modified JSON object
               
               for key, value in item.items(): # Iterates over each key-value pair in the JSON object
                   modified_key = key.replace(" ", "_")  # Replaces spaces with underscores in the key
                   modified_item[modified_key] = value   # Add the modified key and original value to the new JSON object
   
               modified_array.append(modified_item)   # Append the modified JSON object to the result array
   
           returnData = modified_array   # Set the return data to the modified array
           
       except Exception as e:
           error = e               # Captures the error
           resultData = "Failed"   # Updates the result status to Failed
   
       return pb.returnOutputModel(resultData, returnData, '', '', '', error)  # Returns the output model with all the gathered information.
   

5. Add an Input JSON Array input parameter.

   

   1. Navigate to the Overview tab.

   2. Click on the Inputs tab.

   3. Click on the + New Input Parameter button.

   4. Input the parameter details, then click on the + Add button.

      • Set the Parameter Name to Inputjsonarray

      • Set the Display Name to Input JSON Array

      • Set the Parameter Type to JSON Array

      • Set the Is Required? field to Yes

      • Set the Description to A JSON array containing objects with key-value pairs. Keys may include spaces, which will be replaced with underscores.

      • Set the Sample Data to

        JSON

        [
            {
                "Employee ID": "CST-1001",
                "First Name": "Alex",
                "Last Name": "Johnson",
                "Job Title": "Cybersecurity Analyst",
                "Department": "Threat Intelligence",
                "Email": "alex.johnson@cybercorp.com",
                "Phone": "+1-555-0100"
            },
            {
                "Employee ID": "CST-1002",
                "First Name": "Taylor",
                "Last Name": "Morgan",
                "Job Title": "Incident Response Manager",
                "Department": "Security Operations",
                "Email": "taylor.morgan@cybercorp.com",
                "Phone": "+1-555-0200"
            }
        ]
        

6. Verify that the Input JSON Array parameter has been added, then click on the button.

   

7. Test the command.

   

   1. Click on the Test tab.

   2. Ensure that a site is selected.

   3. Paste in the JSON array from the sample data from step 6.

   4. Click on the Test Command button.

   5. Click on the Return Data tab in the popup to observe the modified keys.