Join the Alteryx Community’s Maveryx Summer Cup event! Compete, network with others, and earn your gold through a series of challenges from July 24th to August 11th. Learn more about the event here.

SDK Resources

Explore these resources to customize and extend the power of Alteryx with SDKs, APIs, and more.

Learn how to scaffold the basic Plugin Workspace.

Alteryx_IO_Team
Alteryx
Alteryx
Created

Create a Workspace

A Workspace is a directory that contains information about one or more SDK-produced plugins to be packaged into a single, deployable .yxi archive. A given Workspace contains an ayx_workspace.json file and all other necessary components to build plugins.

To create a Workspace, we first create a new, empty directory. Then, we run the sdk-workspace-init command inside that directory and fill out the prompts, which starts the workspace initialization process.

~$ mkdir MyWorkspace
~$ cd MyWorkspace
~/MyWorkspace$ ayx_plugin_cli sdk-workspace-init
Package Name: MyPackage
Tool Category [Python SDK Examples]: Python SDK Examples
Description []: My Package
Author []: Alteryx
Company []: Alteryx
Backend Language (python): python
[Workspace initialization] started
[Workspace initialization] .  Create configuration directory
[Workspace initialization] .  Create DCM Schemas directory
...omitted...
Created Alteryx workspace in directory: ~\MyWorskpace
Workspace settings can be modified in: ayx_workspace.json
[Generating config files] started
[Generating config files] .  generate_config_files:generate_config_xml
[Generating config files] Generating top level config XML file...
[Generating config files] finished

Next: Create a Plugin