The HTTP Client collector function collects data from a third-party HTTP server. You can configure this function to set the values for how the HTTP Client function would behave when communication communicating with the third-party HTTP server, and how to specify the method of communication.

You can configure this function in the following settings.

Connection

Operational settings

General settings

Results

:

Table of Contents

minLevel	1
maxLevel	1
outline	false
style	disc
type	list
printable	true

Connection

Depending on the users' your configuration, two three authentication methods are available: None, Basic authentication and OAuth 2.0 implementation.

Option

Description

Include basic access authentication credentials

Select to add the specified username and password.

Incude query string in URL

Select to include a query string in the URL. Add a key and its corresponding value. You can include multiple query strings.

Customize header

Select to customize the headers of the URL and specify multiple keys and their respective values.

The default value for the HTTP headers “content-type” and “accept” is application/json.

You can override the default value for the HTTP header “content-type.”

It is recommended that the default value for the HTTP header “accept” is left unchanged. The HTTP functions only support application/json.

A selectable option from the Authentication type is used to make the selection and based on that separate configuration options are available. There will be additional options for the Authentication type selected.

When you select an Authentication type, there will be separate configuration options for the selected authentication type.

OAuth 2.0

Check the Use redirect fields check box to enable URL redirection using the available options. Two fields are displayed when this option is enabled – the Target URL field where the designated address is to be entered, and an optional Resource path.

Rw ui tabs macro

Rw tab

title	None

Add the Target URL of the HTTP request to be made to the HTTP server. You can use Variable Insertion.

Note

Note!

Usage Engine Cloud Edition interprets only a single forward slash in the URL fields. Ensure that you format the URLs accordingly.

Rw tab

title	Basic authentication

Add the Username and Password if there are any. These options

can be left empty

are optional.

Add the Target URL of the HTTP request to be made to the HTTP server. You can use Variable Insertion.

Note

Note!

Usage Engine Cloud Edition interprets only a single forward slash in the URL fields. Make sure Ensure that you format the URLs accordingly.

In Target URL, enter the URL of the target

Rw tab

title	OAuth 2.0

Add the Target URL of the HTTP request to be made to the HTTP server.

You

You can use Variable Insertion.

You can select a combination of the following options to be included in the URL:

Option

Description

Include basic access authentication credentials

Select to add the specified username and password.

Incude query string in URL

Select to include a query string in the URL. Add a key and its corresponding value. You can include multiple query strings.

Customize header

Select to customize the headers of the URL and specify multiple keys and their respective values.

The default value for the HTTP headers “content-type” and “accept” is application/json.

You can override the default value for the HTTP header “content-type.”

It is recommended that the default value for the HTTP

header “accept” is left unchanged. The HTTP functions only support application/json.

Rw tab

title

Note

Note!

Usage Engine Cloud Edition interprets only a single forward slash in the URL fields. Ensure that you format the URLs accordingly.

Note

Note!

When the Authentication type selection is selected as OAuth 2.0, additional options are displayed. See the OAuth2.0 credentials and OAuth2.0 parameters sections for more information. Their configuration is mandatory to properly activate the function.

Rw ui expands macro

Rw expand

title	OAuth2.0 credentials

When the OAuth 2.0 credentialsIt is also possible to use the Secrets Wallet functionality authentication type is selected in the Connection section, it is possible to enable Secrets Wallet to apply stored credentials for the three HTTP Functions.

If Secrets Wallet is not enabled, you configure the following fields.

Grant type – Select the grant type of the credential. There are two grant types, Password credentials and Client credentials.
Client ID – In this field enter Enter the client identifier. This field is mandatory.
Client Secret – in this field enter secret – Enter the associated client secret. This field is mandatory. This parameter may be omitted if the client secret is an empty string.
Username – This field is used to specify Specify the relevant username, it . This field is mandatory. . This field appears when Password credentials is selected for the Grant type.
Password – This field is used to specify Specify the password associated with the username, it . This field is mandatory.

. This field appears when Password credentials is selected for the Grant type.

Rw ui expands macro

Rw expand

title	OAuth 2.0 parameters

The OAuth 2.0 parameters section of the function controls the authentication token credentials. The Token Header Prefix field is the Authorization header placed before the access token. Based on the Grant Type selection there are two types of credentials access provided for the authentication provisions – Password and Client credentials. Each of them has a distinctive configuration option.

Password Credentials Grant Type Options

If Secrets wallet is not enabled in the OAuth 2.0 credentials section, the following options are for either Password credentials or Client credentials are selected as the Grant Type:

Access token URL – In this field specify Specify the URL containing the authorization token.
Token header prefix – The authorization header placed before the access token.
Scope – The authorization and token endpoints allow the client you to specify the access request scope using this parameter. The entered value must be expressed as a list of space-delimited, case-sensitive strings. This is an optional parameter.
Audience - Set the recipient that the token is intended for.
Client Authenticationauthentication – This option controls the type of authentication mechanism as defined by the connecting server – Auth Header or Auth Body are available. The options are named "Send as Basic Auth Headerbasic auth header" and "Send client credentials in body".

Client Credentials Grant Type Options

If Secrets wallet is enabled in the OAuth 2.0 credentials section, and the Private key JWT authentication type is selected, there are distinctive configuration options:

Access token URL – In this field specify Specify the URL containing the authorization token.
~~Client ID~~ ~~– In this field enter the client identifier.~~
~~Client Secret~~ ~~– in this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string.~~
Token header prefixToken header prefix – The authorization header placed before the access token.
Issuer – Set the issuer of the JWT
Audience – Set the recipient that the JWT is intended for.
Subject – Set the subject of the JWT, typically representing the user or entity the token is about.
Identifier – Set a unique identifier for the JWT.
Add claim – List the permissions that the application requests. When you click the Add claim button, you enter the Key and Value of the permission.

If Secrets wallet is enabled in the OAuth 2.0 credentials section, and the Bearer token authentication type is selected, there are distinctive configuration options.

Token header prefix – The authorization header placed before the access token.
Scope – The authorization and token endpoints allow the client to specify the access request scope using this parameter. The entered value must be expressed as a list of space-delimited, case-sensitive strings. This is an optional parameter.
Audience - Set the recipient that the token is intended for. This is an optional parameter.
Client Authentication – authentication – This option controls the type of authentication mechanism as defined by the connecting server – Auth Header or Auth Body are available. The The options are named "Send as Basic Auth Headerbasic auth header" and "Send client credentials in body".

Private Key JWT Grant Type Options

Access token URL – In this field specify the URL containing the authorization token.
~~Client ID~~ ~~– In this field enter the client identifier.~~
~~Client Secret~~ ~~– in this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string.~~
Token header prefix
Issuer
Audience
Subject
Identifier

The Use redirect fields checkbox allows you to toggle URL redirection using the available options. Two fields are displayed when this option is enabled – the Target URL field where the designated address is to be entered, and an optional Resource path.

Image Removed

Operational settings

In Operational settings, enter the following details that determine how you want the function to handle the errors. The following options are available for HTTP Collector and Processor Functions only:behave.

In Request run limit, specify the number of times the operation should run . in a single stream. The limit of runs you can request is from one to 12.

In Action on error, specify the action you want to take in case of an error. You can select from the following options:

Any response with the HTTP status code 4xx or 5xx is considered an error. All errors get logged in the system logs. You can refer to the See Logs for more information.

The default value is Ignore.

General settings

You In General settings, you select an HTTP request method from the following options:

HTTP Method	Description
GET	Request data from the target server.
POST	Sends data to the target server. Select either Body or Form under ContentContents*.
PUT	Replaces the current resources of the target URL with the uploaded content. Select either Body or Form under ContentContents*.
PATCH	Updates partial resources of the target URL. Select either Body or Form under ContentContents*.
DELETE	Removes all current representations of the target resource.

Both authentication types also include optional parameters:

Note

Note!

*The Body and Form fields are visible only for the POST, PUT and PATCH request methods. See Contents for more information.

You can select a combination of the following options to be included:

– This enables token URL.

Customize header - This allows for custom headers to be specified.

Note

Note!

*The Body and Form fields are visible only for request methods POST, PUT and PATCH.

URL. Add a Key and its corresponding Value. You can include multiple query strings.

Customize header

Select to customize the headers of the URL and specify multiple keys and their respective values.

The default value for the HTTP headers “content-type” and “accept” is application/json.

You can override the default value for the HTTP header “content-type.”

It is recommended that the default value for the HTTP header “accept” is left unchanged. The HTTP functions only support application/json.

Rw ui expands macro

Rw expand

title	Contents

Select Body or Form and add the corresponding details in the content of the request message. You can use Variable Insertion.

Expand the examples below to view samples of HTTP request messages for Body or Form:

Note

Note!

The form input needs to be URL encoded, otherwise, it fails.

HTTP requests use a hardcoded content-type value of ‘application/x-www-form-urlencoded’.

Expand the examples below to view samples of HTTP request messages for Body or Form:

code

Expand

title	Sample of an HTTP body content message

No Format
{ "name" : "my_username", "first-name" : "My", "last-name" : "Username", "display-name" : "My Username", "email" : "user@example.test", "active" : true }

code

Expand

title	Sample of an HTTP form content message

No Format
name=my_username&first-name=My&last-name=Username&display-name=My%20Username&email=user@example.test&active=true

Results

Response HeadersIn Result key, you can assign a name to the result that you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable. The default value is httpResponse.

The support for response headers can be enabled by toggling on the Enable response headers option.A default value for the key Result headers Key will be added by the engine (httpResponseHeaders) which will match the placeholder for the key input. Configuration is done by filling up the necessary input fields: Result Header Key and Result Key.

Note

HTTP Response Headers Support

By enabling response headers, the overall data size of the HTTP packets will also increase. Caching of the body checkbox check box is tied to the headers.

This option is available only for the HTTP Client collector and the HTTP Client Processor.

In Result Key, you can assign a name to the result that you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable. The default value is httpResponse
processor functions.
Info
Token Renewal Support
The collector and processor Functions functions support token renewal, if the servers return a 401 Token Expiry error.
Image Removed

Version	Old Version 5	New Version Current
Changes made by	Casey Han	Casey Han
Saved on	Jun 13, 2024	Jul 18, 2024

Action on error options	Description
Ignore	Select to ignore the error and the stream keeps on running.
Stop the stream	Select to stop the stream.

Page Comparison

Versions Compared

Key

Connection

Operational settings

General settings

Note!

Note!

Note!

Results

HTTP Response Headers Support

Token Renewal Support