0% found this document useful (0 votes)
149 views

PM SetupGuide

This document provides instructions for installing and configuring the Performance Manager software suite from Schneider Electric. It outlines the required prerequisites and installation steps for the Intelligence Server, Industry Console with Skelta, Operations Data Management, Decision Manager, and Event Manager components. The document begins by describing the overall installation architecture and sequence. It then details the necessary configurations for the operational data store and event store databases before installation. Subsequent chapters provide system requirements, prerequisite software to install, and step-by-step instructions for installing each Performance Manager component.

Uploaded by

Dorival Silva
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
149 views

PM SetupGuide

This document provides instructions for installing and configuring the Performance Manager software suite from Schneider Electric. It outlines the required prerequisites and installation steps for the Intelligence Server, Industry Console with Skelta, Operations Data Management, Decision Manager, and Event Manager components. The document begins by describing the overall installation architecture and sequence. It then details the necessary configurations for the operational data store and event store databases before installation. Subsequent chapters provide system requirements, prerequisite software to install, and step-by-step instructions for installing each Performance Manager component.

Uploaded by

Dorival Silva
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 99

Industry Software Suites

Performance Manager

Setup Guide
Version 2.3

May 2018
© 2018 AVEVA Group Plc. All rights reserved.
The Schneider Electric industrial software business and AVEVA have merged to trade as
AVEVA Group plc, a UK listed company. The Schneider Electric and Life is On trademarks
are owned by Schneider Electric and are being licensed to AVEVA by Schneider Electric.
No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted
by any means, electronic, mechanical, photocopying, recording, or otherwise, without the
prior written permission of Schneider Electric Software, LLC. No liability is assumed with
respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, Schneider
Electric Software, LLC assumes no responsibility for errors or omissions. The information in
this documentation is subject to change without notice and does not represent a commitment
on the part of Schneider Electric Software, LLC. The software described in this
documentation is furnished under a license agreement. This software may be used or copied
only in accordance with the terms of such license agreement.
ArchestrA, Avantis, DYNSIM, eDNA, EYESIM, Foxboro, Foxboro Evo, I/A Series, InBatch,
InduSoft, InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo,
Schneider Electric, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software,
WindowMaker, WindowViewer, and Wonderware are trademarks of Schneider Electric SE, its
subsidiaries, and affiliated companies. An extensive listing of Schneider Electric Software,
LLC trademarks can be found at: http://software.schneider-electric.com/legal/trademarks/. All
other brands may be trademarks of their respective owners.
Schneider Electric Software, LLC
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://software.schneider-electric.com/
Publication date: 5/8/2018
Contact Us
Contact Schneider Electric Software Technical Support
Avantis Technical Support
Listing of regional and local country contacts: http://software.schneider-
electric.com/support/avantis/
Technical support: http://softwaresupport.schneider-electric.com/
For Avantis.PRO, Avantis Approvals, Avantis.DSS, and Condition Manager:
 Email: [email protected]
 Phone (8:30 a.m. to 5:00 p.m. Monday to Friday, Eastern Time):
o Toll-Free U.S. and Canada: 1-888-262-7111
o Toll-Free EMEA: 1-800-4670-6466
o Direct dial: 1-905-632-0635
For Avantis.XA:
 Email: [email protected]
 Phone (8:30 a.m. to 5:00 p.m. Monday to Friday, Eastern Time):
o Toll-Free U.S. and Canada: 1-800-991-8000
o Toll-Free EMEA: 1-800-4670-6466
o Direct dial: 1-905-632-4122
SimSci Technical Support
Listing of regional and local country contacts: http://software.schneider-
electric.com/support/simsci/
Technical support: http://softwaresupport.schneider-electric.com/
 Email U.S. and Canada: [email protected]
 Phone (USA 8:00 a.m. to 5:00 p.m. Central Time)
o Toll-Free U.S. and Canada: 1-800-746-7241
Skelta Technical Support
 Email: [email protected]
 Phone:
o U.S.: 1-678-306-4110 Option 3
o India: 91-80-4060-2600 Option 3
Wonderware Technical Support
Listing of regional and local country contacts: https://www.wonderware.com/contact/contact-
support/
Technical support: http://softwaresupport.schneider-electric.com/
 Priority email for Customer FIRST Members: [email protected]
 Email for customers without a support agreement: [email protected]
 Phone
o Toll-Free North America and Latin America: 1-800-966-3371
o Direct dial: 1-949-639-8500
InStep Technical Support
Contact page: http://www.instepsoftware.com/contact-us
Technical support: https://support.instepsoftware.com/
 Email: [email protected]
 Phone (USA 8:00 a.m. to 5:00 p.m. Central Time)
o 1-312-894-7870
Schneider Electric – Smart Water Software Technical Support
 Help desk email: [email protected]
 Help desk telephone hotline: +45 88 30 20 77 (09:00 to 16:00 Monday to Thursday,
Friday 09:00 to 15:00, Central European Time)
Contact Schneider Electric Software Learning Services
Contact Software Learning Services for assistance regarding classes, schedule, offerings,
frequently asked questions, tuition, policies, and more.
 Email: [email protected]
 Toll-Free U.S. and Canada: 1-866-998-7246
 Direct: 1-949-639-8508
 Fax: 1-949-639-1847
Industry Software Suites Performance Manager Setup Guide

Contents
Contact Us ................................................................................................................... 3
Chapter 1 Introduction to Performance Manager ........................................................ 9
Overview .............................................................................................................................................9
About this Manual ...............................................................................................................................9
Installation Architecture .....................................................................................................................10
Installation and Configuration Sequence .................................................................... 11
Chapter 2 Before You Begin ..................................................................................... 15
Configuring Operational Data Store ..................................................................................................16
Configuring the Event Store ..............................................................................................................16
Chapter 3 General Prerequisites for All Servers ....................................................... 19
Preparing for Installation ...................................................................................................................19
System Requirements .......................................................................................................................20
Verifying SQL Server Is Installed and Running ................................................................................20
Microsoft Windows Domain Controller ..............................................................................................20
Disabling the Internet Explorer Enhanced Security Configuration and Compatibility View Settings 20
Required Firewall Exceptions ...........................................................................................................21
Schneider Electric License Manager and License Server Installation ..............................................22
Chapter 4 Performance Manager Components Installation ...................................... 23
Intelligence Server Prerequisites and Installation .............................................................................23
Installing and Configuring the SQL Server Reporting Services ..................................................23
Installing the Intelligence Server .................................................................................................24
Activating the Wonderware Intelligence License File .................................................................25
Industry Console with Skelta Prerequisites and Installation .............................................................26
Running Update for Windows Server 2012 R2...........................................................................26
Common Licensing API Framework ...........................................................................................26
Activating Software Licenses ......................................................................................................26
Installing the AIM Certificate Manager and Identity Manager .....................................................27
Installing Internet Information Services (IIS) and ASP.NET Components .................................28
Configuring the MSDTC in Windows Server 2012 R2 ................................................................31
Editing the Wonderware Skelta BPM XML File for Configuration ..............................................31
Disabling the Browser's Pop-up Blocker.....................................................................................33
Installing the Industry Console with Wonderware Skelta BPM ...................................................33
Operations Data Management Prerequisite and Installation ............................................................34
Installing ODM ............................................................................................................................35
Decision Manager and Event Manager Prerequisite and Installation ...............................................36

Version 2.3 5
Industry Software Suites Performance Manager Setup Guide Contents

Installing Decision Manager and Event Manager .......................................................................37


Installing KPI Manager ......................................................................................................................37
KPI Manager Data Connectors Prerequisites and Installation .........................................................39
KPI Manager Data Connectors Prerequisites .............................................................................39
Installing the Wonderware System Platform Data Agent ...........................................................40
Wonderware System Platform Data Agent Configuration ..........................................................40
Installing the KPI Manager Data Connectors .............................................................................42
Chapter 5 Performance Manager Components Configuration .................................. 43
Wonderware Skelta BPM Configuration ...........................................................................................43
Configuring the Admin User for Skelta Repository Database ....................................................43
Industry Console Configuration .........................................................................................................47
Configuring the KPI Manager............................................................................................................48
Operational Data Store Configuration ........................................................................................48
Notification Configuration ............................................................................................................50
Intelligence and Event Manager Configuration...........................................................................51
Data Connectors Configuration ..................................................................................................52
General Configuration .................................................................................................................53
Web API Configuration ...............................................................................................................54
Event Manager Configuration ...........................................................................................................56
Configuring SQL Server Connection for Data Connectors ...............................................................59
Application Packages ........................................................................................................................60
Importing the Application Packages ...........................................................................................60
Setting Up Industry Console .............................................................................................................63
External Content Enabler Settings .............................................................................................64
Configuring Industry Console for Active Directory Authentication ..............................................65
Optional Configuration Related to Industry Console .........................................................................65
Modifying the Connection String in appsettings.json File ...........................................................65
Modifying and Running a SQL Script for Everdyn Databases ....................................................66
ODM Configuration ...........................................................................................................................66
Applying the Patches for eDNA Web 2016 R2 ...........................................................................66
Configuring the AD Service in Wonderware eDNA ....................................................................68
Importing the Master Asset Hierarchy ........................................................................................70
Managing Users ................................................................................................................................70
Industry Console User Management ..........................................................................................71
Managing Users in Industry Console ...................................................................................71
Performance Manager Roles and Permissions ....................................................................71
Managing Privileges in Industry Console .............................................................................71
ODM User Management .............................................................................................................73
Managing Groups in ODM ....................................................................................................73
Managing Users in ODM ......................................................................................................73
Managing Asset Security in ODM ........................................................................................74
KPI Manager User Management ................................................................................................74
Managing Users in KPI Manager .........................................................................................74
Consistent Access Across Components .....................................................................................75
Managing Security ............................................................................................................................76
Enabling Microsoft SQL Server Encryption ................................................................................76

6 Version 2.3
Contents Industry Software Suites Performance Manager Setup Guide

Binding the SSL Certificate to a Port Number ............................................................................76


Configuring Sites to Support HTTPS and SSL Protocols ...........................................................77
Setting Up HTTPS for Wonderware Historian OData Web API .................................................81
Web Server Configuration ..........................................................................................................81
Modifying Web.Config for HTTPS Configuration ........................................................................82
Mapping Users to Security Groups .............................................................................................82
Intelligence Server Configuration ......................................................................................................82
Deploying the Performance Manager Intelligence Model on Wonderware Intelligence 2017 ....83
Running the Intelligence SQL Server Script in the Intelligence Database .................................84
Updating the Shared Data Source Credentials ..........................................................................84
Chapter 6 Performance Manager Upgrade ............................................................... 87
Upgrading Performance Manager 2.2 to 2.3 ....................................................................................87
Chapter 7 Appendix .................................................................................................. 89
Deploying the Intelligence Model on Wonderware Intelligence 2014 R3 .........................................89
Granting Database Access to Remote Server ..................................................................................90
Finding User Groups When Defining eDNA Web AD_Admin Configuration ....................................91
Updating executionTimeout Setting in Web.config File ....................................................................93
Troubleshooting Industry Console ....................................................................................................94
Modifying the DNASYS.ini File for Other eDNA Datasource ............................................................95
Decision Manager Web Service ........................................................................................................95
KPI Manager Recommendations ......................................................................................................96
Understanding the Example Asset Hierarchy ...................................................................................97
CORS Origin .....................................................................................................................................98

Version 2.3 7
Industry Software Suites Performance Manager Setup Guide

C HAPTER 1
Introduction to Performance Manager
In This Chapter
Overview ...................................................................................................................................................9
About this Manual......................................................................................................................................9
Installation Architecture ...........................................................................................................................10

Overview
Performance Manager is a common component of Industry Solution, which has the following
modules and components:
 Industry Console: Is a client-based framework similar to Operations Console, but this is
created out of AngularJS framework. There is where all solutions can be merged into a
single user experience
 Decision Manager: A component that provides the ability to capture cases, track and
manage them through their life cycle
 Event Manager: A module for events operations. It provides the ability to select multiple
events for one case, and provides an analysis charts by assets, type, frequency and so
on
 KPI Manager: A component that provides the ability to connect to different data sources,
ability to define calculated variables and key performance indicators (KPIs) with
boundaries and store
 Operations Data Management (ODM): A component that provides the ability to federate
multiple asset models into a unified mode

About this Manual


This document is for the system integrators and delivery engineers who are responsible for
installing and configuring the various components of Performance Manager.
The guide includes:
 An example installation architecture that shows the main software components in each of
the servers that is part of Performance Manager
 General prerequisites for all the servers and for each server
 Configuration requirements for each of the servers in Performance Manager

Version 2.3 9
Industry Software Suites Performance Manager Setup Guide Introduction to Performance Manager

For the list of documents to refer to as part of the Performance Manager, see the Readme
delivered on the <Media>. You can download Wonderware documentation from the
Schneider Electric Software Global Customer Support web site
https://softwaresupportsp.invensys.com/Pages/NewProductHub.aspx. For Wonderware
eDNA documentation, download it from the InStep support website
https://support.instepsoftware.com/login.asp.
Some things to take note of:
 Throughout this guide, the .iso file that you mount to install the Performance Manager is
referred to as <Media>
 Decision Manager and Case Management are the same, but Decision Manager is the
actual module name

Installation Architecture
The following diagram is a standard installation architecture for Performance Manager, where
there is a two-server setup and the data can come from different sources.
Performance Manager 2.3 also supports installation on a distributed environment, where the
Performance Manager components are installed on different servers for better performance.
For more information on which components are recommended to be installed together in a
distributed environment, and information on the supported reference architecture, see the
Architecture and Performance Guidelines page on Performance Manager Developer Network
(PMDN) https://oosa-confluence.au.schneider-electric.com/x/8IHnBw
.

10 Version 2.3
Installation and Configuration Sequence Industry Software Suites Performance Manager Setup Guide

Installation and Configuration Sequence


Refer to the following table for the sequence of installation and configuration in setting up the
Performance Manager in a standard installation architecture, where there is a two-server
setup.

No. Task Related Topics


1 Be sure to check out the details in the  Before You Begin (on page 15)
Before You Begin section
 Configuring Operational Data Store (on page 16)
 Configuring the Event Store (on page 16)
2 Check the general prerequisites for all  Preparing for Installation (on page 19)
servers
 System Requirements (on page 20)
 Verifying Microsoft SQL Server Is Installed and
Running (see "Verifying SQL Server Is Installed and
Running" on page 20)
 Microsoft Windows Domain Controller (on page 20)
 Disabling the Internet Explorer Enhanced Security
Configuration and Compatibility View Settings (on
page 20)
 Required Firewall Exceptions (on page 21)
 Schneider Electric License Manager and License
Server Installation (on page 22)
Intelligence Server (Server 1)
3 Check Intelligence Server  General Prerequisites for All Servers (on page 19)
Prerequisites
 Installing and Configuring the SQL Server Reporting
Services (on page 23)
4 Install the Intelligence Server Installing the Intelligence Server (on page 24)
components
5 Activate the Wonderware Intelligence Activating the Wonderware Intelligence License File (on
license file page 25)

Performance Server (Server 2)


6 Check for Wonderware Skelta and  Running Update for Windows Server 2012 R2 (on
Industry Console Prerequisites page 26)
 Common Licensing API Framework Installation (see
"Common Licensing API Framework" on page 26)
 Activating Software Licenses (on page 26)

Version 2.3 11
Industry Software Suites Performance Manager Setup Guide Installation and Configuration Sequence

 Installing the AIM Certificate Manager and Identity


Manager (on page 27)
 Installing Internet Information Services (IIS) and
ASP.NET Components (on page 28)
 Configuring the MSDTC in Windows Server 2012
R2 (on page 31)
 Editing the Wonderware Skelta BPM XML File for
Configuration (on page 31)
 Disabling the Browser's Pop-up Blocker (on page
33)
7 Install the Industry Console with Installing the Industry Console with Wonderware Skelta
Wonderware Skelta BPM (on page 33)
8 Configure Wonderware Skelta BPM Configuring the Admin User for Skelta Repository
Database (on page 43)
9 Check ODM Prerequisite ODM Prerequisite and Installation (see "Operations
Data Management Prerequisite and Installation" on
page 34)
10 Install ODM Installing ODM (on page 35)
11 Check Decision Manager and Event Decision Manager and Event Manager Prerequisite and
Manager Prerequisite Installation (on page 36)
12 Install Decision Manager and Event Installing Decision Manager and Event Manager (on
Manager page 37)
13 Install KPI Manager Installing KPI Manager (on page 37)
14 Check KPI Manager data connectors  KPI Manager Data Connectors Prerequisites and
prerequisites Installation (on page 39)
 KPI Manager Data Connectors Prerequisites (on
page 39)
 (Only for WSP data connector) Installing the
Wonderware System Platform Data Agent (on page
40) and Wonderware System Platform Data Agent
Configuration (on page 40)
15 Install KPI Manager required data Installing the KPI Manager Data Connectors (on page
connectors 42)
16 Manually configure the following  Configuring the KPI Manager (on page 48)
sections in the Configurator and
configure the data connectors SQL  Operational Data Store Configuration (on page 48)
Server connection:  Intelligence and Event Manager Configuration (on
 Operational Data Store page 51)
Configuration  Event Manager Configuration (on page 56)
 Intelligence and Event Manager  Data Connectors Configuration (on page 52)
Configuration
 Configuring SQL Server Connection for Data
 Event Manager Configuration Connectors (on page 59)
 Data Connectors Configuration
17 Update the Runtime attribute in the Application Packages (on page 60)

12 Version 2.3
Installation and Configuration Sequence Industry Software Suites Performance Manager Setup Guide

Web. Config settings as prerequisite


for installing the Performance Manager
packages
18 Import the Performance Manager Importing the Application Packages (on page 60)
application packages
19 Set up Industry Console  Setting Up Industry Console (on page 63)
 Configuring Industry Console for Active Directory
Authentication (on page 65)
20 Perform some optional configuration  (Optional) Modifying the Connection String in
related to Industry Console appsettings.json File (on page 65)
Do this only if the Industry Console web and
database servers are not in the same server.
 (Optional) Modifying and Running a SQL Script for
Everdyn Databases (on page 66)
Do this only if you want to integrate Everdyn/Alpana
dashboard in Industry Console.
21 Configure ODM  Applying the Patches for eDNA Web 2016 R2 (on
page 66)
 Configuring the AD Service in Wonderware eDNA
(on page 68)
 Importing the Master Asset Hierarchy (on page 70)
22 Manage users for Industry Console,  Industry Console User Management (on page 71)
ODM, and KPI Manager.
 ODM User Management (on page 73)
 KPI Manager User Management (on page 74)
23 Manage security  Enabling Microsoft SQL Server Encryption (on page
76)
 Binding the SSL Certificate to a Port Number (on
page 76)
 Configuring Sites to Support HTTPS and SSL
Protocols (on page 77)
 Setting Up HTTPS for Wonderware Historian OData
Web API (on page 81)
 Web Server Configuration (on page 81)
 Modifying Web.Config for HTTPS Configuration (on
page 82)
24 Perform some additional task for  Granting Database Access to Remote Server (on
Performance Manager (if applicable) page 90)
 Mapping Users to Security Groups (on page 82)
 Modifying the DNASYS.ini File for Other eDNA
Datasource (on page 95)
 Decision Manager Web Service (on page 95)
Intelligence Server (Server 1)
25 Configure the Intelligence Server  Deploying the Performance Manager Intelligence

Version 2.3 13
Industry Software Suites Performance Manager Setup Guide Installation and Configuration Sequence

Model on Wonderware Intelligence 2017 (on page


83)
 Running the Intelligence SQL Server Script in the
Intelligence Database (on page 84)
 Updating the Shared Data Source Credentials (on
page 84)
Performance Server (Server 2)
26 Upgrade Performance Manager to 2.3 Upgrading Performance Manager 2.2 to 2.3 (on page
87)

14 Version 2.3
Industry Software Suites Performance Manager Setup Guide

C HAPTER 2
Before You Begin
The instructions provided in this guide are based on the assumption that the following
applications are already installed and configured in the customers' environment.
The applications are not required to be installed in the servers where Performance Manager
components are installed.
Additionally, whether you set up the Performance Manager based on a standard or
distributed architecture, there are tasks dependencies between servers, so at some point,
you have to shift from one server to the other. It is then recommended to have the servers
ready before setting up the Performance Manager. For the sequence of tasks when setting
up a standard architecture, see Installation and Configuration Sequence (on page 11).
Operational Data Store (ODS - eDNA Services) and Event Store (Wonderware Historian)
These are the versions of the applications that the Performance Manager support:
 eDNA Services 2.0.34 and eDNA Admin Clients 2.0.47 (For important ODS configuration
information, see Configuring Operational Data Store (on page 16))
NOTE: This is not mandatory. You can configure Wonderware Historian as ODS instead
of eDNA services so that you don't have to provide the information for eDNA service
during the components installation.
If you are planning to use eDNA Historian as ODS to store the KPI value history,
Wonderware Intelligence 2017 does not support the eDNA Data Adapter to Intelligence.
You need to install the Wonderware Intelligence 2014 R3 and the eDNA Data Adapter
separately.
For detailed steps on installing the eDNA Data Adapter, see the
Readme_eDNA_Data_Adapter.txt file in <Media>\CD-
eDNADataAdapterForIntelligence.
 Wonderware Historian 2017 (For important Event Store configuration information, see
Configuring the Event Store (on page 16))
NOTE: You may need to apply the Wonderware Historian hotfix L00146351 to resolve
licensing issue when setting up the system in a distributed environment. You can
download it from the Downloads and Release Notes page on PMDN https://oosa-
confluence.au.schneider-electric.com/x/iQAPBw.
If you want to download the installer and installation documents for Wonderware eDNA
services, you can get them from the InStep support website
https://support.instepsoftware.com/login.asp.
For Wonderware Historian, download them from the Schneider Electric Software Global
Customer Support web site
https://softwaresupportsp.invensys.com/Pages/NewProductHub.aspx.

Version 2.3 15
Industry Software Suites Performance Manager Setup Guide Before You Begin

In This Chapter
Configuring Operational Data Store ........................................................................................................16
Configuring the Event Store ....................................................................................................................16

Configuring Operational Data Store


This task assumes that you already have the eDNA Services installed. Ensure that the eDNA
Services are running for the ODS to work.
NOTE: eDNAServices may be installed on a different server.
To start the eDNA Services
Consider SiteName as PMODS.
1. Go to the Start menu, run eDNA Explorer.
The PMODS.SVCDIR - eDNA Explorer window appears.
2. In the left pane, select BOSS under PMODS.
3. In the right pane, right-click the SECURITY service, and select Start.
In the eDnaExdpBoss window that appears, select OK.
4. Enter the Boss password, and select OK.
5. Starting from the ALARM service, start the rest of the services except for UNIV, the same
way you did for the SECURITY.
6. Before starting the UNIV service, ensure that the correct port number is configured for this
service. To do this:
a. Right-click UNIV, and select Edit Config...
b. Go to the INPUT SOCKET SETTINGS section, and verify that next to the
TCPIP_INPUT_ADDRESS, the correct port number is set.
NOTE: The port number here must be the same number in the Universal Service
configuration file (UnvSrv64.cfg), which you can find from C:\Systems\Univ. If the
eDNA Services is installed on the same server as Industry Console with Wonderware
Skelta BPM, ensure that PMODS.UNIV services is not using port 8000 to avoid
conflict with the Skelta default port.
c. Once the value has been verified, select OK to close the config dialog box
d. Right-click UNIV, and select Start

Configuring the Event Store


Configure the Wonderware Historian Event Store. This task assumes that you already have
the Wonderware Historian installed in your environment.
NOTE: Wonderware Historian may be installed on a different server.
To configure the Event Store
1. Run the Configurator.

16 Version 2.3
Before You Begin Industry Software Suites Performance Manager Setup Guide

2. In the left pane, expand the Historian node, and select Server.
3. In the right pane, provide the necessary information for the Historian Server.
For the Performance Manager event store requirement, ensure that under the Alarms &
Event Storage section, High-speed: History blocks, store up to 1,000
messages/second (recommended) option is selected.
4. Select Configure.

Version 2.3 17
Industry Software Suites Performance Manager Setup Guide

C HAPTER 3
General Prerequisites for All Servers

In This Chapter
Preparing for Installation .........................................................................................................................19
System Requirements .............................................................................................................................20
Verifying SQL Server Is Installed and Running .......................................................................................20
Microsoft Windows Domain Controller ....................................................................................................20
Disabling the Internet Explorer Enhanced Security Configuration and Compatibility View Settings ......20
Required Firewall Exceptions .................................................................................................................21
Schneider Electric License Manager and License Server Installation ....................................................22

Preparing for Installation


Before installing the Performance Manager components, ensure that the prerequisites
describe in the following sections are met. For information on which components are
recommended to go in each of the servers, see Installation Architecture (on page 10).
Software Prerequisites
Ensure that the following software are installed in all the servers before running the installer.
 Microsoft .NET Framework 4.5 or 4.6.2
For Microsoft .NET Framework 4.6.2, access the installer from <Media>\CD-
Skelta\Wonderware Skelta BPM 2017 - 64bit\ISSetupPrerequisites\Microsoft .NET
Framewok 4.6.2
View the registry to verify the installed version of the .NET Framework. For detailed steps,
see the section To find .NET Framework versions by viewing the registry (.NET
Framework 4.5 and later) in the Microsoft Documentation > How to: Determine Which
.NET Framework Versions are Installed https://docs.microsoft.com/en-
us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed
 Microsoft SQL Server 2014 or 2016
If you are setting up the Performance Manager in a two-tier distributed environment, where
the server for the databases is different from the application server, you need to install
Microsoft SQL Server 2012 Express to the application server. This allows the application
server to communicate to the database server.
You can download the ENU\x64\SQLManagementStudio_x64_ENU.exe file from the
Microsoft download site https://www.microsoft.com/en-sg/download/details.aspx?id=29062.
Click Download to see the list of files where you can select the mentioned file.

Version 2.3 19
Industry Software Suites Performance Manager Setup Guide General Prerequisites for All Servers

System Requirements
Hardware requirements to set up Performance Manager are described in the example
architecture and performance test result page in the Performance Manager Developer
Network (PMDN) https://oosa-confluence.au.schneider-electric.com/x/vwJ2Cg. The page
provides guidance to solution architects in system sizing when deploying a particular solution.
For software requirements, see the Readme file that comes with the installer.

Verifying SQL Server Is Installed and Running


Ensure that Microsoft SQL Server is installed and running on all your servers.
NOTE: Performance Manager supports Microsoft SQL Server 2014 and 2016.
To verify Microsoft SQL Server is running
1. Go to the Start menu, and select Control Panel.
2. Select Administrative Tools, and then select Services.
3. In the Services window, look for SQL Server (MSSQLSERVER) and verify that under the
Status column, Running appears next to this service.

Microsoft Windows Domain Controller


A Microsoft Windows Domain Controller must exist and the servers that will be used to set up
the Performance Manager must be joined to that Microsoft Windows domain.
Creating User Accounts and Associating with Security Groups
Create a user account that you can use to log in and install the Performance Manager
components.
For example: mydomain\user1
When installing, ensure that mydomain\user1 account:
 Is a member of local administrators in each server
 Has a SQL Server login, and the SQL Server login has dbcreator and securityadmin
privilege
IMPORTANT: For Wonderware Intelligence installation and configuration, sysadmin
privilege is required for the SQL Server login.
Adding the SQL Server Role dbcreator to the Domain User Account
Ensure that the domain user who is installing the software has a SQL Server account, and
this domain user account is granted with dbcreator server role. You can perform this task
using the SQL Server Management Studio.

Disabling the Internet Explorer Enhanced Security


Configuration and Compatibility View Settings
To prevent the Internet Explorer from blocking the Enterprise Console content, disable the
Internet Explorer Enhanced Security Configuration and Compatibility View settings.

20 Version 2.3
General Prerequisites for All Servers Industry Software Suites Performance Manager Setup Guide

To disable the Internet Explorer Enhanced Security Configuration


1. Go to the Start menu, and run the Server Manager.
2. In the Server Manager window, select Local Server in the left pane.
3. In the right pane, verify that IE Enhanced Security Configuration is set to off for both
Administrators and Users.

To disable Compatibility View settings


1. In the Internet Explorer, go to Tools, and select Compatibility View settings.
2. In the Compatibility View Settings window, deselect Display intranet sites in
Compatibility View.
3. Click Close, and then close the Internet Explorer.

Required Firewall Exceptions


Refer to this table for the required firewall exceptions for each of the servers in Performance
Manager.

Component Configuration Configuration Value

KPI Manager Port TCP:9000, 8091, 8092,


8093, 8094, 8095, 8096
 OLE DB database
connector Repository (SQL Server) TCP:1433
 Excel database eDNA <eDNA Services*>
connector
 Historian database
connector
 eDNA database
connector
 WSP database
connector
 OPC HDA database
connector
Event Manager Port TCP: 9001

eDNA Web TCP:80

Industry Console TCP:8000, 9004, 9005

Intelligence SQL Server TCP:1433


61076, 61075 (for
Intelligence Model
builder)
SSRS reports Port TCP: 80, 1433, 1434

Version 2.3 21
Industry Software Suites Performance Manager Setup Guide General Prerequisites for All Servers

Adding Firewall Exceptions


To add firewall exceptions:
1. Go to the Start menu, and select Control Panel > Windows Firewall.
2. In the left pane, select Advanced settings.
The Windows Firewall with Advanced Security dialog box appears.
3. In the left pane, select Inbound Rules.
4. In the third pane, select New Rule.
The New Inbound Rule Wizard dialog box appears.
5. In the Rule Type section, select Port, and then select Next.
6. In the Protocol and Ports section, select TCP, specify the ports, and then select Next.
For example: 1433
7. Keep the default selection, and select Next.
8. Deselect Private and Public options, keep Domain selection, and select Next.
9. Enter a name and description for the port exemption, and then select Finish.
* Ensure that eDNA Services -- SVCDIR, HISTORY AND UNIV -- are allowed through firewall
on the server where ODS is installed.

Schneider Electric License Manager and License Server


Installation
Ensure that the Schneider Electric (SE) License Manager and License Server version 3.2 are
already installed before running the Performance Manager installer. You only need one
instance of these and can be installed in any server within your network domain.
You can access the installers for these two from <Media>\CD-SE Licensing.
Installing the License Hotfix
Apply the license hotfix provided to resolve the licensing issue that you may encounter in
Wonderware Skelta BPM.
1. Go to <Media>\CD-SELicensing\LicAPIHotfix – Skelta.
2. Follow the instructions provided in the Readme (Schneider Electric Licensing Skelta
2017 Hotfix L00148477.html) on installing the hotfix.

22 Version 2.3
Industry Software Suites Performance Manager Setup Guide

C HAPTER 4
Performance Manager Components
Installation
You can install the different components of Performance Manager based on a standard or
distributed architecture. For guidance on installing the components and information on
supported architectures, see Installation Architecture (on page 10).
For general prerequisites, see General Prerequisites for All Servers (on page 19). For related
information on administrator privileges when installing the Performance Manager
components, see Microsoft Windows Domain Controller (on page 20).
When running the installer, these are some of the things to note:
 The list of prerequisites in the Prerequisite dialog box changes according to the
components you selected to install
 If multiple components are selected, input options for the different components are
consolidated and shown together. If more than one components are using the same input
option, that option appears only once. For example, the input for the KPI Manager
database.

In This Chapter
Intelligence Server Prerequisites and Installation .................................................................................. 23
Industry Console with Skelta Prerequisites and Installation ................................................................... 26
Operations Data Management Prerequisite and Installation .................................................................. 34
Decision Manager and Event Manager Prerequisite and Installation .................................................... 36
Installing KPI Manager ............................................................................................................................ 37
KPI Manager Data Connectors Prerequisites and Installation ............................................................... 39

Intelligence Server Prerequisites and Installation


Perform the following prerequisite tasks before installing the software components for the
Intelligence Server.

Installing and Configuring the SQL Server Reporting Services


Install the SQL Server Reporting Services (SSRS) and configure its connection before setting
up the Intelligence Server.
For the steps you can refer to on setting up SSRS, see Install SQL Server Reporting Services
on the Microsoft documentation https://docs.microsoft.com/en-us/sql/reporting-
services/install-windows/install-reporting-services-native-mode-report-server.
NOTE: Performance Manager 2.3 supports SSRS 2016.

Version 2.3 23
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

For SSRS post configuration, take note of the following URLs from Reporting Services
Configuration Manager. These will be used later to configure all report-related connections
in both Decision Manager and ODS Skelta packages.
 Report Server Web Service URL
http://<intelligence_servername>/<ReportServerWebServiceVirtualDirectory>
For example: http://Node1/ReportServer_MSSQLSERVER2016
 Web Portal Web URL / Report Manager URL
http://<IntelligenceServer>/<VirtualDirectory>
For example: http://Node1/Reports_MSSQLSERVER2016

Installing the Intelligence Server


Install the Intelligence Server on its own server. To install:
 You must have sysadmin privilege, for both the operating system and databases on the
local computer
 Ensure that SSRS service is running and the URLs mentioned in Installing and
Configuring the SQL Server Reporting Services (on page 23) are accessible before
running the installer
To install the Intelligence Server
1. In the root directory of the <Media>, double-click the Setup.exe file.
The Welcome dialog box appears, and then the server selection dialog box.
2. Select Intelligence Server, and select Next.
The software prerequisite dialog box appears. It shows if the listed prerequisites are met.
If all are met, select Next.
3. Read and accept the license agreement, and select Next.
4. Enter a domain name, username, and password.
For example:
o Domain Name: mydomain
o Username: user1
o Password: mypassword
Select Next.
The SQL Server authentication dialog box appears.
5. You can keep the default values, and select Next.
For example:
o SQL Server Authentication Type: Windows
o SQL Server Name: intelligence_server
NOTE: The SQL Server Name is automatically populated with the name of the
localhost. You can keep the default. If you have selected SQL Server as the
authentication type, you need to provide the SQL Server username and password.

24 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

6. Provide the following information, and select Next:

Option Description

Install Path This is the Install destination directory.


For example: C:\Program Files (x86) (default)
Data/Log/Reports Path This is the directory where you want to save all the log
files related to the installation. For example:
C:\PMLogs

NOTE: In a distributed environment, ensure that the


folder you specified here exists in the remote
database server.

Select Report Server URL This is the URL of the Performance Manager report
server. For example:
http:\\intelligence_server\<ReportServer_M
SSQLSERVER2016>
Intelligence Data Store Database Name This is the name of the Intelligence database. For
example: IntelligenceDB (default)
Intelligence Data Adapter Service Port This is the port number that you want the Intelligence
Number Data Adapter for eDNA to use. For example: 8732
(default)
LicAPI Server Name This is the name of the server where the Schneider
Electric License Server is installed. For example:
intelligence_server
LicAPI Port Number This is the port number that you want to use for the
Schneider Electric License Manager. For example:
55555 (default)
7. Review the product summary dialog box, and select Install.
The wizard starts installing the software components.
8. When the installation is complete, select Finish.
(Optional) Select View Log to verify the installation. If you see any error in the log file,
please contact the Customer Support.
The Reboot Confirmation dialog box appears. To complete the installation, select
Reboot Now.
IMPORTANT: If Intelligence Server and IntelligenceDB are on different server, grant the
server access to IntelligenceDB. For information on granting access, see Granting Database
Access to Remote Server (on page 90).

Activating the Wonderware Intelligence License File


Activate the Wonderware Intelligence license file (<WWSalesOrderNo-Intelligence>-
Licenses.xml.zip) that is delivered as part of your order using the Schneider Electric License
Manager.
For detailed activation steps, see:

Version 2.3 25
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

 Online Activation https://softwaresupportsp.schneider-


electric.com/#/okmimarticle/docid/tn1395
 Offline Activation https://softwaresupportsp.schneider-
electric.com/#/okmimarticle/docid/tn1396
Use your Schneider Electric Global Customer Support site login account when prompted for
login details.

Industry Console with Skelta Prerequisites and Installation


Ensure that the following Wonderware Skelta BPM prerequisites tasks are met before
installing the Industry Console with Wonderware Skelta BPM component.

Running Update for Windows Server 2012 R2


If you are running the installer on Windows Server 2012 R2, download and install the
Windows update KB2919355 (Windows8.1-KB2919355-x64.msu) on the server.

Common Licensing API Framework


Ensure that the Common Licensing API Framework is already installed. You can access the
installer from <Media>\CD-Skelta\Wonderware Skelta BPM 2017 -
64bit\ISSetupPrerequisites\Common-Licensing-API-Framework.

Activating Software Licenses


The software licenses required for Industry Console with Wonderware Skelta BPM and ODM
are:
 Wonderware Skelta BPM XML license file (<WWSalesOrderNo-Skelta>-
Licenses.xml.zip): This is delivered as part your order. Extract and save the XML license
file in the server where Industry Console with Wonderware Skelta BPM is. Use the
Schneider Electric License Manager and License Server to activate. For installer
information, see Schneider Electric License Manager and License Server Installation (on
page 22).
For detailed activation steps, see:
o Online Activation https://softwaresupportsp.schneider-
electric.com/#/okmimarticle/docid/tn1395
o Offline Activation https://softwaresupportsp.schneider-
electric.com/#/okmimarticle/docid/tn1396
Use your Schneider Electric Global Customer Support site login account when prompted
for login details.
 Wonderware eDNA Web registration keys: A demo license is included in the initial
server software installation and expires after 45 days. To install the official eDNA Web
license, see the Registering Licenses topic in the eDNA License Manager Administrator
Guide.

26 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

You can download this document from the InStep support website
https://support.instepsoftware.com/login.asp.

Installing the AIM Certificate Manager and Identity Manager


If Wonderware Historian is installed in the server where Industry Console with Wonderware
Skelta BPM is, stop all these Historian related services before installing the prerequisite
applications for a successful installation:
 Wonderware Historian Client Access Point
 Wonderware Historian Indexing
 Wonderware Historian System Driver
 Wonderware Historian Storage
 Wonderware Historian Manual Storage
 Wonderware Historian IOServer
 Wonderware Historian Event System
Install the prerequisite applications in the following order. You can access their respective
installers from <Media>\CD-Skelta\Wonderware Skelta BPM 2017 -
64bit\ISSetupPrerequisites.
1. AIM Certificate Manager
This needs to be installed on the local disk.
a. Run CertificateManager.msi. From the Web Application Configurator options, select
Will be installed on local hard drive and follow the wizard to continue with the
installation:

Version 2.3 27
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

Ensure to reboot the system after the installation.


2. AIM Identity Manager
a. Run ArchestrAIdentityManager.msi and follow the wizard to continue with the
installation.
NOTE: When you run the installer, it installs the software and disappears without any
message. This is expected, but just ensure that the software is installed through the
Windows Control Panel > Programs and Features.

Installing Internet Information Services (IIS) and ASP.NET


Components
Install the IIS and ASP.NET components on this server. These components are required. Use
the Server Manager to perform this task.
To install the IIS and ASP.NET components
1. Hold the Windows Key + "R" to open Run command, and type servermanager, then
select OK.
The Server Manager dialog box appears.
2. In the Server Manager > Dashboard, select Add roles and features.
The Add Roles and Features Wizard appears.
3. Select Installation Type in the left pane of the wizard, and then select Role-based or
feature-based installation in the right pane. Select Next.
4. In the Server Selection section, select your local server name from the Server Pool.
Select Next.

28 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

5. In the Server Roles section of the wizard, scroll down and select Web Server (IIS).

The Add Roles and Features Wizard dialog box appears with the features required for
the Web Server (IIS). Select Add Features.
The dialog box closes. Select Next.
6. In the Features section, do these:
a. Expand .NET Framework 3.5 Features, and select HTTP Activation
NOTE: The Add Roles and Features Wizard window appears when you select HTTP
Activation feature. Select Add Features.
b. Expand .NET Framework 4.5 Features, and then expand WCF Services. Select
HTTP Activation.
NOTE: The Add Roles and Features Wizard window appears when you select HTTP
Activation feature. Select Add Features.
7. Instead of selecting Next, select Roles Services right away on the left pane (skip Web
Server Role (IIS) section), and do the following:
a. In the Web Server node, ensure that these roles services are selected in their
respective section:
Common HTTP Features
 Default Document
 Directory Browsing
 HTTP Errors

Version 2.3 29
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

 Static Content
 HTTP Redirection
Health and Diagnostics
 HTTP Logging
 Logging Tools
 Request Monitor
 Tracing
Performance
 Static Content Compression
 Dynamic Content Compression
Security
 Request Filtering
 Windows Authentication
Application Development
 .NET Extensibility 3.5
NOTE: The Add Roles and Features Wizard window appears when you select this
feature. Select Add Features.
 .NET Extensibility 4.5
 ASP
 ASP.NET 3.5
NOTE: The Add Roles and Features Wizard window appears when you select this
feature. Select Add Features.
 ASP.NET 4.5
 CGI
 ISAPI Extensions
 ISAPI Filters
8. In the Management Tools, ensure that these roles services are selected:
 IIS Management Console
 IIS 6 Management Compatibility
 IIS 6 Metabase Compatibility
 IIS Management Scripts and Tools

30 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

 Management Service

Select Next. The Confirm installation selections window appears.


9. In the Confirm installation selections dialog box, select Install.
You are shown with the list of all the components you selected in every section of the
wizard.
The wizard starts installing the features or components, and Installation progress
window appears.
10. When the installation is complete, a message about successful installation appears in the
same Installation progress window. Select Close.

Configuring the MSDTC in Windows Server 2012 R2


Configure the Component Services and Microsoft Distributed Transaction Controller
(MSDTC) to exchange information between remote servers. For detailed steps, see Configure
MSDTC on SQL Server and adapter client on Microsoft Documentation
https://docs.microsoft.com/en-us/biztalk/adapters-and-accelerators/adapter-sql/configure-
msdtc-on-sql-server-and-adapter-client, or see Enable and Verify MSDTC on Wonderware
Skelta BPM 2017 documentation http://sun.skelta.com/index.htm#181613
IMPORTANT: If you are setting up in a distributed environment, MSDTC has to be configured
in both servers where the database is (database server) and in the server where the
component or application (application server) is installed.

Editing the Wonderware Skelta BPM XML File for Configuration


Create your own copy of the example Wonderware Skelta BPM XML file, and edit it to be
used in the installation process. The XML modifications are necessary for automating the
Skelta Farm database and repository creation, as well as automating some related
configurations.

Version 2.3 31
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

You can access the example configuration (SampleWWSKBPMConfig.xml) provided in the


.iso (<Media>\CD-Skelta\SampleConfiguration). After editing the necessary sections in the
XML file, save it as WWSKBPMConfig.xml.
In the example XML file, these are the connection strings with default values, but you have
the option to modify them.

Connection String Default Value

<FarmDatabaseName> SkeltaFarmDB
<DataSourceName> PMDS
<DatabaseName> PMDB
<RepositoryDataSource> PMDS
<RepositoryName> PMRepo
In the following XML sections, replace the highlighted items with your server details.
NOTE: If a default instance exists, SQL_SERVER_INSTANCE is not required.
<SchneiderElectricLicensing>

<FarmDatabase>

<DataSource>

<RepositorySettings>
Important things to take note of when replacing the highlighted items in this section:
 In the <ActiveDirectorySearchBase> element, update the value to match the full domain
path.
For example, if the full domain path is mydomain.dev.wonderware.com, the
configuration must be:

32 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

<ActiveDirectorySearchBase>DC=mydomain,DC=dev,DCwonderware,DC=com</ActiveD
irectorySearchBase>
 In the <DomainName> element, don't forget to include the backslash (\). For example:
mydomain\
 In the <AuthenticationUser> element, don't include the domain name. Just put the user
name
For example: user1
If these are not properly configured, the configuration of the repository through the master
installer will fail.

Disabling the Browser's Pop-up Blocker


Disable your browser's pop-up blocker. This is to ensure that your browser allows workflow
pop-up notifications from the KPI Manager module.

Installing the Industry Console with Wonderware Skelta BPM


Install the Industry Console with Wonderware Skelta BPM in the same server as Decision
Manager/Event Manager, KPI Manager and Operations Data Management (ODM).
To install the Industry Console with Wonderware Skelta BPM
1. In the root directory of the <Media>, double-click the Setup.exe file.
The Welcome dialog box appears, and then the server selection dialog box.
2. Select Industry Console with Wonderware Skelta BPM, and select Next.

Version 2.3 33
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

The software prerequisite dialog box appears. It shows if the listed prerequisites are met.
If all are met, select Next.
3. Read and accept the license agreement, and select Next.
4. Provide the requested details.
For example:
o Install Path: mydomain
o Skelta BPM Configuration XML File Path: C:\WWSKBPMConfig.xml
o Data/Log/Reports Path: C:\PMLogs
o CorsOrigins: http://PerfServerPM23PF:9005, http://localhost:9005...
For more information on this, see CORS Origin (on page 98).
o KPIManager Host Name: KPIManagerServer
o Skelta Workflow User (Without Domain specified): <This should be the Skelta
admin user ID without the domain name>
o Server Root Port: 9004 (default)
o Client Root Port: 9005 (default)
Select Next.
5. Review the product summary dialog box, and select Install.
The wizard starts installing the software components.
6. When the installation is complete, select Finish.
(Optional) Select View Log to verify the installation. If you see any error in the log file,
please contact the Customer Support.
The Reboot Confirmation dialog box appears. To complete the installation, select
Reboot Now.
IMPORTANT: If Industry Console with Skelta and its databases (PMDB, PMDB_BI,
SkeltaFarmDB) are on different server, grant the server access to the databases. For
information on granting access, see Granting Database Access to Remote Server (on page
90).

Operations Data Management Prerequisite and Installation


Ensure that mixed mode authentication in SQL Server is enabled for eDNA Web to work
before installing the Operations Data Management (ODM).
Verifying mixed mode authentication is enabled
1. Connect to Microsoft SQL Server using the Microsoft SQL Server Management Studio.
2. In the Object Explorer, right-click on the server, and select Properties.
3. In the Server Properties dialog box, select Security.
4. In the right pane, under the Server authentication section, ensure that the SQL Server
and Windows Authentication mode option is selected.

34 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

5. If you modify the authentication to enable mixed mode, click OK, and restart SQL Server
in the Services administrative tool.

Installing ODM
Install ODM on the same server as Industry Console, Decision Manager/Event Manager, and
KPI Manager.
To install ODM
1. In the root directory of the <Media>, double-click the Setup.exe file.
The Welcome dialog box appears, and then the server selection dialog box.
2. Select Operations Data Management (ODM), and select Next.
The software prerequisite dialog box appears. It shows if the listed prerequisites are met.
If all are met, select Next.
3. Read and accept the license agreement, and select Next.
4. Provide the requested details.
For example:
o Install Path: C:\Program Files (x86) (Default)
o Data/Log/Reports Path: C:\PMLogs (Default)
o eDNA Web Database Name: eDNAWeb (Default)
o eDNA Database Login Name: ednawebuser (Default)
o eDNA Database Login Password: mypassword
Select Next.
5. Review the product summary dialog box, and select Install.
The wizard starts installing the software components.
6. When the installation is complete, select Finish.
(Optional) Select View Log to verify the installation. If you see any error in the log file,
please contact the Customer Support.
The Reboot Confirmation dialog box appears. To complete the installation, select
Reboot Now.
IMPORTANT: If ODM and eDNAweb are on different server, grant the server access to
eDNAweb. For information on granting access, see Granting Database Access to Remote
Server (on page 90).

Version 2.3 35
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

Decision Manager and Event Manager Prerequisite and


Installation
If you plan to create the database for Decision Manager and Event Manager in a different
SQL server as Skelta Repository and ODM databases, ensure to create the corresponding
linked servers first before installing Decision Manager and Event Manager. You only need to
create one linked server in the Decision Manager and Event Manager database server if both
Skelta Repository and ODM databases are in the same remote server, otherwise you need to
create a linked server for each.
NOTE: The following steps are not required if all the databases are on the same server.
To create a Linked Server
1. Open the SQL Server Management Studio.
2. In the left pane (Object Explorer), expand Server Objects, right-click Linked Servers,
and then select New Linked Server.
3. In the New Linked Server dialog box, enter the Linked server name and select Other
data source as the Server type, and then provide the following information:
o Linked server: <ServerName> (This must be the name of the server where Skelta
Repository and ODM databases are, assuming they are in the same server)
o Provider: SQL Server Native Client 11.0 (Select from the list)
o Product Name: sql_server
o Data Source: <ServerName>
Leave the rest of the fields empty.
4. In the left pane, select Security, and in the right pane, select Be made using this
security context.
5. Enter the Remote login and password.
For example:
o Remote login: user1 (This login account must match with the one in the server you
have specified in step 3)
o with password: mypassword
6. In the left pane, select Server Options, and set the values for these property settings to
True:
o Data Access
o RPC
o RPC Out
o Use Remote Collation
7. Select OK.
To test the connection, right-click the created Linked Server, and select Test
Connection.

36 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

Installing Decision Manager and Event Manager


Install the Decision Manager and Event Manager on the same server as Industry Console,
KPI Manager, and ODM.
To install the component
1. In the root directory of the <Media>, double-click the Setup.exe file.
The Welcome dialog box appears, and then the server selection dialog box.
2. Select Decision Manager and Event Manager, and select Next.
The software prerequisite dialog box appears. It shows if the listed prerequisites are met.
If all are met, select Next.
3. Read and accept the license agreement, and select Next.
4. Provide the requested details.
For example:
o Install Path: C:\Program Files (x86) (Default)
o Data/Log/Reports Path: C:\PMLogs (Default)
o eDNA Web Database Name: eDNA Web (Default)
o Skelta Linked Server (Optional): server name of the Skelta Repository linked server
o EDNA Linked Server (Optional): server name of the ODM databases on the linked
server
Select Next.
5. Review the product summary dialog box, and select Install.
The wizard starts installing the software components.
6. When the installation is complete, select Finish.
(Optional) Select View Log to verify the installation. If you see any error in the log file,
please contact the Customer Support.
The Reboot Confirmation dialog box appears. To complete the installation, select
Reboot Now.
IMPORTANT: If Decision Manager / Event Manager and the DecisionManager database are
on different server, grant the server access to the database. For information on granting
access, see Granting Database Access to Remote Server (on page 90).

Installing KPI Manager


Install KPI Manager on the same server as Decision Manager and Event Manager, Industry
Console, and ODM, or on the server where the KPI Manager data connectors are. Installing
the KPI Manager component installs its services and Web API.
To install the KPI Manager
1. In the root directory of the <Media>, double-click the Setup.exe file.
The Welcome dialog box appears, and then the server selection dialog box.

Version 2.3 37
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

2. Select KPI Manager, and select Next.


The software prerequisite dialog box appears. It shows if the listed prerequisites are met.
If all are met, select Next.
3. Read and accept the license agreement, and select Next.
4. Enter a domain name, username, and password.
For example:
o Domain Name: mydomain
o Username: user1
o Password: mypassword
Select Next.
The SQL Server authentication dialog box appears.
5. You can keep the default values, and select Next.
For example:
o SQL Server Authentication Type: Windows
o SQL Server Name: intelligence_server
NOTE: The SQL Server Name is automatically populated with the name of the
localhost. Use the SQL Server where you want to install the KPI Manager.
6. Provide the following information, and select Next:

Option Description

Install Path This is the install destination directory.


For example: C:\Program Files (x86) (default)
KPI Manager Database Name This name of the KPI Manager database. For
example: KPIManager (default)
OLEDB Service Port Number This is the port number of the OLEDB service. For
example: 8091 (default)
Excel Service Port Number This is the port number of the Excel service. For
example: 8092 (default)
Historian Service Port Number This is the port number of the Historian service. For
example: 8093 (default)
eDNA Service Port Number This is the port number of the eDNA service. For
example: 8094 (default)
OPC HDA Service Port Number This is the port number of the OPC HDA service. For
example: 8095 (default)
WSP Service Port Number This is the port number of the Wonderware System
Platform service. For example: 8096 (default)
OLEDB Service Host Name This is the name of the server where the OLEDB data
connector is installed. For example: localhost
(default)

38 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

Excel Service Host Name This is the name of the server where the Excel data
connector is installed. For example: localhost
(default)
Historian Service Host Name This is the name of the server where the Historian
data connector is installed. For example: localhost
(default)
eDNA Service Host Name This is the name of the server where the eDNA data
connector is installed. For example: localhost
(default)
OPC HDA Service Host Name This is the name of the server where the OPC HDA
data connector is installed. For example: localhost
(default)
WSP Service Host Name This is the name of the server where the Wonderware
System Platform data connector is installed. For
example: localhost (default)
7. Review the product summary dialog box, and select Install.
The wizard starts installing the software components.
8. When the installation is complete, select Finish.
(Optional) Select View Log to verify the installation. If you see any error in the log file,
please contact the Customer Support.
The Reboot Confirmation dialog box appears. To complete the installation, select
Reboot Now.
IMPORTANT: If KPI Manager and the KPIManager database are on different server, grant
the server access to the database. For information on granting access, see Granting
Database Access to Remote Server (on page 90).

KPI Manager Data Connectors Prerequisites and Installation


Before installing the KPI Manager data connectors, ensure that you have checked the
following prerequisites that apply to some of the data connectors.
If you are installing the data connectors on a server different from the KPI Manager, ensure
that the KPI Manager is installed first before the data connectors, and that the KPI Manager
database is accessible from the data connector server. This is to allow successful data
connector configuration during the installation.
If you are installing the KPI Manager together with the data connectors, the installer handles
this sequence accordingly.

KPI Manager Data Connectors Prerequisites


Depending on the KPI data sources that you plan to use with the KPI Manager, the following
components need to be installed first before installing the corresponding connectors.

Data Source Required Component Link to Download Site

OLE DB OLE DB Provider from Database


Vendor

Version 2.3 39
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

Excel Microsoft Access Database Engine Microsoft Access download site


Redistributable https://www.microsoft.com/en-
us/download/details.aspx?displaylang=en&id=1
3255

NOTE: Download the 64-bit (x64) version of the


Microsoft Access Database Engine.

OPC HDA  opc-core-components- OPC Developer Tools download site


redistributables-3.00.107- https://opcfoundation.org/developer-
20171009 tools/developer-kits-classic
 opc-data-access-3.00-binaries- NOTE: To download, you can register for a free
106.0-20160610.zip account with OPC Foundation. You don't need
to become a paid member to get access to the
required software downloads.

WSP  MXAccess Toolkit NOTE: License is required for these connectors.


 GRAccess Toolkit
These are prerequisites for the
Wonderware System Platform data
agent.

Installing the Wonderware System Platform Data Agent


Install the Data Agent for Wonderware System Platform if you need to connect to
Wonderware System Platform. Install the data agent in the same server where the
Wonderware System Platform is.
NOTE: This data agent is only needed if the customer is using a Wonderware System
Platform data connector.
To install the data agent
1. Go to <Media>\CD-PM\CD-KPI Manager\KPISPDataAgent, and run the setup.exe file.
2. Follow the wizard for the installation instructions.
Use the Configurator to configure the data agent settings. Refer to the Wonderware
System Platform Data Agent Configuration (on page 40) table for guidance on filling up
the section in the Configurator.
NOTE: When you click View Install Guide, this opens up in the agent's install directory.
To see the module's install guide (which is the setup guide), navigate to the root directory
of the <Media>.
If the KPI SP Data Agent and the KPIManager database are on different server, grant the
server access to the database. For information on granting access, see Granting Database
Access to Remote Server (on page 90).

Wonderware System Platform Data Agent Configuration

40 Version 2.3
Performance Manager Components Installation Industry Software Suites Performance Manager Setup Guide

Option Description Example

Repository Configuration

SQL Server Name Enter the name of the server where the KPI <kpimanager_database_serve
Manager database is available. r>

Database Enter the name of the database. KPIManager

Integrated Security (Selected by default) Deselect if security for


Wonderware System Platform is disabled.

Galaxy Connection Configuration

Galaxy Name Enter the name of the galaxy to which the


agent will connect to.

Galaxy User Enter the name of the galaxy user. user1

Galaxy Password Enter the galaxy password. mypassword

Data Agent Web API Configuration

TCP Port Enter the TCP port number the agent will bind 9009
to.

Use HTTPS If you select this option, you need to bind the
SSL certificate to the configured port number.
For information on binding the SSL certificate
to a port number, see the topic How to:
Configure a Port with an SSL Certificate in the
Microsoft documentation
https://msdn.microsoft.com/en-
us/library/ms733791(v=vs.110).aspx.
Service Log On User

Local System Account (Selected by default) Keep the default if you're


running the Windows Service with the local
account.
User Account If selected, provide a user name and
password to access the database.

User Enter a user name user1

Password Enter a password mypassword

Version 2.3 41
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Installation

Installing the KPI Manager Data Connectors


Install the data connector or data connectors that you plan to use in your environment on their
own server, or on the same server as the KPI Manager.
To install the data connectors
1. In the root directory of the <Media>, double-click the Setup.exe file.
The Welcome dialog box appears, and then the server selection dialog box.
2. Select the data connectors to install, and select Next.
NOTE: Although you have the option to install the data connectors on different servers,
based on the tested standard and distributed architectures, they are all installed on the
same server.
The software prerequisite dialog box appears. It shows if the listed prerequisites are met.
If all are met, select Next.
3. Read and accept the license agreement, and select Next.
The SQL authentication dialog box appears.
4. Enter the name of the server that has the KPI Manager database in the SQL Server
name. Select Next.
5. Provide the requested details.
For example:
o Install Path: C:\Program Files (x86) (default)
o KPI Manager Database Name: KPIManager (default)
o Historian Service Port Number: 8093 (default)
NOTE: The text for this input option changes depending on the selected data
connector.
Select Next.
6. Review the product summary dialog box, and select Install.
The wizard starts installing the software components.
7. When the installation is complete, select Finish.
(Optional) Select View Log to verify the installation. If you see any error in the log file,
please contact the Customer Support.
The Reboot Confirmation dialog box appears. To complete the installation, select
Reboot Now.
IMPORTANT: If KPI Connectors and the KPIManager database are on different server, grant
the server access to the database. For information on granting access, see Granting
Database Access to Remote Server (on page 90).

42 Version 2.3
Industry Software Suites Performance Manager Setup Guide

C HAPTER 5
Performance Manager Components
Configuration
Before you start the configuration, ensure that:
 You have installed all the components in their respective servers
 You have the necessary IP addresses of the servers to which you install the different
components

In This Chapter
Wonderware Skelta BPM Configuration ................................................................................................. 43
Industry Console Configuration .............................................................................................................. 47
Configuring the KPI Manager ................................................................................................................. 48
Event Manager Configuration ................................................................................................................. 56
Configuring SQL Server Connection for Data Connectors ..................................................................... 59
Application Packages ............................................................................................................................. 60
Setting Up Industry Console ................................................................................................................... 63
Optional Configuration Related to Industry Console .............................................................................. 65
ODM Configuration ................................................................................................................................. 66
Managing Users ...................................................................................................................................... 70
Managing Security .................................................................................................................................. 76
Intelligence Server Configuration .......................................................................................................... 82

Wonderware Skelta BPM Configuration


Additional configuration for Wonderware Skelta BPM is required and it's described in the
following section.

Configuring the Admin User for Skelta Repository Database


Ensure that the Internet Explorer Enhanced Security Configuration and Compatibility View
settings are disabled before performing this task in the server where Industry Console with
Wonderware Skelta BPM is installed. Verify too that the WonderwareSkeltaBPMSites in the
IIS Manager is running.
To configure the Skelta Repository database
1. Go to the Start menu, and run the Central Configuration wizard as administrator.

Version 2.3 43
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

If the Windows Security login dialog box appears, provide your login credentials. This is
the user account you created earlier, which you can also use to install the Performance
Manager components. The Wonderware Skelta BPM Central Configuration page
appears.
2. In the Wonderware Skelta BPM Central Configuration page, select Repository
Settings.
3. In the Repository List page, select Configure Now link under Is Admin Configured
column.
NOTE: If the Repository List page is empty, you probably missed some steps when you
were editing the Wonderware Skelta BPM XML file, so the repository is not created. To fix
this, click Add to manually create the repository using the values specified in the
<RepositorySettings> section in the Editing the Wonderware Skelta BPM XML File for
Configuration (on page 31) topic.
4. In the Administrator Configuration page, click on the User Lookup button.

The User Lookup dialog box appears.


5. In the User Lookup dialog box, do these:
a. Enter the Active Directory (AD) user name that you want to use as an administrator in
the Search For option, and select Search.

44 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

The lookup utility searches for the existing AD accounts based on the value you
entered.

b. Select the user from the Available Resources box, and click the right arrow to move
the selected user to the Selected Resource box. Select Update.

Version 2.3 45
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

46 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

The user or resource you selected is populated in the User Lookup box in the
Administrator Configuration page.

Select OK. A confirmation message appears that the Administrator has been
configured successfully.
6. Close the Central Configuration wizard.

Industry Console Configuration


Refer to this table if you need to modify anything on the Industry Console configuration using
the Configurator. The following settings are silently configured during the Industry Console
installation.

Option Description Example

DB Configuration

Server Name Enter the name of the server where the performance_server
Industry Console database is installed.

Database Name Enter the name of the Industry Console IndustryConsoleDb


database. (Default)
(Optional) Click Migrate DB, and then click
Configure if in case the Industry Console
database has not been successfully created
during the Industry Console installation

Version 2.3 47
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

IndConsole Configuration

ServerRootAddress Enter the name of the name of the server performance_server:900


where Industry Console application is 4 (Default port)
installed and its port number.
ClientRootAddress Enter the name of the name of the server performance_server:900
where Industry Console application is 5 (Default port)
installed and its port number.
CorsOrigins Enter the CorsOrigins. http://performance_ser
ver:9005,
For more information on this, see CORS http://performance_ser
Origin (on page 98). ver.mydomain.com:9005

Configuring the KPI Manager


By default, there are KPI Manager settings that are silently configured during the installation
process, but there are sections that must be configured manually using the Configurator.
To configure the KPI Manager sections
1. Go to Start menu, and run the Configurator.
The Configurator window appears.
2. Provide the required information for the following sections of the Configurator and click
Configure after completing each section. The Configure button triggers the configuration
of the active section only. For guidance on filling the KPI Manager sections, see the
following:
o Operational Data Store Configuration (on page 48)
o Notification Configuration (on page 50)
o Intelligence and Event Manager Configuration (on page 51)
o Data Connectors Configuration (on page 52)
You can continue with Event Manager Configuration section if you want.
After the configuration, restart the KPI Manager Windows Services. Once the services are
running, check the log file to ensure that there are no errors. You can access the log file
from <PerformanceManagerInstallPath>\KPIManager\Logs.
Silently Configured KPI Manager Sections
(Optional) If you need to modify some settings in the KPI Manager sections that are silently
configured during the installation, run the Configurator and update the required sections.
o General Configuration (on page 53)
o Web API Configuration (on page 54)
o Notification Configuration (on page 50)

Operational Data Store Configuration

48 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Option Description Example

ODS Settings

ODS options (drop-down Select either eDNA or WW Historian option.


list)

eDNA option

Primary IP Enter the primary IP address. 10.186.208.11

This is the IP address of the server where


eDNA Services are running.
These are the eDNA Services that are
mentioned in the Before You Begin (on page
15) chapter.

NOTE: This primary IP configuration only


applies to eDNA as ODS, and not for
Wonderware Historian.

Primary Port Enter the primary port number that is 8009


configured for the eDNA service.

Alternative IP (Optional) Enter an alternative IP address. 10.186.208.10

Alternative Port (Optional) Enter an alternative port number. 8010


These alternative settings are applicable
when the eDNA Universal Service is
configured with redundancy.
These are not configured by default. Leave
them blank unless you did a manual
configuration to enable redundancy.
Service Name Enter the Wonderware eDNA service name. PMODS.UNIV

This is the name of the Universal Service in


this format <Site>.<Service>. You can get
this from the Wonderware eDNA explorer.
NOTE: The configurator does not validate
the service name you provide here. Ensure
that you are providing the correct Universal
Service name.

Cache Size* Enter the cache size. 10000 (default)

Version 2.3 49
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

Cache Path* Enter the cache path. <KPIManager Install


Path>\Uploads

Cache File* Enter the cache file. linkmxcache (default)

Wait Interval Enter the wait interval. 2000 (default)


This is a setting used internally when the KPI
Manager creates a Point in the eDNA
Universal Service. The KPI Manager waits
for the configured time (in milliseconds) after
sending a create point request to validate
that the point is created successfully in the
Universal Service.
WW Historian option

HostName or IP Enter the server name or its IP address 10.186.208.10

Store and Forward Path Select Browse to navigate to the designated C:\KPISF
path.

NOTE: If KPI Manager and Event Manager


are installed on the same computer, their
relevant store and forward path must be
different. Otherwise, the store forward
services will utilize the same set of files and
one of the services may fail to work.

User Enter the user name that will access the mydomain\user1
Wonderware Historian.

Password Enter the corresponding password. mypassword

* These are parameters that the eDNA API takes to work with the Universal Service. The API
uses these settings to configure a cache area to be used when the connection to the
Universal Service is lost. API calls made during the period will be cached until the connection
is restored.

Notification Configuration
Option Description Example

Notification

50 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Workflow Web API Enter the URL for the Web API that will http://<servername>:8000
trigger the specified notification workflow. /IndSolWorkflow.WebAPI
/api/workflow

NOTE: The <servername>


must be the IP address or the
name of the server where the
Skelta workflow is installed.

Notification Workflow Enter the name of the workflow that will KPIManagerNotification
trigger the notification. s (Default)
The workflow is delivered as part of the
module's Skelta package.
Email Subject Enter the subject of the email notification. KPI Manager
Notifications (Default)

Email Template Select Browse to navigate to the file of the <Performance Manager Install
HTML email template. Path>\Plugins\KPINotifi
cationTemplate.html

NOTE: If you encounter any issues related to notifications, see the


KPIManagerNotificationLog_<current_date>.txt file in <PMInstallPath>\KPIManager\Logs

Intelligence and Event Manager Configuration


Refer to this table for Intelligence and Event Manager configuration. This is necessary for the
KPI Manager Windows Services to connect to the Intelligence database, which is assumed to
be installed on a different server.

Option Description Example

Intelligence Configurations

Server Name Enter the name of the server where <intelligence_servername>


Wonderware Intelligence is installed.

Database Enter the Intelligence database name. IntelligenceDB

Version 2.3 51
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

Integrated Security (Selected by default) If you deselect this User: sa


checkbox, you need to provide the User and
Password for the Microsoft SQL Server Password: <sa-password>
details.
IMPORTANT: Integrated Security is
recommended. This means that the KPI
Manager services connect to the repository
using the logon identity (Local System) of the
services. If you use this option, grant the
local system account of the KPI Manager
Windows Services server the access to
Intelligence server's SQL Server. To do this,
see issue no. 2 in the Troubleshooting page
in PMDN https://oosa-
confluence.au.schneider-
electric.com/x/UYETCg.

User Enter the user name. user1

Password Enter the SQL Server password. mypassword

Event Store

Host Name or IP Enter the host name or the IP address <eventstore_servername>

NOTE: This must be the host name or IP


address of the Wonderware Historian server.

User Enter the user name. mydomain\user1


Use the Windows credential.
NOTE: This must be the user name that has
access to Event Store.

Password Enter the password. mypassword

Store and Forward Path Select Browse to navigate to the path to C:\SFEvent
specify.

NOTE: If KPI Manager and Event Manager


are installed on the same computer, their
relevant store and forward path must be
different. Otherwise, the store forward
services will utilize the same set of files and
one of the services may fail to work.

Data Connectors Configuration

52 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Option Description Example

OLEDB: net.tcp// Enter the name or the IP address of the <OLEDBDataConnector_Node>:8091


server where the OLEDB connector is
installed and the port number of the data
connector service.
Excel: net.tcp// Enter the name or the IP address of the <ExcelDataConnector_Node>:8092
server where the Excel connector is
installed and the port number of the data
connector service.
Historian: net.tcp// Enter the name or the IP address of the <HistorianDataConnector_Node>:8093
server where the Historian connector is
installed and the port number of the data
connector service.
eDNA: net.tcp// Enter the name or the IP address of the <eDNADataConnector_Node>:8094
server where the eDNA connector is
installed and the port number of the data
connector service.
OPCHDA: net.tcp// Enter the name or the IP address of the <OPCHDADataConnector_Node>:8095
server where the OPC HDA connector is
installed and the port number of the data
connector service.
WSP: net.tcp// Enter the name or the IP address of the <WSPDataConnector_Node>:8096
server where the Wonderware System
Platform connector is installed and the
port number of the data connector
service.
B2MML: net.tcp// Enter the name or the IP address of the <B2MMLDataConnector_Node>:8097
server where the B2MML connector is
installed and the port number of the data
connector service.

General Configuration
Option Description Example

SQL Repository

SQL Server Name Enter the SQL Server Name . <KPIManager_DB_ServerNam


e>

Database Enter the SQL Server database name. KPIManager

If the database already exist, select Validate,


otherwise, select Create Database to create
a new one.

Version 2.3 53
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

Integrated Security (Selected by default) If you deselect this


checkbox, you need to provide the User and
Password for the Microsoft SQL Server.

NOTE: Integrated Security is


recommended. This means that the KPI
Manager services will connect to the
repository using logon identity of the service,
configured in this same section.

Service Log On User

Local System Account (Selected by default) This is if you're


currently logged in using the local account.

NOTE: If you're using this local account,


ensure that it has a read/write access to the
data provider database.

User Account If selected, this allows you to change the


service login to use a user-specified account
(a local user or a domain user), instead of a
Local System account.
It is recommended that you run the services
as a specific user rather than a system
account user, and that the user:
 must be granted with log on as service
rights
NOTE: If the user is not granted the rights to
"Log on as service" on the machine, the
services cannot be started. For detailed
steps to grant these rights, see the Microsoft
documentation
https://technet.microsoft.com/en-
us/library/cc794944(v=ws.10).aspx.

 must have CONNECT, SELECT,


INSERT, UPDATE, DELETE, and
EXECUTE rights to the repository
database, with Integrated Security
setting in the earlier section
User Enter a user name. user1
This is enabled when User Account is
selected.
Password Enter a password. mypassword
This is enabled when User Account is
selected.

Web API Configuration

54 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Option Description Example

Web API Configuration

NOTE: Restart the KPI Manager Web API service after configuring the Web API.

TCP Port Enter the port number where the Web API is 9000 (default)
binded to.

Enable Windows If selected, this means that the authentication


Authentication is enabled and only user added into the
system through the User Management tool
can access the KPI Manager.
When this is disabled, access control will not
happen in KPI Manager and any user can
configure KPIs and view KPI values.
If there is no admin user in the KPI Manager,
a username and password fields will appear
and you can then create an admin user.
Subsequent changes to the users can only be
performed through the User Management.
CORS Origin Enter the CORS origin. *

Use HTTPS If you select this option, you need to bind the
SSL certificate to the configured port number.
For information on binding the SSL certificate
to a port number, see Binding the SSL
Certificate to a Port Number (on page 76).

Upload Folder Enter the upload folder or select Browse to <KPI Manager Install
select a folder path. Path>\Uploads
This is a temporary folder where the .csv files
uploaded for KPI bulk import will be stored.
NOTE: It is recommended to have the Upload
folder outside of the Program Files folder.

Excel File Folder Enter the Excel file folder or select Browse to <KPI Manager Install
navigate to the path. Path>\Uploads
This is the recommended shared folder for
anyone to upload an Excel file from, where
KPI values can be extracted.
NOTE: It is recommended to have the Excel
File folder outside of the Program Files folder.
The services must have read/write access to
the folder.

CHaD Configuration

Version 2.3 55
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

URL Enter the CHaD Web services URL. http://localhost/ednaw


eb/WebService
This is the Wonderware eDNA Web service
URL.
CHaD User Enter the CHaD user name. instep

Password Enter the password. instep

Event Manager Configuration


You can refer to the following tables for help on filling up the Event Manager Configuration
sections. After providing the required information for each section in the Configurator, select
Configure.
Event Manager Database

Option Description Example

WW Historian Runtime Database

Host Name Enter the host name or the IP address of the <eventstore_servername>
Event Store host server.

Integrated Security (Selected by default) If you deselect this


checkbox, you need to provide the User and
Password for the Microsoft SQL Server
details.

NOTE: Integrated Security is


recommended. This means that the KPI
Manager services will connect to the
repository using logon identity of the service,
configured in this same section.

User Enter the user name. user1


Use the SQL user credentials.
NOTE: This is disabled if Integrated Security
is selected.

Password Enter the password. mypassword

NOTE: This is disabled if Integrated Security


is selected.

Decision Manager Database

SQL Server Name Enter the server name where the Decision <DecisionManager_EventMan
Manager and Event Manager are installed. ager_Node>

56 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Database Enter the Decision Manager database. DecisionManager (default)

Integrated Security (Selected by default) If you deselect this


checkbox, you need to provide the User and
Password for the Microsoft SQL Server
details.

NOTE: Integrated Security is


recommended. This means that the KPI
Manager services will connect to the
repository using logon identity of the service,
configured in this same section.

User Enter a user name. user1


Use the SQL user credentials.
This and the password option are enabled if
you deselect the Integrated Security option.
Password Enter a password. mypassword

OData and Web API Settings

WW Historian OData URL Enter the WW Historian OData URL. http://<IP_Address_Of_W


This is the OData Web API that Wonderware WHistorian_EventStore>:325
Historian exposes for querying event 69/Historian/v1/Event
information.
Event Manager Web API Enter the Event Manager Web API URL. http://<EventManager_Nod
URL e>:9001/api/event
This is the Web API for sending or posting
events to event store.
Event Manager Web API Configuration

Option Description Example

Event Store

Host Name or IP Enter the host name or the IP address of the 10.186.208.11
Historian server.

User Enter the user name that will be used to mydomain\user1


access the specified server.
Use the Windows user credentials.
Password Enter the user name that will be used to mypassword
access the specified server.

Version 2.3 57
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

Store and Forward Path Select Browse to navigate to the designated C:\EventSF
path.
NOTE: If KPI Manager and Event Manager
are installed on the same computer, their
relevant store and forward path must be
different. Otherwise, the store forward
services will utilize the same set of files and
one of the services may fail to work.

Web API Settings

Port Enter the port number. 9001

This is the port number that you want the API


to listen to.
Use HTTPS If you select this option, you need to bind the
SSL certificate to the configured port
number.
For information on binding the SSL certificate
to a port number, see Binding the SSL
Certificate to a Port Number (on page 76).
Use Windows If selected, this means that the authentication
Authentication is enabled and only user added into the
system through the User Management tool
can access the Event Manager.
When this is disabled, access control will not
happen in Event Manager and any user can
configure events.
If there is no admin user in the Event
Manager, a username and password fields
will appear and you can then create an
admin user.
Subsequent changes to the users can only
be performed through the User Management.
Service Log On User

Local System Account (Selected by default) This is if you're currently


logged in using the local account.
NOTE: If you're using this local account,
ensure that it has a read/write access to the
data provider database.

58 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

User Account If selected, this allows you to change the


service login to use a user-specified account
(a local user or a domain user), instead of a
Local System account.
It is recommended that you run the services
as a specific user rather than a system
account user, and that the user:
 must be granted with log on as service
rights
NOTE: If the user is not granted the rights to
"Log on as service" on the machine, the
services cannot be started. For detailed steps
to grant these rights, see the Microsoft
documentation
https://technet.microsoft.com/en-
us/library/cc794944(v=ws.10).aspx

 must have CONNECT, SELECT,


INSERT, UPDATE, DELETE, and
EXECUTE rights to the repository
database, with Integrated Security
setting in the earlier section
User Enter a user name user2

Password Enter a password mypassword

Configuring SQL Server Connection for Data Connectors


Configure the SQL Server connection to the KPI Manager database and service port for each
of the data connectors.
To configure the SQL Server connection
1. Go to Start menu, and run the Configurator.
The Configurator window appears.
2. Expand KPIManager Data Connector.
The listed data connector configuration section depends on the installed data connector.
3. Go to each of the data connectors that you want to configure and enter the required
information.
For example: Configuring the Wonderware System Platform data connector
The following field options apply to all data connectors, you just need to provide a
different TCP port number for each connector.

Options Description Example

SQL Server Repository

Version 2.3 59
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

SQL Server Name Enter the name of the SQL server where the <KPIManager_Node>
KPI Manager database is available.
Database Enter the database to connect to KPIManager

Integrated Security Select if you want to use the log on identity to


(checkbox) connect to the repository. If this is not selected,
you need to provide the user and password.
User Enter the username to connect to the user1
repository
Password Enter the password to connect to the mypassword
repository.
Service Configuration
TCP Port Enter the service port number. 8096

4. Click Configure, and then close the Configurator.

Application Packages
There are application packages for Decision Manager /Event Manager and KPI Manager that
you need to import into the server where they are installed. If you encounter some issues
related to runtime execution time out during import, see Updating executionTimeout Setting in
Web.config File (on page 93).

Importing the Application Packages


Import the application packages for Decision Manager / Event Manager and KPI Manager
using the Operations Console. This is to deploy the user interface (UI) configuration pages to
Wonderware Skelta BPM.
NOTE: You can import only one package at a time, so you have to repeat the same steps
starting from step 2 for each package. Perform all the steps first for the first package, and
then start from step 2 for the next package.
To import the application package
1. Launch the Operations Console:
a. Open the Web browser as administrator and enter the URL:
http://<servername>:8000/EnterpriseConsole
b. Select the Active Directory link for the repository you created.
Example repository name: PMRepo
If you see any error, clear the browser cache.
2. In the Operations Console menu, select Dashboard > Package > Manage Package.
3. In the Manage Packages menu, select New, and then select Import.
4. In the Import Package window, browse to the location of the package:
o For Decision Manager / Event Manager: <Media>\CD-PM\CD-Decision
Manager\Package
o For KPI Manager: <Media>\CD-PM\Packages

60 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Select the package, and then select Import. The message that the package is
successfully imported appears. Select Close.
NOTE: After clicking Import, it may take a while and the system may not look like it's
responding, but it's actually performing the operation.
5. In the Manage Package list, select the package, and then select Edit.
The Edit Package page appears.
6. In the left pane, scroll down, and select each of the database connections listed under the
Database Connections section.
7. In the right pane, provide the required connection details (server name, database name,
authentication type) for each of the database connections in the target section, use SQL
Server as the authentication type, and keep the rest of the default values. Select Save
Settings for every database connection. When you're finished providing the required
information for each of the connections, select Save.
NOTE: After importing you can change the authentication to Windows if required.
The Edit Package message appears.
For example:
CaseManagement (This only applies to Decision Manager/Event Manager application
package)
o Server name: decision_manager_node
o Database name: DecisionManager
KPIManagement (This only applies to KPI Manager application package)
o Server name: kpi_manager_node
o Database name: KPIManager
AssetManagement
o Server name: odm_node
o Database name: eDNAWeb
EventsConnection (This only applies to Decision Manager/Event Manager application
package)
o Server name: <Event_Store_Server>
NOTE: This can be in a different server where Wonderware Historian 2017 is
installed.
o Database name: <Runtime>
8. In the left pane, scroll and select the report (PM Reports or
CaseManagementReportsConnection) under the Reports Connections section.
9. In the right pane, provide the required target report connection details.
For example:
Target Report Connection Details
o URI: http://<intelligence_servername>/<ReportServerWebServiceVirtualDirectory>
Version 2.3 61
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

o User Name: user1


o Password: mypassword
o Domain: mydomain
o Default Path: /DecisionManager/Reports (Decision Manager / Event Manager) |
/PM/Reports (KPI Manager)

NOTE: Verify that all the SSRS related reports for Decision Manager, Event Manager,
and KPI Manager are in the report default path. To verify, go to
http://<intelligence_servername>/<ReportServerWebServiceVirtualDirectory>, and
then check that all reports are in /DecisionManager/Reports for Decision Manager, and
/PM/Reports for KPI Manager.
Select Save Settings, and then select Save.
The Edit Package message appears, select Close.
10. In the Manage Packages list, select the package, and then select Install.
The package pre-install validation starts.
11. When the pre-install validation is complete, review the package validation log before
proceeding.
NOTE: Some package configuration types may appear to have warnings. For these
warnings, some of the forms and workflows may need to be published manually. If you
are importing the KPI Manager application package, you can ignore errors with the
message: "Folder already exists and cannot be updated" in the pre-install validation log.
12. Select Install Package.
The message Package installed successfully appears.
13. Review the installation log for the installed package for any errors.
You can ignore this error If you see it: "Either Tables or Columns are missing. Verify Your
Database or List".
14. Select Close.
15. In the Operations Console menu, select Solution Configuration > Application Design >
Business Rules & UI > Workflows.
NOTE: If you don't see the menu options, refresh the page.
16. In the Workflows list, select each workflow in draft mode (if any), and publish individually.
Workflows are in different folders, so you have to go in each of the folders and do this
step.
IMPORTANT: If folders are in Published mode, it does not mean that workflows inside it
are published, so you need to go through each folder to verify. For folders in Draft mode,
publish them too manually. This also applies to forms in step 18.
17. In the Operations Console menu, select Solution Configuration > Application Design >
Business Rules & UI > Forms.
18. In the Forms list, select each form in draft mode (if any), and publish individually.
Forms are in different folders, so you have to go in each of the folders and do this step.
62 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Setting Up Industry Console


Set up Industry Console to start using Performance Manager.
To set up Industry Console
1. Open Chrome, and enter http://<servername>.<domainname>:9005 to launch Industry
Console.
For example: http://performance_server.mydomain:9005
2. Add the domain user as admin, and log in to Industry Console as domain user.
A message appears that says you don't have access. The domain user is automatically
added to the User Management module.
3. Log out and log in again with admin as username and default password 123qwe.
4. In the Industry Console side-menu, click Admin.
5. In the Admin Portal page, select the User card.
6. In the User Management page, assign Administrator role to the domain user account
used in step 2.
For information on using the User Management page, click the help (?) button to launch
the help page.
7. (Optional) Change the default password for the admin user. This is optional, but
recommended for security.
a. Click the profile or Account icon on the upper-right corner of the page.
b. In the menu that appears, select Change Password.
c. In the Change Password dialog box, provide the required information.
IMPORTANT: The password must be at least six characters long and must have at
least one non-alphanumeric character.
d. Click Save. This logs you out and prompts you to log in again with the new password.
For information on adding users and granting user privileges, see Managing Privileges in
Industry Console (on page 71) and Managing Users in Industry Console (on page 71).
8. In the Admin Portal page, select the Settings card, and configure integration of external
content (SSRS, Skelta forms, Performance Manager).
a. Under the Setting Group column, look for the External Content Enabler group of the
corresponding content you want to integrate and enter the values for its required
parameters accordingly. For guidance on configuring the settings, see External
Content Enabler Settings (on page 64).
b. (Optional) Click the help (?) button for information on using the Settings
Management page.
9. Go to the Home page and ensure that the menu and tab items are accessible.
IMPORTANT: Verify one page first to ensure that the External Content Enabler settings
are working, otherwise, you need to manually reconfigure the pages in the Layout
Management page if some settings are missed.

Version 2.3 63
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

External Content Enabler Settings


Refer to the following table for guidance on configuring external content settings. Some things
to take note of when configuring the settings:
 The username and password to access the components database must be a SQL Server
account, and not Windows or domain account
 If you leave the username and password fields blank, the connection to the database is
done using the identity of the application pool that is hosting Industry Console.
 If the database is on the same server as Industry Console, the identity used is IIS
Apppool\IndConsoleApi, and if it is on a different server, the identity used is
<domain>\<servername>$. If the database is on different server, you need to grant
database access to the remote server. For detailed steps on granting access, see
Granting Database Access to Remote Server (on page 90)

Setting Group Display Name Example Value


(External Content Enabler)

Wonderware Skelta BPM Skelta enabled? True


Skelta database server <SQL Server Hostname>
Skelta database username <Username_to_access_SkeltaSQLDB>
Skelta database password <Password_to_access_SkeltaSQLDB>
Skelta repository name PMRepo
Skelta database name PMDB
Skelta web server http://<Skelta Server Host>:8000
Skelta Form Loader /EnterpriseConsole/BPMUITemplates
/Default/NextGenForms/FormLoader1
.aspx
SSRS SSRS enabled? True
SSRS database server <SQL Server Hostname>
SSRS database username <Username_to_access_SSRSSQLDB>
SSRS database password <Password_to_access_SSRSSQLDB>
SSRS database name <SSRS Database name>
SSRS web server http://<SSRS Server
Host>/reportserver
Everdyn (Optional) Everdyn enabled? True
Everdyn database server <SQL Server Hostname>
Everdyn database username <Username_to_access_SSRSSQLDB>
Everdyn database password <Password_to_access_SSRSSQLDB>

Everdyn database name <Everdyn Database name>

64 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Everdyn web server http://<Everdyn Server Host>:<Everdyn


Server Port>
Performance Manager KPI Web API Endpoint http://<KPI Manager Host>:9000/api

KPI Web API username <DomainUser_for_Querying_Against_KPI


Web API>

KPI Web API password <DomainUser_Password_for


querying_Against_KPI Web API>

KPI Trend Page Url http://<Skelta Server


Host>:8000/enterpriseconsole/bpmui
templates/default/repository/site
/kpitrend/files/pages/linechart.h
tml

Configuring Industry Console for Active Directory Authentication


Configure Industry Console to enable using AD login account to the application.
To configure the AD authentication settings
1. In the Industry Console home page, left pane, select Admin.
This loads the Admin Portal page.
2. In the Admin Portal page, select the Settings card.
3. In the Settings Management page, look for the Active Directory Enabler items under
the Setting Group column and click their corresponding pen icon to set their required
values.
Once the AD authentication is enabled in Industry Console, you can set the roles for AD
users such as Administrator in the Admin Portal, User Management module. For steps on
setting roles, see Managing Privileges in Industry Console (on page 71).

Optional Configuration Related to Industry Console


Industry Console has some of these required and optional configurations for it to work as part
of Performance Manager. For information on fixing configuration issues related to Industry
Console, see Troubleshooting Industry Console (on page 94).

Modifying the Connection String in appsettings.json File


(Optional) Modify the appsettings.json file to configure the Industry Console connection to
the web or database server. By default, when you install Industry Console, the web and
database servers are on the same server and these settings are automatically configured.
Perform this task only in a scenario where web and database servers are not in the same
server.
To modify the appsettings.json file
 Go to these paths and modify their respective appsettings.json file accordingly:

Version 2.3 65
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

o C:\inetpub\wwwroot\indconsole\backend

o C:\Program Files (x86)\Wonderware\IndConsole\migrator

Modifying and Running a SQL Script for Everdyn Databases


(Optional) You only need to perform the following tasks if you want to integrate Everdyn /
Alpana dashboard. This is to create a stored procedure on the Everdyn database
To modify and run the SQL script against the Everdyn database
You need to perform this task aside from enabling the Everdyn dashboard through the
Settings Management page in Industry Console.
1. Go to C:\Program Files (x86)\Wonderware\IndConsole\migrator, and double-click
script.sql.
This opens up in the Microsoft SQL Server Management Studio.
2. Run the script for creating stored procedure against the Everdyn database.

ODM Configuration
The configuration of ODM includes configuring the Wonderware eDNA Web, AD, and
importing the master asset models.

Applying the Patches for eDNA Web 2016 R2


Perform the following tasks to apply the patches included in the media for eDNA Web 2016
R2.
Stopping World Wide Web Publishing Service
1. Open the Run dialog box (press Windows + R keys).
2. Type services.msc and press enter.
3. In the Services window, look for World Wide Web Publishing Service, right-click the
service, and then select Stop.

66 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Copying the .dll Patch Files


1. Open the Windows explorer and navigate to the eDNA Web folder
(default:C:\inetpub\eDNA Web).
2. Open the \bin folder.
3. Backup the following files:
o AppCodeInterface.dll
o App_Code.dll
o App_global.asax.dll
o App_Web_dashboard.aspx.cdcab7d2.dll
o App_Web_dashboard.aspx.fdf7a39c.dll
o App_Web_dataquery.aspx.cdcab7d2.dll
o App_Web_default.aspx.6e7994ae.dll
o App_Web_default.aspx.cdcab7d2.dll
o App_Web_default.aspx.fdf7a39c.dll
o App_Web_ednaview.aspx.cdcab7d2.dll
o App_Web_ednaview_menu.aspx.cdcab7d2.dll
o App_Web_jqtrend.aspx.cdcab7d2.dll
o App_Web_login.aspx.cdcab7d2.dll
o App_Web_pointpicker.aspx.fdf7a39c.dll
o App_Web_tr_trend.aspx.cdcab7d2.dll
o eDnaWeb.DB.dll
o wwewu32.dll
4. Navigate to <Media>\CD-eDNA\eDNA 2016 R2 Patch\bin and copy all the files to you
local \bin folder.
Copying the .js Patch File
1. Open the Windows explorer and navigate to the eDNA Web folder (default:
C:\inetpub\eDNA Web).
2. Open the \Javascripts\js folder.
3. Backup the jquery.jqChart.standard.js file.
4. Navigate to <Media>\eDNA 2016 R2 Patch\Javascripts\js and copy the .js file to your
local Javascripts\js folder.
Moving the License Manager Folder and Turning Logging On
1. Navigate to the eDNA Web folder (default: C:\inetpub\eDNA Web).
2. Select and move the LicenseMgr folder to C:\ProgramData\InStep. You can use
cut+paste or select+drag
3. Note the new location or file path of the LicenseMgr folder:
C:\ProgramData\InStep\LicenseMgr.

Version 2.3 67
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

4. Open the Web.Config file from the eDNA Web folder using the Windows notepad.
5. Copy the new location of LicenseMgr folder to the following key:
<add key ="LicenseLocation" value=""/>
For example:
<add key =”LicenseLocation” value =” C:\ProgramData\InStep\LicenseMgr” />
6. To enable logging for the web license check, add the following to the Web.Config file
under <appSettings>:
<add key="LicenseCheckLog" value="true" />
7. Save the Web.Config file.
Copying the InStep .lf File
1. Navigate to C:\ProgramData\InStep\LicenseMgr\licenses.
2. Backup the existing license file by renaming the file as InStepUSA_edna_web_OLD.lf
and move it to a different location.
3. Navigate to <Media>\CD-eDNA\eDNA 2016 R2 Patch and copy the
InStepUSA_edna_web.lf file to C:\ProgramData\InStep\LicenseMgr\licenses.
4. Run LicenseMgr64.exe from C:\ProgramData\InStep\LicenseMgr.
Take note:
o This new .lf file may reset your licensing status to "expired demo" or "demo – 45 days
left". If this happens, contact eDNA Support for re-licensing keys immediately.
o New license file must display phone numbers as (USA) 312-894-7870, while the old
license file must display as (USA) 312-894-7837
Restarting World Wide Web Publishing Service
1. In the Services window, look for World Wide Web Publishing Service, right-click the
service, and then select Start.
2. Open eDNAWeb through http://localhost/ednaweb/admin/default.aspx or
LicenseMgr64.exe to ensure that the licensing is intact.
Reconfigure the KPI Manager Web API in the Configurator
1. Go to Start menu, and run the Configurator.
2. In the left pane, expand KPIManager and select Web API Configuration.
3. In the right pane, go to the CHaD Configuration section, and modify the following to
reflect your Windows Authentication details:
o CHaD User: mydomain\user1
o Password: mypassword
4. Restart the KPI Manager Web API service.

Configuring the AD Service in Wonderware eDNA


Configure the AD service in Wonderware eDNA so you can use it with Performance Manager.
To configure the AD service, you need to set it up in the eDNA Web Administrator's tool and
set the user authentication in Internet Explorer.

68 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

To configure the AD service in the eDNA Web Administrator's tool


1. Navigate to the eDNA web URL: http://localhost/ednaweb/admin/default.aspx.
2. Log in to eDNA web using the following credentials:
o User Name: instep
o Password: instep
If a dialog box appears, which requires you to install the ednawc.cab file. Proceed with
the installation and follow the wizard.
3. Click the Settings icon from the top-right corner of the page.
4. In the eDNA Web Administrator's tool, select the Configuration tab in the left pane,
and then select eDNA Web. In the right pane, select the Log In tab, and then the
Authentication tab.
5. In the table grid, select the edit button next to the UseWindowsAuthentication
configuration key, and set its key value to True. Select the save button to save this
change.
6. Select the ActiveDirectory tab. In the table grid, select the edit button next to the
AD_AdminGroup configuration key, and then set its key value to Local Admin, Domain
Users. Save this change.
NOTE: The Local Admin, Domain Users key value is specific to the domain and this is
just an example.
You can get this key value from the user's AD settings. Look for the MemberOf property
for the user and use that as the key value here. You can also add more domains as the
key value using a ‘,’ (comma) separated values.
For detailed information on finding user groups, see Finding User Groups When Defining
eDNA Web AD_Admin Configuration (on page 91).
7. Select the Users tab on the left pane, and then select User Security Groups.
In the right pane, select the Add New Group icon, and then enter Administrators in
the dialog box that appears.
8. In the left pane, select Users.
The list of available users appears in the right pane.
9. Select Add New User in the top-right corner of the right pane.
The Enter New User Information data entry form appears.
10. Enter or select the required user details. For example:
o User Login Name: user1 (This must be the logged in user's login name to the server
where ODM is)
o First Name: Bruce
o Last Name: Wayne
o User Password: (skip)
o Force Password Change: (skip)
o Email: [email protected]

Version 2.3 69
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

o Security Level: administrator


o Member of Security Groups:Administrators
11. Select the save button at the lower-right corner of the data entry form to add the user.

To configure the AD service user authentication in the Internet Explorer


1. Open the Internet Explorer. Go to Tools > Internet Options. In the Internet Options
window, select the Security tab, select Local intranet, and then Custom level.... Scroll
all the way down and look for User Authentication, and then under Logon, select
Automatic logon only in Intranet zone.
2. Select OK, and then Apply.
3. Open the eDNA web URL: http://localhost/ednaweb/admin/default.aspx.
The added Windows logged in user is now logged into the eDNA web.

Importing the Master Asset Hierarchy


Import the master asset hierarchy using the ODM Manager in the Operations Console or
through Asset Hierarchy left navigation menu in the Industry Console. This task assumes
that a master asset hierarchy has already been prepared for import. You can get a sample
asset hierarchy from the Downloads and Release Notes > Sample Files for Demo page in
PMDN https://oosa-confluence.au.schneider-electric.com/x/q4F7Bw.
NOTE: Ensure that the account you're using--either domain or local--have the appropriate
access to the SQL Server database as you may encounter error during the upload session.
Also, restart the KPIManager service before performing this task.
To import the asset model using Asset Hierarchy upload tool
1. You can perform either of these:
o Open Operations Console (http://<servername>:8000/EnterpriseConsole). In
the Operations Console home page, select Home > Solution Configuration > ODM
Manager > Asset Hierarchy
o Open Industry Console in Chrome (http://<servername>.<domainname>:9005).
In the Industry Console home page, select Asset Hierarchy from the left navigation
menu
2. In the Asset Hierarchy page, select Choose File, and navigate to the path where the
asset hierarchy file (.xml) is.
3. Select the file, and click Upload.
For additional information on asset models, see Understanding the Example Asset Hierarchy
(on page 97).

Managing Users
Manage user access privileges for KPI Manager, ODM and Industry Console. Managing
users for these components are managed separately as Performance Manager integrates
them into a single solution.

70 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Industry Console User Management


User Management for Industry Console can be done in its User Management module under
the Admin Portal.

Managing Users in Industry Console


Import set of AD users of a specific group in Industry Console.
By default, the first time you logged in to Industry Console, your account is added
automatically on the User Management page under the Admin Portal if you are the solution's
administrative user.
To import set of users of a specific group in the Admin Portal User Management
1. Open Chrome, and enter http://<servername>.<domainname>:9005 to launch Industry
Console.
For example: http://performance_server.mydomain:9005
2. In the Industry Console home page, left pane, select Admin.
This loads the Admin Portal home page.
3. In the Admin Portal page, select the AD Rules card.
4. In the AD Rules page, add a rule where you can define the import users action type. This
imports all the users that are members of the group you define in the rule.
For more information in using the AD Rules module, click the help (?) icon.
NOTE: The AD users that are added or imported in the Admin Portal User Management
module can't be deleted using the UI, you need to go to the database to delete them.

Performance Manager Roles and Permissions


Industry Console for Performance Manager comes with the following preconfigured roles:

Name Access

Operator Access to the home page and able to manage Events and Cases
Engineer and Manager Have all the access that Operators has and additional access to reports and
analytic functions in Decision Manager and KPI Manager
Subject Matter Expert Access to report and analytic functions in Decision Manager and KPI
(SME) Manager. Additional access to manage the knowledge base stored in the
solution
Solution Admin Full Access to Industry Console
For detailed information on the required permission for each role and the components that
can be accessed with the given permission, see the Performance Manager Roles and
Permissions page on PMDN https://oosa-confluence.au.schneider-electric.com/x/9QFMCQ.

Managing Privileges in Industry Console


Manage privileges using the Industry Console Admin Portal modules.

Version 2.3 71
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

To assign roles, restrict user log in, and remove AD rule processed flag (check mark)
from the Industry Console users
1. Open Chrome, and enter http://<servername>.<domainname>:9005 to launch Industry
Console.
For example: http://performance_server.mydomain:9005
2. In the Industry Console home page, left pane, select Admin. This loads the Admin Portal
home page.
3. In the Admin Portal page, select the User card to load the User Management page.
4. In the User Management page, depending on what you want to do, you can either:
o Add a role to existing users. To do that, click the corresponding Add a role list for the
particular user.
o Restrict user login. To do that, select a user and in the Locked Out column, click the
corresponding lock icon to set the log in restriction, or
o Remove the AD rule processed flag for new rule to be applied. To do that, click on the
user's corresponding check mark to which you want to apply the new rule
For more information in using the User Management module, click the help (?) icon.
To manage roles and permissions
1. In the Industry Console main page, left pane, select Admin. This loads the Admin Portal
home page.
2. In the Admin Portal page, select the Role & Permission card to load the Role &
Permission Management page.
3. In the Role & Permission Management page, you can either:
o Create a role
o Grant or edit permissions, or
o Delete a role
For more information on how to use the Role & Permission Management page, click the
help (?) icon.
To manage access to menu items for each role
1. In the Industry Console main page, left pane, select Admin. This loads the Admin Portal
home page.
2. In the Admin Portal page, select the Navigation Menu card to load the Side-Menu
Management page.
3. In the Side-Menu Management page, you can
o Add or edit a menu item - For each menu you create, you have the option to set the
permission
o Delete a menu item
For more information on how to use the Side-Menu Management module, click the help (?)
icon.

72 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

ODM User Management


User management for ODM or CHaD can be done from the User Management module in
Industry Console. With User Management, you can manage these configurations:
 Security Groups
 Users
 Asset and Groups association
ODM determines whether a user has access to an asset by checking if the user is part of a
group that is associated with an asset. However, if a user has Administrator access level,
the user has full access to the entire asset hierarchy by default.

Managing Groups in ODM


Add or delete a security group, or update the group name in ODM through the User
Management module.
To add or delete a security group
1. In the main page of Industry Console, left pane, select User Management.
2. In the right pane, select the CHAD USER MANAGEMENT tab.
3. Select the Security Groups tab.
4. Depending on what you want to do, you can either:
o Click Add Security Group to add a security group, or
o Select one of the existing security group that you want to delete, and click Delete
Security Group, or
NOTE: The delete button is disabled by default, only when you select a group in the
table grid the button is enabled.
o Select one of the existing group that you want to modify, update the name in the
security group configuration pane, and then click Update
For additional information when managing groups in ODM, click the help (?) icon to
launch the Manage CHaD Users help page.

Managing Users in ODM


Add or delete a user in ODM through the User Management module.
To add or delete a user
1. In the main page of Industry Console, left pane, select User Management.
2. In the right pane, select the CHAD USER MANAGEMENT tab.
The Users tab is selected by default.
3. Depending on what you want to do, you can either:
o Click Add User to add a user
NOTE: The users that you can add are from the active directory.
o Select one of the existing user that you want to delete, and click Delete User, or

Version 2.3 73
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

NOTE: The delete button is disabled by default, only when you select a user in the
table grid the button is enabled.
o Select one of the existing user that you want to modify, update details in the user
configuration pane, and then click Update
For additional information when managing users in ODM, click the help (?) icon to launch the
Manage CHaD Users help page.
Users Security Level
The available options for security level are:
 Read Only – Only read access to the assets that user has access to
 Read\Write – Read and write access to the assets that the user has access to
 Admin – Full access to the asset hierarchy in ODM

Managing Asset Security in ODM


Link the security groups to the assets to ensure that you have access to the assets.
To link or associate the security groups to the assets
1. In the main page of Industry Console, left pane, select User Management.
2. In the right pane, select the CHAD USER MANAGEMENT tab.
3. Select the Asset Security tab.
4. Expand the tree view asset hierarchy on the left, and select the assets that you want to
link or associate to the available security groups in ODM on the right.
To link the assets, select the check box of the corresponding security group and click
Update.
Press shift to select multiple security groups to assign to an asset.
For additional information when managing asset security in ODM, click the help (?) icon to
launch the Manage CHaD Users help page.

KPI Manager User Management


User management for KPI Manager can also be done from the User Management module in
Industry Console. But unlike ODM or Industry Console where there are groups, roles, and so
on, KPI Manager grants access directly to users by controlling the security level.
There is no access control on each KPI, but you can control the access for KPIs by
controlling the access to the asset in ODM in which the KPIs are associated to.

Managing Users in KPI Manager


Add or delete a user, or modify a user details in KPI Manager through the User Management
module.
To add or delete a user, or modify its details
1. In the main page of Industry Console, left pane, select User Management.
2. In the right pane, select the KPI USER MANAGEMENT tab.
3. In the Users tab, depending on what you want to do, you can either:
74 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

o Click Add User to add a user


NOTE: The users that you can add are from the active directory.
o Select one of the existing user that you want to delete, and click Delete User, or
NOTE: The delete button is disabled by default, only when you select a user in the
table grid the button is enabled.
o Select one of the existing user that you want to modify, update details in the user
configuration pane, and then click Update
For additional information when managing users in KPI Manager, click the help (?) icon to
launch the Manage KPI Users help page.
Users Security Level
The available options for security level are:
 Read Only – Only read access to the KPIs (only if the user has access to the associated
asset)
 Read\Write – Read and write access to the KPIs (only if the user has access to the
associated asset)
 Admin – Full access to the KPI Manager

Consistent Access Across Components


As part of the solution setup process, an administrative user is added in all Performance
Manager components to ensure that the user has full access to the entire solution and all its
contents.
When more users with different roles are added to Industry Console, ensure that the users
are granted the appropriate access in KPI Manager and ODM for sufficient access to the
content.
Refer to the following table for the appropriate access that you must have in KPI Manager
and ODM for the preconfigured roles defined in Industry Console.

Name Access to KPI Manager Access to ODM

Operator Give "Read Only" security level Given "Read Only" Security Level
Assign to groups that has access to
the required assets
Engineer / Manager Give "Read Only" security level Given "Read Only" Security Level
Assign to groups that has access to
the required assets
SME Give "Read\Write" security level Given "Read\Write" Security Level
Assign to groups that has access to
the required assets
Solution Admin Give "Admin" security level Given "Admin" Security Level
Assign to Administrator groups

Version 2.3 75
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

Managing Security
Manage the system security through SSL and HTTPS configuration, and through the user
management tools provided in the system.

Enabling Microsoft SQL Server Encryption


For information on enabling SQL Server encryption, see the Encrypting Connections to SQL
Server https://technet.microsoft.com/en-us/library/ms189067(v=sql.105).aspx topic in the
Microsoft TechNet documentation.

Binding the SSL Certificate to a Port Number


To bind SSL certificate to a port number
1. Obtain thumbprint of certificate in Certmgr.msc (Console Root\Certificates
(LocalComputer)\Trusted Root Certifications Authorities\Certificates)

2. Bind SSL certificate to KPI Manager Web API and Event Manager Web API. Using the
thumbprint obtained from step 1, replace the certhash value with the thumbprint in the
following items without spaces:
o To bind SSL to KPI Manager Web Port (9000)
In the command prompt, administrator mode, run this command:
netsh http add sslcert ipport=0.0.0.0:9000
certhash=4548fcb3fe63efc74933cd592a04c1d3dd320e50 appid={00000000-
0000-0000-0000-000000000000} certstore=MY
o To bind SSL to Event Manager Web Port (9000)
In the command prompt, administrator mode, run this command:
netsh http add sslcert ipport=0.0.0.0:9001
certhash=4548fcb3fe63efc74933cd592a04c1d3dd320e50 appid={00000000-
0000-0000-0000-000000000000} certstore=MY
Check if you have bound desired SSL to desired ports
In the command prompt, administrator mode, run this command:

76 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

netsh http show sslcert

Configuring Sites to Support HTTPS and SSL Protocols


1. Export and save your certificate to the web server desktop. Save certificate as file named
<your_domain_name>.cer.
2. Complete certificate request using IIS.
a. In IIS under Servername\Server Certificates, select Complete Certificate Request

Version 2.3 77
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

b. Map to your certificate created in step 3.1

3. Change existing port bindings to HTTPS using IIS.


a. In the Connections pane, select the sites that you need to set
(WonderwareSkeltaBPMSites, IndConsoleApp, IndConsoleApi) to be secured with
SSL.
b. Select Bindings in the Actions pane.

78 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

c. Replace existing http site bindings for these:


– IndConsoleApi (9004)
– IndConsoleApp (9005)
– WonderwareSkeltaBPMSites (8000) with https bindings and attach the SSL
certificate.

4. Enable https for KPI Manager Web API


In the Configurator, under KPIManager > Web API Configuration, check Use HTTPS
option and click Configure.
5. Modify the Workflow Web API string in the configurator
Replace http with https for the connection string provided in Workflow Web API field.

Version 2.3 79
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

6. Modify Industry Console configurations.


Industry Console back-end configurations
a. Navigate to C:\inetpub\wwwroot\indconsole\backend and open appsettings.json
file.
b. Replace http with https in the entire file.

Industry Console front-end configurations


c. Navigate to C:\inetpub\wwwroot\indconsole\frontend\assets and open
appconfig.json file.
d. In the remoteServiceBaseUrl and appBaseUrl, replace http with https.
e. Modify ExternalContentUrl in [IndustryConsole].[dbo].[GridTiles]
Using SQL Server Management Studio, update all ExternalContentUrl in
IndustryConsoleDB with https using this command:
SELECT *
FROM [IndustryConsoleDb].[dbo].[GridTiles] update GridTiles set
ExternalContentUrl = REPLACE(ExternalContentUrl,
'http://<servername>','https://<servername>')
f. Change Intelligence Event port number
This is only required if the Wonderware Intelligence is installed on the same server as
KPI Manager. In the Configurator, under Wonderware Intelligence section, select
Event Interface Service and in the Event API Interface Configuration section, change
the port number from 9000 to 9095.
g. Restart IIS. Launch the command prompts in administrator mode, and run the iisreset
command.

80 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Setting Up HTTPS for Wonderware Historian OData Web API


This task assumes that SSL certificate is already available for binding.
NOTE: Contact Wonderware Technical Support for assistance on creating an encrypted
connection (HTTPS) with OData for Wonderware Historian client.
The following brief steps are to be performed on the Event Store node.
1. Bind certificate to port 32569.
In the command box, type the netsh commend using this syntax (all in one line):
netsh http add sslcert ipport=0.0.0.0:32569 appid={12345678-db90-4b66-
8b01-88f7af2e36bf} certhash=072a61565b1d741d77fa4cc2a89f26c1934076b5
certhash -- the certificate's thumb print
The certhash is the identifier that maps the certificate to the specified IP endpoint. This
identifier is contained in the SSL certificate.
2. After the binding is completed, modify the Windows Registry to start OWINHost in the
secured mode.
Open Regedit and navigate to
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ArchestrA\Historian\Setup\O
WINHostCmdArgs
Add a key OWINHostCmdArgs (string type) and update the value as follows:
Value = -port 32569 -secured 1
3. Go to SMC and restart the Wonderware Historian for changes to take effect.
Go to Windows Task Manager and verify OWINHost is in secured mode:
aahOWINHostLocal.exe service runs with command line – "C:\Program Files
(x86)\Wonderware\Historian\x64 \aahOWINHostLocal.exe" -port 32569 -
secured 1
For information about creating and using SSL certificates, see this Microsoft related article
https://technet.microsoft.com/en-
us/library/cc753127%28v=ws.10%29.aspx?f=255&MSPPError=-2147217396.

Web Server Configuration


The following optional web server configurations are recommended as cyber security best
practices.
NOTE: Check the best practices that apply to your setup.
It is recommended to set up the web server with the best practices described in the following
links:
 Application Server must not be linked to Error Page directly (e.g. IIS Error codes 404,
505) https://www.iis.net/configreference/system.webserver/httperrors/error
 Default server documentation link must be removed or custom home must be enabled
https://www.iis.net/configreference/system.webserver/defaultdocument

Version 2.3 81
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

 Disable directory browsing. By default, IIS setup disables directory browsing but in case
it's not disabled, follow the instructions described in the link
https://technet.microsoft.com/en-us/library/cc731109(v=ws.10).aspx

Modifying Web.Config for HTTPS Configuration


Modify the Web.config file to configure the <appSettings> tag for KPI Manager HTTPS
configuration.
1. Go to <SkeltaInstallPath>\Web\BPMUITemplates\Default\Repository\Site and open the
Web.config file.
2. Go to the <appSettings> section and add the following key:
<appSettings>
<add key="kpi_webapi_uri"
value="https://<performance_server_name.domain>:9000/api/"/>
</appSettings>

Mapping Users to Security Groups


After a successful package installation and verification, map the users to the security groups.
This enables the Skelta BPM to recognize the associated role to a specific user.
To map a role
1. Launch the Operations Console:
a. Open a browser and enter the URL:
http://<performance_servername>:8000/EnterpriseConsole
b. Select the Active Directory link for the repository you created.
2. In the top right corner of the Operations Console, under the user name, select
Repository Settings.
3. In the Repository Settings page, select Advanced Settings tab, and then select
Manage Security Group - Resource Mapping.
4. Select New.
5. In the Security Group Resource Mapping window, select Map Users tab.
6. Select the User Lookup button, select Active Directory User, and enter a user to search.
7. When the search result appears, select the appropriate user and move it to the Selected
Resource pane, and select Update.
8. Select Administrator as the security group to be associated with the selected user and
click Save.

Intelligence Server Configuration


The required tasks to configure the Intelligence Server to work as part of the module are
described in the following sections.

82 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

Deploying the Performance Manager Intelligence Model on


Wonderware Intelligence 2017
The Performance Manager installer includes Wonderware Intelligence 2017 and installs this
version only if possible. If you run the installer on a machine with Intelligence 2014 R3 or
earlier, Wonderware Intelligence is not upgraded to 2017.
To deploy the Intelligence Model on Wonderware Intelligence 2014 R3, see Deploying the
Intelligence Model on Wonderware Intelligence 2014 R3 (on page 89) in the Appendix
section.
To deploy the Intelligence Model that comes with the Performance Manager 2.3 on
Wonderware Intelligence 2017
1. In the web browser, open the Intelligence 2017 Model Builder through this link:
https://<IntelligenceServerName>:61075/
2. In the browser menu, select Import.
3. Click CHOOSE A FILE, navigate to <Media>\CD-PM\CD-IntelligenceReports, and
double-click the PMIntelligenceModel_WW.json file.
4. Click IMPORT.
5. After importing, configure each data source (DSODSWW, DSODM, DSPM) to reference
the correct database:
o DSODSWW must reference the Runtime database of the Wonderware Historian
server configured to use as ODS for KPI Manager
o DSODM must reference the eDNAWeb database of ODM
o DSPM must reference the KPIManager database of KPI Manager
For example:

After each connection is configured, click Connect to validate the connection to the
source database. Wonderware Intelligence loads the schema of the source database
during this process.
6. After the configuration, select Deploy All from the menu to deploy the entire model.

Version 2.3 83
Industry Software Suites Performance Manager Setup Guide Performance Manager Components Configuration

You are prompted whether to keep or remove the data if the deployed items have existing
data. Assuming that you are deploying the model for the first time, either of the option
works.

Running the Intelligence SQL Server Script in the Intelligence


Database
Create the Intelligence views using the SQL Server script file IntelligencePM.sql provided as
part of the package.
To run the SQL script
1. Go to <Media>\CD-PM\CD-IntelligenceReports, and open IntelligencePM.sql
This opens up in the SQL Server Management Studio.
2. Select IntelligenceDB from the the drop-down list, and select Execute.

Updating the Shared Data Source Credentials


Manually update the different data sources credentials and database name that are required
to use the report server.
To update the shared data source credentials
1. Go to the Web Portal URL or Report Manager URL: http://<Intelligence Server>/<Virtual
Directory>.
2. Double-click on Data Sources, and select each of the following data sources:
a. Asset
b. DecisionManagerDS
c. Intelligence
d. KPIManager
e. EventSource
3. For every data source you select on step 2, update its Connection string option in the
right pane:

Data Source Initial Catalog

Asset <ODMServerName> <eDNAWeb>


DecisionManagerDS <DecisionEventManagerServerN <DecisionManager>
ame>
Intelligence <IntelligenceServerName> <IntelligenceDB>
KPIManager <KPIManagerServerName> <KPIManager>
EventSource <EventStoreServerName> <Runtime>
4. For every configuration of a specific data source, select Using the following credentials
under the Credentials section.
5. Provide the corresponding credentials and select Test Connection.
6. If the connection is successful, select Apply.

84 Version 2.3
Performance Manager Components Configuration Industry Software Suites Performance Manager Setup Guide

7. Go to the Industry Console, and open the report URL again to verify the connection.

Version 2.3 85
Industry Software Suites Performance Manager Setup Guide

C HAPTER 6
Performance Manager Upgrade
In This Chapter
Upgrading Performance Manager 2.2 to 2.3 ...........................................................................................87

Upgrading Performance Manager 2.2 to 2.3


Import the Decision Manager and Event Manager Skelta package for Performance Manager
2.3 on top of Performance Manager 2.2.
Since the new version of this package has the same name as the 2.2 version, ensure that
you install the latest version of the package to successfully install the new content.
To import the latest application package and check the latest version
1. Launch Operations Console and navigate to the Manage Package page. To do this,
follow steps 1 to 3 in Importing the Application Packages (on page 60).
2. In the Import Package window, browse to <Media>\CD-PM\CD-Decision
Manager\Package and select the Decision Manager and Event manager application
package.
Click Import. A confirmation dialog box appears with this message: Package already
exists. Do you want to save it as next major version?
Click OK.The message that the package is successfully imported appears. Select Close.
Since there's already an existing package with the same title as the new package for
version 2.3, the number under the Version column in the Manage Packages list page is
updated showing a newer version.
3. From the list, select the imported package, right-click and select Show All versions.
All the versions are shown and the status of the latest version is Not Installed.
4. Select the latest version, click Edit to update the database connections and other
package details accordingly, and then install the package. To do this, follow the steps in
Importing the Application Packages (on page 60), starting from step 6.

Version 2.3 87
Industry Software Suites Performance Manager Setup Guide

C HAPTER 7
Appendix

In This Chapter
Deploying the Intelligence Model on Wonderware Intelligence 2014 R3 ................................................89
Granting Database Access to Remote Server ........................................................................................90
Finding User Groups When Defining eDNA Web AD_Admin Configuration ..........................................91
Updating executionTimeout Setting in Web.config File ..........................................................................93
Troubleshooting Industry Console ..........................................................................................................94
Modifying the DNASYS.ini File for Other eDNA Datasource ..................................................................95
Decision Manager Web Service ..............................................................................................................95
KPI Manager Recommendations ............................................................................................................96
Understanding the Example Asset Hierarchy .........................................................................................97
CORS Origin ...........................................................................................................................................98

Deploying the Intelligence Model on Wonderware Intelligence


2014 R3
Before you perform this task, install the Wonderware Intelligence license file, and verify that
Wonderware Intelligence Service is running and the domain account you’re using has the
correct privileges to access the Performance Manager database, which includes databases
for KPI Manager, Event Manager, Decision Manager, and ODM.
If you are using Wonderware Intelligence 2017, see Deploying the Performance Manager
Intelligence Model in Wonderware Intelligence 2017 (see "Deploying the Performance
Manager Intelligence Model on Wonderware Intelligence 2017" on page 83) in the
Intelligence Server Configuration section.
IMPORTANT: By default, the account under which the Wonderware Intelligence Service is
running does not have access to any of the Performance Manager databases. Ensure to
grant the account with access to all the databases if you are using Windows authentication
mode. Otherwise, use SQL Server authentication when configuring the Intelligence Deploy
Utility text file, and provide the user ID and password of the SQL Server for the Performance
Manager databases.
To verify the Wonderware Intelligence Service is running
1. Go to the Control Panel, select Administrative Tools, and then select Services.
2. In the Services window, look for Wonderware Intelligence Service.
Verify that under the Status column, Running appears next to this service.

Version 2.3 89
Industry Software Suites Performance Manager Setup Guide Appendix

To deploy the Intelligence model


1. Go to the <Media>\CD-PM, and copy CD-IntelligenceReports to C:\PM.
2. Go to C:\PM\CD-IntelligenceReports\IntelligenceDeployUtility.
3. Open the ReadMe Intelligence Deploy Utility.txt file and follow the deployment
instructions provided in the file.
Example command:
IntelligenceDeployUtility.exe deploy
C:\PM\CD-IntelligenceReports\PMIntelligenceModel_WW.xml
C:\PM\CD-
IntelligenceReports\IntelligenceDeployUtility\DataSourceDefinition_WW.jso
n
As specified in the text file, the installation steps vary depending on whether you are using
eDNA Service or Wonderware Historian as ODS. To check which one you are using:
a. Open the Configurator and go to the KPI Manager section.
b. Select Operational Data Store Configuration, and see the value for Service Name.

Granting Database Access to Remote Server


(Optional) You only need to perform this task if the corresponding databases of these
Performance Manager components are on a different server. Grant access to the Microsoft
SQL Server database based on how IIS and SQL Server authentication are configured.
 Intelligence Server (IntelligenceDB)
 Industry Console with Skelta (PMDB, PMDB_BI, SkeltaFarmDB)
 ODM (eDNAweb)
 Decision Manager / Event Manager (DecisionManager)
 KPI Manager (KPIManager)
 KPI Connectors (KPIManager)
 KPI Datasource - KPISPDataAgent (KPIManager)
To grant database access to a particular remote server
1. In the database server, open the SQL Server Management Studio. Use the following
script to grant the remote server access to the database:
USE [master]
GO
CREATE LOGIN [{DOMAIN}\{HOSTNAME}$] FROM WINDOWS WITH
DEFAULT_DATABASE=[master]
GO
USE [{DBNAME}]
GO
CREATE USER [{DOMAIN}\{HOSTNAME}$] FOR LOGIN [{DOMAIN}\{HOSTNAME}$]

90 Version 2.3
Appendix Industry Software Suites Performance Manager Setup Guide

GO
USE [{DBNAME}]
GO
ALTER ROLE [db_owner] ADD MEMBER [{DOMAIN}\{HOSTNAME}$]
2. Replace the variables in the script depending on which component database you want to
grant access to.
NOTE: The script provided only works for server running as system account. If you modify
the IIS to run as a domain account, modify the script based on that configuration.
For example:
USE [master]
GO
CREATE LOGIN [MYDOMAIN\KPIManagerNode$] FROM WINDOWS WITH
DEFAULT_DATABASE=[master]
GO
USE [KPIManager]
GO
CREATE USER [MYDOMAIN\KPIManagerNode$] FOR LOGIN
[MYDOMAIN\KPIManagerNode$]
GO
USE [KPIManager]
ALTER ROLE [db_owner] ADD MEMBER [MYDOMAIN\KPIManagerNode$]

Finding User Groups When Defining eDNA Web AD_Admin


Configuration
To find the user groups
1. Open Powershell ISE and copy over this script:
[CmdletBinding(SupportsShouldProcess=$True)]
Param(
[Parameter(Mandatory = $True)]
[String]$UserName
)
Import-Module ActiveDirectory
If ($UserName) {
$UserName = $UserName.ToUpper().Trim()
$Res = (Get-ADPrincipalGroupMembership $UserName | Measure-
Object).Count
If ($Res -GT 0) {
Write-Output "`n"

Version 2.3 91
Industry Software Suites Performance Manager Setup Guide Appendix

Write-Output "The User $UserName Is A Member Of The Following


Groups:"
Write-Output
"==========================================================="
Get-ADPrincipalGroupMembership $UserName | Select-Object -
Property Name, GroupScope, GroupCategory | Sort-Object -Property Name |
FT -A
}
}

2. Save it on the server's user directory.

3. Press F5 to execute the script or Debug > Run /Continue.


This prompts you for a user name.
4. Enter a user name.
5. Note down the group name that is shown under Names.
6. In the eDNA Web Administrator's Tool, select eDNA Web in the left pane as shown
below and in the right pane, select the Login tab, and then the Windows tab.

92 Version 2.3
Appendix Industry Software Suites Performance Manager Setup Guide

7. Click the pen icon for the AD_AdminGroup Configuration Key to edit and add one of the
names that you took note earlier.

8. Close the browser and enter http://localhost/eDNAweb/admin.

Updating executionTimeout Setting in Web.config File


To update the executionTimeout settings
1. Navigate to <Skelta Installation Path>\Web\BPMUITemplates\Default.
2. Open the Web.config file.
3. In the <system.web> section, add the following attribute to <httpRuntime>:
executionTimeout="2400"

4. Save the Web.config file.

Version 2.3 93
Industry Software Suites Performance Manager Setup Guide Appendix

Troubleshooting Industry Console


When setting up the Performance Manager 2.3 environment for the first time, there are
configuration issues that may be encountered, and can be related to Industry Console 2.2.
The following items are some of the possible Industry Console configuration related issues:
 Duplicate forward slash (//) in the defined URL
When you're trying to load the Industry Console and you see the following error in the
Console tab (on F12 press):
Failed to load http://<servername>.<domainname>:9004//AbpUserConfiguration/GetAll:
Response to...

As specified in the error message, the URL is configured with duplicate forward slash (//).
To fix this, remove the duplicate forward slash from the remoteServiceBaseUrl element
in the appconfig.json file. This is where the URL is defined.
a. Go to C:\inetpub\wwwroot\indconsole\frontend\assets and open the
appconfig.json file.
b. Look for remoteServiceBaseUrl and update its value to remove the duplicate forward
slash (//)
 CorsOrigins setting does not match the URL specified in the browser
In case you still see the same error when loading the page, check the CorsOrigins
setting in the appsettings.json file.
a. Go to C:\inetpub\wwwroot\indconsole\backend and open appsettings.json file.
b. Look for CorsOrigins and ensure that its value matches the URL specified in the
browser and there is no empty space in the URL. CorsOrigins value is case sensitive.

94 Version 2.3
Appendix Industry Software Suites Performance Manager Setup Guide

IMPORTANT: Any changes you make to CorsOrigins setting, reset the IIS.
 There is more than one version of the appsettings.json file
There must be only one version of the appsettings.json file. The latest Industry Console
MSI checks for this, but in case an older MSI is used in the build, manually delete other
versions from the backend folder.
a. Go to C:\inetpub\wwwroot\indconsole\backend
b. Manually delete these other appsettings*.json files:
– appsettings.production.json
– appsettings.Staging.json

Modifying the DNASYS.ini File for Other eDNA Datasource


(Optional) Modify DNASYS.ini to include the IP address of other eDNA datasource in KPI
Manager. By default, during the Performance Server components installation, the IP address
for the eDNA datasource is automatically populated with the IP address of the localhost. In
case there is an eDNA datasource other than the Performance Server, that IP address needs
to be specified in the DNASYS.ini.
To modify the DNASYS.ini file
1. Open the eDNA explorer, and go to Tools > Edit Files > DNASYS.ini.
2. Add this entry:
SVCDIR_0x=<IP address>

Decision Manager Web Service


The Decision Manager comes with an optional web service that you can use to create a case
aside from the create case tool within the Decision Manager module. Follow the steps
described in the following section to install and setup the web service option.
Installing the Web Service
1. Go to <Media>\CD-PM\CD-Decision Manager\Web Service.
2. Open the DecisionManagerOwinService.exe.config file, and edit the following in the
<connectionStrings> section:
o "datasource" : This must be the name of the server where you are installing the
Decision Manager
o "initial catalog": This must be the name of the Decision Manager database
(DecisionManager)
o "user id" and "password" : These should be the user ID and password that you
configured for the database connection
3. Run the install.bat file as an administrator.
4. Test the service using this format:
http://<IPAddress>:<PortNumber>/api/cases

NOTE: The output of this test is expected to be in .json format, but in Internet Explorer
and Chrome, the rendering will be different.

Version 2.3 95
Industry Software Suites Performance Manager Setup Guide Appendix

where:
IPAddress can be the server name or the IP address
Port number is by default 9099, you can change it in the
DecisionManagerOwinService.exe.config file in this section:
<appSettings>
<add key="port" value="9099/>
</appSettings>
If you want to change the database connection that the web service connects to, uninstall
the web service, and follow steps 1 and 2.
Uninstalling the Web Service
 Go to <Media>\CD-PM\CD-Decision Manager\Web Service, and run the uninstall.bat
file as an administrator.

KPI Manager Recommendations


Recommendations on KPI Manager Operation Data Store (ODS) sizing and repository
maintenance as part of a solution are described in the following sections.
ODS Sizing Estimation
The initial version of the KPI Manager only historize values for calculated KPIs. The file size
of the log file for the KPI Manager repository can grow over time as DataPointService
continuously updates the KPI values stored in the repository. It is recommended to monitor
and clear the log file. The following table illustrates the sizing calculation for ODS, which is
estimated based on the number of calculated KPIs and the average update rate of the KPIs.
For information on the basis for the size taken up per data type by historical value, see
Chapter 3, Bytes Used by eDNA Value Types on the Wonderware eDNA History Service 4.0
Administrator Guide Version 4.1.2.5. You can access this document from <Media>\CD-
eDNA\eDNA Services.

Parameters Historian 4.0

No. of Calculated KPIs 300


Avg. Update Frequency 30
ODS Data Type Analog (Float)
NOTE: KPI Manager only supports numeric
types and creates analog points for storage on
ODS.

Size / Value (bytes) 4


Bytes / Sec 40
Online History (years) 5

Estimated Disk Size (GB) 5.874

96 Version 2.3
Appendix Industry Software Suites Performance Manager Setup Guide

Wonderware eDNA Historian is installed to be able to handle 10000 points and automatically
historizing data for any new points created. You can just leave the eDNA default configuration
when Performance Server is installed. As the data history grows, you may choose to manage
the history segment files using the Segment Manager tool in Wonderware eDNA.
For more administrative information, see Chapter 7, History Segmentation on the
Wonderware eDNA History Service 4.0 Administrator Guide Version 4.1.2.5.
Repository Maintenance
The transaction log file for the KPI Manager repository may grow over time since the KPI
Manager services update the repository with any configuration and data changes. In cases
where the log size is getting too large, shrinking the transaction logs is an option. For detailed
information on shrinking transaction log, see the Microsoft TechNet documentation
https://technet.microsoft.com/en-us/library/ms178037(v=sql.105).aspx.
For information on scheduling and automating backups of Microsoft SQL Server databases,
see the Microsoft documentation https://support.microsoft.com/en-sg/kb/2019698.

Understanding the Example Asset Hierarchy


The example asset hierarchy XML for import contains a class node for each class that is
created as a class in CHaD. The following shows the XML structure that is used to define a
class.
XML Structure
<Class>
<ClassName>PPM_Corporate</ClassName>
<Description>Enterprise</Description>
<ParentClass></ParentClass>
<Attribute>
<Name>System</Name>
<Type>String</Type>
<IsInheritable>-1</IsInheritable>
<IsArray>0</IsArray>
<ArraySize>0</ArraySize>
<ClassRestriction></ClassRestriction>
</Attribute>
<Attribute>
<Name>ImagePath</Name>
<Type>String</Type>
<IsInheritable>-1</IsInheritable>
<IsArray>0</IsArray>
<ArraySize>0</ArraySize>
<ClassRestriction></ClassRestriction>
</Attribute>
<Instance>

Version 2.3 97
Industry Software Suites Performance Manager Setup Guide Appendix

<Name>TJPower</Name>
<ParentFullPath></ParentFullPath>
<Attributevalues>
<Attribute>System</Attribute>
<AttributeValue> PRISM </AttributeValue>
</Attributevalues>
<Attributevalues>
<Attribute>ImagePath</Attribute>
<AttributeValue>PowerPlant.png</AttributeValue>
</Attributevalues>
</Instance>
</Class>
 A <Class> node contains the <ClassName>, <Description>, <ParentClass>,
<Attribute>, and <Instance> nodes.
 The Class Name field is the desired name of the class to be created
 The Description field is the description of the above class
 The Parent Class field is the parent class details to which this class belongs to
 The <Attribute> node is used to define the attributes of the class. Any number of
Attributes can be created in a class.
 The <Instance> node is the instance details of the above class. There can be any
number of instances for the class. The <Instance> node also contains details for
<ParentFullPath> and <AttributeValues>
 System Attribute value provides the application name
 ImagePath Attribute value provides the image for the asset. This attribute is used to show
the image in the dashboards
NOTE: If the image is defined and the associated image file is missing in the XML file, the
report loading message on the Internet Explorer will appear in an infinite loop.
For more details, see the Sample Asset Import XML file in <Media>\Samples.

CORS Origin
Industry Console is designed with a front-end web application as well as a back-end API. The
front-end application and back-end API are designed to work as a separate IIS web sites,
where the front-end web application is accessing the API with a different origin. This is why
the Cross-Origin Resource Sharing (CORS) is involved and CORS Origin configuration is
required during the Industry Console installation.
CORS Origin configuration is a form of white listing mechanism for the back-end API to
determine the origin of the web sites that are allowed to request resource from API. This must
be configured with the identity of the front-end web application so that the front-end
application is allowed to access and no other application are allowed access.
In the master installer, the default value for CORS Origin includes these three entries:

98 Version 2.3
Appendix Industry Software Suites Performance Manager Setup Guide

 http://<hostname>:9005; For example: http://sglab322:9005

 http://<FQDN>:9005; For example: http://sglab322.indsol.dev.com:9005

 http://<IP Address>:9005; For example: http://10.111.222.333:9005


Where 9005 is the default port number for the Industry Console front-end web application.
This allows the front-end application access to the API regardless whether the end user is
accessing Industry Console by hostname, IP, or FQDN.

Version 2.3 99

You might also like