Show TOC

Unsubscribing Consumers (DeregisterConsumer)Locate this document in the navigation structure

Prerequisites

  • The user calling the Web service operations has to have the SAP_XI_ALERTCONFIGURATOR_J2EE authorization role.

    If the security settings in your system allow this, you might also use a user account that has the SAP_XI_DEVELOP_API_J2EE authorization role. For more information, see Assigning Permissions .

  • The requested alert rules must be existing, active, and not contained in any open change list in the Integration Directory.

  • You can use the standard error handling process in the Integration Directory API. For more information, see Error Handling .

Features

Using the DeregisterConsumer operation you can remove the ID of a consumer from the specified alert rules.

The following input parameters are included in the AlertRuleDeregisterConsumerRequest data structure:

  • Use the AlertRuleID data structure to specify the names of the alert rules from which the alert consumer should be unsubscribed.

    You must specify a value for each AlertRuleID parameter you include in the structure.

  • Use the ConsumerName parameter to enter the name of the alert consumer you want to unsubscribe from.

    It is mandatory to specify a value for this parameter.

  • Use the EnableAlertRules parameter with value TRUE when you want the specified alert rules to be enabled after the process of unsubscribing completes.

The operation response contains the results of the request for unsubscribing the consumer. The results are provided in the AlertRuleDeregisterConsumerResponse data structure, which contains the following information for each alert rule:

  • The AlertRule data structure contains the name and the technical ID of the alert rule: AlertRuleID and AlertRuleTechnicalID

  • LogMessageCollection contains a list of possible error or other messages.

Process

The following processes occur in Integration Directory when you run the DeregisterConsumer operation:

  1. The operation creates an open change list called ConsumerRegistration_<ConsumerName>_byUser_<User logged on to directory> and the specified alert rules are added to this change list.

  2. The ID of the alert consumer (input parameter ConsumerName) is removed from the specified alert rules.

  3. If the optional input parameter EnableAlertRules is set to TRUE, the state of all specified alert rules is set to ENABLED.

  4. The change list described in the first step is activated.