EnumSecurityClassRightsAndRolesForBiPub

Generates report in specified format (PDF, RTF, HTML or XLS) and returns a localized XML string that lists the specified users’ access rights to the specified security classes and the roles to which the users are assigned.

Syntax

<HFMwSecurity>.EnumSecurityClassRightsAndRolesForBiPub(bstrLanguage, bstrUsersXml, bstrClassesXml, lReportFormat, bstrReportTemplateFileName, ReportFileOut)
ArgumentDescription
bstrLanguage

String (ByVal). The two-letter language code representing the language in which to return the string. To obtain language codes, use GetLanguageCountryCodeFromLanguageId.

Input argument. String subtype.

bstrUsersXml

An XML string that specifies the users’ usernames and security identifiers. Following is the structure of the string, which must contain one <User> element per user:

<Users><User><Name>username</Name><Id>security identifier</Id></User></Users>

Input argument. String subtype.

bstrClassesXml

An XML string that specifies the names and IDs of the security classes. Following is the structure of the string, which must contain one <Class> element per security class:

<Classes><Class><Name>security class name</Name><Id>security class Id</Id></Class></Classes>

Input argument. String subtype.

lReportFormat

Value that specifies the report output format:

  • 1 = PDF format

  • 2 = RTF format

  • 3 = HTML format

  • 4 = XLS format

  • -1 = Financial Management format

Input argument. Long subtype.

bstrReportTemplateFileName

The BI Publisher report template name that is used to generate the report.

Input argument. String subtype.

ReportFileOut

Specifies the file name of the report generated.

Input argument. String subtype.

Return Value

Returns an XML string that specifies the users’ assigned roles and security class access and e-mail alerting rights Following is the structure of the string. There is one <User> element per user; each <User> element contains one <Role> element per assigned role, and one <Class> element per security class. The access rights flags are represented by the HFMConstants enumeration described in Access Rights Constants.

<UserRightsRoles><User name="username" ><Roles NODISPLAY='Yes/No'><Role>role name</Role><Classes NODISPLAY='Yes/No'><Class name="security class name" id="security class ID" alert="Boolean" rights="access rights flag" /></Classes></User></UserRightsRoles>

String subtype.