topic Find length of scheduled workflow in the API in Alteryx Server Discussions

Find length of scheduled workflow in the API

jsprh — Tue, 21 May 2024 14:31:45 GMT

I've been implementing an alteryx monitoring tool for my team, but have struggled to figure out how to find the length of time it takes for a schedule to be run.

Before using Alteryx Server I could easily do it using the log files, but have yet to find it in the different API endpoints.

Anyone able to help?

Thanks in advance!

Re: Find length of scheduled workflow in the API

fmvizcaino — Tue, 21 May 2024 17:45:40 GMT

Hi @jsprh ,

You can connect to the Alteryx back-end and access the collection AS_Queue. https://help.alteryx.com/20231/en/server/configure/mongodb-management/mongodb-schema-reference/alteryxservice-mongodb-schema.html#idm46021311437200

To simplify, the calculation will be:

CompletionDateTime - CreationDateTime

Be aware that this is also considering the time the workflow was waiting on the Queue to run. The correct calculation would be:

CompletionDateTime - CreationDateTime + QueueTime

However, this QueueTime is only accessible by decrypting the __ServiceData column, which is not straightforward. If your server doesn`t have performance issues, you will probably not have any queue time.

Even though the Alteryx Server Usage Report is deprecated, it already has most of the Back-end data prep and parsing that you can leverage to build this report.

https://help.alteryx.com/20221/en/server/install/install-the-server-usage-report.html#install-the-server-usage-report

Best,

Fernando Vizcaino

Re: Find length of scheduled workflow in the API

Yongcan — Tue, 28 May 2024 03:53:00 GMT

Just comment on @fmvizcaino 's post.

As we are on 2023.2 and notice ExecutionStartTime field already part of AS_Result collection and __ServiceData is removed.

https://help.alteryx.com/20232/en/server/configure/mongodb-management/mongodb-schema-reference/alteryxservice-mongodb-schema.html#idm46091068373568

Hence Queue Time is:

ExecutionStartTime - CreationDateTime

Actual Run Time is:

CompletionDateTime - ExecutionStartTime

Add a chart for easy reading

Re: Find length of scheduled workflow in the API

fmvizcaino — Tue, 28 May 2024 04:12:13 GMT

Thank you, @Yongcan .

I was sure they had removed the servicedata but couldn't find the field anywhere, and I ended up convincing myself I was crazy 😅 I guess I was in the wrong version.

Thank you so much for such a detailed response!

Best,

Fernando

Re: Find length of scheduled workflow in the API

Yongcan — Thu, 30 May 2024 01:55:49 GMT

We are not actively upgrade on each server release, just happen to see this change. Grade it's helping the community,

I learnt a lot here and your "Alteryx Server Series" videos, appreciated.