Skip to main content

About 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.

The Alteryx collector harvests metadata from Alteryx Server which includes information on connections, schedules, collections, workflows, their nodes and jobs.

Note

The latest version of the Collector is 2.245. To view the release notes for this version and all previous versions, please go here.

What is cataloged

The collector catalogs the following information.

Table 1.

Object

Information cataloged

Workflow

ID, Name, Created At, Created By, Upload Source, Upload Date, Package Workflow Type, Is Public, Is Ready For Migration, Execution Mode, Version ID, Has Private Data Exemption, Others May Download, Is History Viewable, Is Executable, Worker Tag, District Tag, Is AMP, Version List

Connection

ID, Name, Type, Owner, Connection String, Created At, Updated At

Credential

ID, Name, Type, Username, Password Expires On, Parameters

Collection

ID, Name, Owned By, Created At

Schedule

ID, Name, Created At, Is Enabled, Owned By, Priority, Worker Tag, Last Run Time, State, Frequency, Iteration Start Time, Iteration End Time, Modified At, Modified By

Workflow Node

  • ID, Type, Configuration XML

  • For fields with expressions: Expression, Field Name, Field Type, Field Size, Regex, Copy Unmatched, Replace Expression, New Field Name, Error On Unmatch, Action, Concat Start Expression, Concat End Expression, Concat Separator, Loop Expression, Initial Expression

Workflow Job

ID, Created At, Priority, Worker Tag, Run With E2, Status, Disposition, Messages, Output



Relationships between objects

By default, the data.world catalog includes catalog pages for the following resource types. Each catalog page has a relationship to the other related resource types. Note that the catalog presentation and relationships are fully configurable, so these will list the default configuration.

Table 2.

Resource page

Relationship

Workflow

  • Contains Workflow Node

  • Is contained in Collection

  • Is scheduled by Schedule

  • Is associated with Workflow Job

Connection

  • Connects to a data resource

  • Uses Credential

Credential

  • Used by Connection

Schedule

  • Schedules Workflow

Collection

  • Contains Workflow

  • Contains Schedule

Workflow Node

  • Contained within a Workflow

Workflow Job

  • Is associated with Workflow



Authentication supported

  • The Alteryx collector supports OAuth 2.0 authentication. It requires a Client ID and Client secret for successful access.

  • For detailed instructions on enabling users to access the API and authenticate, please refer to the Alteryx Server API Configuration and Authorization.