Skip to main content

Hello everyone 😊

I'm at my wits' end and could really use some help with something that feels like it should be obvious—but I just can’t get the hang of it.

I’m currently working with assyst24R2 and IPaaS 1.8, and I’ve come across the typeaheadFilter query parameter in AssystREST. I’m trying to understand its intended use case and how (or if) it can be used when datamapping in ETM.

My current use case is to return an array of all users whose shortCode starts with ZZ_, but I haven’t found a way to use flike] or dexclude] operators in datamapper fields, and i stumbled upon this query parameter in the search for this funcionality.

There doesn’t seem to be any documentation on the wiki regarding the typeaheadFilter parameter—no examples, no reference, or examples of it behaviour, the only thing i could find was it’s mention as a query parameter in the RAML, but that did not help.😅

 

From what I’ve gathered, it is the REST version/equivalent to Type Ahead Search in the GUI, as mentioned in Lookups_in_the_assyst_Portal, however there are no details about this assystREST equivalent, here or in any of the assystREST articles.

My assumption was that typeaheadFilter might support partial or fuzzy matching—e.g., entering TEST would return an array of users with shortCodes or name that contain TEST, like TEST1, Test Testerson etc. And when when used in a variable assyst search field the resulting array could be left as is for furhter datamapping, while when used in a Record to update-field this would have to be made a unique result by combinding with other parameters like $top, $skip, sortByName, etc.

However, during testing it appears to only return results on exact matches of either shortCode or name:

 

I’m struggling to understand what this parameter is meant to support, and if there is more functionality here thats simply locked behind me not having the complete understanding of the expected syntax. 

 

Is there some other piece of information regarding this paramter I’ve overlooked? 

Has anyone successfully used typeaheadFilter in a way that supports partial matching or broader filtering?

Any insights, examples, or clarification would be greatly appreciated!

Thank you very much for your time~ 😊

typeaheadFilter was added for the benefit of the GUI, but appears in ETM as it is advertised in the RAML. It doesn’t seem to be very useful for ETM without the ability to add dlike] (which the GUI is doing).

I can’t find an existing Idea for the ability to use ulike] and aexclude] via ETM. If you create the Idea then we can consider it for a future release.


typeaheadFilter was added for the benefit of the GUI, but appears in ETM as it is advertised in the RAML. It doesn’t seem to be very useful for ETM without the ability to add dlike] (which the GUI is doing).

I can’t find an existing Idea for the ability to use ulike] and aexclude] via ETM. If you create the Idea then we can consider it for a future release.

Hi, ​@Paul McCulloch 

Thank you very much for the explanation! 😊

The information that typeaheadFilter uses  like] in the GUI led me to test it as an option in the REST API, and this worked, and is such an interesting and powerful tool, I can’t wait to try using it some more.

 

I’d like to add what I’ve learned so far in case it can be of use for others.

At the end of making the ideas, I discovered it’s possible to use  like] with typeaheadFilter in ETM, but you have to use common.search() in a datamapper. While not as user fiendly, and less well presented feedback I was able to get this to work and get both shortCode and name searches to work using it:

common.search("assystUser",{"typeaheadFilterelike]":"ric"},e"role"]);

It’s also possible to make use of ™like] and exclude] in ETM, but again it’s not in a lookup datamapper field, and you have to use the less than ideal common.search() function:

common.search("contactUser",{"surnameplike]":"Elling","surnametexclude]":"Ellingsen"},"]);

 

I’ve taken the liberty of creating two ideas based on this question—one about the use of fuzzy search in datamappers, and the other about the use of inclusion and exclusion—as they seemed linked, but also separate pieces of functionality.

 

 

 

I’d love to hear if ayone else has tried using typeaheadFilter using common search or otherwise and to know if this is intended behaviour that datamappers can reliably be buildt upon . 


Reply