System types - properties · System types - properties COMOS Platform System types - properties...

170
System types - properties _____________________________________ ___________________ _______________________________________________________ ___________________ ___________________ ___________________ _____________________________________ ___________________ COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice" 3 "Connector" system type 4 "Device" system type 5 "Document" system type 6 "Specification" system type: Attribute tabs 7 "Specification" system type: Attributes 8 Display properties of attributes 9 Properties of list attributes 10 Scripts at the base object 11 Scripts at the attribute 12

Transcript of System types - properties · System types - properties COMOS Platform System types - properties...

Page 1: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

� System types - � properties

___________________

___________________

___________________

___________________

___________________

___________________

___________________

___________________

___________________

___________________

___________________

___________________

COMOS

Platform System types - properties

Operating Manual

04/2012 A5E03864967-01

Trademarks 1

Introduction 2

System type "CDevice" 3

"Connector" system type 4

"Device" system type 5

"Document" system type 6

"Specification" system type: Attribute tabs

7

"Specification" system type: Attributes

8

Display properties of attributes

9

Properties of list attributes 10

Scripts at the base object 11

Scripts at the attribute 12

Page 2: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Legal information

Legal information Warning notice system

This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger.

DANGER indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken.

CAUTION without a safety alert symbol, indicates that property damage can result if proper precautions are not taken.

NOTICE indicates that an unintended result or situation can occur if the relevant information is not taken into account.

If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage.

Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems.

Proper use of Siemens products Note the following:

WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.

Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions.

Siemens AG Industry Sector Postfach 48 48 90026 NÜRNBERG GERMANY

A5E03864967-01 Ⓟ 05/2012 Technical data subject to change

Copyright © Siemens AG 2012. All rights reserved

Page 3: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 3

Table of contents

1 Trademarks ............................................................................................................................................. 11

2 Introduction.............................................................................................................................................. 13

2.1 General ........................................................................................................................................13

2.2 Opening the properties ................................................................................................................13

2.3 Inheritance ...................................................................................................................................14

3 System type "CDevice" ............................................................................................................................ 15

3.1 User interface...............................................................................................................................15

3.2 The toolbar ...................................................................................................................................15

3.3 "System" tab.................................................................................................................................15 3.3.1 Purpose........................................................................................................................................15 3.3.2 "General" control group................................................................................................................16 3.3.3 "Object icon" button......................................................................................................................17 3.3.4 Assigning the object icon .............................................................................................................17 3.3.5 Text masks...................................................................................................................................18 3.3.5.1 Principle .......................................................................................................................................18 3.3.5.2 User interface...............................................................................................................................19 3.3.5.3 Creating text masks .....................................................................................................................19 3.3.5.4 Using standard-based text masks ...............................................................................................20 3.3.5.5 Examples for text masks..............................................................................................................20 3.3.6 "Link" control group......................................................................................................................21 3.3.7 "Miscellaneous" control group......................................................................................................22 3.3.8 "Object behavior" control group ...................................................................................................22 3.3.9 "Creation option" control group....................................................................................................23 3.3.10 "Creation mode" control group.....................................................................................................24 3.3.11 "Inheritance mode" control group.................................................................................................25 3.3.12 "Virtual" control group ..................................................................................................................25 3.3.13 "Status" control group ..................................................................................................................26

3.4 "System settings" tab ...................................................................................................................26 3.4.1 Purpose........................................................................................................................................26 3.4.2 "Implement requests" control group.............................................................................................26 3.4.3 "Allowed links" control group........................................................................................................27 3.4.4 Control group "Product data: Comparison method" input group .................................................28 3.4.5 "Classification" control group .......................................................................................................29 3.4.6 "Navigator text" control group ......................................................................................................29

3.5 "Attributes" tab for base objects...................................................................................................30

3.6 "Elements" tab for base objects ...................................................................................................31 3.6.1 Purpose........................................................................................................................................31 3.6.2 General information about elements............................................................................................31 3.6.3 User interface...............................................................................................................................32 3.6.4 Creating an element.....................................................................................................................32

Page 4: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties 4 Operating Manual, 04/2012, A5E03864967-01

3.7 "Connectors" tab for base objects............................................................................................... 33 3.7.1 Purpose....................................................................................................................................... 33 3.7.2 Interface ...................................................................................................................................... 33 3.7.3 Context menu.............................................................................................................................. 33 3.7.4 Preassigning connectors with wires, signals or logical potentials............................................... 34 3.7.5 Effect of the implementation links ............................................................................................... 34

3.8 "Symbols" tab.............................................................................................................................. 34 3.8.1 Purpose....................................................................................................................................... 34 3.8.2 General information about symbols ............................................................................................ 35 3.8.3 User interface.............................................................................................................................. 35

3.9 "Script" tab for base objects ........................................................................................................ 37 3.9.1 Purpose....................................................................................................................................... 37 3.9.2 General information about script blocks...................................................................................... 37 3.9.3 User interface.............................................................................................................................. 38 3.9.4 Script functions with return object ............................................................................................... 38 3.9.5 The script editor .......................................................................................................................... 39 3.9.5.1 General........................................................................................................................................ 39 3.9.5.2 User interface.............................................................................................................................. 39 3.9.5.3 Miscellaneous ............................................................................................................................. 41 3.9.5.4 Project object scripts ................................................................................................................... 41 3.9.5.5 Script error handling.................................................................................................................... 42 3.9.6 Converting old data ..................................................................................................................... 42

3.10 "Usage" tab ................................................................................................................................. 43

3.11 "Inheritance sources" tab ............................................................................................................ 44

3.12 "Configuration" tab page ............................................................................................................. 45 3.12.1 Purpose....................................................................................................................................... 45 3.12.2 User interface.............................................................................................................................. 45 3.12.3 Configuring the display................................................................................................................ 46 3.12.4 Behavior if the configuration is inconsistent................................................................................ 47

4 "Connector" system type.......................................................................................................................... 49

4.1 User interface.............................................................................................................................. 49

4.2 Properties.................................................................................................................................... 49

4.3 Connecting connectors ............................................................................................................... 51

4.4 Effect of the implementation links ............................................................................................... 51

4.5 Feed through connectors ............................................................................................................ 51

4.6 Preassigning connectors with wires, signals or logical potentials............................................... 52

5 "Device" system type ............................................................................................................................... 53

5.1 User interface.............................................................................................................................. 53

5.2 Toolbar ........................................................................................................................................ 53

5.3 Area for general data .................................................................................................................. 55

5.4 Link fields .................................................................................................................................... 56

5.5 Tabs ............................................................................................................................................ 56 5.5.1 "General" tab............................................................................................................................... 56

Page 5: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties Operating Manual, 04/2012, A5E03864967-01 5

5.5.2 "Attributes" tab for engineering objects........................................................................................57 5.5.2.1 Overview ......................................................................................................................................57 5.5.2.2 Working in list attributes...............................................................................................................57 5.5.2.3 "Refresh values" menu command................................................................................................58 5.5.2.4 "Copy tab data"/"Paste tab data" menu command ......................................................................58 5.5.2.5 "Delete all data" menu command.................................................................................................59 5.5.2.6 "Refresh static links..." menu command ......................................................................................59 5.5.2.7 "Accept static links..." menu commands ......................................................................................59 5.5.2.8 Read mode...................................................................................................................................60 5.5.3 "Elements" tab for engineering objects........................................................................................60 5.5.3.1 Overview ......................................................................................................................................60 5.5.3.2 Context menu...............................................................................................................................61 5.5.4 "Connectors" tab on engineering objects.....................................................................................62 5.5.4.1 Overview ......................................................................................................................................62 5.5.4.2 Context menu...............................................................................................................................63 5.5.5 "Wires" tab ...................................................................................................................................64 5.5.5.1 Overview ......................................................................................................................................64 5.5.5.2 Context menu...............................................................................................................................64 5.5.5.3 Predetermined wires ....................................................................................................................65 5.5.5.4 Undetermined wires .....................................................................................................................65 5.5.6 "Strip" tab .....................................................................................................................................65 5.5.7 "Status" tab ..................................................................................................................................66

6 "Document" system type.......................................................................................................................... 67

6.1 User interface...............................................................................................................................67

6.2 "General" tab................................................................................................................................68

6.3 "Attributes" tab for documents .....................................................................................................69

6.4 Switch tab.....................................................................................................................................70 6.4.1 Introduction ..................................................................................................................................70 6.4.2 User interface...............................................................................................................................70 6.4.3 Properties for evaluation reports..................................................................................................71 6.4.4 Properties in the case of interactive reports ................................................................................72 6.4.5 Properties for report templates (evaluation and interactive)........................................................73

6.5 "Revisions" tab .............................................................................................................................73

7 "Specification" system type: Attribute tabs............................................................................................... 75

7.1 Introduction ..................................................................................................................................75

7.2 Rights administration ...................................................................................................................75

7.3 Properties of an attribute tab........................................................................................................75 7.3.1 User interface...............................................................................................................................75 7.3.2 "General" tab................................................................................................................................76 7.3.3 "Script" tab ...................................................................................................................................76 7.3.4 "Usage" tab ..................................................................................................................................77 7.3.5 "Help texts" tab.............................................................................................................................79

7.4 Display within the properties of the system types........................................................................80 7.4.1 Introduction ..................................................................................................................................80 7.4.2 Display modes..............................................................................................................................80 7.4.3 Context menu for the tab .............................................................................................................81

Page 6: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties 6 Operating Manual, 04/2012, A5E03864967-01

7.5 Creating an attribute tab.............................................................................................................. 82

8 "Specification" system type: Attributes..................................................................................................... 83

8.1 Introduction ................................................................................................................................. 83

8.2 Rights administration................................................................................................................... 83

8.3 Opening the properties................................................................................................................ 83

8.4 User interface.............................................................................................................................. 84

8.5 "General" tab............................................................................................................................... 84 8.5.1 "Display type" field ...................................................................................................................... 84 8.5.2 "Description", "Name", "Value" fields .......................................................................................... 87 8.5.3 "Decimal digits" field.................................................................................................................... 87 8.5.4 "Formatting digits" field ............................................................................................................... 87 8.5.5 "Format" field............................................................................................................................... 88 8.5.6 "Length" field ............................................................................................................................... 88 8.5.7 "Unit" field.................................................................................................................................... 88 8.5.8 Assigning units ............................................................................................................................ 89 8.5.9 "Type" field .................................................................................................................................. 89 8.5.10 "Standard table" field................................................................................................................... 90 8.5.11 "Working area" field..................................................................................................................... 90 8.5.12 "Edit mode" field.......................................................................................................................... 91 8.5.13 "Catalog attribute" field................................................................................................................ 92 8.5.14 "Engineering object status" and "Engineering object status value" fields................................... 92 8.5.15 "Inheritance mode" field .............................................................................................................. 92 8.5.16 "Attribute editable upon blocking of owner on engineering side" option..................................... 93 8.5.17 The "Base attribute" indicator...................................................................................................... 93

8.6 "Link" tab ..................................................................................................................................... 93 8.6.1 Introduction ................................................................................................................................. 93 8.6.2 User interface.............................................................................................................................. 94 8.6.3 "Attribute" field............................................................................................................................. 95 8.6.4 The link types .............................................................................................................................. 96 8.6.4.1 No link ......................................................................................................................................... 96 8.6.4.2 By own object .............................................................................................................................. 96 8.6.4.3 By owner ..................................................................................................................................... 96 8.6.4.4 By linked object ........................................................................................................................... 96 8.6.4.5 By <GetLinkedSpecification> and <GetDisplayValue> script functions ..................................... 97 8.6.4.6 By connector ............................................................................................................................... 98 8.6.4.7 Via the Navigation assistant........................................................................................................ 98 8.6.4.8 Via mapping table ....................................................................................................................... 99 8.6.4.9 Via calculation formula ................................................................................................................ 99 8.6.5 Value ........................................................................................................................................... 99 8.6.5.1 Static value.................................................................................................................................. 99 8.6.5.2 Dynamic value........................................................................................................................... 100 8.6.5.3 Fully dynamic ............................................................................................................................ 101

8.7 "Script" tab................................................................................................................................. 102

8.8 "Help texts" tab.......................................................................................................................... 102

8.9 "Usage" tab ............................................................................................................................... 103

8.10 Attributes without an attribute tab ............................................................................................. 104

Page 7: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties Operating Manual, 04/2012, A5E03864967-01 7

8.11 Mandatory attributes ..................................................................................................................104

8.12 Displaying a user-defined information window in the case of an invalid value..........................105

8.13 Creating an attribute ..................................................................................................................106

8.14 Setting display properties via the attribute tab...........................................................................107

8.15 Context menu of the attribute on an attribute tab ......................................................................108

9 Display properties of attributes .............................................................................................................. 109

9.1 Introduction ................................................................................................................................109

9.2 Description .................................................................................................................................109

9.3 Image selection..........................................................................................................................110

9.4 Checkbox ...................................................................................................................................110

9.5 File selection ..............................................................................................................................111

9.6 Date............................................................................................................................................112

9.7 Edit: (Min Max)...........................................................................................................................112

9.8 Edit: (Min Value Max).................................................................................................................112

9.9 Edit field .....................................................................................................................................112

9.10 Excel interface............................................................................................................................114

9.11 List..............................................................................................................................................114

9.12 Memo field..................................................................................................................................115

9.13 Memo field (RTF) .......................................................................................................................115

9.14 Object query...............................................................................................................................115

9.15 Frame.........................................................................................................................................116

9.16 Repeater ....................................................................................................................................117

9.17 Button.........................................................................................................................................117

9.18 Signature....................................................................................................................................117

9.19 Link.............................................................................................................................................118

10 Properties of list attributes ..................................................................................................................... 119

10.1 Introduction ................................................................................................................................119

10.2 Display properties of lists ...........................................................................................................120 10.2.1 "General" tab on lists .................................................................................................................120 10.2.2 "Attributes" tab on lists ...............................................................................................................121 10.2.3 "Indices (values)" tab .................................................................................................................123 10.2.4 Moving column attributes or line attributes ................................................................................123

10.3 Limitations ..................................................................................................................................124

10.4 Access to cell values (XValues).................................................................................................124

11 Scripts at the base object ...................................................................................................................... 125

11.1 Read-only scripts at the base object..........................................................................................125

Page 8: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties 8 Operating Manual, 04/2012, A5E03864967-01

11.2 General...................................................................................................................................... 126

11.3 AddToGraficalParamater<Diagram_type>(Num)...................................................................... 126

11.4 BeforeCheck (checkObject) ...................................................................................................... 127

11.5 CalcNextName ()....................................................................................................................... 128

11.6 CheckDelete (Object)................................................................................................................ 128

11.7 CheckStatus [1-13].................................................................................................................... 129

11.8 Connect (Connector)................................................................................................................. 129

11.9 CreateDocumentGroup (class document) ................................................................................ 129

11.10 DeleteWarning (Object)............................................................................................................. 130

11.11 DisConnect (Connector)............................................................................................................ 130

11.12 GetConnectorLabel (Connector)............................................................................................... 131

11.13 GetConnectorSpecification (Device, ConnectorName, SpecName)......................................... 131

11.14 IsDocumentCheckInAllowed (Document, FileName)................................................................ 132

11.15 IsImplementationValid (Device) ................................................................................................ 132

11.16 IsLocationValid (Device) ........................................................................................................... 133

11.17 IsLockAllowed (Lock) ................................................................................................................ 133

11.18 IsReleaseAllowed...................................................................................................................... 134

11.19 IsRevisionAllowed (Document) ................................................................................................. 134

11.20 IsUnitValid (Device)................................................................................................................... 135

11.21 NavigatorText (Object) .............................................................................................................. 135

11.22 OnCheck (Device, Modus) ........................................................................................................ 136

11.23 OnCreateReferenceDocument () .............................................................................................. 137

11.24 OnDocObjCreate (DocObj) ....................................................................................................... 137

11.25 OnDocObjDelete (DocObj)........................................................................................................ 138

11.26 OnDocumentCheckIn (Document)............................................................................................ 138

11.27 OnDocumentCheckOut (Document) ......................................................................................... 138

11.28 OnEditOk () ............................................................................................................................... 139

11.29 OnEStampCreate (ST, RevElm) ............................................................................................... 139

11.30 OnEStampShow (PdfStamper, Revision) ................................................................................. 140

11.31 OnImplementationSet (OldValue) ............................................................................................. 141

11.32 OnLocationSet (OldValue) ........................................................................................................ 141

11.33 OnLockDone (Lock) .................................................................................................................. 142

11.34 OnMenuCreate (Popup, Context) ............................................................................................. 142

11.35 OnMenuExecute (ID, Context) .................................................................................................. 143

11.36 OnNotLongerReferencedByDevice (Device) ............................................................................ 144

Page 9: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties Operating Manual, 04/2012, A5E03864967-01 9

11.37 OnProjectOpen (Project)............................................................................................................144

11.38 OnReferencedByDevice (Device) ..............................................................................................145

11.39 OnReferencedByDocument (Document) ...................................................................................145

11.40 OnRelease .................................................................................................................................145

11.41 OnReleaseDone ........................................................................................................................146

11.42 OnRevision () .............................................................................................................................146

11.43 OnRevisionRelease (RevisionInfo)............................................................................................147

11.44 OnSubMenuCreate (Popup, ID, Context) ..................................................................................147

11.45 OnUnitSet (OldValue) ................................................................................................................148

11.46 RestoreRequest (Request) ........................................................................................................148

11.47 UserScript [1-9] ..........................................................................................................................149

12 Scripts at the attribute............................................................................................................................ 151

12.1 Read-only scripts of attributes ...................................................................................................151

12.2 General script blocks .................................................................................................................151

12.3 Display type-specific script blocks .............................................................................................152

12.4 Alphabetic reference of the script blocks ...................................................................................153 12.4.1 BeforeCheck (checkObject) .......................................................................................................153 12.4.2 CheckStaticLinkValue (value1, value2) .....................................................................................153 12.4.3 CustomizeFileOpenDialog .........................................................................................................154 12.4.4 CustomizeTree (Tree)................................................................................................................155 12.4.5 FillComboList (Combobox) ........................................................................................................155 12.4.6 FilterRow (StdTabItem)..............................................................................................................156 12.4.7 GetDisplayValue ().....................................................................................................................156 12.4.8 GetDisplayXValue (Index)..........................................................................................................157 12.4.9 GetLinkedSpecification ()...........................................................................................................158 12.4.10 GetLinkObject (txt) .....................................................................................................................159 12.4.11 GetRoot () ..................................................................................................................................159 12.4.12 GetScriptLinkObject ...................................................................................................................160 12.4.13 GetScriptUnit () ..........................................................................................................................160 12.4.14 GetScriptValue () .......................................................................................................................161 12.4.15 Import (SpecOwner, ExelActiveWorkbook) ...............................................................................161 12.4.16 IsLinkobjectValid (object) ...........................................................................................................162 12.4.17 IsSignatureAllowed (String) .......................................................................................................162 12.4.18 IsValueValid ...............................................................................................................................162 12.4.19 OnChange..................................................................................................................................163 12.4.20 OnChangeOther () .....................................................................................................................164 12.4.21 OnClick () ...................................................................................................................................165 12.4.22 OnEdit ().....................................................................................................................................165 12.4.23 OnLinkobjectSet (old value).......................................................................................................166 12.4.24 OnShow () ..................................................................................................................................166 12.4.25 SetScriptLinkObject (LinkObject) ...............................................................................................167 12.4.26 SetScriptUnit (Unit) ....................................................................................................................167 12.4.27 SetScriptValue (Value)...............................................................................................................168

12.5 Example script............................................................................................................................169

Page 10: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Table of contents

System types - properties 10 Operating Manual, 04/2012, A5E03864967-01

12.6 Script commands for attributes ................................................................................................. 169

Page 11: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 11

Trademarks 1Trademarks

Registered trademark: COMOS®

Page 12: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Trademarks

System types - properties 12 Operating Manual, 04/2012, A5E03864967-01

Page 13: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 13

Introduction 22.1 General

Purpose of the manual This manual provides administrators with a reference to the properties of the system types.

Definition for system types Each COMOS object has one of the following system types:

Objects System type Base objects "CDevice" Connectors "Connector" Engineering objects "Device" Attributes and attribute tabs "Specification" Documents "Document"

The system type determines in principle which properties the object can have. Administrators configure these properties. By this means they specify the object at a general level. Users refine the requirements of the administrators and specify the object at a concrete level.

Access to the properties of the system types COMOS provides user interfaces via which the user can access the properties. Properties can also be accessed via script.

2.2 Opening the properties

Procedure Select the object in the Navigator and select the "Properties" command in the context menu.

This command is also available at many other points.

Examples:

● In reports

● In link fields

● In additional navigators

Page 14: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Introduction 2.3 Inheritance

System types - properties 14 Operating Manual, 04/2012, A5E03864967-01

Result ● COMOS opens the properties:

On a tab in the work area In a separate window of its own Base object Connector Engineering object Attribute tab Document Attribute

● If the properties of another object with the same system type are already open, COMOS loads the properties into that tab or that window.

Displaying properties of several objects of the same system type Use the button to secure:

● Properties in the window: In the title bar

● Properties on the tab: Hover the mouse pointer over the tab header to display the button.

2.3 Inheritance

Displaying inherited properties The system types inherit some properties from their inheritance source. As long as the inherited property is not changed, its description or its value in the user interface is shown in italics.

You find more information on this topic in the "Inheriting, copying, deleting" manual, keyword "Definition: Hierarchical inheritance".

Page 15: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 15

System type "CDevice" 33.1 User interface

Structure ● A toolbar

● Multiple sub-tabs, which contain the properties

● Standard buttons for saving and closing

3.2 The toolbar

Control elements Button Description

Opens a context menu with navigation commands. Depending on the base object, you see different menu commands: "Object"

Selects the current base object in the Navigator. The project is not switched. "Uses"

Displays where the base object is being used as an element or link. "Inheritance sources"

Displays from which objects the base object inherits information through hierarchical inheritance or links.

Selects the owner of the current base object in the Navigator.

3.3 "System" tab

3.3.1 Purpose The "System" tab manages the general data of the base object.

Page 16: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties 16 Operating Manual, 04/2012, A5E03864967-01

3.3.2 "General" control group

Control elements Field Description "Class" List of classes

The field filters the entries which are offered in "Subclass". Additional control element:

"Delete" button

Sets the value inherited by the owner. "Subclass" List of subclasses that are available for the selected class

Additional control elements: – "Delete" button

Like for "Class". – "Object icon" button

See also section "Object icon" button (Page 17). – "ControlType (ProgID) ... " button

Enter a DLL. It is executed at the start of the object. Enter the DLL with the ProgID from the registry.

"Name" The name of the base object

No other object with this name may exist under this owner. Additional control elements:

– To generate text masks

See also section Text masks (Page 18). – Option "Locked"

Activated: The name of the derived engineering objects cannot be changed.

– Option "Check"

Activated: The mask generator checks whether the entries for the name are valid.

Page 17: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 17

Field Description "Label" The label

Only when using labeling systems Special cases such as document groups for which a label outside a labeling

system is used are documented at the corresponding point. Additional control elements: Like for "Name"

"Description" A long text, displayed in the Navigator Type: "Memo field"

If the user works with several languages in the database, the translations of the different languages are saved in the same field. They remain hidden until the relevant language is set, but occupy a part of the field length.

You find more information on this topic in the "COMOS Administration" manual, keyword "Technological background".

Additional control element "Locked": Like for "Name"

3.3.3 "Object icon" button

Purpose The "Object icon" button is used to assign a user-defined icon to the base object, for better differentiation from other base objects.

Engineering objects and documents adopt the icon of their base object.

3.3.4 Assigning the object icon

Requirement The "System" tab is visible in the base object properties.

Procedure 1. In the "General" control group, click on the "Object icon" button:

The "Manage icon" window opens.

2. To select an icon from the sample library, proceed as follows:

– Activate the "Icon library" option.

– Select a library from the list.

The library "ELO" is set up in the COMOS DB.

– Select an icon from the structure tree.

Page 18: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties 18 Operating Manual, 04/2012, A5E03864967-01

3. In order to upload an ICO file or a BMP file, proceed as follows:

– Activate the "File" option.

– Click on the "..." button.

A file selection window opens.

– Select the file from the file system and confirm your selection.

Note Effect on performance

COMOS runs more quickly if you use icons from the icon library. COMOS runs more slowly if you select an external icon using the "File" option.

4. Confirm your inputs.

Deleting the selected icon In the "Manage icon" window, click on the "Delete" button:

Result: The icon inherited by the owner is applied. If the base object is directly under the project, the standard icon for base objects is used.

3.3.5 Text masks

3.3.5.1 Principle

Purpose of text masks A text mask is a rule that COMOS uses to generate names and labels when creating an engineering object or a document.

Text masks not allowed Do not use text masks for the following objects:

● Objects created on the "Elements" tab

● Objects with the "Virtual = Off" or "Virtual = Default" option

Reason:

The cinnection between the in the base data prepared elements and the from there derived elements is exclusively conducted via the name. Therefore, when creating the prepared element in the engineering data, the name cannot be changed.

Page 19: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 19

3.3.5.2 User interface

Control elements Text masks are defined using the following control elements:

No. Control element Description 1 Text field The text mask 2 "i" button Opens a context menu. Select the wildcards of the text mask from the

menu commands. They are loaded into the front field. The context menu also contains the following menu commands: "Check validity"

Compares the starting value in the right-hand field with the text mask in the left-hand field.

"Use standard table > ..."

In the "SYSTEM > @MASK" standard table you will see text masks which were prepared in the base project.

"Write to standard table" – Only if a text mask has been entered – For definition of project-specific text masks in local standard tables – Checks the "SYSTEM > @MASK" standard table into the current

project and creates a new entry for the text mask there.

3 Text field The starting value 4 "…" button For definition of standard-based text masks

See also Using standard-based text masks (Page 20)

3.3.5.3 Creating text masks

Procedure 1. Click on the "i" button.

2. Select a wildcard.

It appears in the left-hand field.

3. Repeat steps 1 and 2 until the mask is complete.

Page 20: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties 20 Operating Manual, 04/2012, A5E03864967-01

4. Define a starting value in the right-hand field.

5. Optional: To check the validity of the starting value, click on the "i" button and select the "Check validity" command from the context menu.

Specialties when using the wildcard ● "<", ">": May occur only once.

● "\": Always placed in front of the literal.

● "*", "+", "?": May not stand alone if not used as a literal. May be used within and outside the calculation part.

3.3.5.4 Using standard-based text masks

Procedure 1. Click on the "..." button.

2. Enter text masks for the required standards in the "Standard-based text masks" window.

3. Save your entries.

Result ● COMOS evaluates the project properties: "Options > Standard" tab, "Miscellaneous"

control group, "Standard-based text masks" field

● COMOS uses the text mask for the standard set there.

● If no mask is entered for this standard, COMOS uses the mask entered in the "Default" field in the "Standard-based text masks" window.

3.3.5.5 Examples for text masks

Examples COMOS mask First value Last value Regular expression, internal ...<9*> ABC ...[0-9]* \M<c> MA Mz M[a-z] \C<9+> A1 [a-z][0-9]+ \T\V<99> TV01 TV99 TV[0-9][0-9] ..<999+> XY001 ..[0-9][0-9][0-9]+ \H<99+>. H01N H99N H[0-9][0-9]. .*<9+> 1 .*[0-9]+ <9*>.* 1 [0-9]*.* \A\C<CC> ACAA ACZZ AC[A-Z][A-Z]

Page 21: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 21

3.3.6 "Link" control group

Control elements Control element Description "Base object" field Link to a base object

The base object inherits its properties from the base object referenced here. The hierarchical inheritance is interrupted.

"Dereference" option

This appears only if the "Base object" field has been set. Activated: The inheritance structures change: The engineering object adopts the fields "Name", "Label", and "Description"

from the base object from which it is derived. All other properties are adopted from the base object entered in the "Base object" field as the base object.

The information about which base object was used to derive the engineering object originally is lost. Instead the connection to the base object referenced in the "Base object" field is saved at the engineering object.

Any future changes to the base object from which an engineering object was originally derived have no effect on the engineering object. Changes to the base object referenced in the "Base object" field are applied.

"Template" field Link to a template Templates consist of engineering objects that have been prepared in the base project. The engineering objects belonging to a template are collected under an engineering object (root node). The template in the engineering projects is made available via a base object. If you set a link to a template, the following rules apply: The base object must be made available as an element. Only the "System", "Attributes", and "Script" tabs are available at the base

object. Whether the root node is created in the engineering project depends on the

"Creation options" control group: – "Normal"

The root node is created. – "Block"

The root node is created. You find more information on this topic in the "COMOS Administration" manual, keyword "Templates/Assemblies".

Page 22: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties 22 Operating Manual, 04/2012, A5E03864967-01

3.3.7 "Miscellaneous" control group

Control elements Control element Description "Visible for all users" option

This helps you by presenting the base data structure for normal users in a manner that is easier to understand. This property is not inherited further. Deactivated: The base object and all objects located under it are visible only to administrators.

"Count" field Only in the case of a base object that is an element in another base object Not evaluated by COMOS. In a script it can be addressed as "CDevice.Number".

"Working area" field The base object may be used only in the specified working area. The working area also governs the visibility of devices etc. which are based on the base object. You find more information on this topic in the "Rights" manual, keyword "Working areas".

3.3.8 "Object behavior" control group

Control elements Option Description "Define run cases" Activated: The "Change case" menu command is available in the context menu

of the derived engineering objects. This opens a window in which the project properties are offered defined run cases.

"Folder" Activated: The base object is a folder. Its task is to structure the objects lying under it. The object is disregarded if "FullLabel" applies. The property is inherited only by the derived engineering objects. It cannot be

deactivated there.

"Instantiating" Activated: Instances can be set up for attributes. "Unique label" Activated: Each label of the engineering objects must be unique. The property

behaves according to the project property "Directory wide unique name".

You find more information on this topic in the "COMOS Administration" manual, keywords "Run cases", "Directory wide unique name", and "Instances".

Page 23: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 23

3.3.9 "Creation option" control group

Purpose Here you specify the purpose of the base object.

The creation options Value Description "Normal" A normal base object serves as the basis for engineering objects. "Block" A block is used to create several elements collectively. See also section General

information about elements (Page 31). A base object with the "Block" creation option cannot be created as an engineering object itself. It represents only the individual elements.

"Group" A group is used to sort base objects in a similar way to how the folder is used to sort engineering objects. In the case of automatic name detection it is ignored. A base object with the "Group" option cannot be created as an engineering object.

"Structure" Purpose

A structure object has purely a sorting function. It serves to make the underlying base objects accessible. It cannot be created as an engineering object.

Implementation – Create a base object with the "Structure" option. – Create other base objects under this structure object. – Insert the structure object for another base object as an element on the

"Elements" tab, e.g. for a unit. Effect

After creating the unit in the engineering project, the structure object is offered for selection in its context menu under the "New" command. If the user selects the structure object, a submenu opens, which offers the objects under the structure object for creation.

If no base objects are located under the structure object, COMOS evaluates additionally the "Base object" link. If a base object has been referenced, its subobjects are offered.

This option is particularly helpful during definition of labeling systems.

Other control elements Control element Description

The button restores the inherited setting of the control group.

"Not selectable" option

Activated: Users can no longer derive engineering objects from the base object. Engineering objects already created can still be used.

Page 24: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties 24 Operating Manual, 04/2012, A5E03864967-01

3.3.10 "Creation mode" control group

Purpose Creation mode governs which objects in the engineering data can be created under the objects derived from the base object.

Control elements Option Description "Free" Users can create any object under a derived object.

Users can see the "New > New object" command in the context menu of the derived object.

"Elements" Under a derived object, users can create only those objects which are entered as an element for the base object. The base object must have elements. Users can see the "New > <Element>" command in the context menu of the derived object.

"Subelements" Users can create only the following objects under a derived object: The elements of the base object The elements of these elements (subelements), provided they come from the

same branch as its base object Users can see the "New > General > New object from list" command in the context menu of the derived object. This opens a window in which users can use the setting "Virtual n times" to create multiple elements.

"Subelements extended"

Like the "Subelements" creation option, but the subelements can originate from a node different from the base object. In addition, CDevice-Pointer and CLink-Backpointer continue to be followed.

Page 25: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.3 "System" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 25

3.3.11 "Inheritance mode" control group Where base objects are concerned, only elements have this control group.

Inheritance mode is also available for the following system types:

● "Specification"

● "Connector"

Inheritance modes Value Description "Active" The element is inherited by the derived objects and by the base objects under

the element owner. "Inactive" Inheritance is switched off completely.

You can use this inheritance mode to prepare multiple elements at one level of the structure tree and deactivate the elements which are no longer needed in the lower levels.

"Inactive for base objects"

Inheritance within the base data is deactivated.

See also General information about elements (Page 31)

3.3.12 "Virtual" control group Only elements have this control group. It governs how often and when the element is created in the engineering project. Elements which have been prepared in the base data but not yet been created in the engineering data are designated as "virtual".

Control elements Control element Description "< ... > times" field Enter how many times the user can create the element in the engineering data.

Once the maximum number is reached, the object is no longer offered in the context menu.

"N-times" option Users can create the element as often as they wish. "Off" option If a user creates the owner of the element in the engineering data, the element is

automatically created with it. It cannot be deleted. "Default" option As for "Off", but users can delete the element. After the deletion they can create

it again manually.

Page 26: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.4 "System settings" tab

System types - properties 26 Operating Manual, 04/2012, A5E03864967-01

See also General information about elements (Page 31)

3.3.13 "Status" control group Status management at the object level is performed here. You find more information on this topic in the "COMOS Administration" manual, keyword "Object-based status management".

3.4 "System settings" tab

3.4.1 Purpose The "System settings" tab contains further properties relevant to the system.

3.4.2 "Implement requests" control group

Purpose This is where you define whether the object constitutes a request or an implementation and how it behaves when implemented.

"Request" option ● Activated:

The object is a request. It must later be replaced in the engineering data with a manufacturer device.

● Deactivated:

The object is an implementation. The "Project settings" option is activated.

● This property replaces the use of objects of the "Request" class.

"Project setting" option ● Activated:

– When setting an implementation link, the behavior defined under "Implementation" on the "Options > EE/I&C options 2" tab in the project properties applies.

– The list for definition of the implementation behavior is locked.

Page 27: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.4 "System settings" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 27

● Deactivated:

– Requirement

The "Request" option is activated.

– The project setting is overwritten by the value set in the list as the definition of the implementation behavior.

● Inherited by the owner.

"Delete" button

Restores the inheritance for the "Project setting" option and for the list defining the implementation behavior.

List for defining the implementation behavior of the object If the "Project settings" option is deactivated, the list overwrites the behavior defined in the project.

Value Effect "Object will be replaced (by merge)"

The request object will be replaced using the merge technique.

"Object will be replaced (by pointer)"

The request object is deleted and completely replaced by the manufacturer device.

"Object will not be replaced (by merge)"

The request object will not be replaced using the merge technique.

"Object will not be replaced (by pointer)"

The request object is retained. It is given a reference to the manufacturer device and the manufacturer device is given a reference to the request.

You can find additional information on this in the "EI&C Administration" manual, keyword "Project properties".

3.4.3 "Allowed links" control group

Purpose Here you can determine which links to the derived objects are permitted.

Link types ● Unit, position, function, signal

● Location

● Implementation, destination, cable route

Page 28: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.4 "System settings" tab

System types - properties 28 Operating Manual, 04/2012, A5E03864967-01

If you deactivate a link type, the following rules apply:

● A link of this type may not be entered in the user interface by using drag&drop or by using a script or an import.

● Existing links still apply.

● The respective entry on the "Configuration" tab can no longer be moved into the "Current components" area. If it has already been moved there, it is automatically moved back into the "Default components" area.

Controlling links using scripts To control the use of a link explicitly, use the following script blocks:

● "IsUnitValid(Device)"

See also chapter IsUnitValid (Device) (Page 135).

● "IsLocationValid(Device)"

See also chapter IsLocationValid (Device), (Page 133).

● "IsImplementationValid(Device)"

See also chapter IsImplementationValid (Device) (Page 132).

Displaying the links in the engineering data In the default setting, link fields are displayed only when a user sets a corresponding link using drag&drop. If the "Configuration" tab has been configured accordingly, the link fields are displayed from the start.

See also Configuring the display (Page 46)

3.4.4 Control group "Product data: Comparison method" input group

"Recursive" option Activated: The same comparison method runs recursively for elements that are not virtual as for the object.

Page 29: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.4 "System settings" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 29

3.4.5 "Classification" control group

Principle Classification is the successor method to the "Classes" and "Subclasses" method.

Classification gives objects of the "Device" and "Document" system types a label, which they adopt from their base objects. The information is present only in the base objects.

Types of classification Type of classification Description Hierarchical Describes the class structure and therefore the base data structure of a

COMOS module. The string for this classification consists of a maximum of five times two characters, each separated by a period. The string shows where the base object that is used is located. Example: "PI.VA.CV.CO" describes the base object "P&ID > Valves > Control valves > Right angle valves". The " ... " button opens a window with the prepared classification structures. Depending on the object you select, COMOS enters another key.

Functional Describes the function of an object independently of the module, e.g. "Object is a measurement" or "Object is an import interface". You can select up to five independent functional classifications for each object. They can be in any order.

User classification For company-specific purposes The functional classification technique is used in the background.

You find more information on this topic in the "Queries" manual, keyword "Classification"

3.4.6 "Navigator text" control group

"Display of referenced objects" option ● Activated

In the Navigator, users see the back pointer of the object and its subordinate objects.

● Deactivated

Users no longer see the back pointer. The performance increases.

Note Using the implementation technique

The implementation technique also works when the option is deactivated. However, the back pointer display is useful for working with the implementation technique.

Page 30: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.5 "Attributes" tab for base objects

System types - properties 30 Operating Manual, 04/2012, A5E03864967-01

3.5 "Attributes" tab for base objects

Terminology Attribute tabs are also referred to as tabs for short.

Purpose The "Attributes" tab allows you manage the attribute tabs and the attributes of the base object:

● You can create attribute tabs and attributes.

● You can define value ranges and default values.

● You can link attributes.

The user then fills in this data for the engineering objects.

Principle ● Information such as technical data and manufacturer data describe an object in the

engineering context. This information is saved in attributes. The attributes are collected together on attribute tabs.

● Attributes and attribute tabs are objects. Even though they both have the system type "Specification", attributes have different properties from attribute tabs.

● You can create attribute tabs and attributes only under base objects. COMOS creates them automatically under the derived engineering objects.

● Attributes are located in the Navigator under their attribute tabs.

● Owners of the attributes and attribute tabs:

– Base objects

– Engineering objects

– Documents

Further information Due to their complexity, the properties of attributes and attribute tabs and their use in the base data are described in separate chapters.

See also "Specification" system type: Attribute tabs (Page 75)

"Specification" system type: Attributes (Page 83)

Display properties of attributes (Page 109)

Properties of list attributes (Page 119)

Page 31: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.6 "Elements" tab for base objects

System types - properties Operating Manual, 04/2012, A5E03864967-01 31

3.6 "Elements" tab for base objects

3.6.1 Purpose You can use the "Elements" tab to define which elements the object has.

3.6.2 General information about elements

Definition of "Element" Elements are secondary objects with an inseparable relationship to their owner. They are collected together in the "Elements" collection and managed at the base object on the "Elements" tab.

Be careful not to confuse this with objects of the class "Element".

Purpose of elements ● Structure of naming systems

The objects are used as a classification criterion. The "Dereference" option on the "System" tab at the element must be activated. You find more information on this topic in the "COMOS Administration" manual, keyword "Labeling systems".

● Structure of multi-level objects, such as terminal strips

The "Dereference" option at the element must be deactivated. If you drag a base object on to the "Elements" tab, the option is deactivated by default.

● Preparation of thematically or technically related objects

Elements are offered in the engineering data in the context menu of their owner.

Properties of elements Elements have the same tabs and properties as normal base objects. On the "System" tab they also have the "Virtual" and "Inheritance mode" control groups.

Preassigning connectors using elements See also section Preassigning connectors with wires, signals or logical potentials (Page 34).

See also "Inheritance mode" control group (Page 25)

"Virtual" control group (Page 25)

Page 32: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.6 "Elements" tab for base objects

System types - properties 32 Operating Manual, 04/2012, A5E03864967-01

3.6.3 User interface

Elements table On the "Elements" tab, you can see a table with the elements of the object. It contains the most important properties of the elements.

You can edit the properties directly in the table and create or delete elements.

3.6.4 Creating an element

Procedure You have two options:

1. Select the "New" command on the context menu on the "Elements" tab.

The new element is given the class "Element". You can change the class in the table.

2. Drag a base object from the Navigator on to the tab.

The element is given a link on the base object: Properties of the element > "System" tab > "Link" control group > "Base object" field

It has the same class as the referenced base object.

Result The element is available in the engineering data as an element inherited from the base object.

Creating elements in a block 1. Create an element on the "Elements" tab.

2. Open the properties of the element.

3. Configure the "System" tab:

– Creation option: "Block"

– "Virtual" control group: E.g. "N-times"

4. Go to the "Elements" tab.

5. Create multiple elements.

6. Configure the elements. They must not have the "Block" creation option.

Effect: If you select the block element in the context menu in the planning data, its elements are created. The block element itself is not created.

Page 33: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.7 "Connectors" tab for base objects

System types - properties Operating Manual, 04/2012, A5E03864967-01 33

3.7 "Connectors" tab for base objects

3.7.1 Purpose The "Connectors" tab allows you to configure the connectors for the derived engineering objects.

3.7.2 Interface

Control elements Control element Description "All connectors" option Activated

You can also see the connectors of the objects located under the base object. Slows down the performance.

Default

Activated for devices (class: "Device") and elements. Deactivated for the other objects.

Table Here you create connectors via a context menu, and configure them.

Columns: See also section "Connector" system type (Page 49).

3.7.3 Context menu

Principle ● Use the context menu for the table to create the connectors and configure them.

● When the table is empty, the only commands available are "New" and "Paste".

● You can select several connectors and edit them simultaneously via the context menu.

Menu commands Menu command Description "New" Creates a new connector and opens its properties for configuration. "Copy" Copies the connector to the clipboard. "Cut" Cuts the connector and copies it to the clipboard. "Paste" Pastes the connector from the clipboard.

Page 34: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.8 "Symbols" tab

System types - properties 34 Operating Manual, 04/2012, A5E03864967-01

3.7.4 Preassigning connectors with wires, signals or logical potentials For many devices, the information on wires, signals or potentials of many connectors is already known in the base data. On the "Elements" tab you can preassign the connector as potential or signal.

You can find more information on this topic in the "EI&C Administration" manual, keyword "Preassigning connectors with potential".

3.7.5 Effect of the implementation links When an engineering object is given an implementation link, its connectors are given information not only on the potential, signal, wire, and counter connector, but also on their cross-section, color, and number. In addition, "RestoreRequest" is triggered. When the implementation is triggered, the connectors are reset to their original values.

Note

If the script block "OnImplementationSet" is used, the COMOS automatic implementation routines are not executed.

See also RestoreRequest (Request) (Page 148)

OnImplementationSet (OldValue) (Page 141)

3.8 "Symbols" tab

3.8.1 Purpose On the "Symbols" tab, specify which symbols for the object will be used for the required drawing types.

Page 35: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.8 "Symbols" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 35

3.8.2 General information about symbols

Definition A symbol represents an object on an interactive report in a way typical of a drawing type.

Principle ● Specify a symbol drawing for each drawing type. This contains the actual symbol

graphics and an optional text symbol with additional symbols.

● You load the symbols from a file that contains the original drawing or define it in COMOS. In COMOS use either the Symbol Editor or the script editor.

● In the Symbol Editor you can place graphical elements such as circles, lines or text variables. When you save they are converted into script.

● In the script editor you describe the symbol directly using code.

See also The script editor (Page 39)

3.8.3 User interface The "Symbols" tab has the following control elements:

"Symbol path" Here you set the directory in which the files with symbol drawings are located.

"Load symbol scripts" This button then reloads all symbol scripts created under this object.

"Attributes with graphical relevance" The button opens a user interface for defining an attribute-based additional graphic.

Old method, only provided for reasons of compatibility

Instead, use the "*V*P S" text function in the Symbol Editor. You find more information on this topic in the "Reports - Basic Operation" manual, keyword "Subsymbols/Additional symbols".

Page 36: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.8 "Symbols" tab

System types - properties 36 Operating Manual, 04/2012, A5E03864967-01

Symbol table In the table, you can see the symbols already defined, and create new symbols. You can filter the table by means of the "Unused drawing types" option.

Column Description "Type"/"Drawing type"

Reads the name and the description of the drawing type from the "@SYSTEM > @DRW_TYPE" standard table in the system project. You can make user-specific extensions to the standard table in the system project.

"Symbol" Contains a simplified depiction of the symbol and the following information: Symbol defined by script: The word "<Script>"

Double click in the cell to open the Symbol Editor. You can see the elements of the symbol script that can be represented graphically and you can edit the symbol. You find more information on this topic in the "Reports - Basic Operation" manual, keyword "Symbol Editor".

To open the symbol script, use the Show symbol script" button from the "Symbol" control group.

Symbol from file: Path and name of the original drawing

"Text" Saves the additional symbols. Like the "Symbol" column but without the simplified depiction.

"Symbol" and "Text" control groups Using these control groups, you can edit the symbol or additional symbol for the drawing type selected in the symbol table, or create a new one.

Control element Description Text field Symbol defined by script: The word "<Script>"

Symbol from file: Path and name of the original drawing

Button Opens a window in which you can select the path for the symbol file. Button Cancels the assignment to the symbol file. Button Creates a free script which allows you to define the symbol or opens the script in

the script editor. See also chapter The script editor (Page 39). You can also use the symbol table to define the symbol in the Symbol Editor.

Button Only for "Symbol" Opens a variant report, which depicts a three-dimensional object using up to six two-dimensional symbols ("views"). You can find more information on this topic in the manual "EI&C Administration", keyword "Symbol variants for views".

Page 37: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.9 "Script" tab for base objects

System types - properties Operating Manual, 04/2012, A5E03864967-01 37

Option "Hide unused drawing types" ● Activated (default)

In the symbol table, you can only see the drawing types for which a symbol or symbol script exists.

● Deactivated

You can see all drawing types. The setting applies only up until closure of the properties.

3.9 "Script" tab for base objects

3.9.1 Purpose The "Script" tab allows you to manage the script blocks for the base object.

3.9.2 General information about script blocks

Principle of script blocks ● The class of a base object determines which script blocks the object has.

● A script block is executed if a specific event occurs on a derived object or the method of the script block is called from another script.

● Many script blocks are already implemented in the COMOS DB.

● You can write your own implementations. Name, input parameters, and return value of the script function are predefined. You write the instructions that are executed when the relevant event occurs.

Types of script block There are three types of script block:

1. Predefined script blocks for standard functions

They contain a method that is executed for standard functionalities, for example when connecting two connectors ("OnConnect"), or when setting a link ("OnImplementationSet").

2. UserScript blocks

Here you can implement your own methods.

3. Script block for parameters

The script block "ScriptBlockParameter" declares parameters which are available in all other script blocks.

Page 38: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.9 "Script" tab for base objects

System types - properties 38 Operating Manual, 04/2012, A5E03864967-01

Advantages of script blocks Splitting the methods implemented at the base object across several script blocks, instead combining them into one large script, has the following advantages:

● You can inherit specific scripts and expand them at lower levels, or implement new scripts. If an inherited script block is changed at a lower level, this does not disrupt the inheritance of other inherited script blocks.

● Increases the performance, because only individual script blocks have to be loaded, not a large composite script.

List of available scripts See also section Scripts at the CDevice (Page 125).

No user interfaces from scripts Avoid calling user interfaces from scripts (such as message boxes, progress bars). This can lead to problems when saving or undoing user settings in COMOS user interfaces.

3.9.3 User interface

Control elements You can see a table with all the script blocks which can be implemented at the base object.

Structure:

Column Description "Implemented" If you enter a script in the script editor, the option is activated automatically. "Functions" Name of the script block "..." The button opens the script block in the script editor.

See also The script editor (Page 39)

3.9.4 Script functions with return object Script functions that return an object require a return value.

In order to return no object, set "Nothing".

Page 39: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.9 "Script" tab for base objects

System types - properties Operating Manual, 04/2012, A5E03864967-01 39

3.9.5 The script editor

3.9.5.1 General

Purpose The script editor offers you the necessary tools to write small scripts quickly and without complications.

Availability The script editor is available at several points in COMOS, not just in the properties of the base objects.

3.9.5.2 User interface

Structure The script editor consists of the following areas:

● A toolbar

● A working area

Here you enter the script.

● A status bar

Line and position of the cursor in the working area

Toolbar Button Description

Opens the "Options" window.

Opens a txt or rtf file.

Saves the script as a txt or rtf file. If a file is saved as a txt file, all formatting is lost. If you enter the script into COMOS again, COMOS will detect the key words and format it correctly. If the script is opened in another word processing program, the txt file is unformatted, but the rtf file is formatted.

Opens the default printer window.

Cuts the selected text. Nothing is cut if the selection contains lines with keywords, since it is not permitted to change such lines. User-defined key words are cut out.

Copies the selected text.

Page 40: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.9 "Script" tab for base objects

System types - properties 40 Operating Manual, 04/2012, A5E03864967-01

Button Description

Corresponding to "Cut".

Corresponding to "Cut".

Opens a window to search and replace, or controls the search direction.

The selected lines are commented or uncommented.

Inserts or removes a tab at the start of the line.

Opens a window with programming help: "Script components" tab

To load a component into the working area, double click on the component. "Declarations" tab

– Contains a "COM Object Viewer". The "COM Object Viewer" lists all the properties and commands that are available within a component.

– "COMOS.dll " and "vbscript.dll" are offered by default. – When you drag a component from Windows Explorer to the tab, the

properties and commands for this component are also listed. – If you select a node in the structure tree, you can see its exact definition at

the bottom of the information area.

To load the definition or a part of the definition, select the text, press <Ctrl>, and use drag&drop to move the text to the working area of the script editor.

The "Options" window Control group Control element Description "Color" You can change the color by clicking on the color field. "Key word" color

field Default: RGB(0, 0, 128) = blue

"User defined key word" color field

Default: RGB(128, 128, 64) = brown

"Comment" color field

Default: RGB(0, 128, 64) = green

"Font" "Font" field The TrueType fonts of the operating system are available. "Size" field The font size Other control elements "Tabulator length" Defines how many characters constitute a tabulator shift. This

setting also effects tabs that have already been set.

Page 41: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.9 "Script" tab for base objects

System types - properties Operating Manual, 04/2012, A5E03864967-01 41

Control group Control element Description "Background

image" Sets the background image of the script editor.

"Shortcut" Here you can define shortcuts. Some shortcuts are reserved by the system and cannot be changed by the user.

See also Miscellaneous (Page 41)

3.9.5.3 Miscellaneous

Key words in script editor ● All lines beginning with a key word cannot be changed. Key words are defined by

COMOS, for example "Function" and "End Function".

● User-defined key words must be defined as text arrays using the "UserKeywords" method.

Example: RtfScript.UserKeywords = Array("DrawArc", "DrawCircle", "DrawLine", "DrawText")

Predefined shortcuts in the script editor The following shortcuts cannot be overwritten using the "Options" button:

Shortcut key Description <Ctrl+Alt+N> Deletes the code in the Script Editor. <Ctrl+Alt+P> Prints the code in the Script Editor. <Ctrl+Alt+B> Turns bold font on/off. <Ctrl+Alt+I> Turns italic font on/off. <Ctrl+Alt+U> Turns underscore on/off. <Ctrl+Alt+E> Inserts the "€" symbol. <Ctrl+Alt+M> Inserts the "µ" symbol. <Ctrl+Alt+Q> Inserts the "@" symbol.

3.9.5.4 Project object scripts You can define script blocks at the base object of the project, e.g. in order to extend the context menu using "OnMenuCreate".

The base object of the project is entered into the "Project structure" field under the "Links" tab as a project property.

Page 42: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.9 "Script" tab for base objects

System types - properties 42 Operating Manual, 04/2012, A5E03864967-01

3.9.5.5 Script error handling COMOS "Administrator > Script error handling" menu

The menu command activates the following: When a faulty script is executed, the script error is displayed in the Script Editor of the object. If necessary a project change is performed in the base project. The user can correct the script error in the Script Editor directly, or can query the properties of the object. In addition, the global variables can be queried.

3.9.6 Converting old data

Background In earlier COMOS versions, all script blocks were combined in a common script.

Procedure For each base object that does not activate any script blocks, proceed as follows:

1. Open the base object properties.

2. Click on the "Display" button on the "Script" tab.

You can see the "Script functions without block technique" window.

3. Click on the "Separate functions into blocks" button.

All script functions that are detected by the software are automatically separated into script blocks. The script blocks are activated.

4. Separate the remaining code of the overall script manually into the "UserScript" blocks until the "Script functions without block technique" window is empty. Only then does COMOS delete the overall script.

Note Disadvantages of continuing without conversion The advantages of the new technology remain unused. If you install a new COMOS version on an existing database which has not been

converted to the new technology, the performance will slow down.

Page 43: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.10 "Usage" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 43

3.10 "Usage" tab

Purpose The "Usage" tab allows you to discover which base objects or engineering objects use the base object.

Structure ● Upper area

Control elements for configuring the search parameters

● Lower area

Results list

Upper area ● "Access" control group

– "Direct" option activated

The results list contains only directly derived engineering or base objects.

– "Indirect" option activated

The results list also contains engineering or base objects which gain access to the inheritance chain via a base object link.

● "Objects considered" control group

– "Engineering objects" option activated

The results list contains only derived engineering objects.

– "Base objects" option activated

The results list contains only derived base objects.

● "Project" control group

– "Current" option activated

COMOS searches only the open project.

– "All" option is activated

COMOS searches all projects in the database.

Page 44: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.11 "Inheritance sources" tab

System types - properties 44 Operating Manual, 04/2012, A5E03864967-01

● "Search criteria" control group

You can display an attribute and its properties (value, unit, status) in the results list:

– "Tab" field

Select the tab.

– "Attribute" field

Select an attribute of the tab.

– The lists are locked if the base object has no attributes.

3.11 "Inheritance sources" tab

Purpose You can use the "Inheritance sources" to discover the base objects from which the base object attributes and properties were inherited.

Structure Location Description "Inheritance source" You can see a list of all sources from which the information was inherited by

this object. The base object appears at the top; the inheritance sources are listed under it in logical order.

Right area "Primary object" field

The object selected in the left-hand area "Secondary object" field

The base object Results list

The information difference between the primary object and the base object

Page 45: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.12 "Configuration" tab page

System types - properties Operating Manual, 04/2012, A5E03864967-01 45

Content of the results list The following data is evaluated during evaluation of the differences:

● Object properties (properties of the "System" and "Script" tabs)

If a property in one of the two objects is empty, the corresponding field remains empty. Inherited properties are empty.

● Assigned objects (attributes, connectors, elements, symbols)

– If an assigned object is not available for an object, three dashes are shown.

– Attributes that are connected to both objects are indicated by a black arrow which shows that the attributes are inherited and a white arrows which shows that they have been checked in.

The "OwnValue" of the attributes is displayed.

3.12 "Configuration" tab page

3.12.1 Purpose Using the "Configuration" tab, you can control which properties of the derived engineering objects and documents are visible.

3.12.2 User interface The "Configuration" tab has the following control elements:

"Inherit configuration" button

Adopts the settings from the inheritance source.

"Tab type" control group ● "In one line" option activated

The attribute tabs at the engineering object are displayed on the same level as the "Connectors" and "Elements" tabs.

● "Nested" option activated

The attribute tabs are collected together on the "Attributes" tab.

"Default components" table Here you can see the all tabs and components that are supplied with the COMOS DB.

Page 46: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.12 "Configuration" tab page

System types - properties 46 Operating Manual, 04/2012, A5E03864967-01

"Current components" table ● The configuration selected for the base object

● Default

– Blank

– COMOS uses a default setting.

Buttons with arrows Move the selected components between the "Current component" and "Default component" tables.

"User defined" control group ● "Prog-ID for user-defined component" field

Enter the name of a component which defines a user defined tab.

● Button with upwards arrow:

– Adds the user defined tab to the "Current components" list.

– Entries which already exist in the "Current components" list are deleted and must be assigned afresh.

● Button with downwards arrow:

Removes the selected component from the "Current components" list.

See also "Allowed links" control group (Page 27)

3.12.3 Configuring the display

Procedure 1. Select a tab or component from the list of specified components.

2. Click on the "->" button.

Result ● The tab or component is moved on to the list of current components.

● The derived objects continue to display only those tabs and input fields that are entered in the "Current components" list.

Page 47: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.12 "Configuration" tab page

System types - properties Operating Manual, 04/2012, A5E03864967-01 47

The components "General" and "General (up)" For both components the following applies:

● They have the following subordinate components:

– Base object link

This allows users to set or change the base object of an engineering object. Move it to the current components only if the user wishes to create free engineering objects in the engineering data.

– Further link types

Links which are deactivated on the "System settings" tab cannot be moved to the current components.

Links whose link type does not belong to the current components, but which are activated on the "System settings" tab, can still be created in the engineering object. The link fields are displayed only when setting the link.

● If you move the components, all subordinate components also moved. You can then move the subcomponents back individually.

The subcomponents of the component "General (up)" are displayed in a general area.

The subcomponents of the component "General" are displayed on the "General" tab. Use the subcomponent "Separator" to achieve visual separation between subcomponents. COMOS inserts a blank line.

Adopting or removing all components Use the buttons with the double arrows.

See also "Allowed links" control group (Page 27)

3.12.4 Behavior if the configuration is inconsistent

Fault sources ● If the display is configured incorrectly, fields and areas of the engineering objects that are

used may be hidden.

● An import can result in the importation of links which are not intended to be included in the manually configured user interface.

Page 48: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System type "CDevice" 3.12 "Configuration" tab page

System types - properties 48 Operating Manual, 04/2012, A5E03864967-01

Tracking errors COMOS still attempts to process the most important instances. If an engineering object has a link to an object of the following class on the "General" tab or in the general area, the corresponding edit fields are displayed and can be used even if they are subsequently excluded on the "Configuration" tab:

● unit

● location

● implementation

● alias

Page 49: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 49

"Connector" system type 44.1 User interface

Structure ● Edit fields for the properties

● If you open the window from the base data: A toolbar

● Standard buttons for saving and closing

Toolbar Button Description

Selects the connector in the navigator.

Selects the owner of the connector in the Navigator.

Creates a copy of the connector in parallel with the connector.

4.2 Properties

The properties of a connector Control element Description "Name" field The name of the connector

Must be unique in relation to the owner. Option "Label by owner" Relevant for terminals

There the label of the element is used also as the label of the contacts. Activated: The contact label ("Connector.Label") is adopted from the owner ("Device.Label"). For "Connector.FullLabel", all owners of the "Element" class are skipped.

"Label" field The visible label of the connector If the field is empty, the name is used. In some cases (e.g. with documents) the label is always displayed instead of the name.

Field "Description" Long designation Is visible in the Navigator.

Page 50: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Connector" system type 4.2 Properties

System types - properties 50 Operating Manual, 04/2012, A5E03864967-01

Control element Description "I/O" field Defines whether the I/O is an input, an output and whether it is

intrinsically safe. A different symbol in the engineering data is used for each entry.

"Type" field List of connector types: "EE/MCR"

Electrical connection "Single line"

Various areas of application "P&ID"

P&ID connection "Signal"

Signal connection (e.g. control voltage) "Function plan"

Connection in logical diagrams "Fluid"

Connection in hydraulic and pneumatic diagrams "Construction"

Connection for 3D pipe sections Only connectors of the same type can be connected.

"Subtype" List of subtypes, depending on the type Contains the entries which have been defined in the relevant "@Connection<type>" standard table in the system project. The subtype controls, e.g. how the connection is displayed at the connector concerned. You find more information on this topic in the "Reports - Basic Operation" manual, keyword "Connector-specific line types".

"Single line connector" field Visible only if the "Type" is "EE/I&C" Assigns the EE/I&C connector a single line connector. You can find more information on this topic in the "EI&C Administration" manual, keyword "Assign single line connector".

"Wire" field Displays by which wire a connector is joined with another connector. "Cable index" field The cable index is set automatically when two connectors are

connected by a wire. "Feed-through" field See also chapter Feed-throughs (Page 51). "Inheritance mode" field How the inheritance mode behaves in the case of elements, only for

connectors. See also chapter "Inheritance mode" control group (Page 25).

"Signal of owner" option Overwrites the signal transmission with the help of the connected counter connectors. Requirement: Signal tracking is switched on in the project properties. You can find more information on this topic in the "COMOS Administration" manual, keyword "Signal tracking group".

Button Some properties have a button which restores the inherited setting.

Page 51: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Connector" system type 4.3 Connecting connectors

System types - properties Operating Manual, 04/2012, A5E03864967-01 51

4.3 Connecting connectors ● Connectors are connected in the engineering data.

● You can preassign connectors as potentials in the base data. You can find more information on this topic in the "EI&C Administration" manual, keyword "Preassigning connectors with potential".

● Information about the counter connector is not stored in the properties of the connector. You find it in the Navigator and in the properties of the engineering object on the "Connectors" tab.

4.4 Effect of the implementation links Where an engineering object has an implementation link, the connectors are given information not only about the potential, signal, wire, and counter connector but also about the cross-section, color, and number.

4.5 Feed through connectors

Purpose Feed-throughs complement the signal tracking and potential tracking. For a connector, they permit users to define a connector or several connectors which are also to be given the information. Feed-throughs can be defined under any owner.

In a script, the feed-through is addressed via an "InternalConnection".

Syntax for entering feed-throughs Enter the name of the feed-through in the "Feed-through" field in the properties of a connector. Use the following syntax. It is based on the normal path information:

● Starting point

The owner of the connector for which the feed-through is set.

● Navigation

Command Description ".." One layer up "<Name>" Selects the named object or the connector. "|" (Pipe symbol) Separates the parts of the path name. ";" Separates multiple paths; only if multiple feed-throughs are entered.

Page 52: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Connector" system type 4.6 Preassigning connectors with wires, signals or logical potentials

System types - properties 52 Operating Manual, 04/2012, A5E03864967-01

Example ..|..|DevA|DevA1|CP1

With this path information, you would move up two levels, select object "DevA", then object "DevA1" underneath, and finally its "CP1" connector.

Script functions of the connectors ● "InternalConnectionsAsConnectors"

Returns a IComosDCollection with all feed-throughs.

● "InternalConnectionAsConnector"

Returns the first feed-through entered.

Specialty regarding terminals The following constants are available for "InternalConnection":

● InternalConnection_SeparateSignal:

– Value: "@SepS"

– The connection does not pass on signals.

● InternalConnection_SeparatePotential:

– Value: "@SepP"

– The connection does not pass on potentials.

If you assign both constants, the feed-through should separate signals and potentials. The separator may be freely chosen.

4.6 Preassigning connectors with wires, signals or logical potentials For many devices, the information on wires, signals or potentials of many connectors is already known in the base data. On the "Elements" tab you can preassign the connector as potential or signal.

You can find more information on this topic in the "EI&C Administration" manual, keyword "Preassigning connectors with potential".

Page 53: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 53

"Device" system type 55.1 User interface

Structure and content of the properties of an engineering object depend on the base object and can vary.

Structure ● A toolbar

● A general area

Optional. Its content can also appear on a "General" tab.

● Several sub-tabs

● Standard buttons for saving and closing the properties

See also User interface (Page 45)

5.2 Toolbar

Buttons on the toolbar Button Description

Opens a submenu with the same navigation commands as are available for the object in the Navigator.

Opens the properties of the owner. For engineering objects, this is deactivated directly under the project root.

Creates a copy of the engineering object in parallel with the engineering object. Links and attribute values are also copied.

For working with product data and device requests when special or unique production is required You can find more information on this topic in the "EI&C Administration" manual, keyword "Feedback-looped manufacturer device". Not available for all engineering objects.

Page 54: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.2 Toolbar

System types - properties 54 Operating Manual, 04/2012, A5E03864967-01

Button Description

Locks the object so that it cannot be changed any more, or releases it again. Whether a user can lock or release the object depends on the user's rights. Administrators are permitted to edit locked objects. If the "Attribute editable upon blocking of owner on engineering side" option is activated in the properties of the attribute on the "General" tab, the attribute can also be edited without administrator rights. See also "Attribute editable upon blocking of owner on engineering side" option (Page 93).

Only for the "Connectors", "Menu", and "Wires" tabs Opens a menu which governs the scheme used for sorting and filtering the table: "Scheme per object":

– Activated

The scheme saved for the object is loaded automatically. – Deactivated

The default scheme is used. "Load screen scheme > ... ":

– "Save"

Saves the current scheme for the object so that it can be reused at the object. – "Load"

Loads the saved scheme. – "Delete"

Deletes the scheme and uses the default scheme. "Document scheme"

Permits users to create the scheme as a list in a report. You can find more information on this topic in the "Reports - Basic Operation" manual, keyword "Document scheme".

- Buttons for filtering and sorting on the "Elements" and "Connectors" tabs.

Page 55: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.3 Area for general data

System types - properties Operating Manual, 04/2012, A5E03864967-01 55

5.3 Area for general data

Requirement Properties of the underlying base object, "Configuration" tab: The "General (up)" component counts among the current components.

Control elements The content of this area depends on the configuration of the base object. Possible control elements:

Control element Description "Name" field The name

Is generated automatically. Can be overwritten if the configuration of the base object allows it. The adjacent "Generate Name/Label automatically" button creates a new name.

"Label" field The label "Description" field The description

Appears in italics if it is inherited from the base object. "Folder" option Activated: The engineering object is a folder. It categorizes the lower-level

engineering objects. Folders are not taken into consideration in the overall labelling of an object. Users can search for specific folders in the list windows. If the "Folder" option for the base object is already activated, it cannot be deactivated at the engineering object.

"Alias" or "Original" fields

Link to the alias or original This is used to map one labeling system to another. You find more information on this topic in the "COMOS Administration" manual, keyword "Alias".

"Unit", "Position", "Function" or "Signal" fields "Location" field

Link to an engineering object of the corresponding class.

"Request" field Requirement: A request implements the object. Link to the request

"Implementation", "Target" or "Cable route" fields

Requirement: The object has the "Request" property. Link to the implementation or the target or the cable route

"Base object" field Link to the base object from which the engineering object was derived. <Object icon> Allows users to use drag&drop to move the engineering object to another

area, for example into the start field of a query.

If the user uses drag&drop to move an object into this field, a link field with a corresponding link is displayed. Works only if the general area is configured in such a way that the link fields are not visible from the start.

Page 56: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.4 Link fields

System types - properties 56 Operating Manual, 04/2012, A5E03864967-01

See also Link fields (Page 56)

5.4 Link fields

Basic state If the base object of the engineering object uses the COMOS DB default setting, no link fields are visible initially. They are displayed if a user moves an object with one of the permitted classes into the "Description" field or on to the drag&drop field.

Alternative configuration You can configure the properties so that the link fields are visible from the beginning.

In this case users must use the visible link fields.

See also Configuring the display (Page 46)

"Allowed links" control group (Page 27)

5.5 Tabs

5.5.1 "General" tab

Requirement Properties of the underlying base object, "Configuration" tab: The "General" component counts among the current components.

Content The content of the tab depends on how you have configured the base object. It can contain the same properties as the general area.

See also Area for general data (Page 55)

"Configuration" tab page (Page 45)

Page 57: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties Operating Manual, 04/2012, A5E03864967-01 57

5.5.2 "Attributes" tab for engineering objects

5.5.2.1 Overview

Purpose The tab contains attribute tabs which were defined at the base object.

Here the user specifies the engineering object in its engineering context, for example by entering manufacturer data or technical data.

Display mode of the attribute tabs There are two display modes for the attribute tabs of an engineering object:

● They are grouped together on the "Attributes" tab.

● They are displayed in a row with the other tabs. The "Attributes" tab is hidden.

You set the display mode at the base object on the "Configuration" tab in the "Tab type" control group.

See also "Attributes" tab for base objects (Page 30)

5.5.2.2 Working in list attributes

Select several cells Hold down the <Ctrl> key and keep the left mouse button pressed to drag a frame.

Copy and paste options ● Copy and paste from Excel to the list attribute, and vice versa

● Copy and paste within a list attribute and from one list attribute to another

You are informed if the copy area and paste area are not the same size. The data is pasted starting from the top left.

Page 58: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties 58 Operating Manual, 04/2012, A5E03864967-01

5.5.2.3 "Refresh values" menu command

Call Select the "Refresh values" context menu command in the attribute tab context menu.

Function Refreshes the values of all attributes of the tab.

Usage If an attribute is edited simultaneously or the properties of two dynamically linked attributes are open at the same time.

See also "Link" tab (Page 93)

5.5.2.4 "Copy tab data"/"Paste tab data" menu command

Call Select the "Copy tab data" menu command in the attribute tab context menu.

Select the "Paste tab data" menu command in the context menu of an attribute tab of the same name for another engineering object.

Requirement The source attributes and target attributes have the same name.

Function Copies all attribute values and the associated units of the tab (source attributes) and writes them to the attributes of the other tab (target attributes).

Note

COMOS copies the request data and the data for manufacturer devices.

Page 59: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties Operating Manual, 04/2012, A5E03864967-01 59

5.5.2.5 "Delete all data" menu command

Call Select the "Delete all data" menu command in the context menu of the attribute tab.

Function Deletes all entries that were deposited on the tab. Modified units are also reset to their defaults.

5.5.2.6 "Refresh static links..." menu command

Call From the context menu of the attribute tab, select one of the menu commands listed below.

Requirement The tab has linked attributes.

Function Menu command Description "Refresh static links on tab" The statically linked attributes of the visible tab are

refreshed. "Refresh static links for all tabs" The statically linked attributes of all tabs of the object

are refreshed. "Refresh static links for object ... >" Opens a submenu with all statically linked attributes.

The value of the attribute you selected is refreshed.

5.5.2.7 "Accept static links..." menu commands

Call From the context menu of the attribute tab, select one of the following commands:

● "Static link: Accept differences for object"

● "Static link: Always accept differences for object"

● "Static link: No longer accept differences for object"

Requirement The tab has linked attributes.

Page 60: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties 60 Operating Manual, 04/2012, A5E03864967-01

Function Menu command Description "Static link: Accept differences for object" Different values of the link source are marked as valid in

the status management, provided the specification of the link source does not change.

"Static link: Always accept differences for object"

Different values are marked as valid in the status management, even if the specification of the link source changes.

"Static link: No longer accept differences for object"

Revokes the two other commands.

Effect if the differences are accepted:

● The orange switching background is turned off if there is a deviation between the local value and the value of the linked attribute.

● The difference to the linked value is displayed in the tootip.

● The value is no longer marked as invalid in the status management.

● When the data is matched, the linked value is not accepted and the local value is retained.

5.5.2.8 Read mode If an object is "ReadOnly", the data can be only be read and not changed. An important area of application of the "ReadOnly" property is the COMOS viewing mode.

Users can however open text fields and lists so all entries can be read.

5.5.3 "Elements" tab for engineering objects

5.5.3.1 Overview

Content The "Elements" tab contains a table with the following objects:

● Inherited elements

The objects that were entered at the base object on the "Elements" tab

● Engineering data elements

All engineering objects that are in the structure tree directly under the engineering object.

Page 61: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties Operating Manual, 04/2012, A5E03864967-01 61

Purpose of the tab ● Gives users an overview of which elements the engineering object has and which ones

can be created.

● Users can create new elements via the context menu of the tab.

5.5.3.2 Context menu Depending on where users call the context menu, they will see other commands.

Context menu for engineering data elements The "Change base object" menu command enables users to assign a new base object to the selected element.

Menu commands in the context menu of inherited elements ● "Create"

Creates a new engineering object based on the selected element.

● "Create N"

Opens a window in which the user specifies how many new engineering objects to create on the basis of the selected element.

Menu commands in the context menu of the tab ● "New object (below master)"

Opens the properties of a new engineering object. After the user has set the properties and saved the object, a new engineering data element is created directly under the engineering object that was originally opened.

● "Paste"

Requirement: An engineering object was copied to the COMOS clipboard.

The object is created as an element under the master.

● "Sort by name"

Sorts the contents of the tab by name.

● "Sort by label"

Sorts the content of the tab by label.

● "Sort by description" context menu

Sorts the content of the tab by description.

Page 62: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties 62 Operating Manual, 04/2012, A5E03864967-01

5.5.4 "Connectors" tab on engineering objects

5.5.4.1 Overview

Content The "Connectors" tab contains a table with the following objects:

● The connectors of the engineering object

● The connectors of the engineering objects located under the engineering object

Note Filtering the display

The toolbar contains buttons which allow users to filter which connectors are displayed.

Purpose of the tab ● Users are given an overview of the connectors which the engineering object and its

subordinate engineering objects have.

● Users are given an overview of the most important properties of the connectors.

● Users can link connectors.

Page 63: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties Operating Manual, 04/2012, A5E03864967-01 63

5.5.4.2 Context menu

Note

The context menu can contain different commands, depending on the column.

List of the menu commands Menu command Description "Connect with" Requirement: An object was copied to the clipboard.

Provides the connectors of the object. "Connection > ..." Available only in the "Connected with" column.

Requirement: The connectors were linked via the Navigator or in the properties of the objects. If the connector was set in an interactive report, it must be disconnected in the report as well. "Disconnect"

Cuts the connection between two connectors. The wire information in the "via" field is likewise deleted.

"Disconnect (retain wires)"

Cuts the connection between two connectors. The wire information in the "via" field is retained.

"Disconnect (Keep wires at target)"

Cuts the connection between two connectors. The wire information in the "via" field is retained at the target object.

"Cut"

Cuts the counterpart connector, including the wire information. The counter connector can now be linked to another connector via the "Paste" menu command.

"Paste"

The connector is connected to the connector from the clipboard. "Wire > ..." Available only in the "via" column.

"Disconnect"

Deletes the information on the wire at the connector. "Cut"

Cuts the wire. The wire can be assigned to another connector via the "Paste" menu command.

"Paste"

Pastes the wire from the clipboard. "Create auxiliary connectors"

Creates auxiliary connectors for a connector. This allows users to attach multiple wires to a terminal. You can find more information on this topic in the "EI&C Administration" manual, keyword "Auxiliary connectors".

Page 64: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties 64 Operating Manual, 04/2012, A5E03864967-01

Menu command Description "Cross section" "Color" "Type info"

The corresponding details are allocated to a connection. To view the information in the table, the user must display the corresponding column.

"Columns > ..." "Reset"

Removes all filters and other modifications from the table. "<Column name>"

Displays the selected column. A check appears alongside the displayed columns. Selecting it again hides the column again.

"Navigate" Selects the column object in the Navigator. "Refresh" Refreshes the tab. "Properties" Opens the properties of the cell object.

5.5.5 "Wires" tab

5.5.5.1 Overview

Requirement Visible only when the underlying base objects have the following properties:

● Class "Device" and subclass "Cable"

● Class "Element", subclass "Wire"

Purpose The "Wire" tab contains a table listing all connectors (devices) connected with this cable. Users can edit the wires of the cable via the context menu for the table.

5.5.5.2 Context menu

Menu commands Menu command Description "Disconnect" Removes the wire from the connector and its counter connector. "Disconnect" Removes the wire and undoes the connection between two connectors. "Swap" Swaps two wires. "Reset for all columns"

Removes all filters and other modifications from the list window.

"Navigate" Selects the column object in the Navigator.

Page 65: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties Operating Manual, 04/2012, A5E03864967-01 65

Menu command Description "Cut" "Paste"

For cutting and pasting via the clipboard

"Refresh" Refreshes the tab. "Properties" Opens the properties of the column object.

5.5.5.3 Predetermined wires Connectors can be prepared in such a way that a cable/wire is already assigned to the engineering object when it is created.

You can find more information on this topic in the "EI&C Administration" manual, keyword "Preassigning connectors with potential".

5.5.5.4 Undetermined wires Undetermined wires can be defined for virtual elements. The name of the cable appears in the field, with a star as a wildcard for the wire.

Example: "@L.4 x 0.75.*"

Result in the engineering project

If the object is created in the engineering project, it contains a virtual "indicator" element. The indicator can be created using the "Create" or "Create N" menu command. The first free wire is automatically searched for and entered in the cable of the indicator.

5.5.6 "Strip" tab

Requirement The underlying base object has the class "Device" and the subclass "Terminal strip".

Purpose The "Strip" tab has a table with the terminals of the object. The table also shows the devices and cable which are used to connect the terminals internally and externally

Users can edit the data.

Page 66: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Device" system type 5.5 Tabs

System types - properties 66 Operating Manual, 04/2012, A5E03864967-01

5.5.7 "Status" tab

Purpose Users can manage the status of the engineering object by opening the "Status" tab.

User interface Control element Description <Name of the status> The description of the status base objects under "@System > @D

> @Status" "Status value" field List of possible status values configured at the status base object "Set" button Checks the status value and sets a status value:

If the value set by the user is valid, it is set recursively for the object and its subobjects.

If the check for the object or one of the subobjects returns a lower value, the lower value is set.

"Check" button Checks the status value. If the check for the object or one of the subobjects returns a lower value, the lower value is set.

You find more information on this topic in the "COMOS Administration" manual, keyword "Query-based status management" and "Object-based status management".

Page 67: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 67

"Document" system type 66.1 User interface

Structure ● A toolbar

● A general area

● Several sub-tabs

Toolbar Button Description

Selects the document in the Navigator.

Locks/unlocks the document properties. In the case of reports, users cannot edit opened reports. Administrators can makes changes nonetheless.

Displays or hides the "Base object" field in the general area.

General area Control element Description "Name" field Automatically generated

The field length is 256 characters. This allows you to address external files in deeply nested folders using the document object.

"Label" field The label "Description" field The description "Folder" option As with system type "Device". "Base object" field The base object on which the document is based Icon of the document Drag&drop field

As with system type "Device".

Page 68: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.2 "General" tab

System types - properties 68 Operating Manual, 04/2012, A5E03864967-01

6.2 "General" tab

Control elements Field Description "Type" Determines the document type (COMOS report, Word file, etc.)

Depending on the type, the user can work with the document immediately after the type has been set, or must first make further entries on the change tab.

Depending on the type, the document object is given a different icon. To use the document type of an external supplier, the corresponding

program must be installed. Example: Microsoft Word The list includes all document types that are managed in COMOS using

the "Administrator > Base data > Document types" menu. You find more information on this topic in the "Document Management" manual, keyword "Document types".

"Description 1" "Description 2"

For describing the document

"First page" The page number of the first page You find more information on this topic in the "Document Management" manual, keyword "Page numbering".

"Number of pages" The number of pages the document contains

Page 69: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.3 "Attributes" tab for documents

System types - properties Operating Manual, 04/2012, A5E03864967-01 69

Field Description "Mode" Only for documents that are located under a base object or a document

package Controls what happens to the document if the owner of the document - i.e.

the base object or the document package - is created in the engineering data: – "Virtual"

The document is not created immediately, but is available in the context menu.

If the document name ends in "?" or "*", it can be created as often as required. The names are generated using "Nextname".

Otherwise the document is available only once in the context menu, but it can still be created using script or copied manually. The names then have an underscore and a consecutive number.

– "Copy"

The document is created automatically in addition. It cannot be created again.

– "Base object only"

The document is not created. It is available only at the base object. – "Structure"

The document cannot be created in the engineering data. If the document is selected in the context menu, a submenu opens. If further documents are located under the document, they are offered in the submenu.

"Inheritance mode" Only for documents located under a base object "Active"

The document is inherited to the engineering object and to subobjects in the base data.

"Inactive"

Inheritance is switched off completely.

6.3 "Attributes" tab for documents As with system type "Device".

See also Overview (Page 57)

Page 70: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.4 Switch tab

System types - properties 70 Operating Manual, 04/2012, A5E03864967-01

6.4 Switch tab

6.4.1 Introduction The name and content of the change tab depend on the document type. As a rule, its name is the same as that of the document type.

The "Document package" and "Reference document" document types do not have a change tab.

6.4.2 User interface The following document types have the control elements described in this section on their change tab:

Group Document types "Office" All "Conval" All "Others" Adobe PDF

AutoCad Image document TIFF Text

"COMOS" EPLAN electric 8 JT Viewer Net Template Editor S7 Block Interface Sequence Designer document/Template document Smartsketch

Page 71: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.4 Switch tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 71

"Document" control group ● "Normal" option

Activated: COMOS creates a new, external document. There is no template. If you switch to one of the other two options, the external file is deleted.

● "File link" option

Activated: You see the "File name" field. Use the " ... " button to select a file from the file system. COMOS links the COMOS document to the file. There is no template.

If you switch to the "Normal" option, the linked file is retained.

● "Reference" option

Activated: You see the "Template" field. Use the " ... " button to select a COMOS document. COMOS sets a link to the document. The referenced document can be opened but not saved. If the user edits the document, the changes are not saved.

"Object = Owner" field Like the "Report object = Owner" field for evaluation reports.

Not available for the following document types:

● "Others" group:

– Image document

– TIFF

– Text

● "COMOS" group

Smartsketch

6.4.3 Properties for evaluation reports Evaluation reports are the basis for data sheets and lists. They have the "Report" change tab. It has the following control elements:

"Report template" field Link to the report template

The adjacent "..." button opens the "Select report template" window:

● "Base" option activated (default)

You can see the "CRp report templates" document group in the structure tree of the window. It must be located in the base project in the Navigator on the "Documents" tab, directly under the project root; it collects the report templates. If it does not exist, the project root is displayed.

Page 72: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.4 Switch tab

System types - properties 72 Operating Manual, 04/2012, A5E03864967-01

● "Current" option activated

You can view the objects that are located directly under the project root on the tabs of the Navigator in the current project.

Note

The "Select report template" window contains evaluation and interactive report templates. Users must take care to select a report template suitable for the report type.

"Report object = Owner" field ● Link to the report object

The report object is the basis from which all active and automatic functions of a report are executed. No document can exist without a report object.

● Default: The object under which the report is located

Can be overwritten if the functions of the report are to be executed by an object other than its owner. If the default has been overwritten, it can be restored by pressing the "Delete" button.

6.4.4 Properties in the case of interactive reports Interactive reports are the basis of diagrams and drawings. They have the "Report" change tab. It has the following control elements:

"Report template" and "Report object = Owner" fields See also section Properties for evaluation reports (Page 71).

Area for display of the assigned physical files Three instances of the document are saved for interactive reports:

● crp file

The working file

● bak file

The last saved version in each case before the current change

● tmp file

Is carried along during the working session. If the document is closed correctly, it is deleted.

If the crp file is defective, the tmp file and the bak file will still be available. They can be opened using the button "Open" alongside each one.

You find more information on this topic in the "COMOS Administration" manual, keyword "Matching documents".

Page 73: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.5 "Revisions" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 73

6.4.5 Properties for report templates (evaluation and interactive) Report templates for evaluation reports and interactive reports have the "Report template" change tab.

Control elements Control element Description "Template file" field The ready-to-use report template in the COMOS file system "Object = Owner" field The document group under which the report template is located

Corresponds to the report object of COMOS reports. "Edit" button Opens the template file in the report designer.

Further information You find more information on creating the template file in the "Reports - Basic Operation" manual, keyword "Basic operation Report Designer".

6.5 "Revisions" tab You find more information in the "Revisions" manual, keyword "'Revisions' tab".

Page 74: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Document" system type 6.5 "Revisions" tab

System types - properties 74 Operating Manual, 04/2012, A5E03864967-01

Page 75: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 75

"Specification" system type: Attribute tabs 77.1 Introduction

This section contains information on the attribute tabs required for carrying out work in the base data.

See also "Attributes" tab for base objects (Page 30)

"Attributes" tab for engineering objects (Page 57)

"Specification" system type: Attributes (Page 83)

7.2 Rights administration

"Base data" function rights In order to create attribute tabs or edit their properties, users require the "Base data" function rights. Administrators automatically have this right.

You find more information on this topic in the "Rights" manual, keyword "Base data function right".

7.3 Properties of an attribute tab

7.3.1 User interface

Structure ● A toolbar

● Several tabs

● Standard buttons for saving and closing

Page 76: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.3 Properties of an attribute tab

System types - properties 76 Operating Manual, 04/2012, A5E03864967-01

Toolbar Button Description

Selects the tab in the Navigator.

Selects the owner of the tab in the Navigator.

Creates a copy of the tab in parallel with the tab.

7.3.2 "General" tab

Control elements Field Description "Description" Optional

Any descriptive text "Name" Must be unique in relation to the base object. "Sort text" The sort text determines the order of the attribute tabs on the "Attributes" tab.

If some attribute tabs have sort text and others do not, the tabs with sort text are shown first. Attribute tabs without sort text are sorted by name.

"Catalog tab" You can set a link to a different attribute tab. The tab adopts all the data of the linked tab. In the Navigator you can see a text reference to the catalog tab.

"Inheritance mode" Corresponds to the inheritance mode for base objects. "Working area" The working area allocates the tab to an organizational area (e.g. process

technology, mounting, administration). Only users who are permitted to see this working area can also see the tab. You find more information on this topic in the "Rights" manual, keyword "Working areas".

See also "Inheritance mode" control group (Page 25)

7.3.3 "Script" tab On the "Script" tab you can implement UserScript blocks for the attribute tab, and you can define "ScriptBlockParameter" global variables in the script block.

The UserScript blocks can be called from other scripts.

See also The script editor (Page 39)

Page 77: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.3 Properties of an attribute tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 77

7.3.4 "Usage" tab

Requirement Only visible in the base data.

Purpose On the "Usage" tab you can find where the attribute tab is used.

User interface ● Upper area

Several control groups for configuring the search settings

● Middle area

The results list

● Lower area

For comparison of the tab with its uses

Upper area ● Options for the "Evaluation of" control group:

– "Base objects"

All base objects are evaluated.

– "Engineering objects"

All engineering objects are evaluated.

– "All"

All base objects and engineering objects are evaluated.

– "None"

Neither base objects nor engineering objects are evaluated. The results list contains only the results from the control group "Considereddocuments".

● Options for the control group "Considered documents".

– "Templates"

All objects that can be used as a document template are evaluated. These are the COMOS report templates and Office documents that can be used as templates for other documents.

– "Engineering"

All engineering documents are evaluated.

Page 78: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.3 Properties of an attribute tab

System types - properties 78 Operating Manual, 04/2012, A5E03864967-01

– "All"

Templates and engineering documents are evaluated.

– "None"

Neither "templates" nor "engineering documents" are evaluated. The results list contains only the results from the control group "Evaluation of".

● Options for the "Project" control group

– "Current"

The current project is evaluated.

– "All"

All projects are evaluated.

● "Display and evaluation including inherited objects" option

Activated: An object is included in the results list even if it only inherits the tab.

● "Search" and "Search at once" buttons

Start the search.

Lower area ● Left link field

– The tab whose properties are opened

– Set automatically

● Right link field

Select a tab from the results list in the middle area. The link is entered automatically on the tab.

● Results list

COMOS compares the tabs and attributes and displays the result in this list:

– "Value" column: The object that is to be compared - i.e. the tab or one of its attributes

– "Source" and "Target" column: The "OwnValue" of the object in the "Value" column.

– "Display details" context menu: Opens a window which places further properties of the compared objects the next to the "OwnValue".

Page 79: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.3 Properties of an attribute tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 79

7.3.5 "Help texts" tab

Purpose The "Help texts" tab allows you to define help texts for the attribute tab.

Call the help text ● The tab has the focus, and the user presses <F1>: A window containing the help text is

opened.

● The user hovers the mouse pointer over the header of the tab: A tooltip is displayed.

Properties of the tab Button Description "Language" The help texts can be maintained in multiple languages. Select a language.

You find more information on this topic in the "COMOS Administration" manual, section "Language management (localization)".

"Tooltip" The tooltip "Hyperlink" Hyperlink to a web page (syntax: "www.xy.com ") or to a PDF file managed in

COMOS. When <F1> is pressed, this is displayed instead of the help text. "Help (F1)" The help text

Requirements for using PDF files as a hyperlink ● Internet Explorer from Microsoft:

– Version 5.5 or higher

– "Tools > Internet Options > Advanced": option: Activate "Browser extensions from third parties"

● Adobe Reader: "Edit > Preferences > Internet":

– Version 7.0 or higher

– Activate the "Display PDF in browser" option

– "Internet Options > Security > Internet > Custom Level": "Run ActiveX control elements and plugins"

Page 80: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.4 Display within the properties of the system types

System types - properties 80 Operating Manual, 04/2012, A5E03864967-01

7.4 Display within the properties of the system types

7.4.1 Introduction Attribute tabs are used and displayed in the properties of objects of the system types "CDevice", "Device", and "Document".

The context menu that the attribute tab has on it and the appearance of its user interface depend on the following factors:

● Display mode

● Whether the call was for the context menu of the tab or for an attribute

7.4.2 Display modes

Requirements The properties of a base object are opened.

Working mode and design mode ● Design mode

– You can see a grid.

– You can create or edit further attribute tabs and attributes.

● Working mode:

– You see the default setting.

– You can change attribute values and units.

See also Creating an attribute (Page 106)

Setting display properties via the attribute tab (Page 107)

"Attributes" tab for documents (Page 69)

Creating an attribute tab (Page 82)

"Attributes" tab for engineering objects (Page 57)

Page 81: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.4 Display within the properties of the system types

System types - properties Operating Manual, 04/2012, A5E03864967-01 81

7.4.3 Context menu for the tab

Call Right-click on an empty location on the tab.

Context menu in design mode Menu command Description "Working mode" Changes all attribute tabs into working mode. "New > Attribute" Creates a new attribute and opens its properties. See also section

"Specification" system type: Attributes (Page 83). The attribute is inserted at the position on the tab at which the context menu was called.

"New > Tab" Creates a new tab and opens its properties. "Delete", "Cut", "Copy", "Paste"

If you delete a tab, all its attributes are deleted. You can paste the tab into another base object. It receives the same name or, if this has already been allocated, an automatically generated name.

"All attributes > In design mode"

Available only if the base object is located within the current project. Option activated: You can also edit inherited attributes. If you edit an inherited attribute, it is checked in and can be edited the next time even without using this menu command.

"All attributes > Show name", "... > Show description"

Specifies whether the tab displays the name or the description of the attributes. Default: "Show description" active

"Refresh" Standard functionality "Properties" Opens the properties of the tab.

Context menu in working mode "Design mode" menu command: Switches to the design mode. The content of the context menu changes.

See also Setting display properties via the attribute tab (Page 107)

Properties of an attribute tab (Page 75)

Page 82: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attribute tabs 7.5 Creating an attribute tab

System types - properties 82 Operating Manual, 04/2012, A5E03864967-01

7.5 Creating an attribute tab First create the tab, then the attributes.

Procedure 1. Open the base object properties.

2. Select the "Attributes" tab.

If attribute tabs already exist, you can see them on sub-tabs. Otherwise you will see a "General" sub-tab. There is no equivalent to this tab in the database.

3. Click on an empty position in a sub-tab and select "Design mode" in the context menu.

A grid is displayed on the "Attributes" tab.

4. Select "New > Tab" in the context menu.

The properties of the new tab are opened.

5. Set the properties and save your entries.

6. Save the base object.

See also Creating an attribute (Page 106)

Setting display properties via the attribute tab (Page 107)

Page 83: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 83

"Specification" system type: Attributes 88.1 Introduction

This section contains information on the attributes, which is required for performing work on the base data.

See also "Attributes" tab for base objects (Page 30)

"Attributes" tab for engineering objects (Page 57)

Display properties of attributes (Page 109)

Properties of list attributes (Page 119)

"Specification" system type: Attribute tabs (Page 75)

8.2 Rights administration

"Base data" function right In order to edit attributes or their properties, users require the "Base data" function right. Administrators automatically have this right.

A user without this function right may enter a value ("DisplayValue") or a unit ("Unit") and call the "Refresh values" menu command in the context menu.

You find more information on this topic in the "Rights" manual, keyword "Base data function right".

8.3 Opening the properties

Procedure 1. Open the base object properties.

2. Switch to the attribute tab on which the attribute is located.

3. Activate the Design mode.

4. Select the attribute and select the "Properties > Attribute" command in the context menu.

Page 84: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.4 User interface

System types - properties 84 Operating Manual, 04/2012, A5E03864967-01

Procedure for unplaced attributes 1. Select the attribute in the Navigator.

2. Select the "Properties > Attribute" command in the context menu.

8.4 User interface

Structure ● A toolbar

● Several tabs

● Standard buttons for saving and closing

Toolbar Button Description

Selects the attribute in the Navigator.

Selects the owner of the attribute in the Navigator (the tab).

Creates a copy of the attribute in parallel with the attribute.

Opens the window with the display properties of the attribute.

8.5 "General" tab

8.5.1 "Display type" field

Purpose ● The display type determines the display of the attribute.

The display properties are configured in a separate window. See also chapter Display properties of attributes (Page 109).

● The display type determines which script blocks the attribute has. See also chapter Scripts at the attribute (Page 151).

● Some types of display influence the link options on the "Link" tab. See also chapter "Link" tab (Page 93).

Page 85: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 85

The display types Display type Description "Description" A label.

Labeling text: The return value of the "OnShow" script block of the attribute, otherwise the value of the "Description" attribute property.

"Image selection" An image Permitted graphic formats: bmp files ico files cur files wmf files gif files jpeg files To enable usage as a background image, the "New" menu command is available in the context menu for attributes of this type.

"Checkbox" A checkbox. "File selection" Field which stores the name of a file and the path to it

The path specification is saved in relation to the COMOS document directory. If the file is located outside the COMOS document directory, the absolute path is saved. If you require the absolute path information instead of the relative path information in another script, use the following script: 'a is the attribute object st = a.Value" If InStr(st, ":") < 1 And InStr(st, "\\") < 1 Then st = a.Project.GetDocumentDirectory + "\" + st End If" output st

"Date" A field for selecting a date. "Edit: [Min Max]" Fields for entering a value range

COMOS stores the value range in the "XValues" and ignores the "Value". The "Type" field setting is fixed at "Number". No standard table can be assigned to the attribute.

"Edit: [Min Value Max]"

Similar to "Edit [Min Max]", but with automatic range checking for "Value" "Value" corresponds to the standard value of the attribute. If the condition "Min" <" Value" < "Max" is not satisfied, the edit fields are highlighted in orange. The range checking is performed even if the "Value" was adopted from a link source. When you assign a standard table, it is assigned to the "Value".

"Edit field" A field for user inputs (free choice of input, or restricted to selecting from a standard table)

"List" A table The list attribute consists of several nested attributes. See also chapter Properties of list attributes (Page 119). From the user's point of view it is operated similarly to Excel lists. See also chapter Working in list attributes (Page 57).

Page 86: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties 86 Operating Manual, 04/2012, A5E03864967-01

Display type Description "Memo field (ASCII)", "Memo field (RTF)"

A memo field without formatting options (ASCII format) or with (RTF format)

"Object query" A query The start object is always the owner of the attribute.

"Frames" A frame for visual grouping A frame can have a title. When you move the frame, all the attributes located completely within the frame are moved with it. Delete, cut, and copy are performed only for the frame. Attributes of this type have the "New" menu command in the context menu.

"Repeater" An attribute which generates a group of attributes with a common name syntax, and which governs access to it Using the buttons of the repeater allows you to control which of the attributes on the attribute tab are visible. Requirement: Name of the attributes managed through the repeater: "<Name prefix> +

<counter>" First counter: "001" The first attribute has already been created and placed on the attribute tab. You can define the name syntax and the number of attributes in the attribute display. See also chapter Repeater (Page 117).

"Button" A button In the "OnClick" script block you can define the actions that the button triggers.

"Signature" A field in which you can enter an electronic signature "Link" A field for setting a link

The link is saved in the "LinkObject" property, not in "Value".

"Excel interface" display type This display type is offered only if it is entered in the standard table with the name "OcxControls".

You can implement the same functionality via mapping tables for Excel. They are also referred to as "Link table External/Attribute".

Page 87: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 87

8.5.2 "Description", "Name", "Value" fields

Purpose Field Description "Description" Explanatory text "Name" Unique identifier to denote the attribute "Value" The "Value" of the attribute

May differ from the "DisplayValue". Manual input or restriction of the entry selection to the values in a standard table assigned in the "Standard table" field For numerical attributes COMOS removes the group delimiter before it sets the value. The "Type" field restricts the characters and types permitted for the value. This can contain a calculation formula. For additional information see the "COMOS Administration" manual, keyword "Calculation formula".

See also "Type" field (Page 89)

"Standard table" field (Page 90)

8.5.3 "Decimal digits" field

Purpose Specifies the number of displayed decimal places.

8.5.4 "Formatting digits" field

Purpose Defines the number of digits after which a number is rounded to zero.

Page 88: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties 88 Operating Manual, 04/2012, A5E03864967-01

8.5.5 "Format" field

Purpose ● "Date" display type: Here you can determine whether the date includes the time.

● Remaining display types: You can define a mask which must be complied with when entering the value. This functions in the same way as text masks for base objects.

See also Text masks (Page 18)

8.5.6 "Length" field

Purpose Limits the number of characters permitted for the input.

8.5.7 "Unit" field

Purpose If the attribute is assigned a unit, a field for the unit is displayed on the attribute tab alongside the edit field. The unit set there is assigned to the attribute value. If the unit changes, COMOS converts the value automatically.

See also Assigning units (Page 89)

Page 89: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 89

8.5.8 Assigning units

Requirement The "General" tab is visible in the attribute properties.

Procedure 1. Click the "..." button next to the "Unit" field.

The "Unit selection" window is displayed. You can see the units of the COMOS unit system.

2. In the "Project" control group you can use the "Current" and "Base" options to determine whether the units displayed are those managed in the base project or those managed in the current project.

If the system project has physical unit groups, see also the "System" entry.

3. Select a physical unit group in the "Groups" area.

In the "Units" area you can see all units in the group.

4. Optional: Select a unit in the "Units" area.

5. Specify in the "Return objects" area whether the object of the physical unit group or the unit will be returned when the unit of the attribute is queried by a script. This setting is not relevant for the user. You can always see a list in which you can change the current unit.

Result Only the units of the physical unit group are available for the attribute value. If you have set a unit, this is used as the default.

Further information You find more information on this topic in the "COMOS Administration" manual, keyword "Unit systems".

8.5.9 "Type" field

Purpose Restricts which types are permitted in the "Value" field. If the input in the "Value" field does not match the type, an error message is displayed.

Entries ● Number

● Text

Page 90: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties 90 Operating Manual, 04/2012, A5E03864967-01

● Alphanumeric

● Date

● Signature

The type depends on the selected "Unit". Examples:

● Unit = "Ampere" -> type = "Number"

● Unit = "Editor" -> type = "Text"

Note

Some display types have fixed templates in the "Type" field.

Example: "Edit" requires the type "Number".

8.5.10 "Standard table" field

Purpose If you assign a standard table to an attribute, the values that can be assigned to the attribute are restricted to the entries in the standard table. The "Combo box" option in the display properties is activated.

Only for display type "Edit field".

Local standard tables Button Description

The "Create local standard table" button creates a local standard table and assigns it.

The "Local standard table properties" button opens the properties of the local standard table.

8.5.11 "Working area" field

Purpose By setting a working area, you assign the attribute to an organizational area (e.g. process technology, mounting, administration). Only users who are allowed to see this working area can also see the attribute.

You find more information on this topic in the "Rights" manual, keyword "Working areas".

Page 91: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 91

8.5.12 "Edit mode" field

The edit modes Value Description "Editable - normal" No restrictions "Editable - high priority"

The edit field is displayed in red.

"Not editable" The attribute is locked. Administrators can edit it by opening its properties. "Not editable (value set by script)"

No user input can be performed. Only scripts can set the value.

"Editable - only on base data side"

The value can be set only in the base data.

"Editable - in base object tree in base project only"

The value can be set only in the base data in the base project.

"Instantiating" Like "Editable - normal", but the attribute can create instances. You find more information on this topic in the "COMOS Administration" manual, keyword "Instances".

"Instantiating and editable - only via script"

Like "Instantiating", but the value can be set only by a script.

"Hidden" The attribute is not visible in the engineering data. In the base data the attribute is visible to users with the "Base data" function right, and can be edited by them.

"Pure user interface with scripts"

Read access to the attribute is achieved via the "GetScriptValue" script block of the attribute; write access via "SetScriptValue". The attribute value is not saved in the database, it is always generated by "GetScriptValue". In a similar way, access to the unit is achieved via the script blocks "GetScriptUnit" and "SetScriptUnit". Here again the unit is not saved but is always is requested by "GetScriptUnit". The script blocks "GetScriptLinkObject" and "SetScriptLinkObject" are available for the "Link" display type. This is not practical for some display types such as "Edit: (Min, Value, Max)".

"Values in XML (limited functionality)"

The values of the attribute are saved in an XML string of the engineering object, not in a database field. You find more information on this topic in the "Interfaces" manual, keyword "Values in XML".

"Values in XML (limited functionality) - high priority"

This is a combination of "Values in XML (limited functionality)" and "Editable - high priority"

Page 92: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.5 "General" tab

System types - properties 92 Operating Manual, 04/2012, A5E03864967-01

Value Description "Values in XML (limited functionality) - value set by script"

This is a combination of "Values in XML (limited functionality)" and "Not editable (value set by script)"

Extended properties "Extended properties - high priority" "Extended properties - value set by script"

You can find additional information on this topic in the "COMOS Administration" manual, keyword "Use extended properties".

You can find additional information on this topic in the "COMOS Administration" manual, keyword "Instances (Reducing the object number)".

8.5.13 "Catalog attribute" field

Purpose If you set a link to another attribute here, the attribute adopts all the information of the catalog attribute. A text reference to the catalog attributes is displayed in the Navigator.

Note

If you set the link via the "..." button and a "@Y Attribute catalog" base object exists in the current project, only the attributes under this node are available to you for selection.

8.5.14 "Engineering object status" and "Engineering object status value" fields You find more information on this topic in the "COMOS Administration" manual, keyword "Object-based status management".

8.5.15 "Inheritance mode" field

Purpose Corresponds to the inheritance mode for base objects.

See also "Inheritance mode" control group (Page 25)

Page 93: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 93

8.5.16 "Attribute editable upon blocking of owner on engineering side" option When you enable this option, the attribute can be edited in the engineering project even without administrator rights, although it is locked. Attributes that inherit from this attribute can also be edited. See also chapter Toolbar (Page 53).

8.5.17 The "Base attribute" indicator Only for inherited attributes

Purpose Link to the inheritance source of the attribute.

8.6 "Link" tab

8.6.1 Introduction

Purpose of the "Link" tab Here you can link the attribute in the base data to another attribute (link source) link.

Principle ● The link is defined in the base data. It is evaluated in the engineering data.

● The linked attribute adopts the value ("Value") of the link source.

● Whether the value is applied automatically or only by the user depends on the exact link settings. See also section Value (Page 99).

● If the linked attribute uses a unit different to that of the link source, the value is converted.

● An attribute can be the link source for any number of linked attributes.

Displaying linked values The value adopted from the link source is shown in italics.

Page 94: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties 94 Operating Manual, 04/2012, A5E03864967-01

8.6.2 User interface

Properties Control group Control element Description - "Link type" field The basic algorithm on which the link is based

Depending on the link type, additional edit fields are displayed. They are dealt with in the sections on the link types.

- Button Next to the "Link type" field Pressing the "Delete link" button restores the inherited link settings.

"Link" Only for attributes with "Edit (Min Value Max)" and "Edit (Min,Max)" display types, if the settings "Static" or "Dynamic" were selected in the "Value" control group.

Option "Min/Val/Max"

Activated: "Value", minimum value, and maximum value have the same link settings. "Edit (Min,Max)" display type has no "Value".

"Separated" option Activated: "Value", minimum value, and maximum value each have their own link settings. Depending on which of these values you select in the adjacent list, COMOS loads or saves the link settings for this value. "Edit (Min,Max)" display type has no "Value".

"Value" Governs when the value is adopted. Some link types require certain inputs in this control group. Depending on which option you activate, further fields are displayed in addition to the control group. See also chapter Value (Page 99).

"Product data, request" Only for display types "Edit field" and "Edit (Min Max)" You can find more information on this topic in the "EI&C Administration" manual, keyword "Preparing attributes".

"Combination" option

Activated: The attribute is relevant to the product data.

"Operator" field Operator for selection of the manufacturer device "Script" value: The script block "CheckProductRequestValues" is executed.

"3D" "Mode" field "On" value: If the attribute is on the "GD" tab, it is marked as a

3D attribute.

See also "Attribute" field (Page 95)

The link types (Page 96)

Page 95: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 95

8.6.3 "Attribute" field

Purpose For definition of the link source

Availability Available only for the following link types:

● "Own object"

● "By linked object"

● "Owner"

● "By connector"

Notation ● "<Nested name>"

COMOS searches for this attribute in the object (target object) defined by the link type.

● "*"

COMOS searches the target object for an attribute with the same "Nested name".

● "<Tab name>.*"

COMOS searches the target object on this tab for an attribute with the same "Nested name".

● "<Nested name>#<Index>"

Access to a cell ("XValue") of a list attribute

No automatic checking COMOS does not check whether the link source at the target object exists. For all link types except "Own object", this is technically not feasible.

Note

Check whether the link source in the engineering data exists in the destination object.

Page 96: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties 96 Operating Manual, 04/2012, A5E03864967-01

Using the "Select attribute" window Clicking on the "..." button next to the "Attribute" field opens the "Select attribute" window. It contains a tree with all objects under the project root. If you select an attribute under a base object, COMOS transfers its "Nested name" into the "Attribute" field.

Note

The attribute selected in the window is not identical to the link source. The link source merely has the same "Nested name".

See also Access to cell values (XValues) (Page 124)

8.6.4 The link types

8.6.4.1 No link No link is used.

8.6.4.2 By own object

Principle For the "Own object" link type, the link source is under the same owner.

8.6.4.3 By owner

Principle For the "By owner" link type, COMOS searches for the owner of the engineering object or document under which the attribute is located and links the attribute with one of its attributes.

8.6.4.4 By linked object

Requirement The attribute entered in the "Attribute" field has the "Link" display type. It is under the same engineering object or document as the attribute that is to be linked. The engineering data must contain a link.

Page 97: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 97

Principle If the "By linked object" link type is selected, COMOS assesses which object is linked to the attribute entered in the "Attribute" field. It searches under this object for the attribute entered in the "Attribute name" field and uses this as the link source.

8.6.4.5 By <GetLinkedSpecification> and <GetDisplayValue> script functions

Principle For the "By script function <GetLinkedSpecification()>" and " ... <GetDisplayValue()>" link types, COMOS assesses the corresponding script block for the attribute on the "Script" tab:

● "GetLinkedSpecification()"

The script returns an object of the system type "Specification". This object is used as the link source.

● "GetDisplayValue()"

The script returns a string. It is saved as "DisplayValue".

No write access to the scripts If an attribute is linked via a script and a write access is made within this script, then this write access is carried out every time the attribute is evaluated by COMOS, for example in order to display it in the Navigator or on a tab.

Examples of write access:

● Setting a value

● Connecting two connectors.

Note

Write access in the script disrupts the revision. There is a mechanism within the revision that resets the revision under certain conditions after a change of data. Even if the same value is assigned, it constitutes a change of data.

Behavior of the "Edit (Min Value Max)" display type This display type has a "Value" and "XValues" and therefore has the script blocks "GetDisplayValue" and "GetDisplayXValue".

If "Edit (Min Value Max)" has the "By script function <GetDisplayValue()>" link type, COMOS evaluates both script blocks.

Page 98: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties 98 Operating Manual, 04/2012, A5E03864967-01

8.6.4.6 By connector

Requirement The owner of the attribute is an object of system type "Device".

Principle For the "By connector" link type, COMOS uses the connector entered in the "Connector name" field to assess which object is linked to the engineering object. It searches for the link source on this object.

Note No link via dynamic connectors

Do not create links via dynamic connectors. Their number and names are only determined in the engineering view.

Specifying several connectors If you enter multiple connectors in the "Connector name" field, COMOS performs the search algorithm successively for each connector until it finds an attribute with a matching name.

Notation for the "Connector name" field:

● Separator: Comma

● No wildcards

8.6.4.7 Via the Navigation assistant

Principle For the "Via navigation assistant" link type, you can determine the link source in the "Object navigation" field. To do this, use the navigation libraries for the navigation assistant. You find more information on this topic in the "Queries" manual, keyword "Navigation library"

If the link source is a list attribute, use the "Cell index" field to address a specific cell within the list.

See also Access to cell values (XValues) (Page 124)

Page 99: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 99

8.6.4.8 Via mapping table

Principle You can use the "Via mapping table" link type to link attributes in the engineering data. For this you use a mapping table.

You find more information on this topic in the "COMOS Administration" manual, keyword "Mapping table".

8.6.4.9 Via calculation formula

Principle You can use the "Via calculation formula" link type to link the attributes via a calculation formula.

You find more information on this topic in the "COMOS Administration" manual, keyword "Calculation formulas".

8.6.5 Value

8.6.5.1 Static value

Principle COMOS compares the "Value" of the linked attribute and the link source, and indicates any deviation by highlighting in orange the linked attribute in the properties of the engineering object (orange background). The attribute is marked as inconsistent in the status management of the engineering object.

The user can apply the value manually:

● Using the context menu of the attribute or tab, "Refresh ... static links" menu command

● By performing an action which is called by the "CalculateLinkedSpecifications" function of the attribute.

If the link source has no "Value", no value is applied. This is the case if a script sets the value and sets only the "DisplayValue".

Page 100: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties 100 Operating Manual, 04/2012, A5E03864967-01

"Value/range" control group Control element Description "Operator" field Select an operator. The value of the linked attribute and the link source are

identical if the expression "Own <Operator> Link" is evaluated as "True". "Script" entry: Calls the script block "CheckStaticLinkValue".

"Comparison only" option

Activated: The linked value is not applied. The link merely compares the values. All menu commands for applying linked values are deactivated in the context menu of the attribute at the engineering object.

"Apply unit" option ● Deactivated: COMOS applies the value of the link source, but not the unit. The value of

the link source is converted to the unit set at the attribute.

● Activated: COMOS applies the value and unit of the link source.

Considering an empty source value Project properties, "Options" tab, "Static link: Consider empty source values" option activated:

If the value of the link source is empty (not "0", but no value there at all) and a value is entered at the linked attribute, this is considered a deviation.

See also "Refresh values" menu command (Page 58)

"Copy tab data"/"Paste tab data" menu command (Page 58)

"Refresh static links..." menu command (Page 59)

"Accept static links..." menu commands (Page 59)

CheckStaticLinkValue (value1, value2) (Page 153)

8.6.5.2 Dynamic value

Principle The value of the link source is automatically applied.

If the link source has no "Value", no value is applied. This is the case if a script sets the value and sets only the "DisplayValue".

Page 101: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.6 "Link" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 101

"Always get linked value" option Value Description Activated Default

The attribute value cannot be edited. You always see the value of the link source. It is displayed in italics and with a gray background. The value is always updated if the attribute is used or newly displayed.

Deactivated COMOS shows the linked value first. The attribute value can be edited. If the manually entered value is deleted, the linked value is restored. In contrast to a static link: No orange background is switched on There are no menu commands for refreshing in the context menu

"Get linked value" option Can be activated only for the "By linked object" and "Via navigation assistant" link types.

Activated: If the link to the linked object is deleted, the attribute value is checked in.

"Accept unit on link" option Like the "Apply unit" option for static links.

8.6.5.3 Fully dynamic A fully dynamically linked attribute is also considered a "View attribute".

Principle The value is applied in the engineering data in both directions: Changes to the view attribute are applied to the original attribute (link source).

The value is refreshed after saving.

In the engineering data, the attribute applies the data of the link source, with the exception of the following properties:

● Name

● Description

● Display properties

● Information about the link

Purpose View attributes are used to make an attribute visible and accessible to users again at another location.

Example: A subset from a larger number of attributes is made visible on an additional tab.

Page 102: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.7 "Script" tab

System types - properties 102 Operating Manual, 04/2012, A5E03864967-01

8.7 "Script" tab

Purpose The "Script" tab allows you to manage the script blocks for the attribute.

Principle Like the script blocks for base objects.

The script blocks are executed when a specific event for the attribute occurs in the engineering data, or the method of the script block is called from another script.

See also Scripts at the attribute (Page 151)

Scripts at the base object (Page 125)

8.8 "Help texts" tab

Purpose Here you define help texts for the attribute. The help texts function in the same way as the help texts for the tabs.

Calling help texts ● The attribute has the focus, and the user presses <F1>.

A window containing the help text is opened.

● The user hovers the mouse pointer over the attribute.

A tooltip is displayed.

See also "Help texts" tab (Page 79)

Page 103: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.9 "Usage" tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 103

8.9 "Usage" tab

Purpose On the "Uses" tab, you can see where the attribute is used. This function is especially useful with catalog attributes.

Control groups Control group Control element Description "Evaluation of" "Base objects"

option Activated: Uses only displayed in the case of base objects.

"Engineering objects" option

Activated: Uses only displayed in the case of engineering objects.

"All" option Activated: Uses displayed in the case of both base objects and engineering objects.

"None" option Activated: Uses not displayed in the case of base objects or engineering objects.

"Considered documents". "Templates" option Activated: Uses only displayed in the case of report templates. "Engineering"

option Activated: Uses only displayed in the case of interactive and evaluation reports.

"All" option Activated: Uses displayed in the case of report templates, interactive reports, and evaluative reports.

"None" option Activated: Uses not displayed in the case of report templates, interactive reports or evaluation reports.

"Project" "Current" option Activated: The current project is searched. "All" option Activated: All projects are searched. - "Display and

evaluation including inherited objects" option

Activated: Uses arising by means of inheritance are also displayed.

Note "Current" option activated in engineering project

The search results contain no base objects from the base project, only local base objects.

Page 104: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.10 Attributes without an attribute tab

System types - properties 104 Operating Manual, 04/2012, A5E03864967-01

8.10 Attributes without an attribute tab

Attributes directly below the object Attributes can be created directly under an object:

● By importing

● If you create an attribute in the properties of an object before creating an attribute tab.

The attributes are displayed on the "General" tab in the properties of the object. There is no tab in the database. The attributes are located in the Navigator and in the database directly under the object.

Note

If you subsequently create an attribute tab, the attributes remain directly under the object.

● If you created the attribute in the Navigator directly under the object, for example by copying and pasting.

Note

The attribute is not displayed in the properties of the object.

Avoid such structures. They are very unclear.

See also Creating an attribute tab (Page 82)

8.11 Mandatory attributes

Principle An engineering object with mandatory attributes can be saved only when all mandatory attributes have been filled out.

Requirements for the use of mandatory attributes ● The base project contains the following base object:

– Path: "@System > @D > @ClassificationKeys > @KeyCode2 > MA"

– Class: "Data set"

● The base object of the engineering object has the functional classification "MA".

● Edit mode for mandatory attributes: "Editable - high priority" or "Values in XML - high priority"

Page 105: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.12 Displaying a user-defined information window in the case of an invalid value

System types - properties Operating Manual, 04/2012, A5E03864967-01 105

Color code You can configure mandatory attributes so that they are highlighted in color in the properties of engineering objects:

COMOS menu "Plugins > Basic > Define attribute color": Set the "Editable – high priority" entry.

See also "Classification" control group (Page 29)

"Edit mode" field (Page 91)

8.12 Displaying a user-defined information window in the case of an invalid value

Background When setting an attribute value, COMOS calls the attribute script block "IsValueValid". If the function returns "False", COMOS opens an information window.

You can implement "IsValueValid" so that the information window contains a text you have defined.

Procedure Implement the script block "IsValueValid" as follows:

● Set the variable "Workset.Globals.ShowSpecValueValidMsgBox" to "False".

● Check the new value.

● If the value is wrong, an information window with an appropriate text is called.

See also "Help texts" tab (Page 102)

IsValueValid (Page 162)

Page 106: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.13 Creating an attribute

System types - properties 106 Operating Manual, 04/2012, A5E03864967-01

8.13 Creating an attribute First create the tab, then the attributes.

Procedure 1. Open the base object properties.

2. Select an attribute tab on the "Attributes" tab.

3. Open the context menu on the tab and select the "Design mode" menu command.

4. Select the "New > Attribute" menu command in the context menu on the tab.

The properties of the new attribute open.

5. Set the properties and save your entries.

The attribute is inserted at the position on the tab where you opened the context menu.

6. Save the base object.

Copying an attribute The following options are available for making a copy of an attribute (source):

● Use the "New attribute" button on the toolbar in the source properties.

● Use the "Copy" and "Paste" menu commands in the context menu in the Navigator or in the design mode of the attribute tab.

● Drag an existing attribute (original) from the Navigator to the attribute tab. The tab must be in design mode.

If the original is in an attribute catalog, a link to the original will be set in the "Catalog attribute" field in the properties of the copy.

Note

An attribute is located in an attribute catalog if the "FullName" of the attribute contains the string "@Y".

See also Creating an attribute tab (Page 82)

Page 107: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.14 Setting display properties via the attribute tab

System types - properties Operating Manual, 04/2012, A5E03864967-01 107

8.14 Setting display properties via the attribute tab

Introduction You can configure the following display properties of an attribute not only in the display properties but also directly on the attribute tab:

● Position on the tab

● Scaling

Requirements ● Base object > Attribute tab > Design mode: Activated

● An attribute is placed on the attribute tab.

Scaling 1. Select the attribute.

Marks appear at the corners:

2. Hover the mouse cursor over a mark.

3. Drag the mark, keeping the left mouse button pressed.

The size of the attribute is scaled accordingly.

Moving 1. Select the attribute.

You can see the corner marks.

2. Hover the mouse pointer over the attribute.

3. Move the attribute using drag&drop to the desired location.

Page 108: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

"Specification" system type: Attributes 8.15 Context menu of the attribute on an attribute tab

System types - properties 108 Operating Manual, 04/2012, A5E03864967-01

8.15 Context menu of the attribute on an attribute tab To call the context menu of an attribute, right click on the attribute.

Context menu in design mode Menu command Description "Navigate" Selects the attribute in the Navigator. "Delete", "Cut", "Copy" Self-explanatory

You can paste the attribute onto another tab or into another base object. To use these menu commands on inherited attributes, you must first activate "All attributes > Design mode" in the context menu. The attribute is given the same name, or, if this has already been allocated, an automatically generated name.

"Copy format", "Paste format"

Apply the format of an attribute to another attribute.

"Generate tab index" Opens a window in which you can assign the index for the sequence of the <Tab> focus.

"Properties > Display of the attribute"

See also section Properties: Display of the attribute (Page 109).

"Properties > Attribute" See this chapter.

Context menu in working mode Default commands, depending on the display type of the attribute

Page 109: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 109

Display properties of attributes 99.1 Introduction

Purpose of the display type See also section "Display type" field (Page 84).

Display properties The display type determines which display properties the attribute has.

Management in the base data You can configure the display of the attribute in the base data in the "Display of the attribute" window.

The size and position of the attribute can also be configured on the attribute tab. See also section Setting display properties via the attribute tab (Page 107).

Opening the "Display of the attribute" window Select the attribute in the Navigator or in design mode on the attribute tab and select the "Properties > Display of the attribute" menu command in the context menu.

Controlling the display using a script Programmers can control the display of an attribute using a script by means of the "CtrlProperty" property of "Lib.SUI".

You find more information on this topic in the "Programming" manual, keyword "ControlProperties".

9.2 Description

The "Display of the attribute" window "A" button: Like the "File selection" display type.

See also File selection (Page 111)

Page 110: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.3 Image selection

System types - properties 110 Operating Manual, 04/2012, A5E03864967-01

9.3 Image selection

The "Display of the attribute" window Control group

Control element

Description

"File of the image selection" "…" button Determine the image file. "Display setting" Fields "Left",

"Right", "Top", "Bottom"

Determine the size and alignment of the image file. Enter a value and select from the following settings: "Percent"

Relates to the visible area of the tab. If the size of the tab changes, the image is scaled along with it.

"Lines"

The gap between the top left corner of the tab and the top left corner of the image in default lines

A default line corresponds to the height of the control element.

9.4 Checkbox

The "Display of the attribute" window Control group Control element Description "Alignment" Options "Right",

"Left" The alignment of the checkbox description

"'Properties of checkbox caption" "A" button Like the "File selection" display type.

Page 111: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.5 File selection

System types - properties Operating Manual, 04/2012, A5E03864967-01 111

9.5 File selection

The "Display of the attribute" window Control group Control element Description "Properties of file selection caption" "Length" field The description length as an integer or as a decimal

The remaining area is used for the file selection field and the buttons.

"A" button Opens a window in which you can select the following formatting for the description: Font Size Style Color

"Setting of the dialog display" "With file name"

option Activated: The user opens a file selection. Deactivated: The user opens a directory selection.

"File extension" field

Determines which file formats are displayed by default in the file selection window. Separate listing

Separate the file extensions with a semicolon. Shared listing

Separate the file extensions with a comma. Mixed listing

Separate the file extensions with parentheses.

Example: "(doc,html);jpg,png" the Word files and HTML files are listed together, and the files ending with jpg and png are listed separately.

Note

In the file selection window, the entry in the "File name" field has priority over the setting in the "File type" field.

For example, if you enter "*.crp" in the "File name" field, this entry is evaluated irrespective of what is entered in the "File type" field.

Page 112: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.6 Date

System types - properties 112 Operating Manual, 04/2012, A5E03864967-01

9.6 Date

The "Display of the attribute" window Control group Control element Description "Label settings" "Length" field "A" button

Like the "File selection" display type.

"Show button" "Current date"

option Activated: The date attribute features the "..." button with which the user can select the date.

"Delete" option Activated: The date attribute features the "Delete the entry" button. It deletes the date.

9.7 Edit: (Min Max) See also section Edit field (Page 112).

9.8 Edit: (Min Value Max) See also section Edit field (Page 112).

9.9 Edit field

The "Display of the attribute" window An attribute of the edit field type has several, partly optional, graphic components. The description (attribute title) and the edit field are always visible.

Control group Control element Description "Type of the edit field" "Text field" option Activated: The user sees an edit field. The values can be

freely entered. "Combo box"

option Activated: The user sees a list. The values available for selection are predefined. They originate, for instance, from a standard table.

"Editable combo box" option

Activated: Like "Combo box", but the users can also enter a value manually.

"Unit" Monitors the operation of the "Unit" field based on the properties of the attribute.

Page 113: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.9 Edit field

System types - properties Operating Manual, 04/2012, A5E03864967-01 113

Control group Control element Description "Fixed" option Activated: The units field in the user interface is locked. If

the unit is changed internally, the value is converted automatically.

Deactivated: The units field can be edited. Users see a list with the units defined via the attribute properties.

"Length" field The proportional length of the units field The length of the edit field is scaled accordingly. The length of the attribute title remains unchanged as long as the units field does not suppress the edit field. You can change the total length of the attribute in design mode. See also chapter Setting display properties via the attribute tab (Page 107).

"Local editing option of product data" For attributes relevant to product data, an additional info field is displayed for product instructions. The options of this control group govern when the field can be edited. You can find more information on this topic in the "EI&C Administration" manual, keyword "Preparing attributes".

"Not editable" option

Self-explanatory

"If engineering object is a 'Request'" option

Self-explanatory

"Always" Self-explanatory "Properties of attribute title" "Description/Name

" option Activated: The "Name length" field is displayed. The attribute is displayed on the attribute tab before the

description of the name.

"Description length" field

The proportional length of the description The length of the edit field is scaled accordingly. The length of the units field remains unchanged as long as the description does not suppress the edit field.

"Name length" field The proportional length of the name Visible only if the "Description/name" option is activated.

"A" button For setting the font color and font Like the "Description" display type.

"Filter standard table" "In base object

tree" option Activated: COMOS displays a button in the base data on the attribute tab with which you can filter which entries in the stored standard table are offered.

"Always" option Activated: The button is offered in the engineering data and the base data.

"Off" option Activated: No filtering function

Page 114: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.10 Excel interface

System types - properties 114 Operating Manual, 04/2012, A5E03864967-01

See also FillComboList (Combobox) (Page 155)

9.10 Excel interface

The "Display of the attribute" window Control element Description "File selection" option Activated: The user specifies an Excel file in the engineering data

via a file selection. Deactivated: The Excel file is set in the base data. The user can

open only this file. The file selection is not visible at the engineering object.

"Assignment" option Activated: The user assigns the attributes and Excel cells to each another. The Allocation window is opened when the Excel file is opened.

Deactivated: You specify the assignment in the base object. The allocation window is not opened in the engineering data.

"Edit Excel sheet" option Deactivated: Users cannot edit the Excel file within the engineering data.

"Calculate Excel sheet" option

Deactivated: Users cannot calculate the Excel file within the engineering data.

"Length of text field" field The proportional length for the description of the attribute. The remaining area is used for the file selection field and the buttons.

9.11 List See also chapter Properties of list attributes (Page 119).

Page 115: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.12 Memo field

System types - properties Operating Manual, 04/2012, A5E03864967-01 115

9.12 Memo field

The "Display of the attribute" window Control element Description "Scrollbar active" option Activates and deactivates the scrollbar. "Command button visible" option

Activates and deactivates the "..." button. The button opens the memo field in a separate window.

"Properties of attribute title" control group

The same control group as for the "Edit field" display type

See also Edit field (Page 112)

9.13 Memo field (RTF)

The "Display of the attribute" window The control elements function in the same way as the "Display setting" control group of the "Image selection" display type.

See also Image selection (Page 110)

9.14 Object query

The "Display of the attribute" window Control group Control element Description "Query settings" "Execute query

immediately" option

Activated: The query will be executed as soon as the attribute is accessed. Deactivated: The query remains blank until it is started using a script. The tab with the query is loaded more quickly. You can change the configuration of the query before starting via the script.

Page 116: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.15 Frame

System types - properties 116 Operating Manual, 04/2012, A5E03864967-01

Control group Control element Description Link field For setting the query. If the query is located in the engineering

data, it must be located under the owner of the attribute. Derive an engineering object from the base object which is the owner of the attribute, and create a query under the engineering object. You can then set this query in the display properties within the base data.

"Display setting" Like the "Image selection" display type.

See also Image selection (Page 110)

9.15 Frame

The "Display of the attribute" window Control group Control element Description "Properties of frame caption" "Title visible" option Activated: COMOS displays the text of the "Title" field

above the frame. "Title" field Edit field for the title "A" button Like the "Description" display type. "Frame type" Changes the appearance of the frame. "Normal" option Self-explanatory "Thick" option Self-explanatory

See also Description (Page 109)

Page 117: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.16 Repeater

System types - properties Operating Manual, 04/2012, A5E03864967-01 117

9.16 Repeater

The "Display of the attribute" window Control element Description "Name prefixes of the attributes"

The part of the name that comes before the counter

"Maximum amount of datasets"

Enter how many attributes the repeater manages. If your input is greater than the number of the attributes which satisfy the name syntax, COMOS creates copies of the first attribute: The counter in the name is incremented. The remaining properties are copied.

9.17 Button

The "Display of the attribute" window Control element Description Option "Always (independent from rights)"

Deactivated: Edit mode and rights are evaluated. The button is locked if necessary. Activated: The button is always executable. Purpose: Display of safety-relevant alarm messages which run independently of rights administration.

"A" button Like the "File selection" display type.

9.18 Signature

The "Display of the attribute" window "Label settings" control group:

Control element Description "Width" "A" button

Like the "File selection" display type.

Page 118: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Display properties of attributes 9.19 Link

System types - properties 118 Operating Manual, 04/2012, A5E03864967-01

9.19 Link

The "Display of the attribute" window Control group Control element Function "Properties of link caption" "Name/Description" option Displays the "Name length" field and displays the

name on the tab. "Description length" field Like the "width" field for the "File selection" display

type. "Name length" field The name length

Visible only if the "Name/Description" option is activated. Like the "Description length" field, but for the name.

"A" button Like the "File selection" display type. "Display" "Name of linked object"

option Activated: The name of the linked object is displayed.

"Description of the linked object" option

Activated: The description of the linked object is displayed.

"FullName of the linked object" option

Activated: The "SystemFullName" of the linked object is displayed.

"DisplayValue of the attribute" option

Activated: The "DisplayValue" of the attribute is displayed.

"Label of the linked object" option

Activated: The label of the linked object is displayed.

"Display" Like the "Description" display type.

Page 119: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 119

Properties of list attributes 1010.1 Introduction

Principle Tables are set up in COMOS by nesting the following attributes:

● A list attribute

– "List" display type

– Serves as a container.

● Dependent on the table alignment: Column attributes or line attributes

– One attribute per column or line

– Located in the Navigator under the list attribute.

– Their "XValues" save the cell values.

– Can be linked and can have script blocks.

– "Edit field" display type

Evaluated properties COMOS uses the following data from the list attribute properties:

● "Description"

Labels the table header (the top left field in the table).

● "Working area"

● "Catalog attribute"

● "Inheritance mode"

● "Help" tab: "Tooltip" and "Help (F1)" fields

COMOS takes the other settings from the display properties of the list attribute. Here you specify the following information:

● Number and properties of the column attributes or line attributes

● Other display properties of the table

Page 120: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Properties of list attributes 10.2 Display properties of lists

System types - properties 120 Operating Manual, 04/2012, A5E03864967-01

Alignment ● Horizontal (default)

– The list has column attributes. The column names are saved in the descriptions of the column attributes.

– You can assign line names. They are saved in the "XValues" of the list attribute.

● Vertical

– The list has line attributes. The line names are saved in the descriptions of the line attributes.

– You can assign column names. They are saved in the "XValues" of the list attribute.

Note

The following sections assume that the table is aligned horizontally.

10.2 Display properties of lists

10.2.1 "General" tab on lists

Purpose Here you can manage the column width, together with other properties which affect the entire list.

User interface Control element Description "Number of columns" label The total number of columns in a list

Corresponds to the number of the column attributes plus a column for the line headers. It is set by COMOS.

"Column" field Index number of the column whose width is displayed in the "Width of column" field The first column is the column with the line headers.

"<", ">" buttons Switch to the previous or following column. "Width of column" field The width of the selected column in the "Column" field

Unit of width: Twips Standard value: 1000 twips = 50 pixels = approx. 1.76 cm

"Compatibility mode COMOS 5.62" option

Do not activate this, otherwise malfunctions may occur.

Page 121: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Properties of list attributes 10.2 Display properties of lists

System types - properties Operating Manual, 04/2012, A5E03864967-01 121

Control element Description "Attributes as lines" option Activated: The list has a horizontal alignment (line attributes).

Deactivated (default): The list has a vertical alignment (column attributes).

"Scrollbar active" option Activated: COMOS displays a scrollbar as necessary. "Line display" control group "Fix" option Activated: Number of lines displayed, as specified by the

"Indices (values)" tab in the "Quantity" field. "Dynamic" option Activated: COMOS searches for the last line with cell values.

This line and all entries before this entry are displayed; the subsequent lines are not.

"Extend dynamically" option Activated: Like dynamic. COMOS additionally displays a blank line below the last line that has a cell value. This enables users to fill in additional lines dynamically.

10.2.2 "Attributes" tab on lists

Note

Entries on this tab are automatically written to the clipboard. If you close the "List properties" window by clicking on the "OK" button, they are loaded into the database.

Purpose Dependent on the alignment, you can manage the number and properties of the column attributes or line attributes here.

User interface Control element Description "Count" field The number of the column attributes

It is set by COMOS. "Index" field The index number of the column attribute whose data you can see on

the tab. All entries apply to this column attribute. The first column attribute has the index "0".

"<", ">" buttons Switch to the previous or following column attribute.

Page 122: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Properties of list attributes 10.2 Display properties of lists

System types - properties 122 Operating Manual, 04/2012, A5E03864967-01

Control element Description "Add" button Creates a new column attribute at the last index position. The tab

displays the data of the new column. Defaults for the new column: "Name" field: "Column<index number>" "Description" field: "Column<index number>" "Type" field: "Text"

"Paste" button Inserts a new column attribute behind the position displayed in the "Index" field. The tab displays the data of the new column. The index numbers of the following column attributes are incremented. Defaults: "Name" field: "Column00<index number>" "Description" field: "Column00<index number>" "Type" field: "Text"

"Remove" button Removes the column attribute. The index numbers of the following column attributes are adjusted.

"Link" button Opens the "Link" window. There you can define a link to another attribute for the entire column or for a column cell. "Link for" field: Select the column or a cell. Remaining fields: Like in the attribute properties, "Link" tab.

"Script" button For the definition of a script block Alternative access to the properties of the column attribute, "Script" tab

Multiple edit fields Alternative access to the properties of the column attribute, "General" tab

"Unit" field If you assign a unit to a column, then it is displayed in column header or line header.

The context menu of the column header or line header contains all units of the assigned physical unit group.

Users can change the unit using the context menu. The cell values are converted.

See also "General" tab on lists (Page 120)

"General" tab (Page 84)

"Link" tab (Page 93)

Page 123: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Properties of list attributes 10.2 Display properties of lists

System types - properties Operating Manual, 04/2012, A5E03864967-01 123

10.2.3 "Indices (values)" tab

Note

Entries on this tab are automatically written to the clipboard. If you close the "List properties" window by clicking on the "OK" button, they are loaded into the database.

Purpose ● Vertical alignment: Here you can manage the number and properties of the lines.

● Horizontal alignment: Here you can manage the number and properties of the columns.

User interface Control element Description "Count" field The number of lines

All column attributes have the same number of lines. "Description inactive" option

Activated: Vertical alignment: Hides the line headers. Horizontal alignment: Hides the column headers. Hides the list header in the top left of the list.

"Index" field The index number of the current line "<", ">" buttons Switch to the previous or following line. "Add" button Inserts a new line at the last index position.

Default for the "Description" field: "Line<counter>" "Remove" button Removes the current line. The index numbers of the following lines are

adjusted. "XValues" saved for this line are deleted.

"Description" field The line name of the line at the "Index" position

10.2.4 Moving column attributes or line attributes

Procedure 1. Open the display properties of the list attribute.

2. Change to the "Attributes" tab.

3. Press the ">" button to select the desired column.

4. Keep the <Shift> key pressed while using the "<" or ">" buttons to select the index number to which you wish to move the column.

Page 124: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Properties of list attributes 10.3 Limitations

System types - properties 124 Operating Manual, 04/2012, A5E03864967-01

Result The column is moved to the new index position. The index numbers of the other columns are adjusted.

10.3 Limitations List attributes can handle a maximum of 200 rows.

10.4 Access to cell values (XValues)

Notation <NestedName column attribute>#<Cell index>

The first "XValue" has the index "0".

Example "SYS.Test.Col1#1"

Access to the second "XValue" of the column attribute "Col1", which is located on the "SYS" tab under the "Test" list attribute

Page 125: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 125

Scripts at the base object 1111.1 Read-only scripts at the base object

Read-only scripts Read-only scripts do not set values. They can have a return value.

Base objects can have the following read-only scripts:

● "GetConnectorSpecification" script block

● "CheckStatus[1-13]" script block

● "OnMenuCreate" script block

● "OnCheck" script block

● "GetConnectorLabel" script block

● "Navigator text" script block

● "IsUnitValid" script block

● "IsLocationValid" script block

● "IsImplementationValid" script block

● "CheckDelete" script block

● "DeleteWarning" script block

● "OnSubMenuCreate" script block

● "IsDocumentCheckInAllowed" script block

● "IsReleaseAllowed" script block

● "CalcNextName" script block

● "IsLockAllowed" script block

● "IsRevisionAllowed" script block

● "OnEStampShow" script block

Page 126: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.2 General

System types - properties 126 Operating Manual, 04/2012, A5E03864967-01

11.2 General The sections for the script blocks are sorted alphabetically.

The trigger is listed for each script block:

● User interface

The script block is called if the user tampers with the data via the user interface.

Example: An attribute in the properties of an engineering object is changed on the attribute tab.

● COMOS

The location from which the script block is called does not matter.

See also "Script" tab for base objects (Page 37)

11.3 AddToGraficalParamater<Diagram_type>(Num)

Trigger User interface

If the "Graphical settings > ..." menu command is called in an interactive report for a placed object.

Purpose Expand the context menu of the object in an interactive report so that users can set attribute values using the "Graphical settings > ..." menu command, and thus show and hide additional graphics.

Not yet implemented for the ISO and FUP modules.

Requirements ● A standard table containing the graphics is assigned to the attributes assigned to the

array.

● A corresponding wildcard is prepared for the drawing type specified in the script block at the symbol of the object.

Page 127: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.4 BeforeCheck (checkObject)

System types - properties Operating Manual, 04/2012, A5E03864967-01 127

Implementation Dim AddToGraficalParameter<Diagram_type>(Num) AddToGraphicalParameter<Drawing type>(Num> = <Name_Tab>. <Name_Attribute>

● "<Diagram_type>":

The script applies to this drawing type. You can also specify a drawing type group.

If a script exists for a drawing type and its drawing type group, only the script for the drawing type is evaluated.

Examples:

– AddToGraphicalParameterRI applies to all drawing types which begin with "RI", i.e. "RI1", "RI2", "RI_FLUID".

– AddToGraphicalParameterRI1 applies only to drawing type "RI1".

● Create an array with "Num" elements.

● Use the index to assign each element an attribute of the current object. (The index starts with 0.

Result ● Attributes added to the array are incorporated into the context menu of the specified

drawing type.

● The user can use the context menu to set the values of the attributes. On the interactive report, the symbol of the object is extended with the additional graphic.

11.4 BeforeCheck (checkObject)

Trigger COMOS

Calling by "OnCheck"

Purpose Define the actions that are performed prior to "OnCheck".

Page 128: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.5 CalcNextName ()

System types - properties 128 Operating Manual, 04/2012, A5E03864967-01

11.5 CalcNextName ()

Trigger User interface

Engineering object property > "System" tab > "Generate Name/Label automatically" button

Purpose Generate a new name for the engineering object

Return value Type: String

The new name

11.6 CheckDelete (Object)

Trigger COMOS

Prior to deleting the object

Purpose Check whether it is permissible to delete the object.

Note

COMOS continues to run its own tests.

Return value Type: String

The transferred string is displayed in the error message. The object is not deleted.

If the return value is blank, the object is deleted.

Page 129: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.7 CheckStatus [1-13]

System types - properties Operating Manual, 04/2012, A5E03864967-01 129

11.7 CheckStatus [1-13] There is a function for each of the possible status types prepared in the status management: "CheckStatus1" reacts to Status 1, and so on.

Trigger User interface

Engineering object property > "Status" tab > "Check" or "Set" buttons

Purpose Overwrite the standard test for determining the object status.

Return value Type: Boolean

11.8 Connect (Connector)

Trigger COMOS

Immediately after connecting two connectors

Purpose Define actions to be performed after the connection.

11.9 CreateDocumentGroup (class document)

Trigger COMOS

On saving the document, before document referencing

Requirement The "Automatic referencing" project option is activated.

Page 130: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.10 DeleteWarning (Object)

System types - properties 130 Operating Manual, 04/2012, A5E03864967-01

Purpose Name matching is performed in the document group in which a document is referenced. The script block permits you to create a corresponding structure in the document groups so that the document group with the matching name will be found during automatic referencing.

11.10 DeleteWarning (Object)

Trigger COMOS

Prior to deleting an object

Purpose Define a warning message to be displayed before the object is deleted.

Return parameters Type: String

The warning message

11.11 DisConnect (Connector)

Trigger COMOS

● Immediately before disconnecting two connectors

● When reconnecting two connectors that are already connected

Purpose Define actions to be executed before the disconnection is performed.

Page 131: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.12 GetConnectorLabel (Connector)

System types - properties Operating Manual, 04/2012, A5E03864967-01 131

11.12 GetConnectorLabel (Connector)

Trigger COMOS

If the label is called.

Purpose Determine the label for the transferred connector.

Return parameters Type: String

The label

11.13 GetConnectorSpecification (Device, ConnectorName, SpecName)

Trigger COMOS

When accessing an attribute linked by a "By connector" link type

Purpose Is used to find the link source even if the name given to it in the link settings ("SpecName" parameter) differs from its actual name.

Return value Type: String

The name of the link source

See also Script functions with return object (Page 38)

Page 132: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.14 IsDocumentCheckInAllowed (Document, FileName)

System types - properties 132 Operating Manual, 04/2012, A5E03864967-01

11.14 IsDocumentCheckInAllowed (Document, FileName)

Trigger User interface

Before checking in a DVM document.

Availability Only for class "Document"

Purpose Check whether it is permissible to check in the document.

Return value Type: Boolean

11.15 IsImplementationValid (Device)

Availability "Document" system type and "Device" system type

Trigger COMOS

Before setting the link

Purpose Check the validity of the implementation link.

Note

COMOS continues to run its checks.

Return value Type: Boolean

Page 133: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.16 IsLocationValid (Device)

System types - properties Operating Manual, 04/2012, A5E03864967-01 133

11.16 IsLocationValid (Device)

Availability For "Document" and "Device" system types

Trigger COMOS

Purpose Check the validity of the location link.

Note

COMOS continues to run its checks.

Return value Type: Boolean

11.17 IsLockAllowed (Lock)

Trigger COMOS

Before locking or unlocking

E.g. after pressing the "Lock" and "Unlock" buttons in the object properties

Purpose Specify whether the user can lock or unlock the object.

Implementation Lock: Input parameter is "True".

Unlock: Input parameter is "False".

Return parameters Type: String

Page 134: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.18 IsReleaseAllowed

System types - properties 134 Operating Manual, 04/2012, A5E03864967-01

If you return a string, the object is neither locked nor unlocked.

See also OnLockDone (Lock) (Page 142)

11.18 IsReleaseAllowed

Availability Only at the base object of the working layers

Purpose You find more information on this topic in the "COMOS Administration" manual, keyword "IsReleaseAllowed".

11.19 IsRevisionAllowed (Document)

Availability Only for class "Document"

Trigger User interface

Before the start of the next revision

Purpose Check whether you are permitted to start a new revision.

Return value Type: String

The string transferred is displayed as warning message. The document is not revised.

If the return value is blank, the document is revised.

Page 135: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.20 IsUnitValid (Device)

System types - properties Operating Manual, 04/2012, A5E03864967-01 135

11.20 IsUnitValid (Device)

Availability "Document" system type and "Device" system type

Trigger COMOS

Before setting the link

Purpose Check the validity of the unit link.

Note

COMOS continues to run its checks.

Return value Type: Boolean

11.21 NavigatorText (Object)

Trigger User interface

Purpose Define a string which replaces the standard Navigator text. This allows you to create new texts for the existing entries in the context menu for the "New" menu command.

Note

Unless explicit provisions are made in the script block, all links are filtered out. Example: The base object link lacks the double arrow ">>" and the "FullName".

Return value Type: String

The new Navigator text

Page 136: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.22 OnCheck (Device, Modus)

System types - properties 136 Operating Manual, 04/2012, A5E03864967-01

11.22 OnCheck (Device, Modus)

Trigger COMOS

● When saving an object

● With a global test

● With an object test

Purpose Check whether it is permissible to save the object. Repair it if necessary.

"Device" input The engineering object for which the script block is executed

"Mode" input Determines whether the object is only to be checked or also repaired.

Mode:

● "0": Check

● "1": Repair

Checks The following checks are performed:

● Standard checks within COMOS:

– Name (unique)

– Label (unique)

– Creation mode

● All the checks that you have defined in the script block

Return value Type: String

● Check not passed: Return a string.

● Check successful: Blank return value

Use a message box to give the user a response message.

Page 137: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.23 OnCreateReferenceDocument ()

System types - properties Operating Manual, 04/2012, A5E03864967-01 137

11.23 OnCreateReferenceDocument ()

Requirements ● Project Properties > "Options > Documents" tab: Automatic referencing of documents is

activated.

● The required name syntax is maintained.

Trigger COMOS

When a document is automatically referenced in a document group.

Purpose Specify the actions executed during automatic referencing.

11.24 OnDocObjCreate (DocObj)

Trigger COMOS

When setting the link at the DocObject, e.g. by importing or placing an object on a report

Usage At base objects of documents which manage objects, e.g. interactive reports

Purpose Specify the actions to be performed when setting the link.

Page 138: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.25 OnDocObjDelete (DocObj)

System types - properties 138 Operating Manual, 04/2012, A5E03864967-01

11.25 OnDocObjDelete (DocObj)

Trigger COMOS

On deleting the link at the DocObj, for example because an object has been deleted by an interactive report

Usage At base objects of documents which manage objects, e.g. interactive reports

Purpose Specify the actions to be performed on deleting the link.

11.26 OnDocumentCheckIn (Document)

Availability Only for class "Document"

Trigger User interface

On checking in a DVM document according to script block "IsDocumentCheckInAllowed".

Purpose Specify the actions to be performed on checking in.

Example: Starting workflow, sending e-mails

11.27 OnDocumentCheckOut (Document)

Availability Only for class "Document"

Trigger User interface

Page 139: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.28 OnEditOk ()

System types - properties Operating Manual, 04/2012, A5E03864967-01 139

On checking out a DVM document

Purpose Specify the actions to be performed on checking out.

Example: Sending e-mails

11.28 OnEditOk ()

Trigger User interface

Press the "OK" or "Apply" buttons in the properties of the derived engineering object (MouseUp)

Purpose Specify the actions to be run after these buttons are pressed.

Return value Type: Integer

Values:

● "0"

No error text is output.

● Not equal to "0"

error text from standard table ('SCRIPT_ERRORS')

11.29 OnEStampCreate (ST, RevElm)

Availability Only for class "Document"

Trigger After generating a PDF revision file

Page 140: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.30 OnEStampShow (PdfStamper, Revision)

System types - properties 140 Operating Manual, 04/2012, A5E03864967-01

Purpose Determine which texts are to be written to the predefined eStamp wildcards. They are saved with the PDF file.

Procedure 1. Check out a document.

2. Define a wildcard in the document.

3. Assign a value to the wildcard in the script block.

Example:

PdfStamper.SubstituteValue "<Wildcard_Name>", "<Value>"

See also OnEStampShow (PdfStamper, Revision) (Page 140)

11.30 OnEStampShow (PdfStamper, Revision)

Availability Only for class "Document"

Trigger On opening a PDF revision file

Purpose Determine which texts are to be written to the predefined eStamp wildcards.

The texts are generated afresh each time and are not saved.

See also OnEStampCreate (ST, RevElm) (Page 139)

Page 141: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.31 OnImplementationSet (OldValue)

System types - properties Operating Manual, 04/2012, A5E03864967-01 141

11.31 OnImplementationSet (OldValue)

Trigger COMOS

After setting the implementation link

Purpose Define which actions are to run after the link is set.

Note

When you implement the script block, the COMOS-specific implementation function "Device.dll" is switched off. This also inhibits the mechanism that automatically replaces request objects. The "Implementation replaces objects" project option is no longer effective.

"OldValue" parameter Saves the link previously set. This is available only for the runtime of the script block.

See also Effect of the implementation links (Page 34)

11.32 OnLocationSet (OldValue)

Trigger After setting the location link

Purpose Define which actions are to run after the location link is set.

"OldValue" parameter Like for "OnImplementationSet" script block.

See also OnImplementationSet (OldValue) (Page 141)

Page 142: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.33 OnLockDone (Lock)

System types - properties 142 Operating Manual, 04/2012, A5E03864967-01

11.33 OnLockDone (Lock)

Trigger After locking or unlocking

Purpose Define which actions are to run after locking or unlocking.

See also IsLockAllowed (Lock) (Page 133)

11.34 OnMenuCreate (Popup, Context)

Trigger User interface

Before opening the context menu

Purpose Complement the context menu. All menu commands created here are generated before COMOS displays the context menu.

Implementation ● PopUp.Add "<Menu command>", "<Key>"

Creates a new menu command with a unique key at the highest menu level.

● Popup.OutputDebugString

Sends the entries (IDs) from the context menu to the DBMon.

● Popup.Delete "<Key>"

Deletes the menu command with this key.

● Popup.Disable "<Key>"

Deactivates the menu command with this key.

Page 143: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.35 OnMenuExecute (ID, Context)

System types - properties Operating Manual, 04/2012, A5E03864967-01 143

● To add a submenu, insert the character "<" before the key:

PopUp.Add "<Title_Submenu>", "><Key>"

Example: PopUp.Add "<Templates>", ">TEMPL"

● To add a menu command to a submenu, place the key of the submenu and the character "|" before the key of the menu command:

PopUp.Add "<Submenu_command", "<Key_submenu>|<Key>"

Example: PopUp.Add "<Your own>", "TEMPL|OWN"

Further information You can find more information on this topic in the "COMOS Administration" manual, keyword "Adapting context menus".

See also OnSubMenuCreate (Popup, ID, Context) (Page 147)

OnMenuExecute (ID, Context) (Page 143)

11.35 OnMenuExecute (ID, Context)

Trigger User interface

After selection of a menu command in the context menu.

Purpose Define actions to be run after calling the menu command.

"ID" parameter ● Type: String

● The key of the menu command

Further information You can find more information on this topic in the "COMOS Administration" manual, keyword "Adapting context menus".

Page 144: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.36 OnNotLongerReferencedByDevice (Device)

System types - properties 144 Operating Manual, 04/2012, A5E03864967-01

See also OnMenuCreate (Popup, Context) (Page 142)

OnSubMenuCreate (Popup, ID, Context) (Page 147)

11.36 OnNotLongerReferencedByDevice (Device)

Trigger COMOS

Immediately after deleting the base object link at the engineering object.

Purpose Define actions to be run after deleting the link.

11.37 OnProjectOpen (Project)

Trigger COMOS

After opening a project

Purpose Define actions to be run after opening.

Examples of application ● Checking access for the project.

Since "OnProjectOpen" does not recognize any formal shut down of COMOS, the COMOS script block should be locked after a negative access check so that the user can shut down COMOS manually and restart it.

● Logging login to the project.

A failed login cannot be logged.

Page 145: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.38 OnReferencedByDevice (Device)

System types - properties Operating Manual, 04/2012, A5E03864967-01 145

11.38 OnReferencedByDevice (Device)

Trigger COMOS

● Immediately after setting the base object link at the engineering object or document

● On copying the engineering object

Purpose Define actions to be run after setting the link.

11.39 OnReferencedByDocument (Document)

Trigger COMOS

● On setting the base object link at the document

● On copying the document

Purpose Define actions to be run on setting the link.

11.40 OnRelease

Availability Only at the base object of the working layers

Purpose You find more information on this topic in the "COMOS Administration" manual, keyword "Script".

Page 146: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.41 OnReleaseDone

System types - properties 146 Operating Manual, 04/2012, A5E03864967-01

11.41 OnReleaseDone

Availability Only at the base object of the working layers

Purpose You find more information on this topic in the "COMOS Administration" manual, keyword "Script".

11.42 OnRevision ()

Availability Only for class "Document"

Trigger User interface

When a new revision is created for a document.

Purpose Define actions to be run on creating the revision.

Alternative script block The script block "OnReferencedByDevice" of the revision base object and its underlying revision objects responds to the same event.

When creating a new revision, COMOS creates an object internally, which is not visible in the Navigator. The object is given a base object link to the prepared revision base objects.

Page 147: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.43 OnRevisionRelease (RevisionInfo)

System types - properties Operating Manual, 04/2012, A5E03864967-01 147

11.43 OnRevisionRelease (RevisionInfo)

Availability Only for class "Revision".

Trigger User interface

● On unlocking a document revision

● On unlocking a document group for all the documents in the group

Purpose Define the actions to be run on unlocking.

11.44 OnSubMenuCreate (Popup, ID, Context)

Trigger User interface

Before opening a submenu of the context menu

Purpose Create your own menu commands in the submenu. The menu commands are not generated until the submenu has been displayed.

See also OnMenuCreate (Popup, Context) (Page 142)

OnMenuExecute (ID, Context) (Page 143)

Page 148: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.45 OnUnitSet (OldValue)

System types - properties 148 Operating Manual, 04/2012, A5E03864967-01

11.45 OnUnitSet (OldValue)

Trigger After setting the unit link

Purpose Define which actions are to run after the unit link is set.

"OldValue" parameter Like for "OnImplementationSet" script block.

See also OnImplementationSet (OldValue) (Page 141)

11.46 RestoreRequest (Request)

Trigger COMOS

● On setting the implementation link for the first time

Input: "Nothing"

● On setting the implementation link again

Input: The "old" implementation link

● Restore request

Input: The implementation link

Purpose Define actions to be run on setting the link.

Page 149: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.47 UserScript [1-9]

System types - properties Operating Manual, 04/2012, A5E03864967-01 149

11.47 UserScript [1-9]

Trigger Manual call from another function

Example: "UserScript1" implements a "Test" function. The function is called via "CDevice.Scriptengine.Scriptobject.Test " from a DLL.

Purpose Blank for user-specific scripts.

Note

The script engine takes up computer processing power. For this reason, use the predefined script blocks if possible.

Page 150: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the base object 11.47 UserScript [1-9]

System types - properties 150 Operating Manual, 04/2012, A5E03864967-01

Page 151: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

System types - properties Operating Manual, 04/2012, A5E03864967-01 151

Scripts at the attribute 1212.1 Read-only scripts of attributes

Read-only scripts Read-only scripts do not set values. They can have a return value.

Attributes can have the following read-only scripts:

● ScriptBlockGetLinkedSpecification

● ScriptBlockGetDisplayValue

● ScriptBlockGetDisplayXValue

● ScriptBlockGetScriptValue

● ScriptBlockGetScriptUnit

● ScriptBlockFilterRow

● ScriptBlockFillComboList

● ScriptBlockCustomizeFileOpenDialog

● ScriptBlockGetLinkObject

● ScriptBlockGetRoot

● ScriptBlockCustomizeTree

● ScriptBlockExport

● ScriptBlockIsValueValid

● ScriptBlockIsLinkObjectValid

● ScriptBlockIsSignatureAllowed

● ScriptBlockGetScriptLinkObject

● ScriptBlockCheckProductRequestValues

● ScriptBlockCheckStaticLinkValues

12.2 General script blocks The following script blocks are always available, except in the edit mode "Graphical user interface with scripts":

● "OnChange ()"

● "IsValueValid (ValueStr)"

● "BeforeCheck (checkObject)"

Page 152: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.3 Display type-specific script blocks

System types - properties 152 Operating Manual, 04/2012, A5E03864967-01

Additional general script blocks If the attribute has the edit mode "Graphical user interface with scripts", the following general script blocks are also available:

● "GetScriptUnit"

● "GetScriptValue"

● "SetScriptUnit(Unit)"

● "SetScriptValue(Value)"

See also "Edit mode" field (Page 91)

12.3 Display type-specific script blocks Some script blocks are available only for the following display types:

Type of display 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18"Description" - - - - - - - - - - - - - - - - X - "Checkbox" - - - - X - X - - - - - X - - - - - "File selection" X - - - - - - - - - - - - - - - - - "Edit: (Min, Max)" - - X X X X X - - - - - - X X - - - "Edit: (Min, Value, Max)"

- - X X X X X - - - - - - X X - - -

"Edit field" - - X X X X X - - - - - - X X - - - "Memo field (ASCII)"

- - - - - X X - - - - - - - - - - -

"Object query" - - - - - - - - - - - - - - X - - - "Frames" - - - - - - - - - - - - - - - - X - "Button" - - - - - - - - - - - - X - - - - - "Signature" - - - - - - - - - - - X X - - - - - "Link" - X - - X - - X X X X - - - X X - X

Number Script block 1 "CustomizeFileOpenDialog" 2 "CustomizeTree" 3 "FillComboList" 4 "FilterRow" 5 "GetDisplayValue" 6 "GetDisplayXValue" 7 "GetLinkedSpecification"

Page 153: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 153

Number Script block 8 "GetLinkObject" 9 "GetRoot" 10 "GetScriptLinkObject" 11 "IsLinkObjectValid" 12 "IsSignatureAllowed" 13 "OnClick" 14 "OnChangeOther" 15 "OnEdit" 16 "OnLinkObjectSet" 17 "OnShow" 18 "SetScriptLinkObject"

12.4 Alphabetic reference of the script blocks

12.4.1 BeforeCheck (checkObject)

Trigger User interface

Before the attribute is saved.

Purpose Define actions to be run before saving.

12.4.2 CheckStaticLinkValue (value1, value2)

Requirement The attribute is linked statically and the "Script" entry is set as the comparison operator.

Trigger User interface

● Read access to the attribute

● After the write access, if the attribute loses the focus

Page 154: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 154 Operating Manual, 04/2012, A5E03864967-01

Purpose Compare the values transferred as parameters.

Return value Type: Boolean

12.4.3 CustomizeFileOpenDialog

Availability Only for display type "File Selection"

Trigger User interface

If the button for opening the file selection window is pressed.

Purpose The script block receives an MS object of the type "FileOpenDialog" as an input. You can preconfigure the setting of file selection window.

You find more information on this topic in the Microsoft Help.

Example Function CustomizeFileOpenDialog(FileOpenBox) FileOpenBox.Filter = "(*.bmp)|*.bmp|(*.exe)|*.exe|(*.zei)|*.zei|All files (*.*)|*.*" End Function

The list for the file type contains the following formats:

● bmp

● exe

● zei

● *.*

Page 155: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 155

12.4.4 CustomizeTree (Tree)

Availability Only for display type "Link"

Trigger User interface

If the button for opening the additional navigator is pressed.

Purpose Provides the Navigator properties ("functree.ocx"). You can configure the Navigator settings.

Example Display only base objects in the Navigator: Tree.DisableObject("Element") Tree.DisableObject("Document")

12.4.5 FillComboList (Combobox)

Availability For only the following display types:

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

Requirement The "Combo box" option in the display properties is activated.

Trigger User interface

On expanding the list

Page 156: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 156 Operating Manual, 04/2012, A5E03864967-01

Purpose Allows you to determine the content of the combo box. You have the following options:

● Filter entries of the assigned standard table

● Delete entries

● Make user entries permanently available in editable combo boxes:

Combobox.AddItem(<any text>)

12.4.6 FilterRow (StdTabItem)

Availability For only the following display types:

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

Requirement A standard table is assigned to the attribute.

Trigger User interface

On expanding the list

Purpose Filter which of the standard table entries are displayed on expanding the list.

12.4.7 GetDisplayValue ()

Availability For only the following display types:

● "Checkbox"

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

Page 157: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 157

Requirement Link type: "Via script: <GetDiyplayValue>"

Trigger COMOS

When the attribute is displayed. This is done by calling the "DisplayValue" method from the "COMOS.dll".

Purpose Determine the "DisplayValue" of the attribute.

Return value Type: String

The "DisplayValue"

12.4.8 GetDisplayXValue (Index)

Availability For only the following display types:

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

● "Memo field (ASCII)"

Requirement Link type: "Via script: <GetDiyplayValue>"

Trigger COMOS

When the attribute is displayed. This is done by calling the "DisplayXValue" method from the "COMOS.dll".

Purpose Determine the "DisplayXValue".

Page 158: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 158 Operating Manual, 04/2012, A5E03864967-01

Input The index number of the "DisplayXValue"

Return value ● Type: String

● The "DisplayXValue"

12.4.9 GetLinkedSpecification ()

Availability For only the following display types:

● "Checkbox"

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

● "Memo field (ASCII)"

Requirement Link type: "Via script: <GetLinkedSpecification>"

Trigger COMOS

When the attribute is displayed. This is done by calling the "DisplayValue" method.

Purpose Determine an attribute to be used as the link source.

Return value Type: Specification

The link source

See also Script functions with return object (Page 38)

Page 159: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 159

12.4.10 GetLinkObject (txt)

Availability Only for display type "Link"

Trigger User interface

If the link was entered via the keyboard and the link field loses the focus ("LostFocus").

Input Type: String

The text input

Purpose Define the linked object.

Return value The linked object

12.4.11 GetRoot ()

Availability Only for display type "Link"

Trigger User interface

The button to open the additional navigator has been pressed.

Purpose Define the root object of the additional navigator.

Return value The root object

Page 160: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 160 Operating Manual, 04/2012, A5E03864967-01

12.4.12 GetScriptLinkObject

Availability Only for display type "Link"

Requirement Edit mode: "Graphical user interface with scripts"

Trigger User interface

For read access to the link object, e.g. for display or evaluation of the attribute

Purpose Calculate the link object.

Return value The link object

See also Script functions with return object (Page 38)

12.4.13 GetScriptUnit ()

Requirement Edit mode: "Graphical user interface with scripts"

Trigger COMOS

For read access to the unit of the attribute, e.g. for display or evaluation of the attribute

Purpose Determine the unit of the attribute.

Page 161: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 161

Return value The unit

See also "Edit mode" field (Page 91)

12.4.14 GetScriptValue ()

Requirement Edit mode: "Graphical user interface with scripts"

Trigger COMOS

For read access to the unit of the attribute, e.g. for display or evaluation of the attribute

Purpose Calculate the attribute value.

Return value The attribute value

See also "Edit mode" field (Page 91)

12.4.15 Import (SpecOwner, ExelActiveWorkbook) Do not use the script block. Instead, use an action object or CDI.

See also Excel interface (Page 114)

Page 162: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 162 Operating Manual, 04/2012, A5E03864967-01

12.4.16 IsLinkobjectValid (object)

Availability Only for display type "Link"

Purpose Specify whether the input parameter is permitted as a link.

Return value Type: Boolean

12.4.17 IsSignatureAllowed (String)

Availability Only for display type "Signature"

Purpose Check whether the signature is permitted.

Return value Type: String

● Signature not permitted: Load an error text into the information window.

● Signature permitted: Blank return value

12.4.18 IsValueValid

Availability Not for the "Graphical user interface with scripts" edit mode

Page 163: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 163

Trigger COMOS

Before setting the "Value" or "XValue".

Note

In the case of attributes with display type "Edit: (Min, Max)" and "Edit: (Min, Value, Max)", "IsValueValid" is triggered for each of the edit fields.

Purpose Check whether the input is valid.

Return value Type: Boolean

Return value Result "False" COMOS opens a default information window or an information window with a

user-defined text. The old value is restored.

"True" The input is written to the "Value" or "XValue" The timestamp is changed.

See also General script blocks (Page 151)

Displaying a user-defined information window in the case of an invalid value (Page 105)

12.4.19 OnChange

Availability Not for the "Graphical user interface with scripts" edit mode

Trigger COMOS

● Immediately after setting the "Value", "XValue" or the unit

● "Link" display type: On setting "LinkObject"

Page 164: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 164 Operating Manual, 04/2012, A5E03864967-01

Purpose ● Extend standard tables automatically.

To do this, use the following command in the script block:

Workset.Lib.AddSpecValueToStdTable thisobj

● In the event of changes to the attribute, make changes to other objects.

12.4.20 OnChangeOther ()

Availability For only the following display types:

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

Trigger User interface

A user is working in the properties of a base object, engineering object or document or in bulk processing with the attribute tab on which the attribute is located. The user changes the value or the unit of another attribute on the same attribute tab, and the other attribute loses the focus.

Purpose Define which actions are to be run if other attributes are changed.

Special case To call "OnChangeOther" to change an attribute located on a different attribute tab, call the Workset.lib .OnChangeOther method in the "OnChange" script block.

First parameter: The owner of the attribute

Second parameter: "NestedName" of the attribute on the other tab

Page 165: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 165

12.4.21 OnClick ()

Availability For only the following display types:

● "Checkbox"

● "Button"

Trigger Activation of the checkbox or clicking the button ("MouseUp")

Purpose Define which actions are to be run after the "MouseUp".

12.4.22 OnEdit ()

Availability For only the following display types:

● "Edit: (Min, Max)"

● "Edit: (Min, Value, Max)"

● "Edit field"

● "Link"

Trigger User interface

● If a user edits the "Value" or "XValue" in the properties of the attribute owner, and the field loses the focus.

● For the "Link" display type: After setting the "LinkObject" property

Purpose Improve the user guidance

Similar functions ● "IsValueValid"

● "OnChange"

Page 166: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 166 Operating Manual, 04/2012, A5E03864967-01

12.4.23 OnLinkobjectSet (old value)

Availability Only for display type "Link"

Trigger Setting the link

Purpose Define actions to be run after setting the link.

"OldValue" parameter Like for the "OnImplementationSet" script block of a base object.

See also OnImplementationSet (OldValue) (Page 141)

12.4.24 OnShow ()

Availability Only for display type "Description"

Trigger User interface

When the attribute is displayed on the attribute tab.

Purpose Defines the label.

Output Type: String

Is used as a label.

Page 167: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties Operating Manual, 04/2012, A5E03864967-01 167

12.4.25 SetScriptLinkObject (LinkObject)

Availability Only for display type "Link"

Requirement Edit mode: "Graphical user interface with scripts"

Trigger COMOS

Write access to the attribute.

Input The user input

Purpose Modify the user input.

Note

The link is always determined by the "GetScriptLinkObject" script block.

12.4.26 SetScriptUnit (Unit)

Requirement Edit mode: "Graphical user interface with scripts"

Trigger COMOS

Write access to the unit of the attribute

Input The user input

Page 168: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.4 Alphabetic reference of the script blocks

System types - properties 168 Operating Manual, 04/2012, A5E03864967-01

Purpose Modify the user input.

Note

The unit of the attribute is always determined by the "GetScriptUnit" script block.

See also "Edit mode" field (Page 91)

12.4.27 SetScriptValue (Value)

Requirement Edit mode: "Graphical user interface with scripts"

Trigger COMOS

Write access to the attribute

Input The user input

Purpose Modify the user input.

Note

The attribute value is always calculated using the "GetScriptValue" script block.

See also "Edit mode" field (Page 91)

Page 169: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.5 Example script

System types - properties Operating Manual, 04/2012, A5E03864967-01 169

12.5 Example script

Labeling PLC addresses Sub OnChange() Prefix = Owner.Specifications.Item("Prefix").Value Set Dev = Owner.Owner Set Elms = Dev.Enobs("E") For I = 1 to Elms.Count Set Elm = Elms.item(I) If Elm.InheritStatus = "E" Then Elm.InheritCheckIn End If Elm.OwnLabel = Prefix + Value + "." + CStr(I - 1) Next End Sub

Allocating PLC addresses on the basis of a start number The following script belongs to an attribute with "Edit field" display type. The attribute belongs to the base object of the PLC card. Once a start address has been input or modified in the edit field of the attribute, the elements (the channels of the card) are given a new label. OnChange If Not IsNumeric(Value) Then Exit Sub Set Elements = Owner.Elements ' STOP For I = 1 to Elements.Count Set Element = Elements.Item(I) If Element.InheritStatus = "E" Then Element.InheritCheckIn End If Element.Label = Value + (I-1) Next End Sub

12.6 Script commands for attributes

GetControlProperty, SetControlProperty SetControlProperty (PropertyConst, vNewValue-String)

The properties of the SUI* controls can be controlled with "SetControlProperty". Call in the script:

● Set:

workset.lib.sui.CtrlProperty(PropertyConst, Spec) = xy"

● Read:

from = workset.lib.sui.CtrlProperty(PropertyConst, Spec)

ConvertPhysUnits (unit conversion)

Page 170: System types - properties · System types - properties COMOS Platform System types - properties Operating Manual 04/2012 A5E03864967-01 Trademarks 1 Introduction 2 System type "CDevice"

Scripts at the attribute 12.6 Script commands for attributes

System types - properties 170 Operating Manual, 04/2012, A5E03864967-01

This function achieves the same for an object as the "Unit conversion" plugIn. LIB.DLL: Function ConvertPhysUnits(ByVal ComosObj As IComosBaseObject, ByVal ToBritish As Boolean) As Boolean

The units of all attributes of "ComosObj" are converted (not only the OwnSpecifications), for ToBritish=True from metric to British, otherwise vice versa.