Exago .NET API Documentation
WebReports.Api.Roles Namespace
Inheritance Hierarchy
The Roles namespace contains classes used to interact with roles.
Classes
 ClassDescription
ClassA DataObject object represents an Exago Data Object (aka an Entity) that in the Role's DataObjectCollection. Depending on the value of DataSourceCollection's IncludeAll Property, the DataObject's in the collection will either be included or excluded from the Role.
ClassA DataObjectCollection represents all of the Data Objects defined in the Role's Data Objects list. Each data object in the list is represented by a DataObject object. Additionally, the Include All Folders, All Folders Read Only and Allow Folder Management settings (from the Main section of the Admin Console) are defined in this class. Do not instantiate it, reference it from the Role.Security.DataObjects property.
ClassA DataObjectRow represents a single data object tenancy filter, as if it were defined in Admin Console > Roles > Filters. DataObjectRow objects are kept in a DataObjectRowCollection object.
ClassA DataObjectRowCollection represents all of the Data Object Filters (aka row filters) defined in the Role's Filters list. Each row filter in the list is represented by a DataObjectRow object. Do not instantiate it, reference it from the Role.Security.DataObjectRows property.
ClassA Folder object represents a single Folder in the collection of Folders that the Role will either be permitted to or restricted from.
ClassA FolderCollection represents all of the Folders defined in the Role's folder list. Each folder in the list is represented by a Folder object. Additionally, the Include All Folders, All Folders Read Only and Allow Folder Management settings (from the Main section of the Admin Console) are defined in this class. Do not instantiate it, reference it from the Role.Security.Folders property.
Class

The General class holds all of the Role's General Settings overrides.

Do not instantiate this class, instead access it through the Role object's General Property.

Class

Roles are created to specify how a user or group of users interfaces with Exago. Roles can restrict access to folders or data objects. Roles can also override the General Settings.

A Role object refers to the definition of an Exago Role. At minimum, a role contains an ID (name), a General object representing any General Settings overrides and a Security object representing data object or report tree folder tenancy.

ClassA RoleCollection represents a collection of all of the Roles in the system configuration. Do not instantiate this collection, instead access it through the api.Roles property.
Class

In addition to the General Settings, Roles offer a layer of security by:

  • granting or restricting access to certain folders in the Report Tree, by way of the Folder and FolderCollection classes — this is similar to the Folders section of the Role's Admin Console settings
  • granting or restricting access to certain Data Objects, by way of the DataObject and DataObjectCollection classes — this is similar to the Objects section of the Role's Admin Console settings
  • further restricting access to certain rows in Data Objects, by way of the DataObjectRow and DataObjectRowCollection classes — this is similar to the Filters section of the Role's Admin Console settings
See Also

Reference

WebReportsApi Assembly