onion.net SharePoint Integration Datasource Server

1. Configuring SharePoint

In this part of the installation, the integration is prepared on the SharePoint server as far as necessary for the onion.net Render Engines to access the onion.net SharePoint Integration Datasource Server (referred to as Datasource server in the following) and read data from SharePoint.

1.1 Setting up service account

BenutzereigenschaftenFor the impersonation of the Datasource server, a user is needed who has the necessary rights for reading out data from SharePoint.

Create a new Windows user in the user administration for this and add the group WSS_ADMIN_WPG to the user.



SQL Server BerechtigungenNow go to the SQL Server Management Studio. The user just created needs the authorization “public” and “db_owner” for the SharePoint configuration database as well as for the SharePoint content database.

The default name of the configuration database is “SharePoint_Config”. The default name of the content database is “WSS_Content”.

After the user has obtained the authorizations in the SQL server, go to the SharePoint site collection for which the Datasource server is to be installed and configured.

The user must have the following rights in this site collection:

  • Registration of EventRecipient for webs, lists and list entries
  • Read access to:
    • The webs of the site
    • The meta data of the webs
    • The lists of the webs
    • The meta data of the lists
    • The list entries
    • The ContentTypes

1.2 Prepare database

The Datasource server needs a database for recording the SharePoint events. Create a database (e.g. with the name “ONION_SPEvents”) in the SQL server now and allocate the authorization “db_owner” to an SQL server user.

The user used must be one with SQL server authentication, since this user must be saved both in the Datasource server and in SharePoint as the connection string.

Verzeichnisstruktur1.3 Copying datasource server into the project directory

Go to the current distribution directory and then to the directory “onion.net SharePoint 2010 Integration”, copy the folder "Datasource Server" under "c:\onion.net\services" and rename the directory if necessary.

1.4 Installing Windows service

.NET-based Windows services are installed via the command line program “installutil.exe”. Just open a command line for this and go to the copied directory. If you are not logged in with the administrator on the server and UAC (User Account Control) is activated, then you must start the command line as the administrator.

The necessary program “installutil.exe” is already on your computer system in the directory "%WINDIR%\microsoft.net\framework\v2.0.50727\".

For installation, execute it with the following arguments:

installutil.exe /servicename=ONION_SharePointIntegration Onion.SharePointIntegration.DatasourceServer.WindowsService.exe

The argument /servicename controls the name of the service. A clear name must be allocated for each instance of this service.

After executing the command, the service can be viewed in the Windows service console. Now open the properties window of the service there. For operation, you should select the starting type to "Automatic (delayed start)" in the current tab.

Now go to the tab "Log in". In this tab you select the option "This account:" and enter the user created under point 1.1 as the execution account.

Konfigurationsdatei1.5 Configuration of the Datasource server

In the instance directory of the Datasource server there is a configuration file named "Onion.SharePointIntegration.DatasourceServer.WindowsService.exe.config".

1.5.1 SharePoint connection

In the configuration file you will find the attribute “siteUri” under “configuration/onion/sharepointintegration”. As the value of the attribute you configure the SharePoint Site with which the Datasource server is to connect.

1.5.2 SQL server connection

The Datasource server needs a connection to the SQL server for retrieving the recorded SharePoint events. Enter the connection information you created in point 1.2 for the attribute “eventConnectionString” in the section “configuration/onion/sharepointintegration”.

1.5.3 Service availability via .NET remoting

You can configure the connection of the service under this point. The most important setting in the case of several instances is the port connection. Port 8081 is specified as the default port. The specified port may not already be blocked by another application.

1.6 Configuring trust level of the site collection

In the “web.config” of the site collection there is an element “trust” with the attribute “level”. If the “level” is not yet changed to “Full”, then change this value to “Full”.

1.7 Installing and making SharePoint solution available

WebsiteeinstellungenGo to the current distribution directory and then to the directory “onion.net SharePoint 2010 Integration/WebPart”.

In this directory there is a SharePoint solution file (wsp). You install this solution in SharePoint and make it available to the site configured in the Datasource server. If you have already installed the onion.net Render Engine WebPart and made it available in the same site collection, then this solution no longer needs to be installed and made available.

In the site collection features there is now an onion.net SharePoint Integration feature which you must activate, and then there is a new point “onion.net configuration” in the site settings with two subitems.

Now click on the link “configure onion.net Datasource Server”. On this page you configure the connection settings to the database you created under point 1.2.

The installation of the service is thus complete and can now be started.

2. Configuring onion.net Render Engine

After the Datasource server has been completely configured, SharePoint can now be added as a further data source in the onion.net Render Engine.

To do this, you go to the directory “onion.net SharePoint 2010 Integration / Render Engine Datasource” in the distribution directory. There are DLLs there which are copied into the bin directory of the onion.net Render Engine.

You then open the “web.config” of the onion.net Render Engine and add the following further section within the element “dataSources”.

 <source xlinkPrefix="sharepoint" type="Onion.RenderEngine.DataSources.SharePointIntegration.Client.SharePointRepository, Onion.RenderEngine.DataSources.SharePointIntegration.Client">
  <server uri="tcp://localhost:8081/onion/sharepointintegration" versionFilter="true" />

Configure the “uri” to the Datasource server in the inserted section. Save the configuration file.

As an initial test, you can call the “autoconfig.ashx” for the onion.net Render Engine. If this page can be rendered, then a connection could be established to the Datasource server.

3. Importing onion.net Editor module

The Editor module can be imported as an option. For this part of the integration, the module offers editors for the simple selection of references to SharePoint contents.

The module is located in the directory “onion.net SharePoint 2010 Integration / Editor Module” of the current distribution directory.

If an error message can be seen in the data editor after importing the module, stating that the DLL Onion.SharePointIntegration.Editor.dll could not be found, this can be for two reasons:

  • There are problems with the onion.net Management Service
    • Not installed
    • Not configured in the “web.config” of the editor
    • The service may not write into the bin directory of the editor
  • or else the page was loaded too quickly, even before the management service could copy the DLL into the bin directory.

In the latter case, simply refresh the page again. The editor should then function normally.