Governança

Observação: essa página documenta o modelo de governança baseada em arquivos disponível para o Studio. Para obter informações sobre como implantar políticas a partir do Automation Ops, consulte o Guia do Automation Ops.

Para garantir que os usuários do Studio sigam os padrões de desenvolvimento e cumpram determinadas regras, as organizações podem aplicar as políticas de governança que controlam as funcionalidades do Studio.

Aplique as políticas de governança de uma das seguintes maneiras:

• Crie e implante políticas no Automation Ops, um aplicativo da Web fácil de usar.
• Use um modelo de governança com base em arquivo que consiste em criar um arquivo de política JSON e implante o arquivo localmente ou por meio do Orchestrator.

Os recursos atuais são:

• impor diferentes políticas por perfil do Studio.
• restringir o uso de feeds de pacote da janela Gerenciar Pacotes e Exibição de Backstage > Configurações > Gerenciar Origens.
• impor padrões de desenvolvimento organizacionais com as regras do Analisador de Fluxo de Trabalho.
• impor configurações de design e local e definir diversas configurações que não estão disponíveis no Studio.
• habilitar o envio de dados de uso do Studio para sua organização.
• impor o uso de repositórios específicos para o controle de origem do GIT.

Assista o vídeo a seguir para obter uma visão geral dos recursos de governança disponíveis no Studio, bem como uma demonstração de como usá-los no StudioX.

Para impor uma política de governança, comece pela geração de um arquivo de governança do Studio. Depois, configure o arquivo usando os parâmetros que ele contém e aplique a política de uma das seguintes maneiras:

• Como usar um arquivo local (para fins de teste) - Coloque o arquivo de governança na pasta Roaming da máquina em que o Studio estiver instalado.
• Como usar um arquivo externo (para implantações grandes) - Coloque o arquivo de governança em um caminho (por exemplo, um servidor HTTP/HTTPS) referenciado por uma chave de registro ou um ativo no Orchestrator.
• Como usar um ativo no Orchestrator - Copie o conteudo do arquivo de governança para um ativo no Orchestrator.

Gerar Arquivo da Governança

O primeiro passo na aplicação dos padrões de desenvolvimento de sua organização é gerar um arquivo de governança a partir do Studio ou criar manualmente um arquivo semelhante que incorporaria todos ou parte dos recursos que listamos acima.

Importante: O arquivo de governança deve ser do tipo .config com o nome de uipath.policies.config.

Para gerar um arquivo de governança com a configuração atual do Studio, acesse a Exibição Backstage > guia Help e selecione Gerar Arquivo de Governança. O arquivo exportado pode ser compartilhado entre os membros de sua equipe.

Observação: se o Automation Ops estiver habilitado para sua organização, será solicitado que você opte por gerar uma política Clássica ou Moderna. Selecione o modelo de governança clássico com base em arquivo. A opção moderna gera políticas que você pode importar em Automation Ops para uma migração fácil para esse modelo.

Use o botão abaixo para baixar o exemplo que inclui todas as regras do Analisador de Fluxo de Trabalho. Modifique o exemplo para atender às necessidades de sua organização.

Fazer download de amostra

Configurar o Arquivo de Governança

Versão do Arquivo e Rótulo do Arquivo

Os arquivos de governança podem ter diferentes versões e um nome personalizado.

{
    "Metadata": {
        "Version": "1.0"
                "LastUpdatedUtc": "2021-08-25T07:49:26.3089368Z",
                "Availability": null
    },
    "Info": {
        "Name": "Sample Policy Registry Key"
    }
}

Parâmetros	Valores
"Metadata" > "Version"	major.minor entre aspas ""
"Info" > "Name"	Rótulo escrito entre aspas "", visível em Início > Ajuda, sob Política da Empresa.

Perfis do Studio

O arquivo de governança pode conter políticas para usuários do Studio e do StudioX. Entretanto, as políticas devem ser estruturadas por perfil. As políticas para o Studio devem ficar separadas daquelas para o StudioX, como no exemplo abaixo:

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

Parâmetros	Valores
"Profiles"	Para o Studio: Development Para o StudioX: Business Você pode adicionar ambos os perfis no mesmo arquivo.

Configurações que os usuários não podem configurar no Studio

Os parâmetros em "Shell" permitem que você impeça execuções de produção a partir do StudioX, ao definir um limite para o número de execuções que um usuário pode realizar para um projeto sem alterações.

Além disso, você pode configurar se o formulário de feedback e a tela de boas-vindas ficarão disponíveis para os usuários.

{
      "Shell": {
        "IsFeedbackEnabled": true,
        "HideGettingStartedScreen": false,
        "RequireUserPublish": {
          "PermittedConsecutiveRuns": 3,
          "DialogMessage": null,
          "LogToQueue": {
            "QueueName": "NameOfQueue",
            "QueueFolder": "NameOfQueueFolder"
          }
        }
      }
}

Configuração do Studio	Parâmetros	Valores
Habilita ou desabilita o formulário Enviar feedback, que pode ser acessado na barra de título do Studio.	"IsFeedbackEnabled"	A true ou false.
Habilita ou desabilita a tela de boas-vindas que é exibida ao abrir o Studio, com links para o UiPath Academy, um vídeo de introdução e tutoriais	"HideGettingStartedScreen"	A true ou false.
Os parâmetros em "RequireUserPublish" permitem que você limite o número de execuções consecutivas que podem ser disparadas do Studio para um projeto que não tenha alterações, e para definir as configurações de registro para os eventos em que o limite é excedido. Isso pode ser usado para evitar que os usuários disparem as execuções de produção a partir do Studio. Como uma prática recomendada, os projetos que estão prontos para produção devem ser publicados no Orchestrator e executados a partir do Assistant.	"RequireUserPublish" 1	N/A
Número máximo de vezes consecutivas que um projeto sem alterações pode ser executado.	"PermitidosConsecutiveRuns" 1	Insira o número permitido de vezes. Se o valor for null ou um número negativo, nenhum limite é definido.
Mensagem a ser exibida ao usuário em uma caixa de diálogo quando o número permitido de execuções consecutivas é excedido. A caixa de diálogo solicita que o usuário publique o projeto ou cancele a execução.	"DialogMessage"	Insira uma mensagem personalizada a ser exibida entre aspas "". Se o valor for null, a seguinte mensagem será usada: Parece que você está realizando execuções de produção diretamente do seu projeto. Sua organização exige que você publique seu projeto no Orchestrator e faça execuções a partir do seu Assistant.
Os parâmetros sob "LogToQueue" lhe dão a opção de configurar uma fila do Orchestrator para registrar eventos. As seguintes informações são registradas para cada evento: nome de usuário, nome do projeto, hash do arquivo XAML principal e o carimbo de data/hora da máquina local.	"LogToQueue"	N/A
Fila do Orchestrator em que os registros são salvos.	"QueueName"	Insira o nome da fila entre aspas "". Se o valor for null, nenhum registro é salvo.
Pasta do Orchestrator contendo a fila em que os registros são salvos.	"QueueFolder"	Insira o nome da pasta do Orchestrator entre aspas "". Se o valor for null, nenhum registro será salvo.

1 — as alterações entram em vigor apenas no perfil do StudioX.

Uso das Origens do Pacote

Você pode restringir o acesso, adicionar ou remover origens de pacotes para o Studio ou StudioX usando o arquivo de governança.

{
    "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://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json",
                "IsEnabled": true
            }
        ]
    }
}

Parâmetros		Valores
"Package Manager"	"AllowAddRemoveFeeds"		A true ou false.
	"AllowEnableDisableFeeds"		A true ou false.
	"AllowOrchestratorFeeds"		A true ou false.
	"Feeds"	“Nome”	Rótulo escrito entre aspas "", visível em Gerenciar Pacotes.
		"Source"	Origem do feed escrita entre aspas "", visível em Gerenciar Pacotes.
		"IsEnabled"	A true ou false.

Se os parâmetros "AllowAddRemoveFeeds" e "AllowEnableDisableFeeds" estiverem definidos como true, o usuário poderá modificar os feeds disponíveis no Gerenciador de Pacotes. Se forem feitas alterações, elas persistirão quando o Studio for reiniciado.

Se o parâmetro "AllowOrchestratorFeeds" for definido como true e o Robô estiver conectado ao Orchestrator, os usuários não poderão desabilitar os feeds padrão do Orchestrator.

Os feeds definidos no arquivo de governança são adicionados à seção das origens do pacote Padrão na janela Gerenciar Pacotes e o usuário pode adicionar feeds personalizados (se tiverem os privilégios necessários no arquivo de governança) à seção Origens de pacote definidas pelo usuário.

Observe que o caminho para o feed Local para instalações por usuário é C:\Users\CurrentUser\AppData\Local\Programs\UiPath\Studio\Packages.

Configurações do Painel de Atividades (apenas no StudioX)

As configurações em ActivitiesManager permitem que você oculte atividades específicas e imponha o uso do filtro Mostrar Desenvolvedor no StudioX.

"ActivitiesManager": {
        "AllowShowDeveloper": false,
        "HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard","UiPath.Mail.Activities.Business.OutlookApplicationCard"]
}

Configuração	Parâmetros	Valor
Permite que os usuários selecionem o filtro Mostrar Desenvolvedor no painel de atividades no StudioX. Se for definido como False, a opção ficará indisponível.	"AllowShowDeveloper"	A true ou false.
Uma lista das atividades a serem ocultadas do painel de atividades.	"HiddenActivities"	Insira nomes de atividades na matriz, separados por vírgulas. No exemplo abaixo, as atividades Use Gmail e Use Desktop Outlook App foram ocultadas. "HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard", "UiPath.Mail.Activities.Business.OutlookApplicationCard"]

Feeds de modelos

As configurações de TemplatesManager permitem que você imponha quais feeds de modelos são habilitados ou desabilitados para sua organização.

"TemplatesManager": {
        "Feeds": [
          {
            "Name": "GettingStarted",
            "IsEnabled": true
          },
          {
            "Name": "Official",
            "IsEnabled": true
          },
          {
            "Name": "Marketplace",
            "IsEnabled": true
          }
        ]

Configurações		Parâmetros	Valor
TemplatesManager	Feeds	Name	O nome do feed escrito entre aspas "".
		IsEnabled	A true ou false.

Configurações de controle de origem

As configurações em "SourceControl" permitem que você imponha usar repositórios permitidos ao se trabalhar com o GIT, e confirmar alterações antes da publicação.

{
      "SourceControl": {
        "PublishSourceControlInfoParam": {
          "AllowEdit": false,
          "Value": false
        },
        "CheckInBeforePublishParam": {
          "AllowEdit": false,
          "Value": false
        },
       "RepositoriesConfigParam": {
          "AllowEdit": true,
          "Value": {
            "AllowSaveLocal": null,
            "AllowEditRepositories": null,
            "Repositories": [
              {
                "SourceControlType": 0,
                "Name": null,
                "Url": null,
                "DefaultFolder": null
              }
            ]
          }
       
}

O parâmetro "AllowEdit" indica se os usuários tem permissão para alterar a configuração padrão definida pelo arquivo de governança.

Configuração do Studio	Parâmetros	Valor
Consulte informações de controle de origem do processo (URL do repositório, confirmação de repositório, ramificação do repositório, URL da ideia do Automation Hub e tipo de repositório).	PublishSourceControlInfoParam	A true ou false.
Impor o Check-In antes da Publicação Observação: essa configuração está disponível em Início > Configurações > Design.	"CheckInBeforePublishParam"	A true ou false.
Os parâmetros sob RepositoriesConfigParam permitem que você controle o uso de repositórios de controle de origem. Isso se aplica apenas para o GIT.	"RepositoriesConfigParam"	N/A
Permitir que usuários salvem projetos localmente em sua máquina.	"AllowSaveLocal" 1	Ou true ou false. Se o valor for null, o parâmetro será interpretado como true. Quando definido como false, os usuários não podem selecionar Este PC como local na criação de um novo projeto no StudioX, e o projeto será salvo em um repositório.
Permite que os usuários adicionem e editem repositórios.	"AllowEditRepositories"	Ou true ou false. Se o valor for null, o parâmetro será interpretado como true. Se for definido como false: Na visualização Backstage do StudioX, as opções em Início > Equipe são somente leitura, e os usuários não podem adicionar, editar ou remover um repositório. No Studio, os usuários podem adicionar URLs de repositórios na janela Clonar um repositório remoto do GIT, mas cada URL é comparada com a lista de repositórios permitidos.
Uma lista de repositórios permitidos do GIT. Este parâmetro aceita uma matriz JSON de repositórios.	"Repositories" Observação: um repositório que já tenha passado por check-out localmente por um usuário é permitido para ambos os perfis, mesmo se estiver na lista de permissões de apenas um deles.	Insira repositórios na matriz, adicionando o Nome, Url e, opcionalmente, DefaultFolder (a pasta padrão do repositório). Exemplo de um repositório: "Name": "%username%'s Repo", "Url": "https://github.com/uipath/%username%", "DefaultFolder": null Adicionar uma URL base (por exemplo, https://github.com/MyOrg/) permite o uso de repositórios com URLs filhas (por exemplo, https://github.com/MyOrg/RPA). Toda string colocada entre % nos parâmetros de nome e URL são interpretadas como variáveis de ambiente nas máquinas dos usuários. Todos os espaços no parâmetro de URL são substituídos por hífens (-).

1 — as alterações entram em vigor apenas no perfil do StudioX.

Configurações do Studio

Os parâmetros a seguir permitem que você defina as configurações encontradas principalmente em Início (Exibição Backstage do Studio) > Configurações. Para mais informações, consulte Ajustando Configurações do Studio. Há também parâmetros que definem as configurações do nível do projeto a partir da janela Configurações do Projeto e configurações que não podem ser definidas a partir da Interface Gráfica do Studio.

{
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DefaultProjectFrameworkParam": {
          "Value": "Classic",
          "AllowEdit": true
        },          
        "AllowedProjectFrameworks": {
          "Classic": true,
          "Modern": true,
          "CrossPlatform": true
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "ShowDataManagerOnlyParam": {
          "AllowEdit": true,
          "Value": false
        },
        "ShowPropertiesInlineParam": {
          "AllowEdit": true,
          "Value": false
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseSmartFilePathsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableLineNumberingParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableActivityOnlineRecommendationsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableDiscoveredActivitiesParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnforceReleaseNotes": false,
        "DisplayLegacyFrameworkDeprecation": true,
        "AnalyzeOnPublishParam": {
          "AllowEdit": false,
          "Value": false
        },
        "PublishApplicationsMetadata": true,
        "AnalyzeOnPushParam": {
          "AllowEdit": true,
          "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"
        },
        "DefaultPipTypeParam": {
          "Value": "ChildSession",
          "AllowEdit": true
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "SeparateRuntimeDependenciesParam": {
          "AllowEdit": true,
          "Value": true
        },
        "IncludeSourcesParam": {
          "AllowEdit": true,
          "Value": true
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseConnectionServiceParam": {
          "AllowEdit": true,
          "Value": false
        },
        "PlatformAutoUpdateIntervalDaysParam": {
          "AllowEdit": true,
          "Value": 7
        },
        "HideSequencesParam": {
          "AllowEdit": true,
          "Value": true
        },
        "AutoGenerateActivityOutputsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "AllowedPublishFeeds": {
          "Custom": true,
          "PersonalWorkspace": true,
          "TenantPackages": true,
          "FolderPackages": true,
          "HostLibraries": true,
          "TenantLibraries": true,
          "Local": true
        }
      },
}

Dois parâmetros estão disponíveis para a maioria das opções:

• "AllowEdit" - Indique se os usuários têm ou não permissão de alterar a definição padrão configurada pelo arquivo de governança (true para permitir e false para negar).
• "Valor" - Indique a configuração padrão, conforme descrita nas tabelas a seguir.

Em "Workflow":

Configuração do Studio	Parâmetros	Valor
Usar Linguagem C#	"DefaultProjectLanguageParam" 1	CSharp Se "AllowEdit" for false - Permitir somente C#. Se "AllowEdit" for true - Defina a linguagem #C como padrão e permita que os usuários mudem a linguagem padrão. VisualBasic Se "AllowEdit" for false - Permita somente VB. Se "AllowEdit" for true — defina a linguagem padrão para VB e permita que os usuários alterem a linguagem padrão.
Criar anotações encaixadas	"DockedAnnotationsParam"	A true ou false.
Mostrar somente o painel Gerenciador de dados	“MostrarApenasParaGerenteDeDados”	A true ou false.
Exibir todas as propriedades da atividade nos cartões de atividade no painel Designer.	"ShowPropertiesInlineParam"	A true ou false.
Ocultar sequências	“HideSequencesParam”	A true ou false.
Gerar saídas automaticamente para atividades	"AutoGenerateActivityOutputsParam"	A true ou false.
Estrutura padrão de destino do projeto	"DefaultProjectFrameworkParam" 1	"Classic" Se "AllowEdit" for false - Permite apenas o Windows - Legado (.NET Framework 4.6.1). Se "AllowEdit" for true - Define o destino padrão para Windows - Legado e permite que os usuários alterem a estrutura de destino. "Modern" Se "AllowEdit" for false - Permite apenas o Windows. Se "AllowEdit" for true - Define o destino padrão no Windows e permite que os usuários alterem a estrutura de destino. "Cross-platform" Se "AllowEdit" for false - Permite apenas multiplataforma. Se "AllowEdit" for true - Define o destino padrão como multiplataforma e permite que os usuários alterem a estrutura de destino.
Os parâmetros em "AllowedProjectFrameworks" determinam as estruturas de destino permitidas ao criar ou abrir um projeto no perfil do Studio. Para habilitar uma estrutura, defina seu parâmetro como true. Observação: essa configuração não pode ser definida pela interface gráfica do Studio	"AllowedProjectFrameworks" 1	Ou true ou false. para cada uma das seguintes: "Clássico" (Windows - Legado) "Moderno" (Windows) "Multiplataforma" (Multiplataforma)
Usar caminhos de arquivo inteligentes	"UseSmartFilePathsParam" 2	A true ou false.
Habilite a numeração de linhas	"EnableLineNumberingParam"2	A true ou false.
Habilitar sugestões de atividades de IA	"EnableActivityOnlineRecommendationsParam"	A true ou false.
Mostrar todos os pacotes de atividades oficiais que podem ser instalados no seu projeto	"EnableDiscoveredActivitiesParam"	A true ou false.
Acompanhar quais aplicativos e URLs externos são direcionados por uma automação em projetos do Windows e multiplataforma. As versões mais recentes dos pacotes de atividade precisam ser instaladas. Observação: essa configuração não pode ser definida pela interface gráfica do Studio.	"PublishApplicationsMetadata"	A true ou false.
Tornar o campo Notas de Versão no assistente de Publicação obrigatório Observação: essa configuração não pode ser definida pela interface gráfica do Studio.	"EnforceReleaseNotes"	A true ou false.
Defina a visibilidade da mensagem que aparece ao abrir um projeto do Windows - Legado. Observação: essa configuração não pode ser definida pela interface gráfica do Studio.	"ExibirDescontinuaçãoDaFramework"	A true ou false.
Exibição Fina para Atividades Recolhidas	"IsCollapsedViewSlimParam"	A true ou false.
Impor o Analisador antes da Publicação	"AnalyzeOnPublishParam"	A true ou false.
Impor o Analisador antes de Enviar por Push/Fazer Check-In	"AnalyzeOnPushParam"	A true ou false.
Impor o Analisador antes de Executar	"AnalyzeOnRunParam"	A true ou false.
Analisar Somente Arquivos XAML do RPA	"AnalyzeRpaXamlsOnlyParam"	A true ou false.
Localização das Regras do Analisador de Fluxo de Trabalho	"AdditionalAnalyzerRulePathParam"	null - Use a localização padrão. Para alterar a local, insira o caminho para a pasta em que as regras personalizadas estão armazenadas entre aspas.
Caminho do projeto	"DefaultProjectFolderParam"	null - Use a localização padrão. Para alterar a local, insira o caminho para a pasta em que as regras personalizadas estão armazenadas entre aspas.
URL de Publicação do processo	"DefaultProcessPublishUrlParam"	null - Use a localização padrão. Para alterar o local, insira o caminho entre aspas.
URL de Publicação da biblioteca	"DefaultLibraryPublishUrlParam"	null - Use a localização padrão. Para alterar o local, insira o caminho entre aspas.
URL de Publicação de modelos de projeto	"DefaultTemplatePublishUrlParam"	Para alterar o local, insira o caminho entre aspas.
Use a Moderna para novos projetos	"ModernBehaviorParam"	A true ou false.
Separar dependências do Runtime Observação: essa configuração está na janela Configurações do projeto.	"SeparateRuntimeDependenciesParam"	A true ou false.
Incluir Origens Observação: essa configuração está na janela Configurações do projeto.	"IncludeSourcesParam"	A true ou false.
Repositório de Objetos imposto	"ObjectRepositoryEnforcedParam"	A true ou false.
Padrão para conexões gerenciadas	"UseConnectionServiceParam"	A true ou false.
Os parâmetros em "AllowedPublishFeeds" determinam os locais de publicação disponíveis para os usuários. Para habilitar um local de publicação, defina seu parâmetro como true. Observação: essa configuração não pode ser definida pela interface gráfica do Studio	"AllowedPublishFeeds"	Ou true ou false. para cada um dos seguintes: "Custom", "PersonalWorkspace", "TenantPackages", "FolderPackages", "HostLibraries", "TenantLibraries", "Local".
Tipo de PiP	"DefaultPipTypeParam"	ChildSession - Nova sessão. SecondaryDesktop - Nova área de trabalho.

1 - As alterações entram em vigor apenas no perfil do Studio.

2 — as alterações entram em vigor apenas no perfil do StudioX.

Em "ObjectBrowser":

Configuração do Studio	Parâmetros	Valor
Enviar Descritores de Interface Gráfica anônimos	"SendUiDescriptors"	Seja true ou false

Enviar dados de uso do Studio para sua organização

Os parâmetros em "Telemetry" permitem que você habilite o envio de dados de uso do Studio para um recurso Application Insights em seu portal do Azure. Esses dados permitem que você monitore e analise o que os usuários estão fazendo no Studio. Para habilitar este recurso, insira a chave de instrumentação da sua instância do Application Insights no parâmetro "instrumentation-keys".

{
       "Telemetry": {
        "TelemetryOptions": {
          "TelemetryOptionsDictonary": {
            "instrumentation-keys": ""
        }
      }
   }
}

Consulte a tabela a seguir para obter mais informações sobre os dados de telemetria que são enviados para o Application Insights.

Ação	Nome do Evento	Dados coletados
O Studio é iniciado	StudioStarted	ID de usuário do Windows ID da sessão
O Studio é fechado	StudioClosed	ID de usuário do Windows ID da sessão Duração da sessão
O projeto é aberto	Abrir Projeto	ID de usuário do Windows ID da sessão Project Name
O projeto é criado 1	Novo Projeto NewProjectCreated	ID de usuário do Windows ID da sessão Project Name
O projeto é executado	RunProject StartDebug 2	ID de usuário do Windows ID da sessão Project Name
O arquivo é executado	RunDocument StartDebug 2	ID de usuário do Windows ID da sessão Project Name
O projeto é depurado	DebugProject StartDebug 2	ID de usuário do Windows ID da sessão Project Name
O arquivo é depurado	DebugDocument StartDebug 2	ID de usuário do Windows ID da sessão Project Name
Executar até esta Atividade é executado	Designer_RunTo	ID de usuário do Windows ID da sessão Project Name
O Projeto é publicado	Publicar Projeto	ID de usuário do Windows ID da sessão Project Name URL do Orchestrator Folder name Local de publicação (feed)
O pacote de atividades é instalado	PackageAdded	ID de usuário do Windows ID da sessão Nome do Pacote Versão do pacote Project Name
A atividade é adicionada a um projeto	S.Activities.ActivityAdded	ID de usuário do Windows ID da sessão Nome da Atividade Nome do Pacote Versão do pacote
O destino é indicado na atividade da Automação de Interface Gráfica	S.Activities.PropertyChanged	ID de usuário do Windows ID da sessão

1- Quando um projeto é criado, o NewProject é gerado quando o usuário seleciona criar um novo projeto na Studio Backstage View, e o NewProjectCreated é gerado quando o usuário clica no botão Criar na janela de novo projeto.

2 - O evento StartDebug rastreia o robô de destino que executou a operação - o robô local (Local) ou um robô remoto (Orchestrator para conexão de robô não assistido, Remoto para conexão remota da máquina).

Usando os dados no Application Insights

Além dos cenários de caso de uso descritos na documentação oficial da Microsoft, você pode testar e criar consultas usando o Log Analytics no Azure Monitor de sua instância do Azure Insights. Para ver todos os dados possíveis de um evento, você pode construir uma consulta simples que explorará todas as suas ocorrências no intervalo de tempo predefinido. Por exemplo:

customEvents
| where name == "StudioStarted"

Consulte a tabela a seguir para obter exemplos de consultas de telemetria e uma descrição para cada uma. Você também pode verificar a lista de problemas conhecidos.

Evento	Exemplo de consulta	Descrição da consulta
StudioStarted O Studio é iniciado	customEvents | where name == "StudioStarted" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Quantas vezes por dia o Studio foi aberto nos últimos 30 dias, excluindo o dia atual.
StudioClosed O Studio é fechado	customEvents | where name == "StudioClosed" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Quantas vezes por dia o Studio foi fechado nos últimos 30 dias, excluindo o dia atual.
StudioClosed O Studio é fechado	customEvents | where name == "StudioClosed" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend TotalSessionTimeInSeconds = tostring(customDimensions.TotalSessionTimeInSeconds) | extend SessionId = tostring(parse_json(tostring(customDimensions.Context)) .SessionId) | summarize AvgSessionTime_inMinutes = round(avg(todouble(TotalSessionTimeInSeconds))/60,2) by bin(timestamp, 1d) | order by timestamp desc	A duração média da sessão diária nos últimos 30 dias, excluindo o dia atual (em minutos arredondados para duas casas decimais).
Abrir Projeto O projeto é aberto	customEvents | where name == "OpenProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Quantas vezes por dia um projeto foi aberto nos últimos 30 dias, excluindo o dia atual.
NewProjectCreated O projeto é criado	customEvents | onde nome == "NewProjectCreated" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActionArgs = tostring(customDimensions .ActionArgs) | where ActionArgs != "" | summarize count(name) by ActionArgs, bin(timestamp, 1d) | order by timestamp desc	Quantos projetos e de que tipo foram criados nos últimos 30 dias, excluindo o dia atual.
StartDebug O projeto é executado ou depurado / O arquivo é executado ou depurado	customEvents | where name == "StartDebug" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend RunTarget = tostring(customDimensions .RunTarget) | summarize count(name) by RunTarget, bin(timestamp, 1d) | order by timestamp desc	Quantas execuções foram iniciadas e para qual meta nos últimos 30 dias, excluindo o dia atual.
Designer_RunTo Executar até esta Atividade é executado	customEvents | where name == "Designer_RunTo" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Quantas vezes Executar para esta atividade foi executado nos últimos 30 dias, excluindo o dia atual.
Publicar Projeto O Projeto é publicado	customEvents | where name == "PublishProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Quantos projetos foram publicados nos últimos 30 dias, excluindo o dia atual.
PackageAdded O pacote de atividades é instalado	customEvents | where name == "PackageAdded" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActionArgs = tostring(customDimensions. ActionArgs) | summarize count(name) by ActionArgs, bin(timestamp, 1d) | order by timestamp desc	Quantos pacotes e os nomes dos pacotes que foram instalados nos últimos 30 dias, excluindo o dia atual.
S.Activities.ActivityAdded A atividade é adicionada a um projeto	customEvents | where name == "S.Activities.ActivityAdded" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActivityType = tostring(customDimensions. ActivityType) | extend PackageName = tostring(customDimensions.PackageName) | extend PackageVersion = tostring(customDimensions.PackageVersion) | summarize count(name) by ActivityType, PackageName, PackageVersion, bin(timestamp, 1d) | order by timestamp desc	Quantas atividades foram adicionadas nos últimos 30 dias, excluindo o dia atual. Inclui o nome e a versão do pacote de onde vem cada atividade. 3
S.Activities.PropertyChanged O destino é indicado na atividade da Automação de Interface Gráfica	customEvents | where name == "S.Activities.PropertyChanged" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActivityType = tostring(customDimensions.ActivityType) | extend PropertyName = tostring(customDimensions.PropertyName) | summarize count(name) by ActivityType, PropertyName, bin(timestamp, 1d) | order by timestamp desc	Quantas vezes as propriedades das atividades usadas foram alteradas nos últimos 30 dias, excluindo o dia atual. Inclui os nomes das atividades e o nome de cada propriedade que foi alterada.

A tabela a seguir lista parâmetros adicionais incluídos por padrão em eventos.

Parâmetro	Description	Representação em consulta (em um evento selecionado)
customDimensions	Uma coleção detalhada de dados e parâmetros relacionados a cada evento.	customEvents | where name == "StudioStarted" | extend customDimensions
Context	Uma parte da coleção customDimensions que lida com detalhes sobre o projeto, incluindo perfil, ID do usuário, tipo de licença, tipo de robô, ID da sessão.	customEvents | where name == "StudioStarted" | extend Context = parse_json(customDimensions.Context)
Ambiente	Uma parte da coleção customDimensions que consiste no nome da máquina, versão do SO e nome de usuário.	customEvents | where name == "StudioStarted" | extend Environment = parse_json(customDimensions.Environment)

O Log Analytics oferece a opção de estender explicitamente cada tipo de dados que faz parte dos parâmetros mencionados para servir como filtro ou para ser usado como um elemento de resumo adicional. Para fazer isso, clique no ícone de três pontos ao lado de um elemento de dados no log e escolha estender os dados ou usá-los como filtro.

Consulte a tabela a seguir para obter exemplos de extensão ou filtragem de dados.

Exemplo de dados	Representação em consulta (em um evento selecionado)
ApplicationName (extend)	customEvents | where name == "StudioStarted" | extend ApplicationName = tostring(customDimensions.ApplicationName)
LicenseType (extend)	customEvents | where name == "StudioStarted" | extend LicenseType = tostring(parse_json(tostring(customDimensions.Context)).LicenseType)
OSVersion (filtro incluído)	customEvents | where name == "StudioStarted" | where parse_json(tostring(customDimensions.Environment)).OSVersion == "Microsoft Windows NT 10.0.19043.0"
CurrentLanguage (filtro incluído)	customEvents | where name == "StudioStarted" | where parse_json(tostring(customDimensions.Context)).CurrentLanguage == "en"

Problemas conhecidos

• O evento PublishProject exibe apenas detalhes de projetos publicados no Orchestrator.
• O evento S.Activities.ActivityAdded exibe uma versão incorreta do pacote.

Regras do Analisador de Fluxo de Trabalho

O Analisador de Fluxo de Trabalho é a ferramenta para verificar se os projetos atendem os padrões de desenvolvimento. Usando o arquivo de governança, as organizações podem aplicar as regras personalizadas que pertencem às suas necessidades entre todos os projetos de maneira centralizada.

Considerações

• O conjunto de regras personalizadas pode ser definido antecipadamente em um arquivo separado do tipo .json, sendo entregue por meio de uma assembly dll externa ou um pacote de atividades personalizadas. Leia mais sobre Como Criar Regras Personalizadas para o Analisador de Fluxo de Trabalho.
• O arquivo de governança não pode fornecer credenciais, o que significa que feeds seguros não são compatíveis.
• Se for aplicado um conjunto de regras personalizadas, então os usuários não poderão fazer nenhuma alteração nas regras do Analisador de Fluxo de Trabalho.
• Se um conjunto de regras personalizadas não tiver sido referenciado ou inserido no arquivo de governança, as regras padrão do Analisador de Fluxo de Trabalho serão usadas. Se a seção "Analisador" não for mencionada, a governança do Analisador de Fluxo de Trabalho não será aplicada. Se a seção for mencionada, mesmo se estiver vazia, então o gerenciamento de regras será desabilitado no Studio.
• Ao aplicar a governança, as regras integradas do Studio ou dos pacotes de atividades do UiPath são desabilitadas por padrão, a menos que mencionado de modo distinto no arquivo de governança ou nos conjunto de regras personalizadas.

Regras de Aplicação

Há duas maneiras de se gerenciar o conjunto de regras personalizadas no arquivo de governança uipath.policies.config:

1. Apontar para o conjunto de regras localizado em um dos seguintes caminhos:

   • na máquina local;
   • compartilhado em um servidor de rede ou máquina, que possa ser identificado pelo caminho do UNC;
   • em armazenamento de Blobs compartilhado, que possa ser identificado através de caminho http(s).
2. Inserir o conjunto de regras personalizadas, habilitando ou desabilitando regras, mencionando suas IDs, níveis de erro.

Todas as regras personalizadas devem ser referidas ou adicionadas na seção "Analyzer". As regras e os contadores devem ser divididos em suas próprias seções, conforme ilustrado abaixo:

{
    "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": []
            }]
        }
    }
}

Parâmetros/Seções	Valores
"AllowEdit"	Se definidas como true, as configurações de governança são passadas como padrão, o que permite ao usuário alterar as regras. Se definidas como false, não podem ser feitas mudanças nas regras. Se o parâmetro não for adicionado, por padrão os usuários ficam impedidos de editar regras.
"ReferencedRulesConfigFile"	Caminho para o conjunto de regras .json Use null para aplicar as regras do "EmbeddedRulesConfig"
"EmbeddedRulesConfig"	Contém "Rules" e "Counters"
"Id"	Rule ID, ex. ST-NMG-001
"IsEnabled"	Seja true ou false
"Parameters"	Contém Name e Valuedo parâmetro da regra Use [] se a regra não tiver parâmetros.
"Name"	O nome do parâmetro escrito entre aspas.
"Value"	O valor do parâmetro escrito entre aspas Pode ser null
"ErrorLevel"	Seja Error, Warning, Info ou Verbose.
"Counters"	Contém parâmetros para os contadores: "Id", "IsEnabled", "Parameters" 1.

1 - Como os contadores não têm parâmetros, utilize [].

Se o parâmetro "AllowEdit" for definico como true, o usuário poderá modificar as regras disponíveis disponíveis na janela de configurações do Analisador de Fluxo de Trabalho. Se forem feitas alterações, elas persistirão quando o Studio for reiniciado.

Aplicar a Política de Governança

Observação: Recomendamos configurar e implantar políticas usando o Automation Ops. Para obter mais informações sobre como criar políticas a partir de arquivos de governança gerados a partir do Studio, consulte Criar uma política de governança no Guia O Automation Ops.

Como usar um arquivo local

Se armazenado localmente, o arquivo de governança deve localizar-se no seguinte caminho: %AppData%\UiPath.

Como usar um arquivo externo

Se armazenado externamente, o caminho para o arquivo de política deve ser definido usando o Registro do Windows ou um ativo do Orchestrator:

Para definir o caminho do arquvo usando o Registro do Windows:

1. Abra o Editor de Registros na máquina em que o Studio estiver instalado.
2. Localize a seguinte chave de registro: Computer\HKEY_CURRENT_USER\Software\UiPath e pressione Enter.
3. No Editor de Registros, clique com o botão direito do mouse e selecione Novo > Valor de String. Digite no nome GovernanceSource para obter o novo valor. Não use outro nome para o valor!
4. Clique duas vezes na string GovernanceSource para editar. No campo Dados do valor, adicione o caminho para o arquivo uipath.policies.config e clique em OK.
   • Se o arquivo de política for armazenado localmente, um exemplo para este campo seria C:\policies\uipath.policies.config.
   • Se o arquivo de política for armazenado em um servidor, um exemplo para este campo seria 192.168.1.1\policies\uipath.policies.config.

A chave de registro deve ser parecido com este:

Para definir o caminho do arquivo usando um ativo do Orchestrator:

1. No Orchestrator, selecione Tenant > Pastas e adicione uma nova pasta chamada de uipath.settings.config
2. Designar os usuários aos quais aplicar a política de governança em relação à pasta.

3. Na pasta de uipath.settings.config, crie um ativo e configure-o da seguinte maneira:

   • Nome do ativo - uipath.studio.governancesource.
   • Tipo — texto.

   • Valor Global – Selecione esta opção e insira o caminho completo para o arquivo uipath.policies.config na caixa de texto.

     Opcionalmente, você pode aplicar políticas diferentes para usuários diferentes, adicionando valores por usuário com caminhos para arquivos diferentes.

     
     

     

     
     

Como usar um ativo do Orchestrator

1. No Orchestrator, selecione Tenant > Pastas e adicione uma nova pasta chamada de uipath.settings.config
2. Designar os usuários aos quais aplicar a política de governança em relação à pasta.

3. Na pasta de uipath.settings.config, crie um ativo e configure-o da seguinte maneira:

   • Nome do ativo - uipath.studio.governancepolicy.
   • Tipo — texto.

   • Valor Global – Selecione esta opção e cole o conteúdo completo do arquivo uipath.policies.config na caixa de texto.

     Opcionalmente, você pode aplicar políticas diferentes para usuários diferentes ao adicionar valores por usuário e colar parâmetros diferentes.

     Observação:

     • Enforcing a governance policy using an Orchestrator asset that references the file path or holds the contents of the file requires Orchestrator v2020.10 or later with modern folders.
     • Os usuários precisam estar conectados à sua conta no Studio para receber políticas por usuário.
     
     

     

     
     

Aplicação e Precedência

Quando uma política é definida, ela é aplicada depois que o Studio é reiniciado.

Uma mensagem aparece na janela de configurações do Analisador de Fluxo de Trabalho, na janela Enviar comentários, na guia Configurações na Visualização Backstage e na janela Gerenciar pacotes.

O Studio aplica a política de governança usando a seguinte ordem: Automation Ops > uipath.studio.governancepolicy > uipath.studio.governancesource > Chave do registro > arquivo.

Se a política de governança for removida em relação ao usuário, as configurações que tiverem sido aplicadas por meio do arquivo de governança serão persistidas como padrões. Entretanto, agora o usuário terá a opção de alterar as configurações que eram restritas quando a política de governança estava em vigor.