UM_InitiateUserListingByGroupReport

This web service retrieves information about the user population registered in the OLSA environment. You can specify the user population to list with the following options:

allUsers - When true it means all top-level groups will be selected and subGroupName must be empty.
subGroupName - When non-empty it means use the named subgroup, allUsers must be set to false.
includeSubGroups - True means include all users in the selected group's subgroups.
listBySubgroups - True means organize users by sub groups.

The function returns reports in HTML or CSV formats. Table 6 lists a sample user listing by group CSV report fragment with allUsers, includeSubGroups and listBySubgroups all set to true. The table does not show all CSV fields.

GroupTitle	GroupPath	groupCode	LoginName	LastName	FirstName
SkillSoft	/SkillSoft	SkillSoft	Admin	Admin	Admin
SkillSoft	/SkillSoft	SkillSoft	Smith1	Smith1	John
HR Team	/SkillSoft/HR Team	HR_TEAM	Jones1	Jones1	Fred
Books24x7	/Books24x7	Books24x7	Jones2	Jones2	Bill
Books24x7	/Books24x7	Books24x7	Smith2	Smith2	Sally

Table 6. Sample User Listing by Group Report

The UM_InitiateUserListingByGroupReport reports assumes the following user population that has been registered into the OLSA environment.

Figure 5. Sample User Hierarchy

Inputs

customerId - This refers to the sname provided by SkillSoft. The string identifies the customer of the OLSA environment.
allUsers - true or false
subGroupName - non-empty only if allUsers==false
includeSubGroups - true or false
listBySubgroups - true or false
reportFormat - Format of the report to generate. Formats include: CSV16, CSV, and HTML.

Outputs

A report ID handle. Use this value with the UTIL_PollForReport function to get the actual contents of the report.

Additional Faults

None