We are celebrating the 10-year anniversary of the Alteryx Community! Learn more and join in on the fun here.
Start Free Trial

Alteryx Designer Desktop Discussions

Find answers, ask questions, and share expertise about Alteryx Designer Desktop and Intelligence Suite.

API Documentations for Alteryx Exceptions & Methods

daryoush-mz
5 - Atom

Hi,

I've been using the Designer for the past 5 weeks.  I have got a fair bit of background in procedural and some object-Oriented (Java) paradigm of programming.

 

I have come across performance 'issues' with regards to some of the methods in Alteryx, specifically 'STRING' method 'REGEX_MATCH()' method, as well as very obscure runtime errors that required me to seek a more experienced Alteryx Expert colleague to tell me what the error message was indicating.  These have been very frustrating moments in upskilling in Alteryx.

 

My question is this....

Where can I get the API documentation for various runtime exceptions and methods used by Alteryx, so that one could use the right method to suit the data and / or be empowered to  interpret error messages more independently- rather than relying on what's already been encountered and talked about online?  For example, Java/Python offer details of the method signatures as well as exceptions they could throw.

 

(Alteryx must be looking at 'something' to throw a runtime exception, albeit a very vague one that needs looking it up in various online programming forums to decipher it).

 

In summary, can i expect Alteryx to give me the same API documentation support as major object oriented programming languages; as briefly outlined above?  If not, is that coming up anytime soon?

 

Thank you for your help.

 

5 REPLIES 5
Jean-Balteryx
16 - Nebula
16 - Nebula

Hi @daryoush-mz ,

 

Are you looking for this kind of documentation : https://help.alteryx.com/developer-help/apis ?

daryoush-mz
5 - Atom

Hi Jean,

Thanks for the quick reply.

'No', i am after something like this: Overview (Java Platform SE 7 ) (oracle.com).

 

Really, a set of documentation that would tell me how best to design my workflow to get the fastest performance, and if something goes wrong in the execution, i'd be able to either catch it later, using a similar concept as 'Try {..} and Catch{..}' block, so i'd gracefully either exit or simply know what has happened.

Oracle is another good example where they provide detailed documentation for their constructs and runtime or compile errors.

 

The exception for the tools are great and easy to understand, though.

 

Hope it makes sense. 

Thanks.

Jean-Balteryx
16 - Nebula
16 - Nebula

I'm not aware of a documentation of this type. Maybe someone else will be able to provide you with a better answer !

apathetichell
20 - Arcturus

Not sure about the API/Platform overview but could your specific Regex_Match issues be related to Perl vs Java? Alteryx uses PERL regex.

daryoush-mz
5 - Atom

No, it's a posix regex.  The same syntax worked fine in another part of the workflow; with the regex being less complex.

In shot, if a method has limitations, can I see that it in any API document?  For example, could it cause an 'out of memory' exception.

 

Regex_match() was just an example.

Labels
Top Solution Authors