IBM Insights Foundation for Energy documentationWelcome to the IBM Insights Foundation for Energy documentation, where you can find information about how to install, maintain, and use the product.Product introduction IBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution. You can use the extension capabilities that are provided by the user interface framework to build application user interfaces that meet your operational requirements.Audience IBM Insights Foundation for Energy is designed for personnel who are involved with analyzing energy and utility assets and determining maintenance plans.Finding information To find information on the web, including all translated documentation, access IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).Accessibility features Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products. IBM Cognos HTML documentation has accessibility features. PDF documents are supplemental and, as such, include no added accessibility features. For information about these features, see Accessibility features in this document.Forward looking statementsThis documentation describes the current functionality of the product. References to items that are not currently available may be included. No implication of any future availability should be inferred. Any such references are not a commitment, promise, or legal obligation to deliver any material, code, or functionality. The development, release, and timing of features or functionality remain at the sole discretion of IBM.

IBM Insights Foundation for Energy documentation

Welcome to the IBM® Insights Foundation for Energy documentation, where you can find information about how to install, maintain, and use the product.

Product introduction

IBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.

You can use the extension capabilities that are provided by the user interface framework to build application user interfaces that meet your operational requirements.

Audience

IBM Insights Foundation for Energy is designed for personnel who are involved with analyzing energy and utility assets and determining maintenance plans.

Finding information

To find information on the web, including all translated documentation, access IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).

Accessibility features

Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products. IBM Cognos® HTML documentation has accessibility features. PDF documents are supplemental and, as such, include no added accessibility features. For information about these features, see Accessibility features in this document.

Forward looking statements

This documentation describes the current functionality of the product. References to items that are not currently available may be included. No implication of any future availability should be inferred. Any such references are not a commitment, promise, or legal obligation to deliver any material, code, or functionality. The development, release, and timing of features or functionality remain at the sole discretion of IBM.

Solution overviewIBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.Currently, data from multiple systems must be manually analyzed. IBM Insights Foundation for Energy provides an analytics platform and core services to consolidate and correlate the data.IBM Insights Foundation for Energy is installed on IBM Predictive Maintenance and Quality, so that you can also use predictive maintenance capabilities to help you to anticipate asset failures and to predict the need for maintenance.The product provides REST services that can be used to extend the product and provide integration interfaces to other systems.FeaturesIBM Insights Foundation for Energy is an analytics platform that provides a broad range of analytics capabilities. It is based on IBM platform and analytics products.Users and benefitsIBM Insights Foundation for Energy is designed for personnel who are involved with analyzing energy and utility assets and determining maintenance plans.Included productsIBM Insights Foundation for Energy is built on IBM products. Versions of these products are included for use with the solution.ConceptsIBM Insights Foundation for Energy has concepts that are unique to the solution and the energy industry. Understanding these concepts is important to understanding the data presented by the solution.What's newIBM Insights Foundation for Energy V1.6 is deployed on IBM PMQ 2.5.3. This new release includes simplified installation and operation, and improved customization and extension capabilities.

Solution overview

IBM® Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.

Currently, data from multiple systems must be manually analyzed. IBM Insights Foundation for Energy provides an analytics platform and core services to consolidate and correlate the data.

IBM Insights Foundation for Energy is installed on IBM Predictive Maintenance and Quality, so that you can also use predictive maintenance capabilities to help you to anticipate asset failures and to predict the need for maintenance.

The product provides REST services that can be used to extend the product and provide integration interfaces to other systems.

Features
IBM Insights Foundation for Energy is an analytics platform that provides a broad range of analytics capabilities. It is based on IBM platform and analytics products.

Users and benefits
IBM Insights Foundation for Energy is designed for personnel who are involved with analyzing energy and utility assets and determining maintenance plans.

Included products
IBM Insights Foundation for Energy is built on IBM products. Versions of these products are included for use with the solution.

Concepts
IBM Insights Foundation for Energy has concepts that are unique to the solution and the energy industry. Understanding these concepts is important to understanding the data presented by the solution.

What's new
IBM Insights Foundation for Energy V1.6 is deployed on IBM PMQ 2.5.3. This new release includes simplified installation and operation, and improved customization and extension capabilities.

Features IBM Insights Foundation for Energy is an analytics platform that provides a broad range of analytics capabilities. It is based on IBM platform and analytics products. IBM Insights Foundation for Energy provides built in applications for the situational awareness of grid assets and health, and risk analytics for these assets, along with predictive maintenance capabilities. Also, IFE enables energy companies to unify data and analytic processes across their operations to provide both visual and contextual insights. IBM Insights Foundation for Energy provides data management, visualization and analytics capabilities, and includes a broad range of integrated analytic technologies. It can also be used as a foundation for other analytics applications. This foundation can be used to: Unify systems and business processes by integrating multiple data sources such as sensors, SCADA, weather, EAM (Enterprise Asset Management). Deliver contextual awareness by correlating, analyzing and visualizing data within and across systems and processes. Asset Health Asset health assessment uses a predictive decision tree to help you do an in-depth analysis of the many factors affecting an asset's lifespan. For example, the health status of the pole is affected by multiple factors, some are based on a property of the asset (the species of the pole), some are based on a computed value (asset age based on installation date), and some based on result of a predictive model (failure risk). Asset health assessment combines different factors into a predictive asset health score and provides treatment options. IBM Insights Foundation for Energy provides the capability to configure the user interface for the filter bar and connectivity filter. Based on requirement, you can also create new reports or customize existing reports.Situation Awareness Situation awareness helps you to monitor changes to the status of assets. Standard operating procedures inform you of any actions that are necessary in response to those changes. The changes to an asset status show in real time and can be seen with different views. Immediate response can be taken to solve issues or plan corrective action for future occurrences for assets within the regional or municipal boundaries.Solution overviewIBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.

Features

IBM® Insights Foundation for Energy is an analytics platform that provides a broad range of analytics capabilities. It is based on IBM platform and analytics products.

IBM Insights Foundation for Energy provides built in applications for the situational awareness of grid assets and health, and risk analytics for these assets, along with predictive maintenance capabilities. Also, IFE enables energy companies to unify data and analytic processes across their operations to provide both visual and contextual insights.

IBM Insights Foundation for Energy provides data management, visualization and analytics capabilities, and includes a broad range of integrated analytic technologies. It can also be used as a foundation for other analytics applications.

This foundation can be used to:

Unify systems and business processes by integrating multiple data sources such as sensors, SCADA, weather, EAM (Enterprise Asset Management).

Deliver contextual awareness by correlating, analyzing and visualizing data within and across systems and processes.

Asset Health

Asset health assessment uses a predictive decision tree to help you do an in-depth analysis of the many factors affecting an asset's lifespan. For example, the health status of the pole is affected by multiple factors, some are based on a property of the asset (the species of the pole), some are based on a computed value (asset age based on installation date), and some based on result of a predictive model (failure risk). Asset health assessment combines different factors into a predictive asset health score and provides treatment options.

IBM Insights Foundation for Energy provides the capability to configure the user interface for the filter bar and connectivity filter. Based on requirement, you can also create new reports or customize existing reports.

Situation Awareness

Situation awareness helps you to monitor changes to the status of assets. Standard operating procedures inform you of any actions that are necessary in response to those changes. The changes to an asset status show in real time and can be seen with different views. Immediate response can be taken to solve issues or plan corrective action for future occurrences for assets within the regional or municipal boundaries.

Parent topic: Solution overview

Users and benefitsIBM Insights Foundation for Energy is designed for personnel who are involved with analyzing energy and utility assets and determining maintenance plans.The following table describes the users and benefits that are associated with using IBM Insights Foundation for Energy.IBM Insights Foundation for Energy users and benefitsIf you are a...This software can help you...Reliability planning engineerAnalyze data on assets and networks.Data scientistCreate and configure analysis models.IT AdministratorConfigure custom services and user interface elements. Software developerCreate new applications. Create new data models and services. Create new user interfaces for new applications.Solution overviewIBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.

Users and benefits

IBM® Insights Foundation for Energy is designed for personnel who are involved with analyzing energy and utility assets and determining maintenance plans.

The following table describes the users and benefits that are associated with using IBM Insights Foundation for Energy.

Table 1. IBM Insights Foundation for Energy users and benefits

If you are a...
This software can help you...

Reliability planning engineer
Analyze data on assets and networks.

Data scientist
Create and configure analysis models.

IT Administrator
Configure custom services and user interface elements.

Software developer

Create new applications.

Create new data models and services.

Create new user interfaces for new applications.

Parent topic: Solution overview

Included productsIBM Insights Foundation for Energy is built on IBM products. Versions of these products are included for use with the solution.Apache Jena 0.2.3DB2 Enterprise Server Edition 10.5.0.5IBM Cognos Business Intelligence 10.2.2IBM HTTP Server 8.5.5.5IBM ILOG CPLEX Optimization Studio 12.6.0.1IBM Integration Bus 9.0.0.3IBM SPSS Data Access Pack 7.1.1IBM SPSS Modeler 17.0IBM SPSS Modeler Batch 17.0IBM SPSS Modeler Collaboration and Deployment Services Adapter 17.0IBM SPSS Statistics 23.0IBM SPSS Statistics 23.0 Collaboration and Deployment Services Adapter 7.0IBM SPSS Analytic Server 2.0IBM WebSphere MQ 7.5.0.4IBM WebSphere SDK Java Technology Edition 7.1.2.10 SPSS Collaboration and Deployment Services 7.0.0WebSphere Application Server Liberty Profile 8.5.5.5WebSphere Application Server Network Deployment 8.5.5.5Solution overviewIBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.

Included products

IBM® Insights Foundation for Energy is built on IBM products. Versions of these products are included for use with the solution.

Apache Jena 0.2.3

DB2® Enterprise Server Edition 10.5.0.5

IBM Cognos® Business Intelligence 10.2.2

IBM HTTP Server 8.5.5.5

IBM ILOG® CPLEX® Optimization Studio 12.6.0.1

IBM Integration Bus 9.0.0.3

IBM SPSS® Data Access Pack 7.1.1

IBM SPSS Modeler 17.0

IBM SPSS Modeler Batch 17.0

IBM SPSS Modeler Collaboration and Deployment Services Adapter 17.0

IBM SPSS Statistics 23.0

IBM SPSS Statistics 23.0 Collaboration and Deployment Services Adapter 7.0

IBM SPSS Analytic Server 2.0

IBM WebSphere® MQ 7.5.0.4

IBM WebSphere SDK Java™ Technology Edition 7.1.2.10

SPSS Collaboration and Deployment Services 7.0.0

WebSphere Application Server Liberty Profile 8.5.5.5

WebSphere Application Server Network Deployment 8.5.5.5

Parent topic: Solution overview

ConceptsIBM Insights Foundation for Energy has concepts that are unique to the solution and the energy industry. Understanding these concepts is important to understanding the data presented by the solution.Asset health Asset health indicates how well a specific asset will provide its service in the future in terms of a percentage figure. IBM Insights Foundation for Energy provides an aggregate score for the health of each asset. Factors such as age, manufacture, overload time, and others are considered when calculating the health score. Asset health is shown in terms of a percentage figure. The higher the value for asset health, the less likely the asset will fail. Failure probability Failure is the probability that a single asset or a network will fail. The failure calculation takes into consideration the probability, in percentage terms, that the asset itself will fail as well as the impact on assets upstream and downstream from the failing asset. Network failure probability takes into account four failure probabilities:The probability of failure of an individual asset. This is calculated as {(100 - Asset Health score) * constant}The probability of failure of an asset downstream from the individual failing asset.The probability of failure of an asset upstream from the individual failing asset.The probability of the physical failure of a supporting asset. A supporting asset is one that gives physical support to the individual asset, for example, an overhead cable is physically supported by 2 poles, then the physical failure probability of the cable c1 = 1 - (1 - Physical failure probability of p1) * (1 - Physical failure probability of p2) where c1 is the overhead cable, and p1 and p2 are the supporting poles. The higher the failure score, the more likely the asset will fail.Consequence of failure The consequence of an asset failing is a measure of the number of customers associated with that asset. Assets that support more customers are more important than assets that support fewer customers. As the number of downstream network nodes propagates, the real consequence of failure of one asset is the summation of all consequence values of all downstream nodes, plus its own value. In order to normalize the consequence value into the range of [0-100], we use the maximum value for the normalization factor for each asset. For example: Three distribution transformers dt1, dt2, dt3 each have a number of customers: 5, 8, and 6 where 8 is the maximum value. The normalized factor value for dt1 = 5/8. This is converted to a percentage value to give a consequence of failure = 62.5%. The number of customers for each distribution transformersDistribution transformerNumber of customersNormalized factor valueConsequence of failuredt155/862.5%dt288/8100%dt366/875%Risk Risk is given as a percentage value and is the product of the failure probability and the consequence of failure. For example, if the failure probability is 30% and the consequence of failure is 62.5%, then the risk of failure is 18.75%.Solution overviewIBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.Supported asset classes and measurementsThe default supported asset classes and measurements that are included with IBM Insights Foundation for Energy.

Concepts

IBM® Insights Foundation for Energy has concepts that are unique to the solution and the energy industry. Understanding these concepts is important to understanding the data presented by the solution.

Asset health

Asset health indicates how well a specific asset will provide its service in the future in terms of a percentage figure.

IBM Insights Foundation for Energy provides an aggregate score for the health of each asset. Factors such as age, manufacture, overload time, and others are considered when calculating the health score. Asset health is shown in terms of a percentage figure. The higher the value for asset health, the less likely the asset will fail.

Failure probability

Failure is the probability that a single asset or a network will fail.

The failure calculation takes into consideration the probability, in percentage terms, that the asset itself will fail as well as the impact on assets upstream and downstream from the failing asset. Network failure probability takes into account four failure probabilities:

The probability of failure of an individual asset. This is calculated as {(100 - Asset Health score) * constant}

The probability of failure of an asset downstream from the individual failing asset.

The probability of failure of an asset upstream from the individual failing asset.

The probability of the physical failure of a supporting asset. A supporting asset is one that gives physical support to the individual asset, for example, an overhead cable is physically supported by 2 poles, then the physical failure probability of the cable c1 = 1 - (1 - Physical failure probability of p1) * (1 - Physical failure probability of p2) where c1 is the overhead cable, and p1 and p2 are the supporting poles.

The higher the failure score, the more likely the asset will fail.

Consequence of failure

The consequence of an asset failing is a measure of the number of customers associated with that asset. Assets that support more customers are more important than assets that support fewer customers. As the number of downstream network nodes propagates, the real consequence of failure of one asset is the summation of all consequence values of all downstream nodes, plus its own value. In order to normalize the consequence value into the range of [0-100], we use the maximum value for the normalization factor for each asset.

For example: Three distribution transformers dt1, dt2, dt3 each have a number of customers: 5, 8, and 6 where 8 is the maximum value. The normalized factor value for dt1 = 5/8. This is converted to a percentage value to give a consequence of failure = 62.5%.

Table 2. The number of customers for each distribution transformers

Distribution transformer | Number of customers | Normalized factor value | Consequence of failure
dt1 | 5 | 5/8 | 62.5%
dt2 | 8 | 8/8 | 100%
dt3 | 6 | 6/8 | 75%

Risk

Risk is given as a percentage value and is the product of the failure probability and the consequence of failure.

For example, if the failure probability is 30% and the consequence of failure is 62.5%, then the risk of failure is 18.75%.

Supported asset classes and measurements
The default supported asset classes and measurements that are included with IBM Insights Foundation for Energy.

Parent topic: Solution overview

Supported asset classes and measurementsThe default supported asset classes and measurements that are included with IBM Insights Foundation for Energy.IFE includes algorithms for five asset class models:Substation transformerDistribution transformerOverhead cableUnderground cablePoleThe following table shows the default support.The measurements associated with each asset classAsset ClassInput measurementsPredictive modelAsset Health FactorsOutput network riskSubstation TransformerDissolved Gas Analysis ReadingPercentage summation of each of the weighted asset health factors. Stage 3 Rating (MVA) Winter Emergency Rating (A) Summer Normal Rating (A) Operating Voltage Stage 1 Rating (MVA) Stage 2 Rating (MVA) Age Summer Emergency Rating (A) Phase Orientation Rated KVAUpstream, downstream failure probability, consequence of failure and riskDistribution TransformerLoad EnergyPercent aging coefficient modelNumber of customers Rated KVA Is outage device Owner Age Operating voltage Percent Aging Coefficient Upstream and downstream failure probability, consequence of failure and risk.Overhead CableNo measurement input Age Length Age Operating voltageUpstream and downstream failure probability, consequence of failure and risk. Failure probability of supporting polesUnderground CableNo measurement input Age Length Age Operating voltage Phase designationUpstream and downstream failure probability, consequence if failure and risk.PolePole Inspection resultPole maintenance based asset health scoreReclaimed status Species Inspection status Age Length Inspection result Preservative Failure Risk ScoreUpstream and downstream failure probability, consequence if failure and risk.Asset Health calculation for a distribution transformer The health score for the Distribution Transformer asset class is calculated from two drivers, condition and risk. The condition driver has four input asset health factors:Percent Aging Coefficient is a statistical factor that is derived from the PMQ SPSS analysis model. The PMQ SPSS analysis model analyzes several properties and returns the analysis to IFE as the Ageing Coefficient statistical factor. The properties that PMQ analyzes are: subtypeCode, ratedKva, installationDate, removalDate and isActive. Outage Device is a raw factor that derives directly from the property isOutageDevice.Age is a calculation derived from the installationDate property and the current date.Operating Voltage is a raw factor that derives directly from the operatingVoltage property. The risk driver has one input factor, Rated KVA, that derives directly from the ratedkva property.Asset Health factors for a substation transformer The health score for the Substation Transformer asset class is calculated from two drivers. Condition and Risk. The condition driver condition has seven input factors:Stage 3 Rating (MVA) is a raw input factor derived directly from the stage3Rating property.Winter Emergency Rating (A) is a raw input factor derived directly from the winterEmergencyRating property. Summer Normal Rating (A) is a raw factor derived directly from the summerNormalRating property.Winter Normal Rating (A) is a raw factor derived directly from the winterNormalRating property.Operating Voltage is a raw factor derived directly from the operatingVoltage property.Stage 1 Rating (MVA) is a raw factor derived directly from the stage1Rating property.Stage 2 Rating (MVA) is a raw factor derived directly from the stage2Rating property.The risk driver risk has three input factors:Age is a calculation derived from the installationDate property and the current date.Summer Emergency Rating (A) is a raw input factor derived directly from the summerEmergencyRating property .Rated KVA is a raw factor derived directly from the ratedkva property Asset Health factors for an overhead cable The health score for the Overhead Cable asset class is calculated from two drivers. Condition and Risk. The condition driver condition has two input factors:Age is a calculation derived from the installationDate property and the current date.Phase Designation is a raw input factor derived directly from the phaseDesignation property. The risk driver has two input factors:Length is a raw input factor derived directly from the length property.Operating Voltage is a raw input factor derived directly from the operatingVoltage property.Asset Health factors for an underground cable The health score for the Underground Cable asset class is calculated from two drivers. Condition and Risk. The condition driver has four input factors:Length is a raw factor derived directly from the length property. Age is a calculation derived from the installationDate property and the current date.Sub Type Code is a raw factor derived directly from the subtypecode property. Phase Designation is a raw factor derived directly from the phaseDesignation property. The risk driver risk has one input factor. Operating Voltage is a raw input factor, derived directly from the operatingVoltage property. Asset Health factors for a pole The health score for the Pole asset class, is calculated from two drivers. Condition and Risk. The condition driver has three input factors:Height is a raw input factor derived directly from the length property.Age is a calculation derived from the installationDate property and the current date.Inspection Result is a computed factor derived directly from the measurement POLESTATUS. The risk driver risk has three input factors:Species Type is a raw input factor derived directly from the speciestype property .Preservative Kind is a raw input factor derived directly from the preservativekind property.Feature based health is a statistical factor derived from the PMQ SPSS analysis model. The PMQ SPSS analysis model analyzes several properties and returns the analysis to IFE as the Feature based health factor. The properties that the PMQ analyzes are: speciestype, preservativekind, installationDate, reclaimedstatus, length, removalDate and isActive.ConceptsIBM Insights Foundation for Energy has concepts that are unique to the solution and the energy industry. Understanding these concepts is important to understanding the data presented by the solution.

Supported asset classes and measurements

The default supported asset classes and measurements that are included with IBM® Insights Foundation for Energy.

IFE includes algorithms for five asset class models:

Substation transformer

Distribution transformer

Overhead cable

Underground cable

Pole

The following table shows the default support.

Table 3. The measurements associated with each asset class

Asset Class
Input measurements
Predictive model
Asset Health Factors
Output network risk

Substation Transformer

Dissolved Gas Analysis Reading

Percentage summation of each of the weighted asset health factors.

Stage 3 Rating (MVA)

Winter Emergency Rating (A)

Summer Normal Rating (A)

Operating Voltage

Stage 1 Rating (MVA)

Stage 2 Rating (MVA)

Age

Summer Emergency Rating (A)

Phase Orientation

Rated KVA

Upstream, downstream failure probability, consequence of failure and risk

Distribution Transformer

Load Energy

Percent aging coefficient model

Number of customers

Rated KVA

Is outage device

Owner

Age

Operating voltage

Percent Aging Coefficient

Upstream and downstream failure probability, consequence of failure and risk.

Overhead Cable
No measurement input

Age

Length

Age

Operating voltage

Upstream and downstream failure probability, consequence of failure and risk.

Failure probability of supporting poles

Underground Cable
No measurement input

Age

Length

Age

Operating voltage

Phase designation

Upstream and downstream failure probability, consequence if failure and risk.

Pole

Pole Inspection result

Pole maintenance based asset health score

Reclaimed status

Species

Inspection status

Age

Length

Inspection result

Preservative

Failure Risk Score

Upstream and downstream failure probability, consequence if failure and risk.

Asset Health calculation for a distribution transformer

The health score for the Distribution Transformer asset class is calculated from two drivers, condition and risk.

The condition driver has four input asset health factors:

Percent Aging Coefficient is a statistical factor that is derived from the PMQ SPSS analysis model. The PMQ SPSS analysis model analyzes several properties and returns the analysis to IFE as the Ageing Coefficient statistical factor. The properties that PMQ analyzes are: subtypeCode, ratedKva, installationDate, removalDate and isActive.

Outage Device is a raw factor that derives directly from the property isOutageDevice.

Age is a calculation derived from the installationDate property and the current date.

Operating Voltage is a raw factor that derives directly from the operatingVoltage property.

The risk driver has one input factor, Rated KVA, that derives directly from the ratedkva property.

Asset Health factors for a substation transformer

The health score for the Substation Transformer asset class is calculated from two drivers. Condition and Risk.

The condition driver condition has seven input factors:

Stage 3 Rating (MVA) is a raw input factor derived directly from the stage3Rating property.

Winter Emergency Rating (A) is a raw input factor derived directly from the winterEmergencyRating property.

Summer Normal Rating (A) is a raw factor derived directly from the summerNormalRating property.

Winter Normal Rating (A) is a raw factor derived directly from the winterNormalRating property.

Operating Voltage is a raw factor derived directly from the operatingVoltage property.

Stage 1 Rating (MVA) is a raw factor derived directly from the stage1Rating property.

Stage 2 Rating (MVA) is a raw factor derived directly from the stage2Rating property.

The risk driver risk has three input factors:

Age is a calculation derived from the installationDate property and the current date.

Summer Emergency Rating (A) is a raw input factor derived directly from the summerEmergencyRating property .

Rated KVA is a raw factor derived directly from the ratedkva property

Asset Health factors for an overhead cable

The health score for the Overhead Cable asset class is calculated from two drivers. Condition and Risk.

The condition driver condition has two input factors:

Age is a calculation derived from the installationDate property and the current date.

Phase Designation is a raw input factor derived directly from the phaseDesignation property.

The risk driver has two input factors:

Length is a raw input factor derived directly from the length property.

Operating Voltage is a raw input factor derived directly from the operatingVoltage property.

Asset Health factors for an underground cable

The health score for the Underground Cable asset class is calculated from two drivers. Condition and Risk.

The condition driver has four input factors:

Length is a raw factor derived directly from the length property.

Age is a calculation derived from the installationDate property and the current date.

Sub Type Code is a raw factor derived directly from the subtypecode property.

Phase Designation is a raw factor derived directly from the phaseDesignation property.

The risk driver risk has one input factor. Operating Voltage is a raw input factor, derived directly from the operatingVoltage property.

Asset Health factors for a pole

The health score for the Pole asset class, is calculated from two drivers. Condition and Risk.

The condition driver has three input factors:

Height is a raw input factor derived directly from the length property.

Age is a calculation derived from the installationDate property and the current date.

Inspection Result is a computed factor derived directly from the measurement POLESTATUS.

The risk driver risk has three input factors:

Species Type is a raw input factor derived directly from the speciestype property .

Preservative Kind is a raw input factor derived directly from the preservativekind property.

Feature based health is a statistical factor derived from the PMQ SPSS analysis model. The PMQ SPSS analysis model analyzes several properties and returns the analysis to IFE as the Feature based health factor. The properties that the PMQ analyzes are: speciestype, preservativekind, installationDate, reclaimedstatus, length, removalDate and isActive.

Parent topic: Concepts

What's new IBM Insights Foundation for Energy V1.6 is deployed on IBM PMQ 2.5.3. This new release includes simplified installation and operation, and improved customization and extension capabilities.Revised architecture IBM Insights Foundation for Energy now installs on four servers to support simplified installation, deployment, and operation.User interface frameworkUse the extension capabilities that are provided by the enhanced user interface framework to build application user interfaces that meet your operational needs. As an application developer, you can create customized user interface components to extend the user interface. Your administrator can register new user interface components, and configure the style, layout, widgets, access controls, and services for the pages in your application. REST service framework Use the extension capabilities that are provided by the enhanced Representational State Transfer (REST) service framework to create customized REST services with minimal coding. Your administrator can then register custom services, and assign access to the services to user roles in your solution.Solution overviewIBM Insights Foundation for Energy is an analytics platform for the energy and utilities industry. You can use the platform to develop new applications to support analytics use cases for your assets and networks, and to integrate existing applications with the solution.

What's new

IBM® Insights Foundation for Energy V1.6 is deployed on IBM PMQ 2.5.3. This new release includes simplified installation and operation, and improved customization and extension capabilities.

Revised architecture

IBM Insights Foundation for Energy now installs on four servers to support simplified installation, deployment, and operation.

User interface framework

Use the extension capabilities that are provided by the enhanced user interface framework to build application user interfaces that meet your operational needs. As an application developer, you can create customized user interface components to extend the user interface. Your administrator can register new user interface components, and configure the style, layout, widgets, access controls, and services for the pages in your application.

REST service framework

Use the extension capabilities that are provided by the enhanced Representational State Transfer (REST) service framework to create customized REST services with minimal coding. Your administrator can then register custom services, and assign access to the services to user roles in your solution.

Parent topic: Solution overview

Securing the solutionSecuring your IBM Insights Foundation for Energy solution is an important consideration. To ensure that the system is secure, you must manage who can access the system and assign the correct level of access within the solution.Securing access to the solutionIBM Insights Foundation for Energy uses a WebSphere Application Server Liberty Profile basic user registry to authenticate and authorize users. For more information about Liberty profile user registries, see the related link. Your administrator assigns access to features, data, and services in your solution based on the user role groups. The following topics explain how to manage user access to IBM Insights Foundation for Energy.User roles and accessIBM Insights Foundation for Energy implements security by limiting access to features, data, and services based on user roles.Adding users and groups To access specific features or services in the solution, a user must be a member of a user role group that provides the required level of access to that feature or service. IBM Insights Foundation for Energy uses a basic user registry to define users and user role groups. You can add users and user role groups to the solution by adding users and groups to the WebSphere Application Server Liberty Profile server_ife_frwk.xml configuration file on the application server. Modifying or removing users and groupsYou can change passwords and group membership for users in IBM Insights Foundation for Energy. Membership of a user role group gives users access to the parts of the solution that are appropriate to that user role. You can change the access level of a user by updating the basic user registry to remove the user from one group and add the user to another group. You can also update the basic user registry to remove users and groups that no longer require access to the solution. To update the basic user registry, edit the WebSphere Application Server Liberty Profile server_ife_frwk.xml file on the application server. Mapping groups to license typesIBM Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server.WebSphere Application server 8.5.5 product documentation: Configuring a user registry for the Liberty profile

Securing the solution

Securing your IBM® Insights Foundation for Energy solution is an important consideration. To ensure that the system is secure, you must manage who can access the system and assign the correct level of access within the solution.

Securing access to the solution

IBM Insights Foundation for Energy uses a WebSphere® Application Server Liberty Profile basic user registry to authenticate and authorize users. For more information about Liberty profile user registries, see the related link.

Your administrator assigns access to features, data, and services in your solution based on the user role groups.

The following topics explain how to manage user access to IBM Insights Foundation for Energy.

User roles and access
IBM Insights Foundation for Energy implements security by limiting access to features, data, and services based on user roles.

Adding users and groups
To access specific features or services in the solution, a user must be a member of a user role group that provides the required level of access to that feature or service. IBM Insights Foundation for Energy uses a basic user registry to define users and user role groups. You can add users and user role groups to the solution by adding users and groups to the WebSphere Application Server Liberty Profile server_ife_frwk.xml configuration file on the application server.

Modifying or removing users and groups
You can change passwords and group membership for users in IBM Insights Foundation for Energy. Membership of a user role group gives users access to the parts of the solution that are appropriate to that user role. You can change the access level of a user by updating the basic user registry to remove the user from one group and add the user to another group. You can also update the basic user registry to remove users and groups that no longer require access to the solution. To update the basic user registry, edit the WebSphere Application Server Liberty Profile server_ife_frwk.xml file on the application server.

Mapping groups to license types
IBM Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server.

Related information

WebSphere Application server 8.5.5 product documentation: Configuring a user registry for the Liberty profile

User roles and accessIBM Insights Foundation for Energy implements security by limiting access to features, data, and services based on user roles. To use a specific feature of IBM Insights Foundation for Energy, a user must be a member of a user role that provides the required access level to that feature. Users and user role groups are defined in a basic user registry that is deployed with IBM Insights Foundation for Energy. The basic user registry is defined in the WebSphere Application Server Liberty Profile server_ife_frwk.xml configuration file. The following table shows the sample users and user role groups that are defined in the IBM Insights Foundation for Energy basic user registry, and the default access levels for the groups.User groups and sample users defined in the user registryUser role groupsSample usersDefault access levelsadminsBobMembers of the admins role group have the following access levels:Members can access the Administration Console view and the sample application. Members also have create, read, update, and delete access to the REST services that are provided with the solution. usersuser1, user2Members of the users role group have the following access levels:Members can access the sample application.Members have varying levels of access to the REST services that are provided with the solution.After you define users for your organization, you can delete the sample users.For more information about configuring access levels to pages and services in IBM Insights Foundation for Energy based on user role groups, see the related links.Securing the solutionSecuring your IBM Insights Foundation for Energy solution is an important consideration. To ensure that the system is secure, you must manage who can access the system and assign the correct level of access within the solution.Configuring pagesIf you are an administrator, you can add and configure custom pages. Each page has a style and a layout to manage the widgets on the page. Configuring REST servicesIf you are an administrator, you can register and configure custom Representational State Transfer (REST) services.

User roles and access

IBM® Insights Foundation for Energy implements security by limiting access to features, data, and services based on user roles.

To use a specific feature of IBM Insights Foundation for Energy, a user must be a member of a user role that provides the required access level to that feature. Users and user role groups are defined in a basic user registry that is deployed with IBM Insights Foundation for Energy. The basic user registry is defined in the WebSphere® Application Server Liberty Profile server_ife_frwk.xml configuration file.

The following table shows the sample users and user role groups that are defined in the IBM Insights Foundation for Energy basic user registry, and the default access levels for the groups.

Table 4. User groups and sample users defined in the user registry

User role groups
Sample users
Default access levels

admins
Bob
Members of the admins role group have the following access levels:

Members can access the Administration Console view and the sample application.

Members also have create, read, update, and delete access to the REST services that are provided with the solution.

users
user1, user2
Members of the users role group have the following access levels:

Members can access the sample application.

Members have varying levels of access to the REST services that are provided with the solution.

After you define users for your organization, you can delete the sample users.

For more information about configuring access levels to pages and services in IBM Insights Foundation for Energy based on user role groups, see the related links.

Parent topic: Securing the solution

Related tasks:

Configuring pages

Configuring REST services

Adding users and groups To access specific features or services in the solution, a user must be a member of a user role group that provides the required level of access to that feature or service. IBM Insights Foundation for Energy uses a basic user registry to define users and user role groups. You can add users and user role groups to the solution by adding users and groups to the WebSphere Application Server Liberty Profile server_ife_frwk.xml configuration file on the application server. Decide on the groups, users, and user passwords that you want to add to the IBM Insights Foundation for Energy basic user registry. To add user role groups and users to IBM Insights Foundation for Energy, edit the server_ife_frwk.xml file on the application server. For each user entry that you add to server_ife_frwk.xml, you must include an encoded version of the user's password. The procedure describes how to use the Liberty profile securityUtility command line tool to encode the password for each new user. Add the encoded password that the utility outputs to the user entry in the XML file. Log on to the application server as a user who has edit access to the server_ife_frwk.xml file, for example, the root user.Use the Liberty profile securityUtility command line tool to generate an encoded password for each new user. To encode a user password, run the following command:/opt/IBM/WebSphere/Liberty/bin/securityUtility encode userPasswordWhere userPassword is the password to encode. As a precaution, make a backup copy of the server_ife_frwk.xml file that is in the /opt/IBM/WebSphere/Liberty/user/servers/member01 directory.To add groups and users, edit the server_ife_frwk.xml file.To add a group, add a group element to the basicRegistry element. Then, add a member element for each user in the group.For example, to add a group that is named reliability_group with a member named reliability_engineer_1, add the following entry to the basicRegistry element in the server_ife_frwk.xml file:<group name="reliability_group"> <member name="reliability_engineer_1"/> </group> For each new group member, add a user element to the basicRegistry element. Each user element has a name attribute and a password attribute.Copy the encoded password that you generated for the user with the securityUtility tool into the server_ife_frwk.xml as the value for the password attribute. For example, to add a user with the user name reliability_engineer_1, add the following user element to the basicRegistry element in the server_ife_frwk.xml file:<user name="reliability_engineer_1" password="{xor}KzosKw=="/>Where {xor}KzosKw== is the encoded password that you generated with the Liberty profile securityUtility tool for the reliability_engineer_1 user.The new groups and users are added to the basic user registry, and the users can now be authenticated when they log on to IBM Insights Foundation for Energy.To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server. For more information, see Mapping groups to license typesIBM Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server..If you are an administrator, you can now assign access to pages and REST services in the solution to each new user role. For more information about configuring access control for pages and services, see the related links.Securing the solutionSecuring your IBM Insights Foundation for Energy solution is an important consideration. To ensure that the system is secure, you must manage who can access the system and assign the correct level of access within the solution.Configuring pagesIf you are an administrator, you can add and configure custom pages. Each page has a style and a layout to manage the widgets on the page. Configuring REST servicesIf you are an administrator, you can register and configure custom Representational State Transfer (REST) services.

Adding users and groups

To access specific features or services in the solution, a user must be a member of a user role group that provides the required level of access to that feature or service. IBM® Insights Foundation for Energy uses a basic user registry to define users and user role groups. You can add users and user role groups to the solution by adding users and groups to the WebSphere® Application Server Liberty Profile server_ife_frwk.xml configuration file on the application server.

Before you begin

Decide on the groups, users, and user passwords that you want to add to the IBM Insights Foundation for Energy basic user registry.

About this task

To add user role groups and users to IBM Insights Foundation for Energy, edit the server_ife_frwk.xml file on the application server.

Note: For each user entry that you add to server_ife_frwk.xml, you must include an encoded version of the user's password. The procedure describes how to use the Liberty profile securityUtility command line tool to encode the password for each new user. Add the encoded password that the utility outputs to the user entry in the XML file.

Procedure

Log on to the application server as a user who has edit access to the server_ife_frwk.xml file, for example, the root user.

Use the Liberty profile securityUtility command line tool to generate an encoded password for each new user. To encode a user password, run the following command:

/opt/IBM/WebSphere/Liberty/bin/securityUtility encode userPassword

Where userPassword is the password to encode.

As a precaution, make a backup copy of the server_ife_frwk.xml file that is in the /opt/IBM/WebSphere/Liberty/user/servers/member01 directory.

To add groups and users, edit the server_ife_frwk.xml file.

To add a group, add a group element to the basicRegistry element. Then, add a member element for each user in the group. For example, to add a group that is named reliability_group with a member named reliability_engineer_1, add the following entry to the basicRegistry element in the server_ife_frwk.xml file:

<group name="reliability_group">
    <member name="reliability_engineer_1"/>
</group>

 For each new group member, add a user element to the basicRegistry element. Each user element has a name attribute and a password attribute.

Note: Copy the encoded password that you generated for the user with the securityUtility tool into the server_ife_frwk.xml as the value for the password attribute.

For example, to add a user with the user name reliability_engineer_1, add the following user element to the basicRegistry element in the server_ife_frwk.xml file:

<user name="reliability_engineer_1" password="{xor}KzosKw=="/>

Where {xor}KzosKw== is the encoded password that you generated with the Liberty profile securityUtility tool for the reliability_engineer_1 user.

Results

The new groups and users are added to the basic user registry, and the users can now be authenticated when they log on to IBM Insights Foundation for Energy.

What to do next

To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server. For more information, see Mapping groups to license types.

If you are an administrator, you can now assign access to pages and REST services in the solution to each new user role. For more information about configuring access control for pages and services, see the related links.

Parent topic: Securing the solution

Related tasks:

Configuring pages

Configuring REST services

Modifying or removing users and groupsYou can change passwords and group membership for users in IBM Insights Foundation for Energy. Membership of a user role group gives users access to the parts of the solution that are appropriate to that user role. You can change the access level of a user by updating the basic user registry to remove the user from one group and add the user to another group. You can also update the basic user registry to remove users and groups that no longer require access to the solution. To update the basic user registry, edit the WebSphere Application Server Liberty Profile server_ife_frwk.xml file on the application server. While you update the basic user registry, ensure that the affected users are not logged on to IBM Insights Foundation for Energy.Before you remove groups from the basic registry, ensure that the groups are not assigned access to pages and services in the solution. For more information about configuring access to pages and services in IBM Insights Foundation for Energy, see the related links.You can modify or remove users or user role groups for IBM Insights Foundation for Energy by editing the server_ife_frwk.xml file on the application server. To change a user password in the server_ife_frwk.xml file, you must first generate an encoded version of the new password. The procedure describes how to use the Liberty profile securityUtility command line tool to encode a new password. Add the encoded password that the utility outputs to the user entry in the XML file. Log on to the application server as a user who has edit access to the server_ife_frwk.xml file, for example, the root user.Use the Liberty profile securityUtility command line tool to generate an encoded password for each user password that you want to change. To encode a user password, run the following command:/opt/IBM/WebSphere/Liberty/bin/securityUtility encode userPasswordWhere userPassword is the password to encode. As a precaution, make a backup copy of the server_ife_frwk.xml file that is in the /opt/IBM/WebSphere/Liberty/user/serves/member01 directory.To modify or remove users and groups, edit the server_ife_frwk.xml file.To add members to a group, see Adding users and groups. To remove a member from a group, delete the member element from the group element in the server_ife_frwk.xml file.To change the password for a user, copy the encoded password that you generated for the user with the securityUtility tool into the server_ife_frwk.xml as the value for the user's password attribute.For example, to change the password for a user with the user name reliability_engineer_1, edit the entry for the user in theserver_ife_frwk.xml file as follows:<user name="reliability_engineer_1" password="{xor}Lz4sLCgwLTs="/>Where {xor}Lz4sLCgwLTs= is the new encoded password that you generated for the reliability_engineer_1 user. To remove a user from IBM Insights Foundation for Energy, delete the user element for that user, and remove any group member element for that user.The users and groups are modified or removed in the IBM Insights Foundation for Energy basic user registry. If you modified or removed user role groups, update the license mapping for the affected groups in the slmtag_groups.properties file on the application server. For more information, see Mapping groups to license typesIBM Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server.. If you are an administrator, you can change access to pages and REST services in the solution based on the modified user role groups. For more information about configuring access control for pages and services, see the related links.Securing the solutionSecuring your IBM Insights Foundation for Energy solution is an important consideration. To ensure that the system is secure, you must manage who can access the system and assign the correct level of access within the solution.Configuring pagesIf you are an administrator, you can add and configure custom pages. Each page has a style and a layout to manage the widgets on the page. Configuring REST servicesIf you are an administrator, you can register and configure custom Representational State Transfer (REST) services.

Modifying or removing users and groups

You can change passwords and group membership for users in IBM® Insights Foundation for Energy. Membership of a user role group gives users access to the parts of the solution that are appropriate to that user role. You can change the access level of a user by updating the basic user registry to remove the user from one group and add the user to another group. You can also update the basic user registry to remove users and groups that no longer require access to the solution. To update the basic user registry, edit the WebSphere® Application Server Liberty Profile server_ife_frwk.xml file on the application server.

Before you begin

While you update the basic user registry, ensure that the affected users are not logged on to IBM Insights Foundation for Energy.

Before you remove groups from the basic registry, ensure that the groups are not assigned access to pages and services in the solution. For more information about configuring access to pages and services in IBM Insights Foundation for Energy, see the related links.

About this task

You can modify or remove users or user role groups for IBM Insights Foundation for Energy by editing the server_ife_frwk.xml file on the application server.

Note: To change a user password in the server_ife_frwk.xml file, you must first generate an encoded version of the new password. The procedure describes how to use the Liberty profile securityUtility command line tool to encode a new password. Add the encoded password that the utility outputs to the user entry in the XML file.

Procedure

Log on to the application server as a user who has edit access to the server_ife_frwk.xml file, for example, the root user.

Use the Liberty profile securityUtility command line tool to generate an encoded password for each user password that you want to change. To encode a user password, run the following command:

/opt/IBM/WebSphere/Liberty/bin/securityUtility encode userPassword

Where userPassword is the password to encode.

As a precaution, make a backup copy of the server_ife_frwk.xml file that is in the /opt/IBM/WebSphere/Liberty/user/serves/member01 directory.

To modify or remove users and groups, edit the server_ife_frwk.xml file.

To add members to a group, see Adding users and groups.

 To remove a member from a group, delete the member element from the group element in the server_ife_frwk.xml file.

To change the password for a user, copy the encoded password that you generated for the user with the securityUtility tool into the server_ife_frwk.xml as the value for the user's password attribute. For example, to change the password for a user with the user name reliability_engineer_1, edit the entry for the user in theserver_ife_frwk.xml file as follows:

<user name="reliability_engineer_1" password="{xor}Lz4sLCgwLTs="/>

Where {xor}Lz4sLCgwLTs= is the new encoded password that you generated for the reliability_engineer_1 user.

 To remove a user from IBM Insights Foundation for Energy, delete the user element for that user, and remove any group member element for that user.

Results

The users and groups are modified or removed in the IBM Insights Foundation for Energy basic user registry.

What to do next

If you modified or removed user role groups, update the license mapping for the affected groups in the slmtag_groups.properties file on the application server. For more information, see Mapping groups to license types.

If you are an administrator, you can change access to pages and REST services in the solution based on the modified user role groups. For more information about configuring access control for pages and services, see the related links.

Parent topic: Securing the solution

Related tasks:

Configuring pages

Configuring REST services

Mapping groups to license typesIBM Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server.For more information about license usage metrics in IBM Insights Foundation for Energy, see License usage metricsIBM License Metric Tool helps Passport Advantage clients determine their full and sub-capacity PVU licensing requirements..To map a user role group to a license type, edit the slmtag_groups.properties file that is packaged in the ife_frwk_service WAR folder. There are two properties in the file: groups_StandardUser is the property for the standard user license, and groups_LimitedUser is the property for the limited user license.Log on to the application server as a user who has edit access to the slmtag_groups.properties file, for example, the root user.Edit the slmtag_groups.properties file. The default file content maps the admins sample group to the standard user license, and maps the users sample group to the limited user license:groups_StandardUser=admins groups_LimitedUser=usersTo map a group to the standard user license, add the group name as a value for the groups_StandardUser property. Use a comma as the delimiter between group names.For example, groups_StandardUser=standardUserGroup1,standardUserGroup2.To map a group to the limited user license, add the group name as a value for the groups_LimitedUser property. Use a comma as the delimiter between group names.For example, groups_LimitedUser=limitedUserGroup1,limitedUserGroup2.Usage information for the two types of licensed users in IBM Insights Foundation for Energy is generated for the IBM License Metric Tool.Securing the solutionSecuring your IBM Insights Foundation for Energy solution is an important consideration. To ensure that the system is secure, you must manage who can access the system and assign the correct level of access within the solution.

Mapping groups to license types

IBM® Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server.

Before you begin

For more information about license usage metrics in IBM Insights Foundation for Energy, see License usage metrics.

About this task

To map a user role group to a license type, edit the slmtag_groups.properties file that is packaged in the ife_frwk_service WAR folder. There are two properties in the file: groups_StandardUser is the property for the standard user license, and groups_LimitedUser is the property for the limited user license.

Procedure

Log on to the application server as a user who has edit access to the slmtag_groups.properties file, for example, the root user.

Edit the slmtag_groups.properties file. The default file content maps the admins sample group to the standard user license, and maps the users sample group to the limited user license:

groups_StandardUser=admins
groups_LimitedUser=users

To map a group to the standard user license, add the group name as a value for the groups_StandardUser property. Use a comma as the delimiter between group names. For example, groups_StandardUser=standardUserGroup1,standardUserGroup2.

To map a group to the limited user license, add the group name as a value for the groups_LimitedUser property. Use a comma as the delimiter between group names. For example, groups_LimitedUser=limitedUserGroup1,limitedUserGroup2.

Results

Usage information for the two types of licensed users in IBM Insights Foundation for Energy is generated for the IBM License Metric Tool.

Parent topic: Securing the solution

Use case: Define a new asset class in the Data Model applicationIn this tutorial, you are the administrator of a system and you have a new asset class called Meter as well as assets belonging to this asset class. You want to integrate the new asset class called Meter into IBM Insights Foundation for Energy. Assets belonging to this asset class need to be integrated into current system. These are the steps required to integrate the new asset class Meter into IBM Insights Foundation for Energy with the Data Model application.The custom data model application aims to help operators create and manage the asset classes and the measurement reading table.Defining the new asset class in the Data Model applicationYou can add new asset classes to the IBM Insights Foundation for Energy data model application and define the properties of the asset classes.Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.Prepare and load the dynamic dataPrepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

Use case: Define a new asset class in the Data Model application

In this tutorial, you are the administrator of a system and you have a new asset class called Meter as well as assets belonging to this asset class.

You want to integrate the new asset class called Meter into IBM Insights Foundation for Energy. Assets belonging to this asset class need to be integrated into current system. These are the steps required to integrate the new asset class Meter into IBM Insights Foundation for Energy with the Data Model application.

The custom data model application aims to help operators create and manage the asset classes and the measurement reading table.

Defining the new asset class in the Data Model application
You can add new asset classes to the IBM® Insights Foundation for Energy data model application and define the properties of the asset classes.

Prepare and load Static Data
When you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Prepare and load the dynamic data
Prepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.

Related concepts:

The Insights Foundation for Energy Data Model

Defining the new asset class in the Data Model applicationYou can add new asset classes to the IBM Insights Foundation for Energy data model application and define the properties of the asset classes.IBM Insights Foundation for Energy integrates data from different data sources, for example EAM System, GIS System. Data from different sources are consolidated into a common asset class and properties definitions. The mapping between an external object ID and an internal object ID is also maintained by IBM Insights Foundation for Energy.Use case: Define a new asset class in the Data Model applicationIn this tutorial, you are the administrator of a system and you have a new asset class called Meter as well as assets belonging to this asset class. Adding an asset classThe resource type is the category of the asset. In this use case the resource type is Meter. When you have created the resource type you can add meter instruments to this resource type.Defining the property type of an asset classYou must add the property type to the new asset class in IBM Insights Foundation for Energy. The attributes of the new resource type are stored in a database table called CIM.Meter.Adding a measurement reading table for use with asset classesThe measurement reading table is used to store the data from measurements made on an asset class.

Defining the new asset class in the Data Model application

You can add new asset classes to the IBM® Insights Foundation for Energy data model application and define the properties of the asset classes.

IBM Insights Foundation for Energy integrates data from different data sources, for example EAM System, GIS System. Data from different sources are consolidated into a common asset class and properties definitions. The mapping between an external object ID and an internal object ID is also maintained by IBM Insights Foundation for Energy.

Adding an asset class
The resource type is the category of the asset. In this use case the resource type is Meter. When you have created the resource type you can add meter instruments to this resource type.

Defining the property type of an asset class
You must add the property type to the new asset class in IBM Insights Foundation for Energy. The attributes of the new resource type are stored in a database table called CIM.Meter.

Adding a measurement reading table for use with asset classes
The measurement reading table is used to store the data from measurements made on an asset class.

Parent topic: Use case: Define a new asset class in the Data Model application

Adding an asset classThe resource type is the category of the asset. In this use case the resource type is Meter. When you have created the resource type you can add meter instruments to this resource type.To define a new asset class type, you need to add the asset class to the resource type table in the data base for IBM Insights Foundation for Energy.Open IBM Insights Foundation for Energy and select Custom data modelAsset Classes from the drop-down menu.On the Asset Classes tab, click Add New to open the attributes dialog box for the asset class.Type the code. The code is a unique alpha-numeric code for the asset class. The letters a to Z and numbers 0 to 9 are supported.Type the name of the new asset class. In the example Meter is the name of the asset class and is a globalization attribution. Click the edit icon and you will see the dialog. You can input one or more languages. Click the Save button to save the name.Type the table name. The table name is in the form <schema name>.<table name>, in the example, CIM.METER. Type the description for the asset class.Select the asset type. Each asset type has a setting for the isAsset and isResource attributes.Container, isAsset = 0isResource = 0Logical resourceisAsset = 0isResource = 1Physical assetisAsset = 1 isResource = 1Click Save.The asset type and asset table are created with four default attributes for each asset type: serial number, is Active, Installation data, remove date.Defining the new asset class in the Data Model applicationYou can add new asset classes to the IBM Insights Foundation for Energy data model application and define the properties of the asset classes.

Adding an asset class

The resource type is the category of the asset. In this use case the resource type is Meter. When you have created the resource type you can add meter instruments to this resource type.

About this task

To define a new asset class type, you need to add the asset class to the resource type table in the data base for IBM® Insights Foundation for Energy.

Procedure

Open IBM Insights Foundation for Energy and select Custom data model > Asset Classes from the drop-down menu.

On the Asset Classes tab, click Add New to open the attributes dialog box for the asset class.

Type the code. The code is a unique alpha-numeric code for the asset class. The letters a to Z and numbers 0 to 9 are supported.

Type the name of the new asset class. In the example Meter is the name of the asset class and is a globalization attribution. Click the edit icon and you will see the dialog. You can input one or more languages. Click the Save button to save the name.

Type the table name. The table name is in the form <schema name>.<table name>, in the example, CIM.METER.

Type the description for the asset class.

Select the asset type. Each asset type has a setting for the isAsset and isResource attributes.

Container,

isAsset = 0

isResource = 0

Logical resource

isAsset = 0

isResource = 1

Physical asset

isAsset = 1

isResource = 1

Click Save. The asset type and asset table are created with four default attributes for each asset type: serial number, is Active, Installation data, remove date.

Parent topic: Defining the new asset class in the Data Model application

Defining the property type of an asset classYou must add the property type to the new asset class in IBM Insights Foundation for Energy. The attributes of the new resource type are stored in a database table called CIM.Meter.You can edit an asset class when you click the edit button in a row.Click the Add New icon in the row for the asset class that you want to add a property to.Type the Code. The code is a unique alpha-numeric code for the asset type property. The letters a to Z and numbers 0 to 9 are supported.Type the name of the property type in the Column Name field. The column name is the name of the property using the letters a to Z and numbers 0 to 9 without spaces. For example if the Name of a property is Serial Number, then the Column Name is SERIALNUMBER.Type the length of the string Column Name in the Column Length field.Type the scale of the asset in the Column scale field.Type No in the Allow null field if you do not want the column to allow null values and you need a default value. If you do not need a default value, then type Yes.Click Save.Defining the new asset class in the Data Model applicationYou can add new asset classes to the IBM Insights Foundation for Energy data model application and define the properties of the asset classes.

Defining the property type of an asset class

You must add the property type to the new asset class in IBM® Insights Foundation for Energy. The attributes of the new resource type are stored in a database table called CIM.Meter.

About this task

You can edit an asset class when you click the edit button in a row.

Procedure

Click the Add New icon in the row for the asset class that you want to add a property to.

Type the Code. The code is a unique alpha-numeric code for the asset type property. The letters a to Z and numbers 0 to 9 are supported.

Type the name of the property type in the Column Name field. The column name is the name of the property using the letters a to Z and numbers 0 to 9 without spaces. For example if the Name of a property is Serial Number, then the Column Name is SERIALNUMBER.

Type the length of the string Column Name in the Column Length field.

Type the scale of the asset in the Column scale field.

Type No in the Allow null field if you do not want the column to allow null values and you need a default value. If you do not need a default value, then type Yes.

Click Save.

Parent topic: Defining the new asset class in the Data Model application

Adding a measurement reading table for use with asset classesThe measurement reading table is used to store the data from measurements made on an asset class.When you create one record, IBM Insights Foundation for Energy creates a measurement reading table in the database.Defining the new asset class in the Data Model applicationYou can add new asset classes to the IBM Insights Foundation for Energy data model application and define the properties of the asset classes.Defining the measurement type for an asset classYou can add a measurement type to an asset class.Defining a measurement reading for an asset classThe measurement reading defines the table name and description of the measurement. The measurement reading is used when defining the measurement type for an asset class.

Adding a measurement reading table for use with asset classes

The measurement reading table is used to store the data from measurements made on an asset class.

When you create one record, IBM Insights Foundation for Energy creates a measurement reading table in the database.

Defining the measurement type for an asset class
You can add a measurement type to an asset class.

Defining a measurement reading for an asset class
The measurement reading defines the table name and description of the measurement. The measurement reading is used when defining the measurement type for an asset class.

Parent topic: Defining the new asset class in the Data Model application

Defining the measurement type for an asset classYou can add a measurement type to an asset class.This procedure add a measurement type to the .csv reading file located here: /opt/IBM/energy/data/reading. The columns 1 and 2 are generated with default names, measurement and timestamp, you are creating additional measurement types from the names already created in the reading .csv file.In the list of Asset Classes select the row for the asset class you want to edit and click the Edit icon.Click the Measurement tab.In the Measurement Type field type the measurement description. The letter a to Z and the number 0 to 9 are supported.Select the target table.The target table is already defined in the data base. If not you can create a new measurement reading table.Click the Add New icon.Type the Code. The code is a column name in the .csv reading file. The code is a unique alpha-numeric code for the measurement type property. The letters a to Z and numbers 0 to 9 are supported.Select the Type. The type is the column type in the .csv file.Select the Target Column. This is the column in the database to where you want to import the .csv file.Click Savesave & back to exit.Adding a measurement reading table for use with asset classesThe measurement reading table is used to store the data from measurements made on an asset class.

Defining the measurement type for an asset class

You can add a measurement type to an asset class.

About this task

This procedure add a measurement type to the .csv reading file located here: /opt/IBM/energy/data/reading. The columns 1 and 2 are generated with default names, measurement and timestamp, you are creating additional measurement types from the names already created in the reading .csv file.

Procedure

In the list of Asset Classes select the row for the asset class you want to edit and click the Edit icon.

Click the Measurement tab.

In the Measurement Type field type the measurement description. The letter a to Z and the number 0 to 9 are supported.

Select the target table. The target table is already defined in the data base. If not you can create a new measurement reading table.

Click the Add New icon.

Type the Code. The code is a column name in the .csv reading file. The code is a unique alpha-numeric code for the measurement type property. The letters a to Z and numbers 0 to 9 are supported.

Select the Type. The type is the column type in the .csv file.

Select the Target Column. This is the column in the database to where you want to import the .csv file.

Click Save > save & back to exit.

Parent topic: Adding a measurement reading table for use with asset classes

Defining a measurement reading for an asset classThe measurement reading defines the table name and description of the measurement. The measurement reading is used when defining the measurement type for an asset class. In IBM Insights Foundation for Energy, select AdministrationCustom Data Model.Select the Measurement Reading tab, and click the Add New icon.Add the Table Name.The table name must contain an existing schema name and a table name, for example cim.testmeasurement.Add the Description of the measurement table.Click Save. Click the edit button to edit the newly created measurement reading table. You can add or delete table columns.Click save & back to exit.Adding a measurement reading table for use with asset classesThe measurement reading table is used to store the data from measurements made on an asset class.

Defining a measurement reading for an asset class

The measurement reading defines the table name and description of the measurement. The measurement reading is used when defining the measurement type for an asset class.

Procedure

In IBM Insights Foundation for Energy, select Administration > Custom Data Model.

Select the Measurement Reading tab, and click the Add New icon.

Add the Table Name.

The table name must contain an existing schema name and a table name, for example cim.testmeasurement.

Add the Description of the measurement table.

Click Save.

Click the edit button to edit the newly created measurement reading table. You can add or delete table columns.

Click save & back to exit.

Parent topic: Adding a measurement reading table for use with asset classes

Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.Use case: Define a new asset class in the Data Model applicationIn this tutorial, you are the administrator of a system and you have a new asset class called Meter as well as assets belonging to this asset class. Defining the data for the resourceThe resource data is saved in a .csv file that you need to create and add content to.Defining the terminal dataThe terminal data is saved in a .csv file that you need to create and add content to.Defining the connectivity node dataThe connectivity node data is saved in a .csv file that you need to create and add content to.Defining the measurement dataThe measurement data is saved in a .csv file that you need to create and add content to.Defining the asset dataThe asset data is saved in a .csv file that you need to create and add content to.Configuring the data loaderThe data loader needs to be configured and the config.properties file created. Loading the static data

Prepare and load Static Data

When you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Defining the data for the resource
The resource data is saved in a .csv file that you need to create and add content to.

Defining the terminal data
The terminal data is saved in a .csv file that you need to create and add content to.

Defining the connectivity node data
The connectivity node data is saved in a .csv file that you need to create and add content to.

Defining the measurement data
The measurement data is saved in a .csv file that you need to create and add content to.

Defining the asset data
The asset data is saved in a .csv file that you need to create and add content to.

Configuring the data loader
The data loader needs to be configured and the config.properties file created.

Loading the static data

Parent topic: Use case: Define a new asset class in the Data Model application

Defining the data for the resourceThe resource data is saved in a .csv file that you need to create and add content to.Go to /opt/IBM/energy/data/cityname/resources on the application server, and create a file called meter.csv.Add the following content to the file:<isActive>, <mRID>, <resourceType>,<name>,<description>,<isContainer>,<container>, <location>,<direction>,<mainAddress>,<phone1>,<phone2>,<secondaryAddress>, <locationDescription>,<geometry>The resource CSV file is loaded to the ObjectID, Resource and Location tables. The columns in the CSV file include: The columns in the .csv fileFieldTypeDescriptionisActiveCHAR(1)Indicates if the asset is currently active, 1 = active, 0 = inactive.mRIDVARCHAR(256)Master resource id. A string based identifier of the logical resource.resourceTypeVARCHAR(128)Code of the resource type defined in the ResourceType table.nameVARCHAR(128)The name of the logical resource.descriptionVARCHAR(512)The description of the logical resource.isContainerCHAR(1)Indicates if the logical resources is a container (has children), 0 not container, or 1 is container.containerVARCHAR(256)The Master resource id of the container of the logical resource.locationVARCHAR(256)The master resource id of the location.directionVARCHAR(32)The direction of a given asset. that shows field crews to quickly find a given asset. For example: NW shows to a field crew that a street light is located NW (northwest) of the customer's site.mainAddressVARCHAR(256)Main address of the location.phone1VARCHAR(32)Phone numberphone2VARCHAR(32)Phone numbersecondaryAddressVARCHAR(256)Secondary address of the location. For example, a PO Box address may have different ZIP code than that in the mainAddress.geometryGEOMETRYThe geometry of the resource in Well-Known Text (WKT), normally this information comes from the Geographical Information System (GIS).locationDescriptionVARCHAR(256)Description of the location.Here is a sample CSV section that needs to be added to the meter.csv file:isActive,mRID,resourceType,name,description,isContainer,container,location, direction,mainAddress,phone1,phone2,secondaryAddress, locationDescription,geometry 1,Meter_1813699,Meter,Meter_1813699,Meter_1813699,0,Substation_NIXON, Loc_Meter_1813699,,Southern Yellow Pine,,,,CCA, POINT (-83.4973760 42.5683241)Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Defining the data for the resource

The resource data is saved in a .csv file that you need to create and add content to.

Procedure

Go to /opt/IBM/energy/data/cityname/resources on the application server, and create a file called meter.csv.

Add the following content to the file:

<isActive>, <mRID>,
        <resourceType>,<name>,<description>,<isContainer>,<container>,
<location>,<direction>,<mainAddress>,<phone1>,<phone2>,<secondaryAddress>,
<locationDescription>,<geometry>

The resource CSV file is loaded to the ObjectID, Resource and Location tables. The columns in the CSV file include:

Table 5. The columns in the .csv file

Field | Type | Description
isActive | CHAR(1) | Indicates if the asset is currently active, 1 = active, 0 = inactive.
mRID | VARCHAR(256) | Master resource id. A string based identifier of the logical resource.
resourceType | VARCHAR(128) | Code of the resource type defined in the ResourceType table.
name | VARCHAR(128) | The name of the logical resource.
description | VARCHAR(512) | The description of the logical resource.
isContainer | CHAR(1) | Indicates if the logical resources is a container (has children), 0 not container, or 1 is container.
container | VARCHAR(256) | The Master resource id of the container of the logical resource.
location | VARCHAR(256) | The master resource id of the location.
direction | VARCHAR(32) | The direction of a given asset. that shows field crews to quickly find a given asset. For example: NW shows to a field crew that a street light is located NW (northwest) of the customer's site.
mainAddress | VARCHAR(256) | Main address of the location.
phone1 | VARCHAR(32) | Phone number
phone2 | VARCHAR(32) | Phone number
secondaryAddress | VARCHAR(256) | Secondary address of the location. For example, a PO Box address may have different ZIP code than that in the mainAddress.
geometry | GEOMETRY | The geometry of the resource in Well-Known Text (WKT), normally this information comes from the Geographical Information System (GIS).
locationDescription | VARCHAR(256) | Description of the location.

Here is a sample CSV section that needs to be added to the meter.csv file:

isActive,mRID,resourceType,name,description,isContainer,container,location,
direction,mainAddress,phone1,phone2,secondaryAddress,
locationDescription,geometry
1,Meter_1813699,Meter,Meter_1813699,Meter_1813699,0,Substation_NIXON,
Loc_Meter_1813699,,Southern Yellow Pine,,,,CCA,
POINT (-83.4973760 42.5683241)

Parent topic: Prepare and load Static Data

Defining the terminal dataThe terminal data is saved in a .csv file that you need to create and add content to.Go to /opt/IBM/energy/data/cityname/terminals on the application server, and create a file named meter.csv.Add the following content to the file:<isActive>,<mRID>,<name>,<description>,<sequenceNumber>, <connected>,<phases>,<resource>,<connectivityNode>The resource CSV file is loaded to the ObjectID, Resource and Location tables. The columns in the CSV file include:The columns in the .csv fileFieldTypeDescriptionisActiveCHAR(1)Delete tag, indicates if current terminal is active.mRIDVARCHAR(256)Master resource id. A string based identifier of the terminal.nameVARCHAR(128)The name of the terminal.descriptionVARCHAR(512)Description of terminal.sequenceNumberINTEGERThe sequence number of terminal. If a resource has multiple terminals, the sequence number is used to order the terminals in sequence.connectedCHAR(1)Indicates if the terminal is connected.phasesVARCHAR(32)The phases of the terminal.resourceVARCHAR(256)The mRID of the resource that the terminal is connected to.connectivityNodeVARCHAR(256)The mRID of the connectivity node that the terminal is connected to.The meter asset is connected to distribution transformer through terminals and connectivity nodes. If the meter Meter_1813699 is connected to the distribution transformer DT_101221, the terminal of Meter_1813699 is Terminal_Meter_1813699_1 and the terminal of DT_101221 is Terminal_DT_101221_2. The two terminals are both connected to connectivity node CN_cn85555. Below is a diagram for the connection information: Connectivity node with two terminals, one for the meter 1813699 and one for a distribution transformer 101221.Here is a sample csv that needs to be added to the meter.csv file.isActive,mRID,name,description,sequenceNumber,connected,phases, resource,connectivityNode "1","Terminal_Meter_1813699_1","Terminal 1","Terminal 1","1","1",, "Meter_1813699","CN_cn85555" "1","Terminal_DT_101221_2","Terminal 2", "Terminal 2","2","1",,"DT_101221","CN_cn85555"Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Defining the terminal data

The terminal data is saved in a .csv file that you need to create and add content to.

Procedure

Go to /opt/IBM/energy/data/cityname/terminals on the application server, and create a file named meter.csv.

Add the following content to the file:

<isActive>,<mRID>,<name>,<description>,<sequenceNumber>,
<connected>,<phases>,<resource>,<connectivityNode>

The resource CSV file is loaded to the ObjectID, Resource and Location tables. The columns in the CSV file include:

Table 6. The columns in the .csv file

Field | Type | Description
isActive | CHAR(1) | Delete tag, indicates if current terminal is active.
mRID | VARCHAR(256) | Master resource id. A string based identifier of the terminal.
name | VARCHAR(128) | The name of the terminal.
description | VARCHAR(512) | Description of terminal.
sequenceNumber | INTEGER | The sequence number of terminal. If a resource has multiple terminals, the sequence number is used to order the terminals in sequence.
connected | CHAR(1) | Indicates if the terminal is connected.
phases | VARCHAR(32) | The phases of the terminal.
resource | VARCHAR(256) | The mRID of the resource that the terminal is connected to.
connectivityNode | VARCHAR(256) | The mRID of the connectivity node that the terminal is connected to.

The meter asset is connected to distribution transformer through terminals and connectivity nodes. If the meter Meter_1813699 is connected to the distribution transformer DT_101221, the terminal of Meter_1813699 is Terminal_Meter_1813699_1 and the terminal of DT_101221 is Terminal_DT_101221_2. The two terminals are both connected to connectivity node CN_cn85555. Below is a diagram for the connection information:

Here is a sample csv that needs to be added to the meter.csv file.

isActive,mRID,name,description,sequenceNumber,connected,phases,
resource,connectivityNode
"1","Terminal_Meter_1813699_1","Terminal 1","Terminal 1","1","1",,
"Meter_1813699","CN_cn85555"
"1","Terminal_DT_101221_2","Terminal 2",
"Terminal 2","2","1",,"DT_101221","CN_cn85555"

Parent topic: Prepare and load Static Data

Defining the connectivity node dataThe connectivity node data is saved in a .csv file that you need to create and add content to.Go to /opt/IBM/energy/data/cityname/connectivityNodes on the application server, and create file called meter.csv.Add the following content to the file:<isActive>,<mRID>,<name>,<description>,<container>The connectivity node CSV file is loaded to the ObjectID, Resource and Location tables. The columns in the CSV file include: The columns in the .csv fileFieldTypeDescriptionisActiveCHAR(1)Indicates if the asset is currently active, 1 = active, 0 = inactive.mRIDVARCHAR(256)Master resource id. A string based identifier of the connectivity node.nameVARCHAR(128)The name of the connectivity node.descriptionVARCHAR(512)The description of the connectivity node.containerVARCHAR(256)The Master resource id of the container of the connectivity node.As the meter asset is connected to distribution transformer here is a sample csv section that needs to be added to meter.csv. In the teminal data file, it defines Meter_1813699 is connected to distribution transformer DT_101221, through 2 terminals and 1 connectivity node, so here below example defines the detail of the connectivity node. isActive,mRID,name,description,container "1","CN_cn85555","cn85555","cn5555","Substation_NIXON"Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Defining the connectivity node data

The connectivity node data is saved in a .csv file that you need to create and add content to.

Procedure

Go to /opt/IBM/energy/data/cityname/connectivityNodes on the application server, and create file called meter.csv.

Add the following content to the file:

<isActive>,<mRID>,<name>,<description>,<container>

The connectivity node CSV file is loaded to the ObjectID, Resource and Location tables. The columns in the CSV file include:

Table 7. The columns in the .csv file

Field | Type | Description
isActive | CHAR(1) | Indicates if the asset is currently active, 1 = active, 0 = inactive.
mRID | VARCHAR(256) | Master resource id. A string based identifier of the connectivity node.
name | VARCHAR(128) | The name of the connectivity node.
description | VARCHAR(512) | The description of the connectivity node.
container | VARCHAR(256) | The Master resource id of the container of the connectivity node.

As the meter asset is connected to distribution transformer here is a sample csv section that needs to be added to meter.csv. In the teminal data file, it defines Meter_1813699 is connected to distribution transformer DT_101221, through 2 terminals and 1 connectivity node, so here below example defines the detail of the connectivity node.

isActive,mRID,name,description,container
"1","CN_cn85555","cn85555","cn5555","Substation_NIXON"

Parent topic: Prepare and load Static Data

Defining the measurement dataThe measurement data is saved in a .csv file that you need to create and add content to.Go to /opt/IBM/energy/data/cityname/measurements on the application server, and create a file named meter.csv.Add the following content to the file:<mRID>,<isActive>,<name>,<measurementType>,<phaseCode>,<unitMultiplier>, <unitSymbol>,<resource>,<terminal>The measurement CSV file is loaded to the ObjectID and Measurement table. The columns in the CSV file include:Columns in the measurement tableFieldTypeDescriptionisActiveCHAR(1)Delete Tag. Indicates if current measurement is active.mRIDVARCHAR(256)Master resource ID. a string based identifier of the measurement.nameVARCHAR(128)The name of the measurement.measurementTypeVARCHAR(128)The type of measurement.phaseCodeVARCHAR(32)The phase code of the measurement.unitMultiplierVARCHAR(32)Multiplier of unit. For example: k indicates one thousand, if the symbol is V, then the fully qualified unit is kV.unitSymbolVARCHAR(32)The symbol of the unit. For example: V indicates voltage.resourceVARCHAR(256)The mRid of the logical resource that the measurement is measuring. terminalVARCHAR(256)The mRid of the terminal that the measurement is measuring. As the data of meter measurement indicates the power payload, the sample csv section needs to be added to meter.csv file. mRID,isActive,name,measurementType,phaseCode,unitMultiplier, unitSymbol,resource,terminal "M_MT_148610_Payload","1","PayLoad","PayLoad",,"none","none","Meter_1813699",Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Defining the measurement data

The measurement data is saved in a .csv file that you need to create and add content to.

Procedure

Go to /opt/IBM/energy/data/cityname/measurements on the application server, and create a file named meter.csv.

Add the following content to the file:

<mRID>,<isActive>,<name>,<measurementType>,<phaseCode>,<unitMultiplier>,
<unitSymbol>,<resource>,<terminal>

The measurement CSV file is loaded to the ObjectID and Measurement table. The columns in the CSV file include:

Table 8. Columns in the measurement table

Field | Type | Description
isActive | CHAR(1) | Delete Tag. Indicates if current measurement is active.
mRID | VARCHAR(256) | Master resource ID. a string based identifier of the measurement.
name | VARCHAR(128) | The name of the measurement.
measurementType | VARCHAR(128) | The type of measurement.
phaseCode | VARCHAR(32) | The phase code of the measurement.
unitMultiplier | VARCHAR(32) | Multiplier of unit. For example: k indicates one thousand, if the symbol is V, then the fully qualified unit is kV.
unitSymbol | VARCHAR(32) | The symbol of the unit. For example: V indicates voltage.
resource | VARCHAR(256) | The mRid of the logical resource that the measurement is measuring.
terminal | VARCHAR(256) | The mRid of the terminal that the measurement is measuring.

As the data of meter measurement indicates the power payload, the sample csv section needs to be added to meter.csv file.

mRID,isActive,name,measurementType,phaseCode,unitMultiplier,
unitSymbol,resource,terminal
"M_MT_148610_Payload","1","PayLoad","PayLoad",,"none","none","Meter_1813699",

Parent topic: Prepare and load Static Data

Defining the asset dataThe asset data is saved in a .csv file that you need to create and add content to.Go to /opt/IBM/energy/data/cityname/assets on the application server, and create file called meter.csv.Add the following content to the file:<mRID>,<serialNumber>,<isActive>,<installationDate>,<removalDate>, <manufacture>,<randomError>The columns in the .csv fileFieldTypeDescriptionmRIDVARCHAR(256)Master resource id. A string based identifier of the physical asset.serialNumberVARCHAR(128)The serial number of the physical asset.isActiveCHAR(1)Indicates if the assets is currently active, 1 = active, 0 = inactive.installationDateVARCHAR(512)Date when the asset was installed.removalDateVARCHAR(256)The date when the asset is to be removed.manufacturerManufacturer of the meter.randomErrorRandom error number of the meter.Here is the sample csv section that needs to be added to meter.csv file. mRID,serialNumber,isActive,installationDate,removalDate,manufacture,randomError Meter_1813699,1813699,1,1973-01-01,,ABC,4Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Defining the asset data

The asset data is saved in a .csv file that you need to create and add content to.

Procedure

Go to /opt/IBM/energy/data/cityname/assets on the application server, and create file called meter.csv.

Add the following content to the file:

<mRID>,<serialNumber>,<isActive>,<installationDate>,<removalDate>,
<manufacture>,<randomError>

Table 9. The columns in the .csv file

Field | Type | Description
mRID | VARCHAR(256) | Master resource id. A string based identifier of the physical asset.
serialNumber | VARCHAR(128) | The serial number of the physical asset.
isActive | CHAR(1) | Indicates if the assets is currently active, 1 = active, 0 = inactive.
installationDate | VARCHAR(512) | Date when the asset was installed.
removalDate | VARCHAR(256) | The date when the asset is to be removed.
manufacturer |  | Manufacturer of the meter.
randomError |  | Random error number of the meter.

Here is the sample csv section that needs to be added to meter.csv file.

mRID,serialNumber,isActive,installationDate,removalDate,manufacture,randomError
Meter_1813699,1813699,1,1973-01-01,,ABC,4

Parent topic: Prepare and load Static Data

Configuring the data loaderThe data loader needs to be configured and the config.properties file created. Create the contents for the config.properties file.Go to /opt/IBM/energy/data/cityname/ and create a file called config.properties.Add this content to the file for the resources/meter.cs to the adapters.1.file section.For example:#namespace of the data namespace=http://cityName# #number of rows of single insert/update batch=1000 #number of threadsconcurrency=10 #service url serviceBaseURL=https://<app_server_host_name>:<port_number> serviceUser=<user in EnergyAdmin group> servicePassword=<password> #adapter and load sequence #logical resources adapters.1.name=com.ibm.ife.framework.adapter.Resource adapters.1.file=resources/substation.csv,resources/meter.csv adapters.2.name=com.ibm.ife.framework.adapter.ConnectivityNode adapters.2.file=connectivityNodes/meter.csv adapters.3.name=com.ibm.ife.framework.adapter.Terminal adapters.3.file=terminals/meter.csv adapters.4.name=com.ibm.ife.framework.adapter.Measurement adapters.4.file=measurements/meter.csv #physical assets Adapters.5.name=com.ibm.ife.framework.adapter.Asset Adapters.5.file=assets/meter.csv Adapters.5.type=MeterWhere: The resource node /resources/meter.csv is in the adapters.1.file section.The connectivity node connectivityNodes/meter.csv is in the adapters.2.file section.The terminal terminals/meter.csv is in the adapters.3.name section.The measurement measurements/meter.csv is in the adapters.4.file section.The physical asset assets/meter.csv is in the adapters.5.file section.Make sure that the service base URL is HTTPS.Save the file config.properties.Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Configuring the data loader

The data loader needs to be configured and the config.properties file created.

About this task

Create the contents for the config.properties file.

Procedure

Go to /opt/IBM/energy/data/cityname/ and create a file called config.properties.

Add this content to the file for the resources/meter.cs to the adapters.1.file section. For example:

#namespace of the data
namespace=http://cityName#
#number of rows of single insert/update
batch=1000
#number of threadsconcurrency=10
#service url
serviceBaseURL=https://<app_server_host_name>:<port_number>
serviceUser=<user in EnergyAdmin group>
servicePassword=<password>

#adapter and load sequence
#logical resources
adapters.1.name=com.ibm.ife.framework.adapter.Resource
adapters.1.file=resources/substation.csv,resources/meter.csv

adapters.2.name=com.ibm.ife.framework.adapter.ConnectivityNode
adapters.2.file=connectivityNodes/meter.csv

adapters.3.name=com.ibm.ife.framework.adapter.Terminal
adapters.3.file=terminals/meter.csv

adapters.4.name=com.ibm.ife.framework.adapter.Measurement
adapters.4.file=measurements/meter.csv

#physical assets
Adapters.5.name=com.ibm.ife.framework.adapter.Asset
Adapters.5.file=assets/meter.csv
Adapters.5.type=Meter

Where:

The resource node /resources/meter.csv is in the adapters.1.file section.

The connectivity node connectivityNodes/meter.csv is in the adapters.2.file section.

The terminal terminals/meter.csv is in the adapters.3.name section.

The measurement measurements/meter.csv is in the adapters.4.file section.

The physical asset assets/meter.csv is in the adapters.5.file section.

Make sure that the service base URL is HTTPS.

Save the file config.properties.

Parent topic: Prepare and load Static Data

Loading the static dataFind the data loader tool in the application server: /opt/IBM/energy/data/runDataLoader.sh. Run the data loader tool to validate the .csv files with the following command:[root@ioc16-app data]# pwd /opt/IBM/energy/data root@ioc16-app data]# ./runDataLoader.sh validate <Path to data folder>If the .csv files pass validation, run the data loader with the following command: [root@ioc16-app data]# pwd /opt/IBM/energy/data root@ioc16-app data]# ./runDataLoader.sh <Path to data folder>Prepare and load Static DataWhen you have completed defining the new asset class Meter, you can prepare static data files, define the asset and load the data files to the database.

Loading the static data

About this task

Procedure

Find the data loader tool in the application server: /opt/IBM/energy/data/runDataLoader.sh.

Run the data loader tool to validate the .csv files with the following command:

[root@ioc16-app data]# pwd
/opt/IBM/energy/data
root@ioc16-app data]# ./runDataLoader.sh
validate <Path to data folder>

If the .csv files pass validation, run the data loader with the following command:

[root@ioc16-app data]# pwd
/opt/IBM/energy/data
root@ioc16-app data]# ./runDataLoader.sh <Path to data folder>

Parent topic: Prepare and load Static Data

Prepare and load the dynamic dataPrepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.Use case: Define a new asset class in the Data Model applicationIn this tutorial, you are the administrator of a system and you have a new asset class called Meter as well as assets belonging to this asset class. Defining the reading data fileConfiguring the data loader for the reading tableThe data loader needs to be configured for the reading table and the config.properties file created.Running the data loaderWhen you run the data loader it monitors csv files in the incoming folder. Valid measurements csv files are processed and put into the processed folder.Defining the asset styleYou can define icon of the the asset and how it will show on the map in IBM Insights Foundation for Energy.

Prepare and load the dynamic data

Prepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.

Defining the reading data file

Configuring the data loader for the reading table
The data loader needs to be configured for the reading table and the config.properties file created.

Running the data loader
When you run the data loader it monitors csv files in the incoming folder. Valid measurements csv files are processed and put into the processed folder.

Defining the asset style
You can define icon of the the asset and how it will show on the map in IBM® Insights Foundation for Energy.

Parent topic: Use case: Define a new asset class in the Data Model application

Defining the reading data fileThis example applies the same use case, the asset meter that has payload reading data. The reading data files needs to be defined. Create and create file called meterPayload.csv on the application server, and save it to a temporary location.Add the following content to the file:<mrid>,<timestamp>,<serialNumber>, <payload>Here is a sample CSV section that needs to be added to the meter.cs file:mRID,timestamp,serialNumber,payload M_MT_148610_Payload,2015-01-01 00:00:00.000,148610,20000Copy the meterPayload.csv file to this location /opt/IBM/energy/apps/simulator/incoming on the application server.Prepare and load the dynamic dataPrepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.

Defining the reading data file

About this task

This example applies the same use case, the asset meter that has payload reading data. The reading data files needs to be defined.

Procedure

Create and create file called meterPayload.csv on the application server, and save it to a temporary location.

Add the following content to the file:

<mrid>,<timestamp>,<serialNumber>, <payload>

Here is a sample CSV section that needs to be added to the meter.cs file:

mRID,timestamp,serialNumber,payload
M_MT_148610_Payload,2015-01-01 00:00:00.000,148610,20000

Copy the meterPayload.csv file to this location /opt/IBM/energy/apps/simulator/incoming on the application server.

Parent topic: Prepare and load the dynamic data

Configuring the data loader for the reading tableThe data loader needs to be configured for the reading table and the config.properties file created.Go to /opt/IBM/energy/data/reading/ and create the config.properties file, or open the file if it already exists.Edit the config.properties file. For example:#namespace of the datanamespace=http://cityName# #number of rows of single insert/update batch=1000 #number of threads concurrency=10 #service url serviceBaseURL=https://<app_server_host_name>:<port_number> serviceUser=<user in EnergyAdmin group>service Password=<password> #adapter and load sequence #logical resources adapters.1.name=com.ibm.ife.framework.adapter.Reading adapters.1.file=meterPayload.csv.del adapters.1.resourceTypeCode=Meter adapters.1.measurementType=PayLoadMake sure that the service base URL is HTTPS.Save the file config.properties.Prepare and load the dynamic dataPrepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.

Configuring the data loader for the reading table

The data loader needs to be configured for the reading table and the config.properties file created.

Procedure

Go to /opt/IBM/energy/data/reading/ and create the config.properties file, or open the file if it already exists.

Edit the config.properties file. For example:

#namespace of the datanamespace=http://cityName#
#number of rows of single insert/update
batch=1000
#number of threads
concurrency=10
#service url
serviceBaseURL=https://<app_server_host_name>:<port_number>
serviceUser=<user in EnergyAdmin group>service
Password=<password>

#adapter and load sequence
#logical resources
adapters.1.name=com.ibm.ife.framework.adapter.Reading
adapters.1.file=meterPayload.csv.del
adapters.1.resourceTypeCode=Meter
adapters.1.measurementType=PayLoad

Make sure that the service base URL is HTTPS.

Save the file config.properties.

Parent topic: Prepare and load the dynamic data

Running the data loaderWhen you run the data loader it monitors csv files in the incoming folder. Valid measurements csv files are processed and put into the processed folder.Find the data loader tool in the application server: /opt/IBM/energy/data/runDataLoader.sh.Run the data loader tool to validate csv files with the following command:[root@ioc16-app data]# pwd /opt/IBM/energy/dataroot@ioc16-app data ]#./runDataLoader.sh validate <Path to data folder>If validation passed, run the data loader tool with the following command:[root@ioc16-app data]# pwd /opt/IBM/energy/data root@ioc16-app data]# ./runDataLoader.sh <Path to data folder>Prepare and load the dynamic dataPrepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.

Running the data loader

When you run the data loader it monitors csv files in the incoming folder. Valid measurements csv files are processed and put into the processed folder.

Procedure

Find the data loader tool in the application server: /opt/IBM/energy/data/runDataLoader.sh.

Run the data loader tool to validate csv files with the following command:

[root@ioc16-app data]# pwd
/opt/IBM/energy/dataroot@ioc16-app data
]#./runDataLoader.sh
validate <Path to data folder>

If validation passed, run the data loader tool with the following command:

[root@ioc16-app data]# pwd
/opt/IBM/energy/data
root@ioc16-app data]# ./runDataLoader.sh <Path to data folder>

Parent topic: Prepare and load the dynamic data

Defining the asset styleYou can define icon of the the asset and how it will show on the map in IBM Insights Foundation for Energy.The steps here are to illustrate the asset Meter.Go to the database, and open the AHA.ASSETSTYLE table.Edit the table for the asset Meter.ASSETTYPE 21, the resource type ID is 21.GEOTYPE 0, the meter shops as a point on the map. If 1, then it shows as a line.SHAPE, you decide what kind of icon you want to represent the asset on the map. You can also add your own icons here: /opt/IBM/WebSphere/Liberty/usr/servers/member01/apps/ife_aha_mig_app.ear/ife_aha_web.war/iconMINSIZE and MAXSIZE defines the size of the icon.DEVIDESCALE, keep empty Define asset type styleThe asset type Meter is defined.Prepare and load the dynamic dataPrepare the data files and tables for the dynamic data, load the dynamic data and define the asset style.

Defining the asset style

You can define icon of the the asset and how it will show on the map in IBM® Insights Foundation for Energy.

About this task

The steps here are to illustrate the asset Meter.

Procedure

Go to the database, and open the AHA.ASSETSTYLE table.

Edit the table for the asset Meter.

ASSETTYPE 21, the resource type ID is 21.

GEOTYPE 0, the meter shops as a point on the map. If 1, then it shows as a line.

SHAPE, you decide what kind of icon you want to represent the asset on the map. You can also add your own icons here: /opt/IBM/WebSphere/Liberty/usr/servers/member01/apps/ife_aha_mig_app.ear/ife_aha_web.war/icon

MINSIZE and MAXSIZE defines the size of the icon.

DEVIDESCALE, keep empty

Figure 1. Define asset type style

Parent topic: Prepare and load the dynamic data

Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid. IBM Insights Foundation for Energy is a web-based solution that uses portal technology. You can access the solution with any supported web browser. Assets can be viewed on a geospatial map or as a list. The displayed assets can be filtered using criteria specified by the user. Detailed reports can be displayed for individual assets, or groups of assets. The User Interface The application user interface is composed of four parts:Filter bar - to filter assets for different criteria, e.g. status, asset class, geography.Task bar - to show or hide the filter bar, legend panel, or switch between the content to map, list or report view.Content area - to visualize differing approaches of assets, including map, list, and report views.Legend panel - to show the different asset classes and the score ranges the representative colors.User interfaceshows filter and task bars, and content area and filter panelLogging on to the Asset Health applicationLog on to access the IBM Insights Foundation for Energy user interface.Task barThe task bar contains the controls for how the various panels and filter options show in user interface.Filter barThe filter bar contains the controls to filter assets for different criteria, e.g. status, asset class, geography.Viewing assets on a mapAssets and their connections within the energy network can be seen on a geographic map. Depending on the zoom level, either individual assets and their health, or an aggregation of assets and the health of the combined assets are displayed.Viewing assets as a listAssets and their network health and risk values can be displayed as a list. Filtering assetsThe assets displayed on the map or list can be filtered based on selected criteria.Preview cardsWhen a user clicks on an asset or region, a preview card is displayed with additional information on that asset or region.Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.Viewing asset reportsYou can view detailed reports on a single asset or on a group of assets.Exporting dataAfter filtering the data to the desired subset, information on the selected assets can be exported for use in other systems.Creating input for a rate use caseUsing IBM Insights Foundation for Energy, regional planning engineers determine where investment is required to maintain or improve reliability.

Viewing and analyzing energy data

Use IBM® Insights Foundation for Energy to analyze the health and risks to the network grid.

IBM Insights Foundation for Energy is a web-based solution that uses portal technology. You can access the solution with any supported web browser.

Assets can be viewed on a geospatial map or as a list. The displayed assets can be filtered using criteria specified by the user.

Detailed reports can be displayed for individual assets, or groups of assets.

The User Interface

The application user interface is composed of four parts:

Filter bar - to filter assets for different criteria, e.g. status, asset class, geography.

Task bar - to show or hide the filter bar, legend panel, or switch between the content to map, list or report view.

Content area - to visualize differing approaches of assets, including map, list, and report views.

Legend panel - to show the different asset classes and the score ranges the representative colors.

Figure 2. User interfaceshows filter and task bars, and content area and filter panel

Logging on to the Asset Health application
Log on to access the IBM Insights Foundation for Energy user interface.

Task bar
The task bar contains the controls for how the various panels and filter options show in user interface.

Filter bar
The filter bar contains the controls to filter assets for different criteria, e.g. status, asset class, geography.

Viewing assets on a map
Assets and their connections within the energy network can be seen on a geographic map. Depending on the zoom level, either individual assets and their health, or an aggregation of assets and the health of the combined assets are displayed.

Viewing assets as a list
Assets and their network health and risk values can be displayed as a list.

Filtering assets
The assets displayed on the map or list can be filtered based on selected criteria.

Preview cards
When a user clicks on an asset or region, a preview card is displayed with additional information on that asset or region.

Using the Connectivity Model
The Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

Viewing asset reports
You can view detailed reports on a single asset or on a group of assets.

Exporting data
After filtering the data to the desired subset, information on the selected assets can be exported for use in other systems.

Creating input for a rate use case
Using IBM Insights Foundation for Energy, regional planning engineers determine where investment is required to maintain or improve reliability.

Logging on to the Asset Health applicationLog on to access the IBM Insights Foundation for Energy user interface.Contact your local administrator to obtain your user ID and password. Your administrator is responsible for ensuring that you have the security access level that is appropriate to your role in your organization. Your administrator will also supply you with the web address URL for accessing the solution portal.Use the following procedure to start a new browser session and access IBM Insights Foundation for Energy.Enter the URL into the address field of the browser.The fully qualified domain name is required in the URL, for example, https://web_hostname/wps/myportal where web_hostname is the host name of the web server. If you use the IP address instead of the registered fully qualified domain name, some windows do not open correctly. Also, if you do not use the https protocol, the link is redirected to use the https protocol.On the login page, enter your user ID and password.Click Log In.Click the down arrow at the top left hand corner, and click Energy Asset Health.Only the pages, features, and data that you have permission to access are displayed. Contact your administrator if you require more access.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.

Logging on to the Asset Health application

Log on to access the IBM® Insights Foundation for Energy user interface.

Before you begin

Contact your local administrator to obtain your user ID and password. Your administrator is responsible for ensuring that you have the security access level that is appropriate to your role in your organization. Your administrator will also supply you with the web address URL for accessing the solution portal.

About this task

Use the following procedure to start a new browser session and access IBM Insights Foundation for Energy.

Procedure

Enter the URL into the address field of the browser.

Note: The fully qualified domain name is required in the URL, for example, https://web_hostname/wps/myportal where web_hostname is the host name of the web server. If you use the IP address instead of the registered fully qualified domain name, some windows do not open correctly. Also, if you do not use the https protocol, the link is redirected to use the https protocol.

On the login page, enter your user ID and password.

Click Log In.

Click the down arrow at the top left hand corner, and click Energy > Asset Health.

Results

Only the pages, features, and data that you have permission to access are displayed. Contact your administrator if you require more access.

Parent topic: Viewing and analyzing energy data

Task barThe task bar contains the controls for how the various panels and filter options show in user interface.You can select how various panels, maps and reports show and also you can select the filter options that are available.map icon Map - used to select the map view.List icon List - used to show the data as a list.Report icon Report - used to show the summary and treatment asset reports.Filter icon Filter - used to show the filter bar for the filter options.legend icon Legend - used to show or hide the legend panel on the content area.Export icon Export - used to export the list view as CSV or XLSX file, or a report as PDF or XLSX file.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Exporting dataAfter filtering the data to the desired subset, information on the selected assets can be exported for use in other systems.

Task bar

The task bar contains the controls for how the various panels and filter options show in user interface.

You can select how various panels, maps and reports show and also you can select the filter options that are available.

map icon Map - used to select the map view.

List icon List - used to show the data as a list.

Report icon Report - used to show the summary and treatment asset reports.

Filter icon Filter - used to show the filter bar for the filter options.

legend icon Legend - used to show or hide the legend panel on the content area.

Export icon Export - used to export the list view as CSV or XLSX file, or a report as PDF or XLSX file.

Parent topic: Viewing and analyzing energy data

Related tasks:

Exporting data

Filter barThe filter bar contains the controls to filter assets for different criteria, e.g. status, asset class, geography.You can select the filter control options that are available. The predefined filters are:Time - The period of time for the assets that you want to view.Score type - There are four types: Health, Risk, Failure and Consequences. where Health is the asset health as a percentage, Failure is probability of failure, Consequence is the consequence of failure.Status - Filters for the status for the score type you selected. There are four states, Critical, Warning, OK, No scoreGeography - Filters the area map that you require.Asset class - Shows the asset class that you want to view for the geographical area.Advanced - You can add your many filters and decide if they should be an And relationship or Or relationship by choosing All criteria or Any criteria.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Filtering assetsThe assets displayed on the map or list can be filtered based on selected criteria.

Filter bar

The filter bar contains the controls to filter assets for different criteria, e.g. status, asset class, geography.

You can select the filter control options that are available. The predefined filters are:

Time - The period of time for the assets that you want to view.

Score type - There are four types: Health, Risk, Failure and Consequences. where Health is the asset health as a percentage, Failure is probability of failure, Consequence is the consequence of failure.

Status - Filters for the status for the score type you selected. There are four states, Critical, Warning, OK, No score

Geography - Filters the area map that you require.

Asset class - Shows the asset class that you want to view for the geographical area.

Advanced - You can add your many filters and decide if they should be an And relationship or Or relationship by choosing All criteria or Any criteria.

Parent topic: Viewing and analyzing energy data

Related tasks:

Filtering assets

Viewing assets on a mapAssets and their connections within the energy network can be seen on a geographic map. Depending on the zoom level, either individual assets and their health, or an aggregation of assets and the health of the combined assets are displayed.Sign on IBM Insights Foundation for Energy as a user.If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.In the task bar at the bottom of the page click Map.The map is displayed.Zoom in or out of the map to see your desired view. IBM Insights Foundation for Energy displays assets and their selected filtered score as individual icons. If there are too many assets to be displayed individual icons, icons are grouped into predefined regions and the overall score for the region is displayed. Optionally you can click on a region and click Zoom-In in the preview card to display the assets of the region.For further information on the asset or area, click the asset or area. A preview card with additional information and options is displayed.If too many assets are displayed, change the filter values and click Apply. The assets meeting the filter criteria will be displayed in the map.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Viewing the legendA legend showing the icons used for the various assets and the colors indicating their status can be displayed.

Viewing assets on a map

Assets and their connections within the energy network can be seen on a geographic map. Depending on the zoom level, either individual assets and their health, or an aggregation of assets and the health of the combined assets are displayed.

Procedure

Sign on IBM® Insights Foundation for Energy as a user.

If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.

In the task bar at the bottom of the page click Map. The map is displayed.

Zoom in or out of the map to see your desired view. IBM Insights Foundation for Energy displays assets and their selected filtered score as individual icons. If there are too many assets to be displayed individual icons, icons are grouped into predefined regions and the overall score for the region is displayed. Optionally you can click on a region and click Zoom-In in the preview card to display the assets of the region.

For further information on the asset or area, click the asset or area. A preview card with additional information and options is displayed.

If too many assets are displayed, change the filter values and click Apply. The assets meeting the filter criteria will be displayed in the map.

Viewing the legend
A legend showing the icons used for the various assets and the colors indicating their status can be displayed.

Parent topic: Viewing and analyzing energy data

Viewing the legendA legend showing the icons used for the various assets and the colors indicating their status can be displayed.If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.In the task bar click Legend.The legend is displayed.To control which assets are displayed, select and deselect the icon to the left of the asset label in the legend.To dismiss the legend, click Legend in the task bar again.Viewing assets on a mapAssets and their connections within the energy network can be seen on a geographic map. Depending on the zoom level, either individual assets and their health, or an aggregation of assets and the health of the combined assets are displayed.Filtering assetsThe assets displayed on the map or list can be filtered based on selected criteria.

Viewing the legend

A legend showing the icons used for the various assets and the colors indicating their status can be displayed.

About this task

Procedure

If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.

In the task bar click Legend. The legend is displayed.

To control which assets are displayed, select and deselect the icon to the left of the asset label in the legend.

To dismiss the legend, click Legend in the task bar again.

Parent topic: Viewing assets on a map

Related tasks:

Filtering assets

Viewing assets as a listAssets and their network health and risk values can be displayed as a list. Sign on IBM Insights Foundation for Energy as a user.If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.In the task bar click List.The list is displayed.IBM Insights Foundation for Energy displays assets and their health status as individual table rows. The table can be sorted by clicking on the desired table header. The list will be redisplayed sorted by that field. For further information on the asset, click the asset. A preview card with additional information and options is displayed. If too many assets are displayed, change the filter values and click Apply. The assets meeting the filter criteria will be displayed in the list.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.

Viewing assets as a list

Assets and their network health and risk values can be displayed as a list.

Procedure

Sign on IBM® Insights Foundation for Energy as a user.

If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.

In the task bar click List. The list is displayed.

IBM Insights Foundation for Energy displays assets and their health status as individual table rows. The table can be sorted by clicking on the desired table header. The list will be redisplayed sorted by that field.

For further information on the asset, click the asset. A preview card with additional information and options is displayed.

If too many assets are displayed, change the filter values and click Apply. The assets meeting the filter criteria will be displayed in the list.

Parent topic: Viewing and analyzing energy data

Filtering assetsThe assets displayed on the map or list can be filtered based on selected criteria.IBM Insights Foundation for Energy has the following predefined filter options:Analysis YearGeographyScore Type, where Health is the asset health, Failure is probability of failure, Consequence is the consequence of failure.StatusAsset ClassAdditional filter criteria can be specified using the Advanced option.To reduce the number of displayed assets to those meeting the desired criteria, do the following. If the filter bar is not displayed at the top of the page, click the Filter option in the task bar on the bottom of the page. If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.Click the desired filter option and select the desired value.Click Apply.The map or list view will display the assets meeting the selected filter criteria.To clear all filter values, click Reset All.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Searching for an assetYou can reduce the number of displayed assets to those meeting the desired criteria.Adding additional filter criteriaIn addition to the provided filters, you can specify your own criteria to filter the data displayed in the map and listFilter barThe filter bar contains the controls to filter assets for different criteria, e.g. status, asset class, geography.Viewing the legendA legend showing the icons used for the various assets and the colors indicating their status can be displayed.

Filtering assets

The assets displayed on the map or list can be filtered based on selected criteria.

About this task

IBM® Insights Foundation for Energy has the following predefined filter options:

Analysis Year

Geography

Score Type, where Health is the asset health, Failure is probability of failure, Consequence is the consequence of failure.

Status

Asset Class

Additional filter criteria can be specified using the Advanced option.

To reduce the number of displayed assets to those meeting the desired criteria, do the following.

Procedure

If the filter bar is not displayed at the top of the page, click the Filter option in the task bar on the bottom of the page. If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.

Click the desired filter option and select the desired value.

Click Apply.

Results

The map or list view will display the assets meeting the selected filter criteria.

What to do next

To clear all filter values, click Reset All.

Searching for an asset
You can reduce the number of displayed assets to those meeting the desired criteria.

Adding additional filter criteria
In addition to the provided filters, you can specify your own criteria to filter the data displayed in the map and list

Parent topic: Viewing and analyzing energy data

Related concepts:

Filter bar

Related tasks:

Viewing the legend

Searching for an assetInsights Foundation for Energy|Searching for an assetYou can reduce the number of displayed assets to those meeting the desired criteria.If the filter bar is not displayed at the top of the page, click the Filter option from the task bar on the bottom of the page. If the task bar is not displayed, click the arrow in the circle on the bottom of the page.In the search bar, input a string value that is part of the asset name you want to find. Related assets are listed on the search bar as search result, click on the asset to display it on the map.Filtering assetsThe assets displayed on the map or list can be filtered based on selected criteria.

Searching for an asset

You can reduce the number of displayed assets to those meeting the desired criteria.

Procedure

If the filter bar is not displayed at the top of the page, click the Filter option from the task bar on the bottom of the page.

If the task bar is not displayed, click the arrow in the circle on the bottom of the page.

In the search bar, input a string value that is part of the asset name you want to find.

Results

Related assets are listed on the search bar as search result, click on the asset to display it on the map.

Parent topic: Filtering assets

Adding additional filter criteriaIn addition to the provided filters, you can specify your own criteria to filter the data displayed in the map and list If the filter bar is not displayed at the top of the page, click the Filter option in the task bar. If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.Click Advanced.This option can only be selected when one or more asset classes is selected in the Asset Class filter.Click Add Filter.From the drop-down fields select the desired criteria.Repeat the steps if multiple criteria are desired. If multiple criteria are desired, indicate if all conditions must be true (All criteria) for an asset to be selected or if only one of the conditions must be true (Any criteria).The map or list view will display the assets meeting the selected filter criteria.When additional filter criteria have been specified, the Advanced option in the filter bar indicates the number of additional filters that have been defined in parenthesis. To clear the advanced filter criteria, click Advanced in the filter bar and then click Clear All. To clear all filter values, click Reset All in the filter bar.Filtering assetsThe assets displayed on the map or list can be filtered based on selected criteria.

Adding additional filter criteria

In addition to the provided filters, you can specify your own criteria to filter the data displayed in the map and list

Procedure

If the filter bar is not displayed at the top of the page, click the Filter option in the task bar. If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.

Click Advanced. This option can only be selected when one or more asset classes is selected in the Asset Class filter.

Click Add Filter.

From the drop-down fields select the desired criteria.

Repeat the steps if multiple criteria are desired. If multiple criteria are desired, indicate if all conditions must be true (All criteria) for an asset to be selected or if only one of the conditions must be true (Any criteria).

Results

The map or list view will display the assets meeting the selected filter criteria.

What to do next

When additional filter criteria have been specified, the Advanced option in the filter bar indicates the number of additional filters that have been defined in parenthesis. To clear the advanced filter criteria, click Advanced in the filter bar and then click Clear All. To clear all filter values, click Reset All in the filter bar.

Parent topic: Filtering assets

Preview cardsWhen a user clicks on an asset or region, a preview card is displayed with additional information on that asset or region.If a region containing multiple assets is selected, the preview card will display the average scores for the region, the total number of assets by class within the region, and available actions.If a single asset is selected, the preview card will display the scores for that asset as well as available actions. Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.

Preview cards

When a user clicks on an asset or region, a preview card is displayed with additional information on that asset or region.

If a region containing multiple assets is selected, the preview card will display the average scores for the region, the total number of assets by class within the region, and available actions.

If a single asset is selected, the preview card will display the scores for that asset as well as available actions.

Parent topic: Viewing and analyzing energy data

Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.The Connectivity Model application ensures:The model is always current: The user is sure that the connectivity model represents the latest analytic results.The connectivity and reliability of information is quickly ascertained: The user can fully understand the state of assets in the network within 5 minutes or less. The network details are simplified: The user can focus on the assets and connections that are important to them.The analysis details can be reported and shared: The users can collect the necessary charts or maps, and download and share them with the key stakeholders.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Logging onto the Connectivity Model applicationLog on to access the IBM Insights Foundation for Energy user interface for the Connectivity Model application.Viewing the legend of the connectivity model applicationThe legend shows the icons used for the assets in the connectivity model and the colors indicating their status.Viewing the information of a substation with all its connectionsYou can view a substation with all the connected transformers, meters, and Viewing all meter mismatches of a transformerYou can view the miss-matched information in general and in greater detail.Exporting the asset information of a utilityYou can export the meter or transformer detail information to a local system as a csv file.

Using the Connectivity Model

The Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

The Connectivity Model application ensures:

The model is always current: The user is sure that the connectivity model represents the latest analytic results.

The connectivity and reliability of information is quickly ascertained: The user can fully understand the state of assets in the network within 5 minutes or less.

The network details are simplified: The user can focus on the assets and connections that are important to them.

The analysis details can be reported and shared: The users can collect the necessary charts or maps, and download and share them with the key stakeholders.

Logging onto the Connectivity Model application
Log on to access the IBM Insights Foundation for Energy user interface for the Connectivity Model application.

Viewing the legend of the connectivity model application
The legend shows the icons used for the assets in the connectivity model and the colors indicating their status.

Viewing the information of a substation with all its connections
You can view a substation with all the connected transformers, meters, and

Viewing all meter mismatches of a transformer
You can view the miss-matched information in general and in greater detail.

Exporting the asset information of a utility
You can export the meter or transformer detail information to a local system as a csv file.

Parent topic: Viewing and analyzing energy data

Logging onto the Connectivity Model applicationLog on to access the IBM Insights Foundation for Energy user interface for the Connectivity Model application.Contact your local administrator to obtain your user ID and password. Your administrator is responsible for ensuring that you have the security access level that is appropriate to your role in your organization. Your administrator will also supply you with the web address URL for accessing the solution portal.Use the following procedure to start a new browser session and access IBM Insights Foundation for Energy.Enter the URL into the address field of the browser.The fully qualified domain name is required in the URL, for example, https://web_hostname/wps/myportal where web_hostname is the host name of the web server. If you use the IP address instead of the registered fully qualified domain name, some windows do not open correctly. Also, if you do not use the https protocol, the link is redirected to use the https protocol.On the login page, enter your user ID and password.Click Log In.Click the down arrow at the top left hand corner, and click Energy Connectivity Model.Only the pages, features, and data that you have permission to access are displayed. Contact your administrator if you require more access.Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

Logging onto the Connectivity Model application

Log on to access the IBM® Insights Foundation for Energy user interface for the Connectivity Model application.

Before you begin

Contact your local administrator to obtain your user ID and password. Your administrator is responsible for ensuring that you have the security access level that is appropriate to your role in your organization. Your administrator will also supply you with the web address URL for accessing the solution portal.

About this task

Use the following procedure to start a new browser session and access IBM Insights Foundation for Energy.

Procedure

Enter the URL into the address field of the browser.

Note: The fully qualified domain name is required in the URL, for example, https://web_hostname/wps/myportal where web_hostname is the host name of the web server. If you use the IP address instead of the registered fully qualified domain name, some windows do not open correctly. Also, if you do not use the https protocol, the link is redirected to use the https protocol.

On the login page, enter your user ID and password.

Click Log In.

Click the down arrow at the top left hand corner, and click Energy > Connectivity Model.

Results

Only the pages, features, and data that you have permission to access are displayed. Contact your administrator if you require more access.

Parent topic: Using the Connectivity Model

Viewing the legend of the connectivity model applicationInsights Foundation for Energy | Viewing the legendThe legend shows the icons used for the assets in the connectivity model and the colors indicating their status.Via the legend you can filter the assets that show on the map for the connectivity model. The assets that show in the legend are: Electric StationTransformerMeterLateralsMeter LinkageLegend for Connectivity ModelThe eye icon hides or displays the asset type on the map. The polygon represents the asset type on the map.Select Connectivity Model from the menu bar.Click Select Utility from the drop down menu and select the utility you need.The list of associated substations show.Click the substation that you need to view with the associated meters.The substation shows at the top level of the substation menu bar.Click the up arrow in substation menu bar to open the legend.Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

Viewing the legend of the connectivity model application

The legend shows the icons used for the assets in the connectivity model and the colors indicating their status.

About this task

Via the legend you can filter the assets that show on the map for the connectivity model. The assets that show in the legend are:

Electric Station

Transformer

Meter

Laterals

Meter Linkage

Figure 3. Legend for Connectivity Model

The eye icon hides or displays the asset type on the map.

The polygon represents the asset type on the map.

Procedure

Select Connectivity Model from the menu bar.

Click Select Utility from the drop down menu and select the utility you need. The list of associated substations show.

Click the substation that you need to view with the associated meters. The substation shows at the top level of the substation menu bar.

Click the up arrow in substation menu bar to open the legend.

Parent topic: Using the Connectivity Model

Viewing the information of a substation with all its connectionsYou can view a substation with all the connected transformers, meters, and After you have selected utility, you can see all the substations in the selected utility. The substation information contains two parts. The name of the substation.The total number of asset phase and connection errors if errors are present.You can also see the substations of the selected utility on the map.In Insights Foundation for Energy, click Select a Utility. Click the utility you want to view.To search for a certain sub-station, in the search field type a letter contained in the name of the sub-station.Click on the name of the sub-station you want to view.Zoom in on the map to see the clusters of transformers connected to the sub station, and again to see the clusters of meters connected to the transformers.Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

Viewing the information of a substation with all its connections

You can view a substation with all the connected transformers, meters, and

About this task

After you have selected utility, you can see all the substations in the selected utility. The substation information contains two parts.

The name of the substation.

The total number of asset phase and connection errors if errors are present.

You can also see the substations of the selected utility on the map.

Procedure

In Insights Foundation for Energy, click Select a Utility.

Click the utility you want to view.

To search for a certain sub-station, in the search field type a letter contained in the name of the sub-station.

Click on the name of the sub-station you want to view.

Zoom in on the map to see the clusters of transformers connected to the sub station, and again to see the clusters of meters connected to the transformers.

Parent topic: Using the Connectivity Model

Viewing all meter mismatches of a transformerYou can view the miss-matched information in general and in greater detail.The hover function returns the general detail of miss-matches: the number of meters that have miss matched information, the name of the sub-station as the feeder for the transformer and the supply phase for the meters.The detail of the transformer with the hover function The preview panel for the transformer gives more detail information: the title, logical map, transformer information, search bar and meter detail information. The logical map shows the connectivity between the feeder, transformer, and meter. Details of the preview panelIn Insights Foundation for Energy, click Select a Utility. Click the utility you want to view.To search for a certain sub-station, in the search field type a letter contained in the name of the sub-station.Click on the name of the sub-station you want to view.Zoom in on the map to see the clusters of transformers connected to the sub station, and again to see the clusters of meters connected to the transformers.Hover over a transformer on the map to see the general details of a transformer.Click on the transformer to see the preview panel for the transformer.To view a sub-station with all the transformers.Click the sub-station on the logical map to see all the transformers that are fed by the sub-station. To view a certain transformer, type part of the name for the transformer in the search bar.Click the transformer name in the results field.To view the details of all the meters fed by a transformer.Click the Meters on the logical map.Click the meter you want to view.Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

Viewing all meter mismatches of a transformer

You can view the miss-matched information in general and in greater detail.

About this task

The hover function returns the general detail of miss-matches: the number of meters that have miss matched information, the name of the sub-station as the feeder for the transformer and the supply phase for the meters.

Figure 4. The detail of the transformer with the hover function

The preview panel for the transformer gives more detail information: the title, logical map, transformer information, search bar and meter detail information. The logical map shows the connectivity between the feeder, transformer, and meter.

Figure 5. Details of the preview panel

Procedure

In Insights Foundation for Energy, click Select a Utility.

Click the utility you want to view.

To search for a certain sub-station, in the search field type a letter contained in the name of the sub-station.

Click on the name of the sub-station you want to view.

Zoom in on the map to see the clusters of transformers connected to the sub station, and again to see the clusters of meters connected to the transformers.

Hover over a transformer on the map to see the general details of a transformer.

Click on the transformer to see the preview panel for the transformer.

To view a sub-station with all the transformers.

Click the sub-station on the logical map to see all the transformers that are fed by the sub-station.

To view a certain transformer, type part of the name for the transformer in the search bar.

Click the transformer name in the results field.

To view the details of all the meters fed by a transformer.

Click the Meters on the logical map.

Click the meter you want to view.

Parent topic: Using the Connectivity Model

Exporting the asset information of a utilityYou can export the meter or transformer detail information to a local system as a csv file.The export option Click the Export icon .Select the asset type and substation.Click Export. You can either view or save the exported data.Using the Connectivity ModelThe Connectivity Model gives feedback to managers, data analysts and grid operators as to the accuracy of the phase and connectivity details of the network.

Exporting the asset information of a utility

You can export the meter or transformer detail information to a local system as a csv file.

About this task

The export option

Procedure

Click the Export icon .

Select the asset type and substation.

Click Export. You can either view or save the exported data.

Parent topic: Using the Connectivity Model

Viewing asset reportsYou can view detailed reports on a single asset or on a group of assets.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Single asset reportsA report with details about a single asset can be displayed.Multiple asset reportsA summarized report about multiple assets selected by filter criteria can be displayed.Report dataIBM Insights Foundation for Energy reports provide background information on single and multiple assets.Viewing analytics dashboardsWhen viewing a report, additional analytic data is available from IBM Predictive Maintenance and Quality.

Viewing asset reports

You can view detailed reports on a single asset or on a group of assets.

Single asset reports
A report with details about a single asset can be displayed.

Multiple asset reports
A summarized report about multiple assets selected by filter criteria can be displayed.

Report data
IBM Insights Foundation for Energy reports provide background information on single and multiple assets.

Viewing analytics dashboards
When viewing a report, additional analytic data is available from IBM Predictive Maintenance and Quality.

Parent topic: Viewing and analyzing energy data

Single asset reportsA report with details about a single asset can be displayed.On the map or list, click the desired asset.The preview card for the asset will be displayed.Click View Asset Report.The report for the selected asset is displayed. Report data can also be exported. Viewing asset reportsYou can view detailed reports on a single asset or on a group of assets.

Single asset reports

A report with details about a single asset can be displayed.

Procedure

On the map or list, click the desired asset. The preview card for the asset will be displayed.

Click View Asset Report.

Results

The report for the selected asset is displayed.

What to do next

Report data can also be exported.

Parent topic: Viewing asset reports

Multiple asset reportsA summarized report about multiple assets selected by filter criteria can be displayed.On the map or list, use the filter criteria to specify the assets to be included in the report.In the task bar at the bottom of the page click Report . If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.An aggregate report for the assets is displayed.The report can be further refined by changing the Time, Geography, and Asset Class filters. Report data can also be exported. Viewing asset reportsYou can view detailed reports on a single asset or on a group of assets.

Multiple asset reports

A summarized report about multiple assets selected by filter criteria can be displayed.

Procedure

On the map or list, use the filter criteria to specify the assets to be included in the report.

In the task bar at the bottom of the page click Report . If the task bar is not displayed, display it by clicking the arrow in the circle on the bottom of the page.

Results

An aggregate report for the assets is displayed.

What to do next

The report can be further refined by changing the Time, Geography, and Asset Class filters. Report data can also be exported.

Parent topic: Viewing asset reports

Report dataIBM Insights Foundation for Energy reports provide background information on single and multiple assets.The tables describe the type of data included in each report. Data provided in IBM Insights Foundation for Energy single asset reportsReport TabDataDescriptionSummary ScoreCurrent Health, Risk, Consequence of Failure score and change since last year.Summary Asset MapAsset location in the map.Summary Asset InformationSelected year, asset id and other basic information.Summary Score over time Health, risk, consequence of failure score over time.Summary Score breakdownCalculation detail of health, risk, consequence of failure scoresHealth Degradation Asset InformationSelected year, asset id and other basic information.Health Degradation Health score over timeHealth score over time.Health DegradationHealth score breakdown over timeCalculation detail of scores(factor/driver/asset scores) over time.Historical DataAsset InformationSelected year, asset id and other basic information.Historical DataAdvanced AnalyticsLink to PMQ report.Historical DataDissolved Gas Analysis DGA report specific to substation transformer.Asset DetailsAsset InformationSelected year, asset id and other basic information.Asset DetailsAsset propertiesAll of property values of selected asset.TreatmentAsset InformationSelected year, asset id and other basic information.TreatmentTreatment OptionTreatment options over time.TreatmentMinimal and Maximum Budgets by Year The minimum and maximum annual treatment cost for the asset. Data provided in IBM Insights Foundation for Energy multiple asset reportsReport TabDataDescriptionSummaryAggregate ScoreCurrent Health, Risk, Consequence of Failure score and change since last year.SummaryRegion MapAssets region located in the map.SummaryAsset InformationSelected filter.SummaryAsset BreakdownNumber of selected assets for each asset class.SummaryAggregate Score over timeAggregate health, risk, consequence of failure score over time.SummaryScore by asset classAggregate health and risk score by asset class.SummaryScore breakdown Factor scores by asset class for health, risk, consequence of failure.TreatmentAsset InformationSelected filter.TreatmentAsset BreakdownNumber of selected assets for each asset class.TreatmentMimimal and Maximum budgets by year Aggregate minimum and maximum annual treatment cost for all included assetsTreatmentTreatment optionsTreatment options for each asset over timeViewing asset reportsYou can view detailed reports on a single asset or on a group of assets.

Report data

IBM® Insights Foundation for Energy reports provide background information on single and multiple assets.

The tables describe the type of data included in each report.

Table 10.  Data provided in IBM Insights Foundation for Energy single asset reports

Report Tab | Data | Description
Summary | Score | Current Health, Risk, Consequence of Failure score and change since last year.
Summary | Asset Map | Asset location in the map.
Summary | Asset Information | Selected year, asset id and other basic information.
Summary | Score over time | Health, risk, consequence of failure score over time.
Summary | Score breakdown | Calculation detail of health, risk, consequence of failure scores
Health Degradation | Asset Information | Selected year, asset id and other basic information.
Health Degradation | Health score over time | Health score over time.
Health Degradation | Health score breakdown over time | Calculation detail of scores(factor/driver/asset scores) over time.
Historical Data | Asset Information | Selected year, asset id and other basic information.
Historical Data | Advanced Analytics | Link to PMQ report.
Historical Data | Dissolved Gas Analysis | DGA report specific to substation transformer.
Asset Details | Asset Information | Selected year, asset id and other basic information.
Asset Details | Asset properties | All of property values of selected asset.
Treatment | Asset Information | Selected year, asset id and other basic information.
Treatment | Treatment Option | Treatment options over time.
Treatment | Minimal and Maximum Budgets by Year | The minimum and maximum annual treatment cost for the asset.

Table 11.  Data provided in IBM Insights Foundation for Energy multiple asset reports

Report Tab | Data | Description
Summary | Aggregate Score | Current Health, Risk, Consequence of Failure score and change since last year.
Summary | Region Map | Assets region located in the map.
Summary | Asset Information | Selected filter.
Summary | Asset Breakdown | Number of selected assets for each asset class.
Summary | Aggregate Score over time | Aggregate health, risk, consequence of failure score over time.
Summary | Score by asset class | Aggregate health and risk score by asset class.
Summary | Score breakdown | Factor scores by asset class for health, risk, consequence of failure.
Treatment | Asset Information | Selected filter.
Treatment | Asset Breakdown | Number of selected assets for each asset class.
Treatment | Mimimal and Maximum budgets by year | Aggregate minimum and maximum annual treatment cost for all included assets
Treatment | Treatment options | Treatment options for each asset over time

Parent topic: Viewing asset reports

Viewing analytics dashboardsWhen viewing a report, additional analytic data is available from IBM Predictive Maintenance and Quality.When viewing a report, click Advanced Analytics.When viewing a single asset report, the Equipment Dashboard for that single asset is displayed. When viewing a multiple asset report, the site overview dashboard is displayed. Viewing asset reportsYou can view detailed reports on a single asset or on a group of assets.

Viewing analytics dashboards

When viewing a report, additional analytic data is available from IBM® Predictive Maintenance and Quality.

Procedure

When viewing a report, click Advanced Analytics.

Results

When viewing a single asset report, the Equipment Dashboard for that single asset is displayed. When viewing a multiple asset report, the site overview dashboard is displayed.

Parent topic: Viewing asset reports

Exporting data After filtering the data to the desired subset, information on the selected assets can be exported for use in other systems.Sign on IBM Insights Foundation for Energy as a user.Using the map or list, filter the assets as desired.If you want to export a report summarizing all the displayed assets displayed on a map, click Report. If you want to export a report with data about a single asset, click the asset on the map or list. On the displayed preview card, click View Asset Report. The list of assets displayed in the list view can also be exported.Click Export to export the data into one of the following formats when viewing a list. CSVXLSX When viewing a report, the report can be exported into one of the following formats. PDFXLSX All the tabs in the report will be exported into a .zip file. Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.Task barThe task bar contains the controls for how the various panels and filter options show in user interface.

Exporting data

After filtering the data to the desired subset, information on the selected assets can be exported for use in other systems.

Procedure

Sign on IBM® Insights Foundation for Energy as a user.

Using the map or list, filter the assets as desired.

If you want to export a report summarizing all the displayed assets displayed on a map, click Report. If you want to export a report with data about a single asset, click the asset on the map or list. On the displayed preview card, click View Asset Report. The list of assets displayed in the list view can also be exported.

Click Export to export the data into one of the following formats when viewing a list.

CSV

XLSX

When viewing a report, the report can be exported into one of the following formats.

PDF

XLSX

All the tabs in the report will be exported into a .zip file.

Parent topic: Viewing and analyzing energy data

Related concepts:

Task bar

Creating input for a rate use caseUsing IBM Insights Foundation for Energy, regional planning engineers determine where investment is required to maintain or improve reliability.$33.5 billion is spent annually maintaining distribution grids across the United States. North America has an estimated $4 trillion backlog in electrical infrastructure. Customer minutes without power have increased 15% since 2002 while in the last decade the cost to maintain distribution equipment has gone up 42%.The delivery of consistent and reliable energy is an important business. By having a better understanding of asset risks, preventative maintenance, and planning, the energy business can be better and more efficient.Regional planning engineers need to easily manage and optimize regional budgets. They want to be able to generate budget plans quickly and efficiently without having to analyze masses of data. They want the information they need in an accessible, single location so their utilities can provide reliable, affordable energy for their customers.The regional planning engineer signs on IBM Insights Foundation for Energy as a user.He clicks Map.The map is displayed.He zooms in to determine an area he is interested in analyzing.Clicking an area of interest, a preview card is displayed giving information on the health and risks of the assets in the area.Wanting to look at the assets in the area, the regional planning engineer clicks Zoom-in to see more details on the area assets.The map is redisplayed with the individual assets displayed.The regional planning engineer wants to look at high risk assets so he changes his Score type filter to Risk score and the Score Range to the high risk range and clicks Apply.The map is redisplayed with the assets at the highest risk.Wanting to see the high risk assets as a list, he clicks List.The high risk assets are displayed as a list.The regional planning engineer now wants to export the list so he can provide the information to the maintenance plan. To do so he clicks Export and selects the format for the data export, for example, CSV.Viewing and analyzing energy dataUse IBM Insights Foundation for Energy to analyze the health and risks to the network grid.

Creating input for a rate use case

Using IBM® Insights Foundation for Energy, regional planning engineers determine where investment is required to maintain or improve reliability.

About this task

$33.5 billion is spent annually maintaining distribution grids across the United States. North America has an estimated $4 trillion backlog in electrical infrastructure. Customer minutes without power have increased 15% since 2002 while in the last decade the cost to maintain distribution equipment has gone up 42%.

The delivery of consistent and reliable energy is an important business. By having a better understanding of asset risks, preventative maintenance, and planning, the energy business can be better and more efficient.

Regional planning engineers need to easily manage and optimize regional budgets. They want to be able to generate budget plans quickly and efficiently without having to analyze masses of data. They want the information they need in an accessible, single location so their utilities can provide reliable, affordable energy for their customers.

Procedure

The regional planning engineer signs on IBM Insights Foundation for Energy as a user.

He clicks Map. The map is displayed.

He zooms in to determine an area he is interested in analyzing.

Clicking an area of interest, a preview card is displayed giving information on the health and risks of the assets in the area.

Wanting to look at the assets in the area, the regional planning engineer clicks Zoom-in to see more details on the area assets. The map is redisplayed with the individual assets displayed.

The regional planning engineer wants to look at high risk assets so he changes his Score type filter to Risk score and the Score Range to the high risk range and clicks Apply. The map is redisplayed with the assets at the highest risk.

Wanting to see the high risk assets as a list, he clicks List. The high risk assets are displayed as a list.

The regional planning engineer now wants to export the list so he can provide the information to the maintenance plan. To do so he clicks Export and selects the format for the data export, for example, CSV.

Parent topic: Viewing and analyzing energy data

Customizing the solutionYou can customize the solution to suit your business requirements.Use the Administration Console view to register custom user interface components and to customize the user interface to suit your particular operation. Configure the global settings of the Asset Health modelThe data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

Customizing the solution

You can customize the solution to suit your business requirements.

Use the Administration Console view to register custom user interface components and to customize the user interface to suit your particular operation.

Configure the global settings of the Asset Health model
The data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

Configure the global settings of the Asset Health modelThe data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.The global configuration items are: Business Driver: the motivations behind the analysis. For example, the driver for treating a transformer could be maintain the condition or reduce risk. You can create as many drivers as needed for your analysis. The global level drivers can be referred to in Package when configuring an asset class specific analysis model.Factor: the analysis unit that the Asset Health Model is based on. The global factors can be referred to in a package when configuring asset class specific analysis model. You can extend the analysis health model by registering customized factors into the data base. There are 3 kinds of factor supported in the product, including raw factor, computed factor and statistical factor. This document will introduce how to register a new factor in Define New Factors section. Treatment: the improvement approach that is available for assets. For example, to improve a health condition of a transformer, there can be two approaches available. 1, Replace the transformer with a new one. 2, Repair the existing one. The global level treatment can be referred to in a package when configuring the asset class specific analysis model.Asset default age: the age of every asset is calculated from the installation date. Where the asset installation date is missing, the default age is used instead. The default age is the average maximum expected life of the asset based on the asset class.Customizing the solutionYou can customize the solution to suit your business requirements.Configuration file formatIBM Insights Foundation for Energy provides a default asset health configuration model. The default configuration can be found on the application server, /opt/IBM/energy/metaData.CSV in CSV format. Loading the default configurationTo load the default configuration files to IBM Insights Foundation for Energy.Update the default configurationThis section gives examples of popular configurations.Configure the SPSS Asset Health modelAs the asset health models are implemented as SPSS streams, the model configuration can be customized by editing the SPSS streams.

Configure the global settings of the Asset Health model

The data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

The global configuration items are:

Business Driver: the motivations behind the analysis. For example, the driver for treating a transformer could be maintain the condition or reduce risk. You can create as many drivers as needed for your analysis. The global level drivers can be referred to in Package when configuring an asset class specific analysis model.

Factor: the analysis unit that the Asset Health Model is based on. The global factors can be referred to in a package when configuring asset class specific analysis model. You can extend the analysis health model by registering customized factors into the data base. There are 3 kinds of factor supported in the product, including raw factor, computed factor and statistical factor. This document will introduce how to register a new factor in Define New Factors section.

Treatment: the improvement approach that is available for assets. For example, to improve a health condition of a transformer, there can be two approaches available. 1, Replace the transformer with a new one. 2, Repair the existing one.

The global level treatment can be referred to in a package when configuring the asset class specific analysis model.

Asset default age: the age of every asset is calculated from the installation date. Where the asset installation date is missing, the default age is used instead. The default age is the average maximum expected life of the asset based on the asset class.

Configuration file format
IBM® Insights Foundation for Energy provides a default asset health configuration model. The default configuration can be found on the application server, /opt/IBM/energy/metaData.CSV in CSV format.

Loading the default configuration
To load the default configuration files to IBM Insights Foundation for Energy.

Update the default configuration
This section gives examples of popular configurations.

Configure the SPSS Asset Health model
As the asset health models are implemented as SPSS® streams, the model configuration can be customized by editing the SPSS streams.

Parent topic: Customizing the solution

Configuration file formatIBM Insights Foundation for Energy provides a default asset health configuration model. The default configuration can be found on the application server, /opt/IBM/energy/metaData.CSV in CSV format. A configuration command line tool is used to load the CSV format configuration into database. The mapping relationship between the .csv file and the meta data is as follows:CSV file: AHA.ANALYSIS.csvMeta data:asset default age, health failure factor, asset class package mappingcsv Format:<asset class id> <package id> <health failure factor> <status> <start_date> <complete_date> <defalt_age>Table name in the database: AHA.ANALYSISCSV file: AHA.ANALYSIS_YEAR.csvMeta dataanalysis start year analysis duration analysis intervalcsv Format<interval> <duration> <start year>Table name in the database: AHA.ANALYSIS_YEARcsv File: AHA.DRIVER.csvMeta datadrivercsv Format<driver id> <driver_name> <driver_description>Table name in the database: AHA.DRIVERcsv File: AHA.FACTOR.csvMeta datafactorcsv Format<factor id> <name> <description> <asset class code> <factor type> <property code> <factor data type> <implementation>Table name in the database:: AHA.FACTORcsv File: AHA.PACKAGE.csvMeta datapackagecsv Format<package id> <name> <description> <is template> <asset class>Table name in the database: AHA.PACKAGEcsv File: AHA.PACKAGE_DEGRADATION.csvMeta datadegradationcsv Format<id> <package id> <factor id> <age> <description> <cumulative degradation>Table name in the database: AHA.PACKAGE_DEGRADATIONcsv File: AHA.PACKAGE_DRIVER.csvMeta dataasset drivercsv Format: <id> <package id> <driver id> <driver weight>Table name in the database: AHA.PACKAGE_DRIVERcvs File: AHA.PACKAGE_FACTOR.csvMeta dataasset factorcsv Format:<id> <package id> <driver id> <factor id> <factor weight> <default value>Table name in the database: AHA.PACKAGE_FACTORcsv File: AHA.PACKAGE_INDEX.csvMeta data: asset factor indexcsv Format: <id> <package id> <driver id> <factor id> <index sequence id> <index type> <from range> <to range> <string value> <int value> <index value>Table name in the database: AHA.PACKAGE_INDEXcsv File: AHA.PACKAGE_TREATMENT.csvThe mapping between the csv file and the meta datacsv File:Meta data:csv Format:Table name in the database:asset treatment<id>,<package id>,<treatment id>,<unit>,<unit cost>,<service life extension>,<service level improvement> <description>AHA.PACKAGE_TREATMENTAHA.PACKAGE_TREATMENT_EXCLUDE.csvtreatment exclusive rule<id>,<package id>,<treatment id>,<driver id>,<factor id>,<sequence id>,<index type>,<from range>,<to range>,<string value>,<int value>,<filter name>, <filter description>AHA.PACKAGE_TREATMENT_EXCLUDEAHA.PACKAGE_TREATMENT_INCLUDE.csvtreatment inclusive rule<id>,<package id>,<treatment id>,<driver id>,<from range>,<to range>,<exclusion factor based >,<exclusion description > <exclusion location based >AHA.PACKAGE_TREATMENT_INCLUDEAHA.TREATMENT.csvtreatment<treatment id>,<treatment name>,<treatment description > <replace vs rehab >AHA.TREATMENTAHA.ANALYSIS.csv asset class idColumn 1Asset Class ID number Asset Class Id, number Column 2Package ID number, the reference ID from AHA.PACKAGE tablehealth failure factorColumn 3The factor needed to calculate the asset failure probability, a value between 0 and 1.statusColumn 4The status of the analysis. The states are: open, started , completed or fail.start_dateColumn 5The start date of the latest analysis run. A timestamp value that can be empty.complete_dateColumn 6The completion date of the latest analysis run. A timestamp value that can be empty.defalt_ageColumn 7The default age of an asset if the actual installation date is not known. Number.AHA.ANALYSIS_YEAR.csv intervalColumn 1Time interval of the analysis in years. Number. For example: A value of 3 means every 3 years there is an analysis.durationColumn 2The period of the analysis in years. Number. A value of 10 means the analysis will last for 10 years.start yearColumn 3The year for the start of the analysis. Number.AHA.DRIVER.csv driver idColumn 1Driver ID, automatically generated number for the driver.driver_nameColumn 2The name of the driver.driver_descriptionColumn 3The description of the driver.AHA.FACTOR.csv factor idColumn 1Factor ID, automatically generated number for the factor. nameColumn 2The name of the factor.descriptionColumn 3The description of the factor.asset class codeColumn 4The code in the CIM.RESOURCETYPE database table for the target asset class that the factor is registered against.factor typeColumn 5The factor type can be Raw, Computed, or Statistical.property codeColumn 6The property code in the CIM.PROPERTYTYPE database table that is used for the factor value.factor data typeColumn 7The data type of the factor. NUM denotes a numeric data type. STR denotes a string data type.implementationColumn 8The command line needed to get the factor value. This is only needed for Computed and Statistical factors.AHA.PACKAGE.csv package idColumn 1The package ID automatically generated number for the package.nameColumn 2The name of the package.descriptionColumn 3The description of the package.templateColumn 4Determines if the current package is a template. The value is either 0 or 1.asset classColumn 5The asset class ID of the asset class that is associated to this package in the CIM.resourcetype table.AHA.PACKAGE_DEGRADATION.csv idColumn 1Degradation ID, automatically generated number.package idColumn 2Packa ID, the reference ID from the AHA.PACKAGE table.factor idColumn 3Factor ID, the reference ID from AHA.Factor table.ageColumn 4The age factor, number.descriptionColumn 5The degradation description.cumulative degradationColumn 6The cumulative degradation value based on the asset factor age. Double.AHA.PACKAGE_DRIVER.csv idColumn 1Package driver id, automatically generated number for the AHA.package_driver table.package idColumn 2Package ID, the reference id from the AHA.PACKAGE table.driver idColumn 3Driver ID, the reference id from AHA.Driver table.driver weightColumn 4The weight value applied to the driver. Number. A value of 40 means the weight is 40%.AHA.PACKAGE_FACTOR.csv idColumn 1Package factor id, automatically generated number for the AHA.package_factor tablepackage idColumn 2Package ID, the reference id from the AHA.PACKAGE table.driver idColumn 3Driver ID, the reference id from AHA.Driver table.factor idColumn 4Factor ID, the reference ID from AHA.Factor table.factor weightColumn 5The weight value applied to the factor. Number. A value of 40 means the weight is 40%.default valueColumn 6The default factor value if the current factor does not have a value.AHA.PACKAGE_INDEX.csv idColumn 1The package index ID, automatically generated number for the AHA.package_factor table.package idColumn 2Package ID, the reference id from the AHA.PACKAGE table.driver idColumn 3Driver ID, the reference id from the AHA.Driver table.factor idColumn 4Factor ID, the reference ID from AHA.Factor table.index sequence idColumn 5The sequence number of the indexing.index typeColumn 6The index type is either Range, String, Int. The actual value depends on the business requirements. from rangeColumn 7The included start value of a range. Required if the index type is Range. to rangeColumn 8The end value of a range. The end value is not included in the range. Required if the index type is Range. string valueColumn 9Required if the index type is String. int valueColumn 10Required if the index type is Int.index valueColumn 11The mapping value for factor normalization from a factor value to a factor score. Values from 0% to 100%.AHA.PACKAGE_TREATMENT.csv idColumn 1The package treatment ID, automatically generated number for the AHA.package_treatment table.package idColumn 2Package ID, the reference id from the AHA.PACKAGE table.treatment idColumn 3Treatment id, the reference id from the AHA.TREATMENT table.unitColumn 4The unit for each treatment.unit costColumn 5The unit cost of treatment, number.service life extensionColumn 6The number of years of service that can be added to the life of the asset due to the treatment. Number. A value of 40 means the service life extension is 40 years.service level improvementColumn 7The improvement to the level of service of the asset due to the treatment. Number. A value of 40% means that the service level improvement is 40%.descriptionColumn 8The description of the treatment.AHA.PACKAGE_TREATMENT_EXCLUDE.csv idColumn 1The package treatment exclude ID, automatically generated number for the AHA.package_treatment_exclude table. package idColumn 2Package ID, the reference id from the AHA.PACKAGE table.treatment idColumn 3Treatment id, the reference id from the AHA.TREATMENT table.driver idColumn 4Driver ID, the reference id from the AHA.Driver table.factor idColumn 5Factor ID, the reference ID from AHA.Factor table.sequence idColumn 6The sequence number of the exclude roles.index typeColumn 7The index type is either Range, String, Int. The actual value depends on the business requirements. from rangeColumn 8The included start value of a range. Required if the index type is Range. to rangeColumn 9The end value of a range. The end value is not included in the range. Required if the index type is Range. string valueColumn 10Required if the index type is String. int valueColumn 11Required if the index type is Int.filter nameColumn 12The filter name of the exclude rule.filter descriptionColumn 12The filter description of the exclude rule. AHA.PACKAGE_TREATMENT_INCLUDE.csv idColumn 1The package treatment include ID, automatically generated number for the AHA.package_treatment_include table. package idColumn 2The package reference id from the AHA.PACKAGE table.treatment idColumn 3The treatment reference id from the AHA.TREATMENT table.driver idColumn 4The driver reference id from the AHA.Driver table.from rangeColumn 5The included start value of a range. to rangeColumn 6The excluded end value of a range.exclusion factor basedColumn 7Nullexclusion descriptionColumn 8Nullexclusion location basedColumn 9NullAHA.TREATMENT.csv treatment idColumn 1The treatment ID, automatically generated number for the AHA.package_treatment table. treatment nameColumn 2The name of the treatment.treatment descriptionColumn 3The description of the treatment.replace vs rehabColumn 4Either replacement or retention and repair of the current asset. The value is either Replace or Rehab.Configure the global settings of the Asset Health modelThe data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

Configuration file format

IBM® Insights Foundation for Energy provides a default asset health configuration model. The default configuration can be found on the application server, /opt/IBM/energy/metaData.CSV in CSV format.

A configuration command line tool is used to load the CSV format configuration into database. The mapping relationship between the .csv file and the meta data is as follows:

CSV file: AHA.ANALYSIS.csv

Meta data:

asset default age,
health failure factor,
asset class
package mapping

csv Format:

<asset class id>
<package id>
<health failure factor>
<status>
<start_date>
<complete_date>
<defalt_age>

Table name in the database: AHA.ANALYSIS

CSV file: AHA.ANALYSIS_YEAR.csv

Meta data

analysis start year
analysis duration
analysis interval

csv Format

<interval>
<duration>
<start year>

Table name in the database: AHA.ANALYSIS_YEAR

csv File: AHA.DRIVER.csv

Meta data

driver

csv Format

<driver id>
<driver_name>
<driver_description>

Table name in the database: AHA.DRIVER

csv File: AHA.FACTOR.csv

Meta data

factor

csv Format

<factor id>
<name>
<description>
<asset class code>
<factor type>
<property code>
<factor data type>
<implementation>

Table name in the database:: AHA.FACTOR

csv File: AHA.PACKAGE.csv

Meta data

package

csv Format

<package id>
<name>
<description>
<is template>
<asset class>

Table name in the database: AHA.PACKAGE

csv File: AHA.PACKAGE_DEGRADATION.csv

Meta data

degradation

csv Format

<id>
<package id>
<factor id>
<age>
<description>
<cumulative degradation>

Table name in the database: AHA.PACKAGE_DEGRADATION

csv File: AHA.PACKAGE_DRIVER.csv

Meta data

asset driver

csv Format:

<id>
<package id>
<driver id>
<driver weight>

Table name in the database: AHA.PACKAGE_DRIVER

cvs File: AHA.PACKAGE_FACTOR.csv

Meta data

asset factor

csv Format:

<id>
<package id>
<driver id>
<factor id>
<factor weight>
<default value>

Table name in the database: AHA.PACKAGE_FACTOR

csv File: AHA.PACKAGE_INDEX.csv

Meta data:

asset factor index

csv Format:

<id>
<package id>
<driver id>
<factor id>
<index sequence id>
<index type>
<from range>
<to range>
<string value>
<int value>
<index value>

Table name in the database: AHA.PACKAGE_INDEX

csv File: AHA.PACKAGE_TREATMENT.csv

Table 12. The mapping between the csv file and the meta data

csv File:
Meta data:
csv Format:
Table name in the database:

asset treatment

<id>,

<package id>,

<treatment id>,

<unit>,

<unit cost>,

<service life extension>,

<service level improvement>

<description>
AHA.PACKAGE_TREATMENT

AHA.PACKAGE_TREATMENT_EXCLUDE.csv
treatment exclusive rule

<id>,

<package id>,

<treatment id>,

<driver id>,

<factor id>,

<sequence id>,

<index type>,

<from range>,

<to range>,

<string value>,

<int value>,

<filter name>,

<filter description>
AHA.PACKAGE_TREATMENT_EXCLUDE

AHA.PACKAGE_TREATMENT_INCLUDE.csv
treatment inclusive rule

<id>,

<package id>,

<treatment id>,

<driver id>,

<from range>,

<to range>,

<exclusion factor based >,

<exclusion description >

<exclusion location based >
AHA.PACKAGE_TREATMENT_INCLUDE

AHA.TREATMENT.csv
treatment

<treatment id>,

<treatment name>,

<treatment description >

<replace vs rehab >
AHA.TREATMENT

AHA.ANALYSIS.csv

asset class id

Column 1

Asset Class ID number

Asset Class Id, number

Column 2

Package ID number, the reference ID from AHA.PACKAGE table

health failure factor

Column 3

The factor needed to calculate the asset failure probability, a value between 0 and 1.

status

Column 4

The status of the analysis. The states are: open, started , completed or fail.

start_date

Column 5

The start date of the latest analysis run. A timestamp value that can be empty.

complete_date

Column 6

The completion date of the latest analysis run. A timestamp value that can be empty.

defalt_age

Column 7

The default age of an asset if the actual installation date is not known. Number.

AHA.ANALYSIS_YEAR.csv

interval

Column 1

Time interval of the analysis in years. Number. For example: A value of 3 means every 3 years there is an analysis.

duration

Column 2

The period of the analysis in years. Number. A value of 10 means the analysis will last for 10 years.

start year

Column 3

The year for the start of the analysis. Number.

AHA.DRIVER.csv

driver id

Column 1

Driver ID, automatically generated number for the driver.

driver_name

Column 2

The name of the driver.

driver_description

Column 3

The description of the driver.

AHA.FACTOR.csv

factor id

Column 1

Factor ID, automatically generated number for the factor.

name

Column 2

The name of the factor.

description

Column 3

The description of the factor.

asset class code

Column 4

The code in the CIM.RESOURCETYPE database table for the target asset class that the factor is registered against.

factor type

Column 5

The factor type can be Raw, Computed, or Statistical.

property code

Column 6

The property code in the CIM.PROPERTYTYPE database table that is used for the factor value.

factor data type

Column 7

The data type of the factor. NUM denotes a numeric data type. STR denotes a string data type.

implementation

Column 8

The command line needed to get the factor value. This is only needed for Computed and Statistical factors.

AHA.PACKAGE.csv

package id

Column 1

The package ID automatically generated number for the package.

name

Column 2

The name of the package.

description

Column 3

The description of the package.

template

Column 4

Determines if the current package is a template. The value is either 0 or 1.

asset class

Column 5

The asset class ID of the asset class that is associated to this package in the CIM.resourcetype table.

AHA.PACKAGE_DEGRADATION.csv

id

Column 1

Degradation ID, automatically generated number.

package id

Column 2

Packa ID, the reference ID from the AHA.PACKAGE table.

factor id

Column 3

Factor ID, the reference ID from AHA.Factor table.

age

Column 4

The age factor, number.

description

Column 5

The degradation description.

cumulative degradation

Column 6

The cumulative degradation value based on the asset factor age. Double.

AHA.PACKAGE_DRIVER.csv

id

Column 1

Package driver id, automatically generated number for the AHA.package_driver table.

package id

Column 2

Package ID, the reference id from the AHA.PACKAGE table.

driver id

Column 3

Driver ID, the reference id from AHA.Driver table.

driver weight

Column 4

The weight value applied to the driver. Number. A value of 40 means the weight is 40%.

AHA.PACKAGE_FACTOR.csv

id

Column 1

Package factor id, automatically generated number for the AHA.package_factor table

package id

Column 2

Package ID, the reference id from the AHA.PACKAGE table.

driver id

Column 3

Driver ID, the reference id from AHA.Driver table.

factor id

Column 4

Factor ID, the reference ID from AHA.Factor table.

factor weight

Column 5

The weight value applied to the factor. Number. A value of 40 means the weight is 40%.

default value

Column 6

The default factor value if the current factor does not have a value.

AHA.PACKAGE_INDEX.csv

id

Column 1

The package index ID, automatically generated number for the AHA.package_factor table.

package id

Column 2

Package ID, the reference id from the AHA.PACKAGE table.

driver id

Column 3

Driver ID, the reference id from the AHA.Driver table.

factor id

Column 4

Factor ID, the reference ID from AHA.Factor table.

index sequence id

Column 5

The sequence number of the indexing.

index type

Column 6

The index type is either Range, String, Int. The actual value depends on the business requirements.

from range

Column 7

The included start value of a range. Required if the index type is Range.

to range

Column 8

The end value of a range. The end value is not included in the range. Required if the index type is Range.

string value

Column 9

Required if the index type is String.

int value

Column 10

Required if the index type is Int.

index value

Column 11

The mapping value for factor normalization from a factor value to a factor score. Values from 0% to 100%.

AHA.PACKAGE_TREATMENT.csv

id

Column 1

The package treatment ID, automatically generated number for the AHA.package_treatment table.

package id

Column 2

Package ID, the reference id from the AHA.PACKAGE table.

treatment id

Column 3

Treatment id, the reference id from the AHA.TREATMENT table.

unit

Column 4

The unit for each treatment.

unit cost

Column 5

The unit cost of treatment, number.

service life extension

Column 6

The number of years of service that can be added to the life of the asset due to the treatment. Number. A value of 40 means the service life extension is 40 years.

service level improvement

Column 7

The improvement to the level of service of the asset due to the treatment. Number. A value of 40% means that the service level improvement is 40%.

description

Column 8

The description of the treatment.

AHA.PACKAGE_TREATMENT_EXCLUDE.csv

id

Column 1

The package treatment exclude ID, automatically generated number for the AHA.package_treatment_exclude table.

package id

Column 2

Package ID, the reference id from the AHA.PACKAGE table.

treatment id

Column 3

Treatment id, the reference id from the AHA.TREATMENT table.

driver id

Column 4

Driver ID, the reference id from the AHA.Driver table.

factor id

Column 5

Factor ID, the reference ID from AHA.Factor table.

sequence id

Column 6

The sequence number of the exclude roles.

index type

Column 7

The index type is either Range, String, Int. The actual value depends on the business requirements.

from range

Column 8

The included start value of a range. Required if the index type is Range.

to range

Column 9

The end value of a range. The end value is not included in the range. Required if the index type is Range.

string value

Column 10

Required if the index type is String.

int value

Column 11

Required if the index type is Int.

filter name

Column 12

The filter name of the exclude rule.

filter description

Column 12

The filter description of the exclude rule.

AHA.PACKAGE_TREATMENT_INCLUDE.csv

id

Column 1

The package treatment include ID, automatically generated number for the AHA.package_treatment_include table.

package id

Column 2

The package reference id from the AHA.PACKAGE table.

treatment id

Column 3

The treatment reference id from the AHA.TREATMENT table.

driver id

Column 4

The driver reference id from the AHA.Driver table.

from range

Column 5

The included start value of a range.

to range

Column 6

The excluded end value of a range.

exclusion factor based

Column 7

Null

exclusion description

Column 8

Null

exclusion location based

Column 9

Null

AHA.TREATMENT.csv

treatment id

Column 1

The treatment ID, automatically generated number for the AHA.package_treatment table.

treatment name

Column 2

The name of the treatment.

treatment description

Column 3

The description of the treatment.

replace vs rehab

Column 4

Either replacement or retention and repair of the current asset. The value is either Replace or Rehab.

Parent topic: Configure the global settings of the Asset Health model

Loading the default configurationTo load the default configuration files to IBM Insights Foundation for Energy.Before running the meta data loader, please first stop all sessions connecting to the database in case the loader can not get an immediate table lock. To stop sessions connecting to database, if you are on the application server, log in as the db user, for example db2inst1 and run the command: db2 attach to <db2 node name> user <db2 instance user > using < db2 instance password> and then run the command db2 force application all. if you are on the database server, please log as db user, for example db2inst2 and directly run the command db2 force application all.Go to the meta data loader on the application server, and run the command /opt/IBM/energy/metaDataCSV/load_client.sh -y <db2 instance user > < db2 instance password>.You can now open the Web User Interface to view the report. As the FORCE APPLICATION command forces all applications off the system to allow the loader to be run, ignore the HTTP 500 error and wait for 2-3 minutes for the portal to rebuild its connection to database again.Configure the global settings of the Asset Health modelThe data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

Loading the default configuration

To load the default configuration files to IBM Insights Foundation for Energy.

Before you begin

Before running the meta data loader, please first stop all sessions connecting to the database in case the loader can not get an immediate table lock.

To stop sessions connecting to database,

if you are on the application server, log in as the db user, for example db2inst1 and run the command: db2 attach to <db2 node name> user <db2 instance user > using < db2 instance password> and then run the command db2 force application all.

if you are on the database server, please log as db user, for example db2inst2 and directly run the command db2 force application all.

Procedure

Go to the meta data loader on the application server, and run the command /opt/IBM/energy/metaDataCSV/load_client.sh -y <db2 instance user > < db2 instance password>.

You can now open the Web User Interface to view the report.

Note:

As the FORCE APPLICATION command forces all applications off the system to allow the loader to be run, ignore the HTTP 500 error and wait for 2-3 minutes for the portal to rebuild its connection to database again.

Parent topic: Configure the global settings of the Asset Health model

Update the default configurationThis section gives examples of popular configurations.You can update the configuration CSV files in /opt/IBM/energy/metaDataCSV/ on application server.You can then run the reload configuration to database using the command load_client.sh.Update asset class and package mapping You need to update existing entry of the AHA.ANALYSIS.csv file with the following format:<asset class id>, <package id>, <healthfailure factor>, <status>, <start_date>, <complete_date>, <default_age> The example entry adds a mapping between asset class with id 7 and package 1:7,1,0.05,"Open",,,40Configure the global settings of the Asset Health modelThe data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

Update the default configuration

This section gives examples of popular configurations.

You can update the configuration CSV files in /opt/IBM/energy/metaDataCSV/ on application server.

You can then run the reload configuration to database using the command load_client.sh.

Update asset class and package mapping

You need to update existing entry of the AHA.ANALYSIS.csv file with the following format:

<asset class id>, <package id>, <healthfailure factor>, <status>, <start_date>, <complete_date>, <default_age>

The example entry adds a mapping between asset class with id 7 and package 1:

7,1,0.05,"Open",,,40

Parent topic: Configure the global settings of the Asset Health model

Configure the SPSS Asset Health modelAs the asset health models are implemented as SPSS streams, the model configuration can be customized by editing the SPSS streams. The user can open the streams with SPSS modeler and edit the SPSS streams.These are hints to be aware of when doing customization:Do not change the integration interface between streams without verifying the data source in the stream.The integration interface includes the CIM data model and the flat file export node in the stream. If the CIM data model is changed, you must verify again the data source node in the stream.The flat file export node gives .csv files as an output that can be used by other streams when doing steams integration. If the CSV file format changes, it can cause errors in other streams.Make sure Python scripts in the stream are consistent with the GUI models. Python scripts control the stream execution. If you change any node, flow, or variable to assigned to the SPSS modeler client, make sure the corresponding change is also made in Python. The nodes with customized annotation are referred to in Python.You can customize the model configuration by editing the default formulas and values, or by assigning, changing, or deleting nodes. There are comments added in the streams to inform about the places can be customized. The user can refer to these comments when doing customization. For example: In the Pole_Health.str, the "Index” node, "Weight" node and "Individual Failure Score" nodes can be changed if user wants to change the asset health model configuration. The asset specific configuration items are:Asset DriverA business driver for a specific asset class. You can define as many drivers as you need for your analysis, and give each driver a weighting to indicate the importance of the driver to the analysis. Asset drivers and their weightings are used to calculate an aggregated asset driver score.Asset FactorIs the analysis unit for the asset driver. A single asset factor can be selected for multiple asset drivers. The total of all weightings for all asset factors for an asset driver should be 100%. Asset factors and their weights are used to calculate an aggregated asset factor score.Asset Factor IndexNormalizes and quantifies the asset factors. The index is an indication of the health score an asset should be assigned between 0 and 100. For example, if age as a asset factor and the age range of 10-20 years has a poor health index, then you should assign a lower score of 25% for the asset factor index value.Do not assign 100% as an asset factor index because 100% indicates that the asset in the best health and no risk score can be calculated for it.Asset Treatmentthe basic treatment information for a specific asset. Asset treatment references the global treatment, but adds specific information for a particular asset, including information about how the treatment improves the asset, and cost of treatment.Treatment ruleDefines when a type of treatment should be applied to an asset based on asset current driver score. For example, if an asset has a asset driver condition score in the range of 50-100% (good health), then you can add the treatment inspect pole. If the condition score is less than 50% (poor health), then you can add the treatment replace pole.Treatment informationIncludes cost of treatment, service life extension and service level improvement.Configure the global settings of the Asset Health modelThe data scientist needs to define the configuration items to be able to configure the Asset Health Model. Some configuration items are global and shared by more asset classes, and some are more specific to certain asset classes.

Configure the SPSS Asset Health model

As the asset health models are implemented as SPSS® streams, the model configuration can be customized by editing the SPSS streams.

The user can open the streams with SPSS modeler and edit the SPSS streams.

These are hints to be aware of when doing customization:

Do not change the integration interface between streams without verifying the data source in the stream.

The integration interface includes the CIM data model and the flat file export node in the stream. If the CIM data model is changed, you must verify again the data source node in the stream.

The flat file export node gives .csv files as an output that can be used by other streams when doing steams integration. If the CSV file format changes, it can cause errors in other streams.

Make sure Python scripts in the stream are consistent with the GUI models.

Python scripts control the stream execution. If you change any node, flow, or variable to assigned to the SPSS modeler client, make sure the corresponding change is also made in Python. The nodes with customized annotation are referred to in Python.

You can customize the model configuration by editing the default formulas and values, or by assigning, changing, or deleting nodes. There are comments added in the streams to inform about the places can be customized. The user can refer to these comments when doing customization. For example: In the Pole_Health.str, the "Index” node, "Weight" node and "Individual Failure Score" nodes can be changed if user wants to change the asset health model configuration.

The asset specific configuration items are:

Asset Driver

A business driver for a specific asset class. You can define as many drivers as you need for your analysis, and give each driver a weighting to indicate the importance of the driver to the analysis. Asset drivers and their weightings are used to calculate an aggregated asset driver score.

Asset Factor

Is the analysis unit for the asset driver. A single asset factor can be selected for multiple asset drivers. The total of all weightings for all asset factors for an asset driver should be 100%. Asset factors and their weights are used to calculate an aggregated asset factor score.

Asset Factor Index

Normalizes and quantifies the asset factors. The index is an indication of the health score an asset should be assigned between 0 and 100. For example, if age as a asset factor and the age range of 10-20 years has a poor health index, then you should assign a lower score of 25% for the asset factor index value.

Note: Do not assign 100% as an asset factor index because 100% indicates that the asset in the best health and no risk score can be calculated for it.

Asset Treatment

the basic treatment information for a specific asset. Asset treatment references the global treatment, but adds specific information for a particular asset, including information about how the treatment improves the asset, and cost of treatment.

Treatment rule

Defines when a type of treatment should be applied to an asset based on asset current driver score. For example, if an asset has a asset driver condition score in the range of 50-100% (good health), then you can add the treatment inspect pole. If the condition score is less than 50% (poor health), then you can add the treatment replace pole.

Treatment information

Includes cost of treatment, service life extension and service level improvement.

Parent topic: Configure the global settings of the Asset Health model

Running an Asset Health analysis This section shows you how you can do an asset health scoring analysis and network risk analysis.Prerequisites for an analysis The data loading for asset health must be complete. A file called year.txt must be available with a list of analysis years. The location of the file must be: /opt/IBM/energy/AssetHealth/SPSS_stream/score_input/year.txt. A every line on the file is an analysis year, do not have empty lines. An example contents of the file: 2016 2017 2018 The SPSS parameter template file must be complete. The location for the file is: /opt/IBM/energy/AssetHealth/SPSS_stream/script/ah_params_template.txtAn example contents of the file contains all the parameters required to pass into the SPSS modeler batch during analysis:-server -hostname _hostname_ -username _username_ -stream_modelPath_/stream/Pole/Pole_TTarget_Failure_Threshold.str-stream _modelPath_/stream/Pole/Pole_Health.str -stream_modelPath_/stream/SubstationTransformer/ST_DGA_Category.str -stream_modelPath_/stream/SubstationTransformer/ST_Health.str -stream_modelPath_/stream/DistributionTransformer/DT_Health.str -stream _modelPath_/stream/OverheadCable/OHC_Health.str -stream _modelPath_/stream/UndergroundCable/UGC_Health.str -stream _modelPath_/stream/Save_Score_to_DB.str -stream _modelPath_/stream/Pole/Pole_Treatment.str -stream_modelPath_/stream/SubstationTransformer/ST_Treatment.str -stream_modelPath_/stream/DistributionTransformer/DT_Treatment.str-stream _modelPath_/stream/OverheadCable/OHC_Treatment.str -stream_modelPath_/stream/UndergroundCable/UGC_Treatment.str -stream _modelPath_/stream/Save_Prescription_to_DB.str -PpoleTTargetModelTrainingOrPrediction=_poleTTargetModelTrainingOrPrediction_-PTTargetModelFile=_modelPath_/_poleTTargetModelFile_ -PstDGACatgOutputFile=_modelPath_/score_input/ST_DGA_Category.csv -PanalysisYearFile=_modelPath_/score_input/years.txt -PpoleTTargetOutputFile=_modelPath_/score_input/Pole_TTarget_Failure_Threshold.csv -PinputFolder=_modelPath_/score_input-PcsvFolder=_modelPath_/score -PlogFolder=_modelPath_/log-execute-appendlog -log _modelPath_/log/AHBacth.log The parameters starting with “-stream” define the streams and the sequences to be executed. Some of those streams are placed into folders named with the asset class code. For example, the stream Pole_Health.str is located in the folder named Pole and is an asset class related stream. Other streams are common streams and are not located in an asset related folder. For example the stream Save_Score_to_DB.str. Make sure that for the asset class related streams you remove the streams if you have no related asset class data loaded. You can add and delete lines to the template, but the template file must not contain empty lines or comments. If you add a new stream into the executable, it should be also added into this template.Running the analysisYou can use the command line to start an analysis. Tracking the progress of an analysisYou can track the progress of the analysis process.

Running an Asset Health analysis

This section shows you how you can do an asset health scoring analysis and network risk analysis.

Prerequisites for an analysis

The data loading for asset health must be complete.

A file called year.txt must be available with a list of analysis years. The location of the file must be: /opt/IBM/energy/AssetHealth/SPSS_stream/score_input/year.txt. A every line on the file is an analysis year, do not have empty lines. An example contents of the file:

2016
2017
2018

The SPSS parameter template file must be complete. The location for the file is: /opt/IBM/energy/AssetHealth/SPSS_stream/script/ah_params_template.txtAn example contents of the file contains all the parameters required to pass into the SPSS modeler batch during analysis:

-server
-hostname _hostname_
-username _username_
-stream_modelPath_/stream/Pole/Pole_TTarget_Failure_Threshold.str-stream _modelPath_/stream/Pole/Pole_Health.str
-stream_modelPath_/stream/SubstationTransformer/ST_DGA_Category.str
-stream_modelPath_/stream/SubstationTransformer/ST_Health.str
-stream_modelPath_/stream/DistributionTransformer/DT_Health.str
-stream _modelPath_/stream/OverheadCable/OHC_Health.str
-stream _modelPath_/stream/UndergroundCable/UGC_Health.str
-stream _modelPath_/stream/Save_Score_to_DB.str
-stream _modelPath_/stream/Pole/Pole_Treatment.str
-stream_modelPath_/stream/SubstationTransformer/ST_Treatment.str
-stream_modelPath_/stream/DistributionTransformer/DT_Treatment.str-stream _modelPath_/stream/OverheadCable/OHC_Treatment.str
-stream_modelPath_/stream/UndergroundCable/UGC_Treatment.str
-stream _modelPath_/stream/Save_Prescription_to_DB.str
-PpoleTTargetModelTrainingOrPrediction=_poleTTargetModelTrainingOrPrediction_-PTTargetModelFile=_modelPath_/_poleTTargetModelFile_
-PstDGACatgOutputFile=_modelPath_/score_input/ST_DGA_Category.csv
-PanalysisYearFile=_modelPath_/score_input/years.txt
-PpoleTTargetOutputFile=_modelPath_/score_input/Pole_TTarget_Failure_Threshold.csv
-PinputFolder=_modelPath_/score_input-PcsvFolder=_modelPath_/score
-PlogFolder=_modelPath_/log-execute-appendlog
-log _modelPath_/log/AHBacth.log

Important:

The parameters starting with “-stream” define the streams and the sequences to be executed. Some of those streams are placed into folders named with the asset class code. For example, the stream Pole_Health.str is located in the folder named Pole and is an asset class related stream. Other streams are common streams and are not located in an asset related folder. For example the stream Save_Score_to_DB.str. Make sure that for the asset class related streams you remove the streams if you have no related asset class data loaded.

You can add and delete lines to the template, but the template file must not contain empty lines or comments.

If you add a new stream into the executable, it should be also added into this template.

Running the analysis
You can use the command line to start an analysis.

Tracking the progress of an analysis
You can track the progress of the analysis process.

Running the analysisYou can use the command line to start an analysis. By default the command line first invokes the SPSS modeler batch to execute SPSS streams and then do the asset health score analysis. When complete, it then invokes grid engine to do the network risk analysis.Type in the command line to start a network risk analysis: /opt/IBM/energy/grid_engine/ife_aoms_core/scripts/run_cfp.sh /opt/IBM/energy/grid_engine/ife_aoms_core/scripts/run_cfp.sh –n The second line requests to ignore asset health scoring and to execute network risk analysis only.Running an Asset Health analysisThis section shows you how you can do an asset health scoring analysis and network risk analysis.

Running the analysis

You can use the command line to start an analysis.

About this task

By default the command line first invokes the SPSS modeler batch to execute SPSS streams and then do the asset health score analysis.

When complete, it then invokes grid engine to do the network risk analysis.

Procedure

Type in the command line to start a network risk analysis:

/opt/IBM/energy/grid_engine/ife_aoms_core/scripts/run_cfp.sh
/opt/IBM/energy/grid_engine/ife_aoms_core/scripts/run_cfp.sh –n

The second line requests to ignore asset health scoring and to execute network risk analysis only.

Parent topic: Running an Asset Health analysis

Tracking the progress of an analysisYou can track the progress of the analysis process. There are 4 directories containing the output of the analysis. To check the log files, go to /opt/IBM/energy/AssetHealth/SPSS_stream/log/.AHBatch.log is the common log. You can find the status of every SPSS stream in this log. The validation logs are: pole_assetHealth.log, st_assetHealth.log, dt_assetHealth.log, ohc_assetHealth.log and ugc_assetHealth.log. All asset health model configuration related error messages are found in these validation logs, for example, the sum of driver weights are not 100.To check the prediction output, go to/opt/IBM/energy/AssetHealth/SPSS_stream/score_input/ and open the .csv files to see if they are correct.To check the health score output, go to /opt/IBM/energy/AssetHealth/SPSS_stream/score/ and open the .csv files to see if the score is generated correctly. To check the grid engine log, go to /opt/IBM/energy/grid_engine/ife_aoms_core/log/.Running an Asset Health analysisThis section shows you how you can do an asset health scoring analysis and network risk analysis.

Tracking the progress of an analysis

You can track the progress of the analysis process.

About this task

There are 4 directories containing the output of the analysis.

Procedure

To check the log files, go to /opt/IBM/energy/AssetHealth/SPSS_stream/log/.

AHBatch.log is the common log. You can find the status of every SPSS stream in this log.

The validation logs are: pole_assetHealth.log, st_assetHealth.log, dt_assetHealth.log, ohc_assetHealth.log and ugc_assetHealth.log. All asset health model configuration related error messages are found in these validation logs, for example, the sum of driver weights are not 100.

To check the prediction output, go to/opt/IBM/energy/AssetHealth/SPSS_stream/score_input/ and open the .csv files to see if they are correct.

To check the health score output, go to /opt/IBM/energy/AssetHealth/SPSS_stream/score/ and open the .csv files to see if the score is generated correctly.

To check the grid engine log, go to /opt/IBM/energy/grid_engine/ife_aoms_core/log/.

Parent topic: Running an Asset Health analysis

Maintaining the solutionPerform maintenance tasks to keep your solution running smoothly. Restarting the IBM Insights Foundation for Energy componentsAfter you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.

Maintaining the solution

Perform maintenance tasks to keep your solution running smoothly.

Restarting the IBM Insights Foundation for Energy components
After you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM® Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.

Restarting the IBM Insights Foundation for Energy componentsAfter you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.Maintaining the solutionPerform maintenance tasks to keep your solution running smoothly. Understanding the platform control tool componentsThe individual platform control tool components are organized into logical groupings called base components. It is recommended that you run a single IFEControl command to stop or start all the components on a server. However, if necessary, you can stop or start the platform control tool components either at the base component level or at the individual component level. It is important that you stop and start the components in the correct order.Stopping the componentsUse the platform control tool to stop the components on the IBM Insights Foundation for Energy servers. Starting the componentsUse the platform control tool to start the components on the IBM Insights Foundation for Energy servers.

Restarting the IBM Insights Foundation for Energy components

After you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM® Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.

Understanding the platform control tool components
The individual platform control tool components are organized into logical groupings called base components. It is recommended that you run a single IFEControl command to stop or start all the components on a server. However, if necessary, you can stop or start the platform control tool components either at the base component level or at the individual component level. It is important that you stop and start the components in the correct order.

Stopping the components
Use the platform control tool to stop the components on the IBM Insights Foundation for Energy servers.

Starting the components
Use the platform control tool to start the components on the IBM Insights Foundation for Energy servers.

Parent topic: Maintaining the solution

Understanding the platform control tool componentsThe individual platform control tool components are organized into logical groupings called base components. It is recommended that you run a single IFEControl command to stop or start all the components on a server. However, if necessary, you can stop or start the platform control tool components either at the base component level or at the individual component level. It is important that you stop and start the components in the correct order.The following table lists the base components and their individual components on the three servers:Base components and their individual components on each serverServersBase componentsIndividual componentsStarted products or servicesDatabase serverdbdb2DB2 Enterprise Server EditionjenaApache JenaApplication serverappappiibIBM Integration BusapplibertyWebSphere Application Server Liberty ProfileappihsIBM HTTP ServerAnalytics serveranaanacognosIBM Cognos Business IntelligenceanaihsIBM HTTP Server for CognosasklibertyWebSphere Application Server Liberty Profile for the Analytics Solution Kit (ASK)anacndsservWebSphere Application Server Network Deployment for SPSS Collaboration and Deployment ServicesanaspssIBM SPSS Modeler Restarting the IBM Insights Foundation for Energy componentsAfter you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.

Understanding the platform control tool components

The individual platform control tool components are organized into logical groupings called base components. It is recommended that you run a single IFEControl command to stop or start all the components on a server. However, if necessary, you can stop or start the platform control tool components either at the base component level or at the individual component level. It is important that you stop and start the components in the correct order.

The following table lists the base components and their individual components on the three servers:

Table 13. Base components and their individual components on each server

Servers | Base components | Individual components | Started products or services
Database server | db | db2 | DB2® Enterprise Server Edition
jena | Apache Jena
Application server | app | appiib | IBM® Integration Bus
appliberty | WebSphere® Application Server Liberty Profile
appihs | IBM HTTP Server
Analytics server | ana | anacognos | IBM Cognos® Business Intelligence
anaihs | IBM HTTP Server for Cognos
askliberty | WebSphere Application Server Liberty Profile for the Analytics Solution Kit (ASK)
anacndsserv | WebSphere Application Server Network Deployment for SPSS® Collaboration and Deployment Services
anaspss | IBM SPSS Modeler

Parent topic: Restarting the IBM Insights Foundation for Energy components

Stopping the componentsUse the platform control tool to stop the components on the IBM Insights Foundation for Energy servers. It is recommended that you run the IFEControl command with the -a option to stop all the components. However, in some cases, it might be necessary to stop only a selection of base components or individual components. If it is necessary to stop only a selection of base components or individual components, you must stop the components in the correct order.Log on to the analytics server as the ibmadmin user.Stopping all the componentsTo stop all the IBM Insights Foundation for Energy components, enter the following command, where password is the topology password that was created during the installation process:IFEControl -a stop -c all -p passwordStopping base components or individual componentsTo stop a base component or an individual component, enter the following command:IFEControl -a stop -c component -p passwordIn the previous command, component is the name of the base component or the individual component, and password is the topology password that was created during the installation process. You must stop base components or individual components in the correct order that is outlined in Table 1. For example, if you want to stop only the app base component and the anacndsserv component, you must stop the anacndsserv component before you stop the app component.The order in which to stop base components or individual componentsOrder in which to stop base componentsOrder in which to stop individual components1. ana 1. anaspss 2. anacndsserv 3. askliberty 4. anaihs 5. anacognos2. app 6. appihs 7. appliberty 8. appmb3. db 9. jena10. db2Restarting the IBM Insights Foundation for Energy componentsAfter you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.

Stopping the components

Use the platform control tool to stop the components on the IBM® Insights Foundation for Energy servers.

About this task

It is recommended that you run the IFEControl command with the -a option to stop all the components. However, in some cases, it might be necessary to stop only a selection of base components or individual components.

Note: If it is necessary to stop only a selection of base components or individual components, you must stop the components in the correct order.

Procedure

Log on to the analytics server as the ibmadmin user.

Stopping all the components

To stop all the IBM Insights Foundation for Energy components, enter the following command, where password is the topology password that was created during the installation process:

IFEControl -a stop -c all -p password

Stopping base components or individual components

To stop a base component or an individual component, enter the following command:

IFEControl -a stop -c component -p password

In the previous command, component is the name of the base component or the individual component, and password is the topology password that was created during the installation process.

Note: You must stop base components or individual components in the correct order that is outlined in Table 1. For example, if you want to stop only the app base component and the anacndsserv component, you must stop the anacndsserv component before you stop the app component.

Table 14. The order in which to stop base components or individual components

Order in which to stop base components | Order in which to stop individual components
1. ana | 1. anaspss
2. anacndsserv
3. askliberty
4. anaihs
5. anacognos
2. app | 6. appihs
7. appliberty
8. appmb
3. db | 9. jena
10. db2

Parent topic: Restarting the IBM Insights Foundation for Energy components

Starting the componentsUse the platform control tool to start the components on the IBM Insights Foundation for Energy servers. It is recommended that you run the IFEControl command with the -a option to start all the components. However, in some cases, it might be necessary to start only a selection of base components or individual components. If it is necessary to start only a selection of base components or individual components, you must start the components in the correct order.Log on to the analytics server as the ibmadmin user.Starting all the componentsTo start all the IBM Insights Foundation for Energy components, enter the following command, where password is the topology password that was created during the installation process: IFEControl -a start -c all -p passwordStarting base components or individual componentsTo start a base component or an individual component, enter the following command: IFEControl -a start -c component -p passwordIn the previous command, component is the name of the base component or the individual component, and password is the topology password that was created during the installation process.You must start base components or individual components in the correct order that is outlined in Table 1. For example, if you want to start only the anaspss and the anacognos components, you must start the anacognos component before you start the anaspss component.The order in which to start base components or individual component Order in which to start base componentsOrder in which to start individual components1. db 1. db2 2. jena2. app 3. appmb 4. appliberty 5. appihs3. ana 6. anacognos 7. anaihs 8. askliberty 9. anacndsserv 10. anaspssRestarting the IBM Insights Foundation for Energy componentsAfter you install a custom application, or if you modify files in the system, for the changes to take effect, you might need to restart the IBM Insights Foundation for Energy components. Use the platform control tool to stop and start the components that are running on the servers.

Starting the components

Use the platform control tool to start the components on the IBM® Insights Foundation for Energy servers.

About this task

It is recommended that you run the IFEControl command with the -a option to start all the components. However, in some cases, it might be necessary to start only a selection of base components or individual components.

Note: If it is necessary to start only a selection of base components or individual components, you must start the components in the correct order.

Procedure

Log on to the analytics server as the ibmadmin user.

Starting all the components

To start all the IBM Insights Foundation for Energy components, enter the following command, where password is the topology password that was created during the installation process:

IFEControl -a start -c all -p password

Starting base components or individual components

To start a base component or an individual component, enter the following command:

IFEControl -a start -c component -p password

In the previous command, component is the name of the base component or the individual component, and password is the topology password that was created during the installation process.

Note: You must start base components or individual components in the correct order that is outlined in Table 1. For example, if you want to start only the anaspss and the anacognos components, you must start the anacognos component before you start the anaspss component.

Table 15. The order in which to start base components or individual component

Order in which to start base components | Order in which to start individual components
1. db | 1. db2
2. jena
2. app | 3. appmb
4. appliberty
5. appihs
3. ana | 6. anacognos
7. anaihs
8. askliberty
9. anacndsserv
10. anaspss

Parent topic: Restarting the IBM Insights Foundation for Energy components

Troubleshooting and supportTo isolate and resolve problems with your IBM software, you can use the troubleshooting and support information, which contains instructions for using the problem-determination resources that are provided with your IBM products.Techniques for troubleshooting problemsTroubleshooting is a systematic approach to solving a problem. The goal of troubleshooting is to determine why something does not work as expected and how to resolve the problem.Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

Troubleshooting and support

To isolate and resolve problems with your IBM® software, you can use the troubleshooting and support information, which contains instructions for using the problem-determination resources that are provided with your IBM products.

Techniques for troubleshooting problems
Troubleshooting is a systematic approach to solving a problem. The goal of troubleshooting is to determine why something does not work as expected and how to resolve the problem.

Known problems and solutions for IBM Insights Foundation for Energy
Some common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

IBM Insights Foundation for Energy messages
Each message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

Techniques for troubleshooting problemsTroubleshooting is a systematic approach to solving a problem. The goal of troubleshooting is to determine why something does not work as expected and how to resolve the problem.The first step in the troubleshooting process is to describe the problem completely. Problem descriptions help you and the IBM technical-support representative know where to start to find the cause of the problem. This step includes asking yourself basic questions:What are the symptoms of the problem?Where does the problem occur?When does the problem occur?Under which conditions does the problem occur?Can the problem be reproduced? The answers to these questions typically lead to a good description of the problem, which can then lead you to a problem resolution. What are the symptoms of the problem?When starting to describe a problem, the most obvious question is What is the problem? This question might seem straightforward; however, you can break it down into several more-focused questions that create a more descriptive picture of the problem. These questions can include:Who, or what, is reporting the problem?What are the error codes and messages?How does the system fail? For example, is it a loop, hang, crash, performance degradation, or incorrect result?Where does the problem occur?Determining where the problem originates is not always easy, but it is one of the most important steps in resolving a problem. Many layers of technology can exist between the reporting and failing components. Networks, disks, and drivers are only a few of the components to consider when you are investigating problems.The following questions help you to focus on where the problem occurs to isolate the problem layer:Is the problem specific to one platform or operating system, or is it common across multiple platforms or operating systems?Is the current environment and configuration supported?If one layer reports the problem, the problem does not necessarily originate in that layer. Part of identifying where a problem originates is understanding the environment in which it exists. Take some time to completely describe the problem environment, including the operating system and version, all corresponding software and versions, and hardware information. Confirm that you are running within an environment that is a supported configuration; many problems can be traced back to incompatible levels of software that are not intended to run together or have not been fully tested together.When does the problem occur?Develop a detailed timeline of events leading up to a failure, especially for those cases that are one-time occurrences. You can most easily develop a timeline by working backward: Start at the time an error was reported (as precisely as possible, even down to the millisecond), and work backward through the available logs and information. Typically, you need to look only as far as the first suspicious event that you find in a diagnostic log.To develop a detailed timeline of events, answer these questions:Does the problem happen only at a certain time of day or night?How often does the problem happen?What sequence of events leads up to the time that the problem is reported?Does the problem happen after an environment change, such as upgrading or installing software or hardware?Responding to these types of questions can give you a frame of reference in which to investigate the problem.Under which conditions does the problem occur?Knowing which systems and applications are running at the time that a problem occurs is an important part of troubleshooting. These questions about your environment can help you to identify the root cause of the problem:Does the problem always occur when the same task is being performed? Does a certain sequence of events need to occur for the problem to surface?Do any other applications fail at the same time? Answering these types of questions can help you explain the environment in which the problem occurs and correlate any dependencies. Remember that just because multiple problems might have occurred around the same time, the problems are not necessarily related.Can the problem be reproduced?From a troubleshooting standpoint, the ideal problem is one that can be reproduced. Typically, when a problem can be reproduced you have a larger set of tools or procedures at your disposal to help you investigate. Consequently, problems that you can reproduce are often easier to debug and solve. However, problems that you can reproduce can have a disadvantage: If the problem is of significant business impact, you do not want it to recur. If possible, re-create the problem in a test or development environment, which typically offers you more flexibility and control during your investigation. Can the problem be re-created on a test system?Are multiple users or applications encountering the same type of problem?Can the problem be re-created by running a single command, a set of commands, or a particular application?Troubleshooting and supportTo isolate and resolve problems with your IBM software, you can use the troubleshooting and support information, which contains instructions for using the problem-determination resources that are provided with your IBM products.

Techniques for troubleshooting problems

Troubleshooting is a systematic approach to solving a problem. The goal of troubleshooting is to determine why something does not work as expected and how to resolve the problem.

The first step in the troubleshooting process is to describe the problem completely. Problem descriptions help you and the IBM technical-support representative know where to start to find the cause of the problem. This step includes asking yourself basic questions:

What are the symptoms of the problem?

Where does the problem occur?

When does the problem occur?

Under which conditions does the problem occur?

Can the problem be reproduced?

The answers to these questions typically lead to a good description of the problem, which can then lead you to a problem resolution.

What are the symptoms of the problem?

When starting to describe a problem, the most obvious question is What is the problem? This question might seem straightforward; however, you can break it down into several more-focused questions that create a more descriptive picture of the problem. These questions can include:

Who, or what, is reporting the problem?

What are the error codes and messages?

How does the system fail? For example, is it a loop, hang, crash, performance degradation, or incorrect result?

Where does the problem occur?

Determining where the problem originates is not always easy, but it is one of the most important steps in resolving a problem. Many layers of technology can exist between the reporting and failing components. Networks, disks, and drivers are only a few of the components to consider when you are investigating problems.

The following questions help you to focus on where the problem occurs to isolate the problem layer:

Is the problem specific to one platform or operating system, or is it common across multiple platforms or operating systems?

Is the current environment and configuration supported?

If one layer reports the problem, the problem does not necessarily originate in that layer. Part of identifying where a problem originates is understanding the environment in which it exists. Take some time to completely describe the problem environment, including the operating system and version, all corresponding software and versions, and hardware information. Confirm that you are running within an environment that is a supported configuration; many problems can be traced back to incompatible levels of software that are not intended to run together or have not been fully tested together.

When does the problem occur?

Develop a detailed timeline of events leading up to a failure, especially for those cases that are one-time occurrences. You can most easily develop a timeline by working backward: Start at the time an error was reported (as precisely as possible, even down to the millisecond), and work backward through the available logs and information. Typically, you need to look only as far as the first suspicious event that you find in a diagnostic log.

To develop a detailed timeline of events, answer these questions:

Does the problem happen only at a certain time of day or night?

How often does the problem happen?

What sequence of events leads up to the time that the problem is reported?

Does the problem happen after an environment change, such as upgrading or installing software or hardware?

Responding to these types of questions can give you a frame of reference in which to investigate the problem.

Under which conditions does the problem occur?

Knowing which systems and applications are running at the time that a problem occurs is an important part of troubleshooting. These questions about your environment can help you to identify the root cause of the problem:

Does the problem always occur when the same task is being performed?

Does a certain sequence of events need to occur for the problem to surface?

Do any other applications fail at the same time?

Answering these types of questions can help you explain the environment in which the problem occurs and correlate any dependencies. Remember that just because multiple problems might have occurred around the same time, the problems are not necessarily related.

Can the problem be reproduced?

From a troubleshooting standpoint, the ideal problem is one that can be reproduced. Typically, when a problem can be reproduced you have a larger set of tools or procedures at your disposal to help you investigate. Consequently, problems that you can reproduce are often easier to debug and solve. However, problems that you can reproduce can have a disadvantage: If the problem is of significant business impact, you do not want it to recur. If possible, re-create the problem in a test or development environment, which typically offers you more flexibility and control during your investigation.

Can the problem be re-created on a test system?

Are multiple users or applications encountering the same type of problem?

Can the problem be re-created by running a single command, a set of commands, or a particular application?

Parent topic: Troubleshooting and support

Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing. troubleshootingknown problemsproblems and solutionsTroubleshooting and supportTo isolate and resolve problems with your IBM software, you can use the troubleshooting and support information, which contains instructions for using the problem-determination resources that are provided with your IBM products.Browser back button does not return to the perceived previous pageWhen you click the browser back button, the browser might return to a page other than where you think it should.Updated service passwords for the data loader are not automatically encryptedIf you update the service password in the data loader configuration file, the updated password is not automatically encrypted. You must run the encryption utility to store an encrypted version of the password in the configuration file.Dissolved Gas Analysis graphic cannot be exported in the .xlsx fileA Dissolved Gas Analysis graphic in the single asset report for Substation Transformer cannot be exported in the .xlsx file. Drilled-down bar chart does not clearWhen you drill-down on a bar chart, it does not clear when you select another asset on a map or list.A bar chart does not clear when user selects another assetBar chart does not clear after user selects another asset on a map or list.An analysis on the ANA node causes a segmentation faultA segmentation fault occurs when both the Asset Health and Wind 360 are installed, and both sample data are loaded too.

Known problems and solutions for IBM Insights Foundation for Energy

Some common problems with IBM® Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

Browser back button does not return to the perceived previous page
When you click the browser back button, the browser might return to a page other than where you think it should.

Updated service passwords for the data loader are not automatically encrypted
If you update the service password in the data loader configuration file, the updated password is not automatically encrypted. You must run the encryption utility to store an encrypted version of the password in the configuration file.

Dissolved Gas Analysis graphic cannot be exported in the .xlsx file
A Dissolved Gas Analysis graphic in the single asset report for Substation Transformer cannot be exported in the .xlsx file.

Drilled-down bar chart does not clear
When you drill-down on a bar chart, it does not clear when you select another asset on a map or list.

A bar chart does not clear when user selects another asset
Bar chart does not clear after user selects another asset on a map or list.

An analysis on the ANA node causes a segmentation fault
A segmentation fault occurs when both the Asset Health and Wind 360 are installed, and both sample data are loaded too.

Parent topic: Troubleshooting and support

Browser back button does not return to the perceived previous page When you click the browser back button, the browser might return to a page other than where you think it should. Symptoms Clicking the browser back button results in a page other than what is expected being displayed. Resolving the problemUse product navigation to navigate through the product. The browser forward and back buttons might not navigate to the desired product pages.Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

Browser back button does not return to the perceived previous page

When you click the browser back button, the browser might return to a page other than where you think it should.

Symptoms

Clicking the browser back button results in a page other than what is expected being displayed.

Resolving the problem

Use product navigation to navigate through the product. The browser forward and back buttons might not navigate to the desired product pages.

Parent topic: Known problems and solutions for IBM Insights Foundation for Energy

Updated service passwords for the data loader are not automatically encrypted If you update the service password in the data loader configuration file, the updated password is not automatically encrypted. You must run the encryption utility to store an encrypted version of the password in the configuration file. Symptoms If you change the service password in the data loader configuration file, the password is stored in plain text. Automatic encryption is not available for passwords that are stored in the data loader configuration file. Resolving the problemTo update the service password for the data loader, you must run the encryption utility to store an encrypted version of the password in the data loader configuration file. Enter a new value in plain text for the servicePassword property in the /opt/IBM/energy/data/cityname/config.properites file. Then, run the encrypt.sh utility to encrypt the updated service password. Log on to the application server as a user who has edit access to the config.properites file, for example, the root user.Edit the /opt/IBM/energy/data/cityname/config.properites file, and enter a new value in plain text for the servicePassword property.To encrypt the new service password in the data loader configuration file, go to the /opt/IBM/energy/lib directory and enter the following command: ./encrypt.sh /opt/IBM/energy/data/cityname/config.properties servicePassword encryptTypeWhere encryptType is the type of encryption to use. Advanced Encryption Standard (AES) and Base64 are the supported encryption types, so the value for encryptType is either aes or base64. For example, to encrypt the service password using AES, enter the following command:./encrypt.sh /opt/IBM/energy/data/cityname/config.properties servicePassword aesAES is the recommended encryption to use to encrypt the service password.Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

Updated service passwords for the data loader are not automatically encrypted

If you update the service password in the data loader configuration file, the updated password is not automatically encrypted. You must run the encryption utility to store an encrypted version of the password in the configuration file.

Symptoms

If you change the service password in the data loader configuration file, the password is stored in plain text. Automatic encryption is not available for passwords that are stored in the data loader configuration file.

Resolving the problem

To update the service password for the data loader, you must run the encryption utility to store an encrypted version of the password in the data loader configuration file. Enter a new value in plain text for the servicePassword property in the /opt/IBM/energy/data/cityname/config.properites file. Then, run the encrypt.sh utility to encrypt the updated service password.

Log on to the application server as a user who has edit access to the config.properites file, for example, the root user.

Edit the /opt/IBM/energy/data/cityname/config.properites file, and enter a new value in plain text for the servicePassword property.

To encrypt the new service password in the data loader configuration file, go to the /opt/IBM/energy/lib directory and enter the following command:

./encrypt.sh /opt/IBM/energy/data/cityname/config.properties servicePassword encryptType

Where encryptType is the type of encryption to use. Advanced Encryption Standard (AES) and Base64 are the supported encryption types, so the value for encryptType is either aes or base64.

For example, to encrypt the service password using AES, enter the following command:

./encrypt.sh /opt/IBM/energy/data/cityname/config.properties servicePassword aes

Note: AES is the recommended encryption to use to encrypt the service password.

Parent topic: Known problems and solutions for IBM Insights Foundation for Energy

Dissolved Gas Analysis graphic cannot be exported in the .xlsx fileA Dissolved Gas Analysis graphic in the single asset report for Substation Transformer cannot be exported in the .xlsx file. Symptoms When you want to export the single asset report for Substation Transformer into .xlsx file, the Dissolved Gas Analysis graphic does not show in the exported .xlsx file.Resolving the problem Export the single asset report for Substation Transformer into a .pdf file.Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

Dissolved Gas Analysis graphic cannot be exported in the .xlsx file

A Dissolved Gas Analysis graphic in the single asset report for Substation Transformer cannot be exported in the .xlsx file.

Symptoms

When you want to export the single asset report for Substation Transformer into .xlsx file, the Dissolved Gas Analysis graphic does not show in the exported .xlsx file.

Resolving the problem

Export the single asset report for Substation Transformer into a .pdf file.

Parent topic: Known problems and solutions for IBM Insights Foundation for Energy

Drilled-down bar chart does not clear When you drill-down on a bar chart, it does not clear when you select another asset on a map or list.Symptoms When you are on the DNO sample application page and select an asset on a map or list, then select a measurement in the Asset Details list and drill down the bar chart, when you select another asset on map or list the drilled-down bar chart does not clear or refresh for the new measurement.Resolving the problem Drill up the bar chart to the top level. The normal bar chart can be refreshed correctly.Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

Drilled-down bar chart does not clear

When you drill-down on a bar chart, it does not clear when you select another asset on a map or list.

Symptoms

When you are on the DNO sample application page and select an asset on a map or list, then select a measurement in the Asset Details list and drill down the bar chart, when you select another asset on map or list the drilled-down bar chart does not clear or refresh for the new measurement.

Resolving the problem

Drill up the bar chart to the top level. The normal bar chart can be refreshed correctly.

Parent topic: Known problems and solutions for IBM Insights Foundation for Energy

A bar chart does not clear when user selects another assetBar chart does not clear after user selects another asset on a map or list.Symptoms When you are on the DNO sample application page, and select an asset on map or list, and then a measurement in the Asset Details list, a bar chart will show for this measurement. If you then select another asset on map or list, the bar chart will not be cleared.Resolving the problem Select a measurement under the new selected asset, the bar chart will be updated.Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

A bar chart does not clear when user selects another asset

Bar chart does not clear after user selects another asset on a map or list.

Symptoms

When you are on the DNO sample application page, and select an asset on map or list, and then a measurement in the Asset Details list, a bar chart will show for this measurement. If you then select another asset on map or list, the bar chart will not be cleared.

Resolving the problem

Select a measurement under the new selected asset, the bar chart will be updated.

Parent topic: Known problems and solutions for IBM Insights Foundation for Energy

An analysis on the ANA node causes a segmentation faultA segmentation fault occurs when both the Asset Health and Wind 360 are installed, and both sample data are loaded too.Symptoms When an analysis is run on the analytics node (ANA node) and the Asset Health and Wind 360 applications are loaded at the same time, a segmentation fault occurs as Wind 360 sample data causes a conflict with the Asset Health application data.Segmentation faultResolving the problem 1. Run these commands on the DB node to update the container of the WPP resource type asset before you run the analysis on ANA node again. su - <db2 instance user> for example: su - db2inst1 db2 connect to IFEDB db2 "update CIM.RESOURCE set container=(select oid from CIM.RESOURCE where mrid='cityName') where resourcetype=(SELECT ID FROM CIM.RESOURCETYPE WHERE CODE='WPP') " 2. Run the analysis again on the ANA node. 3. Run these commands on the DB node to update the container of the WPP resource type asset. su - <db2 instance user> for example: su - db2inst1 db2 connect to IFEDB db2 "update CIM.RESOURCE set container=null where resourcetype=(SELECT ID FROM CIM.RESOURCETYPE WHERE CODE='WPP') "Known problems and solutions for IBM Insights Foundation for EnergySome common problems with IBM Insights Foundation for Energy are documented, along with their solutions or workarounds. If you have a problem with IBM Insights Foundation for Energy, review the problem-solution topics to determine if a solution is available to the problem that you are experiencing.

An analysis on the ANA node causes a segmentation fault

A segmentation fault occurs when both the Asset Health and Wind 360 are installed, and both sample data are loaded too.

Symptoms

When an analysis is run on the analytics node (ANA node) and the Asset Health and Wind 360 applications are loaded at the same time, a segmentation fault occurs as Wind 360 sample data causes a conflict with the Asset Health application data.

Figure 6. Segmentation fault

Resolving the problem

1. Run these commands on the DB node to update the container of the WPP resource type asset before you run the analysis on ANA node again.

su - <db2 instance user> for example: su - db2inst1

db2 connect to IFEDB

db2 "update CIM.RESOURCE set container=(select oid from CIM.RESOURCE where mrid='cityName') where resourcetype=(SELECT ID FROM CIM.RESOURCETYPE WHERE CODE='WPP') "

2. Run the analysis again on the ANA node.

3. Run these commands on the DB node to update the container of the WPP resource type asset.

su - <db2 instance user> for example: su - db2inst1

db2 connect to IFEDB

db2 "update CIM.RESOURCE set container=null where resourcetype=(SELECT ID FROM CIM.RESOURCETYPE WHERE CODE='WPP') "

Parent topic: Known problems and solutions for IBM Insights Foundation for Energy

IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error. To help you understand the errors that you might encounter, each message topic is divided into three sections: the message that is displayed in the product or its logs, an explanation, and an action. The messageContains two identifiers, which are the error identification and associated text. The error identification is the message ID. It is a unique number that identifies a message. A final character of E indicates that the message resulted from an error, W indicates a warning message, and I indicates an information message.The explanationContains an additional explanation of the message. The user responseSuggests the corrective action for resolving the error. The topics in this section are specific to IBM Insights Foundation for Energy. For all other messages, see the appropriate product documentation.Troubleshooting and supportTo isolate and resolve problems with your IBM software, you can use the troubleshooting and support information, which contains instructions for using the problem-determination resources that are provided with your IBM products.CIYIF0001EService Error - An internal error occurred.CIYIF0002ESystem Error - An internal error occurred.CIYIF0011EThe style cannot be deleted because it is used by one or more pages.CIYIF0012EThe database operation failed.CIYIF0013EThe extension cannot be deleted because it is used by one or more layouts.CIYIF0014EThe extension cannot be deleted because it is used by one or more widgets.CIYIF0015EThe layout cannot be deleted because it is used by one or more pages.CIYIF0016EYou must enter a valid value for the module name. The Module name field cannot be empty.CIYIF0017EYou must enter a valid value for the package name. The Package name field cannot be empty.CIYIF0018EYou must enter a valid value for the package location. The Package location field cannot be empty.CIYIF0019EThe widget cannot be deleted because it is used by one or more pages.CIYIF0020EThe page cannot be deleted because it is used by one or more page hierarchies.CIYIF0021EThe call to the access control REST service failed because the resource ID input parameter was not provided.CIYIF0022EThe call to the access control REST service failed because the resource type input parameter was not provided.

IBM Insights Foundation for Energy messages

Each message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

To help you understand the errors that you might encounter, each message topic is divided into three sections: the message that is displayed in the product or its logs, an explanation, and an action.

The message

Contains two identifiers, which are the error identification and associated text. The error identification is the message ID. It is a unique number that identifies a message. A final character of E indicates that the message resulted from an error, W indicates a warning message, and I indicates an information message.

The explanation

Contains an additional explanation of the message.

The user response

Suggests the corrective action for resolving the error.

Note: The topics in this section are specific to IBM® Insights Foundation for Energy. For all other messages, see the appropriate product documentation.

CIYIF0001E
Service Error - An internal error occurred.

CIYIF0002E
System Error - An internal error occurred.

CIYIF0011E
The style cannot be deleted because it is used by one or more pages.

CIYIF0012E
The database operation failed.

CIYIF0013E
The extension cannot be deleted because it is used by one or more layouts.

CIYIF0014E
The extension cannot be deleted because it is used by one or more widgets.

CIYIF0015E
The layout cannot be deleted because it is used by one or more pages.

CIYIF0016E
You must enter a valid value for the module name. The Module name field cannot be empty.

CIYIF0017E
You must enter a valid value for the package name. The Package name field cannot be empty.

CIYIF0018E
You must enter a valid value for the package location. The Package location field cannot be empty.

CIYIF0019E
The widget cannot be deleted because it is used by one or more pages.

CIYIF0020E
The page cannot be deleted because it is used by one or more page hierarchies.

CIYIF0021E
The call to the access control REST service failed because the resource ID input parameter was not provided.

CIYIF0022E
The call to the access control REST service failed because the resource type input parameter was not provided.

Parent topic: Troubleshooting and support

CIYIF0001EService Error - An internal error occurred.An error occurred in services provided by the product.Contact IBM Support to resolve the issue.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0001E

Explanation

An error occurred in services provided by the product.

User response

Contact IBM® Support to resolve the issue.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0002ESystem Error - An internal error occurred.An internal error occurred with the product.Contact your administrator to resolve the issue. The administrator needs to check or possibly restart the system.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0002E

Explanation

An internal error occurred with the product.

User response

Contact your administrator to resolve the issue. The administrator needs to check or possibly restart the system.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0011EThe style cannot be deleted because it is used by one or more pages.The style cannot be deleted because one or more pages are configured to use this style.To delete the style, you must first remove the style from any page configuration.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0011E

Explanation

The style cannot be deleted because one or more pages are configured to use this style.

User response

To delete the style, you must first remove the style from any page configuration.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0012EThe database operation failed.The database operation failed.See the WebSphere Application Server Liberty Profile log files for more information about why the database operation failed. The log files are named console.log and messages.log, and they are in the /opt/IBM/WebSphere/Liberty/usr/servers/member01/logs directory on the application server.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0012E

Explanation

The database operation failed.

User response

See the WebSphere® Application Server Liberty Profile log files for more information about why the database operation failed. The log files are named console.log and messages.log, and they are in the /opt/IBM/WebSphere/Liberty/usr/servers/member01/logs directory on the application server.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0013EThe extension cannot be deleted because it is used by one or more layouts.The extension cannot be deleted because one or more layouts are configured to use this extension.To delete the extension, you must first remove the extension from any layout configuration.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0013E

Explanation

The extension cannot be deleted because one or more layouts are configured to use this extension.

User response

To delete the extension, you must first remove the extension from any layout configuration.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0014EThe extension cannot be deleted because it is used by one or more widgets.The extension cannot be deleted because one or more widgets are configured to use this extension.To delete the extension, you must first remove the extension from any widget configuration.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0014E

Explanation

The extension cannot be deleted because one or more widgets are configured to use this extension.

User response

To delete the extension, you must first remove the extension from any widget configuration.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0015EThe layout cannot be deleted because it is used by one or more pages.The layout cannot be deleted because one or more pages are configured to use this layout.To delete the layout, you must first remove the layout from any page configuration.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0015E

Explanation

The layout cannot be deleted because one or more pages are configured to use this layout.

User response

To delete the layout, you must first remove the layout from any page configuration.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0016EYou must enter a valid value for the module name. The Module name field cannot be empty.There must be a valid value for the module name. The Module name field cannot be empty.Enter a valid value in the Module name field.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0016E

Explanation

There must be a valid value for the module name. The Module name field cannot be empty.

User response

Enter a valid value in the Module name field.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0017EYou must enter a valid value for the package name. The Package name field cannot be empty.There must be a valid value for the path name. The Package name field cannot be empty.Enter a valid value in the Package name field.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0017E

Explanation

There must be a valid value for the path name. The Package name field cannot be empty.

User response

Enter a valid value in the Package name field.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0018EYou must enter a valid value for the package location. The Package location field cannot be empty.There must be a valid value for the package location. The Package location field cannot be empty.Enter a valid value in the Package location field.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0018E

Explanation

There must be a valid value for the package location. The Package location field cannot be empty.

User response

Enter a valid value in the Package location field.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0019EThe widget cannot be deleted because it is used by one or more pages.The widget cannot be deleted because one or more pages are configured to use this widget.To delete the widget, you must first remove the widget from any page configuration.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0019E

Explanation

The widget cannot be deleted because one or more pages are configured to use this widget.

User response

To delete the widget, you must first remove the widget from any page configuration.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0020EThe page cannot be deleted because it is used by one or more page hierarchies.The page cannot be deleted because one or more page hierarchies are configured to use the page.To delete the page, you must first remove the page from any page hierarchy configuration.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0020E

Explanation

The page cannot be deleted because one or more page hierarchies are configured to use the page.

User response

To delete the page, you must first remove the page from any page hierarchy configuration.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0021EThe call to the access control REST service failed because the resource ID input parameter was not provided.You must specify a resource ID as an input parameter for this access control REST service method.Specify a resource ID as a parameter to the access control REST service method.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0021E

Explanation

You must specify a resource ID as an input parameter for this access control REST service method.

User response

Specify a resource ID as a parameter to the access control REST service method.

Parent topic: IBM Insights Foundation for Energy messages

CIYIF0022EThe call to the access control REST service failed because the resource type input parameter was not provided.You must specify a resource type as an input parameter for this access control REST service method.Specify a resource type as a parameter to the access control REST service method.IBM Insights Foundation for Energy messagesEach message topic helps you to identify the cause of a particular error condition and recommends actions to take to resolve the error.

CIYIF0022E

Explanation

You must specify a resource type as an input parameter for this access control REST service method.

User response

Specify a resource type as a parameter to the access control REST service method.

Parent topic: IBM Insights Foundation for Energy messages

ReferenceThese topics contain additional reference information to help you.The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading. License usage metricsIBM License Metric Tool helps Passport Advantage clients determine their full and sub-capacity PVU licensing requirements.Supported browsersThe IBM Insights Foundation for Energy user interface is supported in several browsers.Supported browsersThe IBM Insights Foundation for Energy user interface is supported in several browsers.AccessibilityAccessibility features help users with physical disabilities, such as restricted mobility or limited vision, to use software products successfully.

Reference

These topics contain additional reference information to help you.

The Insights Foundation for Energy Data Model
The Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

License usage metrics
IBM® License Metric Tool helps Passport Advantage® clients determine their full and sub-capacity PVU licensing requirements.

Supported browsers
The IBM Insights Foundation for Energy user interface is supported in several browsers.

Accessibility
Accessibility features help users with physical disabilities, such as restricted mobility or limited vision, to use software products successfully.

The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading. The CIM is a standard adopted by the International Electromechanical Commission (IEC) for the reporting and exchange of information about electrical supply networks. Three types of data need be loaded into the IFE Data Model:Ontology - used to define the supported assets classes and properties of the asset classes. Static data - used to define nameplate data, geographical location, network connectivity, measurement definitions and the relationships between assets.Dynamic data - is the data that changes over time. ReferenceThese topics contain additional reference information to help you.OntologyOntology is used to define the supported assets classes and properties on asset classes. IBM Insights Foundation for Energy integrates data from different data sources that is consolidated into common asset class and properties definitions. Logical ResourceThe logical resource is abstract of components of an electrical network. Asset identity and AttributesThe asset identity and attributes describe physical asset of a logical resource at a point in time. GeometryThe geospatial information that specifies both the geometry and the location of a logical resource in a network.Relationships and connectivityThe relationships that include network connectivity, the supporting structure, and flow roles are described here. Use case: Define a new asset class in the Data Model applicationIn this tutorial, you are the administrator of a system and you have a new asset class called Meter as well as assets belonging to this asset class.

The Insights Foundation for Energy Data Model

The Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

The CIM is a standard adopted by the International Electromechanical Commission (IEC) for the reporting and exchange of information about electrical supply networks. Three types of data need be loaded into the IFE Data Model:

Ontology - used to define the supported assets classes and properties of the asset classes.

Static data - used to define nameplate data, geographical location, network connectivity, measurement definitions and the relationships between assets.

Dynamic data - is the data that changes over time.

Ontology
Ontology is used to define the supported assets classes and properties on asset classes. IBM® Insights Foundation for Energy integrates data from different data sources that is consolidated into common asset class and properties definitions.

Logical Resource
The logical resource is abstract of components of an electrical network.

Asset identity and Attributes
The asset identity and attributes describe physical asset of a logical resource at a point in time.

Geometry
The geospatial information that specifies both the geometry and the location of a logical resource in a network.

Relationships and connectivity
The relationships that include network connectivity, the supporting structure, and flow roles are described here.

Parent topic: Reference

Related concepts:

Use case: Define a new asset class in the Data Model application

OntologyOntology is used to define the supported assets classes and properties on asset classes. IBM Insights Foundation for Energy integrates data from different data sources that is consolidated into common asset class and properties definitions. The mapping between external object id and internal object id is also maintained by IBM Insights Foundation for Energy.Ontology can also be used to map between semantics from all the data sources and a common semantics. Data sources can have their own semantics; they often do not use the same vocabulary of terms and data concepts. For example, a PowerTransfomer can be called differently in different data sources. IBM Insights Foundation for Energy maps semantics from all the data sources into the IEC CIM semantics.There are three types of table in ontology: Object IDResourceTypePropertyTypeObjectID table All objects are identified by a database generated object identifier, and a unique URI that is in two parts: namespace and local name. For example: for the URI http://cityName#transformer1, the namespace is http://cityName# and its local name is transformer1. When data is loaded to IFE, we assume all data objects have an unique id in the format of a URI. IFE generates a unique number based oid for internal use only, e.g. as primary key or foreign key. The ObjectID table is used to support this mechanism, providing the mapping between internal object id (oid) and external object URI. This table stores the mapping for Logical Resource, Geo Location, Connectivity Node, Terminal, Measurement, Support Association, Flow Role. oidBIGINTInternal object ids which uniquely identifies an object. It is generated by the database. namespaceVARCHAR(256)Namespace part of the URI. localNameVARCHAR(256)Local name part of the URI.ResourceType table The ResourceType table is use to store the metadata of the CIM PowerSystemResource. For example: The CIM asset classes PowerTransformer, and Switch, are subclasses of PowerSystemResource. The user can register these standard or custom defined power system resources to the ResourceType table. In addition to “PowerSystemResource”, IEC CIM also defines a set of class as asset containers, for example: GeoGraphicalRegion, SubGeographicalRegion, Substation, and Bay. The ResourceType table can also be used to register these standard or any custom defined container types. idBIGINTThe primary key id of the resource type. codeVARCHAR(128)A unique string based code of the resource type. nameVARCHAR(128)Display name of the resource type. descriptionVARCHAR(512)Description of the resource type. isAssetCHAR(1)Indicates whether resources of this type can be linked to physical asset.1 = yes, 0 = no. If isAsset = 1, then the table field holds the name of table used to store the properties of the asset. isResourceCHAR(1)Indicates whether this resource type is a power system resource or a container. 0 = is a container (for example, a geospatial region), 1 = is a power system resource. For example, a transformer. cimIDVARCHAR(128)Class name of this resource type as in the IEC CIM when the resource type is defined in IEC CIM. For example, PowerTransformer. tableVARCHAR(256)Used when isAsset = 1. The fully qualified table name used to store the properties of the asset. serviceURLVARCHAR(256)The relative service URL which expose instance data of this resource type.PropertyType table The PropertyType is used to store the properties metadata of each resource type when ResourceType.isAsset = 1. idBIGINTThe primary key, id of the property type. resourceTypeBIGINTThe foreign Key, the id of resource type. codeVARCHAR(128)A unique string based code of the property type. nameVARCHAR(128)Display name of property type. descriptionVARCHAR(512)Description of property type. cimIDVARCHAR(128)The property name of this property type in the IEC CIM when defined in IEC CIM. For example, Asset.lifecycle.installationDate. columnVARCHAR(128)Column name in target table which been used to store this property value. dataTypeVARCHAR(32)The data type of the property. lengthINTEGERThe length of the property. scaleINTEGERThe scale of the property. isEnumCHAR(1)Indicates if the property value is an enumeration. isReferenceCHAR(1)Not used. isMinimalCHAR(1)Indicates if the property is a minimal property. Minimal property is an important property to filter and sort data. tagVARCHAR(128)Tags on property type. groupVARCHAR(128)The group name of the property. Used to group related properties.unitVARCHAR(128)The unit of the property value.The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

Ontology

Ontology is used to define the supported assets classes and properties on asset classes. IBM® Insights Foundation for Energy integrates data from different data sources that is consolidated into common asset class and properties definitions.

The mapping between external object id and internal object id is also maintained by IBM Insights Foundation for Energy.

Ontology can also be used to map between semantics from all the data sources and a common semantics. Data sources can have their own semantics; they often do not use the same vocabulary of terms and data concepts. For example, a PowerTransfomer can be called differently in different data sources. IBM Insights Foundation for Energy maps semantics from all the data sources into the IEC CIM semantics.

There are three types of table in ontology:

Object ID

ResourceType

PropertyType

ObjectID table

All objects are identified by a database generated object identifier, and a unique URI that is in two parts: namespace and local name. For example: for the URI http://cityName#transformer1, the namespace is http://cityName# and its local name is transformer1.

When data is loaded to IFE, we assume all data objects have an unique id in the format of a URI. IFE generates a unique number based oid for internal use only, e.g. as primary key or foreign key.

The ObjectID table is used to support this mechanism, providing the mapping between internal object id (oid) and external object URI. This table stores the mapping for Logical Resource, Geo Location, Connectivity Node, Terminal, Measurement, Support Association, Flow Role.

oid

BIGINT

Internal object ids which uniquely identifies an object.

It is generated by the database.

namespace

VARCHAR(256)

Namespace part of the URI.

localName

VARCHAR(256)

Local name part of the URI.

ResourceType table

The ResourceType table is use to store the metadata of the CIM PowerSystemResource. For example: The CIM asset classes PowerTransformer, and Switch, are subclasses of PowerSystemResource. The user can register these standard or custom defined power system resources to the ResourceType table.

In addition to “PowerSystemResource”, IEC CIM also defines a set of class as asset containers, for example: GeoGraphicalRegion, SubGeographicalRegion, Substation, and Bay. The ResourceType table can also be used to register these standard or any custom defined container types.

id

BIGINT

The primary key id of the resource type.

code

VARCHAR(128)

A unique string based code of the resource type.

name

VARCHAR(128)

Display name of the resource type.

description

VARCHAR(512)

Description of the resource type.

isAsset

CHAR(1)

Indicates whether resources of this type can be linked to physical asset.

1 = yes, 0 = no.

If isAsset = 1, then the table field holds the name of table used to store the properties of the asset.

isResource

CHAR(1)

Indicates whether this resource type is a power system resource or a container.

0 = is a container (for example, a geospatial region),

1 = is a power system resource. For example, a transformer.

cimID

VARCHAR(128)

Class name of this resource type as in the IEC CIM when the resource type is defined in IEC CIM. For example, PowerTransformer.

table

VARCHAR(256)

Used when isAsset = 1. The fully qualified table name used to store the properties of the asset.

serviceURL

VARCHAR(256)

The relative service URL which expose instance data of this resource type.

PropertyType table

The PropertyType is used to store the properties metadata of each resource type when ResourceType.isAsset = 1.

id

BIGINT

The primary key, id of the property type.

resourceType

BIGINT

The foreign Key, the id of resource type.

code

VARCHAR(128)

A unique string based code of the property type.

name

VARCHAR(128)

Display name of property type.

description

VARCHAR(512)

Description of property type.

cimID

VARCHAR(128)

The property name of this property type in the IEC CIM when defined in IEC CIM. For example, Asset.lifecycle.installationDate.

column

VARCHAR(128)

Column name in target table which been used to store this property value.

dataType

VARCHAR(32)

The data type of the property.

length

INTEGER

The length of the property.

scale

INTEGER

The scale of the property.

isEnum

CHAR(1)

Indicates if the property value is an enumeration.

isReference

CHAR(1)

Not used.

isMinimal

CHAR(1)

Indicates if the property is a minimal property.

Minimal property is an important property to filter and sort data.

tag

VARCHAR(128)

Tags on property type.

group

VARCHAR(128)

The group name of the property. Used to group related properties.

unit

VARCHAR(128)

The unit of the property value.

Parent topic: The Insights Foundation for Energy Data Model

Logical ResourceThe logical resource is abstract of components of an electrical network. When a transformer is referred to in an electrical network, we are interested in its role in the network, how it connected and physical device that is acts upon it. In this example the transformer is the logical resource within the electrical network.The types of Logical resource varies; the type is defined in the ResourceType table. Some types of logical resources are associated with properties that are stored in a separate child table. For example, a logical resource can also have a location that is stored in the Location table.Logical resources have different types that are defined in ResourceType table. Based on the definition in the ResourceType table, some types of logical resources can be associated with properties that are stored in a separate children table, for example: Pole, SubstationTrasformer. The relationship between logical resources are described by a container and the objects it comprises. The container is used to group together components of an asset, or to group assets of a service region. For example, an overhead cable is composed of line segments, the overhead cable is the container and the line segment are its objects. The aggregation of the relationship can be hierarchical, that is, a container can contain other containers.Attributes for Logical Resources table oidBIGINTPrimary key, the object id of the resource type. The Object ID is generated in the ObjectID table.lastUpdateTimeTIMESTAMPGenerated last update time.resourceTypeBIGINTForeign key, the type of this logical resource with reference to the ResourceType table.mRIDVARCHAR(256)Master resource ID. The string based identifier of the logical resource.nameVARCHAR(128)The name of logical resource.descriptionVARCHAR(512)The description of the logical resource.isContainerCHAR(1)Indicates if the logical resources is a container of other components.locationBIGINTForeign key, the location of the logical resource with reference to the Location table.containerBIGINTForeign key, the container or parent of this logical resource, with reference to self.The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

Logical Resource

The logical resource is abstract of components of an electrical network.

When a transformer is referred to in an electrical network, we are interested in its role in the network, how it connected and physical device that is acts upon it. In this example the transformer is the logical resource within the electrical network.

The types of Logical resource varies; the type is defined in the ResourceType table. Some types of logical resources are associated with properties that are stored in a separate child table. For example, a logical resource can also have a location that is stored in the Location table.

Logical resources have different types that are defined in ResourceType table. Based on the definition in the ResourceType table, some types of logical resources can be associated with properties that are stored in a separate children table, for example: Pole, SubstationTrasformer.

The relationship between logical resources are described by a container and the objects it comprises. The container is used to group together components of an asset, or to group assets of a service region. For example, an overhead cable is composed of line segments, the overhead cable is the container and the line segment are its objects. The aggregation of the relationship can be hierarchical, that is, a container can contain other containers.

Attributes for Logical Resources table

oid

BIGINT

Primary key, the object id of the resource type.

The Object ID is generated in the ObjectID table.

lastUpdateTime

TIMESTAMP

Generated last update time.

resourceType

BIGINT

Foreign key, the type of this logical resource with reference to the ResourceType table.

mRID

VARCHAR(256)

Master resource ID. The string based identifier of the logical resource.

name

VARCHAR(128)

The name of logical resource.

description

VARCHAR(512)

The description of the logical resource.

isContainer

CHAR(1)

Indicates if the logical resources is a container of other components.

location

BIGINT

Foreign key, the location of the logical resource with reference to the Location table.

container

BIGINT

Foreign key, the container or parent of this logical resource, with reference to self.

Parent topic: The Insights Foundation for Energy Data Model

Asset identity and AttributesThe asset identity and attributes describe physical asset of a logical resource at a point in time. Each logical resource can be associated with more than one physical asset. Each asset described indicates which physical asset is acting as this logical role over different time periods. For example the logical resource transformer1 is associated with two physical transformers, one was active from the year 2000 to 2010 and the other has been active from the year 2010 to the present day.The separation of the logical resource from the physical asset has several benefits.You are able to track the replacement history of a logical resource.The role and responsibility is made clear: the role of the logical resource is to describe the measurement, the connections and location of an asset, and the relationship between assets. The physical asset focuses on the identity of the asset and the static attributes of the nameplate data.Static attributes are the asset specific nameplate information including asset type, model, date of manufacture, manufacturer specifications, serial number, and default operating state. This information typically resides in an Enterprise Asset Management (EAM) system, an Asset Management System (AMS), or in a Geographic Information System (GIS) for assets in the distribution grid. The AMS captures asset attributes beyond what is available in the GIS system. For each resource type registered, when isAsset = 1 in the ResourceType table, there is a corresponding asset identity table used to store the attributes of the asset. Some attributes are also registered in the PropertyType table.IBM Insights Foundation for Energy provides five asset identity and attribute tables:Pole: attributes for pole.SubstationTransformer: attributes for substation transformers.DistributionTransformer: attributes for distribution transformers.OverheadCable: attributes for overhead cables. UnderGroundCable: attributes for underground cables.Common attributes for all assets Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields. oidBIGINT Mandatory, the Primary Key, Foreign Key, object id of the logical resource.serialNumberVARCHAR(128) Mandatory, the serial number of the physical asset.isActiveCHAR(1) Mandatory, indicates if the assets is currently active, 1 = active, 0 = inactive.installationDateDATE Mandatory, the date when the asset is installed.removalDateDATE Date when asset is removed.lastUpdateTimeTIMESTAMP Mandatory, Generated last update time.Attributes for Pole assets Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields. lengthDECIMAL(8 , 4) Mandatory, the length of the pole includes any section of the pole that is underground after installation. The unit is defined in the PropertyType table.lengthClassVARCHAR(32)classificationVARCHAR(32) Pole class: 1, 2, 3, 4, 5, 6, 7, H1, H2, Other, Unknown.materialKindVARCHAR(32) The material the pole is made from. For example, wood, metal, cement.speciesTypeVARCHAR(32) Mandatory, Pole species. Aluminum, Aluminum Davit, Concrete, Fiberglass, Galvanized Davit, Galvanized, Steel Davit Primed, Steel Davit, Steel Standard Primed, Steel, Truncated, Wood-Treated, Wood-Hard, Wood-Salt Treated, Wood-Soft, Wood, Other, Unknown.reclaimedStatusCHAR(1) Mandatory, Indicates if the pole is made from reclaimed material. treatmentKindVARCHAR(32) The treatment type for the pole.preservativeKindVARCHAR(32) Mandatory, The type of preservative used for the pole.originalGroundlineCircumferenceDECIMAL(8 , 4)manufacturerVARCHAR(128) The manufacturer of the pole.ownerTypeVARCHAR(32) Type of pole owner, for example, company.inspectionTypeVARCHAR(32)inspectionTreatmentTypeVARCHAR(32)inspectionStatusVARCHAR(32) Mandatory, Status of last inspection.Attributes for Substation Transformer assets Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields. operatingVoltageINTEGER Mandatory, the operating voltage.summerEmergencyRatingINTEGER Mandatory, the Summer Emergency Rating.summerNormalRatingINTEGER Mandatory, the Summer Normal Rating.winterEmergencyRatingINTEGER Mandatory, the Winter Emergency Rating.winterNormalRatingINTEGER Mandatory, the Winter Normal Rating.stage1RatingINTEGER Mandatory, the Stage 1 Rating.stage2RatingINTEGER Mandatory, the Stage 2 Rating.stage3RatingINTEGER Mandatory, the Stage 3 Rating.manufacturerVARCHAR(128) Mandatory, the manufacturer of the transformer.subTypeCodeVARCHAR(32) The substation type code.feederVARCHAR(32) Feeder for the transformer.alterFeederVARCHAR(32) Alter feeder of the transformer.feederInfoINTEGER The feed information.workorderiVARCHAR(32)electricTraceWeightINTEGER Electric trace weight.GLNXINTEGERGLNYINTEGERprotectiveGLNXINTEGER Protective GLNXprotectiveGLNYINTEGERProtective GLNYownerVARCHAR(32)Mandatory, the owner of the transformergroundreacINTEGERgroundresiINTEGERhighsidegrINTEGERhighside_1INTEGERhighsideprVARCHAR(32)labeltextVARCHAR(32)Label textphaseDesignationINTEGERThe phase designationnominalVoltageINTEGERNominal VoltageratedkvaFLOAT(53)Mandatory, rated KVAhighsidecoVARCHAR(32)lowsideconVARCHAR(32)lowsidegroFLOAT(53)lowsideg_1FLOAT(53)lowsideproVARCHAR(32)lowsidevolINTEGERfilledweigFLOAT(53)Filled weightemptyweighFLOAT(53)Empty weightheightbushFLOAT(53)heightnobuFLOAT(53)ratedkva65INTEGERratedtertiINTEGERswitchtypeVARCHAR(32)tertiarycoVARCHAR(32)tertiaryvoINTEGERsectionalizerVARCHAR(32)SectionalizercabinetconVARCHAR(32)xfnumberVARCHAR(32)cableidVARCHAR(32)The identification number of the cable.circuitVARCHAR(32)Circuit descriptionworkLocationVARCHAR(32)Work locationphaseOrientationVARCHAR(32)The phase orientationfacilityIdVARCHAR(32)constructiINTEGERisOutageDeviceCHAR(1)Mandatory, indicates if the transformer is an outage device.numberOfCustomersINTEGERMandatory, the number of downstream customers supported by transformer.Attributes for overhead cable assets Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields. lengthFLOAT(53)The length of the cable. The units are defined in the PropertyType table.feederVARCHAR(32)The feeder for the cable.operatingVoltageINTEGERThe operating voltageownerVARCHAR(32)The owner of cable.labeltextVARCHAR(32)Label textphaseDesignationINTEGERPhase Designation.phaseOrientationVARCHAR(32)Phase OrientationcableRatingASet1INTEGERCable Rating A Set 1cableRatingBSet1INTEGERCable Rating B Set 1cableRatingASet2INTEGERCable Rating A Set 2cableRatingBSet2INTEGERCable Rating B Set 2cableRatingASet3INTEGERCable Rating A Set 3cableRatingBSet3INTEGERCable Rating B Set 3cableRatingASet4INTEGERCable Rating A Set 4cableRatingBSet4INTEGERCable Rating B Set 4Attributes for underground cable assets Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields. lengthFLOAT(53)The length of the underground cable. The unit is defined in the PropertyType tablefeederVARCHAR(32)Feeder of cablesubTypeCodeVARCHAR(32)Sub type codeoperatingVoltageINTEGEROperating VoltageownerVARCHAR(32)The owner of cable.labeltextVARCHAR(32)Label textphaseDesignationINTEGERPhase Designation.phaseOrientationVARCHAR(32)Phase OrientationcableIdVARCHAR(32)Cable IDcircuitVARCHAR(32)CircuitcableNumberVARCHAR(32)Cable NumbercableRatingASet1INTEGERCable Rating A Set 1cableRatingBSet1INTEGERCable Rating B Set 1cableRatingASet2INTEGERCable Rating A Set 2cableRatingBSet2INTEGERCable Rating B Set 2cableRatingASet3INTEGERCable Rating A Set 3cableRatingBSet3INTEGERCable Rating B Set 3cableRatingASet4INTEGERCable Rating A Set 4cableRatingBSet4INTEGERCable Rating B Set 4The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

Asset identity and Attributes

The asset identity and attributes describe physical asset of a logical resource at a point in time.

Each logical resource can be associated with more than one physical asset. Each asset described indicates which physical asset is acting as this logical role over different time periods. For example the logical resource transformer1 is associated with two physical transformers, one was active from the year 2000 to 2010 and the other has been active from the year 2010 to the present day.

The separation of the logical resource from the physical asset has several benefits.

You are able to track the replacement history of a logical resource.

The role and responsibility is made clear: the role of the logical resource is to describe the measurement, the connections and location of an asset, and the relationship between assets. The physical asset focuses on the identity of the asset and the static attributes of the nameplate data.

Static attributes are the asset specific nameplate information including asset type, model, date of manufacture, manufacturer specifications, serial number, and default operating state. This information typically resides in an Enterprise Asset Management (EAM) system, an Asset Management System (AMS), or in a Geographic Information System (GIS) for assets in the distribution grid. The AMS captures asset attributes beyond what is available in the GIS system.

For each resource type registered, when isAsset = 1 in the ResourceType table, there is a corresponding asset identity table used to store the attributes of the asset. Some attributes are also registered in the PropertyType table.

IBM® Insights Foundation for Energy provides five asset identity and attribute tables:

Pole: attributes for pole.

SubstationTransformer: attributes for substation transformers.

DistributionTransformer: attributes for distribution transformers.

OverheadCable: attributes for overhead cables.

UnderGroundCable: attributes for underground cables.

Common attributes for all assets

Note: Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields.

oid

BIGINT

Mandatory, the Primary Key, Foreign Key, object id of the logical resource.

serialNumber

VARCHAR(128)

Mandatory, the serial number of the physical asset.

isActive

CHAR(1)

Mandatory, indicates if the assets is currently active, 1 = active, 0 = inactive.

installationDate

DATE

Mandatory, the date when the asset is installed.

removalDate

DATE

Date when asset is removed.

lastUpdateTime

TIMESTAMP

Mandatory, Generated last update time.

Attributes for Pole assets

Note: Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields.

length

DECIMAL(8 , 4)

Mandatory, the length of the pole includes any section of the pole that is underground after installation. The unit is defined in the PropertyType table.

lengthClass

VARCHAR(32)

classification

VARCHAR(32)

Pole class: 1, 2, 3, 4, 5, 6, 7, H1, H2, Other, Unknown.

materialKind

VARCHAR(32)

The material the pole is made from. For example, wood, metal, cement.

speciesType

VARCHAR(32)

Mandatory, Pole species. Aluminum, Aluminum Davit, Concrete, Fiberglass, Galvanized Davit, Galvanized, Steel Davit Primed, Steel Davit, Steel Standard Primed, Steel, Truncated, Wood-Treated, Wood-Hard, Wood-Salt Treated, Wood-Soft, Wood, Other, Unknown.

reclaimedStatus

CHAR(1)

Mandatory, Indicates if the pole is made from reclaimed material.

treatmentKind

VARCHAR(32)

The treatment type for the pole.

preservativeKind

VARCHAR(32)

Mandatory, The type of preservative used for the pole.

originalGroundlineCircumference

DECIMAL(8 , 4)

manufacturer

VARCHAR(128)

The manufacturer of the pole.

ownerType

VARCHAR(32)

Type of pole owner, for example, company.

inspectionType

VARCHAR(32)

inspectionTreatmentType

VARCHAR(32)

inspectionStatus

VARCHAR(32)

Mandatory, Status of last inspection.

Attributes for Substation Transformer assets

Note: Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields.

operatingVoltage

INTEGER

Mandatory, the operating voltage.

summerEmergencyRating

INTEGER

Mandatory, the Summer Emergency Rating.

summerNormalRating

INTEGER

Mandatory, the Summer Normal Rating.

winterEmergencyRating

INTEGER

Mandatory, the Winter Emergency Rating.

winterNormalRating

INTEGER

Mandatory, the Winter Normal Rating.

stage1Rating

INTEGER

Mandatory, the Stage 1 Rating.

stage2Rating

INTEGER

Mandatory, the Stage 2 Rating.

stage3Rating

INTEGER

Mandatory, the Stage 3 Rating.

manufacturer

VARCHAR(128)

Mandatory, the manufacturer of the transformer.

subTypeCode

VARCHAR(32)

The substation type code.

feeder

VARCHAR(32)

Feeder for the transformer.

alterFeeder

VARCHAR(32)

Alter feeder of the transformer.

feederInfo

INTEGER

The feed information.

workorderi

VARCHAR(32)

electricTraceWeight

INTEGER

Electric trace weight.

GLNX

INTEGER

GLNY

INTEGER

protectiveGLNX

INTEGER

Protective GLNX

protectiveGLNY

INTEGER

Protective GLNY

owner

VARCHAR(32)

Mandatory, the owner of the transformer

groundreac

INTEGER

groundresi

INTEGER

highsidegr

INTEGER

highside_1

INTEGER

highsidepr

VARCHAR(32)

labeltext

VARCHAR(32)

Label text

phaseDesignation

INTEGER

The phase designation

nominalVoltage

INTEGER

Nominal Voltage

ratedkva

FLOAT(53)

Mandatory, rated KVA

highsideco

VARCHAR(32)

lowsidecon

VARCHAR(32)

lowsidegro

FLOAT(53)

lowsideg_1

FLOAT(53)

lowsidepro

VARCHAR(32)

lowsidevol

INTEGER

filledweig

FLOAT(53)

Filled weight

emptyweigh

FLOAT(53)

Empty weight

heightbush

FLOAT(53)

heightnobu

FLOAT(53)

ratedkva65

INTEGER

ratedterti

INTEGER

switchtype

VARCHAR(32)

tertiaryco

VARCHAR(32)

tertiaryvo

INTEGER

sectionalizer

VARCHAR(32)

Sectionalizer

cabinetcon

VARCHAR(32)

xfnumber

VARCHAR(32)

cableid

VARCHAR(32)

The identification number of the cable.

circuit

VARCHAR(32)

Circuit description

workLocation

VARCHAR(32)

Work location

phaseOrientation

VARCHAR(32)

The phase orientation

facilityId

VARCHAR(32)

constructi

INTEGER

isOutageDevice

CHAR(1)

Mandatory, indicates if the transformer is an outage device.

numberOfCustomers

INTEGER

Mandatory, the number of downstream customers supported by transformer.

Attributes for overhead cable assets

Note: Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields.

length

FLOAT(53)

The length of the cable. The units are defined in the PropertyType table.

feeder

VARCHAR(32)

The feeder for the cable.

operatingVoltage

INTEGER

The operating voltage

owner

VARCHAR(32)

The owner of cable.

labeltext

VARCHAR(32)

Label text

phaseDesignation

INTEGER

Phase Designation.

phaseOrientation

VARCHAR(32)

Phase Orientation

cableRatingASet1

INTEGER

Cable Rating A Set 1

cableRatingBSet1

INTEGER

Cable Rating B Set 1

cableRatingASet2

INTEGER

Cable Rating A Set 2

cableRatingBSet2

INTEGER

Cable Rating B Set 2

cableRatingASet3

INTEGER

Cable Rating A Set 3

cableRatingBSet3

INTEGER

Cable Rating B Set 3

cableRatingASet4

INTEGER

Cable Rating A Set 4

cableRatingBSet4

INTEGER

Cable Rating B Set 4

Attributes for underground cable assets

Note: Where an attribute is mandatory, it will be used in the analysis of asset health. You must provide values for these fields.

length

FLOAT(53)

The length of the underground cable. The unit is defined in the PropertyType table

feeder

VARCHAR(32)

Feeder of cable

subTypeCode

VARCHAR(32)

Sub type code

operatingVoltage

INTEGER

Operating Voltage

owner

VARCHAR(32)

The owner of cable.

labeltext

VARCHAR(32)

Label text

phaseDesignation

INTEGER

Phase Designation.

phaseOrientation

VARCHAR(32)

Phase Orientation

cableId

VARCHAR(32)

Cable ID

circuit

VARCHAR(32)

Circuit

cableNumber

VARCHAR(32)

Cable Number

cableRatingASet1

INTEGER

Cable Rating A Set 1

cableRatingBSet1

INTEGER

Cable Rating B Set 1

cableRatingASet2

INTEGER

Cable Rating A Set 2

cableRatingBSet2

INTEGER

Cable Rating B Set 2

cableRatingASet3

INTEGER

Cable Rating A Set 3

cableRatingBSet3

INTEGER

Cable Rating B Set 3

cableRatingASet4

INTEGER

Cable Rating A Set 4

cableRatingBSet4

INTEGER

Cable Rating B Set 4

Parent topic: The Insights Foundation for Energy Data Model

GeometryThe geospatial information that specifies both the geometry and the location of a logical resource in a network.Geospatial location is a key attribute in a physical infrastructure that enables geospatial analytics and visualization of the entities on a map.Location attributes The location attributes are typically stored in a GIS system, an example being the Environmental Systems Research Institute (ESRI) ArcGIS. oidBIGINTPrimary key, object id of the location. Object id is generated in ObjectID table.lastUpdateTimeTIMESTAMPGenerated last update time.mRIDVARCHAR(256)Master resource id. Which is a string based identifier.isActiveCHAR(1)Indicate if the location is active or not.directionVARCHAR(32)The direction that allows field crews to find quickly a given asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site.mainAddressVARCHAR(256)Main address of the location.phone1VARCHAR(32)Phone number.phone2VARCHAR(32)Phone number.secondaryAddressVARCHAR(256)Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.geometryGEOMETRYThe geospatial location in GIS.locationDescriptionVARCHAR(256)Description of the location.The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

Geometry

The geospatial information that specifies both the geometry and the location of a logical resource in a network.

Geospatial location is a key attribute in a physical infrastructure that enables geospatial analytics and visualization of the entities on a map.

Location attributes

The location attributes are typically stored in a GIS system, an example being the Environmental Systems Research Institute (ESRI) ArcGIS.

oid

BIGINT

Primary key, object id of the location.

Object id is generated in ObjectID table.

lastUpdateTime

TIMESTAMP

Generated last update time.

mRID

VARCHAR(256)

Master resource id. Which is a string based identifier.

isActive

CHAR(1)

Indicate if the location is active or not.

direction

VARCHAR(32)

The direction that allows field crews to find quickly a given asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site.

mainAddress

VARCHAR(256)

Main address of the location.

phone1

VARCHAR(32)

Phone number.

phone2

VARCHAR(32)

Phone number.

secondaryAddress

VARCHAR(256)

Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.

geometry

GEOMETRY

The geospatial location in GIS.

locationDescription

VARCHAR(256)

Description of the location.

Parent topic: The Insights Foundation for Energy Data Model

Relationships and connectivityThe relationships that include network connectivity, the supporting structure, and flow roles are described here. The IEC CIM is the template for model network connectivity between logical resources. In IEC CIM, ConnectiivtyNode and Terminal are used to model connectivity between conducting equipment.ConnectivityNode: points where terminals of conducting equipment are connected together with zero impedance.Terminal: An electrical connection point to a piece of electrical equipment. Terminals are connected at physical connection points called "connectivity nodes".Using this model, the terminals are connected to a connectivity node, as in the following diagram.Terminals connected to a connectivity nodeThe same model is used to describe the connectivity between logical resources.Attributes for the Connectivity Node oidBIGINTPrimary key, object id of the connectivity node. Object id is generated in ObjectID table.lastUpdateTimeTIMESTAMPGenerated last update time.mRIDVARCHAR(256)The master resource ID. This is a string based identifier for the connectivity node.isActiveCHAR(1)Indicates if current connectivity node is active.nameVARCHAR(128)The name of the connectivity node.descriptionVARCHAR(512)The description of the connectivity node.containerBIGINTA foreign key, the parent of this connectivity node with reference to the resource table.Attributes for the terminals oidBIGINTPrimary key, object id of the terminal. Object id is generated in ObjectID table.lastUpdateTimeTIMESTAMPGenerated last update time.mRIDVARCHAR(256)The master resource ID. This is a string based identifier for the connectivity node.isActiveCHAR(1)Indicates if the current terminal is active.nameVARCHAR(128)The name of the terminal.descriptionVARCHAR(512)The description of terminal.sequenceNumberINTEGERThe sequence number of the terminal. If a resource has multiple terminals, the sequence number is used to put the terminals in order.connectedCHAR(1)Indicates if the terminal is connected.phasesVARCHAR(32)The phases of the terminal.resourceBIGINTA foreign Key, the resource end of the terminal, with reference to the Resource attributes.connectivityNodeBIGINTA foreign key, the connectivity node end of the terminal, with reference to the ConnectivityNode attributes.The attributes for support association For supporting structural relationships, the supporting structure relationship does not indicate any electric transmission between assets. For example, if several poles are used support the an overhead cable, then there is a supporting structure relationship between the poles and the overhead cable, however, this relationship cannot be modeled using the connectivity relationship as no electric current flows from the cable to the poles. oidBIGINTThe primary key, the object id of the support association. The object id is generated in the ObjectID table.lastUpdateTimeTIMESTAMPGenerated last update time.mRIDVARCHAR(256)The master resource id. This is a string based identifier for the support association.isActiveCHAR(1)Indicates if current support association is active.supporterBIGINTA foreign key, the oid for the supporter resource, with reference to the Resource attributes.supportedBIGINTA foreign key, the oid of the supported resource, with reference to the resource attributes. For example if the supporter is a pole then the oid is for the pole, the supported is the oid of the cable.The attributes for flow role Flow role is used to describe the role of a logical resource in a network. For example, we can assign the role power source to one asset, and assign the role power sink of to another asset, we can then use these roles to calculate power flow. oidBIGINTPrimary key, foreign key, object id of logical resource.lastUpdateTimeTIMESTAMPGenerated last update time.isActiveCHAR(1)Indicates if the current flow role is active.roleINTEGERThe role of the logical resource in the network.The Insights Foundation for Energy Data ModelThe Insights Foundation for Energy data model is based on the Common Information Model (CIM) Data Model and needs be populated with data through Data Loading.

Relationships and connectivity

The relationships that include network connectivity, the supporting structure, and flow roles are described here.

The IEC CIM is the template for model network connectivity between logical resources. In IEC CIM, ConnectiivtyNode and Terminal are used to model connectivity between conducting equipment.

ConnectivityNode: points where terminals of conducting equipment are connected together with zero impedance.

Terminal: An electrical connection point to a piece of electrical equipment. Terminals are connected at physical connection points called "connectivity nodes".

Using this model, the terminals are connected to a connectivity node, as in the following diagram.

Figure 7. Terminals connected to a connectivity node

The same model is used to describe the connectivity between logical resources.

Attributes for the Connectivity Node

oid

BIGINT

Primary key, object id of the connectivity node.

Object id is generated in ObjectID table.

lastUpdateTime

TIMESTAMP

Generated last update time.

mRID

VARCHAR(256)

The master resource ID. This is a string based identifier for the connectivity node.

isActive

CHAR(1)

Indicates if current connectivity node is active.

name

VARCHAR(128)

The name of the connectivity node.

description

VARCHAR(512)

The description of the connectivity node.

container

BIGINT

A foreign key, the parent of this connectivity node with reference to the resource table.

Attributes for the terminals

oid

BIGINT

Primary key, object id of the terminal.

Object id is generated in ObjectID table.

lastUpdateTime

TIMESTAMP

Generated last update time.

mRID

VARCHAR(256)

The master resource ID. This is a string based identifier for the connectivity node.

isActive

CHAR(1)

Indicates if the current terminal is active.

name

VARCHAR(128)

The name of the terminal.

description

VARCHAR(512)

The description of terminal.

sequenceNumber

INTEGER

The sequence number of the terminal. If a resource has multiple terminals, the sequence number is used to put the terminals in order.

connected

CHAR(1)

Indicates if the terminal is connected.

phases

VARCHAR(32)

The phases of the terminal.

resource

BIGINT

A foreign Key, the resource end of the terminal, with reference to the Resource attributes.

connectivityNode

BIGINT

A foreign key, the connectivity node end of the terminal, with reference to the ConnectivityNode attributes.

The attributes for support association

For supporting structural relationships, the supporting structure relationship does not indicate any electric transmission between assets. For example, if several poles are used support the an overhead cable, then there is a supporting structure relationship between the poles and the overhead cable, however, this relationship cannot be modeled using the connectivity relationship as no electric current flows from the cable to the poles.

oid

BIGINT

The primary key, the object id of the support association.

The object id is generated in the ObjectID table.

lastUpdateTime

TIMESTAMP

Generated last update time.

mRID

VARCHAR(256)

The master resource id. This is a string based identifier for the support association.

isActive

CHAR(1)

Indicates if current support association is active.

supporter

BIGINT

A foreign key, the oid for the supporter resource, with reference to the Resource attributes.

supported

BIGINT

A foreign key, the oid of the supported resource, with reference to the resource attributes. For example if the supporter is a pole then the oid is for the pole, the supported is the oid of the cable.

The attributes for flow role

Flow role is used to describe the role of a logical resource in a network. For example, we can assign the role power source to one asset, and assign the role power sink of to another asset, we can then use these roles to calculate power flow.

oid

BIGINT

Primary key, foreign key, object id of logical resource.

lastUpdateTime

TIMESTAMP

Generated last update time.

isActive

CHAR(1)

Indicates if the current flow role is active.

role

INTEGER

The role of the logical resource in the network.

Parent topic: The Insights Foundation for Energy Data Model

License usage metricsIBM License Metric Tool helps Passport Advantage clients determine their full and sub-capacity PVU licensing requirements.Learn more: IBM License Metric Tool.<CONSUMING_PRODUCT_NAME> writes usage information to Software License Metric Tag (SLMTag) files. These files have the extension .slmtag and are read periodically by the IBM License Metric Tool (ILMT) after it has been configured to scan for these files. You can generate reports that summarize usage.For more information about using IBM License Management Tool, see the IBM License Management Tool 9.0 Knowledge Center. SLMTag logging When IBM Insights Foundation for Energy is running, license management information is logged every day to the /opt/IBM/energy/properties/slmtags directory on the application server. The logged .slmtag files contain usage information for the three types of usage:Standard userThe usage information that is logged is the number of licensed standard users in the system.Limited userThe usage information that is logged is the number of licensed limited users in the system.Asset analyticsThe usage information that is logged is the number of managed assets in the system. This value is retrieved from the CIM database. For the IBM Insights Foundation for Energy 1.5 release, this value is always 0. The numbers of licensed standard users and limited users in the system is retrieved from the basic user registry that is deployed with IBM Insights Foundation for Energy. To ensure the accuracy of these numbers, the configuration file that maps user groups to license types must be kept up to date. For more information about mapping groups to license types, see the related link. The following content is an example of usage information from an .slmtag file: <SchemaVersion>2.1.1</SchemaVersion> <SoftwareIdentity> <PersistentId>e137414b35d140dca5fd631df1098e0d</PersistentId> <Name>IBM Insights Foundation for Energy</Name> <InstanceId>/opt/IBM/energy</InstanceId> </SoftwareIdentity> <Metric logTime="2015-08-05T16:44:36+08:00"> <Type>AUTHORIZED_USER</Type> <SubType>Standard User</SubType> <Value>5</Value> <Period> <StartTime>2015-08-05T16:44:36+08:00</StartTime> <EndTime>2015-08-05T16:44:36+08:00</EndTime> </Period> </Metric> <Metric logTime="2015-08-05T16:44:36+08:00"> <Type>AUTHORIZED_USER</Type> <SubType>Limited User</SubType> <Value>5</Value> <Period> <StartTime>2015-08-05T16:44:36+08:00</StartTime> <EndTime>2015-08-05T16:44:36+08:00</EndTime> </Period> </Metric> <Metric logTime="2015-08-05T16:44:36+08:00"> <Type>ASSET</Type> <SubType></SubType> <Value>0</Value> <Period> <StartTime>2015-08-05T16:44:36+08:00</StartTime> <EndTime>2015-08-05T16:44:36+08:00</EndTime> </Period> </Metric> ReferenceThese topics contain additional reference information to help you.Mapping groups to license typesIBM Insights Foundation for Energy has standard user licenses and limited user licenses. To generate usage information for the IBM License Metric Tool, you must map each user role group to the relevant license type in the slmtag_groups.properties file on the application server.

License usage metrics

IBM® License Metric Tool helps Passport Advantage® clients determine their full and sub-capacity PVU licensing requirements.

Learn more: IBM License Metric Tool.

<CONSUMING_PRODUCT_NAME> writes usage information to Software License Metric Tag (SLMTag) files. These files have the extension .slmtag and are read periodically by the IBM License Metric Tool (ILMT) after it has been configured to scan for these files. You can generate reports that summarize usage.

For more information about using IBM License Management Tool, see the IBM License Management Tool 9.0 Knowledge Center.

SLMTag logging

When IBM Insights Foundation for Energy is running, license management information is logged every day to the /opt/IBM/energy/properties/slmtags directory on the application server. The logged .slmtag files contain usage information for the three types of usage:

Standard user

The usage information that is logged is the number of licensed standard users in the system.

Limited user

The usage information that is logged is the number of licensed limited users in the system.

Asset analytics

The usage information that is logged is the number of managed assets in the system. This value is retrieved from the CIM database. For the IBM Insights Foundation for Energy 1.5 release, this value is always 0.

Note: The numbers of licensed standard users and limited users in the system is retrieved from the basic user registry that is deployed with IBM Insights Foundation for Energy. To ensure the accuracy of these numbers, the configuration file that maps user groups to license types must be kept up to date. For more information about mapping groups to license types, see the related link.

The following content is an example of usage information from an .slmtag file:

<SchemaVersion>2.1.1</SchemaVersion>
<SoftwareIdentity>
	<PersistentId>e137414b35d140dca5fd631df1098e0d</PersistentId>
	<Name>IBM Insights Foundation for Energy</Name>
	<InstanceId>/opt/IBM/energy</InstanceId>
</SoftwareIdentity>
<Metric logTime="2015-08-05T16:44:36+08:00">
	<Type>AUTHORIZED_USER</Type>
	<SubType>Standard User</SubType>
	<Value>5</Value>
	<Period>
		<StartTime>2015-08-05T16:44:36+08:00</StartTime>
		<EndTime>2015-08-05T16:44:36+08:00</EndTime>
	</Period>
</Metric>
<Metric logTime="2015-08-05T16:44:36+08:00">
	<Type>AUTHORIZED_USER</Type>
	<SubType>Limited User</SubType>
	<Value>5</Value>
	<Period>
		<StartTime>2015-08-05T16:44:36+08:00</StartTime>
		<EndTime>2015-08-05T16:44:36+08:00</EndTime>
	</Period>
</Metric>
<Metric logTime="2015-08-05T16:44:36+08:00">
	<Type>ASSET</Type>
	<SubType></SubType>
	<Value>0</Value>
	<Period>
		<StartTime>2015-08-05T16:44:36+08:00</StartTime>
		<EndTime>2015-08-05T16:44:36+08:00</EndTime>
	</Period>
</Metric>

Parent topic: Reference

Related tasks:

Mapping groups to license types

Supported browsersThe IBM Insights Foundation for Energy user interface is supported in several browsers.Browsers Google Chrome 43 or laterMicrosoft Internet Explorer 11Mozilla Firefox 38 ESRSafari 8 for Mac OS Known issues on Internet ExplorerOn the SOP administration page, for the HTTPS URI in the SOP Reference tab, the Launch URI button might not work. To open the URI, copy the URI and paste it in your browser.ReferenceThese topics contain additional reference information to help you.ReferenceThese topics contain additional reference information to help you.

Supported browsers

The IBM® Insights Foundation for Energy user interface is supported in several browsers.

Browsers

Google Chrome 43 or later

Microsoft Internet Explorer 11

Mozilla Firefox 38 ESR

Safari 8 for Mac OS

Known issues on Internet Explorer

On the SOP administration page, for the HTTPS URI in the SOP Reference tab, the Launch URI button might not work. To open the URI, copy the URI and paste it in your browser.

Parent topic: Reference

AccessibilityAccessibility features help users with physical disabilities, such as restricted mobility or limited vision, to use software products successfully. The major accessibility features in this product enable users to do the following:Use assistive technologies, such as screen-reader software and digital speech synthesizer, to hear what is displayed on the screen. Consult the product documentation of the assistive technology for details on using those technologies with this product.Operate specific or equivalent features using only the keyboard. Magnify what is displayed on the screen. In addition, the documentation was modified to include the following features to aid accessibility: All documentation is available in XHTML formats to give the maximum opportunity for users to apply screen-reader software technology.All images in the documentation are provided with alternative text so that users with vision impairments can understand the contents of the images.The solution includes the following features to aid accessibility:The Administration Console view includes an accessibility prologue that describes a link that you use to skip over the navigation elements of the page.If you are using a screen reader and keyboard, click the Enable accessibility mode button to optimize your user experience. The button is displayed after you click the link to skip over the navigation elements on the Administration Console view. The following web browser and screen reader are recommended:Web browserMozilla Firefox 31 ESRScreen readerFreedom Scientific JAWS 16ReferenceThese topics contain additional reference information to help you.

Accessibility

Accessibility features help users with physical disabilities, such as restricted mobility or limited vision, to use software products successfully.

The major accessibility features in this product enable users to do the following:

Use assistive technologies, such as screen-reader software and digital speech synthesizer, to hear what is displayed on the screen. Consult the product documentation of the assistive technology for details on using those technologies with this product.

Operate specific or equivalent features using only the keyboard.

Magnify what is displayed on the screen.

In addition, the documentation was modified to include the following features to aid accessibility:

All documentation is available in XHTML formats to give the maximum opportunity for users to apply screen-reader software technology.

All images in the documentation are provided with alternative text so that users with vision impairments can understand the contents of the images.

The solution includes the following features to aid accessibility:

The Administration Console view includes an accessibility prologue that describes a link that you use to skip over the navigation elements of the page.

If you are using a screen reader and keyboard, click the Enable accessibility mode button to optimize your user experience. The button is displayed after you click the link to skip over the navigation elements on the Administration Console view.

The following web browser and screen reader are recommended:

Web browser

Mozilla Firefox 31 ESR

Screen reader

Freedom Scientific JAWS 16

Parent topic: Reference

NoticesThis information was developed for products and services offered worldwide.This material may be available from IBM in other languages. However, you may be required to own a copy of the product or product version in that language in order to access it. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. This document may describe products, services, or features that are not included in the Program or license entitlement that you have purchased. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 19-21, Nihonbashi-Hakozakicho, Chuo-ku Tokyo 103-8510, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Software Group Attention: Licensing 3755 Riverside Dr. Ottawa, ON K1V 1B7 Canada Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. If you are viewing this information softcopy, the photographs and color illustrations may not appear. Depending upon the configurations deployed, this Software Offering may use session cookies that collect each user'snameuser namepasswordprofile namepersonally identifiable information other than name, user name, password, profile name and positionfor purposes of session managementsingle sign-on configurationusage tracking or functional purposes other than session management, authentication, enhanced user usability and single sign-on configuration These cookies cannot be disabled. If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.For more information about the use of various technologies, including cookies, for these purposes, see IBM's Privacy Policy at http://www.ibm.com/privacy and IBM's Online Privacy Statement at http://www.ibm.com/privacy/details in the section entitled "Cookies, Web Beacons and Other Technologies" and the "IBM Software Products and Software-as-a-Service Privacy Statement" at http://www.ibm.com/software/info/product-privacy.©

Notices

This information was developed for products and services offered worldwide.

This material may be available from IBM in other languages. However, you may be required to own a copy of the product or product version in that language in order to access it.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. This document may describe products, services, or features that are not included in the Program or license entitlement that you have purchased.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785

U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law

IBM Japan Ltd.

19-21, Nihonbashi-Hakozakicho, Chuo-ku

Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Software Group

Attention: Licensing

3755 Riverside Dr.

Ottawa, ON

K1V 1B7

Canada

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Depending upon the configurations deployed, this Software Offering may use session cookies that collect each user's

name

user name

password

profile name

personally identifiable information other than name, user name, password, profile name and position

for purposes of

session management

single sign-on configuration

usage tracking or functional purposes other than session management, authentication, enhanced user usability and single sign-on configuration

These cookies cannot be disabled.

If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.

For more information about the use of various technologies, including cookies, for these purposes, see IBM's Privacy Policy at http://www.ibm.com/privacy and IBM's Online Privacy Statement at http://www.ibm.com/privacy/details in the section entitled "Cookies, Web Beacons and Other Technologies" and the "IBM Software Products and Software-as-a-Service Privacy Statement" at http://www.ibm.com/software/info/product-privacy.

©

© Product Information This document applies to Industry Solutions Insights Foundation for Energy Version 1.6.0 and may also apply to subsequent releases. Copyright Licensed Materials - Property of IBM © Copyright IBM Corp. 2015, 2016. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at Copyright and trademark information at www.ibm.com/legal/copytrade.shtml. Notices

©

Product Information

This document applies to Industry Solutions Insights Foundation for Energy Version 1.6.0 and may also apply to subsequent releases.

Copyright

Licensed Materials - Property of IBM

© Copyright IBM Corp. 2015, 2016.

US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM, the IBM logo and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at " Copyright and trademark information " at www.ibm.com/legal/copytrade.shtml.

Parent topic: Notices

Preparing your development environmentBefore you develop custom widgets and layouts, install a development environment and deploy the user interface framework EAR that is provided with IBM Insights Foundation for Energy.Install Rational Software Architect for WebSphere Software as your development environment. Edit the configuration for WebSphere Application Server Liberty Profile to deploy the user interface framework EAR. Install Rational Software Architect for WebSphere Software version 9.1.1. For more information, see the related link. To deploy the ife_frwk_app.ear file to WebSphere Application Server Liberty Profile, edit the server.xml file to add the following configuration: <enterpriseApplication id="ife_frwk_app" location="ife_frwk_app.ear" name="ife_frwk_app"> <classloadercommonLibraryRef="ifebaseLib"/> <application-bnd> <security-rolename="users"> <special-subjecttype="ALL_AUTHENTICATED_USERS"/> </security-role> </application-bnd> </enterpriseApplication> For more information about WebSphere Application Server Liberty Profile, see the related link.WebSphere Application Server Network Deployment 8.5.5 product documentation: Liberty profileIBM Rational Software Architect 9.1.1 product documentation

Preparing your development environment

Before you develop custom widgets and layouts, install a development environment and deploy the user interface framework EAR that is provided with IBM® Insights Foundation for Energy.

About this task

Install Rational® Software Architect for WebSphere® Software as your development environment. Edit the configuration for WebSphere Application Server Liberty Profile to deploy the user interface framework EAR.

Procedure

Install Rational Software Architect for WebSphere Software version 9.1.1. For more information, see the related link.

To deploy the ife_frwk_app.ear file to WebSphere Application Server Liberty Profile, edit the server.xml file to add the following configuration:

<enterpriseApplication id="ife_frwk_app" location="ife_frwk_app.ear" name="ife_frwk_app">
    <classloadercommonLibraryRef="ifebaseLib"/>
    <application-bnd>
        <security-rolename="users">
            <special-subjecttype="ALL_AUTHENTICATED_USERS"/>
        </security-role>
    </application-bnd>
</enterpriseApplication>

For more information about WebSphere Application Server Liberty Profile, see the related link.

Related information

WebSphere Application Server Network Deployment 8.5.5 product documentation: Liberty profile

IBM Rational Software Architect 9.1.1 product documentation

Creating a custom widgetTo create a custom widget, add a JavaScript widget module to your custom web project. When you design a custom widget, you need to identify the extension that is relevant for the widget. Every widget is registered as part of an extension. An extension is defined by a name and an optional description, and it groups widgets that have similar functions. Your JavaScript widget module must include any functions that are required by the extension. For example, the sample application includes a Preview Card extension to group widgets that display asset data in a preview card. Each widget that is added to the Preview Card extension must implement a function to provide the data to display on the preview card. The user interface framework provides a number of JavaScript libraries and packages that you can use when you are creating custom widget modules. For more information, see JavaScript libraries and packagesThe user interface framework provides a number of JavaScript libraries and packages that you can use when you are creating custom widget or layout modules. . Use the JavaScript widget file that is named AssetPreviewCard.js as a guide to creating a custom widget. The AssetPreviewCard.js file is provided with the ife_sampleapp_web web project. The AssetPreviewCard widget is registered as part of the Preview Card extension.Open the Java EE view in Rational Software Architect.Go to the directory that you configured as the WebContent directory in your web project. Create a directory to contain your custom JavaScript widget files, for example, WebContent/js/widgetUse the sample AssetPreviewCard.js JavaScript file as a guide to creating your custom widget module. The functions that you implement in a JavaScript widget module vary depending on the purpose of the widget. Table 1 describes some common widget functions. The widget module might also be required to implement some functions specific to the extension that the widget is added to. Examples of widget functions The following table describes three common widget functions: Widget functionsFunctionDescriptionplaceAt:function(divId)Positions the widget within a <div> element with the specified ID.startup:function()The function is run when the widget is displayed on a page.getParameters:function()The getParameters function returns a JSON object that lists the parameters that are required by the widget; for example, {"orientation":"horizontal"}.Example of a function that is required by an extensionThe widget extension might require the widget module to implement some functions. For example, if you add a widget to the Preview Card extension that is provided with the solution, then you must implement the setModel(message) function in the widget module. The setModel(message) function provides the asset data to display in the preview card. You can also add image files to the web project to use as widget thumbnails.For example, you can add image files under the WebContent/images directory. Use the sample page configuration and HTML file to test your custom widget before you deploy your web project. For more information about testing your custom widget, see the related link. After you test and deploy your custom widget, your administrator can then register and configure the widget. For more information about configuring a widget, see the related link.Testing custom layouts and widgetsUse the sample page configuration that is provided with the solution to test custom widgets and layouts before you deploy them to production. Configuring widgetsIf you are an administrator, you can register and configure custom widgets.

Creating a custom widget

To create a custom widget, add a JavaScript widget module to your custom web project.

Before you begin

When you design a custom widget, you need to identify the extension that is relevant for the widget. Every widget is registered as part of an extension. An extension is defined by a name and an optional description, and it groups widgets that have similar functions. Your JavaScript widget module must include any functions that are required by the extension. For example, the sample application includes a Preview Card extension to group widgets that display asset data in a preview card. Each widget that is added to the Preview Card extension must implement a function to provide the data to display on the preview card.

The user interface framework provides a number of JavaScript libraries and packages that you can use when you are creating custom widget modules. For more information, see JavaScript libraries and packages.

About this task

Use the JavaScript widget file that is named AssetPreviewCard.js as a guide to creating a custom widget. The AssetPreviewCard.js file is provided with the ife_sampleapp_web web project. The AssetPreviewCard widget is registered as part of the Preview Card extension.

Procedure

Open the Java EE view in Rational® Software Architect.

Go to the directory that you configured as the WebContent directory in your web project.

Create a directory to contain your custom JavaScript widget files, for example, WebContent/js/widget

Use the sample AssetPreviewCard.js JavaScript file as a guide to creating your custom widget module. The functions that you implement in a JavaScript widget module vary depending on the purpose of the widget. Table 1 describes some common widget functions. The widget module might also be required to implement some functions specific to the extension that the widget is added to.

Examples of widget functions

The following table describes three common widget functions:

Widget functions

Function | Description
placeAt:function(divId) | Positions the widget within a <div> element with the specified ID.
startup:function() | The function is run when the widget is displayed on a page.
getParameters:function() | The getParameters function returns a JSON object that lists the parameters that are required by the widget; for example, {"orientation":"horizontal"}.

Example of a function that is required by an extension

The widget extension might require the widget module to implement some functions. For example, if you add a widget to the Preview Card extension that is provided with the solution, then you must implement the setModel(message) function in the widget module. The setModel(message) function provides the asset data to display in the preview card.

Optional: You can also add image files to the web project to use as widget thumbnails. For example, you can add image files under the WebContent/images directory.

What to do next

Use the sample page configuration and HTML file to test your custom widget before you deploy your web project. For more information about testing your custom widget, see the related link. After you test and deploy your custom widget, your administrator can then register and configure the widget. For more information about configuring a widget, see the related link.

Related tasks:

Testing custom layouts and widgets

Configuring widgets

Testing custom layouts and widgetsUse the sample page configuration that is provided with the solution to test custom widgets and layouts before you deploy them to production. Before you deploy your custom web project to production, you can test your custom user interface components by using a JSON file and an HTML file that are provided with the sample web project, ife_sampleapp_web. The JSON file is named pageConfig_page1.json, and the HTML file is named layoutWrapper.html. Edit the pageConfig_page1.json file to add the configuration details for the layout and widgets that you want to test. Add configuration details for the layout to the pageConfig_page1.json file.The properties for a layout are described in the following table: Property nameTypeDescriptionlayout_idStringAn ID for the layout. The ID must be unique to the JSON file.nameStringThe name of the layout.descriptionStringThe description of the layout.moduleJSON objectThe module property includes the following elements:moduleName: the name of the JavaScript module that implements the layout, for example, ifef/layout/IFELayoutWithTaskbar.pathName: the name of the package that contains the layout module, for example, ifef.pathLocation: the package location, for example, /ibm/ife/framework/js.Add configuration details for each widget to the widgets property in the pageConfig_page1.json file. The properties for a widget are described in the following table: Property nameTypeDescriptionwidget_idStringAn ID for the widget. The ID must be unique to the JSON file.nameStringThe name of the widget.descriptionStringThe description of the widget.moduleJSON objectThe module property includes the following elements:moduleName: the name of the JavaScript module that implements the widget, for example, ife/list/AssetListViewer.pathName: the name of the package that contains the widget module, for example, ife.pathLocation: the package location, for example, /ibm/ife/sample/widget/js.Add configuration details for the config property to the pageConfig_page1.json file. The config property specifies the region and parameters for each widget on the page.The config properties are described in the following table: Property nameTypeDescriptionwidget_idStringThe ID of the widget to be displayed.region_idStringThe ID of the region that contains the widget.parametersJSON objectThe elements that are included in the parameters property are determined by the widget and by the region that includes the widget. The parameters are defined in the widget module's getParameters function, and in the layout module's getRegionParameters function. To test the page configuration that is specified in the pageConfig_page1.json file, use the following URL: http://host:port/ibm/ife/framework/layoutWrapper.html?config=/ibm/ife/sample/widget/pageConfig_page1.json. The following example shows sample configuration details in the pageConfig_page1.json file:"layout": {"layout_id":"layout1", "name": "IFELayout", "description": "", "module":{"moduleName":"ifef/layout/IFELayoutWithTaskbar", "pathName":"ifef", "pathLocation":"/ibm/ife/framework/js" } } "widgets": [ {"widget_id":"ife.List", "name":"List", "description":"", "module":{"moduleName":"ife/list/AssetListViewer", "pathName":"ife", "pathLocation":"/ibm/ife/sample/widget/js" } }, {"widget_id": "ife.Filter", "name": "Filter", "description": "", "module": {"moduleName":"ife/filter/FilterBar", "pathName":"ife", "pathLocation":"/ibm/ife/sample/widget/js" } } ] "config": [ {"widget_id":"ife.List", "region_id":"View", "parameters": {"noInit":true, "view_name":"contentViewTab-List", "i18nLabel":"List", "greyIcon":"/ibm/ife/sample/widget/icon/ICN-TB_List-STD.png", "selectedIcon":"/ibm/ife/sample/widget/icon/ICN-TB_List-SEL.png" } }, {"widget_id":"ife.Filter", "region_id":"Task", "parameters": {"i18nLabel":"Filter", "darkIcon":"/ibm/ife/sample/widget/icon/ICN-TB_Filter-STD.png", "selectedIcon":"/ibm/ife/sample/widget/icon/ICN-TB_Filter-SEL.png", "primaryPaneAttr": {"title": "", "overflow":"hidden", "hasHideButton": false, "name":"", "position":{"top":"0px","left":"0px"}, "fullSize":{"width":"100%", "height":"36px"} } } } ] Deploy your custom web project to WebSphere Application Server Liberty Profile.

Testing custom layouts and widgets

Use the sample page configuration that is provided with the solution to test custom widgets and layouts before you deploy them to production.

About this task

Before you deploy your custom web project to production, you can test your custom user interface components by using a JSON file and an HTML file that are provided with the sample web project, ife_sampleapp_web. The JSON file is named pageConfig_page1.json, and the HTML file is named layoutWrapper.html. Edit the pageConfig_page1.json file to add the configuration details for the layout and widgets that you want to test.

Procedure

Add configuration details for the layout to the pageConfig_page1.json file. The properties for a layout are described in the following table:

Property name
Type
Description

layout_id
String
An ID for the layout. The ID must be unique to the JSON file.

name
String
The name of the layout.

description
String
The description of the layout.

module
JSON object
The module property includes the following elements:

moduleName: the name of the JavaScript module that implements the layout, for example, ifef/layout/IFELayoutWithTaskbar.

pathName: the name of the package that contains the layout module, for example, ifef.

pathLocation: the package location, for example, /ibm/ife/framework/js.

Add configuration details for each widget to the widgets property in the pageConfig_page1.json file. The properties for a widget are described in the following table:

Property name
Type
Description

widget_id
String
An ID for the widget. The ID must be unique to the JSON file.

name
String
The name of the widget.

description
String
The description of the widget.

module
JSON object
The module property includes the following elements:

moduleName: the name of the JavaScript module that implements the widget, for example, ife/list/AssetListViewer.

pathName: the name of the package that contains the widget module, for example, ife.

pathLocation: the package location, for example, /ibm/ife/sample/widget/js.

Add configuration details for the config property to the pageConfig_page1.json file. The config property specifies the region and parameters for each widget on the page. The config properties are described in the following table:

Property name | Type | Description
widget_id | String | The ID of the widget to be displayed.
region_id | String | The ID of the region that contains the widget.
parameters | JSON object | The elements that are included in the parameters property are determined by the widget and by the region that includes the widget. The parameters are defined in the widget module's getParameters function, and in the layout module's getRegionParameters function.

To test the page configuration that is specified in the pageConfig_page1.json file, use the following URL:

http://

host

:

port

/ibm/ife/framework/layoutWrapper.html?config=/ibm/ife/sample/widget/pageConfig_page1.json.

Example

The following example shows sample configuration details in the pageConfig_page1.json file:

"layout": {"layout_id":"layout1",
           "name": "IFELayout",
           "description": "",
           "module":{"moduleName":"ifef/layout/IFELayoutWithTaskbar",
                     "pathName":"ifef",
                     "pathLocation":"/ibm/ife/framework/js"
                    }
          }
"widgets":
[
    {"widget_id":"ife.List",
     "name":"List",
     "description":"",
     "module":{"moduleName":"ife/list/AssetListViewer",
               "pathName":"ife",
               "pathLocation":"/ibm/ife/sample/widget/js"
              }
    },
    {"widget_id": "ife.Filter",
     "name": "Filter",
     "description": "",
     "module": {"moduleName":"ife/filter/FilterBar",
                "pathName":"ife",
                "pathLocation":"/ibm/ife/sample/widget/js"
               }
    }
]
"config":
[
    {"widget_id":"ife.List",
     "region_id":"View",
     "parameters":
         {"noInit":true,
          "view_name":"contentViewTab-List",
          "i18nLabel":"List",
          "greyIcon":"/ibm/ife/sample/widget/icon/ICN-TB_List-STD.png",
          "selectedIcon":"/ibm/ife/sample/widget/icon/ICN-TB_List-SEL.png"
          }
    },
    {"widget_id":"ife.Filter",
     "region_id":"Task",
     "parameters":
         {"i18nLabel":"Filter",
          "darkIcon":"/ibm/ife/sample/widget/icon/ICN-TB_Filter-STD.png",
          "selectedIcon":"/ibm/ife/sample/widget/icon/ICN-TB_Filter-SEL.png",
          "primaryPaneAttr":
              {"title": "",
               "overflow":"hidden",
               "hasHideButton": false,
               "name":"",
               "position":{"top":"0px","left":"0px"},
               "fullSize":{"width":"100%", "height":"36px"}
              }
         }
     }
]

What to do next

Deploy your custom web project to WebSphere® Application Server Liberty Profile.

Configuring widgetsIf you are an administrator, you can register and configure custom widgets. Use the Administration Console view to register and configure custom widgets. To group widgets that have similar functions, every widget is registered as part of an extension. Each widget is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. You can view widgets that are provided with the solution, but you cannot edit or remove them. In the Administration Console view, click Widget. The extensions and their widgets are listed on the left.Registering a custom widgetClick the add icon beside an extension. In the Create a Widget window, enter the details for your custom widget. In Name, enter a unique name for the widget.In Description, enter a description of the widget.In Module name, enter the name of the widget JavaScript module.For example, ife/map/MapViewExt.In Package name, enter the name of the package that contains the widget JavaScript module.For example, ife.In Package location, enter the location of the package.For example, /ibm/ife/sample/widget/js.In Thumbnail, you can enter the details of a file to display as a thumbnail for the widget.Click Save. The new widget is listed under the extension. Editing a custom widgetSelect the widget to edit the name, description, and thumbnail for the widget. The module name, package name, and package location cannot be edited. Click Save.Deleting a custom widgetClick the delete icon beside the widget, and then in the confirmation window, click Yes. You cannot delete a widget if the widget is included in the configuration of a page.

Configuring widgets

If you are an administrator, you can register and configure custom widgets.

About this task

Use the Administration Console view to register and configure custom widgets. To group widgets that have similar functions, every widget is registered as part of an extension. Each widget is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. You can view widgets that are provided with the solution, but you cannot edit or remove them.

Procedure

In the Administration Console view, click Widget. The extensions and their widgets are listed on the left.

Registering a custom widget

Click the add icon beside an extension.

In the Create a Widget window, enter the details for your custom widget.

In Name, enter a unique name for the widget.

Optional: In Description, enter a description of the widget.

In Module name, enter the name of the widget JavaScript module. For example, ife/map/MapViewExt.

In Package name, enter the name of the package that contains the widget JavaScript module. For example, ife.

In Package location, enter the location of the package. For example, /ibm/ife/sample/widget/js.

Optional: In Thumbnail, you can enter the details of a file to display as a thumbnail for the widget.

Click Save. The new widget is listed under the extension.

Editing a custom widget

Select the widget to edit the name, description, and thumbnail for the widget.

Note: The module name, package name, and package location cannot be edited.

Click Save.

Deleting a custom widget

Click the delete icon beside the widget, and then in the confirmation window, click Yes.

Note: You cannot delete a widget if the widget is included in the configuration of a page.

Creating a custom layoutA layout manages one or more regions, and each region includes one or more extensions. An extension is a mechanism for grouping widgets that have similar functions. To create a custom layout, add a JavaScript layout module to your custom web project. The user interface framework provides a number of JavaScript libraries and packages that you can use when you are creating custom layout modules. For more information, see JavaScript libraries and packagesThe user interface framework provides a number of JavaScript libraries and packages that you can use when you are creating custom widget or layout modules. .Use the JavaScript layout file that is named IOWLayout.js as a guide to creating a custom layout. The IOWLayout.js file is provided with the ife_frwk_web web project. Open the Java EE view in Rational Software Architect.Go to the directory that you configured as the WebContent directory in your web project. Create a directory to contain your custom JavaScript layout files, for example, WebContent/js/layout. Use the IOWLayout.js JavaScript file as a guide to creating your custom layout module.The functions that you implement in a JavaScript layout module vary depending on the purpose of the layout. The following table describes some common layout functions: Layout functionsFunctionDescriptionplaceAt: function(divId)Positions the widget within a parent <div> element with the specified ID.addWidget: function(widget, region)The addWidget function adds a widget to a region in the layout; for example, addWidget(mapWidget, "View").getRegions: function()The getRegions function returns a JSON array that contains the names of the regions in the layout; for example, ["View", "Task"].getRegionParameters: function(region)The getRegionParameters function returns a JSON object that describes extra widget parameters for any widget that is managed by the specified region; for example, { "view_name":"", "selectedIcon":"", "i18nLabel":"","greyIcon":""}. You can also specify default values for the parameters, for example, "i18nLabel":"Map". You can also add image files to the web project to use as layout thumbnails. For example, you can add image files under the WebContent/images directory. Use the sample page configuration and HTML file to test your custom layout before you deploy your web project. For more information about testing your custom layout, see the related link. After you test and deploy your custom layout, your administrator can then register and configure the layout. For more information about configuring a layout, see the related link.Testing custom layouts and widgetsUse the sample page configuration that is provided with the solution to test custom widgets and layouts before you deploy them to production. Configuring layoutsAs an administrator, you can register and configure custom layouts. A layout manages the widgets on a page. A layout is made up of regions, and each region can contain one or more extensions.

Creating a custom layout

A layout manages one or more regions, and each region includes one or more extensions. An extension is a mechanism for grouping widgets that have similar functions. To create a custom layout, add a JavaScript layout module to your custom web project.

Before you begin

The user interface framework provides a number of JavaScript libraries and packages that you can use when you are creating custom layout modules. For more information, see JavaScript libraries and packages.

About this task

Use the JavaScript layout file that is named IOWLayout.js as a guide to creating a custom layout. The IOWLayout.js file is provided with the ife_frwk_web web project.

Procedure

Open the Java EE view in Rational® Software Architect.

Go to the directory that you configured as the WebContent directory in your web project.

Create a directory to contain your custom JavaScript layout files, for example, WebContent/js/layout.

Use the IOWLayout.js JavaScript file as a guide to creating your custom layout module. The functions that you implement in a JavaScript layout module vary depending on the purpose of the layout. The following table describes some common layout functions:

Layout functions

Function
Description

placeAt: function(divId)
Positions the widget within a parent <div> element with the specified ID.

addWidget: function(widget, region)
The addWidget function adds a widget to a region in the layout; for example, addWidget(mapWidget, "View").

getRegions: function()
The getRegions function returns a JSON array that contains the names of the regions in the layout; for example, ["View", "Task"].

getRegionParameters: function(region)
The getRegionParameters function returns a JSON object that describes extra widget parameters for any widget that is managed by the specified region; for example, { "view_name":"", "selectedIcon":"", "i18nLabel":"","greyIcon":""}.

Note: You can also specify default values for the parameters, for example, "i18nLabel":"Map".

Optional: You can also add image files to the web project to use as layout thumbnails. For example, you can add image files under the WebContent/images directory.

What to do next

Use the sample page configuration and HTML file to test your custom layout before you deploy your web project. For more information about testing your custom layout, see the related link. After you test and deploy your custom layout, your administrator can then register and configure the layout. For more information about configuring a layout, see the related link.

Related tasks:

Testing custom layouts and widgets

Configuring layouts

Configuring layoutsAs an administrator, you can register and configure custom layouts. A layout manages the widgets on a page. A layout is made up of regions, and each region can contain one or more extensions. Use the Administration Console view to register and configure custom layouts. Each layout is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. You can view layouts that are provided with the solution, but you cannot edit or remove them. In the Administration Console view, click Layout. Registering a custom layoutClick Create.In the Create a Layout window, enter the details for your custom layout. In Name, enter a unique name for the layout.In Description, enter a description of the layout.In Module name, enter the name of the layout JavaScript module. For example, ife/layout/SampleLayout.In Package name, enter the name of the package that contains the layout JavaScript module.For example, ife.In Package location, enter the location of the package.For example, /ibm/ife/sample/widget/js.In Thumbnail, you can enter the details of a file to display as a thumbnail for the layout.For example, /ibm/ife/framework/images/admin/sidebarlayout.png.Click Save. The new layout is listed under the Create button. The regions for the layout are listed in the Regions table. Each region is defined by a unique name and a list of extensions, and can also include a description. The regions for a layout are defined in the layout's JavaScript module.Editing a custom layoutTo edit a region for a selected custom layout, click the row in the Regions table. The Edit a Region window displays. In the Edit a Region window, enter the details for the region.In Unique name, enter a unique name for the region.In Description, you can enter a description of the region.In Extensions, select one or more extensions to include in the region from the drop-down list.Click Save to save the changes to the region.You can also edit the name, description, and thumbnail for a custom layout. The module name, package name, and package location cannot be edited. Click Save.Deleting the configuration for a custom layoutClick the delete icon beside the custom layout, and then in the confirmation window, click Yes. You cannot delete the configuration for a custom layout if the layout is included in the configuration of a page.

Configuring layouts

As an administrator, you can register and configure custom layouts. A layout manages the widgets on a page. A layout is made up of regions, and each region can contain one or more extensions.

About this task

Use the Administration Console view to register and configure custom layouts. Each layout is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. You can view layouts that are provided with the solution, but you cannot edit or remove them.

Procedure

In the Administration Console view, click Layout.

Registering a custom layout

Click Create.

In the Create a Layout window, enter the details for your custom layout.

In Name, enter a unique name for the layout.

Optional: In Description, enter a description of the layout.

In Module name, enter the name of the layout JavaScript module. For example, ife/layout/SampleLayout.

In Package name, enter the name of the package that contains the layout JavaScript module. For example, ife.

In Package location, enter the location of the package. For example, /ibm/ife/sample/widget/js.

Optional: In Thumbnail, you can enter the details of a file to display as a thumbnail for the layout. For example, /ibm/ife/framework/images/admin/sidebarlayout.png.

Click Save. The new layout is listed under the Create button.

Note: The regions for the layout are listed in the Regions table. Each region is defined by a unique name and a list of extensions, and can also include a description. The regions for a layout are defined in the layout's JavaScript module.

Editing a custom layout

To edit a region for a selected custom layout, click the row in the Regions table. The Edit a Region window displays.

In the Edit a Region window, enter the details for the region.

In Unique name, enter a unique name for the region.

Optional: In Description, you can enter a description of the region.

In Extensions, select one or more extensions to include in the region from the drop-down list.

Click Save to save the changes to the region.

You can also edit the name, description, and thumbnail for a custom layout.

Note: The module name, package name, and package location cannot be edited.

Click Save.

Deleting the configuration for a custom layout

Click the delete icon beside the custom layout, and then in the confirmation window, click Yes.

Note: You cannot delete the configuration for a custom layout if the layout is included in the configuration of a page.

Deploying a web projectDeploy your custom web project to WebSphere Application Server Liberty Profile. You can package and deploy your web project as a WAR file or as an EAR file.For more information about configuring WebSphere Application Server Liberty Profile, see WebSphere Application Server Network Deployment 8.5.5 product documentation: Liberty profile.To deploy a custom web project to WebSphere Application Server Liberty Profile, edit the server.xml file to add configuration for either the WAR file, or the EAR file. To deploy the sample ife_sampleapp_web.war file, add the following configuration to the server.xml file:<enterpriseApplication id="ife_sampleapp_web" location="ife_sampleapp_web.war" name="ife_sampleapp_web"> <classloadercommonLibraryRef="ifebaseLib"/> <application-bnd> <security-rolename="users"> <special-subjecttype="ALL_AUTHENTICATED_USERS"/> </security-role> </application-bnd> </enterpriseApplication>To deploy the sample ife_sample_app.ear file, add the following configuration to the server.xml file:<enterpriseApplication id="ife_sample_app" location="ife_sample_app.ear" name="ife_sample_app"> <classloadercommonLibraryRef="ifebaseLib"/> <application-bnd> <security-rolename="users"> <special-subjecttype="ALL_AUTHENTICATED_USERS"/> </security-role> </application-bnd> </enterpriseApplication>Use the Administration Console view to register and configure your custom widgets and layouts. For more information, see the related links.Configuring widgetsIf you are an administrator, you can register and configure custom widgets. Configuring layoutsAs an administrator, you can register and configure custom layouts. A layout manages the widgets on a page. A layout is made up of regions, and each region can contain one or more extensions.

Deploying a web project

Deploy your custom web project to WebSphere® Application Server Liberty Profile. You can package and deploy your web project as a WAR file or as an EAR file.

Before you begin

For more information about configuring WebSphere Application Server Liberty Profile, see WebSphere Application Server Network Deployment 8.5.5 product documentation: Liberty profile.

Procedure

To deploy a custom web project to WebSphere Application Server Liberty Profile, edit the server.xml file to add configuration for either the WAR file, or the EAR file.

To deploy the sample ife_sampleapp_web.war file, add the following configuration to the server.xml file:

<enterpriseApplication id="ife_sampleapp_web" location="ife_sampleapp_web.war" name="ife_sampleapp_web">
             <classloadercommonLibraryRef="ifebaseLib"/>
             <application-bnd>
                 <security-rolename="users">
                     <special-subjecttype="ALL_AUTHENTICATED_USERS"/>
                 </security-role>
             </application-bnd>
          </enterpriseApplication>

To deploy the sample ife_sample_app.ear file, add the following configuration to the server.xml file:

<enterpriseApplication id="ife_sample_app" location="ife_sample_app.ear" name="ife_sample_app">
             <classloadercommonLibraryRef="ifebaseLib"/>
             <application-bnd>
                 <security-rolename="users">
                     <special-subjecttype="ALL_AUTHENTICATED_USERS"/>
                 </security-role>
             </application-bnd>
          </enterpriseApplication>

What to do next

Use the Administration Console view to register and configure your custom widgets and layouts. For more information, see the related links.

Related tasks:

Configuring widgets

Configuring layouts

Configuring pagesIf you are an administrator, you can add and configure custom pages. Each page has a style and a layout to manage the widgets on the page. Use the Administration Console view to add and configure custom pages. Each page is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. You can view pages that are provided with the solution, but you cannot delete them, and you can edit only the layout properties for these pages. In the Administration Console view, click Page. Adding a custom pageClick Create.In the Create a Page window, enter the details for your custom page.In Title, enter a unique page title. In Description, enter a description of the page. In URI, enter a valid URI, for example /ibm/ife/sample/index/HTML.Click Save. The new page is listed under the Create button.For a newly created page, select Groups in the Access control field if you want those groups to access this page. Click Save.Editing information for a custom pageEdit the page title, description, URI and access control for a custom page.Click Save to save the changes to the page's configuration.Deleting a custom pageClick the delete icon beside the custom page, and then in the confirmation window, click Yes. You cannot delete a custom page if the page is included in the configuration of a page hierarchy. User roles and accessIBM Insights Foundation for Energy implements security by limiting access to features, data, and services based on user roles.

Configuring pages

If you are an administrator, you can add and configure custom pages. Each page has a style and a layout to manage the widgets on the page.

About this task

Use the Administration Console view to add and configure custom pages. Each page is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. You can view pages that are provided with the solution, but you cannot delete them, and you can edit only the layout properties for these pages.

Procedure

In the Administration Console view, click Page.

Adding a custom page

Click Create.

In the Create a Page window, enter the details for your custom page.

In Title, enter a unique page title.

Optional: In Description, enter a description of the page.

In URI, enter a valid URI, for example /ibm/ife/sample/index/HTML.

Click Save. The new page is listed under the Create button.

For a newly created page, select Groups in the Access control field if you want those groups to access this page. Click Save.

Editing information for a custom page

Edit the page title, description, URI and access control for a custom page.

Click Save to save the changes to the page's configuration.

Deleting a custom page

Click the delete icon beside the custom page, and then in the confirmation window, click Yes.

Note: You cannot delete a custom page if the page is included in the configuration of a page hierarchy.

Related concepts:

User roles and access

Configuring REST servicesIf you are an administrator, you can register and configure custom Representational State Transfer (REST) services. Use the Administration Console view to register and configure custom REST services. Each service is defined by a set of properties, and each property value that you enter is validated by the solution upon entry. In the Administration Console view, click Service.Registering a custom REST serviceClick Create.In the Create a Service window, enter the details for your custom service. In Name, enter the name of the service.In URI, enter the URI for the resource.For example, /ibm/ife/api/ui-service/style.You can append /* to the base URI for the service to include all the resources that are managed by the service. For example, /ibm/ife/api/ui-service/*.In Description, enter a description of the service.Click Save. The new service is listed under the Create button.Edit the service to assign access rights to the service to user groups in your solution.Editing a custom REST serviceSelect the service and edit the values.Edit the values for the name, URI, and description.For Access Control , assign access rights to the service for the user role groups in your solution. For each user role group, you can select one or more of the access controls that are labeled Create, Read, Update, and Delete. For more information about user role groups, see the related link.Click Save to save the changes.Deleting a custom REST serviceClick the delete icon beside the service, and then in the confirmation window, click Yes.User roles and accessIBM Insights Foundation for Energy implements security by limiting access to features, data, and services based on user roles.

Configuring REST services

If you are an administrator, you can register and configure custom Representational State Transfer (REST) services.

About this task

Use the Administration Console view to register and configure custom REST services. Each service is defined by a set of properties, and each property value that you enter is validated by the solution upon entry.

Procedure

In the Administration Console view, click Service.

Registering a custom REST service

Click Create.

In the Create a Service window, enter the details for your custom service.

In Name, enter the name of the service.

In URI, enter the URI for the resource. For example, /ibm/ife/api/ui-service/style.

Note: You can append /* to the base URI for the service to include all the resources that are managed by the service. For example, /ibm/ife/api/ui-service/*.

Optional: In Description, enter a description of the service.

Click Save. The new service is listed under the Create button. Edit the service to assign access rights to the service to user groups in your solution.

Editing a custom REST service

Select the service and edit the values.

Edit the values for the name, URI, and description.

For Access Control , assign access rights to the service for the user role groups in your solution. For each user role group, you can select one or more of the access controls that are labeled Create, Read, Update, and Delete. For more information about user role groups, see the related link.

Click Save to save the changes.

Deleting a custom REST service

Click the delete icon beside the service, and then in the confirmation window, click Yes.

Related concepts:

User roles and access

Copyright notice and trademarksCopyright notice and trademarksnoticestrademarks

Copyright notice and trademarks

ConfigurationThe configuration is managed by one JSON file that is loaded by Runtime and includes other required JSON files.Each item inside configuration file is composed of:id - a unique id of the widget.module - the module name the widget.container - an optional container of the widget.regions - an optional list of regions if the widget is a container.parameters - optional parameters for the widget.Example one - Configure Widget Containment The widget containment relationship represents a parent - child relationship between the widgets. There is a root container that contains everything to be displayed. The root container widget is contained by a DOM node in the Bootstrap file. The example shows that div id ="root" is the division and can be used as the root container. The division as the root container Children widgets are contained by a the container widget in a specified region. The example shows the left widget being be part of the main widget and is located in the left region. Region container widget Result for left and center containment Filter Panes are contained by left widget Map & 3D Map contained by center widgetExample two - Configure Dependency Injection Dependency represents the interaction relationship among different widgets. Dependency injection is the way of UI framework to configure this kind of relationship in JSON format configuration file. The example shows the countryLayer module has the map and the countryFilter dependency is injected, respectively. The countryLayer module has {map} and {countryFilter} is the dependencyList Container WidgetThe user can place one list directly in one page. However, where there are multiple lists that can change based on the selection made by the user, it is better to put all the lists in one List Container.

Configuration

The configuration is managed by one JSON file that is loaded by Runtime and includes other required JSON files.

Each item inside configuration file is composed of:

id - a unique id of the widget.

module - the module name the widget.

container - an optional container of the widget.

regions - an optional list of regions if the widget is a container.

parameters - optional parameters for the widget.

Example one - Configure Widget Containment

The widget containment relationship represents a parent - child relationship between the widgets. There is a root container that contains everything to be displayed. The root container widget is contained by a DOM node in the Bootstrap file. The example shows that div id ="root" is the division and can be used as the root container.

The division as the root container

Children widgets are contained by a the container widget in a specified region. The example shows the left widget being be part of the main widget and is located in the left region.

Region container widget

Result for left and center containment

Filter Panes are contained by left widget

Map & 3D Map contained by center widget

Example two - Configure Dependency Injection

Dependency represents the interaction relationship among different widgets. Dependency injection is the way of UI framework to configure this kind of relationship in JSON format configuration file. The example shows the countryLayer module has the map and the countryFilter dependency is injected, respectively.

The countryLayer module has {map} and {countryFilter} is the dependency

Related concepts:

List Container Widget

List Container WidgetThe user can place one list directly in one page. However, where there are multiple lists that can change based on the selection made by the user, it is better to put all the lists in one List Container. In the List Container widget you can specify the container for the lists. This is configured in a widget containment JSON file.ifef.widget.ListContainer Parameters selectLabel:The label used for the drop down list.style:The cascading style sheet (CSS) used to define the display style.Configuration sample { "id": "listContainer", "module": "ifef/widget/list/ListContainer", "container": "listTab", "parameters": { "selectLabel":"@{dno_nls.Select_Item}", "style": "width: 100%; height: 100%;" } }, { "id": "overheadlineList", "module": "ifef/widget/list/List", "container": "listContainer", "properties": ["store"], "parameters": { "keyFields":["ASSET_TYPE", "ASSET_ID"], "title": "@{overheadline_filter.label}", "pageSize": 100, "paginationBar":[100,150,200,1000,0], "baseSort": [ { "attribute": "STATUS", "descending": true } ], "column": [ { "name": "@{dno_nls.STATUS}", "field": "STATUS" }, { "name": "@{dno_nls.NAME}", "field": "NAME", "sortable" : true } ] } }ConfigurationThe configuration is managed by one JSON file that is loaded by Runtime and includes other required JSON files.

List Container Widget

The user can place one list directly in one page. However, where there are multiple lists that can change based on the selection made by the user, it is better to put all the lists in one List Container.

In the List Container widget you can specify the container for the lists. This is configured in a widget containment JSON file.

ifef.widget.ListContainer Parameters

selectLabel:

The label used for the drop down list.

style:

The cascading style sheet (CSS) used to define the display style.

Configuration sample

{
        "id": "listContainer",
        "module": "ifef/widget/list/ListContainer",
        "container": "listTab",
        "parameters": {
                        "selectLabel":"@{dno_nls.Select_Item}",
                        "style": "width:
        100%; height: 100%;"
        }
     },
     {
        "id": "overheadlineList",
        "module": "ifef/widget/list/List",
        "container": "listContainer",
           "properties": ["store"],
        "parameters": {
                       "keyFields":["ASSET_TYPE", "ASSET_ID"],
                       "title": "@{overheadline_filter.label}",
                       "pageSize": 100,
                       "paginationBar":[100,150,200,1000,0],
                       "baseSort": [
                           {
                            "attribute": "STATUS",
                            "descending": true
                           }
                           ],
                       "column": [
                           {
                            "name": "@{dno_nls.STATUS}",
                            "field": "STATUS"
                           },
                           {
                            "name": "@{dno_nls.NAME}",
                            "field": "NAME",
                            "sortable" : true
                           }
                     ]
     }
}

Related concepts:

Configuration