- 发行说明
- 入门指南
- 安装和升级
- 访问和权限
- 与 Insights 交互
- 故障排除
安装
- 确保您满足 Insights 的硬件和软件要求。
- 启用 IIS 10+。
要启用 IIS 10+,请前往“控制面板”>“程序”>“打开或关闭 Windows 功能”>“IIS”。
启用以下网页服务器 (IIS) 模块:- 网页服务器
- 常见的 HTTP 功能
- 默认文档
- 目录浏览
- HTTP 错误
- 默认文档
- 静态内容
- 运行状况和诊断
- HTTP 日志记录
- 性能
- 静态内容
- 安全性
- 请求筛选
- 常见的 HTTP 功能
- 管理工具
- IIS 管理控制台
- 网页服务器
- 下载并安装 .NET Hosting Bundle 版本 3.1.17 及以上。
- 下载 .NET Hosting Bundle。
- 在命令提示符中,运行
net stop was /y
,然后运行net start w3svc
。
- 安装 Orchestrator 并启用 Insights 功能。 您需要从 Orchestrator 获取安装访问令牌。
重要提示:• 在配置 Insights SQL Server 期间添加数据库所有者角色时,请确保选择
db_owner
角色。• Orchestrator 和 Insights 的版本需要匹配。例如,如果您已将 Orchestrator 升级到 2021.10.1,则需要运行相同版本的 Insights,以在这两个 UiPath 产品之间建立适当的通信。
- 使用 SSL 证书在服务器上启用 HTTPS。该过程类似于为 Orchestrator 提供的过程。请参阅使用 HTTPS 协议证书。
- 获取 DNS 的自签名证书,并将其导入
certlm.msc
。
- 运行以下命令:
$cert = New-SelfSignedCertificate -certstorelocation cert:\localmachine\my -dnsname <your-dns-name> -KeySpec KeyExchange $pwd = ConvertTo-SecureString -String '<your-password>' -Force -AsPlainText $path = 'cert:\localMachine\my\' + $cert.thumbprint Export-PfxCertificate -cert $path -FilePath <path-to-save>\cert.pfx -Password $pwd
$cert = New-SelfSignedCertificate -certstorelocation cert:\localmachine\my -dnsname <your-dns-name> -KeySpec KeyExchange $pwd = ConvertTo-SecureString -String '<your-password>' -Force -AsPlainText $path = 'cert:\localMachine\my\' + $cert.thumbprint Export-PfxCertificate -cert $path -FilePath <path-to-save>\cert.pfx -Password $pwd注意:请务必替换以下内容:<your-dns-name>
,其中包含您服务器或虚拟机的 DNS 名称<your-password>
,其中包含要用于加密证书的密码<path-to-save>
,其中包含要保存导出的.pfx
格式证书的位置
- 使用证书管理器在“个人”和“受信任”中手动安装证书。
重要事项:最好使用提交给证书颁发机构的 SAN SSL 证书,而不是使用自签名证书。
- 自签名证书(以及您自己的证书颁发机构中的证书)必须同时安装在 Insights 计算机上“受信任的根”和“个人”证书存储区中。证书还必须标记为“可导出”。
- 提交给证书颁发机构的证书只需安装在“受信任的根”中。
请注意,使用自签名证书时,如果通过 Firefox 或 Edge 访问 Insights,您可能会遇到问题。Insights 2021.4 或更高版本不再支持 Internet Explorer。
- 获取 DNS 的自签名证书,并将其导入
- 为 Insights 指定主机名时,请确保所需主机名在 DNS 中可解析。
- 确认将要安装 Insights 的服务器可以与已安装 Orchestrator 的服务器建立通信,反之亦然。
- 如果您使用的是本地或云托管虚拟机,则它必须支持 Windows 操作系统的嵌套虚拟化。
- 确保使用 TLS 1.1 或 1.2。
- 确保以下端口处于打开状态且可访问:
543
(默认)、9999
和19999
。为每个端口创建一个入站端口规则以将其打开:543
、9999
、19999
。
- 端口
543
:
- 端口
9999
:
- 端口
19999
:
- 端口
- 根据您的环境安装 Docker。
安装适用于 Windows Server 2019 的 Docker:
- 使用 PowerShell 创建以下变量:
$TMP_WORKDIR="c:\docker"
$TMP_WORKDIR="c:\docker" - 使用 PowerShell 创建以下目录:
New-Item $TMP_WORKDIR -ItemType Directory -force
New-Item $TMP_WORKDIR -ItemType Directory -force - 启用以下 Windows 功能:“Hyper-V”和“容器”。为此,请执行以下步骤:
- 前往“控制面板”,然后前往“程序”。
- 单击“打开或关闭 Windows 功能”。
- 选中“服务器角色”选项卡中的“Hyper-V”和“功能”选项卡中的“容器”旁边的复选框。
- 如果需要,重新启动服务器。
- 您可以通过运行以下命令,使用 PowerShell 下载 Docker 并将 Linux 容器解压缩到 $TMP_WORKDIR 文件夹中:
Invoke-WebRequest -URI "https://download.docker.com/win/static/stable/x86_64/docker-20.10.24.zip" -OutFile "$TMP_WORKDIR\docker-20.10.24.zip"
Invoke-WebRequest -URI "https://download.docker.com/win/static/stable/x86_64/docker-20.10.24.zip" -OutFile "$TMP_WORKDIR\docker-20.10.24.zip" - 您可以通过运行以下命令,使用 PowerShell 下载 lcow 内核并将 Linux 容器解压缩到 $TMP_WORKDIR 文件夹中:
Invoke-WebRequest -Uri "https://github.com/linuxkit/lcow/releases/download/v4.14.35-v0.3.9/release.zip" -UseBasicParsing -OutFile "$TMP_WORKDIR\release.zip"
Invoke-WebRequest -Uri "https://github.com/linuxkit/lcow/releases/download/v4.14.35-v0.3.9/release.zip" -UseBasicParsing -OutFile "$TMP_WORKDIR\release.zip" - 接下来,安装 Docker 和 lcow:
Expand-Archive $TMP_WORKDIR\Docker-20.10.24.zip -DestinationPath $Env:ProgramFiles -Force Expand-Archive $TMP_WORKDIR\release.zip -DestinationPath "$Env:ProgramFiles\Linux Containers\." -Force
Expand-Archive $TMP_WORKDIR\Docker-20.10.24.zip -DestinationPath $Env:ProgramFiles -Force Expand-Archive $TMP_WORKDIR\release.zip -DestinationPath "$Env:ProgramFiles\Linux Containers\." -Force - 接下来,使用 PowerShell,通过运行以下命令来设置环境变量:
[Environment]::SetEnvironmentVariable("PATH", $Env:PATH + ";$Env:ProgramFiles\docker", [EnvironmentVariableTarget]::Machine) [Environment]::SetEnvironmentVariable("LCOW_SUPPORTED", "1", "Machine") [Environment]::SetEnvironmentVariable("LCOW_API_PLATFORM_IF_OMITTED", "linux", "Machine")
[Environment]::SetEnvironmentVariable("PATH", $Env:PATH + ";$Env:ProgramFiles\docker", [EnvironmentVariableTarget]::Machine) [Environment]::SetEnvironmentVariable("LCOW_SUPPORTED", "1", "Machine") [Environment]::SetEnvironmentVariable("LCOW_API_PLATFORM_IF_OMITTED", "linux", "Machine") - 使用 PowerShell,通过运行以下命令启用
daemon.json
中的“实验性功能”:$configfile = @" { "experimental": true } "@ $configfile|Out-File -FilePath C:\ProgramData\docker\config\daemon.json -Encoding ascii -Force
$configfile = @" { "experimental": true } "@ $configfile|Out-File -FilePath C:\ProgramData\docker\config\daemon.json -Encoding ascii -Force - 通过在 PowerShell 中运行以下命令来注册服务:
cd $Env:ProgramFiles\docker .\dockerd.exe --register-service
cd $Env:ProgramFiles\docker .\dockerd.exe --register-service - 最后,通过在 PowerShell 中运行以下命令来重新启动计算机:
Restart-Computer -Force
Restart-Computer -Force
在离线虚拟机上安装 Docker:
要在离线环境中安装 Docker,您需要执行两个步骤。首先,将安装文件下载到在线虚拟机,然后将文件复制到要安装的离线虚拟机。
要求- 确保离线虚拟机满足 Insights 服务器的要求。
- 在线虚拟机需要运行 Windows Server 2019 及以上版本并可以访问互联网。
在在线虚拟机上下载 Docker 安装文件
在在线虚拟机中,以管理员身份打开 PowerShell 并运行以下命令以创建新的 Docker 文件夹。
# variables $TMP_WORKDIR="c:\docker" # Create tmp_workdir New-Item $TMP_WORKDIR -ItemType Directory -force # Install Hyper-V and Containers Install-WindowsFeature Hyper-V Install-WindowsFeature containers
# variables $TMP_WORKDIR="c:\docker" # Create tmp_workdir New-Item $TMP_WORKDIR -ItemType Directory -force # Install Hyper-V and Containers Install-WindowsFeature Hyper-V Install-WindowsFeature containers下载 lcow 内核并将 Linux 容器解压缩到 $TMP_WORKDIR 文件夹。
# Get docker Invoke-WebRequest -URI "https://download.docker.com/win/static/stable/x86_64/docker-20.10.24.zip" -OutFile "$TMP_WORKDIR\docker-20.10.24.zip" # Get lcow Invoke-WebRequest -Uri "https://github.com/linuxkit/lcow/releases/download/v4.14.35-v0.3.9/release.zip" -UseBasicParsing -OutFile "$TMP_WORKDIR\release.zip"
# Get docker Invoke-WebRequest -URI "https://download.docker.com/win/static/stable/x86_64/docker-20.10.24.zip" -OutFile "$TMP_WORKDIR\docker-20.10.24.zip" # Get lcow Invoke-WebRequest -Uri "https://github.com/linuxkit/lcow/releases/download/v4.14.35-v0.3.9/release.zip" -UseBasicParsing -OutFile "$TMP_WORKDIR\release.zip"在离线虚拟机上安装 Docker
在离线虚拟机中,以管理员身份打开 PowerShell 并运行以下命令,以安装 Docker、注册服务并重新启动计算机。
# Install Expand-Archive $TMP_WORKDIR\Docker-20.10.24.zip -DestinationPath $Env:ProgramFiles -Force Expand-Archive $TMP_WORKDIR\release.zip -DestinationPath "$Env:ProgramFiles\Linux Containers\." -Force # Add Environment Variables [Environment]::SetEnvironmentVariable("PATH", $Env:PATH + ";$Env:ProgramFiles\docker", [EnvironmentVariableTarget]::Machine) [Environment]::SetEnvironmentVariable("LCOW_SUPPORTED", "1", "Machine") [Environment]::SetEnvironmentVariable("LCOW_API_PLATFORM_IF_OMITTED", "linux", "Machine") # Enable Experimental Features in Docker daemon.conf $configfile = @" { "experimental": true } "@ $configfile|Out-File -FilePath C:\ProgramData\docker\config\daemon.json -Encoding ascii -Force # Register service cd $Env:ProgramFiles\docker .\dockerd.exe --register-service # Restart Computer Restart-Computer -Force
# Install Expand-Archive $TMP_WORKDIR\Docker-20.10.24.zip -DestinationPath $Env:ProgramFiles -Force Expand-Archive $TMP_WORKDIR\release.zip -DestinationPath "$Env:ProgramFiles\Linux Containers\." -Force # Add Environment Variables [Environment]::SetEnvironmentVariable("PATH", $Env:PATH + ";$Env:ProgramFiles\docker", [EnvironmentVariableTarget]::Machine) [Environment]::SetEnvironmentVariable("LCOW_SUPPORTED", "1", "Machine") [Environment]::SetEnvironmentVariable("LCOW_API_PLATFORM_IF_OMITTED", "linux", "Machine") # Enable Experimental Features in Docker daemon.conf $configfile = @" { "experimental": true } "@ $configfile|Out-File -FilePath C:\ProgramData\docker\config\daemon.json -Encoding ascii -Force # Register service cd $Env:ProgramFiles\docker .\dockerd.exe --register-service # Restart Computer Restart-Computer -Force - 使用 PowerShell 创建以下变量:
- 如果您使用 VMWare,请确保使用 VMwareToolboxCmd 11.0.6 及以上版本。较早的版本可能会导致 Docker 容器意外重新启动。
在安装 Insights 之前,您需要配置要使用的 Insights SQL Server 实例。
Latin1_General_CI_AS
。
先决条件
作为初始配置步骤,请确保您拥有以下内容或已完成以下操作:
- SQL Server 计算机的名称。
- 实例的名称(如果它不是默认实例)。
- SQL Server 端口已在 SQL Server 计算机的防火墙中打开。
- SQL Server 配置管理器中的 TCP 协议已启用。
- SQL Server 服务设置为侦听固定端口,而不是动态分配的端口。
建议
要配置数据库的默认 MAXDOP,请参阅配置最大并行度服务器配置选项。
SQL Server 身份验证方法
配置以下其中一种身份验证方法,Insights 可通过该方法连接到 SQL Server 数据库:
Windows 集成身份验证
对于此选项,SQL Server 需要作为服务帐户进行新的登录。服务帐户应是密码永不过期的域用户。Looker 是 Insights 使用的分析平台,在 Linux 容器中运行。要启用 Windows 身份验证,SQL Server 需要通过 Kerberos 协议支持身份验证。
配置 Windows 集成身份验证时的注意事项
- 在配置 Kerberos 身份验证之前,请确保 Insights Server 可以访问您的 Active Directory (AD) 和 SQL Server。您可以与 IT 管理员一起审核。
- 需要将 SQL Server 添加到您的 AD 域。
- Insights Server 需要与 AD 域和 SQL Server 位于同一网络上。
- 应配置 DNS,以便 Insights Server 可以解析 AD 域和 SQL Server 的域名。
- AD 用户应具有“权限”部分中定义的 SQL Server 访问权限和数据库权限。必须在 Insights 安装过程中提供该用户的域、用户名和密码。请记住,用户名区分大小写,这也可用作用户的
sAMAccountName
。以管理员身份打开 cmd 并运行set user
以获取USERDNSDOMAIN
和USERNAME
。 - SQL Server 需要在 AD 中具有 SPN 条目。有关详细信息,请参阅为 Kerberos 连接注册服务主体名称。
重要事项:Insights 服务器需要同时解析 AD 域和 SQL Server 的域名,这一点至关重要。您可以通过在主机上运行
nslookup <your_AD_domain_name>
和nslookup <your_SQL_server_domain_name>
来验证这一点。
在 SQL Server Management Studio 中创建新登录名
- 在“对象资源管理器”面板中,导航到“安全”>“登录”。
- 右键单击“登录名”文件夹,然后选择“新建登录名”。
- 选择“Windows 身份验证”选项。窗口会相应地更新。
- 在“登录名”字段中,键入要用作服务帐户的用户域。
- 从“默认语言”列表中选择“English”。
重要事项:确保将“默认语言”设置为“English”。否则,网站将无法启动,并且安装了 Insights 的计算机上的事件查看器将显示以下错误消息:
The conversion of a varchar data type to a datetime data type resulted in an out-of range value
。 - 单击“确定”以保存配置。
如果服务帐户已创建并添加到 SQL Server 的“安全”>“登录”部分,请检查其默认语言是否设置为“英语”。如果不是,请进行必要的调整。
SQL Server 身份验证
对于此身份验证方法,您需要 SQL Server 用户。
在 SQL Server Management Studio 中创建新 SQL 用户
- 在“对象资源管理器”面板中,导航到“安全”>“登录”。
- 右键单击“登录名”文件夹,然后选择“新建登录名”。系统将显示“登录名 - 新建”窗口。
- 选择“SQL Server 身份验证”选项。窗口会相应地更新。
- 适当填写“登录名”、“密码”和“确认密码”字段。
- e. 确保未选择“强制密码过期”和“用户必须在下次登录时更改密码”选项。
重要提示:确保将“默认语言”设置为“英语”。否则,网站将无法启动,并且安装了 Insights 的计算机上的事件查看器将显示以下错误消息:“将 VARCHAR 数据类型转换为日期时间数据类型导致值超出范围”。
如果 SQL Server 帐户已创建并添加到 SQL Server 的“安全”>“登录”部分,请检查其“默认语言”是否设置为英语。如果不是,请进行必要的调整。
权限
dbcreator
服务器角色,因为数据库是在此安装过程中创建的。
dbcreator
服务器角色,请在 SQL Server 中创建空数据库。
Windows 安装程序连接到 SQL Server 以验证数据库是否存在。
db_owner
用户映射角色,如以下屏幕截图所示。
db_owner
用户映射角色与 UiPath 登录名一起使用,请授予以下权限:
db_datareader
db_datawriter
db_ddladmin
dbo
架构上的EXECUTE
权限
GRANT EXECUTE
SQL 命令授予 EXECUTE
权限,如下所示。
- 如果使用 Windows 集成身份验证:
USE UiPath Insights GO GRANT EXECUTE ON SCHEMA::dbo TO [domain\user] GO
USE UiPath Insights GO GRANT EXECUTE ON SCHEMA::dbo TO [domain\user] GO - 如果使用 SQL Server 身份验证:
USE UiPath Insights GO GRANT EXECUTE ON SCHEMA::dbo TO [sql_user] GO
USE UiPath Insights GO GRANT EXECUTE ON SCHEMA::dbo TO [sql_user] GO
- 升级到 2021.10 时,拥有 Insights 权限的用户当前不会迁移到新版本。用于执行此迁移的脚本即将推出。
- 如果 Windows 显示语言为以下其中一种语言,则安装程序将使用该语言:en-US、fr-FR、de-DE、es-ES、es-MX、ja-JP、ko-KR、pt-BR、pt -PT、ru-RU、tr-TR、zh-CN。如果 Windows 显示语言不是其中一种语言,则安装程序将使用英语。
- 使用命令提示符或 PowerShell 控制台以管理员身份运行
InsightsInstaller.msi
安装程序。 - 键入
cmd
或powershell
,然后右键单击应用程序并以管理员身份运行。 - 键入
cd <path-to-msi>
命令,其中<path-to-msi>
是您的.msi
安装程序所在的位置。例如C:\Users\yourUsername\Downloads>
。 - 使用以下命令运行 Insights 安装程序:
msiexec /i InsightsInstaller.msi
msiexec /i InsightsInstaller.msi或者,使用以下命令:
.\InsightsInstaller.msi
.\InsightsInstaller.msi - Insights 安装程序现在应检查先决条件。如果满足所有先决条件,则会显示 UiPath Insights 安装向导,并指导您完成 Insights 的安装和配置。
备注:如果安装失败或者您想查看安装日志,可以前往%temp%
或%temp%/<sessionID>
文件夹并查看最新的MSI{random chars}.LOG
。如果要指定其他目录,请使用命令msiexec.exe /i InsightsInstaller.msi /L*V logfilepath
。有关更多详细信息,请参阅支持页面。 - 接受许可协议,然后单击“下一步”。
- 按如下方式更改 Insights 服务器设置:
- “Insights 服务器 URL”- Insights 服务器的主机名或 URL。
- “端口”- 要用于启用计算机和 Insights 之间通信的端口。
- “证书”- 要用于保障与 Insights 稳定连接的 SSL 证书的主题或指纹。
- 按如下方式配置 Orchestrator 设置:
- “Orchestrator URL”- Orchestrator 的 URL
- “单独的身份服务器”- 如果您有单独的身份服务器,请启用此选项。
- “安装令牌”- 以主机租户身份登录,输入您在 Identity Server 的“安装访问令牌”页面上生成的安装访问令牌。有关更多信息,请参阅安装访问令牌。
注意:每次安装时都需要一个新的安装访问令牌。令牌有效期为 2 个小时,之后失效。如果安装失败,请再生成一个。
- 按如下方式配置 Insights 数据库设置:
- “服务器名称”- Insights 数据库所在的 SQL Server 计算机的名称
- “数据库名称”- Insights 数据库的名称
- “身份验证类型”- 选择以下身份验证方法之一:
请注意:您必须使用数据库的完全限定域名(例如,
mysever.my.domain
而不是myserver
)。最好让 SQL Server 必须直接加入 AD 域。- “Windows 身份验证”- 如果选中,Insights 将连接到数据库,创建表格,并使用指定的凭据运行 IIS 应用程序池。安装程序将使用您当前登录时所用的 Windows 凭据验证连接。如果选择此选项,则必须指定域、用户名和密码。
-
“SQL 身份验证”- 如果选中,则使用 SQL 身份验证建立连接。如果使用此选项,则“用户名”和“密码”字段将变为可编辑状态,并且您必须提供用于连接到数据库的 SQL 用户名和密码。
- 按如下方式配置电子邮件设置:
- “配置电子邮件服务 (SMTP)”- 选中以配置电子邮件服务
- “服务器”- SMTP 主机
- “发件人”- 用于发送邮件的电子邮件地址。它必须与为用户名提供的电子邮件地址匹配。
- “用户名”- SMTP 服务器的用户名(如果需要身份验证)。例如,如果您使用的是 Gmail,则在此字段中填写用于发送邮件的电子邮件地址。
重要事项:请考虑使用带身份验证的 SMTP,因为将来可能不支持不带身份验证的 SMTP。
- “密码”- 电子邮件帐户密码
- “端口”- SMTP 端口。
- “TLS/SSL”- 选中以启用 TLS/SSL。
- “TLS/SSL 版本”- 仅选中可见的 TLS/SSL。在 TLSv1_1 和 TLSv1_2 之间进行选择。
注意:完成此步骤后,将使用 SMTP 服务器详细信息发送电子邮件。这是为了确保 SMTP 详细信息正确无误。
- “TLS/SSL 版本”- 仅选中可见的 TLS/SSL。在 TLSv1_1 和 TLSv1_2 之间进行选择。
- 单击“下一步”开始安装。安装过程完成后,单击“关闭”以退出安装程序。
重要事项:Insights 安装完成后,请确保重新启动 Docker。
要验证 Looker 是否正在运行,请确保 Docker 容器已启动。
Insights 安装完成后,导航至浏览器以确认安装成功。
解决 Log4j 漏洞
要解决 log4j 漏洞,请确保运行热修复程序以将依赖项更新到 Apache Log4j 的最新无漏洞版本。
有关更多信息,请参阅 UiPath 安全咨询 CVE-2021-44228、CVE-2021-45046 和 CVE-2021-45105 中的 UiPath Insights(版本 2021.10 及以上)/Automation Suite 咨询部分。
保留原始安装文件,以便您在修改或卸载时使用。
有关更多信息,请参阅修改 Insights 配置。
安装 Insights 后,您必须从 Orchestrator 主机门户为所需的租户启用它。有关更多详细信息,请参阅启用或禁用功能。
- 检查 %programdata%/UiPath Insights/Provisioning 下的日志
- 应该存在有关 Orchestrator 租户作业失败的错误。
- 使用 SQL 客户端登录到 Orchestrator DB。
- 检查 dbo.Tenants 表。
- 检查列“Key”和“AccountId”是否全部大写。
- 如果是,将其小写可以解决此问题。
- 如果有一个小写租户,请尝试启用该租户,并查看是否仍然会发生错误。
- 要解决此问题,请更改字段的大小写(确保事先备份数据库)。 还要记下已经是小写的 KEY)。
- UPDATE [UiPath].[dbo].[Tenants]
- set [key] = LOWER([key]), [AccountId] = LOWER([AccountId])
- 要还原更改,请运行
- UPDATE [UiPath].[dbo].[Tenants]
- set [key] = UPPER([key]), [AccountId] = UPPER([AccountId])
- WHERE [key] NOT IN ('xx-xx-xx-xx', 'xx-xx-xx-xx');
- 可能有必要重置 IIS(或仅回收配置应用程序池)。 配置服务会尝试每 10 分钟配置一次实例,因此,如果未完成配置,最多只需等待 10 分钟。
- 如果问题仍然存在,请向 UiPath 提交工单,并在其中包含以下内容
- dbo.tenants 表的屏幕截图。
- 上述配置日志。