Managing a script snippet library

Edit a code snippet

You can use the following steps to edit a code snippet:

1. On the Script Snippet library page, click the open and close list of options button corresponding to the required code snippet, and then click Edit.

   

2. In the Edit script snippet dialog box, update the required details, and then click Save.
   

   

ⓘ NOTES:

• You can edit a code snippet only if you are the owner of the script or if your user credentials have the edit permission. For all other instances, the Edit feature is disabled.

• The Edit script snippet dialog box displays the following warning message if the selected snippet is assigned to more than one task:
  

  Warning Editing this script will impact the n linked tasks associated to this snippet

• To add applications to a snippet or to delete an application from the snippet, you must use the Edit script snippet dialog box.

Duplicate a code snippet

You can use the following step to duplicate a code snippet:

• On the Script Snippet library page, click the open and close list of options button corresponding to the required code snippet, and then click Duplicate.

  

The message Snippet has been successfully duplicated appears and the duplicated snippet appears in the view. The name of the duplicated snippet includes the date and timestamp when it is created.

Delete a code snippet

You can use the following steps to delete a code snippet:

1. On the Script Snippet library page, click the open and close list of options button corresponding to the required code snippet, and then click Delete.

   

2. In the Confirm Deletion message box, click Delete.

   

ⓘ NOTE: You can delete a code snippet only if you are the owner of the snippet.

Exporting from the snippet library

You can choose to export from the snippet library corresponding to one or more vendors.

You can use the following steps to export code snippets from the snippet library:

1. On the Script Snippet Library page, click Export snippets.

   

2. In the Export script snippets dialog box, do the following steps: a. In the Select vendors you wish to export section, select the required vendors. b. In the Included applications section, click the application tags to select the required application names.
   c. Click Export selection.

   

3. The exported code snippet is available in the downloads folder of your device. Note that the file format of the exported code snippet is .json file.

ⓘ NOTES:

• By default, all the application names are selected in the Export script snippets dialog box. You can click each tag to deselect the application names that are not required.

• The Included applications section is displayed only after you select the vendor.

Importing snippets into the snippet library

When you import code snippets into the snippet library, you must ensure that the code snippets adhere to the following standards and formats that are defined in the snippet library:

• The file format of the code snippet must be .json.

• The data in the .json file must be represented by using the same fields as in the IBM Task Mining Snippet Library. In other words, the .json file should have the following fields:

  • snippetName
  • snippet
  • vendor
  • snippetType
  • description

• The value in the snippetName field must adhere to the naming rules in IBM Task Mining. For more information on naming rules, see Create a new code snippet in the library.

• The value in the snippetType field must be TASK.

• The value in the vendor field must include the name of the vendor that IBM Task Mining supports. After importing the file, the snippet is linked to the vendor based on the name defined in the vendor field.

You can use the following steps to import a code snippet:

1. On the Script Snippet Library page, click Import snippets.

   

2. In the Choose Files to Upload dialog box, select the required .json file, and then click Upload.

3. The imported snippet library is available in the view.

Error messages that are displayed during importing a snippet

IBM Task Mining displays an error message for the following scenarios:

• The content of the imported file does not adhere to the snippet library standards.
  

  ---

  Example: Assume that the code snippet is a .json file with the following contents:

  [ {
  "snippetName" : "Initial Task",
  "snippet" : "//defVar --name customerId --type Numeric\n\twebClose --name web01 --leavebrowseropen",
  "vendor" : "IBM_RPA",
  "snippetType" : "TASK",
  "description" : "GitHub Click"
  }, {
  "snippetName" : "GitHub !87",
  "snippet" : "//defVar --name customerId --type Numeric\n\twebClose --name web01 --leavebrowseropen",
  "vendor" : "IBM_RPA",
  "snippetType" : "TASK",
  "description" : null
  }, {
  "snippetName" : "GitHub Comment 165",
  "snippet" : "//defVar --name customerId --type Numeric\n\twebClose --name web01 --leavebrowseropen",
  "vendor" : "XYZ",
  "snippetType" : "TASK",
  "description" : null
  }, {
  "snippetName" : "Provauno",
  "snippet" : "//defVar --name customerId --type Numeric\n\twebClose --name web01 --leavebrowseropen",
  "vendor" : "IBM_RPA",
  "snippetType" : "PROCESS",
  "description" : null
  } ]
  

  In this example, only the Initial Task snippet adheres to the Snippet Library standards. Hence, when you try to import the code snippet, the application displays the error message, Invalid File Format - Snippet name should contain alphanumeric and whitespace chars.

  ---

• If the name and vendor details of the imported code snippet is identical to an existing snippet.

  IBM Task Mining displays the error message, Duplicate snippets found, when you try to import a duplicate code snippet with identical snippet name and vendor details. The application also displays the Duplicate snippets found message box.

  In the Duplicate snippets found message box, click any one of the following options, and then click Proceed to complete the import process:
  

  • Replace existing with new imports
    This option replaces the existing code snippet with the imported code snippet.
    

  • Keep existing and do nothing
    This option retains the exiting code snippet and skips the duplicate snippet during the import process.
    

  • Keep both
    This option allows you to maintain the existing code snippet and the duplicate code snippet in the snippet library. Additionally, the snippet name of the imported code snippet is appended with a timestamp to differentiate it from the existing code snippet.