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.

Services provided to the data visualization modules on the mid tier

The data visualization feature includes the following services to ease integration with BMC Remedy AR System.

  • Authentication services — Supplied by BMC Remedy Mid Tier.
  • Authorization services — Supplies meta-information needed to generate the graphical elements. This information is retrieved only if a user has permission to view the graphical elements. The meta-information is stored in a special form.
  • Deployment services — The module code is stored as a JAR file attachment on the BMC Remedy AR System server. The module container automatically downloads this code from the BMC Remedy AR System server and uses it to serve up requests. This makes installation and deployment of the module code a simple data import operation into a form on the BMC Remedy AR System server.
  • Signaling (event) services — Signals (events) are sent on the client side. For the module writer to use signals, the module needs to generate HTML content in response to requests. These responses can include an HTML script tag that contains event dispatching JavaScript code that is generated by the module container. This script snippet can be obtained at the mid tier by calling the PageService.getEventInfrastructureCode() method. The PageService also returns the name of the Javascript eventDispatcher object in the PageService.getEventDispatcherName() method. It can be used to send and receive events on the client side. This name might change in portlet environments to prevent name clashes.
    The following signals are available:
    • Signals from module client side to module mid tier — Generates internal code for sending signals to the mid tier. Module code must be written to call the EventDispatcher.sendEventToMidTier(eventtype, eventData) JavaScript object method in the HTML response that is generated by the module in response to a request, which returns a string value.
    • Signals from module client-side to parent BMC Remedy AR System form — Generates the internal code that sends signals from the module in the main form. Module code must be written to call the EventDispatcher.sendEventToParentForm (eventType, eventData) JavaScript object method in the HTML response that is generated by the module.
    • Signals from BMC Remedy AR System form workflow to module — Generates the code to receive events from the main form in the module. Module code must be written to register a JavaScript function with the EventDispatcher java script object on the client side by calling EventDispatcher.setEventHandler(object, functionRefence). The object parameter is the name of a variable that refers to the object that has the functionReference as one of its members. For functions that are not members of an object, null can be passed in for the object parameter.
    • Drill down from client module to a BMC Remedy AR System form — Generates code to perform the drill-down into a BMC Remedy AR System form without being dependent on the module HTML being present in a BMC Remedy AR System form. This allows the module code to generate HTML that can be just fragments in a portlet environment, while still providing the drill-down capability.
      The function call is EventDispatcher.drillDownToForm(server, form, view, qualification).
  • Configuration services:
    • Surfaces configuration properties of the module into the BMC Remedy Mid Tier configuration page.
    • Stores the configuration properties and sends them to the module when it is initialized.
  • Definition storage and retrieval services — Definitions in BMC Remedy AR System are retrieved from the BMC Remedy AR System server and sent to the module when it is asked to handle a request.
  • Caching services — The module container can be requested to cache objects created and repeatedly used by the module.
  • Locale services — Retrieves messages for a specific locale for a supplied key. Numbers, dates, and times are formatted based on the locale.
  • Page generation services — URLs are generated for various types of hotspots used in signaling for this module.
  • Session services — Enables module objects to be stored in the user session so that they are available throughout the lifetime of the session.
Was this page helpful? Yes No Submitting... Thank you