Automate - Using Allowed Parameters to Retrieve Evidence Lists

 

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. Allowed Parameters enable Automate administrators to restrict user workflow inputs, populate a dynamic pick list or even authenticate to a database based on user credentials. Allowed Parameters are an advanced configuration option and provide significant workflow scale and functionality. This guide outlines the steps required to create an Allowed Parameter that will query a location on the filesystem. This will allow an Automate user to select one of the location items, when running a workflow. This guide outlines the functionality for Evidence Lists, but can be adapted to retrieve folder names as well.

Prerequisites 

  • Rampiva Automate v4.3.0 greater

  • Clients and Matters must be in use


Instructions

A. Configure Workflow

1

Identify the operations that will use the Allowed Parameter. In the example workflow, we’re adding an Allowed Parameter for {evidence_list} to the Configuration Operation.

2

Update the Add Evidence Operation to include the {evidence_list} parameter.

Be sure to select the scope option of Evidence Listing. Ensure that the Evidence list provided matches the format in the Rampiva Workflow help file. See the Workflow user guide: https://downloads.rampiva.com/automate/release/guides/workflow/en_US/user-guide.html#_add_evidence_operation for more information.

 

B. Configure Scheduler

1

From the Clients tab, select and edit the Client to receive the Allowed Parameter.

Allowed Parameter restrictions can be set at the Client Pool, Client, or the Matter level. If a script is not Matter specific, it’s recommended to add it to the Client or Client Pool level.

2

Add the Allowed Parameter name value. This value should match the value used in the Workflow operation(s).

3

Add the value to be used in the Allowed Parameter. In the example, we’re adding a python script that performs a file system lookup that will populate a pick-list in the job setup screen in Rampiva Scheduler.

When using scripts as Allowed Parameters, the input value must be formatted properly to identify the script language used.

4

Allowed Parameter text value:

1 python:T:\Scripts\listFolders_EvidenceList.txt

C. Configure Script

1

The sample Python script predefines the base location where data is stored using the baseFolder variable, and the pattern for building the path to the folder containing the evidence list files using the evidenceList variable – update these as appropriate for your environment. This will allow the script to look at the directory and identify any files or folders in that location. The names of the files will be displayed in the job setup window of Rampiva Scheduler.

Example full path of our evidence list file location:

S:\Source Data\Fast Food Corp\Jumbo Shrimp Vs Popcorn Shrimp\Evidence_Lists

Ensure proper formatting is used in the Python script - including escaping backslashes.

The Python script executes under the Scheduler service. If the script accesses file shares, ensure that the Rampiva Scheduler service runs under a service account which has access and appropriate permissions to those file shares.

 

2

Script text, from previous image.

1 2 3 4 import os baseFolder="\\\\nuixlab\\S\\Source Data" evidenceList= baseFolder+"\\"+client_name+"\\"+matter_name+"\\evidence_lists" result= os.listdir(evidenceList)
3

For additional information on scripted Allowed Parameters and for scripts in other languages, see the Rampiva Scheduler help file on this topic.

https://downloads.rampiva.com/automate/release/guides/scheduler/en_US/user-guide.html#_scripted_allowed_parameter_values

D. Test Allowed Parameter Operation

1

Create a Job using the same Client that was configured in the previous steps and workflow.

Ensure that you have files in the prescribed location set in Section C.1.

2

If completed correctly, the Evidence List parameter should populate with the filenames of items from the specified directory.