HypCreateConnection
Describes the Oracle Smart View for Office VBA function, HypCreateConnection.
Cloud data provider types: Oracle Analytics Cloud - Essbase, Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting
On-premises data provider types: Oracle Essbase, Oracle Hyperion Planning, Oracle Hyperion Financial Management
Description
HypCreateConnection() creates a private connection to the data provider from the specified information.
Note:
HypCreateConnection is not supported for shared connections. HypCreateConnection is for private connections only.
Syntax
HypCreateConnection(vtSheetName, vtUserName, vtPassword, vtProvider, vtProviderURL, vtServerName, vtApplicationName, vtDatabaseName, vtFriendlyName, vtDescription)
ByVal vtSheetName As Variant
ByVal vtUserName As Variant
ByVal vtPassword As Variant
ByVal vtProvider As Variant
ByVal vtProviderURL As Variant
ByVal vtServerName As Variant
ByVal vtApplicationName As Variant
ByVal vtDatabaseName As Variant
ByVal vtFriendlyName As Variant
ByVal vtDescription As Variant
Parameters
vtSheetName: Not used
vtUserName: A valid user name
vtPassword: The password for this user
vtProvider: The data provider. Supported vtProvider types:
-
Global Const HYP_ESSBASE = "Essbase"
-
Global Const HYP_FINANCIAL_MANAGEMENT = "Hyperion Financial Management"
-
Global Const HYP_PLANNING = "Planning"
-
Global Const HYP_RA = "Hyperion Smart View Provider for Hyperion Reporting and Analysis"
Note:
The global constant HYP_ANALYTIC_SERVICES = "Analytic Provider Services" is deprecated.
vtProviderURL: The URL of the data provider
vtServerName: The name of the server on which the application resides
vtApplicationName: The name of the application
vtDatabaseName: The name of the database
Note:
Financial Management only: This parameter is required, but you cannot use the name of the application. Instead, use Empty or Null for this parameter.
vtFriendlyName: The connection name of the data provider
vtDescription: A description of the data provider
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
Declare Function HypCreateConnection Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtProvider As Variant, ByVal vtProviderURL As Variant, ByVal vtServerName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtFriendlyName As Variant, ByVal vtDescription As Variant) As Long
Sub Example_HypCreateConnection()
X = HypCreateConnection(Empty, UserName, Password, HYP_ESSBASE, "http://localhost:13080/smartview/SmartView", "localhost", "Sample", "Basic", "My Connection", "Essbase_1")
End Sub