1 2 3 4 Previous Next 52 Replies Latest reply on Feb 14, 2019 8:08 AM by Guo Wei Ma

Regular Expression (Regex) AR API Filter Plug-in (v4.1)

Yudi Maryanto Jan 14, 2015 3:50 AM

Share This:

In Remedy, we often have difficulties when we want to validate user input, replace and split a string based on certain pattern, or even extract token from a string that matches a pattern. For instance, we often want to validate whether an email address is typed correctly, or whether a phone number is comply with our specific format. When we want to validate user input, we must create some filters to parse user input and check it against our desired rules. Unfortunately, that is not an easy task. Building complicated validation using Remedy filter is tedious and complicated task.

The things get even more complicated when, say, we want to process an incoming email in Remedy. Have you ever imagine how to split email subject based on colon character or how to get phone numbers that are buried somewhere inside the email body?

Actually, there is a technique that simplifies those activities. That is using regular expression. Unfortunately, there is no built in regular expression functionality in Remedy.

This API filter plug-in tries to address those problems. Using this filter plug-in, we can validate user input using regular expression, split a string based on certain separator, or extract token from a string.

Version History

Version 4.1

Counting occurrence of a pattern

Version 4.0

Capturing groups

Version 3.0.1

Small revisions in this documentation

Version 3.0

String replacement

Version 2.0

Split a string
Extract token from a string

Version 1.0

String validation using regular expression

--- My disscussions ---

AR System - HTTP Integration Part I (inbound)

Regular Expression (Regex) AR API Filter Plug-in

Create Simple Command Line Console Using AR System

1. Regular Expression (Regex) AR API Filter Plug-in

Vincent Riedweg May 4, 2011 2:21 AM (in response to Yudi Maryanto)

Hi,

Good job

Did you test this plugin with AR System 7.6.04? Now in 7.6.04, the arplugin process runs in 64 bits and that's not the case in the version 7.5 described in your documentation.

Vincent.
Like Show 0 Likes(0)

Actions
2. Regular Expression (Regex) AR API Filter Plug-in

Yudi Maryanto May 4, 2011 2:27 AM (in response to Vincent Riedweg)

Hi vriedweg,

I have not tested it on ARS 7.6.04. But since this plugin uses java (no native libraries are included in this plugin distribution), I think It should work seamlessly.

Or could you please test it on your ARS 7.6.04 on 64 bit machine and share the result here?
Like Show 0 Likes(0)

Actions
3. Regular Expression (Regex) AR API Filter Plug-in

Vincent Riedweg May 4, 2011 2:30 AM (in response to Yudi Maryanto)

Hi,

Sure, I will test it on a 64bits 7.6.04 installation as soon as I have enough time.

I'll keep you informed.

Vincent.
Like Show 0 Likes(0)

Actions
4. Regular Expression (Regex) AR API Filter Plug-in

Abhijit NameToUpdate Jul 25, 2011 9:28 AM (in response to Yudi Maryanto)

Hi Yudi,

I have tested this on windows 2008 and ARS 7.6.03.

This is working fine.

Thanks for sharing such a nice plugin.

Thanks and regards,
Abhijit Khewale
Like Show 0 Likes(0)

Actions
5. Regular Expression (Regex) AR API Filter Plug-in

Yudi Maryanto Jul 25, 2011 9:31 AM (in response to Abhijit NameToUpdate)

Hi Abhijit,

thank you for your effort testing the plugin. Nice to hear that it works on ARS 7.6.03. I hope it will broaden the people that can take benefit of this plugin.

Best Regard
Like Show 1 Likes(1)

Actions
6. Regular Expression (Regex) AR API Filter Plug-in

Sergey Klevtsov Jul 27, 2011 3:59 AM (in response to Yudi Maryanto)

Hi Yudi,

thanks for the plugin, good job!

If you're accepting wishes for future versions, here's one: add regexp-based substitution/replacement, as in perl 's/<regex>/<subst>/g' construct. This would be the most-welcomed feature

Sergey
Like Show 0 Likes(0)

Actions
7. Regular Expression (Regex) AR API Filter Plug-in

Yudi Maryanto Jul 27, 2011 4:06 AM (in response to Sergey Klevtsov)

Hi Sergey,

Thank you for your suggestion. That's really a great idea. I will inform here when the feature is available
Like Show 0 Likes(0)

Actions
8. Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Yudi Maryanto Aug 7, 2011 5:11 AM (in response to Yudi Maryanto)

Hi All,

Based on Sergey's wish, I have updated the Regex plug-in. Now it supports string substitution. Hope that this will make you take more benefit from this plugin.

Thank you Sergey. Anyone who has any idea to improve this plug-in, kindly write your wishes here
Like Show 1 Likes(1)

Actions
9. Re: Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Jose Huerta Aug 3, 2012 7:36 PM (in response to Yudi Maryanto)

Hi,

I tried to install it on ARS 7.5. I followed your instructions, but when trying to access the plugin I get the error:

The specified plug-in does not exist. :
MII.ARF.REGEXVALID (ARERR 8755)

I activated the plugin log, and don't see anything extrange.

Could you tell me where to start to solve the problem?

Thanks!
Like Show 0 Likes(0)

Actions
10. Re: Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Yudi Maryanto Aug 3, 2012 8:56 PM (in response to Jose Huerta)

Hi Jose,

1. Make sure that your <AR System Installation>/pluginsvr/pluginsvr_config.xml file contains MII.ARF.REGEXVALID configuration like this:
<plugin>
      <name>MII.ARF.REGEXVALID</name>
      <classname>id.co.mii.filterplugin.RegexFilterPlugin</classname>
      <pathelement type="location">C:/Program Files/BMC Software/ARSystem/pluginsvr/regexfilterapi-3.0.jar</pathelement>
</plugin>

2. Make sure that your ar.cfg (or ar.conf) file contains MII.ARF.REGEXVALID configuration like this
Server-Plugin-Alias: MII.ARF.REGEXVALID MII.ARF.REGEXVALID <your arserver name>:9999

3. After you modify these values, restart arplugin. If you don't know how to restart arplugin, just restart the arsystem service.
Like Show 0 Likes(0)

Actions
11. Re: Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Jose Huerta Aug 4, 2012 4:00 AM (in response to Yudi Maryanto)

Well,

Here is the jar file location at the server:
Here is how I modified the pluginsvr_config.xml file:
And here is how I changed the ar.cfg file
This is the filter action that makes the plugin call:

And this is the error when executing this filter:
Thanks.
Like Show 1 Likes(1)

Actions
12. Re: Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Yudi Maryanto Aug 4, 2012 5:33 AM (in response to Jose Huerta)

Hi Jose,

first of all, your jar location file is "C:/BMCSoftware/ARSystem/pluginsvr/regexfilterapi-3.0.jar" but you write it in your pluginsvr_config.xml file as "C:/BMC Software/ARSystem/pluginsvr/regexfilterapi-3.0.jar". So, remove the space in "BMC Software".

I notice that in your pluignsvr_config.xml, you write (with space after dot)

id.co.mii.filterplugin. SplitRegexFilterPlugin
id.co.mii.filterplugin. ExtractRegexFilterPlugin
id.co.mii.filterplugin. ReplaceRegexFilterPlugin

It must not contain any spaces. It must be

id.co.mii.filterplugin.SplitRegexFilterPlugin
id.co.mii.filterplugin.ExtractRegexFilterPlugin
id.co.mii.filterplugin.ReplaceRegexFilterPlugin

Note: there are some errors in the documentation. I checked the documentation of this plugin and it contains spaces as well. I will revise the documentation and reupload it.

Modify your pluginsvr_config.xml file accordingly then don't forget to restart the arplugin.
1 of 1 people found this helpful
Like Show 1 Likes(1)

Actions
13. Re: Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Jose Huerta Aug 6, 2012 3:37 AM (in response to Yudi Maryanto)

Hi Yudi,

Solved!

That was the error. Changed the files, restarted the service and it's now running. Thank you for this valuable contribution.

I'm creating a def file so the call to the filter api is made using a service wich can be easier to many people (including me), and also can unitarily test the functionality or the regular expression used.

Also I will publish this plug in and the def file on my blog, citing you (if you don't have any inconvenience).

Regards,

Jose Huerta
http://theremedyforit.com/
Like Show 0 Likes(0)

Actions
14. Re: Regular Expression (Regex) AR API Filter Plug-in (v3.0)

Yudi Maryanto Aug 6, 2012 4:04 AM (in response to Jose Huerta)

Hi Jose,

Thanks for your contribution. Sure, you can publish this plugin on your blog. That's the power of communities. Our contributions will make ordinary product become good and good product become great.
Like Show 0 Likes(0)

Actions