Skip to main content

Relatório de rastreamento de automação do Server

Use o Relatório de rastreamento de automação do Server (SATR) para obter o total de créditos de automação usados no Alteryx Server (versões 24.2 e anteriores). Esse utilitário só é necessário quando sua conta está com os novos preços e pacotes do Alteryx One, enquanto o Server está em execução em uma versão anterior à 25.1. Conecte-se ao servidor do MongoDB ou MSSQL para extrair os dados de execução do Server. O fluxo de trabalho empacotado inclui várias opções de configuração que atendem a vários cenários, desde execução diária até trimestral.

Desempacotar o SATR e instalar as dependências

Etapa 1: desempacote o fluxo de trabalho empacotado do SATR

  1. Baixe Server Automation Tracking Report_vX.X.X.yxzp.

  2. Clique duas vezes no arquivo YXZP para desempacotar e abra o fluxo de trabalho no Designer.

  3. Uma vez aberto, o fluxo de trabalho tem vários contêineres desabilitados. Escolha o contêiner que melhor se adapta às suas necessidades e o habilite. Se você não tiver certeza, comece com o contêiner habilitado como padrão.

Etapa 2: instale 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.04.3.1003 de 64 bits. A versão no portal pode ser diferente. Isso é bom e esperado.

  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.

Etapa 3a (usa o MongoDB como back-end): crie conexões do DCM para o MongoDB

Como as tabelas acessadas têm uma estrutura simples, a opção "Conexão rápida do MongoDB" será eficaz. Não há necessidade de configurar uma entrada DSN, pois ela não requer o acesso a estruturas aninhadas para ser executada corretamente.

  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 Conexão rápida ODBC do MongoDB com Simba.

    1. Nome da fonte de dados: insira o nome da fonte de dados do AlteryxService do Mongo que você deseja usar.

    2. Server: insira o nome do servidor do MongoDB para o AlteryxService. Se estiver configurando isso em um Alteryx Server usando o Mongo integrado, você pode usar localhost.

    3. Porta: insira a porta do MongoDB. O padrão usado para o Mongo integrado é 27018.

    4. Banco de dados: insira AlteryxService.

    5. Driver: use o valor padrão Simba MongoDB ODBC Driver.

  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: seu nome de usuário (o padrão para o banco de dados do integrado é "user").

    • 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.

Etapa 3b (usa MSSQL como back-end): crie conexões do DCM para MSSQL

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

  2. Na guia Fontes de dados, selecione + Novo e escolha o bloco Microsoft SQL Server.

  3. No menu suspenso Tecnologia, selecione ODBC do Microsoft SQL Server sem DSN.

    1. Nome da fonte de dados: insira o nome da fonte de dados do AlteryxService do MSSQL que você deseja usar.

    2. Driver: use o valor padrão ODBC Driver 17 for SQL Server.

    3. Server: insira o nome do servidor do MSSQL para o AlteryxService.

    4. Banco de dados: insira AlteryxService.

  4. Selecione Salvar e Conectar credencial.

  5. Preencha estes campos (ajuste para seus tipos de credencial do Server):

    1. Método: o nome de usuário e a senha

    2. Nome da credencial: nome de sua escolha (por exemplo, MSSQL_AlteryxService_Local).

    3. Cofre: DCM

    4. Nome de usuário: seu nome de usuário.

    5. Senha: sua senha.

  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.

Executar o Relatório de rastreamento de automação do Server

  1. Na macro PullServerExecutions, insira as credenciais criadas nas etapas anteriores e escolha as opções aplicáveis.

    1. Selecione o back-end do MongoDB ou MSSQL.

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

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

    2. Filtrar execuções 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.

      • Filtrar por intervalo de datas (botão de opção):

        • Data de início: selecione a data para começar a extrair dados (incluindo a data selecionada).

        • Data de término: selecione a data para encerrar a extração dos dados (incluindo a data selecionada).

      • Filtrar por data relativa (botão de opção):

        • Filtrar por últimos: selecione o número de dias/meses de extração a partir da data de execução atual.

        • Unidades: selecione "Dias" ou "Meses".

        • Excluir período atual: opção para excluir o dia ou mês atual, dependendo da unidade selecionada acima.

  2. Na macro SummarizeAutomationUsage, selecione uma das opções disponíveis.

    • Incluir resumo do centro de custo: para resumir contagens de automação por centro de custo, conecte uma tabela de consulta à âncora de entrada opcional que contém o e-mail do usuário e o centro de custo correspondente. Mapeie os campos usando os dois menus suspensos.

    • Incluir resumo do e-mail: marque a caixa para gerar uma tabela de resumo que classifica o número total de execuções de automação por usuário por e-mail.

    • Escolher caminho do arquivo de saída: escolha um caminho completo do arquivo para o qual o relatório será enviado. O padrão é um arquivo chamado "AutomationSummary.pdf", gravado na pasta "%temp%".

  3. Execute o fluxo de trabalho.

  4. Verifique a janela de resultados para obter links para o arquivo PDF temporário criado na macro SummarizeAutomationUsage.

FAQ

1.

What is the Server Automation Tracking Report (SATR)?

SATR is a lightweight workflow utility for Alteryx Server versions 24.1 and 24.2. It provides visibility into your automation usage, allowing you to share usage statistics with Account Executives (AEs) for billing and compliance purposes. It's intended as a temporary solution for customers who have not yet upgraded to version 25.1 or newer.

2.

Why is the SATR needed?

Many customers are unable to upgrade immediately due to IT policies or the timing of their upgrade cycle. SATR provides the necessary visibility for contract renewals and compliance. It serves as a stopgap until customers can move to 25.1 or newer, which has native reporting.

3.

Who needs to use SATR?

SATR is required for customers who run supported versions of Alteryx Server lower than 25.1 (24.1 and 24.2) while under an Alteryx One contract.

SATR is not required for...

  • Customers on Alteryx Server 25.1 and newer versions: Telemetry is already reported to the cloud platform.

  • Customers who are not under an Alteryx One contract.

4.

What does SATR do?

SATR...

  • Connects to the Alteryx Server MongoDB database.

  • Counts daily automated runs and total runs within a user-specified date range.

  • Aggregates results into monthly summaries.

  • Outputs:

    • PDF Report: Monthly automated run totals and customer account details.

    • YXDB File: Daily automated and total run counts, with server info and timestamps.

5.

What data is collected while running the macros?

Execution records are retrieved from the AS_Queue and AS_Results tables to determine relevant attributes, such as the type of run and whether any errors were encountered. This helps identify if the run counts toward an automation credit. The Users table is pulled to append emails to the execution records. This allows the user to later break down automation credits by cost center or by user.

No data leaves the environment while the workflow is running. The summary files need to be manually transferred to the relevant Account Executive for reporting credit usage.

6.

How do I use the SATR if I have multiple server controllers?

Each macro can pull data from a single controller’s back-end database. You can use multiple macros in a single workflow to pull data from 2 or more controllers, provided those databases are accessible from the machine that runs the workflow. To generate reports, run the macro for each Server controller and submit separate reports. If you want a combined view, manual consolidation is required.

7.

Will the SATR integrate with Alteryx One Usage Service?

No. The SATR is a standalone, customer-managed reporting tool. Automated ingestion into Alteryx One Usage Service is not planned. If automated ingestion is required, please update to Alteryx Server 25.1 or newer.

8.

Does the SATR track cloud executions (for example, Cloud Execution for Desktop, Plans)?

No. The SATR only reports on local Server automated executions. For a complete view of automation credits used, combine SATR results with any execution data found in the Alteryx One portal.

9.

What if my organization purges its database for data hygiene?

If the back-end database is regularly purged of results and queue logs, you should run the workflow more frequently to capture daily logs and store them in a separate database. These logs can then be summarized for total usage reporting later with the report macro.

10.

How do I download and install the SATR?

  • Distributed as an Enterprise Utility (YXZP) via the Alteryx Marketplace.

  • SATR is set up and scheduled by the Server Admin.

  • Documentation and installation guides are available on this help page.

11.

I’ve run the report. What do I do now?

Contact your Account Executive to determine the best way to transfer the report that best satisfies your agreement.

12.

Will the SATR Automation Credits be reflected in the Account Admin console after submitting the report to my AE?

No. The SATR output submitted is only noted in the account and is not integrated into the Alteryx One platform. Total Automation Credits in the Admin console will be under-reported until Servers are updated to 25.1 or newer.

Nesta secção: