Skip to main content

YXI Packaging and Installation

Important

This Python SDK uses outdated technology that limits your extension opportunities. We've built a new Platform SDK using Python and the latest open-source technology to deliver a vastly improved development experience. Go to Platform SDK to get started!

Packaging

A modified process for packaging and installing Python tools is available to accommodate Python virtual environments and third-party library dependencies.

If your Python tool does not use a virtual environment or third-party libraries, complete the process outlined in Package a Tool.

If your tool uses a virtual environment or third-party libraries, complete the following steps to package your tool and its dependencies.

  1. Verify that you have setup a Python Virtual Environment and Dependencies.

  2. Run a pip freeze command from the Python virtual environment's \Scripts path.

    • C:\ProgramData\Alteryx\Tools\ExamplePythonSDKTool\Scripts>pip freeze > ..\requirements.txt

    • Verify that the resulting text file only contains libraries that are used in the tool.

  3. Create a temporary working folder: C:\temp\ExamplePythonSDKTool.

    Note

    Copy Exclusions

    Do not copy any virtual environment files or folders, including:

    • pyvenv.cfg

    • pip-selfcheck.json

    • \include

    • \Lib

    • \Scripts

  4. Copy all files that will be included in the YXI file, including the requirements file, into the temporary folder.

  5. Copy the ToolNameConfig.xml file from the tool sub folder to the root of the temporary tool directory.

  6. Rename ToolNameConfig.xml to Config.xml, and open the file.

  7. Verify that the file is configured correctly and that all quotes are removed from the elements.

<Properties>
        <MetaInfo>
                <Icon></Icon>
                <ToolVersion></ToolVersion>
                <Author></Author>
                <Name></Name>
                <CategoryName></CategoryName>
                <Description></Description>
                <SearchTags></SearchTags>
        </MetaInfo>
</Properties>

  1. Compress the contents of the temporary working folder into a zip file.

  2. Rename the .zip file to a .yxi file.

  3. Verify the conversion by double-clicking on the yxi file. Designer should show a tool installer window for your tool.

Installation

To begin the installation process...

  • Verify you have an active internet connection.

  • Double-click the .yxi file.

  • Open Designer and select Open Workflow from the File menu to browse to the .yxi file.

If installing as an Administrator, the option to install for all users is available. On the tool installer window, select Install to complete the installation process.

Troubleshooting

If you receive an error during the installation process, there might be 2 issues.

  1. The files might not exist.

  2. You might need to enable Windows long paths.

Follow these steps:

  1. Open the Registry Editor (regedit.exe)

  2. Go to HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet\Control\FileSystem.

  3. Right-click on the key, and Export for backup.

  4. Change value LongPathsEnabled from 0 to 1.

  5. Re-install the YXI again. You should not need to restart.

Build-Your-Own-Tool Checklist

In this section: