How to setup a Plugin Rule

[Belinda Frick]

In PABX3 version 3.3.3.0 or newer, there is a new screen that allows you to setup rules that get applied to the call record after the plugin has processed the data. These rules can be used to modify, fix or delete records.

Version 3.4.0.0 included the following new features:

The ACD data from PABX3 will now also be passed through the plugin rules allowing the group and number to be modified by the rules.The Group will be treated as an extension.
LONGER THAN: Check for strings longer than specified length.

A rule consists out of the following values:

• COLUMN: This is the call data filed that will be check and modified.
  At the moment only the Extension, Line, Number and IO are available here.
  
• CHECK METHOD: This is the type of check that will be performed of the COLUMN.
• CHECK VALUE: This is the value that will be searched for in the COLUMN.
  This can be a single or multiple characters. When multiple characters are use, the rule will only execute if all the characters are found in the same order as they have been entered.
• REPLACE VALUE:If the CHECK VALUE is found, it will be replace with this value. Single or multiple characters can be used.
• STOP CHECKING RULES:If this box is ticked, no further rules will be check one the COLUMN, if this rule is executed. This is to prevent other rules from modifying the COLUMN once it has been changed once.

The Check Methods are for a rule to be executed:

• EQUALS:The whole COLUMN must match the CHECK VALUE.
• REPLACE AFTER:If the CHECK VALUE is found, everything from the CHECK VALUE (including the CHECK VALUE) to the end of the COLUMN will be replace with the REPLACE VALUE.
• REPLACE BEFORE:If the CHECK VALUE is found, everything from the beginning of the COLUMN to the CHECK VALUE (including the CHECK VALUE) will be replace with the REPLACE VALUE.
• STARTS:The first values of the COLUMN must equal the CHECK VALUE, then only the CHECK VALUE will be replaced with the REPLACE VALUE.

The Replace Value can not be left blank, so to be able to replace a value with a blank value, there is a reserved word "" available in the dropdown box.
If the rules is executed and the replace value is "", the CHECK VALUE will be deleted and nothing put in it's place.
There is also a reserved word "" this will allow you to totally prevent this record from being processed. This can be used in the PABX3 should not be generating a certain type of call (e.g. Incoming or Outgoing.)

Here are some rule examples:

1. This rule will check for any number that starts with the routing digits "141" and remove them. It will continue to try and process the next rule even it this one is executed.
   COLUMN=NUMBER
   CHECK METHOD=STARTS
   CHECK VALUE=141
   REPLACE VALUE=
   STOP CHECKING=FALSE
   
2. This rule will delete all incoming calls. and not try to process any further rules.
   COLUMN=IO
   CHECK METHOD=EQUALS
   CHECK VALUE=I
   REPLACE VALUE=
   STOP CHECKING=TRUE
   
3. This rule will remove all digits after the "#" in a telephone number and continue to process the next rule.
   COLUMN=NUMBER
   CHECK METHOD=REPLACE AFTER
   CHECK VALUE=#
   REPLACE VALUE=
   STOP CHECKING=FALSE