Automate - Using Allowed Parameters to Retrieve Evidence Folder Names

Owned by Ryan Best (Unlicensed)
Sept 05, 2023

 

The material in this document is for informational purposes only. This guide assumes that the most recent version of Rampiva Automate is in use unless otherwise noted in the prerequisites. The products it describes are subject to change without prior notice, due to the manufacturer’s continuous development program. Rampiva makes no representations or warranties with respect to this document or with respect to the products described herein. Rampiva shall not be liable for any damages, losses, costs or expenses, direct, indirect or incidental, consequential or special, arising out of, or related to the use of this material or the products described herein.

Introduction

Rampiva Automate introduced Allowed Parameters in version 4.3.0. This guide outlines the steps required to create an Allowed Parameter that will query a location on the filesystem. When running a workflow, this function will allow users to select one of the Evidence Folder names from a pick-list. This guide outlines the functionality for Evidence Folders, but can also be adapted to retrieve file names such as .CSV, .JSON etc.

Rampiva version 7.4 added additional functionality to support running scripts from the File Libray for ease of management and deployment. Workflows can also have Python, Ruby or ECMA scripts embedded into the workflow for easier portability.

Prerequisites 

  • Rampiva Automate v7.4.0 later

Instructions

A. Add Script to File Libray

1

Create a directory listing script using Python, Ruby, or ECMA. In our example we chose Python.

The sample Python script uses the import os function to retrieve a directory listing of sourceLocation.

For best results, standardize data locations across all servers and file structure. If a script accesses file shares, ensure that the Rampiva Engine Server service uses a service account with appropriate access permissions.

import os baseFolder="\\\\nuix_storage\\Nuix Source\\Source Data" sourceLocation = baseFolder+"\\"+client_name+"\\"+matter_name+"\\Evidence\\" result= os.listdir(sourceLocation) #result= [sourceLocation + s for s in result]
2

Open the File Libray to store the Evidence Folder directory lookup script.

3

Click Add + to add a file to the File Library.

4

Browse to and choose the script to add to the library.

5

Click Add File.

B. Configure Workflow

1

Find and select the workflow in the workflow library.

2

Select Edit to open the workflow.

3

Create a User parameter to be used as the Evidence Folder lookup list. We chose {next_source_folder}.

 

4

Selec the parapameter Type as Scripted.

5

Check the ‘Use scripted library file’ option.

6

Select the File Library script file to use in the workflow.

 

7

Click Close to save the parameter.

8

Click Next then Save to save the workflow.

C. Test Allowed Parameter Operation

1

From the workflow in the library, select the pulldown and select Add Job.

 

2

Proceeed to Step 3 of the workflow setup where user parameters are displayed.