Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf ·...

31
1 Quality Gates™ 3.3.5 Admin guide 06/2013

Transcript of Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf ·...

Page 1: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

1

Quality Gatestrade

335

Admin guide

062013

2

Content

1 - Introduction 4

2 - System architecture 5

21 General 5

22 General Architecture structure 5

23 General Architectural Elements 6

3 - Installation process 7

31 Prerequisite 7

32 Pre-configured 9

33 Installation 11

34 Pro installation 15

4 ndash Set up DB connection 17

41 - Oracle 17

42 - Teradata 17

43 - MySQL 17

44 - Postgresql 18

45 - GreenPlum 18

46- DB2 18

5 ndash Set up File connection 19

6 - Calling QG test from external source 22

61 -General 22

62 - Windows server or minimum SQL Server Standard Edition 22

3

63- Linux environment 23

7 - Upgrade version 24

8 - Users and security 24

81 General definition 24

82 Recommended type of users to create 26

9 - System configuration 27

91 Application pool 27

92 Mail Configuration 28

93 Set environment 28

94 RI default values 29

95 Additional Category definition 29

96 Excel Attachments 30

4

1 - Introduction

This guide is for the Quality Gates system administrator This guide will go through 3 main topics System

architecture installation information and system configuration

In order to learn how to use Quality Gates define tests and alerts please refer to Quality Gates user

guide

If you have any question or a problem you are welcome to contact one of our Quality Gates experts or

open a ticket in the Quality Gates support site httpwwwquality-gatescomsupport

5

2 - System architecture

21 General The architecture described below is updated to version 330 and above

22 General Architecture structure In order to establish an environment for QG the following components are required

1 Windows Server

2 SQL Server (for repository)

3 PC to access

Optional components are

1 Email Server

2 Additional SQL Server for full log history

Windows

Web Server

SQL SERVER

Repository

SQL SERVER full log history

Client Access

Email Alerts

6

23 General Architectural Elements Quality Gates leverages four core technologies as well as technologies that are directly imbedded in

these three standards

Extjs ndash Is a JavaScript library for building interactive web applications using techniques such

as Ajax DHTML and DOM scripting ExtJS is a cross-browser JavaScript library for building rich internet

applications It is built for developing high performance customizable UI widgets and features

PHP ndash Server-side scripting language originally designed for Web development to produce dynamic Web

pages Quality Gates also uses the PEAR (PHP Extension and Application Repository) that is a framework

and distribution system for reusable PHP components The PHP is 32 bit and responsible only for the

requests received from the client

QGExecuterexe ndash Quality Gates uses the QGexecuterexe executable file in the RunQG directory to load

data from different sources (eg Oracle and OLAP) in order to analyze them The executable files use

Language Integrated Query (LINQ) that is a Microsoft NET Framework (35) component that adds native

data querying capabilities to NET languages that allow fast Data Analysis The QGExecuter can work on

a 32- or a 64-bit mode depending on the operating system This enables QG to exploit all the memory

available for faster performance

SQL Repository ndash When you run your QG tests any information gathered during a load test run is stored

in the SQL Repository which is a SQL database The Quality Gates Repository contains performance

counter data and any information about recorded errors The Quality Gates Repository database is

created by setup

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 2: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

2

Content

1 - Introduction 4

2 - System architecture 5

21 General 5

22 General Architecture structure 5

23 General Architectural Elements 6

3 - Installation process 7

31 Prerequisite 7

32 Pre-configured 9

33 Installation 11

34 Pro installation 15

4 ndash Set up DB connection 17

41 - Oracle 17

42 - Teradata 17

43 - MySQL 17

44 - Postgresql 18

45 - GreenPlum 18

46- DB2 18

5 ndash Set up File connection 19

6 - Calling QG test from external source 22

61 -General 22

62 - Windows server or minimum SQL Server Standard Edition 22

3

63- Linux environment 23

7 - Upgrade version 24

8 - Users and security 24

81 General definition 24

82 Recommended type of users to create 26

9 - System configuration 27

91 Application pool 27

92 Mail Configuration 28

93 Set environment 28

94 RI default values 29

95 Additional Category definition 29

96 Excel Attachments 30

4

1 - Introduction

This guide is for the Quality Gates system administrator This guide will go through 3 main topics System

architecture installation information and system configuration

In order to learn how to use Quality Gates define tests and alerts please refer to Quality Gates user

guide

If you have any question or a problem you are welcome to contact one of our Quality Gates experts or

open a ticket in the Quality Gates support site httpwwwquality-gatescomsupport

5

2 - System architecture

21 General The architecture described below is updated to version 330 and above

22 General Architecture structure In order to establish an environment for QG the following components are required

1 Windows Server

2 SQL Server (for repository)

3 PC to access

Optional components are

1 Email Server

2 Additional SQL Server for full log history

Windows

Web Server

SQL SERVER

Repository

SQL SERVER full log history

Client Access

Email Alerts

6

23 General Architectural Elements Quality Gates leverages four core technologies as well as technologies that are directly imbedded in

these three standards

Extjs ndash Is a JavaScript library for building interactive web applications using techniques such

as Ajax DHTML and DOM scripting ExtJS is a cross-browser JavaScript library for building rich internet

applications It is built for developing high performance customizable UI widgets and features

PHP ndash Server-side scripting language originally designed for Web development to produce dynamic Web

pages Quality Gates also uses the PEAR (PHP Extension and Application Repository) that is a framework

and distribution system for reusable PHP components The PHP is 32 bit and responsible only for the

requests received from the client

QGExecuterexe ndash Quality Gates uses the QGexecuterexe executable file in the RunQG directory to load

data from different sources (eg Oracle and OLAP) in order to analyze them The executable files use

Language Integrated Query (LINQ) that is a Microsoft NET Framework (35) component that adds native

data querying capabilities to NET languages that allow fast Data Analysis The QGExecuter can work on

a 32- or a 64-bit mode depending on the operating system This enables QG to exploit all the memory

available for faster performance

SQL Repository ndash When you run your QG tests any information gathered during a load test run is stored

in the SQL Repository which is a SQL database The Quality Gates Repository contains performance

counter data and any information about recorded errors The Quality Gates Repository database is

created by setup

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 3: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

3

63- Linux environment 23

7 - Upgrade version 24

8 - Users and security 24

81 General definition 24

82 Recommended type of users to create 26

9 - System configuration 27

91 Application pool 27

92 Mail Configuration 28

93 Set environment 28

94 RI default values 29

95 Additional Category definition 29

96 Excel Attachments 30

4

1 - Introduction

This guide is for the Quality Gates system administrator This guide will go through 3 main topics System

architecture installation information and system configuration

In order to learn how to use Quality Gates define tests and alerts please refer to Quality Gates user

guide

If you have any question or a problem you are welcome to contact one of our Quality Gates experts or

open a ticket in the Quality Gates support site httpwwwquality-gatescomsupport

5

2 - System architecture

21 General The architecture described below is updated to version 330 and above

22 General Architecture structure In order to establish an environment for QG the following components are required

1 Windows Server

2 SQL Server (for repository)

3 PC to access

Optional components are

1 Email Server

2 Additional SQL Server for full log history

Windows

Web Server

SQL SERVER

Repository

SQL SERVER full log history

Client Access

Email Alerts

6

23 General Architectural Elements Quality Gates leverages four core technologies as well as technologies that are directly imbedded in

these three standards

Extjs ndash Is a JavaScript library for building interactive web applications using techniques such

as Ajax DHTML and DOM scripting ExtJS is a cross-browser JavaScript library for building rich internet

applications It is built for developing high performance customizable UI widgets and features

PHP ndash Server-side scripting language originally designed for Web development to produce dynamic Web

pages Quality Gates also uses the PEAR (PHP Extension and Application Repository) that is a framework

and distribution system for reusable PHP components The PHP is 32 bit and responsible only for the

requests received from the client

QGExecuterexe ndash Quality Gates uses the QGexecuterexe executable file in the RunQG directory to load

data from different sources (eg Oracle and OLAP) in order to analyze them The executable files use

Language Integrated Query (LINQ) that is a Microsoft NET Framework (35) component that adds native

data querying capabilities to NET languages that allow fast Data Analysis The QGExecuter can work on

a 32- or a 64-bit mode depending on the operating system This enables QG to exploit all the memory

available for faster performance

SQL Repository ndash When you run your QG tests any information gathered during a load test run is stored

in the SQL Repository which is a SQL database The Quality Gates Repository contains performance

counter data and any information about recorded errors The Quality Gates Repository database is

created by setup

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 4: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

4

1 - Introduction

This guide is for the Quality Gates system administrator This guide will go through 3 main topics System

architecture installation information and system configuration

In order to learn how to use Quality Gates define tests and alerts please refer to Quality Gates user

guide

If you have any question or a problem you are welcome to contact one of our Quality Gates experts or

open a ticket in the Quality Gates support site httpwwwquality-gatescomsupport

5

2 - System architecture

21 General The architecture described below is updated to version 330 and above

22 General Architecture structure In order to establish an environment for QG the following components are required

1 Windows Server

2 SQL Server (for repository)

3 PC to access

Optional components are

1 Email Server

2 Additional SQL Server for full log history

Windows

Web Server

SQL SERVER

Repository

SQL SERVER full log history

Client Access

Email Alerts

6

23 General Architectural Elements Quality Gates leverages four core technologies as well as technologies that are directly imbedded in

these three standards

Extjs ndash Is a JavaScript library for building interactive web applications using techniques such

as Ajax DHTML and DOM scripting ExtJS is a cross-browser JavaScript library for building rich internet

applications It is built for developing high performance customizable UI widgets and features

PHP ndash Server-side scripting language originally designed for Web development to produce dynamic Web

pages Quality Gates also uses the PEAR (PHP Extension and Application Repository) that is a framework

and distribution system for reusable PHP components The PHP is 32 bit and responsible only for the

requests received from the client

QGExecuterexe ndash Quality Gates uses the QGexecuterexe executable file in the RunQG directory to load

data from different sources (eg Oracle and OLAP) in order to analyze them The executable files use

Language Integrated Query (LINQ) that is a Microsoft NET Framework (35) component that adds native

data querying capabilities to NET languages that allow fast Data Analysis The QGExecuter can work on

a 32- or a 64-bit mode depending on the operating system This enables QG to exploit all the memory

available for faster performance

SQL Repository ndash When you run your QG tests any information gathered during a load test run is stored

in the SQL Repository which is a SQL database The Quality Gates Repository contains performance

counter data and any information about recorded errors The Quality Gates Repository database is

created by setup

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 5: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

5

2 - System architecture

21 General The architecture described below is updated to version 330 and above

22 General Architecture structure In order to establish an environment for QG the following components are required

1 Windows Server

2 SQL Server (for repository)

3 PC to access

Optional components are

1 Email Server

2 Additional SQL Server for full log history

Windows

Web Server

SQL SERVER

Repository

SQL SERVER full log history

Client Access

Email Alerts

6

23 General Architectural Elements Quality Gates leverages four core technologies as well as technologies that are directly imbedded in

these three standards

Extjs ndash Is a JavaScript library for building interactive web applications using techniques such

as Ajax DHTML and DOM scripting ExtJS is a cross-browser JavaScript library for building rich internet

applications It is built for developing high performance customizable UI widgets and features

PHP ndash Server-side scripting language originally designed for Web development to produce dynamic Web

pages Quality Gates also uses the PEAR (PHP Extension and Application Repository) that is a framework

and distribution system for reusable PHP components The PHP is 32 bit and responsible only for the

requests received from the client

QGExecuterexe ndash Quality Gates uses the QGexecuterexe executable file in the RunQG directory to load

data from different sources (eg Oracle and OLAP) in order to analyze them The executable files use

Language Integrated Query (LINQ) that is a Microsoft NET Framework (35) component that adds native

data querying capabilities to NET languages that allow fast Data Analysis The QGExecuter can work on

a 32- or a 64-bit mode depending on the operating system This enables QG to exploit all the memory

available for faster performance

SQL Repository ndash When you run your QG tests any information gathered during a load test run is stored

in the SQL Repository which is a SQL database The Quality Gates Repository contains performance

counter data and any information about recorded errors The Quality Gates Repository database is

created by setup

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 6: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

6

23 General Architectural Elements Quality Gates leverages four core technologies as well as technologies that are directly imbedded in

these three standards

Extjs ndash Is a JavaScript library for building interactive web applications using techniques such

as Ajax DHTML and DOM scripting ExtJS is a cross-browser JavaScript library for building rich internet

applications It is built for developing high performance customizable UI widgets and features

PHP ndash Server-side scripting language originally designed for Web development to produce dynamic Web

pages Quality Gates also uses the PEAR (PHP Extension and Application Repository) that is a framework

and distribution system for reusable PHP components The PHP is 32 bit and responsible only for the

requests received from the client

QGExecuterexe ndash Quality Gates uses the QGexecuterexe executable file in the RunQG directory to load

data from different sources (eg Oracle and OLAP) in order to analyze them The executable files use

Language Integrated Query (LINQ) that is a Microsoft NET Framework (35) component that adds native

data querying capabilities to NET languages that allow fast Data Analysis The QGExecuter can work on

a 32- or a 64-bit mode depending on the operating system This enables QG to exploit all the memory

available for faster performance

SQL Repository ndash When you run your QG tests any information gathered during a load test run is stored

in the SQL Repository which is a SQL database The Quality Gates Repository contains performance

counter data and any information about recorded errors The Quality Gates Repository database is

created by setup

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 7: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

7

3 - Installation process

31 Prerequisite

Application server

Quality Gates Server Minimum Recommended

Operating System Windows server 2003

Windows server 2008

Windows server 2012

Windows 7

Windows server 2008

Windows server 2012

CPU 2 CPU 4 CPU and above

Memory 2 GB 8 GB and above 1

Disk Space 30 GB 30 GB and above

IIS II6 and above II6 and above

Net Framework 35 35

SMTP SMTP server user password

and port

SMTP server user password

and port

A user with admin permission should be given to install Quality Gates component on the server

1 - The amount of Memory is relevant especially for Compare Table test and depends on the amount

of columns records and data types that need to be compared

Repository

Quality Gates

Repository

Minimum Recommended

Data Base version SQL Server express 2008

SQL Server express 2008 R2

SQL Server express 2012

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 8: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

8

Agent Enable SQL Server Agent

Storage size 4 GB 4 GB per Year

Security MSSQL user with admin permission

Log Data Base Additional Data Base can be created to log tests results

File Data Base Additional Data Base can be created to store file sources (Excel

CSV)

- The repository can be installed on the same or different server as Quality Gates server

User Workstation

User Workstation

Memory 2 GB

Disk Space 2 GB

Flash Some component require flash player

Browser Internet Explorer Firefox Chrome

Database connectors

Data Base connector

SQL Server (MSSQL) Built in connection

Analysis Services (SSAS) Application pool should run with user that has access to OLAP

cube

OLEDB provider for Analysis Services

Oracle Oledb Provider for Oracle 32 and 64 bit

Teradata ODBC provider for Teradata 32 and 64 bit

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 9: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

9

MySQL ODBC provider for MySQL 32 and 64 bit

DB2 DB2 OLEDB Provider

PostgreSQL OLEDB Provider for PostgreSQL

Greenplum OLEDB Provider for PostgreSQL

Excel CSV Provide a folder with write permission to upload files by users

32 Pre-configured The following steps need to be validatedconfigured before starting the installation

1 IIS is installed

2 Microsoft Net Framework 35 is installed

3 The following service Rolewindows features are activated

a CGI

b ASP

c ASPNet

d Security (all component)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 10: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

11

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 11: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

11

4 SQL Server is installed

5 A SQL server User is defined Make sure the user is allowed to login with its credentials and

create new DB

33 Installation

1 Install PHP

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 12: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

12

2 Install Pear

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 13: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

13

3 Install dev environments

Write the full name of the DB (not localhost) Use user and password and not NT

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 14: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

14

4 Install Prod environnements (On Dev server)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 15: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

15

34 Pro installation

Test

1 From the server type the following path httplocalhostqualitygatesdevdefaulthtml 2 Login with the admin user

user admin password admin2

Window server 2003 adjustment

With some instances of windows server 2003 we will have to allow the application to access the cmdexe file

1 Search for cmdexe in C or D drive (depends on the installation) 2 Make sure it is a pure cmdexe (without any other extension like cmdexemui) 3 Right click properties Security Modify Add 4 Add user lsquoeveryonersquo with full permissions

Fix Pack

Follow any Fix pack instructions that exist in the Support Files in the installation Kit

Create new DB for writing to logs

In QG it is possible to write the results of a test into a table and later query this table It is recommended not to write the log table to the repository but to a new DB either in the same SQL Server as the repository DB or in a new SQL Server

License key and activation

In order to activate Quality Gates perform the following steps

1 Go to administration 2 General settings 3 General 4 And replace the license key 5 Click on Save

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 16: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

16

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 17: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

17

4 ndash Set up DB connection In 64-bit server QG uses both 32- and 64-bit providers The reason is that the PHP works with 32-bit and the engine (based on C) works with 64-bit

41 - Oracle QG connects to Oracle 10g and 11g using OLEDB In case the server is a 64-bit install both 32- and 64-bit provider Download and install the following from Oracle website

1 Oracle 32-bit client Choose the administrator option 2 Oracle 64-bit client Choose the administrator option 3 ODAC

Use UDL file to check the connectivity

42 - Teradata QG connect to Teradata using ODBC provider

1 download both 32bit and 64bit ODBC connection from httpdownloadsteradatacomdownloadconnectivityodbc-driverwindows

2 Install both 32bit and 64bit according to the following order a Teradata GSS client package (TeraGSS) b Shared common components for Internationalization for Teradata (tdicu) c Tdodbc

3 Define ODBC connection both in 32 bit and in 64 bit for Teradata 4 To open data source administration for ODBC use

a for 32bit WINDIRSysWOW64odbcad32exe b for 64bit WINDIRSystem32odbcad32exe

5 The DSN name for both 32 and 64 bit have to be the same name 6 Create connection in QG Use the following method

Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

43 - MySQL QG connects to MySQL using ODBC provider

1 Download and install ODBC provider for MySQL from this site httpdevmysqlcomdownloadsconnectorodbc51html

a 32-bit mysql-connector-odbc-5111-winx64msi b 64-bit mysql-connector-odbc-5111-winx32msi

2 Define ODBC connection both in 32-bit and in 64-bit for MySQL 3 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

4 The DSN names for both 32- and 64-bit have to be the same name 5 Make sure you define the DSN in the data source system tab

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 18: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

18

6 Create connection in QG Use the following method Provider=MSDASQL1Password=xxxPersist Security Info=TrueUser ID=xxxDsn=xxx

44 - Postgresql

QG connect to Postgresql using OLEDB provider for Postgresql 1 Install PGNP-1302224 2 Check the connectivity using UDL

45 - GreenPlum It is recommended to use ODBC for connecting Greenplum QG connects to Greenplum using ODBC provider

1 Install Postgresql drivers 2 To open data source administration for ODBC use

a for 32-bit WINDIRSysWOW64odbcad32exe b for 64-bit WINDIRSystem32odbcad32exe

3 The DSN names for both 32- and 64-bit have to be the same name 4 Make sure you define the DSN in the data source system tab 5 Check the connectivity after you set up the driver

QG connects to GreenPlum using OLEDB provider for Postgresql

1 Install PGNP-1302224 2 Check the connectivity using UDL

46- DB2 QG connects to DB2 using and OLEDB provider

1 Install OLEDB provider for DB2 2 Check the connectivity using UDL

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 19: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

19

5 ndash Set up File connection CSV and Excel loading were created to allow the business users to load their own excel or Flat files and compare it to the organization data Attention This option of loading files is not replacing your loading process (often done using ETL)

File connection definition

1 Prefix- Prefix will be added before the name of the stored table Default value (can be changed) 2 Server file path- the location of the folder in the QG server where files will be uploaded to This

field is obligatory 3 Suffix- Suffix will be added before the name of the stored table Default value (can be changed) 4 Auto type generate- marked by default it uploads the files to the DB with specified data types

as the file identify If this field is unchecked QG will provide a varchart data type for all fields

5 Set up a connection to a database which the files will be loaded too This DB can be only SQL Server type Do not use the default repository DB for that Instead create a dedicated DB

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 20: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

21

6 Create templates and friendly names for the uploaded files A template is used to identify the file name It is commonly used when the file to load is changing daily and contain the current date suffix

- Once a template is defined all the characteristics will be saved- the delimiter code and etc - Every time a file will be loaded from the UI the template will be loaded automatically with

the saved characteristics - In addition files which will load directly to the folder in the server when executing the test

from QG the file which the system will use are the latest file from the template and according to the defined characteristics in the template

7 Upload sample- enables the user to upload a sample file to the QG server

More information regarding loading file is available in the user guide

Security and permissions

1 On the Quality Gates server make sure the folder to upload files are shared to everyone 2 In the application pool the user identity should be defined as an administrator user in the

server to upload the files To do so enter to the application pool area and click on advanced settings Check the user and modify if necessary

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 21: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

21

Provider installation

In some cases it is required to install an additional driver in order to load excel Driver name MicrosoftACEOLEDB120 provider Link to the download httpwwwmicrosoftcomen-usdownloadconfirmationaspxid=13255

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 22: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

22

6 - Calling QG test from external source

61 -General There are several ways to execute Quality Gates from external sources as shown below After a test finish it will return a result of either 0 or 1 if the result is 0 then the test succeed if the result is 1 then the test failed

62 - Windows server or minimum SQL Server Standard Edition There are several ways of calling a Quality Gates test from an external source

1 Run a command line to execute a QG test 2 Run a Store Procedure to execute QG test

Share the RunQG folder

In order to be able to call QG using command line it is required to share the RunQG folder to everyone RunQG is located under hellipinstallation pathQualityGatesDevmodulesQualityGates

Create SSIS package calling SP

Use Execute SQL Task Connection Create connection to QG repository SQL Statement exec [dbo][SP_Exec_QG_Test_Ex] qgExeFullPath = hellipinstallation pathQualityGatesDevmodulesQualityGates modulesQualityGatesRunQGQGexecuterexe objectKey = xxxxx environmentKey = -1 xxxxx is the number of QG test

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 23: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

23

Create SSIS package calling command line

To run directly from command line on the server this is the way to run based on the default installation ldquoCProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesRunQGQGexecuterexerdquo 25890 Application -1 Use Execute Process Task and fill the following parameters Executable hellipinstallation pathQualityGatesDev modulesQualityGatesRunQGQGexecuterexe Argument xxxxx Application -1 xxxxx is the number of the QG test Success Value Change from 0 to 1 QG return the value 1 on success

63- Linux environment Many ETL products such as Informatica DataStage Talend ODI BODS and more are installed on a Linux environment The best way to run Quality Gates tests on such cases is by using a web service calling a PHP

1 Inside the shell use the wget command to call Quality Gates test

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111 -q -O - 2 Make sure you replace the following

a QGServername ndash The server name or IP known by the network

b 11111 ndash QG test number

3 The following command enables to call a Quality Gates test with external parameters

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 24: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

24

wget httpQGServernameQualityGatesDevmodulesQualityGates jsexecuteQG2phpobject_id=11111ampVariable_A=param1ampVariable_B=param2 -q -O -

7 - Upgrade version

In order to upgrade Quality Gates proceed according to the following steps

1 Backup the repository By default the repository is an SQL Server DB called lsquoQualityGatesDevrsquo or

lsquoQualityGatesProdrsquo This DB contains all the Quality Gates tests configuration and history This

backup is not an obligatory step It is just for security reasons

2 Uninstall Quality Gates Go to Programs and Features and choose the Quality Gates installation

that needs to be upgraded

3 Execute the new Quality Gates files

4 When prompted for the repository name give the same credentials as the old repository The

system will add additional tables views and stored procedures but will not overwrite existing

objects

5 Use the lsquoCompletersquo option during the installation wizard

8 - Users and security

81 General definition

In order to define permission to control the security of the system and to be able to track the users

activity it is important to define users

Navigate to AdministrationUsersNew

Define the user name in the Name area and click ok (The user name will be the user you log in to QG

with)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 25: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

25

User Settings

In this section define the general settings of the user

- First Name

- Last Name

- Password Password to log in

- Is admin Check this box in order to allow a user to be able to navigate to the Administration

section

- Select Source This will be the root folder of the user The user will be able to see only objects

that exist under this folder

- Source folder id Each folder has an ID It is possible to type it directly without selecting the

folder In case the user is not Admin and it is required to provide him with an access to the

Settings and Reports type in the number 15104

Data source permissions

In this section check all the data sources the user has the permission to see As default behavior the user

has no permission to any data source

User permission

In this section define the action(s) the user can do in the system

It is possible to check several checkboxes based on the rights we would like to grant to the user

- Create a test ndash Capability to create a new test

- Edit test ndash Capability to modify an existing test

- Execute test ndash Execute an existing test No capabilities to change any settings in the test

- Deploy testFolder ndash Capability to deploy a test from development environment to another

environment (Test Prod etc)

- CreateEdit Connection ndash Capabilities to create and modify data source connection

Send alerts

In this section define what are the capabilities of the user in terms of sending alerts

Send permission -

In this section define what are the capabilities of the user in terms of sending alerts

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 26: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

26

82 Recommended type of users to create Below are recommended users Developers

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Admin + NA

DBA 15104 + +

Project manager

15104 + + +

Developer 15108 or other

+ +

Production + NA + + +

Business Users

Type of user

Is Admin

Source Folder

Data source Permission

Create and Edit

Edit Execute Deploy Create connection

Modify parameters

Relevant folder

Relevant data source

+ +

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 27: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

27

Executer Relevant folder

+

Viewer Relevant folder

Relevant data source

9 - System configuration

91 Application pool In order to access the different cubes within Quality Gates interface it is required to provide a strong

user who can have access Quality Gates does not use the QGrsquos user in order to authenticate to the

cube

To define the user it is required to define it in the application pool

In the application pool (in IIS) click on the Default application pool and on the Advanced Settings on the

right

In the application Pool Identity insert a user with enough permission to access the entire cube by

setting a Custom account

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 28: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

28

92 Mail Configuration In order to allow email alerts it is required to set the email configuration

Inside QG interface navigate to Administration General Settings Mail Config

Login Name User to access SMTP Server

Mail Sender the email of the sender which will appear every time a QG alert is sent

Password SMTP account password

Port SMTP port (usually 25)

SMTP SMTP Server Name

93 Set environment After a test is validated it is possible to transfer it directly to another environment by choosing the

relevant environment and using lsquocommitrsquo

In order to set the different environments open the Environments table from the repository DB and

change the name and the connection string

The EnvKey = 1 will always be the initial environment we deploy from

Make sure that in each repository the EnvKey = 1 is the Connection string

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 29: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

29

94 RI default values When RI Completion is done through QG it is possible to define the exact value which will be completed

for each data type

Navigate to Quality Gates Settings General Settings QGRIDefaultValue

Edit the Values and click on the Save button before exiting

95 Additional Category definition

In some cases there is a need to classify a test in several places A test can be part of a folder called

Marketing but at the same time I would like to classify the tests inside Marketing folder for the type of

user depending on interest (Business IT Management) or other classification

The classification allows us to query the repository and filter the data based on the relevant category we

would like to see

1 Check the visible check box

2 Insert a name for the category

3 Add edit or delete values

After saving the definition the category will appear in the setting tab which will allow a drop down list

selection

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 30: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

31

Pay attention Only 2 categories are optional for definition

96 Excel Attachments

In order to attach an Excel file to an email upon test execution the following need to be done

1 Make sure the security permissions of the js directory is set to enable all users (everyone) full

control of it

Folder path is at

CProgram Files (x86)QualityGatesQualityGatesDevmodulesQualityGatesjs

(Path is subject to the QualityGates installation directory)

2 On Administration section under General Settings General set ExcelTomail and

ResultToExcel to Yes

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute

Page 31: Quality Gates™ - Amazon Web Serviceskeyrus-prod.s3.amazonaws.com/.../PDF/Quality...3_5.pdf · pages. Quality Gates also uses the PEAR (PHP Extension and Application Repository)

31

3 Configure the user used to run the test to have permissions for attaching an Excel file

4 On Settings tab in test check the Attach Excel option

86 Store Procedure Configure and Execute