启动浏览器
启动 Web 浏览器。
命令可用性: 本地 IBM RPA SaaS 和 IBM RPA
脚本语法
IBM RPA 的专有脚本语言具有类似于其他编程语言的语法。 该脚本语法在脚本文件中定义命令的语法。 您可以在 IBM RPA Studio的 脚本 方式下使用此语法。
webStart --name(String) --type(BrowserTypes) [--userprofilepreferences(BrowserProfiles)] [--enableextensions(Boolean)] [--extensionsFolder(String)] [--disablegpu(Boolean)] [--bypassExternalProtocols(String)] [--useproxy(Boolean)] [--isautodetect(Boolean)] [--username(String)] [--password(String)] --proxyaddress(String) --proxyport(Numeric) [--headless(Boolean)] [--commandexecutiontimeout(TimeSpan)] [--pageloadtimeout(TimeSpan)] [--implicitwaittimeout(TimeSpan)] [--asynchronousjavascripttimeout(TimeSpan)] [--incognito(Boolean)] [--downloadpath(String)] [--userdatadir(String)] (Browser)=value
依赖关系
防病毒和端口可影响机器人并阻止其操作:
如果选择 Microsoft Edge 作为 启动浏览器 命令必须打开的浏览器，那么需要将命令添加到脚本以处理在启用以下输入参数时出现的弹出窗口:
- 启用扩展 (
enableextensions) - 使用代理 (
useproxy)
请参阅 示例 以了解这些问题的变通方法。
- 如果在本地使用 IBM RPA ，或者在 Red Hat® OpenShift® Container Platform上使用 IBM RPA ，那么 IBM RPA 服务器将从因特网下载 Web 驱动程序。 这些下载可能需要几分钟时间，对于 Microsoft Edge，最多需要 1 小时。 需要互联网连接。
- 机器人首次运行 启动浏览器 命令时，机器人会请求从服务器下载 Web 驱动程序。 如果 Web 驱动程序不可用或无法下载，那么机器人将失败。
输入参数
下表显示了此命令中提供的输入参数的列表。 在表中，您可以看到在 IBM RPA Studio的脚本方式及其 Designer 方式等效标签中工作时的参数名称。
| 设计器方式标签 | 脚本方式名称 | 必需的 | 接受的变量类型 | 描述 |
|---|---|---|---|---|
| 实例名称 | name |
Required |
Text |
浏览器实例的名称。 |
| 浏览器类型 | type |
Required |
BrowserTypes |
要使用的浏览器类型。 请参阅 type 参数选项。 |
| 使用概要文件首选项 | useprofilepreferences |
Required |
BrowserProfiles |
启动已登录到所需用户概要文件的会话。 对于您选择的概要文件，您可能会在自动化方面看到一些差异。 有关每个概要文件的更多信息，请参阅 useprofilepreferences 参数选项 。重要信息:此参数仅适用于 Google Chrome， Mozilla Firefox和 Microsoft™ Edge . |
| 启用扩展 | enableextensions |
Optional |
Boolean |
允许在浏览器中安装扩展。 |
| 扩展文件夹 | enxtensionsfolder |
Optional |
Text |
文件夹路径，其中包含要安装的扩展。 |
| 禁用 GPU | disablegpu |
Optional |
Boolean |
禁用图形处理单元。 |
| 绕过外部协议 | bypassexternalprotocols |
Optional |
Text |
用于定义要忽略的协议的字符串。 |
| 使用代理 | useproxy |
Optional |
Boolean |
允许使用基于代理的连接。 |
| 自动检测 | isautodetect |
Optional |
Boolean |
自动检测代理。 |
| 用户名 | username |
Optional |
Text |
代理用户名。 |
| 密码 | password |
Optional |
Text, Secure String |
代理用户密码。 |
| 代理地址 | proxyaddress |
Only when Auto detect is False |
Text |
代理连接的地址。 |
| 代理端口 | proxyport |
Only when Auto detect is False |
Number |
为代理连接打开的端口。 |
| 无头 | headless |
Optional |
Boolean |
不显示该浏览器窗口。 |
| 执行超时 | commandexecutiontimeout |
Optional |
Time Span, Number, Text |
启动浏览器时的超时值。 |
| 页面装入超时 | pageloadtimeout |
Optional |
Time Span, Number, Text |
装入页面组件的超时。 |
| 隐式超时 | implicitwaittimeout |
Optional |
Time Span, Number, Text |
运行命令时的隐式超时值。 |
| JavaScript 超时 | asynchronousjavascripttimeout |
Optional |
Time Span, Number, Text |
运行 JavaScript 回调时的超时值。 |
| Incognito | incognito |
Optional |
Boolean |
以 incognito 方式打开浏览器窗口。 |
| IE11 兼容性方式 | iecompatibility |
Only when Microsoft Edge is the Browser type |
Boolean |
启用以在 Internet Explorer 11 兼容性方式下打开 Microsoft™ Edge 。 如果使用此参数，请遵循 此故障诊断主题 上的过程在 Internet Explorer 11 中启用 受保护方式 选项。 |
| 下载路径 | downloadpath |
Optional |
Text |
用于保存已下载文件的路径。 此参数的行为可根据用户概要文件集而更改。 |
| 用户数据目录 | userdatadir |
Optional |
String |
创建或从默认配置文件文件夹复制的备用配置文件路径（与默认路径不同）。 如果该命令用于 Chrome 浏览器 136 或更高版本，则必须使用此参数。 |
type 参数选项
下表显示了可用于 type 输入参数的选项。 该表显示了在脚本方式下工作时的可用选项以及在设计器方式下的等效标签。
| 设计器方式标签 | 脚本方式名称 | 描述 |
|---|---|---|
| Google Chrome | Chrome |
Google Chrome 浏览器。 |
| Internet Explorer | InternetExplorer |
Internet Explorer 浏览器。 |
| Microsoft Edge | Edge |
Microsoft™ Edge (Chromium) 浏览器。 |
| Mozilla Firefox | Firefox |
Mozilla Firefox 浏览器。 |
useprofilepreferences 参数选项
下表显示了可用于 useprofilepreferences 输入参数的选项。 该表显示了在脚本方式下工作时的可用选项以及在设计器方式下的等效标签。
| 设计器方式标签 | 脚本方式名称 | 描述 |
|---|---|---|
| 自动化的缺省值 | AutomationOptimized |
装入缺省 IBM RPA Studio 概要文件，忽略浏览器的概要文件首选项。 |
| 自动化优化的用户概要文件 | UserProfileOptmized |
装入浏览器的概要文件首选项，同时仍保留一些 IBM RPA Studio的首选项以优化自动化。 |
| 完整用户概要文件 | StrictUserProfile |
装入浏览器的概要文件首选项，而忽略 IBM RPA Studio的首选项。 重要信息:使用此选项可能会导致自动化无法正常工作。
|
要更好地了解每个概要文件如何使用可用的浏览器，请参阅以下部分:
- 自动化的缺省值 和 自动化优化的用户概要文件
| 元素 | 描述 |
|---|---|
| 该命令将始终下载 PDF ，而不仅仅是打开它们。 | |
| 密码 | 此命令将禁用与密码保存和密码建议相关的弹出窗口。 |
| 下载 | 该命令将自动处理选择所有下载的文件路径的提示。 |
| 导航 | 此命令将禁用向浏览器服务器报告分析信息。 该命令还将绕过有用的验证，但是这些验证可能会阻止机器人执行流程，例如弹出窗口阻止。 该命令始终打开最大程度的浏览器，并隐藏每个消息提示。 |
| 内容 | 该命令允许在 Google Chrome 和 Microsoft Edge 上加载 HTTP 内容。 |
- 完整用户概要文件
| 元素 | 描述 |
|---|---|
| 该行为将取决于浏览器上设置的配置。 | |
| 密码 | 该行为将取决于浏览器上设置的配置。 |
| 下载 | 该命令不会处理任何与下载相关的提示，您的脚本必须加以处理。 如果要执行多次下载，那么可能会看到来自浏览器的消息可能阻止下载。 |
| 导航 | 缺省情况下，该命令不会禁用报告分析信息，并且行为将取决于浏览器的配置方式。 该命令也不会绕过一些可能阻止机器人执行的验证，因此脚本将需要处理这些验证，其中一些行为将取决于浏览器的配置方式。 |
| 内容 | HTTP 内容的加载取决于浏览器上设置的配置。 |
输出参数
| 设计器方式标签 | 脚本方式名称 | 接受的变量类型 | 描述 |
|---|---|---|---|
| 浏览器 | value |
Browser |
返回包含浏览器实例的变量。 |
示例
示例 1: 启动 Google Chrome 浏览器:
webStart --name browser --type "Chrome"
// Navigate to the ibm web page.
webNavigate --url "ibm.com"
webClose --name browser --leavebrowseropen
示例 2: 启动 Microsoft™ Edge 浏览器，关闭 在开发者方式下关闭扩展 弹出窗口并导航到 IBM 页面。
webStart --name browser --type "Edge"
// Close the pop-up
click --safesearch --selector "XPath" --controlsimilarity 100 --forcerefresh --xpath "//window[@name=\'Turn off extensions in developer mode\']//button[@name=\'Close\']" --timeout "00:00:20
// Navigate to the IBM web page.
webNavigate --url "ibm.com"
webClose --name browser --leavebrowseropen
限制
- IBM Robotic Process Automation 使用扩展在浏览时连接到代理服务器。 要使用扩展，请确保满足以下浏览器需求:
- Google Chrome 108 或更高版本。
- Microsoft™ Edge 108 或更高版本。
- 一次只能打开一个浏览器实例。 有关更多详细信息，请参阅 Bot 在尝试使用用户数据打开两个 Google Chrome 浏览器时失败 。