Skip to main content

Relatório de uso do Server

Use o Relatório de uso do Server para entender métricas de usuários, aplicativos, permissões, agendamentos e trabalhos, para que você possa avaliar rapidamente problemas de desempenho, auditoria e conformidade. Conecte-se ao MongoDB e à API do Server para extrair dados e análises pertinentes do seu Alteryx Server com facilidade. Escolha a saída preferida, incluindo: painel do Tableau, arquivos separados, banco de dados ou use as saídas de macro para processos em etapas posteriores.

Você pode baixar o Relatório de uso do Server no Alteryx Marketplace.

Requisitos

O Relatório de uso do Server é compatível com o Designer versões 2023.2 e mais recentes. Use o patch mais recente disponível para sua versão do Designer.

Instale o utilitário Relatório de uso do Server e as dependências

Siga estas etapas para instalar o Relatório de uso do Server e as dependências associadas.

Instalar o YXI

  1. Baixe o Server_Usage_Report.yxi do Alteryx Marketplace.

  2. Clique duas vezes no arquivo YXI para instalar o utilitário com o Designer.

  3. Siga os prompts:

    • Instalar para minha conta: somente sua conta de usuário terá acesso ao utilitário na máquina. Instala em: %AppData%\Alteryx\.

    • Instalar para todos os usuários: todos os usuários terão acesso ao utilitário na máquina. Instala em: %ProgramData%\Alteryx\.

  4. Após a conclusão, abra o fluxo de trabalho "Introdução". No Designer, vá para Ajuda > Exemplos de fluxos de trabalho > Utilitários empresariais > Relatório de uso do Server > Introdução.

Instalar o conector de Saída do Tableau

Nota

Esse é um item opcional. O conector de Saída do Tableau só é necessário se você optar por gravar a saída no Tableau. O fluxo de trabalho pode funcionar sem a Saída do Tableau, desde que você não selecione a opção de gravar no Tableau.

  1. Baixe o conector de Saída do Tableau do Alteryx Marketplace.

  2. Clique duas vezes no arquivo YXI para instalar o conector usando o Designer.

  3. Siga os prompts:

    • Instalar para minha conta: somente sua conta de usuário terá acesso à ferramenta na máquina. Instala em: %AppData%\Alteryx\.

    • Instalar para todos os usuários: todos os usuários terão acesso à ferramenta na máquina. Instala em: %ProgramData%\Alteryx\.

Instalar o driver do Simba para MongoDB

  1. Baixe o driver do Simba no Portal de Licenças da Alteryx.

  2. Role até a parte inferior da seção "Downloads de produtos" e selecione Baixar à direita da entrada Drivers.

  3. Na lista de versões, selecione "MongoDB" e clique em Próximo.

  4. Selecione Baixar à direita da entrada Simba MongoDB 2.3.22.1024 de 64 bits.

  5. Clique duas vezes no arquivo MSI para instalar o driver na sua máquina. O driver agora estará acessível no utilitário de administrador do ODBC.

Configurar o DSN para conexões do MongoDB

Em seguida, configure o DSN para conexões do MongoDB. Siga as etapas abaixo.

  1. Abra o Administrador de fonte de dados ODBC (64 bits) em sua máquina.

  2. Crie uma nova fonte de dados usando o Driver ODBC do MongoDB do Simba (versão 2.03.22.1024).

  3. Preencha estes campos:

    • Nome da fonte de dados: pode ser qualquer coisa, mas precisa ser preenchido, mesmo que usando temporariamente a conexão ODBC.

    • Servidor: o nome do seu servidor.

    • Porta: a porta do seu servidor (27018 para o MongoDB integrado).

    • Banco de dados: AlteryxService (ou AlteryxGallery, dependendo do banco de dados que você está atualizando).

    • Mecanismo: SCRAM-SHA-256

    • Fonte de autenticação: corresponde ao nome do banco de dados da entrada "d" acima.

    • Nome de usuário: nome de usuário do banco de dados, geralmente usuário.

    • Senha: senha do banco de dados. Verifique as configurações de sistema do Alteryx para obter a senha do MongoDB integrado.

  4. Selecione Teste... para se certificar de que a conexão seja bem-sucedida.

  5. Selecione Opções avançadas....

  6. Atualize o valor de Tamanho da coluna binária para 2147483647.

  7. Na seção Metadados em "Mecanismo", selecione Arquivo local.

  8. Clique em Navegar... e selecione o arquivo de esquema apropriado localizado na pasta "Esquema específico da versão do MongoDB":

    • Para versões até a 2023.2:

      • Arquivo de esquema: MongoDB_Schema_23.2.json

      • Local da instalação por usuário: %appdata%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_23.2.json

      • Local da instalação por administrador: %ProgramData%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_23.2.json

    • Para versões 2024.1 e posteriores:

      • Arquivo de esquema: MongoDB_Schema_24.1Plus.json

      • Local da instalação por usuário: %appdata%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_24.1Plus.json

      • Local da instalação por administrador: %ProgramData%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_24.1Plus.json

  9. Clique em Abrir, em seguida, em OK e em OK novamente.

  10. Repita as etapas acima para o banco de dados AlteryxService.

Criar conexões do DCM para o MongoDB

A próxima etapa é criar conexões para o MongoDB no Gerenciador de Conexões de Dados (DCM).

  1. Abra o DCM. No Designer, vá para Arquivo > Gerenciar conexões.

  2. Na guia Fontes de dados, selecione + Novo e escolha o bloco MongoDB.

  3. No menu suspenso Tecnologia, selecione ODBC do MongoDB.

    • Nome da fonte de dados: insira o nome da fonte de dados do AlteryxService do Mongo na seção Configurar o DSN para conexões do MongoDB acima.

    • DSN do ODBC: selecione o DSN do ODBC do AlteryxService do MongoDB criado anteriormente.

  4. Selecione Salvar e Conectar credencial.

  5. Preencha estes campos:

    • Método de autenticação: nome de usuário e senha do MongoDB

    • Credencial: crie uma nova credencial

    • Nome da credencial: nome de sua escolha (por exemplo, MongoDB_AlteryxService_Local).

    • Cofre: DCM

    • Nome de usuário: usuário

    • Senha: sua senha.

    • Mecanismo de autenticação: SCRAM-SHA-256

    • Fonte da autenticação: AlteryxService

    • Permitir conexão para SDK: desmarcado

  6. Clique em Testar conexão. Se o teste for bem-sucedido, selecione Criar e vincular.

  7. Repita essas etapas para o banco de dados do AlteryxGallery.

Criar uma conexão do DCM com a API do Server

  1. Abra o DCM. No Designer, vá para Arquivo > Gerenciar conexões.

  2. Na guia Fontes de dados, selecione + Novo e escolha o bloco Baixar.

    • Nome da fonte de dados: nome de sua escolha (por exemplo, API do Server).

    • URL de base: insira o URL de base para a API do Server. Termina com /webapi/.

      Exemplo: https://CompanyServerName/webapi/

  3. Clique em Salvar.

  4. Selecione Conectar credencial.

  5. No menu suspenso Método de autenticação, selecione Nome de usuário e senha.

  6. No menu suspenso Credencial, selecione Criar nova credencial.

    • Nome da credencial: nome de sua escolha (por exemplo, Chaves da API do Server).

    • Cofre: selecione DCM.

    • Nome de usuário: insira sua chave de acesso à API encontrada no seu perfil do Gallery.

    • Senha: insira seu segredo de acesso à API encontrado no seu perfil do Gallery.

  7. Selecione Criar e vincular.

(Opcional) Criar bancos de dados de cache e saída de conexões do DCM

  1. Abra o DCM. No Designer, vá para Arquivo > Gerenciar conexões.

  2. Clique em + Novo e escolha o bloco MongoDB.

  3. No menu suspenso Tecnologia, selecione o banco de dados desejado e conclua a configuração da conexão.

(Opcional) Criar tabelas necessárias nos bancos de dados de saída

Execute os seguintes aplicativos para criar as tabelas necessárias nos bancos de dados de saída. Esta etapa é opcional com base na preferência. Também é opcional se o banco de dados de cache não estiver sendo usado ou se os dados não estiverem sendo enviados para tabelas de banco de dados. Se um deles for usado, execute o aplicativo correspondente.

  • Se você usar um banco de dados para armazenar em cache os pacotes de fluxo de trabalho baixados do Gallery, execute Criar tabelas de banco de dados de cache (aplicativo).

  • Se você usar um banco de dados para enviar os dados finais para tabelas, execute Criar tabelas de banco de dados de saída (aplicativo).

Executar o Relatório de uso do Alteryx Server

Siga estas etapas para executar o Relatório de uso do Server:

  1. Insira as credenciais criadas nas etapas anteriores:

    • Alteryx Gallery: conexão do DCM ao banco de dados do AlteryxGallery.

    • Alteryx Service: conexão do DCM ao banco de dados do AlteryxService.

    • Credenciais de API: conexão do DCM às credenciais de API do Server.

    • Filtrar trabalhos e resultados por data: restringe as consultas das tabelas "AS_Queue" (trabalhos) e "AS_Results" (mensagens de resultados) para que elas extraiam apenas até uma data especificada.

    • Usar banco de dados de fluxo de trabalho em cache (opcional): armazene em cache os downloads do pacote do aplicativo a partir das chamadas da API. Use essa opção se o Designer contiver muitos fluxos de trabalho, pois isso pode levar muito tempo para baixar em cada execução.

    • Saída para arquivo hyper do Tableau: defina onde você deseja fazer a saída do arquivo hyper do Tableau. Se esta for a primeira execução, deixe essa opção como padrão para testar a pasta de trabalho do Tableau.

    • Saída para tabelas do banco de dados (opcional): use a conexão do DCM para fazer a saída dos dados em tabelas separadas em seu próprio banco de dados.

    • Saída para arquivos separados (opcional):

      • (Opcional) Selecione um local (pasta) para salvar os arquivos separados. Vazio = pasta .\Output.

      • (Opcional) Insira o prefixo. Vazio = sem prefixo.

      • Escolha o tipo de arquivo (CSV ou YXDB).

  2. Execute o fluxo de trabalho.

  3. Navegue até a pasta fornecida para abrir a pasta de trabalho do Tableau e visualizar os dados. Se o arquivo hyper foi enviado para um local diferente, reconecte a fonte de dados no Tableau para ver seus dados.

Solução de problemas

Consulte esta seção para conhecer problemas comuns e etapas de solução de problemas.

Verificar as permissões

Em primeiro lugar, certifique-se de que as permissões corretas estejam definidas na IU do Alteryx Server para baixar fluxos de trabalho:

  • No Server, vá para Painel do administrador > Configurações > Ativos: certifique-se de que a opção Desabilitar download direto não esteja selecionada.

  • Os usuários devem ter a caixa de seleção Outras pessoas podem baixar este fluxo de trabalho marcada nas configurações de cada fluxo de trabalho. Essa caixa de seleção está marcada por padrão, portanto, a menos que ela seja explicitamente desmarcada, o pacote do fluxo de trabalho deverá ter as permissões corretas.

  • O usuário que estiver executando o Relatório de uso do Server deve ter o acesso à API ativado para obter tokens de API.

Notas adicionais de solução de problemas

Consulte os erros comuns e as etapas de resolução sugeridas abaixo.

500 Resposta não encontrada

Consulte este Artigo da Comunidade.

Relatório de uso do Alteryx Server (8): PullServiceDetails (1483): Ferramenta nº 147: Erro interno: Tentativa de ler além do final de um blob.

Verifique as Configurações avançadas do DSN do ODBC. O tamanho da coluna binária deve ser 2147483647.

Relatório de uso do Alteryx Server (8): Falha ao extrair detalhes do fluxo de trabalho do Alteryx Server: HTTP/1.1 500 Erro interno do servidor

Verifique se o fluxo de trabalho está corrompido. Confirme se ele pode ser executado no Server.

Relatório de uso do Alteryx Server (8): Falha ao extrair detalhes do fluxo de trabalho do Alteryx Server: HTTP/1.1 403 Proibido

Verifique se o fluxo de trabalho pode ser baixado e se as configurações globais permitem que fluxos de trabalho sejam baixados. Em seguida, revise a configuração "Desabilitar download direto" em Administrador > Configurações do Server.

HTTP/1.1 404 ou HTTP/1.1 401 ou "RetrieveServerOAuthToken: O teste 'DownloadSucceeded' falhou"

Verifique se o baseURL da conexão do DCM é "http://localhost/webapi/" (observe o sufixo /webapi e "/" à direita, não use /Gallery/ aqui).

Confirme se a chave de acesso (nome de usuário) e o segredo de acesso (senha) da conexão do DCM estão corretos.

Verifique se o AlteryxService está em execução e se você pode acessar a documentação do Gallery ou do Swagger (API). Caso contrário, tente reiniciar o AlteryxService em "serviços".

Nesta secção: