setting up an ms sql server for igssd2i1dro1ulg1xm.cloudfront.net/v11/setting up the sql server for...

Setting up an MS SQL Server for IGSS Development June, 2014

Page - 1 -

Setting up an MS SQL Server for IGSS

Table of Contents

Table of Contents .................................................................................................................................................1

Introduction .......................................................................................................................................... 2

The Microsoft SQL Server database .................................................................................................................2

Setting up an MS SQL Server ................................................................................................................................3

Installing the MS SQL Server software .............................................................................................................3

Enable protocols in the SQL Server Configuration form ..................................................................................6

Set up the TCP/IP Properties ............................................................................................................................7

Create databases ..............................................................................................................................................8

User Setup ..................................................................................................................................................... 11

Set up ODBC interfaces for IGSS ........................................................................................................................ 13

Set up the IGSS configuration ............................................................................................................................ 18

Reduced data (HDM) and MNTDB databases ............................................................................................... 19

The HDM database ........................................................................................................................................ 19

The Maintenance database ........................................................................................................................... 21

Audit Trail and LOG database ............................................................................................................................ 21

Set up integration to the Audit Trail database .............................................................................................. 21

Define Audit Trail logging details and settings .............................................................................................. 24

The LOG and Alarm log database ...................................................................................................................... 26

Set up integration to the LOG database ........................................................................................................ 26

Define logging parameter for each individual object .................................................................................... 28

Transfer Alarm log database ......................................................................................................................... 28

Operator Station access to the MS SQL Server ................................................................................................. 28


Page - 2 -

Introduction The IGSS program stores process data primarily in two proprietary data file types: LOG and BCL, although some IGSS data is stored directly in .MDB files (Microsoft Access format). Some process data (for example Audit Trail data) is stored exclusively in Microsoft SQL server databases which must therefore be set up and configured correctly in order to function. The IGSS program uses the stored process data for populating reports and graphs as well as displaying and extracting historical data. LOG and Alarm log stored in the MS SQL Servers is not retrieved for reporting or display purposes but instead used as data storage for 3rd party software access or security backups, while HDM, Maintenance and AuditTrail data is used directly in IGSS.

The Microsoft SQL Server database In addition to storing process data in LOG and BCL files you can set up the IGSS program to store LOG process data in a Microsoft SQL server database also, as well as storing AuditTrail, Alarm log, Maintenance and HourDayMonth (HDM) data.

LOG process data is stored for IGSS objects set up to store LOG data and also set up to transfer LOG data to an SQL database.

Alarm log data from the Active Alarm list can be stored in the LOG database as well as IGSS own proprietary Alarm log data files.

HDM process data is transferred from the HDM access database, generated from reduced data which is generated from process values from objects that have been set up to store reduced data values.

AuditTrail data is only stored in an MS-SQL database and the AuditTrail module cannot be used unless the AuditTrail database is created and set up correctly.

Maintenance data is transferred from values in the Maintenance module, generated by the creation of Maintenance jobs and the day-to-day registering of completed and due maintenance.

IGSS can integrate with the following versions of Microsoft SQL servers as well as their Express versions:

SQL Server 2005

SQL Server 2008

SQL Server 2008 R2

SQL Server 2012

SQL Server 2014

Note MS SQL Express versions have a reduced database toolset, can only utilize one processor, 1 GB memory and have a limit to the size of the database. 4 GB database maximum

SQL Server 2005 Express


Page - 3 -

SQL Server 2008 Express 10 GB database maximum

SQL Server 2008 R2 Express



IGSS can access and utilize all the express versions, but be aware of the limitations built into the express versions. An MS SQL Express can be upgraded to a full MS SQL version if necessary.

Setting up an MS SQL Server When setting up an MS SQL Server to integrate with the IGSS program, you must:

Download and install the MS SQL server software

Create the SQL databases you will need when integrating with IGSS

Create the SQL user accounts and set up security privileges for the database

Installing the MS SQL Server software You must first obtain installation files for the MS SQL version you want to install, either purchasing the program from a Microsoft Solutions vendor or downloading the files directly from various sources on the internet. For example, the MS SQL Server Express 2014 and Management Tools software can be downloaded from this link: http://www.microsoft.com/express/Database/ After having obtained the MS SQL server software, install the software on the IGSS Server or another computer in the IGSS network, often a machine set up to be a dedicated MS SQL Server PC. If you install an MS SQL server on a dedicated machine, all IGSS client and server machines must be able to access the dedicated machine. Execute the installation files you have downloaded to start the installation process. The illustration below depicts the feature selection part of the installation process.

Example - MS SQL Server 2014 Express The following screenshots are examples and depict an installation process of an MS SQL Server 2014 Express version with subsequent integration with IGSS. If you are installing and configuring other versions of MS SQL Server, you can use the descriptions in this example as inspiration and general guidelines as the installation and setup procedure can vary between different MS SQL Server versions.

Feature Selection Click the Select All button and then click the Next button to open the Instance Configuration form.

http://www.microsoft.com/express/Database/


Page - 4 -

Note

If you need to save space, the Client Tools SDK and SQL Client Connectivity SDK are not required and do not need to be installed. Clear the Client Tools SDK and SQL Client Connectivity SDK check boxes if necessary.

Instance Configuration In the Instance Configuration form, you can name your database. If you expect to have more than one database instance, you must give a unique name to each of the databases.


Page - 5 -

If you are using MS SQL Server Express, it is recommended to create a new server name, instead of using the default name, SQLEXPRESS. For example, you could call it "IGSSSQL" After you have named the instance of your database, click the Next button to open the Database Engine Configuration form.

Database Engine Configuration In the Database Engine Configuration form, you must define the authentication mode and, depending on the authentication mode, set up the administrators of the database.


Page - 6 -

If you later want to delegate 3rd party software Read rights to the database, you should select the Mixed Mode authentication mode.

Windows Authentication mode can be used if you are using domain/workgroup network security policies. If all the IGSS machines (Server and Operator) are on the same domain, we recommend using the Windows Authentication mode.

Mixed Mode (which includes MS SQL Server Authentication and Windows Authentication) and is necessary if you are if using domain/workgroup network security policies. If you later want to delegate 3rd party software Read rights to the database, you should select the Mixed Mode authentication mode.

Click the Next button to complete the MS SQL Server database setup.

Enable protocols in the SQL Server Configuration form After you have installed the MS SQL Server, you must enable the protocols to be used by the SQL Server. Make sure the SQL Server and SQL Server Browser under SQL Server Service are started. In the windows desktop, click Start > SQL Server 2014 > Configuration Tools > SQL Server Configuration Manager to open the SQL Server Configuration Manager form.


Page - 7 -

In the left pane of the SQL Server Configuration Manager form, select SQL Server Network Configuration > Protocols for <DB Instance>, where <DB Instance> is the name of the database instance defined previously.

In the right pane, enable the following protocols by clicking the protocol to toggle between Enabled and Disabled:

Shared Memory

TCP/IP The Shared Memory and TCP/IP protocols for SQL Native Client 11.0 Configuration must also be enabled. The Named Pipes protocol should be disabled for the SQL Native Client 11.0 Configuration and the SQL Server Network Configuration both.

Set up the TCP/IP Properties You must define a TCP/IP port if you want to access IGSS Maintenance and AuditTrail process data from connected operator stations. IGSS Maintenance and AuditTrail process data are only stored in SQL Server databases.


Page - 8 -

The defined TCP/IP port can afterwards be opened in any local firewalls or routing equipment on the network that has port filtering.

1. In the right pane, double-click the TCP/IP protocol to open the TCP/IP Properties form. 2. In the TCP/IP Properties form> IP Addresses tab, expand the IP1 group and in the TCP Port

field, enter the port number you want to use. 3. Repeat the steps for the IPAll group.

Note

Port 1433 and 1434 are general default port, other numbers can be chosen, to mask its SQL traffic or fit a Firewall port setup.

Create databases After you have enabled the protocols to be used and set up the IP ports to be used, you must create the databases you want to store IGSS process data. In the windows desktop, click Start > SQL Server 2014 > Server Management Studio to open the SQL Server Management studio.


Page - 9 -

1. In the Server type field, select Database Engine. 2. In the Server name field, select the correct server name (see Note above). 3. In the Authentication field, select Windows Authentication or SQL Server Authentication, as

required. 4. If you select SQL Server Authentication:¹

In the User name field, select the SQL user name to access the database with

In the Password field, enter the user password

Select the Remember Password check box to allow users to access the database without having to enter their password every time.

¹ This assumes an MS SQL Server user account already exists with sufficient rights to create and edit databases. If an MS SQL Server user account does not exist, select Windows Authentication instead. In the left pane of the SQL Server Management studio, right-click Databases and select New Database to open the New Database form. In the Database name field, enter a name for the database. There are four databases you can create for storage of IGSS process data:

LOG

HDM

AUDITTRAIL

MNTDB Each database must be created individually. You do not need to create databases for process data that is not stored in the MS SQL Server. Click the OK button to create the database.


Page - 10 -

Run the SQL script After you have created the database, you must run an MS-SQL script which will automatically create the tables necessary for integration with IGSS. Running MS-SQL script will ensure the tables are created, named and set up correctly, with the required database indexes, rows and fields. In the left pane of the SQL Server Management studio, expand the Databases and select the newly created database. Click File > Open > File to browse to the SQL folder in the IGSS installation folder. By default, IGSS is installed in the C:\Program Files\Schneider Electric\IGSS32\V11.0.

Select the SQL script which corresponds to the SQL database you have created and selected:

For storing LOG data, select logdb.sql

For storing HDM data, select hdmdb.sql

For storing Maintenance data, select mntb.sql

For storing AuditTrail data, select audittraildb.sql

In the Toolbar, click the Parse button (Blue check mark ) to compile the SQL script and uncover any potential conflicts. In the Toolbar, click the Execute button to run the.selected SQL script. In the Messages pane, a line should be displayed with the contents: (1 Row(s) affected). If there are more lines, an error has occurred. Troubleshoot the error and repeat this step, once fixed.


Page - 11 -

User Setup If you have an operator station which is not in the same domain / workgroup as the SQL Server and therefore cannot use Windows Authentication, you must create and configure an SQL Server Authentication account for that operator station. In the left pane of the SQL Server Management studio, expand Security > right-click Login and select New Login.

The General page Create the login account details on the General page. On the General page,

In the Login name field, enter a unique name for the new login account

Select the SQL Server authentication option

In the Password field, enter the password for the login account and repeat the password in the Confirm password field.

Select the Enforce password policy check box if required and define any necessary password policies


Page - 12 -

In the example below, an account named IGSS is created with a password consisting of four letters. The default database is set to Master, although you can set whichever database you like as the default database.

Server Role After you have defined an account name and password, you must define appropriate server-wide security privileges for the new account on the Server Role page. The public account server role is usually sufficient for IGSS purposes.

User Mapping After you have defined server roles for the new account, you must define database roles for each database the account is to access.


Page - 13 -

On the User Mapping Page, define the database role membership of the new account for each database. In the upper pane, select the database and then define one or more database roles for the new account in the lower pane. Define database role for each relevant database for the new account.

Click the OK button and close the MS SQL Server Management Studio.

Set up ODBC interfaces for IGSS If you want to use the HDM and MNTDB databases to store reduced data (In HourDayMonth format) and/or data from the IGSS Maintenance Module, you must use the Windows 32-bit ODBC interface.


Page - 14 -

The Windows 32-bit ODBC interface is configured in the ODBC Data Source Administrator form. Use the odbcad32.exe file to open ODBC Data Source Administrator form to set up the ODBC interface, regardless of the operating system (32bit/64 bit). The odbcad32.exe file is located in different folders depending on the operating system. 32-bit Windows In the windows desktop, click Start > Control panel > Administrative Tools > Data Sources (ODBC) to open the ODBC Data Source Administrator form. 64-bit windows Open an Explorer and browse to the C:\Windows\SYSWOW64 folder. Double click the odbcad32.exe to open the ODBC Data Source Administrator form.

In the open the ODBC Data Source Administrator form > System DSN tab, click the Add button to add a new system data source.


Page - 15 -

Select SQL Server or Microsoft Ole DB for SQL

In the Name field, enter the name of the data source

In the Description enter a description of the data source

In the Server field, select the MS SQL server.


Page - 16 -

Note

If there are no DNS servers on present on the local network, you can enter the IP address of the server instead of the server name

In the example below, the source is named HDM and the ANI-WIN7U-X64 SQL server has been selected.

Click the Next button to define user authentication for the new data source.


Page - 17 -

Select the With SQL Server authentication using a login ID and password entered by the user option and enter the SQL user name and password for the user that is to access the database. Click the Next button to define the default database to connect to.

Select the default database from the drop-down list in the Change the default database to: field and click the Next button twice to open the ODBC Microsoft SQL Server Setup form.


Page - 18 -

You can click the button to test the data source connection, but the connection will usually be valid as the default database was selected just previously. Click the OK button to create the ODBC connection to the database.

Set up the IGSS configuration After you have created the ODBC interface, you must set up the data logging parameters for your IGSS configuration. Start the IGSS Master on the IGSS Server. The Supervise module does not need to be started. Note

Database integration Setup is not necessary for operator stations. The only requirement for operator stations is that they must have read/write access to the SQL Server.

In the IGSS Master > Design and Setup tab, click the System Configuration button to open the System Configuration form. In the left pane of the System Configuration form, select the IGSS Server, right-click and select This PC to set up the data logging parameters for the IGSS server. Select the Files tab to set up the SQL parameters for data logging.


Page - 19 -

You can set up the following MS SQL database integrations on this tab:

Reduced Data (HourDayMonth or HDM)

Maintenance data

AuditTrail data

LOG and Alarm log data

Reduced data (HDM) and MNTDB databases The HourDayMonth (Reduced data) and MNTDB (Maintenance) databases both use the windows 32-bit ODBC interface settings which were configured previously.

The HDM database In the System Configuration form > File tab > > External database group, click the SQL settings button to open the SQL Server Settings form.


Page - 20 -

In the SQL Server Settings form:

1. Select the Enable external DB for HDM database check box 2. In the DSN field, enter the Data Source Name for the reduced (HDM) data from the ODBC

interface set up. 3. In the Computer name of server field, enter the name of the SQL server from the ODBC

interface set up. 4. In the Database name field, enter the name of the SQL database you want to store reduced

(HDM) data in. 5. In the Authentication group, select the database authentication mode you have set up for the

SQL database

NT authentication is equivalent to Windows authentication

Database authentication is equivalent to MS SQL authentication). 6. Enter the user name and password if you have selected the Use database authentication

check box. Note

For HDM database integration only Once the IGSS configuration has been “checked & Installed”, the next time the GenHDM.exe runs, SQL links will be created in the GENHDM.db. If you want to transfer historical data from the GENHDM.db to the HDM database in the SQL Server, you will need to run the GENHDM.exe program and set the collection time back to the time to where you want data in the SQL server to start.


Page - 21 -

The Maintenance database The database setup of the Maintenance database integration to a MS SQL Server is identical to the HDM setup. In the System Configuration form > File tab > > Maintenance data group, click the SQL settings button to open the SQL Server Settings form. In the SQL Server Settings form:

7. Select the Enable external DB for HDM database check box 8. In the DSN field, enter the Data Source Name for the Maintenance data from the ODBC

interface set up. 9. In the Computer name of server field, enter the name of the SQL server from the ODBC

interface set up. 10. In the Database name field, enter the name of the SQL database you want to store

maintenance data in. 11. In the Authentication group, select the database authentication mode you have set up for the

SQL database a. NT authentication is equivalent to Windows authentication b. Database authentication is equivalent to MS SQL authentication).

12. Enter the user name and password if you have selected the Use database authentication check box.

Audit Trail and LOG database Audit Trail database integration is set up in two steps:

The database integration is configured in the File tab of the System Configuration form

The Audit Trail logging parameters are defined in the Access Control tab of the System Configuration form

The LOG database integration is set up in nearly the same fashion

The database integration is configured in the File tab of the System Configuration form

Each individual object is configured to send LOG data to the MS SQL Server in the Data Management Definitions tab on the Object Properties form of the object.

Set up integration to the Audit Trail database The IGSS Audit Trail module is only accessible from the Home tab on the IGSS Master if the Audit Trail database has been set up correctly. If the Audit Trail database has not been set up correctly, the Audit Trail group and buttons will not be displayed in the Home tab on the IGSS Master. In the System Configuration form > File tab > Audit trail data group, click the SQL Settings to open the SQL Server Settings form.


Page - 22 -

In the SQL Server Settings form, select the Write audit trail value to SQL server check box and click the Database Setup button to open the Data Link Properties form.

In the Data Link Properties form > Provider tab, select SQL Server Native Client 10.0 data

source (Not depicted in the screenshot above) and click the Next button to open the Connection

tab.


Page - 23 -

On the Connection tab:

1. In the Select or enter a server name field, select the MS SQL Server to store the audit trail data from the drop-down list.¹

2. In the Enter information to log on to the server section, select the authentication mode to be used to connect to the MS SQL Server.

Select the Use Windows NT integrated security check box to use the Windows authentication mode

Select the Use a specific user name and password to use MS SQL Server authentication mode.

If you select to use the MS SQL Server authentication mode:

In the User name field, enter the SQL Server user account used to connect to the MS SQL Server.

In the Password field, enter the password of the selected SQL Server account

Select the Blank password check box to permit blank passwords

Select the Allow saving password check box to save the password of the selected user, allowing the user to connect to the SQL server without specifying the password every time.

3. In the Select the database on the server section, select the AUDITTRAIL database from the drop-down list.

4. Click the Test Connection button to test that the connection is working. If successful, then click the OK button to close the Data Link Properties form and return to the SQL Server Settings form.


Page - 24 -

The SQL Server Settings form should display the data source machine and user as well as the database name.

¹ In multiuser systems, we recommend that you use the actual IP address, for example, 192.168.0.1.

Define Audit Trail logging details and settings After you have set up the database integration for the IGSS Audit Trail module, you must:

Define how long Audit Trail data is stored in the database

Enable Audit Trail data logging

Configure the degree of user actions to be logged in the Audit Trail database.

Set up IGSS User Administration

Define how long Audit Trail data is stored In the System Configuration form > Files tab > Audit Trail data group, enter the number of days Audit Trail data is to be retained in the database. The maximum number of days you can specify is 36500, corresponding to 100 years of data. If you specify 0 days, the Audit Trail data will never be deleted.

Enable Audit Trail data logging In the System Configuration form > Access tab > Audit Trail group, select the Keep a record of all user activity in an audit trail database check box to enable audit trail data logging.


Page - 25 -

If the Keep a record of all user activity in an audit trail database check box is not selected, audit trail data will not be saved to the database, regardless of the correct set up of the database.

Configure user actions to log In the System Configuration form > Access tab > Audit Trail group, select which user actions are to be logged in the Audit Trail database.

Select the Store audit Trail check box for each user action which is to be logged in the Audit Trail database. See the table below for a description of the user actions.

Select the Comment check box for each user action to be logged in the Audit Trail database if a comment is mandatory from the user who performs the action.

User Action Description

Output Commands sent by the user to the PLC.

Limits Alarm limits changed by the user.

Access When the user logs in and out of the system.

Note Used for object notes and user notes.

Alarm Used for alarm actions, such as acknowledgement and ending of alarms.

System Used for system start and stop (automatic or user-activated).

Data Used for operations concerning data logging and data collection.


Page - 26 -

Set up User Administration As the IGSS Audit Trail module registers user actions, setting up the Audit trail functionality really only makes sense, if you enabled and are using the IGSS User Administration module This will allow you to record exact user actions, the result of the actions and the user who performed the action. We recommend that set up and configure the IGSS User Administration module before starting the audit trail by:

Defining the relevant users and user groups in the User Administration module.

Enabling the User Administration module by clearing the Disable access control check box on the Access Control tab in the System Configuration form.

Ensuring users are logged in permanently, while are using IGSS. If a user is only temporarily logged in, he will be prompted for his user name and password, every time the Audit Trail needs to record an activity.

The LOG and Alarm log database The LOG database stores process values from IGSS objects in the specified MS SQL database. You can also elect to store alarm log data in the specified MS SQL database as well.

Set up integration to the LOG database In the System Configuration form > File tab > Log data group, click the SQL Settings to open the SQL Server Settings form. In the SQL Server Settings form, select the Write audit trail value to SQL server check box and click the Database Setup button to open the Data Link Properties form.


Page - 27 -

In the Data Link Properties form > Provider tab, select SQL Server Native Client 10.0 data

source (Not depicted in the screenshot above) and click the Next button to open the Connection

tab.

On the Connection tab:

1. In the Select or enter a server name field, select the MS SQL Server to store the LOG data from the drop-down list.¹

2. In the Enter information to log on to the server section, select the authentication mode to be used to connect to the MS SQL Server.

Select the Use Windows NT integrated security check box to use the Windows authentication mode

Select the Use a specific user name and password to use MS SQL Server authentication mode.

If you select to use the MS SQL Server authentication mode:

In the User name field, enter the SQL Server user account used to connect to the MS SQL Server.

In the Password field, enter the password of the selected SQL Server account

Select the Blank password check box to permit blank passwords

Select the Allow saving password check box to save the password of the selected user, allowing the user to connect to the SQL server without specifying the password every time.

3. In the Select the database on the server section, select the LOG database from the drop-down list.


Page - 28 -

4. Click the Test Connection button to test that the connection is working. If successful, then click the OK button to close the Data Link Properties form and return to the SQL Server Settings form.

The SQL Server Settings form should display the data source machine and user as well as the database name. ¹ In multiuser systems, we recommend that you use the actual IP address, for example, 192.168.0.1.

Define logging parameter for each individual object After you have set up database integration to the SQL Server LOG database, you must define which objects are to store process data in the MS SQL database. If no objects are set up to store process data in the MS SQL database, then no process data will transferred to the LOG database, regardless of whether the database integration is set up correctly. In the Definition form, right-click the object you want LOG data stored for and select Properties to open the Object Properties form. In the Object Properties form > Data Management Definitions tab > Logging group, select the Log to SQL database check box. Note

You can mass-update objects by using the Property Table Viewer form, changing the logging parameters for all or selected objects instead of each one individually.

Transfer Alarm log database After you have set up database integration to the SQL Server LOG database, you can elect to transfer Alarm log data to the LOG database. You must set up a LOG database in the SQL Server to save Alarm log data in a LOG database, even the only data in the LOG database is to be Alarm log data.

To transfer Alarm log data to an MS SQL database 1. In the IGSS Master > System Configuration tab, click the System Configuration button to

open the System Configuration form 2. In the System Configuration form > Files tab > Log data group, select the Alarm log data

too check box to include Alarm log data in the MS SQL LOG database. 3. Close the System Configuration form and re-start the IGSS configuration.

Operator Station access to the MS SQL Server If an operator station needs to utilize any of the four IGSS Databases located on the MS SQL Server, you must set up the ODBC integration for that operator station as described under the ODBC section above.

setting up an ms sql server for igssd2i1dro1ulg1xm.cloudfront.net/v11/setting up the sql server for...

Documents