Deploy Policy Designer

Deploy Policy Designer

The checklists in this section of the documentation contain all the steps necessary for deploying and configuring this module whether you are deploying the module for the first time or upgrading from a previous module.

Deploy Policy Designer 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 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.

If you are deploying this module in APM Now, before you begin completing these tasks, review the system requirements for this module to identify the supported features for this module in APM Now . Unless noted, all deployment tasks in the following table are applicable for the deployment of this module in APM Now.

Results

StepTaskNotes
1Assign Security Users to one or more of the Policy Designer Security Groups and Roles.This step is required.
2Review the Policy Designer data model to determine which relationship definitions you will need to modify to include your custom equipment and location families. Via Configuration Manager, modify the relationship definitions as needed.

This step is required only if you store equipment and location information in families other than the baseline Equipment and Functional Location families.

3

On the GE Digital APM Server, start the Policy Execution Service.

This step is required. If your system architecture contains more than one GE Digital APM Server, you must complete this step for every server in the load-balanced cluster that you want to use for policy execution.

You may review the log files for this service at C:\ProgramData\Meridium\Logs.

4On the GE Digital APM Server, start the Policy Trigger Service.

This step is required.

If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

You may review the log files for this service at C:\ProgramData\Meridium\Logs.

5On the GE Digital APM Server, reset IIS. This step is required.
6On the GE Digital APM Process Data Integration Server, start or restart the Process Data Integration Service. This step is required only if you want to use OPC Tag records in your policies.

Upgrade or Update Policy Designer to V4.3.0.6.0

Before you begin

The following tables outline the steps that you must complete to upgrade this module to V4.3.0.6.0. 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.

If your system architecture contains multiple servers to process policy executions, these steps assume that you have configured them according to your company's preference for server load-balancing.

Procedure

  • Upgrade from any version V4.3.0.0.0 through V4.3.0.5.2
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V4.2.0.0 through V4.2.0.9.2
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V4.1.0.0 through V4.1.7.4.0
    StepTaskNotes
    1

    If you are upgrading from V4.1.5.x and you used Policy Recommendations for the first time in V4.1.5.x, after you upgrade your database, use the State Management option in the Revert to Baseline feature to apply the correct State Configuration for the Policy Recommendation Family.

    When you do so, you will need to provide mappings from the incorrect states to the corresponding correct states, as shown in the following table:

    Custom (incorrect)

    Baseline (correct)

    Accepted by ASM

    Completed

    Closed

    Completed

    Consolidated

    Superseded

    Open

    Proposed

    Pending

    Pending Approval

    Superseded

    Superseded

    This step is necessary because an incorrect baseline State Configuration was delivered for the Policy Recommendation family in V4.1.5.0. The baseline configuration was corrected in V4.1.6.0.

    The correct baseline state configuration must be applied for various queries and lists in GE Digital APM to function as expected.

    You do not need to complete this step if:

    • You never used V4.1.5.x

      -or-

    • You never used Policy Recommendations

      -or-

    • You used Policy Recommendations in a version prior to V4.1.5.x
    2On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    3

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    4

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    5On the GE Digital APM Server, reset IIS.This step is required.
    6

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    7

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V4.0.0.0 through V4.0.1.0
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V3.6.1.0.0 through V3.6.1.7.1
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V3.6.0.0.0 through V3.6.0.12.8
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V3.5.1 through V3.5.1.12.3
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V3.5.0 SP1 LP through V3.5.0.1.10.1
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V3.5.0 through V3.5.0.0.7.1
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

  • Upgrade from any version V3.4.5 through V3.4.5.0.1.4
    StepTaskNotes
    1On the GE Digital APM Server, start or restart the Policy Execution Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    2

    If your system architecture contains more than one GE Digital APM Server, you must configure the Policy Trigger Service on each server to specify the name of the load-balanced server cluster that you want to use for policy execution.

    This step is required.

    3

    Start or restart the Policy Trigger Service.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    4On the GE Digital APM Server, reset IIS.This step is required.
    5

    On the Process Data Integration Server, start (or restart if it is already started) the Meridium Process Data Integration Service.

    This step is required only if you want to use OPC Tag records in your policies.
    6

    Review the Policy Upgrade Utility log files, and, as needed, manually update policy schedules.

    This step is required.

    You may review the log files for this service at C:\ProgramData\Meridium\Logs.

    If your database contained policies with execution schedules containing invalid times for the most recent Next Date or Last Date (for example, between 2:00 A.M. and 3:00 A.M. on the morning of daylight savings time), these fields were left blank during the upgrade. To ensure that your scheduled policies execute as expected, review the log, and update policy schedules in Policy Designer as needed.

About the Asset Health Services

When you deploy the Asset Health Manager, Process Data Integration, and Policy Designer modules together, the services used by each module interact with each other in various ways. This topic summarizes those services and describes a standard system architecture containing the components used by all three modules.

Services Summary

The following services are used by the Asset Health Manager, Process Data Integration, and Policy Designer modules:

  • Asset Health Indicator Service: Automatically updates the following field values in a Health Indicator record when reading values related to the health indicator source record (for example, an OPC Tag or Measurement Location record) change:
    • Alert Level
    • Last Reading Date
    • Last Char Reading Value (for records that accept character values)
    • Last Numeric Reading Value (for records that accept numeric values)

    This service also facilitates the automatic creation of Health Indicator records for configured sources.

  • Policy Trigger Service: When an input to a policy (that is, an associated record in the GE Digital APM database or reading value in the process historian) changes or when a policy schedule is due, a message is added to the policy trigger queue. The Policy Trigger Service monitors the trigger queue. When it receives a message, it determines which policy instances should be executed for the message, and then it sends corresponding messages to an appropriate policy execution queue.
  • Policy Execution Service: The Meridium Policy Execution Service handles the execution of policies. Specifically, the Policy Execution Service monitors a corresponding policy execution queue and executes the policy instances that are added to it.
  • Process Data Integration (PDI) Service: Monitors the subscribed tags (that is, tags that are used in policies and health indicators or tags for which readings are being stored in the GE Digital APM database) and, when data changes occur on these tags, adds messages to the appropriate queues. This service also facilitates the automatic import and synchronization of tags from a configured process historian. For more information, refer to the PDI Services section of the documentation.

Standard System Architecture Configuration

The following diagram illustrates the machines in the GE Digital APM system architecture when the Policy Designer, Process Data Integration (PDI), and Asset Health Manager (AHM) modules are used together. This image depicts the standard configuration, where the OPC Server software and the Process Data Integration Service are on the same machine.

Note: In this example configuration, only one machine of each type is illustrated. Your specific architecture may include multiple GE Digital APM Servers, multiple OPC Servers, or multiple GE Digital APM Servers used for policy executions.

The following table summarizes the machines illustrated in this diagram and the software and services that you will install when you complete the first-time deployment steps for Asset Health Manager, Process Data Integration, and Policy Designer.

MachineSoftware InstalledAsset Health Service Installed Automatically with Service Software
GE Digital APM Server

GE Digital APM  Server software

Asset Health Indicator Service
Policy Trigger Service
Policy Execution Service
Process Data Integration Server, which also acts as the OPC ServerProcess Data Integration Service softwareProcess Data Integration Service
OPC Server softwareN/A
Process HistorianProcess historian softwareN/A

About Configuring Policy Execution

Policy designers can configure a policy to be executed on a schedule or automatically when records or reading values associated with the policy are updated. This topic describes the ways that the items configured in the first-time deployment workflow facilitate each type of policy execution.

Note: Only the active instances of active policies are executed.

Automatic Execution

When records or reading values associated with the policy are updated, the GE Digital APM Server adds messages to the policy trigger queue. The Policy Trigger Service monitors the trigger queue. When it receives a message, it determines which policy instances should be executed for the message, and then it sends corresponding messages to an appropriate policy execution queue. Finally, the corresponding Policy Execution Service executes the policies associated with the records or reading values that were updated.

Scheduled Execution

When a policy is due, the scheduled job adds a message to the policy trigger queue. The Policy Trigger Service monitors the trigger queue and sends messages to the appropriate policy execution queue. Finally, the corresponding Policy Execution Service executes the policies that are due.

Configure the Policy Trigger Service

Procedure

  1. On the GE Digital APM Server, navigate to the folder where the Policy Trigger Service files are installed. If you installed the software in the default location, you can locate this file in the folder C:\Program Files\Meridium\Services.
  2. Open the file Meridium.Policies.Service.exe.config in an application that you can use to modify XML (for example, Notepad).
  3. Within the <executionServers> tags, locate the following text: <add url="http://localhost/Meridium" />
  4. Within the add url attribute, choose one of the following:
    • If you have only one GE Digital APM Server in your system architecture, accept the default value (that is, localhost).
    • If you have more than one GE Digital APM Server in your system architecture, replace localhost with the name of the server cluster that you want to use for policy executions.
  5. Save and close the file.
    Your settings will be applied when the Policy Trigger Service is started or restarted.

Configure Multiple GE Digital APM Servers for Policy Execution

Depending on the number of policies that you need to manage in your system, you may have multiple GE Digital APM Servers to process policy executions. Based on your company’s preference for server load balancing, you can configure your GE Digital APM System Architecture using global load balancing or isolated load balancing.

Regardless of the approach you use, you must fully configure each GE Digital APM Server according to the steps for deploying the basic GE Digital APM system architecture. In addition, each GE Digital APM Server must be configured to use the same instance of Redis.

Global Load Balancing

In global load balancing, you configure all GE Digital APM Server(s) to process policy executions in a single load-balanced cluster. In this scenario, an increase in activity from any server can be absorbed across all servers in your system architecture. Because there is only one cluster to manage in this scenario, this is the simpler configuration to set up and manage.

In this scenario, you must:

Isolated Load Balancing

In isolated load balancing, you configure designated GE Digital APM Server(s) to process policy executions in a separate load-balanced cluster from other GE Digital APM Server(s). In this scenario, the policy execution processes are isolated from the GE Digital APM Server processes, therefore preventing an increase in activity in one cluster from negatively impacting the processes of the other.

In this scenario, you must:

  • Configure the Policy Trigger service on all GE Digital APM Servers to specify the name of the cluster used for policy executions.

  • Start the Policy Execution Service on only the GE Digital APM Servers in the cluster designated to process policy executions.