Using the alert functions defined in bmc_remedy.notification.js

The bmc_remedy.notification.js file defines a variety of alert functions that operate on Tivoli Netcool/OMNIbus alerts. The file also imports functionality from several modules. The alert functions supplied in the bmc_remedy.notification.js file define a basic default behaviour for each of those functions. You can modify these alert functions to suit your environment.

The following sections discuss each of the imported modules and alert functions defined in the bmc_remedy.notification.js file.

The bmc_remedy.notification.js file uses the require function to load the following modules:

The SOG interface module exposes the following method:

The bmc_remedy module exposes the following method (through the bmc_remedy.js file):

• getEntry -- Returns the BMC Remedy ARS entry identified by the requestid from the configured form. For example:

  var remedy = require("bmc_remedy");
  .
  .
  .
  var entry = remedy.getEntry("00000001232");
  var field = entry.getField("fieldid");

The bmc_remedy module allows for calling back into BMC Remedy ARS to retrieve details of BMC Remedy ARS requests.

The gateway calls the addJournal function to add a journal entry in the journal table for the alert specified in alert.

The addJournal function is defined as follows:

function addJournal(alert,message)

The gateway calls the update function whenever it receives a notification from the target system. In the case of BMC Remedy ARS this notification is the result of a ticket modification. The update function is defined as follows:

function update(alert,inputs)

The following example shows a call to the update function:

function update(alert, inputs)
{
        values = sog.newrow();
        values.put("Severity", inputs.get("Severity"));
        alert.update(values);
}

The gateway calls the clear function whenever the target ticket is deleted or cleared, in which case the gateway clears the Tivoli Netcool/OMNIbus alert. In the case of BMC Remedy ARS, the gateway performs the clear operation when the end user deletes the target BMC Remedy ARS ticket, as there is no open or closed status. The clear function is defined as follows:

function clear(alert,inputs)

The gateway calls the error function whenever an error occurs when the gateway tries to manipulate the corresponding ticket in the target system (in this case, BMC Remedy ARS). The error function is defined as follows:

function error(alert,inputs, message)

The gateway calls the setTargetId function whenever the alert is associated with a destination target system ticket. Typically, the gateway calls setTargetId after the user creates a BMC Remedy ARS ticket and a corresponding creation ticket alert is generated. The setTargetId function sets the target ID in the underlying alert and adds the target ID details to a journal entry for the alert (by calling the addJournal method).

The setTargetId function is defined as follows:

function setTargetId(alert,targetid)

The gateway calls the logError function to log errors associated with the alert specified in alert. The logError function actually calls the error method, which is implemented as part of the Tivoli Netcool/OMNIbus Logger interface. The gateway writes errors to the gateway log file.

The logError function is defined as follows:

function logError(alert, msg)