Skip to main content

Server Automation Tracking Report

Use the Server Automation Tracking Report (SATR) to obtain total automation credits used on Alteryx Server (versions 24.2 and below). This utility is only necessary when your account is on the new Alteryx One pricing and packaging, while Server runs on a version older than 25.1. Connect to your MongoDB or MSSQL server to extract the execution data for your Server. The packaged workflow includes several setup options that cater to various scenarios, ranging from daily to quarterly execution.

Unpack SATR and Install Dependencies

Step 1: Unpack the SATR Packaged Workflow

  1. Download Server Automation Tracking Report_vX.X.X.yxzp from the Alteryx Marketplace.

  2. Double-click the YXZP file to unpack and open the workflow in Alteryx Designer.

  3. Once open, the workflow has several disabled containers. Choose the container that best fits your needs and enable it. If you're unsure, start with the enabled container as the default.

Step 2: Install Simba Driver for MongoDB

  1. Download the Simba Driver from the Alteryx License Portal.

  2. Scroll to the bottom of the Product Downloads section and select Download to the right of the Drivers entry.

  3. Select MongoDB from the version list and select Next.

  4. Select Download to the right of the Simba MongoDB 2.04.3.1003 64-bit entry. The version in the portal can differ. That is expected.

  5. Double-click the MSI file to install the driver on your machine. The driver will now be accessible in the ODBC administrator utility.

Step 3a (Uses MongoDB as Backend): Create DCM Connections for MongoDB

Since the tables accessed have a simple structure, the MongoDB Quick Connect option is effective. There is no need to set up a DSN entry, as it doesn’t require accessing nested structures to run correctly.

  1. Open Data Connection Manager (DCM). In Designer, go to File > Manage Connections.

  2. On the Data Sources tab, select + New and choose the MongoDB tile.

  3. From the Technology dropdown, select MongoDB ODBC Quick Connect with Simba.

    1. Data Source Name: Enter the Mongo AlteryxService data source name you wish to use.

    2. Server: Enter the MongoDB server name for AlteryxService. If setting this up on an Alteryx Server using embedded Mongo, you can use localhost.

    3. Port: Enter the port for the MongoDB. The default used for embedded Mongo is 27018.

    4. Database: Enter AlteryxService.

    5. Driver: Use the default value Simba MongoDB ODBC Driver.

  4. Select Save, then Connect Credential.

  5. Fill in these fields:

    • Authentication Method: MongoDB Username and Password

    • Credential: Create New Credential

    • Credential Name: Name of your choice (for example, MongoDB_AlteryxService_Local).

    • Vault: DCM

    • Username: Your username (the default for the embedded database is "user”).

    • Password: Your password.

    • Authentication Mechanism: SCRAM-SHA-256

    • Authentication Source: AlteryxService

    • Allow connection for SDK: Unchecked

  6. Select Test Connection. If successful, select Create and Link.

  7. Repeat these steps for the AlteryxGallery database.

Step 3b (Uses MSSQL as Backend): Create DCM Connections for MSSQL

  1. Open DCM. In Designer, go to File > Manage Connections.

  2. On the Data Sources tab, select + New and choose the Microsoft SQL Server tile.

  3. From the Technology dropdown, select Microsoft SQL Server ODBC DSN-less.

    1. Data Source Name: Enter the MSSQL AlteryxService data source name you wish to use.

    2. Driver: Use the default value ODBC Driver 17 for SQL Server.

    3. Server: Enter the MSSQL server name for AlteryxService.

    4. Database: Enter AlteryxService.

  4. Select Save, then Connect Credential.

  5. Fill in these fields (adjust for your Server’s credential types):

    1. Method: Username and Password

    2. Credential Name: Name of your choice (for example, MSSQL_AlteryxService_Local).

    3. Vault: DCM

    4. Username: Your username.

    5. Password: Your password.

  6. Select Test Connection. If successful, select Create and Link.

  7. Repeat these steps for the AlteryxGallery database.

Run Server Automation Tracking Report

  1. In the PullServerExecutions macro, enter the credentials created in the previous steps and choose applicable options.

    1. Select either MongoDB or MSSQL backend.

      1. Alteryx Gallery: DCM Connection to the AlteryxGallery database.

      2. Alteryx Service: DCM Connection to the AlteryxService database.

    2. Filter Executions by Date: Restricts the AS_Queue (Jobs) and AS_Results (Results Messages) table queries to only pull back to a specified date.

      • Filter by date range (radio button):

        • Start Date: Select the date to start pulling data (inclusive of the date selected).

        • End Date: Select the date to end pulling data (inclusive of the date selected).

      • Filter by relative date (radio button):

        • Filter by last: Select the number of days/months to pull back from the current run date.

        • Units: Select Days or Months.

        • Exclude Current Period: Option to exclude the current Day or Month, depending on the Unit selected above.

  2. In the SummarizeAutomationUsage macro, select from the available options.

    • Include Cost Center Rollup: To roll up automation counts by cost center, connect a lookup table to the optional input anchor that contains the user email and the corresponding cost center. Map the fields using the 2 dropdowns.

    • Include Email Rollup: Select the checkbox to generate a summary table that ranks the total number of automation runs per user by email.

    • Choose output file path: Choose a full file path to output the report to. The default is a file called “AutomationSummary.pdf” written to the %temp% folder.

  3. Run the workflow.

  4. Check the results window for links to the temporary PDF file created in the SummarizeAutomationUsage macro.

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.

En esta sección: