Using the Service Level Enforcement Policy

Learn how to enable and configure the error message returned to the consumer when an SLA (service level agreement) is violated.

About Policies Managing Policies QoS Policies Use Cases for Policy Manager

Use Cases for the Akana API Platform (Community Manager)

Supported Platforms: 7.x, 8.0

Table of Contents

  1. Introduction
  2. Service Level Enforcement Policy Options
  3. Configuration
  4. Use Cases for Policy Manager
  5. Use Cases for the Akana API Platform (Community Manager)

Introduction

The Service Level Enforcement Policy is a Quality of Service (QoS) policy that allows you to enable and configure the error message returned to the consumer when an SLA is violated.

This policy only applies to the following Service Level rules:

  • Usage Count
  • Total Request Message Size
  • Total Response Message Size

The Service Level Enforcement Policy works in conjunction with a Service Level Policy. You define a Service Level Policy and specify each service level condition and alert code; then, you define a Service Level Enforcement Policy and specify the error message you would like displayed when the specified service level condition is violated.

When the Service Level Policy and Service Level Enforcement Policy are attached to the same Organization/Service/Contract, the messages will be rejected and returns the configured error message you defined as long as the Service Level Policy is being violated.

Service Level Enforcement Policy Options

The policy includes the configuration options listed below.

Service Level Enforcement Policy Details
  • Name: A read-only field that displays the name of the Service Level Enforcement Policy.
  • Description: A read-only field that displays the description of the Service Level Enforcement Policy.
Service Level Enforcement
  • Consumer Fault Message: A field display that allows you to specify the error message returned to the consumer when an SLA is violated.

back to top

Configuration

Let's take a quick walkthrough of the Service Level Enforcement Policy configuration process to get you started.

Step 1: Add Policy

In Policy Manager, to create a Service Level Enforcement Policy instance, go to Policies > QoS Policies and choose Add Policy.

Step 2: Modify Policy

When you click Modify to make changes to the Service Level Enforcement Policy on the Policy Details page, the initial policy looks like this:

Configure the policy options based on your requirements and click Apply.

Step 3: Attach Policy

After you've saved your policy, you can attach it to a web service, operation, or binding.

Step 4: Test Policy and View Monitoring Data

After you've attached the Service Level Enforcement Policy to a web service, operation, or binding, send a request to your service and go to the Services > Monitoring section to view the results for Logs, Real Time Charts, and Historical Charts. For more information on using the monitoring functions, refer to the Policy Manager Online Help, available via the Help button.

back to top

Use Cases for Policy Manager

For a list of Policy Manager-specific use cases for the Service Level Enforcement Policy, refer to Service Level Enforcement Policy Usage Scenarios for Policy Manager.

back to top

Use Cases for the Akana API Platform (Community Manager)

For a list of Community Manager-specific use cases for the Service Level Enforcement Policy, refer to Service Level Enforcement Policy Usage Scenarios for Community Manager.

Back to top