ips-energy™ starting ips-energy™ part d: custom properties · ips-energy_v1.92_custom...

© 2017 This document is the sole property of IPS-Intelligent Process Solutions GmbH and is provided to the recipient for its own use only. It may not be supplied to any third party, or copied or reproduced in any form without the explicit written permission of IPS-Intelligent Process Solutions GmbH. All copies and reproductions shall be the property of IPS-Intelligent Process Solutions GmbH. IPS-Intelligent Process Solution GmbH, Dr.-Gustav-Adolph-Str. 2, 82049 Pullach (Munich), Germany

IPS-ENERGY™

Starting IPS-ENERGY™

Part D: Custom

Properties

Version 1.92

© IPS-Intelligent Process Solutions GmbH I IPS-ENERGY_v1.92_Custom Properties_ENU_v1.0.docx

History of Changes

Version Date (mm/dd/yyyy)

Chapter and changes Name

1.0 1/16/2017 Integrate proofread comments, approved ILE

0.3 12/9/2017 Review and Proofread DFO

0.2 12/05/2016 Updated screenshots and content to final version of 1.92 ILE

0.1 10/04/2016 Restructuring & content editing incl. screenshot updates smc

© IPS-Intelligent Process Solutions GmbH II IPS-ENERGY_v1.92_Custom Properties_ENU_v1.0.docx

Table of Contents

1 General 1

1.1 How to read the documentation ...................................................................................... 1

1.2 Abbreviations .................................................................................................................... 1

2 Custom Properties 2

2.1 Introduction ....................................................................................................................... 2

2.2 Definition of the Custom Properties Group ................................................................... 4

2.3 Property Definition ........................................................................................................... 6

2.4 Property Types .................................................................................................................. 7

List of figures 15

1 Genera l 1 .2 Abbrev ia t io ns

© IPS-Intelligent Process Solutions GmbH 1/15 IPS-ENERGY_v1.92_Custom Properties_ENU_v1.0.docx

1 General

Thank you for purchasing IPS-ENERGY™ Asset Performance Management Software.

This user documentation should introduce you to all necessary information to get best use out of this application.

IPS-ENERGY™ is programmed in a dynamic way which means that more (or less) features are available to you depending on configuration and licensing.

1.1 How to read the documentation

Texts written in italics indicate Names in the software (Windows, Fields, Tables, Columns, etc.).

Texts written in bold indicate Function in the software (Buttons, Menu Options, Tabs, anything you can click on).

Instructions to follow are indicated with numbers:

Step 1

Step 2

Listings without specific order or alternative options are shown as a list with bullet points:

Option 1

Option 2

Legend numbers in an image are referenced underneath the image:

1 Legend explanation 1

2 Legend explanation 2

NOTE: Important information to consider is written in a box starting with NOTE.

1.2 Abbreviations

CB Circuit Breaker

CT Current Transformer

PT Power Transformer

VT Voltage Transformer

2 Cus tom Proper t ies 2 .1 In t r oduc t ion


2 Custom Properties

2.1 Introduction

Custom Properties can be defined as an advanced power user function. You access this option via File > Edit Custom Properties, the Edit Property Definition window opens.

Before defining any custom properties the data structure and the requirements have to be analyzed. Sub–optimal definition of custom properties can influence the performance of the entire system.

One of the most important issues is to define the data owner (e.g. which entity/component owns the data). For example, ratio is not a property of a CT but a property of the core of a CT. One CT can have several cores, and each core can have a ratio.

Custom Properties is a function that allows customer specific definition of the object attributes. For the following Object Types you can set custom properties. Click the drop-down list to see all options:

Asset – Definition of custom properties for all asset objects

Work Order – Definition of custom properties for all work orders

Plan – Definition of custom properties for all plans

Device – Definition of custom properties for all asset class devices

Asset Links – Definition of custom properties for all asset links

CT Link – Definition of custom properties for all CT Links

VT Link – Definition of custom properties for all VT Links

Action Group – Definition of custom properties for all action groups

Repair – Definition of custom properties for all repair records

Malfunction – Definition of custom properties for all malfunction records

Asset Type Link – Definition of custom properties for all asset type links

Notification – Definition of custom properties for all notification records

Protection Operation – Definition of custom properties for all protection operation records

Fault Record – Definition of custom properties for all fault records

Asset Location Link – Definition of custom properties for all asset location links

Location Links – Definition of custom properties for all locations

Location Asset Link – Definition of custom properties for all asset location links

Location Asset Type Link – Definition of custom properties for all location asset type links

Location – Definition of custom properties for all locations

Project – Definition of custom properties for all the projects

Project Stage – Definition of custom properties for all the project stages

Asset Type on Asset – Definition of custom properties for all asset types on asset level

Primary Data Type – Definition of custom properties for all Primary Data Types

PT Winding – Definition of custom properties for all PT Windings

CT Core – Definition of custom properties for all CT Cores

VT Winding – Definition of custom properties for all VT Winding

2 Cus tom Proper t ies 2 .1 In t r oduc t ion


CB Coil – Definition of custom properties for all CB Coils

Tap Position – Definition of custom properties for all Tap Positions

Digital Device – Definition of custom properties for all Digital Devices

In the Edit Property Definition window a drop-down menu is displaying the different Object Types from which the user can select the required object:

It is possible to define custom properties for all individual Object Types listed above. Here below some explanations applied to several mostly used object types:

Asset Group – Definition of custom properties for all assets that belong to a specific asset group

Asset Type – Definition of custom properties for all assets that belong to a specific asset type

Location Type Link – Definition of custom properties for all locations that belong to a specific

location type

Maintenance Action – Definition of custom properties for all actions that belong to a specific

maintenance action template

Commissioning Action – Definition of custom properties for all actions that belong to a specific

commissioning action template

2 Cus tom Proper t ies 2 .2 De f in i t i on o f t he Cus tom Proper t ies G roup


2.2 Definition of the Custom Properties Group

The definition of the custom properties group is a common function for any custom property. The group allows full flexibility to group several properties. Each group is displayed in UI as a separate tab/page on object type.

Every custom property group (tab) needs to be defined. This is the same for any custom property. Each custom property must be part of a property group.

Figure 1: Definition of custom properties group

Property groups are defined via the context menu.

NOTE: All property groups that don’t have a user-defined flag are IPS-SYSTEM™ properties and cannot be edited by the user.

If you would like to hide one custom property group (tab), you can use the context menu command Enable/Disable. If a custom property group is disabled the text is displayed in italic and grey. Users are allowed to disable the system custom property group but not to edit them.

2 Cus tom Proper t ies 2 .2 De f in i t i on o f t he Cus tom Proper t ies G roup


Figure 2: Edit groups

A custom property group will be displayed as a data tab later in the application. For example, a custom property group defined for all assets will make a separate tab New Group in all asset objects.

Figure 3: New group

2 Cus tom Proper t ies 2 .3 Proper t y De f in i t i o n


2.3 Property Definition

After the custom property group is defined, a custom property list can be implemented. Once one individual property is defined, this property can be used for other objects. Be aware that even if the properties are defined within different groups, properties are stored within one database table and can be seen in one common list (e.g. a custom property defined in one specific context will be visible/selectable/editable in a different context).

Custom properties can be defined using the context menu option New.

Figure 4: Property definition

Name - the name of the custom property must be unique; you can only use ASCII codes for the

custom property names.

Select (button) - allows the selection of an already existing custom property from the database.

This custom property name will later be used in formulas, filters, or for referencing. We suggest

2 Cus tom Proper t ies 2 .4 Proper t y T yp es


you label custom property names with, e.g. your company shortcut in order to distinguish your

defined custom properties from the system custom properties.

Display - displayed within property instance.

Description - description of the property.

Unit - unit of the property (if existing).

2.4 Property Types

Each property must have a specific Type defined. The following property types are available:

Figure 5: Property definition type text



Text – simple text property (50 characters long)

Enum – selection of the enumeration list; this list will be selectable later within property instance.

Figure 6: Property definition type enum



Double – Defines the Double (Precision) Number Format

Figure 7: Property definition type double



Date – the date format depends on regional and system date setting.

Figure 8: Property definition type date



Figure 9: Property definition List

There are some more options:

Integer – Integer number format

Has Filter – is a function that sets properties to be selected later within the custom property filter

selection.

Formula – defines the value of the custom property as a formula; this is only for advanced users

with a programming knowledge in VB or C#.



To go to the Select Formula window you click in the selection box (…) at the end of the formula row:

Figure 10: Edit custom properties



Figure 11: Formula definition variable

Figure 12: Edit formula



Figure 13: Maintenance action history

Examples of the formula syntax are presented in the Help FAQ section How to use formula engine.

L is t o f f i gu res


List of figures

Figure 1: Definition of custom properties group ................................................................................................ 4 Figure 2: Edit groups ......................................................................................................................................... 5 Figure 3: New group .......................................................................................................................................... 5 Figure 4: Property definition .............................................................................................................................. 6 Figure 5: Property definition type text ............................................................................................................... 7 Figure 6: Property definition type enum ............................................................................................................ 8 Figure 7: Property definition type double .......................................................................................................... 9 Figure 8: Property definition type date ............................................................................................................ 10 Figure 9: Property definition List...................................................................................................................... 11 Figure 10: Edit custom properties ................................................................................................................... 12 Figure 11: Formula definition variable ............................................................................................................. 13 Figure 12: Edit formula .................................................................................................................................... 13 Figure 13: Maintenance action history ............................................................................................................ 14

ips-energy™ starting ips-energy™ part d: custom properties · ips-energy_v1.92_custom...

Documents