HypCreateConnectionEx
Describes the Oracle Smart View for Office VBA function, HypCreateConnectionEx.
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
HypCreateConnectionEx is a superset of HypCreateConnection; it has additional parameters that enable use of the Smart View Panel. Oracle Hyperion Planning users who want to add data providers in the Smart View Panel must use HypCreateConnectionEx.
For Essbase, Oracle Hyperion Planning, and Financial Management, HypCreateConnectionEx can be used to create private connections using a Workspace URL.
Note:
HypCreateConnectionEx is not supported for shared connections. HypCreateConnectionEx is for private connections only.
Syntax
HypCreateConnectionEx (vtProviderType, vtServerName, vtApplicationName, vtDatabaseName, vtFormName, vtProviderURL, vtFriendlyName, vtUserName, vtPassword, vtDescription, vtReserved1, vtReserved2)
ByVal vtProviderType As Variant
ByVal vtServerName As Variant
ByVal vtApplicationName As Variant
ByVal vtDatabaseName As Variant
ByVal vtFormName As Variant
ByVal vtProviderURL As Variant
ByVal vtFriendlyName As Variant
ByVal vtUserName As Variant
ByVal vtPassword As Variant
ByVal vtDescription As Variant
ByVal vtReserved1 As Variant (reserved for future use)
ByVal vtReserved2 As Variant (reserved for future use)
Parameters
vtProviderType: The data provider. Supported vtProviderType types:
-
Global Const HYP_ESSBASE = "Essbase"
-
Global Const HYP_PLANNING = "Planning"
-
Global Const HYP_FINANCIAL_MANAGEMENT = "Financial Management"
-
Global Const HYP_RA = "Hyperion Smart View Provider for Hyperion Reporting and Analysis"
vtServerName: The name of the server on which the application resides
vtApplicationName: The name of the application
vtDatabaseName: The name of the database
vtFormName: The name of the data form. Required to create Oracle Hyperion Planning connection in Smart View Panel under Private Connections.
vtProviderURL: The data provider URL. Required to create Oracle Hyperion Planning connection in Smart View Panel.
vtFriendlyName: The connection name of the data provider
vtUserName: A valid user name
vtPassword: The password for this user
vtDescription: Description for the data provider
Note:
For Oracle Hyperion Reporting and Analysis, only the provider URL, provider type, and connection name are required.
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
Public Declare Function HypCreateConnectionEx Lib "HsAddin" (ByVal vtProviderType As Variant, ByVal vtServerName As Variant,ByVal vtApplicationName As Variant,ByVal vtDatabaseName As Variant, ByVal vtFormName As Variant, ByVal vtProviderURL As Variant, ByVal vtFriendlyName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtDescription As Variant, ByVal vtReserved1 As Variant, ByVal vtReserved2 As Variant) As Long
Sub Example_HypCreateConnectionEx()
Dim lRet As Long
lRet = HypCreateConnectionEx("Essbase", "server12", "Demo", "Basic", "", "", "My Demo", "Username", "Password", "", "", "")
lRet = HypCreateConnectionEx("Planning", "planqe14", "TotPlan", "", "/Forms/Smart View Forms/01 Product Revenue", "http://planqe14:8300/HyperionPlanning/SmartView", "My Planning VBA Conn", "UserName", "Password", "", "", "")
End Sub