Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To open the HTTP/2 Server agent configuration dialog from a workflow configuration, you can do either one of the following:

...

Setting

Description

Enable Overload Protection

Select this option if you want enable overload protection.

Number of Requests

If you have selected enable overload protection, enter the maximum number of requests that are allowed to be sent during the time specified in Average Period (sec). When this number of requests has been reached, further requests will be blocked until the time specified in Wait Duration (sec) has passed, then a retry will be attempted.

Period (sec)

Enter the time period in seconds for which the number of requests should be counted.

Wait Before Retry (sec)

Enter the number of seconds to wait before attempting to retry a request.

OpenAPI Tab

...

HTTP/2 Server Agent Configuration - OpenAPI tab

...

Setting

Description

OpenAPI

Use OpenAPI Profile

Select this option if you want the agent to use an the OpenAPI profile(s).

OpenAPI Profile

Browse and select the profiles to be used. This field is enabled when theĀ Use OpenAPI Profile option is selected.

Click Add to browse for the available OpenAPI profiles.

Warning

Warning!

There are no limits to the number of profiles users can select. However, by selecting a large number of OpenAPI profiles will have significant impact on the overall performance of the workflow.

Enable Validation

Select this option if you want to validate the OpenAPI profile.

Warning

Warning!

Turning this option ON will have a very significant performance impact on the overall performance of the flow. When validation is enabled, each payload will be validated against the Open API schema, an operation that can be very resource-intensive. We recommend to only enable this setting during development and testing and to disable it in a stable production environment.

Note

Note!

Strict validation is applied against the OpenAPI specification due to the upgrade of third party libraries. For Example, if the response contains the body but the schema doesn't expect the response to contain body then it will causing validation failure. Refer to this link for further information https://bitbucket.org/atlassian/swagger-request-validator/issues/246/validator-does-not-check-a-response-body

Override Error Response

Override Error Response on Server Shutdown

Select this option to enable the customization of the HTTP response for when a request to the server is received upon the server being terminated.

Override Error Response on Server Overload

Select this option to enable the customization of the HTTP response for when a request to the server is received upon the server being overloaded.

Note

Note!

Overload protection should be enabled to utilize this feature


Status Code

The HTTP error code for the error response. The default error code set is 503 for server shutdown and 429 for server overload.

Content Type

Enter the media type to be used as part of the HTTP header for the response. The default media type is "application/problem+json".

UDR Type

Browse for the UDR that will be populated as part of the HTTP response message.

UDR Field

The fields in the selected UDR Type will be shown in this column.

Type

The data type for the each of the UDR fields will be shown here. supports the following data type:

  • String

  • BigInt

  • Boolean

  • Int

Value

Enter a value that conforms to the data type of the UDR field. The value will then be parsed into the HTTP response when the error is triggered.

5G Tab

...

HTTP/2 Server Agent Configuration - 5G tab

The 5G tab contains the following settings:

...