免责声明

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

© Nuix 加拿大公司 2024 保留所有权利

介绍

本指南介绍*努克斯·兰皮瓦*的安装。本文档就像参考一样工作-使用目录查找您所找到的主题。

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

虽然我们接受有关产品所有版本的反馈，但支持仅限于季度和年度发布渠道的最新主要版本和最新次要版本。 Nuix Rampiva 建议订阅产品更新通知，并在更新可用后的短时间内查看和应用更新。

该软件需要有效的 Nuix Rampiva 许可证。许可证通常是有时间限制的，并且软件的某些功能需要特定的许可证版本。如果您遇到 Nuix Rampiva 许可证的任何问题，或者对产品功能有任何具体问题，请联系 nuix support。

本指南中使用的样式

注意：此图标表示提供其他说明，例如有效选项是什么。
小费：此图标使您知道提供了一些特别有用的花絮，也许是使用应用程序实现特定行为的一种方式。
警告：此图标突出显示可以帮助您避免不良行为的信息。

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

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

1. 建筑

1.1. 组件

Nuix Rampiva 部署中有几个组件：

  • Nuix Rampiva 调度程序：接收来自分析师或企业服务的队列作业请求，并将作业分派到 Nuix Rampiva 引擎服务器。

  • Nuix Rampiva 引擎服务器：从 Nuix Rampiva Scheduler 接收作业，启动引擎并运行作业。

  • Nuix引擎：Nuix引擎会创建/打开Nuix案例并在案例中执行所需的工作。

  • Nuix许可证来源：可以使用以下类型的一个或多个Nuix许可证来源：

    • Nuix NMS

    • Nuix许可证加密狗

    • Nuix云许可证

  • 认证来源：将用于验证用户身份和确定组成员身份的服务。这可以是以下各项的组合：

    • Nuix UMS：Nuix用户管理服务器

    • LDAP：本地Active Directory

    • Azure AD：Microsoft Azure Active Directory

    • OIDC：符合 Open ID Connect 标准的身份验证服务

    • 内部：内部定义的用户名和密码，用于初始配置。

此外，以下组件是可选的：

  • Nuix Rampiva OData 服务器：使用 OData 协议返回利用率数据。

  • Nuix Rampiva 代理：从主 Nuix Rampiva Scheduler 卸载数据上传和散列。

  • 商业智能软件：一种软件工具，用于查询 Nuix Rampiva 环境的指标、分析数据并提供交互式仪表板，例如 Microsoft Power BI 或 Tableau。

  • Microsoft SQL：可用于替换内置的Scheduler数据库，用于存储作业信息，配置和审核日志。

1.2. 部署方式

除了 Nuix Rampiva Engine Server 需要安装在将成为自动化部署一部分的每台 Nuix 服务器上之外，所有其余组件都可以部署在同一服务器或专用服务器上。

在与托管 Nuix Rampiva Scheduler 的服务器不同的服务器上部署可选的 Nuix Rampiva OData 服务器时，必须将利用率数据从嵌入式数据库重定向到 Microsoft SQL 数据库。

1.2.1. 样本分布式架构

此示例体系结构包含托管 Nuix Rampiva Scheduler 的专用服务器、托管 Nuix Rampiva 引擎服务器和 Nuix 引擎的多台服务器、用于 Nuix NMS 和 Nuix UMS 的专用服务器以及与 Azure AD 的连接。

样本分布式架构

1.2.2. 示例独立架构

此示例架构由托管 Nuix Rampiva Scheduler 和 Nuix Rampiva Engine 服务器、多个 Nuix 引擎以及 Nuix NMS 和 Nuix UMS 的单个服务器组成。

示例独立架构

1.3. 网络流量

自动部署中的组件通过HTTP进行通信。要配置TCP端口和TLS证书，请参阅Configuration节。

交通流
来源 目的地 协议（端口）

分析 Web 浏览器

Nuix Rampiva 调度程序

HTTPS (TCP/443)

分析 Web 浏览器

Azure AD

HTTPS (TCP/443)

Nuix Rampiva 调度器

Nuix Rampiva 引擎服务器

HTTPS (TCP/443)

Nuix Rampiva 引擎

Nuix Rampiva 调度程序

HTTPS (TCP/443)

Nuix Rampiva 调度程序

Nuix UMS

HTTPS (TCP/443)

Nuix Rampiva 调度程序

Azure AD

HTTPS (TCP/443)

Nuix 引擎

Nuix NMS

HTTPS (TCP/27443)

2. 先决条件

见 https://rampiva.atlassian.net/wiki/spaces/KB/pages/1354858497/Prerequisites

3. 配置

3.1. 服务设定

配置文件位于以下位置：

  • Nuix Rampiva 调度程序 C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • Nuix Rampiva 引擎服务器 C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Nuix Rampiva OData 服务器 C:\ProgramData\Nuix\Automate\ODataServer\config\config.yml

此外，可以使用环境变量设置某些调度程序服务配置选项（有关更多详细信息，请参阅第 节。）

3.1.1. 计划程序服务设置

这些文件遵循YAML语法，并包含以下参数：

  • role：SCHEDULER，表示Nuix Rampiva Scheduler组件将运行；

  • apiSecret：用于 Nuix Rampiva 组件之间身份验证的密钥。在所有 Nuix Rampiva Scheduler、Proxy 和 Server 实例上设置相同的随机值。

  • internalCredentials：表示将使用配置文件中定义的凭据进行身份验证。以下子项提供了配置：

    • displayName：（可选）此身份验证方法在登录页面中显示的名称。

    • restrictToLocalhost：（可选）限制本地身份验证对浏览器的可用性。如果未指定此属性，则默认为 false。

    • usersEligibleLegalHoldAdministrator：（可选）使内部用户有资格获得合法保留管理。如果未指定此属性，则默认为 false。

    • usersEligibleLegalHoldCustodian：（可选）使内部用户有资格成为合法持有保管人。如果未指定此属性，则默认为 false。

    • credentials：凭证列表。

可以使用以下任一 PBKDF2 格式提供凭据：

  • username

  • email

  • salt，base64 编码的字符串

  • iterations，哈希迭代次数

  • hash，使用 PBKDF2WithHmacSHA512 算法计算，密钥长度为 512 位。

或明文，使用：

  • username

  • email

  • password

具有2个用户的示例内部身份验证配置：

internalCredentials:
  displayName: UsernamePassword
  restrictToLocalhost: true
  credentials:
    - username: user1
      email: user1@example.com
      salt: NlbCqq8kL6sqdZQrjMmgSw==
      iterations: 1000000
      hash: ca4xiopDRshgyKvArOfKqBoDeVfbsOpayzVrh8n1WAWOhqvunITolqBBTiSAn1VxTBUz+15IfX4qxiTuHrthuA==

    - username: user2
      email: user2@example.com
      password: Password2@
内部身份验证方法需要将用户名和密码或哈希值存储在配置文件中。建议将此方法限制为 localhost。
将 restrictToLocalhost 属性设置为 true 以在以 localhost 身份访问 Automate 时仅允许使用内部凭据登录。

  • userSessionTimeout：不活动的持续时间（以秒为单位），用户会话在该持续时间之后到期。

  • 说明：Nuix Engine部署的位置。此文件夹应直接包含`bin，lib和user-data`子文件夹。

  • log4jConfigurationFile：log4j配置文件。

  • enableCentralizedLogging：true`或false`指示是否启用集中式日志记录功能。

默认情况下启用此功能，要禁用此功能，请将值设置为`false`

  • centralizedLoggingRetention：将保留日志的天数。

  • centralizedLoggingMaxSize：过渡前的最大数据库大小（以字节为单位）。

  • centralizedLoggingSizeCheckInterval：数据库执行大小检查之前的持续时间（以秒为单位）。

  • engineInitLogFolder：运行作业之前，引擎初始化期间要使用的日志文件夹。

  • archiveJobsPastDuration：持续时间（以秒为单位），此后自动完成已完成的作业。

  • archiveJobsPastCount：完成的最大作业数，之后自动存档最旧的作业。

  • server：表示要侦听的IP /端口和HTTPS连接的TLS证书。

默认情况下，该服务在 localhost 的 80 端口上侦听 HTTP，并在 HTTPS 上的 443 端口侦听所有 IP 地址。要限制服务器侦听特定 IP 地址，请将 0.0.0.0 更改为 config.yml 文件中所需的 IP 地址。
如果从 6.0 之前的版本升级调度程序，服务器将默认只接受 HTTP/1.1 连接。要启用 HTTP/2 连接，请将 config.yml 文件中的 type: https 更改为 type: h2。

  • webConfiguration：指示将哪些 Web 设置应用于用于 REST API 的 Web 服务器，包括 HSTS、XSS 保护、CORS 和 CSP。

  • cors：CORS 配置。

Nuix Rampiva REST API 旨在通过调度程序服务器上托管的网页以及第三方服务和网页进行访问。因此，默认 CORS 配置允许所有来源。此配置是安全的，因为对 REST API 的每个请求都需要使用承载令牌进行身份验证。如果需要进一步限制 CORS 允许的来源，可以通过编辑 config.yml 文件中的默认 CORS 设置来实施更严格的策略。

限制允许来源的示例 CORS 策略：

  cors:
    allowedOrigins: ["https://scheduler.example.com"]

  • logging：指示服务执行的日志记录的参数。这些日志还将包含Nuix Workstation通常记录的信息。在`nuixFlags`参数中指定工作日志的位置。

  • applicationStore：表示使用自定义数据库存储审核信息。

    • driverClass：net.sourceforge.jtds.jdbc.Driver

    • user：数据库用户名

    • password：数据库密码

    • url：JDBC连接字符串，例如`jdbc:jtds:sqlserver://HOST:1433/DATABASE`

    • properties：连接属性。

示例Microsoft SQL配置：

applicationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: rampiva-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/rampiva
  properties:
    charSet: UTF-8
如果 Microsoft SQL 存储配置中未提供用户名和密码，则将使用集成 Windows 身份验证执行连接。当以这种方式连接到 Microsoft SQL 时，Nuix Rampiva Scheduler 服务应配置为在有权访问 Microsoft SQL 数据库的帐户下运行。

  • utilizationStore：表示使用自定义数据库存储操作利用率数据。

  • loggingStore：表示使用自定义数据库存储日志。

loggingStore 是所有平台日志的循环缓冲区，预计会产生写入吞吐量。不建议将此日志存储重定向到 SQL 数据库。

将`loggingStore重定位到D:\Logs\Rampiva`的示例配置：

loggingStore:
  driverClass: org.sqlite.JDBC
  url: jdbc:sqlite:D:/Logs/Rampiva/logging.db
  properties:
    charSet: UTF-8
上面列出的各种存储都可以全部重定向到单个Microsoft SQL数据库，或根据需要重定向到单独的数据库。

  • 注释：覆盖在用户配置文件上未设置任何特定配置时适用的用户设置。

用于定义允许的参数值的样本设置，这些参数值在创建新的客户端或新的问题时默认填充：

defaultUserSettings:
  newMatter:
    allowedParameterValues:
      - "{custodian}": ["John Smith","Annie Rosella"]
      - "{sample_parameter_1}": []
    synchronizeJobs: true
  newClient:
    allowedParameterValues:
      - "{doc_id_prefix}": ["DOC","DOC-","DOCID"]
      - "{sample_parameter_2}": []

  • sortAllowedParametersValues：true`或false`指示是否应该对用户界面中定义的或脚本返回的允许参数值进行排序，或者是否应保持原始顺序。

  • jobMaximumExecutionParametersLength：执行参数在值被修剪之前可以具有的字符数。这只会影响调度器前端的性能。默认情况下，这被设置为`200`字符。

  • synchronizeJobsOnAllMatters：true`或false`表示在任何给定时间是否仅允许一项作业在事务上运行。

  • authTokenTtl：用户身份验证令牌过期后的持续时间（以秒为单位）。浏览器将在令牌生命周期的一半时请求刷新身份验证令牌。默认情况下，设置为 600 秒。

  • disableAuthTokenExpiration：true`或false表示用户认证令牌未过期。默认情况下，它设置为 `false。

  • expiredAuthTokenTombstone：跟踪过期身份验证令牌的持续时间（以秒为单位）。当尝试使用过期的身份验证令牌访问 努克斯·兰皮瓦 时，将返回友好的错误消息，并且当前实时用户会话无效。默认情况下，此设置为 900。

  • downgradeWebWorkerToken：true 或 false 表示浏览器应该降级 Web Worker 令牌以使其可以被浏览器中的脚本访问。默认情况下，它设置为 false。

使用默认设置`downgradeWebWorkerToken: false，当刷新浏览器窗口时，用户将被注销。将此选项设置为 `true 将在刷新浏览器窗口时保持用户会话，但会使浏览器中的脚本可以访问身份验证令牌，这不太安全。

  • libraryFileMaxSize：默认情况下可以上传到文件库的文件的最大大小（以字节为单位）10000000。

文件库旨在存储配置文件和配置文件。此限制不适用于上传到 Data Repositories 的文件。

  • expireIdleUploadAfter：空闲上传到 Data Repositories 过期后的持续时间（以毫秒为单位），默认情况下 3600000 对应于 1 小时。

  • uploadBufferMaxSize：默认情况下，在上传到数据存储库期间分配的最大缓冲区大小（以 KiB 为单位）8192。每个文件上传最多可以分配 3 次缓冲区大小，并且仅在文件上传期间使用。

将数据写入通过高延迟网络连接的文件共享时，增加 uploadBufferMaxSize 的大小可能会提高整体传输性能，但会增加内存使用量。

  • uploadHashAlgorithms：默认情况下，将文件上传到数据存储库时用于服务器端散列的算法`MD5。要在上传期间禁用散列，请使用值 `None。

在上传期间散列文件需要调度程序服务器上的大量 CPU 资源。要将此计算卸载到不同的服务器，请使用 调度程序代理 角色。

  • enableUtilizationEndpoint：默认启用 Scheduler 上的 OData 服务`true。要禁用，请使用值 `false。

  • utilizationErrorsSoftFail：默认情况下，屏蔽利用率数据数据库写入应用程序的错误`false`。

  • azureLocations：（可选）运行 VM 的位置列表。示例“azureLocations”设置：

azureLocations: westus,eastus

  • azureVmSizes：（可选）VM 大小列表。示例“azureVmSizes”设置：

azureVmSizes: Standard_M8ms,Standard_M16ms,Standard_M32ts

3.1.2. 调度服务环境变量

可以配置以下环境变量以设置或覆盖在调度程序服务配置文件中配置的设置：

  • 数据库重定向。使用以下设置将应用程序重定向到 SQL 数据库：

    • AUTOMATE_STORE_APPLICATION_ENABLED：设置为 true 启用

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS：驱动类，例如`org.postgresql.Driver`

    • AUTOMATE_STORE_APPLICATION_URL：JDBC连接字符串，例如`jdbc:postgresql://postgres.example.internal:5432/rampivaScheduler`

    • AUTOMATE_STORE_APPLICATION_USERNAME：数据库用户名

    • AUTOMATE_STORE_APPLICATION_PASSWORD：数据库密码

    • AUTOMATE_STORE_APPLICATION_CHARSET：数据库字符集，例如`UTF-8`

    • AUTOMATE_STORE_LOGGING_REDIRECT_TO_APPLICATION：设置为`true`将集中日志记录重定向到与应用程序商店相同的位置

    • AUTOMATE_CENTRALIZED_LOGGING_ENABLED：设置为`false`以禁用集中日志记录

    • AUTOMATE_STORE_UTILIZATION_REDIRECT_TO_APPLICATION：设置为 true 将使用数据重定向到与应用程序商店相同的位置

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS：保持打开的最小连接数

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS：保持打开的最大连接数

  • 验证。使用以下设置配置访问凭据以登录应用程序进行初始配置：

    • 内部用户名/密码验证：

      • AUTOMATE_AUTH_INTERNAL_ENABLED：设置为 true 启用

      • AUTOMATE_AUTH_INTERNAL_USERNAME: 登录的用户名

      • AUTOMATE_AUTH_INTERNAL_EMAIL：用户的电子邮件地址

      • AUTOMATE_AUTH_INTERNAL_PASSWORD：登录密码。

    • 内部 PBKDF2 身份验证：

      • AUTOMATE_AUTH_INTERNAL_ENABLED：设置为 true 启用

      • AUTOMATE_AUTH_INTERNAL_USERNAME: 登录的用户名

      • AUTOMATE_AUTH_INTERNAL_EMAIL：用户的电子邮件地址

      • AUTOMATE_AUTH_INTERNAL_SALT：base64 编码的字符串

      • AUTOMATE_AUTH_INTERNAL_ITERATIONS：哈希迭代次数

      • AUTOMATE_AUTH_INTERNAL_HASH：使用 PBKDF2WithHmacSHA512 算法计算的密码哈希，密钥长度为 512 位。

    • OIDC认证：

      • AUTOMATE_AUTH_OIDC_ENABLED：设置为 true 启用

      • AUTOMATE_AUTH_OIDC_NAME：认证机制名称

      • AUTOMATE_AUTH_OIDC_DESCRIPTION：认证机制说明

      • AUTOMATE_AUTH_OIDC_WELL_KNOWN_CONFIG_URI：众所周知的配置URI，例如`http://keycloak:8080/realms/default/.well-known/openid-configuration`

      • AUTOMATE_AUTH_OIDC_SCOPE：范围，例如`openid email profile`

      • AUTOMATE_AUTH_OIDC_USERNAME_CLAIM：用户名声明，例如`email`

      • AUTOMATE_AUTH_OIDC_CLIENT_ID：客户端ID

      • AUTOMATE_AUTH_OIDC_CLIENT_SECRET：客户端秘密

    • 德比控制服务：

      • AUTOMATE_DERBY_CONTROL_SERVICE_ENABLED：设置为 true 启用

      • AUTOMATE_DERBY_CONTROL_SERVICE_NAME：Derby Control 服务名称

      • AUTOMATE_DERBY_CONTROL_SERVICE_DESCRIPTION：德比控制服务说明

      • AUTOMATE_DERBY_CONTROL_SERVICE_URL：例如 Derby Control 基本 URL http://127.0.0.1:8999/DERBY-CONTROL

  • 多服务器 API 秘密。使用以下设置配置用于管理不同引擎服务器的 API 密码：

    • AUTOMATE_API_SECRET：用于 Nuix Rampiva 组件之间身份验证的密钥。在所有 Nuix Rampiva Scheduler、Proxy 和 Server 实例上设置相同的随机值。

  • 安全政策。使用以下设置来配置安全策略：

    • AUTOMATE_SECURITY_POLICY_ENABLED：设置为 true 启用

    • AUTOMATE_SECURITY_POLICY_NAME：保单名称

    • AUTOMATE_SECURITY_POLICY_DESCRIPTION：政策说明

    • AUTOMATE_SECURITY_POLICY_PRINCIPALS：策略适用的主体列表。以下设置将匹配任何经过身份验证的用户：[{"identifierType":"BUILTIN","identifierName":"AUTHENTICATED_USER"}]

    • AUTOMATE_SECURITY_POLICY_PERMISSIONS：策略权限，例如`["VIEW","VIEW_SENSITIVE","MODIFY","CREATE","SUBMIT_JOB","DOWNLOAD_LOGS"]`

    • AUTOMATE_SECURITY_POLICY_SCOPE_BUILTIN：策略内置范围，例如`["ALL_CLIENT_POOLS","ALL_CLIENTS","ALL_LIBRARIES","API_KEYS","COLLECTIONS","LEGAL_HOLDS","SCRIPTS","SCHEDULES","SECURITY","RESOURCES"]`

    • AUTOMATE_SECURITY_POLICY_SCOPE：（可选）定义完整的策略范围，例如 [{"identifierType":"BUILTIN","identifierName":"RESOURCES"}]

  • 安全政策。使用以下设置来配置 Rampiva 许可证：

    • AUTOMATE_LICENSE_ENABLED：设置为 true 启用

    • AUTOMATE_LICENSE_ID：许可证 ID

    • AUTOMATE_LICENSE_KEY：许可证密钥

    • AUTOMATE_LICENSE_DIAGNOSTIC_LEVEL：诊断级别，例如`ENHANCED`

  • Nuix CLS 许可证。使用以下设置来配置 Nuix CLS 许可证：

    • AUTOMATE_NUIX_CLS_LICENSE_ENABLED：设置为 true 启用

    • AUTOMATE_NUIX_CLS_LICENSE_NAME：许可证名称

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION：许可证说明

    • AUTOMATE_NUIX_CLS_LICENSE_FILTER：许可证工作者过滤器，例如`workstation`

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION：许可证说明

    • AUTOMATE_NUIX_CLS_LICENSE_USERNAME：CLS 用户名

    • AUTOMATE_NUIX_CLS_LICENSE_PASSWORD：CLS 密码

  • 资源池。使用以下设置来配置资源池：

    • AUTOMATE_RESOURCE_POOL_ENABLED：设置为 true 启用

    • AUTOMATE_RESOURCE_POOL_NAME：资源池名称

    • AUTOMATE_RESOURCE_POOL_DESCRIPTION：资源池说明

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ENABLED：设置为 true 以启用自动注册。

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ACCESS_KEY：自动注册访问密钥。引擎服务器需要使用相同的密钥。

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_STRICT_IP：可选，设置为 true 强制从与目标服务器相同的 IP 地址进行注册，默认情况下 false。

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_MIN_WORKERS：可选，默认自动注册最少工人`1`。

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_TARGET_WORKERS：可选，自动注册目标工人，默认`2`。

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_EXECUTION_MODE：可选，自动注册执行模式，默认`AUTOMATE_NUIX`。

  • 执行概况。使用以下设置来配置执行配置文件：

    • AUTOMATE_EXECUTION_PROFILE_ENABLED：设置为 true 启用

    • AUTOMATE_EXECUTION_PROFILE_NAME：执行配置文件名称

    • AUTOMATE_EXECUTION_PROFILE_DESCRIPTION：执行配置文件说明

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_COMMAND_LINE_PARAMS：可选，引擎命令行参数，默认`-Xmx16g -Dnuix.logdir=/var/log/nuix/automate -Duser.language=en -Duser.country=US`。

    • AUTOMATE_EXECUTION_PROFILE_NUIX_ENGINE_FOLDER：可选，Nuix 引擎二进制文件文件夹，默认情况下`/opt/nuix/engine`。

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_LOG_FOLDER：可选，引擎日志文件夹，默认情况下`/var/log/nuix/automate`。

    • AUTOMATE_EXECUTION_PROFILE_JAVA_FOLDER：可选，Java 二进制文件文件夹，默认为空。

    • AUTOMATE_EXECUTION_PROFILE_PARAMETERS：可选，参数和值的 JSON 序列化 Map<String,String>，默认为空。

    • AUTOMATE_EXECUTION_JOB_PROGRESS_MIN_PERCENTAGE：可选，中止作业之前的最小作业进度，默认情况下`1.0`。

    • AUTOMATE_EXECUTION_JOB_PROGRESS_TIMEOUT_HOURS：可选，默认情况下，如果未实现作业进度则中止作业的超时时间`48.0`。

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_MIN_PERCENTAGE：可选，中止作业之前的最小操作进度，默认`1.0`。

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_TIMEOUT_HOURS：可选，默认情况下，如果操作进度未达到则中止作业的超时时间`24.0`。

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_MIN_PERCENTAGE：可选，尝试跳过操作之前的最小操作进度，默认情况下`1.0`。

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_TIMEOUT_HOURS：可选，默认情况下未达到尝试跳过操作进度的操作的超时`12.0`。

  • 要覆盖任意设置，请将设置名称转换为大写蛇形字母，前面带有 Rampiva。例如，要配置 downgradeWebWorkerToken 设置，请使用 AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN 环境变量。

3.1.3. 计划程序代理服务设置

此文件遵循 YAML 语法并包含以下参数：

  • role：PROXY，表示Nuix Rampiva Scheduler Proxy组件将运行；

  • apiSecret：用于 Nuix Rampiva 组件之间身份验证的密钥。在所有 Nuix Rampiva Scheduler、Proxy 和 Server 实例上设置相同的随机值。

  • 说明：代理使用的主Scheduler实例的详细信息。以下子项提供了配置：

    • baseUrl：Scheduler实例的URL。

    • whitelistedCertFingerprints：计划程序证书指纹用于在打开安全连接时进行验证。

  • allowedAuthenticationServices：可通过此代理使用的身份验证服务名称列表。如果未定义此设置，则将允许所有身份验证服务通过代理。

代理配置示例：

proxy:
  baseUrl: https://scheduler.rampiva.local
  whitelistedCertFingerprints:
    - e62dd01ca608c10402d07714cfd626bfc6b1001e5a16ca039d1050a71f73ee24

allowedAuthenticationServices:
  - Internal
  - Lab Azure AD

  • log4jConfigurationFile：log4j配置文件。

  • server：Web访问日志设置、监听的HTTP协议以及HTTPS连接对应的IP、端口和TLS证书。

  • webConfiguration：指示要应用于REST API的Web服务器要应用的Web设置。

3.1.4. 引擎服务器服务设置

此文件遵循 YAML 语法并包含以下参数：

  • role：ENGINE_SERVER，表示Nuix Rampiva Engine Server组件将运行；

  • apiSecret：用于 Nuix Rampiva 组件之间身份验证的密钥。在所有 Nuix Rampiva Scheduler、Proxy 和 Server 实例上设置相同的随机值。

  • 说明：Nuix Engine部署的位置。此文件夹应直接包含`bin，lib和user-data`子文件夹。

  • log4jConfigurationFile：log4j配置文件。

  • engineInitLogFolder：引擎在初始化阶段用于存储配置文件和日志的临时位置。运行Jobs时，引擎会将日志和配置文件存储在执行配置文件中指定的位置。

  • engineInitTimeout：默认情况下允许引擎初始化的超时时间（以秒为单位）120。

  • engineAbortTimeout：引擎等待中止作业的超时时间（以毫秒为单位），默认值 5000（5 秒）

  • server：Web访问日志设置、监听的HTTP协议以及HTTPS连接对应的IP、端口和TLS证书。

  • webConfiguration：指示要应用于REST API的Web服务器要应用的Web设置。

  • jobRunningLogMaxSize：表示作业运行日志存储的最大日志数，默认`20`。

  • logging：指示服务执行的日志记录的参数。这些日志还将包含Nuix Workstation通常记录的信息。在`nuixFlags`参数中指定工作日志的位置。

  • workerBrokerIP：运行远程工作器时用于承载工作代理的IP地址。

  • 说明：工人代理的端口范围开始。

  • 说明：工人经纪人的港口范围结束。

在IP`10.0.0.1`上配置Worker Broker的示例设置：

workerBrokerIP: 10.0.0.1
workerBrokerStartPort: 50000
workerBrokerEndPort: 50100
如果未提供`workerBrokerIP`设置，则服务器将在默认网络适配器上启动代理。在服务器具有多个网络适配器的环境中，请在每台服务器上配置configure，以便其他服务器通过远程作业与该服务器联系来使用该IP地址。

3.1.5. 引擎服务器服务环境变量

可以配置以下环境变量来设置或覆盖引擎服务器服务配置文件中配置的设置：

  • 数据库重定向。使用以下设置将应用程序重定向到 SQL 数据库：

    • AUTOMATE_STORE_APPLICATION_ENABLED：设置为 true 启用

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS：驱动类，例如`org.postgresql.Driver`

    • AUTOMATE_STORE_APPLICATION_URL：JDBC连接字符串，例如`jdbc:postgresql://postgres.example.internal:5432/rampivaEngineServer`

    • AUTOMATE_STORE_APPLICATION_USERNAME：数据库用户名

    • AUTOMATE_STORE_APPLICATION_PASSWORD：数据库密码

    • AUTOMATE_STORE_APPLICATION_CHARSET：数据库字符集，例如`UTF-8`

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS：保持打开的最小连接数

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS：保持打开的最大连接数

  • 自动注册。使用以下设置自动将引擎服务器注册到调度程序资源池。资源池必须配置为启用自动注册功能：

    • AUTOMATE_REGISTRATION_ENABLED：设置为 true 启用

    • AUTOMATE_REGISTRATION_SERVER_NAME：引擎服务器的名称，例如`Server1`

    • AUTOMATE_REGISTRATION_SERVER_URL：调度程序可以访问引擎服务器的 URL，例如 http://Server1.internal.local

    • AUTOMATE_REGISTRATION_SCHEDULER_URL：调度程序 URL，例如 http://Scheduler.internal.local

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ID：可选，要注册的资源池 ID。默认情况下，调度程序中使用 ENV 变量配置的资源池的 ID。只需提供此设置即可注册到不同的资源池。

    • AUTOMATE_REGISTRATION_ROLE_MAIN：可选，设置为`true`使引擎充当资源池中的主引擎。

    • AUTOMATE_REGISTRATION_ROLE_REMOTE：可选，设置为`true`启用引擎作为资源池中的远程引擎。

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ACCESS_KEY：资源池访问密钥。 Se 与使用 ENV 变量在资源池上配置的值相同。

  • 多服务器部署。对多服务器部署方案使用以下设置：

    • 蓝碧瓦_API_SECRET：用于 Nuix Rampiva 组件之间身份验证的密钥。在所有 Nuix Rampiva Scheduler、Proxy 和 Server 实例上设置相同的随机值。

    • 蓝碧瓦_SERVER_ID：为每个引擎服务器设置一个唯一的随机 ID。

3.1.6. OData 服务器服务设置

此文件遵循 YAML 语法并包含以下参数：

  • role：ODATA_SERVER，表示Nuix Rampiva OData Server组件将运行；

  • internalCredentials：表示将使用配置文件中定义的凭据进行身份验证。以下子项提供了配置：

    • displayName：（可选）此身份验证方法在登录页面中显示的名称。

    • restrictToLocalhost：（可选）限制本地身份验证对浏览器的可用性。如果未指定此属性，则默认为 false。

    • credentials：凭证列表。

可以使用以下任一 PBKDF2 格式提供凭据：

  • username

  • email

  • salt，base64 编码的字符串

  • iterations，哈希迭代次数

  • hash，使用 PBKDF2WithHmacSHA512 算法计算，密钥长度为 512 位。

或明文，使用：

  • username

  • email

  • password

具有2个用户的示例内部身份验证配置：

internalCredentials:
  displayName: UsernamePassword
  restrictToLocalhost: true
  credentials:
    - username: user1
      email: user1@example.com
      salt: NlbCqq8kL6sqdZQrjMmgSw==
      iterations: 1000000
      hash: ca4xiopDRshgyKvArOfKqBoDeVfbsOpayzVrh8n1WAWOhqvunITolqBBTiSAn1VxTBUz+15IfX4qxiTuHrthuA==

    - username: user2
      email: user2@example.com
      password: Password2@
内部身份验证方法需要将用户名和密码或哈希值存储在配置文件中。建议将此方法限制为 localhost。
将 restrictToLocalhost 属性设置为 true 以在以 localhost 身份访问 Automate 时仅允许使用内部凭据登录。

  • server：Web访问日志设置、监听的HTTP协议以及HTTPS连接对应的IP、端口和TLS证书。

默认情况下，该服务在 localhost 的 8081 端口上侦听 HTTP，并在 8443 端口上的 HTTPS 上侦听所有 IP 地址。要限制服务器侦听特定 IP 地址，请将 0.0.0.0 更改为 config.yml 文件中所需的 IP 地址。

  • webConfiguration：指示要应用于REST API的Web服务器要应用的Web设置。

  • utilizationStore：表示使用自定义数据库存储审核信息。

    • driverClass：net.sourceforge.jtds.jdbc.Driver

    • user：数据库用户名

    • password：数据库密码

    • url：JDBC连接字符串，例如`jdbc:jtds:sqlserver://HOST:1433/DATABASE`

    • properties：连接属性。

示例Microsoft SQL配置：

utilizationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: rampiva-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/rampiva
  properties:
    charSet: UTF-8
如果 Microsoft SQL 存储配置中未提供用户名和密码，则将使用集成 Windows 身份验证执行连接。当以这种方式连接到 Microsoft SQL 时，Nuix Rampiva Scheduler 服务应配置为在有权访问 Microsoft SQL 数据库的帐户下运行。

3.2. 认证方式

3.2.1. Nuix UMS

如果使用 Nuix UMS 身份验证方法，请在“自动化”网页的“设置”选项卡中的“身份验证服务”下配置 UMS 身份验证服务。 Nuix UMS 中定义的所有用户都可以登录到 Automate。每个用户的访问级别由在“自动化”网页的“设置”选项卡中定义的安全策略确定。

3.2.2. LDAP

如果使用 LDAP 身份验证方法，请在“自动化”网页的“设置”选项卡中的“身份验证服务”下配置 LDAP 身份验证服务。在提供的 LDAP domainDN 中定义的所有用户都可以登录到 Automate。每个用户的访问级别由在“自动化”网页的“设置”选项卡中定义的安全策略确定。

3.2.3. 内部

如果使用内部验证方法，请在 YAML 文件中设置 internalCredentials 配置，如 Service Settings 所示。

3.3. 访问安全策略

Auto页的*安全政策*选项卡中定义了对自动资源的访问。默认策略允许任何经过身份验证的用户查看和修改所有资源，以及使用任何设置提交作业。

3.4. 记忆

3.4.1. Nuix工人

Nuix Workers的内存可以在工作流*配置*操作中指定，也可以在执行配置文件中明确指定为命令行参数，例如：

-Dnuix.worker.jvm.arguments="-Xmx8g"

3.4.2. Nuix引擎

Nuix引擎的内存，相当于执行配置文件中作为命令行参数的Nuix工作站的内存，例如：

-Xmx2g
每个 Nuix 引擎将在单独的 JVM 下运行，并且不会与其他 Nuix 引擎或 Nuix Rampiva 服务共享内存。

3.5. 共享数据源

Nuix Rampiva 工作流程在运行 Nuix Rampiva Engine Server 组件的服务器上执行。为了确保工作流程可以从共享位置访问案例和源数据，请提供可从运行 Nuix Rampiva Engine 服务器组件的所有服务器访问的 UNC 路径或映射驱动器号路径。

默认情况下，Rampiva Engine服务器服务在本地系统帐户下运行，并在同一用户帐户下启动Engine。

根据需要，可以在执行配置文件中指定其他用户帐户。

3.6. 相对论应用

可以使用 Nuix Rampiva Relativity 应用程序在 Relativity 中访问 Nuix Rampiva。

安装后，应用程序的 相对论代理 需要配置 相对论用户模拟服务 才能连接到 Automate。代理需要以下参数：

  • API URI：Automate的URI；

  • Service ID：Automate 中定义的 Relativity User Impersonation Service 的 ID；

  • Service Secret：Automate 中定义的 Relativity 用户模拟服务的秘密。

配置完成后，如果 Automate 中定义的 安全政策 允许，所有登录的 Relativity 用户将能够访问 Automate。

该应用程序会自动添加管理员级别的选项卡以访问该应用程序。所有选项卡都以 兰皮瓦 开头。

注意：对于边栏访问，编辑选项卡 兰皮瓦自动化，并启用选项卡选项 在边栏中显示。

注意：应用程序不管理创建后的选项卡；卸载或删除应用程序后，需要手动删除它们。

4. 故障排除

4.1. 浏览 Nuix Rampiva 调度程序

默认情况下，Nuix Rampiva Scheduler 侦听端口 80 上的 127.0.0.1 以及端口 443 上的所有 IP 地址。要访问默认安装，请浏览到地址：http://localhost

4.2. Nuix Rampiva 服务未启动

Nuix Rampiva Scheduler 和 Engine Server 作为 Windows 服务运行。如果服务已启动，请检查`C:\Temp\Log\automate-scheduler.log和C:\Temp\Log\automate-engine-server.log`处的日志文件。

4.3. 登录错误

如果尝试登录时显示错误 与身份验证服务器通信时出错，请检查日志以确定 Automate 在与身份验证服务器通信时遇到的问题。

4.4. 添加 Nuix Rampiva Engine Server 会抛出 javax.net.ssl.SSLHandshakeException 错误

确保部署在每个 Nuix Rampiva Scheduler 服务器上的最新版本 Nuix Workstation 的 Java 运行时环境信任 Nuix Rampiva Engine 服务器的 TLS 证书。请参阅第 Managing Certificates 节了解更多详细信息。

5. 管理证书

请参阅 https://rampiva.atlassian.net/wiki/spaces/KB/pages/1536557057/Managing+Certificates。

6. 利用与报告

如果在 Nuix Rampiva 许可证中启用了此功能，则利用率和报告数据将作为 OData V4 源提供。

OData feed仅支持查询元数据和从视图中检索所有数据。不支持OData过滤器。

可以使用Basic或Microsoft OAuth身份验证在以下端点下访问OData feed：

  • /api/v2/reporting/odata

7. REST API文档

Nuix Rampiva Scheduler 可以直接通过浏览器访问，也可以使用 REST API 访问。 API 文档以 OpenAPI v3 格式提供，位于 /openapi 下。

例如，要访问 Nuix Rampiva Scheduler 标准安装中的 API 文档，请浏览到 http://localhost/openapi

8. 集中记录

集中式日志记录将来自Scheduler，Engine Server，Engine和Worker日志的所有日志合并到Scheduler管理的日志数据库中。

默认情况下，启用集中日志记录，这意味着日志文件和数据库日志都将存在。要禁用集中式日志记录，请按`YAML文件中的指示在配置YAML文件中将enableCentralizedLogging键设置为false`。

如果禁用了集中式日志记录，则将禁用下载作业日志和下载系统日志功能。

集中日志记录将自动删除早于保留期限的日志。默认保留期为*30天*。要更改保留期限，请编辑`YAML文件中的centralizedLoggingRetention`键。

当数据库日志大小超过最大数据库大小时，较旧的日志将被删除。默认情况下，最大数据库大小为1字节（1 GB）。要更改默认的最大数据库大小，请编辑`YAML文件中的centralizedLoggingMaxSize`键。

由于数据库开销和删除旧日志行的延迟，实际的集中式日志记录数据库大小可能会超过指定的最大大小。

9. 文件路径清单

9.1. 默认文件路径

9.1.1. 排程器

  • C:\Program Files\Rampiva\Automate：安装文件夹

  • %programdata%\Rampiva\Automate\Scheduler\config：配置文件夹

  • %programdata%\Rampiva\Automate\Scheduler\stores：工作细节，利用率，审计，报告和利用率的持久性和归档

  • C:\Temp\logs\automate-scheduler.log：应用日志

  • C:\Temp\logs\automate-scheduler.%d.log.zip：以前的应用程序日志文件

  • C:\Temp\logs\rampiva-scheduler-access.log：Web访问日志

  • C:\Temp\logs\rampiva-scheduler-access.%d.log.zip：先前的主日志文件

  • C:\Temp\logs\Rampiva Scheduler.wrapper.log：服务包装器日志

  • C:\Temp\logs\Rampiva Scheduler.err.log：服务标准错误日志

  • C:\Temp\logs\Rampiva Scheduler.out.log：服务标准输出日志

9.1.2. 引擎服务器

  • C:\Program Files\Rampiva\Automate：安装文件夹

  • %programdata%\Rampiva\Automate\EngineServer\config：配置文件夹

  • C:\Temp\logs\automate-engine-server.log：应用日志

  • C:\Temp\logs\automate-engine-server.%d.log.zip：以前的应用程序日志文件

  • C:\Temp\logs\automate-engine-server-access.log：Web访问日志

  • C:\Temp\logs\automate-engine-server-access.%d.log.zip：先前的主日志文件

  • C:\Temp\logs\Rampiva Engine Server.wrapper.log：服务包装器日志

  • C:\Temp\logs\Rampiva Engine Server.err.log：服务标准错误日志

  • C:\Temp\logs\Rampiva Engine Server.out.log：服务标准输出日志

9.1.3. 发动机

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.log：初始化日志

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.yml：初始化配置

  • C:\Temp\logs\automate-engine.aaaaaaaa-service.exe：服务包装

  • C:\Temp\logs\automate-engine.aaaaaaaa-service.xml：服务配置

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.log：作业日志

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.yml：作业配置

9.2. 更改日志位置

可以从以下位置更改默认文件路径：

  • 计划程序主日志：从`C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml更新logging`部分

  • 与计划程序服务相关的日志：从Update更新标签`<workingdirectory>和<logpath>`

  • 引擎服务器主日志：更新`C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml`中的section部分

  • 与Engine Server服务相关的日志：从Update更新标签`<workingdirectory>和<logpath>`

  • 引擎初始化日志，配置和与服务相关的日志：从`C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml更新engineInitLogFolder`部分

  • 作业日志和配置：更新字段`Log Folder并在执行配置文件中设置命令行参数-Dnuix.logdir=c:\Temp\Logs`