Variáveis personalizadas

O Insights sempre consome dados por meio dos campos predefinidos disponíveis no modelo de dados do Insights, mas os administradores também podem configurar variáveis personalizadas extraídas de logs e filas de robôs para usar para calcular KPIs específicos ou criar painéis mais especializados.

Dica:

Para incluir variáveis personalizadas para processos, você deve primeiro certificar-se de que elas são adicionadas aos logs em sua automação por meio da atividade UiPath.System.Activities.AddLogFields no Studio e, em seguida, deve selecioná-las para ingestão.
Para incluir variáveis personalizadas para filas você deve primeiro certificar-se de que elas são adicionadas em fluxos de trabalho por meio de uma atividade no Studio e depois selecioná-las para a ingestão.
- Use a atividade UiPath.System.Activities.AddQueueItem para dados específicos;
- Use a atividade UiPath.System.Activities.SetTransactionStatus para Dados de saída e Dados de análise.
A desativação de variáveis personalizadas pode interromper os painéis existentes que fazem referência às variáveis.
You only have to designate a Transaction Item as either Successful or Failed, and you don't need to fill in the OutputData or AnalyticsData properties.

Uso de variáveis personalizadas em painéis de controle com escopo de organização

Ao usar variáveis personalizadas em painéis de controle com escopo de organização, considere o seguinte:

Apenas variáveis personalizadas extraídas da janela Configurar variável personalizada enquanto na exibição Tenant são exibidas dentro da seção de configuração de variáveis personalizadas com escopo da organização. Quaisquer variáveis personalizadas que não sejam extraídas do tenant não são exibidas dentro de painéis com escopo da organização.
Ao alterar variáveis personalizadas com escopo de tenant, as variáveis personalizadas com escopo da organização são desabilitadas da organização. Certifique-se de reabilitá-las após todas as alterações serem feitas para que sejam exibidas dentro dos painéis.
As seções de ROI e variáveis personalizadas são somente leitura.

Configuração de variáveis personalizadas

Para configurar variáveis personalizadas, um administrador deve adotar as seguintes medidas:

Abra o menu de 3 pontos no canto superior direito de qualquer página do Insights e selecione Configurar variáveis personalizadas. A página de configuração abre, listando todos os campos personalizados que estão disponíveis para extração.
Decida se deseja configurar as variáveis personalizadas para processos ou filas clicando na aba correspondente na parte superior da página de configuração.
Na coluna Extrair, escolha as variáveis personalizadas que você deseja usar ao criar painéis.
Na coluna Tipo, selecione o tipo da variável personalizada. Você pode escolher String, Número ou DataHora.
Importante:
- Os campos são limitados a 40 caracteres, e quaisquer caracteres após esse número serão cortados. Para adicionar mais de 40 caracteres, altere o sinalizador Insights.Etl.Json.MaxStringLen. Você pode adicionar esse sinalizador na configuração da web do Orchestrator e definir o valor de acordo com as necessidades de seu projeto. Por exemplo:
<add key="Insights.Etl.Json.MaxStringLen" value="60" />
- A porcentagem de preenchimento mostra o progresso da extração de uma variável personalizada de todos os processos ou filas. Você precisará atualizar a página para ver a porcentagem mais recente de preenchimento. Isso pode levar algum tempo dependendo do tamanho dos dados. Os valores de variáveis personalizadas serão preenchidos começando dos dados mais novos até os mais antigos. O campo estará disponível para uso logo após a configuração ser salva — você não precisará esperar até ele ser 100% preenchido.
- Você pode extrair variáveis de no máximo 500 processos ou filas, e no máximo 200 variáveis por processo ou fila.
- Se você definir o Tipo de uma variável personalizada como Número, certifique-se de que ela não contém um , ou outros caracteres não numéricos, como $, pois esses caracteres não são compatíveis. Para números com caracteres especiais, selecione o tipo String.
- Toda mudança na configuração de variáveis personalizadas causará um novo preenchimento completo para esse processo específico. O tempo do preenchimento depende do número de registros armazenados no banco de dados do Insights para esse processo específico.

Salve a configuração. Todas as variáveis extraídas para um processo específico devem aparecer em um Explorar com o nome *Processo — NomedoProcesso, e todas as variáveis extraídas para uma fila específica devem aparecer em um Explorar com o nome *Fila — NomedaFila.

Importante: Você pode extrair variáveis de no máximo 500 processos ou filas, e no máximo 200 variáveis por processo ou fila.

Número de variáveis personalizadas configuradas	Escala de hardware	Número de processos	Número de logs de robô por processo	Tempo aproximado para extração
30	Grande escala	1	1.000.000	5 minutos
30	Grande escala	1	40.000.000	120 minutos

Editar uma configuração existente

Para editar uma configuração existente, um administrador deve adotar as seguintes medidas:

Abra o menu de 3 pontos no canto superior direito de qualquer página do Insights e selecione Configurar variáveis personalizadas. A página de configuração abre, listando todos os campos personalizados que estão disponíveis para extração.
Decida se deseja configurar as variáveis personalizadas para processos ou filas clicando na aba correspondente na parte superior da página de configuração.
Para remover variáveis que foram selecionadas anteriormente, desmarque a caixa de seleção Extrair.
Para remover o status Comum de uma variável, desmarque a caixa de seleção dedicada.
Para alterar o tipo de variável, selecione o novo tipo desejado no menu suspenso.
Certifique-se de salvar a configuração.
Executar as seguintes verificações nos painéis existentes que usaram uma variável modificada ou removida:
1. Se você excluiu a variável, certifique-se de remover quaisquer referências a essa variável de fórmulas que foram criadas ou modificadas, de filtros ou de visualizações internas;
2. Se você alterou o tipo de variável, certifique-se de que o novo tipo ainda se aplica corretamente;
3. Se a variável não tiver mais o status Comum, é necessário substituir a referência à variável comum pelo valor atualizado por processo.

Exemplo de configuração

Esta seção fornece um exemplo de uso de uma variável personalizada em um painel.

Na imagem a seguir, a variável ProcessCount está presente em vários processos, enquanto a variável Argument1_Email ocorre apenas em um processo.

Adote as seguintes medidas para configurar variáveis personalizadas:

Selecione a variável ProcessCount para extração e escolha o tipo String. Marque a variável como Comum para que você obtenha seu valor em todos os processos em que ela é exibida.
Habilite a variável Argument1_Email e selecione o tipo de String. Como essa variável não ocorre em vários processos, você não deve selecionar Common. Clique em Salvar.
Navegue de volta para Painéis, crie um novo painel e adicione um novo bloco.
Escolha o explore de Logs de robôs para ver as variáveis personalizadas já configuradas.

Como você selecionou Comum para o ProcessCount, é possível ver que não há prefixo de nome de processo porque ele foi adicionado ao modelo de dados padrão. Ao contrário do ProcessCount, você não selecionou Comum para o Argument1_Email, então o campo personalizado foi adicionado como Log_Email.Argument1_Email.

Casos nulos de variáveis personalizadas

As variáveis personalizadas podem ter um valor nulo em alguns casos específicos, conforme descrito nas seções a seguir.

Cenário 1

Se você usar um campo do modelo de dados padrão em uma visualização combinada com um campo de variável personalizada específico do processo e um processo não contiver a variável personalizada nos logs de robô, o valor de todos os campos associados ao processo que não contiverem a variável personalizada em seus logs de robôs é nulo.

Há duas maneiras de eliminar os valores nulos para esse cenário:

Opção 1: adicione a variável personalizada como filtro e defina a condição como não é nula

Opção 2: defina um filtro para o nome do processo que inclua a variável personalizada. Observe, no entanto, que se você adotar essa abordagem, é possível incorrer no segundo cenário abaixo.

Cenário 2

Se uma variável personalizada não estiver presente em todos os logs gerados por um processo, os logs que não contêm um valor para essa variável personalizada mostrarão o valor da variável como nulo.

O exemplo a seguir ilustra esse caso específico.

Acesse Configurar variáveis personalizadas. É possível ver que o campo de variável personalizada do Argument1_Email ocorre apenas no processo de Log_Email. Considerando que o Argument1_Email é um campo de variável personalizado específico do processo, mantenha o Comum desmarcado.
Abra um painel novo ou existente e adicione um bloco.
Navegue até o explore de Logs de robô. Selecione o campo Nome do processo e o campo de variável personalizada. Neste caso, o campo de variável personalizada é Log_Email.Argument1_Email.
Clique em Executar. Os resultados que você vê devem ser semelhantes aos que são exibidos na captura de tela a seguir.

Para eliminar os valores nulos, adicione o campo de variável personalizada como um filtro. Por fim, defina a condição como não é nula, de modo que você possa remover os valores nulos da visualização.

Nota: Esses dois casos ocorrem ao visualizar os dados brutos do campo personalizado. Ao aplicar uma função (Soma, Média, etc.) às variáveis personalizadas, você exclui valores nulos.