HsvSystemInfo Type Library Overview

The HsvSystemInfo type library contains one object, the HsvSystemInfo object. Use the HsvSystemInfo object to get and set various types of system information such as application directories, server names, and task audit histories.

The HsvSystemInfo object is a child of the HsvSession object. Use HsvSession’s SystemInfo property to assign HsvSystemInfo object references as shown in the following example:

  Dim cHsvSystemInfo As HsvSystemInfo
  Set cHsvSystemInfo = cHsvSession.SystemInfo

The following table lists the HsvSystemInfo object’s methods.

Table 28. HsvSystemInfo Object Methods

Method

Description

AddRefToHsxServer

For internal use.

AddTaskToAudit

Adds a given task for the user to the audit log.

AddTaskToRunningTasks

For internal use.

AddTaskToRunningTasksAndUpdatePOV

For internal use.

CheckAccess

Indicates whether the current user has access to the application.

ClearAuditTasks

Deletes the task audit history for all tasks that meet the specified criteria.

ClearAuditTasks2

Deletes the audit history for a given task that meets the specified criteria.

ClearRunningTask

For internal use.

DeleteUserParameter

Deletes a user parameter that has been created with SetUserParameter.

DisableNewConnections

Disables new Financial Management connections for the specified user and application server criteria.

EnableNewConnections

Enables new Financial Management connections for the specified user and application server criteria.

EnumActivityServers

Returns the names of the application servers for which there are task audit and data audit records.

EnumActivityUsers

Returns the usernames of all users who have performed at least one activity in the application.

EnumActivityUsersForRunningTasks

For internal use.

EnumAuditTasks

Returns task audit information from a given range of audit records that meet the selection criteria. Criteria include date range, application server, and user.

EnumAuditTasks2

Returns task audit information from a given range of audit records that meet the selection criteria. Criteria include task, date range, application server, and user.

EnumProhibitConnections

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

EnumRunningTasks

Returns information about the running tasks that meet the selection criteria.

EnumRunningTasksEx

Returns information about the running tasks that meet the selection criteria; the information returned includes an array of flags that indicate whether the tasks currently are running or stopped.

EnumRunningTasksPOV

Returns the dimension members, consolidation types, and other information for the running consolidations that meet the selection criteria.

ExtractTaskAudit

Extracts to a file the task audit records that meet the specified criteria. Criteria include date range, application server, user, and task.

ExtractTaskAudit2

Extracts to a file the task audit records that meet the specified criteria. Criteria include date range, application server, user, and task.

GetActivityCodeDesc

Returns the description of a given type of activity.

GetActivityUserID

Returns the activity user ID for a given username.

GetApplicationDirectory

Returns the name of the application folder for an application.

GetApplicationName

Returns the name of the application to which the client is connected.

GetCalcRulestype

For internal use.

GetCOMDLLCalcRules

For internal use.

GetCurrentActivity

Returns information about the user’s current activity.

GetExtractFileEncoding

Returns the type of file encoding for extracted files.

GetFormattedDateTime

Returns a string representation of the given double-byte date/time value using the language ID for the connected user.

GetFormattedResourceString

For internal use.

GetRunningTaskLogFilePathName

Returns the name and path of the log file for a given running task.

GetRunningTaskProgress

Returns information on the progress of a given running task.

GetRunningTasksCount

Returns the number of currently running tasks for the application.

GetRunningTaskStatus

Returns the status of a given task.

GetKillUsersStatus

For internal use.

GetKillUserStatus

Indicates whether an administrator has logged off the current user.

GetLanguageUserParameters

Gets the language in which member descriptions are displayed for the connected user.

GetLastModifiedDateForArtifactFor internal use.

GetModuleName

Returns the name of the module represented by a given module ID.

GetNumberFormattingUserParameters

Returns the double-byte Integers that identify the user’s decimal and thousands separator characters.

GetResourceLanguageUserParameters

Returns the ID of the user’s default language for resource strings such as error messages and other strings that are generated on the server.

GetResourceString

For internal use.

GetServerName

Returns the name of the server to which the client is connected.

GetUserName

Returns the username of the connected user.

GetUserParameter

Returns the value of a user parameter that has been set with SetUserParameter.

GetVBScriptCalcRules

Returns the rules that have been loaded into an application. The rules are returned as an array of bytes.

GetVBScriptCalcRulesEX

For internal use.

GetVBScriptMemberListRules

Returns an application’s member lists as an array of bytes in the .LST file format.

GetWorkingDirectory

For internal use.

IsScheduledTaskReadyToRun

For internal use.

KeepRunningTaskStillAlive

For internal use.

KillUsers

Logs off users.

OutputSystemInfo

For internal use.

pIHsvDSSecurityUnkFor internal use.
pIHsvDSReportsUnkFor internal use.

ReleaseHsxServer

For internal use.

SetApplicationDirectory

For internal use.

SetCOMDLLCalcRules

For internal use.

SetCurrentActivity

Sets the activity for the current user.

SetCurrentModule

Sets the current module using a module name.

SetCurrentModuleEx

Sets the current module using a module ID.

SetExtractFileEncoding

Sets the file encoding type for extracted files.

SetLanguageUserParameters

Sets the language in which member descriptions are displayed for the connected user.

SetNumberFormattingUserParameters

Sets the user’s decimal and thousands separator characters.

SetResourceLanguageForCurrentSession

Sets the language for a user’s resource strings in the current session. The specified language does not persist beyond the current session.

SetResourceLanguageUserParameters

Sets the user’s default language for resource strings such as error messages and other strings that are generated on the server.

SetUserParameter

Sets a parameter for the user. Use SetUserParameter to create and edit custom parameters for items such as personal preferences.

SetVBScriptCalcRules

Validates and loads a rules file; a flag determines whether SetVBScriptCalcRules loads after validation or validates without loading.

SetVBScriptMemberListRules

Validates and loads a member lists file; a flag determines whether SetVBScriptMemberListRules loads after validation or validates without loading.

StopRunningTask

Stops a given task.

UpdateRunningTaskLogFilePathName

For internal use.

UpdateRunningTaskPOV

For internal use.

UpdateRunningTaskProgress

For internal use.

UpdateRunningTaskProgressDetails

For internal use.

UpdateRunningTaskStatus

For internal use.

UpdateUserAppPreferences

For internal use.

WarnUsersForShutDown

For internal use.

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