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

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

Using Web services with alerts

BMC Remedy AR System can send alerts to the plug-in server for users registered with the Web Services Plugin Name in the AR System Alert User Registration form. You can configure alerts to go to the AR System Alert Web Services plug-in installed with BMC Remedy AR System, or to another plug-in that you create.

Note

To send alerts via Web service, the AR System Web services plug-in ARSYS.ARF.WEBSERVICE must be installed. See Setting up the environment for web services.

The AR System Alert Web Services plug-in (ARSYS.ALRT.WEBSERVICE) converts the alert information, including the alert text, recipient, and alert destination, to an XML document. It then passes the alert request to the Web Services plug-in, which must also be installed and running. The Web Services plug-in sends the alert to the destination Web service.

You can also use Web services to register users in the AR System Alert Users Registration form.

To receive alerts via Web services, create a Web service that uses the Alert Notification .wsdl file (alertNotification.wsdl) installed with BMC Remedy AR System. This .wsdl is installed in the <ARSystemInstallDir>/pluginsvr directory.

For more information about using Web services with BMC Remedy AR System, see Publishing the BMC Remedy AR System functionality as a web service.

To register a user to receive alerts through the AR System Alert Web Services plug-in

  1. Create a Web service that uses the alertNotification.wsdl.
  2. Create an entry for the user in the AR System Alert User Registration form.
    1. In the Registered User field, enter the user's AR System login ID.
    2. In the Plugin Name field, select Web Service.
    3. In the Plugin Values field, enter the End Point URL of the Web service that uses the alertNotification.wsdl.

Registering and deregistering users by web service

The Alert Web Services plug-in contains the following methods and input parameters to allow registration, re-registration, and de-registration of alert users via Web Services:

  • DeRegister --Deletes an entry that has the Web Service Plugin Type from the AR System Alert User Registration form by using the Registered User name. The minimum values required are Registered_User and DeRegister. DeRegister must be set to Yes. If the remaining values are provided, they are used to search for an entry with those values.
    Example:
    
    <urn:Registered_User>?</urn:Registered_User>
       <!--Optional:-->
       <urn:Plugin_Name>ARSYS.ALRT.WEBSERVICE</urn:Plugin_Name>
       <!--Optional:-->
       <urn:Plugin_Values>?</urn:Plugin_Values>
       <!--Optional:-->
       <urn:DeRegister>Yes</urn:DeRegister>
  • DeRegisterOnRequestID --Deletes an entry that has the Web Service Plugin Type from the AR System Alert User Registration form by using the Request ID of the entry. The DeRegister element must be set to Yes.
    Example:
    
    <!--Optional:-->
       <urn:DeRegister>Yes</urn:DeRegister>
       <urn:Request_ID>?</urn:Request_ID>
  • GetByRequestID --Retrieves an entry from the AR System Alert User Registration form.
    Example:
    
    <urn:Request_ID>?</urn:Request_ID>
  • GetListByQual --Retrieves entries from the AR System Alert User Registration form by using the qualification provided.
    Example:
    
    <urn:Qualification>?</urn:Qualification>
       <urn:startRecord>?</urn:startRecord>
       <urn:maxLimit>?</urn:maxLimit>
    In this method, the default qualification is 'Registered User' = $USER$. The default qualification is used if no Qualification element is present or if the Qualification element is empty (for example, <urn:Qualification></urn:Qualification>).
    To see all the registered users, enter the qualification in the format <urn:Qualification> 'Registered User' LIKE "%%" </urn:Qualification>.

    Note

    You must be a member of the Administrator group to see all the registered users. If a non-administrator uses this qualification, they will see only those records for which they have permission.

  • Register --Creates an entry in the AR System Alert User Registration form.
    Example:
    
    <urn:Registered_User>?</urn:Registered_User>
       <urn:Short_Description>?</urn:Short_Description>
       <!--Optional:-->
       <urn:Plugin_Name>ARSYS.ALRT.WEBSERVICE</urn:Plugin_Name>
       <!--Optional:-->
       <urn:Plugin_Values>?</urn:Plugin_Values>
       <!--Optional:-->
       <urn:Enc_Plugin_Values>?</urn:Enc_Plugin_Values>
       <!--Optional:-->
       <urn:Expiration_Time__secs_>0</urn:Expiration_Time__secs_>
       <!--Optional:-->
       <urn:Update_Sent_flag>?</urn:Update_Sent_flag>
  • ReRegister --Resets the value in the Registration Time field. The minimum value required to be sent is the value in Expiration Time (secs). The value of this field can be the same as what it was originally to reset the registration rime. If required, the remaining values can also be sent to modify them along with resetting the registration time.
    Example:
    
    <!--Optional:-->
       <urn:Registered_User>?</urn:Registered_User>
       <!--Optional:-->
       <urn:Short_Description>N/A</urn:Short_Description>
       <!--Optional:-->
       <urn:Plugin_Name>ARSYS.ALRT.WEBSERVICE</urn:Plugin_Name>
       <!--Optional:-->
       <urn:Plugin_Values>?</urn:Plugin_Values>
       <!--Optional:-->
       <urn:Enc_Plugin_Values>?</urn:Enc_Plugin_Values>
       <urn:Expiration_Time__secs_>?</urn:Expiration_Time__secs_>
       <urn:Request_ID>?</urn:Request_ID>
       <!--Optional:-->
       <urn:Update_Sent_flag>?</urn:Update_Sent_flag>
Was this page helpful? Yes No Submitting... Thank you

Comments