AlteryxRunModule_Pipe

Last modified: July 08, 2021

AlteryxRunModule_Pipe AlteryxEngine API method is used to run a workflow in a separate process using separate memory space from the calling application. Returns 0 if an error occurs; non-zero when successful.

In server-side applications, use AlteryxRunModule_Pipe instead of AlteryxRunModule unless performance is a critical concern.

The AlteryxRunModule and AlteryxRunModule_Pipe methods are identical except the AlteryxRunModule_Pipe runs the workflow in a separate process from the calling application. This is useful when running in a server environment and will not cause the calling application to fail if Alteryx encounters a problem.

Risks: This method instantiates the Alteryx Engine each time a workflow is run. This can increase processing time.

Method Declaration

int AlteryxRunModule_Pipe( 
	const wchar_t* strXmlModule,
	TCallbackToolProgress pCallbackToolProgress,
	TCallbackMessage pCallbackMessage,
	__int64 userData
)

Properties

strXmlModule: A path to the workflow, or a string containing the full XML of the workflow to be run.
pCallbackToolProgress: A callback function for progress of individual tools. Optional - can be NULL. See TCallbackToolProgress for more information.
pCallbackMessage: A callback function for status messages. Optional - can be NULL. See TCallbackMessage for more information.
userData: User data that will be passed to the callback methods. Optional. Can be 0 if Callbacks are either NULL or do not access userData. See Alteryx Engine API Example for more detail on how to define a custom userData structure.

Example

AlteryxRunModule_Pipe(strModule, NULL, pCallbackMessage, 0);