This documentation supports the 21.05 version of Action Request System.
To view an earlier version, select the version from the Product version menu.

Enabling plug-ins

AR System  plug-ins enable you to extend AR System server  functionality to external data (data not contained in the AR System database). This section describes each type of AR System  plug-in and provides general information about plug-ins. Topics include:

To extend client functionality, you can use the AR System  C API or Java API. See Creating and executing AR System C API programs  and AR System Java API overview.

You can get the class name and setting name information about a plug-in the AR System  Administration Console.

  1. In a browser, open the AR System Administration Console, and click System > General > Plugin Server Configuration.
  2. On the Plugin Server Configuration form, click the Plugin Configuration tab.
    Plugin Configuration tab
  3. In the Plugins area, click a plug-in name.
    The class name of the plug-in is displayed in the Plugin Class Name field, and one or more setting names are displayed in the Path Elements area. 

The following table provides information about  AR System  plug-ins. Version 9.1 and later supports all Java plug-ins, version 9.0 and later supports all C plug-ins.

The configurations for all Java plug-ins are available in Centralized Configuration.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Plug-in NamePlug-in TypeArchitectureDescriptionUsed By

ARSYS.ARF.REGISTRY

AR FilterJava

This plug-in is used to register, modify, and unregister web services. The AR System server interacts with the AR Registry plug-in when an event occurs on the AR System Web Services Registry form.

AR System server

ARSYS.ARDBC.REGISTRYARDBCJavaThis plug-in is used to register, modify, and unregister web services.

AR System server

ARSYS.ARF.RSAKEYPAIRGENERATORAR FilterJava

An RSA 2048-bit asymmetric encryption algorithm in the server uses this plug-in to create a public and private key pair. During installation, the server exports the key pair to the AR System Key Store form, and the AR System server to the Key Map form. The key pair is protected with the 128-bit Advanced Encryption Standard (AES) encryption.

AR System server

ARSYS.ARF.ARMIGRATEAR FilterJavaThis plug-in interacts with the Deployment Management Console when a build, validate, deploy, or rollback process is initiated.Deployment Management Console

ARSYS.ARDBC.PENTAHOARDBCJava

This plug-in connects and interacts with the AR System server by using the AR System Java APIs. It enables you to run and monitor Atrium Integrator jobs and transformations from AR System vendor forms. It is designed specifically to enable a AR System or BMC Helix ITSM application user to create a comprehensive, AR form-based data management user interface.

AR System server

ARSYS.ALRT.TWITTERAR FilterJavaThis plug-in provides a way to send an alert notification or a "tweet" to a valid Twitter account.

AR System server

ARSYS.ARF.TWITTERAR FilterJava

This plug-in provides a way to authorize a Twitter account and register a mapping between the AR System user and Twitter user accounts.

AR System server

ARSYS.ARDBC.FTSCONFIGARDBCJava

The Full Text Search ( FTS ) Configuration console uses this plug-in. You can use the AR System Administration FTS Configuration form to configure FTS . You can access this form from the AR System Administration Console.

FTS Configuration Console

ARSYS.AREA.AREALDAPAREAJava

This plug-in enables you to authenticate AR System users against external Lightweight Directory Access Protocol (LDAP) directory services. It implements the AREA LDAP Configuration form.

AR System server

ARSYS.ARDBC.LDAPARDBCJavaThis plug-in enables you to access data from an external LDAP system through the ARDBC LDAP Configuration form.

AR System server

ARSYS.ARDBC.PREVIEWARDBCJava

This plug-in is the Approval Server Engine. It performs Approval Server functionality while also serving as a Vendor Form that the Approval Engine uses.

AR System server

RMDY.ITSM.RKM.UPDATEKAMMAPPINGSAR FilterJava

This plug-in is used to fix the date of migrated knowledge articles. BMC Helix ITSM: Knowledge Management uses this plug-in.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.REGISTRATIONAR FilterJavaThis plug-in provides the interface for the RKM user to register new knowledge sources and to modify, remove, enable, and disable knowledge sources.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.FILESYSTEMARDBCJavaThis plug-in synchronizes files that are modified or added since the last sync with the RKM:KnowledgeArticleManager form.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.FORMPERMISSIONSAR FilterJava

This plug-in is used when you register the AR System form as a knowledge base item. It is called when you open the Accessibility screen of the Knowledge Registration Wizard. It also extracts the permissions that are assigned to the AR System form by using the AR System API, and it adds this information to the RKM:SourceFormPermissions_Temp form.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.FS.KAM.SYNCAR FilterJava

This plug-in synchronizes files that were modified or added since the last sync with the RKM:KnowledgeArticleManager form. A AR System escalation calls this plug-in and passes the latest sync time.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.LOGLEVEL.CHANGEARDBCJava

This plug-in is used to change the log levels of the BMC Helix ITSM: Knowledge Management plug-ins. It is used when a user modifies the RKM:SystemConfig form.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.DOCSMIGRATIONAR FilterJava

This plug-in converts an old BMC Helix ITSM: Knowledge Management (7.1/7.2/7.5 non-AR System based) article to a AR System -based RKM article.

BMC Helix ITSM: Knowledge Management

RMDY.ITSM.RKM.GROUPARDBCJava

This plug-in gets group-related information from the Group form because the BMC Helix ITSM: Knowledge Management user does not have permissions to use the Group form. It queries the data by logging on as a Remedy Application Service user and retrieving the read-only data from the form.

BMC Helix ITSM: Knowledge Management

RMDY.CAI.RESTFUL.CLIENT.FILTER.PLUGINAR FilterJavaThis plug-in establishes communication between the Change Management application and BMC ProactiveNet Performance Management Server. It gets data from CAI and pushes data to a RESTful web service exposed by BMC ProactiveNet Performance Management. This plug-in refers to the configuration data for communicating with RESTful web services.

BMC Helix ITSM

REMEDY.ARF.ZIPATTACHMENTSAR FilterJava

This plug-in is provided by BMC Helix ITSM with Rule Based Engine (RBE). It is used for zipping the attachments coming with email messages.

BMC Helix ITSM

ARSYS.ARF.SDGAR FilterJava

This plug-in looks up the AR System forms, fields, and conditional dependency of fields and retrieves the field properties, such as the help text, length, and label. It then generates columns for each field in a Microsoft Excel spreadsheet. It reformats the data to the correct set and eliminates the possibility of data mismatch by generating spreadsheets directly from the AR System forms.

AR System server

REMEDY.ARF.HTML2TEXTAR FilterJava

BMC Service Request Management uses this plug-in to strip some HTML tags from character data, for example, in Work Order details. This plug-in is also a part of Rule Based Engine (RBE).

BMC Service Request Management

RMDY.ITSM.OffsetCalculationAR FilterJavaThis plug-in calculates the time zone differences with the current server time and updates the CFG:Time Zone.

BMC Helix ITSM

RMDY.ITSM.ASSET.SOFTWAREUSAGEARDBCJavaThis plug-in enables you to gather product usage information. By querying the usage information, you can identify products that are tied to a certificate or multiple certificates that might be approaching expiration or a breach of compliance. The usage information can also be checked against a product in the product catalog, such as Adobe Acrobat that requires a contract. This produces a list of CIs that have usage information. The purpose of the plug-in is to help the IT asset managers understand what software instances are used or are not used, so that they can make harvesting decisions.

BMC Helix ITSM

RMDY.ITSM.ARLAR FilterJava

This plug-in checks the AR System licenses.

BMC Helix ITSM

RMDY.ITSM.RLEAR FilterJavaThis plug-in is a stand-alone Remedy rules-driven engine with the Java engine running in the back end. It provides the interface for defining and running rules, such as getting data from a data source and updating or processing data in the data source. It also facilitates asset management within the software license compliance functionality.

BMC Helix ITSM

RMDY.ITSM.RLECONFIGARDBCJavaThis plug-in configures the log level, log file path, and log file size of the Rule Engine plug-in. It also permits you to view the Rule Engine plug-in log file.

BMC Helix ITSM

DSO.FILTERCONFIGURATIONARDBCJava

This plug-in adds or deletes a DSO action, such as DSO Delete, DSO Return, or DSO Transfer to or from a filter. This action is then used as an event for DSO . The filter list is provided in a configuration form, which is an input for the plug-in configuration.

AR System server

BMC.REMEDY.ITSM.INCIDENT.DLPAR FilterJava

This plug-in checks for DLP security events in Office 365.  For each event found, it generates an incident in BMC Helix ITSM .

BMC Helix ITSM - Incident Management

REMEDY.ARF.CAIAR FilterJava

This plug-in is used to create, update, and receive data from other back-office applications. It provides a dynamic data-mapping mechanism because you cannot use workflow to push values to dynamic fields. It also helps to address issues caused by incompatible permission models. This plug-in is used within BMC Service Request Management to process variables that are used during processing of submitted service requests. It also helps you move data between different sources and destinations. It enables bidirectional communication with external applications and delivers command events, depending on the protocol used.

Service Request Management and UDM

REMEDY.ARDBC.APPQUERYARDBCC/Java

This plug-in queries several AR System forms and consolidates the results, which you can display in the Overview console or in a table field. This plug-in supports only read functionality.

AR System server

REMEDY.ARF.ITSMUtilAR FilterJavaThis plug-in is used to set the Knowledge Article field as an input parameter. It is also used to create or delete an approval filter when a user defines a custom approval chain.

BMC Helix ITSM

REMEDY.ARF.CBDATAAR FilterJava

BMC Helix ITSM: Asset Management uses the Cost module to track costs associated with CIs. This integration uses the common cost creation dialog box that is provided by the Cost module. The fields on the CI user interface forms integrate with BMC Helix ITSM: Asset Management forms to show cost data related with a CI.

AR System server

NextIdAR FilterJavaThis plug-in is used to merge new IDs on a form. It creates a new entry, adds a request ID, and then merges this entry on a specified form with the merge type as AR_MERGE_ENTRY_DUP_MERGE, which updates the fields specified in the field list in the existing entry.

AR System server

ARSYS.ARDBC.ARREPORTENGINEARDBCJavaThis plug-in is used when you create or modify a BIRT report.

AR System server

ARSYS.ARDBC.CONFIGFILEARDBCCThe server uses this plug-in to read and write the ar.conf file.

AR System server

ARSYS.ARDBC.REPORTARDBCCThis plug-in is used for creating, running, and scheduling the native and BIRT reports.

AR System server

ARSYS.ARF.FTS

AR Filter

Java

This plug-in is used to perform a search from a non-indexer server in a server group. It provides row-level and field-level security for indexed data during searches. It supports the multiform search used by applications such as BMC Helix ITSM: Knowledge Management .

AR System server

ARSYS.ARF.PARSEPARAMETERS

AR Filter

JavaThis plug-in is used to parse parameters that out-of-the-box Business Intelligence Reporting Tool (BIRT) reports use. It is called when you create or modify a BIRT report.

AR System server

ARSYS.ARF.PUBLISHREPORT

AR Filter

JavaThis plug-in is used when you publish a BIRT report. It is executed when you publish the report manually or when you use a job scheduler.

AR System server

ARSYS.ARF.QUERYPARSER

AR Filter

Java

This plug-in is used to convert a formatted AR System qualification into an encoded qualification. This formatted qualification is used by the BIRT report and is also used when performing the search.

AR System server

ARSYS.ARF.REPORTSCHEDULER

AR Filter

JavaThis plug-in is used to schedule a BIRT report. It is used for calculating the next schedule to publish a report based on a recurring value that is provided when defining the schedule for the BIRT report.

AR System server

BMC.ARDBC.ATRIUM.AIS Open link

ARDBCJava

This is the Atrium Integrator plug-in. It is responsible for handling commands from the user interface, organizing the simulation information, and creating results. It uses the filter interface to receive commands, such as add input, update input, or simulate. It is responsible for queuing the CMDB for all the components and relationships and calculating the impact for the simulation.

BMC Helix CMDB

BMC.ARDBC.ATRIUM.API Open link

ARDBCJava

This is the Unified Service Modeling (USM) plug-in, and it provides an interface that offers convenience for working with business services. It provides an interface for AR System applications, such as BMC Service Request Management and BMC Cloud Lifecycle Management to access USM-related features through vendor forms.

BMC Helix CMDB

BMC.ARDBC.ATRIUM.SERVICECONTEXT Open link

ARDBCJavaThis plug-in is the back-end logic that supports BMC Atrium Service Context. BMC Atrium Service Context collects key attributes from several BMC applications and provides that information in a consistent and summarized format.

BMC Helix CMDB

BMC.ARDBC.DEPRECATION.PLUGIN Open link

ARDBCJava

This plug-in is used to support the create, read, update, and delete operations on instances in the deprecated classes in the CMDB . When a class is deprecated by a later version of the BMC Helix CMDB , this plug-in handles CMDB API calls from client apps that are using the old class.

BMC Helix CMDB

BMC.ARDBC.NOTIFYARDBCJava

The TrueSight Infrastructure Management (TSIM) publishing server component uses this plug-in to get information from CMDB when a reconciliation job is executed or when a class or attribute information is modified, so that the publishing server can update the cache or run a publish in the automated mode to get the newly promoted CIs in CMDB .

TrueSight Infrastructure Management (TSIM)


BMC.FILTERAPI.EVENT_ENGINE Open link
AR FilterJava

This plug-in (also called the Event Engine Channels plug-in) provides a near real-time, responsive, and scalable publish-and-subscribe mechanism for notifying changes to CIs stored in the CMDB

BMC Helix CMDB

BMC.FILTERAPI.NOE Open link

AR FilterJava

The applications that rely on a CI and relationship data stored in the CMDB use this plug-in to know whether CIs and relationships have been added, changed, or deleted.

BMC Helix CMDB

BMC.FILTERAPI.NORM.ENGINE Open link

AR FilterJavaThis plug-in is used to normalize the instances that use the Product Catalog data. Based on the product catalog entry, the plug-in normalizes the Category, Type, and Item values of a CI. It can also help in creating the product catalog if needed. It runs on all the servers in a server-group environment; however, only the Administration server schedules jobs at startup.

BMC Helix CMDB

BMC.REMEDY.ITSM.CHG.FILTERAR FilterJava

This plug-in is used in the Change Management workflow.

BMC Helix ITSM

DSM.FILTER Open link

AR FilterJavaThis plug-in is the background engine that wakes up periodically and queries to see if any new or modified CIs meet the criteria in the saved queries for a specified CI. If a CI is found, a relationship is created to relate it to the specified CI. It uses its own sandbox dataset to make changes and then runs the Reconciliation Engine job to BMC.ASSET. It allows you to dynamically relate physical CIs to a technical service.

BMC Helix CMDB

REMEDY.ARDBC.SERVER.ADMINISTRATIONARDBCC/JavaThis plug-in is used to provide data for the AR System Administration Console forms. It was originally a C plug-in, but it was moved to Java in version 9.x and is loaded as part of the server itself and not by a plug-in server.

AR System server

RMDY.ARDBC.IDM.PLUGIN.AGNOSTICARDBCJava

Identity Management uses this plug-in in BMC Service Request Management .

BMC Service Request Management

RMDY.FILTER.IDM.PLUGIN.AGNOSTICAR FilterJava

Identity Management uses this plug-in in BMC Service Request Management .

BMC Service Request Management

Federated Data Plug-ins (JDBC, CMDBf, AR) Open link

ARDBCJava

The federated data plug-ins use adapters to connect an external source of data to BMC Helix CMDB .

The JDBC adapter enables you to federate data from any JDBC-compliant database. The CMDBf adapter enables you to federate data from any CMDBf-compliant BMC Service Request Management . If you have third-party CMDBs in your environment, you can use the CMDBf adapter. The AR adapter enables you to federate data from forms on any AR System server .

BMC Helix CMDB

MYES.CHATTOOLSPLUGIN

AR Filter

Java

This plug-in is used like a utility module that helps in communication between the AR System server part of Virtual Chat (VC) and other parts on the Mid Tier . It also contains utility methods for other tasks.

Virtual Chat

MYES.CNSPLUGIN

AR Filter

Java

This plug-in is responsible for the communication between the AR System server part of VC and other parts on the Mid Tier servers.

Virtual Chat

MYES.SUPPORTBOTPLUGIN

AR Filter

Java

This plug-in helps Virtual Chat to communicate with the systems that contain information, which might answer a user's questions on:

  • ProgramD (VC Chat Bot)
  • Knowledge Management
  • Other systems

Virtual Chat

MYES.TRANSLATEPLUGIN

AR Filter

Java

This plug-in helps Virtual Chat to translate messages by using Google API or Microsoft API.

Virtual Chat

MII.ARF.REGEX
(VALID/SPLIT/EXTRACT/REPLACE)

AR Filter

Java

This plug-in validates a user input using a regular expression, splits a string based on a certain separator, or extracts a token from a string.

Third party

REMEDY.ARF.OMFOBJIEAR FilterC++This plug-in is used for Service Target (SVT) import, export, and delete functions.

BMC Service Level Management

REMEDY.ARF.SLASETUPAR FilterC++

This plug-in is used to create join forms and display-only fields on the Data Source form that are required by BMC Service Level Management .

BMC Service Level Management

ARSYS.FILTERAPI.SMARTREPORTINGUSERAR FilterJavaThis plug-in is used to invoke the user sync, content sync, and instant sync functionalities.

BMC Helix ITSM: Smart Reporting

BMC.ARDBC.NOTIFY Open link

AR Filter

The Notify ARDBC plug-in adds real-time notifications functionality to AR System applications and enables clients to receive notifications about events in the AR System server .

BMC TrueSight Infrastructure Management


Was this page helpful? Yes No Submitting... Thank you

Comments