Report Server Security Extension (RSSE) API data types
This section describes the RSSE API data types. Some data types have the same name as data types within the IDAPI, but do not have the same content.
Arrays of data types
Data type definitions can be grouped into arrays. Each array has a specific definition for that data type.
The following data types have arrays defined and used in the RSSE:
Permission
PropertyValue
String
UserAndProperties
ErrorMessage
The contents of a error message, including the request name, error code, and description.
Elements
RequestName
The request name or call included in the error message.
ErrorCode
The error code.
Description
The description associated with the error code.
Permission
A complex data type that describes a user access rights.
Elements
RoleName
The role name.
UserName
The user name.
AccessRight
The privileges the user or role has on an object. One or more of the following characters representing a privilege:
D—Delete
E—Execute
G—Grant
V—Visible
S—Secured Read
R—Read
W—Write
PropertyValue
A complex data type that describes a name-value pair.
Elements
Name
The name portion of the name-value pair.
Value
The value portion of the name-value pair.
TranslatedRoleNames
A complex data type that describes the role names RSSE uses that match external role names.
Elements
Administrator
The Administrator role name.
Operator
The Operator role name.
All
All other role names.
TranslatedUserNames
A complex data type that describes the administrator name RSSE uses that matches the external administrator name.
Elements
Administrator
The Administrator user name.
User
A complex data type describing an RSSE user and their attributes.
Elements
Name
The username used to connect to iHub.
EmailAddress
The user e-mail address.
HomeFolder
The users’s home folder.
LicenseOptions
The user license options.
ViewPreference
The user viewer, Default or DHTML.
MaxJobPriority
The maximum priority that the user can assign to a job.
SendNoticeForSuccess
Specifies whether the BIRT iHub sends success notices to the user.
SendNoticeForFailure
Specifies whether the BIRT iHub sends failure notices to the user.
SuccessNoticeExpiration
Specifies the minimum number of minutes success notices remain in the Completed folder. To set the user success notices to never expire, set the value to 0xffffffff.
FailureNoticeExpiration
Specifies the minimum number of minutes failure notices remain in the Completed folder. To set the user failure notices to never expire, set the value to 0xffffffff.
SendEmailForSuccess
Specifies whether the BIRT iHub sends success notices in an e-mail message to the user.
SendEmailForFailure
Specifies whether the BIRT iHub sends failure notices in an e-mail message to the user.
AttachReportInEmail
Specifies whether to attach a report to an e-mail completion notice.
UserAndProperties
A complex data type describing an RSSE user and properties, such as privileges and roles.
Elements
User
The reference to the user object that contains the details to use to connect to iHub.
PrivilegeTemplate
Permission list as specified in privilege template.
Permission