Automate - Workflow Design Guide

Source storage container URL: The URL of the source storage container.

Source storage account SAS token: The SAS access token of the source container. To create a token, see https://learn.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers.

Destination storage container URL: The URL of the destination storage container.

Destination storage account SAS token: The SAS access token of the Destination container.

Command-line flags: Optionally, additional command-line flags for the AzCopy command.

Storage container URL: The URL of the storage container.

Storage account SAS token: The SAS access token. To create a token, see https://learn.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers.

Download location: The folder to download the data to.

Brainspace API URL: The URL to of the Brainspace environment, for example https://app.brainslace.local

Certificate fingerprint: Optional, the SHA-256 fingerprint of the Brainspace app server certificate that should be trusted even if the certificate is self-signed.

API key: The API key. This value can be obtained from the Brainspace Administration page → Connectors → API Authentication.

Dataset identifier:

Existing dataset: The action to take if the case does not exist:

Clone settings: The settings to use when cloning a dataset.

Scope query: The Nuix query to select the items to load into Brainspace.

Export standard metadata: Export items standard metadata to Brainspace.

Export custom metadata from profile: Optional, the metadata profile to use for additional metadata to export to Brainspace. When using this option, a Custom field mapping file must be provided.

Custom fields mapping file: The JSON mapping file defining the mapping of the custom metadata profile to Brainspace.

Export DocIDs from production set: If checked, the name of the production set to export the DocID numbers from.

Trim body text at: if checked, the size in characters after which the body text of items is trimmed before loading to Brainspace.

Wait for previous build to complete: Waits for a build that was running at the operation start to complete.

Build dataset: Triggers a build of the dataset.

Wait for build to complete: Waits for the build triggered by this operation to complete.

Scope query: The query to retrieve the Nuix items for which to propagate tags.

Nuix root tag: The name of the Nuix root tag.

Nuix scope query: The Nuix query to select the items to update.

Brainspace scope:

Tag matching items: The tag to apply to the Nuix items that were matched to Brainspace items.

Retrieve Brainspace tags: Select whether to retrieve the tags assigned to items in Brainspace, and what prefix to use when applying the tags to the matching Nuix items.

Retrieve Brainspace classifier scores: Select whether to the values of Brainspace fields corresponding to classifiers. These fields are identified as having a numeric type and the word score in their name.

Retrieve Brainspace fields: Select whether to retrieve metadata fields from Brainspace to be assigned as custom metadata to the Nuix items, and which Brainspace fields to retrieve.

Gen AI service ID: The ID of the Gen AI service, {gen_ai_service_id}

Override model: If set, the model configured on the Gen AI service will be overridden with the value set below.

Model: If Override model is set, the model to use for subsequent Gen AI operations.

Scope query: The Nuix query to select the items for which the size in tokens will be estimated.

Run on a sample of: The sample size to run the analysis on.

Content location:

Results metadata field: Store the prompt tokens count as custom metadata

Create metadata profile: If set, a metadata profile will be created in the case with the field reporting the tokens count.

Tag analyzed items as: The tag to apply to items analyzed.

Tag failed items as: The tag to apply to items that failed.

GenAI|System|Model: The model that was used for the last analysis, if applicable.

GenAI|System|Service: The hostname of the service that was used for the last analysis.

GenAI|System|Warning: The warning that was encountered during the last analysis, if any.

GenAI|System|Error: The error that was encountered during the last analysis, if any.

Scope query: The Nuix query to select the items for analysis with Gen AI.

Run on a sample of: The sample size to run the analysis on.

Content location:

Sanitize content before prompting: If set, the content will be searched for the regex patterns listed. The matched patter will be replaced with the replacement string provided. The expression $1 can be used to reference the first matched group.

Context prompt: The prompt with which to initialize the Gen AI analysis.

Document prompt: The document prompt to send to the Gen AI service. The parameter {item_text} will be replaced with the content of the item.

Split content with separator: The separator to use when splitting the document to fit within the token limits.

Extraction prompt: The prompt with instructions on how to extract the entities.

Clean up prompt responses: If set, the prompt responses will be searched for the regex patterns listed and the matched text will be replaced.

Output JSON schema: Request the prompt response to follow the specified JSON schema. NOTE: Not all Gen AI services and models support JSON schemas.

Temperature: The temperature setting, from 0 to 1, to set to the Gen AI service.

Max response tokens: The maximum number of tokens to accept in the response for each prompt.

Results location:

Create metadata profile: If set, a metadata profile will be created in the case with the fields corresponding to the entity names extracted.

Tag analyzed items as: The tag to apply to items analyzed.

Tag failed items as: The tag to apply to items that failed.

GenAI|System|Model: The model that was used for the last analysis, if applicable.

GenAI|System|Service: The hostname of the service that was used for the last analysis.

GenAI|System|Warning: The warning that was encountered during the last analysis, if any.

GenAI|System|Error: The error that was encountered during the last analysis, if any.

Scope query: The Nuix query to select the items for analysis with Gen AI.

Run on a sample of: The sample size to run the analysis on.

Content location:

Sanitize content before prompting: If set, the content will be searched for the regex patterns listed. The matched patter will be replaced with the replacement string provided. The expression $1 can be used to reference the first matched group.

Context prompt: The prompt with which to initialize the Gen AI analysis.

Document prompt: The document prompt to send to the Gen AI service. The parameter {item_text} will be replaced with the content of the item. The parameter {doc_id} will be replaced with the item DocID.

Split content with separator: The separator to use when splitting the document to fit within the token limits.

Prompt in parts when content exceeds max prompt tokens: If set, a separate prompt is run for each part. If not set, a prompt is run on the first part only and a warning is recorded.

Keep responses from individual batches: If set, the responses from each part of the document will be stored as custom metadata field, with the name GenAI|name|Level x|Part y where name is the name of the prompt, x is the recursion level and y is the part number.

Context prompt for prompt responses: THe prompt with which to initialize the Gen AI analysis when prompting on the responses the previous level.

Content prompt for part responses: The prompt in which to send each response from the previous level.

Question prompts: The question prompts to send to the Gen AI service, with the following settings:

Clean up prompt responses: If set, the prompt responses will be searched for the regex patterns listed and the matched text will be replaced.

Parse JSON output: If set, the prompt responses will be parsed as a JSON dictionary and the resulting keys and values will be stored in nested custom metadata fields. If the data cannot be parsed as JSON, the response will be stored as a string in the custom metadata field. Dates will be parsed if they are in the ISO 8601 format, for example 2023-12-31T12:00:00Z, or in the yyyy-MM-dd format, for example 2023-12-31

Output JSON schema: Request the prompt response to follow the specified JSON schema. NOTE: Not all Gen AI services and models support JSON schemas.

Use follow-up prompts: The follow-up prompts to send to the Gen AI service following each question prompt. This option is only available when not prompting in parts.

Only run follow-up prompts if response matches regex: For each response, the follow-up prompts will only be run if the response matches the regex pattern.

Clean up follow-up prompt responses: If set, the follow-up prompt responses will be searched for the regex patterns listed and the matched text will be replaced.

Temperature: The temperature setting, from 0 to 1, to set to the Gen AI service.

Max response tokens: The maximum number of tokens to accept in the response for each prompt.

Create metadata profile: If set, a metadata profile will be created in the case with the fields corresponding to the prompt and follow-up prompt responses.

Tag analyzed items as: The tag to apply to items analyzed.

Tag failed items as: The tag to apply to items that failed.

GenAI|System|Model: The model that was used for the last analysis, if applicable.

GenAI|System|Service: The hostname of the service that was used for the last analysis.

GenAI|System|Warning: The warning that was encountered during the last analysis, if any.

GenAI|System|Error: The error that was encountered during the last analysis, if any.

Scope query: The Nuix query to select the items for analysis with Gen AI.

Run on a sample of: The sample size to run the analysis on.

Content location:

Sanitize content before prompting: If set, the content will be searched for the regex patterns listed. The matched patter will be replaced with the replacement string provided. The expression $1 can be used to reference the first matched group.

Context prompt: A system prompt used to initialize the Gen AI analysis.

Document prompt: The prompt for each document. The parameter {item_text} will be replaced with the content of the item. The parameter {doc_id} will be replaced with the item DocID.

Use different settings for recursive prompts: If set, when prompting recursively on the responses from the previous level, the settings for the recursive prompts will be used instead of the settings for the main prompt.

Context prompt for recursive responses: A system prompt used to initialize the Gen AI analysis for recursive prompts.

Content prompt for recursive responses: The prompt for each answer from the previous level. The parameter {answer_text} will be replaced with the content of each the answer.

Question prompts: The question prompts to send to the Gen AI service.

Prompt options:

Output options:

Parse JSON output: If set, the prompt responses will be parsed as a JSON dictionary and the resulting keys and values will be stored in nested custom metadata fields. If the data cannot be parsed as JSON, the response will be stored as a string in the custom metadata field. Dates will be parsed if they are in the ISO 8601 format, for example 2023-12-31T12:00:00Z, or in the yyyy-MM-dd format, for example 2023-12-31

Create metadata profile: If set, a metadata profile will be created in the case with the fields corresponding to the prompt.

Tag analyzed items as: The tag to apply to items analyzed.

Tag failed items as: The tag to apply to items that failed.

GenAI|System|Model: The model that was used for the last analysis, if applicable.

GenAI|System|Service: The hostname of the service that was used for the last analysis.

Scope query: The Nuix query to select the items for transcription with Gen AI.

Run on a sample of: The sample size to run the transcription on.

Context prompt: The prompt with which to initialize the Gen AI transcription.

Question prompts: The question prompts to send to the Gen AI service. For each question, the Gen AI service will be sent the context prompt (if any), followed by the image and the question prompt. Each question prompt will be sent to the Gen AI service independently of the other question prompts.

Parse JSON output: If set, the prompt responses will be parsed as a JSON dictionary and the resulting keys and values will be stored in nested custom metadata fields. If the data cannot be parsed as JSON, the response will be stored as a string in the custom metadata field. Dates will be parsed if they are in the ISO 8601 format, for example 2023-12-31T12:00:00Z, or in the yyyy-MM-dd format, for example 2023-12-31

Output JSON schema: Request the prompt response to follow the specified JSON schema. NOTE: Not all Gen AI services and models support JSON schemas.

Temperature: The temperature setting, from 0 to 1, to set to the Gen AI service.

Max response tokens: The maximum number of tokens to accept in the response for each prompt.

Printing options:

Multi-page options:

Tag analyzed items as: The tag to apply to items analyzed.

Tag failed items as: The tag to apply to items that failed.

GenAI|System|Model: The model that was used for the last analysis, if applicable.

GenAI|System|Service: The hostname of the service that was used for the last analysis.

GenAI|System|Warning: The warning that was encountered during the last analysis, if any.

GenAI|System|Error: The error that was encountered during the last analysis, if any.

Scope query: The Nuix query to select the items for transcription with Gen AI.

Run on a sample of: The sample size to run the transcription on.

Results location:

Context prompt: The prompt with which to initialize the Gen AI transcription.

Transcription prompt: The transcription prompt instructions.

Temperature: The temperature setting, from 0 to 1, to set to the Gen AI service.

Max response tokens: The maximum number of tokens to accept in the response for each prompt.

Printing options:

Multi-page options:

Tag analyzed items as: The tag to apply to items analyzed.

Tag failed items as: The tag to apply to items that failed.

GenAI|System|Model: The model that was used for the last analysis, if applicable.

GenAI|System|Service: The hostname of the service that was used for the last analysis.

GenAI|System|Warning: The warning that was encountered during the last analysis, if any.

GenAI|System|Error: The error that was encountered during the last analysis, if any.

Source image files folder: The folder containing the image files to be OCRed.

Scan folder recursively: If set, the source folder will be scanned recursively, and the output files will be created using the same folder structure.

Skip images with existing non-empty text files: If set, images will be skipped if a text file with the expected name and a size greater than 0 exists in the destination folder.

Assemble pages regex: The regular expression to use to detect documents with multiple pages, which were exported with one image file per page. The regex must have at least one matching group which is used to select the document base name.

Output text files folder: The folder in which the text files will be created.

Keep incomplete files: If set, empty files and incomplete text files from the OCR Engine are not deleted.

Context prompt: The prompt with which to initialize the Gen AI transcription.

Host: The ElasticSearch host name, for example es.example.com, or 127.0.0.1.

Host: The port on which the ElasticSearch REST API is deployed, by default 9200.

Username: The username to authenticate with.

Password: The password for the username above.

Certificate fingerprint: Optional, the SHA-256 fingerprint of the ElasticSearch certificate that should be trusted even if the certificate is self-signed.

Bulk operations: The number of operations to submit in bulk to ElasticSearch. Using a higher value can increase throughout but requires more memory.

Scope query: The Nuix query to select the items to export to ElasticSearch.

Metadata profile: The Nuix metadata profile used during the export.

Index name: The ElasticSearch index name.

Export items text: If selected, the operation will export the item text in addition to the metadata. The text is exported in ElasticSearch under the item property _doc_text.

Trim item text at: The maximum number of characters to export from the item text. If the item text is trimmed, the ElasticSearch property _doc_text_trimmed is set on the item.

Case identifier: The Name or ID of the Purview case.

Create case if it does not exist create a new case, with the following settings

Close: Closes the case.

Close and Delete: Closes the case and attemps to delete it.

Reopen: Opens a previously closed case.

Custodians: All custodians from the case.

Custodial data sources: All custodial data sources from the case.

Non-custodial data sources: All non-custodial data sources from the case.

Data sources file: A file containing the list of data sources to add.

Data sources: A table with the data sources to add.

Data sources file: A file containing the list of data sources to add.

Data sources: A table with the data sources to add.

All case custodians: Apply the hold to all custodians in the selected Purview case.

Custodians file: A file containing the list of custodians to apply the hold to.

Custodian IDs JSON: A JSON formatted list of Purview custodian IDs.

Wait for completion: Waits until the hold was applied.

All case non-custodial data sources: Apply the hold to all non-custodial data sources in the selected Purview case.

Non-custodial data sources file: A file containing the list of non-custodial data sources to apply the hold to.

Non-custodial data sources IDs JSON: A JSON formatted list of Purview non-custodial data sources IDs.

Wait for completion: Waits until the hold was applied.

Purview export folder: The folder where the Purview data was downloaded to.

Resulting NLI location: The location of the resulting NLI.

Advanced options: Settings used to identify the Purview CDS loadfiles and Column names used to extract metadata from items.

Reduce noise items: This option reduces noise items from extensions provided in the field Noise extensions.

The Original_file_extension is in the Noise extensions list

The Native_extension is different then Original_file_extension

The Input_path ends in Original_file_extension

The Compound_path starts with Input_path and is followed by a suffix (ex: ../Presentation.pptx/slide25.xml.rels)

Purview export folder: The folder where the Purview data was downloaded to.

Resulting NLI location: The location of the resulting NLI.

Export options: Settings used to identify the Purview CDS loadfiles

Item options: Column names used to extract metadata from general items.

Conversation options: Column names used to extract metadata from conversations.

Loadfile: The CSV loadfile to be converted.

Resulting NLI: The location of the resulting NLI file.

DocID column: The name of the column containing the document ID, or a unique identifier for each item.

Family ID column: Optional, the name of the column containing the family ID.

Path column: Optional, the name of the column containing the path of the document, excluding the document name.

Name column: Optional, the name of the column containing the name of the document.

Native file column: Optional, the name of the column containing the path to the native file.

Custodian column: Optional, the name of the column containing the custodian associated with the document.

MD5 column: Optional, the name of the column containing the document MD5.

Load all fields: Select this option to convert all columns from the loadfile to metadata fields in the NLI.

Fields metadata prefix: Optional, the prefix to use for metadata fields in the NLI.

Source location: The folder to be packaged.

Resulting NLI location: The location of the resulting NLI.

Matter identifier: The ID, Name, or Name (Regex) of the Vault matter.

Matter state filter: The required state of the Vault matter.

Create matter if it does not exist: If the matter does not exist with the required state filter, creates a new matter with the following settings:

Close: Closes the matter.

Delete: Deletes the matter.

Reopen: Reopens the matter.

Undelete: Undeletes the matter.

Query name prefix: The prefix used in the name for the saved queries.

Data scope: The scope of data for the saved queries.

Use date range: Set a date range to filter the data covered by the saved queries with the following settings:

Query locations and terms:

Export name prefix: The prefix used in the name for the exports.

Region: The requested data region for the exports.

Message format: The file format for exported messages.

Mail options:

Drive options:

Saved query identifier type: The type of the identifiers.

Saved query identifiers: The identifiers used to find the saved queries.

Wait for completion: Wait for exports to complete.

Download location: The folder to download the exports to.

Explicitly include linked exports: Download linked exports.

Export identifier type: The type of the identifiers.

Export identifiers: The identifiers used to find the exports.

Explicitly include linked exports: Include linked exports.

Wait for completion: Wait for exports to complete.

Export identifier type: The type of the identifiers.

Export identifiers: The identifiers used to find the exports.

Hold name prefix: The prefix used in the name for the holds.

Mail/Groups options:

Drive/Chat options:

Hold locations and terms:

All hold locations: Remove all hold locations.

Hold locations file: A file containing the list of hold location values to remove.

Hold locations: A table with the hold location values to remove.

Remove from all holds: Remove the specified locations from all holds.

Hold identifier type: The type of the identifiers.

Hold identifiers: The identifiers used to find the holds.

Discover hostname: The hostname of the Nuix Discover API, for example ringtail.us.nuix.com

API token: The API token to connect with. This token can be obtained from the Nuix Discover User Administration page → Users → username → API Access.

Case identifier:

File repository: The type of repository to use for uploading native files. For local Nuix Discover deployments set to the Windows File Share location corresponding to the imports folder of the Nuix Discover case. For SaaS deployments, use the Amazon S3 repository.

Existing case: The action to take if the case does not exist:

Wait for case to be active: Waits for the specified time for the case to become active.

Clone settings: The settings to use when cloning a case.

Production set name: The name of the production set to promote to Nuix Discover.

Export standard metadata: Export items standard metadata to Nuix Discover. If checked, a copy of the metadata profile will be saved in the export folder.

Export custom metadata from profile: Optional, the metadata profile to use for additional metadata to export to Nuix Discover. To use this option, ensure that the Nuix Discover case is configured with the fields that are defined in the custom metadata profile.

Run indexing in Nuix Discover: Triggers an indexing in Nuix Discover after the documents are uploaded.

Run deduplication in Nuix Discover: Triggers a deduplication in Nuix Discover after the documents are uploaded.

Document ID strategy: Assign new Sequential document numbers from the Nuix Discover case, or use the Nuix Production set numbering.

Level: The Nuix Discover level to import documents to.

Documents per level: The maximum number of documents per level.

Filetypes: Select the components to uploadto the Nuix Discover case:

Temporary export folder: The folder where which the temporary legal export is created. After the upload is complete, the native and text files are deleted from the temporary folder.

Split export at: Break down the export and uploads into multiple part of the maximum number of items specified.

Wait for Nuix Discover job to finish: Waits until the items have been loaded into Nuix Discover before moving to the next upload part or before finishing the operation.

Nuix scope query: The Nuix query to select the items to update.

Tag Matching Items: Tags items that exist in Nuix Discover and in the Nuix case

Retrieve Fields: Retrieves fields from Nuix Discover and applies it to a matching item in the Nuix case as custom metadata

Tag Matching Items and Retrieve Fields: Performs both of the actions above

All Documents: All documents within the Nuix Discover case

Saved Search: Items that match a saved search

Production: Items in a production

Binder: Items in a binder

Hostname: The hostname of the Nuix ECC instance

Endpoint type: The Nuix ECC Endpoint Type, for example HTTPS.

Username: The username used to connect to the Nuix ECC instance.

Password: The password for the username above.

Case identifier: The Name, ID or Name (Regex) of the Nuix ECC case

Create case if it does not exist: Optionally, create a new Nuix ECC case if the one specified does not exist.

Configuration identifier: The Name, ID or Name (Regex) of the Nuix ECC Collection configuration

Collection sources: The sources to collect from:

Service account username: The username of the service account used to run commands on computers

Service account password: The password of the service account used to run commands on computers

Computer names: The names of computers to deploy ECC agents on, for example DESKTOP-AZH1K4

Install command: the command used to install the ECC agent on a computer

Retry command on failure: Retries the install command if it failed to run the first time, the user also has the option to set how many times they would like to retry to command

Timeout: The amount of time given for the agent to deploy and be visible on Nuix ECC Admin console.

Collection name: The name of the Nuix ECC Collection

Wait for collection to finish: Optionally, waits for the Nuix ECC Collection to finish before moving onto the next operation.

Collection location: The location where collected files will be stored. This location must be available to all computers.

Service account username: The username of the service account used to run commands on computers

Service account password: The password of the service account used to run commands on computers

Computer names: The names of computers to remove ECC agents on, for example DESKTOP-AZH1K4

Uninstall command: the command used to uninstall the ECC agent on a computer

Retry command on failure: Retries the uninstall command if it failed to run the first time, the user also has the option to set how many times they would like to retry to command

Timeout: The amount of time given for the agent to be removed

Path item: Adds the file or folder as an evidence container.

Path contents: Adds the contents of the folder as an evidence container.

Path contents as separate evidence: Create separate evidence containers for each file or subfolder in the base folder.

Loadfile: Adds the contents of a Concordance, CSV or EDRM XML 1.2 loadfile as an evidence container.

Evidence listing: Creates an evidence container for each line in the listing. See Add Evidence from Evidence listing.

Google Vault Export: Creates an evidence container for each Google Vault Export and adds Drive Link Export files as child items. See Add Evidence from Google Vault Exports.

Data set: Adds the contents of the Data set as an evidence container. See Add Evidence from Data Set.

Microsoft Graph: Adds Teams, Calendar, Contacts, Sharepoint data to an evidence container using Microsoft Graph. See Add Evidence from Microsoft Graph.

SharePoint: Adds SharePoint data to an evidence container. See Add Evidence from SharePoint.

Exchange: Adds Exchange data to an evidence container. See Add Evidence from Exchange.

Enterprise Vault: Adds Enterprise Vault data to an evidence container. See Add Evidence from Enterprise Vault.

S3: Adds S3 data to an evidence container. See Add Evidence from S3.

SQL Server: Adds SQL Server data to an evidence container. See Add Evidence from SQL Server.

Oracle: Adds Oracle database data to an evidence container. See Add Evidence from Oracle.

Documentum: Adds Documentum data to an evidence container. See Add Evidence from Documentum.

Dropbox: Adds Dropbox data to an evidence container. See Add Evidence from Dropbox.

SSH: Adds SSH data to an evidence container. See Add Evidence from SSH.

Historical Twitter: Adds Historical Twitter data to an evidence container. See Add Evidence from Historical Twitter.

Metadata-only processing: Deduplication status is tracked using the metadata field Load original. Top-level original items will have the value true in this field and will have all typical metadata and descendants processed - the descendants will not have this metadata field populated. Top-level duplicate items will have value false in this field and no other properties except for the metadata field Load duplicate of GUID which will indicate the GUID of the original document with the same deduplication key as the duplicate document.

Skip processing entirely will completely skip items identified as duplicates and no reference of these items will exist in the case.

Top-level MD5: Uses the MD5 hash of the top-level item.

Email Message-ID: Uses the email Message-ID property from the first non-blank field: Message-ID, Message-Id, Mapi-Smtp-Message-Id, X-Message-ID, X-Mapi-Smtp-Message-Id, Mapi-X-Message-Id, Mapi-X-Smtp-Message-Id.

Email MAPI Search Key: Uses the email MAPI Search Key property from the first non-blank field: Mapi-Search-Key, X-Mapi-Search-Key.

Items which are in a PST or EDB file, must have the first Outlook Folder in their path named Mailbox - John Smith.

Items which are not in a PST or EDB file are not affected.

Name: The name of the evidence container

Path: The path to the file or folder to load

Custodian: Optional, the custodian value to assign

Timezone: Optional, the timezone ID to load the data under. See Joda Time Zones for a list of valid timezone IDs.

Encoding: Optional, the encoding to load the data under.

ZipEncoding: Optional, the encoding to load the zip files under.

As family items: Skip creating an evidence container for the Drive Link Export and add each drive link file as a family item.

As full standalone items + placeholder family items: Create an evidence container for the Drive Link Export and add placeholder files as family items in-place of the drive link file.

As standalone items: Create an evidence container for the Drive Link Export without any link to the parent Export files.

{ms_graph_tenant_id}: The tenant ID for Azure AD.

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

{ms_graph_client_secret_protected}: The client secret that has been configured for the client ID provided, for authentication.

{ms_graph_certificate_store_path}: The path to a PKCS#12 certificate store, to use instead of the client secret, for authentication.

{ms_graph_certificate_store_password}: The password for the PKCS#12 certificate store, if present.

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

{ms_graph_password}: The password for the username, if it is present.

{ms_graph_start_datetime}: The beginning of the collection date range.

{ms_graph_end_datetime}: The end of the collection date range.

{ms_graph_retrievals}: A list of the content types to be retrieved, containing one or more of the following values: TEAMS_CHANNELS, TEAMS_CALENDARS, USERS_CHATS, USERS_CONTACTS, USERS_CALENDARS, USERS_EMAILS, ORG_CONTACTS, SHAREPOINT.

{ms_graph_mail_folder_retrievals}: Optionally, a list of mail folders to retrieve from, containing one or more of the following values: ARCHIVE, CLUTTER, CONVERSATION_HISTORY, DELETED_ITEMS, DRAFTS, INBOX, JUNK, OUTBOX, SENT_ITEMS, SYNC_ISSUES, OTHER, RECOVERABLE_ITEMS_DELETIONS, RECOVERABLE_ITEMS_PURGES, RECOVERABLE_ITEMS_DISCOVERY_HOLDS, RECOVERABLE_ITEMS_SUBSTRATE_HOLDS, RECOVERABLE_ITEMS_OTHER.

{ms_graph_team_names}: Optionally, a list of team names to filter on.

{ms_graph_user_principal_names}: Optionally, a list of user principal names to filter on.

{ms_graph_version_retrieval}: Optionally, a boolean indicating of all versions should be retrieved. Defaults to false

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

{ms_graph_tenant_id} : example.com

{ms_graph_client_id} : 6161a8bb-416c-3015-6ba5-01b8ca9819f6

{ms_graph_client_secret_protected} : AvjAvbb9akNF<pbpaFvz,mAGjgdsl>vk

{ms_graph_start_datetime} : 20180101T000000

{ms_graph_end_datetime} : 20201231T235959

{ms_graph_user_principal_names} : john.smith@example.com, eve.rosella@example.com

{ms_graph_retrievals} : TEAMS_CHANNELS, USERS_CHATS, USERS_EMAILS, SHAREPOINT

{ms_graph_mailbox_retrievals} : MAILBOX, ARCHIVE, RECOVERABLE_ITEMS, ARCHIVE_RECOVERABLE_ITEMS

{sharepoint_uri}: A URI specifying the site address.

{sharepoint_domain}: This optional parameter defines the Windows networking domain of the server account.

{sharepoint_username}: The username needed to access the account.

{sharepoint_password}: The password needed to access the account.

{exchange_uri}: The path to the Exchange Web Service (e.g. https://ex2010/ews/exchange.asmx).

{exchange_domain}: This optional parameter defines the Windows networking domain of the server account.

{exchange_username}: The username needed to access the account.

{exchange_password}: The password needed to access the account.

{exchange_mailbox}: The mailbox to ingest if it differs from the username.

{exchange_impersonating}: A boolean, defaults to false. This optional setting instructs Exchange to impersonate the mailbox user instead of delegating when the mailbox and username are different.

{exchange_mailbox_retrieval}: A list containing one or more of the following values: mailbox, archive, purges, deletions, recoverable_items, archive_purges, archive_deletions, archive_recoverable_items, public_folders.

{exchange_from_datetime}: 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_to_datetime}: 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.

{ev_computer}: The hostname or IP address of Enterprise Vault.

{ev_vault}: A vault store ID. This optional parameter limits the evidence to the specified Enterprise Vault vault.

{ev_archive}: An archive ID. This optional parameter limits the evidence to the specified Enterprise Vault archive.

{ev_custodian}: A name. This optional parameter limits the evidence to the specified custodian or author.

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

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

{ev_keywords}: 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_flag}: An optional value from any, all, allnear, phrase, begins, beginany, exact, exactany, ends, endsany.

{s3_access}: This parameter specifies the access key ID for an Amazon Web Service account.

{s3_secret_protected}: This parameter specifies the secret access key for an Amazon Web Service account.

{s3_credential_discovery_boolean}: 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 value will attempt anonymous access to the specified bucket.

{s3_bucket}: This optional parameter specifies a bucket and optionally a path to a folder within the bucket that contains the evidence to ingest. For example, mybucketname/top folder/sub folder. Omitting this parameter will cause all buckets to be added to evidence.

{s3_endpoint}: This optional parameter specifies a particular Amazon Web Service server endpoint. This can be used to connect to a particular regional server, e.g. https://s3.amazonaws.com.

{documentum_domain}: This optional parameter defines the Windows networking domain of the server account.

{documentum_username}: The username needed to access the account.

{documentum_password}: The password needed to access the account.

{documentum_port_number}: The port number to connect on.

{documentum_query}: A DQL query. This optional parameter specifies a query used to filter the content.

{documentum_server}: This parameter specifies the Documentum server address.

{documentum_doc_base}: This parameter specifies the Documentum docbase repository.

{documentum_property_file}: This optional parameter specifies the Documentum property file.

{sql_server_domain}: This optional parameter defines the Windows networking domain of the server account.

{sql_server_username}: The username needed to access the account.

{sql_server_password}: The password needed to access the account.

{sql_server_computer}: The hostname or IP address of the SQL Server.

{sql_server_max_rows_per_table_number}: 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_instance}: A SQL Server instance name.

{sql_server_query}: A SQL query. This optional parameter specifies a query used to filter the content.

{oracle_username}: The username needed to access the account.

{oracle_password}: The password needed to access the account.

{oracle_max_rows_per_table}: 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_driver_type}: The driver type used to connect. Can be thin, oci, or kprb.

{oracle_database}: A string representation of the connection params. The possible formats are documented at https://www.oracle.com/database/technologies/faq-jdbc.html#05_04

{oracle_role}: The role to login as, such as SYSDBA or SYSOPER. For normal logins, this should be blank.

{oracle_query}: A SQL query. This parameter specifies a query used to filter the content.

{dropbox_auth_code_protected}: A string retrieved via a webpage on Dropbox that enables access to an account.

{dropbox_team_boolean}: 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.

{dropbox_access_token_protected}: 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.

{slack_auth_code_protected}: The temporary authentication code. Initiate a manual collection through Nuix Workstation to retrieve this code.

{slack_user_ids}: Optionally, the internal Slack IDs of the users to which the collection should be limited.

{slack_start_datetime}: Optionally, the beginning of the collection date range.

{slack_end_datetime}: Optionally, the end of the collection date range.

{ssh_username}: The username needed to access the account.

{ssh_password}: The password needed to access the account.

{ssh_sudo_password}: The password needed to access protected files when using SSH key based authentication.

{ssh_key_folder}: Points to a folder on the local system which holds the SSH authentication key pairs.

{ssh_computer}: The hostname or IP address of Enterprise Vault.

{ssh_port_number}: The port number to connect on.

{ssh_host_fingerprint}: 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_remote_folder}: A folder on the SSH host to start traversing from. This optional parameter limits the evidence to items underneath this starting folder.

{ssh_accessing_remote_disks_boolean}: 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.

{twitter_access_token}: 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_key}: The consumer key (API key) of the Twitter app.

{twitter_consumer_secret_protected}: The consumer secret (API secret) of the Twitter app.

{twitter_access_token_secret_protected}: The access token secret of the Twitter app.

Set custodians from folder names sets the custodian to the same name as the folder at the specified path depth.

Set custodians from folder names with typical custodian names attempts to extract custodian names from the folder names, where the folder names contain popular first names, up to the specified maximum path depth.

Set custodians from PST files sent emails sender name attempts to extract custodian names from the name of the sender of emails in the Sent folder.

Set custodians from data set metadata sets the custodian names defined in the Custodian field in the data set metadata.

{set_custodian_from_folder_name} - Enable or disable the Set custodians from folder names option;

{custodian_folder_level} - The folder depth corresponding to the Set custodians from folder names option;

{set_custodian_from_typical_folder_name} - Enable or disable the Set custodians from folder names with typical custodian names option;

{max_custodian_typical_folder_level} - The max folder depth corresponding to the Set custodians from folder names with typical custodian names option.

{set_custodian_from_pst} - Enable or disable the Set custodians from PST files sent emails sender name option;

Message ID: Uses the email Message-ID property from the first non-blank field: Message-ID, Message-Id, Mapi-Smtp-Message-Id, X-Message-ID, X-Mapi-Smtp-Message-Id, Mapi-X-Message-Id, Mapi-X-Smtp-Message-Id, PR_INTERNET_MESSAGE_ID.

Message ID / MD5: Uses the email Message-ID property if available, or alternatively the MD5.

Mapi Search Key: Uses the email MAPI Search Key property from the first non-blank field: Mapi-Search-Key, X-Mapi-Search-Key.

Case: Case location, equivalent to the following subfolder from the case folder Stores\User Data\Digest Lists

User: User profile location, equivalent to %appdata%\Nuix\Digest Lists

Local Computer: Computer profile location, equivalent to %programdata%\Nuix\Digest Lists

Add: Produces hashes which are present in either digest list A or digest list B;

Subtract: Produces hashes present in digest list A but not in digest list B;

Intersect: Produces hashes which are present in both digest list A and digest list B.

Text file (.txt, .csv, .tsv). If the file contains a single column, hashes are expected to be provided one per line. If the file contains multiple columns, a column with the header name MD5 is expected

Nuix hash (.hash) file

Identify families: If selected, the operation will search for Family items and Top-Level items of items with hits for each keyword.

Identify descendants If selected, the operation will search for descendants of items with hits for each keyword.

Identify exclusive hits ("Unique" hits) oIf selected, the operation will search for Exclusive hits (items which only hit on one keyword), Exclusive family items (items for which the entire family only hit on one keyword) and Exclusive top-level items (also items for which the entire family only hit on one keyword).

Compute size If selected, the operation will compute the audited size for Hits and Family items.

Compute totals If selected, the operation will compute the total counts and size for all keywords.

Breakdown by custodian If selected, the searches and reporting will be performed for each individual custodian, as well as for items with no custodians assigned.

Log results If selected, the search counts will be printed in the Execution Log.

Tag prefix

.csv: Comma-separated file, with the fist column containing the keyword name or tag and the second column containing the keyword query. If the first row is a header with the exact values tag and query, the line will be read as a header. Otherwise, it will be read as a regular line with a keyword and tag name.

.tsv, .txt : Tab-separated file, with the fist column containing the keyword name or tag and the second column containing the keyword query.

.json: JSON file, either exported from the Nuix Search and Tag window, or containing a list of searches, with each search containing a tag and a query.

Tag internal-only emails

Tag communications between two individuals only

Tag communications within a group

Threading

Memory-Intensive: This method uses a large amount of memory on large cases but requires reduced computation.

Compute-Intensive: This operation performs a large number of computations on large cases but requires a reduced amount of memory.

As individuals: Items that are duplicates at the item level.

By family: Items that are duplicates at the family level.

By top-level item: Only the top-level items of items in scope that are duplicates are identified.

Custodians

Item Names

Item Dates

Paths

Tags

Sub Tags

GUIDs

Parent GUIDs

Top-Level Parent GUIDs

DocIDs

Lowest Family DocID

Metadata Profile

The first column: Type, indicating that this line is a header specifying field types

For each subsequent column, the type of the data, from the following options:

Google Mail

Google Documents

No sorting: Items are not sorted.

Top-level item date (ascending): Items are sorted according to the date of the top-level item in each family, in ascending order.

Top-level item date (descending): Items are sorted according to the date of the top-level item in each family, in descending order.

Evidence order (ascending): Items are sorted by effective path name (similar to the Windows Explorer sorting), in ascending order.

Keyword Fields: Items are sorted by a combination of fields in ascending or descending order.

Metadata Profile: Items are sorted by the fields within a Metadata profile in ascending order.

{docid_start_numbering_at} - Select the option Start numbering at in the configuration of the Add Items to Production Set operation for this parameter to have an effect;

{docid_digits}

{docid_family_digits} - Select the numbering scheme Family Document ID in the configuration of the Add Items to Production Set operation for this parameter to have an effect;

Fields mapping file: Path to JSON file mapping the Nuix Metadata profile to the Relativity workspace fields. If a mapping file is not provided, the fields in the loadfile will be mapped to fields with the same names in the Relativity workspace.

No sorting: Items are not sorted.

Top-level item date (ascending): Items are sorted according to the date of the top-level item in each family, in ascending order.

Top-level item date (descending): Items are sorted according to the date of the top-level item in each family, in descending order.

Evidence order (ascending): Items are sorted in the same way in which they appear in the evidence tree, in ascending order.

Case History: Enables the scanning of the case history to extract sessions, operations and volumes.

Compute Size: The methods used to compute the size of items.

Max scan duration (seconds): Stop scanning further case details after this time is reached.

Native Export: Include non-exported material children: If selected, when a Native Export event is detected in the case history, the material childre of the exported items are also included in the export scope.

Force scan previously scanned case: Re-scan a case even if it was previously scanned and no new events were detected.

Don’t skip Automate Engine sessions: By default, sessions ran by the Automate Engine are skipped during the case history scan. If enabled, this option will scan sessions ran by the Automate Engine as well. Use this option when rebuilding the Scheduler Utilization database.

None: Does not acquire a Nuix license and runs the remaining operations in the workflow without access to the Nuix case.

NMS: Acquires a Nuix license from the NMS server specified.

CLS: Acquires a Nuix license from the Nuix Cloud License server.

Dongle: Acquires a Nuix license from a USB Dongle connected to the Engine Server.

Engine Default: Acquires a Nuix license from the default source from which the Engine acquired the original Nuix license when the job was started.

Attach workflow execution log as text: Select this option to attach a file named WorkflowLog.txt to the email, containing the current Execution Log.

Attach last generated report, if available: Select this option to attach the last generated report file.

Additional attachments: Specify additional files that should be attached to the email.

Application location: C:\Windows\System32\Robocopy.exe

Arguments: "C:\Program Files\Automate" "C:\Temp\Automate" /E

Application location: C:\Windows\System32\cmd.exe

Arguments /c dir "C:\Program Files" > "listing_{date_time}.txt"

Working Directory: C:\Temp

Verb: The HTTP verb, such as GET or POST.

URL: The URL.

Certificate fingerprint: Optional, the certificate SHA-256 fingerprint that should be trusted even if the certificate is self-signed.

Authentication type: The type of authentication that the API requires.

Parameters: Optional, URL parameters.

Headers: Optional, custom HTTP headers.

Body type: The type of body data to submit.

{call_api_response_code}: The HTTP response code.

{call_api_response_headers}: The response headers, JSON encocoded.

{call_api_response_body}: The response body.

Workers allocation:

OCR engine binaries folder: Optional, the folder where the Automate OCR or the Tesseract OCR is installed.

User words file: Optional, the path to the Tesseract words file.

User patterns file: Optional, the path to the Tesseract patterns file.

Image resolution: Optional, the resolution of the source image in DPI of the images, if known.

Rasterize PDF resolution: Optional, the resolution to use when rasterizing PDF files before OCR.

OCR engine log level: Optional, the logging level for the Tesseract OCR Engine.

Languages: Optional, the language(s) in which the text is written, if known. When configuring multiple languages, separate them by the plus sign, for example eng+deu+fra.

Page segmentation mode: Optional, the method used to segment the page.

Deskew: If set, the preprocessor will attempt to deskewed the image before running the OCR.

Rotate: If set, the preprocessor will rotate the image before running the OCR. When using the Auto Detect option, the OCR engine will first run in 0 - Orientation and Script Detection (OSD) only mode to detect the orientation, and then will run a second time on the rotated images in the user-configured mode.

OCR engine mode: Optional, the mode in which the OCR engine should run. This option should only be used when using a custom Tesseract build.

OCR engine config file: Optional, the Tesseract configuration file to use with configuration variables.

Timeout per file: Optional, the maximum duration of time that the OCR engine is allowed to run on a single file, possibly containing multiple pages.

OCR temp folder: Optional, the folder in which the temporary files used during files the OCR operations are created. If not set, a temp folder will be created in the destination folder where the OCR text is exported, or inside the Nuix case folder.

Don’t clear OCR temp folder on completion: If set, the OCR temp folder is not deleted on OCR completion. This option can be used to troubleshoot the OCR process by inspecting the intermediary temporary files.

Scope query: The Nuix query to select the items to OCR.

Text modifications

Create searchable PDF: If set, generate PDF files with the extracted text overlaid and set as the printed images for the items.

Source image files folder: The folder containing the image files to be OCRed.

Scan folder recursively: If set, the source folder will be scanned recursively, and the output files will be created using the same folder structure.

Skip images with existing non-empty text files: If set, images will be skipped if a text file with the expected name and a size greater than 0 exists in the destination folder.

Assemble pages regex: The regular expression to use to detect documents with multiple pages, which were exported with one image file per page. The regex must have at least one matching group which is used to select the document base name.

Output text files folder: The folder in which the text files will be created.

Keep incomplete files: If set, empty files and incomplete text files from the OCR Engine are not deleted.

Create searchable PDF: If set, the source images are converted to PDF files in the Output text files folder with the extracted text overlaid.

Output PDF files folder: The folder in which the PDF files will be created. If this field is blank, it will default to the output text files folder.

Host name: The Relativity host name, for example relativity.example.com.

Service endpoint: The Relativity Service Endpoint, for example /relativitywebapi.

Endpoint type: The Relativity Endpoint Type, for example HTTPS.

User name: The user name used to perform the import into Relativity.

Password: The password for the username above.

Import threads: The number of parallel threads to use for Relativity uploads, such as Legal Export, Relativity Loadfile Upload, Relativity Images Overlay, Relativity Metadata Overlay, Relativity CSV Overlay.

Import thread timeout: The number of seconds to allow a Relativity upload thread to be idle. If no progress is reported for longer than the allowed timeout, the import thread will be aborted.

Import thread retries: The number of times to retry running an import thread, in situations where import encountered a fatal error or timed out.

Metadata threads: The number of parallel threads to use for Relativity metadata operations, such as Create Relativity Folders.

Patch invalid entries: If selected, this option will automatically patch entries that fail uploading due to the following issues:

Client version: When unchecked, Automate will use the Relativity client version which is the closest match to the Relativity server version. When checked, Automate will use the specified Relativity client version, if available.

REST version: The version of the REST services to use when querying Relativity objects, such as workspaces and folders. For Relativity One, use REST (v1 Latest).

Client identifier: The Name or Artifact ID of the Relativity client.

Existing client: The action to take if the client does not exist:

Client number: The client number to set on the client.

Status identifier: Optional, the Name or Artifact ID of the status to set on the client.

Keywords: Optional, the keywords to set on the client.

Notes: Optional, the notes to set on the client.

Matter identifier: The Name or Artifact ID of the Relativity matter.

Existing matter: The action to take if the matter does not exist:

Matter number: The matter number to set on the matter.

Status identifier: Optional, The Name or Artifact ID of the status to set on the matter.

Keywords: Optional, the keywords to set on the matter.

Notes: Optional, the notes to set on the matter.

Workspace identifier: The Name or Artifact ID of the Relativity workspace.

Folder path: The path inside the workspace. If blank, this will retrieve the folder corresponding to the root of the workspace.

Create folder path if it does not exist:: If checked, the specified folder path will be created in the workspace if it does not exist.

Existing workspace: The action to take if the Workspace does not exist:

Clone settings: The settings to use when cloning a Workspace.

Group Name: The name of the group to be created.

Keywords: Optional, the keywords to assign to the group created.

Notes: Optional, the notes to assign to the group created.

Group identifier type: The identifier type used for the workspace groups, Name or Artifact ID.

Group action: The action to be performed on the groups, Add or Remove.

Group Settings Table

User template identifier: The Name, Artifact ID or Email Address of the user to copy properties from.

Send email invitation: Sends an email invitation to each user created.

User Settings:

User identifier type: The identifier type used to retrieve users: Name, Artifact ID or Email Address.

User action: The action to be performed on the users, Delete.

Users:

Group identifier: The Name, Artifact ID or Name (Like) of the group to add or remove users.

User identifier type: The identifier type used to retrieve users: Name, Artifact ID or Email Address.

User group action: The action to be performed on the users of the group, Add or Remove.

Group users:

Group Identifier: The Name, Artifact ID or Name (Like) of the group to apply permissions to.

Permissions JSON: Optionally, the content of a permissions file.

Permissions file: A permissions file created by the Query Relativity Workspace Group Permissions operation.

Source Workspace Identifier: The Name, Artifact ID or Name (Like) of the source workspace.

Source Group Identifier: The Name, Artifact ID or Name (Like) of the source group.

Destination Workspace Identifier: The Name, Artifact ID or Name (Like) of the source workspace.

Destination Group Identifier: The Name, Artifact ID or Name (Like) of the source group.

Loadfile location: Path to the loadfile.

Fields mapping file: Path to JSON file mapping the Nuix Metadata profile to the Relativity workspace fields. If a mapping file is not provided, the fields in the loadfile will be mapped to fields with the same names in the Relativity workspace.

Detect export in parts: Detects the existence of loadfiles in subfolders in the specified location, and uploads all detected loadfiles sequentially.

Fields mapping file: Path to JSON file mapping the Nuix Metadata profile to the Relativity workspace fields. If a mapping file is not provided, the fields in the loadfile will be mapped to fields with the same names in the Relativity workspace.

Identifier field: The Artifact ID of the identifier field, such as Control Number or Document ID.

Strip suffix from first page: Strips the suffix from the first page to infer the document ID from the Opticon loadfile, for example _0001.

Detect export in parts: Detects the existence of loadfiles in subfolders in the specified location, and uploads all detected loadfiles sequentially.

Fields mapping file: Path to JSON file mapping the Nuix Metadata profile to the Relativity workspace fields. If a mapping file is not provided, the columns in the CSV file will be mapped to fields with the same names in the Relativity workspace.

Object type identifier: The Name, Artifact ID or Name (Like) of the object type.

Load objects in workspace: Determines if the objects will be loaded into a workspace.

Objects: Tab separated list of the objects to be loaded.

Archive Directory: The path where the archive will be stored, for example \\INSTANCE007\Arhives\TestWorkspaceArchive

Use Default Archive Directory: Uses the default path to store your archive

Priority: The priority of execution for the archive job: Low, Medium, High

Wait for Archive to Complete: Waits until the archive job completes.

Lock UI Job Actions: Determines if job actions normally available on UI should be visible for the user.

Notify Job Creator: Determines if email notifications will be sent to the job creator.

Notify Job Executor: Determines if email notifications will be sent to the job executor.

Include Database Backup: Include database backup in the archive.

Include dtSearch: Include dtSearch indices in the archive.

Include Conceptual Analytics: Include conceptual analytics indices in the archive.

Include Structured Analytics: Include structured analytics indices in the archive.

Include Data Grid: Include data grid application data in the archive.

Include Repository Files: Include all files included in workspace repository, including files from file fields in the archive.

Include Linked Files: Include all linked files that do not exist in the workspace file repository in the archive.

Missing File Behavior: Indicates weather to Skip File or Stop Job when missing files are detected during the archiving process.

Include Processing: Include processing application data in the archive.

Include Processing Files: Include all files and containers that have been discovered by processing in the archive.

Missing Processing File Behavior: Indicates whether to Skip File or Stop Job when missing processing files are detected during the archiving process.

Include Extended Workspace Data: Include extended workspace information in the archive.

Application Error Export Behavior: Indicates whether to Skip Application or Stop Job on applications that encountered errors during export.

Archive Path: Path of the ARM archive to be restored, for example \\INSTANCE007\Arhives\TestWorkspaceRestore

Priority: The priority of execution for the restore job: Low, Medium, High.

Lock UI Job Actions: Determines if job actions normally available on UI should be visible for the user.