How to Use the Script Repository

The Script Repository page enables you to manage the scripts that are applied to search results for remediation.

Overview

  • This topic describes how to access and view your script repository, add a new script, view and change script encoding, test your script, export a script and delete a script.
  • See the topics below for more information.

How to Access and View Your Script Repository

Procedure:

  1. From the left menu, click Settings.

  2. Click Script Repository.

  3. Scripts are displayed in a list sorted by:
    • Script Name
    • Script Description
    • File Name
    • Script Status
    • More options

  4. Click a the Script Status column to sort ascending.

  5. Click the Script Status column again to sort descending.

  6. Search for a script
  7. Your can search for scripts by
    • Name
    • Description
    • File Name

  8. Type the search query in the box and the results are sorted and displayed in the list below.

  9. Click the x to clear the search term.

How to Add a New Script

Script Encoding Requirements by Version

  • Spirion Sensitive Data Platform version 13.5 and later requires scripts that are UTF-8 encoded
  • Using scripts that are not UTF-8 encoded may result in errors
  • Use the steps in the topics below to change the encoding of your non-compliant scripts to be compliant

How to View and Change Script Encoding

To view, and if necessary, change your script, use the steps below:

  1. Open any script in the application Notepad++.
  2. To view the encoding, select the Encoding menu from the top of the application.

  3. If the encoding is not UTF-8, select UTF-8 from the menu options.

  4. Save the script.

How to Test Your Script

To test your script, use the steps below:

  1. Re-upload the updated script with UTF-8 encoding to the Script Repository.
  2. Use the updated script with UTF-8 encoding.
  3. Use the script in a Scan Playbook.
  4. The script should now work as expected.

How to Add and Use Your New Script

To add a new UTF-8 script use the following procedure:

  1. In the top-right of the screen, click Actions.
  2. Click Create Playbook.

  3. In the Custom Script Detail pop-up window, fill in the following:
    • Script Name: Type the name of the script.
    • Script Description: Type the description of the script.
    • Upload Script: Click the blue magnifying glass icon to upload a script file.
  4. Click Save to proceed or Cancel to discard.

How to Export a Script

Use the following steps to export a script from the Settings > Script Repository page:

  1. In the top right corner of the page click the blue Actions button.
  2. Click Export from the sub-menu.

  3. A .csv format file is downloaded to you local computer.

How to View or Edit Script Details

Use the following steps to view or edit the details of a script from the Settings > Script Repository page:

  1. Locate the script you wish to view or edit in the Script Repository table.
  2. In the far right column, click the more options menu (3 vertical dots).
  3. Click View Details from the sub-menu.

  4. The "Custom Script Details" pop-up window is displayed.
  5. Make changes as you desire to any of the following fields:
    • Script Name: Type the script name.
    • Script Description: Type the script description.
    • Upload Script: Click the magnifying glass icon to upload a script file - for example, script.ps1 - from your local computer.

  6. Click Save to save changes or Cancel to discard your changes.

How to Delete a Script

Use the following steps to delete a script from the Settings > Script Repository page:

  1. Locate a script in the Script Repository table.
  2. In the far right column, click the more options menu (...).
  3. Click Delete Script.

  4. Click the blue Confirm button to confirm deletion or Cancel to abort the action.


Was this article helpful?