Alteryx Designer Desktop Knowledge Base
Definitive answers from Designer Desktop experts.YXI - Understanding the installation process for Python-based tools
Question
With the introduction of Python SDK, Alteryx Designersupports the installation of YXI files for Python-based tools. What happens during the installation process for one of these tools?
Answer
Note:The following is based on 2018.4. Each command is assumed to be prefixed with %ALTERYXDIR%\bin\Miniconda3\python.exe.
Example: C:\Program Files\Alteryx\bin\Miniconda3\python.exe -m venv c:\temp\my_tool
General Process after running a YXI file
1. The contents of the YXI fileare uncompressed(unzipped) in%DESTINATION_PATH%(seeTools Location). Please note thatmultiple tools could be installed with a single YXI.
2.A Python environment is created for the tool.
-m venv %DESTINATION_PATH%
Note: Following this step, the tool folder shouldhave the following structure:
If any of these components are missing, the tool is not installed correctly.
3.pip (the Python package manager) is upgraded in the Python environment.
-m pip install --upgrade pip
4.setuptools(a library for Python package support)is upgraded in the Python environment.
-m pip install --upgrade setuptools
5.Any tool dependencies are installed in the Python environment.
-m pip install --disable-pip-version-check -r requirements.txt --log PythonDependencyInstall.log
Errors and Cancellation
Tool folder will be deleted if:
- user cancels the installation
- an error occurs and user click on OK
Logs
FilePythonDependencyInstall.log contains the logs for tool installation
By default, tools are installed under:
%APPDATA%\Alteryx\Tools (ex: C:\users\My_Account\AppData\Roaming\Alteryx\Tools) for current user
%PROGRAMDATA%\Alteryx\Tools (ex: C:\ProgramData\Alteryx\Tools) for all users
Example of use case:
Following is only provided as an example.Should you face an error during the installation of one of the tools, please contact Alteryx Customer Support (support@alteryx.com).
Imagine that want to investigate the following error message during the installation ofazure_data_lake_input_v1.0.2.yxi.
Asthe installation window only returns the last error message, you may need to dig further.
Byproceeding with a manual installation, you can obtain more details.
The process is as follows:
1. Renameazure_data_lake_v1.0.2.yxi toazure_data_lake_v1.0.2.zip and uncompress folderazure_data_lake_input_v1.0.2to C:\users\%Your_Account%\AppData\Roaming\Alteryx\Tools\azure_data_lake_input_v1.0.2 (%Your_Account% should match your Windows login)
2. Open a command prompt (cmd.exe)
3.Create the Python environment for the tool (based on default path):
C:\Program Files\Alteryx\bin\Miniconda3\python.exe -m venv C:\users\%Your_Account%\AppData\Roaming\Alteryx\Tools\azure_data_lake_input_v1.0.2
4.Change to tool folder and proceed with package updates and dependency installations:
cd C:\users\%Your_Account%\AppData\Roaming\Alteryx\Tools\azure_data_lake_input_v1.0.2
Scripts\python.exe -m pip install --upgrade pip Scripts\python.exe -m pip install --upgrade setuptools Scripts\python.exe -m pip install --disable-pip-version-check -r requirements.txt --log PythonDependencyInstall.log
In this particular example your trace showed the following error:
This message indicates there was a problem confirming the SSL certificate from pypi. It is a clue regarding the cause of the issue and its solution.
This specific issue can be fixed with the following steps:
- Create Filepip.ini(case is important) under%APPDATA%\pip(exampleC:\Users\my_account\AppData\Roaming\pipwheremy_accountis the Windows login).
pipfolder will have to be created if it does not already exist. - Openpip.iniand add the following content:
[global]
trusted-host = pypi.python.org
pypi.org
files.pythonhosted.org
3. Install tool again
My thinking is this has something to do with a firewall. Do you know where I can find an offline connector?
