Alteryx Workflow execution from Command Prompt : Need Urgent Help

Hi Team

We are implementing a workflow in Alteryx tool to perform few operations ( To remove special characters) in a file and the return the data to another file post operations.

We have implemented a regular workflow to perform this and its running well.

However,we need this workflow to be called from cmd prompt.

We have came across an article about this from :https://help.alteryx.com/10.1/index.htm#Command_Line.htm?Highlight=AlteryxEngineCmd

With the guidelines mentioned , we are able to succeed and we used below line from cmd prompt :

cmd > AlteryxEngineCmd.exe regexp.yxmd

Kindly help us with the details on implementing an alteryx workflow which accepts a file as parameter as we need to pass input file dynamically to the workflow.

Example: cmd > AlteryxEngineCmd.exe workflowname.yxwz testfile.csv

We appreciate your quick help on this.

Yashtest.yxwz

Developer Tools

Accepted answers

JordanB

Hi @ynijapuram001

You will need to turn that workflow into an analytic app and use an interface tool to pass through a value to the input tool.

In the article referenced it explains how to do this:

AlteryxEngineCmd.exe MyAnalyticApp.yxwz AppValues.xml

This runs an Analytic App (.yxwz) and uses the parameters in the AppValues.xml to dynamically configure the Analytic App. The easiest way to build the AppValues.xml file is to build a fully functioning Analytic App in the Alteryx GUI, open the Interface Designer window (View>>Interface Designer), click Test View, and click View. The xml in the pop up window can be copied (using CTRL-C) and pasted into a text editor and then saved as an .xml file.

Example of AppValues.xml:

AlteryxEngineCmd.exe AppValues.xml

This is identical to the option above except instead of having the *.yxwz and the *.xml parameters, simply specify the *.xml parameter and ensure that the *.yxwz reference is embedded in the *.xml.

Example of AppValues.xml in this case:

<Module>MyAnalyticApp.yxwz</Module> <Value name="FILEINPUT">TEST.CSV</Value> </WizardValues>

Best,

Jordan Barker

Solutions Consultant

PaulN

Hi @ynijapuram001,

I have attached a basic example for your consideration.

File MyAnalyticApp.xml contains both app name and parameter:

<WizardValues>
<Module>CommandLineApp.yxwz</Module>
<Value name="FileName">test.csv</Value>
</WizardValues>

FileName is the name of the tool which is going to use value test.csv.

Result (creation of result.csv):

Kind regards,

Paul Noirel

Customer Support Engineer

test.csv

Hi @ynijapuram001,

Your screenshot -shared offline- shows the issue:

AlteryxEngineCmd will look for the value name mentioned in the xml file. Current error is caused by tool being named "File Browse (6)" instead of "Fileinput".

If you rename your File Browse tool to Fileinput, then your test will work:

New result - following change above:

Kind regards,

Paul Noirel

Customer Support Engineer

PaulN

Hi @ynijapuram001,

Action tool was not configured in the workflow you sent me.

Once fixed (with value name and file browse name set to "File Browse (6)") it is now working:

Kind regards,

Paul Noirel

Customer Support Engineer

All comments

JordanB

Hi @ynijapuram001

You will need to turn that workflow into an analytic app and use an interface tool to pass through a value to the input tool.

In the article referenced it explains how to do this:

AlteryxEngineCmd.exe MyAnalyticApp.yxwz AppValues.xml

Example of AppValues.xml:

AlteryxEngineCmd.exe AppValues.xml

This is identical to the option above except instead of having the *.yxwz and the *.xml parameters, simply specify the *.xml parameter and ensure that the *.yxwz reference is embedded in the *.xml.

Example of AppValues.xml in this case:

<Module>MyAnalyticApp.yxwz</Module> <Value name="FILEINPUT">TEST.CSV</Value> </WizardValues>

Best,

Jordan Barker

Solutions Consultant

ynijapuram001

Thanks Jordan.

I tried to implement as per suggested.

In the first attempt , I used FTSTeam.xlsx file in .xml file and its
content is as shown below:

MyAnalyticApp.yxwz
name="FILEINPUT">C:\Users\ynijapuram001\Desktop\FTSTeam.xlsx

In second attempt , I changed input file to FTS.xlsx and ran the command. I
can see the workflow is still considering the file we gave in 1st attempt.

MyAnalyticApp.yxwz
name="FILEINPUT">C:\Users\ynijapuram001\Desktop\FTS.xlsx

Kindly suggest.

Regards
Yashwanth

PaulN

Hi @ynijapuram001,

I have attached a basic example for your consideration.

File MyAnalyticApp.xml contains both app name and parameter:

<WizardValues>
<Module>CommandLineApp.yxwz</Module>
<Value name="FileName">test.csv</Value>
</WizardValues>

FileName is the name of the tool which is going to use value test.csv.

Result (creation of result.csv):

Kind regards,

Paul Noirel

Customer Support Engineer

test.csv

I tried creating 2 appvalues.xml files with content as shown below in which
each file pointed to each different file.

However , when tried to run workflow from cmd prompt, irrespective of the
file name given in .xml file , workflow is getting executed as per the
initial design in the workflow.

*.xml file content:*

File-1:

C:\Users\ynijapuram001\Desktop\Yashtest.yxwz
C:\Users\ynijapuram001\Desktop\*FTS.xlsx*

command : C:\Program Files\Alteryx\bin>AlteryxEngineCmd.exe
C:\Users\ynijapuram001\Desktop\Yashtest.yxwz C:\Users\ynijapuram001\Desktop\
*AppValuess.xml*

File-2:

C:\Users\ynijapuram001\Desktop\Yashtest.yxwz
C:\Users\ynijapuram001\Desktop\*FTSTeam.xlsx*

command : C:\Program Files\Alteryx\bin>AlteryxEngineCmd.exe
C:\Users\ynijapuram001\Desktop\Yashtest.yxwz C:\Users\ynijapuram001\Desktop\
*AppValuess2.xml*

Screen shot of execution of two different .xml files where the data is
operating from only FTS.xlsx file in both the scenarios is attached.

--
Regards
Yashwanth

hberg

I read this and the solution looks fine, however parameters requires an Analytic workflow.

If you do not want an analytic workflow, then I have a (somewhat clunky) workaround as follows:

Determine a temporary location and fixed filename where the input file may be stored.
Alter your workflow to read that fixed filename
Immediately prior to launching the workflow, copy/rename the original source file into that temporary location

Now your workflow will run using that "dynamic" file.

There are drawbacks such as, the extra time to copy the file, the extra storage for the 2nd copy, the potential security exposure of having another copy, but it will work.

praneshsapmm

Hi @ynijapuram001 ,

How could you manage to run the workflow with cmd line .

I have designer license , will that be enough to execute or any additional set up is needed.

Thanks

praneshsapmm

Hi @ynijapuram001 @hberg @JordanB

Iam trying to execute workflow using command line , but i receive below error .

Error - Alteryx Engine: The Feature "API or FlowChartMode" is not licensed.
Finished in 2.640 seconds with 1 error

Do you know what is missing here . I have designer license .

Thanks.

hberg

The documentation and advice from forum entries mention that the program named AlteryxEngineCmd.exe can be used to launch a workflow from the command line.

re: I have designer license . Do you know what is missing here?

You need a Server or Scheduler license. My understanding (I am not a licensing expert, so it may not be accurate) is that this program does not operate with the designer license alone. You can find other responses with the same message (for example: "How we create a .exe or BAT file in Alteryx to run via cmd line.")

FYI: When I was first evaluating Alteryx, I was able to get this to work (thus the reason I could provide an answer where you found my name). But then I had been provided an evaluation key that included this functionality. After I got my first real Designer license key, this functionality continued to work. However, immediately after I performed a product upgrade, I was then no longer able run the program AlteryxEngineCmd.exe.

Quick Links

This months top contributors

atcodedog05 19458

Qiu 15866

binu_acs 15708

MarqueeCrew 13708

apathetichell 13703