This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Call AR System API from an ARDBC plug-in

You can make AR SystemC API calls to the AR System serverwith a C ARDBC plug-in. To make sure that any call from the ARDBC plug-in has the same permissions as the user who called the ARDBC plug-in, make the calls as that user.

When a plug-in call is made, AR System servercreates a globally unique ID (GUID) to identify the user instance calling the plug-in. The plug-in provides callback routines to fetch the user name, authentication string, and GUID. Subsequently, when a plug-in makes an API call, it uses those callback routines to fetch the information it needs to authenticate itself as the user who made the original call to the plug-in. When using the GUID authentication feature from a plug-in, internal users, such as ESCALATOR and ARCHIVE, encounter errors because these users are not valid users for making API calls.

The calling plug-in uses the following API calls to set the callback routines for the API to fetch the username, authentication string, and authenticating GUID:

  • ARSetUserNameSource
  • ARSetAuthStringSource
  • ARSetNativeAuthenticationSource

Pointers to the callback routines are made available to the plug-ins as members of a properties list (ARPropList) passed as an argument to ARDBCPluginSetProperties, if implemented by the plug-in, when the plug-in is loaded. The plug-in must save these pointers and use them later as arguments to API calls. These API calls must be made immediately after the ARIntitialization call and before any other API calls. For more information, see AR System plug-in API functions.

A Java ARDBC plug-in can make AR System Java API calls to the AR System server. Use the ARPluginContext object to create an ARServerUser object.

For more information, see the Java plug-in server API online documentation located at ARSystemServerInstallDir\ARserver\api\javaplugins\arpluginsdocVerNum.jar.

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

Comments