Edit

ConfigurationSetting method - GenerateDatabaseRightsScript

  • Article

Generates a SQL script that you can use to grant a user access to the report server database. Additionally, it grants access to other databases required for a report server to run. The caller should connect to the SQL Server database server and execute the script.

Syntax

Public Sub GenerateDatabaseRightsScript(ByVal UserName As String, _  
    ByVal DatabaseName As String, ByVal IsRemote As Boolean, _  
    ByVal IsWindowsUser As Boolean, ByRef Script As String, _  
    ByRef HRESULT As Int32)  

public void GenerateDatabaseRightsScript(string UserName, string DatabaseName, bool IsRemote, bool IsWindowsUser, out string Script,   
out Int32 HRESULT);

Parameters

UserName
The user name or Windows security identifier (SID) of the user to which the script grants rights.

DatabaseName
The database name to which the script grants access to the user.

IsRemote
A Boolean value to indicating whether the database is remote from the report server.

IsWindowsUser
A Boolean value indicating whether the specified user name is a Windows user or a SQL Server user.

Script
[out] A string containing the generated SQL Server script.

HRESULT
[out] Value indicating whether the call succeeded or failed.

Return value

Returns an HRESULT indicating success or failure of the method call. A value of 0 indicates that the method call was successful. A nonzero value indicates that an error occurred.

Remarks

If DatabaseName is empty, then IsRemote is ignored and the report server configuration file value is used for the database name.

If IsWindowsUser is set to true, UserName should be in the format <domain>\<username>.

When IsWindowsUser is set to true, the generated script grants sign in rights to the user for the SQL Server, setting the report server database as the default database, and grants the RSExec role on the report server database, the report server temporary database, the main database and the MSDB system database.

When IsWindowsUser is set to true, the method accepts standard Windows SIDs as input. When you supply standard Windows SID or service account name, the name translated to a user name string. If the database is local, the account is translated to the correct localized representation of the account. If the database is remote, the account is represented as the computer's account.

The following table shows accounts that are translated and their remote representation.

Account / SID that is translated Common Name Remote Name
(S-1-5-18) Local System <Domain>\<ComputerName>$
.\LocalSystem Local System <Domain>\<ComputerName>$
ComputerName\LocalSystem Local System <Domain>\<ComputerName>$
LocalSystem Local System <Domain>\<ComputerName>$
(S-1-5-20) Network Service <Domain>\<ComputerName>$
NT AUTHORITY\NetworkService Network Service <Domain>\<ComputerName>$
(S-1-5-19) Local Service Error
NT AUTHORITY\LocalService Local Service Error

On Windows 2000, if you're using a built-in account and the report server database is remote, an error is returned.

If the LocalService built-in account is specified and the report server database is remote, an error is returned.

When IsWindowsUser is true, the WMI provider determines whether the report server database is located on the same computer or on a remote computer. This determination is made when the value supplied in UserName needs to be translated. To determine if the installation is local, the WMI provider evaluates the DatabaseServerName property against the following list of values. If a match is found, the database is local. Otherwise, it's remote. The comparison is case-insensitive.

Value of DatabaseServerName Example
"."
"(local)"
"LOCAL"
localhost
<Machinename> testlab14
<MachineFQDN> example.redmond.microsoft.com
<IPAddress> 180.012.345,678

When IsWindowsUser is set to true, the WMI provider calls LookupAccountName to get the SID for the account, and then calls LookupAccountSID to get the name to put in the SQL Server script. This action ensures that the account name used passes SQL Server validation.

When IsWindowsUser is set to false, the generated script grants the RSExec role on the report server database, the report server temporary database, and the MSDB database.

When IsWindowsUser is set to false, the SQL Server user must already exist on the SQL Server for the script to run successfully.

If the report server doesn't have a report server database specified, calling GrantRightsToDatabaseUser returns an error.

The generated script supports SQL Server 2000 (8.x), SQL Server 2005, and SQL Server 2008 (10.0.x).

Requirements

Namespace: root\Microsoft\SqlServer\ReportServer\<InstanceName>\v13\Admin

Related content

MSReportServer_ConfigurationSetting members