Workspace Execution Environment Customization
Use environment customization to add custom resources, such as database drivers, connectors, and Alteryx tools, to Alteryx One. The platform installs these resources on Workspace Execution nodes so workflows can use them when running Designer Desktop workflows on Alteryx One.
You can upload these resource types:
Microsoft Installer (MSI) packages
Alteryx package (YXI) files
Supported Resource Types
MSI Packages
MSI packages are Windows installer files that install software components, such as database drivers.
MSI packages support:
Installation Status Tracking
Installation Details and Error Reporting
Version Detection and Display
Installation Parameters through an Associated Configuration File
Some MSI installations require installation parameters. When parameters are required, admins can enter parameters and values in the UI. The MSI uses these parameters during driver installation.
YXI Packages
YXI packages are Alteryx package files that contain custom tools and related files.
YXI packages support:
Installation Status Tracking
Installation Details and Error Reporting
The platform doesn’t display version information for YXI packages because version metadata isn’t consistently available across package types.
Upload Resources
To customize a Workspace Execution environment, upload a supported MSI or YXI package to Alteryx One used for environment customization.
After you upload a package, the platform distributes the package to Workspace Execution nodes and installs it automatically.
The package status shows whether installation completed successfully.
Installation Status
After you upload a resource, the platform tracks its installation status.
The user interface displays only these statuses: Pending, Installed, and Failed.
Pending: The resource uploaded successfully, and the platform recorded any required installation parameters. The resource isn’t installed on a Workspace Execution node yet.
For resources with a Pending status, the upload timestamp is displayed. No additional installation details are shown.
Installed: The resource installed successfully on a Workspace Execution node and is available for workflow execution.
For resources with an Installed status, these details are displayed:
The timestamp of the most recent successful installation.
A confirmation message that installation completed successfully.
Failed: The resource installation failed. Error details are available to help with troubleshooting.
For resources with a Failed status, these details are displayed:
The timestamp of the most recent installation failure.
The installation error message.
Installation Events
The Workspace Execution page displays only the most recent installation result for a resource.
Historical installation events, retries, and Workspace Execution node lifecycle events aren’t displayed.
The displayed status and installation details reflect the latest known installation outcome.
Resource Information by Type
The information displayed for a resource depends on its type.
Information | MSI | YXI |
|---|---|---|
Installation Status | Yes | Yes |
Installation Details | Yes | Yes |
Version Information | Yes | No |
For MSI packages, the platform extracts version information from the installer and displays it when available.
For YXI packages, version information isn’t displayed.
Troubleshoot Failed Installations
If a resource has a Failed status:
Expand the resource entry.
Review the installation error message.
Verify that the uploaded package is supported and compatible with Workspace Execution.
Confirm that you provided any required installation parameters.
Upload the package again if needed.
If the problem continues, provide the installation error message from the resource details to Alteryx Support.
Note
Account Admins can audit installed environment customization resources across workspaces from the Admin Console, including resources with failed installations.
Limitations
Administrators can upload only MSI and YXI resources.
The platform generates and manages configuration files associated with MSI installations.
The user interface displays only the most recent installation result.
Historical installation logs aren’t currently available for download.