The configuration of 3rd party software i.e. Operating Systems, Databases, Application Server, etc., in the context of this documentation is for illustration purposes only. iGrafx doesn't imply that the provided examples are the best or only way of configuration for the described scenario. Nor can we guarantee that it is the best option for performance and security. You apply the instructions at your own risk, please consult an expert of the 3rd party software if you are not sure.
Oracle Databases are no longer supported
Before you install the iGrafx platform, you need to do the following database setup tasks:
- Install Microsoft SQL Server (or Oracle*).
- Create the required databases.
- Create and map a database user.
These steps are described in the following sections. Some have special requirements depending on the database server you use. The explanations provided here use Microsoft SQL Server as an example.
Install SQL Server
The iGrafx platform runs on any version of Microsoft SQL Server listed on the System Requirements page. Please note that while iGrafx supports SQL Server, iGrafx does not provide technical support for SQL Server products themselves.
Installing SQL Server 2019
Before installing SQL Server 2019, check the system requirements for running it at microsoft.com.
The Microsoft SQL Server installer uses a wizard to prompt you through the installation steps. For setup to continue, you must click the Yes button to accept the license agreement when requested.
For more detailed installation instructions, system requirements, and additional information related to Microsoft SQL Server, see the Microsoft resources that are available on the microsoft.com website or in the Planning section of the SQL Server setup wizard.
To install SQL Server 2019, do the following:
- Insert the Microsoft SQL Server 2019 DVD or mount the downloaded ISO image.
Run the setup.exe program.
Click System configuration checker. If the checker reports any issues, it is recommended that you fix the issues before continuing with the installation.
Click Installation in the navigation area on the left. The Installation dialog box appears.
Click New SQL Server stand-alone installation or add features to an existing installation.
- Follow the prompts in the Microsoft SQL Server Setup wizard. Note the following iGrafx platform requirements (other configuration options can use the default settings or be configured as desired):
- On the Feature Selection page, select the following features:
- Database Engine Services
- Management Tools - Complete
Documentation Components (optional).
If you had previously installed an older version of the iGrafx platform, you might have previously installed the Full-Text and Semantic Extractions for Search also known as Full-Text-Index Engine (FTE) during this step. With iGrafx Platform versions after 16.2 the indexing is done by the application server and the FTE should not be installed anymore.
- On the Server Configuration page, Service Accounts tab, specify the Account Name, Password, and Startup Type for SQL Server Database Engine. The logon Account Name and Password can use built-in system accounts, a local account, local group, domain group, or domain user accounts for SQL Server services. iGrafx recommends assigning the minimum level of user rights available.
Set the SQL Server Database Engine Startup Type to Automatic.
For more information, see the SQL Server Configuration - Service Accounts topic in the SQL Server Books Online.
On the Database Engine Configuration page, Server Configuration tab, choose Mixed Mode. This enables the Microsoft SQL Server Management Studio to define a local Microsoft SQL server user that can be used to connect the iGrafx platform application server with the database backend. Alternately, you can obtain an Active Directory user or service account from your IT department to use for administration and connecting from the application server to the database server.
Create a Database
There are two different types of table structures required by the iGrafx platform: the administrative tables and the repository tables. These two structures can share the same database or can be separated into different databases.
You can also combine multiple repositories into one database. Having repositories share the same database is not recommended in an environment where you require backups of individual repositories, because if you need to roll back to a database backup and you have more than one repository in a database you will restore all of them at the same time even if no restore is required for the other repositories. The ideal scenario depends on your environment and backup requirements. Sharing the same database for multiple repositories is useful if you are not interested in individual backups and want to keep the number of databases as low as possible. Also, if you have only one repository, you may prefer having the administrative tables together with the repository to share the same backup and keep them consistent.
For the best performance and data security, keep the administrative tables and repository tables separate, and avoid having more than one repository per database. All backups should be made on the same schedule, to ensure consistency if a recovery is required.
To create a database, do the following:
- Open Microsoft Server Management Studio.
- Right-click on the Databases folder and select New Database.
- Specify a database name.
On the Options tab, change the settings to meet your requirements. The recommended collation setting is SQL_Latin1_General_CP1_CI_AS.
If you choose a different collation, please note that a Case Insensitive (CI) collation is required.
- Click OK to create the database.
Create a Database User
To connect the iGrafx platform application server with the database, you need either a local or directory (i.e. Active Directory) user. The roles or permissions required for this user depends on the database version you use.
If you use multiple databases, as described above, you can use the same or separate users depending on your needs.
Microsoft SQL JDBC Driver
The Microsoft SQL JDBC driver does not allow the iGrafx Platform to connect to the MS SQL database using a different directory user (i.e. Active Directory user) than the one being used to run the iGrafx Platform service. When configured to use JDBC and a directory user - the sign-in is pass through.
If you plan to use a directory user to connect the iGrafx Platform to the Database and/or Repositories - make sure you create a Database user for the user configured to run the iGrafx Platform service.
Failure to do so will result in the following error getting caught in the igrafx_server.log. "
com.microsoft.sqlserver.jdbc.SQLServerException: Login failed for user"
To create a SQL Server user, do the following:
- Open Microsoft Server Management Studio.
- Right-click on the Security / Logins folder and select New Login.
- Add a Windows or SQL Server authenticated user.
- On the Server Role page, keep the public default role.
- On the User Mapping page, map the user to the database and assign the following database roles:
You will then need to create the role db_executor since it does not exist by default:
The script provided below can only be taken as a suggestion, and will require adjustment to meet your corporate standards, system requirements, and performance needs. If you don't use roles make sure the user get the listed permissions through other mechanisms as they are required during the initial setup phase as well as during normal operation of the application server.
In order to use the iGrafx Platform with an Oracle database, the database character set needs to be UTF8
The below script uses separate tablespaces for the administrative tables and repository tables. Technically this is not necessary and you can combine them into one space if you like, however it might be easier to keep them in separate tablespaces if you want to have different backup and retention policies. Also in case you only want to restore one repository without impacting others it may be easier to keep each repository in a separated tablespace as well. If you want to combine repositories into one tablespace you need to provide a table prefix when you add a repository which will be used to identify the tables per repository. The administrative tables use Adm as prefix for easier identification.
The Users created by the script are used to connect the iGrafx Platform application server to the database, no end user need to connect to the database directly. You can keep the database in a network segment unavailable for the end users but available for the iGrafx Platform application.
The actual administrative tables are created by the application during the initial setup. The tables for a repository will be created every time you add a repository. The database details and credentials can be different as described above and illustrated in the script below.
For Oracle 12c, we recommend adding the following statement to the beginning of the script - as otherwise you may encounter script errors (the first of which being: SQL Error: ORA-65096: invalid common user or role name)
This article contains