HsxClient Type Library Overview

The HsxClient type library contains one object, the HsxClient object. The HsxClient object connects to applications and provides other client tier functionality.

Assign HsxClient object references with the Set keyword as shown in the following example:

  Dim cHsxClient As HsxClient
  Set cHsxClient = New HsxClient

Use the SetLogonInfoSSO and OpenApplication methods to log on and to connect to applications. Note that OpenApplication returns object references to the HsxServer and HsvSession objects.

Tip:

The HsxClientUI type library’s methods provide dialogs that offer similar functionality to some of the HsxClient methods. The HsxClientUI methods are introduced in HsxClientUI Type Library Overview.

The following table lists the HsxClient object’s methods.

Table 4. HsxClient Object Methods

Method

Description

AuthenticateCSSToken

For internal use.

AuthenticateSecurityAgentCredentials

For internal use.

AuthenticateUserCredentials

For internal use.

AuthenticateUserOnCluster

For internal use.

AuthenticateUserOnClusterSSO

For internal use.

AuthenticateUserOnServer

For internal use.

CreateApplication

Deprecated.

CreateApplicationCAS

Creates a Classic application.

CreateApplicationCASWithAccessCodeFor internal use.

CreateObjectOnCluster

Instantiates an object on a cluster or application server.

CreateObjectOnServer

Deprecated - use CreateObjectOnCluster.

DeleteApplication

Deletes a Classic application.
DeleteApplicationWithAccessCodeFor internal use.

DeleteSystemErrors

Deletes records of system errors for a cluster.

DetermineWindowsLoggedOnUser

Returns the domain name and the username of the user who is logged onto Windows.

DisableNewConnections

Disables new Financial Management connections to a cluster for the specified application and application server criteria.

DoesUserHaveCreateApplicationRights

Indicates whether the connected user is a member of the Creator group for a given application server cluster.

DoesUserHaveSystemAdminRights

Indicates whether the connected user is a member of the Administrator group for a given application server cluster.

EnableNewConnections

Enables new Financial Management connections to a cluster for the specified application and application server criteria.

EnumProhibitConnections

Returns information on the applications, application servers, and users for which connections have been disabled on a given cluster.

EnumProvisioningProjects

Returns the names of the provisioning projects for Oracle's Hyperion® Shared Services associated with a given cluster.

EnumRegisteredClusterNames

Returns an array containing the names of the clusters or application servers that have been registered for the client.

EnumRegisteredClustersOrServers

For internal use.

EnumRegisteredServerNames

Deprecated - use EnumRegisteredClusterNames.

EnumUserAppPreferences

For internal use.

EnumUsersOnSystem

Returns the usernames of and other information applicable to the users logged on to a given cluster.

EnumUsersOnSystemEx

Returns the usernames of and other information applicable to users logged on to a given cluster; you can specify the language in which the names of the user’s active modules are returned.

EnumUsersOnSystemEx2

Returns the usernames and other information applicable to all users logged on to / logged out from a given cluster.

GetApplicationFolder

Returns the path of an application’s local storage folder.

GetClusterInfo

Returns the name of the cluster to which the specified application server is assigned.

GetHFMErrorLogRecordSet

For internal use.

GetLogonInfo

Deprecated - use GetLogonInfoSSO.

GetLogonInfoSSO

Gets the domain, username, and external authentication token for the connected user.

GetServer

Deprecated - use GetServerOnCluster.

GetServerOnCluster

Returns an object reference to the HsxServer object that represents the specified cluster or server.

GetSSOTokenUsingWebSecurityAgentCredentials

For internal use.

GetWebSecurityAgentSettings

For internal use.

IsValidApplicationIndicates whether the specified application exists on the specified cluster.

KillUsers

Logs off users from a cluster.

OpenApplication

Opens an application. OpenApplication also sets object references to the HsxServer and HsvSession objects.

RegisterApplicationCAS

Registers a Classic application with Shared Services.
RegisterApplicationCASWithAccessCodeFor internal use.

RegisterCluster

Registers a cluster or application server for a client.

RegisterServer

Deprecated - use RegisterCluster.

ScriptableEnumRegisteredClusterNames

For internal use.

ScriptableEnumRegisteredServerNames

For internal use.

ScriptableGetLogonInfoSSO

For internal use.

ScriptableOpenApplication

For internal use.

SetApplicationFolder

Sets an application’s local storage folder.

SetLogonInfo

Deprecated - use SetLogonInfoSSO.

SetLogonInfoSSO

Sets logon information such as the user’s name, password, domain or sets an SSO token.

UnregisterAllClusters

Unregisters all the clusters or application servers that are registered for the client.

UnregisterCluster

Unregisters the specified cluster or application server.

UnregisterServer

Deprecated - use UnregisterCluster.

WarnUsersForShutDown

For internal use.

For detailed descriptions of these methods, see HsxClient Object Methods.