Skip to main content

AlteryxRunModule

AlteryxRunModule AlteryxEngine API method is used to run a workflow. Returns 0 if an error occurs, non-zero when successful.

Important

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 runs the workflow in the same process as the calling application. In general, this provides better performance than the AlteryxRunModule_Pipe method because the AlteryxEngine is only instantiated one time.

Risks: If Alteryx encounters a problem it may cause the calling application to fail.

Method Declaration

int AlteryxRunModule( 
        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 method for progress of individual tools. Optional - can be NULL. See TCallbackToolProgress for more information.

  • pCallbackMessage: A callback method 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(strModule, NULL, pCallbackMessage, 0);
In this section: