Deployment

Upgrade or Update GE Analytics to GE Digital APM

Before you begin

The following tables outline the steps that you must complete to upgrade this module to GE Digital APM GE Digital APM. These instructions assume that you have completed the steps for upgrading the basic GE Digital APM system architecture.

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

Procedure

Deploy GE Analytics for the First Time

Before you begin

The following table outlines the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic GE Digital APM system architecture.

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

This GE Digital APM module is not available in the APM Now environment.

Results

Step

Task

Notes

1

Assign Security Users to one or more of the GE Analytics Security Groups and Roles.

This step is required.

2

 Modify the file Meridium.AMQP.Service.exe.config to configure the RabbitMQ connection.This step is required.

3

Restart the AMQP Service.This step is required.
4 Install GE System 1 Integration Service.This step is required.

5

Create and configure the GE Connection record to connect to the GE Message Broker Server.

This step is required.

6

Modify the file Meridium.GE.Service.exe.config to configure the GE Service.

This step is required.

7

Configure the GE Service to restart automatically.

This step is required.

8

Start the GE Service.

This step is required. Once the GE Service is started, the GE Enterprise hierarchy will import automatically into the GE Digital APM database.

9

Configure GE Enterprise and Filter records .

This step is required. These records are created automatically by the GE Service.

10

Stop and then start the GE Service.

This step is required.

11

Link tags to assets (i.e., equipment and functional locations) .

This step is required. You must repeat this step for any GE Tags records that are imported from your GE system. New tags are imported automatically.

12

Import the GE Analytics policies.

This step is required only if you want to use GE policies.

Modify the File Meridium.AMQP.service.exe.config

Procedure

  1. On your GE Digital APM Server, navigate to the folder where the Meridium.AMQP.service.exe.config is installed. If you installed the software in the default location, you can locate this file in the following location: C:\Program Files\Meridium\Services.
  2. Open the file Meridium.AMQP.service.exe.config in an application that you can use to modify XML script (e.g., Notepad).
  3. Within the <apmMqConnections> tags, uncomment the example connection tag by deleting <!--EXAMPLE: and the corresponding --> from the beginning and end of the string.
  4. Within the <apmMqConnections> tags, configure the attributes, by replacing the values within the quotation marks with the values detailed in the following chart.
    Note: The heartbeat attributes should not be edited.

    Attribute

    Replace text...

    ... with the following values:

    		Notes

    server key

    KEY

    A unique connection key.

    		If there are multiple server entries containing the same key in the configuration file, the last defined server entry is used and all others with the same key are removed when the service starts.

    host

    ENTER_BROKER_HOSTNAME

    The host name of the GE Fleet Message Broker.

    		If there are multiple server entries containing the same host name in the configuration file, the last defined server entry is used and the other host names with the same key will be logged as errors in the service log file.
    port5672

    The appropriate port for your configuration.

    • The default SSL port is 5671.
    • The default HTTP port is 5672, and is the port preconfigured in the config file.
    		None

    user

    ENTER_MQ_USER_NAME

    The user name for the RabbitMQ Message Broker.

    		This field is not required if using SSL to connect to the message broker.

    password

    ENTER_MQ_PASSWORD

    The password for the RabbitMQ Message Broker.

    This field is not required if using SSL to connect to the message broker.

    Note: Do not delete the ! in front of the password. This symbol is not part of the password itself. Instead, this symbol will cause the password to be encrypted automatically when the service is restarted.

Results

Your settings will be applied when you start or restart the Meridium AMQP Service.

Install the GE System 1 Integration Service

Procedure

  1. On GE Enterprise Impact 17.1 SP1 Message Server, access the GE Digital APM distribution package, and then navigate to the folder \\Setup\Meidium Enterprise APM Server and Add-ons.
  2. Double-click the file Setup.exe.

    The Welcome screen appears.

  3. Select Next.

    The License Agreement screen appears.

  4. Read the License Agreement, and, if you agree, select the I accept the terms of the license agreement check box. Then, select Next.

    The Select Installation Location screen appears.

  5. Select Next to accept the default location.

    The Select the features you want to install screen appears.

  6. Select the Meridium GE System 1 Integration Service option.
    Note: While additional options are available for selection, these options are not meant to be installed on the Meridium Integration Service server. These instructions assume that you want to install only the Meridium Integration Service software. When this software is installed, the APM System Administration tool will also be installed automatically.
  7. Select Next.

    The Complete the Installation screen appears.

  8. Select Install.

    The Installation is Complete screen appears.

  9. Select Finish.

Results

The GE System 1 Integration Service is installed.

Modify the File Meridium.GE.Service.exe.config

Procedure

  1. On the machine on which you are configuring the Meridium GE Service, navigate to the folder where the Meridium GE Service is installed. If you installed the software in the default location, you can locate this file in the following location: <root:>\Program Files\Meridium\Services.
  2. Open the file Meridium.GE.Service.exe.config in an application that you can use to modify XML script (e.g., Notepad).
  3. In the file, within the <configuration> tags, locate the following text:

    <apmMqConnections>

  4. Within the <apmMqConnections> tags, uncomment the example connection tag by deleting <!--EXAMPLE: and the corresponding --> from the beginning and end of the string.
  5. Within the <apmMqConnections> tags, configure the attributes, by replacing the values within the quotation marks with the values detailed in the following chart.
    Note: The heartbeat attributes should not be edited.

    Attribute

    Replace text...

    ... with the following values:

    		Notes

    server key

    KEY

    A unique connection key.

    		If there are multiple server entries containing the same key in the configuration file, the last defined server entry is used and all others with the same key are removed when the service starts.

    host

    ENTER_BROKER_HOSTNAME

    The host name of the GE Fleet Message Broker.

    		If there are multiple server entries containing the same host name in the configuration file, the last defined server entry is used and the other host names with the same key will be logged as errors in the service log file.
    port5672

    The appropriate port for your configuration.

    • The default SSL port is 5671.
    • The default HTTP port is 5672, and is the port preconfigured in the config file.
    		None

    user

    ENTER_MQ_USER_NAME

    The user name for the RabbitMQ Message Broker.

    		This field is not required if using SSL to connect to the message broker.

    password

    ENTER_MQ_PASSWORD

    The password for the RabbitMQ Message Broker.

    This field is not required if using SSL to connect to the message broker.

    Note: Do not delete the ! in front of the password. This symbol is not part of the password itself. Instead, this symbol will cause the password to be encrypted automatically when the service is restarted.
  6. If you are using SSL configuration, configure the attributes, by replacing the values within the quotation marks with the values detailed in the following chart.

    Attribute

    Replace text...

    ... with the following values:

    		Notes

    sslEnabled

    FALSE

    TRUE

    		None

    sslServerName

    SSL_SERVER_NAME

    The Common Name (CN) where the SSL certificate stored.

    		Typically, this is the host name of the server to which this client will connect.

    sslCertPassPhrase

    SSL_CERT_PASSWORD

    SSL certificate password.
    Note: Do not delete the ! in front of the password. This symbol is not part of the password itself. Instead, this symbol will cause the password to be encrypted automatically when the service is restarted.

    sslCertPath

    PATH_TO_CERT

    File path to the directory where the SSL certificate is stored.

    The SSL certificate is not supplied by GE Digital APM It should be obtained from a third-party certificate authority.

    tlsVersions1.2

    The desired encryption algorithm.

    • The default value is 1.2.
    • Alternatively, to support multiple algorithms, you can enter multiple values, and then separate the values with a semicolon.
    		Only tls1.1 and tls1.2 versions are supported.
  7. Within the <meridiumconnections> tags, uncomment the example connection tag by deleting <!--EXAMPLE: and the corresponding --> from the beginning and end of the string.
  8. Within the <meridiumconnections> tags, configure the attributes by replacing the values within the quotation marks with the values detailed in the following chart.

    Attribute

    Replace text...

    ... with the following values:

    		Notes

    name

    NAME

    A name to identify the connection to the database.

    		This value is used only by the configuration file.
    apmMqKeyKEYThe key of the apmMqConnection to use for this connection.The key must match at least one of the defined keys in the apmMqConnection section.
    applicationServerENTER_APP_SERVERThe name of the GE Digital APM server.None

    datasource

    DATA_SOURCE

    The name of the GE Digital APM data source to which you want to connect.

    		The data source value is case sensitive and should be typed exactly as it is defined for the GE Digital APM Server in the Data Sources section of Operations Manager.

    userId

    ENTER_USER

    The User ID of the Security User whose credentials should be used to log in to the specified GE Digital APM database.

    		None

    password

    ENTER_PASS

    The password for the specified user.
    Note: Do not delete the ! in front of the password. This symbol is not part of the password itself. Instead, this symbol will cause the password to be encrypted automatically when the service is restarted.

Results

Your settings will be applied when you start or restart the Meridium GE Service.

Import the GE Policies

About this task

The following instructions explain how to import Policy records that can be used in GE Analytics. These instructions assume that you have already installed the GE Digital APM Server software.

Procedure

Using the Import and Export tool , import the following XML files, one at a time:
  • GE Event Response.xml
  • PLA_Policy.xml

These files are located in following location on the GE Digital APM Server machine: C:\Meridium\DbUpg\MI_DB_Master_<DatabaseVersion>.ZIP\<DatabaseVersion>\_IEU_ManualImports\Policy Records, where <DatabaseVersion> is the database version that is currently installed.

The following policies are now available in GE Digital APM.

Create a GE Connection Record

About this task

You can use the GE Connection section of the GE Connection workspace to create a GE Connection record.

Note: There can only be one GE Connection per GE Digital APM System.

Procedure

  1. In the module navigation menu, select Admin > Operations Manager > Connections.
  2. Select GE Connection.
  3. In the Connection subsection, populate the following fields on the GE Connection record.
    • Server
    • Login
    • Security Token
      Note: To populate the Security Token field, you must upload a security token file.
    • Heartbeat
  4. To use an SSL Connection, select the Use SSL check box, and then complete the following SSL configuration fields on the GE Connection record.
    • SSL Server
    • SSL Certificate
    • SSL Passphrase
  5. Select .
    The GE Connection record is created.

Results

  • Your GE system and GE Digital APM system are connected and data can be passed from one system to the other.
  • If the Meridium GEService is running, GE Enterprise records are imported automatically.

Configure GE Enterprise and Filter Records

Procedure

  1. In the module navigation menu, select Admin > Operations Manager > Connections.
  2. Select GE Connection.
  3. Select the GE Enterprises tab.
    The GE Enterprises section appears.
    Note: GE Enterprise records are imported automatically after the GE Connection record is configured.
  4. Select the GE Enterprise record
  5. To enable integration between your GE system and GE Digital APM, select the Enable check box.
  6. In the GE Filters section, select , and then add at least one GE Filter record.
    Note: GE Filter records are used to filter GE Tag records to import only those where the type of the event matches a regular expression in the Event Type field on a GE Filter record. A single GE Filter record with the regular expression .* will allow all events to be imported into the GE Digital APM database.
  7. Repeat these steps for each GE Enterprise record that you want to use in GE Digital APM.

Results

Once the GE Connection record is created and the GE Enterprise records (imported by the service) are correctly configured, GE Tag records are created automatically.

Populate Security Token

Procedure

  1. Access GE Connection record for which you want to populate the Security Token field by uploading a file.
    The GE Connection record appears.
  2. In the Connection section, select the white space in the Security Token field.
    The Upload Security Token window appears.
  3. Select Choose File, and select the security token file to be uploaded.
    Note: The security token file is supplied by the GE system. During the GE Fleet installation, a default security token file is created (the default file can be used as a template to create a custom file), and it should be placed in a location from which it can be uploaded into GE Digital APM.
  4. Select Upload.
    The security token is decrypted by GE Digital APM, and then populated as masked, plain-text in the Security Token field.
  5. Select Save.
    The security token is encrypted again, and then committed to the GE Digital APM server where it can be accessed by GE Digital APM and the GE Fleet message broker to facilitate data transfers.