Preparing to run the Alteryx collector
Important
This collector is available in Private Preview. If you would like access to this collector, please contact your Customer Success Director.
Setting up pre-requisites for running the collector
Make sure that the machine from where you are running the collector meets the following hardware and software requirements.
Item | Requirement |
|---|---|
Hardware (for on-premise runs only) Note: The following specs are based upon running one collector process at a time. Please adjust the hardware if you are running multiple collectors at the same time. | |
RAM | 8 GB |
CPU | 2 Ghz processor |
Software (for on-premise runs only) | |
Docker | Click here to get Docker. |
data.world specific objects (for both cloud and on-premise runs) | |
Dataset | You must have a ddw-catalogs dataset set up to hold your catalog files when you are done running the collector. If you are using Catalog Toolkit , follow these instructions to prepare the datasets for collectors. |
Network connection | |
Allowlist IPs and domains | |
Setting up permissions for Alteryx collector
Required permissions
For more details on user roles and permissions, please refer to the Alteryx User Roles and Permissions page.
You need to have specific roles to access the following resources:
To harvest collections, schedules and connections, you should have a curator role.
To harvest workflows, its node details and related jobs, you should have a minimum of any of the following permissions:
Viewer role (ensure workflows are made public).
Member role (the workflow should be shared with users via collection).
Enabling API Access
Detailed documentation for enabling users to access and authenticate to API is available at the Server API Configuration and Authorization page.
Work with your Alteryx administrator to enable API access:
Go to the Server admin interface. Click the Users tab.
On the Users tab, locate the user who needs API access.
From the Role dropdown, select the appropriate role to access the APIs.
In the Name field, click the user name.
Move to the Permissions section. Click Edit.
Select the API Access checkbox. API access has been successfully configured.
Authenticating to API
To authenticate to API:
Go to your Profile page.
From the Keys section, note down the API Access Key and API Access Secret.
Use the API key and secret credentials to run the collector.