AlteryxEngine API Methods

Version:
Current
Last modified: June 10, 2020

Use the AlteryxEngine API methods for interacting with workflows. For example, you can change the configuration of the engine before running a workflow, run a workflow, or query the currently installed version of Alteryx.

Methods

The collection of AlteryxEngine API methods is shown below:

Method Description Documentation

AlteryxAllowDesktopInteraction

Used to tell Alteryx whether or not to display dialog boxes and choices to the user. Default: false.

AlteryxAllowDesktopInteraction

AlteryxGetUserSettingsPath Returns the path of the current user's settings file. AlteryxGetUserSettingsPath
AlteryxGetVersion Returns the currently installed version of Alteryx as a string. AlteryxGetVersion
AlteryxRunModule Used to run a workflow in the same process and memory space as the calling application to increase performance over using AlteryxRunModule_Pipe. AlteryxRunModule
AlteryxRunModule_Pipe Used to run a workflow in a separate process and memory space from the calling application. AlteryxRunModule_Pipe
AlteryxRunModule2 Used to run a workflow in the same process and memory space as the calling application to increase performance over AlteryxRunModule_Pipe2. AlteryxRunModule2
AlteryxRunModule_Pipe2 Used to run a workflow in a separate process and memory space from the calling application. AlteryxRunModule_Pipe2
AlteryxRunWizard Used to run a wizard in the same process and memory space as the calling application to increase performance over using AlteryxRunWizard_Pipe. AlteryxRunWizard
AlteryxRunWizard_Pipe Used to run a wizard in a separate process and memory space from the calling application. AlteryxRunWizard_Pipe
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.