Engines Parity Utility

Version:
2022.3
Last modified: November 29, 2022

Engines Parity Utility is an easy way to compare the original and AMP engines. It allows you to run both in parallel, evaluate the results, and make decisions about which workflow you can confidently convert to AMP.

Parity Framework is a command-line tool. However, to make it easier, there is a macro that uses the Alteryx Run Command tool. So you can choose to:

  • Run Parity Framework via the command line with AlteryxEngineCmd.exe,
  • using engines parity macro,
  • run engines parity analytic app.

Using AlteryxEngineCmd.exe

You can compare workflows on AMP and the original Engine via AlteryxEngineCmd.exe with these parameters:

  • -testDir <path to workflow>
    This parameter is mandatory and should be first.
    Path to the folder with workflows or to a single YXMD file that you want to test.

  • -compareReport <path to CSV report file>
    CSV file name where you want to save the report.

  • -tempDir <path to intermediate files>
    Folder where intermediate files are saved. By default, it's the Alteryx temporary folder that is deleted after the run.

  • -compatibleMode <run AMP engine with/without Compatibility mode>
    Boolean parameter, "False" by default. If called with "True", AMP engine runs in compatibility mode to guarantee the same record order as the original Engine.

  • -recordLimit <set record limit for all inputs>
    Sets global record limit for input tools to reduce execution type. The default is 100,000. Set this value to 0 to disable.

  • -e1Filter <filter only workflows created with the original Engine>
    Boolean parameter, "False" by default. If called with "True", it filters workflows (from the folder) that were created for the Original Engine only.

All parameters are case insensitive and can be used with both '/' and '-' prefixes.

Examples

Basic Run

AlteryxEngineCmd.exe /testdir "D:/path/to/workflows" /comparereport "D:/report.csv"

Full Parameters

AlteryxEngineCmd.exe -testDir "D:/path/to/workflows" -compareReport "D:/report.csv" -tempDir "D:/temp" 
-compatibleMode true -recordLimit 5 -e1Filter true

Using Engines Parity Macro

Engines Parity macro is available starting from Designer version 22.3.

Another way of making workflow comparison is using Designer macro. Engines parity macro is not shipped with the Designer, you can download the Engines Parity.yxzp file from the Gallery.

Engines Parity.yxzp consists of the following files:

  • Engines Parity.yxmc - Engine Parity Macro.

  • Engines Parity.yxwz - Engine Parity Analytic App.

  • ReadFile.yxmc - supporting file for Macro and Analytic App and should be placed in the same directory with them.

  • RunCmdUniqueFiles.yxmc - supporting file for Macro and Analytic App and should be placed in the same directory with them.

To run the macro, in Designer right click on canvas, choose Insert > Macro > Engines Parity.yxmc. Now you can configure the macro.

Macro Configuration

  1. Specify the Directory with the workflows to run with both Engines in parallel.

  2. You can also set the path where you want the report to be generated. Otherwise, it's saved to the Alteryx temporary folder and deleted when you close Designer.
    Output Location

  3. Run AMP Engine with compatibility mode makes sure that the record order is the same with both the original and AMP engines. By default this checkbox is selected.

  4. Select the Filter only workflows built with the Original Engine checkbox to generate the reports only for workflows that were created to work with the original Engine.

  5. The global record limit is the max number of records that is used for comparison. If you don't want to specify a limit, set the number to 0.
    Record Limit

Using Engines Parity Analytic App

Engines Parity Analytic App is available starting from Designer version 22.3.

Engines Parity Analytic App is not shipped with the Designer, it is a part of the Engines Parity.yxzp file available for download from the Gallery.

To use Engines Parity Analytic App run the Engines Parity.yxwz file.

Analytic Path

Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.