Workflow XML Parser Tool
Use the Workflow XML Parser tool to extract workflow properties, tool configurations, and connection details.
Use the Workflow XML Parser tool to extract workflow properties, tool configurations, and connection details.
Marketplace Tool
This tool is not automatically installed with Alteryx Designer. To use this tool, download it from the Alteryx Marketplace.
Requirements and Compatibility Notes
The Workflow XML Parser tool is compatible with Designer and Server version 2022.1 and newer.
The tool is compatible with both Alteryx Multi-threaded Processing (AMP) and the original Engine.
Tool Components
The Workflow XML Parser tool has 4 anchors:
Input anchor: I input anchor: This anchor serves as the tool's input and should contain the target workflow XML in a single record.
Output anchors:
W (Workflows) output anchor: This anchor outputs your workflow properties. This includes all elements from the Properties and MetaInfo sections of the Workflow XML. Events, Constants, and RuntimeProperties are output as XML objects since many child elements can exist for each parent element.
T (Tools) output anchor: This anchor outputs your tool properties. The most common tool configuration elements are parsed and the full tool XML is provided for further analysis. Refer to the section below for details on what elements are parsed.
C (Connections) output anchor: This anchor outputs all connection details, including all origin and destinations along with the anchor names.
Configure the Tool
This tool requires the entire workflow XML to reside in a single cell (single column and single row) of your input data. To best achieve this, open files using the Blob Input tool to pull the yx* binaries into the workflows. Then, convert the workflow binaries to a string using the Blob Convert tool set to UTF-8.
Choose field that contains Workflow XML: Select the field (column) that contains the workflow XML string.
Workflow Output Fields
Field Name | Description | Menu Location | Menu Item | Corresponding Option | Values | Notes |
---|---|---|---|---|---|---|
| The version of Alteryx Designer that was used to modify the workflow last. | Auto Created* | Built-in | YYYY.X | ||
| Is the AMP engine enabled for the workflow? | Runtime | Use AMP Engine | T or Null | ||
| Full XML for the "Properties" section. | N/A | N/A | N/A | ||
| Specific Memory Amount defined by the user (in MBs). | Runtime | Memory Limit (MB) | Integer | ||
| True: Use Global Default, False: Use Specific Amount. | Runtime | Memory Limit Radio | True or False | ||
| The user-defined limit for all inputs (blank = no limit). | Runtime | Record Limit for All Inputs | Integer | ||
| A specific temp folder defined by the user. | Runtime | Use Specific Folder | Folder Path | ||
| True: Use Global Default, False: Use Specific Folder. | Runtime | Temporary Files Radion | True or False | ||
| The Annotations visibility setting. | Canvas | Annotations | True or False | ||
| Are Annotations displayed with the tool name? | Canvas | Annotations | True or False | ||
| Number of conversions to limit (0 = no limit). | Runtime | Maximum Errors per Location | Integer | ||
| Stop processing when the limit is reached. | Runtime | Checkbox | True or False | ||
| Cancel running the workflow on error. | Runtime | Checkbox | True or False | ||
| Disable all Browse tools. | Runtime | Checkbox | True or False | ||
| Enable Performance Profiling. | Runtime | Checkbox | True or False | ||
| Use AMP engine. | Runtime | Checkbox | True or False | ||
| Engine Compatibility Mode. | Runtime | Checkbox | True or Null | ||
| The code page to use for Predictive tools in the workflow. This setting overrides the selection in Language and Region User Settings. | Runtime | Dropdown | Code page values. | ||
| Disable all tools that write output. | Runtime | Checkbox | True or False | ||
| Show all macro messages. | Runtime | Checkbox | True or False | ||
| Determine what level of Connection Progress is shown (False = hide). | Canvas | Connection Progress | Dropdown | True or False | |
| Determine if connection progress is shown only while running. False = Show, True = Show only when running. | Canvas | Connection Progress | Dropdown | True or False | |
| The zoom value when opening the workflow. | Built-In | Built-In | Integer | ||
| The direction of the tool layout in the canvas. | Canvas | Layout Direction | Dropdown | Horizontal or Vertical | |
| Defines if the workflow is a template (YXTD). | Built-In | Built-In | True or False | ||
| Meta Info | Use File Name | Radio Button | True or False | ||
| Meta Info | Custom | Radio, Text Input | Text | ||
| The description of the workflow shown either in Server, on the App splash screen, or on hover in the Designer tool palette. | Meta Info | Description | Text Input | Text | |
| The root tool name that helps identify versions to group. | Meta Info | Root Tool Name | Text Input | Text | Macros Only |
| The version of the tool to use when multiple macros exist with the same RootToolName. | Meta Info | Tool Version | Text Input | Text | Macros Only |
| Identifies if the macro is an In-Database tool. | Meta Info | Tool In-Database? | Checkbox | True or False | Macros Only |
| The category where the macro can be found in the Designer tool palette. | Meta Info | Category Name | Text Input | Text | Macros Only |
| The keywords used to find the tool when searching. | Meta Info | Search Tags | Text Input | Text | Macros Only |
| The name of the workflow author. | Meta Info | Name | Text Input | Text | |
| The company of the workflow author. | Meta Info | Company | Text Input | Text | |
| The copyright information for the workflow. | Meta Info | Copyright | Text Input | Text | |
| The description link (used in the interface for apps and in the tool palette for macros). | Meta Info | URL | Text Input | Text | |
| The description link display text (used in the interface for apps and in the tool palette for macros). | Meta Info | Display Text (optional) | Text Input | Text | |
| The current workflow ID of the file. | Built-In | ||||
| The previous workflow ID of the file. | Built-In | ||||
| The initial workflow ID of the file. | Built-In | ||||
| The corresponding platform workflow ID. | Built-In | ||||
| The hyperlink text to display (for example, "Open Example"). | Manual XML Entry | ||||
| The file path for One Tool Example workflow. | Manual XML Entry | The example file path needs to be present in the | |||
| The full XML object for all Events. | |||||
| The full XML object for all Constants. | |||||
| The full XML object for all Runtime Properties. | |||||
| The full XML object for all MetaInfo for the workflow. |
Tool Output Fields
Avvertimento
Tools can have multiple rows if there are 2 or more of the elements parsed. This is common in the Formula tool along with tools that have multiple file connections.
Nota
Rows with ParentIds and null ToolIds are empty tool containers.
Field Name | Description | Relevant Tools |
---|---|---|
| The ToolID of the node. | All |
| The ToolIDs of upstream tools. Data originates from these tools and flows into the specified tool. | Any tool that is connected to an upstream tool. |
| The ToolIDs of downstream tools. Data originates from the specified tool and flows into these tools. | Any tool that connects downstream to another tool. |
| The Tool Container or Control Container ToolID in which the specified tool is located. | Only filled in when the tool is in a container. |
| The tool-specific EngineDll. | |
| The tool-specific EngineDllEntryPoint. | |
| The tool-specific macro path (only applicable for macros). | |
| The tool-specific Gui Plugin. | |
| The tool canvas horizontal location. | |
| The tool canvas vertical location. | |
| The tool width. | |
| The tool height. | |
| The full XML element for the tool properties. | |
| True and False settings for whether the Join tool is set to "Join by Record Position." | Join, Join Multiple |
| The full XML for annotations. | |
| The display mode of tool annotation (Canvas Settings, Always, Never). | |
| True or False for Manifest. | SDK Tools |
| The SDK language used. | SDK Tools |
| The stored directory for the SDK tool. | SDK Tools |
| The language-specific transport layer. | SDK Tools |
| The full XML for tool SDK settings. | SDK Tools |
| The tool XML (accessible in tool configuration). | |
| The full XML for tool-specific dependencies. | |
|
| |
| Formula Field Name | Formula Tool |
| Formula Field Size | Formula Tool |
| Formula Field Type | Formula Tool |
| Describes if the formula expression is enabled. | Formula Tool |
| Formula Expression | Dynamic Select, Filter, Formula, Multi-Field Formula, Multi-Row Formula |
Field Name | Description | Relevant Tools |
---|---|---|
| Formula Expression | Filter Tool |
| Simple filter field selected. | Filter Tool |
| Simple filter field operator. | Filter Tool |
| Simple filter operands. | Filter Tool |
| The default annotation text of a tool. | Any |
| The custom annotation text of a tool. | |
| True or False setting to determine if Jupyter is set to run in production mode. | Python Tool |
| The Python environment used for running the script. | Python Tool |
| The full XML for the vEnvName element. | Python Tool |
| The script run while the Python tool is in interactive mode. | Python Tool |
| The script run while the Python tool is in production mode. | Python Tool |
| The script run in the R tool. | R Tool |
| The full file path entered in the text box. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| Determines if the file name is output as a full path or only the file name. | |
| The numeric value for the file format. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| The option checked to Search Sub Directories for a file. | |
| The record limit for file input. | |
| The full XML for the file element. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| The record limit for file output. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| The table referenced as a part of the file input. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| In-DB Create Mode | In-DB |
| The full XML for In-DB Create Mode. | |
| The PreSQL statement run prior to executing a query. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| The PostSQL statement run after executing a query. | Dynamic Input, Input Data, Macro Input, Output Data, Run Command |
| The full XML for the R script element. | |
| The readable format name for file format referenced in | |
| The tool name as seen in Designer. | |
| The tool category as seen in Designer. | |
|
Connection Output Fields
Field Name | Description |
---|---|
| The tool ID at the beginning of the connection. |
| The anchor name at the beginning of the connection. |
| The tool ID at the end of the connection. |
| The anchor name at the end of the connection. |
| Connection Name |
| Is the connection wireless (True or False)? |