Set Service Context


The Set Service Context filter configures service-level monitoring details. For example, you can use the fields on this filter screen to configure whether the API Gateway stores service usage and service usage per client details. You can also set the name of the service displayed in the web-based API Gateway Manager monitoring tools and Oracle API Gateway Analytics reporting tools.

When you use the API Service Manager tool to virtualize an API service, a Set Service Context filter is automatically generated for the service. For example, you can view generated policies in the Policy Studio tree under the Polices -> Generated Polices -> API Service Manager -> Services.



Enter an appropriate name for the filter to be displayed in a policy.

Service Name:

Enter an appropriate name for this service to be displayed in the Web-based API Gateway Manager tools, and in the Oracle API Gateway Analytics interface when generating reports for this service.

Monitoring Options:

The fields in this group enable you to configure whether this service stores usage metrics data to a database. For example, this information can be used by Oracle API Gateway Analytics to produce reports showing how and who is calling this service. The following fields are available:

  • Monitor service usage:

    Select this option if you want to store message metrics for this service.

  • Monitor service usage per client:

    Select this option if you want to generate reports monitoring which authenticated clients are calling which services.

  • Monitor client usage:

    If you want to generate reports on authenticated clients, but are not interested in which services they are calling, select this option and deselect Monitoring service usage per client.

  • Which attribute is used to identify the client?:

    Enter the message attribute to use to identify authenticated clients. The default is, which stores the identifier of the authenticated user (for example, the username or user's X.509 Distinguished Name).

  • Composite Context:

    This setting enables you to select a service context as a composite context in which multiple service contexts are monitored during the processing of a message. This setting is not selected by default.

    For example, the API Gateway receives a message, and sends it to serviceA first, and then to serviceB. Monitoring is performed separately for each service by default. However, you can set a composite service context before serviceA and serviceB that includes both services. This composite service passes if both services complete successfully, and monitoring is also performed on the composite service context.