Policy Designer
Total Page:16
File Type:pdf, Size:1020Kb
Policy Designer © 2021 General Electric Company Contents Chapter 1: Overview 1 Overview of the Policy Designer Module 2 Access the Policy Designer Overview Page 2 Policy Designer Workflow 3 Chapter 2: Workflow 5 Policy Designer: Design Policy Workflow 6 ASM (Asset Strategy Management) 6 Create / Modify Policy? 7 Other Workflows 7 Design Policy 7 Validate Ad Hoc 7 Define Execution Settings 8 Activate Policy 8 Add / Edit Instances 8 Validate Instances 8 Activate Instances 8 Execute Policy 9 Review Policy Execution History 9 Policy Designer: Execute Policy Workflow 9 Start 10 Retrieve Notification from Trigger Queue 10 Add Instance to Policy Execution Queue 11 Retrieve Instance Message from Execution Queue 11 Retrieve Instance Execution Data 11 Execute Instance 11 GE Digital APM Records 11 Other Workflows 12 Chapter 3: Policy Management 13 ii Policy Designer About Policies 14 About Module Workflow Policies 15 Dates and Times Displayed in Policy Designer 16 Create a New Policy 16 Access a Policy 17 Take Ownership of a Policy 18 Copy a Policy 18 Refresh Metadata for Policies 19 Delete a Policy 20 Revert a Module Workflow Policy to the Baseline Version 20 Chapter 4: Security Settings 21 Configure Security Settings for a Policy 22 Modify or Remove Security Settings for a Policy 25 Chapter 5: Policy Models 26 Policy Model Basic Principles 27 Add Nodes to the Model Canvas 30 Enable Grid in Model Canvas 32 Connect Nodes in a Policy Model 33 Configure Node Properties 34 Define Input Values 35 Configure Logic Paths 37 Copy and Paste Nodes and Connections 39 Download Image of Policy Model 40 Chapter 6: Policy Instances 41 About Primary Records and Primary Nodes 42 Specify the Primary Node in a Policy Model 45 Create a Policy Instance 45 Create a New Health Indicator Record from the Instances Pane 48 Configure OT Connect Tag Limits from the Instances Pane 49 Activate or Deactivate a Single Policy Instance 50 Activate or Deactivate All Policy Instances Associated with a Policy 51 iii Export Policy Instances 52 Delete a Policy Instance 53 Chapter 7: Policy Logic Validation 54 About Validating the Policy Logic 55 Validate Policy Logic Using Ad Hoc Test Values 55 Validate Policy Logic Using Policy Instance Values 56 Chapter 8: Policy Execution 59 About Policy Execution 60 About Active Policies and Policy Instances 62 Configure Scheduled Execution 62 Configure Automatic Execution 64 Execute an Active Instance Manually 64 Execute all Active Instances Manually 65 Activate or Deactivate a Policy 66 Configure Policy Execution History Log Setting 66 Access Execution History 67 Chapter 9: Admin 69 Access the Policy Admin Page 70 Configure Execution History Retention Settings 70 Chapter 10: Data Loader 72 About the Policy Instance Data Loader 73 About the Policy Instance Data Loader Requirements 73 About the Policy Instance Data Loader Data Model 73 About the Policy Instance Data Loader General Loading Strategy 74 About the Policy Instance Data Loader Workbook Layout and Use 74 Example Policy Instance Data Loader Workbook 79 About the Policy Instance Data Loader Load Verification 79 Chapter 11: Deployment 81 Deploy Policy Designer 82 iv Policy Designer Deploy Policy Designer for the First Time 82 Upgrade Policy Designer 82 About Policy Execution 83 Configure Queue Settings for Policy Execution Service 84 Configure Queue Settings for Policy Trigger Service 84 Configure the Time Limit for Policy Execution 85 Configure Execution Time Out Value for Math Node 86 Configure Alternative Query for the Policy Designer Overview Page 86 Chapter 12: Reference 88 General Reference 89 Family Field Descriptions 104 Catalog Items 111 Policy Examples 113 Input Nodes 131 Condition, Logic, and Calculation Nodes 148 Action Nodes 196 Baseline Policies 258 Glossary 260 Chapter 13: Release Notes 261 Second Quarter of 2021 262 First Quarter of 2021 262 Fourth Quarter of 2020 263 Second Quarter of 2020 266 Fourth Quarter of 2019 269 Third Quarter of 2019 270 Second Quarter of 2019 274 First Quarter of 2019 276 Fourth Quarter of 2018 283 Third Quarter of 2018 285 v Copyright GE Digital © 2021 General Electric Company. GE, the GE Monogram, and Predix are either registered trademarks or trademarks of All other trademarks are the property of their respective owners. This document may contain Confidential/Proprietary information of and/or its suppliers or vendors. Distribution or reproduction is prohibited without permission. THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION OR WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHER LIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLY DISCLAIMED. Access to and use of the software described in this document is conditioned on acceptance of the End User License Agreement and compliance with its terms. vi © 2021 General Electric Company Chapter 1 Overview Topics: • Overview of the Policy Designer Module • Access the Policy Designer Overview Page • Policy Designer Workflow © 2021 General Electric Company 1 Overview of the Policy Designer Module Traditionally, many companies attempt to improve equipment and location performance by identifying historical trends and using them to define future actions. For example, the results of a Reliability Distribution Analysis may indicate that a type of equipment fails about every six months, so a strategy might be implemented to replace equipment of that type every five months (that is, one month prior to the next predicted failure). In reality, however, some equipment of that type could last longer than six months (for example, for eight months), and in these cases, replacing the equipment too early would result in unnecessary costs. Waiting until the equipment fails, however, is also not the best plan. The objective of Policy Designer is to develop and execute strategies based upon historical data and dynamic data, which is obtained by monitoring conditions in real time. Using Policy Designer, you can define policies that: • Retrieve information about current conditions. • Allow you to identify emerging trends of equipment performance. • Apply some logic to that data based on historical trends. • Initiate actions that will mitigate future risk. More Details An engineer might know that when a motor reaches 200 degrees, it will begin to fail. Historical data might also tell him that the same motor operating continuously will overheat about every three months. Rather than implementing a strategy to replace the motor every three months, as suggested by the historical data, he can create a policy to take action when threshold temperature conditions are actually met. If the policy retrieves a reading from a process historian indicating that the motor has reached 200 degrees, policy logic can create a recommendation automatically for a technician to replace the equipment and send an email message to notify the engineer. In this way, the company can save money by avoiding unnecessary replacements and still prevent failures that will occur if the equipment is replaced too late. Further, employees who do not have the expertise to analyze real-time data can implement strategies based upon emerging trends immediately. Policies can be configured to monitor current conditions continuously and perform a variety of actions automatically based on criteria that have been defined by the policy owner. In addition to creating recommendations and sending email messages, a policy can create Event records to track the occurrence of certain conditions. You can also use Policy Designer to create and update composite health indicators that indicate the overall health of a piece of equipment. Related Information: • https://www.predix.io/resources/tutorials/tutorial-details.html? tutorial_id=2586&tag=2583&journey=APM%20Basic %20Configuration&resources=2584,2579,2585,2586 • https://www.predix.io/resources/tutorials/tutorial-details.html? tutorial_id=2587&tag=2588&journey=APM%20Tools%20and%20Tips Access the Policy Designer Overview Page Procedure In the module navigation menu, select Tools > Policy Designer. 2 © 2021 General Electric Company The Policy Designer Overview page appears. The Policy Designer Overview page contains the following sections that summarize the number of Policies and Policy Recommendations: • Policies: Contains a list of all active and inactive Policies. • My Policy Recommendations: Contains a list of the Policy Recommendation records assigned to you. • Overdue Policy Recommendations: Contains a list of the Policy Recommendation records that are past target completion dates with pending recommended actions. • Module Workflow Policies: Contains a list of the Policies that support GE Digital APM module workflows. Note: The module workflow Policies do not appear in the other sections of this page. Note: The Policy Designer Overview page is not updated automatically when you return to the previously opened tab. You can select to update the page. The Count of Executions per Policy for Last 30 Days section in the Policy Designer Overview page displays a graphical summary of the execution results for the 20 Policies that were most active in the past 30 days. You can select an execution result to access the corresponding Policy. Policy Designer Workflow This workflow provides the basic, high-level steps for using Policy Designer. The steps and links in this workflow do not necessarily reference every possible procedure. 1. Begin a policy by providing a name and description for the policy. 2. Build a policy model, which includes nodes and connections that represent the inputs, logic, and resulting actions for the policy. Note: Interaction with the model design canvas, such as adding and moving nodes, is not available on touch-screen devices. 3. Create policy instances, which define the specific records to which logic in the policy model will be applied. © 2021 General Electric Company 3 4. Run the validation process to confirm that the policy logic is working correctly. 5. Define execution settings to specify whether you want the policy to be executed automatically or executed according to a predefined schedule (or both).