AR Filter API plug-ins

AR System Filter (AR Filter) API plug-ins enable you to create integrations between your systems and the Approval Server. The Set Field actions in filters and escalations trigger these plug-ins. It consumes fewer resources and less processor time than a Set Fields $PROCESS$ action because this middleware is loaded as a plug-in when Approval Server  is started instead of a standalone executable at each event. 

Related topic

Enabling-plug-ins

At run time, the Approval Server sends AR Filter API requests to the plug-in, which directs the requests to the appropriate plug-in. The plug-in processes the input arguments and returns the values that can be used in the Set Fields action.

When you enter AR Filter API requests in the Create Filter form, the Approval Server sends the requests to the plug-in, which sends them to AR Filter. Then, AR Filter processes the data or request itself, or it retrieves output data from the external data source and returns it in the opposite direction. To create AR Filter Set Field actions in filters and escalations, use Developer Studio.

Unlike AREA plug-ins, the plug-in server can simultaneously load multiple AR Filter API plug-ins.

The following figure shows the flow of requests and information for AR Filter API plug-ins:

22_1_AR_filter_API_plug_ins.png

The following table specifies the actions you need to perform to create and configure AR Filter API plug-ins:

Action

Reference

Create AR Filter API plug-ins in Java methods and C function

Configure AR Filter API plug-ins

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*