alteryx / alteryx-tool-generator

Generator to scaffold a custom Alteryx Designer tool.

Alteryx Tool Generator

Overview

The Alteryx Tool Generator scaffolds a custom Alteryx Designer tool using the HTML GUI SDK and either the Javascript or Alteryx macro engine.

To use, run the main Node script and answer the prompts to write the needed files.

Features

• Program: Tool generation script
• Output: Alteryx Designer compatible tool

Getting Started

• Install the generator using the command line
  1. Clone or download the tool generator repository: alteryx/alteryx-tool-generator
  2. Navigate to the directory housing package.json
  3. Use npm install
• Run the generator
  1. Use node alteryx-tool-generator.js to create your new tool
• Access the written tool files
  1. Navigate to the tool directory: C:\Users\%USERNAME%\AppData\Roaming\Alteryx\Tools

Docs

• The Alteryx HTML GUI SDK help page
• Engine Works Blog Post

Version Support

Technology	Version
Alteryx	11.5
node	6.9.1
npm	3.10.8

Contribute

Contributions, questions, and comments are welcome and encouraged. To contribute code, submit a pull request. To report website-related issues, file a report using the Alteryx Tool Generator issue tracker.

License

• MIT License
• Alteryx Copyright 2017

alteryx-tool-generator's Issues

Alteryx unresponsive

I was able to generate a tool that uses javascript and contains 1 input connection. However, Alteryx becomes unresponsive when a simple file is connected to the generated tool through the 'Input Data' tool. Any idea what this could be? I'm using Alteryx 2018.4.

TypeError when trying to use tool to create first test

I downloaded today:
Latest LTS Version: 10.16.0 (includes npm 6.9.0)

But my first run hit an error:

C:\Users\ah57473\Documents\~Alteryx\alteryx-tool-generator-master\app\get-install-location.js:18
    const installDir = (items.find(findInstallDir)).value
                                                    ^

TypeError: Cannot read property 'value' of undefined
    at regKey.values (C:\Users\ah57473\Documents\~Alteryx\alteryx-tool-generator-master\app\get-install-location.js:18:53)
    at ChildProcess.<anonymous> (C:\Users\ah57473\Documents\~Alteryx\alteryx-tool-generator-master\node_modules\winreg\lib\registry.js:492:7)
    at ChildProcess.emit (events.js:198:13)
    at maybeClose (internal/child_process.js:982:16)
    at Socket.stream.socket.on (internal/child_process.js:389:11)
    at Socket.emit (events.js:198:13)
    at Pipe._handle.close (net.js:606:12)