Data provider types: Oracle Analytics Cloud - Essbase

Description

Add custom HTTP headers using this function. Once set, all requests made by Oracle Smart View for Office will include this header as part of the request.

This function may be used for signing on to providers that use the OAuth 2.0 token for authentication, such as Oracle Analytics Cloud - Essbase.

For example, with Oracle Analytics Cloud - Essbase, users can generate an OAuth bearer token by connecting to Oracle Identity Services Cloud and providing necessary information (Client ID, Client Secret, etc.). Once the token is generated, this token can be added to the header.

Syntax

HypSetCustomHeader Lib "HsAddin" (vtHeader) As Long

ByVal vtHeader As Variant

Parameters

vtHeader: Content of this parameter will be added to existing HTTP headers. Parameter content must conform to HTTP header semantics. This parameter can then be added to the authorization header. See the Example for more information.

Return Value

Returns 0 if successful; otherwise, returns the appropriate error code.

Example

Public Declare PtrSafe Function HypSetCustomHeader Lib "HsAddin" (ByVal vtHeader As Variant) As Long

AuthHeader = "Authorization: Bearer " + token
   sts = HypSetCustomHeader(AuthHeader)