EnumUsersOnSystemEx2

Returns the usernames and other information applicable to all users logged on to or logged out of a given cluster. You can specify the language in which the names of the user’s active modules are returned. You can return information for users on all application servers, or filter by application, application server, and user. The information is returned in arrays that have a one-to-one correspondence.

Syntax

<HFMwManageApplications>.EnumUsersOnSystemEx2 bstrCluster, vbAllApplications, bstrAppName, vbAllServers, bstrServer, vbAllUsers, lActivityUserID, lLanguageID, pvaralActivitySessionIDs, pvaravarServerNames, pvaravarApplicationNames, pvaralActivityUserIDs, pvaravarUserNames, pvaralCurrentActivity, pvaravarModuleNames, pvaradTimeStarted, pvaravarUserDescs, pvaralSessionStatus
ArgumentDescription
bstrCluster

The name of the application server cluster.

Input argument. String subtype.

vbAllApplications

Indicates whether users of all applications are returned. Pass TRUE to return all users, FALSE to filter by application.

If you pass FALSE, you must pass an application name to the bstrAppName argument.

Input argument. Boolean subtype.

bstrAppName

The name of the application for which to return users. This is used only if the vbAllApplications argument is set to FALSE.

Input argument. String subtype.

vbAllServers

Indicates whether users of all application servers in the application server cluster are returned. Pass TRUE to return users for all servers, FALSE to filter by application server.

If you pass FALSE, you must pass an application server name to the bstrServer argument.

Input argument. Boolean subtype.

bstrServer

The name of the application server for which to return users. This is used only if the vbAllServers argument is set to FALSE.

Input argument. String subtype.

vbAllUsers

Indicates whether all users who meet the other arguments’ selection criteria are returned. Pass TRUE to return all users, FALSE otherwise.

If you pass FALSE, you must pass a value for the lActivityUserID argument.

Input argument. Boolean subtype.

lActivityUserID

The activity user ID for which to return users. This is used only if the vbAllUsers argument is set to FALSE.

Input argument. Long subtype.

lLanguageID

The ID of the language in which to return module names.

Tip:

You can use the HsvResourceManager method GetAvailableLanguages to obtain the IDs of the languages valid for a given release.

Input argument. Long subtype.

pvaralActivitySessionIDs

Returns an array of activity session IDs for the users.

Note:

Because a user can be logged on to multiple sessions of Financial Management, these activity session IDs are generated by the system to uniquely identify each user session.

Input/output argument.

pvaravarServerNames

Returns an array containing the names of the servers to which the users are logged on.

Note:

This is a 1-based array.

Input/output argument.

pvaravarApplicationNames

Returns an array containing the names of the applications to which the users are logged on.

Note:

This is a 1-based array.

Input/output argument.

pvaralActivityUserIDs

Returns an array containing the activity user IDs of the logged on users.

The corresponding item in the array returned by the pvaravarUserNames argument contains the username associated with an activity user ID.

Input/output argument.

pvaravarUserNames

Returns an array containing the usernames of the logged on users.

Note:

This is a 1-based array.

Input/output argument.

pvaralCurrentActivity

Returns an array of activity IDs that identify the users’ current activities. Valid values are represented by the HFMConstants type library constants listed in User Activity Constants.

Input/output argument.

pvaravarModuleNames

Returns an array containing the names of the modules in which the users are active.

Note:

This is a 1-based array.

Input/output argument.

pvaradTimeStarted

Returns an array of timestamps indicating when the users logged on.

Note:

Array items are in a Double format. To render user-readable dates and times, you must perform conversions. For example, in VBScript, passing an array item to CDate returns a user-readable date and time.

Input/output argument.

pvaravarUserDescs

Future use. An array is returned, but you can ignore it.

Note:

This is a 1-based array.

Input/output argument.

pvaralSessionStatus

Returns an array of status IDs that identify the user’s task status. Valid values are represented by the HFMConstants type library constants listed in Task Status Constants“.

Input/output argument.