Technics:Reporting Services Integration

2022-03-04T10:17:08Z

Support: added 2 examples of how to define the ssrs coplanner datasource connection string

==Installation==
The CoPlanner Reporting Services Integration (CRSI) is located in the directory execute\Reporting and consists of two components:

:*A server component which must be installed on the report server.
:*A client component which must be installed on the client computer (only if report creating and editing using Business Intelligence Development Studio (BIDS) will be done). For SQL Server 2012 you will find a seperate component.

The setups for both components must be executed with administrator rights.

{| {{Bausteindesign1}}
|-
| '''Hint'''  The BIStudioConfigurator application must always be made from the corresponding folder of reports. (SQL Server 2008R2 of the Reporting folder, SQL Server 2012 from Reporting.2012 folder and SQL Server 2014 from the folder Reporting.2014)
|}

===Server Component Setup===
The server component has to be installed using '''ReportServerConfigurator.exe''' which must be executed on the report server. The setup will verify the integrity of the files located in the '''DataExtension'''-directory, recognize al locally installed report servers (using the registry) and install the extension

[[Image:T_Screenshot des ReportServerConfigurator.jpg|thumb|center|Technical, ReportServerConfigurator Screenshot]]

If there are several local report servers the default instance resp. first instance (order appearing in the registry) will be chosen. The setup will only take configured instances into account. Using command line arguments other instances can be selected. Command line arguments can start with / or

{| class="wikitable" width={{{breite|100%}}}
|- {{Tabellentitel}}
|width="200pt" |Argument
|Description
|-
|autoinstall
|Start installation after launching setup
|-
|autoquit
|Quit setup after successfull (!) installation
|-
|instance
|Instance selection (the next argument must define the report server’s instance name)
|-
|?
|Show help
|-
|help
|Show help
|}

An example for automatic installation for instance SQL2012:

<source lang="csharp">
ReportServerConfigurator –autoinstall –autoquit –instance SQL2012
</source>

===Client Component Setup===
The client component hast do be installed using '''BiStudioConfigurator.exe''', which must be executed on each PC which will be used for designing reports using BIDS. The setup will verify the integrity oft he files in the '''DataExtension'''- and '''QueryDesigner'''-directory, recognize locally installed Visual Studio versions (using the registry) and install the extension.

[[Image:T_Screenshot des BiStudioConfigurator.jpg|thumb|center|Technical, Screenshot des BiStudioConfigurator]]

If several versions of Visual Studio exist, the last one with an report designer extension will be chosen. Using command line arguments other versions can be selected. Command line arguments can start with / or –.

{| class="wikitable" width={{{breite|100%}}}
|- {{Tabellentitel}}
|width="200pt" |Argument
|Description
|-
|autoinstall
|Start installation after launching setup
|-
|autoquit
|Quit setup after successfull (!) installation
|-
|version
|Version selection (the next argument must specify the Visual Studio version number)
|-
|?
|Show help
|-
|help
|Show help
|}

An example for automatic installation for Visual Studio 2008 (9.0):

<source lang="csharp">BiStudioConfigurator –autoinstall –autoquit –version 9.0</source>

===Manuel Installation===
The steps for manual installation are described in the following document and its references:
http://msdn.microsoft.com/en-us/library/ms155104.aspx

You have to add following extension in file ''RSReportServer.config'' in section Data:

<Extension Name="CoPlanner" Type="Cop.Reports.DataExtension.CopConnection,Cop.Reports.DataExtension"/>

You have to create a codegroup with ''FullTrust''-rights in file ''rssrvpolicy.config'':

<CodeGroup class="UnionCodeGroup" version="1" PermissionSetName="FullTrust" Name="CoPlannerCodeGroup" Description="CodeGroup for CoPlanner DataExtension"/>
<IMembershipCondition class="UrlMembershipCondition" version="1" Url="C:\Programme\Microsoft SQL Server\MSSQL.3\Reporting Services\ReportServer\bin\Cop.Reports.DataExtension.dll"/>

On the client computer you have to add the extendion in the ''Data''-section and the query designer in the ''Designer''-section in file ''RSReportDesigner.config'':

<Extension Name="CoPlanner" Type="Cop.Reports.DataExtension.CopConnection,Cop.Reports.DataExtension"/>
<Extension Name="CoPlanner" Type="Cop.Reports.QueryDesigner.CopQueryDesigner,Cop.Reports.QueryDesigner"/>

You have to create a codegroup with ''FullTrust''-rights in file ''rspreviewpolicy.config'':

<CodeGroup class="UnionCodeGroup" version="1" PermissionSetName="FullTrust" Name="CoPlannerCodeGroup" Description="CodeGroup for CoPlanner DataExtension"/>
<IMembershipCondition class="UrlMembershipCondition" version="1" Url="C:\Programme\Microsoft Visual Studio 8\Common7\IDE\PrivateAssemblies\Cop.Reports.QueryDesigner.dll"/>

==Configuration==

CoPlanner Reporting Services Integration settings you will find in [[Technics:CoPlanner-Server#SSRSSettings|SvrConfig.xml]].

The following points must be taken into account:
:*If any of the required elements is missing or empty all reporting functions in the CoPlanner client will be disabled or hidden.
:*The server name in the URLs must not be localhost.
:*The folders on the report server won’t be created automatically.
:*The variable names are case-sensitive.

In the SSRS CoPlanner datasource the connection string has to be equal following the client connection string.

2 examples:

1) < COP10: Server=Rechnername;Port=8963;TcpFormatter=Native

2) >= COP10: ServerUrl=http://Rechnername:8080/coplanner;

===Data Processing Extension (DataExtension)===

You can cinfugure the data processing extension in configuration file RSReportServer.config and RSReportDesigner.config. The following figure shows all kinds of options with their default values. All elements and attributes are optional, that means if they are missing, the default value will be taken. If the server delivers an error message, like the figure below, the TimeOut Setting values must be increased.

[[Image:T_Screenshot der Fehlermeldung.png|thumb|center|Technics, Server Error Message]]

<Extension Name="CoPlanner" Type="...">
 <Configuration>
 <Connection LogLevel="ErrorWarning"/>
 <Connection LogLevel="ErrorWarning" TimeOut="10000"/>
 <Reader LogLevel="ErrorWarning"/>
 <CopApiClientStore LogLevel="ErrorWarning" EntryLifeTime="30000"/>
 <Session ConnectTimeOut="2000" ConnectMaxAttempts="5" DisConnectTimeOut="2000"/>
 <Kerberos SPN=""/>
 <ServerCommandLog Active="False" Path=""/>
 </Configuration>
</Extension>

LogLevel=""
The attribute LogLevel defines the granularity for logging of the component. All messages are logged, with a smaller or equal granularity of the configured granularity. Following table shows the available steps.

{| class="wikitable" width={{{breite|100%}}}
|- {{Tabellentitel}}
|width="200pt" |Level
|Description
|-
|None
|NoLogging
|-
|Error
|Error message
|-
|Warning
|Error message and warning
|-
|ErrorWarning
|Compatibility to previous versions
|-
|Info
|Additional state messages
|-
|Verbose
|Extended Logging
|}

Log-file ''coprsint.log'' will be written in the temporary user folder of the report server. The report server generally use the folder
C:\Windows\Temp,
and for BIDS (Windows 2003 Server) the folder
C:\Documents and settings\''username''\Lokale Einstellungen\Temp

TimeOut=""
The following table shows the available time specifications (in millisecond) and their lower and upper limits.

{| class="wikitable" width={{{breite|100%}}}
|- {{Tabellentitel}}
|width="200pt" |Element
|Attribut
|Min
|Max
|Standard
|-
|Command
|TimeOut
|100
|
|10000
|-
|CopApiClientStore
|EntryLifeTime
|100
|120000
|30000
|-
|Session
|ConnectTimeOut
|100
|
|2000
|-
|Session
|DisConnectTimeOut
|100
|
|2000
|}

The TimeOut-Attribute controls the time, within the command has to be executed by the CoPlanner server. The EntryLifeTime–Attribut defines, within which time span a connection has to be reused by the data extension.

{| {{Bausteindesign1}}
|-
| '''Important'''  During the installation you must set the TimeOut, otherwise it doesn't work. The TimeOut must be set at the BI-Studio in ''RSReportDesigner.config'' (C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies) and at the ReportServer in ''RSReportServer.config'' (C:\Program Files\Microsoft SQL Server\MSRS11.MSSQLSERVER\Reporting Services\ReportServer).
|}

ConnectMaxAttempts=""
This attribute defines the maximum number of connection attempts to the [[Technics:CoPlanner-Server|CoPlanner Server]]. The minimum value is 1.

<ServerCommandLog Active="False" Path=""/>
Using this option the logging of the [[Technics:CoPlanner-Server|CoPlanner Server]] commands can be activated. In this case each request to the [[Technics:CoPlanner-Server|CoPlanner Server]] and its answer will create a file with the following file name pattern:

'''Counter-Command-anfrage.xml (for requests)'''
bzw.
'''Counter-Command-ergebnis.xml (for answers answers)'''

Counter is a consecutive numbering of the commands.By default the files will be put into the report server’s bin-directory (the clCop_ClientProxy-class’ default path is the path of the binary).

<Kerberos SPN=""/>
Defines the Service Principle Name (SPN) if Kerberos authentication must be used

===SQL Server Reporting Services 2012===

For accessing to an CoPlanner data source with SSRS 2012 the transmission mode ''Native'' has to be activated. Therefore the connection settings have to be extended: ''server=vpcopsq2;port=8963;tcpformatter=native''

{| {{Bausteindesign1}}
|-
| '''Hint'''  The chosen mode has to be adjusted both on server (SvrConfig.xml) and on client (ClientConfig.xml) and both have to come to an agreement.
|

__NOEDITSECTION__

[[Category:Technics|Reporting Services Integration]]

[[de:Technik:Reporting Services Integration]]

Technics:Requirements

2022-01-31T06:17:04Z

Support: Windows 11 support added

__TOC__

==Hardware==

These indications refer to standard [[Enterprise_Edition:Enterprise_Edition|Enterprise Edition]]. Hardware requirements have to be set in relation to processed amount of data.

'''Server: '''

:*processor: 4 * 2,3 GHz Intel Xeon Quad Core Processor (at least)
:*RAM: 16-32 GB (at least)

'''Client: '''

:*processor: 1.5 GHz
:*RAM: 4 GB (at least)
:*screen resolution: at least 1024*768

==Software==

===Platforms/operating system===

'''CoPlanner Server (x32/x64) (x64 empfohlen):'''

:*Windows Server 2012
:*Windows Server 2012 R2
:*Windows Server 2016
:*Windows Server 2019

'''CoPlanner Win-Client (x32/x64): '''

:*Windows 8
:*Windows 8.1
:*Windows 10
:*Windows 11

'''CoPlanner Excel-Client (x32/x64): '''

:*Excel 2010
:*Excel 2013
:*Excel 2016
:*Excel 2019 (from 9.5 HF 3.5)
:*Excel 365 desktop version with version numbers 15 and 16

'''CoPlanner Word Add-in (x32/x64): '''

:*Word 2013
:*Word 2016
:*Word 2019 (from 9.5 HF 3.5)
:*Word 365 desktop version with version numbers 15 and 16

'''CoPlanner PowerPoint Add-in (x32/x64): '''

:*PowerPoint 2013
:*PowerPoint 2016
:*PowerPoint 2019 (from 9.5 HF 3.5)
:*PowerPoint 365 desktop version with version numbers 15 and 16

===Required Software===

'''Server: '''

:*Microsoft SQL Server (x32/x64)
::*Microsoft SQL Server 2014
::*Microsoft SQL Server 2016 (Requirement to use SQL Server Reporting Services in combination with the CoPlanner DataExtension)
::*Microsoft SQL Server 2017
:*Microsoft SQL Server Engines
::*Database Server
::*Integration Services
::*Reporting Services
::*Analysis Services

:*.Net Framework 4.8 (x32/x64)

'''Win-Client: '''

:*.Net Framework 4.8 (x32/x64)

'''Excel-Client: '''

:*Shared AddIn Supportupdate (MS Patch, included in Setup)
:*.Net Framework 4.8 (x32/x64) - to CoP 10 HF 2.8
:* Framework NET 5 and ASP.NET Core 5 - from CoP 10 HF 2.9

===Requirment for use of SSL===
To use https you need a certificate.

__NOEDITSECTION__

[[Category:Technics|Requirements]]
[[de:Technik:Voraussetzung]]

CoPlanner 10 - User contributions [en]

Technics:Reporting Services Integration

Technics:Requirements