ITokenDataExtension.SetUserToken(Byte[]) Method

Definition

Namespace:

Microsoft.ReportingServices.DataProcessing

Assemblies:

Microsoft.ReportingServices.Interfaces.dll, Microsoft.ReportingServices.SharePoint.UI.WebParts.dll

Sets the SharePoint user token. This method is used by the report server to send the SharePoint user token to the data processing extension.

public:
 void SetUserToken(cli::array <System::Byte> ^ UserToken);

public void SetUserToken (byte[] UserToken);

abstract member SetUserToken : byte[] -> unit

Public Sub SetUserToken (UserToken As Byte())

Parameters

UserToken

Byte[]

An array of byte that represents the token data.

Examples

The following code demonstrates how to create a connection class implement an IDbConnection interface that can connect to a SharePoint data source with a SharePoint user token.

using System.Microsoft.ReportingServices.DataProcessing;  
using Microsoft.SharePoint;  

public class SPConnection : ITokenDataExtension, IDbConnection  
{  
   private SPUserToken token = null;  
   private SPSite site = null;  
   ...  
   // Implement the SetUserToken method in ITokenDataExtension  
   public void SetUserToken(byte[] UserToken)  
   {  
      token = new SPUserToken(UserToken);  
   }  

   // Implement the Open method in IDbConnection  
   public void Open()  
   {  
      // Connect to a site collection using the token.  
      // To use a variable for site URL, implement the   
      // IDbConnection.ConnectionString property accordingly.  
      site = new SPSite(  
            "http://contoso/sites/salesdata/thisyear/default.aspx",   
            token);  
      ...  
   }  

   //Implement the other methods and properties in IDbConnection  
   ...  
}  

Imports System.Microsoft.ReportingServices.DataProcessing  
Imports Microsoft.SharePoint  

Public Class SPConnection  
   Implements ITokenDataExtension  
   Implements IDbConnection  
   Private token As SPUserToken = Nothing  
   Private site As SPSite = Nothing  
   ...   ' Implement the SetUserToken method in ITokenDataExtension  
   Public Sub SetUserToken(ByVal UserToken As Byte())  
      token = New SPUserToken(UserToken)  
   End Sub  

   ' Implement the Open method in IDbConnection  
   Public Sub Open()  
      ' Connect to a site collection using the token.  
      ' To use a variable for site URL, implement the   
      ' IDbConnection.ConnectionString property accordingly.  
      site = New SPSite(_  
            "http://contoso/sites/salesdata/thisyear/default.aspx",_  
            token)  
   End Sub  

   'Implement the other methods and properties in IDbConnection  
   ...  
End Class  

Remarks

The user token is almost always the logged-on user. In the case of subscription delivery, this is the token of the subscription creator. If the report server cannot obtain a user token, it creates a SharePoint token of the unattended execution account. For more information, see Configure the Unattended Execution Account (SSRS Configuration Manager).