Note

This version of the .NET API documentation is deprecated. A new version can be found at https://www.exagoaccess.com/api-docs/.

Classes are listed below in alphabetical order by class name.

DataObject Class

The DataObject class can allow or deny access to specific Data Objects for a particular user session.

Properties

A DataObject object has the following property:

• Name – The name (non-mnemonic) of the Data Object to include or exclude.
  • A DataObject in the DataObjectCollection will be excluded if the property IncludeAll is True and included if it is False.

Methods

A DataObject object has no available methods.

DataObjectCollection Class

Note

This collection should not be instantiated.

There is a single DataObjectCollection object that is accessed through the DataObjects property of the Security object.

Properties

The DataObjectCollection has the following property:

• IncludeAll – Boolean indicating whether to include all of the Data Objects (default) or none of the Data Objects.

The DataObjects property of a Security object has the following method:

GetDataObject(string dataObjectName)

NewDataObject()

DataObjectRow Class

The DataObjectRow class can set Row Level filters to Data Objects for a particular user session.

Properties

A DataObjectRow object has the following properties:

• ObjectName – The name (non-mnemonic) of the Data Object.
• FilterString – The filter string for the Data Object. The filter string will be placed into the SQL WHERE clause.

Methods

A DataObjectRow object has no available methods.

DataObjectRowCollection Class

Note

This collection should not be instantiated.

There is a single DataObjectRowCollection object that is accessed through the DataObjectRoles property of the Security object.

Methods

The DataObjectRoles property of a Security object has the following method

GetDataObject(string dataObjectRowName)

NewDataObjectRow()

Folder Class

The Folder class is used to allow or deny access to folders or sets folders as execute-only for a particular user session.

Properties

A Folder object has the following properties:

• Name – The name (non-mnemonic) of the folder to include/exclude.
  • The folder in the FolderCollection will be excluded if the property IncludeAll is True and included if it is False.
• ReadOnly – Boolean indicating whether a folder is read only. Default is False.
• Propagate – Not used: Parameters set for a folder are always propagated down to all of its subfolders unless parameters for specific child folder are set.

Methods

A Folder object has no available methods.

FolderCollection Class

Note

This collection should not be instantiated.

Caution

The Report Tree should contain no more than 1,000 items in it for best user experience.

There is a single FolderCollection object that is accessed through the Folders property of the Security object.

A FolderCollection object has the following property:

• IncludeAll – Boolean indicating whether to include all of the folders (default) or none.
• ReadOnly – Global read-only for all of the folders in the collection. Individual Folder objects can be set with a different ReadOnly property.
• AllowManagement – Boolean indicating whether or not to allow users to manage folders. Set to False to hide the Manage Folder Icon.

The Folders property of a Security object has the following method:

GetFolder(string folderName)

NewFolder()

General Class

Note

This collection should not be instantiated.

The General class is utilized to overwrite the General Settings of the Administration Console. There is a single General object that is accessed through the General property of the Role object.

Properties

The General property of the Role object has the following properties:

• DbTimeout – The amount of time (in seconds) to allow the database to execute a query before returning to Exago.
• DateFormat – Used to format dates on a report output.
• CurrencySymbol – The symbol prepended to currency numbers on a report output.
• SeparatorSymbol – The symbol used to separate 3 digits of number on a report output.
• ReadFilterValues – Boolean value that indicates whether to show a list of data values associated with a specific filter in the Report Filters window. In certain cases, allowing this can result in a lengthy delay of showing filter values, however, this depends on the amount of data, the complexity of data object, etc.  If the delay is unacceptable, setting this value to ‘false’ will disable the feature.
• ShowGrid – Boolean value that indicates whether to show the grid in the Report Designer. Also sets the ‘Show Grid Lines’ default HTML in Report Options.
• ReportVirtualPath – IIS virtual path for the location of the report path.

Methods

The General property of the Role object does not have any available methods.

Parameter Class

The Parameter class is used to create and modify Parameters.

Properties

A Parameter object has the following properties:

• Id – Name of the parameter.

Note

Parameter names are case sensitive.

• Value – The value being stored in the parameter.

Methods

A Parameter object has the following available methods:

Constructor(string paramId, string paramValue)

ParameterCollection Class

Note

This collection should not be instantiated.

There is a single ParameterCollection object that is accessed through the Parameters property of the Api object.

Methods

The Parameter property of an Api object has the following method:

GetParameter(string parameterId)

Role Class

Note

This collection should not be instantiated.

The Role class contains all of the information concerning General and Security parameters. A Role can be created at runtime and used for a single session or loaded from the roles that have been created through the Admin Console. For more information see Roles.

There is a single RoleCollection object that is accessed through the Role property of the Api object.

Properties

A Role object may have the following properties:

• General – Access to all of the General Parameters. See General Class.
• Security – Access to all of the Security Parameters. See Security Class.
• IsActive – Queries the Active Role Id to determine if the current Role is active. Sets the Active Role Id to the specified value.
  
• IsMarkedActive– Used to read the isActive setting. For support of older, non-static configuration architectures only.

Methods

A Role object has the following methods available:

Activate()

RoleCollection Class

Note

This collection should not be instantiated.

There is a single RoleCollection object that is accessed through the Roles property of the Api object.

Properties

A RoleCollection object may have the following properties:

• ActiveRole – Queries the Active Role Id setting and locates the active role. If no active role is set, returns a new Role().

Methods

A RoleCollection object has the following methods available:

GetRole(string roleId)

NewRole()

FindActive()

Security Class

Note

This collection should not be instantiated.

The Security class contains all of the security parameters for a user session.

There is a single Security object that is accessed through the Security property of the Role object.

Properties

The Security object has the following properties:

• Folders – Controls access to all of the FolderCollection parameters. See FolderCollection
• DataObjects – Controls access to all of the DataObjectCollection parameters. See DataObjectCollection
• DataObjectRows – Controls access to all of the DataObjectRowCollection parameters. See DataObjectRowCollection

Methods

There are no available methods for a Security object.