Nuix Rampiva - 工作流程设计指南

免责声明

本文档中的材料仅供参考。由于制造商的持续开发计划，其中描述的产品如有更改，恕不另行通知。 Rampiva对本文档或此处描述的产品不作任何陈述或保证。 Rampiva对因使用此材料或本文所述产品而引起或与之相关的任何直接，间接或偶然，后果性或特殊性的损坏，损失，成本或费用概不负责。

介绍

本指南介绍了 努克斯·兰皮瓦 的 工作流程设计 Web 组件的选项和选项。本文档的作用类似于参考 - 使用目录查找您所了解的主题。

Nuix Rampiva 软件和本文档可能包含缺陷、错误或其他限制。如果您在使用 Nuix Rampiva 软件或本文档时遇到任何问题，请联系 nuix support。

本指南中使用的样式

注意：此图标表示提供其他说明，例如有效选项是什么。

小费：此图标使您知道提供了一些特别有用的花絮，也许是使用应用程序实现特定行为的一种方式。

警告：此图标突出显示可以帮助您避免不良行为的信息。

强调：此样式表示菜单，选项或链接的名称。

code：此样式表示应逐字使用的代码，并且可以引用文件路径，参数名称或Nuix搜索查询。

1. 编辑工作流程

工作流程在 Nuix Rampiva 的“库”部分中进行管理。

要编辑、删除、停用或激活工作流程，请从库中选择工作流程，然后单击工作流程名称右侧的按钮。

要创建新的工作流程，请单击所需库中的 添加+工作流程 按钮。可以通过不同的方式创建工作流：

空白工作流程：从空白画布开始创建新的工作流程。
模板：从现有模板开始构建工作流程。
工作流向导：创建一个通过回答一系列问题来处理和导出数据的工作流。
工作流程文件：上传之前创建的工作流程文件。

参数可以在工作流程中与每个字段中的静态文本一起使用，这些字段接受用户输入，例如搜索查询、文件路径、生产集名称等。有关更多详细信息，请参阅Parameters Guide。

1.1. 操作动作

使用操作列表按钮可以对操作执行以下操作：

添加 (image:../_images/plus.svg[width=12pt]) 对工作流程的操作。
去掉 (image:../_images/minus.svg[width=12pt]) 从工作流程中选择的操作。
上移 (image:../_images/up.svg[width=12pt]) 工作流程中选定的操作。
下移 (image:../_images/down.svg[width=12pt]) 工作流程中选定的操作。
搜索 (image:../_images/search.svg[width=12pt]) 在按名称列出的操作列表中。

此外，还可以使用行动操作列表菜单执行以下操作：

不激活 / 禁用：禁用的操作对工作流执行没有影响。
使可跳过 / 删除可跳过：如果某个操作被标记为 可跳过，则用户可以在该操作运行时跳过该操作的执行。

可跳过的操作可能会使作业执行处于意外状态。仅当后续工作流逻辑不受跳过的操作影响时才应启用它们。

启用软故障 / 禁用软故障：标记为 软故障 的操作在遇到错误时不会停止工作流执行。
启用字段覆盖 / 禁用字段覆盖：标记为 字段覆盖 的操作可以使用以操作名称开头、后跟字段名称的参数覆盖其所有字段，例如 {set_purview_case_case_identifier_type}。
插入工作流程：在选定位置插入工作流程文件中的操作。
剪切：剪切所选操作（CTRL+X）。
复制：复制所选操作（CTRL+C）。
粘贴：将之前剪切或复制的操作粘贴到所选位置（CTRL+V）。
删除：删除选定的操作（Del）。

2. 运作方式

操作按其执行的平台进行分类。

当一个操作有多个平台时，例如 中继资料转SQL 操作将数据从 Nuix 案例导出到 SQL 服务器，它会记录在其最特定的平台下，在此示例中为 SQL。

2.1. Azure 存储操作

这些操作执行与 Azure 存储帐户相关的操作。

2.1.1. Azure 容器副本

此操作使用 Microsoft AzCopy 命令将 Azure 容器的内容复制到另一个 Azure 容器。

可以配置以下设置：

源存储容器URL：源存储容器的URL。
源存储帐户 SAS 令牌：源容器的 SAS 访问令牌。要创建令牌，请参阅 https://learn.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers。
目标存储容器 URL：目标存储容器的URL。
目标存储帐户 SAS 令牌：目标容器的 SAS 访问令牌。
命令行标志：可选，AzCopy 命令的附加命令行标志。

2.1.2. Azure 容器下载

此操作使用 Microsoft AzCopy 命令将 Azure 容器的内容下载到本地存储。

可以配置以下设置：

存储容器 URL：存储容器的URL。
存储帐户 SAS 令牌：SAS 访问令牌。要创建令牌，请参阅 https://learn.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers。
下载位置：下载数据的文件夹。

2.1.3. 配置 Azure 存储帐户连接

此操作设置用于连接到 Azure 存储帐户的配置。除 Azure 容器复制和 Azure 容器下载外，所有与 Azure 存储相关的操作都需要此操作。

Azure 存储帐户 ID 必须指定为 Azure 存储帐户 类型的参数。

2.1.4. 创建 Azure 存储帐户容器

此操作在配置的 Azure 存储帐户中创建一个容器。

集装箱名称 将进行标准化，以遵守 https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and- 中描述的 Azure 要求元数据#容器名称

2.1.5. 删除 Azure 存储帐户容器

此操作将删除已配置的 Azure 存储帐户中的容器。

2.1.6. 生成 Azure 存储帐户 SAS 令牌

此操作会在配置的 Azure 存储帐户中生成 SAS 访问令牌。

2.2. 脑空间

这些操作在 Nuix 案例和 Brainspace 之间传输数据，并允许管理 Brainspace 中的各种操作。

2.2.1. 设置脑空间数据集

此操作使用以下设置连接到 Brainspace 环境并检索指定的数据集 ID：

脑空间 API URL：Brainspace 环境的 URL，例如 https://app.brainslace.local
证书指纹：可选，Brainspace 应用程序服务器的 SHA-256 指纹即使证书是自签名的也应该信任的证书。
API 密钥：API 密钥。这个值可以从 Brainspace Administration 页面 → Connectors → API Authentication 获取。
数据集标识符：
- ID: Brainspace 数据集 ID.
- 名称: Brainspace 数据集名称。
- 名称（正则表达式）：匹配 Brainspace 数据集名称的正则表达式。
现有数据集：案例不存在时采取的行动：
- 如果数据集尚不存在，则克隆数据集 通过克隆源数据集创建一个新数据集。
- 仅使用现有数据集 如果数据集不存在则触发错误。
克隆设置：克隆数据集时使用的设置。
- 复制组：将源数据集的组复制到新创建的数据集。
- 将新数据集添加到组：将新创建的数据集添加到指定组中。

2.2.2. 将项目加载到大脑空间

此操作从 Nuix 案例中导出项目的文本和元数据，并将其加载到 Brainspace。

可以配置以下设置：

范围查询：用于选择要加载到 Brainspace 中的项目的 Nuix 查询。
导出标准元数据：将项目标准元数据导出到 Brainspace。
从配置文件导出自定义元数据：可选，用于将其他元数据导出到 Brainspace 的元数据配置文件。当使用此选项时，必须提供一个*自定义字段映射文件*。
自定义字段映射文件：定义自定义元数据配置文件到 Brainspace 的映射的 JSON 映射文件。
从生产集中导出 DocID：如果选中，则为从中导出 DocID 编号的生产集的名称。
修剪正文：如果选中，则在加载到 Brainspace 之前修剪 items 的正文后的字符大小。

当项目的正文被修剪时，在有问题的项目上，Brainspace 中的字段*文本修剪*设置为`true`。

将失败的项目标记为 选项的行为与合法导出操作中的行为相同。

示例 自定义字段映射文件 映射 2 个名为 Custom Field 1 和 Custom Field 2 的自定义 Nuix 字段：

{
  "name": "Custom Mapping",
  "fields": [
    {
      "name": "Custom Field 1",
      "mapTo": "STRING"
    },
    {
      "name": "Custom Field 2",
      "mapTo": "ENUMERATION",
      "faceted": true
    }
  ]
}

2.2.3. 管理大脑空间构建

此操作管理 Brainspace 数据集上的构建。

可以配置以下设置：

等待之前的构建完成：等待在操作开始时运行的构建完成。
构建数据集：触发数据集的构建。

将项目加载到大脑空间 操作后应使用 构建数据集 选项，以使加载的项目可用于重审。

等待构建完成：等待此操作触发的构建完成。

如果选择了等待选项并且构建未在分配的时间内完成，则操作将失败。

此操作的百分比进度反映了经过的超时时间，而不是构建进度的指示。

2.2.4. 将标签传播到大脑空间

此操作将标签值从 Nuix 项目传播到相应的 Brainspace 文档作为标签选择。

可以配置以下设置：

范围查询：检索要为其传播标签的 Nuix 项目的查询。
Nuix 根标签: Nuix 根标签的名称。

使用此操作时，预计在 Nuix 中会创建一个根标签，例如 Relevancy。然后，应该在根标签下为 Nuix 项目分配子标签值，例如 Relevancy|Relevant 和 Relevancy|Not Relevant。根 Nuix 标签将映射到 Brainspace 标签（本例中为`Relevancy），Nuix 子标签值将映射到 Brainspace 选项（本例中为Relevant` 和 Not Relevant。）

Nuix 项目应该只有一个子标签值，因为在 Brainspace 中这些被映射到单选标签。

不支持嵌套子标签值，例如 Relevancy|Not Relevant|Personal。

此操作会更新以前的标签选择，但不会更新 Nuix 中不存在子标签的项目。作为一种解决方法，要指示文档不应具有任何以前的标签选项，请将其分配给新的专用选项，例如 Relevancy|Unassigned。

2.2.5. 从脑空间检索元数据

此操作从 Brainspace 读取元数据表单项并应用于 Nuix 项。

可以配置以下设置：

Nuix 范围查询：选择要更新的项目的 Nuix 查询。
脑空间范围：
- 全部项目：从数据集中的所有 Brainspace 项目中检索元数据。
- 笔记本：仅从指定笔记本中的 Brainspace 项目中检索元数据。
标记匹配项：应用于与 Brainspace 项目匹配的 Nuix 项目的标签。
检索大脑空间标签：选择是否检索分配给 Brainspace 中项目的标签，以及将标签应用于匹配的 Nuix 项目时使用的前缀。
检索脑空间分类器分数：选择Brainspace字段的值是否对应分类器。这些字段被标识为具有数字类型和名称中的单词 score。
检索脑空间字段：选择是否从 Brainspace 检索元数据字段以作为自定义元数据分配给 Nuix 项目，以及要检索哪些 Brainspace 字段。

2.3. 人工智能型

这些操作使用 Gen AI 服务对 Nuix 项目进行丰富。

2.3.1. 配置 Gen AI 连接

此操作设置用于连接 Gen AI 服务的配置：

通用人工智能服务 ID：Gen AI 服务的 ID，{gen_ai_service_id}

2.3.2. 文档上的 Gen AI 提示

此操作将在范围内的每个文档上运行 Gen AI 提示，并将结果记录在自定义元数据字段中。

可以配置以下选项：

范围查询：Nuix 查询选择要使用 Gen AI 进行分析的项目。
运行样本：进行分析的样本量。
将已分析的项目标记为：应用于所分析项目的标签。
将失败的项目标记为：应用于失败项目的标签。
上下文提示：初始化 Gen AI 分析的提示。
修剪正文：每个文档发送到 Gen AI 平台的最大字符数。如果文档正文被删减，则会记录一条警告消息。
温度：温度设置，从0到1，设置为Gen AI服务。
最大代币数：每次提示可使用的最大代币数量
问题提示：用于丰富文档的主要问题。问题将独立发送到 Gen AI 服务。
后续提示：每个问题提示后发送给 Gen AI 服务的后续提示。

Gen AI 服务的响应以前缀 GenAI 的自定义元数据形式记录在每个文档中。此外，还记录以下系统元数据：

GenAI|System|Model：用于上次分析的模型（如果适用）。
GenAI|System|Service：上次分析所用服务的主机名。
GenAI|System|Warning：上次分析时遇到的警告（如果有）。
GenAI|System|Error：上次分析期间遇到的错误（如果有）。

2.4. 弹性搜索

这些操作在 Nuix 案例和 ElasticSearch 之间传输数据。

2.4.1. 配置弹性搜索连接

此操作设置用于连接到 ElasticSearch 环境的配置：

主持人：ElasticSearch 主机名，例如 es.example.com 或 127.0.0.1.
主持人: 部署ElasticSearch REST API的端口，默认为 9200.
用户名：用于验证的用户名。
密码：上面用户名的密码。
证书指纹：可选，即使证书是自签名的，也应该信任 ElasticSearch 证书的 SHA-256 指纹。
批量操作：批量提交给ElasticSearch的操作数。使用更高的值可以增加吞吐量，但需要更多内存。

2.4.2. 将项目导出到 ElasticSearch

此操作会将与范围查询匹配的项目的元数据导出到 ElasticSearch。

范围查询：用于选择要导出到 ElasticSearch 的项目的 Nuix 查询。
元数据配置文件：导出期间使用的 Nuix 元数据配置文件。
索引名称：ElasticSearch 索引名称。
导出项目文本：如果选择，除了元数据外，该操作还将导出项目文本。文本在项目属性 _doc_text. 下导出到 ElasticSearch 中
修剪项目文本：从项目文本中导出的最大字符数。如果项目文本被修剪，则在项目上设置 ElasticSearch 属性 _doc_text_trimmed。

2.5. 内存图

这些操作配置与 Memgraph 的连接，将升级数据发送到 Memgraph。

2.5.1. 配置 Memgraph 连接

该操作仅在 Nuix Neo 中可用。

此操作设置用于连接 Memgraph 服务的配置。

Memgraph 服务 ID 应设置为 内存图服务 类型的参数。在 Scheduler 中提交工作流程期间，系统将提示用户选择 Memgraph 服务并根据需要对该服务进行身份验证。

剧本文件 应设置为 Nuix playbook 文件，该文件将项目转换为 Memgraph 节点和边。

交易规模 用于对相似事务进行分组和重复数据删除。

2.5.2. 将项目升级到 Memgraph

该操作仅在 Nuix Neo 中可用。

此操作将范围内的项目发送到 Memgraph。

2.6. 微软权限

这些操作在 Microsoft Purview eDiscovery (Premium) 中执行操作。

有关 Microsoft Purview 的概述，请参阅 https://learn.microsoft.com/en-us/purview/ediscovery-overview。

2.6.1. 配置权限连接

此操作设置用于连接到 Purview 的配置。在 Purview 中执行操作的所有其他操作都需要此操作。

Microsoft Purview 服务 ID 必须指定为 微软权限服务 类型的参数。

2.6.2. 设置权限案例

此操作使用以下设置选择 Purview 案例：

案例标识符：Purview 案例中的名称或 ID。
如果不存在则创建案例 创建一个新案例，进行以下设置
- 案件编号：可选，要在案例上设置的案例编号。
- 描述：可选，要设置在案例上的描述。

2.6.3. 更新权限案例设置

此操作会更新所选 Purview 案例的设置。

2.6.4. 管理权限案例

此操作对选定的 Purview 案例执行以下管理操作：

关闭：结案。
关闭并删除：关闭案例并尝试将其删除。
重新开放：打开之前关闭的案例。

2.6.5. 将托管数据源添加到权限

此操作使用以下设置将托管数据源添加到 Purview 案例：

数据源文件：包含要添加的数据源列表的文件。
数据源：包含要添加的数据源的表格。

2.6.6. 将非托管数据源添加到权限

此操作使用以下设置将非托管数据源添加到 Purview 案例：

数据源文件：包含要添加的数据源列表的文件。
数据源：包含要添加的数据源的表格。

2.6.7. 将保留应用于权限托管人

此操作使用以下设置对 Purview 保管人应用保留：

所有案件保管人：对所选 Purview 案例中的所有保管人应用保留。
保管人档案：包含要应用保留的保管人列表的文件。
JSON 托管人 ID：Purview 保管人 ID 的 JSON 格式列表。
等待完成：等待直到应用保留。

2.6.8. 将保留应用于权限非托管数据源

此操作使用以下设置对 Purview 非托管数据源应用保留：

所有案例非托管数据源：将保留应用于所选 Purview 案例中的所有非托管数据源。
非托管数据源文件：包含要应用保留的非托管数据源列表的文件。
非托管数据源 ID JSON：Purview 非托管数据源 ID 的 JSON 格式列表。
等待完成：等待直到应用保留。

2.6.9. 解除托管人的保留

此操作解除了 Purview 托管人的保留。

有关可用设置，请参阅[_申请_hold_至_purview_custodians]

2.6.10. 从权限非托管数据源中删除保留

此操作会删除 Purview 非托管数据源的保留。

有关可用设置，请参阅[_申请_hold_至_purview_非_custodial_数据_sources]

2.6.11. 释放权限托管人

此次行动将 Purview 保管人从案件中释放。

有关可用设置，请参阅[_申请_hold_至_purview_custodians]

2.6.12. 发布权限非托管数据源

此操作从案件中释放 Purview 非托管数据源。

有关可用设置，请参阅[_申请_hold_至_purview_非_custodial_数据_sources]

2.6.13. 添加到权限搜索

此操作创建 Purview 搜索和/或将数据源添加到搜索。

有关可查询字段的列表，请参阅 https://learn.microsoft.com/en-us/purview/ediscovery-keyword-queries-and-search-conditions

2.6.14. 估计权限搜索统计数据

此操作估计 Purview 搜索范围内的项目，并且在将搜索中的项目添加到审阅集中之前需要执行此操作。

2.6.15. 添加到权限审阅集

此操作创建 Purview 审阅集和/或将搜索结果添加到审阅集。

2.6.16. 创建权限审阅集查询

此操作创建一个查询以应用于 Purview 审阅集。

有关可查询字段的列表，请参阅 https://learn.microsoft.com/en-us/purview/ediscovery-document-metadata-fields

2.6.17. 删除权限审阅集查询

此操作删除 Purview 审阅集查询。

2.6.18. 删除权限搜索

此操作删除权限搜索。

2.6.19. 导出权限审查集

此操作从审阅集或审阅集查询中导出项目。

要传输导出，请参阅 [_天蓝色的_container_copy] 和 [_天蓝色的_container_download] 操作。

2.6.20. 转换权限导出

此操作将电子邮件从 Purview 精简目录结构 (CDS) 导出转换为 Nuix 逻辑映像 (NLI)。

此操作不支持 Teams 和 Copilot 对话。此操作已弃用，并由 [_转变_purview_cds] 操作取代。

可以配置以下设置：

权限导出文件夹：Purview 数据下载到的文件夹。
生成的 NLI 位置：生成的 NLI 的位置。
高级选项：用于识别 Purview CDS 加载文件和用于从项目中提取元数据的列名的设置。

2.6.21. 转换 Purview CDS

此操作将电子邮件、文件和对话从 Purview 精简目录结构 (CDS) 导出转换为 Nuix 逻辑映像 (NLI)。

可以配置以下设置：

权限导出文件夹：Purview 数据下载到的文件夹。
生成的 NLI 位置：生成的 NLI 的位置。
导出选项：用于识别 Purview CDS 加载文件的设置。
项目选项：用于从一般项目中提取元数据的列名。
对话选项：用于从对话中提取元数据的列名。

2.6.22. 将 Loadfile 转换为 Nuix 逻辑图像

此操作将 CSV 加载文件转换为 Nuix 逻辑映像 (NLI)。

可以配置以下设置：

加载文件：需要转换的 CSV 加载文件。
生成的 NLI：生成的 NLI 文件的位置。
DocID 列：包含文档 ID 的列名称，或每个项目的唯一标识符。
家庭 ID 栏：可选，包含家庭ID的列名称。
路径列：可选，包含文档路径的列名称，不包括文档名称。
名称列：可选，包含文档名称的列的名称。
本机文件列：可选，包含本机文件路径的列的名称。
保管专栏：可选，包含与文档相关的保管人的列的名称。
MD5 列：可选，包含文档 MD5 的列的名称。
加载所有字段：选择此选项可将加载文件中的所有列转换为 NLI 中的元数据字段。
字段元数据前缀：可选，用于 NLI 中的元数据字段的前缀。

2.6.23. 创建 Nuix 逻辑映像

此操作将本地文件夹打包到*Nuix 逻辑映像 (NLI)*。

可以配置以下设置：

源位置：要打包的文件夹
生成的 NLI 位置：生成的 NLI 的位置。

2.7. 谷歌保险柜

这些操作在 Google 保险柜中执行操作。

有关 Google 保险柜的概述，请参阅 https://support.google.com/vault/answer/2462365?hl=en

2.7.1. 配置 Vault 连接

此操作设置将用于连接到 Google 保险柜的 Google 保险柜第三方服务。在 Vault 中执行操作的所有其他操作都需要此操作。

Google 保险柜服务 ID 必须指定为 谷歌保险柜服务 类型的参数。

2.7.2. 设置 Vault 事项

此操作使用以下设置选择保管库案件：

物质标识符：Vault 的 ID、名称或 名称（正则表达式） 很重要。
物质状态过滤器：避难所所需的状态。
如果物质不存在则创建物质：如果案件不存在所需的状态过滤器，则使用以下设置创建新案件：
- 描述：可选，对此事进行设置的描述。

2.7.3. 管理保管库事务

此操作对选定的保管库案件执行以下管理操作。

关闭：结束这件事。
删除：删除该事件。
重新开放：重新讨论此事。
恢复删除：取消删除该事件。

2.7.4. 创建保管库保存的查询

此操作使用以下设置在选定的 Vault 案件中创建 Vault 保存的查询：

查询名称前缀：已保存查询的名称中使用的前缀。
数据范围：保存查询的数据范围。
使用日期范围：设置日期范围以使用以下设置过滤已保存查询所涵盖的数据：
- 时区：日期范围的时区。
- 开始日期：日期范围的开始日期。
- 结束日期：日期范围的结束日期。
查询地点和条款：
- 从 CSV 文件中读取：从CSV文件中读取查询位置和术语。
  - 查询位置文件：包含查询位置列表的文件。
  - 查询条件文件：包含查询词列表的文件。
- 手动输入：手动输入查询地点和条件
  - 查询地点：包含要添加的查询位置的表。
  - 查询条件：包含要添加的查询项的表格。

A 位置是用于 Vault 查询和保留的单位。它指定 Google 服务、位置类型和值，例如：

MAIL,ACCOUNT,user1@example.com
GROUPS,ACCOUNT,group1@example.com

A 查询词 是应用于 Vault 查询和保留所涵盖的数据的过滤器。它指定了 Google 服务和服务特定条款，例如：

MAIL,from:user1 subject:Hello has:attachment
GROUPS,from:group1

对于地点，可用的位置类型取决于所选的 Google 服务。例如，对于 Google 邮件服务，只能使用邮件、组织单位 和 整个组织 位置类型。 整个组织 位置类型也仅适用于邮件服务。

2.7.5. 导出保管库保存的查询

此操作使用以下设置在选定的 Vault 案件中创建 Vault 导出：

导出名称前缀：导出名称中使用的前缀。
区域：导出请求的数据区域。
消息格式：导出消息的文件格式。
邮件选项：
- 包含 Gmail 机密模式内容：导出机密模式内容。
- 使用新的导出系统：使用新的导出系统。
- 导出链接的云端硬盘文件：为链接的云端硬盘文件创建链接导出。
驱动选项：
- 包括间接访问文件的用户的访问级别信息：包括间接访问文件的用户的访问级别信息。
保存的查询标识符类型：标识符的类型。
保存的查询标识符：用于查找已保存查询的标识符。
等待完成：等待导出完成。

消息格式 仅适用于 Gmail、网上论坛、聊天和语音服务。

2.7.6. 下载 Vault 导出

此操作使用以下设置从选定的保管库案件下载保管库导出：

下载位置：将导出文件下载到的文件夹。
明确包含链接导出：下载链接的导出。
导出标识符类型：标识符的类型。
导出标识符：用于查找导出的标识符。

在 [_出口_vault_已保存_queries] 操作中使用 导出链接的云端硬盘文件 设置时会创建链接导出。

2.7.7. 设置保管库导出

此操作使用以下设置选择 Vault 导出：

明确包含链接导出：包括链接导出。
等待完成：等待导出完成。
导出标识符类型：标识符的类型。
导出标识符：用于查找导出的标识符。

2.7.8. 添加保管库保留

此操作使用以下设置在选定的保管库案件中添加保管库保留：

保留姓名前缀：保留名称中使用的前缀。
邮件/群组选项：
- 使用日期范围：设置日期范围以使用以下设置过滤保留所涵盖的数据：
  - 开始日期：日期范围的 UTC 开始日期。
  - 结束日期：日期范围的 UTC 结束日期。
驾车/聊天选项：
- 将项目包含在共享云端硬盘中：将文件包含在共享云端硬盘中。
- 在聊天空间中包含对话：在用户所属的聊天空间中包含消息。
保留地点和条款：
- 从 CSV 文件中读取：从 CSV 文件中读取保留位置和查询条件。
  - 保存位置文件：包含保留位置列表的文件。
  - 查询条件文件：包含查询词列表的文件。
- 手动输入：手动输入保留地点和条件。
  - 持有地点：带有要添加的保留位置的表格。
  - 查询条件：包含要添加的查询项的表格。

有关位置和 查询词 的定义和示例，请参阅 [_创造_vault_已保存_queries]。

2.7.9. 从保管库保留中删除位置

此操作使用以下设置从所选 Vault 案件中的 Vault 保留中删除位置：

所有持有地点：删除所有保留位置。
保存位置文件：包含要删除的保留位置值列表的文件。
持有地点：包含要删除的保留位置值的表。
从所有保留中移除：从所有保留中删除指定位置。
保留标识符类型：标识符的类型。
保留标识符：用于查找保留的标识符。

如果从保留中删除所有位置，则该保留也将被删除。

2.8. 努克斯调查

这些操作分配 Nuix 案例中项目的权限，以便在 Nuix Investigate 中使用。

2.8.1. 将项目添加到文件夹

此操作将 Nuix 案例中与 范围查询 和特定文件夹查询匹配的项目分配给指定的 文件夹。

如果选择选项 在路径中包含项目，则将包含路径中直到根项目（包括根项目）的所有项目。

2.8.2. 从文件夹中删除项目

此操作将从 Nuix 案例中删除与 范围查询 和特定文件夹查询与指定 文件夹 匹配的项目。

2.8.3. 将文件夹分配给组

此操作将 资料夹 分配给 Nuix Investigate 团体，由名称或 ID 标识。

2.9. 发现

这些操作在 Nuix 案例和 Nuix Discover 之间传输数据并管理 Nuix Discover 中的构建。

2.9.1. 配置 Nuix Discover 连接

此操作设置用于连接到 Nuix Discover 环境的配置。

或者，可以使用 发现服务 并指向 发现服务 类型的参数。在 Scheduler 中提交工作流期间，系统将提示用户选择 Nuix Discover 服务，并根据需要对该服务进行身份验证。

当不使用 Nuix Discover 服务时，操作中显式定义以下选项：

发现主机名：Nuix Discover API 的主机名，例如 ringtail.us.nuix.com
API令牌：要连接的 API 令牌。该令牌可以从 Nuix Discover 用户管理页面 → 用户 → 用户名 → API 访问获取。

2.9.2. 设置Nuix发现案例

此操作使用以下设置检索指定的案例 ID：

案例标识符：
- ID：Nuix Discover 案例 ID。
- 名称：Nuix Discover 案例名称。
- 名称（正则表达式）：匹配 Nuix Discover 案例名称的正则表达式。
文件库：用于上传本机文件的存储库类型。对于本地 Nuix Discover 部署，设置为 Windows文件共享 location 对应于 Nuix Discover 案例的导入文件夹。对于 SaaS 部署，请使用 亚马逊S3 存储库。

通常可以从Nuix Discover案例的名称派生*文件库*位置，例如使用类似于`\\DISCOVER.local\Repository\Import\{discover_case_name}`的路径。但是，在某些情况下，导入文件夹的名称可以与Nuix Discover案例的名称不同，例如，如果案例名称包含空格或非字母数字字符（例如标点符号），或者存在两个具有相同名称的案例。在这种情况下，可以使用脚本来规范Nuix Discover案例名称并派生预期的导入文件夹。

现有情况：案例不存在时采取的行动：
- 通过克隆源案例创建一个新案例
- 如果不存在这种情况，*仅使用现有案例*会引发错误。
等待案件生效：等待案件激活的指定时间。

在将文档升级到Nuix Discover之前，请先使用*等待案件生效*选项进行专用操作，以确保可以上载文档。

克隆设置：克隆案例时使用的设置。

2.9.3. 推广至Nuix Discover

此操作从Nuix案例导出生产集，并将项目上载到Nuix Discover。

可以配置以下设置：

生产集名称：推广到 Nuix Discover 的生产集的名称。
导出标准元数据：将项目标准元数据导出到 Nuix Discover。如果选中，元数据配置文件的副本将保存在导出文件夹中。
从配置文件导出自定义元数据：可选，用于将其他元数据导出到 Nuix Discover 的元数据配置文件。要使用此选项，请确保 Nuix Discover 案例配置了自定义元数据配置文件中定义的字段。
在 Nuix Discover 中运行索引：上传文档后在 Nuix Discover 中触发索引。

启用*在 Nuix Discover 中运行索引*选项可对内容进行解析，并可以在Nuix Discover中进行搜索。

在 Nuix Discover 中运行重复数据删除：在上传文档后触发 Nuix Discover 中的重复数据删除。
文件识别码策略：从 Nuix Discover 案例中分配新的 顺序的 文档编号，或使用 Nuix 生产集 编号。
水平：导入文档的 Nuix Discover 级别。
每级文件：每个级别的最大文档数。
文件类型：选择要上传到 Nuix Discover 案例的组件：
- 本地文件
- 文本从 Nuix 外壳中取出
- PDF 文件图片
临时导出文件夹：创建临时合法导出的文件夹。上传完成后，本机和文本文件从临时文件夹中删除。
分割出口：将导出和上传分解为指定最大项目数的多个部分。
等待 Nuix Discover 作业完成：等到项目已加载到 Nuix Discover 中，然后再移动到下一个上传部分或在完成操作之前。

将邮件、联系人、日历转换为，*出口方案*和*将失败的项目标记为*选项的行为与Legal Export操作中的行为相同。

2.9.4. 从 Nuix Discover 检索元数据

此操作从 Nuix Discover 中的项目读取元数据，并应用自定义元数据或标记 Nuix 项目。

可以配置以下设置：

Nuix 范围查询：选择要更新的项目的 Nuix 查询。

行动：对 Nuix 项目执行的操作

标记匹配项：标记 Nuix Discover 和 Nuix case 中存在的项目
检索字段：从 Nuix Discover 检索字段并将其作为自定义元数据应用于 Nuix 案例中的匹配项
标记匹配项和检索字段：执行上述两个动作

Nuix 发现项目源: Nuix Discover 中哪里可以查询项目

所有文件：Nuix Discover 案例中的所有文档
保存的搜索：与已保存的搜索匹配的项目
生产: 制作中的物品
活页夹：活页夹里的物品

匹配 Nuix 项目：项目的 GUID 或 文档 ID，用于匹配 Nuix Discover 中的项目

匹配 Nuix 发现项目： 文档 ID 或 命名字段 用于匹配 Nuix 案例中的项目

使用*名称字段*范围时，用户必须提供一个字段，以便将 Nuix Discover 中的项目与 Nuix case 中的项目进行匹配

Nuix 标签名称：当 Nuix discovery 中的项目与 Nuix case 中的项目匹配时使用的标签名称

导出 CSV：将 Nuix Discover 文档的字段值导出到`CSV`文件

Nuix 发现字段：从 Nuix Discover 检索的字段

除了手动提供 Nuix Discover 字段的值之外，用户还可以从 CSV 或 TSV 文件加载，例如：

Field Name
[Meta] GUID
Document Type
Created By

2.10. 夜间ECC

这些操作使用 Nuix ECC 执行操作。

2.10.1. 配置 Nuix ECC 连接

此操作设置用于连接到 Nuix ECC 环境的配置。

或者，可以使用 Nuix ECC 服务 并指向 Nuix ECC 服务 类型的参数。在 Scheduler 中提交工作流期间，系统将提示用户选择 Nuix ECC 服务。

主机名：Nuix ECC 实例的主机名
端点类型：Nuix ECC 端点类型，例如 HTTPS。
用户名：用于连接 Nuix ECC 实例的用户名。
密码：上面用户名的密码。

在此字段中输入的值将以明文形式存储在工作流文件中-不应在此字段中输入密码。而是将此字段设置为受保护的参数名称，例如`{nuix_ecc_password}`，有关如何设置受保护的参数值的说明，请参见Protected Parameters节。

2.10.2. 套装 Nuix ECC 案例

此操作使用以下设置设置用于 Nuix ECC 集合的情况：

案例标识符：Nuix ECC 案例的名称、ID 或 名称（正则表达式）
如果不存在则创建案例：（可选）如果指定的 ECC 案例不存在，则创建一个新的 Nuix ECC 案例。

2.10.3. 设置 Nuix ECC 收集配置

此操作使用以下设置设置用于 Nuix ECC 集合的配置：

配置标识符：Nuix ECC Collection 配置的名称、ID 或 名称（正则表达式）

2.10.4. 将集合源添加到 Nuix ECC 集合

此操作使用以下设置添加 Nuix ECC 集合的收集来源：

收藏来源：收集来源：
- 标识符：来源的标识符，例如`LAPTOP-4KYG769`
- 标识符类型：用于确定如何识别源的名称、ID 或 名称（正则表达式）
- 来源类型：用户正在使用的来源类型，例如`Computer`
- 采集策略：从源收集时使用的策略，使用配置 或 使用自定义路径
- 集合自定义路径：要从中收集的自定义路径，例如`C:\Data\Files`

使用收集策略 使用配置 时，来源必须具有预定义的收集位置。此设置是在 ECC 管理控制台应用程序中定义的。

除了手动提供收集源的值之外，用户还可以从 CSV 或 TSV 文件加载，例如：

Identifier  IdentifierType  SourceType  CollectionStrategy  CollectionCustomPaths
LAPTOP-4KYG769  NAME    COMPUTER    PREDEFINED  ""
Server\s\d  NAME_REGEX  COMPUTER    PREDEFINED  ""
119 ID  COMPUTER    CUSTOM_PATH "C:\Data\Files,C:\Users\Admin\Documents,D:\Temp"

从 CSV 或 TSV 文件指定收集源时，如果用户使用自定义路径，则路径必须使用逗号分隔符 ,，例如 C:\Data\Files,C:\Users\Admin\Documents

2.10.5. 部署 Nuix ECC 代理

此操作用于在计算机上部署 Nuix ECC 代理，使用以下设置：

服务帐户用户名：用于在计算机上运行命令的服务帐户的用户名
服务账号密码：用于在计算机上运行命令的服务帐户的密码
计算机名称：部署 ECC 代理的计算机名称，例如 DESKTOP-AZH1K4

除了手动提供计算机名称的值之外，用户还可以从 CSV 或 TSV 文件加载，例如：

ComputerName
LAPTOP-4KYG769
DESKTOP-AZH1K4
Server2

安装命令：用于在计算机上安装ECC代理的命令

使用 WinRS 部署代理的示例：

winrs /r:{computer_name} /u:{username} /p:{password} "msiexec.exe /i PATH_TO_INSTALLER /q /norestart"

使用 PsExec 部署代理的示例：

PATH_TO_PSEXEC \\{computer_name} -u {username} -p {password} -nobanner -s msiexec.exe /i PATH_TO_INSTALLER /q /norestart

PATH_TO_INSTALLER 是 ECC 客户端安装程序的路径，例如 \\Storage\Installers\ECC_Client_Installer.msi。 PATH_TO_PSEXEC 是 PsExec 可执行文件的路径，例如 C:\SysInternals\psexec.exe

安装命令使用自定义参数并公开 {computer_name}、{username} 和 {password}。用户名和密码参数将始终是服务帐户用户名和服务帐户密码。计算机名称参数将更改为正在安装代理的计算机的名称。

失败时重试命令：如果第一次运行失败，则重试安装命令，用户还可以选择设置要重试命令的次数
暂停：代理部署并在 Nuix ECC 管理控制台上可见的时间。

超时针对命令并适用于命令的每次运行，例如，如果用户设置 2 分钟的超时并允许最多 5 次命令重试，则每次命令运行时，命令将每两分钟超时一次。如果命令失败 5 次，则命令的总时间将为 10 分钟。

2.10.6. 提交 Nuix ECC 集合

此操作使用以下设置向 ECC 提交 Nuix ECC 集合：

藏品名称：Nuix ECC Collection 的名称

如果集合中有多个集合源，Nuix ECC 集合的名称可能会更改，具有多个集合源的集合的格式为`collection_name (1 of 4)。其中集合名称是集合的名称1是集合源的索引，4`是集合中集合源的总数。

等待采集完成：可选地，等待 Nuix ECC 收集完成，然后再进行下一个操作。
集合地点：收集的文件的存储位置。该位置必须可供所有计算机使用。

2.10.7. 删除 Nuix ECC 代理

此操作用于删除计算机上的 Nuix ECC 代理，使用以下设置：

服务帐户用户名：用于在计算机上运行命令的服务帐户的用户名
服务账号密码：用于在计算机上运行命令的服务帐户的密码
计算机名称：要删除 ECC 代理的计算机的名称，例如 DESKTOP-AZH1K4

除了手动提供计算机名称的值之外，用户还可以从 CSV 或 TSV 文件加载，例如：

ComputerName
LAPTOP-4KYG769
DESKTOP-AZH1K4
Server2

卸载命令：用于卸载计算机上的ECC代理的命令

使用 WinRS 卸载代理的示例：

winrs /r:{computer_name} /u:{username} /p:{password} "msiexec.exe /x PATH_TO_INSTALLER /q /norestart"

使用 PsExec 卸载代理的示例：

PATH_TO_PSEXEC \\{computer_name} -u {username} -p {password} -nobanner -s msiexec.exe /x PATH_TO_INSTALLER /q /norestart

卸载命令使用自定义参数并公开 {computer_name}、{username} 和 {password}。用户名和密码参数将始终是服务帐户用户名和服务帐户密码。计算机名称参数将更改为正在安装代理的计算机的名称。

失败时重试命令：如果第一次运行失败，则重试卸载命令，用户还可以选择设置要重试命令的次数
暂停：代理被移除的时间

2.11. Nuix引擎

这些操作使用 Nuix 引擎执行操作。

2.11.1. 配置 Nuix

此操作用于定义 Nuix 处理引擎的设置，来自 Nuix 配置配置文件 和/或 Nuix 正在处理配置文件。建议使用 处理资料 而不是 配置配置文件。

默认情况下，Nuix将配置配置文件存储在用户特定的文件夹`%appdata%\Nuix\Profiles中。要使配置文件可供所有用户使用，请将相应的*.npf`文件复制到`%programdata%\Nuix\Profiles*`。

Nuix Rampiva 工作流程仅支持配置文件中的一部分设置，包括证据处理设置（日期处理、MIME 类型、并行处理）、合法导出（导出类型 - 部分、加载文件 - 部分、并行处理）。

配置工人

可以从Nuix设置中提取工作程序设置（请参见上文），也可以在工作流程中明确提供工作程序设置。

对于本地工作程序，这些设置可用于指定本地工作程序的数量，每个工作程序的内存以及工作程序临时目录。

Nuix 不支持在没有本地工作人员的情况下运行 OCR 操作和合法导出操作。如果在这些操作的本地工作人员中指定值 0，Nuix Rampiva Workflow 将使用 1 个本地工作人员和请求的任意数量的远程工作人员启动操作。

对于远程工作者，必须指定远程工作者的数量，工作者代理IP地址和端口。

在启动工作流之前，工作者代理必须正在运行，以避免Nuix出现不可恢复的错误，该错误将终止工作者的执行。

如果在开始需要工作人员的操作时无法立即获得请求的远程工作人员数量，Nuix Rampiva Workflow 将继续尝试分配所需数量的工作人员，直到操作结束。

也可以使用以下参数来设置并行处理设置：

{local_worker_count}-当地工人人数；
{local_worker_memory}-每个本地工作者的内存（以MB为单位）；
{broker_worker_count}-要分配的远程工作者的数量；

密码设定

在Nuix中加载和重新加载数据期间使用密码。本部分允许指定密码文件的密码列表的使用。

密钥库设置

在 Nuix 中加载和重新加载数据期间会使用密钥库。此部分允许指定包含密钥库信息的 CSV 或 TSV 文件。

密钥库配置文件需要以下列：

路径：密钥库的文件路径
密码：密钥库的密码
别名：密钥库中要使用的别名
别名密码：别名的密码
目标：笔记存储格式文件`(NSF)`

样品*Lotus Notes编号*：

Path	Password	Alias	AliasPassword	Target
C:\Stores\Lotus\user.id	password			example.nsf
C:\Stores\Lotus\rampiva.id	password123			rampiva.nsf

配置*Lotus Notes编号*存储时，目标可以是便笺存储格式文件`(NSF)或*文件名*。另外，可以将目标设置为*，以将ID文件应用于任何(NSF)`文件。

显示showing，*PKCS12*和*Lotus Notes编号*的示例：

Path	Password	Alias	AliasPassword	Target
C:\Stores\PGP\0xA8B31F11-sec.asc		test@rampiva.com	test_password
C:\Stores\PKCS12\template.keystore	password	ssl_cert
C:\Stores\Lotus\user.id	password			example.nsf
C:\Stores\PKCS12\rampiva.keystore	password123	rampiva-sample
C:\Stores\PGP\0x9386E293-sec.asc		user@rampiva.com	abcd1234

配置密钥库文件时，并非所有列都有值，在将此文件添加到工作流之前，请验证值是否位于正确的列中。

可以使用以下参数设置单个密钥库：

{keystore_file_path} - 密钥库的路径。
{keystore_file_password} - 密钥库的密码。
{keystore_file_alias} - 从密钥库使用的别名。
{keystore_file_alias_password} - 别名的密码。
{keystore_file_target} - 笔记存储格式文件`(NSF)`。

当使用单个密钥库时，`{keystore_file_path}`参数必须包含要添加的密钥库的有效文件路径。

也可以使用以下参数设置密钥库文件：

{keystore_tsv} - 密钥库 CSV 或 TSV 文件的文件路径；

在执行配置文件中需要 Nuix 配置文件

在 Nuix Rampiva 中使用工作流程时，选择选项 要求在执行配置文件中提供所有 Nuix 配置文件 选项将要求工作流程中使用的所有 Nuix 配置文件都在执行配置文件中显式提供。如果配置文件丢失，作业将无法启动。

2.11.2. 用例

根据指定的an选项，此操作将打开现有的Nuix外壳或创建一个外壳。

通过设置参数`{case_timezone_id}`可以覆盖时区时区。有关有效时区ID的列表，请参见Joda Time Zones。

2.11.3. 添加到复合箱

此操作将现有案例添加到当前打开的Nuix案例中。

当前的Nuix大小写必须是复合大小写，否则此操作将在执行期间失败。

默认情况下，复合案例将在添加所有子案例后关闭并重新打开。选项 跳过重装复合箱 更改此行为并且不重新加载复合案例。使用此选项时，由于未刷新复合大小写，某些操作可能无法正确执行。

2.11.4. 添加证据

此操作为Nuix案增添了证据。

使用*范围*设置定义添加到Nuix大小写的数据类型：

路径项目：将文件或文件夹添加为证据容器。
路径内容：将文件夹的内容添加为证据容器。
路径内容作为单独的证据：为基础文件夹中的每个文件或子文件夹创建单独的证据容器。
加载文件：添加 Concordance、CSV 或 EDRM XML 1.2 加载文件的内容作为证据容器。
证据清单：为列表中的每一行创建一个证据容器。见 Add Evidence from Evidence listing.
Google 保险柜导出：为每个 Google Vault 导出创建一个证据容器，并将 Drive Link 导出文件添加为子项。请参阅 Add Evidence from Google Vault Exports。
资料集：将数据集的内容添加为证据容器。见 Add Evidence from Data Set.
微软图：使用 Microsoft Graph 将团队、日历、联系人、Sharepoint 数据添加到证据容器。见 Add Evidence from Microsoft Graph.
的SharePoint：将 SharePoint 数据添加到证据容器。见 Add Evidence from SharePoint.
交换：将 Exchange 数据添加到证据容器。见 Add Evidence from Exchange.
企业保管箱：将 Enterprise Vault 数据添加到证据容器。见 Add Evidence from Enterprise Vault.
S3：将 S3 数据添加到证据容器。见 Add Evidence from S3.
SQL服务器：将 SQL Server 数据添加到证据容器。见 Add Evidence from SQL Server.
甲骨文：将 Oracle 数据库数据添加到证据容器中。见 Add Evidence from Oracle.
Documentum：将文档数据添加到证据容器。见 Add Evidence from Documentum.
投寄箱：将 Dropbox 数据添加到证据容器。见 Add Evidence from Dropbox.
SSH协议：将 SSH 数据添加到证据容器。见 Add Evidence from SSH.
历史推特：将历史 Twitter 数据添加到证据容器中。见 Add Evidence from Historical Twitter.

设置中指定的源数据时区，并且可以通过设置参数`{data_timezone_id}`进行覆盖。有关有效时区ID的列表，请参见Joda Time Zones。

可以在设置中指定源编码和zip编码。

2.11.5. 去除重复项目

如果选择此选项，则数据将在摄取时进行重复数据删除。除非将数据分批添加到案例中，否则需要选择选项*针对多个批处理负载进行跟踪和重复数据删除*。

摄取时重复数据删除机制旨在用于加载大量数据且预计具有高重复级别的特定场景。由于在摄取期间Nuix辅助程序之间需要实时同步，因此一次只能在服务器上运行一次具有重复数据删除功能的摄取，并且不能添加任何远程辅助程序。

处理重复项：

仅元数据处理：使用元数据字段track跟踪重复数据删除状态。顶级原始项目在此字段中将具有值`true，并将处理所有典型的元数据和后代-后代将不会填充此元数据字段。顶级重复项在此字段中将具有值Load original`，而元数据字段except则将没有其他属性，该字段将指示原始文档的GUID，具有与重复文档相同的重复数据删除键。

要查询所有未标记为重复项的项目，请使用查询`!boolean-properties:"Load original":false`。

将完全跳过被标识为重复项的项目，并且在这种情况下将不存在这些项目的引用。

去除重复项目方法：

顶级MD5：使用顶级项目的MD5哈希。
电子邮件ID：使用第一个非空白字段中的电子邮件Message-ID属性：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。
电子邮件MAPI搜索密钥：使用第一个非空白字段中的电子邮件MAPI搜索关键字属性：Mapi-Search-Key，X-Mapi-Search-Key。

要获得与导入后的Nuix ItemSet重复数据删除类似的重复数据删除结果，请仅选中选项*顶级MD5*。为了获得最全面的重复数据删除结果，请检查所有三个选项。

the文件夹中的电子邮件不会基于Message-ID和MAPI搜索键进行重复数据删除，原因是该文件夹中的数据通常不可靠。

2.11.6. 日期过滤器

除*没有过滤器*以外的所有其他模式均指定要加载数据的时间段。日期过滤器之外的所有项目都将被完全跳过，并且在这种情况下将不存在这些项目的引用。

2.11.7. 哑剧类型过滤器

允许设置过滤器以将某些MIME类型的数据限制为特定名称。

例如，具有MIME类型type和项目名称*邮箱-约翰·史密斯*的过滤器模式*火柴*将具有以下效果：

PST或EDB文件中的项目在其路径中必须具有名为Mailbox-John Smith的第一个Outlook文件夹。
不在PST或EDB文件中的项目不受影响。

Mime类型过滤器可用于选择要从Exchange数据库（EDB）文件加载的特定文件夹。

2.11.8. 从证据列表添加证据

选择范围选项 证据清单 时，源路径应指向具有以下列的 CSV 或 TSV 文件：

名称：证据容器的名称
路径：要加载的文件或文件夹的路径
保管人：可选，要分配的保管人值
时区：可选，时区ID，用于加载数据。有关有效时区ID的列表，请参见link:https://www.joda.org/joda-time/timezones.html[Joda Time Zones]。
编码方式：可选，用于加载数据的编码。
邮编编码：可选，用于加载zip文件的编码。

如果指定了其他列，则将这些列设置为自定义证据元数据。

如果未提供可选设置，则将使用“添加证据”操作中的默认设置。

选择选项 省略证据文件夹名称 时，列表中包含的每个证据的路径中的最后一个文件夹名称将不会包含在 Nuix 案例的路径中。相反，文件夹中的所有项目将直接显示在证据容器下。

样本证据清单：

Name	Path	Custodian	Encoding	Timezone	Sample Custom Field	Another Sample Field
Evidence1	C:\Data\Folder1	Morrison, Jane	UTF-8	Europe/London	Value A	Value B
Evidence2	C:\Data\Folder2	Schmitt, Paul	Windows-1252	Europe/Berlin	Value C	Value D

2.11.9. 从数据集中添加证据

选择“范围”选项*资料集*时，*资料集编号*字段应指向在*配置*操作中定义的数据集参数。

资料集 范围仅与 Nuix Rampiva Scheduler 中提交的作业以及具有与其关联的数据集的事务兼容。

2.11.10. 添加来自 Google Vault 导出的证据

选择范围选项 Google 保险柜导出 时，源路径应指向包含所有 Google Vault 导出和 Drive Link 导出的文件夹。这与从 [_下载_vault_exports] 操作下载导出时获得的文件夹结构相同。

有三种不同的方法可以添加 Drive Link Exports：

作为家庭用品：跳过为 Drive Link Export 创建证据容器，并将每个 Drive Link 文件添加为家庭项目。
- 链接导出文件添加为家庭项目限制：限制驱动器链接文件可以添加为家庭项目的次数。达到限制后，将使用占位符来代替。
- 使用重复族中的占位符替换链接导出文件：是否使用占位符作为驱动器链接文件遇到重复的家庭时。
作为完整独立商品 + 占位系列商品：为 Drive Link Export 创建一个证据容器，并将占位符文件作为家庭项目添加到 Drive Link 文件的位置。
作为独立物品：为 Drive Link Export 创建一个证据容器，但不提供任何指向父导出文件的链接。

使用 作为家庭用品 选项时，如果要将大量驱动器链接文件添加为系列项目，则操作可能需要很长时间。使用其他方法或项目限制可以帮助避免此问题。

占位符文件用于减轻将驱动器链接文件添加为系列项目的压力。

所有占位符文件都跟踪 内容项 GUID 自定义元数据，该元数据指向占位符所代表的完整项目。

添加所有 Google Vault 导出和 Drive Link 导出后，选项 关联 Google Vault 元数据 将从导出文件夹中的元数据 xml 和 csv 文件中解析并分配自定义元数据。

2.11.11. 从 Microsoft Graph 添加证据

使用 Microsoft Graph 添加数据时，必须在 添加证据 操作之前定义以下配置参数。

{ms_graph_tenant_id}：Azure AD 的租户 ID。
{ms_graph_client_id}：已向 Azure AD 注册并授予必要权限的应用程序的客户端/应用程序 ID。
{ms_graph_client_secret_protected}：已为提供的客户端 ID 配置的客户端密钥，用于身份验证。
{ms_graph_certificate_store_path}：PKCS#12 证书存储的路径，用于代替客户端密钥进行身份验证。
{ms_graph_certificate_store_password}：PKCS#12 证书存储的密码（如果存在）。
{ms_graph_username}：可选，作为要处理的团队成员的用户的用户名，仅在摄取团队日历时需要。
{ms_graph_password}：用户名的密码（如果存在）。

对于身份验证，必须设置 {ms_graph_client_secret_protected} 或 {ms_graph_certificate_store_path} 参数之一。

{ms_graph_start_datetime}：收集日期范围的开始。
{ms_graph_end_datetime}：收集日期范围的结束日期。

对于日历集合（用户或团队），日期范围不能超过 5 年。

{ms_graph_retrievals}：要检索的内容类型列表，包含以下一个或多个值：TEAMS_CHANNELS、TEAMS_CALENDARS、USERS_CHATS、USERS_CONTACTS、USERS_CALENDARS、USERS_EMAILS、ORG_CONTACTS、SHAREPOINT。
{ms_graph_mailbox_retrievals}：可选，要从中检索的区域列表，包含以下一个或多个值：MAILBOX、ARCHIVE、PURGES、DELETIONS、RECOVERABLE_ITEMS、ARCHIVE_PURGES、ARCHIVE_DELETIONS、ARCHIVE_RECOVERABLE_ITEMS、PUBLIC_FOLDERS。默认情况下，只检索 MAILBOX 区域。
{ms_graph_team_names}：（可选）要过滤的团队名称列表。
{ms_graph_user_principal_names}：（可选）要过滤的用户主体名称列表。
{ms_graph_version_retrieval}：可选地，应检索指示所有版本的布尔值。默认为`false`
{ms_graph_version_limit}：可选的，如果启用版本检索，则限制检索的版本数量的整数。默认为 -1 检索所有可用版本。

Microsoft Graph 集合参数示例：

{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

有关如何配置 Microsoft Graph 身份验证的详细信息，请参阅 Microsoft Graph 连接器上的 Nuix 文档，网址为 https://download.nuix.com/system/files/Nuix%20Connector%20for%20Microsoft%20Office%20365%20Guide%20v9 .0.0.pdf

2.11.12. 从SharePoint添加证据

从SharePoint添加数据时，必须在*添加证据*操作之前定义以下配置参数。

{sharepoint_uri}：一个指定站点地址的URI。
说明：此可选参数定义服务器帐户的Windows网络域。
{sharepoint_username}：访问帐户所需的用户名。
{sharepoint_password}：访问帐户所需的密码。

2.11.13. 添加来自交易所的证据

从Exchange添加数据时，必须在*添加证据*操作之前定义以下配置参数。

{exchange_uri}：Exchange Web 服务的路径（例如 https://ex2010/ews/exchange.asmx）。
说明：此可选参数定义服务器帐户的Windows网络域。
{exchange_username}：访问帐户所需的用户名。
{exchange_password}：访问帐户所需的密码。
{exchange_mailbox}：要提取的邮箱与用户名不同。
{exchange_impersonating}：布尔值，默认为`false`。此可选设置指示Exchange模拟邮箱用户，而不是在邮箱和用户名不同时委派。
{exchange_mailbox_retrieval}：包含以下一个或多个值的列表：mailbox，archive，purges，deletions，recoverable_items，archive_purges，archive_deletions，archive_recoverable_items，public_folders。
{exchange_from_datetime}：此可选参数将证据限制为从指定日期/时间开始的日期范围。它必须带有`{exchange_to_datetime}`参数。
{exchange_to_datetime}：此可选参数将证据限制为以指定的日期/时间结束的日期范围。它必须带有`{exchange_from_datetime}`参数。

2.11.14. 从Enterprise Vault添加证据

从Enterprise Vault添加数据时，必须在执行*添加证据*操作之前定义以下配置参数。

{ev_computer}：Enterprise Vault的主机名或IP地址。
{ev_vault}：保管库存储ID。此可选参数将证据限制为指定的Enterprise Vault保管库。
{ev_archive}：存档ID。此可选参数将证据限制为指定的Enterprise Vault归档。
{ev_custodian}：一个名字。此可选参数将证据限制为指定的保管人或作者。
{ev_from_datetime}：此可选参数将证据限制为从指定日期/时间开始的日期范围。它必须带有`{ev_to_datetime}`参数。
{ev_to_datetime}：此可选参数将证据限制为以指定的日期/时间结束的日期范围。它必须带有`{ev_from_datetime}`参数。
说明：此可选参数将证据限制为使用此字符串中的单词匹配Enterprise Vault查询的结果。主题和邮件/文档内容由Enterprise Vault搜索，并且它将与字符串中的任何单词匹配，除非在`{ev_flag}`参数中指定不同。
{ev_flag}：any、all、allnear、phrase、begins、beginany、exact、exactany、ends、endsany 中的可选值。

{ev_flag}`参数指定如何组合和处理基于关键字的查询中的关键字。它必须带有{ev_keywords}参数，但如果省略则默认为any`。

2.11.15. 添加来自S3的证据

从S3添加数据时，必须在*添加证据*操作之前定义以下配置参数。

说明：此参数指定Amazon Web Service帐户的访问密钥ID。
说明：此参数指定Amazon Web Service帐户的秘密访问密钥。
说明：此可选参数仅在未指定访问权限和机密时才有效。 `true`值允许按系统属性发现凭证。 `false`或省略的值将尝试匿名访问指定的存储桶。
说明：此可选参数指定存储桶以及存储桶中包含要提取的证据的文件夹的路径（可选）。例如，mybucketname/top folder/sub folder。省略此参数将导致将所有存储桶添加到证据中。
说明：此可选参数指定特定的Amazon Web Service服务器终端节点。这可以用于连接到特定的区域服务器，例如`https://s3.amazonaws.com`。

2.11.16. 添加来自Documentum的证据

从Documentum添加数据时，必须在*添加证据*操作之前定义以下配置参数。

说明：此可选参数定义服务器帐户的Windows网络域。
{documentum_username}：访问帐户所需的用户名。
{documentum_password}：访问帐户所需的密码。
{documentum_port_number}：要连接的端口号。
{documentum_query}：DQL查询。此可选参数指定用于过滤内容的查询。
{documentum_server}：此参数指定Documentum服务器地址。
说明：此参数指定Documentum文档库。
说明：此可选参数指定Documentum属性文件。

2.11.17. 从SQL Server添加证据

从SQL Server添加数据时，必须在*添加证据*操作之前定义以下配置参数。

说明：此可选参数定义服务器帐户的Windows网络域。
{sql_server_username}：访问帐户所需的用户名。
{sql_server_password}：访问帐户所需的密码。
{sql_server_computer}：SQL Server的主机名或IP地址。
{sql_server_max_rows_per_table_number}：每个表或查询要返回的最大行数。此参数是可选的。在处理具有很多行的表或查询结果时，可以节省时间。选择返回哪些行应该被认为是任意的。
{sql_server_instance}：SQL Server实例名称。
{sql_server_query}：SQL查询。此可选参数指定用于过滤内容的查询。

2.11.18. 添加来自Oracle的证据

从Oracle添加数据时，必须在*添加证据*操作之前定义以下配置参数。

{oracle_username}：访问帐户所需的用户名。
{oracle_password}：访问帐户所需的密码。
{oracle_max_rows_per_table}：每个表或查询要返回的最大行数。此参数是可选的。在处理具有很多行的表或查询结果时，可以节省时间。选择返回哪些行应该被认为是任意的。
{oracle_driver_type}：用于连接的驱动程序类型。可以是`thin，oci或kprb`。
{oracle_database}：连接参数的字符串表示形式。可能的格式在https://www.oracle.com/database/technologies/faq-jdbc.html#05_04中进行了说明
{oracle_role}：登录角色，例如`SYSDBA或SYSOPER`。对于普通登录，该字段应为空白。
{oracle_query}：一个SQL查询。此参数指定用于过滤内容的查询。

2.11.19. 从Dropbox添加证据

从Dropbox添加数据时，必须在*添加证据*操作之前定义以下配置参数。

{dropbox_auth_code_protected}：通过Dropbox上的网页检索的字符串，该字符串可访问帐户。
{dropbox_team_boolean}：一个布尔值，指示将Dropbox组添加到证据。应该存在此可选参数，并将Dropbox组添加到证据时对于所有调用都将其设置为`true`。添加单个Dropbox帐户可以省略。
{dropbox_access_token_protected}：使用authCode检索的字符串，该字符串允许访问帐户。如果已知帐户的访问令牌，请使用此参数而不是`{dropbox_auth_code_protected}`直接提供。除非帐户所有者撤消访问权限，否则此代码不会过期。

2.11.20. 从 Slack 添加证据

从 Slack 添加数据时，必须在 添加证据 操作之前定义以下配置参数。

{slack_auth_code_protected}：临时验证码。通过 Nuix Workstation 启动手动收集以检索此代码。
{slack_user_ids}：可选，应限制收集的用户的内部 Slack ID。
{slack_start_datetime}：可选，收集日期范围的开始。
{slack_end_datetime}：可选，收集日期范围的结束时间。

2.11.21. 从SSH添加证据

从SSH添加数据时，必须在*添加证据*操作之前定义以下配置参数。

{ssh_username}：访问帐户所需的用户名。
{ssh_password}：访问帐户所需的密码。
{ssh_sudo_password}：使用基于SSH密钥的身份验证时访问受保护文件所需的密码。
{ssh_key_folder}：指向本地系统上包含SSH身份验证密钥对的文件夹。
{ssh_computer}：Enterprise Vault的主机名或IP地址。
{ssh_port_number}：要连接的端口号。
{ssh_host_fingerprint}：连接的主机的预期主机指纹。如果未设置此值，则将允许任何主机指尖插入，从而有可能在连接中途受到攻击。
{ssh_remote_folder}：SSH主机上的一个文件夹，用于从其开始遍历。此可选参数将证据限于该起始文件夹下的项目。
{ssh_accessing_remote_disks_boolean}：布尔值设置为`true时，将显示远程磁盘（例如/dev/sda1`）作为证据，而不是远程系统文件系统结构。

2.11.22. 从历史推特添加证据

从Twitter添加数据时，必须在*添加证据*操作之前定义以下配置参数。

{twitter_access_token}：使用 authCode 检索的字符串，可以访问帐户。可以在 https://apps.twitter.com 上创建一个新应用来生成此令牌。
{twitter_consumer_key}：Twitter 应用的消费者密钥（API 密钥）。
{twitter_consumer_secret_protected}：Twitter 应用的消费者秘密（API 秘密）。
{twitter_access_token_secret_protected}：Twitter 应用程序的访问令牌秘密。

2.11.23. 添加证据库

此操作将证据存储库添加到案件。典型的Nuix选项可用于自定义证据存储库设置。

此操作不会将数据加载到外壳中。 *重新扫描证据存储器*操作必须用于添加数据。

2.11.24. 重新扫描证据存储器

此操作将重新扫描所有证据存储库，并向案件中添加新数据。

如果未发现新证据，则选项*没有新的证据行为*可用于显示警告，触发错误或完成工作流程的执行。

2.11.25. 检测并分配保管人

此操作使用以下选项之一检测托管人名称：

*从文件夹名称设置托管人*在指定的路径深度将托管人设置为与文件夹相同的名称。
*从文件夹名称中设置具有典型保管人名称的保管人*尝试从文件夹名称中提取托管人名称，其中文件夹名称包含流行的名字，直到指定的最大路径深度。
*从发送电子邮件的发件人名称的PST文件设置保管人*尝试从已发送文件夹中的电子邮件发件人名称中提取托管人名称。
从数据集元数据中设置托管人*设置在数据集元数据的`*Custodian`字段中定义的保管人名称。

使用 从文件夹名称设置托管人 选项时，请确保范围查询包含从 Nuix 案例根到定义的文件夹深度的所有文件夹。例如，查询 path-guid:{evidence_guid} 无效，因为它仅包含证据容器下方的项目，而不包含证据容器本身。另一方面，查询 batch-load-guid:{last_batch_load_guid} 是有效的，因为它包含该特定批次中加载的所有项目，包括证据容器和将分配托管值的所有文件夹。

也可以使用以下参数控制此操作的设置：

{set_custodian_from_folder_name}-启用或禁用*从文件夹名称设置托管人*选项；
{custodian_folder_level}-对应于*从文件夹名称设置托管人*选项的文件夹深度；
{set_custodian_from_typical_folder_name}-启用或禁用*从文件夹名称中设置具有典型保管人名称的保管人*选项；
{max_custodian_typical_folder_level}-对应于*从文件夹名称中设置具有典型保管人名称的保管人*选项的最大文件夹深度。
{set_custodian_from_pst}-启用或禁用*从发送电子邮件的发件人名称的PST文件设置保管人*选项；

可以将用于启用或禁用选项的参数设置为`true，yes或Y`以启用该选项，而将其他参数设置为禁用该选项。

2.11.26. 排除项目

此操作从与特定搜索条件匹配的情况中排除项目。

可以使用 + 和 - 按钮将条目添加到排除列表中，或者从 CSV 或 TSV 文件的排除列表中加载条目。

也可以使用*排除文件*选项在工作流程执行期间从文件中加载排除项。

可以在*排除文件*路径中使用参数，以根据工作流程的要求动态选择排除文件。

2.11.27. 包含项目

此操作包括先前排除的项目。

范围查询之外的排除项目将不包括在内。

可以包含属于所有排除类别的项目，或者，可以使用 + 和 - 按钮指定排除名称，或从文本文件加载。

2.11.28. 添加到项目集

如果不存在具有指定名称的项目集，则此操作将项目添加到现有项目集或创建新的项目集。

如果要添加到项目集中的项目列表为空，则将第一个根项目临时添加为填充项目，以帮助创建项目集批。

除了标准的 Nuix 重复数据删除选项之外，Nuix Rampiva Workflow 还提供两种额外的重复数据删除方法：

讯息编号：使用第一个非空字段中的电子邮件消息 ID 属性：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_互联网_MESSAGE_ID。
消息 ID/MD5：如果可用，则使用电子邮件 Message-ID 属性，或者使用 MD5。
Mapi搜索关键字：使用第一个非空白字段中的电子邮件MAPI搜索关键字属性：Mapi-Search-Key，X-Mapi-Search-Key。

当基于Message-ID或MAPI Search Key按系列执行重复数据删除时，将创建两个批次：一个批次用于顶级项目（后缀TL），另一批次用于非顶级项目（后缀NonTL）。要查询这两个批次中的原始物料，请使用语法：+item-set-batch:("{last_item_set_originals_batch} TL" OR "{last_item_set_originals_batch} NonTL")

2.11.29. 从项目集中删除

此操作从指定的项目集中删除项目（如果存在）。

2.11.30. 删除项目集

此操作将删除指定的项目集。

2.11.31. 将项目添加到摘要列表

此操作将项目添加到摘要列表，并带有创建摘要列表（如果不存在）的选项。

可以在三个摘要列表位置之一中创建摘要列表：

案例：箱子位置，相当于箱子文件夹`Stores\User Data\Digest Lists` 中的以下子文件夹
用户：用户个人资料位置，相当于`%appdata%\Nuix\Digest Lists`
本地计算机：计算机配置文件位置，相当于`%programdata%\Nuix\Digest Lists`

2.11.32. 从摘要列表中删除项目

此操作将从指定的摘要列表中删除项目（如果存在）。

2.11.33. 管理摘要列表

此操作对两个指定的摘要列表执行一个操作，然后将结果摘要列表保存在指定的摘要列表位置。

操作清单：

添加：产生摘要列表A或摘要列表B中存在的哈希；
减去：产生摘要列表A中存在的哈希值，但摘要列表B中不存在的哈希值
相交：产生摘要列表A和摘要列表B中都存在的哈希。

2.11.34. 删除摘要列表

此操作将从任何指定的摘要列表位置删除指定的摘要列表（如果存在）。

2.11.35. 摘要列表导入

此操作将文本或Nuix哈希文件导入到指定的摘要列表位置。

可接受的文件格式：

(.txt, .csv, .tsv)。如果文件仅包含一列，则每行应提供一个散列。如果文件包含“多列”，则标题为`MD5`的列应为
Nuix哈希`(.hash)`文件

2.11.36. 摘要列表导出

此操作将Nuix摘要列表作为文本文件导出到指定位置。生成的文本文件包含无标题的一列，每行一个哈希。

2.11.37. 搜索和标签

此操作标记符合特定搜索条件的案例中的项目。

选项：

识别家庭：如果选择，该操作将搜索家庭项目和每个关键字命中的项目的顶级项目。
识别后代 如果选中，该操作将搜索每个关键字命中的项目的后代。
识别独家匹配（“唯一”匹配） o如果选中，则操作将搜索独家命中（仅命中一个关键字的项目），独家家庭项目（整个家庭仅命中一个关键字的项目）和独家顶级项目（也是该项目的项目）全家人只点了一个关键词）。
计算大小 如果选中，该操作将计算 Hits 和 Family 项目的审核大小。
计算总数 如果选中，该操作将计算所有关键字的总计数和大小。
按保管人分类 如果选择，将为每个单独的保管人以及未指定保管人的项目执行搜索和报告。
记录结果 如果选择，搜索计数将打印在执行日志中。

2.11.38. 标记

如果选择*分配标签*选项，则将在以下标记结构下标记项目：

Tag prefix
- 命中
  - Keyword tag：与搜索查询匹配的项目。
- 家庭
  - Keyword tag：与搜索查询匹配的项目系列。
- 顶层
  - ：与搜索查询匹配的项目的顶级项目。
- 子级
  - Keyword tag：与搜索查询匹配的项目的后代。
- 独家命中
  - Keyword tag：仅与关键字匹配的项目。
- 独家家庭
  - ：仅在关键字上触及的家庭。
- ExclusiveTopLevel
  - ：仅在关键字上触及的家庭的顶级商品。

如果选择*删除带有此前缀的先前标签*选项，则根据*删除以前的标签方法*，无论搜索范围如何，所有以*标签前缀*开头的先前标签都将被删除。

此操作可以与空的关键字列表一起使用，并启用*删除带有此前缀的先前标签*，以便删除以前通过此操作或其他方式应用的删除标签。

删除带有此前缀的先前标签*方法将rename重命名为`*Rampiva|SearchAndTagOld|Tag prefix_{datetime}`。尽管此方法是禁忌的，但多次运行“搜索和标签”操作后，它会创建大量标签，这可能会减慢Nuix Workbench中的手动活动。

2.11.39. 报告中

此选项基于模板文件以Excel格式生成搜索报告。

有关使用自定义模板的信息，请参见Processing Report。

2.11.40. 关键词

关键字可以在工作流编辑器界面中手动指定，也可以从文件中加载。

支持以下文件格式：

.csv：逗号分隔的文件，第一列包含关键字名称或标签，第二列包含关键字查询。如果第一行是具有确切值 tag 和 query 的标题，则该行将被读取为标题。否则，它将被读取为带有关键字和标签名称的常规行。
.tsv、.txt：制表符分隔文件，第一列包含关键字名称或标签，第二列包含关键字查询。
.json：JSON 文件，或者从 Nuix 搜索和标签窗口导出，或者包含一个搜索列表，每个搜索都包含一个标签和一个查询。

示例 JSON 文件：

{
  "searches": [
    {
      "tag": "KW 01",
      "query": "Plan*"
    },
    {
      "tag": "KW 02",
      "query": "\"Confidential Data\" OR Privilege"
    }
  ]
}

或者，可以提供关键字文件的路径，该路径将在工作流程执行时加载。

2.11.41. 搜索和分配保管人

此操作将保管人分配给与特定搜索条件匹配的案例中的项目。

可以使用 + 和 - 按钮将条目添加到保管人/查询列表，或从 CSV 或 TSV 文件加载。

2.11.42. 标签项目

此操作在范围查询中搜索项目。

然后，它匹配要处理的项目，无论是作为范围中的项目，还是作为个人或家庭，作为范围中的项目的重复项。

标签名称将应用于匹配的项目（火柴），其家庭（所有家庭），其后代（所有后裔），匹配的项目及其后代（火柴与子孙）或其家庭顶级项目（顶级）。

2.11.43. 取消标签项

此操作将删除范围查询中项目的标签。

可选地，如果在作用域中的项目未加标签后标签为空，则可以设置remove方法以删除标签。

指定删除以前缀开头的标签的选项时，将删除具有前缀名称及其子标签的标签。例如，如果前缀设置为`Report，则将删除标签Report和but，但不会删除Reports`。

2.11.44. 匹配项

此操作从指定的文本文件中读取`MD5和/或GUID值的列表。作用域中具有匹配的MD5和/或GUID值的作用域中的项目将使用Tag`字段中提供的值进行标记。

2.11.45. 日期范围过滤器

此操作使用项目日期，顶级项目日期或日期属性列表将范围查询中的项目筛选为指定日期范围内的项目。

然后，它应用类似于Tag Items的标记或排除。

使用*\**作为日期属性可以指定所有日期属性。

可以使用参数`{filter_before_date}和{filter_after_date}`指定此范围的日期。

2.11.46. 用单词查找项目

此操作分析范围内的项目的文本，并确定单词的数量是否符合最小和最大计数标准，该项目是否响应。

通过使用提供的正则表达式拆分每个项目的文本来提取单词。

示例正则表达式提取仅包含字母和数字的单词：

[^a-zA-Z0-9]+

示例正则表达式提取仅包含字母的单词：

[^a-zA-Z]+

样本正则表达式可提取包含任何字符的单词，并用空格字符分隔（例如，空格，制表符，换行符或换页符）

\s+

2.11.47. 筛选电子邮件

该操作根据收件人姓名，电子邮件地址和域名对电子邮件执行高级搜索。

*巫师*功能根据以下情况之一预先填充过滤逻辑：

标记仅内部电子邮件
仅标记两个人之间的通信
标记组内的通信

2.11.48. 将项目添加到集群运行

如果不存在具有指定名称的项目，则此操作将项目添加到现有的“群集运行”或创建新的“群集运行”。

运行此操作时，进度将仅显示`0.01%`，并在操作完成时进行更新。

2.11.49. 检测包含附件的电子邮件

此操作必须与 Nuix 的 Cluster Run 操作结合使用。首先，使用 Nuix Workstation 生成 Cluster Run，然后运行 Detect Attachment-Implied Emails 操作以补充包容性和非包容性电子邮件的识别。

如果未指定群集运行名称，则该操作将处理所有现有的群集运行。

物品将根据以下标签结构进行标签：

穿线
- 集群运行名称
  - 项目
    
    包括的
    
    依恋推断
    
    单数
    
    被忽略
    
    终点
    
    非包容性
  - 所有家庭
    
    包括的
    
    依恋推断
    
    单数
    
    被忽略
    
    终点
    
    非包容性

要选择除非包容性电子邮件以外的所有数据，请使用查询+tag:"Threading|Cluster run name|All Families|Inclusive|*"

此操作应在仅包含顶级电子邮件的集群运行中使用，这些集群使用电子邮件线程进行集群。否则，该操作将产生不一致的结果。

2.11.50. 重新加载项目

此操作从源中重新加载与范围查询匹配的项目。

如果配置操作定义了密码，并且使用了*删除加密的无法访问*选项，那么此操作可用于解密受密码保护的文件。

如果范围查询结果为 0 项，则 Nuix 案例数据库不会关闭，这会在将来尝试添加更多数据时导致问题。作为一种解决方法，如果范围查询导致 0 个项目，请使用前面的 getO 跳过重新加载项目操作。请参阅下面的示例 Python 脚本：

# Set scope_query to the scope query of the Reload Items operation
items_count = current_case.count(scope_query);
print("Reload Items operation scope count: %s" %items_count)

if items_count == 0:
    # Skip next operation
    current_operation_id = workflow_execution.getCurrentOperationId()
    workflow_execution.goToOperation(current_operation_id + 2)

解密文档时，Nuix引擎会将原始加密的项目保留在原位，并使用解密后的内容创建后代。在这种情况下，使用*排除成功解密的加密文档*选项时，将排除原始加密的项目，仅保留解密的版本。请注意，这只会影响加密的文档（例如Word或PDF），而不会影响加密的zip存档。

2.11.51. 更换物品

此操作将案例项目替换为使用源项目的MD5或GUID值命名的文件。

2.11.52. 删除项目

此操作将删除范围查询中的项目及其子代。

这是不可逆的。删除的项目将从案件中删除，并且将不再出现在搜索中。所有关联的注释也将被删除。

2.11.53. 取代文字

如果在基于项目MD5或GUID值命名的文件中提供了替代文本，则此操作将替换为与范围查询匹配的项目存储的文本。

通过将所有文本文件从OCR缓存复制到特定文件夹，然后将“替换文本”操作指向该文件夹，可以在中断Nuix OCR操作之后使用此操作来应用OCR操作的部分结果。

此操作仅在指定文件夹的根目录下搜索文件，而忽略子文件夹中的文件。

2.11.54. 删除文字

此操作将删除为与范围查询匹配的项目存储的文本。

此操作可用于从Nuix在加载过程中剥离了文本但未提取有意义文本的项目中删除文本。

2.11.55. 编辑文本

此操作针对范围内的项目文本运行正则表达式搜索，并编辑所有匹配项。

*修订定义文件*可以是带有正则表达式列表的文本文件，也可以是制表符分隔的文件列Name和Regex。

2.11.56. OCR 项目

此操作使用 Nuix OCR 对范围查询标识的项目运行 OCR，使用标准 Nuix 选项

从 Nuix 版本 8 开始，不能手动提供 OCR 设置，而必须使用 OCR 配置文件。

当使用带有自定义缓存目录的 OCR 配置文件时，选项 区分配置文件 将适用。在这种情况下，短作业 ID 将作为子目录添加到自定义缓存目录中，以避免同时运行多个作业时发生冲突。

2.11.57. 生成重复的保管人字段

此操作将生成一个CSV文件，其中包含案件中重复的保管人列表。有关可用选项的说明，请参见Generate Duplicate Fields。

在*原始领域*中未选择*DocID*的情况下运行将大大缩短执行时间。

与*生成重复字段*操作相比，此操作占用的内存较少。

2.11.58. 生成域字段

此操作将从in中的项目中提取电子邮件域。

结果提取的域字段可以保存到CSV文件和/或可以作为自定义元数据分配给in中的项目。

2.11.59. 生成重复字段

此操作将识别与*更新项目范围*查询匹配且在较大的*搜索范围*查询中重复的所有项目。

该操作支持两种评估方法：

内存密集型：这种方法在大情况下会占用大量内存，但需要减少计算量。
密集计算：此操作对大型案例执行大量计算，但需要减少内存量。

根据以下重复级别来标识重复项：

作为个体：在项目级别重复的项目。
按照项目集合：在家庭中重复的物品。
按顶层项目：仅识别范围中重复项的顶级项。

使用重复数据删除选项 按顶层项目 时，确保提供的系列在搜索和更新范围内是完整的。

当在“更新项目”范围中的一个项目被标识为重复项时，此操作将生成_重复字段_捕获重复项的属性。支持以下_重复字段_：

管理人
项目名称
项目日期
路径
标记
子标签
图形用户界面
上级GUID
顶级父GUID
DocID
最低家庭DocID
元数据配置文件

选择*元数据配置文件*选项时，将计算在指定的元数据配置文件中找到的所有字段。

结果包容性*选项确定是否应将当前原始项目的值添加到_重复字段_。例如，如果原始文档中有托管人`*Smith，并且有两个重复的项目，其中有托管人Jones和Taylor，则*备用保管人*字段将包含值Jones; Taylor，而*所有的管理人*字段将包含值Jones; Taylor; Smith`。

生成的_重复字段_可以保存到`CSV`文件中，和/或可以作为自定义元数据分配给*更新项目范围*中的项目。

有关日期格式的帮助，请参阅Joda Pattern-based Formatting以获取基于模式的日期格式指南。

2.11.60. 生成打印图像

此操作使用指定的“成像”配置文件为范围内的项目生成图像。

将失败的项目标记为 选项的行为与合法导出操作中的行为相同。

2.11.61. 填充二进制存储

此操作将使用范围中项目的二进制文件填充二进制存储区。

2.11.62. 分配自定义元数据

此操作将自定义元数据添加到范围内的项目。需要 CSV 或 TSV 文件。

文件头必须以 GUID、ItemName、DocID 或 Key 开头，后跟要分配的元数据字段的名称。

使用 ItemName 时，元数据将分配给 Nuix 案例中具有该项目名称的所有项目。这可能涉及将相同的元数据信息分配给多个项目，如果它们具有相同的名称。

使用 Key 时，将按照 GUID、ItemName 或 DocID 的顺序尝试匹配项目。

随后的每一行对应一个需要更新的项目，第一列包含项目的 GUID、ItemName 或 DocID，其余列包含自定义元数据。

简单的 CSV 元数据文件示例：

DocID,HasSpecialTerms,NumberOfSpecialTerms
DOC00001,Yes,5
DOC00002,Yes,1
DOC00003,No,0
DOC00004,Yes,7

要分配特定类型的自定义元数据，请添加具有以下格式的第二个标题行：

第一列：Type，表示这一行是指定字段类型的表头
对于每个后续列，数据的类型，来自以下选项：
- 文本
- 日期
- 布尔值
- 整数
- 漂浮

具有以下类型的示例 CSV 元数据文件：

ItemName,DateRecorded,SampleThreshold
Type,Date,Float
file1.txt,2020-01-01,0.5
file2.txt,2021-01-01,1.5
Email.eml,2022-01-01,-7

2.11.63. 分配数据集元数据

此操作将数据集中定义的字段分配为自定义元数据或标签。

2.11.64. 关联Google保险柜元数据

此操作解析从 Google Vault 导出的 XML 文件和 CSV 文件，提取可用的元数据记录（请参阅 https://support.google.com/vault/answer/6099459?hl=en#mailxml）并将这些作为自定义元数据关联到Nuix 案例中的匹配项。

Google Vault 元数据记录与 Nuix 案例中的项目之间的匹配是通过以下方式进行的：

谷歌邮件
- 解析 XML 元数据文件时，使用元数据字段 MBOX From Line 进行匹配
- 解析 CSV 元数据文件时，使用元数据字段 Mapi-Smtp-Message-Id 和 Message-ID 执行匹配。
Google文件
- 解析 XML 元数据文件时，使用文件名进行匹配

2.11.65. 移除自定义元数据

此操作将从作用域中的项目中删除指定的自定义元数据。

2.11.66. 将项目添加到生产集中

此操作将与范围查询匹配的项目添加到生产集。

将项目添加到生产集中时，可以应用以下排序顺序：

没有排序：物品没有分类
顶级文件日期（升序）：物品按照每个家庭中顶级物品的日期，以升序排列。
顶层项目日期（升序）：物品按照每个家族中顶级物品的日期，以降序排列。
证据顺序（升序）：项目按有效路径名升序排序（类似于Windows资源管理器排序）。
关键字字段：项目是按字段的升序或降序排列的。
元数据配置文件：项目按照元数据配置文件中的字段按升序排序。

要实现与 Nuix Engine 默认排序顺序 等效的排序顺序，请选择 Nuix Rampiva 自定义 排序方法，其中字段位置按上升顺序排列。

可以在*文档 ID*级别或在*家庭文件编号*级别执行项目编号。在后一种情况下，将根据定义的前缀和编号数字为每个系列中的顶级项目分配一个文档ID。来自该家族的所有后代都将被分配一个文档ID，该ID与顶层项之一相同，并带有一个后缀，指示该后代在家族中的位置。

可以使用自定义参数指定文档ID的起始编号，位数和家族位数。

{docid_start_numbering_at}-在“将产品添加到生产设置”操作的配置中选择选项*从开始编号*，此参数才能生效；
{docid_digits}
{docid_family_digits}-在“将产品添加到生产设置”操作的配置中选择编号方案*家庭文件编号*，此参数才能生效；

使用页级编号方案时，参数`{group_family_items}可用于控制同一族文档的分组，参数{group_document_pages}可用于控制同一文档的页面分组。这些参数可以设置为true或false`。

2.11.67. 删除产品集

此操作删除全部或具体生产集。

2.11.68. 合规导出

此操作使用标准Nuix选项执行合法导出。

使用*图像配置文件*和*生产配置文件*选项控制在合法导出过程中导出的图像的参数。

*分割出口*选项会将整个导出（包括装入文件和导出组件）拆分为指定最大大小的多个部分，并将包括族项目。

*将邮件、联系人、日历转换为*选项会将本机电子邮件导出为所选格式。

*出口方案*选项可用于控制附件是否与电子邮件分开。

2.11.69. 导出到相对论

该产品模块仅可由拥有 Relativity 或 Relativity One（Relativity ODA LLC 产品）有效许可证的各方使用。Relativity ODA LLC 不测试、评估、认可或认证该产品。

选择*出口类型**Relativity*时，将在合法导出操作期间将加载文件上传到相对论。如果导出分为多个部分，则每个部分将在可用时立即上载，并且以前的部分将完成上载。

需要以下设置：

字段映射文件：将 Nuix 元数据配置文件映射到 Relativity 工作区字段的 JSON 文件路径。如果未提供映射文件，则加载文件中的字段将映射到 Relativity 工作区中具有相同名称的字段。

请参阅有关如何在 Relativity Loadfile Upload 操作中创建映射文件的更多信息。

此操作仅将本机文件、文本和元数据加载到 Relativity。要加载图像，除此操作外，请使用Relativity Images Overlay 操作。

2.11.70. 案例子集导出

此操作将在指定参数下导出案例子集中范围内的项目。

2.11.71. 出口项目

此操作将项目导出到指定的*导出文件夹*。

*路径选项*选项会将项目导出到原始数据的*单目录*或*重新创建目录结构*中。

*将电子邮件转换为*选项会将本机电子邮件导出为所选格式。

默认情况下，利用率数据库中仅跟踪导出的项目。选择选项 在利用率数据中跟踪出口项目的材料后代 时，除了跟踪导出的项目外，还会跟踪这些项目的材料后代。

2.11.72. 逻辑图像导出

此操作将导出Nuix Logical Image`(NLI)`容器中范围内的项目。

2.11.73. 元数据导出

此操作将使用选定的元数据配置文件导出与范围查询匹配的项目的元数据。

可以应用以下排序顺序：

没有排序：物品没有分类
顶级文件日期（升序）：物品按照每个家庭中顶级物品的日期，以升序排列。
顶层项目日期（升序）：物品按照每个家族中顶级物品的日期，以降序排列。
证据顺序（升序）：项目按照在证据树中出现的方式，以升序排列。

*最大路径深度*选项不会提供任何性能优势-处理与范围查询匹配的所有项目，并且超过最大路径深度的项目不会输出到结果文件中。

2.11.74. 词表导出

此操作从匹配范围查询的项目中导出单词列表。

通过使用提供的正则表达式分割每个项目的文本来运行来提取单词。

示例正则表达式提取仅包含字母和数字的单词：

[^a-zA-Z0-9]+

样本正则表达式可提取包含任何字符的单词，并用空格字符分隔（例如，空格，制表符，换行符或换页符）

\s+

小于提供的最小长度或大于最大长度的单词将被忽略。

2.11.75. 处理报告

该操作基于模板文件以Excel格式生成处理报告。

如果未指定自定义模板，操作将使用默认的 Nuix Rampiva 模板。要创建自定义模板，请首先使用默认设置运行处理报告操作。然后，复制最新的模板文件。当在服务帐户下运行时，模板位于 %userprofile%\.rampiva\Workflow\Templates，当在本地系统帐户下运行时，模板位于 C:\Windows\System32\config\systemprofile\.rampiva\Workflow\Templates。然后，修改工作流程以指向新创建的自定义模板文件。

处理阶段

处理阶段由案例中的项目子集组成，由 Nuix 查询标识，并使用关联的方法来计算大小。可以使用以下尺寸方法：

经审核的大小: Nuix 审核尺寸。
文件大小 Nuix 文件大小。
字体大小：文字大小
已审核+文字大小: 审核大小加上文字大小
已审核（附件2x）：审核大小，附件大小包含两次。这可以是对合法出口规模的估计，并可选择在电子邮件中留下附件。
已审核（附件2x）+文字大小 审核大小，附件大小加两倍，加上正文大小
摘要大小：摘要大小。如果项目没有摘要，则回退到文件大小。如果项目不是文件，则回退到审核大小。

此操作的默认选项将生成具有预定义阶段数的报告：

源数据
提取
材料
排除后
重复数据删除后
导出

观看次数

视图用于定义数据在报告表中的显示方式，包括垂直和水平列、视图适用的处理阶段、计算项目计数和/或大小的选项以及大小单位。

默认选项包括多个预定义视图，每个视图对应于 Excel 报告中的一个工作表：

处理概述
保管人的重要物品
保管人出口物品
年度重要项目
按年份导出项目
物料类型
按类型导出项目
扩展的重大项目
按扩展名导出项目
按尺寸的材料图像
按尺寸导出图像
不规则物品
按类型排除

默认情况下，大小以吉字节（GiB）报告。 1 GiB = 1024 x 1024 x 1024字节= 1,073,741,824字节大小单位可以在视图选项窗格中更改。

可以自定义，删除每个阶段和视图，并可以添加新的阶段和视图。

如果设置了参数`{report_password}`，则将使用提供的密码对生成的Excel文件进行加密。

2.11.76. 从多个案例生成处理报告

通过指定需要考虑的其他案例的位置，可以使用*其他情况*选项从多个案例生成单个报告。首先，按照提供的顺序，从主要工作流程案例中评估项目，然后再从其他案例中评估项目。如果一个项目在多个情况下都具有相同的`GUID`，则仅报告该项目的第一个实例。

当使用 其他情况 选项报告案例子集和原始案例时，从案例子集运行报告并将原始案例添加到 其他情况 列表中。这将具有首先报告案例子集项目的效果，并忽略原始案例中这些项目的相同副本。

2.11.77. 扫描案例统计

此操作将扫描案例，以查找证据容器，保管人，语言，标签和日期范围（按月），项目集，生产集和排除项，并针对每一个跟踪所有项目的数量，已审核项目的数量和大小，以及实物的数量和大小。

生成的 JSON 文件存储在案例文件夹`Stores\Statistics`中，并发送到 Nuix Rampiva Scheduler 进行集中报告。

可以配置以下附加选项：

病历：启用案例历史扫描以提取会话、操作和卷。
计算大小：用于计算项目大小的方法。
最大扫描持续时间（秒）：到达此时间后停止扫描进一步的案例详细信息。
Native Export：包括未导出的材质子项：如果选中，当在案例历史记录中检测到 Native Export 事件时，导出项目的材料子项也包含在导出范围中。
强制扫描之前扫描过的案例：重新扫描一个案例，即使它之前被扫描过并且没有检测到新事件。
不要跳过 Nuix Rampiva Engine 会话：默认情况下，在案例历史记录扫描期间会跳过 Nuix Rampiva Engine 运行的会话。如果启用，此选项也将扫描 Nuix Rampiva 引擎运行的会话。重建调度程序利用率数据库时使用此选项。

2.11.78. 树大小计数报告

此操作将生成一个树形报告，其中包括合并范围中项目的大小和计数。

如果不应将项目路径中的前几个元素（例如，证据容器名称和逻辑证据文件名称）包括在报告中，请增加*省略路径前缀*选项的值。

*最大路径深度*选项限制将为其生成报告的嵌套项目的数量。

有关使用自定义模板和尺寸单位的信息，请参见Processing Report。

2.11.79. 切换许可

此操作释放 Nuix Engine 在 Nuix Rampiva Scheduler 中运行作业时使用的许可证，并可以根据许可证源选项获取不同的许可证：

无：未获得 Nuix 许可证并在没有访问 Nuix 案例的情况下运行工作流中的剩余操作。
网管系统：从指定的 NMS 服务器获取 Nuix 许可证。
CLS：从 Nuix 云许可证服务器获取 Nuix 许可证。
加密狗：从连接到引擎服务器的 USB Dongle 获取 Nuix 许可证。
引擎预设：从默认源获取 Nuix 许可证，引擎在作业启动时从该默认源获取原始 Nuix 许可证。

指定*过滤*时，会将提供的文本与可用的Nuix许可证名称和说明进行比较。

当将*工人*计数指定为`-1`时，将选择引擎最初使用的默认工作程序数。

Nuix Rampiva Workflow 中执行的工作流不支持此操作。

2.11.80. 关闭案件

此操作关闭当前打开的 Nuix 案例。

如果选择了*关闭执行日志*选项，则将关闭案例文件夹stored中存储的执行日志，除非重新打开案例，否则不会对日志文件进行进一步的更新。

2.12. 努克斯自然语言处理

这些操作配置与 Nuix NLP 的连接，并使用 Nuix NLP 分析 Nuix 案例中的项目。

2.12.1. 配置 Nuix NLP 连接

该操作仅在 Nuix Neo 中可用。

此操作设置用于连接 Nuix NLP 服务的配置。

Nuix NLP 服务 ID 应设置为 Nuix NLP 服务 类型的参数。在 Scheduler 中提交工作流期间，系统将提示用户选择 Nuix NLP 服务，并在需要时对该服务进行身份验证。

2.12.2. 使用 Nuix NLP 分析项目

该操作仅在 Nuix Neo 中可用。

此操作将范围内的项目发送到 Nuix NLP 进行丰富，并将结果应用到 Nuix Engine 案例中的项目。

2.13. 努克斯·兰皮瓦

这些操作是 Nuix Rampiva 原生的，用于配置工作流程以及使用 API、脚本、外部命令与任意第三方交互。

2.13.1. 日志

这会记录用户定义的日志，并且可以在运行时将日志打印到执行日志中。

2.13.2. 占位符

该操作可用于分隔工作流的各个部分，或者作为跳转到工作流执行中的特定部分时跳转的锚点。

2.13.3. 配置参数

此操作允许用户定义将在工作流执行范围内存在的自定义参数。自定义参数可以手动定义或从 CSV 或 TSV 文件加载，连同值、描述和验证正则表达式。

在此操作中可以定义两种类型的参数：静态参数 和*用户参数*。 静态参数 是在操作配置中定义的具有固定值的参数。对于*用户参数*，在工作流排队时会出现提示以提供值。

显示条件

显示条件可用于确定是否提示用户为特定参数提供值，这取决于先前填写的参数的值。

例如，如果有`{perform_add_evidence}和{source_data_location}两个参数，则可以设置显示条件，如果{perform_add_evidence}参数的值为True，则只显示{source_data_location}`参数。

如果一个参数与显示条件不匹配，它将有一个空白值。

显示条件只能引用在当前参数之上的同一个Configure Parameters 操作中定义的参数。

参数值过滤器

根据参数类型，可以应用以下参数值文件：

文本可以使用正则表达式 (regex) 过滤参数值。
数可以使用最小和最大允许值过滤参数值。
Relativity 可以根据之前的其他 Relativity 参数（例如 Relativity 客户端或工作区）过滤参数值。这些过滤器需要使用 Relativity 服务。

2.13.4. 通知

此操作会发送带有自定义消息的电子邮件通知。

如果选择了 电子邮件通知 选项，则会向指定的电子邮件地址发送一封电子邮件。要获取有关环境中使用的 SMTP 电子邮件服务器和端口的信息，请联系网络管理员。

输入的值密码字段将以明文形式存储在工作流文件中 - 不应在此字段中输入密码。相反，将此字段设置为受保护的参数名称，例如 {smtp_password} 并查看 Protected Parameters 部分以获取有关如何设置受保护参数值的说明。

可以配置以下附加选项：

将工作流程执行日志附加为文本：选择此选项可将名为 WorkflowLog.txt 的文件附加到电子邮件，其中包含当前执行日志。
附加最后生成的报告（如果有）：选择此选项以附加最后生成的报告文件。
附加附件：指定应附加到电子邮件的其他文件。

要将多个报告附加到通知电子邮件，请使用参数定义和存储这些文件的路径，然后在 附加附件 部分中使用这些参数。

2.13.5. 脚本

在Nuix情况下，此操作将运行提供的or或来自*脚本文件*的代码。

此操作可用于将现有内部脚本集成到工作流中。

访问静态参数

在脚本启动之前，将评估所有大小写参数，并且可以在脚本执行上下文中将它们作为属性访问，而无需使用大括号。例如，要打印case文件夹的内容，可以使用以下python脚本：

import os

print "Contents of case folder: "+case_folder
for f in os.listdir(case_folder):
	print f

管理动态参数

parameters 辅助对象可用于获取和设置动态参数的值：

get(String name) - 使用作为字符串提供的名称获取参数的值。如果未定义参数，则返回参数名称。
get(String name, Object defaultValue) - 获取名称为字符串的参数值。如果未定义参数，则返回默认值。
put(String name, String value) - 使用提供的名称设置参数的值。如果提供的名称不是有效的参数名称，它将被规范化。
getAllParameterNames() - 返回包含所有参数名称的列表，包括系统参数、用户定义的参数和执行配置文件中提供的参数

设置和检索参数的示例：

# Setting parameter {param1}
parameters.put("{param1}","Test Value from Script1")
print "Parameter {param1} has value: "+parameters.get("{param1}")

# Attempting to get undefined parameter {param2}
parameterValue = parameters.get("{param2}",None)
print "Parameter {param2} has value: "+str(parameterValue)

输出：

Parameter {param1} has value: Test Value from Script1
Parameter {param2} has value: None

此外，要获取转换为特定类型的参数值，请使用以下方法：

getLong(String name) - 获取名称为长数字的参数值。如果参数未定义或无法转换，则会引发异常。
getLong(String name, long defaultValue) - 获取名称为长整数的参数值。如果参数未定义或无法转换，则返回默认值。
putLong(String name, long value) - 转换长数值并存储在参数中。
getBoolean(String name) - 使用作为布尔值提供的名称获取参数的值。如果参数未定义或无法转换，则会引发异常。
getBoolean(String name, boolean defaultValue) - 使用作为布尔值提供的名称获取参数的值。如果参数未定义或无法转换，则返回默认值。
putBoolean(String name, boolean value) - 转换布尔值并存储在参数中。
getDouble(String name) - 获取名称为双精度数的参数值。如果参数未定义或无法转换，则会引发异常。
getDouble(String name, double defaultValue) - 获取名称为双精度数的参数值。如果参数未定义或无法转换，则返回默认值。
putDouble(String name, double value) - 转换 Double 数值并存储在参数中。
getJsonObject(String name) - 使用作为反序列化 JSON 对象提供的名称获取参数的值。如果参数未定义或无法反序列化为 JSON 对象，则会引发异常。
getJsonObject(String name, Object defaultValue) - 使用作为反序列化 JSON 对象提供的名称获取参数的值。如果参数未定义或无法反序列化为 JSON 对象，则返回默认值。
putJsonObject(String name, Object value) - 将值序列化为 JSON 字符串并存储在参数中。

将参数值转换为 JSON 对象时，会在反序列化期间推断生成的对象类型，并且可能与原始类型不同。

获取和设置类型参数的示例：

# Defining a Python dictionary
dictionary={}
dictionary["number"]=5
dictionary["color"]="Orange"
print "Original dictionary:"
print type(dictionary)
print dictionary

# Storing the dictionary as a parameter
parameters.putJsonObject("{sample_dictionary}",dictionary)

# Getting the parameter as an object
retrievedDictionary = parameters.getJsonObject("{sample_dictionary}")
print "Deserialized dictionary:"
print type(retrievedDictionary)
print retrievedDictionary

输出：

Original dictionary:
<type 'dict'>
{'color': 'Orange', 'number': 5}

Deserialized dictionary:
<type 'com.google.gson.internal.LinkedTreeMap'>
{u'color': u'Orange', u'number': 5.0}

有关内置参数的列表，请参见section节。

如需创建自定义脚本或将现有脚本集成到 Nuix Rampiva 工作流程中的帮助，请通过 info@rampiva.com 联系我们。

管理工作流程执行

可使用`workflowExecution`helper对象中的以下方法通过Script操作实时操作工作流执行：

stop()-停止执行工作流程
pause()-暂停工作流程执行
log(String message)-将消息添加到工作流执行日志
logInfo(String message)-将消息添加到工作流程信息列表
logWarning(String message)-将消息添加到工作流警告
addLink(String linkUrl) - 将链接添加到工作流程链接列表
addLink(String linkName, String linkUrl) - 将链接添加到工作流程链接列表
addLink(String prefix, String linkName, String linkUrl) - 将链接添加到工作流程链接列表
addLink(String prefix, String linkName, String linkUrl, String suffix) - 将链接添加到工作流程链接列表
triggerError(String message)-使用指定的消息触发错误
appendWorkflow(String pathToWorkflowFile)-将工作流程的操作从文件`pathToWorkflowFile`追加到当前工作流程的末尾。
appendWorkflowXml(String workflowXml) - 将工作流 XML workflowXml 中的操作附加到当前工作流的末尾。 workflowXml 应该包含工作流文件的全部内容。
insertWorkflow(String pathToWorkflowFile)-在当前脚本操作之后从文件`pathToWorkflowFile`插入工作流中的操作。
insertWorkflowXml(String workflowXml) - 在当前脚本操作之后插入来自工作流 XML workflowXml 的操作。 workflowXml 应该包含工作流文件的全部内容。
goToOperation(int id)-脚本操作完成后，跳转到具有指定ID的操作。要跳到第一个操作，请指定ID值1。
goToNthOperationOfType(int n, String type) - 脚本操作完成后，从工作流跳转到指定类型的第 n 个操作。
goToOperationWithNoteExact(String text)-跳至工作流程中注释等于指定文本的第一个操作。
goToOperationWithNoteContaining(String text)-跳至工作流程中注释包含指定文本的第一个操作。
goToOperationWithNoteStartingWith(String text)-跳至工作流程中以注释以指定文本开头的第一项操作。
getOperations() - 返回所有操作。
getOperationsWithWarnings() - 返回所有带有警告的操作。
getOperationsWithErrors() - 返回所有有错误的操作。
getOperationsWithExecutionState(ExecutionState executionState) - 返回执行状态等于指定执行状态的所有操作。
getOperation(int id) - 返回具有指定 id 的操作。
getOperationWithNoteExact(String text) - 返回工作流中注释等于指定文本的第一个操作。
getOperationWithNoteContaining(String text) - 返回工作流中注释包含指定文本的第一个操作。
getOperationWithNoteStartingWith(String text) - 返回工作流中注释以指定文本开头的第一个操作。
getCurrentOperationId()-返回当前脚本操作的ID。
getOperationsCount()-返回工作流中最后一个操作的ID。
clearStickyParameters()-删除用户配置文件中设置的所有粘性参数。
setProgress(double percentageComplete)-设置操作进度。这显示在用户界面中，并用于ETA计算。指定0.0到1.0之间的值。
setTaskName(String taskName)-设置脚本正在处理的任务的名称。这显示在用户界面中。

脚本示例，该脚本重新启动执行两次，然后跳转到工作流中的最后一个操作：

count = parameters.getLong("{execution_count}",0)
count=count+1
parameters.putLong("{execution_count}",count)

if (count<3):
        workflowExecution.goToOperation(1)
else:
        workflowExecution.goToOperation(workflowExecution.getOperationsCount())

管理运营

可以使用 operation 辅助对象中的以下方法从脚本操作中获取有关操作的信息：

getId() - 返回操作 ID。
getExecutionState() - 返回操作执行状态。
getName() - 返回操作名称。
getNotes() - 返回操作说明。
getErrorMessage() - 返回操作错误信息。如果操作没有错误，则此值将为空或空白。
getWarningMessages() - 返回操作的警告列表。如果操作没有任何警告，这将是一个空列表。
getStartDateTime() - 以 Joda DateTime 形式返回操作的开始日期。
getFinishedDateTime() - 以 Joda DateTime 形式返回操作的完成日期。
getSkippable(Boolean skippable) - 如果可跳过则返回`true`。
getDisabled() - 如果操作被禁用，则返回真的`。
setDisabled(Boolean disabled) - 设置操作的禁用状态。
getSoftFail() - 如果操作设置为错误时软失败，则返回真的`。
setSoftFail(Boolean softFail) - 设置操作的软失败状态。
getEta() - 将操作 ETA 作为 Joda DateTime 返回。
getPercentageComplete() - 以百分比形式返回操作进度。

打印最后一个操作的详细信息并出现错误的示例脚本：

operations_with_errors = workflowExecution.getOperationsWithErrors()

if operations_with_errors.size() >= 1:
	last_error_operation = operations_with_errors[-1]
	print "Last operation with error #{0} {1}: {2}".format(last_error_operation.getId(), last_error_operation.getName(), last_error_operation.getErrorMessage())
else:
	print "No operations encountered errors"

管理数据集元数据

有关提交作业时选择的数据集的信息存储在 dataSetsMetadata helper 对象中。该对象是一个字典，键是数据集 ID，值是具有数据集属性的字典。

调用API

Script 操作公开了几个辅助对象，可用于调用 Nuix Rampiva 和第三方 API。这些辅助对象是：

restRampiva - 调用 Nuix Rampiva Automate API。
restDiscover - 调用 Nuix Discover API。
restRelativity - 调用 Relativity REST API。
rest - 调用通用 REST API。
genAi - 调用第三方 Gen AI 服务。

REST API 调用的响应具有以下方法和字段：

status_code - 表示状态代码的整数
text - 文字回复
json() - 将响应解析为 JSON 后的对象
raise_for_status() - 如果状态代码为 4xx 或 5xx，则引发异常
headers - 带有响应标头的字典

通过 HTTPS 调用 REST API 时，如果 HTTPS 证书不受 Java 密钥库信任，则调用将失败。要明确允许连接到具有特定 SHA-256 指纹证书指纹的服务器，请使用以下方法：

setFingerprint (String fingerprint)

调用 Rampiva API 要从脚本操作调用 Nuix Rampiva API，请使用 `restRampiva` 辅助对象。

Nuix Rampiva 实例的基本 URL 和身份验证 API 密钥是从运行脚本操作的作业自动设置的。但是，可以使用以下方法覆盖这些设置：

setBaseUrl(String baseUrl)
setBearerToken(String bearerToken)

可以使用以下方法来调用 API 端点：

get(String endpoint)
delete(String endpoint)
post(String endpoint, Object data)
put(String endpoint, Object data)

创建新客户端的 Python 脚本示例：

body = {
  "name": "Sample Client Name",
  "description": "This client was created from the API",
  "enabled": False
}

response = restRampiva.post("/api/v1/scheduler/client", body);

print response.json();

调用 Nuix Discover API 要从脚本操作调用 Nuix Discover API，请使用 `restDiscover`

辅助对象。

Nuix Discover API 的基本 URL 和身份验证 API 密钥是通过使用 Nuix Discover Case 操作自动设置的。但是，可以使用以下方法覆盖这些设置：

setBaseUrl(String baseUrl)
setBearerToken(String bearerToken)

可以使用以下方法来调用 API 端点：

call(String query)
call(String query, Map<String,Object> variables)

为名为 John 的用户运行 GraphQL 查询的示例 Python 脚本：

body = '''
query MyQuery ($fn: String){
  users(firstName: $fn) {
    id,
    fullName
  }
}
'''
variables = {"fn":"John"}

response = restDiscover.call(body,variables);
print response.json();

调用 Relativity API 要从脚本操作调用 Relativity Rest API，请使用 `restRelativity`

辅助对象。

Relativity 服务器的 URL 和身份验证标头是通过配置 Relativity 连接操作自动设置的。但是，可以使用以下方法覆盖这些设置：

setBaseUrl(String baseUrl)
setBearerToken(String bearerToken)
setBasicAuth(String username, String password)

可以使用以下方法来调用 API 端点：

get(String endpoint)
delete(String endpoint)
post(String endpoint, Object data)
put(String endpoint, Object data)
queryObjectManager(String objectTypeName, Long workspaceArtifactId, String condition, int start, int length)
queryObjectManager(String objectTypeName, Long workspaceArtifactId, String condition, String[] fieldNames, int start, int length)
queryObjectManagerSlim(String objectTypeName, Long workspaceArtifactId, String condition, int start, int length)
queryObjectManagerSlim(String objectTypeName, Long workspaceArtifactId, String condition, String[] fieldNames, int start, int length)

查询 Relativity 对象管理器中具有特定名称的工作区并打印工件 ID 的示例 Python 脚本：

workspaceName = "Relativity Starter Template"

body = {
    "request": {
        "Condition": "'Name' == '"+workspaceName+"'",
        "ObjectType": {
            "ArtifactTypeID": 8
        },
        "Fields": [{
                "Name": "Name"
            }
        ]
    },
    "start":0,
    "length":1000
}

response = restRelativity.post("/Relativity.Rest/api/Relativity.ObjectManager/v1/workspace/-1/object/query",body)
response.raise_for_status()

print("Response count: "+str(int(response.json()["TotalCount"])))
for responseObject in response.json()["Objects"]:
    print "ArtifactID: "+str(int(responseObject["ArtifactID"]))
    for fieldValue in responseObject["FieldValues"]:
        print(fieldValue["Field"]["Name"]+": "+fieldValue["Value"])

使用 queryObjectManager 帮助器查询所有事项的名称和客户名称的示例 Python 脚本：

fields = ["Name", "Client Name"]

response = restRelativity.queryObjectManager("Matter", -1, None, fields, 1, 10000)
response.raise_for_status()

print("Response count: "+str(int(response.json()["TotalCount"])))
for responseObject in response.json()["Objects"]:
    print "ArtifactID: "+str(int(responseObject["ArtifactID"]))
    for fieldValue in responseObject["FieldValues"]:
        print(fieldValue["Field"]["Name"]+": "+fieldValue["Value"])

调用通用 API 要从脚本操作调用通用 API，请使用 `rest` 帮助程序对象。

可以使用以下方法选择设置基本 URL：

setBaseUrl(String baseUrl)

可以使用以下方法选择设置身份验证：

setBearerToken(String bearerToken)
setBasicAuth(String username, String password)

可以使用以下方法选择设置自定义标头：

setCustomHeader(String name, String value)

可以使用以下方法来调用 API 端点：

get(String endpoint)
delete(String endpoint)
post(String endpoint, Object data)
put(String endpoint, Object data)

示例 Python 脚本查询 REST API：

response = rest.get("https://dummy.restapiexample.com/api/v1/employees");
print response.json();

调用 Gen AI 调用第三方 Gen AI 服务 `genAi` 辅助对象。

可以使用以下方法：

getModel()：返回正在使用的模型的名称
getApiUrl()：返回正在使用的 API 的 URL
getServiceRoot()：返回 API 的域名，删除“api。”值
getCompletionMessage(List<Map<String,String>> genAiChatRequestMessages)：获取 Gen AI 的文本回复
getCompletions(List<Map<String,String>> genAiChatRequestMessages)：从 Gen AI 获取完成对象

示例 Python 脚本通过简单调用来获取响应：

messages = [
    { 'role': 'system', 'content': 'You always respond with 10 words in English followed by a word in French.' },
    { 'role': 'user', 'content': 'Hi, what''s your name' }
]

response = genAi.getCompletionMessage(messages);

print(response)

带有调用的示例 Python 脚本以获取响应的详细信息：

print("Setup:")
print("\tModel: "+genAi.getModel())
print("\tService Root: "+genAi.getServiceRoot())
print("\tAPI URL: "+genAi.getApiUrl())


messages = [
    { 'role': 'system', 'content': 'You always respond with 10 words in English followed by a word in French.' },
    { 'role': 'user', 'content': 'Hi, who are you' },
    { 'role': 'assistant', 'content': 'I am a warrior' },
    { 'role': 'user', 'content': 'Why did you say that?' }
]

completions = genAi.getCompletions(messages);

for choice in completions.getChoices():
    print("Choice: ")
    print("\tMessage: "+choice.getMessage().getContent())
    print("\tRole: "+str(choice.getMessage().getRole()))

usage = completions.getUsage()
print("Usage: ")
print("\tPrompt tokens: "+str(usage.getPromptTokens()))
print("\tCompletion tokens: "+str(usage.getCompletionTokens()))
print("\tTotal tokens: "+str(usage.getTotalTokens()))

2.13.6. 电源外壳

此操作将运行指定的 PowerShell 脚本。

获取参数值

从指定代码运行 PowerShell 脚本时，将在运行代码之前评估代码中使用的 Nuix Rampiva 参数。运行 PowerShell 脚本文件时不会执行 Nuix Rampiva 参数的评估。

例如，以下 PowerShell 脚本代码：

Write-Host "The time is: {date_time}"

将产生以下输出：

Running PowerShell code
The time is: 20221006-132923
PowerShell exited with code 0

设置参数值

要从 PowerShell 脚本设置 Nuix Rampiva 参数值，必须将参数值写入特定位置的文件中。这种机制是必需的，因为 PowerShell 脚本不会在与 Nuix Rampiva 工作流程相同的上下文中运行。

要设置名称为 {sample_parameter_name} 的参数，PowerShell 脚本应将参数的值写入文件夹 {powershell_parameters} 中名为 sample_parameter_name 且没有扩展名的文件，例如：

Set-Content -NoNewline -Path {powershell_parameters}\sample_parameter_name -Value $SampleValue

参数`{powershell_parameters}`会在运行PowerShell操作时自动分配到一个临时路径，不需要在别处定义。要在 PowerShell 脚本中使用此机制，请将此参数的值作为参数传递给脚本。

例如，要在 PowerShell 中获取当前日期和时间并将其设置为 Nuix Rampiva 参数，请使用以下 PowerShell 代码：

$CurrentDate = Get-Date
Set-Content -NoNewline -Path {powershell_parameters}\date_from_powershell -Value $CurrentDate

2.13.7. 运行外部应用程序

此操作将运行带有指定参数的可执行文件，并等待其完成。

使用robocopy复制文件夹的示例：

申请地点：C:\Windows\System32\Robocopy.exe
参数："C:\Program Files\Rampiva" "C:\Temp\Rampiva" /E

使用cmd.exe列出文件夹并将输出重定向到C：\ Temp文件夹中的文本文件的示例：

申请地点：C:\Windows\System32\cmd.exe
/c dir "C:\Program Files" > "listing_{date_time}.txt"
工作目录：C:\Temp

2.13.8. 调用接口

此操作将进行 API 调用。

可以配置以下选项：

动词：HTTP 动词，例如 GET 或 POST.
网址：网址。
证书指纹：可选，即使证书是自签名的，也应该信任证书 SHA-256 指纹。
认证类型：API 要求的身份验证类型。
- 无授权：没有认证。
- API 密钥：提供将设置为标题的*API 密钥名称*和*API 键值*。
- 不记名令牌：提供*令牌*值。
- 基本认证：提供*用户名*和*密码*.
参量：可选，URL参数。
标题：可选，自定义 HTTP 标头。
体型：要提交的身体数据类型。
- 无：没有要提交的数据。
- 表格数据：提供表单域*名称*和*价值观*.
- 生的：提供*体型*和数据。
- 二进制：提供包含二进制数据的*文件位置*。

API 调用完成后，将填充以下参数：

{call_api_response_code}：HTTP 响应代码。
{call_api_response_headers}：响应标头，JSON 编码。
{call_api_response_body}：响应体。

2.13.9. 配置本机 OCR

此操作设置 Nuix Rampiva OCR 的配置。

Nuix Rampiva OCR 使用曼海姆大学图书馆构建的 Tesseract/Leptonica 二进制文件。在运行本机 OCR 操作之前，必须安装 Nuix Rampiva OCR 或 Tesseract OCR 的其他发行版。

该操作具有以下设置：

工人分配：
- 预定的：使用指定数量的工人
- 每个 CPU 内核：使用worker数作为CPU核数的比例。例如，在 16 核的服务器上，0.8 的比率对应于 12 核（即 16 核的 80%）。
OCR 引擎二进制文件文件夹：可选，安装 Nuix Rampiva OCR 或 Tesseract OCR 的文件夹。
用户词文件：可选，Tesseract 单词文件的路径。
用户模式文件：可选，Tesseract 模式文件的路径。
图像分辨率：可选，图像的DPI中源图像的分辨率，如果知道的话。
光栅化 PDF 分辨率：可选，在 OCR 之前光栅化 PDF 文件时使用的分辨率。
OCR 引擎日志级别：可选，Tesseract OCR 引擎的日志级别。
语言能力：可选，文本所用的语言（如果已知）。配置多种语言时，用加号分隔，例如`eng+deu+fra`.

有关 Tesseract 支持的语言列表，请参阅 https://github.com/tesseract-ocr/tessdoc/blob/main/Data-Files-in-different-versions.md。

页面分割模式：可选，用于分割页面的方法。

有关 Tesseract 支持的页面分割模式列表，请参阅 https://tesseract-ocr.github.io/tessdoc/ImproveQuality.html#page-segmentation-method

抗扭斜：如果设置，预处理器将在运行 OCR 之前尝试对图像进行纠偏。

抗扭斜 选项仅适用于常见的图像格式和 PDF 文件。它不适用于包含图像列表的源文本文件。

抗扭斜 选项只会纠正小角度旋转，不会将图像旋转 90、180 或 270 度。

旋转：如果设置，预处理器将在运行 OCR 之前旋转图像。使用 自动侦测 选项时，OCR 引擎将首先在*0 - 仅方向和脚本检测 (OSD)*模式下运行以检测方向，然后在用户配置的模式下对旋转的图像进行第二次运行。

使用 自动侦测 旋转模式时，在大多数情况下，最好不要选择特定的 页面分割模式，或者选择没有 OSD 的模式，因为图像已经正确定向。

OCR引擎模式：可选，OCR 引擎应该运行的模式。此选项仅应在使用自定义 Tesseract 构建时使用。
OCR 引擎配置文件：可选，与配置变量一起使用的 Tesseract 配置文件。
每个文件超时：可选，允许OCR引擎在单个文件上运行的最长时间，可能包含多个页面。
OCR 临时文件夹：可选，在其中创建 OCR 操作期间使用的临时文件的文件夹。如果未设置，则会在导出 OCR 文本的目标文件夹或 Nuix 案例文件夹中创建一个临时文件夹。
完成时不要清除 OCR 临时文件夹：如果设置，OCR 临时文件夹不会在 OCR 完成时被删除。此选项可用于通过检查中间临时文件对 OCR 过程进行故障排除。

2.13.10. 原生 OCR 项目

此操作使用 Nuix Rampiva OCR 引擎在 Nuix 案例项上运行 OCR。该操作旨在当 Nuix 项存储了二进制数据时执行最佳性能。

在没有存储二进制数据的 Nuix 项目上运行 原生 OCR 项目 操作时，OCR 将花费更长的时间。在运行此操作之前，要么在 添加证据 操作期间存储项目二进制文件，要么使用 填充二进制存储 操作填充需要 OCRed 的项目的二进制文件。

Nuix Rampiva OCR 引擎支持的 PDF 或图像格式的项目从 Nuix 项目和 OCR 中提取为本机文件。对于所有其他项目，打印图像在 Nuix 内部生成，然后进行 OCRed。

OCR 引擎的设置在Configure Native OCR 操作中定义。

生成 CSV 汇总报告，列出所有源项目、OCR 成功状态和 OCR 过程的其他详细信息。

该操作具有以下设置：

范围查询：Nuix 查询选择要进行 OCR 的项目。
文字修改
- 附加：将提取的文本附加到现有文档文本的末尾。
- 覆盖：用提取的文本替换文档文本。
创建可搜索的 PDF：如果设置，生成PDF文件并覆盖提取的文本并设置为项目的打印图像。

将失败的项目标记为 选项的行为与合法导出操作中的行为相同。

2.13.11. 本机 OCR 图像文件

此操作使用 Nuix Rampiva OCR 引擎对图像文件运行 OCR。

有关支持的图像文件格式的列表，请参阅 https://github.com/tesseract-ocr/tessdoc/blob/main/InputFormats.md。除了这种文件格式之外，Nuix Rampiva 还支持源 PDF 文件（这些文件被光栅化为图像）和包含图像文件列表的文本文件。

OCR 引擎的设置在Configure Native OCR 操作中定义。

对于每个源图像文件，在*输出文本文件文件夹*中写入一个对应的文本文件。生成一个名为 summary_report.csv 的 CSV 报告，列出所有源文件、OCR 成功状态、生成的文本文件的路径和大小，以及 OCR 引擎的输出。

该操作具有以下设置：

源图像文件夹：包含要进行 OCRed 的图像文件的文件夹。
递归扫描文件夹：如果设置，将递归扫描源文件夹，并使用相同的文件夹结构创建输出文件。
跳过包含现有非空文本文件的图像：如果设置，如果目标文件夹中存在具有预期名称且大小大于 0 的文本文件，则将跳过图像。
组装页面正则表达式：用于检测多页文档的正则表达式，每页导出一个图像文件。正则表达式必须至少有一个匹配组，用于选择文档库名称。
输出文本文件文件夹：将在其中创建文本文件的文件夹。
保留不完整的文件：如果设置，则不会删除 OCR 引擎中的空文件和不完整的文本文件。
创建可搜索的 PDF：如果设置，源图像将转换为 输出文本文件文件夹 中的 PDF 文件，并覆盖提取的文本。
输出 PDF 文件夹：将在其中创建 PDF 文件的文件夹。如果此字段为空，它将默认为输出文本文件文件夹。

2.14. Relativity

这些操作在 Nuix 案例和 Relativity 之间传输数据，并允许管理 Relativity 中的各种操作。

2.14.1. 配置相对论连接

该产品模块仅可由拥有 Relativity 或 Relativity One（Relativity ODA LLC 产品）有效许可证的各方使用。Relativity ODA LLC 不测试、评估、认可或认证该产品。

此操作设置用于连接到 Relativity 环境的配置。

可选地，可以使用 相对论服务 并指向 相对论服务 类型的参数。在 Scheduler 中提交工作流期间，系统将提示用户选择 Relativity 服务并在需要时对服务进行身份验证。

当不使用 Relativity 服务时，以下选项在操作中明确定义：

主机名：Relativity 主机名，例如 relativity.example.com。
服务端点：Relativity 服务端点，例如 /relativitywebapi.
端点类型：相对论端点类型，例如 HTTPS.
用户名：用于执行导入 Relativity 的用户名。
密码：上面用户名的密码。

在此字段中输入的值将以明文形式存储在工作流文件中-不应在此字段中输入密码。而是将此字段设置为受保护的参数名称，例如`{relativity_password}`，有关如何设置受保护的参数值的说明，请参见Protected Parameters节。

导入线程：用于 Relativity 上传的并行线程数，例如 Legal Export、Relativity Loadfile Upload、Relativity Images Overlay、Relativity Metadata Overlay、Relativity CSV Overlay。
导入线程超时：允许 Relativity 上传线程空闲的秒数。如果超过允许的超时时间没有报告任何进展，导入线程将被中止。
导入线程重试：在导入遇到致命错误或超时的情况下重试运行导入线程的次数。
元数据线程：用于 Relativity 元数据操作的并行线程数，例如创建 Relativity 文件夹。
修补无效的条目：如果选中，此选项将自动修补由于以下问题而导致上传失败的条目：
- 字段值太长-上传的字段值被修整为相对论中允许的最大长度；
- 栏位值无效，例如由于日期格式错误-栏位值已从上传至相对论的项目中移除；
- 文本文件缺少本机-从上载到相对论的项目中删除了本机或文本组件；
客户端版本：取消选中时，Nuix Rampiva 将使用与 Relativity 服务器版本最接近的 Relativity 客户端版本。选中后， Nuix Rampiva 将使用指定的 Relativity 客户端版本（如果可用）。
休息版：查询 Relativity 对象（例如工作区和文件夹）时要使用的 REST 服务的版本。对于 Relativity One，使用 REST (v1 Latest).

REST (Server 2021) 版本需要 Relativity Server Patch (Q3 2021) 或更高版本。

*导入线程*值与Nuix工人的数量无关。当使用多个导入线程时，将拆分加载文件或覆盖文件，并将数据并行上传到相对论。由于多个线程并行加载数据，因此当未指定排序顺序时，此方法将影响文档在相对性中的显示顺序。

2.14.2. 设置相对论客户端

此操作使用以下设置在 Relativity 环境中选择一个客户端：

客户标识符：Relativity 客户端的*名称*或*伪影ID*。
现有客户：客户端不存在时采取的行动：
- 如果客户端不存在则创建 创建一个新客户。
- 仅使用现有客户端 如果客户端不存在会触发错误。

创建新客户端时适用以下设置：

客户编号：在客户端设置的客户端编号。
状态标识符：可选，状态的*名称*或*伪影ID*要在客户端设置。
关键词: 可选，要在客户端设置的关键字。
注: 可选，要在客户端设置的注释。

2.14.3. 设置相对论

此操作使用以下设置在 Relativity 环境中选择一个事物：

物质标识符：相对论的*名称*或*伪影ID*很重要。

无论它属于哪个客户，即使先前使用了 设置相对论客户端 操作，也会在 Relativity 中选择该事项。

现有物质：如果事情不存在要采取的行动：
- 如果物质不存在则创建物质 创造新事物。
- 只使用现有的物质 如果问题不存在则触发错误。

创建新事务时适用以下设置：

事项编号：在案件上设置的案件编号。
状态标识符: Optional, 状态的*名称*或*伪影ID*要在这件事上设置。
关键词: 可选，要设置的关键字。
注: 可选，要在这件事上设置的注释。

创建新事项时，将在使用之前的*设置相对论客户端*操作选择的客户端下创建。

2.14.4. 设置相对论工作区

此操作使用以下设置在 Relativity 环境中选择一个工作区：

工作区标识符：Relativity 工作区的*名称*或*伪影ID*。

在 Relativity 中选择工作区，而不管它属于什么客户和事项，即使之前使用了 设置相对论客户端 或 设置相对论 操作。

资料夹路径：工作空间内的路径。如果为空，这将检索与工作区根目录对应的文件夹。
创建文件夹路径（如果不存在）：：如果勾选，指定的文件夹路径如果不存在，会在工作区创建。
现有工作区：工作区不存在时采取的行动：
- 如果工作区不存在，则克隆它 通过克隆源 Workspace 创建一个新的 Workspace。
- 仅使用现有工作区 如果 Workspace 不存在会触发错误。
克隆设置：克隆工作区时使用的设置。
- 工作区名称：新创建的工作区的名称。
- 物：克隆工作区时使用的问题。
- 工作区模板：克隆工作区时使用的工作区模板。
- 资源池：克隆工作区时使用的资源池，如果未定义此设置，将选择 Relativity 环境中的第一个可用资源池。
- 数据库位置：克隆工作区时使用的数据库位置，如果未定义此设置，将选择 Relativity 环境中的第一个可用数据库位置。
- 默认文件存储库：克隆工作区时使用的默认文件存储库，如果未定义此设置，则将从 Relativity 环境中选择第一个可用的默认文件存储库。
- 默认缓存位置：克隆工作区时使用的默认缓存位置，如果未定义此设置，则将从 Relativity 环境中选择第一个可用的默认缓存位置。
- 状态：克隆工作区时使用的状态，如果未定义此设置，将选择 Relativity 环境中的第一个可用状态。

当工作空间被克隆时，它是在使用之前的*设置相对论*操作选择的事项下创建的。

2.14.5. 删除 Relativity 工作区

此操作删除指定的工作区（如果存在）。

2.14.6. 创建相对论组

此操作在 Relativity 中创建一个或多个组，该组位于使用之前的 设置相对论客户端 操作选择的客户端下，使用以下设置：

团队名字：要创建的组名。
关键词：可选，分配给创建的组的关键字。
注：可选，分配给创建的组的注释。

如果客户端下存在具有指定名称的组，则不会创建该组，而是会记录组名称和工件 ID。

除了手动提供组设置的值外，用户还可以从 CSV 或 TSV 文件加载，例如：

Group Name   Keywords    Notes
Reviewer    reviewer    Simple group for reviewer
Admin   admin   Group for admins

2.14.7. 管理 Relativity 工作区组

此操作在 Relativity 中添加或删除组，该组位于使用之前的 设置相对论工作区 操作选择的工作空间下，使用以下设置：

组标识符类型：用于工作区组的标识符类型，名称*或*伪影ID。
集体行动：要对组执行的操作，添加*或*去掉.
组设置表
- 组标识符：组的*名称*或*伪影ID*，由*组标识符类型*字段定义。

除了手动提供工作区组的值外，用户还可以从 CSV 或 TSV 文件加载，例如：

Group Identifier
Domain Users
Level 1
Level 2

在工作流执行期间，也可以使用 工作区组文件 选项从文件中加载工作区组。

2.14.8. 创建相对论用户

此操作在 Relativity 中创建一个或多个用户，该用户位于使用之前的 设置相对论客户端 操作选择的客户端下，使用以下设置：

用户模板标识符：要从中复制属性的用户的名称、伪影ID 或 电子邮件地址。

选择标识符类型名称时，必须提供完整的 Relativity 名称。

如果启用模板用户，则创建的所有用户也将被启用并有权访问 Relativity，如果禁用模板用户，则创建的用户将无法访问 Relativity。

发送电子邮件邀请：向创建的每个用户发送电子邮件邀请。
用户设置：
- 邮件：要创建的用户的电子邮件。
- 名：要创建的用户的名字。
- 姓：要创建的用户的姓氏。
- 关键词：可选，分配给创建的组的关键字。
- 注：可选，分配给创建的组的注释。
- 登录方法用户标识符：可选，从模板用户复制的登录方法的主题或帐户名。

除了手动提供用户设置的值外，用户还可以从 CSV 或 TSV 文件加载，例如：

Email   First Name    Last Name    Keywords    Notes    Login Method User Identifier
jon.doe@hotmail.com Jon Doe Reviewer    User    created by Nuix Rampiva  j.doe
el.mills@gmail.com  Elisa   Mills   Support User    created by Nuix Rampiva  e.mills

用户设置也可以在工作流执行期间使用 用户设置文件 选项从文件中加载。

2.14.9. 管理相对论用户

此操作使用以下设置从 Relativity 中删除一个或多个用户：

用户标识符类型：用于检索用户的标识符类型：名称、伪影ID 或 电子邮件地址。

在为用户标识符选择标识符类型名称时，必须提供全名。

用户操作：要对用户执行的操作，删除.
用户：
- 用户标识符：用户的*名称*、伪影ID*或*电子邮件地址。

除了手动为用户提供值外，用户还可以从 CSV 或 TSV 文件加载，例如：

User Identifier
jon.doe@hotmail.com
el.mills@gmail.com

还可以在工作流执行期间使用 用户档案 选项从文件中加载用户。

2.14.10. 管理相对论组用户

此操作使用以下设置从组中添加或删除一个或多个用户：

组标识符：添加或删除用户的组的*名称*、伪影ID*或*姓名（喜欢）。
用户标识符类型：用于检索用户的标识符类型：名称、伪影ID 或 电子邮件地址。

选择标识符类型名称时，必须提供全名。

用户组操作：要对组的用户执行的操作，添加*或*去掉.
群组用户：
- 用户标识符：用户的*名称*、伪影ID*或*电子邮件地址。

除了手动为组用户提供值外，用户还可以从 CSV 或 TSV 文件加载，例如：

User Identifier
jon.doe@hotmail.com
el.mills@gmail.com

还可以在工作流执行期间使用 组用户文件 选项从文件加载组用户。

2.14.11. 查询 Relativity Workspace 组权限

此操作将 Relativity 组的权限作为 JSON 文件导出到指定位置。

2.14.12. 应用 Relativity Workspace 组权限

此操作使用以下设置将权限应用于 Relativity Group：

组标识符：要应用权限的组的*名称*、伪影ID*或*姓名（喜欢）。
权限 JSON：可选，权限文件的内容。
权限文件：由*查询 Relativity Workspace 组权限*操作创建的权限文件。

2.14.13. 复制 Relativity Workspace 组权限

此操作使用以下设置将分配给 Relativity 工作区中的一个组的权限复制到另一个组或工作区：

从以下位置复制权限：

源工作区标识符：源工作区的*名称*、伪影ID*或*姓名（喜欢）。
源组标识符：源组的*名称*、伪影ID*或*姓名（喜欢）。

至：

目标工作区标识符：源工作区的*名称*、伪影ID*或*姓名（喜欢）。
目标组标识符：源组的*名称*、伪影ID*或*姓名（喜欢）。

2.14.14. 创建相对文件夹

此操作根据列表 CSV 文件在 Relativity 工作区中创建文件夹。列表文件必须只有一个列，并且列的名称必须包含单词 文件夹 或路径或位置。

将文档上载到具有复杂文件夹结构的相对论时，建议在上载之前使用to准备文件夹结构。

2.14.15. 相对性加载文件上传

此操作将 Concordance 或 CSV 加载文件加载到 Relativity。

需要以下设置：

加载文件位置：加载文件的路径。
字段映射文件：将 Nuix 元数据配置文件映射到 Relativity 工作区字段的 JSON 文件路径。如果未提供映射文件，则加载文件中的字段将映射到 Relativity 工作区中具有相同名称的字段。
检测零件的出口：检测指定位置的子文件夹中是否存在加载文件，并依次上传所有检测到的加载文件。

将文档加载到相对论中时，此操作会将Relativity`OverwriteMode属性设置为Append`。

*合规导出*操作可用于导出加载文件并上传到Relativity，并具有在导出零件可用后立即上传的附加好处。

最小样本`mapping.json`：

{
    "FieldList": [
        {
            "identifier": true,
            "loadfileColumn": "DOCID",
            "workspaceColumn": "Control Number"
        },
        {
            "loadfileColumn": "TEXTPATH",
            "workspaceColumn": "Extracted Text"
        },
        {
            "loadfileColumn": "ITEMPATH",
            "workspaceColumn": "File"
        },
        {
            "loadfileColumn": "BEGINGROUP",
            "workspaceColumn": "Group Identifier"
        }
    ]
}

2.14.16. 相对论元数据覆盖

此操作从范围查询中的Nuix项导出元数据，并将其覆盖到相对论中。

需要以下设置：

字段映射文件：将 Nuix 元数据配置文件映射到 Relativity 工作区字段的 JSON 文件路径。如果未提供映射文件，则加载文件中的字段将映射到 Relativity 工作区中具有相同名称的字段。

请参阅有关如何在 Relativity Loadfile Upload 操作中创建映射文件的更多信息，或使用下面的示例映射文件。

将元数据加载到相对论中时，此操作会将Relativity`OverwriteMode属性设置为Overlay`。

要使用非索引字段将数据覆盖到 Relativity，请在映射文件中将 identifier 属性设置为 true 并在 fieldId 属性中提供该字段的工件 ID。

示例 mapping.json 用于在工作空间中基于 GUID 覆盖数据，其中包含字段 NuixGuid 和工件 ID 1040313：

{
    "FieldList": [
        {
            "loadfileColumn": "TEXTPATH",
            "workspaceColumn": "Extracted Text"
        },
        {
            "loadfileColumn": "GUID",
            "identifier": true,
            "fieldId": 1040313,
            "workspaceColumn": "NuixGuid"
        }
    ]
}

2.14.17. 相对论图像叠加

此操作将图像从 Opticon 加载文件叠加到 Relativity。

需要以下设置：

标识符字段：标识符字段的Artifact ID，如*控制序列号*或*文档 ID*。

要获取标识符字段的工件 ID，请在 Relativity 中打开工作区，导航到 Workspace Admin → Fields，然后单击标识符字段，例如 控制序列号。然后，要获取此字段的 Artifact ID，请从 URL 中提取值。例如，具有以下 URL 的 Artifact ID 为 1003667: https://relativity.rampiva.lab/Relativity/RelativityInternal.aspx?AppID=1018179&ArtifactTypeID=14&ArtifactID=1003667&Mode=Forms&FormMode=view&LayoutID=null&SelectedTab=null

从第一页去除后缀：去除第一页的后缀以从 Opticon 加载文件推断文档 ID，例如 _0001.
检测零件的出口：检测指定位置的子文件夹中是否存在加载文件，并依次上传所有检测到的加载文件。

此操作在将图像加载到 Relativity 时将 Relativity OverwriteMode 属性设置为 Overlay。

2.14.18. 相对性CSV重叠式广告

此操作将元数据从指定的覆盖文件覆盖到相对性。

需要以下设置：

字段映射文件：将 Nuix 元数据配置文件映射到 Relativity 工作区字段的 JSON 文件路径。如果未提供映射文件，CSV 文件中的列将映射到 Relativity 工作区中具有相同名称的字段。

请参阅有关如何在 Relativity Loadfile Upload 操作中创建映射文件的更多信息。

2.14.19. 相对性查询

此操作查询 Relativity 工作空间的属性并将它们分配为工作流中的参数。

2.14.20. 加载相对论动态对象

此操作使用以下设置将动态对象 (RDO) 加载到 Relativity ：

对象类型标识符：对象类型的*名称*、伪影ID*或*姓名（喜欢）。
在工作空间中加载对象：确定对象是否将加载到工作空间中。

如果选择了选项 在工作空间中加载对象，则需要 设置相对论工作区操作。

对象：要加载的对象的制表符分隔列表。

样本对象数据：

Article Title	Article Type	Article Date	Is Available
Star Wars	Wikipedia Article	2022-11-10T00:00:01	Yes
Globex	Review Article	2022-11-10T00:00:01	No

字段名称是必需的，如果该字段不存在，操作将失败。

除了手动提供对象的值外，用户还可以使用与上述示例相同的格式从 TSV 文件加载。

加载对象时，第一行代表对象类型的字段，后面的行是将被评估并加载到 Relativity 中的对象。

当用户使用字段类型对象或选项时，在列中使用对象或选项的名称，例如给定字段 单一对象 的类型为 单一对象 和字段 部门组 的类型为 单项选择：

Name    Department  Department Group
John Doe    IT  Sales
Jane Doe    Marketing   Sales

当用户使用字段类型 multiple object 或 multiple choice 时，使用对象或选择的名称并用逗号 , 分隔每个项目，例如给定字段爱好的类型 多对象 和字段团体的类型 多项选择：

Name    Hobbies  Groups
John Doe    Hockey,Golfing  Rotary Club,Robotics
Jane Doe    Golfing,Skiing,Reading   Book Club,Crossfit

2.14.21. 创建 ARM 存档

此操作使用以下设置创建 Relativity ARM 存档作业：

存档目录：存档将被存储的路径，例如 \\INSTANCE007\Arhives\TestWorkspaceArchive
使用默认存档目录：使用默认路径存储您的存档

选择存档目录时，必须提供有效的 UNC 路径，例如：\\INSTANCE001\Arhives\NewArchive。

优先：归档作业的执行优先级：低、中、高
等待归档完成：等待存档作业完成。
锁定 UI 作业操作：确定用户界面上通常可用的工作操作是否应该对用户可见。
通知工作创建者：确定是否将电子邮件通知发送给作业创建者。
通知作业执行者：确定是否将电子邮件通知发送给作业执行者。
包括数据库备份：在存档中包含数据库备份。
包括 dtSearch：在存档中包含 dtSearch 索引。
包括概念分析：在存档中包含概念分析索引。
包括结构化分析：在存档中包含结构化分析索引。
包括数据网格：在存档中包含数据网格应用程序数据。
包括存储库文件：包括工作区存储库中包含的所有文件，包括存档中文件字段中的文件。
包括链接文件：将工作区文件存储库中不存在的所有链接文件包含在存档中。
丢失文件行为：在归档过程中检测到丢失的文件时，向*跳过文件*或*停止工作*指示天气。

将 丢失文件行为 设置为 停止工作 将导致存档作业在缺少文件时停止/失败。

包括处理：在存档中包含处理应用程序数据。
包括处理文件：包括存档中处理发现的所有文件和容器。

When the options 包括处理文件 is selected the files will be located in the archive directory under the folder Invariant.

缺少处理文件行为：表示在归档过程中检测到丢失的处理文件时是*跳过文件*还是*停止工作*。
包括扩展工作区数据：在存档中包含扩展工作区信息。

扩展工作区数据包括已安装的应用程序、链接的相关性脚本和非应用程序事件处理程序。

应用程序错误导出行为：表示是否对在导出过程中遇到错误的应用程序进行*跳过申请*或*停止工作*。

此操作需要 Relativity 实例安装 ARM 应用程序。

2.14.22. 创建 Relativity ARM 还原

此操作使用以下设置创建 ARM 还原作业：

存档路径：要恢复的ARM存档的路径，例如`\\INSTANCE007\Arhives\TestWorkspaceRestore`

提供的 存档路径 不能被另一个 ARM 作业使用。

优先：恢复作业的执行优先级：低、中、高.
锁定 UI 作业操作：确定用户界面上通常可用的工作操作是否应该对用户可见。
通知工作创建者：确定是否将电子邮件通知发送给作业创建者。
通知作业执行者：确定是否将电子邮件通知发送给作业执行者。
物质标识符：要恢复到的物质的*名称*、伪影ID*或*姓名（喜欢）。

如果工作流中存在前面的 设置相对论 操作，则使用 设置相对论 操作的事务，如果 物质标识符 字段中有值，则将使用 物质标识符 字段中设置的事务。

资源池标识符：将工作空间恢复到的资源池。如果未定义此设置，将选择 Relativity 环境中的第一个可用资源池。
数据库服务器标识符：将工作区恢复到的数据库服务器。如果未定义此设置，将选择 Relativity 环境中的第一个可用数据库服务器。
缓存位置标识符：将工作区恢复到的缓存位置。如果未定义此设置，将选择 Relativity 环境中的第一个可用缓存位置。
文件存储库标识符：将工作区恢复到的文件存储库。如果未定义此设置，将选择 Relativity 环境中的第一个可用文件存储库。
- 参考文件作为存档链接：确定文件是否应保留在存档目录中，是否应从工作区数据库中引用，而不是将它们复制到工作区存储库中。
- 更新存储库文件路径：确定是否应更新存储库文件位置以反映其新位置。
- 更新链接文件路径：确定是否应更新非存储库文件位置以反映其新位置
- 自动地图用户：确定存档用户是否应按电子邮件地址自动映射。
- 自动地图组：确定存档组是否应按名称自动映射。
- 结构化分析服务器：结构化分析服务器的*名称*、伪影ID*或*姓名（喜欢）。仅当用户正在恢复的存档包含结构化分析数据时才需要此字段。
- 概念分析服务器: The 名称, 伪影ID or 姓名（喜欢） of the conceptual analytics server 仅当用户正在恢复的存档包含概念分析数据时才需要此字段。
- dtSearch 位置标识符：dtSearch 位置的名称、伪影ID 或 姓名（喜欢）。仅当用户正在恢复的存档包含 dtSearch 索引时才需要此字段。
- 现有目标数据库：目标数据库，以防存档没有数据库备份文件。

此操作需要 Relativity 实例安装 ARM 应用程序。

2.14.23. 列出相对论文件

此操作列出了相对工作空间中存在的所有文档。

可以使用以下设置：

范围查询：在此范围内将 Relativity 工作区中的 DocID 与 Nuix 案例中的文档进行交叉引用。
将匹配项标记为：分配给 Nuix 案例范围内文档的标签，这些文档与 Relativity 工作区中的文档具有相同的 DocID。
在以下位置导出DocID：要将 Relativity 工作区中的 DocID 列表写入其中的文件的路径和名称。每行将包含一个 DocID。

2.14.24. 添加相对论脚本

此操作使用以下设置将指定脚本添加到工作区：

脚本标识符：添加到 Relativity 工作区的脚本
应用程序标识符：脚本将运行的应用程序，此设置是可选的。

为了将脚本添加到 Relativity Workspace，首先在 相对论脚本库 中定义它。 相对论脚本库 位于 Relativity 主页的 应用程序和脚本 → 相对论脚本库 下。

2.14.25. 相对论运行脚本

此操作在 Relativity 工作区或管理工作区中运行脚本。

可选地，可以向脚本提供输入值。要确定所需的输入 ID 和允许的值，请在没有任何输入的情况下运行脚本并检查执行日志。

脚本完成后，最终错误将存储在参数名称 {last_relativity_script_error} 中。

脚本的输出可以导出到以下类型的文件中：

CSV：使用扩展名 .csv
PDF：使用扩展名 .pdf
XLSX：使用扩展名`.xlsx`，导出默认使用此选项，如果没有匹配其他格式，将使用此选项。

2.14.26. 删除相对论脚本

此操作删除指定的脚本（如果存在）。

2.14.27. 管理相对论 dtSearch 索引

此操作使用以下设置在 dtSearch 索引上运行索引构建：

dtSearch 索引标识符：执行操作的 dtSearch 索引。
索引操作：要对索引进行的索引构建操作，构建操作为以下之一：
- 完整构建
- 增量构建
- 压缩索引
- 激活索引
- 停用索引
等待动作完成：等待构建操作完成，然后再进行下一个操作。

2.14.28. 运行 Relativity 搜索词报告

此操作使用以下设置在 Relativity 实例上运行搜索词报告：

搜索词报告标识符：要运行的搜索词报告
报表运行类型：要执行的报表运行类型，报表运行类型为以下之一：
- 运行所有条款
- 运行未决条款
报告结果位置: 可选，导出报告csv结果的位置

此操作完成后，结果将作为 json 对象存储在参数 {relativity_search_term_results_json} 中。结果将采用以下格式：

{
    "results": [
        {
            "Name": "apples",
            "Documents with hits": "16",
            "Documents with hits, including group": "0",
            "Unique hits": "",
            "Last run time": "2/10/2023 4:08 AM"
        },
        {
            "Name": "rampiva",
            "Documents with hits": "72",
            "Documents with hits, including group": "0",
            "Unique hits": "",
            "Last run time": "2/10/2023 4:08 AM"
        },
        {
            "Name": "sensitive",
            "Documents with hits": "2",
            "Documents with hits, including group": "0",
            "Unique hits": "",
            "Last run time": "2/10/2023 4:08 AM"
        }
    ]
}

搜索词报告的结果存储在results数组中，对象内部的属性是搜索词报告结果视图对应的字段。

参数 {relativity_search_term_results_json} 可以在脚本中用于为搜索词报告的结果添加逻辑，例如以下脚本只打印至少出现过一次的结果：

# Example script only showing terms with hits
results_object = parameters.getJsonObject("{relativity_search_term_results_json}")
results_array = results_object["results"]

# Header which indicates how many times it was seen
hits_header = "Documents with hits"

# Only print a result if it was seen at least one time
for result in results_array:
	if int(result[hits_header]) > 0:
		for key in result.keySet():
			print(key + ": " + result[key])

		# Separate results
		print("\n")

报告中

此选项基于模板文件生成 Excel 格式的搜索词报告。该报告使用模板中的 _REL_RUN_SEARCH_TERMS_ 工作表。

有关使用自定义模板的信息，请参见Processing Report。

2.14.29. 导出 Relativity 保存的搜索

此操作使用以下设置将保存的搜索转换为 Nuix Rampiva Relativity Query Language 格式并将保存的搜索导出到 csv 文件：

保存的搜索导出位置：导出csv结果的位置

此操作完成后，csv 文件位置将存储在参数 {relativity_saved_searches_file} 中。

报告中

此选项基于模板文件生成 Excel 格式的已保存搜索报告。该报告使用模板中的 _REL_EXPORT_SAVED_SEARCH_ 工作表。

有关使用自定义模板的信息，请参见Processing Report。

2.14.30. 创建 Relativity 保存的搜索

此操作使用 Nuix Rampiva Relativity Query Language 创建保存的搜索，使用以下设置：

保存的搜索：
- 文件夹：文件夹路径，如果路径不存在则创建它
- 名称：查询的名称
- 查询：将转换为保存搜索的相对查询语言字符串
- 范围：保存搜索的范围
- 字段: 已保存搜索的字段，字段由 , 逗号分隔
- 排序：已保存搜索的排序字段，排序字段以 , 逗号分隔，并在方括号 [] 中包含排序方向。例如，如果用户想要按工件 ID 升序排序，则用户将提供 Artifact ID [Ascending] 作为排序列。用户只能为排序方向提供两个可能的值 Ascending 或

除了手动为保存的搜索提供值外，用户还可以从 CSV 或 TSV 文件加载，例如：

Folder,Name,Query,Scope,Scope Folders,Fields,Sorting
Admin Searches,Produced Documents,[Bates Beg] is_set,WORKSPACE,,"Edit,File Icon,Control Number,Bates Beg,Bates End",Bates Beg [Ascending]
Admin Searches,Extracted Text Only,[Extracted Text] is_set,FOLDERS,Temp\\Tes,Extracted Text,

保存的搜索也可以在工作流执行期间从文件中加载，使用 保存的搜索文件 选项。

2.14.31. Nuix Rampiva 相对论查询语言

Nuix Rampiva Relativity 查询语言是一种用于创建 Relativity 保存搜索的自定义语言，该语言采用 Relativity 保存的搜索创建形式，并将其转换为基于文本的查询语言，以允许工作流程自动创建保存的搜索。

这种语言由一堆表达式组成，每个表达式包含一个文档字段名、运算符和一个值。然后每个表达式由一个和或一个或者连接起来，充当两个表达式之间的逻辑运算符。

表达式也可以组合在一起形成逻辑组，逻辑组在括号内包含一个或多个表达式。逻辑组内的表达式将一起计算，逻辑组的结果是内部计算的表达式。表达式可以嵌套的次数没有限制。

文档字段名文档字段名对应Relativity中的Document

Fields，要在表达式中声明文档字段名，将字段名括在方括号中。例如，如果用户想使用字段名称 控制序列号，那么在表达式中它将声明为 [控制序列号]。

当使用 保存的搜索 或 索引搜索 作为表达式中的文档字段时，它们声明如下：[保存的搜索] 用于保存的搜索和 [索引搜索] 用于索引搜索。

运算符表达式的运算符定义了值的计算方式，有两种不同的运算符二元运算符期望值和一元运算符

不需要值。要在表达式中声明运算符，用户必须首先声明文档字段名称，然后提供下表中列出的以下运算符之一。

运算符示例

is

[Control Number] is "Example"

is_not

[Control Number] is_not "Example"

is_set

[Artifact ID] is_set

is_not_set

is_logged_in

[Created By] is_logged_in

is_not_logged_in

[Created By] is_not_logged_in

is_like

[Folder Name] is_like "FolderA"

is_not_like

[Control Folder Name] is_not_like "FolderA"

is_less_than

[Attachment Count] is_less_than "3"

is_less_than_or_equal_to

[Attachment Count] is_less_than_or_equal_to "12"

is_greater_than

[Attachment Count] is_greater_than "9"

is_greater_than_or_equal_to

▷

starts_with

[Email Subject] starts_with "Confidential"

does_not_start_with

[Email Subject] does_not_start_with "Redacted"

ends_with

[Title] ends_with "signing"

does_not_end_with

[Title] does_not_end_with "signing"

contains

[Email From] contains "@example.com"

does_not_contain

[Email From] does_not_contain "@example.com"

is_any_of_these

[Custodian] is_any_of_these [1023221, 2254568]

is_none_of_these

[Custodian] is_none_of_these [1023221, 2254568]

is_all_of_these

[Submitted By] is_all_of_these [1024881]

is_not_all_of_these

[Submitted By] is_not_all_of_these [1024881, 102568]

is_in

[Folder] is_in [1025681, 1024881, 1032568]

is_not_in

[Folder] is_not_in [1025681, 1024881, 1032568]

is_before

[Sort Date] is_before 2022-04-05

is_before_or_on

[Sort Date] is_before_or_on 2022-04-05

is_after

[Date Last Modified] is_after 2021-12-09T15:36:00

is_after_or_on

[Date Last Modified] is_after_or_on 2021-12-09T15:36:00

is_between

[Date Added] is_between 2019-01-01 - 2023-01-01

is_not_between

[Date Added] is_not_between 2019-01-01 - 2023-01-01

Value

表达式的值定义了用户期望从文档字段中得到什么值。要在表达式中声明一个值，必须声明文档字段名称和运算符，然后用户可以通过将文本或数字放在双引号内来提供一个值，例如 "Value 8" 或者用户可以在方括号内提供整数列表，例如`[102889, 1025568]`。方括号内的整数对应于 Relativity 上对象的工件 ID。

值也可以声明为日期，日期值不需要在双引号或方括号内。声明日期值时只能使用特定的运算符，支持日期值的运算符有 is、is_not、is_in、is_not_in、is_before、is_before_or_on、is_after、is_after_or_on、is_between、is_not_between。

运算符 is_between 和 is_not_between 只能采用由 - 分隔的两个日期或日期时间值。例如：2019-01-01 - 2023-01-01 或 2019-01-01T00:00:00 - 2022-12-31T23:59:59

日期值可以是以下格式之一：

日期：日期的格式是年（4 位数字）- 月（2 位数字）- 日（2 位数字）。例如`2023-04-13`
约会时间:日期时间的格式为年（4位） - 月（2位） - 日（2位） T 时（2位） : 分（2位） : 秒（2位）可选用户也可以声明通过添加 . 后跟 1 到 9 位数字来表示毫秒。例如：2019-05-10T05:00:13 或 -
月: month的格式是大写的月份名称。例如：March 或 July
本星期：本周的格式是小写单词，例如*本星期*
这个月：这个月的格式是小写单词，例如*这个月*
下周：下周的格式为小写单词，例如*下周*
上星期：上周的格式是小写的单词，例如*上星期*
最近 7 天：最近7天的格式是小写的单词，例如*最近 7 天*
最近 30 天：最近30天的格式是小写的单词，例如`last 30 days`

示例保存的搜索查询

两个日期之间带有附件的电子邮件：

[Email Subject] is_set and ([Number of Attachments] is_not "0" and [Date Sent] is_between 2021-08-04 - 2023-02-28T23:59:59.997)

生成的有生产错误的文档，按文件大小排序：

[Bates Beg] is_set and [Production Errors] is "true"

没有提取文本的文档：

[Extracted Text] is_not_set or [Extracted Text Size] is "0"

2.14.32. 查询 Relativity 工作区被覆盖的权限

此操作使用以下设置导出覆盖的继承权限：

权限输出文件：导出权限JSON文件的位置
对象范围：
- 对象类型：对象的类型，例如*文件夹*
- 对象名称：可选，对象的名称，例如*分期*。要查询具有特定类型的所有对象，请将名称字段留空。

除了手动提供对象类型的值外，用户还可以从 CSV 或 TSV 文件加载，例如：

Folder  Admin
Folder  Staging
View

对象范围也可以在工作流执行期间从文件加载，使用 对象范围文件 选项。

2.14.33. 应用 Relativity 工作区覆盖权限

在生产工作区上运行此操作之前，请在使用同一模板创建的测试工作区上运行此操作，或执行生产工作区的备份，以确保实现预期结果。

此操作使用以下设置应用覆盖的继承权限：

匹配对象：
- 工件 ID 和名称：目标工作区中的对象必须与权限文件中的对象具有相同的名称和工件 ID 才能匹配。
- 名称：目标工作区中的对象必须与权限文件中的对象同名。
新对象行为：在目标工作空间中识别出对象时采取的操作，但该对象在权限文件中不存在：
- 不要更改权限文件中不存在的对象的权限
- 为权限文件中不存在的对象重置权限
跳过对象：（可选）跳过对表中定义的对象应用权限
- 对象类型：对象类型名称，例如*视图*
- 对象名称: 对象名称
覆盖权限文件：由*查询 Relativity 工作区被覆盖的权限*操作创建的权限文件。
覆盖权限 JSON：可选，权限文件的内容。

报告中

此选项基于模板文件生成 Excel 格式的覆盖权限报告。该报告使用模板中的 _REL_OVERWRITTEN_PERMISSIONS_ 工作表。

有关使用自定义模板的信息，请参见Processing Report。

2.14.34. 调用相对论 API

此操作将使用 Configure Relativity Connection 中的当前配置对 Relativity 进行 API 调用，使用以下设置：

动词：HTTP 动词，例如 GET 或 POST.
终点：Relativity API 的端点。
参量：可选，URL参数。
身体：JSON 请求。

API 调用完成后，将填充以下参数：

{relativity_call_api_response_code}：HTTP 响应代码。
{relativity_call_api_response_headers}：响应标头，JSON 编码。
{relativity_call_api_response_body}：响应体。

2.14.35. 删除 Relativity 保存的搜索

此操作从工作空间中删除指定的已保存搜索或所有已保存搜索。

2.14.36. 运行相对论成像装置

此操作使用以下设置运行指定的成像集：

影像集标识符: 成像设置的*名称*、伪影ID*或*姓名（喜欢）。
隐藏图像以供 QC 审查：启用后，它会阻止用户在 QC 审查过程完成之前查看图像。
等待完成：等到成像集运行完毕。

2.14.37. 删除相对指数

此操作删除指定的索引（如果存在）。

2.14.38. 创建相关性分析索引

此操作使用以下设置创建一个分析索引：

名称: 分析指标名称
索引类型：索引的类型，概念性的*或*分类
保存的搜索标识符：已保存搜索的*名称*、伪影ID 或 姓名（喜欢）
分析服务器标识符：分析服务器的*名称*、伪影ID 或 姓名（喜欢）
订购：在 Relativity 内的下拉列表中看到的索引顺序，例如将值设置为订购会导致在所有下拉列表中首先看到索引
电子邮件通知收件人文件：（可选）在索引填充和构建期间通知的电子邮件收件人列表，例如：

Email Notification Recipient
usera@example.com
userb@example.com
userc@example.com

除了上面的设置，概念分析索引还有以下高级选项

高级选项
- 概念停用词文件：（可选）包含要从索引中删除的单词的文件
- 继续索引步骤完成：（可选）指示是否在开始一个步骤后自动完成激活分析索引所需的所有步骤
- 方面: (可选)建索引时文档映射到的概念空间的维数
- 启用电子邮件标题过滤器：（可选）删除常见的标题字段（例如 To、From 和 Date）和 reply-indicator 行
- 优化训练集：（可选）表示是否只从训练集保存的搜索中选择概念上相关的文档
- 删除填充期间出错的文档：（可选）当文档在之前的填充中出错时，将其从填充中移除
- 删除英文签名和页脚：（可选）表示是否删除英文电子邮件中的签名和页脚
- 重复内容过滤器文件：（可选）包含与索引关联的重复内容过滤器的文件
- 训练集: (Optional) 已保存搜索训练的*名称*, 伪影ID or 姓名（喜欢）

示例*概念停用词文件*：

Stop Words
and
a
can

示例 重复内容过滤器文件，过滤器是按名称标识的：

Content Filters
Credit Card Regex Filter
Email Address Filter

2.14.39. 运行相对论保存的搜索

此操作使用以下设置在 Relativity 实例上运行已保存的搜索并返回项目计数：

运行选项：用户将如何检索保存的搜索以运行：
- 工作区中所有保存的搜索：运行工作区中所有保存的搜索
- 搜索容器下的所有已保存搜索：运行指定搜索容器下所有保存的搜索
- 单个保存的搜索：运行指定的已保存搜索
保存的搜索标识符：已保存搜索的*名称*、伪影ID 或 姓名（喜欢）
搜索容器标识符：搜索容器的*名称*、伪影ID*或*姓名（喜欢）

此操作完成后，结果将作为 json 对象存储在参数 {relativity_run_saved_search_results_json} 中。结果将采用以下格式：

{
    "results": [
        {
            "Name": "All Documents",
            "Query": "[Artifact ID] is_set",
            "Hits": 163,
            "Folder": "Admin Searches\\Tests"
        },
        {
            "Name": "Extracted Text Only",
            "Query": "[Extracted Text] is_set",
            "Hits": 113,
            "Folder": ""
        },
        {
            "Name": "Produced Documents",
            "Query": "[Control Number] is_set and [Document] is \"true\"",
            "Hits": 65,
            "Folder": "Admin Searches"
        }
    ]
}

运行的已保存搜索的结果存储在结果数组中，对象内的属性是：

名称: 保存搜索的名称
伪影ID: 保存搜索的神器ID
命中：运行保存的搜索时返回的文档数量

参数 {relativity_run_saved_search_results_json} 可以在脚本中使用，为保存的搜索结果的结果添加逻辑，例如以下脚本将只打印至少有一次命中的结果：

# Example script only showing saved searches with atleast one document
results_object = parameters.getJsonObject("{relativity_run_saved_search_results_json}")
results_array = results_object["results"]

# Only print a result if it has atleast one document
for result in results_array:
	if int(result["Hits"]) > 0:
		print("Folder: " + result["Folder"])
		print("Name: " + result["Name"])
		print("Query: " + result["Query"])
		print("Hits: " + str(result["Hits"]))

	# Separate results
	print("\n")

报告中

此选项基于模板文件生成 Excel 格式的已保存搜索报告。该报告使用模板中的 _REL_RUN_SAVED_SEARCH_ 工作表。

有关使用自定义模板的信息，请参见Processing Report。

2.14.40. 管理相关性分析指数

此操作使用以下设置对指定的分析索引运行索引操作：

解析索引标识符: 分析指标的*名称*、伪影ID*或*名称（正则表达式）
解析指标类型：分析指标类型*概念性的*或*分类*
现有的分析作业操作：找到现有分析索引作业时的行为
- 如果同一索引正在进行另一个分析索引作业，则跳过运行分析索引作业
- 停止当前正在运行的分析作业操作，并开始一个新的作业
索引操作：对分析索引执行的操作
- 全人口：运行完整的索引填充
- 增量人口：运行增量填充
- 建索引：运行完整的索引构建
- 重试错误：重试填充期间发生的错误
- 删除错误的文档：删除错误的文件
- 启用: 激活索引进行查询
- 停用：禁用对索引的查询
等待完成：等待索引作业完成

在分析索引上使用索引操作 建索引 时，必须停用分析索引。

2.14.41. 运行 Relativity OCR 集

此操作使用以下设置运行指定的 OCR 集：

OCR 集标识符：OCR 集的*名称*、伪影ID 或*姓名（喜欢）*。
现有 OCR 设置作业操作：当前正在运行现有 OCR 设置作业时要采取的操作
- 停止：停止当前正在运行的 OCR 设置作业，并开始新作业
- 跳跃：如果同一组正在进行另一个 OCR 组作业，则跳过运行 OCR 组作业
等待完成：等到 OCR 集完成运行。

2.14.42. 导出相对论元数据

此操作使用以下设置导出指定的元数据类型：

元数据类型：要导出的元数据类型，视图或 保存的搜索
元数据标识符：元数据的名称、伪影ID 或 姓名（喜欢）。
元数据类型位置：导出元数据的位置，可以是 当前工作空间 或 管理工作区
定制条件：允许用户在导出元数据时定义更细粒度的查询，请参阅“https://platform.relativity.com/RelativityOne/Content/REST_API/资源_Tasks/Querying_为了_resources.htm#_Syntax_为了_query_conditions”了解更多信息。

视图的输出可以导出到以下类型的文件中：

CSV：使用扩展名 .csv
PDF：使用扩展名 .pdf
XLSX：使用扩展名`.xlsx`，导出默认使用此选项，如果没有匹配其他格式，将使用此选项。

2.14.43. 创建相对论生产集

此操作使用以下设置创建一个生产集：

名称: 制作集名称
生产数据源: 制作数据来源
- 数据源名称: 数据源名称
- 数据源类型：要生成的数据类型，以下*图片*、原住民*或*影像与原住民 之一
- 保存的搜索标识符：已保存搜索的*名称*、伪影ID 或 姓名（喜欢）
- 图片占位符：使用图片占位符时要执行的操作，可以是*从不使用图像占位符*、始终使用图像占位符*或*没有图像时
- 占位符标识符：占位符的*名称*、伪影ID*或*姓名（喜欢）
- 标记集标识符：标记集的名称、伪影ID 或 姓名（喜欢）
- 刻录编辑：在制作图像类型作品时要烧掉修订版的天气
从模板创建生产集：使用现有制作集的设置创建新的制作集
- 生产集模板标识符：制作集模板的*名称*、伪影ID*或*姓名（喜欢）
- 生产集存在于另一个工作区：启用此选项可让用户从任何工作区复制生产集模板设置
- 工作区标识符：模板制作集工作区的*名称*、伪影ID*或*姓名（喜欢）
从设置创建生产集 使用操作中的设置创建新作品
- 编号类型：文件编号类型
- 前缀: 贝茨数字前显示的字符串
- 后缀：（可选）贝茨数字后显示的字符串
- 起始编号：初始起始贝茨数
- 编号位数：代表文档级编号所用位数的数字，范围1-7
- 品牌字体：用于品牌的字体类型
- 品牌字体大小：用于品牌的字体大小
- 缩放品牌字体：使品牌字体缩放
- 包装品牌字体：导致品牌文字在与相邻的页眉或页脚重叠时换行

2.14.44. 运行相对论生产集

此操作使用以下设置运行生产集：

生产集标识符：制作集的*名称*、伪影ID*或*姓名（喜欢）
制作组动作：在生产集上执行的动作
- 阶段：暂存生产集以准备生产文件
- 跑：在生产集上开始工作并生产分阶段文件
- 阶段和运行：暂存生产集以准备生成文件，然后立即在生产集上开始作业
等待完成：在进入下一个操作之前等待生产集完成

2.15. SQL

这些操作在 Nuix 实例和 SQL 服务器之间传输数据，并允许运行任意 SQL 命令。

2.15.1. SQL命令

此操作连接到 SQL 数据库并使用以下选项运行 SQL 命令：

SQL平台：运行命令的 SQL 平台，Microsoft SQL（使用 JTDS 或 Native 驱动程序）和 PostgreSQL的.
SQL服务器名称：SQL主机名，例如`localhost`。
港口：SQL主机端口，例如Microsoft SQL的host，PostgreSQL的`5432`。
加密：加密JTDS连接的要求：
- 未启用：不使用加密。
- 请求：如果服务器支持，尝试使用加密连接
- 需要：需要使用加密连接。
- 签：需要使用加密连接，并在 Java Trust Store 中使用证书签名。
实例：Microsoft SQL实例，例如`SQLEXPRESS`，或默认实例为空白。
域：Microsoft SQL身份验证的Windows域，或集成身份验证的空白域。
用户名：用于连接数据库的用户名，对于集成身份验证则为空白。
密码：用于连接数据库的密码，对于集成身份验证则为空白。
数据库：运行SQL命令的SQL数据库。

如果使用SQL平台*PostgreSQL的*未指定数据库，则该操作将尝试连接到`postgres`数据库。另外，使用*PostgreSQL的*创建数据库时，无法使用相同的查询更改该数据库。要更改创建的数据库，需要执行另一个SQL Comm*PostgreSQL的*操作。

SQL查询：要运行的SQL查询。

此操作可用于创建运行其他SQL操作所需的数据库。

创建数据库的示例SQL查询：

CREATE DATABASE rampiva;

2.15.2. 中继资料转SQL

此操作将与范围查询匹配的项目的元数据导出到 Microsoft SQL（使用 JTDS 或 Native 驱动程序）或 PostgreSQL的。

当指定的表不存在时，此操作将尝试从选定的元数据配置文件中的元数据字段确定每种列类型，并使用检测到的列类型创建一个SQL表。

创建SQL表时，如果无法确定元数据字段类型，则在in中使用类型`NVARCHAR(MAX)，在*PostgreSQL的*中使用类型TEXT`。

2.15.3. 从SQL查询

此操作从SQL数据库查询数据，并将自定义元数据添加到合并范围中的项目，并将查询到的数据导出到`CSV`文件。

表的第一列名称必须为`GUID或DocID`。随后的列对应于要分配的元数据字段。

列别名可以代替名称为`GUID或DocID`的列。

带有列别名的示例查询：

SELECT [Header One] as 'GUID'
      ,[Header Two] as 'File Type'
      ,[Header Two] as 'File Path'
  FROM [TEST TABLE]

带有列别名的示例查询：

SELECT "Header One" as "GUID"
      ,"Header Two" as "File Type"
      ,"Header Two" as "File Path"
  FROM test_table