命令行选项
Blue Prism 提供了两个可接受命令行开关的实用程序:
- Automate.exe
图形 Blue Prism 应用程序。这个应用程序的所有消息或反馈都会以可视方式来呈现。如果返回的代码为 0,则表示运行成功;如果返回的代码不为 0,则表示出现错误。
- AutomateC.exe
一个命令行实用程序,可以(通过标准输出)向命令行返回消息和反馈。如果返回的代码为 0,则表示运行成功;如果返回的代码不为 0,则表示出现错误。
提示:
- 使用“/help”开关可以获取 AutomateC 的动态帮助;在 Automate.exe 下方,“/help”开关能在图形窗口中显示这个文档。
- 某些开关需要使用额外的参数(如下文中的 <参数> 所示),这些参数必须紧跟在开关后面。
- 开关与参数之间要用空格隔开。如果参数值包含空格或其他特殊字符,则必须用引号将值括起来。出于这一原因,实际的值不能包含引号。所以,请务必多加注意,以免值中出现引号。
- 在传输 XML 时,必须用引号将 xml 字符串括起来。由于引号在标准输入中被用来划定参数 xml 字符串的开始/结束,所以 Blue Prism 建议使用单引号 ('') 来划定 xml 属性。或者,也可以对出现的所有引号进行转义,具体方法就是:为参数 xml 中的每一个引号输入两个引号。
将 Blue Prism 作为用户“admin”独占的资源 PC 来运行:
automate /resourcepc /user admin mypwd
或者,对于单点登录用户,请使用:
automate /resourcepc /sso
将 Blue Prism 作为公共资源 PC 来运行:
automate /resourcepc /public
在本地 PC 上运行流程:
AutomateC /run "My Scheduled Process" /user admin mypwd
或者,对于单点登录用户,请使用:
AutomateC /run "My Scheduled Process" /sso
使用启动参数在远程 PC 上运行流程:
AutomateC /run "Excel Test" /resource YourPCHostName /user admin mypwd /startp "<inputs> <input name='Comment' type='text' value='Hello World' /></inputs>"
在不启动主 Blue Prism 应用程序的情况下启动后台流程警报监控:
automate /alerts /user admin mypwd
或者,对于单点登录用户,请使用:
automate /alerts /sso
Automate.exe—可用的开关
在 Blue Prism html 帮助浏览器中打开本文档。
只能与 /resourcepc 开关结合使用。如运行模式帮助中所述,这个开关能使资源 PC 成为公开可用的资源。
只能与 /resourcepc 开关结合使用。利用指定了指纹的证书(必须安装在用户或计算机的证书存储库中),这个开关可以确保资源 PC 连接上的传输安全 (SSL/TLS)。
实现传输安全后,源自控制室和调度程序的连接以及路由至资源的公开 Web 服务都将从中受益。证书中的 CN 要与用于连接资源的地址相匹配,连接客户端则要信任发放证书的 CA。
(高级)只能与 /resourcepc 开关结合使用。这个开关可以覆盖所显示的已发布 Web 服务的可寻址位置,以及这个设备上托管的相关资源(如 WSDL)。指定的值需要包含完整的路径地址,如:https://blueprismws.myorg.com:8181。对于本地可用资源,Blue Prism 会自动为附加上 /ws/ 和相关路径。
请务必通过手动方式应用正确的网络路由,以确保指定的前缀是可路由到这个设备的有效地址。
(高级)只能与 /resourcepc 开关结合使用。这个开关会指示运行时资源忽略所侦听端口上收到的任何 HTTP 通信。仅在不需要资源来公开任何 Web 服务,并且无需通过 HTTP 接口来控制资源的情况下,才应使用此选项。
启动时,如果数据库在指定的秒数过后未变为可用状态,则放弃连接。在此期间,系统会按照指定的时间间隔重新尝试建立连接。对于小型安装而言,如果要在启动时运行资源 PC,且同一台计算机上装有数据库“服务器”,那么这个开关会非常有用—在这种情况下,数据库在资源 PC 启动后可能不会立刻做好接受连接的准备。例如,如果使用了 /dbwait 120,那么系统在放弃连接之前会先重复尝试 2 分钟。
只能与 /resourcepc 开关结合使用。默认情况下,资源 PC 信息表单不可见。您可以使用通知区域中的上下文菜单来重新显示该表单(要查找的图标如下所示:)。
只能与 /resourcepc 开关结合使用。资源 PC 只能通过本地计算机来控制;远程资源无法辨别是否存在本地计算机。
只能与 /resourcepc 开关结合使用。指定 Blue Prism 应该通过哪个端口使自己成为可供使用的资源 PC。这样,您便可在同一台计算机上运行多个资源 PC。
在极少数特定情况下,这个选项会非常有用。(例如:
- 覆盖默认端口
如果默认端口 8181 已被网络中的其他服务占用,您可能要使用其他端口。除非有特殊的原因,否则请务必为您网络中的所有资源 PC 使用相同的端口。
- 使用终端服务
在与终端服务主机交互时,Blue Prism 在每个资源 PC 上一次只能运行一个会话。这是因为 Microsoft 终端服务实施存在技术限制。通过在不同的端口上运行多个资源 PC,一台计算机可以正常地运行多个会话。
这可以确定流程警报所针对的目标资源 PC。如果不指定,则会使用本地 PC。
不应该将这个选项与 /resourcepc 开关混为一谈。
使所有 Blue Prism 配置选项都适用于当前已登录的操作系统用户。默认情况下,这一配置适用于所有用户。
请结合使用这些参数,以便创建与指定数据库名称同名的新数据库连接(另请参见 /dbconname),或更新同名的连接(如果存在)。如果采用的是推荐的 SQL Server 身份验证方式,则必须同时提供这四个参数。如果采用的是 Windows 身份验证方式,则应该省略用户名和密码。连接也会被设置为现有的连接。之后,Blue Prism 就会退出。
与 /setdbserver 结合使用,以指定可用性组连接,而非直接数据库连接。在这种情况下,“databaseservername”会是可用性组侦听器的名称。
与 /ag 结合使用,以便为可用性组侦听器指定端口。如果不指定,则会使用默认端口 1433。
与 /ag 结合使用,以指明应该启用“多子网故障转移”。
这个开关可以创建与指定主机同名的新 Blue Prism 服务器连接。(另请参阅 /dbconname、/connectionmode 和 /bpserversecure)连接也会被设置为现有的连接。之后,Blue Prism 就会退出。
这个开关可以与 /setdbserver 或 /setbpserver 选项结合使用,以指定特定的连接名称,而不是使用默认值。如果不与上述某个参数结合使用,则它指定要使用的数据库连接的名称。
这个开关可与 /setbpserver 选项结合使用,以选择客户端与 Blue Prism 服务器之间的连接所用的连接模式。请注意,这个选项必须与 Blue Prism 服务器配置中设置的对应值相匹配。
默认值为 0。可用连接模式有:
- 0—WCF:包含消息加密和 Windows 身份验证的 SOAP
- 1—WCF:包含传输加密和 Windows 身份验证的 SOAP
- 2—WCF:包含传输加密的 SOAP
- 3—.NET Remoting:安全
- 4—.NET Remoting:不安全
- 5—WCF 不安全
这个开关可与 /setbpserver 选项结合使用,以停用安全的 Blue Prism 服务器连接。除非已另作安排来保证连接的安全性,否则绝不应该使用这个开关。注意:不推荐使用 /bpserversecure 选项;现在,应该改用 /connectionmode 选项。
将 Blue Prism 应用程序的优先级设置为指定的模式。通常会在 Blue Prism 作为资源 PC 运行的情况下用于控制 Blue Prism Windows 流程的优先级。如果 Blue Prism 需要比 PC 上其他流程更高的优先级,否则后者可能会独占 CPU 资源并导致 Blue Prism 无法高效运行,那么这个开关会非常有用。有效的模式包括:
- below—低于普通优先级
- above—高于普通优先级
- high—高优先级
- realtime—可能的最高优先级
与 /run 参数结合使用,以便为会话提供启动参数。
paramsxml 参数应该包含有效的 Blue Prism 参数 xml,并用引号 ("") 括起来。由于引号在标准输入中被用来划定参数 xml 字符串的开始/结束,所以 Blue Prism 建议使用单引号 ('') 来划定 xml 属性。例如:
AutomateC /run "Excel Test" /resource YourPCHostName /user admin mypwd /startp "<inputs> <input name='Comment' type='text' value='Hello World' /></inputs>"
或者,也可以对出现的所有引号进行转义,具体方法就是:为参数 xml 中的每一个引号输入两个引号。例如:
AutomateC /run "Excel Test" /resource YourPCHostName /user admin mypwd /startp "<inputs> <input name=""Comment"" type=""text"" value=""Hello World"" /></inputs>"
单点登录用户应该使用 /sso 开关来替代上述示例中的 /user 开关。例如:
AutomateC /run "Excel Test" /resource YourPCHostName /sso /startp "<inputs> <input name=""Comment"" type=""text"" value=""Hello World"" /></inputs>"
显示数据库配置表单。在用户退出该表单(使用“确定”或”取消”按钮)后,应用程序也会随之退出。
AutomateC.exe—可用的开关
打印一些有关命令行标准输出的快速帮助提示。
使用已配置的数据库连接来创建数据库(请参见 Automate.exe /setdbserver)。不 需要输入已配置的数据库连接中所提供的密码。
这个开关有别于 /replacedb 开关:这个开关会删除任何同名的现有数据库;/replacedb 开关会删除数据库中的现有表格,而不删除数据库本身。
使用已配置的数据库连接来创建数据库(请参见 Automate.exe /setdbserver)。不 需要输入已配置的数据库连接中所提供的密码。
这个开关有别于 /createdb 开关:如果已存在同名的数据库,这个开关只会删除这个数据库中的现有表格;/createdb 命令会删除整个数据库并重新进行创建。
在创建数据库时为 Blue Prism 管理员确定 Active Directory 组。只有在您想要使用单点登录时,才会涉及这个开关。必须与 /setaddomain 以及 /createdb 或 /replacedb 结合使用。
在创建数据库时为 Blue Prism 管理员确定域名。只有在您想要使用单点登录时,才会涉及这个开关。必须与 /setadadmingroup 以及 /createdb 或 /replacedb 结合使用。
升级现有数据库(如果需要)。不 需要输入已配置的数据库连接中所提供的密码。
创建一个可供 DBA 用来创建新数据库的 SQL 脚本。例如:
AutomateC.exe /getdbscript createdb.sql
此命令输出脚本—createdb.sql。
创建或更新指定名称所标示的 BP 服务器配置,设置数据库连接名称,并侦听端口上有没有出现所提供的值。
可以使用可选的 /connectionmode 开关来设置连接模式。
如果没有为 BP 服务器配置配置过任何加密方案,则会创建新的加密方案记录。默认情况下,这个方案名为 Default Encryption Scheme,并会被配置为使用 AES 256 (AESCryptoService) 和随机生成的密钥。或者,请使用 /encryptionscheme 开关来定义将要使用的设置。
这是一个可选开关,要与 /serverconfig 开关结合使用,可用于定义在创建加密方案时将要使用的设置。
<name> 定义了加密方案的名称。
<encryptionmethod>(可选)定义了要使用的加密算法。
- 1 = 三重 DES(192 位)
- 2 = AES-256 RijndaelManaged(256 位)
- 3 = AES-256 AesCryptoService(256 位)—默认值
三重 DES(192 位)可以实现向后兼容性。强烈建议不要将新的加密方案配置为使用这一方法。
请求在 Blue Prism 升级将对象/流程依赖项存储库标记为过时后刷新该存储库。如果指定了关键字“force”,那么无论该存储库当前处于何种状态,它都会被刷新。
注册 Web 服务,以便在 Blue Prism 流程中加以使用。这相当于通过系统管理器的“Web 服务”区域中的向导来注册 Web 服务。
- 需要通过 /user 或 /sso 开关提供用户凭据。
- 可以选择与 /objectname 开关结合使用。
- 可以选择指定 /timeout 开关。
- 如果需要凭据以获取 WSDL 文档,则可使用 /wsauth 开关。
<servicename> 标识符必须与 Web 服务的 WSDL 文档中的服务名称相匹配(请参见 Web 服务术语表,以进一步了解 WSDL 文档)。这个标识符是必需的,因为一个 WSDL 文档可能会包含对于多个不同 Web 服务的描述。这里提供的名称不同于 /objectname 开关所指定的名称,前者指定的是 Web 服务在 Blue Prism 各流程内部所用的名称。
<WSDLURL> 参数必须指定相关 Web 服务的 WSDL 文档的位置 (URL)。这会使用 http 或 https(适用时)来获取。
与 /regwebservice 开关结合使用,以指定 Web 服务在完成注册后将要使用的业务对象名称。
与 /regwebservice 开关结合使用,以指定在下载 WSDL 文档时 http 请求中所要使用的任何用户凭据。仅当托管服务器为 WSDL 启用了密码保护时,才需要使用这个开关。
与 /regwebservice 开关结合使用,以指定 Web 服务所要关联的超时值(以毫秒为单位)。这是在等待 Web 服务响应时将要应用的运行时超时值。稍后,可通过访问系统管理器并编辑 Web 服务来修改这个超时值。
可以选择将这个开关与 /regwebservice 命令结合使用。如果不使用这个开关,则会应用默认值,即 10,000 毫秒。
本产品运行的标准 SQL 查询函数,用于设置时间限制,以便命令执行和在超时之前返回结果;默认设置为 60 秒。
为通常需要最长时间来返回结果的 SQL 查询(例如与工作队列交互的查询)设置时间限制,以便命令执行和在超时之前返回结果;默认设置为 600 秒。
为通常需要较长时间来处理的日志设置时间限制,以便命令执行和在超时之前返回结果;默认设置为 0(无限)。
这些命令执行的是系统级别的不可逆更改,因此仅应在 Blue Prism 客户支持团队的建议下使用。
将系统报告写入到指定的文件中。系统报告广泛地概述了系统的当前状态,包括会话和日志条目的数量、队列项的数量、流程的验证状态等。
将元素使用报告写入到指定的文件(CSV 格式)中。请使用 /process 选项来指定所要报告的业务对象。报告中将会包含使用了应用程序模型中的各个元素的页面和环节的相关详细信息。
默认使用在文件中找到的 ID(如果存在的话,否则系统生成新的 ID)将 Blue Prism 流程(或可视业务对象)导入到数据库中。请参见 /forceid 以了解如何覆盖此行为。
filespec 参数是指要导入的 xml 文件的位置。
默认情况下,如果所选环境中已存在导入的流程/对象,这个操作将以失败告终。请参见 /overwrite 以了解如何避免这一情况。
与 /import 配合使用,以便为流程强制使用指定的 ID,而不是使用我导入文件中定义的 ID。
如果使用关键字“new”,则会为导入的对象生成一个新的 ID;否则,应该提供有效的 GUID。
默认情况下,如果数据库中已存在导入的流程/对象,/import 将以失败告终。
如果使用 /overwrite 选项,则会导入新版流程/对象以覆盖现有流程/对象。
注意:如果存在与导入的流程/对象同名的其他流程/对象,但它们的 ID 互不相同,则导入操作将以失败告终—仅当找到 ID 相同的流程/对象时,/overwrite 才能正常执行。
要解决这一问题,可以使用产品中的导入向导。
将 Blue Prism 发行版文件 (.bprelease) 会 Blue Prism 技能文件 (.bpskill) 导入到数据库中。这个操作在功能上等同于通过 Blue Prism 客户端以交互方式执行导入操作(请参见“发行版”选项卡),只是前者是非交互式的,而且在可能的情况下会自动处理所有冲突。一般来说,默认的操作是在数据库中已存在导入的项目时进行覆盖。但是,某些冲突将导致发行版无法以非交互方式来导入。下表概述了冲突的处理方式:
冲突 | 结果 |
---|---|
数据库中已存在 ID/名称和类型相同的项目 | 该项目将被覆盖 |
完成导入后,需要发布或停用流程 | 将会发布/停用流程 |
下方提供了会导致导入失败的冲突示例:
|
不会导入发行版 |
以交互方式导入新凭据时,系统会提示用户输入用户名和密码(因为这些信息没有写入到导出文件中)。以非交互方式导入时,导入的凭据将包含空的用户名/密码,而且需要在 Blue Prism 客户端中手动进行更新。
filespec 参数是指要导入的 .bprelease 文件的位置。
将指定的 Blue Prism 软件包的当前版本从数据库导出到本地文件系统。要导出软件包以前的发行版,请使用可选的 [/release <releasename>] 参数。
将 Blue Prism 流程(或可视业务对象)从数据库导出到本地文件系统。
设置存档路径。这是 /archive 和 /restorearchive 命令以及系统管理器界面中所用的路径。
与 /archive 和 /restorearchive 结合使用,以设置日期范围的包含性开始日期。
与 /archive 和 /restorearchive 结合使用,以设置日期范围的非包含性结束日期。
与 /queueclearworked 结合使用,以删除早于指定期限的所有已处理项(包括在此之前被标记为异常的项)。
与 /archive 和 /restorearchive 结合使用,以绕过基于日期范围所选的会话,并选择早于特定期限的会话。这个值为一个数字后跟一个“y”(年)、“m”(月)、“w”(周)或“d”(天)。例如,“6m”表示应该存档 6 个月之前的日志。
与 /archive 结合使用,以限制为只存档运行了指定流程的会话。与 /elementusage 结合使用,以选择要为其生成报告的流程。
删除环境变量。
发布指定的 Blue Prism 流程。如果流程的名称中包含空格,则需使用引号将名称括起来。
取消发布指定的 Blue Prism 流程。如果流程的名称中包含空格,则需使用引号将名称括起来。
将指定的 Blue Prism 对象或流程作为 Web 服务来公开,以供外部应用程序使用。如果对象或流程的名称中包含空格,则需使用引号将名称括起来。
如果存在可选的 /forcedoclitencoding,则 Web 服务将始终以 Document\Literal 形式返回 SOAP 消息,以确保 WS-I 合规性。
如果不存在 /forcedoclitencoding 参数,则您可以强制使用全局命名空间。
隐藏先前已作为 Web 服务公开的 Blue Prism 对象或流程。如果对象或流程的名称中包含空格,则需使用引号将名称括起来。
给定资源名称的报告会话,可将结果限制为特定期间。列出将 [All] 用作资源名称的资源。
您也可以提供限制数量和类型(m = 分钟,h = 小时,d = 天,mm = 月)来限制返回的结果,例如 /resourcestatus ABC:8181 1 d 将返回在最后一天开始的命名资源的所有会话。
需要通过 /user 开关提供用户凭据。
向指定会话发送“停止请求”,以在决策环节使用 IsStopRequested() 函数设置一个可供正在运行的流程检查的标志。
必须提供会话 ID(一个 GUID)或会话编号(一个数字),以指明停止请求应该要标记的会话。
请注意,只有已通过身份验证且拥有“会话管理完整访问权限”权限的用户(使用 /user 或 /sso 开关来指定)才能执行此操作。
使用 keyfield、running 和 maxattempts 值创建工作队列;在系统管理器中手动创建队列时需要这么做。
必须与 /queuename 结合使用。需要通过 /user 或 /sso 开关提供用户凭据。
将所需的加密方法应用到 Blue Prism 服务器配置。您可以选择使用默认的 Blue Prism 加密方法,或者安装指定的证书。此命令的选项包括:
- /configencrypt—显示在服务器配置中使用的当前加密方法。
- /configencrypt default—应用默认的 Blue Prism 加密方法。需要指定 Blue Prism 系统管理员密码。
- /configencrypt thumbprint—将 configencrypt 方法更改为带有指定指纹的自有证书。需要指定 Blue Prism 系统管理员密码。
- /configencrypt thumbprint /forceconfigencrypt—强制覆盖错误。这可能会导致显示警告。需要指定 Blue Prism 系统管理员密码。
例如:
显示当前加密方法:
AutomateC /configencrypt /user admin password
设置为默认加密方法:
AutomateC /configencrypt default /user admin password
设置为使用指定的证书指纹:
AutomateC /configencrypt bc6269e89048cbf5553601cc0314b291609d9f3 /user admin password
设置指定队列将要使用的加密方案。要想成功,就必须在这个环境中配置指定的方案。Blue Prism 服务器配置中所设置的默认方案名称被称为默认加密方案。
要停用队列的加密密钥,请参阅 /resetencrypt 开关。
必须与 /queuename 结合使用。需要通过 /user 或 /sso 开关提供用户凭据。
重置指定队列的加密方案,以便不再对队列进行加密。
必须与 /queuename 结合使用。需要通过 /user 或 /sso 开关提供用户凭据。
从工作队列中导出数据,并将数据存储在 <filespec> 指定的位置。需要通过 /user 或 /sso 开关提供用户凭据。必须与 /queuename 结合使用。可以同时使用 /queuefilter 和/或 /clearexported。
请注意,要使用 /exportqueue,必须通过 /user 或 /sso 开关提供用户凭据,还需要以下权限之一:“队列管理完整访问权限”、“队列管理只读访问权限”
从工作队列中清除已处理的案例(即标记为已完成或异常的案例)。需要通过 /user 或 /sso 开关提供用户凭据。必须与 /queuename 结合使用。
如果使用了 /age 开关,则只会从队列中删除早于指定期限的已处理项;否则,会从指定队列中删除所有已处理的项。
您可能会想将 /exportqueue 命令与 /clearexported 结合使用,以就流程中删除的项生成相应的记录—这个命令不会创建此类记录。
在与队列相关的命令(如 /exportqueue 或 /createqueue)结合使用时,可以指定队列的名称。
指定在使用 /exportqueue 导出队列时要使用的筛选器。这里要使用在控制室的“队列管理”区域中创建的筛选器的名称。
与 /exportqueue 结合使用时,会从队列中删除已导出的已处理项和已引用项。
需要通过 /user 或 /sso 开关提供用户凭据,还需要“队列管理完整访问权限”权限。
使用指定的名称、密码和用户名来创建新的凭据。
如果无需指定用户名和密码,则可用 "" 表示。
如果未指定任何参数,则会创建常规类型的凭据。
需要通过 /user 或 /sso 开关提供用户凭据,还需要“安全—管理凭据”权限。
默认情况下,所创建的凭据可供所有用户角色、资源和流程使用。
更新根据指定名称所找到的现有凭据。
需要通过 /user 或 /sso 开关提供用户凭据,还需要“安全—管理凭据”权限。
与 /updatecredential 结合使用,以更新凭据密码。
与 /updatecredential 结合使用,以更新凭据中所含的用户名。
与 /updatecredential 或 /createcredential 结合使用,以设置凭据中所含的描述文本。
与 /updatecredential 或 /createcredential 结合使用,以设置凭据的到期日期。日期的格式必须为 yyyyMMdd。
与 /updatecredential 或 /createcredential 配合使用,以指定是否应将某个凭据指定为“无效”。
与 /updatecredential 或 /createcredential 结合使用,以指定凭据类型。必须指定一个受支持的值。
创建新的凭据属性,或更新已有的凭据属性。
需要通过 /user 或 /sso 开关提供用户凭据,还需要“安全—管理凭据”权限。
调度程序选项
您可以使用 AutomateC 命令行程序来启动和删除计划、查看报告和时间表。
要执行任何计划操作,必须提供有效的登录详细信息。
与 /startschedule、/deleteschedule、/viewschedtimetable 和 /viewschedreport 操作结合使用,以指定要使用的计划的名称。
所有后面带有 /schedule 开关的参数都将被视为计划名称,直至出现另一个开关(即以“/”字符开头的参数)或命令结束为止。
如果没有指定任何计划,则命令通常会被视为要针对所有计划运行。
立刻启动所指定的计划。如果调度程序正在运行中,那么相应计划应该会在 30 秒内开始执行。
删除指定计划和所有相关计划日志。
制定计划报告或时间表的输出格式,即“txt”(人类可读格式)或“csv”(逗号分隔的变量格式)。如果没有显式指定格式,则会使用默认格式“txt”。
输出指定的时间表。
您可以指定某个已在 Blue Prism 客户端中创建并配置的时间表。
或者,您也可以通过指明时间表应该开始运行的日期、要显示的天数和要下载的格式,来指定一个临时时间表。
输出指定的报告。
您可以指定某个已在 Blue Prism 客户端中创建并配置的报告。
或者,您也可以通过指明报告应该涵盖到的结束日期、要往回涵盖的天数和要下载的格式,来指定一个临时报告。
资源池选项
您可以使用 AutomateC 命令行程序来创建和删除资源池,以及在现有池中添加和删除资源。
要执行任何资源池操作,必须提供有效的登录详细信息。
创建指定名称的资源池。
删除指定的资源池。
将资源添加到指定的池。
如果没有指定资源名称,则会将本地资源添加到池中。
从资源所在的池中删除资源。
如果没有指定资源名称,则会从本地资源所在的池中删除本地资源。