Alteryx Server Ideas

Situation:

As your analytics work grows - you find yourself using the power of Alteryx to create shared macros.    These act as an accelerator for a team because one team member can us a reusable solution created by another team member.   For example - many teams need to get data out of JIRA (or some other system) so you create a connector that everyone can use.

That's going well - and now you have 20 teams all publishing canvasses to your server (possibly 100s of canvasses running in production) which make use of your JIRA connector - all good so-far!

Problem:

BUT THEN - you discover an issue with the JIRA connector and you need to fix it and publish a new version!

It's at this point that you realise that the canvasses on your server which use your JIRA connector are NOT pointing to it, but they have made a copy and included this inside their canvas.   So when you fix the problem with the JIRA connector - no-one gets the fix!

This is because every application uploaded to the server is a yxzp file, which zips up a COPY of all the shared macros and uses this in an isolated way.

So - in order to get the new JIRA connector (with the defect repaired) used instead of the old one you now need to:

- Download EVERY canvas on your server

- Unpack them all to expose the sub-macros being used

- Inspect them to see if they are actually an instance of the JIRA Macro

- Make a list of the owner and application IDs

- reach out by e-mail or phone to every one of these folk to ask them to republish their Alteryx workflow with your new version of the JIRA connector.

Proposal:

Please can we revisit this - we really do need the power of shared macros - and we also need the ability to fix and manage these like a product over time.   This will have an impact on the engine (hence copying @AdamR_AYX ) 

Desired end-state:

- When you build a canvas using a shared macro - it doesn't store the macro itself, but rather a reference to the version on the server - unless you explicitly decide to break the connection and take a copy.

- When you check this canvas into the server - your application / yxzp does NOT include a copy of the shared macro - instead it has a reference link

- this means that Alteryx Server can now track which canvasses use this shared macro very simply

- When I fix this shared macro - I can then do an in-place update; or if the interface is not the same (i.e. different inputs or outputs) then this has to be a new version and the users will stay pointing to version 1.

This is how shared assets are managed in a micro-service world, which is the way that all of our architecture is going - and it seems important that we build this thinking into the Alteryx infrastructure too.

@AdamR_AYX ; @Treyson ; @SteveA @DerekK ; @BlytheE 

Given the need for administrators to be able to perform analysis and monitoring on server performance; user usage etc - it is necessary to provide full documentation for both the API and the database underlying the server so that admins can use this to good effect.

Ref: https://community.alteryx.com/t5/Alteryx-Server-Discussions/Server-API-Download-packages-for-surveil...

Although very limited documentation is available on the server API (https://gallery.alteryx.com/api-docs) what we're looking for is a much more fully formed and navigable experience like some of the examples below.

• https://onlinehelp.tableau.com/current/server/en-us/data_dictionary.html
• https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api.htm%3FTocPath%3D___...
• https://community.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=commv2

This will make building helper processes substantially easier; as well as allow admins to fully manage their environment.

Many thanks

S

cc: @HeatherMHarris @revathi @AshwiniChezhiyan @LizaNemchynova

A nice to have is a connector for Microsoft Flow to trigger workflows.  With Microsoft Flow, users can automate processes, or set conditions that can trigger services across many different providers.  

Having the ability to use a Microsoft Flow can enable alteryx users to run workflows and feed in data that could be used by Microsoft Flow to feed into other processes. 

This would be a game changer for many users.

Hi

In a heavily used server environment, and depending on how workflows are deployed, it is possible to accumulate a vast number of "one off" workflows that could/should be deleted  as they would never be used again. In one of our environments we have over 1 million of these.

Currently we are manually deleting them 500 at a time but have asked if there is a way to script the delete process to make it more efficient. We have been told that to really delete a workflow you would need to touch at least 4 collections.

Can we have a Delete workflow API in one of the next releases in order to address this issue?

Thank you

Tom Diroff

My team currently uses the API to call a large number of workflows via a Python based scheduler process.  We use this currently by having ~10 users in a single subscription (Private Studio).  

All of the Private Studio sites on the Alteryx help state that they are going away in the near future to be replaced by individual studios and Shared Collections.  

From our testing, this would kill our processing as we cannot have an API for 1 Private Studio call workflows from a different private studio even if they have access through a shared collection.  

Are there plans to adjust the API endpoints in the future to better account for this?

Our IT department is looking to move to the Collections based structure now in preparation for the removal of the current Studio setup, so another question is when the structural update is planned to go into effect (which server version should we expect this?) so that we can get ready to account for this or if we can ask them to back off a little.

Thanks

There is a strong need for more APIs to be introduced in Alteryx Server so that our Admin teams can provide automated solutions to our users. My understanding is that a lot of these will be introduced into Alteryx Analytics Hub however, it is also needed in Alteryx Server.

I would propose that the internal APIs for Collections and Scheduler be exposed to the Admin Key/Secrets so that we can use these APIs to move our Users workflows directly to their collection or automatically schedule for them, if needed. It seems that all this would take would be to release the Authorization from internal to the Admin on the API.

APIs I am requesting be released:

• PUT .../gallery/api/collections/{collectionID}/apps/{appID}/
• POST .../gallery/api/scheduler/

I’ve had a query from a Team here at my organisation regarding OAuth2. They are trying to investigate whether a Robotic Process Automation Tool can be integrated with the Alteryx Gallery API.

It uses OAuth2 but my understanding is Alteryx Gallery uses OAuth1. 

Can Alteryx Gallery API be enhanced to use OAuth2? A plan to support OAuth2 authentication for a REST API in a future release?   

Our company has workflows where we use the Gallery API to kick off executions on server.  The user kicking off the workflow has setup API access using his account, but when he kicks off his jobs, it does not show up under his Gallery so he is unable to view the results.  In the admin panel, it shows the owner as (None) so it does not appear that workflows kicked off via the API get assigned to the user tied to the API key.

Conversations with Alteryx support revealed that these results are available via an API call, but not within the Gallery web UI.  It would be great if the user tied to the API key were added to the workflow execution so they could see results within the Gallery rather than going back through the API.  

Currently, in order to run an app via the API, you have to have uploaded the app to your private studio. Frankly, I don't find this function useful because you have to download then re-upload an app in order to gain access to the API. The API would be more useful if when an app is shared with you (or a collection is shared with you), then it would also allow for that app to be run via API by the user it was shared with. Right now, the only person who can run the app via API is the user who originally uploaded said app. 

Hi, 

I think it would be extremely useful to be able to trigger an Alteryx workflow using Power Automate. 

The main benefit I see at the moment is automatically triggering an Alteryx workflow when the input data has been refreshed.

This would also enable a Power App to be added directly to Power Bi which can simply be clicked to re-run an Alteryx workflow then refresh the Power Bi dataset. 

The publishing endpoint, a POST to api/admin/v1/workflows/, is useless whenever workflows, apps, or macros contain Gallery Data Connections.  The workflow will get published but valid Gallery Data Connections are ignored and the apps will not run.

Please add the same dependency checks against Gallery Data Connections as is performed when a workflow or app is manually published from Designer.

This might be considered a subset of the Idea Server API to extract / submit workflows.

Thank you for your consideration.
Sincerely,

David

Using current version of the server - you can see that there is no OAuth managed or published API endpoint for canvas delete (screenshot 1).   However this API does CLEARLY exist as you can see if you inspect what happens when you hit the delete button (screenshot 2 clearly shows the API being called - but it requires user login security token)

Please can you enable this API for OAuth - the API already exists, it just needs to be exposed with the others.

CC: @BlytheE 

We use the Server API to manage our server environment - and we recently noticed that the Workflows API (/admin/v1/workflows) ignores any canvasses after the 10 000'th submission.

For example:

• If we don't use any offsets or limits - then we get 10 000 applications
• If we use an offset of 5000 with a limit of 10000 - we get 5000 applications (i.e. anything after canvas 10 000 is being ignored)
• if we use an offset of 9990 with a limit of 100 - we get 10 rows returned (i.e. anything after canvas 10 000 being ignored)

By querying Mongo directly (appinfos collection) we know that we have 18 800 or so unique applications in our environment.

Please can you remove this cap from the API so that it can be used to query any number of canvasses on a larger environment?

cc: 

+  @Hemanth @marydest24 @Shreyasi @Sotoll @Kosi @revathi @Bethanyturner012  @TanyaS 

Currently, the API V3 endpoints does not have anything for Data Connection Manager (DCM). Create an endpoint to allow users to add/delete/update and list data sources, credentials, and users of DCM data sources. Also include an "admin" endpoint that can list all of the above for the entire server.

The admin screen of Alteryx gallery does not have an admin function for DCM sources, its users, and credentials. This can cause visibility issues during audits of the gallery. An API endpoint can alleviate this issue until it is added to the UI.

Hello,

We use external corporate scheduler and we would like to start scheduling Alteryx workflows in this way. However, collections don't have API which would simplify our way of running workflows which we are shared by the users. Are you planning to enable such feature?

Best,

Piotr Zawistowski

There are two key APIs that we use for extracting canvasses for governance & surveillance:

- the Workflows API which lists all canvasses on the server;

-  and the API call which returns a packaged version of the application by AppID

Unfortunately - when we query for all workflows to get the first list - there is no flag to indicate that a subset of these are actually deleted.   The result is that you need to make the second call to find this out which is wasteful.

Please add a "deleted" flag to the Workflows API so that we can identify which applications have been deleted without having to call the specific App ID post.

CC: @jalvarezv

We are taking an incremental feed of all server canvasses in order to look for patterns - however there is no option on the server admin APIs (the Workflow API specifically) that allow you to filter by date.

Please can you add to this API to allow API users to specify an upload/updated date filter and only take items after this date.

cc: @jalvarezv

We've confirmed with @KevinP that the Alteryx Gallery / Server API does not currently support downloading canvasses in unzipped data-stream format. (https://community.alteryx.com/t5/Alteryx-Server-Discussions/Server-API-Download-packages-for-surveil...)

Please can we add an API end-point that allows the following:

• Connect to the gallery and download a canvas; along with all of its sub-canvasses and helper macros. 
• Format required:
  • Plain XML (not zipped)
  • Provided in a data stream so that we can perform analytics and surveillance on this data
  • Fields required
    
    • Canvas filename
    • Application ID
    • Some unique ID per macro / sub-macro
    • XML for the canvas
    • Last run date
    • Last changed date
    • Environment (this is important once Server actually allows a Dev; UAT; Prod progression cycle - so we can see which environment people are in)
    • User details who uploaded
    • User details who are marked as the owners
    • Any other meta-tags on the canvas (important once server allows for meta-tagging of canvasses for categorisation)

Current API only allows this to be downloaded to a zipped file; which then needs to be unzipped; and then loaded back into a data stream.

Thank you

S

CC: @revathi @AshwiniChezhiyan @LizaNemchynova 

It might be helpful to be able to use an API to call and pass parameters to/from an Alteryx App or Workflow on an Alteryx Server.  Then a user could use a  browser or another application to call an Alteryx app/workflow.