Database Server Installation

Deploy the APM Database Server for the First Time

The installation and configuration steps differ depending on whether you are connecting to an Oracle or SQL Server Database. Use the checklist appropriate to the type of database that you are using.

Use the checklist appropriate to the type of database that you are using.

Oracle Checklist

The following checklist should be used to install and configure an Oracle Database Server, create the APM schema, and configure the Server for use with Oracle.

You should complete these steps in relatively the same order in which they are listed in the table.

StepTaskNotes
1Ensure that the Database Server machine meets the system requirements.This step is required.
2On the Database Server, install the Oracle Server software.This step is required.
3 On the Database Server, create the Oracle database.This step is required.
4On the Database Server, configure the Oracle database.This step is required.
5On the Database Server, create the Oracle schema.This step is required.
6On the Database machine, Create the Oracle Scheduler Database.This step is required.
7On the Database machine, Create the Oracle Scheduler Schema.This step is required.
8On the Database machine, Create the Localization Oracle Database.This step is required.
9On the Database machine, Create the Localization Oracle Schema.This step is required.
10On the Server, create an initial data source.This step is required.
11In , build the search index.This step is required.

Install the Oracle Server Software

About This Task

Note: You need to complete this step only if you plan to use an Oracle Database Server to host the APM schema.

The first step in setting up the database server for the APM schema is to install the Oracle Server software on the database server machine. Instructions for installing the Oracle Server software exceed the scope of this documentation. For information on performing the installation, refer to the Oracle installation documentation that is specific to your database server platform. If you plan to create a database via the Oracle Universal installer, then, before proceeding, you should review the section in this documentation on Creating and configuring the Oracle database.

What To Do Next

Create the Oracle Database

Before you create the Oracle schema that will contain the APM repository, you must install the Database Server software on the APM Database Server machine. The creation of the Oracle database exceeds the scope of this documentation. For details on creating an Oracle database, consult the Oracle documentation that is specific to your database platform.

When the database is created, the database character set must be specified. If you are creating a Unicode database, use the character set AL32UTF8. This is the most recent and recommended Unicode database character set.

What To Do Next

Configure the Oracle Database

After you have created the Oracle database, you will need to configure it. Details on configuring the Oracle database exceed the scope of this documentation. For details on configuring an Oracle database, consult the Oracle documentation that is specific to your database platform. Note, however, that the Oracle database must meet the following requirements:

The following database parameter values are recommended and must persist from one database startup to the next.

Database parameter value

Notes

dml_locks=5000

The dml_locks parameters should be set to a large value to avoid the possibility of waiting for a lock.

open_cursors=500

It is not uncommon for one APM user to have multiple cursors open simultaneously. For this reason, you should set this value accordingly.

parallel_max_servers=0

The APM schema is not configured for parallel query. Therefore, we recommend that you disable this feature. Enabling parallel query when the database and schema are not properly configured can severely degrade system performance.

parallel_min_servers=0

The APM schema is not configured for parallel query. Therefore, we recommend that you disable this feature. Enabling parallel query when the database and schema are not properly configured can severely degrade system performance.

processes=500

None

query_rewrite_enabled=true

None

timed_statistics=true

Setting timed_statistics allows for minimum maintenance and enables reporting on internal wait events, which can be used to reconfigure your database.

Memory_target= 4G

Suggested minimum

Default values for database parameters that are not mentioned in the above list meet or exceed recommendations for a APM database configuration. APM recommends that you monitor the database so that changes can be made as necessary to accommodate the needs of your specific installations. For more information on these and other database parameters, consult the Oracle documentation.

What To Do Next

Create the APM Oracle Schema on the APM Database Server

About This Task

The following instructions provide details on creating the APM Oracle schema. After you have created the Oracle schema using these instructions, the schema will be referred to as the APM database throughout this documentation.

To perform these steps, you will need Oracle DBA privileges on the APM Database Server machine. These instructions assume that:

  • You are logged in to your APM Database Server machine with DBA privileges and have a connection to Oracle.
  • You are familiar with running SQL scripts and the associated terminology.

Procedure

  1. On the APM Server machine, in the APM distribution package, navigate to the Database folder.
  2. Open the file MI_DB_MASTER_<version>.zip, and then extract the contents of the file <version>.zip to a folder on the C: drive.
  3. Open the file <version>.zip, and then open the subfolder _Setup\NewInstall\Oracle.

    This folder contains the extracted files that will need to be run by the database administrator (via the remaining steps). The database administrator will need the following three files, as well as access to the remaining instructions in this topic:

    • CRT_MI_CONNECT_ROLE.SQL
    • CRT_MI_USER.SQL
    • MI_V4030070.DMP.ZIP
    1. Locate and run the script CRT_MI_CONNECT_ROLE.SQL.
      This script creates the APM role (MI_CONNECT_ROLE), which contains several of the Oracle privileges that are necessary to run the APM applications. This script does not require any parameters. You will need to run this script one time per database.
    2. Locate and run the script CRT_MI_USER.SQL.
      This script creates the Oracle user, and then grants to the user the role MI_CONNECT_ROLE that you created in the preceding step.

      The schema is created. For example, if you were to define the parameters through the command SQL> @CRT_MI_USER MERIDIUM_PROD MERIDIUM_PROD 1000M Meridium_DATA, it would automatically:

      • Create a user named MERIDIUM_PROD.
      • Set the password for the user to MERIDIUM_PROD.
      • Set the default tablespace for the user to MERIDIUM_DATA.
      • Grant 1GB of quota on the default tablespace.
      Note: This example assumes that the MERIDIUM_DATA tablespace already exists.
  4. Import the Oracle schema that you created in the preceding steps. To do so:
    1. On the APM Database Server machine, locate the file MI_V4030070.DMP.ZIP, and then extract and import the contents.
    2. Update the schema statistics.
  5. Log in to SQL*Plus (or equivalent) as the schema owner, and then run the following command: SQL> EXEC MI_DDL.CRT_SIDX_SI_MI_GEOD_GD
    The spatial/geo index for the database is imported.

What To Do Next

Create the Oracle Scheduler Database

Before you create the Oracle schema that will contain the APM repository, you must install the Database Server software on the APM Database Server machine.

Create an Oracle database that will be used by the APM Scheduler. You may set the database name as apm_scheduler. The creation of the Oracle database exceeds the scope of this documentation. For details on creating an Oracle database, consult the documentation that is specific to your database platform.

When the database is created, the database character set must be specified. If you are creating a Unicode database, use the character set AL32UTF8. This is the most recent and recommended Unicode database character set.

What To Do Next

Create the Oracle Scheduler Schema

About This Task

The following instructions provide details on creating the Scheduler Oracle schema.

To perform these steps, you will need Oracle DBA privileges on the APM Database Server machine. These instructions assume that:

  • You are logged in to your APM Database Server machine with DBA privileges and have a connection to Oracle.
  • You are familiar with running SQL scripts and the associated terminology.

Procedure

  1. On the APM Server machine, in the APM distribution package, navigate to the Database folder.
  2. Open the file MI_DB_MASTER_<version>.zip, and then extract the contents of the file <version>.zip to a folder on the C: drive.
  3. Open the file <version>.zip, and then open the subfolder _Setup\NewInstall\Oracle.

    This folder contains the extracted files that will need to be run by the database administrator (via the remaining steps). The database administrator will need the following two files, as well as access to the remaining instructions in this topic:

    • CRT_MI_CONNECT_ROLE.SQL
    • CRT_MI_USER.SQL
    • SCHEDULER.SQL
    1. Locate and run the script CRT_MI_CONNECT_ROLE.SQL.
      This script creates the APM role (MI_CONNECT_ROLE), which contains several of the Oracle privileges that are necessary to run the APM applications. This script does not require any parameters. You will need to run this script one time per database.
    2. Locate and run the script CRT_MI_USER.SQL.
      This script creates the Oracle user, and then grants to the user the role MI_CONNECT_ROLE that you created in the preceding step.

      The schema is created. For example, if you were to define the parameters through the command SQL> @CRT_MI_USER SCHEDULER_PROD SCHEDULER_PROD 1000M SCHEDULER_DATA, it would automatically:

      • Create a user named SCHEDULER_PROD.
      • Set the password for the user to SCHEDULER_PROD.
      • Set the default tablespace for the user to SCHEDULER_DATA.
      • Grant 1GB of quota on the default tablespace.
      Note: This example assumes that the SCHEDULER_DATA tablespace already exists.
    3. Connect as the user, created in the previous step. And then, locate and run the script SCHEDULER.SQL. This script will set up the schema and create the initial data for the scheduler.
  4. On the APM server, navigate to C:\ProgramData\Meridium.
  5. Open the appsettings.Global.json file using a text editor.
  6. Modify the following values:
    1. DatabaseProvider: Set the scheduler service database provider as Oracle.
      "scheduler": {
		// Scheduler service API URL
		"serviceUrl": "http://localhost/meridium/scheduler/",
		// Scheduler service database provider. Valid values are PostgreSQL, SqlServer, Oracle
		"databaseProvider": "Oracle"
	},
    2. connectionStrings: To connect to the Oracle database, enter the connection string. For more details on the connectionString format, refer to the Oracle documentation. The following lines of code show a sample connectingString for the Oracle database. 
      "connectionStrings": {
		// Scheduler service connection string for the above configured DatabaseProvider
		"SchedulerDatabase": "Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST={0})(PORT={1}))(CONNECT_DATA=(SERVICE_NAME={0})));User Id={0};Password={0};",

What To Do Next

Create the Localization Oracle Database

Before you create the Oracle schema that will contain the APM repository, you must install the Database Server software on the APM Database Server machine.

Create an Oracle database that will be used by the APM Localization. You may set the database name as apm_localization. The creation of the Oracle database exceeds the scope of this documentation. For details on creating an Oracle database, consult the documentation that is specific to your database platform.

When the database is created, the database character set must be specified. If you are creating a Unicode database, use the character set AL32UTF8. This is the most recent and recommended Unicode database character set.

What To Do Next

Create the Localization Oracle Schema

About This Task

The following instructions provide details on creating the Localization Oracle schema.

To perform these steps, you will need Oracle DBA privileges on the APM Database Server machine. These instructions assume that:

  • You are logged in to your APM Database Server machine with DBA privileges and have a connection to Oracle.
  • You are familiar with running SQL scripts and the associated terminology.

Procedure

  1. On the APM Server machine, in the APM distribution package, navigate to the Database folder.
  2. Open the file MI_DB_MASTER_<version>.zip, and then extract the contents of the file <version>.zip to a folder on the C: drive.
  3. Open the file <version>.zip, and then open the subfolder _Setup\NewInstall\Oracle.

    This folder contains the extracted files that will need to be run by the database administrator (via the remaining steps). The database administrator will need the following two files, as well as access to the remaining instructions in this topic:

    • CRT_MI_CONNECT_ROLE.SQL
    • CRT_MI_USER.SQL
    1. Locate and run the script CRT_MI_CONNECT_ROLE.SQL.
      This script creates the APM role (MI_CONNECT_ROLE), which contains several of the Oracle privileges that are necessary to run the APM applications. This script does not require any parameters. You will need to run this script one time per database.
    2. Locate and run the script CRT_MI_USER.SQL.
      This script creates the Oracle user, and then grants to the user the role MI_CONNECT_ROLE that you created in the preceding step.

      The schema is created. For example, if you were to define the parameters through the command SQL> @CRT_MI_USER LOCALIZER_PROD LOCALIZER_PROD 1000M LOCALIZER_DATA, it would automatically:

      • Create a user named LOCALIZER_PROD.
      • Set the password for the user to LOCALIZER_PROD.
      • Set the default tablespace for the user to LOCALIZER_DATA.
      • Grant 1GB of quota on the default tablespace.
      Note: This example assumes that the LOCALIZER_DATA tablespace already exists.
  4. Import the Oracle schema that you created in the preceding steps. To do so:
    1. On the APM Server machine, in the APM distribution package, navigate to the C:\Meridium\DbUpg\DBBackupFiles\Oracle folder.
    2. Locate the dump files EXPDP_LOCALIZER_PRODNUMBER.DMP, and then extract and import the contents.
    3. Update the schema statistics.
  5. On the APM server, navigate to C:\ProgramData\Meridium.
  6. Open the appsettings.Global.json file using a text editor.
  7. Modify the following values:
    1. DatabaseProvider: Set the Localization database provider as Oracle.
      "LocalizerDatabase": {
		// Localizer service database provider. Valid values are PostgreSQL, SqlServer, Oracle
		"databaseProvider": "Oracle"}
    2. connectionStrings: To connect to the Oracle database, enter the connection string. For more details on the connectionString format, refer to the Oracle documentation. The following lines of code show a sample connectingString for the Oracle database. 
      "connectionStrings: {
            // Localizer service connection string for the above configured DatabaseProvider
            "LocalizerDatabase": "Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST={0})(PORT={1}))(CONNECT_DATA=(SERVICE_NAME={0})));User Id={0};Password={0};"}

What To Do Next

SQL Server Checklist

The following checklist should be used to install and configure a SQL Server Database Server, create the APM database, and configure the APM Server for use with the SQL Server.

You should complete these steps in relatively the same order in which they are listed in the table.

Step

Task

Notes

1Ensure that the APM Database Server machine meets the system requirements.This step is required.
2On the APM Database Server, install the SQL Server software.This step is required.
3 On the APM Database Server, create the SQL Server database.This step is required.
4On the APM Database Server, configure the SQL Server database.This step is required.
5On the APM Database server machine, Create the SQL Server Scheduler Database.This step is required.
6On the APM Database server machine, Configure the SQL Server Database.This step is required.
7On the APM Database server machine, Create the SQL Server Localization Database.This step is required.
8On the APM Database server machine, Configure the SQL Server Localization Database.This step is required.
9On the APM Server, create an initial data source.This step is required.
10In APM, build the search index.This step is required.

Install the SQL Server Software

About This Task

If you will connect to a SQL Server database, the first step is to install the SQL Server software on the Database Server machine. This documentation assumes that your system meets Database Server system requirements. The installation of the SQL Server software exceeds the scope of this documentation. For information on performing the installation, refer to the SQL Server documentation that is specific to your database server platform.

When you prepare to install SQL Server on the Database Server, you should consider the following notes:

Procedure

  1. APM requires mixed-mode authentication for SQL Server installations. The documentation and scripts provided by GE Vernova assume that the SQL Server instance allows mixed-mode authentication.
  2. The APM database must be owned by the SQL Server login referenced in the APM data source. Being a member of the SQL Server db_owner role is not sufficient. GE Vernova provides a script to properly configure the SQL Server database for use with APM.
  3. The database provided by GE Vernova (via a .bak file) was created with the SQL Server collation Latin1_General_CI_AS.

What To Do Next

About Creating and Configuring the SQL Server Database

After you have installed the SQL Server software on the Database Server machine, you can create the APM database by restoring a database backup file that is provided by GE Vernova. For example, the restore database option in SQL Server Management Studio could be used to create the database. Specific instructions for creating the APM database are not included in this documentation.

After you have created the database, you will need to configure it. To create and configure the APM database, you must have access to:

  • Microsoft SQL Server Management Studio.
  • A privileged SQL Server account with sysadmin rights in the target instance.
  • Two files from the APM distribution package that will be extracted on the APM Server:
    • GE Digital APM, which is included in the file APM in the APM distribution package.

      -and-

    • MI_SQL_DB_Configure.sql, which was extracted from the APM distribution package.

These instructions assume that you are familiar with SQL Server Management Studio or another third-party tool for running SQL scripts.

Note: If you do not have sufficient privileges to restore or configure the database, ask the person responsible for creating the database to create the database and complete the configuration steps. That person will need a copy of these instructions, the BAK file, and the MI_SQL_DB_Configure.sql script.

What To Do Next

Create the SQL Server Database

The following instructions provide details on locating the files that are needed for creating and configuring the SQL Server database. To create the database, you will restore a backup file that is included in your APM distribution package. For example, the restore database option in SQL Server Management Studio could be used to create the database. Specific instructions on creating the SQL Server database are not included in this documentation.

Steps

  1. On the APM Server, access the APM distribution package, and then navigate to the Database folder.
  2. Open the MI_DB_MASTER_<version>.zip file, and then extract the contents of the file to a folder on the C: drive.
    Important: The name of the folder to which you extract the files must not contain any spaces.
  3. Open _Setup\NewInstall\SQLServer, and then locate the MI_<version>.BAK file.
  4. Place the MI_<version>.BAK file in a location where it can be referenced by the SQL Server service, and then restore the file.

    The APM database is created.

What To Do Next

Configure the SQL Server Database

About This Task

The following instructions explain how to configure a SQL Server database for use by APM. These instructions assume that the SQL Server database has already been created by restoring a backup file using SQL Server Management Studio or another third-party tool.

These instructions provide details on configuring the APM SQL Server database using the script MI_SQL_DB_Configure.sql, which is included in your APM distribution package. This script ensures that the database will be properly configured for use with APM.

When you run the script MI_SQL_DB_Configure.sql, the following database settings will be configured automatically:

  • The database will be set to read/write mode.
  • The database will be configured to allow multiple users.
  • The database will be set to Full recovery mode.
  • A SQL Server login will be created, and this login will own the database.
  • The SQL Server database name, SQL Server login name, and password will all match.
Note: Because of an update in a third-party application, the SQL client uses encryption by default. If your database is encrypted, in the C:/ProgramData/Meridium/AppSettings.Global.json file, set the sqlEncrypt parameter as follows:
sqlEncrypt = configuration.GetValue("sqlServer:encrypt", true);

Procedure

  1. Open a SQL Server Management Studio query window that is connected via a privileged login.
  2. Open the file MI_SQL_DB_Configure.sql, and then copy its contents into the SQL Server Management Studio query window.
  3. Set the @dbname variable to the name of the APM SQL Server database that you created.
  4. Execute the edited script.
  5. As needed, use SQL Server Management Studio to modify the password. These are the same login credentials that will be used when you create the APM data source that will connect to this database.
  6. Create the custom server-level error messages, which are required by the APM system. These error messages must be created at the instance level. Creating them requires a privileged login assigned to either the System Administrator (sysadmin) or Server Administrator (serveradmin) fixed server roles. To create the APM error messages:
    1. Make sure that you are connected to the Database Server with SQL Server Management Studio as a System Administrator or Server Administrator user
    2. Execute the stored procedure MI_ERRORS_CRT_ALL_MSGS. This procedure was supplied with the APM database and can be executed by using the command exec <databasename>..MI_ERRORS_CRT_ALL_MSGS, where <databasename> is the name of the database you created in the preceding steps.

What To Do Next

Create the SQL Server Scheduler Database

Create SQL Server database that will be used by the APM Scheduler. You may set the database name as apm_scheduler. The creation of the SQL Server database exceeds the scope of this documentation. For details on creating an SQL Server database, consult the documentation that is specific to your database platform.

What To Do Next

Configure the SQL Server Scheduler Database

About This Task

The following instructions explain how to configure a SQL Server database for use by APM Scheduler. These instructions assume that the SQL Server database has already been created by restoring a backup file using SQL Server Management Studio or another third-party tool.

Procedure

  1. Create an empty database with username. You may set the database name as apm_scheduler.
  2. Run MI_SQL_DB_Configure.sql to configure the database (password).
  3. Open a SQL Server Management Studio query window that is connected via a privileged login.
  4. Open the APM distribution package and navigate to the Database folder.
  5. Open the file MI_DB_MASTER_<version>.zip, and then extract the contents of the file <version>.zip to a folder on the C: drive.
  6. Open the file <version>.zip, and then open the subfolder _Setup\NewInstall\SQLServer.
  7. Execute the Scheduler.sql script. This script will create the required objects for APM Scheduler.
  8. On the APM server, navigate to C:\ProgramData\Meridium.
  9. Open the appsettings.Global.json file using a text editor.
  10. Modify the following values:
    1. DatabaseProvider: Set the scheduler service database provider as SqlServer.
      "scheduler": {
		// Scheduler service API URL
		"serviceUrl": "http://localhost/meridium/scheduler/",
		// Scheduler service database provider. Valid values are PostgreSQL, SqlServer, Oracle
		"databaseProvider": "SqlServer"
	},
    2. connectionStrings: To connect to the SQL Server database, enter the connection string. For more details on the connectionString format, refer to the SQL Server documentation. The following lines of code show a sample connectingString for the SQL Server database. 
      "connectionStrings": {
		// Scheduler service connection string for the above configured DatabaseProvider
		"schedulerDatabase": "DATABASE={2};SERVER={3};UID={0};PASSWORD={1};MultipleActiveResultSets=true;Max Pool Size=1000;Encrypt=false;",

Create the SQL Server Localization Database

Create SQL Server database that will be used by the APM Scheduler. Name the database as apm_localization. The creation of the SQL Server database exceeds the scope of this documentation. For details on creating an SQL Server database, consult the documentation that is specific to your database platform.

What To Do Next

Configure the SQL Server Localization Database

About This Task

The following instructions explain how to configure a SQL Server database for use by APM Localization. These instructions assume that the SQL Server database has already been created by restoring a backup file using SQL Server Management Studio or another third-party tool.

Procedure

  1. Open a SQL Server Management Studio query window that is connected via a privileged login.
  2. Open the APM distribution package and navigate to the C:\Meridium\DbUpg\DBBackupFiles folder.
  3. Open the subfolder \SQL.
  4. Restore database using the backup file apm_localization.bak. This database includes the required objects for APM localization.
  5. Run MI_SQL_DB_Configure.sql to configure the database (password).
  6. On the APM server, navigate to C:\ProgramData\Meridium.
  7. Open the appsettings.Global.json file using a text editor.
  8. Modify the following values:
    1. DatabaseProvider: Set the Localization database provider as SqlServer.
      "localizer": {
		// Localizer service database provider. Valid values are PostgreSQL, SqlServer, Oracle
		"databaseProvider": "SqlServer"}
    2. connectionStrings: To connect to the SQL Server database, enter the connection string. For more details on the connectionString format, refer to the SQL Server documentation. The following lines of code show a sample connectingString for the SQL Server database. 
      "connectionStrings": {
            // Localizer service connection string for the above configured DatabaseProvider
            "LocalizerDatabase": "DATABASE={2};SERVER={3};UID={0};PASSWORD={1};MultipleActiveResultSets=true;Max Pool Size=1000;",}