We are in the final days to enter our Data and Analytics - "What's your why?" raffle with SparkED!

Reply with your "why" in text/video format to our forum post by January 28 to be entered! 

Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!

Acquire the name of the tool category using the API

5 - Atom

We are using the API to get the category of the tool, however, we are only getting List of Nodes. For getting Tool Category, we are using below highlighted property, but it is giving Technical class name like DbFileInput, DbFileOutput, etc.. If you open the same workflow file from UI, It shows Proper user friendly name in tool tip.




How can we get user friendly name from API?


    Sub GetInformationofNodes(ByVal strFile As String)

        Dim strEngineEntryPoint As String

        Dim objDoc As AlteryxDocument.Document


        objDoc = New AlteryxDocument.Document(strFile)


        For Each objNode As NodeBase In objDoc.GetAllNodes


            If TypeOf objNode Is AlteryxDocument.ToolNode Then

                Dim objToolNode As AlteryxDocument.ToolNode = DirectCast(objNode, AlteryxDocument.ToolNode)

                strEngineEntryPoint = objToolNode.EngineEntryPoint

            End If



    End Sub


Any help is really appreciated.

13 - Pulsar

hey @CIMCONSoftware 

Its a bit of a pain - but if you are doing this programmatically, you might want to create a lookup table of the tools - and then use a find/replace tool to change the name of the tool.
For instance - a lookup table of:

Tool NameFriendly Tool Name
DbFileInputInput Data
DbFileOutputOutput Data

Hope this helps at all,

5 - Atom

Thank you for your response @TheOC. It does clarify that the API won't give the category/Friendly Tool Name, correct me if I'm wrong. 


Do you know if there is a ready list of such items that lists out all the Tool Names and their Friendly Tool Names, somewhere on Alteryx's community docs that can be used? Building this list manually won't really be a practical option as there are a lot of tools that are available for use.


Also, how can we submit this as a suggestion to Alteryx's development team so that they can add this attribute as part of the result of the API call?