Automate - Configure Dynamic Worker Allocation

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

This Knowledge Base article covers the basic steps to configure Rampiva Automate to dynamically assign workers based on source data size and count.

Prerequisites

Rampiva Automate 6.0 or later
Rampiva Automate Premium Edition license
Security Policy permissions for API Keys
Rampiva Automate environment accessible over http, or https with valid certificates

Instructions

A. Rampiva Workflow Download

1	Download the Dynamic Worker Allocation - Submit Job workflow.
2	Optionally, configure the script in the Dynamic Worker Allocation - Submit Job workflow in order to set different thresholds for each Resource Pool. Adjust the total_size values based on the desired Resource Pool threshold. By default, the workflow sets the following thresholds: Source data up to 1.5GB or up to 4999 files. - RP_Low Source data between 1.5GB and 9.9 GB or 5000 and 9999 files - RP_Med Source data greater than 10GB or 10000 files - RP_High	`if total_size > 10 \|\| file_count > 10000 puts "Using Resource Pool High" rp=rp_high elsif total_size > 1.5 \|\| file_count > 5000 puts "Using Resource Pool Medium" rp=rp_med else puts "Using Resource Pool Low" rp=rp_low end`

B. Configure Rampiva Automate - Part 1

1	Browse to Settings then User Settings.
2	Expand Troubleshooting settings and toggle the Show Object IDs setting to Enabled.
3	Browse to API Keys.
4	Click the +Add button to create a new API Key.
5	Name the API Key and set an API Key duration in days. The default value is 1825 days (5 years).
6	Click Add key to finalize creation of the API Key.
7	From the API Key that was just created, click the Copy Header button.
8	Browse to Execution Profiles.
9	Click the +Add button to create a new Execution Profile.
10	Add the following Workflow Parameters. {rp_low} {rp_med} {rp_high} {scheduler_host} {workflow_id} {api_key_header_masked}
11	Browse to Libraries.
12	Upload and save the Dynamic Worker Allocation - Submit Job workflow to your desired Library.
13	Select workflow that will run once Rampiva has dynamically assigned workers.
14	Document the workflow ID in a text editor.

B. Configure Engines and Resource Pools

1	Browse to Engines.
2	Click the +Add button to create a new Engine.
3	Name the New Engine RP_Low and designate a Target Worker count
4	Repeat Step 3 for RP_Med and RP_High Engines.
5	Browse to Resource Pools.
6	Click the Add+ button to create a new Resource Pool.
7	Name the Resource Pool RP_Low and add the RP_Low Engine to the selected column.
8	Document in a text editor the Resource Pool ID from the Local Resource Pool page.
9	Repeat Step 7 to create RP_Med and RP_High Resource Pools.

C. Configure Rampiva Automate - Part 2

1	Browse to Execution Profiles.
2	Find and Edit the Dynamic Workers Execution Profile created in Step 9 of Section A.
3	Add the documented values for the workflow, API Key, Scheduler Host, and Resource Pools.
4	Save the Execution Profile.

D. Verify Operation and Testing

1	From the Main Rampiva Automate page, click Add+ Processing Job.
2	Select the Client and Matter for the job to run under.
3	Select the Submit Job workflow from the Library.
4	Select the Dynamic Workers Execution Profile
5	Select any Resource Pool.
6	Input the Source Data Set Folder name from your desired source.
7