This documentation supports the 18.08 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Using Java classes for data visualization

Data visualization modules are packaged and deployed as JAR files. The following Java classes and interfaces are provided for data visualization developers. The Javadocs contain more information about these classes.

Note

When searching for a class name, remember that each class is in the com.remedy.arsys.plugincontainer package. So, the Plugin class is named com.remedy.arsys.plugincontainer.Plugin.

Data visualization developers can implement these interfaces:

  • Plugin — Interface that must be implemented by data visualization developers.
  • DefinitionFactory — Interface that can optionally be implemented by data visualization developers to parse their definition data into Java objects. These Java objects must imported into the Definition or the CacheableDefinition interfaces described in the following list.
  • Definition — Marker interface implemented by the modules' definition objects.
  • CacheableDefinition — Marker interface to use if the module needs the container to cache the definition objects. The cached objects are returned when the module requests the DefinitionSevice to get the definition. For more information, see the cache service.

Other interfaces include:

  • ARPluginContextEX — Extends the PluginContext class to provide BMC Remedy AR System server specific services. To use this class in a plug-in, you must typecast objects to com.bmc.arsys.api.ARServerUser. (In version 7.0.01, the ARPluginContext is used, and it returned com.remedy.arsys.api.ARServerUser object in its functions. For more information, see the 7.6.04 BMC Remedy AR System API Javadocs.)
  • AuthenticationException — Extends the Exception class.
  • CacheableDefinition — Uses the caching services of the plug-in container.
  • DefaultDefinition — Default implementation of the Definition class.
  • Definition — Acts as a marker interface for data visualization definition.
  • DefinitionService — Provides the definition service for the data visualization container.
  • LocaleService — Provides services such as getting appropriate strings for the locale to enable the module writer to localize the plug-in. For example, you can format dates, time, and numbers for locale conventions.
  • ARLocaleServiceEX — As a subset of LocaleService, provides a simpler way to access localized messages from the Message Catalog.
  • PluginContext — Provides the context that can be used to make API calls.
  • NoPermissionException — Occurs when the data visualization tries to retrieve a definition for a user who does not have authorization to access the definition.
  • PageService — Generates URLs that provide a reference back to the data visualization.

Note

When you update to new APIs, make sure you make the appropriate changes (as described in the Javadocs).

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

Comments