Disclaimer

The material in this document is for informational purposes only. 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.

© Rampiva Technology Inc. 2023 All Rights Reserved

Introduction

Parameters are used throughout Rampiva Automate to link together the different features of the platform and to control the behavior of operations and jobs.

This document describes the types and formats of parameters, and provides sample values.

1. Name Syntax

The parameter names contain only lower-case letters and underscore, and are wrapped in curly brackets, for example: {case_name}

2. Parameter Realms

2.1. System Parameters

These parameters have predefined names and are used to either record the behavior of various operations and features, or to customize this behavior.

For example, the system parameter {last_item_set_name} records the name of the last Item Set that was created in the Case, and when accessed in a Job, will return this name. Conversely, the system parameter {data_timezone_id} can be set to configure the time zone under which data will be loaded in the Case during.

See the section Parameters Glossary for a complete listing of system parameters.

2.2. User-Defined Parameters

These parameters can have any name with a valid syntax that is not already in use by a system parameter.

An example usage of user-defined parameters is configuring a parameter named {base_case_location} for recording the path under which cases will be created or opened, and prompting the user to fill out the value of this parameter

3. Parameter Types

3.1. Parameters Defined in the Configuration Operation

3.1.1. Text

By default, parameter values are stored as Text and can contain any value.

3.1.2. Text (Masked)

Text (Masked) parameters will have their values masked in the user interface, but can be retrieved by any operation. See Parameters Security.

3.1.3. Text (Protected)

Text (Protected) parameters will have their values masked in the user interface. The values can only be accessed by the Rampiva operations which have a password or key field. See Parameters Security.

3.1.4. Number

Number parameters can contain an integer or real number.

3.1.5. Boolean

Boolean parameters can contain the value True or False.

3.1.6. Date

Date parameters are presented to the user as a date picker. The value has the format yyyyMMdd.

3.1.7. Date Time

Date Time parameters are presented to the user as a date and time picker. The value has the format yyyyMMddTHHmmss.

3.1.8. Relativity

Relativity parameters are used to select a Relativity object. To use these parameters, a Relativity Service must be configured, and the user submitting the Job must be logged in to the Relativity Service.

The parameter value resolves to the Artifact ID of the Relativity object. The user-printable value resolves to the name of the Relativity object.

3.1.9. Microsoft User Service

Microsoft User Service parameters are used to select a Microsoft Service object, configured in the Settings → User Services section.

3.1.10. Library File

Library File parameters are used to select a file defined in the Settings → File Library section.

The value contains the path to the file, accessible during the Job execution.

3.1.11. User File

User File parameters are used to select a file during the submission of the Job.

The value contains the path to the file, accessible during the Job execution.

3.1.12. Server File

Server File parameters are used to select a file from an In-Place Data Repository during the submission of the Job.

The value contains the path to the file, accessible during the Job execution.

The list of available data repositories and files can be filtered when building the Workflow.

3.1.13. Server Folder

Server Folder parameters are used to select a folder from an In-Place Data Repository during the submission of the Job.

The value contains the path to the folder, accessible during the Job execution.

The list of available data repositories can be filtered when building the Workflow.

3.1.14. Data Set

Data Set parameters are used to select a finalized Data Set from the Matter to which the Job is submitted.

The parameter value resolves to the ID of the Data Set. The user-printable value resolves to the name of the Data Set.

To access additional metadata related to data sets, use the dataSetsMetadata in a Script operation.

3.1.15. Legal Hold

Legal Hold parameters are used to select a Legal Hold. These parameters can only be used in a Schedule triggered on a Legal Hold event.

The parameter value resolves to the ID of the Legal Hold. The user-printable value resolves to the name of the Legal Hold.

3.1.16. Lock

Lock parameters can be used to create interdependencies between Jobs. If two Jobs use a lock parameter with the same name and value, these two Jobs will not run concurrently.

For example, if two Jobs use the parameter {job_lock} defined with a value of Initech, the first Job will start and run to completion before the second Job can start, even if enough resources are available to run both Jobs in parallel.

Alternatively, if two Jobs use the parameter {job_lock} defined with a value of Test1 and Test2, this will not prevent the Jobs from running in parallel.

3.1.17. Separator

Separator parameters are used to create a visual separation between a group of parameters.

3.1.18. Warning-Supression Parameters

Parameters with the name starting in suppress_warnings_ can be used to suppress warnings from an operation of a certain type.

For example, to suppress the warnings from the Add Evidence operation, set the parameter {suppress_warnings_add_evidence} with the value true.

3.2. Parameters Defined in the Execution Profile

By default, all parameters defined in the Execution Profile will be of the type Text.

By adding the suffix _protected or _password to the parameter name sets the type to Text (Protected). Similarly, by setting the suffix _masked to the parameter name, sets the type to Text (Masked).

3.3. User-Printable Values

Certain parameters, such as Relativity objects, Legal Holds, Data Sets, etc., have both a system value as well as a user printable value. The system value corresponds to the ID of the object, whereas the printable value contains the name of the object.

When evaluating a parameter, the system value is returned by default. To access the user-printable value, call the parameter along with the suffix _userprintable.

4. Filters

4.1. Regex

The values allowed to be submitted in a user-defined parameter can be restricted with a regular expression. This is done in the Configuration operation.

Parameters using regular expressions that have values separated by alternations | will only allow for those choices, and will be presented to the user as dropdowns.

The regular expression must only contain characters and alternations. Special regex characters must be escaped.

For example, the regular expression GMT\+1|GMT\+2|GMT\+3 corresponds to the choices GMT+1, GMT+2 and GMT+3. However, the regular expression GMT+1|GMT+2|GMT+3 is an invalid and will not trigger a choice parameter.

To allow empty values, place an alternation at the end of the regular expression, for example: GMT\+1|GMT\+2|. This results in the choices GMT+1, GMT+2 and a blank option.

4.2. Relativity Conditions

Relativity Conditions can be used to restrict the accepted values of a Relativity parameter, for example, to only objects from a specific Relativity Workspace, or Relativity Matter.

4.3. Scripted Parameters

Scripted parameters let users provide a script can be used to return the list of allowed values.

Scripted parameters support the following scripted language Powershell, Python, Ruby and ECMA scripts.

Scripted parameters have access to the following variables:

  • client_id

  • client_name

  • client_reference

  • matter_name

  • matter_id

  • matter_reference

  • library_name

  • library_id

  • workflow_name

  • workflow_id

  • user_name

  • parameter_name

Scripted parameters also have access to all parameters above the scripted parameter defined in the Configure Parameters operation.
Workflows with Scripted Parameters requires a Security Policy with the Modify permission set on the Built-In scope Scripts.

Powershell scripts have access to the same variables except all variables are wrapped with curly brackets {}, additionally Powershell scripts have access to the variable {results_file} which is where the values generated from the script should be written to, where each allowed value is written on a separate line.

Scripted parameters may run more than once, as dependant parameters and parameters defined above the script change the script will update as needed.

Sample Powershell script:

## DEBUG
#Write-Output("Starting script to evaluate "+{parameter_name}+" - this will be logged to the Scheduler log")

$result = @()

# Sample Result
$result += "C:\\Temp\\Powershell"

# Sample result to confirm live execution
$date = Get-Date
$result += "C:\\Temp\\$date"

# Sample result containing client name
$result +=  "C:\\Client\\{client_name}"

## DEBUG
#Write-Output(result)

# Return the array
Set-Content -Path "{results_file}" -Value $result

Sample JavaScript script:

//// DEBUG
//print("Starting script to evaluate "+parameter_name+" - this will be logged to the Scheduler log")

var result = []

// Sample result
result.push("C:\\Temp\\JS")

// Sample result to confirm live execution
var today = new Date();
result.push("C:\\Temp\\"+today)

// Sample result containing client name
result.push("C:\\Client\\"+client_name)

//// DEBUG
//print (result)

// Return the array
result

Sample Python script:

import datetime

## DEBUG
#print("Starting script to evaluate "+parameter_name+" - this will be logged to the Scheduler log")

result=[]

# Sample result to confirm live execution
result.append('C:\\Temp\\Python')

# Sample result to confirm live execution
result.append('C:\\Temp\\'+str(datetime.datetime.now()))

# Sample result containing client name
result.append("C:\\Client\\"+client_name)

## DEBUG
#print("returning: "+str(result))

# The resulting list is expected in the variable named "result"

Sample Ruby script:

## DEBUG
#puts("Starting script to evaluate "+parameter_name+" - this will be logged to the Scheduler log")

result = []

# Sample result
result << "C:\\Temp\\Ruby"

# Sample result to confirm live execution
result << "C:\\Temp\\"+Time.now.strftime("%d/%m/%Y %H:%M:%s")

# Sample result containing client name
result << "C:\\Client\\"+client_name

## DEBUG
#puts(result)

# Return the array
result

5. Display Conditions

Display Conditions are used to define when a parameter should be presented to the user when submitting a Job.

The conditions can be defined based on the value of a previously defined parameter in the same Configuration operation.

6. Parameters Security

6.1. Accessible Parameters

By default, parameters are accessible throughout Rampiva Automate. This means that the parameter values can be stored in the audit logs, are retried when submitting a Job and can be used in any Job operation.

6.2. Protected Parameters

The values of Protected parameters can be set in the Configuration operation,

The values of Protected parameters can be set when queueing a Job, or in the Execution Profile. The values of the Protected Parameters are stored encrypted in the Automate database and can only be accessed by the Rampiva operations which have a password or key field.

6.3. Masked Parameters

Masked parameters have their values masked in the user interface, but can be retrieved by any operation.

These parameters can be used to capture sensitive information that should not be displayed back to the user, but that needs to be accessed in fields that are not designated as passwords, or in custom scripts.

7. Parameters Glossary

This section lists all system parameters used in Rampiva Automate.

The Scope column indicates the scope of the application to which the parameters apply. For example, parameters that are specific to certain operations, such as the Add Evidence operation, will indicate this operation in the scope, and parameters which are specific to a certain feature, will indicate the feature name in the scope.

The R/W column indicates if the parameter is read-only (R), or if it can be written to (W) to customize the behavior of the platform.

The search box can be used to search in any field of the table, including the parameter name and scope.
Parameter R/W Scope Description Example

{box_cycle_from}

W

Production Set Nuix

Specify a number for the box to cycle from

1

{box_cycle_to}

W

Production Set Nuix

Specify a number for the box to stop numbering at

9999

{box_start_at}

W

Production Set Nuix

Specify a number for the box to start numbering at

1

{brainspace_dataset_id}

R

Brainspace

The ID of the Brainspace Dataset

1

{brainspace_dataset_name}

R

Brainspace

The name of the Brainspace Dataset

Sample Dataset

{brainspace_version}

R

Brainspace

The Brainspace version

6.9

{broker_worker_count}

W

Nuix Workers

The number of workers to use from the worker broker

3

{call_api_response_body}

R

Call API

The API response body. This parameter is not exposed as a variable in the Script operation.

{call_api_response_code}

R

Call API

The API response code

200

{call_api_response_headers}

R

Call API

The API response headers, JSON encoded

{case_folder}

R

Case Nuix

The folder in which the Nuix case resides

C:\Cases\Globex vs. Initech

{case_name}

R

Case Nuix

The name of the case

Globex vs. Initech

{case_or_workspace_name}

R

Case Relativity

The last set value of the name of the case or the name of the Relativity workspace

Globex vs. Initech or Sample Workspace

{case_prefix}

R

Case Nuix

At most the first 5 alphabetic characters from the case name, to be used in document ID numbering schemes

GLOBE

{case_timezone_id}

W

Case Nuix

The timezone to use when opening cases. See Joda Time Zones for a list of valid timezone IDs

US/Eastern

{client_id}

R

Scheduler Job

The system ID of the client under which the job was submitted, if available

73e07af3-b31f-49a0-ae85-1dff0cc84876

{client_name}

R

Scheduler Job

The name of the client under which the job was submitted, if available

Internal

{client_reference}

R

Scheduler

The Client reference set using the API

custom-ref

{custodian_folder_level}

W

Assign Custodians

Specify the folder level from which custodian names should be extracted

3

{custodian_name}

W

Legal Hold

The name of the custodian

true

{custom_digest_size_metadata_field_name}

W

Workflow

Specify a custom metadata field which records the digest size of items to use instead of the regular digest size calculation

GUID

{data_locale_country}

W

Add Evidence Nuix

The source data locale country to use when adding evidence

CA

{data_locale_language}

W

Add Evidence Nuix

The source data locale language to use when adding evidence

fr

{data_timezone_id}

W

Add Evidence Nuix

The source timezone of the data to use when adding evidence. See Joda Time Zones for a list of valid timezone IDs

US/Eastern

{date_local}

R

Utility

The date in local format

12/31/17

{date_spreadsheet}

R

Utility

The date in spreadsheet format

2020-12-31

{date_time_epoch}

R

Utility

The current date and time at execution as epoch millis

1655755627516

{date_time_local}

R

Utility

The current date and time at execution, in local format as reported by Nuix

12/31/17 4:30 PM

{date_time_spreadsheet}

R

Utility

The date and time in spreadsheet format

2020-12-31 23:59:59

{date_time}

R

Utility

The current date and time at execution, formatted using YYYYMMDD-HHmmss

20171231-163000

{date}

R

Utility

The current date at execution, formatted using YYYYMMDD

20171231

{discover_case_id}

R

Discover

The ID of the Discover case

1

{discover_case_name}

R

Discover

The name of the Discover case

Sample Case

{discover_version}

R

Discover

The Discover version

10.0

{docid_digits}

W

Production Set Nuix

Specify a custom number of digits

7

{docid_family_digits}

W

Production Set Nuix

Specify a custom number of family digits

3

{docid_start_numbering_at}

W

Production Set Nuix

Specify a custom document ID start number

100000

{documentum_doc_base}

W

Add Evidence Nuix Documentum

This parameter specifies the Documentum docbase repository

{documentum_domain}

W

Add Evidence Nuix Documentum

This optional parameter defines the Windows networking domain of the server account

{documentum_password}

W

Add Evidence Nuix Documentum

The password needed to access the account

{documentum_port_number}

W

Add Evidence Nuix Documentum

The port number to connect on

{documentum_property_file}

W

Add Evidence Nuix Documentum

This optional parameter specifies the Documentum property file

{documentum_query}

W

Add Evidence Nuix Documentum

A DQL query. This optional parameter specifies a query used to filter the content

{documentum_server}

W

Add Evidence Nuix Documentum

This parameter specifies the Documentum server address

{documentum_username}

W

Add Evidence Nuix Documentum

The username needed to access the account

{dropbox_access_token_protected}

W

Add Evidence Nuix Dropbox

A string retrieved using the authCode that enables access to an account. If the access token to an account is already known, provide it directly using this parameter instead of {dropbox_auth_code_protected}. This code doesn’t expire unless the account owner revokes access

{dropbox_auth_code_protected}

W

Add Evidence Nuix null

A string retrieved via a webpage on Dropbox that enables access to an account

{dropbox_team_boolean}

W

Add Evidence Nuix Dropbox

A boolean that indicates that a Dropbox team will be added to evidence. This optional parameter should be present and set to true for all invocations when adding a Dropbox team to evidence. It can be omitted to add an individual Dropbox account

true

{es_version}

R

ElasticSearch

The version of the ElasticSearch cluster

8.5.0

{ev_archive}

W

Add Evidence Nuix Enterprise Vault

An archive ID. This optional parameter limits the evidence to the specified Enterprise Vault archive

{ev_computer}

W

Add Evidence Nuix Enterprise Vault

The hostname or IP address of Enterprise Vault

{ev_custodian}

W

Add Evidence Nuix Enterprise Vault

A name. This optional parameter limits the evidence to the specified custodian or author

{ev_flag}

W

Add Evidence Nuix Enterprise Vault

This option parameters specified the Enterprise Vault flag for the collection. Only one flag value must be specified.

any, all, allnear, phrase, begins, beginany, exact, exactany, ends, endsany

{ev_from_datetime}

W

Add Evidence Nuix Enterprise Vault

This optional parameter limits the evidence to a date range beginning from the specified date/time

{ev_keywords}

W

Add Evidence Nuix Enterprise Vault

This optional parameter limits the evidence to results matching Enterprise Vault’s query using the words in this string. Subject and message/document content are searched by Enterprise Vault and it will match any word in the string unless specified differently in the {ev_flag} parameter

{ev_to_datetime}

W

Add Evidence Nuix Enterprise Vault

This optional parameter limits the evidence to a date range ending at the specified date/time

{ev_vault}

W

Add Evidence Nuix Enterprise Vault

A vault store ID. This optional parameter limits the evidence to the specified Enterprise Vault vault

{exchange_domain}

W

Add Evidence Nuix Exchange

This optional parameter defines the Windows networking domain of the server account

{exchange_from_datetime}

W

Add Evidence Nuix Exchange

This optional parameter limits the evidence to a date range beginning from the specified date/time. It must be accompanied by the {exchange_to_datetime} parameter

{exchange_impersonating}

W

Add Evidence Nuix Exchange

Specify a value to instructs Exchange to impersonate the mailbox user instead of delegating when the mailbox and username are different

false

{exchange_mailbox_retrieval}

W

Add Evidence Nuix Exchange

The mailbox locations to add evidence from

mailbox, archive, purges, deletions, recoverable_items, archive_purges, archive_deletions, archive_recoverable_items, public_folders

{exchange_mailbox}

W

Add Evidence Nuix Exchange

The mailbox to ingest if it differs from the username

{exchange_password}

W

Add Evidence Nuix Exchange

The password needed to access the account

{exchange_to_datetime}

W

Add Evidence Nuix Exchange

This optional parameter limits the evidence to a date range ending at the specified date/time. It must be accompanied by the {exchange_from_datetime} parameter

{exchange_uri}

W

Add Evidence Nuix Exchange

The path to the Exchange Web Service

https://ex2010/ews/exchange.asmx

{exchange_username}

W

Add Evidence Nuix Exchange

The username needed to access the account

{export_production_set_name}

R

Production Set Nuix

The name of the production set being exported

Production 1

{filter_after_date}

W

Add Evidence Nuix

Set the after date filter to use when adding evidence

20151231-163000

{filter_before_date}

W

Add Evidence Nuix

Set the before date filter to use when adding evidence

20201231-163000

{first_case_folder}

R

Case Nuix

The folder in which the first Nuix used case resides

C:\Cases\Globex vs. Initech

{folder_cycle_from}

W

Production Set Nuix

Specify a number for the folder to cycle from

1

{folder_cycle_to}

W

Production Set Nuix

Specify a number for the folder to stop numbering at

9999

{folder_start_at}

W

Production Set Nuix

Specify a number for the folder to start numbering at

1

{group_document_pages}

W

Production Set Nuix

Sspecify if pages from the same document should be grouped

true

{group_family_items}

W

Production Set Nuix

Specify if documents from the same family should be grouped

true

{job_bearer_token_protected}

R

Call API Scheduler

The Bearer token that can be used to authenticate to Scheduler from a Job using the Call API operation. This token is valid while the Job is running and will authenticate the request as the user who last submitted the Job

job:090ada35-bd10-4aad-8d01-7d50d6b86519:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{job_engine_id}

R

Scheduler Job

The system ID of the engine that is running the job

b77e02e0-5f65-4544-8b9a-ae5c0cf25995

{job_engine_name}

R

Scheduler Job

The name of the engine that is running the job

ENGINE01

{job_execution_log}

R

Scheduler Job

The location of the job execution log

C:\Temp\GlobexWorkflow.log

{job_execution_profile_name}

R

Job

The name of the Execution Profile

Default

{job_id}

R

Scheduler Job

The system ID of the job

537c6863-ff33-4b49-803d-18516d6cf6c3

{job_name}

R

Scheduler Job

The name of the job

Global vs. Initech Processing Job

{job_notes}

R

Scheduler Job

The notes assigned to the job

Example notes

{job_priority}

R

Scheduler Job

The job priority

High

{job_resource_pool_id}

R

Scheduler Job

The system ID of the Resource Pool to which the job was assigned

3b5f15ef-4349-45a0-988a-15491028a5c7

{job_resource_pool_name}

R

Scheduler Job

The name of the Resource Pool to which the job was assigned

Local Resource Pool

{job_server_id}

R

Scheduler Job

The system ID of the server hosting the engine that is running the job

1b16c5eb-7d9c-47f8-a91a-3a08d04b4ff5

{job_server_name}

R

Scheduler Job

The name of the server hosting the engine that is running the job

SERVER01

{job_side_script_file}

W

Job

The path to a Job-Side Script file

C:\Scripts\jss.py

{job_submitted_by}

R

Scheduler Job

The name of the user who submitted the job

Job Admin

{job_submitted_date}

R

Scheduler Job

The time and date when the job was submitted

12/31/17 4:30 PM

{job_worker_broker_ip}

R

Job Nuix Workers

The IP of the Job worker broker

10.0.0.1

{job_worker_broker_port}

R

Job Nuix Workers

The port of the Job worker broker

1234

{keystore_file_alias_password}

W

Add Evidence Nuix

The password for the alias

{keystore_file_alias}

W

Add Evidence Nuix

The alias to use from the keystore

{keystore_file_password}

W

Add Evidence Nuix

The password of the keystore

{keystore_file_path}

W

Add Evidence Nuix

The path to the keystore

{keystore_file_target}

W

Add Evidence Nuix

The notes storage format file

{keystore_tsv}

W

Add Evidence Nuix

The file path to the keystore tsv file

{last_batch_load_date_time_local}

R

Add Evidence Nuix

The date and time of the last batch loaded into the case, in local format as reported by Nuix

12/31/17 4:30 PM

{last_batch_load_date_time}

R

Add Evidence Nuix

The date and time of the last batch loaded into the case

20171231-163000

{last_batch_load_date}

R

Add Evidence Nuix

The date of the last batch loaded into the case

20171231

{last_batch_load_guid}

R

Add Evidence Nuix

The GUID of the last batch loaded into the case

99fd2cc9ef564b498e28fb760d33ec83

{last_evidence_guid}

R

Add Evidence Nuix

The GUID of the last evidence loaded into the case

31d947842d994d33afb9cd0a0c7f6181

{last_evidence_name}

R

Add Evidence Nuix

The name of the last evidence loaded into the case. The actual name assigned to the evidence might be different than the one specified in the workflow, for example, if an evidence with the same name previously existed in the case

Evidence 1

{last_exit_code}

R

PowerShell External Application

The exit code of the external application.

0

{last_export_folder}

R

Legal Export Nuix

The folder of the last legal export

C:\Cases\Globex vs. Initech\Export\Production 20170101

{last_item_set_batch}

R

Item Set Nuix

The batch ID of the last item set to which items were added, including both original and duplicate items

item-set-batch:"ee4c…​d192;Emails and PDF"

{last_item_set_duplicates_batch}

R

Item Set Nuix

The duplicates batch ID of the last item set to which items were added

item-set-batch:"ee4c…​d192;duplicates;Emails and PDF"

{last_item_set_name}

R

Item Set Nuix

The name of the item set to which items were last added

Documents of interest

{last_item_set_originals_batch}

R

Item Set Nuix

The originals batch ID of the last item set to which items were added

item-set-batch:"ee4c…​d192;originals;Emails and PDF"

{last_metadata_export_file}

R

Metadata Nuix

The full file name and path of the last metadata export, from operations Generate Domain Fields, Generate Duplicate Custodians, Generate Duplicate Fields and Metadata Export

C:\Cases\Globex vs. Initech\Export\Metadata.csv

{last_overwritten_permissions_file}

R

Relativity

The location of the last overwritten permissions file

{last_production_set_name}

R

Production Set Nuix

The name of the last production set created in this workflow session. The actual name assigned to the production set might be different than the one specified in the workflow, for example, if frozen production set with the same name previously existed in the case

Documents of interest

{last_relativity_script_error}

R

Relativity

The description of error encountered during Relativity script execution. If no exception was encountered, this will be blank

{last_report_file}

R

Report Nuix

The full file name and path of the last report produced

C:\Cases\Globex vs. Initech\Reports\20170101 Processing Report.xlsx

{last_script_error}

R

Script

The description of error encountered during script execution. If no exception was encountered, this will be blank

{last_script_output}

R

Script

The text outputted by the script, for example using the print method. If no text was outputted by the script, this will be blank

{last_script_return_value}

R

Script

The string representation of the object returned by the script. If no object was returned, this will be null

{legal_hold_name}

W

Legal Hold

The name of the Legal Hold

{local_worker_count}

W

Nuix Workers

The number of local workers to use

2

{local_worker_memory}

W

Nuix Workers

The memory in MB for each worker to use

8000

{log_custom_digest_size_warnings}

W

Workflow

Set this parameter to true to log warning messages when items do not have the custom digest size metadata field. These warning messages will be logged for all items that are in the scope of the Processing Report operation, not just those for which the digest size was selected

true

{matter_id}

R

Scheduler Job

The system ID of the matter under which the job was submitted, if available

02544c7d-1dd8-41a2-8495-8e1c5b559bd3

{matter_name}

R

Scheduler Job

The name of the matter under which the job was submitted, if available

Globex vs. Initech

{metadata_profile}

W

Metadata Nuix

Specify a custom metadata profile for operations Legal Export, Metadata Export and Relativity Metadata Overlay

Context

{ms_graph_certificate_store_password}

W

Add Evidence Nuix Microsoft Graph

The password for the PKCS#12 certificate store, if present

{ms_graph_certificate_store_path}

W

Add Evidence Nuix Microsoft Graph

The path to a PKCS#12 certificate store, to use instead of the client secret, for authentication

{ms_graph_client_secret_protected}

W

Add Evidence Nuix Microsoft Graph

The client secret that has been configured for the client ID provided, for authentication

{ms_graph_client_id}

W

Add Evidence Nuix Microsoft Graph

The client/application ID for the app that has been registered with Azure AD which and granted the necessary privileges

{ms_graph_end_datetime}

W

Add Evidence Nuix Microsoft Graph

The end of the collection date range

{ms_graph_mailbox_retrievals}

W

Add Evidence Nuix Microsoft Graph

The locations to retrieve mailbox data from

MAILBOX, ARCHIVE, PURGES, DELETIONS, RECOVERABLE_ITEMS, ARCHIVE_PURGES, ARCHIVE_DELETIONS, ARCHIVE_RECOVERABLE_ITEMS, PUBLIC_FOLDERS

{ms_graph_password}

W

Add Evidence Nuix Microsoft Graph

The password for the username, if it is present

{ms_graph_retrievals}

W

Add Evidence Nuix Microsoft Graph

The type of data to retrieve

TEAMS_CHANNELS, TEAMS_CALENDARS, USERS_CHATS, USERS_CONTACTS, USERS_CALENDARS, USERS_EMAILS, ORG_CONTACTS, SHAREPOINT

{ms_graph_start_datetime}

W

Add Evidence Nuix Microsoft Graph

The beginning of the collection date range

{ms_graph_team_names}

W

Add Evidence Nuix Microsoft Graph

Optionally, a list of team names to filter on

{ms_graph_tenant_id}

W

Add Evidence Nuix Microsoft Graph

The tenant ID for Azure AD

{ms_graph_user_principal_names}

W

Add Evidence Nuix Microsoft Graph

Optionally, a list of user principal names to filter on

{ms_graph_username}

W

Add Evidence Nuix Microsoft Graph

Optionally, the username for a user that is a member of the Teams to be processed, only needed for ingesting Team Calendars

{ms_graph_version_limit}

W

Add Evidence Nuix Microsoft Graph

Optionally, an integer limiting the number of versions retrieved if version retrievel is enabled. Defaults to -1 which retrieves all versions available

{ms_graph_version_retrieval}

W

Add Evidence Nuix Microsoft Graph

Optionally, a boolean indicating of all versions should be retrieved. Defaults to false

{notice_subject}

W

Legal Hold

The subject of the Notice

Sample Notification

{operation_position}

R

Workflow

The position of the operation in the workflow

3

{oracle_database}

W

Add Evidence Nuix null

A string representation of the connection params

{oracle_driver_type}

W

Add Evidence Nuix null

The driver type used to connect. Can be thin, oci, or kprb

{oracle_max_rows_per_table}

W

Add Evidence Nuix null

The maximum number of rows to return from each table or query. This parameter is optional. It can save time when processing tables or query results with very many rows. The selection of which rows will be returned should be considered arbitrary

{oracle_password}

W

Add Evidence Nuix null

The password needed to access the account

{oracle_query}

W

Add Evidence Nuix null

A SQL query. This parameter specifies a query used to filter the content

{oracle_role}

W

Add Evidence Nuix null

The role to login as. For normal logins, this should be blank

SYSDBA or SYSOPER

{oracle_username}

W

Add Evidence Nuix null

The username needed to access the account

{original_notice_respond_by_date}

W

Legal Hold

The respond-by date of the original Notification, to use in reminder or escalations

{original_notice_sent_date}

W

Legal Hold

The sent date of the original Notification, to use in reminder or escalations

{original_notice_subject}

W

Legal Hold

The subject of the original Notification, to use in reminder or escalations

{page_cycle_from}

W

Production Set Nuix

Specify a number for the page to cycle from

1

{page_cycle_to}

W

Production Set Nuix

Specify a number for the page to stop numbering at

9999

{page_start_at}

W

Production Set Nuix

Specify a number for the page to start numbering at

1

{powershell_parameters}

R

PowerShell

The folder to use in PowerShell scripts to write parameters values

{previous_case_folder}

R

Case Nuix

The folder in which the previously used Nuix case resides

C:\Cases\Globex vs. Initech

{processing_init_timeout_minutes}

W

Nuix Add Evidence

Specify a custom timeout for the initialization of the Add Evidence. A value of 0 disabled the initialization timeout mechanism

120

{processing_profile_name}

R

Add Evidence Nuix

Specify a custom processing profile

Internal Processing

{rampiva_logo_html}

R

Utility

HTML image tag showing the Rampiva logo

{random_guid}

R

Utility

A randomly generated GUID

090ada35-bd10-4aad-8d01-7d50d6b86519

{relativity_call_api_response_body}

R

Relativity

The Relativity API response body. This parameter is not exposed as a variable in the Script operation.

{relativity_call_api_response_code}

R

Relativity

The relativity API response code

200

{relativity_call_api_response_headers}

R

Relativity

The relativity API response headers, JSON encoded

{relativity_client_created}

R

Relativity

Indicates if a client was created in the Set Relativity Client operation

true

{relativity_client_id}

R

Relativity

The artifact ID of the client used in the Set Relativity Client operation

107658

{relativity_client_name}

R

Relativity

The name of the client used in the Set Relativity Client operation

Simple Client

{relativity_matter_created}

R

Relativity

Indicates if a matter was created in the Set Relativity Matter operation

true

{relativity_matter_id}

R

Relativity

The artifact ID of the matter used in the Set Relativity Matter operation

107658

{relativity_matter_name}

R

Relativity

The name of the matter used in the Set Relativity Matter operation

Simple Matter

{relativity_native_copy_mode}

W

Legal Export Relativity

Specify the Relativity native copy mode

SetFileLinks

{relativity_overwrite_mode}

W

Legal Export Relativity

Specify a the Relativity overwrite mode for the Legal Export, Relativity Loadfile Upload and Relativity Metadata Overlay operations

Append, Overlay or AppendOverlay

{relativity_workspace_created}

R

Relativity

Indicates if a workspace was created in the Set Relativity Workspace operation

true

{relativity_workspace_id}

R

Relativity

The artifact ID of the workspace used in the Set Relativity Workspace operation

107658

{relativity_workspace_name}

R

Relativity

The name of the workspace used in the Set Relativity Workspace operation

Simple Workspace

{report_password}

W

Report Nuix

Specify the password to lock the Excel report files with

Password1234

{s3_access}

W

Add Evidence Nuix S3

This parameter specifies the access key ID for an Amazon Web Service account

{s3_bucket}

W

Add Evidence Nuix S3

This optional parameter specifies a bucket and optionally a path to a folder within the bucket that contains the evidence to ingest. Omitting this parameter will cause all buckets to be added to evidence

mybucketname/top folder/sub folder

{s3_credential_discovery_boolean}

W

Add Evidence Nuix S3

This optional parameter is only valid when access and secret are not specified. A true value allows credential discovery by system property. A false or omitted alue will attempt anonymous access to the specified bucket

{s3_endpoint}

W

Add Evidence Nuix S3

This optional parameter specifies a particular Amazon Web Service server endpoint. This can be used to connect to a particular regional server

https://s3.amazonaws.com

{s3_secret_protected}

W

Add Evidence Nuix S3

This parameter specifies the secret access key for an Amazon Web Service account

{scheduler_url}

R

Call API Scheduler

The URL used to access Scheduler. This value is defined in the Execution Profile

https://automate.example.com

{sent_date}

W

Legal Hold

The date of the Notification

{server_fqdn}

R

Scheduler

The fully qualified domain name (FQDN) of the server running the workflow

Server1.company.local

{server_name}

R

Scheduler

The name of the server running the job

Server1

{set_custodian_from_typical_folder_name}

W

Assign Custodians

Specify whether to assign custodian names from folder names with typical custodian names

true

{set_custodian_from_folder_name}

W

Assign Custodians

Specify whether to assign custodian names from folder names

true

{set_custodian_from_pst}

W

Assign Custodians

Specify whether to assign custodian names from the PST file information

true

{sharepoint_domain}

W

Add Evidence Nuix Sharepoint

This optional parameter defines the Windows networking domain of the server account

{sharepoint_password}

W

Add Evidence Nuix Sharepoint

The password needed to access the account

{sharepoint_uri}

W

Add Evidence Nuix Sharepoint

A URI specifying the site address

{sharepoint_username}

W

Add Evidence Nuix Sharepoint

The username needed to access the account

{simple_style_html}

R

Utility

Simple HTML style code for the workflow progress table

{sql_connection_string}

W

SQL

The SQL connection string to use for overwriting the default behavior of the SQL-related operations

{sql_server_computer}

W

Add Evidence Nuix SQL

The hostname or IP address of the SQL Server

{sql_server_domain}

W

Add Evidence Nuix SQL

This optional parameter defines the Windows networking domain of the server account

{sql_server_instance}

W

Add Evidence Nuix SQL

A SQL Server instance name

{sql_server_max_rows_per_table_number}

W

Add Evidence Nuix SQL

The maximum number of rows to return from each table or query. This parameter is optional. It can save time when processing tables or query results with very many rows. The selection of which rows will be returned should be considered arbitrary

{sql_server_password}

W

Add Evidence Nuix SQL

The password needed to access the account

{sql_server_query}

W

Add Evidence Nuix SQL

A SQL query. This optional parameter specifies a query used to filter the content

{sql_server_username}

W

Add Evidence Nuix SQL

The username needed to access the account

{ssh_accessing_remote_disks_boolean}

W

Add Evidence Nuix SSH

A boolean. When set to true, remote disks (e.g. /dev/sda1) will be exposes as evidence instead of the remote systems file system structure

{ssh_computer}

W

Add Evidence Nuix SSH

The hostname or IP address of Enterprise Vault

{ssh_host_fingerprint}

W

Add Evidence Nuix SSH

The expected host fingerprint for the host being connected to. If this value is not set then any host fingerpint will be allowed, leaving the possibility of a man in the middle attack on the connection

{ssh_key_folder}

W

Add Evidence Nuix SSH

Points to a folder on the local system which holds the SSH authentication key pairs

{ssh_password}

W

Add Evidence Nuix SSH

The password needed to access the account

{ssh_port_number}

W

Add Evidence Nuix SSH

The port number to connect on

{ssh_remote_folder}

W

Add Evidence Nuix SSH

A folder on the SSH host to start traversing from. This optional parameter limits the evidence to items underneath this starting folder

{ssh_sudo_password}

W

Add Evidence Nuix SSH

The password needed to access protected files when using SSH key based authentication

{ssh_username}

W

Add Evidence Nuix SSH

The username needed to access the account

{start_date_local}

R

Utility

The start date in local format

12/31/17

{start_date_spreadsheet}

R

Utility

The start date in spreadsheet format

2020-12-31

{start_date_time_epoch}

R

Utility

The start date and time as epoch millis

1655755627516

{start_date_time_local}

R

Utility

The start date and time, in local format as reported by Nuix

12/31/17 4:30 PM

{start_date_time}

R

Utility

The start date and time, formatted using YYYYMMDD-HHmmss

20171231-163000

{start_date}

R

Utility

The start date, formatted using YYYYMMDD

20171231

{start_time_spreadsheet}

R

Utility

The start time in spreadsheet format

23:59:59

{start_time}

R

Utility

The start time

4:30 PM

{time_spreadsheet}

R

Utility

The time in spreadsheet format

23:59:59

{time}

R

Utility

The time

4:30 PM

{twitter_access_token_secret_protected}

W

Add Evidence Nuix Twitter

The access token secret of the Twitter app

{twitter_access_token}

W

Add Evidence Nuix Twitter

A string retrieved using the authCode that enables access to an account. A new app can be created at https://apps.twitter.com to generate this token

{twitter_consumer_secret_protected}

W

Add Evidence Nuix Twitter

The consumer secret (API secret) of the Twitter app

{twitter_consumer_key}

W

Add Evidence Nuix Twitter

The consumer key (API key) of the Twitter app

{webhook_body}

R

Webhook

The body of the Webhook call that triggered the Scheduled Job

{"custom_data":"1234"}

{webhook_headers}

R

Webhook

The headers of the Webhook call

{"Accept":"/","User-Agent":"Zapier","Content-Type":"application/json"}

{webhook_schedule_id}

R

Webhook

The ID of the Schedule that triggered the job

c2b64747-505d-4719-bb5f-75bbd8a63774

{webhook_schedule_name}

R

Webhook

The name of the Schedule that triggered the job

Sample Workflow

{workflow_log}

R

Workflow Job

Text indicating the status of each workflow operation, up to the current point of execution. This parameter is not exposed as a variable in the Script operation.

{workflow_name}

R

Workflow

The name of the workflow

Standard Processing

{workflow_state}

R

Workflow Job

The execution state of the workflow or of the job

Running

{workflow_status_html}

R

Workflow Job

HTML table showing an overview of the workflow progress, up to the current point of execution. This parameter is not exposed as a variable in the Script operation.

{workflow_status}

R

Workflow Job

Tab-separated text table showing an overview of the workflow progress, up to the current point of execution. This parameter is not exposed as a variable in the Script operation.