订阅

UiPath Studio

UiPath Studio 指南

监管

关于监管

为确保 Studio 用户遵守开发标准并遵循某些规则,组织可以执行控制 Studio 功能的监管策略。

您可以通过以下方式之一实施监管策略:

  • 通过 UiPath Automation Ops 创建和部署策略,这是一个在 Automation Cloud 中易于使用的 Web 应用程序。
  • 使用基于文件的监管模型,该模型包括创建 JSON 策略文件并在本地、外部或通过 Orchestrator 部署文件。

This page documents the file-based governance model. For information on how to deploy policies from Automation Cloud, see the Automation Ops Guide.

当前功能包括:

  • 按照 Studio、Studio Pro 或 StudioX 及其任何组合强制实施。
  • restrict usage of package feeds from the Manage Packages window and Backstage View> Settings > Manage Sources.
  • enforce organizational development standards using Workflow Analyzer rules.
  • enforce several design and location settings.
  • 禁用“发送反馈”功能。

观看以下视频,了解 Studio 中可用的监管功能及其在 StudioX 中的用法演示。

To enforce a governance policy, start by generating a governance file from Studio, then configure the file using the parameters it contains, and apply the policy in one of the following ways:

  • Using a local file (for testing purposes) - Place the governance file in the Roaming folder on the machine where Studio is installed.
  • Using an external file (for large deployments) - Place the governance file at a path (for example, an HTTP/HTTPS server) referenced by either a registry key or an asset in Orchestrator.
  • Using an asset in Orchestrator - Copy the contents of the governance file to an asset in Orchestrator.

生成监管文件

在组织中强制执行开发标准的第一步是从 Studio 生成监管文件,或手动创建包含上述所有或部分功能的类似文件。

🚧

Important!

监管文件必须为 .config 类型,并具有以下名称:uipath.policies.config

若要使用 Studio 的当前配置生成监管文件,请进入“后台视图”>“帮助”标签,然后选择“生成监管文件”。导出的文件可以在团队中共享。

📘

Note:

如果 Studio 已连接到 Cloud Orchestrator,则系统将提示您选择生成“经典”策略还是“现代”策略。对于基于文件的监管模型,选择经典选项。现代选项会生成策略,然后可以将其导入到 Automation Ops 中,以轻松迁移到该模型。

使用下面的按钮下载包含所有 Workflow Analyzer 规则的示例。根据所在组织的需求修改示例。

请记住,如果已安装 UiPathStudioSetup.exe,则需要将“本地订阅源”的路径更改为 C:\Users\CurrentUser\AppData\Local\UiPath\app-Studio_version

配置监管文件

文件版本和文件标签

监管文件可能有不同的版本和自定义名称。

{
    "Metadata": {
        "Version": "1.0"
    },
    "Info": {
        "Name": "Sample Policy Registry Key"
    }
}

Parameters

Values

"Metadata" > "Version"

major.minor between quotation marks ""

"Info" > "Name"

Label written between quotation marks ""
visible in Backstage > Help, under Company Policy.

Studio 配置文件和发送反馈

监管文件可能包含适用于 Studio、Studio Pro 和 StudioX 用户的策略,但这些策略必须根据配置文件进行结构化。Studio 的策略必须与 StudioX 和 Studio Pro 的策略不同,如下例所示:

{
    "Profiles": {
        "Development": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        },
        "Business": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        },
        "StudioPro": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        }
    }
}

Parameters

Values

"Profiles"

For Studio: Development
For StudioX: Business
For Studio Pro: StudioPro
all three are accepted in the same file.

"Shell" > "IsFeedbackEnabled", "HideGettingStartedScreen"

truefalse

包来源的使用

使用监管文件可能会限制通过 Studio、StudioX、Studio Pro 或这三者的任意组合对包来源进行访问、添加或删除。

{
    "PackageManager": {
        "AllowAddRemoveFeeds": false,
        "AllowEnableDisableFeeds": false,
        "AllowOrchestratorFeeds": true,
        "Feeds": [{
                "Name": "Organization Internal Feed",
                "Source": "https://[company].pkgs.visualstudio.com/_packaging/nuget-packages/nuget/v3/index.json",
                "IsEnabled": true
            },
            {
                "Name": "Official",
                "Source": "https://www.myget.org/F/workflow/",
                "IsEnabled": true
            }
        ]
    }
}

Parameters

Values

"Package Manager"

"AllowAddRemoveFeeds"

truefalse

"AllowEnableDisableFeeds"

truefalse

"AllowOrchestratorFeeds"

truefalse

"Feeds"

"Name"

Label written between quotation marks ""
visible in Manage Packages.

"Source"

Feed source written between quotation marks ""
visible in Manage Packages.

"IsEnabled"

truefalse

如果将 "AllowAddRemoveFeeds""AllowEnableDisableFeeds" 参数设置为 true,则用户可以修改“包管理器”中可用的订阅源。Studio 重新启动时将会保留作出的任何更改。

如果将 "AllowOrchestratorFeeds" 参数设置为 true 并且机器人已连接到 Orchestrator,则用户无法禁用默认的 Orchestrator 订阅源。

监管文件中定义的订阅源将添加到“管理包”窗口的“默认包来源”部分,并且用户可以将自定义订阅源(如果监管文件已经提供必需的权限)添加到“用户定义的包来源部分。

Studio 设置

Configure settings found in Home (Studio Backstage View) > Settings. For more information, see Configuring Studio Settings.

{
      "SourceControl": {
        "CheckInBeforePublishParam": {
          "AllowEdit": false,
          "Value": false
        }
      },
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeOnPublishParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeOnRunParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeRpaXamlsOnlyParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AdditionalAnalyzerRulePathParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultProjectFolderParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultProcessPublishUrlParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultLibraryPublishUrlParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultTemplatePublishUrlParam": {
          "AllowEdit": false,
          "Value": "C:\\Users\\username\\Documents\\UiPath\\.templates"
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        }
      },
}

每个选项有两个参数可用:

  • "AllowEdit" - 指定是否允许用户更改由监管文件配置的默认设置(true 表示允许,false 表示拒绝)。
  • "Value" - 指定默认设置,如下表所述。

"SourceControl" 下:

后台设置

Parameters

在发布前强制签入

"CheckInBeforePublishParam"

truefalse

"Workflow" 下:

后台设置

Parameters

使用 C# 语言

"DefaultProjectLanguageParam"

注意:对此参数的更改仅在 Studio Pro 配置文件中生效。

CSharp
If "AllowEdit" is false - Allow only C#.
If "AllowEdit" is true - Set the default language to C# and allow users to change the default language.
VisualBasic
If "AllowEdit" is false - Allow only VB.
If "AllowEdit" is true - Set the default language to VB and allow users to change the default language.

创建固定注释

"DockedAnnotationsParam"

truefalse

折叠活动精简视图

"IsCollapsedViewSlimParam"

truefalse

在发布前强制使用分析器

"AnalyzeOnPublishParam"

truefalse

运行前强制使用分析器

"AnalyzeOnRunParam"

truefalse

仅分析 RPA XAML 文件

"AnalyzeRpaXamlsOnlyParam"

truefalse

工作流分析器规则位置

"AdditionalAnalyzerRulePathParam"

null - Use the default location.
To change the location, enter the path to the folder where custom rules are stored between quotation marks.

项目路径

DefaultProjectFolderParam

null - Use the default location.
To change the location, enter the path to the folder where custom rules are stored between quotation marks.

发布流程 URL

"DefaultProcessPublishUrlParam"

null - Use the default location.
To change the location, enter the path between quotation marks.

发布库 URL

"DefaultLibraryPublishUrlParam"

null - Use the default location.
To change the location, enter the path between quotation marks.

发布项目模板 URL

"DefaultTemplatePublishUrlParam"

要更改位置,请在引号之间输入路径。

为新项目使用新式体验

"ModernBehaviorParam"

truefalse

强制使用对象存储库

"ObjectRepositoryEnforcedParam"

truefalse

"ObjectBrowser"下:

后台设置

Parameters

发送匿名用户界面描述符

"SendUiDescriptors"

truefalse

工作流分析器规则

The Workflow Analyzer is the tool for verifying if projects meet development standards. Using the governance file, organizations can enforce custom rules pertaining to their needs across all projects, in a centralized manner.

备注

  • The custom ruleset can be defined beforehand in a separate file of type .json, and delivered through a dll external assembly or custom activity pack. Read more about Building Custom Rules for Workflow Analyzer.
  • 监管文件无法提供凭据,这意味着不支持安全订阅源。
  • 如果强制执行自定义规则集,用户将无法对工作流分析器规则作出任何更改。
  • 如果未在监管文件中引用或嵌入自定义规则集,则使用工作流分析器默认规则。如果未提及“分析器”部分,则不会强制执行工作流分析器监管操作。如有提及,即使该部分为空,系统也将在 Studio 中禁用规则管理。
  • 强制执行监管时,默认情况下将“禁用”Studio 或 UiPath 活动包的内置规则,除非监管文件或自定义规则集中另有说明。

强制执行规则

有两种方法可以用于管理 uipath.policies.config 监管文件中的自定义规则集:

  1. 指向位于以下路径之一的规则集:
  • 在本地计算机上;
  • 在网络服务器或计算机上共享,由 UNC 路径标识;
  • 在共享 Blob 存储中,由 http(s) 路径识别。
  1. 通过启用或禁用规则(提及其 ID、参数和错误级别)来嵌入自定义规则集。

必须在 "Analyzer" 部分中引用或添加所有自定义规则。规则和计数器必须分成其各自的部分,如下所示:

{
    "Analyzer": {
    "AllowEdit": false,
        "ReferencedRulesConfigFile": null,
        "EmbeddedRulesConfig": {
            "Rules": [
        {
                    "Id": "ST-NMG-001",
                    "IsEnabled": false,
                    "Parameters": [{
                        "Name": "Regex",
                        "Value": null
                    }],
                    "ErrorLevel": "Error"
                }
            ],
            "Counters": [{
                "Id": "ST-ANA-009",
                "IsEnabled": true,
                "Parameters": []
            }]
        }
    }
}

参数/部分

Values

"AllowEdit"

If set to true, governance settings are passed as defaults allowing the user to make changes to rules.
If set to false, no changes can be made to any rules.
If the parameter is not added, by default, users are restricted from editing rules.

"ReferencedRulesConfigFile"

Path to .json ruleset
Use null to enforce rules from "EmbeddedRulesConfig"

"EmbeddedRulesConfig"

保留 "Rules""Counters"

"Id"

规则 ID,例如 ST-NMG-001

"IsEnabled"

truefalse

"Parameters"

Holds the rule parameter's **Name** and **Value**
Use [] if the rule doesn't have parameters.

“名称”

写入引号之间的参数名称。

"Value"

The parameter's value written between quotation marks
Can be null

"ErrorLevel"

ErrorWarningInfoVerbose

"Counters"

保留计数器的参数:"Id""IsEnabled""Parameters" 1

1 - 由于计数器不包含参数,因此使用 []

如果将 "AllowEdit" 参数设置为 true,则用户可以在工作流分析器设置窗口中修改可用规则。Studio 重新启动时将会保留作出的任何更改。

实施监管政策

使用本地文件

如果存储在本地,则监管文件必须位于以下路径:%AppData%\UiPath

使用外部文件

如果存储在外部,则必须使用 Windows 注册表或 Orchestrator 资产定义策略文件的路径:

To define the file path using the Windows Registry:

  1. 在安装 Studio 的计算机上打开注册表编辑器。
  2. 找到以下注册表项:Computer\HKEY_CURRENT_USER\Software\UiPath,然后按一下 Enter。
  3. 在注册表编辑器中,右键单击并选择“新建”>“字符串值”。输入 GovernanceSource 名称作为新值。请勿使用其他名称作为值!
  4. 双击 GovernanceSource 字符串进行编辑。在“数值数据”字段中,将路径添加到 uipath.policies.config 文件,然后单击“确定”

注册表项应如下所示:

To define the file path using an Orchestrator asset:

  1. 在 Orchestrator 中,选择“租户”>“文件夹”,然后添加一个名为 uipath.settings.config 的新文件夹。
  2. 将要实施监管策略的用户分配给该文件夹。
  3. 在 uipath.settings.config 文件夹中,创建一个新资产并按以下方式对其进行配置:
    • “资产名称”- uipath.studio.governancesource。
    • “类型”- 文字。
    • Global Value - Select this option and enter the full path to the uipath.policies.config file in the text box.
      Optionally, you can apply different policies to different users by adding per-user values with paths to different files.
      :information-source: Note: Enforcing policies per user currently works only if Studio is connected to Automation Cloud Orchestrator.

使用 Orchestrator 资产

  1. 在 Orchestrator 中,选择“租户”>“文件夹”,然后添加一个名为 uipath.settings.config 的新文件夹。
  2. 将要实施监管策略的用户分配给该文件夹。
  3. 在 uipath.settings.config 文件夹中,创建一个新资产并按以下方式对其进行配置:
    • “资产名称”- uipath.studio.governancepolicy。
    • “类型”- 文字。
    • Global Value - Select this option and paste the entire contents of the uipath.policies.config file in the text box.
      Optionally, you can apply different policies to different users by adding per-user values and pasting different parameters.
      :information-source: Note: Enforcing policies per user currently works only if Studio is connected to Automation Cloud Orchestrator.

应用和优先级

定义策略后,将在 Studio 重新启动后应用该策略。

在“工作流分析器”设置窗口、“发送反馈”窗口、后台视图的“设置”选项卡以及“管理包”窗口中会出现一条消息。

Studio 使用以下优先顺序应用治理策略:Automation Ops > uipath.studio.governancepolicy> uipath.studio.governancesource> 注册表项 > 本地文件。

如果已为用户删除监管策略,则通过监管文件强制执行的设置将保留为默认设置。但是,现在用户可以选择修改实施监管策略时的受限设置。

Updated about a month ago

监管


建议的编辑仅限用于 API 参考页面

You can only suggest edits to Markdown body content, but not to the API spec.