HypCreateConnection

Data source types: Essbase, Financial Management, Hyperion Enterprise

Description

HypCreateConnection() creates a connection to the data source provider from the specified information. See also HypCreateConnectionEX.

Note:

Planning users who want to add data sources in the Smart View Panel must use HypCreateConnectionEX.

Note:

Use HypConnect to establish the connection.

Syntax

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

ByVal vtSheetName As Variant — not used

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

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

vtPassword: Text name of the password for this user.

vtProvider: Description for the data source provider. Supported vtProvider types:

  • New: Global Const HYP_ESSBASE = "Essbase"

  • New: Global Const HYP_PLANNING = "Planning"

  • New: Global Const HYP_OBIEE = "OBIEE"

  • Deprecated: Global Const HYP_ANALYTIC_SERVICES = "Analytic Provider Services"

  • Global Const HYP_FINANCIAL_MANAGEMENT = "Hyperion Financial Management"

vtProviderURL: Data source provider URL which to connect.

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

vtApplication: Name of the application.

vtDatabase: Name of the database.

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

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 vtDatabase As Variant, ByVal vtFriendlyName As Variant, ByVal vtDescription As Variant) As Long

Sub Conn()
	X=HypCreateConnection(Empty, username, password, HYP_ANALYTIC_SERVICES,
	"http://localhost:13080/smartview/SmartView", “localhost”, “Sample”, 
	“Basic”, “My Connection”, “Analytic  Provider Services”)
End Sub