Enable Notification Rules

In SAP’s cloud solutions, notification rules can be defined by customers to receive a notification in case a certain situation occurs for a business object. Typical examples are status changes of business objects or the exceeding of threshold values. The notifications only serve as information and do not trigger automatic actions or tasks.

If a customer wants to use notification rules with a custom business object, you as a partner need to enable the business object for notification rules in the studio: In the Notification Rules Wizard, you select business object fields that can be used as placeholders, conditions, and recipients.

After you have enabled the custom business object for notification rules, your customer can create notification rules for the business object in the cloud solution.

For more information, see the "Notification Rules Quick Guide" in the documentation of the SAP cloud solution.

Availability

Caution

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes all features that are available within the studio. Not all of these features are available for every cloud solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine whether the feature is available for the cloud solution from SAP for which you are creating your solution.

For details, see Feature Matrix.

End of the caution

Prerequisites

  • You have activated the custom business object for which you want to enable notification rules. For more information, see Business Objects Quick Guide.

If you want to use thing-based navigation with your solution, the following prerequisites apply:

  • You have created a thing-based screen scenario. For more information, see Generate Screens for a Business Object.

  • You have created a query. In the Query Wizard, in the Create a Query step, you have selected the Include in Enterprise Search option. For more information, see Create a Query.

    Note

    To be able to select the Include in Enterprise Search option, you need to define a Date/Date Time field in your custom business object.

    End of the note

Procedure

  1. In the studio, in the Solution Explorer, right-click the custom business object and select Enable Notification Rules.

    The Notification Rules Wizard opens.

    Note

    You can use this process only once per custom business object.

    End of the note
  2. In the wizard, in the Define Fields for Placeholders and Conditions step, do the following:

    1. Select the business object elements to be used as fields for placeholders and conditions in notification rules.

      Note

      • For the placeholders, you can use business object elements defined in the root node or in [1,1] associated nodes.

      • For the conditions, you can use business object elements from the root node and from [1,n] associated nodes.

      • You can only use data types with the following representation terms:

        amount

        description

        measure

        quantity

        code

        duration

        name

        text

        date

        identifier

        numeric

        time

        date/time

        indicator

        percent

        value

        To find out the representation term of a data type, call up the relevant data type in the Repository Explorer. For more information, see Look Up the Representation Term of a Data Type.

      End of the note
    2. Click Next.

  3. In the Define Labels for Placeholders and Condition Fields step, you can adapt the field labels. Click OK.

    Note

    Do not leave the field label blank or use identical labels for different fields; field labels must be unique.

    End of the note
  4. In the Define Recipients step, select the recipients to be used in notifications:

    1. In the Description field, enter a description for the recipient, for example, Manager or Requestor.

    2. In the Business Object Element field, click the ... button.

    3. Select a business object element that you want to use as recipient and click OK.

      Note

      • You can select business object elements of type UUID or EmployeeID, or fields generated by associations.

      • The elements must be taken from the business object for which the approval process is defined. You cannot refer to elements in another business object using an association.

      End of the note
    4. Click Next.

  5. In the Review step, review your entries and click Finish.

  6. In the Solution Explorer, a [business object name].notification file () is created. Right-click the file and select Activate.

  7. Right-click your solution and click Deploy Business Configuration.

Result

You have enabled the custom business object for notification rules. Your customer can now define a notification rule in the cloud solution. For more information, see the “Notification Rules Quick Guide” in the documentation of the SAP cloud solution.

In maintenance mode, the following restrictions apply:

  • Delivered fields cannot be deselected as they may have been used in notification rules by customers.

  • Delivered fields cannot be renamed.

See Also

Example: Enable Notification Rules (Price Request)