Policy Designer Deployment

Deploy Policy Designer for the First Time

The following table outlines the steps that you must complete to deploy and configure this module for the first time.

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.

Important: The Policy Execution Service uses the MIJOB user account. MIJOB should be a Super User, and should have its time zone set to UTC. Any modifications to the security privileges of the MIJOB user account may lead to failure of the Policy Execution Service.
Table 1. Procedure
StepTaskNotes
1Assign Security Users to one or more of the Policy Designer Security 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, and as needed, modify the relationship definitions using Configuration Manager.

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

3Configure Alternative Query for Policy OverviewThis step is optional. The alternative query provides additional information on the most recent execution of each policy but may impact performance.
4Configure Python Analytic Template for PoliciesThis step is optional. You must complete this step before using the Python Script node in Policy Designer or Family Policies.
5Configure permissions for the policy integration userThis step is optional. You must complete this step before using the Python script node in Policy Designer or Family Policies.

Configure Alternative Query for the Policy Designer Overview Page

About This Task

To optimize the performance of the Policy Designer Overview page in the systems with a large volume of policy execution history records, the Policies tab displays a simplified view which does not display the latest policy execution results. If you want to see the latest results in the Policies list, you can configure the Policy Designer Overview page to use the alternative query (Policy Overview – Policies Alternate Query) that is provided in the APM Catalog.
Note: When you configure an alternative query for Policy Designer Overview page, you might face some performance issues.

Procedure

  1. Access APM using the super user account.
  2. Access the Catalog page.
  3. In the Catalog section, select Public > Meridium > Modules > Policy Manager > Queries.
    The Queries workspace appears, displaying the catalog items of the Queries folder in a table.
  4. Select the check box corresponding to the Policy Overview – Policies query.
  5. In the same row, select .
    The Catalog Item Properties window appears, displaying the properties of the Policy Overview – Policies query.
  6. In the Name box, modify the value to rename the query.
  7. Select Done.
    The Policy Overview – Policies query is renamed.
  8. Select the check box corresponding to the alternative query (Policy Overview – Policies Alternate Query).
  9. In the same row, select .
    The Catalog Item Properties window appears, displaying the properties of the alternative query.
  10. In the Name box, delete the existing value, and then enter Policy Overview – Policies.
  11. Select Done.
    The alternative query is configured for the Policy Designer Overview page.

Configure Python Analytic Template for Policies

Before You Begin

Before you use the Python Script node in Policy Designer or Family Policies, in the Analytics module, you must deploy an Analytic Template that allows the policy execution service to execute Python script. Once the Analytic Template is successfully deployed, you must update the policy configuration with the analytic ID.

You must have the following permissions to create the Python Analytic Template and update Policy configuration:

  • Analytics
    • GEDCR
    • View Analytics
    • View Deployments and Filters
    • Manage Analytics Configurations
    • View Analytics Configurations
    • Manage Analytics
  • Policies
    • MI Policy Admin

About This Task

Complete these steps to configure Python Analytic Template.

Procedure

  1. Download the Python analytic from the GE Vernova Customer Portal. See KBA Article 000068934.
  2. Follow the steps in Add an Analytic Template to create a new Analytic Template, using the following input values.
    1. For RUNTIME TYPE select GEDCR.
    2. In the drop-down list box, select DATA FRAME TYPE.
    3. Upload the Python Analytics template .zip file.
    The new template is listed in the Analytics Templates workspace. Before proceeding, confirm that the publish status of the new template is updated to Published. This typically takes 10 minutes.
  3. Select the name of the template you added in step 2.
    The Analytics Details page is displayed.
  4. Select Test Analytic.
  5. Enter any text, for example ‘demo’, in the INPUT DATA box and select Submit.
    The result of the analytic execution, which is an error message, is displayed in the RESULT box.
  6. In the RESULT box, highlight and copy the analytic ID (excluding quotation marks), that is, the value labeled analyticID as shown in the following image.

  7. Access the Policy Admin page.
  8. In the Analytics Configuration workspace, paste the analytic ID in the Python Analytic ID box.
  9. Select Save.
    The Python analytic template for policies is deployed.

Configure Permissions for Policy Integration User

Before You Begin

Before you use the Python node in Policy Designer or Family Policies, you must provide additional permissions to the Policy Integration User. In most tenants, the Policy Integration User is pre-provisioned automatically, with user name apm-policyuser.<n>.<tenantID>. This user usually has one pre-assigned permission set, APM OT Connect Functional User, which is not editable. You must assign an additional permission set for analytics.

About This Task

Procedure

  1. Follow the steps in Create a Permission Set to add a new Permission Set with the following permissions.
    • Analytics
      • Analytics
      • GEDCR
      • View Analytics
      • View Deployments and Filters
      • Manage Analytics Configurations
      • View Analytics Configurations
      • Manage Analytics
      • Manage Deployments and Filters
  2. Follow the steps in Add Assets to Users and Add Assets to Groups to enable the Permission Set you created in step 1 to the Policy Integration User for All Resources in the tenant.