AVEVA NET Reporting - Installation Guide
AVEVA NET Reporting - Installation Guide
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA
Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim
any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or
entity for any actions, claims, loss or damage arising from the use or possession of any information,
particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every
part of it (including source code, object code, any data contained in it, the manual and any other
documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in
this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval
system, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where such
permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently
displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material
or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not
reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the
product described in this publication may be incorporated into any third-party software, product,
machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by
law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal
prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with
the terms and conditions of the respective licence agreements, and in accordance with the relevant
User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trade mark rights, or other intellectual property rights in any other product, its name or
logo belongs to its respective owner.
AVEVA NET Reporting - Installation Guide
Contents Page
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
How this Guide is Organised . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
AVEVA NET Reporting Common Installation Steps . . . . . . . . . . . . . . . . . . . . . . 1:2
Deploying to a Native Report Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Deployment of AVEVA NET Reporting to the Native Report Server . . . . . . . . . . . . . . . . . . 1:3
Connecting the AVEVA NET Report Model to the AVEVA NET Data Source . . . . . . . . . . . 1:5
Deploy the Design Document Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:7
Parts List Reports and Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:8
Modify the Sample Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:8
Deploy the Parts List Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:8
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1
Potential Report and Model Deployment Issues and their Solutions . . . . . . . . A:1
Data Connection has been Deleted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1
Setting up Reporting Services for Deep Integration with SharePoint. . . . . . . . . . . . . . . . . . A:1
Deploying Report Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1
Unable to show Sub Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:2
GRANT PERMISSIONS on SQL Functions and Views . . . . . . . . . . . . . . . . . . . . A:3
Preparing the Sample Templates for Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:4
OneClickInstallDeploy Installation and Deployment Procedure . . . . . . . . . . . . A:5
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:5
One Click Create DataSource and Deploy Report Model . . . . . . . . . . . . . . . . . . . . . . . . . . A:5
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:6
Create DataSource and Deploy Report Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:7
Check Data Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:8
Deploy Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:9
1 Introduction
AVEVA NET Reporting is a facility which utilizes Microsoft SQL Server Reporting Services
(SSRS) to produce custom reports of data held within AVEVA NET, and includes
deployment methods for all AVEVA NET Standard Reports, AVEVA NET Standard Parts
Report Templates, AVEVA NET Data Source Connection and the AVEVA NET Report
Model.
AVEVA NET Reporting deploys with four example reports.
• Design Document Summary Report
• Parts List Report
• Summarised Bill of Materials Report
• Multi-level Indented Bill of Materials Report
Once deployed, with a small amount of customization for local settings these reports are
ready to use out of the box, but can be used as templates or further customized to change to
the content and presentation of the report. Creating and using reports is described in the
AVEVA NET Reporting Creation and User Guide.
AVEVA NET Reporting can be deployed in two different ways.
• To a Native Report Server
• To a Deep Integrated SSRS SharePoint Site
When choosing which variant of AVEVA NET Reporting you will install, you need to consider
if you want to use SharePoint Deep integration with SSRS or not. AVEVA recommends
Deep Integration for SharePoint as the standard for AVEVA NET Reporting, however you
may choose in the short term to reuse your existing Native Reporting Services installation.
In that case we also recommend keeping the Native Report Server separate from the
SharePoint Site Server, in order to make it easier to switch to Deep Integration at some
point in the future.
This document describes the installation and setup procedures for both choices of
deployment.
Deploying to a Native Report Server Describes deploying AVEVA NET 4.3 Reporting to a
Native Report Server.
Deploying to a Deep Integrated SSRS Describes deploying AVEVA NET 4.3 Reporting to
SharePoint Site Deep Integrated SSRS SharePoint Site.
Appendices:
Potential Report and Model Details common problems that can be encountered
Deployment Issues and their during installation.
Solutions
Preparing the Sample Templates Describes how to prepare the sample templates
for Use supplied with AVEVA NET 4.3 Reporting.
1.3.1 Prerequisites
The following software must be installed
• Microsoft SQL Server 2005 SP2 with Microsoft SQL Server Reporting Services (SSRS)
• Internet Information Services (IIS)
If not already installed, SSRS can be installed as part of the Microsoft SQL Server
installation.
3. Replace the tag <DATABASENAME> with the name of the SQL Database which
relates to the AVEVA NET Community you wish to report against.
1.3.3 Connecting the AVEVA NET Report Model to the AVEVA NET Data
Source
You must next set the Data Source connection for the AVEVA NET Report Model to the
AVEVANetDataSource DataSource;
1. In the Report Manager open the Models folder.
2. Open AVEVANETReportModel.
Reporting Services configured for SharePoint 3.0 Integration are required. Please refer to
the Microsoft documentation for detailed instructions:
Configuring Reporting Services for SharePoint 3.0 Integration
http://technet.microsoft.com/en-us/library/bb283321.aspx
A variety of deployment scenarios are supported: either deploying to a single server or a
distributed deployment across multiple computers.
The diagrams below illustrate two possibilities:
1. Single Server used for SharePoint and SQL Server Reporting Services
• Security Update for SQL Server 2005 Service Pack 2 (KB954606) (build 9.00.3073.00)
OR Security Update for SQL Server 2005 Service Pack 2 (KB954607) (build 9.00.
3282.00)
• Microsoft .NET Framework 3.0 with ASP.NET 2.0 enabled
• Microsoft Office SharePoint Server (MOSS) 2007
• Report Center templates enabled in MOSS
• Microsoft SQL Server 2005 Reporting Services Add-in for Microsoft SharePoint
Technologies
For detailed setup instructions see: How to: Configure SharePoint Integration on a Stand-
alone Server http://msdn.microsoft.com/en-us/library/bb677368.aspx
2. Multiple Servers: Reporting Services installed on AVEVA NET Datasource Server,
separated from the SharePoint Server
Note: Note: Service Pack 2 adds essential capabilities for SharePoint integration
• Security Update for SQL Server 2005 Service Pack 2 (KB954606) (build 9.00.3073.00)
OR Security Update for SQL Server 2005 Service Pack 2 (KB954607) (build 9.00.
3282.00)
• Microsoft .NET Framework 3.0
• Microsoft Office SharePoint Server (MOSS) 2007 SP1 or Windows SharePoint
Services 3.0
Note: The SharePoint configuration and content databases can also be separated from the
SharePoint server, and other multiple machine configurations are possible. For
additional information and detailed setup instructions see: How to: Configure
SharePoint Integration on Multiple Servers http://msdn.microsoft.com/en-us/library/
bb677365.aspx
2.0.1 Resources
Microsoft SQL Server 2005 Reporting Services Add-in for Microsoft SharePoint
Technologies can be downloaded from here
http://www.microsoft.com/downloads/details.aspx?familyid=1E53F882-0C16-4847-B331-
132274AE8C84&displaylang=en
Installation instructions for the Microsoft SQL Server 2005 Reporting Services Add-in for
Microsoft SharePoint Technologies are given here:
http://technet.microsoft.com/en-us/library/bb839479.aspx
MOSS Service Pack 1 can be downloaded from here
http://www.microsoft.com/downloads/details.aspx?FamilyId=AD59175C-AD6A-4027-8C2F-
DB25322F791B&displaylang=en
Security Update for SQL Server 2005 Service Pack 2 (KB954606) (build 9.00.3073.00)
http://go.microsoft.com/fwlink/?LinkID=132078&clcid=0x409
Security Update for SQL Server 2005 Service Pack 2 (KB954607) (build 9.00. 3282.00)
http://go.microsoft.com/fwlink/?LinkID=132079&clcid=0x409
Configuration required for Reporting Services - How to: Create a Report Server Database
for SharePoint Integrated Mode
http://technet.microsoft.com/en-us/library/bb283151.aspx
Configuration required in the SharePoint Central Administration - How to: Configure the
Report Server Integration Feature in SharePoint Central Administration
http://msdn.microsoft.com/en-us/library/bb326213.aspx
2.1 Overview
In summary though specific to AVEVA NET Reporting, the manual deployment to a
SharePoint Report Center Site requires the following main steps:
1. Create the AVEVANETDataSource
2. Upload the AVEVANETReportModel
3. Connect the AVEVANETReportModel to the AVEVANETDataSource
4. Upload the Parts Report Masters
5. Upload the Design Doc Summary Report
6. Connect the Bill of Materials Reports to the AVEVANETDataSource
7. Connect all other Reports to the AVEVANETReportModel
The sections below will attempt to indicate exactly how to do this in the event of unfamiliarity
with Deep Integrated SSRS and SharePoint.
4. Enter the details for connection to your AVEVA NET DataSource in the form presented
and click OK. An example is shown below:
This is an example of the settings for setting up the standard datasource (note you will need
to use the exact name AVEVA NET DataSource as above), in this example ukched3138b is
the data server and the database is zodiactst. The format of the connection string is:
• Data Source=<SQL Server name>;Initial Catalog=<SQL Database name>
The stored credentials are those of an individual with sysadmin permissions on the
SQL Database, and you also need the correct password. Notice the two extra
checkboxes checked.
• Use as Windows credentials
• Set execution context to this account
In some circumstances you may simply be able to use Windows authentication
(integrated), however depending on your server configuration, and where you have
located your data server with respect to your SharePoint server will mean you will need
to use Stored Credentials as illustrated above.
Also select:
• Enable this data source.
Note: The steps to connect three of the Bill of Materials Parts Reports to the
AVEVANETDataSource are identical to this.
1. Hover over the Report Model (or indeed the Bill of Materials Reports) and select the
drop down menu Manage Data Sources.
4. You may need to select Up to navigate up a folder. Then select the Data Connections
folder.
5. Select the AVEVANETDataSource which was previously created and click OK.
The standard Deployment for AVEVA NET Reporting creates two sub folders under the
Reports (Report Centre) folder of the Deep Integrated Site, one for Parts that is called Parts
Reports and one for Design Documents that is called Design Doc Reports.
A Appendices
Note: To modify these files using Business Intelligence Studio 2005 copy them to
C:\Program Files\Microsoft Visual Studio 8\Common7\IDE\PrivateAssemblies\
ProjectItems\ReportProject\ or the equivalent location for your installation.
You should also create the following folder structure to suit within your Report Server folder
structure that is:
<DefaultWebFolder>Corporate/Logo, and store the topleftheader.gif file, and any other
corporate related logos that will appear on reports into that folder.
A.4.1 Overview
AVEVA NET 4.3 Reporting provides a prototype tool called OneClickInstallDeploy which
can be used as an alternative to the manual steps involved in installation and deployment of
both the Native and SharePoint Deep Integration deployments.
The use of this tool is currently unsupported but instructions are provided here if you choose
to try it.
Note that the settings shown on entry are specific to the Windows User Name that you
logged onto Windows with (albeit the default settings largely prompt you for entry), and
another user will have their own settings.
It is recommended that you allocate a single Windows User Name (say Administrator) to
running this program, and setting up your AVEVA NET Reporting facilities.
OneClickInstallDeploy will save your configuration settings (or not if you answer no when
asked), and this will allow you to re-run the program without having to remember what your
previous settings.
Notice on unlocking the Config Settings that you are now prevented from actioning the two
One Click buttons, until you Lock the Settings again after completing the necessary Inputs.
The example settings on entry assume a Deep Integrated SharePoint example (hence the
Native checkbox is not clicked), and here we will continue with that assumption. A Native
installation should be relatively intuitive once you have performed a Deep Integrated
installation.
Note: DO NOT prefix the name with http:// or anything similar, as at the moment this will not
produce anything, and also will not produce any error messages either (a later
release should address one or both of these issues).
Note: You must have already set up your own Default Integrated SharePoint Site and
implemented Report Centre into this Site. Please refer to the online links provided
above to assist with this.
Enter the Name of your Data Server which is the Name of the AVEVA NET SQL Server that
hosts the SQL Database which is connected to your AVEVA NET Community.
Enter the Name of the Database which is the Name of the SQL Database connected to your
AVEVA NET Community.
Enter the Username of a valid Windows User, in the same format as shown within the
Stored Credential Username (SharePoint Deep) Input field
Enter the valid password associated with that Username. (Note for security purposes you
will have to enter this password each time you access the OneClickInstallDeploy program,
as this is not stored in the Configuration Settings).
Enter a valid Windows Group User Name that any Reporting User will exist in. If you have
more than one Windows Group likely to be using AVEVA NET Reporting, you will have to
perform this step as many times as you have Reporting User Groups (or enter individual
Users if you do not wish to enable Reporting across Groups). This is required because
OneClickInstallDeploy will assign permissions to this (these) Group(s)/Users to enable the
execution of specific Reporting functions, and also enable the db_datareader role against
them.
However, this does rely on you having the necessary SQL permissions to execute the
associated internal standard SQL procedure called sp_addrolemember. If you do not have
this permission you may need to contact your IT Administrator / Support person to either to
give you that permission or run the OneClickInstallDeploy under his account.
Check that the default Report Model Path corresponds to the Drive/Directory Path where
you installed AVEVA NET Reporting, and if any or all of it is incorrect, then amend it to suit
your chosen path and remember to save the Config Settings on exit.
After checking all your inputs are valid and correct you can now Lock the Config Settings
and then click the Create DataSource and Deploy Report Model button.
This will create the AVEVANETDataSource, upload the AVEVANETReportModel into the
Data Connections Folder/Library, and automatically connect it to the aforementioned
DataSource.
Note: If you do not have a Data Connections Library then you will first need to check your
MOSS and Report Centre Installation as this Library forms part of that Installation.
Note: Under some circumstances some time after clicking the One Click Create
DataSource button, you may receive a dialog which recommends you should double
check that the Report Model has in fact been correctly created within your Data
Connections folder. This is an intermittent error that has been noticed on some
occasions, and if after checking and waiting a bit you still do not see the Model and
DataSource simply retry the One Click Create.
If you just see the Model without DataSource, you will need to delete the Model and retry the
One Click Create.
Do not continue to deploy reports until you have both the Data Source and Model within
your Data Connections folder.
Make sure you check and double check your Report/Sharepoint Server Name entry to
confirm that it is spelt correctly and does NOT have a trailing /.
Check that the first part of the default settings for Master Design Doc RDL Path (before
Design Document Summary) correspond to the Drive and Directory Path where you
installed AVEVA NET Reporting, and if any or all of it is incorrect, then simply amend it to
suit your chosen path and remember to save the Config Settings on exit.
Note: You will need to cater for any images that you wish to include within these templates
in a similar way to the AVEVA Standard Templates.
However, you will still need to ensure that all AVEVA NET Users and Groups that are
registered within AVEVA NET are given at least data reader permissions within the relevant
AVEVA NET Datasource. This is to ensure Reporting adheres properly to the AVEVA NET
Security principles, and OneClickInstallDeploy will also assist in this.
OneClickInstallDeploy can create the necessary valid Windows User / Group Names into
the specified SQL Server (as long as you have sufficient permission to create Users in the
AVEVA NET Datasource).
To test the reports, open the AVEVA NET Parts Reports folder (http://@SharePointSite/
ReportsLibrary/Parts Reports) and click them.
Index