Alteryx Server Knowledge Base
Definitive answers from Server experts.Search Gallery Workflows for Connections, Files, Queries, Tools and More
Search Gallery Workflows for Connections, Files, Queries, Tools and More
This workflow downloads all workflows from a Server to a local machine using the V1 API endpoint /webapi/admin/v1/workflows and the V3 API Pack, then parses through the XML to search for a specified term (such as tools used, database connections, DSNs, queries, versions, etc.).
Prerequisites
- Alteryx Server
- Version 2021.4+
- Alteryx Server API Key/Secret
- API Permissions
- Curator Role
Procedure
This workflow expands on a community post, "ServerRipper - Using the Alteryx Gallery API to download workflows en masse". With this workflow, Server admins can download all workflows from the Gallery (backing up all workflows at once), and search through the XML of each workflow for any term. This is useful when an admin would like to see which workflows are using a particular DSN connection, connector, workflow version, SMTP server, query, database, and more.How to Configure and Run:
Be sure to install the V3 API Pack, if you haven't already.
Download here: https://community.alteryx.com/t5/Engine-Works/Introducing-the-Alteryx-Server-v3-API/ba-p/899228
1. Once the V3 API Pack is installed, download the attached file, SearchServerWorkflowXml_OAuth2.yxzp (or SearchServerWorkflowXml_OAuth1.yxzp). OAuth 1.0 is for pre-2021.4 Servers, and OAuth2.0 is for Server version 2021.4+.
2. Ignore the import errors on the .bat files, as they will not affect the ability to run.
3. Click into the workflow Canvas.
4. In the Workflow- Configuration pane, click the "Workflow" tab.
image.png5. In the "Constants" section, edit the value of the GalleryBaseURL to your Server URL (NOTE: must not include "/gallery" at the end).
6. Also in the "Constants" section, edit the value of the SaveTo constant to a location where all Server workflows can be saved. Ensure there is enough space in this location.
7. Configure the first tool (API Authentication Macro with #5 comment) to include your Web API address, API Key, and API Secret. This is found in the "My Profile" section of the Server UI.
8. Input a term to search for within the XML of the workflows in the Text Input Tool (replace the word "Query").
image.png9. Run the workflow.
10. Check the boxes of "subscriptionName" and "metaInfo_name" if any errors occur on the Data Cleansing Tool, or if there are any Windows file errors.
How to Know What to Search
Look at the XML of a similar workflow to one you're looking for. Is there any pattern specific to what you're searching for? Here are a few examples:- "Query" - Returns all workflows with database queries.
- "<AlteryxDocument yxmdVer="2022.1">" - Returns all workflows with version 2022.1.
- "DSN=SQL Test" - Returns all workflows using the data source named SQL Test.
- "Plugin="SharePointInput"" - Returns all workflows that contain the SharePoint Input Tool.
- "FileName.xlsx" - Returns all workflows that reference FileName.xlsx, either on Input or Output.
Common Issues
"401 Unauthorized"- Was the API Key and Secret input into the first tool? Is the API user an admin? Do they have curator rights?
"Error: Server API Authenticate (79): Tool #47: Parse Error at char(1): Type mismatch. Number provided where a string is required. (Expression #1)"
- Ensure the Web API URL is input in the first tool.
"Formula (60): Parse Error at char(62): Unknown variable "id" (Expression #1)"
- Ensure the Web API URL in the first tool has the right base address, matching the workflow constant "GalleryBaseURL". Also remove "/gallery" from the GalleryBaseURL Workflow Constant, if present.
"Error transferring data: [URL]: Failure when receiving data from the peer"
- The root cause of this error is currently investigated (TCPE-539), but may be related to proxies using a PAC script. A few potential workarounds are:
- Throttle the records in the Download Tool.
- Use Fiddler while decrypting HTTPS traffic (Tools > Options > HTTPS > Check "Decrypt HTTPS traffic" in Fiddler).
- Configure the proxy to send http requests to 127.0.0.1 on port 8888.
Additional Resources
Took at the peek at the OAuth v2 version today.
Had some workflow dependency issues with may or may not be a problem, but I'm wondering if there's a typo in the Run Command tool.
I suspect at the 'Command' value is missing a \ ?
Right right, some user feedback for you @London !
Having some issues getting past the first tool here.
We're trying to run the workflow on the Alteryx Server Machine, but we're getting a 401 Unauthorized error in the download tool of the 'Server API Authenticate' macro.
It looks like we have the macro configuration set up and the workflow constants set up and we're using the API Access Key and API Access Secret from the user's Gallery profile:
We cracked open the macro to manually input the values into the Text Input, whacked a Browse tool onto the end of the Download tool, and got the full return message which doesn't give a ton of insight:
Any thoughts on if we might be missing something obvious here?
Progress.
@csh8428 If you click the output anchor of the first Download tool, what does the DownloadHeaders field say? If it's anything other than "HTTP/1.1 200 OK", it may not have downloaded the workflow information correctly. In this case, I would re-input the authentication information, and ensure you are a Curator in your environment. Additionally, the DownloadData field should have values in it (at first glance it looks like it contains only a bracket "[", but if you double-click the value and expand the results pane, you can see more lines of data:
A couple of other areas to check:
Do you have API permissions granted to your subscription?
Does your User profile have API enabled?
Your admin should be able to check these permissions.
