HypCreateConnectionEx

Data source types: Essbase, Planning, Financial Management, Hyperion Enterprise

Description

HypCreateConnectionEX is a superset of HypCreateConnection; it has additonal parameters that enable use of the Smart View Panel. Planning users who want to add data sources in the Smart View Panel must use HypCreateConnectionEX.

Syntax

HypCreateConnection(vtUserName, vtPassword, vtProvider, vtProviderURL, vtServerName, vtApplicationName, vtDatabaseName, vtFriendlyName, vtDescription)

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: Description for the data source provider. Supported vtProvider types:

  • Global Const HYP_ESSBASE = "Essbase"

  • Global Const HYP_PLANNING = "Planning"

  • Global Const HYP_OBIEE = "OBIEE"

  • Global Const HYP_FINANCIAL_MANAGEMENT = "Hyperion Financial Management"

vtServerName: Name of the server on which the application resides.

vtApplication: Name of the application.

vtDatabase: Name of the database.

vtFormName: Name of the data form. Required to create Planning connection in Smart View Panel under Favorites

vtUserName:Text name of a valid user on the server.

vtPassword: Text name of the password for this user.

vtProviderURL: Data source provider URL which to connect. Required to create Planning connection in Smart View Panel.

vtFriendlyName: Connection name for the data source provider.

vtDescription: Description for the data source provider.

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 CreateConnExTest()

Dim lRet As Long
lRet = HypCreateConnectionEx("Essbase", "server12", "Demo", "Basic", "", "", "My Demo", "system", "password", "", "", "")

lRet = HypCreateConnectionEx("Planning", "planqe14", "TotPlan", "", "/Forms/Smart View Forms/01 Product Revenue", "http://planqe14:8300/HyperionPlanning/SmartView", "My Planning VBA Conn", "admin", "password", "", "", "")

End Sub