Object Permissions Report

Report Name: Object Permissions Report (example)

File Name: EarthSoft.Reports.Library.97403.dll

Dependencies: Enterprise Schema and site

Software: EQuIS Professional, EQuIS Enterprise

Source: EQuIS Enterprise /bin folder

Language: Arabic, English, French, German, Spanish, and Portuguese

Output Type: Excel1

Description: The Object Permissions Report shows the permission granted or denied on a specified object for users or roles.

The report consists of a Microsoft Excel workbook with multiple worksheets. The first worksheet, called "Report Info", is an overview of the report including report runtime, run by, which object the permissions are for, and what report parameters were used. The two remaining worksheets show the permissions on the object for Users and Roles, respectively. The format of the Users and Roles worksheets is similar to the permissions grid. Instead of the rows listing objects with the associated permissions, the rows list users and roles with the associated permissions for the report's specified object that use numbers rather than icons to signify permission levels:

Value	Permission Type
0	None/Denied
1	Owner
2	Editor
4	Viewer
8	Creator
9	Owner + Creator
10	Editor + Creator
12	Viewer + Creator

If the user is an administrator, the report will list all users and roles. If not, the report will only list the logged-on user and any roles to which that user is a member.

Installation Instructions:

To access the report in Professional, the report must either be copied from the bin folder of the Enterprise package into the EQuIS installation folder, typically C:\Program Files\EarthSoft\EQuIS or (for per-user installation) %localappdata%\Programs\EarthSoft\EQuIS\. Alternatively, the report can be published to the database and stored in the database assembly.

To enable the report in Enterprise, do the following:

1.Publish the Reports – The two reports from the EarthSoft.Reports.Library.97403.dll assembly will need to be published to the database before they will work. Publishing can be achieved with EQuIS Professional. To publish using EQuIS Professional, follow the steps on the Publish a Report - Quick-start Guide page.

2.Grant Appropriate Permissions – Once the report has been published to the EQuIS database, users who do not already have permission to view the general report type will need to have at least Viewer permission granted to them for the report. The permission must be granted to this report specifically; granting any permission to a new report created from these reports (such as a saved user report) will not enable the download link in Enterprise.

In Enterprise, download links with the icon appear in the final column on the permissions grid located in the following areas:

•The User Profile window, accessible to administrators in the User Manager widget.

•The Permissions section of the Role Profile window, accessible to administrators in the Role Manager widget.

•The current logged-on user's profile, accessible within the More Options icon on the right side of the dashboard header.

These download links are available for an object type or a single object.

If the report is published and the user has permission, clicking on this download link icon will run the report and download it in the browser. The report will show the permissions granted or denied to users and roles on the EQuIS Enterprise object specified in that row of the permissions grid. If the user is not an administrator and is accessing the download link from the permissions grid on that user's User Profile, the report will only show permissions on the specified object effectively granted to that user and only to roles to which that user is a member. Changes to a user’s permissions must be saved to appear in the report.

Note: The “Groups and Folders” or “Modules” object types will show “Object Type: No Object selected” or “No Object selected” in the Description field of the “Report Info” tab, although the pertinent information is otherwise returned.

Overview:

Input Parameters

Object Type

Select the type or class of object. Note that if the Object Type is changed after selecting an Object ID, the Object ID will need to be reselected.

Object ID

Select the object upon which to see who has permissions granted or denied. Note that the Object Type must be selected first.

If the logged-on user is an administrator, the list will include all objects of the specified "Object Type". If not, the list will only include those objects to which the user has been granted at least Viewer permission.

Filter

Search Text

Enter in search text related to users and roles. This works the same as the search box on the permissions grid.

Note: The Object ID parameter may not populate when the report is run in Professional. If this behavior is observed, run the report in Enterprise via the EZView widget, or use the Download link in the Enterprise permissions grid to run the report for that object.

Tables: ST_ROLE, ST_USER, hidden XT_AUTH… tables

Data Requirements: N/A

Report Requirements: In EQuIS Professional, it is recommended to log in as an Enterprise user to run this report; otherwise, some parameters may not be able to be set and/or the report may not output any results.

1Excel report output requires a valid license of Microsoft Excel to view the output.