kollmorgen visualization builder visualization... · kollmorgenvisualizationbuilder|contents...

KollmorgenVisualizationBuilderUserGuide

EditionF,April 2017Kollmorgen Visualization Builder

Keep all manuals as a product component during the life span of the product.Pass all manuals to future users / owners of the product.

Revision Remarks

A, 07/2010 Preliminary edition

B, 05/2012 Added additional information about importing tags from KAS IDE

C, 06/2013 Updated for software revision 2.0-SP1

D, 04/2014 Updated for software revision 2.10-SP1

E, 11/2015 Updated for software revision 2.20

F, 04/2017 Updated for software revision 2.20-SP2

IMPORTANTNOTICE

Copyright© Kollmorgen™ 2013-2017.

Technical changeswhich improve theperformanceof thedevicemaybemadewithoutpriornotice!Printed in the United States of America. This document is the intellectual property of Kollmorgen™. All rights reserved. Nopart of this work may be reproduced in any form (by photocopying, microfilm or any other method) or stored, processed,copied or distributed by electronic means without the written permission of Kollmorgen™.

ky Kollmorgen | April 2017 2

Kollmorgen Visualization Builder | CONTENTS

1 TheConfigurationTool1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.1.1 Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.1.2 Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.1.3 System Requirements and Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.1.4 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.1.5 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.1.6 Configured Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.1.7 Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.1.8 File Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

2 WorkingwithProjects2.1 Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.1.1 Connecting to a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182.1.2 Designing a Screen Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182.1.3 Designing Additional Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.2 Optimizing Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.2.1 Communication Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.2.2 Communication Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212.2.3 Performance in the HMI-panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.3 Moving Objects with the Touch Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.3.1 Operate Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.4 Peripherals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.4.1 USB .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.4.2 Ethernet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.4.3 Memory Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

3 DevelopmentEnvironment3.1 Starting Kollmorgen Visualization Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

3.1.1 Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293.1.2 Opening a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313.1.3 Getting Familiar with Kollmorgen Visualization Builder . . . . . . . . . . . . . . . . . . . . . . . 313.1.4 Starting Kollmorgen Visualization Builder from the Command Line . . . . . . . . . . 343.1.5 File Menu .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.1.6 Quick Access Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383.1.7 Ribbon Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393.1.8 Additional Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

3.2 Desktop Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403.2.1 Screen View in Desktop Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413.2.2 Desktop View Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423.2.3 Positioning Windows .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473.2.4 Configuration Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3.3 Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513.3.1 Screen Name and Screen Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513.3.2 Background and Foreground Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523.3.3 Startup Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543.3.4 Screen Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543.3.5 Screen Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543.3.6 Popup Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543.3.7 Importing Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553.3.8 Screen Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563.3.9 Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

3.4 Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573.4.1 Handling Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

3.5 Navigation Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61



3.5.1 Screen Relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623.5.2 Add Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623.5.3 Links in the Navigation Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623.5.4 Navigation Overview .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

3.6 Project Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633.6.1 Project Explorer Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

3.7 Component Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683.7.1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683.7.2 Add and Use Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693.7.3 Component Library Window .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703.7.4 XAML Import into Kollmorgen Visualization Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

3.8 Property Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793.8.1 Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803.8.2 Toggling views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803.8.3 Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803.8.4 Copy Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

3.9 Object Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813.10 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813.11 Error List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823.12 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

4 Tags4.1 Adding Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

4.1.1 Removing Unused Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834.1.2 Importing Tags from the KAS IDE .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874.1.3 Basic Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874.1.4 Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884.1.5 Data Exchange .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884.1.6 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894.1.7 Adding Tags during Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904.1.8 Selecting Multiple Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

4.2 Tag Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904.3 Internal Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914.4 System Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924.5 Array Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

4.5.1 Array Tag Set Up .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954.6 Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964.7 Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964.8 Poll Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974.9 Station Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974.10 Index Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

4.10.1 Index Addressing Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004.10.2 Using Index Registers for Station Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

4.11 Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044.11.1 Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044.11.2 Using Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044.11.3 Library Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054.11.4 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

4.12 Tag Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064.13 Data Exchange .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064.14 Importing and Exporting Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

4.14.1 Handling Columns .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104.14.2 Saving the Import Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104.14.3 Tag Import Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111



4.14.4 Importing Tags from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144.15 Filtering Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154.16 Tag Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154.17 Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

4.17.1 Creating Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174.17.2 Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

5 Controller5.1 Adding a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

5.1.1 Notify Window .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1215.2 DEMO Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1215.3 External OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

5.3.1 OPC Classic Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225.3.2 OPC UA Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

5.4 Updating Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255.4.1 Updating Drivers from File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

5.5 Synchronizing the Controller Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255.6 Changing IP Address of a Connected Controller from the Command Line . . . . . . . . . . . 126

6 WebServer6.1 Web Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

6.1.1 Web Site Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1276.1.2 Login Form .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

6.2 Javascript SDK .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286.2.1 Javascript SDK Overview .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

6.3 Web Service API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386.3.1 RESTful Web Service API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386.3.2 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386.3.3 REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

7 Objects7.1 Blinking Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

7.1.1 Limitations for HMI-panel Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1457.2 Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1457.3 HMI Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

7.3.1 Action Menu Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1467.3.2 Alarm Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487.3.3 Analog Numeric Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487.3.4 Animated GIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507.3.5 Animated Label Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517.3.6 Audit Trail Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1527.3.7 Button Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1527.3.8 Circular Meter Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1557.3.9 Chart Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1577.3.10 Database Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1607.3.11 Digital Clock Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1607.3.12 Linear Meter Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1617.3.13 Multi Picture Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1627.3.14 Picture Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1637.3.15 Roller Panel Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1647.3.16 Slider Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1657.3.17 Tag Monitor Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1667.3.18 Text Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1677.3.19 Touch Combo Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1677.3.20 Touch List Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687.3.21 Trend Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169



7.4 Media Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1697.4.1 Media Player Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1707.4.2 PDF Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1717.4.3 Web Browser Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

7.5 Special Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737.5.1 Navigation List Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737.5.2 Screen Carousel Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

7.6 Debug Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1767.6.1 Alarm Distributor Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

7.7 Windows Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1777.7.1 Check Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1777.7.2 Combo Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1787.7.3 Group Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1797.7.4 List Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1797.7.5 Progress Bar Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1807.7.6 Radio Button Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1817.7.7 Text Box Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

7.8 Additional Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1837.8.1 Target Platform .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1837.8.2 Adding Controls to the Kollmorgen Visualization Builder Toolbox . . . . . . . . . . . . 1847.8.3 Default Controls and Installed Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

7.9 WPF Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1867.9.1 WPF User Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877.9.2 WPF Custom Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877.9.3 Creating a WPF User Control with Tag Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877.9.4 Creating a Windows Forms User Control for a controller Target . . . . . . . . . . . . . . 1897.9.5 Creating a Windows Forms User Control for a CE Target . . . . . . . . . . . . . . . . . . . . . 192

8 RibbonTabs8.1 Home Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

8.1.1 Clipboard Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968.1.2 Screen Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1978.1.3 Objects Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1978.1.4 Object Variations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1988.1.5 Font Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2018.1.6 Format Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2028.1.7 Tag/Security Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058.1.8 Name Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

8.2 Project Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2078.2.1 Run Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2078.2.2 Transfer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2088.2.3 Project Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

8.3 System Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208.3.1 Date, Time, and Region Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208.3.2 Buzzer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218.3.3 Backlight Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218.3.4 Serial Ports Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2228.3.5 Servers Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2228.3.6 Output Devices Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2258.3.7 Service Menu Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

8.4 Insert Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308.4.1 Functions Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

8.5 View Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2318.5.1 Windows Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231



8.6 Dynamics Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2318.6.1 Layout Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2328.6.2 Color Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2348.6.3 General Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

8.7 General Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2418.8 Actions Ribbon Tab .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

8.8.1 Click Action Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2428.8.2 Mouse Button Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2428.8.3 Function Key Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438.8.4 Value Changed Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438.8.5 Tags Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438.8.6 Focus Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448.8.7 Navigation Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448.8.8 Data Logger Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448.8.9 Alarm Server Action Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448.8.10 Action Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448.8.11 Script Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2488.8.12 Multiple Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

9 TrendViewer9.1 Defining Trend Viewer Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

9.1.1 Adding a Trend Viewer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2519.1.2 Trend Viewer Legend .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

9.2 Historical Mode in Trend Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25410 DataLogger

10.1 Data Logging Strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25510.1.1 Logging Based on Time Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25510.1.2 Logging Based on Changed Tag Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25510.1.3 Maximizing the Lifetime of the Storage Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

10.2 Adding a Data Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25610.2.1 General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25710.2.2 Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

11 Scheduler11.1 Scheduler Set Up .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

11.1.1 Adding a Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25812 Reports

12.1 Reports Template Set up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25912.1.1 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25912.1.2 Database Driven Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

12.2 Reports Set Up .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26012.3 Adding a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

13 RecipeManagement13.1 Recipe Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

13.1.1 Adding a Recipe Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26213.2 Recipes in the HMI panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

13.2.1 Loading Recipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26413.2.2 Saving Recipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26413.2.3 Creating Recipes in the HMI panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26413.2.4 Editing Recipes Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

13.3 Recipe Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26513.3.1 Recipe Export from an Operator Panel Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26613.3.2 Recipe Export from a controller Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

13.4 Recipe Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26713.4.1 Recipe Import to an Operator Panel Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268



13.4.2 Recipe Import to a controller Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26914 FunctionKeys

14.1 Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27014.2 Configuring Function Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

14.2.1 Function Key Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27014.2.2 Function Key Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27214.2.3 Momentary Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

15 AlarmManagement15.1 Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27415.2 Alarm Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

15.2.1 General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27515.2.2 Alarm Server Events and Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27615.2.3 Alarm Distribution Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

15.3 Alarm Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27815.4 Alarm Items .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

15.4.1 Exporting and Importing Alarm Items .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28015.5 Alarm Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

15.5.1 Defining Alarm Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28015.6 Actions and Events for Alarm Items and Alarm Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

15.6.1 Actions and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28115.6.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

15.7 Remote Alarm Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28215.7.1 Remote Alarm Server Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28215.7.2 Remote Alarm Server Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28215.7.3 Remote Alarm Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

15.8 Alarm Distributor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28415.8.1 Alarm Distribution Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28415.8.2 Adding an Alarm Distributor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28515.8.3 Configure Distribution Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

15.9 Alarm Distributor Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29215.10 Alarm Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

15.10.1 Buttons Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29315.10.2 Display Settings Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29415.10.3 Alarm Viewer Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

15.11 Alarm Management in Runtime .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29415.11.1 Alarm Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29415.11.2 Sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29515.11.3 Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29515.11.4 Play/Pause Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29515.11.5 Info Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29515.11.6 Modifying Alarm Distribution Settings in Runtime .. . . . . . . . . . . . . . . . . . . . . . . . . . 29615.11.7 Manage Alarms .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

16 SecurityManagement16.1 General Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

16.1.1 Password Rules Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29916.2 Security Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

16.2.1 Creating Security Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29916.3 Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

16.3.1 Logging In and Logging Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30116.4 Object Security and Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30116.5 Cyber Security Best Practice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

16.5.1 Web Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30216.5.2 FTP Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303



16.5.3 Remote Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30316.5.4 OPC UA Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30416.5.5 Project Transfer Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30416.5.6 Email (Alarm distributer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30416.5.7 Ethernet Printer Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30416.5.8 Password Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30416.5.9 Define Security Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30516.5.10 Service Menu Password Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30516.5.11 Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30516.5.12 Antivirus program .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

16.6 Physical Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30716.7 Open Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30716.8 Client ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

17 LanguageManagement17.1 Setting Up Multiple Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

17.1.1 Adding Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30917.2 System Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31117.3 User Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31217.4 Text ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

17.4.1 Text ID Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31317.5 Automatic Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31517.6 Exporting Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31717.7 Importing Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

18 Audit Trail18.1 Logging Strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32018.2 Using the Audit Trail Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

18.2.1 Audit Trail Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32118.3 Audit Trail Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32118.4 Audit Trail Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

18.4.1 Audit Trail Export from an HMI panel Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32318.4.2 Audit Trail Export from a controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

19 TextLibrary19.1 Connecting Objects to Text Library Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32519.2 Exporting and Importing Text Library Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

20 DatabaseExport20.1 Setting up Database Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

20.1.1 Database Export from HMI-panel Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32820.1.2 Database Export from controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

21 DatabaseCleanup22 HMIpanelSystemSoftware

22.1 Welcome Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33122.2 Service Menu .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

22.2.1 Service Menu in an Empty Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33122.2.2 Service Menu in AKI-CDA/AKI-CDB/AKI2G-CDA/AKI2G-CDB Panels . . . 33122.2.3 Service Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

22.3 HMI panel Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33222.3.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33322.3.2 Transfer Image .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

23 MultipleControllers23.1 Adding a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

23.1.1 Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33723.1.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338



24 Troubleshooting24.1 Trouble Installing Kollmorgen Visualization Builder on Windows 8.1 ..................33924.2 Project Build Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33924.3 Back Up Project Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33924.4 Invalid Names .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33924.5 Adobe Reader not Recognized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33924.6 Expression Cannot Be Found .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33924.7 Performance Issue Related to Graphics Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34024.8 Error Related to Third Party Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34024.9 Performance Issue When Navigating in Script Tree View .. . . . . . . . . . . . . . . . . . . . . . . . . . 340

Kollmorgen | April 2017 10

25 Appendix ...................................................................................................................347

Kollmorgen Visualization Builder | THE CONFIGURATION TOOL

1 THECONFIGURATIONTOOL1.1 Introduction

The Kollmorgen Visualization Builder software is used to configure HMI-panels and controlleroperated control applications, including applications for IPCs (Industrial PCs) from Kollmorgen.

Kollmorgen Visualization Builder contains all basic functions needed in an application. The functionsare tested and developed with customer needs and preferences in focus.

Pre-defined objects in Kollmorgen Visualization Builder can be used to create complete processimages, providing an overview of a complex application. You can customize the pre-defined objects orcreate objects of your own.

The help file assumes that the most recent versions of the system program (image) and KollmorgenVisualization Builder are used.

1.1.1 Controller

HMI panel HMI-panels can be connected to many types of automation equipment, such as PLCs,servos, and drives. Further on, the expression controller is used as a general term for the connectedequipment.

Related informationController

1.1.2 Tags

Data values in a controller are referred to as tags.

Tags may also belong to the system or be internal. A tag has a symbolic name and can be of differentdata types.

Objects connected to tags can change values in the controller, and tag values can be reflected bychanging object appearance in various ways. Objects in a screen will remain static until connected toa tag.

Related informationTags



1.1.3 SystemRequirementsandLimitations

KollmorgenVisualizationBuilder

KollmorgenVisualizationBuilderSystemRequirementsParameter Recommendation

RAM 2 GB

Processor 2 GHz or higher

Microsoft Windows 10

Microsoft Windows 8.1

Operating system

Microsoft Windows 7 SP1

Tier 2:

DirectX version: 9.0 or higher

Video RAM: 120MB or higher

Pixel shader: version level 2.0 or higher

Vertex shader: version level 2.0 or higher

Graphics card

Multitexture units: 4 or more

KollmorgenVisualizerRT

KollmorgenVisualizerRTSystemRequirementsParameter Recommendation

RAM 1 GB

Processor 1.3 GHz or higher

Microsoft Windows 10

Microsoft Windows 8.1

Operating system

Microsoft Windows 7 SP1

Tier 2:

DirectX version: 9.0 or higher

Video RAM: 120MB or higher

Pixel shader: version level 2.0 or higher

Vertex shader: version level 2.0 or higher

Graphics card

Multitexture units: 4 or more

Note:When user interface applications are running on a Kollmorgen HMI, ensure the USB hardware key, AKC-HMI-RK-xxx, is installed.



UpdatingKollmorgenVisualizerRT inanHMI-panel

Kollmorgen Visualizer RT is pre-loaded in every HMI-panel on delivery. If necessary, this could beupgraded to a newer version using the Image Loader application.

Related informationHMI panel System Software

SpecialRequirements forSomeObjects

For some objects to be included in the Kollmorgen Visualization Builder project, specific softwareversions are required. Simulation of the project on the development PC may also be limited for sometargets.

Object Minimumrequirement Simulationoncontroller target

Simulationonpaneltarget

Media Player Windows Media Player10

Supported Not supported

PDF Viewer Acrobat Reader 9 Supported Not supported

Web Browser Microsoft InternetExplorer 7


1.1.4 GettingStarted

Kollmorgen Visualization Builder is installed on a development PC, where projects are developed,designed and compiled. The project is then run in an HMI-panel or controller to observe and control acontroller (or a group of controllers).

Target

Kollmorgen Visualization Builder projects can be targeted for

• An HMI-panel from Kollmorgen• A controller (Industrial PC) from Kollmorgen• A standard PC with Microsoft Windows 7 SP1

To enhance readability, only HMI-panel will be mentioned sometimes, when all different targetsactually could be included.

The functions in Kollmorgen Visualization Builder depend on the model of HMI-panel used.

Some differences exist between the targets, for example:

Item Supportoncontroller target Support onHMI-panel targetMedia Player Supported

PDF Viewer Supported

Web Browser Supported

Not supported on AKI-CDA AKI2G-CDApanels



Item Supportoncontroller target Support onHMI-panel targetNavigation List Box Supported

Screen Carousel Supported

Drop down shadoweffect

Supported

Rounded corners onrectangle

Supported

Opacity Supported

Not supported on AKI-CDA / AKI-CDBAKI2G-CDA / AKI2G-CDB panels

Report Supported Reports containing charts and picturescan not be printed from an HMI-paneltarget

Dynamics All dynamic settings aresupported

Some dynamic settings are notsupported on AKI-CDA / AKI-CDBAKI2G-CDA / AKI2G-CDB panels,e.g. background color for button, trendviewer and meter, and min/max valuesfor meter

License

A project for an HMI-panel can be used without any restrictions imposed by licensing.

A limited number of controller tags are available for a standard controller project. The number of tagsis controlled by a USB hardware dongle.

The controllers from Kollmorgen are configured with a fixed limit of tags.

The number of used controller tags (including DEMO controller tags) is shown in the lower right of thedesktop. The figures will turn red if the number of used tags becomes greater than the number ofavailable tags.

There are no license restrictions for internal tags.



Note:The USB hardware dongle will not be detected when usingRemoteDesktopConnection in Windows to connectremotely.A third party VNC based remote connection is recommended when remote connections are required.

Related informationDEMO Controller

ProductRegistration

The first time Kollmorgen Visualization Builder is started, a registration dialog is displayed. Enteringthe registration key provides unlimited access to all program functionality and software updates.

Alternatively, select to continue using a trial version of the software. You may evaluate KollmorgenVisualization Builder with full functionality for 30 days. When the evaluation period has expired, it willstill be possible to use the software, but the functions in theRunandTransfergroups will be disabled.

ProjectSize

The project size is shown in the lower right of the desktop area when designing an HMI-panel project.The size was calculated at the latest validation.

1.1.5 Installation

When purchased as a part of Kollmorgen Automation Suite, KVB is installed automatically duringsetup.

When KVB is purchased as a standalone application, it can be downloaded fromwww.kollmorgen.com. After a 30 day evaluation period, the software must be registered.

The installation creates an icon for Kollmorgen Visualization Builder in the group named KollmorgenVisualization Builder.

Click onStart/All Programs/KollmorgenVisualizationBuilder /KollmorgenVisualizationBuilder to start Kollmorgen Visualization Builder.


http://www.kollmorgen.com/en-us/products/machine-controls/hmi/kollmorgen-visualization-builder/#tab3


Note:The Kollmorgen Visualization Builder must be installed on a development PC, an AKI-CDC target can not beused to develop projects.

1.1.6 ConfiguredFeatures

Kollmorgen Visualization Builder offers the possibility to add customer-specific features in theprogram. This is done through the use of registration keys that are entered after the KollmorgenVisualization Builder software installation has been done.

Related informationAbout

1.1.7 Project

The top folder for a specific application designed with Kollmorgen Visualization Builder is referred toas the project folder.

During runtime, project database files can be updated, for example with new recipes. This means thatto completely reproduce a project that has been in operation, it may be necessary to combine sourcefiles with files retrieved from the HMI-panel.

1.1.8 FileStructure

A project contains a set of files related to the functional and graphical design and a set of files related tothe runtime operation of the project, where the latter is compiled from the design files.

Project Folder

When a new project is created, a folder with the project name is created as the top-level container, theProject folder. The files that define the functional and graphical design reside in the top level of theproject folder. Other folders are created as a result of validation and build.

Symbols

Pictures that are used in projects are converted to .png files when the project is validated.

Pictures are resized to the largest static usage in any of the project screens, in order to save memoryspace in the panel. If a picture is enlarged in runtime using dynamics, the enlarged picture will havea lower effective resolution.

Project pictures are stored in theSymbols folder as a compressed folder named Symbols.zip.

Temp

TheTemp folder contains intermediate build files from project compilation.

TheTemp folder also includes theOutput folder. TheOutput folder contains all files needed to runthe project in the target. These files are copied to an HMI-panel when theDownload command isused. For a controller, theExportcommand is used to copy the necessary files to a USB stick to theruntime controller via a network connection.



Note:It is necessary to open ports in the firewall for the runtime controller application.

MovingDesignFiles

To move the project files needed for the design:

1. Create a new folder for the project design files.

2. Copy all single files (files not included in any folders) as well as all folders, except theTemp folder,in the project folder.

3. Paste the files in the new folder.

MovingApplicationProject

The runtime project can be downloaded to the HMI-panel using the transfer or export commands, butcan also be moved manually:

1. Create the new folder for the project files.

2. Copy theOutput folder.

3. Paste it in the new folder.

Database

The database used for Kollmorgen Visualization Builder projects is of SQLite type.

The contents of the database can be managed with third-party database management tools.Kollmorgen Visualization Builder includes a database viewer object that can be used to displaydatabase contents in runtime.

Some changes in the project will lead to data being lost when the updated project is downloaded to theHMI-panel. These changes include:

• Renaming a recipe• Changing the data type or name of a recipe's items or runtime data• Renaming a data logger• Changing the data type or name of a data logger's items

If none of the above changes are made, then all runtime data will be kept, even when switchingdatabase type.

A copy of the database can be made with theUploadDatabase command. Some of the databasescan be exported individually in csv, comma separated values, format using theDatabaseExportaction. If possible, it is recommended to use the Database Export action rather than the Back UpDatabase action.

Related informationDatabase Viewer Object

Download

Upload Database

Database Export


Kollmorgen Visualization Builder | WORKING WITH PROJECTS

2 WORKINGWITHPROJECTSThis section describes Kollmorgen Visualization Builder and explains how to work with a project for anHMI-panel.

In Kollmorgen Visualization Builder, ribbon tabs are used instead of menu commands. This reducesthe number of steps needed to design complex components, and also supplies an attractive userinterface.

Ribbon tabs are located in the top section of the tool window. Each ribbon tab holds one or severalcontrol groups. Each group contains a set of related controls. Controls are made to design screens,and to make settings for objects and controls in the project.

2.1 CreatingaProject

A project can be created according to the following sections, but the work process can be adapted andrearranged if needed.

2.1.1 Connecting toaController

Establishing communication between an HMI-panel and controller is necessary to allow operatorobservation and control. The larger the project is, the more important it is to ensure that there is asuitable communication design.

There is a built-in DEMO controller in Kollmorgen Visualization Builder. It can be used for test andsimulation purposes.

Related informationCommunication Design

DEMO Controller

2.1.2 DesigningaScreenSet

It is important to organize the application well and to consider which functions are necessary. Startwith an overall view and then work down to a detailed level.

A project contains a number of screens with objects that can exchange data with the controller.Screens can be arranged in hierarchies to achieve a structured application, or organized as sequencecontrols. When deciding which structure to use, consider how to best describe the process at handand how to simplify procedures for the machine operator.

The complete application, or parts of it, can be tested in the development environment beforedownloading it to the HMI-panel.

Related informationScreens

2.1.3 DesigningAdditional Functions

Alarms

Alarms are used to make the operator aware of events that require immediate action. An alarm is setwhen a certain condition is met. An alarm condition is designed as a logical evaluation of a tag value.Alarms can be divided into groups to create an order of priority.



Related informationAlarm Management

FunctionKeys

Function keys can be used to perform actions and execute scripts. This allows operator control of dataand screen functionality independent of which screen is active.

Related informationFunction Keys

MultipleLanguages

Translation of texts and system texts can be performed directly in the application, or via export to atext file to be translated in other software. The file is imported to the application after translation. Theapplication language can be changed in runtime, for example based on a tag value.

Note:Pre-translated system texts are provided with Kollmorgen Visualization Builder. These texts are adapted fora controller, which means that they contain more strings than what is available for panel targets. This resultsin warnings when importing the system texts to projects created for a panel, but these warnings can safelybe ignored.

Related informationLanguage Management

Security

Access to objects and actions in the project can be limited using security groups and user passwords.

Related informationSecurity Management

TextLibrary

With the text library function, text tables can be created, where values are linked to texts.

Related informationText Library

Audit Trail

The Audit Trail function allows tracking of operator actions.

Related informationAudit Trail



DataLogger

Data can be logged and saved to file. Bit, 16-bit, 32-bit and Real (Float) values can be logged. Beaware that logging of data consumes system resources and memory.

Related informationData Logger

Scheduler

Setting and resetting digital tags in relation to the real-time clock can be performed using a scheduler,in order to control events in the process at special calendar times.

Related informationScheduler

Recipes

Recipes are used to set or save a predefined group of tags in one operation.

Values can be predefined or collected from the controller, and then saved to a recipe in the HMI-panel.The operator can download the recipe at any time to the controller, which will start working with therecipe values. Recipe handling makes it possible to reuse large parameter sets, to improve efficiencyof time critical production where a change of products must be made quickly. Recipe files can becreated in the development project or with the HMI-panel.

Related informationRecipe Management

Reports

The reports function allows adding excel report templates to the project.

Related informationReports

2.2 OptimizingPerformance

The following section presents a couple of issues to consider in order to optimize the KollmorgenVisualization Builder project. Some parts are related to the communication driver; other parts concernCPU load and flash operations.

2.2.1 CommunicationPerformance

SignalTypes

Tags used for driver communication can be static or dynamic. These are updated in different manners.

StaticTags

Static tags are updated continuously, even if they are not currently shown on the panel display.



Additionally, the HMI-panel reads the following items continuously:

• Alarm tags• Data logger tags• Multiple languages tags• Controller tags with value change events

The communication time is not affected by the following:

• Alarm messages• Schedulers• Tags linked to function keys

DynamicTags

Dynamic tags are updated only when they are presented on the display. An analog numeric objectserves as an example of when a dynamic tag is used.

2.2.2 CommunicationDesign

This section describes how tags are read and how the reading can be optimized to make thecommunication between the HMI-panel and the controller fast and efficient.

KeepingTags inConsecutiveOrder

Define controller tags consecutively, for example M0.0-M11.7. If the tags are spread (e.g. I0.4, Q30.0,M45.3 etc.) a complete update will take longer time. The number of tags in each package depends onthe used driver and information about this can be found in the driver help file.

TagPackages

Tags to be transferred are not all transferred at the same time, but are grouped into packages. Thenumber of tags in each package depends on the driver for the controller.

To make communication as fast as possible the number of packages should be minimized.Consecutive tags require a minimum number of packages, but it is perhaps not always possible toprogram it this way. In such cases there is a “waste” between two tags.

Waste is the maximum distance between two tags that can be kept in the same package. The size ofthe waste depends on the driver used, and is included in the driver help file, e.g as in the table below:

Driver x Analogsignals Digital signals

Number of signals/package 29 124

Waste 20 0



Bit-AddressedWordsvs. RegularBitDevices

In most drivers it is better to use bit-addressed words than regular bit devices, since you can fit moredigital devices in one telegram when using bit-addressed words, than when using bit devices.

Example

Driver x Analogsignals Digital signals

Number of signals/package 29 124

Waste 20 0

This specific driver can have 29 analog devices or 124 digital devices in one telegram. If you usebit-addressed words in the selected driver, you can fit 464 (29 × 16) digital devices in one package.This is almost four times as many devices.

ASCIIStrings

ASCII strings are transmitted in separate telegrams, and having a large number of strings will affectthe communication performance negatively. If an ASCII string only has a small number of differentstring values, it may be a good idea to use the Text Library function in Kollmorgen Visualization Builderwith predetermined contents, thus minimizing impact on driver performance.


2.2.3 Performance in theHMI-panel

It is important to understand that due to the complex nature of a running system, there are severalthings that affects the overall performance. The following list gives some examples of things toconsider, when it is necessary to optimize the performance of the HMI-panel:

• Number of tags• Number of sampled tags in trend viewers and data logger• Number of alarms• Driver performance• Multiple drivers• Type of panel• Alarm list size• Size of pictures• Scripts

RecommendedLimits

In order to optimize performance, it is recommended to limit the number of items in the project. Therecommended limits depend on the type of panel, and are listed in the table below.

AKI-CDA/AKI2G-CDA

AKI-CDB/AKI2G-CDB

AKI-CDCcontroller

Tags 1000 2000 4000

Active Controllers 3 10 Unlimited



AKI-CDA/AKI2G-CDA

AKI-CDB/AKI2G-CDB

AKI-CDCcontroller

Dataloggers 10 25 50

Database Items 50 700 2000

Alarm Items 150 500 4000

Alarm Viewer Rows 100 200 400

Alarm Database Max. Rows 500 1000 4000

Screens 100 500 1000

Objects on Screen 150 400 500

Tags

Try to avoid keeping the tag constantly active. If scripts are used, then hooking up event handlers onvalue change event will also set the tag to be always active. Use the passive value change event whenpossible. The passive event will only trigger when the tag is active, and the tag can be deactivatedwhen it is not in use. When the tag is deactivated the passive event will remain idle until the tag isactivated.

The default setting in Kollmorgen Visualization Builder updates all tags every 500 ms. If some tagsmay be updated less often, it is possible to assign them to a poll group with a lower update interval. Pollgroups are configured in theTags configuration page.

Assign and configure poll-groups with care. High poll-interval frequency affects the performance.

Usage of the following properties on tags will reduce performance. The tag should not:

• be an array tag• be connected to more than one controller• be used in script mode• be a system tag• use data exchange



• use any of these properties:– Access Right (other than ReadWrite)– Offset– Gain– Read expression– Write expression– Non volatile– Index register– Log to audit trail

Screens

Optimizing screen update time minimizes CPU load and flash operations. This can make a significantdifference in graphic-intense projects that approach the limits of the panel’s capabilities.

Screen changes are carried out most efficiently through a show screen action, either on a functionkey or an object.

Screens with less content will in general load faster. Certain objects will take longer to load, such asan alarm viewer. If screens are frequently shown or used as a background, try to keep it as slim aspossible.

Caching of screens have a great impact on screen switching times. The more screens that can becached the more screens will load faster, hence it is preferred to keep RAM as low as possible to utilizeit for screen caching. Large screens will take up more memory when cached and will possibly preventsmaller and more frequently used screens from being cached. It is possible to prevent screens frombeing cached by setting itsCachedproperty to false. When utilized RAM reaches approximately85% the application will start to remove screens from the cache in order to avoid the application fromrunning low on memory. This implies that if the application utilize more than 85% without caching theapplication will not be able to cache any screens and therefore not experience faster screen switchingtimes.

TrendViewersandDataLoggers

Several trend viewers can show data from the same log item.

In order to optimize performance in the panel, it is strongly recommended to place all log items loggedon the same frequency/event in the same data logger or at least reduce the amount of data loggers.

Try to avoid having one data logger for each trend viewer.

Data logging in general have impact on the performance. Reconsider the data logger settings, thelog frequency and the amount of log items. Heavy data logging will increase the CPU usage and willinfluence performance across the whole application.

Data logging is queued up if more logging is done than the database can handle at the moment. Ifthe queue reaches a too high level, the warning “Data logging has too high load. Data might be lost.”is shown on the screen in the top left notifier window. If the queue reaches a critical level, there is arisk that the system will malfunction. If this happens, alarm and data logging are turned off, the errormessage “Data logging is overloaded. Data logging is now disabled.” is shown in the dialog and thesystem tagDatabaseErrorActive is set. The system tagDatabaseErrorMessage contains theerror message.

The system tag is not reset by the system. It is up to the user to reset it when the system error is takencare of.

Alarm and data logging are turned on again when the queue is below the critical level.



StorageMedia

If the storage media reaches a critically low level, there is a risk that the system will malfunction. If thishappens, alarm and data logging is turned off. The error message “99% of disk used. Alarm logging isnow disabled. Data logging is now disabled.” is shown and the system tagDatabaseErrorActive isset. The system tagDatabaseErrorMessage contains the error message.

The system tag is never reset by the system. It is up to the user to reset it when the system error istaken care of.

Alarm and data logging are turned on again when the storage usage is below the critical level.

You can avoid this situation by using theMaxSize setting for the database. When the limit is reachedyou will be informed by a warning message.

Database

If there is a risk of the database running out of storage media, then a warning is shown on the screen. Ifthe usage reaches a critical level, risking the system to crash, alarm and data logging is turned off, anerror message is shown and the system tagDatabaseErrorActive is set. The system tagDatabaseErrorMessage contains the error message. Alarm and data logging are turned on again when thestorage usage is below the critical level.

Gradients

Using objects with gradients creates a slightly higher load on the CPU. If a large number of objects usegradients, this will make the screen update time significantly slower. Pay special attention to objectswith gradients that are updated frequently, e.g. a bar graph with a style with gradients connected toa tag that changes at short intervals.

Polygons

Avoid excessive use of polygons. Polygons are usually complex and are drawn each time the screenis shown, hence they will not benefit from caching the screen.

Buttons

From a performance perspective it is preferred to use styled buttons instead of the default button.

Transparency

Drawing transparent objects (circular meter, slider etc.) without transparency will result in improvedperformance. In order to do so these objects should not overlap other objects within their boundingbox. Also, avoid gradients in backgrounds and dynamics on screens containing these types ofobjects.



Figure 2-1: A circular meter and its bounding box

Related informationDatabase

Action Groups

Trend Viewer

Reports

Data Logging Strategies

Symbols

Screen Caching

2.3 MovingObjectswith theTouchScreen

HMI panels with touch screens do not have a built-in keyboard. All maneuvering is done with the touchscreen by pressing distinctly with a finger. Because of the resistive touch technology, the screen canonly apprehend pressing on one place on the panel at the time. Pressing two points at the same time isinterpreted by the panel as a point midway between the two pressed points.

2.3.1 OperateObjects

For an object to react, it is necessary to specify the behavior, typically by assigning a tag and definingan action. All objects can have actions linked to mouse down, mouse up, mouse enter and mouseleave events. Some objects have a predefined behavior, like sliders setting values, but can also haveactions linked to mouse down and mouse up events.

Button

Pressing a button triggers a click- and mouse button event.

TextBox

Pressing on a text box object displays a virtual alpha-numeric keyboard on the panel screen. Type atext using this keyboard and finish by pressing [ENTER].



AnalogNumeric

Pressing on an analog numeric object displays a virtual keyboard on the panel screen. The keyboardtype depends on the format chosen for the Analog Numeric — String, Integer, Decimal, Hex or Binary.Enter a value using this keyboard and finish by pressing [ENTER].

In runtime a validation of the value is done. If the value entered is out of bounds, the correspondinglimit value for the object will be shown.

Slider

Pressing on the desired value position of a slider object sets it to the pressed position.

Related informationActions Ribbon Tab

Mouse Button Action Triggers

Click Action Trigger

Virtual Keyboard

Validation Group

2.4 Peripherals

2.4.1 USB

External devices such as a USB hub, flash drive, mouse, or keyboard can be connected to the USBhost port.

2.4.2 Ethernet

The HMI-panel has built-in Ethernet port(s) for connection to controllers via TCP/IP. The number ofports varies by model.

Related informationIP Settings

2.4.3 MemoryCard

An external memory card can be used as storage of e.g. pdf files and media files, to reduce usedinternal memory. Access to the files on the external memory card is available via scripting.

Related informationProject Group


Kollmorgen Visualization Builder | DEVELOPMENT ENVIRONMENT

3 DEVELOPMENTENVIRONMENTThis section describes how to work with Kollmorgen Visualization Builder.

Clicking theOptionsbutton in the File menu allows adapting the tool behavior.

Related informationFile Menu

Options

3.1 StartingKollmorgenVisualizationBuilder

Kollmorgen Visualization Builder is launched from within the KAS IDE. New KVB projects are contained inside their respective KAS archive. This allows KAS projects to be copied or transferred while retaining all of the KVB data.

Open an existing project in the KAS IDE, or create a new one and add a HMI device for your Visualization Builder project.

1. From the KAS IDE Project Explorer, right-click on a Controller or HMI device and selectAddKVBPanel.

2. Double-click onPanel (KVB) from the Project Explorer.

3. SelectYes to open with Kollmorgen Visualization Builder.

Kollmorgen Visualization Builder application launches and the KVB panel is now ready for design.Projects can also be created or opened later from the File menu, but this is not recommended becausevariable mapping will not be available.

When Kollmorgen Visualization Builder is started, it is possible to:

• Create a new project using a wizard• Open an existing project - a list of recently opened projects is displayed• Open a sample project• Upload a project from a target• View the Quick Start Guide, based on an example project that serves as an instructive

introduction to Kollmorgen Visualization Builder



Note:It is recommended that you open new projects from within the KAS IDE as described inStarting Kollmorgen Visualization Builder. Doing so utilizes the built-in variable mapping functionality.

3.1.1 CreatingaNewProject

To create a new project using the wizard includes the following steps:

1. Start Kollmorgen Visualization Builder.

2. Select to create a new project.

3. Select target for the project.

4. Select controller brand and model.

5. Name the project and define where files are to be saved in the PC environment.

SelectHMI-panel

Select the appropriate target from the presented set of HMI-panel/controller.

The target can be changed later, from theSettingsgroup on theProject ribbon tab.

When working with a project for a standard PC, it is possible to select resolution from a drop-down list.The PC resolution can be changed later, by enftering theSettingsgroup on theProject ribbon tab.

Related informationChanging Project Target

SelectController

Select the appropriate controller for the project.



The demo controller, including regular tags (data containers) and counters, is used to design and testa project directly on the development PC without connection to an external controller.

Internal tags that work like controller tags, but are independent of an external controller, can bedefined.

It is also possible to connect to an external OPC server.

The controller can be changed later by clicking theControllerbutton on theControllers tab of thetags configuration page.

A project can connect to more than one controller.

Note:OPC Classic is not supported for AKI2G-CDB series (OPC Classic is no longer supported by Microsoft Compact2013).

Related informationController

DEMO Controller

Internal Tags

External OPC Server

Multiple Controllers

Select Location

TheSelectLocationdialog controls naming of the project and where project files are saved in thecomputer environment.



1. Change the project name, if desired.

2. Select where to store the project files by clickingBrowse, or accept the suggested location.

3. ClickFinish to create the new project.

3.1.2 OpeningaProject

To open an existing project using the wizard includes the following steps:

1. Start Kollmorgen Visualization Builder from KAS IDE.

2. Select to open a project.

3. Browse to the project file in the appearing “open project” dialog.

Note:It is possible to open a compressed ZIP file of the Kollmorgen Visualization Builder project. The user will beprompted for a path where the ZIP file can be decompressed.

Related informationBack Up Project

Download

3.1.3 GettingFamiliarwithKollmorgenVisualizationBuilder

The ribbon tabs (e.g. Home,Systemand Insert) are located in the top of the window whenKollmorgen Visualization Builder is started. The control groups (e.g. Clipboard,Screen,ObjectsontheHome ribbon tab) are available in the ribbon area.



The Project Explorer contains a folder area, and is managed as a docked window.

The desktop area is where screens are drawn and where tags and functions are handled.

Configuration of objects on a screen is mainly performed using the controls in theHomeandGeneraltabs. Selecting an object on the screen displays the Home ribbon tab; double-clicking displays theGeneral tab, except for the Button object, for which the Actions tab is displayed instead. Severalcommon commands are also available by right-clicking on an object in a screen.



Related informationProject Explorer

Positioning Windows

Screens

Tags

KeyboardNavigation

PressingAlton the keyboard displays which keyboard shortcut commands can be used to execute acommand or to enter a control group, e.g. Alt +Fopens theFilemenu, andAlt + Idisplays the Insertribbon tab control groups.

KeyboardShortcutsandFunctionKeyCommands

The list below includes some of the keyboard shortcuts and function key commands that are availablein Kollmorgen Visualization Builder:

Keyboardshortcut /functionkey Description

Ctrl + P,

[number of the screen]

Switch between screens according to their order on the desktop

Ctrl + E, L Lock selected elements on active screen (E indicates active editor)

Ctrl + E, H Hide selected elements on active screen (E indicates active editor)

Ctrl + Z Undo

Ctrl + Y Redo

Ctrl + A Select all

Ctrl + X Cut

Ctrl + C Copy

Ctrl + V Paste

Ctrl + N New project

Ctrl + O Open project

Ctrl + S Save project

Ctrl + B Bold style

Ctrl + I Italic style

Ctrl + U Underline

F1 Display help file. Pressing F1 from within the Script Editor displaysscripting help.

F5 Validate project

F6 Run



3.1.4 StartingKollmorgenVisualizationBuilder fromtheCommandLine

"[Path to the NeoIDE.exe file]" "[Project location]\[Project name].kvb2"

Example

To start Kollmorgen Visualization Builder, and open the project named Test1 in the directoryC:\MyProjects, selectRun from Windows start menu, and type:

• "C:\Program Files (x86)\Kollmorgen Visualization Builder™ v.2\Bin\NeoIDE.exe""C:\MyProjects\Test1\Test1.kvb2"

Changing the IPAddress from theCommandLine

The IP address of the connected controller may be altered using the command line switch/controllerip=ip-address (e.g. /controllerip=192.168.100.33), provided that the Modbus driveris used for Controller1. The command is restricted to Controller1 and Station0. Only the Station0IP address will be changed.

3.1.5 FileMenu

TheFilemenu contains commands for creating, opening, closing saving and compressing projects.It also offers the possibility to upload a project from a target and to update drivers via Internet or fromfile. TheFilemenu is accessed by clicking on the top left button.

New

When you start Kollmorgen Visualization Builder and select to create a new project, a wizard guidesyou through the creation of a new project, in the same way as having selected Create New Projectfrom the Welcome page.



Note:It is recommended that you open new projects from within the KAS IDE as described inStarting Kollmorgen Visualization Builder. Doing so utilizes the built-in variable mapping functionality.

Related informationCreating a New Project

Open

SelectingOpendisplays a dialog that allows selection of an existing project file by browsing.

Save

SelectingSave saves the project to the current project folder.

SaveAs

SelectingSaveAsallows saving the project with a different name and/or in a different location.

To ensure that the original project remains unchanged, the new project file must be created with theSaveAs command before modifying its contents.

Creating a new folder when using theSaveas command helps keeping the large number of projectfiles neatly collected and easy to overview.

Note:SelectingSaveas cannot be used in order to make modifications of an existing project, keeping the originalproject unchanged, and saving the new version with another name. Changes will affect the original projectanyway. It is recommended to make a backup copy of the original project, for example by using WindowsExplorer, prior to modifying it.

BackUpProject

SelectingBackUpProject compresses the project and saves it as a ZIP file. The user will beprompted for a path where to save the ZIP file and will also be offered the possibility to passwordprotect the ZIP file.


Upload fromTarget

SelectingUpload fromTargetallows uploading a compressed ZIP file of a project from a connectedtarget.

Note:To be able to use the “Upload from target” function, the check box “Download all source code” on the “Download”dialog must have been clicked before downloading the project to an HMI-panel. See the “Download” chapter formore information.



Parameter Description

Connected targets Choose the target type to transfer the project from.

Upload Starts the transfer of the ZIP file from the selected target.

The user will be prompted for a path where to decompress the ZIP file.If the ZIP file is password protected, the user must enter the passwordto be able to upload and decompress the ZIP file.

Verify The verify function enables the user to check if a target platformconfiguration is identical to the project configuration.

Verify is supported for AKI-CDA, AKI-CDB ,AKI2G-CDA,AKI2G-CDB and controller targets. If greyed out, please update tolatest “System program”.

Log Show the data being logged during the upload and verify process.

Related informationDownload

HMI panel Upgrade

CloseProject

SelectingCloseProject closes the current project and activates the start wizard.

UpdateDrivers

Drivers can be updated from a file, downloaded from www.kollmorgen.com.

Related informationUpdating Drivers

About

Clicking theAboutbutton displays information about the current version of Kollmorgen VisualizationBuilder including the product registration key.

Note:The active project needs to be saved in order to access the list of features.


http://www.kollmorgen.com


Options

Clicking theOptionsbutton allows making settings that control the behavior and appearance ofKollmorgen Visualization Builder.

LanguageOptions

Select in which language to run Kollmorgen Visualization Builder. A restart of the application isrequired for the new language selection to have an effect.

BuildOptions

Select whether theCheckForUnusedTags function should be activated or not. When building aproject, the function checks for unused tags and presents a dialog in which it is possible to removethese.

Related informationRemoving Unused Tags

ScriptDebuggerOptions

• Arguments: The “%1” argument is where the file name will be inserted. This option is applicableonly whenCustom is selected forDebuggerType.

• Debugger: Full path to the current debugger application.• DebuggerType: SelectDefaultorCustom. With theDefault setting, the system will

automatically provide the path to the debugger, if found. Customallows the user to provide thepath to a specific debugger.

TagsEditorOptions

Selections underTagsEditorOptionsmakes it possible to customize which columns to show bydefault in the tags configuration window.

TransferOptions

Select if theDownloadall sourcecode checkbox in theDownloaddialog should be automaticallyselected.

RibbonOptions

• GoToDefaultRibbonStrategy: This option changes the active ribbon based on the context ofthe selection in the desktop. When an object is created or selected, theGeneral tab becomesactive in the ribbon area.

• SimpleRibbonStrategy: This is the default setting, and does not swap the active ribbon whenthe context of the current desktop selection changes. Clicking on an object opens theHomeribbon, and double-clicking opens theGeneral ribbon for most objects, but for buttons theActions ribbon is activated.

ScreenEditorOptions

• EnableInPlaceEditing: This option allows editing an object directly when selecting it on thescreen without having to access its properties on e.g. theGeneral ribbon tab.



• ShowPanelAround: This option displays an outline of the selected panel model around thedesktop area.

• ShowSizeAndDistanceInformation: The size of an object is displayed while resizing it.Distance to the edges of the desktop area is displayed when moving an object. The indication canbe turned off, if desired, by setting this option toFalse.

• ShowToolTips: Useful tool tips are automatically displayed in Kollmorgen Visualization Builder.These can be turned off, if desired, by setting this option toFalse.

The screen editor options can also be modified using buttons in the lower part of the desktop area.

Related informationScreen View in Desktop Area

MiniToolbarOptions

The mini toolbar is a context menu addition with a subset of common controls from theFormat,Tag/SecurityandNamegroups.

• ShowMinitoolbarAutomatic: When this option is set toTrue the mini toolbar part of the contextmenu is displayed already when an object is selected. The mini toolbar will always show incombination with the context menu. The mini toolbar will remain active for a selected object, alsoafter it has disappeared, until the selection or the pointer moves away. To show the mini toolbaragain move the mouse pointer to the upper right of the object. With the default setting,False, themini toolbar will only show in combination with the context menu for an object.

Exit

Clicking theExitbutton closes the application. If there are unsaved changes, you are asked if youwant to save them before exiting.

3.1.6 QuickAccessToolbar

TheQuickAccessToolbar contains controls, expected to be used frequently. The toolbar can becustomized to include other buttons.

Save

Saves the current project to the location specified when the project was created.

Undo

Executed commands can be undone using theUndobutton. Clicking the small arrow at the right of theUndobutton lists recently made changes for selection of the undo operation.



The keyboard shortcut forUndo isCtrl +Z.

Redo

A command that has been undone withUndo can be redone withRedo. The keyboard shortcut forRedo isCtrl +Y.

Run

Performs a validation of script code and compiles the project. If the project is valid, a simulation isstarted on the development PC with connection to the selected controller. Also available from theTransfergroup on theProject ribbon tab.

Simulate

Performs a validation of script code and compiles the project. If the project is valid, a simulation isstarted on the development PC without connection to the selected controller. Also available fromtheTransfergroup on theProject ribbon tab.

Related informationProject Ribbon Tab

CustomizingQuickAccessToolbar

Some of the ribbon controls can be added to the Quick Access Toolbar. Right-click on the desiredcontrol and selectAdd toQuickAccessToolbarorRemove fromQuickAccessToolbar.

3.1.7 RibbonTabs

The ribbon tabs contain grouped controls for editing and maintaining a project, screens and objects.Click on any ribbon tab to display the ribbon.

UseMinimize theRibbonandMaximize theRibbon to collapse and expand the ribbon control tabs,or double-click on a ribbon tab. This can also be done from the Quick Access toolbar.

Related informationHome Ribbon Tab

Project Ribbon Tab

System Ribbon Tab

Insert Ribbon Tab



Related informationView Ribbon Tab

Dynamics Ribbon Tab

General Ribbon Tab

Actions Ribbon Tab

Quick Access Toolbar

3.1.8 AdditionalProperties

Some ribbon groups include additional properties that can be configured by clicking the small arrow inthe lower right corner of the current group.

The properties window displays available property groups available for selection at the left. Theproperty groups available differ depending on which object is selected.

3.2 DesktopArea

The desktop area displays screens and configuration pages for project components such ascontrollers and functions. The desktop area shows only one screen or component at a time. Whenmultiple screens or components are opened a row of tabs are shown in the upper part of the desktoparea. Clicking on a tab activates its contents for editing.

If there are more tabs open than can be displayed, navigation arrows in the upper part of the desktoparea can be used to scroll between them.



3.2.1 ScreenView inDesktopArea

Object appearance as well as size and appearance of the current screen can be managed by controlsin the lower part of the desktop area. It is also possible to turn on and off the in-place editing functionthat allows editing text in an object directly when selecting it on the screen.

Show/HideSizeandDistance Information

The size of an object is displayed while resizing it. Distance to the edges of the desktop area isdisplayed when moving an object.

Figure 3-1: Show Size and Distance Information is activated

Show/Hide Info

It is possible to show information about which tag each object is connected to, and if dynamics oractions are configured for the object, by clicking on theShow/Hide Infobutton.

Figure 3-2: Show Info is activated

Show/HideScreenTooltips

A semi-transparent tooltip is displayed for each object when the cursor is rested on it, ifShowScreenTooltips is selected. Tooltips for e.g. menu commands are not affected by this setting; only tooltips forobjects on the screen.

Figure 3-3: Show Screen Tooltips is activated



Enable/Disable In-placeEditing

This option allows editing an object directly when selecting it on the screen without having to access itsproperties on e.g. theGeneral ribbon tab.

Figure 3-4: In-placeEditing is enabled

Show/HidePanelFrame

Show/HidePanel Framedisplays or hides a virtual panel frame surrounding the screen, when anHMI-panel is selected as target.

Fit toScreen

Click onFit toScreen to make the screen the maximum size that will fit in the desktop area.

Zoom

The following methods can be used to zoom in to or out from the desktop area:

• Selecting a set zoom value from theZoomdrop-down list.• Setting theZoomSlider to a desired zoom level.• Clicking theZoom InandZoomOutbuttons.• Placing the mouse pointer anywhere in the screen and using the scroll wheel.

Pan

Panning of the current screen is possible in Layout mode, if the screen is larger than the desktop area.

• Press and hold [Spacebar] (the mouse pointer will change its appearance from an arrow shape toan open hand).

• Drag to pan the screen (the mouse pointer hand closes in panning mode).

3.2.2 DesktopViewModes

Screens and functions have different view modes. The default setting isLayout view mode, butscreens and functions can be partly viewed and edited directly in code. The desired mode is selectedfrom the lower left part of the desktop area. The code for screens is in xaml and in C# for script.

Figure 3-5: Desktop view mode tabs

Caution:Incorrect codeentered in textmode (XamlandScript)may result in errors that arenotpossibleto recognizeduringanalysis andbuild.Erroneouscodemay result inunpredictablebehavior and lossofdata.



Layout

Screens and objects are usually edited inLayout view mode.

XAML

A screen layout is defined in XAML (eXtensible Application Markup Language) code. The .xaml filesare stored in the project folder.

XAML code can be added and changed in theXaml view mode. Any changes done in the XAML codewill affect the screen layout.

Script

InScriptview mode scripted actions can be configured for screens, objects, tags, function keys etc.

Note:To display a script guide that describes Kollmorgen Visualization Builder scripting possibilities in detail, selectScript view mode, click anywhere in the code, and pressF1.

Caution:Kollmorgenonlyoffers support for scripting for the includedexamples inKollmorgenVisualizationBuilder

Objects that can trigger events will show with expandable nodes in theScript view. Clicking the [+]of such a node expands it and shows the trigger events for the object. Double-clicking on an eventinserts its method heading with an empty code body. Scripts are written in C# syntax.

When actions are defined for an object, this will have precedence over script code.

Note:Avoid using multiple trigger methods as this may lead to undesired behavior.Use either a script or define actions with the controls on theActions tab. Avoid using Click Action Trigger actionsin combination with Mouse Button Action Triggers.

Note:Creating scripts that block execution, waiting for other resources or user input, is not supported.

Note:TheValueOffandValueOnevents for internal variables are available for selection in script mode, but they arenot executed when running the project.

Note:TheValueChangeOrErrorevent is available in script mode, but it should only be used with controller tags. Itdoes not support internal variables or system tags.



Note:If an external editor, e.g. Visual Studio, is used for editing a script, the cross-reference will not be updated whenbuilding the project in Kollmorgen Visualization Builder. TheRemoveUnusedTags function will report tagsused in these scripts as unused.For Kollmorgen Visualization Builder to recognize a change made with an external editor, the script file needs tobe opened in Kollmorgen Visualization Builder and provided with just any small change using the script editor inKollmorgen Visualization Builder. Save the project once more before build.

Note:Avoid static state when using script since this might cause memory leaks.Always remember to unsubscribe events previously subscribed to, in order to avoid memory leaks.

Complex behavior can be created using script code.

Selections made inLayout view mode are kept when switching toScript view mode and vice versa.

Nodes with edited script code are highlighted in the expanded tree view.

Figure 3-6: Highlight of an edited node in the tree view

It is possible to disable a script without deleting it, by right-clicking on a node with script, and selectingUnhookeventhandler. This excludes the script from being run, even though there is code, andthe node will no longer be highlighted.

Some objects, such as text boxes, list boxes and combo boxes, rely on script code for advancedbehavior.



NameCompletion

A context sensitive name completion feature (IntelliSense) can be activated during typing with [Ctrl] +[Spacebar] and it triggers automatically when a period (‘.’) is typed after a code element. Using itemsoutside the current scope is defined with the keywordGlobals, but it is not possible to script to otherscreens than the currently selected.

Methods are completed without argument lists. Add parenthesis and arguments to complete aselection.

Note:Incorrect script code may result in errors that are not possible to recognize during analysis and build. Erroneouscode may result in unpredictable behavior and loss of data.

Note:Not all tags available inTagsare visible in IntelliSense when scripting. The name completion function will notshow tags and objects that have names similar to script command names.

If there are errors in script code during validation of a project, it is possible to navigate to the erroneousposition by double-clicking the error in the error list.

Press [Ctrl] + [Shift] + [Spacebar] while editing to get a tool tip with the allowed variants of anoverloaded method. Use [Uparrow] or [Downarrow] to scroll. Make a new selection or press [Esc] toclose the tool tip.

Note:It is necessary to do an explicit type casting of the tag format for operands of an overloaded method.

Script code can be used to format objects. If an object attribute is selected a tool tip with allowedmethods will appear. Methods not part of the default C# API is either addressed with the full path orthe library can be included.

Related informationError List

Tag Format

Format Group

Example:

Filling a rectangle object using a color gradient from one color to another color.



The following code implements a gradient from red to purple in the rectangle. The library with the“BrushCF()” method is added with “using” in the beginning of the example, together with the defaultlibraries.

Note:When a timer is used in script code, it is important to close the timer in the code.

Note:Renaming objects and screens included in scripts in Layout mode will cause the scripts not to function.

ReferencedAssemblies

Third-party components and objects that are added to the project viaReferencedAssemblieswill bemade available when scripting. Their methods and properties will be included by the name completionfunction, in the same way as for built-in components.

Related informationReferenced Assemblies

Name Completion

Aliases

Aliases can be configured in theAliases view mode.



Related informationAliases

3.2.3 PositioningWindows

The behavior of many windows can be adapted in order to suit the user; for example shown or hidden,or moved to another position on the desktop.

Docked windows representing control tools can be converted to floating windows. Control tools canbe docked separately or be managed as a tabbed group in a window. A docked tool window supportsauto-hide.

When a window is dockable, a guide diamond appears when the window is moved on the desktop.Extended position arrows appear at the desktop edges. The guide diamond makes it possible to docka tool window to one of the four sides of the desktop area. When a tool window is undocked, it floats ontop of the desktop. Dropping a tool at the center of a guide diamond creates a tabbed group of the toolsinside the window that the guide diamond belongs to.

DockingaTool

Drag the window heading to any position on the screen. If the tool is not docked it will become floating.

To re-dock a tool:

1. If the tool is docked already, double-click on its heading to change to floating.

2. Drag the tool to the center of the desktop. A guide diamond appears, pointing towards the fouredges of the desktop. Release the window to the desired direction. When the mouse pointer is inposition, an outline of the window appears in the designated area.

DockingaTabbedGroup

It is possible to dock a tool to an existing group of tools, creating a grouped window with tabs:

1. If the tool is docked already, double-click on its heading to change to floating.

2. Drag the tool to the center of the existing group. A guide diamond appears.

3. Drop the tool at the guide diamond center.



ReleasingaTool fromaTabbedGroup

When a window contains multiple tools, they appear as tabs in the lower part of the window. To releasea tool that resides in a tabbed group, drag the tab for the tool and drop it on the desktop.

Auto-Hide

Auto-Hide enables a maximized view of the desktop area by minimizing tool windows along the edgesof the desktop area when not in use. Auto-Hide is turned on and off by clicking the Auto-Hide pushpinicon on the window title bar.

Tool windows expand to their original size when the pointer hovers over them. When a hidden toolwindow loses focus, it slides back to its tab on the edge of the desktop area. While a tool window ishidden, its name and icon are visible on a tab at the edge of the desktop area.

Note:The Auto-Hide function has to be turned off before a tool can be moved.

3.2.4 ConfigurationPages

Many functions, such as Alarm Server and Data Logger, are configured via table style configurationpages.

In some cases there are multiple configuration pages for a feature. When applicable, the configurationpage for a feature can be opened to allow direct access. For example, it is possible not only to select atag, but also to declare new tags, directly through theSelect Tag field for an object.

Home

In a configuration page, theHome tab is used to add and remove items in a function or controller.

Edit TableCells

Use theAddbutton to append a new item in the table view of the configuration page.

Use theDeletebutton in theHome tab or theDeletebutton on the keyboard to remove the active rowin the table. Multiple rows can be selected using the [Ctrl] or [Shift] keys.



KeyboardNavigation

Navigation in configuration pages can be made using arrow keys or with [Tab]. PressingF4 inside atable cell will in some cases open selection list.

Pressing [Enter] acknowledges a selection, and pressing [Esc] cancels a selection.

Press [Delete] to remove a value when editing in a field. If a row is selected when pressing [Delete],the entire row will be removed from the table.

Use [Spacebar] to toggle a value in a check box.

Press [Ctrl] + [Tab] to shift focus from the table.

Navigation inLayeredPages

A layered configuration page (for example the alarm items page) has some specific navigationfunctions.

Keyboard navigation down is made by pressing [Ctrl] + [DownArrow]. This will navigate into anexpanded group, and out again when at the last of the expanded rows.

Keyboard navigation up and out of a group is done by pressing [UpArrow].

Expand a group with [Ctrl] + [+], collapse with [Ctrl] + [-].Keyboard navigation between fields inside a group is made with [RightArrow] or [LeftArrow].

Pressing [Enter] acknowledges a selection, and pressing [Esc] cancels a selection.



AutoFill

Fields in the configuration tables are when possible automatically filled in when [DownArrow] ispressed when at the last table row. When needed, names and tag identifiers are incremented to avoidexact copies of symbolic names and tag identifiers. Incrementing is done if the last part of the string isan integer number. A “1” will be appended to the string if no numeral character ends the string. This isuseful when there are consecutive tags of the same type in the controller data.

Filtering Items

Items in configuration pages can be filtered by selectingShowSelection from theShowSelection/ShowAllbutton.

Clicking the button opens the Filter Builder.

Several conditions can be used, and the different values/operators that can be used for makingconditions are displayed when clicking on the condition building blocks.

Operands and operator nodes are context sensitive. Name strings are not case sensitive. Values inthe filter builder are saved individually for each function during an edit session. A filter is built as alogical expression tree. A filter typically has operations on individual column values as leaf nodes andlogical operators serve as main nodes.



The following color scheme is used:

Color Function

Red Logical operator

Blue Column operand

Green Value operator

Grey Value operand

An indication that a filter is used is displayed at the lower part of the configuration page.

SelectingShowAll from theShowSelection/ShowAllbutton in the configuration page displaysthe complete, unfiltered list.

3.3 Screens

Screens contain objects that can be displayed for the operator in runtime. A screen can containpredefined objects, such as buttons or an alarm list. Pictures of physical objects, such a pump,connected to controller data, can also be included to be used for control and monitoring of the physicalobject.

Properties are defined for each screen.

Screens are edited in the desktop area and can be managed from:

Location Used forThe Navigation Manager Adding new screens, managing links between screens, deleting

screens

The Screens list in theProject Explorer

Adding new screens, importing screens from other projects,renaming screens, setting screen as startup screen, saving screensas templates, deleting screens, editing screen scripts

The Screen group of theHome ribbon tab

Adding new screens, selection of screen template and backgroundscreen, deleting screens, language selection, screen security

The Screen group of theGeneral ribbon tab

Managing popup screen properties

3.3.1 ScreenNameandScreenTitle

All screens have unique names, visible e.g. in the Project Explorer and the Navigation Manager.Names of all open screens are shown as tabs in the desktop area. The name of the current screen isdisplayed and can be changed in the Name group of the Home tab.

In runtime, the screen name is displayed together with the project title in the title bar as default. Todisplay something other than the screen name, a screen title may be added in the Screen group on theGeneral tab when the screen is selected.



Note:The screen name in Kollmorgen Visualization Builder is not updated when the screen title (for display in runtime)is renamed.

If the project title on the Project tab is left empty, only the screen name or screen title is displayed.

3.3.2 BackgroundandForegroundScreen

It is possible to use another screen as background or foreground screen. This is for instance useful forcreating a uniform design of the screens in the project and to avoid repetitive configuration.

Background and foreground screens belong to the current project.

Example

Follow the steps below to use a background screen. A foreground screen is created in the same way,except that you selectForeground instead in step 5.

1. Create a background screen with some reusable elements, such as navigation buttons, andrename it to a suitable name.



2. Create a new screen.

3. Keep the new screen open on the desktop, and click onParentScreen from theScreengroup oftheHome ribbon tab.

4. Click the screen you want to use as background.

5. SelectBackground.

6. ClickOK.

The background screen is now used for the screen.

Any modification made to the background screen will be reflected in all screens using it.



3.3.3 StartupScreen

The startup screen is the first screen that opens when a project is executed. By default, Screen1 isset as startup screen.

Another startup screen can be set at any time by right-clicking on the screen on the desktop or in theProject Explorer and selectingSetasStartupScreen.

The selected startup screen is easily distinguished from the other screens in the Project Explorer by ablue outline when in focus.

3.3.4 ScreenTemplate

The installation of Kollmorgen Visualization Builder includes a number of screen templates with basicfunctionality. It is also possible to save your own screens as screen templates, by right-clicking on thecurrent screen and selectingSaveScreenasTemplate.

The screen template can be used in the current or other Kollmorgen Visualization Builder projects.

If a selected screen template contains tags that were not previously included in the project, you canselect to automatically add these to the Tags list.

To use a template screen, click the lower part of the Add Screen button in the Screen group of theHome ribbon tab. A preview of screen templates is displayed.

User-created as well as predefined screen templates may be deleted by right-clicking on the templatein the preview and selectingDeleteScreenTemplate. The folder of the selected screen is thenpermanently deleted from disk.

3.3.5 ScreenSecurity

Using security settings for screens makes it possible to restrict access to screens based on usersecurity groups, similarly to object security.

It is not possible to set security for the Startup screen.

When using a background screen, the security settings of the top level screen are applied.

When screens are imported from other Kollmorgen Visualization Builder projects, security settingsare included and will be used in the current project.

Related informationObject Security and Visibility

3.3.6 PopupScreen

Normally, only one screen is visible in the HMI-panel in runtime. Sometimes, a popup screen thatbehaves like as a floating window may be useful. Any screen can be configured as a popup screen:

1. CheckPopupscreen in the Screen group of the General tab.

2. Set the start position coordinates (X, Y) to determine where the screen will open. The position(1,1) corresponds to the upper left corner of the screen.

3. Set the desired width and height in pixels of the screen resolution.

ClickingModifyScreenSize/Positionallows changing the popup screen size and position bydragging it with the cursor. The coordinates are updated automatically.



ModalPopupScreen

Checking theModaloption makes the selected popup screen modal, which means that the usercannot interact with other screens while this screen is visible. All other screens will still be updated.

Note:It is not recommended to have more than two parallel modal popup screens open at the same time.

Note:Do not use multiple modal popups triggered by background events such as alarms, tag value changes, etc.

Style

Different styles can be selected for popup screens for controller targets.

Note:When using a web browser or pdf viewer object in a popup screen, only the default style for the popup screen issupported.

OpenPopupScreen

A popup screen is opened in runtime by aShowScreenaction on an object.

Note:When configuring a Show Screen action for a popup screen, position of the screen can be selected. Thesesettings override the settings made in the Screen group of the General tab.

ClosePopupScreen

A popup screen is closed in runtime by aCloseScreenaction on an object.

If theCloseScreenaction is triggered from a tag, this will close both the popup screen and the parentscreen.

3.3.7 ImportingScreens

Screens from other projects can be imported, by right-clicking in Screens area of the Project Explorerand selecting Import.If the selected screen has a name identical to one of the existing screens, a new screen name isproposed.

If the imported screen includes tags that do not already exist in projects, you are asked if you want toadd these.

Note:No tag information, other than tag names, will be added by the import function.



3.3.8 ScreenCaching

Caching of a screen means that the content of the screen is temporarily stored in the memory, so thatthe screen can be loaded faster in the future.

A screen has events which will trigger when the screen loads and closes. There is no difference in thisbehavior wether the screen is cached or not cached. When a cached screen is replaced by anotherscreen, the former will deactivate all dynamic bindings, hibernate any controls that might be runningtimers or processes and, at last, fire the closing and closed events subsequently.

Scripts inCachedScreens

When implementing scripts or actions in a cached screen, it is highly recommended to make surethat any implementation closes down gracefully. If using for instance a timer or a thread that will beinitialized or started at the screen opened event, it must be paused, stopped or disposed on either theclosing or closed event. Otherwise the implementation will continue running in the background, eventhough the screen is cached, and possibly lead to unnecessary CPU load or otherwise bad behavior.

3.3.9 Grid

There are different methods to align objects in screens;Snapobjects tootherobjectsandSnapobjects togrid. Grid properties are managed by right-clicking on the current screen and selectingGrid from the context menu. It is also possible to select not to snap objects.

Grid settings are global and will affect all screens.

SnapObjects toOtherObjects

To help position objects in a screen snap lines will appear when an object is moved across the screen.The snap lines are used to align the dragged object with other objects on the screen.

Blue snap lines appear whenever the right, left, top, or bottom boundaries coincide with other objectboundaries. A horizontal red snap line indicates that the center of the object is aligned with the centerof another object. For vertical center alignment, select the objects and useAlignCenter in theArrange control of the Format group.

SnapObjects toGrid

Use the context menu and selectSnap toGrid to enable binding to grid points for a moved object.Snap toGridmode disablesSnapLines for dragged objects.



Grid

The different grid styles can be used as a help pattern when doing the layout of the objects on thescreen.

Gridsetting Description

Spacing Number of pixels between grid lines

Show grid on screen Displays the grid on the screen

Grid style Selection between dots and lines as grid style

3.4 Objects

Objects that can be created in a screen are available from the Objects group and the ComponentLibrary.

Snap lines are used to position objects in a screen and align a moved object with other objects.

Information about tag connections as well as size and distance information for objects on the currentscreen can be displayed by using the buttons in the lower part of the desktop area.

Related informationObjects

3.4.1 HandlingObjects

Create

To insert a default-sized object, click the position on the screen where you want to place the object.

To give the object a specific size and shape, press the mouse button and drag to create the object onthe screen. Press and hold [Shift] while creating an object to retain the aspect ratio of the object.

When creating a line object, press and hold [Shift] to constrain the line at 45 degrees angles.

Select

TheSelect tool is available at top left in the Objects group when the group is not expanded. The Selecttool is the default tool when editing screens. After applying any other object control, the mouse pointerwill return to the Select tool. When the Select tool hovers over a selected object the mouse pointerchanges to a cross with arrowheads.

Move

The position of an object is part of the properties for the object. The position of an object can bechanged in different ways:

• Click and drag an object to move it to the desired position.

• Open the property grid and edit theLeftandTop coordinates.

To move the selected object one pixel at the time, select the object and use the arrow keys on thekeyboard.



CopyandMove

Use [Ctrl] + drag to make a copy of the selected object, and to move it to the desired position.

Resize

The size of an object is part of the properties for the object. To change the size of an object:

• When the Select tool hovers over the resize handles of a selected object, the mouse pointerchanges to an arrow. Resize the object to the desired size.

• Open the property grid and edit theHeightandWidth values.

To resize the selected object one pixel at the time, select the object, press [Shift] and use the arrowkeys on the keyboard.

Rotate

Rotate is only supported for projects designed for controller targets, and not for all objects.

Angle and rotation center is part of the properties for an object. The rotation center for an object isshown as a small white circle which by default is located in the center of the selected object.

When the Select tool hovers over the rotation center of a selected object the mouse pointer changes toa circle inside a square with arrow sides. This indicates that it is possible to move the rotation center.

To change the rotation center of an object:

1. Point to an object to select it. When an object is selected a red frame with handles is shown aroundthe object.

2. Drag-and-drop the rotation center circle to the position that is to be the center of the rotation.

When the Select tool hovers next to a corner of the selection frame for a selected object the mousepointer changes to a circular arrow. This indicates that the object is possible to rotate by the framehandle around the rotation center.

To change the rotation angle of an object:

1. Drag to rotate the object around its center position.

2. Use [Ctrl] + drag to rotate in steps of 15 degrees.

Figure 3-7: Cursor appearance for Resize, Rotation centre, and Rotate.



SelectingMultipleObjects

Multiple objects on the current screen can be selected at the same time, with the use of the mousepointer to draw a frame that touches the objects. Alternatively, select one object and then use [Ctrl] +click to select or de-select other objects.

A multiple selection can be used to arrange objects, by using the Arrange control on the Format ribbontab. The object with the primary selection is used as guide object.

When multiple objects are selected, the primary selection is shown with a red frame, while all otherobjects in the group have blue frames.

Click on any object in the group to change this to the primary selection. A click or double-click on anyobject will make it the primary selection, and, if applicable, change the ribbon focus according to theselected ribbon behavior.

The groups shown in the General and the Actions tabs are dependent on the selection. When multipleobjects are selected the tabs will show only the properties that are common for the objects in theselection. Property changes will affect all selected objects.

HidingandLockingObjects

Objects can easily be hidden and locked using the Object Browser, but the commands are alsoavailable from the context menu. To make a hidden object visible again, or to unlock a locked object,the Object Browser can be used.

Related informationObject Browser

Property Grid

CreatingSeries

The Create series function facilitates creating a number of identical objects. The function handlesadding graphic elements as well as controller connections.

The following example creates a series of analog numeric objects quickly and easily:

1. Create an analog numeric object and connect it to a tag (in this example; D0).

2. Right-click on the object and selectCreate series from the context menu.



3. Fill in the number of objects to add and make settings for the address incrementation, and clickOK.


Number of copies Enter the number of columns and rows to create

Spacing Specify the number of pixels between the added objects

Address incrementation Select how to increment addresses for the added objects. Onlyaddresses available in the driver will be added.

Increment direction Select if addresses are to be incremented in horizontal or verticaldirection

Graphical objects are added on the screen according to the settings made:

Tags are added to the project according to the settings made:



Right-clicking in the Tags configuration page and selectingCreate seriesmakes it possible to create aseries of tags quickly and easily, without adding graphic objects.

3.5 NavigationManager

The Navigation Manager is used to manage screens and their relations with respect to projectnavigation in runtime. It can be activated/deactivated from the View tab. It provides an overview of allscreens in the current project.



3.5.1 ScreenRelations

The Navigation Manager is used to create relationships between screens.

Dragging the mouse pointer from one screen to another screen creates a relation. A button with aClickaction is defined in the first screen. ThisShowScreenaction has the second screen as target,and when clicking it in runtime, the second screen is opened.

Double-click on a screen to open the screen for editing in the desktop area.

3.5.2 AddScreen

New screens can be added directly in the Navigation Manager.

Dragging the mouse pointer from an existing screen to an empty location in the Navigation Managerarea creates a new screen, with a relation to the original screen. A button with aClickaction is definedin the first screen. ThisShowScreenaction has the second screen as target, and when clicking it inruntime, the second screen is opened. The button must be removed or changed manually if the newscreen is deleted later.

3.5.3 Links in theNavigationManager

A structure of screens and their relations to other screens will be imposed and shown in the NavigationManager. The Navigation Manager will provide an overview to help add screens and manage the linkrelations between project screens.

Right-click anywhere in the Navigation Manager to change link appearance.



Linksetting Description

Show Same LevelReferences

Filters out links to screens on the same hierarchical level.

Show Back References Shows navigation links to higher hierarchical levels. When notselected, only links to screens on lower levels and links betweenscreens on the same level are shown.

Directed Links Draws straight link lines between screens, using the shortest way.

Orthogonal Links Draws link lines in an orthogonal pattern.

Changing the setting or the type affects the appearance in the Navigation Manager only.

3.5.4 NavigationOverview

It is also possible to display theNavigationOverviewby selecting it from theView ribbon tab. Itprovides an overview of all screens included in the project, with zooming facilities.

3.6 ProjectExplorer

The Project Explorer shows all screens and components included in the application. It can beactivated/deactivated from the View tab.

The Project Explorer is divided into five groups; . Screens,Functions,DataLoggers,ScriptModulesandRecipes.



3.6.1 ProjectExplorerGroups

Click on the group heading to expand/collapse the groups. The number of components in each folderis apparent from the group headings. Right-clicking on a group opens a subset of the commands fromtheFilemenuand Insert tab.

Right-clicking on a component in a Project Explorer group opens a context menu with a selection ofcommon operations. Not all commands are available for all components.



Contextmenucommand

Description

Show Opens the selected project component for editing in the desktop area

Rename Renames the selected project component

Add Adds a new project component to the project

Import Imports a project component via browsing the hard disk; e.g. a screenfrom another project

Delete Deletes the selected component from the project

Screens

TheScreensexplorer lists the screens included in the application. Clicking on a screen opens it forediting in the desktop area.

ScreenContextMenu

Right-clicking a screen opens a context menu with a selection of available operations:

• Show• Rename• Import• Delete• Set as startup screen• Save screen as template screen• Add to screen group• Remove from screen group

The screen set to be the startup screen is marked with a green frame in thescreensexplorer.

Groups

TheScreensexplorer offers a possibility to assign screens to groups.

• Right-click on theAll screensheading in theScreensexplorer and selectAddgroup followed byentering a unique name for the group in the appearing dialog.

• To assign a screen to a group, simply right-click a screen in theScreensexplorer and select “Addto Screen Group” from the context menu. Select a group to add the screen to from the appearing“Select Screen group” dialog.

• To show available groups, double-click theAll screensheading in theScreensexplorer.Screens not assigned to a group will be listed asungroupedscreens.

• Right-clicking a group enables a context menu from which you can choose to rename or deletethe group.

Note:Deleting a Screen group also deletes all of its assigned screens.

It is also possible to assign a screen to a group by a simple drag and drop operation. Drag the screensymbol and release it on the group.



ZoomSlider

The Zoom slider is found in theScreensexplorer and provides a way to quickly zoom in and out ofyourscreensexplorer.

Search

The search function provides the option to search for screens using the screen name orscreen-id.

The search is only performed within the selected group.

Functions

The Alarm Server, Multiple Languages and Security functions are predefined, as well as Tags, andcannot be deleted from the Functions folder. The other functions can be added from the Insert menu.Most functions will be available from the Functions folder after having added them to the project, butsome functions are assigned folders of their own.

Clicking on the function in the Functions folder opens its configuration pages for editing in the desktoparea.

AlarmDistributor

Alarms can be distributed between HMI-panels, with notification via printer, SMS or e-mail using thealarm distributor.

Related informationAlarm Distributor

AlarmServer

The Alarm Server handles alarm groups and alarm items.

Related informationAlarm Server

Alarm Groups

Alarm Items

Audit Trail

The Audit Trail function enables tracking of operator actions.


FunctionKeys

Function keys for HMI-panels as well as for the regular controller keyboard can be configured.

Related informationFunction Keys



MultipleLanguages

Configuring multiple languages for user texts and system texts are supported. The texts can beexported, edited and reimported to the project. A tool for automatic translations is also included.


Reports

The reports function allows adding excel report templates to the project.

Related informationReports

Scheduler

A scheduler can be used to control events in the process at special times.

Related informationScheduler

Security

Users and groups of users can be set up for security purposes.


Tags

Clicking onTags in the Functions folder displays the tags configuration page in the desktop with allthe tags that are used in the application. Tags are added by clicking on theAddTag/AddSystemTagbutton.

Tags can belong to a connected controller, or be internal. Internal tags can be used and selected in thesame way as a regular controller tags.

System tags are used to monitor or access variables from the system, for example Used RAM orDateTime. System tags are indicated by blue color in the tag list.


Internal Tags

System Tags

TextLibrary

With the text library function, text tables can be created, where values are linked to texts.




Recipes

Several recipes can be inserted in the project. Each recipe function handles a pre-defined set ofrecipe items.

Related informationRecipe Management

ScriptModules

Clicking on a script module in the Script Modules folder opens the script editor in the desktop area. Ascript module can be included to program features not covered by included functions and actions, or tobe used to share functionality among functions.

There is also a script action function that can be used to apply script modules to an object in the sameway as with other trigger actions.

Related informationScript

Script Action

DataLoggers

Data can be logged and saved to a database on time intervals or depending on changed values.

Related informationData Logger

3.7 ComponentLibrary

The Component Library contains reusable components for a project.

3.7.1 Components

The Component Library includes a large number of predefined graphical objects, categorized intogroups. User-defined graphical objects and other files may also be saved in the component library. Allcomponents in a sub folder must have unique names.

Examples of components that may be included in the library:

• predefined components• objects• text objects configured with multiple texts• symbol objects configured with multiple symbols• grouped objects• external pictures• text• folders (file folders)• HTM/HTML files



• media files• PDF files

Since plain text can be saved as a component, it is possible to save reusable script components bydragging a section of script code from the Script view into the Component Library.

A component is displayed with its name and a thumbnail representation in the Component Librarywindow.

Grouped objects are displayed as a thumbnail representing the primary selection of the object. Textfiles and folders are represented by operating system thumbnails.

Note:Only static graphical objects are supported in Kollmorgen Visualization Builder.

ProjectPictures

The Project Pictures folder is project specific, and contains pictures that are used in the currentproject. The components in Project Pictures are stored in the project’s Symbols folder.

Project Files

The Project Files folder is project specific, and contains files that have been added when creatingthe project.

Project files and folders can be added and deleted from the Project Files folder before downloadingthe project to an HMI-panel. The Project Files folder is located in the Project folder.

For instance, “C:\MyProjects\ProjectFolder\Project Files”.

It is also possible to access the HMI-panel via FTP to add and delete files and folders after thedownload, provided that the FTP service is enabled in the project.

Related informationFTP

Download

3.7.2 AddandUseComponents

Drag-and-drop any component from the library to the current screen, or use copy [Ctrl +C] and paste[Ctrl +V] commands.

Objects can be copied or moved to the Component Library.

A text file, that is saved in the Component Library will be converted to a text box object when pastedinto a screen.

A component (picture or group) that is originally copied from an object with a tag connection will keepits tag connection and any dynamic properties when used from the Component Library.

Note:If a component with a tag association is reused in another project then all referenced tags must be present in thenew project.



3.7.3 ComponentLibraryWindow

The component library is available as a tab at the right-hand side of the desktop. The window isconfigured with auto-hide functions, and can also be activated/deactivated from the View ribbon tab.Its appearance can be managed just as other tools; as docked or floating windows.

The Component Library is also accessible when selecting and placing the Picture object from theHome ribbon tab.

User-DefinedCategories

Right-click on an empty space of the Component Library window and selectAddComponents to adda component to the library. To create a new category, selectAddcategoryand choose a name of yourpreference. A category could also be renamed or deleted.

User-defined categories are not project specific. This means that all objects saved in a user-definedcategory will be available in all Kollmorgen Visualization Builder projects.

Exportingand ImportingComponents

By using the Import and Export functions in the Component Library, categories of components caneasily be copied and moved between projects. Right-click on the category folder and select ImportorExport. Find the location in the project file from where the components should be imported or to wherethey should be exported. The program will not indicate where the component files are located.

Single objects can not be exported or imported.

ExpandandCollapseFolders

The top area is a contents frame that is used to navigate through the folders of the Component Library.The contents heading displays the name of the currently selected folder. The folder view can beexpanded and collapsed with the control to the left of the displayed folder name.



The display of the components is filtered through the selection of the folders, i.e. all components aredisplayed if the top folder is selected.

Search

TheSearch feature provides a case-insensitive and alphabetical search, based on the componentlabel, in the current folder and in all sub folders.

Zoom

The Zoom slider at the bottom area of the tool window can be used to change the size of the displayedcomponents. Resting the mouse pointer over a component displays a full-size picture of thecomponent.

Figure 3-8: Component Library window, displaying full size of a selected component



XAMLGuidelines

All information, including the image, must be contained within the XAML-file. Links to external objectswill result in missing objects. Furthermore, the appearance of the XAML-file may not be dependentof external inputs, like for example a parameter controlling a multi-picture based on internal logicwithin the XAML-file.

NamingControls inXAML

Figure 3-9: Not supported

Figure 3-10: Supported

SpecifyWidthandHeight

The root control must specify a width and a height.

Figure 3-11: Not supported



Figure 3-12: Supported

Bindings

These are the only properties that are supported for XAML-binding within components:

• ISymbolViewboxSignature.Fill is presented as “Fill” within the property grid• ISymbolViewboxSignature.Stroke is presented as “Outline” within the property grid• ISymbolViewboxSignature.StrokeThickness is presented as “Outline Thickness” within the

property grid

It is not supported to bind to anything outside of the component.

Supported:

3.7.4 XAML Import intoKollmorgenVisualizationBuilder

It is possible to import vector graphics, XAML components, into Kollmorgen Visualization Builder.

Basic– ImportXAML intoKollmorgenVisualizationBuilder

Install Microsoft Expression Design 4. The software is free and can be downloaded athttp://www.microsoft.com/expression/eng/.


http://www.microsoft.com/expression/eng/


1. Open Expression Design and draw your image.

2. Select all your components and chooseFile>Export….3. Use the same settings as shown in the picture below.

4. ClickExportAlland save the file.



5. Open Kollmorgen Visualization Builder.6. Right-click on a node in theComponentLibraryand chooseAddComponents.

7. Select the XAML file that you exported from Expression Design.

Advanced–XAMLbindings inKollmorgenVisualizationBuilder

It is possible to bind some of the component’s properties to tags directly in Kollmorgen VisualizationBuilder’s property grid. The following properties are supported:

• Fill• Outline• Outline thickness

Kaxaml

1. Download Kaxaml from http://www.kaxaml.com.2. Open your exported xaml file in Kaxaml.3. Localize which part of the graphic that you want to control with fill, outline and outline thickness.

Changing the fill color for each section makes it easier to find which parts of the XAML code thatneeds to be modified.


http://www.kaxaml.com


Dynamicproperties

The following dynamic properties are supported by Kollmorgen Visualization Builder:

XAML code before modification:



Modify the xaml code by replacing Fill, Stroke and StrokeThickness with dynamics properties. Don’tforget to add the namespace.



Import toKollmorgenVisualizationBuilder

1. Open Kollmorgen Visualization Builder.2. Right-click on a node in theComponentLibraryand selectAddComponents.



3. Select the XAML file that you modified in Kaxaml.

Observe how your component’s appearance is altered when changing fill/outline color or outlinethickness.

When you have modified the component you can easily copy it to theComponentLibrary. This willallow you to reuse the graphic/component later on.

3.8 PropertyGrid

Most properties and settings for an object or screen are defined from its General and Home tabs.

A detailed overview of object properties is available by selectingPropertyGrid from the View ribbontab or by selectingProperties from the context menu.

The property grid includes more properties and settings than the ribbon tabs, for example size andposition of objects, and delay of mouse and touch screen input in runtime.

Property groups can be collapsed/expanded.

The window is configured with auto-hide functions. Its appearance can be managed just as othertools; as docked or floating windows.



3.8.1 Search

The Search feature provides a case-insensitive and alphabetical search, that makes it easy to reducethe number of displayed properties.

3.8.2 Togglingviews

The different views in the Property grid can be selected by using the menu on the top of the window.

Show only the properties marked as favorites

Show all properties in the Property Grid

Show all properties that do not have their default value

Select whether Favorites are editable or not

Show or hide the Copy Properties functions in the Property Grid

3.8.3 Favorites

The properties most commonly used can be added to a Favorites-category for easier access. Thefavorites are saved per object type, i.e. Button has one set of favorites, Analog Numeric has one set offavorites, Chart has one set and so on.

A yellow star indicates that the property is added as a favorite. By clicking the star, theproperty is deselected and removed from the Favorites-category

When clicking on a greyed out star, the corresponding property is added to theFavorites-category

3.8.4 CopyProperties

Multiple properties can be copied from one object to one or more targets. Theproperties can be selected either one by one by clicking the check box next to eachproperty, or all at once by clicking the button for Select all, followed by a click on theCopyPropertiesbutton. The values are then pasted onto the target object(s) whenselecting the target(s) and clicking onPaste.

Note:Only theproperties that aresharedbybothsourceand targetobjects are transferred. Anexception to this is actions,whichcanonlybecopiedbetweenobjectsof thesame type (forinstance frombutton tobutton).



Selects all properties for the object

Deselects all properties for the object

Copies the selected properties to the clipboard

ClickingPastepastes the copied properties onto theselected object(s)

3.9 ObjectBrowser

An overview of all objects included in a screen can be displayed in the Object Browser.

It is easy to bring objects that may have been obscured by other objects up front, by using the arrows atthe top left.

Clicking the buttons at the right side of each object enables simply hiding/showing andlocking/unlocking objects.

Note that the top-to-bottom order in the Object browser corresponds to the front-to-back order onthe screen.

3.10 Output

The Output window contains messages concerning the project validation and build. Created projectfiles with folder paths and any found errors will be listed in Output.

Note:Incorrect code entered in text mode (Xaml and Script) may result in errors that are not possible to recognizeduring analysis and build.



3.11 ErrorList

The Error List contains information about problems and errors detected in Kollmorgen VisualizationBuilder for the current project. Build errors are reported in the Output window.

3.12 Help

The Help file for Kollmorgen Visualization Builder can be opened by pressingF1on the keyboard orusing theHelpbutton in the ribbon tab heading.


Kollmorgen Visualization Builder | TAGS

4 TAGSObjects connected to tags can change values in a controller, and controller values can be reflected bychanging object appearance in various ways. Objects in a screen will remain static until connected toa tag.

A tag has a symbolic name and can be of different data types.

Tags can belong to a connected controller, be internal or belong to the system. Internal tags are usedto handle local data values, and can be viewed and treated in screens just like regular controller tags.

The global tag list provides an overview of all used tags, regardless of controller. This makes it easyto develop projects that can be used with a variety of controllers. It is also possible to connect a tag tomore than one controller simultaneously.

4.1 AddingTags

Tags are handled by clicking onTags in the Functions folder in the Project Explorer.

Clicking theAddTag/AddSystemTagbutton adds a new tag to the list. Make settings for eachadded tag. When predefined values are available, these can be selected by clicking the arrow at theright of the table cell.

4.1.1 RemovingUnusedTags

TheDeletebutton inTags can be used to detect unused tags for immediate removal via theRemoveUnusedTagsdialog.



Similarly, when building the project, a notification of any unused tags will automatically be doneby displaying theRemoveUnusedTagsdialog. To disable or enable pop-up of this dialog, go toOptions in theFilemenu. SelectBuildoptions in the list and then selectCheckForUnusedTagsunderMisc. Change the status of the function toTrueorFalse.



Note:Always review the candidates for removal prior to removing unused tags, since removing tags that are used ine.g. a script can result in a corrupt project.

To be able to detect tags used in scripts, a certain syntax must be used. It is recommended touse the IScriptTag interface within the arguments list for theScriptModule, thus enabling theScriptModule to be used and reused without being locked to a specific tag setup. Use the syntaxGlobals.Tags.TagName for direct tag references within scripts and expressions.

If an external editor, e.g. Visual Studio, is used for editing a script, the cross-reference will not beupdated when building the project in Kollmorgen Visualization Builder. TheRemoveUnusedTagsfunction will report tags used in these scripts as unused.

For Kollmorgen Visualization Builder to recognize a change made with an external editor, the script fileneeds to be opened in Kollmorgen Visualization Builder and provided with just any small change usingthe script editor in Kollmorgen Visualization Builder. Save the project once more before build.



TheSummethod inside the script can be utilized in many different contexts. The following pictureshows how Tag3 will contain the sum of Tag1 and Tag2 when the button is clicked. Notice that the tagsused in scripts must be activated to work as expected.



Related informationTags Editor Options

Options

4.1.2 ImportingTags fromtheKAS IDE

When the KVB is launched through the KAS IDE, all the PLC variables exported for HMI areautomatically imported to the KVB.

Use the HMI check box in the dictionary to select which variables should be exported to the KVB.

Note:Strings are not supported over Modbus for the KVB.

Note:Arrays and structs can be exported and will be available as a collection of tags inside KVB.

Note:Variables exported from the KAS IDE are refreshed each time you open the KVB. If you export a variable whileKVB is already running it will not be visible. Close the KVB and re-open it from within the KAS IDE in order forthe variable to be visible.

4.1.3 BasicSettings

To reduce complexity in the tags configuration page, some columns can be made hidden/visible. Thebasic settings are always displayed. It is possible to customize which columns to show by defaultusingTagsEditorOptions.

Enter name, data type and access rights for the tag. Select if the tag is to belong to a controller enteredon the Controllers tab. If no controller tag address is entered, the tag will be treated as an internal tag.

Parameter DescriptionName Symbolic name. The name can be any alphanumeric string,

beginning with a letter (a-z, A-Z).

Data Type (Tag) Selection of presentation format; for example used to show thecorrect engineering unit when using scaling. DEFAULT followsselection made for Data Type (Controller).

Access Rights Defines access rights to the tag

Controller Controller address

Data Type (Controller) Selection of data type

To rename a tag it is necessary to enter theRenamedialog for the change to take place. The dialogappears when clicking on the three dots to the right of the name in the tags list.



Related informationScaling

4.1.4 Scaling

Scaling affects only tags connected to a controller.

Checking theScalingbox displays theOffsetandGain columns. These parameters are used tochange the scale of the controller value to a value shown in accordance with the following equation:

Panel value = Offset + (Gain × Register value)

When the value for an object is changed from the HMI-panel, the scale is changed to the value shownin accordance with the following equation:

Register value = (Panel value - Offset)/Gain

Scaling does not affect the defined maximum and minimum values, or the number of decimals.

4.1.5 DataExchange

Checking theDataExchangebox displays theDirectionandWhen columns. Data exchangesupports real time data exchange between different controllers. The data exchange can be performedwhen a digital tag is set or at a certain time interval, set up on the Triggers tab. Data exchange can beselected for individual tags, array tags or for the complete range of tags.

Related informationData Exchange



4.1.6 Others

Checking the Others box makes it possible to configure a number of additional tag properties.

Parameter DescriptionDescription An optional description of the tag. Description of system tags is added

automatically.

Please note that the description can not be more than 200 characters long.Descriptions longer than that will cause build errors.

Poll Group Makes it possible to poll groups of tags at different intervals.

Always Active Prevents the tag from becoming inactive. This may be useful for actionsand scripting purposes. Note: The Active setting for the controller on theControllers tab is predominant over the Always Active setting for a particulartag.

Non Volatile Keeps the last tag value in memory even when the panel or controller ispowered off. Only available for internal tags.

Initial Value Makes it possible to assign a tag an initial value at system startup. Onlyavailable for internal tags.

Index Register Makes it possible to select a register from which an object is to collect theshown value.

Action Makes it possible to configure actions based on a condition of a tag.

Log to Audit Trail Logs operator actions on the tag. Only available if the Audit Trail function isactivated in the project.

Audit TrailDescription

Optional static or dynamic descriptions for operator tag actions, that aresaved in the Audit Trail database and visible in the Audit Trail Viewer. IfDynamicDescription is selected, value before change can be included inthe description by using {0}; value after change by using {1}. Only availableif the Audit Trail function is activated in the project.



4.1.7 AddingTagsduringEditing

Tags can be added directly when editing objects. When an object is selected, the tag association canbe managed from the Tag/Security group in the Home or General ribbon tabs, or by right-clicking onthe object and using the Mini Toolbar. In both cases, tags are added by clicking theAddbutton.

Note:Tags added during editing will stay internal until connected to a controller on the tags configuration page.

Related informationTag/Security Group

Mini Toolbar Options

4.1.8 SelectingMultipleTags

Multiple rows of tags can be selected using the [Ctrl] or [Shift] keys. This makes it easy to, forexample, delete a number of tags quickly.

4.2 TagActions

One or multiple actions can be configured depending on a changed value of a tag. The Action columnis displayed when theOthersbox is checked in the Tags configuration page.

Clicking ... in the Actions column for the selected tag brings up the Action properties window. First, acondition is configured by clickingAddunder Condition. Select a condition, enter a value and clickOK.



Note:Only integers are allowed for numeric values.ForBOOLandSTRING types, only the operands==and !=are allowed.

Note:A tag action which alters its own tag, may cause unwanted behavior and should be avoided.

Then, configure actions to be executed when the condition is met.


4.3 Internal Tags

Internal tags can be used to calculate values that need not be represented in the controller, forexample information only for the operator. Internal tags are selected in the same way as an externalcontroller tags. Any number of volatile user defined tags can be created.



Note:Internal tag values will not be saved in the HMI-panel when the project is restarted, unless theNonVolatileoptionis used.

Unlike the regular drivers, it does not matter if internal tags are used in consecutive order or not.

4.4 SystemTags

System tags are used to monitor or access variables from the system. System tags are handled asregular controller tags, i.e. can be used in screens, logged, included in scripts etc. The Date and Timesystem tags can be used when you want to use the controller clock in the panel project. The followingsystem tags are available:

System taggroup

System tag Description

Communication ErrorMessage

Latest communication error message

Communication Errors Number of active communication errors on allcontrollers

Communica-tion

Remote Alarm ServerConnection Errors

Number of remote alarm servers with connectionerrors, e.g. disconnected servers

Database Error Active Set to 1 when there is an active database error

Database Error Message Latest database error message

Database

Database Max SizeExceeded

Set to 1 when the database maximum size isexceeded

DateTime Current date and time

Day Day component of current date

Day of Week Day of current week (1-7 where 1 is Sunday)

Hour Hour component of current time

Minute Minute component of current time

Month Month component of current date

Second Second component of current time

Date and Time

Year Year component of current date



System taggroup


Current Screen Id The ID of the current screen.

The data type of this tag is int16 and it only hasread access. This tag gets updated every timeyou open a screen, with the exception on popupscreens. When opening a pop up screen the currentscreen id tag will not be updated. When enteringa screen without a screen id the tag value of thecurrent screen id will be set to -1. Note that 0 is avalid screen id.

Current Screen Name Name of the current screen

Latest Loaded Recipe Name of the latest loaded recipe

New Screen Id The ID of the new screen.

The data type of this tag is int16 and it has read/writeaccess. The tag is always active. When the newscreen id tag changes value a screen jump is madeto the screen with corresponding screen id. If nosuch screen exists a notification message will show.

If the new screen contains configured screeninstances (alias), the default instance is alwaysdisplayed.

Project

Project Name Name of the current project

Runtime Version Runtime version of framework

Screen Update Time Screen update time (in ms)

Available RAM Amount of available RAM memory (in kB)

Available Storage Amount of available storage memory (in MB)

Backlight Brightness Level Backlight brightness level (in percent)

When approaching 0% backlight, changes inbrightness level may no longer be noticeable in thepanel.

Complete dimming (to 0%) is only possible toachieve with the marine panel types, such as iXT7AM and iX T15BM.

CPU Load Amount of used CPU capacity (in percent)

CPU Load Core 1(2) Amount of capacity used in CPU Core 1 (in percent)




Current User The user name of the currently logged in user

System



System taggroup


Debug Logging Enabled Indicates if debug logging is enabled

Digital Output #1(2) Digital output

Digital Output #2(2) Digital output

Flash Memory EOL Info(2) Information about the flash memory end of life.The three possible values areNormal,Warning -Consumed80%of reservedblockandUrgent.

Flash Memory Life TimeUsed(2)

The usage of the device life time (in percent)

Internal Temperature (1) Internal panel temperature (in °C)

Physical RAM RAM memory installed (in kB)

Serial Number(2) Serial number of the panel

Storage Memory Storage memory installed in computer (in MB)

Used RAM Amount of used RAM memory (in kB)

Used RAM Percent Amount of used RAM memory (in percent ofphysical)

Used Storage Amount of used storage memory (in MB)

Used Storage Percent Amount of used storage memory (in percent of allstorage)

Windows CE ImageVersion

Windows CE Image Version

Power LED BlinkFrequency

Blink frequency of the power LED (1–10 Hz,0 = always on)

Power LED Blue Intensity Intensity of the blue power LED (0–100)

Power LED Red Intensity Intensity of the red power LED (0–100)

Power LED GreenIntensity(2)

Intensity of the green power LED (0–100)

Max Screen Cachememory load

Amount of memory available to the screen cache(in percent of the physical RAM memory available(50–90))

(1) Not applicable on AKI-CDA, AKI2G-CDA and AKI-CDC.(2) Where applicable, see available system tags for specific panel.

System tags are indicated by blue color in the tag list.

System tags are added by clicking theAddTag/AddSystemTagbutton in the tags configurationpage.

4.5 ArrayTags

An array tag is a tag containing multiple values.



If the array size is >1, the tag is considered as an array tag.

Note:Array tags are only supported by controllers which use addresses that can be numerically increased.

4.5.1 ArrayTagSetUp

Clicking theAddbutton adds a tag to the list. Make settings for each added tag. When predefinedvalues are available, these can be selected by clicking the arrow at the right of the table cell.

Clicking theDataType cell in theController column brings up the data type configuration page. Anarray tag is configured by setting the array size to a value >1.

Data type DescriptionData Type Selection of presentation format.

Size Set the array size.

Array Size If the array size is >1, the tag is considered as an array tag.

Limitation

When using controllers with named variables and accessing individual bits with the syntaxVariableName.BitNo, array tags of data type BOOL with bit addressing, are only supported for 16-bitstags.


Chart Object

Data Exchange



4.6 CrossReference

The Cross Reference tool provides an overview of where a specific tag is used in the current project.

All occurrences of the tag in the current project are listed. Double-clicking on an occurrence in the listautomatically brings you to the object or function where the tag is used.

The cross reference tool can be accessed by clicking the cross reference button on theTags tab or onthe View ribbon. It can also be accessed from the context menu.

4.7 Triggers

Triggers are used to determine when data exchange is to be performed; based on tag or a certaininterval.





Tag Selection of a tag, which when changed to a value other than 0,triggers data exchange

Time Time interval between data exchange operations in the format-d.HH:MM:SS.ff (days.hours:minutes:seconds.fractions of asecond). The minus sign is optional and indicates a negative timeinterval.

4.8 PollGroups

Poll groups allow grouping tags for polling at 5 different intervals. The groups defined on the PollGroups tab are available for selection from the Tags tab after checking theOthersbox.



Interval Polling interval in ms

4.9 StationHandling

For some controllers, it is possible for the operator to define from which controller station to read orwrite values. The station number is given as a prefix to the controller address.

The station number for each controller is defined on the Controllers tab of the Tags configuration page,by clicking theSettingsbutton.

The default station is set on theSettings tab, and the stations are defined on theStations tab.



Figure 4-1: In this example, from an Ethernet driver, Station 0 is the default station.

The default station is the station addressed without using a prefix. The other stations can beaddressed either as a fixed number or as an index register. With fixed station numbers, an object isalways connected to the same controller address, and only the value of this controller address canbe used in the object.

When addressing for example D10 in station 2, the following syntax is used: 2:D10



Related informationUsing Index Registers for Station Handling

4.10 IndexRegisters

With index addressing, it is possible for the operator to select from which tag an object is to collect theshown value. Without index addressing an object is always connected to the same controller address,and only the value of this address can be shown in the object.

Which tags to use for indexing are defined on the Index Registers tab of the tags configuration page.Up to eight different index registers can be used for each controller, and each index register can beused for more than one object. Index registers can be connected to any tag in the global tag list, but thetag has to be selected for each controller.



Tags are connected to index registers on the Tags tab.

In general index addressing can be formulated as:

Display value = the content in tag (the object’s address + the content in the index register)

If the content in the index register is 2, and the address of the tag specified in the object is 100, thevalue shown in the object will be collected from address 102. If the value in the index register ischanged to 3, the value in the object will be collected from address 103 instead.

4.10.1 IndexAddressingExample

Using index registers may be convenient when for example controlling torque and speed of a numberof connected motors from the same screen, without having to configure and display maneuverableobjects for each motor.

The following example is based upon the presumption of three motors, and the torque and speed ofeach motor is held in a different tag:

Motor 1 Motor 2 Motor 3

Torque Speed Torque Speed Torque SpeedD11 D21 D12 D22 D13 D23

1. Create a project where the Demo Controller is selected as controller.

2. Add tags and labels and connect them to Demo Controller tags according to below:



3. Select the Index Registers tab and connect Index1 to theMotorIndex tag (D0).

4. Select the Tags tab again and check theOthersbox in order to display the Index Registerscolumn.

5. Connect theTorqueandSpeed tags to Index Register 1.

6. Now, create a ComboBox object for selection of motor, and two analog numeric objects that willdisplay (or set) the Torque and Speed tags for each motor. Also add explaining labels.



7. ClickConfigureTexts for the ComboBox object, connect the object to the MotorIndex tag, andadd three texts and values according to below.

8. Connect the analog numeric objects to the Torque and Speed tags.

9. In order to test that the index addressing works even though no controller is connected, addmaneuverable objects, e.g. sliders, and connect them to the D11–D13 and D21–D23 tags.

10. Run the project, enter values for the objects connected to D11–D13 and D21–D23, and select thedifferent motors using the ComboBox.

4.10.2 Using IndexRegisters forStationHandling

For some controllers, it is possible for the operator to define from which controller station to read orwrite values. The station number is given as a prefix to the controller address.



This is stated either as a fixed number or as an index register. The default station is the stationaddressed without using a prefix. The other stations can be addressed either as a fixed number or asan index register. With fixed station numbers, an object is always connected to the same controlleraddress, and only the value of this controller address can be used in the object.

Index addressing reduces the number of tags needed as well as the number of objects to beconfigured in the Kollmorgen Visualization Builder project when showing values from / writing tomultiple controller stations.

The syntax when using index registers for station handling is for example I1:D10.

This means that the value in the controller address connected to Index 1 will point out which controllerstation number to read or write values.



Related informationStation Handling

4.11 Expressions

The Expressions functionality is used when connecting an object to a tag and the purpose is not to usethe tag value as it is. Expressions enable the user to e.g. extract a bit from a tag, add a dynamic offsetor gain, and then to use this value for a specific object.

Note:Static offset and gain for a tag is set in the tags configuration page.

The same expression can be connected to more than one object in the project.

4.11.1 Definition

An expression is a one line return statement in C#. The default expression code is “value”.

4.11.2 UsingExpressions

Right-click on an object and then click the button ... next toSelect Tag. The Expressions dialog isdisplayed.



ClickNew to create an expression and expression group (optional). Existing expressions areavailable from theSelectExpressiondrop-down menu. Use theEditandDeletebuttons to edit ordelete existing expressions.

Select among the tags, operators and functions to insert. It is also possible to type the expressionmanually, but without assistance from IntelliSense (auto completion). If an expression is not valid,an error message is given when validating the project. The expression is run, when the value of theoriginal tag that is connected to the object is changed.

Expressions added to an object in a project are available only in the current project. If an object with alocal expression is saved into the Component Library, the object can be used in an other project, butthe expression is not included. In order to reuse expressions, they have to be saved in the expressionslibrary.

Related informationLibrary Expressions

4.11.3 LibraryExpressions

Examples of expressions (how to extract bits from an int) are included when installing KollmorgenVisualization Builder and can be added to the project by clickingLoad.

Expressions can be reused in other projects by saving them in the expression library. Select theexpression in the drop-down list and clickSave. The expression is saved to a file in the PC. To load the



expression in another project, clickLoad. A selection dialog is displayed. Select the expression in thedrop-down list and clickOK.

If you have saved expressions to the library that you want to remove, clickDeleteand select amongthe saved expressions in a dialog. Expressions included when installing Kollmorgen VisualizationBuilder are not listed, since these cannot be deleted.

4.11.4 Limitations

An expression is executed only on read, i.e. when the value is changed in the controller.

When writing a value (from e.g. an analog numeric tag), the expression is not executed.

If another tag than the original tag is used in the expression, the expression is not triggered on its valuechange.

If an expression that is used in more than one location is either renamed or deleted, references are notupdated. A build error is given.

Expressions can be used for all data connections except for

• actions• the Property grid• recipe item tags• current language tag in Multiple languages configuration• trigger tags• index tags• scheduler tags• dynamic text for alarm items

Expressions use explicit bool comparison.

Example:Donotuse: value; Globals.Tags.Tag1.ValueUse: value != 0; GlobalsTags.Tag1.Vaule == 1

4.12 TagExpressions

Tag expressions are applied before reading or writing a tag value. Tag expressions should only beused on tags that have an associated address on a controller.

There are two different tag expressions, referred to as read expressions and write expressions. A readexpression is applied to a tag when the tag value is changed from the controller. A write expressionis applied to a tag when the tag value is changed from the user interface or script. When both a readexpression and a write expression are assigned to a tag it is strongly recommended that the readexpression is the inverse of the write expression and vice versa.

When using a write expression make sure the controller's data type matches any possible result fromthe expression. For example, the data type float should be used if the expression would multiply aninteger value with 0.1.

4.13 DataExchange

Data exchange between different controllers is supported. The data exchange can be performedwhen a digital tag is set, or at a certain time interval. Data exchange can be selected for individualtags, array tags or for the complete range of tags.



Note:The data exchange function is isolated from general tag/controller settings. For example, a tag assigned readaccess only for the operator, may still be read and written by the data exchange function.

Follow the steps below to set up data exchange with three different controllers involved:

1. Select theControllers tab of the tags configuration page and enter short names for thecontrollers in the ID column, and make sure that all controllers are active.

2. Select theTags tab and checkDataExchange to display the Direction and When columns.



3. Select an address that is represented in all of the controllers.

If an array tag is selected, the complete address range corresponding to the array size will beexchanged:



4. Click ... in the Direction column to set up the direction of the data exchange.

5. Add a trigger tag on the Triggers tab with time interval for data exchange or use a tag, which whengreater than 0, will trigger the data exchange. Alternatively, set up a trigger that includes bothvalue change and a time interval.



6. Return to the Tags tab and select which trigger to use.

Note:If the poll group contains many tag values that change frequently, the time required for them to be handled couldexceed the set poll time. This could lead to problems updating the data exchange between the controllers. Setthe Poll Group Interval to a higher value or use a time trigger to control the data exchange operations.

Related informationTriggers

4.14 ImportingandExportingTags

Tags can be imported to and exported from an Kollmorgen Visualization Builder project, to, forexample, be edited in Excel or a text editor, or to be transferred to another project. The complete taglist may be imported and exported, or the actions can be based on connected controllers.

The import function also allows selecting individual tags for import.

4.14.1 HandlingColumns

The import function allows skipping columns, or binding columns in the import file to any column inthe Tags configuration page.

TheNameandDataType columns must always be bound.

A column may only be bound once.

4.14.2 Saving the ImportConfiguration

For repetitive import actions the import configuration, e.g. how columns are bound and from whichrow to start the import, can be saved and reused. The import configuration is saved by clicking theSavemappingas importmodulebutton prior to performing the import. Next time the Import Tagsdialog is opened, the configuration is available from the Importmoduledrop-down list. Saving importconfigurations is valid only for files in text or Excel format.

Note:In order to import or export .xls-files Microsoft Excel must be installed.



4.14.3 Tag ImportExample

If the controller in the project is changed to a system with other names for the tags used, these must bechanged:

1. Click onTags in the Project Explorer.2. Click on the arrow to the right of the Import/Exportbutton to display the available options of

import and export operations.

3. SelectExport tags from the desired controller to export the list to a text file or an Excel sheet.Enter a file name and browse to a location. Define how the to separate the columns and whichcolumns to export. Use the arrows if you want to change position of the columns.


4. ClickExport.



5. Open the text file in a text editor or a spread sheet application.

6. Change all current tags to corresponding tags used in the new controller, and save the file.



7. Select Import tags to the desired controller and browse to the updated file. If desired, select arow from which to start the import. It is possible to rebind columns before importing to the project,and to exclude columns. These settings can be saved by clicking theSavemappingas importmodulebutton, and will then be made available for selection from the Import module drop-downlist at next import.

8. Click Import. It is now possible to deselect import of some tags.



9. In case there are name conflicts, these can be handled by changing the name, overwriting,merging or skipping conflicting items. The actions taken are saved to a log file for future reference.

Note:If you selectOverwrite, all settings for the existing tag will be overwritten. If you selectMerge, existing actions forthe tag will be kept.

The imported tags are now added to the current project.

Related informationBasic Settings

4.14.4 ImportingTags fromtheCommandLine

Tags can also be added to the current Kollmorgen Visualization Builder project using a commandline switch, by entering the following:

[Executable file] “Project location]\[Project name].kvb2”/ImportTags=”[Tag file location]\Tag file”

In this case, no application window is displayed, as long as the import is successful.

To open the project named Test1 with the tag file VarFile.txt in the directory C:\MyProjects, runKollmorgen Visualization Builder from the command line with the following arguments:

NeoIDE.exe “C:\MyProjects\Test1\Test1.kvb2” /ImportTags=“C:\MyProjects\VarFile.txt”



RemovingExistingController Tagsat Import

The /ImportTags command line switch may be used together with the switch /RemoveTagsNotInFile.This will remove all existing tags in the controller that are not included in the import file.

4.15 FilteringTags

A selection of tags can be displayed using the Filter Builder. Several conditions can be used, and thedifferent values/operators that can be used for making conditions are displayed when clicking onthe condition building blocks.

Operands and operator nodes are context sensitive. Name strings are not case sensitive. Values inthe filter builder are saved individually for each function during an edit session. A filter is built as alogical expression tree. A filter typically has operations on individual column values as leaf nodes andlogical operators serve as main nodes.

Perform the following steps to create a filter:

1. Click onTags in the Project Explorer.

The tag list is displayed in the desktop area.

2. SelectShowSelection from the Show Selection/Show All button to build a filter.

It is also possible to filter tags depending on tag name by typing in theFilterbox. The filtering affectsthe tags list directly as letters are entered in the box.

Figure 4-2: Only tags including “te” in their names are displayed

Figure 4-3: The filter indication when having entered “te” in the Filter box

Related informationFiltering Items

4.16 TagFormat

The following tag formats (data types) are available in the dialog for a tag, provided that the selecteddriver or OPC server supports the tag format.

Format Data type RangeDEFAULT Treated as INT16

Bit BIT 0 and 1



Format Data type RangeBit BOOL Values can be “false” (0) or “true” (1)(1)

Signed 16-bit INT16 -32,768 – +32,767

Unsigned 16-bit UINT16 0 – +65,535

Signed 32-bit INT32 -2,147,483,648 – +2,147,483,647(2)

Unsigned 32-bit UINT32 0– +4,294,967,295(2)

Float withexponent, 64-bit

DOUBLE 1.7 × 10308 (1)

Float withexponent, 32-bit

FLOAT ±3.4 × 1038 (1)

7 × Signed 16-bit DATETIME An Analog Numeric object can present the time format(1)

Syntax(3): <yyyy-MM-ddhh:mm:ss>7 consecutiveregisters are used to store a time:

Dx, seconds, 0–59

Dx+1, minutes, 0–59

Dx+2, hours, 0–23

Dx+3, day, 1–31

Dx+4, month, 1–12

Dx+5, year, 100–9999

Dx+6, weekday, 1–7

String STRING Storing character strings in tags. For this data type, size canbe selected.

(1)Controller representation for this type is dependent on the driver software.(2)Regarding resolution of values in 32-bit format: both Kollmorgen Visualization Builder and the HMI-panel canhandle up to six decimal digits of an integer 32-bit value. Remaining digits will be truncated or changed into zeros.(3)yyyy=year,MM=month,dd=date,hh=hour,mm=minute,ss=second.

For use in script code, the following table shows the type representation in C#. This is used when thereis a need to do a type casting, for example in calculations that are using overloaded operators.

C# type Data type Description– DEFAULT Treated as INT16

uint BIT C# does not have a “bit” type. In the controller this is a bit.

bool BOOL C# bool type that can have the values “false” (0) and “true” (1)

int INT16 16 bit, -32,768 – +32,767

uint UINT16 16 bit, 0–+65,535

int INT32 32 bit, -2,147,483,648 – +2,147,483,647

uint UINT32 32 bit, 0 – +4,294,967,295

float FLOAT 32 bit, ±3.4 × 1038

double DOUBLE 64 bit, ±1.7 × 10308



C# type Data type Description

DateTime DATETIME 7 elements are used to store a time

string STRING Storing character strings in tags


4.17 Aliases

An alias should be treated as a property of a screen and can act as a stand-in for a tag. The aliascan be used to reference a tag wherever that tag can be referenced directly. An exception to thisare foreground and background screens, where tags can be used but aliases not. When used,Kollmorgen Visualization Builder will act the same as if the original tag had been used. Each screenusing aliases can be configured with a different instance with different tag references.

Using aliases will enable reuse of screens without having to create a new duplicated screen.

4.17.1 CreatingAliases

Aliases are handled by clickingAliaseson the desktop view mode tab.

Figure 4-4: Desktop view mode tabs

Clicking theAddbutton adds an alias to the list. Make settings for each added alias. When predefinedvalues are available, these can be selected by clicking the arrow at the right of the table cell.

BasicSettings

EnterAliasnameandDefault value for the alias. If no default value is entered, the alias will betreated as a local screen variable.



Parameter DescriptionAlias Name Symbolic name. The name can be any alphanumeric string,


Default Value Selection of tags to create aliases of. If no tag is selected the alias willbe treated as a local screen variable.

Thedefault valuewill be the default value for the alias in the createdinstances. It will also be the reference for the default instance. SeeInstances.

Data Type Selection of data type. This setting is enabled by first clicking the DataType check box.

The data type will by default reflect the data type of the selectedDefault Value.

4.17.2 Instances

The aliases created in the project are presented in a table on the instances tab. It is possible to changethe value for the aliases in this tab, in order to override the default value configured in the aliases tab.

If a value for an alias is changed in the instances tab, the new value is displayed with bold text toindicate that it differs from the alias’default value.

To revert back to thedefault value, delete the value followed by pressing [Enter].Thedefault value can be changed in the aliases tab.

Parameter DescriptionInstance Symbolic name. The name can be any alphanumeric string,


Aliases The names of all aliases created in the project will be displayed in thecolumns headers. The values connected to the aliases will be listed ineach columns.

Using the “ShowScreen”Actionwith Instances

The "ShowScreen” action can be used to display a specific screen. For screens that have aliases,it is also possible to select which instance of the screen to use, and thereby also which set of tags toassign to the screen’s aliases.

TheDefaultoption is a virtual instance configured with the alias’ default values.



Figure 4-5: “ShowScreen” Action Parameters.

Related informationAction Groups

Limitations

• Aliases do not support array tags.• Aliases can not be used in connection with expressions.• Aliases can not be used with the Trend Viewer object.• Aliases can not be used on background screens.• No scripting support for value changed event on an alias.


Kollmorgen Visualization Builder | CONTROLLER

5 CONTROLLERHMI panels can be connected to many types of automation equipment, such as PLCs, servos, anddrives.

The expression controller is used as a general term for the connected equipment.

It is possible to connect a tag to more than one controller simultaneously. This makes it possible to usethe same application with different controllers. Controllers can be enabled and disabled in runtime. Aproject can contain multiple controller connections.

A project can also be connected to an external OPC server.

Related informationMultiple Controllers

External OPC Server

Internal Tags

5.1 AddingaController

When a new project is created, one of the steps is to choose which controller brand and modelto connect to. Clicking onTags in the Project Explorer, selecting theController tab displays theController configuration page.





ID Optional short name for controller; displayed in functions such asData exchange.

Active Selection of which controllers are to be active in runtime. Change ofactive controllers can also be performed in runtime using an actionor script.

Controllers are added and deleted using theAddandDeletebuttons.

ClickingControllerallows selecting another controller, andSettingsdisplays settings for theselected driver.

ClickingHelp in the driver settings dialog opens the help file for the driver.

5.1.1 NotifyWindow

If a communication error between the application and the controller is detected in runtime, this willresult in a communication error, and a Notify Window will be displayed in the HMI-panel. The NotifyWindow is a floating window that starts in the upper left corner of the screen. It is also used to displaythe alarm indicator.

The Notify Window can be moved to any position on the current screen.

5.2 DEMOController

The DEMO controller is used and selected in the same way as a regular controller driver, to design andtest a project directly on the development PC without connection to an external controller.

A number of predefined tags can be selected:

Data type Tag ID Description

BIT, BOOL M0 - M99 Digital tags

INT16, UINT16 D0 - D99 Analog tags

The DEMO controller also includes counters and digital tags with predefined functions:

Data type Tag ID DescriptionBIT M100 - M104 Toggles OFF and ON every 1,000 ms

INT16 C0 - C4 Counts from 0 to 100 with 1,000 ms interval bydefault; min/max values can be defined

5.3 ExternalOPCServer

OPC is an industrial standard created in a collaboration of automation hardware and softwaresuppliers. The standard defines methods for exchanging real-time automation data betweenPC-based clients using Microsoft operating systems.

An OPC server acts as a controller towards an HMI-panel.



5.3.1 OPCClassicClient

Settings for the OPC Classic client is made in theChooseControllerdialog.

SelectLocalhostwhen accessing an OPC server running in your local PC.

SelectRemoteServerwhen accessing an OPC server in the network environment, and clickBrowseto select the OPC server. ClickingRefreshmakes it possible to select the OPC server from the OPCServer drop-down list next time.

Add OPC server tags by clicking the small arrow at the right-hand side of theAddbutton on the Tagstab:

To validate tags from a remote OPC server in the Kollmorgen Visualization Builder project, return tothe Controllers tab and select the remote OPC server once more, and clickOK.

This procedure is necessary as the tags in the remote OPC server may have been changed sincethey were selected on the Tags tab.

5.3.2 OPCUAClient

Settings for the OPC UA client can be made in theChooseControllerdialog. Open the dialog byclicking theAddbutton on the Controllers tab.

Enter the URL to theOPCUA server.

ControllerSettingsDialog

The settings dialog for the OPC UA Server is available by clicking theSettingsbutton on theControllers tab.



Parameter DescriptionURL Enter URL to the OPC UA server.

Only UA TCP Binary is supported which means the URL must startwith “opc.tcp://”

Authenticationsettings Choose whether to use anonymous login or enter a user name andpassword to enable a secured login.

Namespacesettings This setting offers a possibility to declare a namespace URI and bindit to a prefix.

Namespaceseparator character: Enter a character to be used toseparate the namespace URI prefix from the tag ID when presentedon the tag tab.

TagViewsettings

Default namespace: Select the default namespace URI prefix to beused when entering a tag on the tag tab.

Maxsubscriptions: Enter the maximum number of subscriptionssupported by the server(1)

Subscriptionsettings

Max itemspersubscription: Enter the maximum number of itemsper subscription supported by the server(1)

(1) Please refer to the server manual for limitations

AddTags fromOPCUAServer

Add OPC UA server tags by clicking theAddbutton on the Tags tab.

Enter the Tag ID along with the preferred namespace URI prefix, defined in the controller settingsdialog. Make sure to separate the values with the separator character.

Example: “NS3:tag” .



The Tag ID, in the example above, corresponds withBrowseName in the OPC UA server.

If no namespace URI prefix is entered, the default namespace URI prefix as defined in the controllersettings dialog will be used.

Note:Array tags are not supported by OPC UA controllers.

SupportedFunctions

Data Access (UA part 8) is supported.

All variables of data types that are used in Kollmorgen Visualization Builder is supported. Read / writeof objects, structs and arrays is not supported.

Limitations

Limitation DescriptionBrowsing Browsing of servers / nodes is not supported.

Address input in GUI NameSpaceandBrowseName is used to identify a variable in theserver.

If this combination is not unique, the client cannot identify thevariable.

Related informationOPC UA Server



5.4 UpdatingDrivers

Note:Run as Administrator for Kollmorgen Visualization Builder when downloading or updating drivers. Administratoruser rights are needed since files in the Program Files folder are changed.

Drivers can be updated from a file.

Each driver takes up approximately 3.0 MB. To use the downloaded drivers, Kollmorgen VisualizationBuilder must be restarted.

5.4.1 UpdatingDrivers fromFile

When updating drivers from file only one driver at the time is updated. This can for example be used torevert to an older driver.

To install a new driver from file:

1. Click on the top left button and selectUpdateDrivers /FromFile to update available drivers to thelatest version.

2. Browse to the folder where the driver files are located.

A list of all drivers that can be installed is now shown.

3. Select the driver to install in Kollmorgen Visualization Builder.

MarkNewer selects the driver when there is a newer version than the currently installed.

4. Click Install.5. Run as Administrator when restarting the Kollmorgen Visualization Builder.

Related informationFile Menu

5.5 Synchronizing theControllerClock

In order to synchronize the controller clock with the Kollmorgen Visualization Builder project, thesystem tags hour, minute, second, need to be added to the project from the Tags configuration page.These are then connected to addresses in the controller.



When the value is changed in any of the system tags, they will be written to the controller.

Related informationSystem Tags

5.6 Changing IPAddressofaConnectedController from theCommandLine

The IP address of the connected controller may be altered using a command line switch includingthe IP address (e.g. /192.168.100.33), provided that the Modbus driver is used for Controller1. Thecommand is restricted to Controller1 and Station0. Only the Station0 IP address will be changed.

The IP address of the connected controller may be altered using the command line switch /controllerip(e.g. /controllerip=192.168.100.33), provided that the Modbus driver is used for Controller1. Thecommand is restricted to Controller1 and Station0. Only the Station0 IP address will be changed.


Kollmorgen Visualization Builder | WEB SERVER

6 WEBSERVERThe Web Server adds the possibility to use a server-side Application Programming Interface (API) tointeract with a running project. The API operates over the HyperText Transfer Protocol (HTTP) andcan be accessed from any compatible device. In addition, the web server can host web pages andrelated media to be consumed by web browsers.

The bundled Javascript Software Development Kit (SDK) makes it easy to build interactive web pagesthat utilize the API.

Login settings for the web server are available from Server group on the System ribbon tab.

6.1 WebServerConfiguration

The web server can be configured for hosting web pages. It also provides a login form forauthentication.

6.1.1 WebSiteConfiguration

For the web server to be able to host web pages, the content of the web site must be transferred usingFTP to a folder named “WebSite” residing in the FTP root directory.

The FTP server must be enabled and the web content can only be transferred after the application hasbeen deployed and started on the panel.

6.1.2 LoginForm

The web server provides a default login form that is used for clients to authenticate. It is also possibleto override the default and provide a custom web page that matches your overall design.

To override the login form, create an HTML file called “login.html” and place it in a folder named“Website” in the root of the FTP root directory.

This file will be used instead of the default when clients access the address “/login”.

The Javascript SDK provides tools for creating the form using a few conventions.

Note that this only applies if you have authentication enabled in the web server settings.

AuthenticationScript

Reference the authentication script

UsernameandPasswordField

Mark the username and password field with the predefined id’s “login.username“ and“login.password”:



LoginButton

Mark a login button with the predefined id “ix-login”. Any element can be used.

InvalidCredentials

Optionally add an element with the predefined id “ix-invalid-credentials” that will be shown if thelogin fails.

6.2 JavascriptSDK

The JavaScript SDK provides a rich set of client-side functionality for accessing the server-side APIcalls.

6.2.1 JavascriptSDKOverview

Javascript SDK makes it possible to build highly interactive web pages that uses tags defined in theproject.

1. The first step to build an interactive web page is to reference the SDK by inserting the followingscript into the header of the HTML.

Note:The SDK is bundled with jQuery 1.7 (http://jquery.com/).

2. Next, the SDK needs to be initialized. In its simplest form the following lines need to be added afterthe reference to the SDK:

This will make it possible to use the defined tag metadata attributes to incorporate the project tagsinto the web page.

The following line will, for example, insert the value of Tag1 into the HTML document:


http://jquery.com


TagValueorProperties

To insert the current value of a tag or tag property into an HTML element, thedata-ix-tagattribute canbe used. The value of the attribute should be the name of the tag as defined in the project and theproperty of a tag. Separate the names with a dot “.”.

If no property is provided, the value of the tag is used.

Formatting

Formatting of a tag value can be applied to a tag of numeric type or a datetime. The format is definedusing thedata-ix-formatattribute.

The following table describes the custom date and time format specifiers and displays a result stringproduced by each format specifier.

Tuesday, February 07, 2012 12:27:24 PM is used as input.

Tagvalue Description Resultd The day of the month, from 01 through 31. 07

D The abbreviated name of the day of the week (in english) Tue

j The day of the month, from 1 through 31 7

l The full name of the day of the week Tuesday

S Ordinal number for the date of the month (eg -st, -nd, -rd, -th etc) th

w Day of the week as a number. 2

z Day of the year 37

W Week of the year 05

F The full name of the month. February

m Gets the day of the month from 00 to 31 02

M The abbreviated name of the month. Feb

n The month of the year 1 to 12 2

t Number of days in the month 29

L Is leap year, 1 if true, otherwise 0 1

Y The year as a four-digit number. 2012

y The year, from 00 to 99 12

a The AM/PM designator lower case. pm



Tagvalue Description ResultA The AM/PM designator upper case. PM

g The hour, using a 12-hour clock from 1 to 12. 12

G The hour, using a 24-hour clock from 0 to 23. 12

h The hour, using a 12-hour clock from 01 to 12. 12

H The hour, using a 24-hour clock from 00 to 23. 12

i The minute, from 00 through 59 27

s The second, from 00 through 59. 24

X The milliseconds, from 000 through 999. 000

O Hours offset from GMT, with a leading zero for a single-digitvalue.

+0100

Z Timezone offset, in seconds 3600

q Quarter 1



The following table describes the custom numeric format specifiers and displays sample outputproduced by each format specifier:

ResultTagValue

DescriptionValue Format

4 00→04

4.5 0.00→4.50

0 Digit

.1 0.00 × 1000→1.00 × 10-01

# Digit, zero shows as absent 4 ##→4

. Decimal separator or monetary decimalseparator

4.5 0.00→4.50

5.55 0.0 × 1000→5.6 × 1000E Separates mantissa and exponent inscientific notation 1000000 0.0 × 1000→1.0 × 1006

1000 0,0→1,000, Grouping separator

1000 0,#→1,000

-5 plus;minus→minus

5 plus;minus→plus

0 plus;minus;zero→ zero

; Separates positive and negativesubpatterns

-5 0;(0.0);0.000→ (5.0)

700 [>500]###.##;[<1000]###;###.#→700.00

400 [>500]medium;[>1000]###;###.#→400

[] Custom subpatterns

1001 [>2000]high;[>1000]nor-mal;[>500]low→normal

SettingTagValue

To set the value of a tag, two elements must be defined.

The first element have thedata-ix-setterattribute on the position where the tag value can be entered.

The second element has thedata-ix-submitbuttonattribute used to submit the new tag value.

Thedata-ix-submitbuttonattribute takes the tag names, separated by comma “,”, to be submittedwhen the button is clicked. To submit all tags an asterisk “*” can be used.



iX-invalidStyle

Basic validation is done on input values. If the value cannot be assigned to the Tag then the valuewill not be set. To indicate an invalid value the framework will set the CSS class “ix-invalid” on theelement. This can then be used to provide the user with visual hints of the invalid state. For example,the following CSS snippet adds a red border around the input when the input is incorrect:

RefreshModes

To control how tag values are refreshed, thedata-ix-refreshattribute can be used with elementsdefined withdata-ix-tagordata-ix-setter.It is recommended to use the least frequent interval that is required by your project.

Advanced

iX.setup

After loading the JavaScript SDK, call iX.setup to initialize the framework. This will wire the tagmetadata attributes that you have defined in HTML and will start periodical polling if this is needed.

Parameters:

Name Type Descriptionoptions Object See the “Options” table below.

Options

Property Type Description Argument Default

refreshInterval Int The refresh interval of tag values inms. For performance reasons it isrecommended not to use low values forthis setting.

Optional 5000

refreshMode String Overrides the default refresh mode oftag values.

Optional onetime



Options

Property Type Description Argument Default

Accepted modes are: none,onetime,interval.

refreshModeSet-ter

String Overrides the default refresh mode oftag setters.

Accepted modes are: none,onetime,interval.

Optional onetime

Example:This example will set periodical refresh interval to 10 seconds, set the refresh mode of HTML elementsmarked with thedata-ix-tagattribute to interval and set the refresh mode of HTML elements markedwith thedata-ix-setterattribute to refresh only once.

iX.refreshElements

Refreshes the tag values of the provided elements manually. The attribute data-ix-refreshbutton canbe used to achieve the same function.

Note:Only an element that have been marked with a valid data-ix-tag or data-ix-setter can be refreshed. The value willbe refreshed regardless of the refresh mode set on the element.

Parameters:

Name Type DescriptionelementIds Array A list of strings containing the HTML element ids. If not

provided all tag elements are updated.

Example:This example show how you programmatically can achieve the same behavior as marking an elementwithdata-ix-refreshbutton. In the example, the HTML element with id "tag1Id" will be updated whenthe element with id "refreshButton" is clicked. This example uses jQuery (bundled with iX.js) to bind tothe click event of the "refreshButton"

In HTML:

In Javascript:



iX.refreshTags

Refreshes the tag values of the provided tag names manually.

Note:Only tags used in conjunction with data-ix-tag or data-ix-setter or created by iX.createTag can be refreshed.

Parameters:

Name Type DescriptiontagName String (Optional) A list of strings containing the names of the

tags to refresh. If not provided all defined tags arerefreshed.

Example:This example show how to programmatically refresh the tag values of "tag1" and "tag2". WhenrefreshButton is clicked the "tag1" and "tag2" will be refreshed even if the refresh mode was set to'none' when creating the tag.

iX.createTag

Creates a representation of a server-side tag on the client-side.

Parameters:



Name Type DescriptiontagName String The name of the tag in the project to create a

connection to.

valueRefreshedCallback Function Optional: Function that is called when the tagvalue has changed. The function is not calledwhen the tag value is the same as last checked.

Function may take two optional parameters. Thefirst parameter is the tag that changed the value,the second parameter is the old value of the tagbefore it changed.

refreshMode String Optional: Overrides the default refresh modeof tag. Accepted modes are: none,onetime,interval.Note that the more frequent refreshModeis always used. For example, if the tag iscreated withonetimebut an element definesdata-ix-refreshmode=”interval” for the sametag then the tag will have a refreshMode ofinterval.

Returns:

Type DescriptioniX.Tag An instance of iX.Tag. See Tag Class for a complete description.

Example:This example show how to display a warning if the value of "tag1" exceeds 70. The example is usingjQuery (bundled with iX.js) to hide and show the warning box.

iX.getTag

Retrieves a tag by name.

Parameters:

Name Type DescriptiontagName String The name of the tag to retrieve.

Returns:



Type DescriptioniX.Tag An instance of iX.Tag. See Tag Class for a complete description.

Example:This example shows how to retrieve an instance of a tag after it has been created. "tag1" and"tag1Again" will refer to the same tag instance.

iX.commitTagValue

Commits any unsaved tag values that was changed using iX.Tag.setValue for the provided tagnames.

Parameters:

Name Type DescriptiontagNames Array (Optional) A list of strings containing the names of the

tags to commit. If not provided all defined tags arecommitted.

Example:This example show how to commit changes to tag values on the server in a batch. Note that the valuemust match the data type of the tag on the server.

TagClass

iX.Tag is a class representing a Tag. The methods and properties of a Tag must be accessed throughan instance of iX.Tagand not the class itself. Typically a Tag instance obtained using iX.createTagoriX.getTagmethods.



iX.TagProperties

Name Type DescriptionisDirty Bool Flag indicating if the local value has been changed.

tagProperties Object An object with data retrieved from the server. See tagmetadata below. Note that these are only availableafter the first refresh. Also, only value is refreshed notall of the metadata.

value Flexible The value of the tag. The type of the value depends onthe data type in the project. Never use this property toset the value.

TagProperties:

Name Type Descriptioncontrollers Array An array of controller names that the tag is connected

to.

description String The tag description, null if not defined.

dataType String The tagdataType, e.g int16,datetime,defaultinitialValue Flexible The initial value of the tag, null if not defined.

readonly Bool True if the tag is read only, otherwise false

quality String Indicates the quality of the tag value: Unknown,Good,Bad

iX.Tag.setValue

Set the tag value manually. To commit the value to the server side call iX.commit.It’s vital that the value that is set corresponds to the data type of the tag.

Parameter:

Name Type DescriptionnewValue Flexible The new value. Must match the data type of the tag.

iX.Tag.subscribeToChange

Adds a callback that is called when the server-side value has changed.

Parameter:

Name Type Description

fn Function The callback to register

iX.Tag.unsubscribeToChange

Unsubscribe from changes.



Name Type Description

fn Function The same callback that was used with iX.Tag.subscri-beToChange

iX.Tag.refresh

Refreshes this tag. It is recommended to refresh tags in batch (using iX.refresh) instead of refreshingindividual tags.

iX.Tag.commit

Commit this tags value if the value has been changed. It is recommended to commit tags in batch(using iX.commit) instead of refreshing individual tags.

6.3 WebServiceAPI

Kollmorgen Visualization Builder provides a web service API.

6.3.1 RESTfulWebServiceAPI

The RESTful Web Service API is used for interacting with tags. The tags can be read or written tousing the HTTP verbsGET,PUTandPOST.GET to read tags,PUT to set the value of a tag orPOSTto perform batch operation.

6.3.2 General

AcceptedTypes

It is possible to negotiate which media type that will be returned as a representation of the resourcebeing retrieved. Use the Accept header in the request to specify the desired media type. text/html andapplication/json media types are understood as response formats for tag related resources.

A client request providing an unsupported media type will be responded with the following message:“406 - Not understood”.

6.3.3 RESTAPI

TagsResource

Lists tags available in the project.

TagsResourceVerbs: GET

Uri: /Tags



TagsResourceExample

TagResource

Resource for interacting with individual tags. To perform multiple operations on tags it isrecommended to useTagBatch resource instead.

TagResourceVerbs: GET, PUT

Uri: /tags/:name

GET params: Name: The name of the tag, e.g., Tag1 SystemTagDateTime

Name: The name of the tag, e.g., Tag1 SystemTagDateTimePUT params:

Value: The value to set the tag to, e.g., 12, "foo"

TagResourceExample

TagBatchResource

TheTagBatch resource is a resource used to perform batch operations on tags.



TagBatchResourceVerbs: POST

Uri: /tagbatch

includeMetadata: boolean indicating if only the tag value or the full tagmetadata should be fetched

getTags: List of tag names to return

POST params:

setTags: List name, value pairs representing new tag values.



TagBatchResourceExample



Note:The returned value (initialValue) for tags of datetime type is presented in the ISO8601 format.Example: "2008-09-22T14:01:54.9571247Z".Dates are always returned in UTC, Coordinated Universal Time.


Kollmorgen Visualization Builder | OBJECTS

7 OBJECTSStatic and dynamic objects that can be included in screens are available for selection from the Objectscontrol group of the Home ribbon tab.

Not all objects are visible in the normal view, but are made available by scrolling. Clicking the expandbutton displays all the objects, categorized into groups.

An object can be created by clicking on it in the Objects group and then clicking on the screen, or bydragging it from the Objects group and dropping it on the screen. This creates the object with defaultsize and appearance.



Dragging the object handles resizes it. Object appearance can be modified using the commands inthe Format and Font control groups, but also by the controls on the Dynamics ribbon tab.

Settings for a selected object can be managed with the control groups on the General ribbon tab, andactions can be configured from the Actions ribbon tab.

An object style that is to be used frequently can be saved as an Object Variation, in order toimmediately apply a predefined appearance to the object when creating it.

Related informationObject Variations

7.1 BlinkingObjects

Some objects can be displayed as blinking objects. Blinking is enabled for each object individuallyusing the Property Grid.

The Blink settings can be entered either from theGeneralgroup under theDynamics tab, or from theProperty Grid, underAnimations. In both cases selectingBlinkopens theEditBlinkDynamicsdialog.

Parameter DescriptionBlink Interval Constant blink intervals:

Time in ms from when the object gets invisible one time until it getsinvisible the next time. For HMI-panel projects, the minimum valueis 400 ms, and it is recommended to use a blink interval of a multipleof 400 ms to ensure a harmonic blink experience (400 ms, 800 ms,1200 ms, 1600 ms etc.). For controller, the minimum value is 200 ms.The default value is 1200 ms for all targets, and the maximum value is10,000 ms for all targets.

Blink intervals bound to a tag:




SelectTag forBlink Interval changes blink frequency based on theselected tag value.

Blink Enabled SelectTag forBlinkEnablemakes it possible to enable and disableblinking depending on the selected tag value:

When the tag value is equal to the given value (=True), blink isenabled. When the tag value is not equal to the given value (=False),blink is disabled.

Security has higher priority than blink, and an object hidden by security cannot be made visiblethrough blink.

It is not recommended to use Blink on objects that should be used for user interaction.

Related informationGeneral Group

7.1.1 Limitations forHMI-panelTargets

Blink is not supported for the following objects in HMI-panel targets:

Alarm Distributor Viewer Alarm Viewer Audit Trail Viewer

Check Box Combo Box Database Viewer

Group Box List Box Media Player

Pdf Viewer Progress Bar Radio Button

Web Browser - -

Related informationGeneral Group

7.2 Shapes

Static shapes such as Line, Rectangle and Poly Line can be used to draw background graphics.Tags can be linked to shapes under Dynamics, to change their appearance (e.g. color and position)depending on value changes of controller tags.

Points for an existing Poly Line object can be adjusted by selectingEditPoints from the context menu.

Ellipse Line Polyline Rectangle

Note:Bevel for Poly Line and Ellipse is only supported for projects designed for controller targets.



7.3 HMIControls

Dynamic objects such as buttons, analog numerics, sliders, meters and trend viewers are linked totags in order to create control and monitoring functions.

The tag associated with an object can be selected and changed from the Tag/Security group on theHome or General ribbon tabs, or from the context menu. Links to tags (controller tags, internal tags orsystem tags) are selected in the Tag drop-down list.

Objects containing text can be edited directly from the keyboard, either when just created, or when asingle selection is done on the text area of the object.

It is also possible to use script code to control the text contents of buttons, texts or text boxes.

Note:Use of braces around digits, such as ‘{0}’, is not allowed in text objects. This will result in an error when openingthe screen.

The following HMI controls are described:

Action Menu Object Alarm Viewer Object Analog NumericObject

Animated GIF

Animated LabelObject

Audit Trail Viewer Button Object Circular Meter Object

Chart Object Database ViewerObject

Digital Clock Object Linear Meter Object

Multi Picture Object Picture Object Roller Panel Object Slider Object

Tag Monitor Object Text Object Touch Combo BoxObject

Touch List Box Object

Trend Viewer Object

7.3.1 ActionMenuObject

The Action menu object is used to display multiple menu groups, each containing its own sets ofactions which can be triggered in Kollmorgen Visualizer RT from the action menu object.



Settings for the Action Menu object are available from the General ribbon tab while the object isselected:

SettingsGroup

Parameter DescriptionEdit Actions Opens the Edit Actions dialog

View type Choose between Bar, Expand and Tab

Item Width Set the width of the items. This is only available for the Bar andExpand View types.

Item Height Set the height of the items

Orientation Set the orientation of the items. This is only available for the Bar Viewtype.

Picture Width Set the width of the pictures for the items

Picture Height Set the height of the pictures for the items

ScrollBar Width Set the width of the scroll bar.

TouchSettingsGroup


Scroll Sensitivity Set the sensitivity of the scroll. Minimum value is 1, maximum value is10.

EditActionsDialog

The Actions tab in the Edit Actions dialog contains the following properties:

Parameter DescriptionText The text to be displayed for the item

Picture The picture to be displayed for the item

Make Transparent Set transparency on the item

Action Configure the action when the item is clicked

The Menu Groups tab in the Edit Actions dialog contains the following properties:


Menu Group Name The name of the menu group

Picture The picture to be displayed for the menu group

Make Transparent Set transparency on the menu group



Note:Make sure not to use semi-transparent pictures in projects targeted for HMI-panel. Since these targets do notfully support opacity, semi-transparent pictures may turn out unclear.

AddingaNewAction

In theEditActionsdialog select the Actions tab. Click theAddbutton. A new item will be added andplaced last in the list. To configure the actions for the item, click the “…” button in the Action column.

AddingaNewMenuGroup

In theEditActionsdialog select the Menu Groups tab. Click theAddbutton. A new menu groupwill be added and placed last in the list. The menu group will be displayed in the Actions tab as a newmenu group tab.

ActionMenuDynamics

It is also possible to set dynamics, i.e. tag dependent values for the Action Menu properties. Thesecan be found in the Dynamics tab in the ribbon bar.

Related informationDynamics Ribbon Tab

7.3.2 AlarmViewerObject

The Alarm Viewer is used to display and manage alarm items, for example indication of out-of-boundstag values. The viewer consists of a list area and a button area.


Alarm Viewer

7.3.3 AnalogNumericObject

The Analog Numeric object displays a box with a numeric or alphanumeric value. The value can beconnected to a tag.

Settings for the analog numeric object are available from the General ribbon tab while the object isselected:

DisplayFormatGroup

Parameter DescriptionType Selection of Integer, Decimal, String, Hex or Binary display format

Number of Decimals Maximum number of decimals to display in the object.

Only available when Type = Decimal. The number of decimals will berepresented by a “#” symbol on the analog numeric object.




Limit Characters to Makes it possible to maximize the number of displayed characters.The number of characters will be represented by a “#” symbol on theanalog numeric object.

Zero Fill Fills empty character positions with zeros, to let the maximumnumber of characters always be displayed

Note:The “LimitCharacters to” function, in combination with the string format type is not supported for the TraditionalChinese, Simplified Chinese and Simplified Chinese (Compact) languages.

Prefix/SuffixGroup


Prefix/Suffix Text value that will precede/follow the object value

Tag/SecurityGroup


Select Tag Connection to a tag from the tags configuration page

Select Security Groups Allows limiting access of the object based on security groups. If leftempty, the object can be accessed by anyone.

Select Visibility Configuration of visibility:

Default: The visibility specified on the General tab of the SecurityManager is used.

Disabled: The object is disabled for users with insufficient accessrights

Hidden: The object is invisible for users with insufficient access rights

Normal: The object looks normal also for users with insufficientaccess rights

FormatGroup


Auto Stretch Font Resizes the font to fit the height of the object. Default setting for theanalog numeric object.

Disable Operator Input Disables input in runtime

Transparent Makes the object transparent, i.e. makes the frame and backgroundcolor invisible



TextAlignmentGroup


Horizontal / Vertical Adjusts the object horizontally or vertically

ValidationGroup


On Input Input values are validated, based on Lower Limit and Upper Limit,when the box is checked

On Display Background color changes according to Other Colors on the Formattab if upper or lower limit are violated, when the box is checked

Lower Limit/Upper Limit Minimum/maximum value that can be entered in runtime whenOnInput is checked, or that will change the background color of theobject whenOnDisplay is checked

Note:The font size of the analog numeric object is auto-sized when resizing the object frame by default, and is notadjusted in the Font control of the Home ribbon tab. UncheckAutoStretchFont in the Text group first, and thenchange the font size on the Home ribbon tab.

7.3.4 AnimatedGIF

The Animated GIF (Graphics Interchange Format) object allows including a moving graphic picturein the Kollmorgen Visualization Builder project. Animated GIFs can be imported to the project bybrowsing the PC environment for graphic files. Imported animated GIFs are added to the ProjectPicture folder in the Component Library.

The Animated GIF can be connected to a tag which controls animation. When the value of theconnected tag is 0, then animation is turned off and the picture is displayed static in its initial design. AnAnimated GIF not connected to a tag runs animated continuously.

Settings for the Animated GIF object are available from the General ribbon tab while the object isselected:

SettingsGroup


Change Picture Opens a browse dialog for selection of picture

Reset Picture Restores original height and width to picture

Stretch Adapts height and width to the selection frame when resizing thepicture





Tag/SecurityGroup









7.3.5 AnimatedLabelObject

The Animated Label object is used to display an animated text label in Kollmorgen Visualizer RT.

Settings for the Animated Label object are available from the General ribbon tab while the object isselected:

Note:Using the animated label object creates a slightly higher load on the CPU.

Parameter DescriptionText The text to be displayed in the animated label

Animated If enabled, the text starts to animate

Animation speed Set the speed for the animation. Minimum value is 1, maximum valueis 32,767.

Animation Direction Set the animation direction:

From right to left

From left to right

From right to left to right

From left to right to left

From down to up

From up to down

From down to up to down

From up to down to up



AnimatedLabelDynamics

It is possible to set dynamics, i.e. tag dependent values for the Animated Label properties. These canbe found in the Dynamics tab in the ribbon bar.


7.3.6 Audit Trail ViewerObject

The Audit Trail Viewer displays information about operator changes that have been logged with theaudit trail function.


Audit Trail Viewer

7.3.7 ButtonObject

The Button tool draws a button with a text and/or picture. The button can be configured to perform aspecific task in runtime via the Actions ribbon tab or using script. The text on the button object can alsobe set to depend directly on a tag value using the General control on the Dynamics ribbon tab. If apicture is used, the picture file is added to the Project Pictures folder in the Component Library.

Settings for the button object are available from the General ribbon tab while the object is selected:

PictureGroup

Parameter DescriptionPicture Selects a picture to display on the button. Pictures from the Project

Pictures folder is available for selection directly. It is also possible tobrowse the PC environment for a picture.

SelectNoPicture to remove a previously selected picture.

Checking the Multi Picture check box will make it possible to displaydifferent pictures based on the value of a connected tag according tosection Configure Multi Pictures.

Multi Picture Multi Picture or single picture displayed on button.

Transparent Makes the picture transparent


ConfigureMulti Pictures

Different pictures can be displayed on the button based on the value of a connected tag, followingthe steps below:



1. Check the Multi Picture check box.

2. Click on thePicture control on the Picture group of the General tab.

3. Select a tag to control which picture to display.

4. ClickAdd to add pictures and configure start and end values for each picture. You can browse thePC for pictures, or select pictures from the current project.

5. ClickOK.

The picture on the button will now change according to the value of the selected tag. When thevalue is out of limits, no picture is displayed.

PictureAlignmentGroup


Vertical Alignment/Horizontal Alignment

Set alignment for the picture

Clicking the small arrow in the lower right corner of the Picture Alignment group displays the pictureproperties with a number of additional picture settings.

StyleGroup


Style Predefined graphical styles for the button

Appearance The appearance of the button, including possibility to make the buttonrounded and settings for each corner of the button.

Additional predefined styles for this object are found in theObjectVariationsgroup.



Note:When editing default button style properties, for example corner radius, appearance in runtime may sometimesdiffer from when designing the project in Kollmorgen Visualization Builder.


TextGroup

Parameter DescriptionText Text displayed on the button

Multiline Lets the text run over more than one line, using [Enter].Confirm the text entry by pressing [Ctrl] + [Enter].

Word Wrap Wraps the text to fit the width of the button

Configure Texts Links the displayed text to a tag. The Text field value is shown if theselected tag is not within the set limits

TextAlignmentGroup


Horizontal / Vertical Adjusts the text on the button horizontally or vertically

VisibilityGroup

Parameter DescriptionTransparent Makes the object transparent

CreatingaButtonwithMomentaryFunction

In order to create a button with a momentary function, you need to combine aSetTagaction for MouseDown with aResetTagaction for Mouse Up .




Script

Component Library

7.3.8 CircularMeterObject

The Circular Meter represents a numeric value, and displays the value of a connected tag.

Different styles can be used to change the graphical profile of the meter, and also if the meter is tobe full, half or quarter.

Figure 7-1: Circular meters in Black Full style, Chrome Half style and Vintage Quarter style

Settings for the meter object are available from the General ribbon tab while the object is selected:

AngularSettingsGroup


Start Angle / End Angle Determines the placement of the scale on the meter. The angularvalue is based on a start (0 degrees) at three o’clock, in a counterclockwise direction from there. The Start Angle must differ from theEnd Angle.

Text Rotation SelectParallel to let the numbers follow the outline of the meter, orNone to display the numbers aligned horizontally.

Clockwise Determines rotation orientation, clockwise or counter clockwise.

RegionSettingsGroup


Low Region / MediumRegion / High RegionMin/Max

Define colors for up to 3 regions, and at which values to start and stopeach region. Entering 0 for both minimum and maximum valuesdisplays no region color.



ValueScaleGroup


Min Value / Max Value Start/end value of scale.

These values can consist of one decimal digit.

Major Ticks Number of labeled scale marks on the meter

Minor Ticks Number of scale ticks between two adjacent major ticks

StyleGroup


Style Predefined graphical styles for the meter. The smaller styles areintended in particular to allow full visibility in the smaller HMI-panels.

Appearance The appearance of the meter; full, half or quarter

Additional predefined styles for this object are found in theObjectVariationsgroup.


NeedleSettingsGroup

Parameter DescriptionAnalog Animation Animation that creates a smooth movement of the needle at value

change.

Oscillation Animation of needle initially oscillating around the new value. Thefunction is only available in combination with Analog Animation.

WhenAnalogAnimation is selected, it is possible to activateShortestPath in the property gridunderAppearance. The setting affects the direction of the animated needle, resulting in a counterclockwise movement if this is the shortest path between two indicated values.

Note:The Shortest Path property is not available for controller targets.

Note:Using animation on the circular meter objects creates a higher load on the CPU. Therefore it is recommendedto limit the use of the needle animation to only a few circular meters per screen, especially for the smaller panelmodels.



Tag/SecurityGroup









VisibilityGroup


Scale When unchecked, the scale color of the meter is made transparent.Scale color is set from Other Colors on the Format tab.

7.3.9 ChartObject

The chart object is used to display values of connected array tags.

Settings for the chart object are available from the General ribbon tab while the object is selected:

ChartSettingsGroup


Edit Series Add, remove and edit the current series for this chart

Chart Types Choose chart type. Available types are:

Area

Area Horizontal

Bar

Bar Join

Donut

Histogram

Kagi

Line

Line Fast

Line Horizontal

Line Point

Pie




Points

Radar

Header Set the name that is displayed above the chart

3D View Set a 3D look and feel for the chart

XAxisSettingsGroup

Parameter DescriptionVisible Set the visibility of the X axis

Grid Visible Set the visibility of the X axis grid lines.

Automatic Automatically calculates the minimum and maximum X axis values.Overrides the Minimum and Maximum properties

Minimum Set the minimum value of the X axis. If automatic is set, this value isignored

Maximum Set the maximum value of the X axis. If automatic is set, this value isignored

Y1AxisSettingsGroup

Parameter DescriptionVisible Set the visibility of the Y1 axis

Grid Visible Set the visibility of the Y1 axis grid lines.

Automatic Automatically calculates the minimum and maximum Y1 axis values.Overrides the Minimum and Maximum properties.

Minimum Set the minimum value of the Y1 axis. If automatic is set, this valueis ignored.

Maximum Set the maximum value of the Y1 axis. If automatic is set, this valueis ignored. When using charts with visible labels on curves themaximum value is extended to make room for label.

Y2AxisSettingsGroup

Parameter DescriptionVisible Set the visibility of the Y2 axis

Grid Visible Set the visibility of the Y2 axis grid lines.

Automatic Automatically calculates the minimum and maximum Y2 axis values.Overrides the Minimum and Maximum properties.



Parameter DescriptionMinimum Set the minimum value of the Y2 axis. If automatic is set, this value

is ignored.

Maximum Set the maximum value of the Y2 axis. If automatic is set, this valueis ignored. When using charts with visible labels on curves themaximum value is extended to make room for label.

StyleGroup


Style Set the style of the chart

VisibilityGroup


Scale Set the visibility of the scale

Transparent Make the chart transparent

Header Set the header visibility

Legend Set the legend visibility

TheEditSeriesDialog

Clicking theEditSeries control in the Chart Settings Group will open the Edit Series Dialog. The EditSeries Dialog contains the following settings:

Parameter DescriptionName The name of the Series, as shown in the legend in the chart.

X Tag The X Tag values.

The tag must be an array tag.

The number of elements shown will be the lowest common denominator of theX Tag array size and the Y Tag array size.

Y Tag Optional: The Y Tag values for the chart.

The tag must be an array tag.

If this value is not chosen, the X Tag Values will still be visible and the Y Axiswill be set automatically. The number of elements shown will be the lowestcommon denominator of the X Tag array size and the Y Tag array size.

Size Optional: The number of elements in the tag arrays. This property overridesthe sizes of the X Tag array size and Y Tag array size. If this value is not set,the lowest common denominator of the X Tags array size and the Y Tags arraysize will be chosen as size.

Labels Set a label for each point in the chart. There is one label for each availabletag value.

Color Choose the color of the series.



Parameter DescriptionThickness Set the thickness of the series. This applies for the chart types Line, Line Fast,

Line Horizontal and Line Point.

Axis Type Select the Y Axis that this series will use.

Note:Chart objects with large arrays where values are frequently changing may affect performance.

Related informationArray Tags

7.3.10 DatabaseViewerObject

The Database Viewer can be used to display database contents in runtime.

For HMI-panel projects, only databases included in the current project are available. For controllertargets, it is possible to access databases from anywhere in the network environment.

Settings for the database viewer object are available from the General ribbon tab while the object isselected:

SettingsGroup


Show Controls When the box is checked, the user is able to select database anddatabase table in runtime

Database Path to database to be loaded automatically in runtime(1)

Table Name The table in the selected database to be loaded automatically inruntime(1)

Browse Data Table Opens a browse dialog for selection of database and databasetable in design time. The path and table name will be added to theDatabaseandTableName fields.

(1) If the entered database or table does not exist or is not valid, an empty database viewer is displayed in runtime.

Note:Simulation of the object on the development PC is supported only for controller targets.


7.3.11 DigitalClockObject

The digital clock displays date, time and/or day of week.

The time zone is selected on the System ribbon tab and is transferred to the target when the projectis downloaded to it. If no time zone is selected, the time zone that has been selected for the panelor controller will be retained.



The date and time display format (for example using AM/PM for time) is based on the operatingsystem settings. For HMI-panel projects, this format may be altered by selecting another region onthe System ribbon tab.

Note:For controller projects the region settings need to be changed in the system account to take place.

Related informationDate, Time, and Region Group

DisplayFormatGroup


DateAndTime / Date / Time Selection of date and time components

Show Day of Week When checked, day of week is displayed

Show Seconds When checked, seconds are displayed

7.3.12 LinearMeterObject

The Linear Meter represents a numeric value, and displays the value of a connected tag.

Different styles can be used to change the graphical profile of the meter, and also if the meter is to behorizontal or vertical.

Figure 7-2: Linear meters in Classic Horizontal style and Eclipse Vertical style

Settings for the meter object are available from the General ribbon tab while the object is selected:



ValueScaleGroup


Min Value / Max Value Start/end value of scale


Major Ticks Number of labeled scale marks on the meter


StyleGroup


Style Predefined graphical styles for the meter. The smaller styles areintended in particular to allow full visibility in the smaller HMI-panels.

Appearance The appearance of the meter; horizontal or vertical

Tag/SecurityGroup









VisibilityGroup

Parameter DescriptionTransparent Makes the object transparent; only indicator bar and scale will be

visible

Scale When unchecked, the scale color of the meter is made transparent.Scale color and indicator color are set from Other Colors on theFormat tab.

7.3.13 MultiPictureObject

The Multi Picture object allows using a set of pictures as an object. The pictures change in runtimedepending on intervals of a tag value.



Pictures can be imported to the project by browsing the hard disk for graphic files. Imported picturesare added to the Project Pictures folder in the Component Library.

Settings for the Multi Picture object are available from the General ribbon tab while the object isselected:

SettingsGroup


Configure Pictures Configuration of start/end values of intervals and selection of picturesfor each interval. Pictures can be selected from the Project Picturesfolder or from the hard disk. Transparency can also be set. Originalpicture size is displayed. TheAdd/Deletebuttons are used to addand remove items to/from the object.

Reset Picture Restores original height and width to picture.

Stretch Adapts height and width to the selection frame when resizing thepicture.

Lock Aspect Ratio Maintains the height/width ratio of the object.


Related informationComponent Library

7.3.14 PictureObject

The Picture object allows using a picture as an object. Pictures can be imported to the project bybrowsing the PC environment for graphic files. Imported pictures are added to the Project Picturesfolder in the Component Library.

The displayed picture can also be dynamic; depending of a set of pictures that have been linked tointervals in a tag value.

Settings for the picture object are available from the General ribbon tab while the object is selected:

SettingsGroup


Change Picture Opens a browse dialog for selection of picture

Reset Picture Restores original height and width to picture

Stretch Adapts height and width to the selection frame when resizing thepicture






7.3.15 RollerPanelObject

The Roller Panel object is used to display predefined texts for certain tag values.

Settings for the Roller Panel object are available from the General ribbon tab while the object isselected:

SettingsGroup

Parameter DescriptionTitle Set the title for the Roller Panel

Title Visible Determines if the title is visible or not

Loop Scroll Determines if the values will loop around or not

Disable Operator Input Determines if the Roller Panel is editable or not

TouchSettingsGroup


Scroll Sensitivity Set the sensitivity of the scroll

Scroll Friction Set the friction of the scroll

TextGroup


Configure Texts Opens the Configure Texts dialog

ConfigureTextDialog

The Configure Texts dialog contains the following properties:


Start Value The starting value for when this item should be selected

End Value The ending value for when this item should be selected

RollerPanelDynamics

It is also possible to set dynamics, i.e. tag dependent values for the Roller Panel properties. Thesecan be found in the Dynamics tab in the ribbon bar.




7.3.16 SliderObject

The Slider can be used to adjust a numeric value. The slider sets a value to a connected tag. If the tagvalue changes for other reasons, the slider control handle will show the actual value in runtime.

Figure 7-3: Sliders in Chrome and Eclipse Horizontal styles, and Vintage Vertical style

Settings for the slider object are available from the General ribbon tab while the object is selected:

ValueScaleGroup


Min Value/Max Value Start/end value of scale


Major Ticks Number of labeled scale marks on the slider


StyleGroup


Style Predefined graphical styles for the slider. The smaller styles areintended in particular to allow full visibility in the smaller HMI-panels.

Appearance The appearance of the slider; horizontal or vertical



Tag/SecurityGroup









VisibilityGroup


Scale When unchecked, the scale color of the slider is made transparent.Scale color and indicator color (color of the handle) are set from OtherColors on the Format tab.

7.3.17 TagMonitorObject

The Tag Monitor object makes it possible to show and set the values of tags in the system. This isuseful for making a system diagnosis.

Settings for the Tag Monitor object are available from the General ribbon tab while the object isselected:

ButtonGroup


Del Selected Delete the selected tag

Add Add a tag

Clear Delete all the tags

DisplaySettingsGroup


Configure columns Opens a dialog where it is possible to configure the columns in thetag monitor object

Show Column Headers Select if the column headers are to be shown in the tag monitor object



7.3.18 TextObject

The Text object is used to display read-only information for the operator. The displayed text can bestatic, or linked to intervals in a tag value that contain different strings. The text object can also be set todepend directly on a tag value using the General control on the Dynamics ribbon tab.

Settings for the text object are available from the General ribbon tab while the object is selected:

TextGroup

Parameter DescriptionText Text that the object displays


Word Wrap Wraps the text to fit the width of the object. Not available if Autosizeis selected.

Configure Texts Links the displayed text to a tag. The Text field value is shown if theselected tag is not within the set limits.

Auto Stretch Font Resizes the font to fit the height of the object. Not available if Autosizeis selected.

Auto Size Resizes the object according to the size of the default text stringlength and font size. Default setting for the text object.

TextAlignmentGroup


Horizontal / Vertical Adjusts the text in the object horizontally or vertically. Not available ifAutosize is selected.

7.3.19 TouchComboBoxObject

The Touch Combo Box object is used to create text selections from a drop-down list.

Settings for the Touch Combo Box object are available from the General ribbon tab while the object isselected:

SettingsGroup


Auto Size Item Height The Touch Combo Box will ignore the Item Height value and size thevalues automatically

Item Height Set the height of the individual items in the Touch Combo Box

ArrowBox Width Set the width of the Arrow Box

ScrollBar Width Set the width of the scroll bar



TextGroup



ConfigureTextDialog





TouchSettingsGroup


Scroll Sensitivity Set the sensitivity of the scrolling

TouchComboBoxDynamics

It is also possible to set dynamics, i.e. tag dependent values for the Touch Combo Box properties.These can be found in the Dynamics tab in the ribbon bar.


7.3.20 TouchListBoxObject

The Touch List Box object is used to handle a list of predefined texts.

Settings for the Touch List Box object are available from the General ribbon tab while the object isselected:

SettingsGroup


Separator Visible Show or hide a separator between the items in the Touch List Box

Item Height Set the height of the individual items in the Touch List Box

ScrollBar Width Set the width of the scroll bar

TouchSettingsGroup


Scroll Sensitivity Set the sensitivity of the scrolling



TextGroup



ConfigureTextsDialog





TouchListBoxdynamics

It is also possible to set dynamics, i.e. tag dependent values for the Touch List Box properties. Thesecan be found in the Dynamics tab in the ribbon bar.


7.3.21 TrendViewerObject

Trend viewers are used to display values of connected tags. Trend viewer curves represent tag valuesover time. A trend viewer object can show any number of trend viewer curves.

Note:A large number of trend viewer pens and short sampling intervals may affect communication performance.

Related informationTrend Viewer

Curves Group

Communication Performance

7.4 MediaControls

The media controls are used to display media files, pdf files and web pages in runtime. The followingmedia controls are described:

Media Player Object PDF Viewer Object Web Browser Object



7.4.1 MediaPlayerObject

Media files can be connected to the media player object, which allows selecting, starting and stoppingthe files in runtime. For HMI-panels, files in .mpeg1 and .wmv format are supported. The media filesare located in the Component Library.

BrowseFoldersGroup


Project Files Default option for browsing. The project files are listed in theComponent Library. At least one of the folders has to be chosen.

External Memory Card Select this option for browsing if project files are placed on an externalmemory card. At least one of the folders has to be chosen.

SettingsGroup


Media Source Select a media file to add to the media player, from the project filesfolder or by browsing the PC

Note:The object is not supported on AKI-CDA /AKI2G-CDA targets. Simulation of the object on the developmentPC is supported only for controller targets.

Note:Connecting a tag to a Media Player Object will cause the media player to try to play a media clip with a name thatcorresponds to the tag’s value, ignoring the configured Media Source parameter.

Scripting to theMediaPlayerObject

When scripting to the Media Player object, the name of the current media file has to be stated, forexample:

MediaPlayer1.Source = “Bear.wmv”;

Prior to running the script, the media file has to be added manually to the Project Files folder. Whenthe script is executed, the file will be copied to the output directory.

Events for the media player can be used, for example:

MediaPlayer1.Play();




7.4.2 PDFViewerObject

PDF files can be displayed in runtime using the PDF viewer object. The added files are availablefrom the Component Library.

Note:Adobe Reader 9 or later is required.

Note:PDF Viewer on Windows Embedded Compact 2013 panels (AKI2G-CDB) are not fully supported. There aresome limitations for display of table of contents, headings, table text and scroll bar.

BrowseFoldersGroup

Parameter DescriptionProject Files Default option for browsing. The project files are listed in the

Component Library. At least one of the folders has to be chosen.

External Memory Card Select this option for browsing if project files are placed on an externalmemory card. At least one of the folders has to be chosen.

SettingsGroup

Parameter DescriptionPDF File Select a PDF file to add to the PDF viewer, from the project files folder

or by browsing the PC

Buttons Select which buttons to make available in runtime

In an HMI-panel, all PDF files in the project files folder will be available for selection in runtime, if theOpen button is checked.

Note:When using a PDF viewer object in a popup screen, only the default style for the popup screen is supported.

Note:The object is not supported on AKI-CDA /AKI2G-CDA targets. Simulation of the object on the developmentPC is supported only for controller targets.


Popup Screen

Adobe Reader not Recognized



7.4.3 WebBrowserObject

Web pages can be displayed using the web browser. It is possible to set up the web browser withregular web browsing functionality, with selection of web addresses in a list or input via the virtualkeyboard. It is also possible to allow showing certain defined web pages only, or a local HTM/HTMLfile.

If certain characters are displayed incorrectly in the web browser, it is because the panel does notsupport the font in that language.

The virtual keyboard in Kollmorgen Visualization Builder is not used in the web browser object. ForAKI-CDC panels and controller targets we recommend using the Tablet PC Input Panel in Windows(found under Accessories > Tablet PC). Otherwise we recommend using an external keyboard.

Note:Microsoft Internet Explorer 9 or later is required.

SettingsGroup

Settings for the Web Browser object are available from the General ribbon tab while the Web Browserobject is selected:

Parameter DescriptionAddress The default web page of the web browser object.

Home The web page that will be displayed when the Home button ispressed.

Favorites Addition of web pages that will be available for selection from thedrop-down address field in runtime.

Address Read Only Checking the box disables entering text in the address field

Address Field Unchecking the box removes the address field in runtime

Go Button Unchecking the box removes the Go button in runtime

Home Button Unchecking the box removes the Home button in runtime

Back Button/ForwardButtons

Unchecking the box removes the navigation buttons in runtime

Referring to a local HTM/HTML file can be useful for example when the HMI-panel is not connected toInternet. The local file — a .HTM- or .HTML-file — has to be located in the Project Files folder of thecurrent project, and is addressed in the following format: “File://filename.html” where “filename.html”represents the actual file”, e.g. File://ReadMe.html.

WebBrowserLimitations

The web browser object functionality is limited under some circumstances:



Function Limitationdescriptioncontrollertargets HMI-panel targets

Web browserobject

Supported Not supported on AKI-CDAtargets

Popup windows Opening popup windowsfrom the web browser inruntime

Not supported Not supported

Web browser ina popup screen

Other styles than the defaultstyle for the popup screen

Not supported Not supported

Simulationof the webbrowser

Simulation on thedevelopment PC


Support ofsome webpages

Access of some web pagesfrom within the web browser.

Supported May not be supported. Ifthe web browser does notbehave as expected, it isrecommended to use thestandard Internet Explorer,available in the HMI panel,instead. The standardInternet Explorer can bestarted using theRunaction and executing theiesample.exe file.

Related informationPopup Screen

7.5 SpecialControls

The special controls are used to create attractive navigation facilities in runtime.

Navigation List Box Object Screen Carousel Object

7.5.1 NavigationListBoxObject

Screen navigation using the Navigation List Box object is performed via thumbnails, and scripting canbe used for advanced functionality.

Note:The object is supported only for AKI-CDC and controller targets.



GeneralGroup


Orientation Select horizontal or vertical orientation for runtime scrolling.

Scroll Tolerance Defines tolerance of pressing the touch screen (or scrolling with thecursor) slightly outside of a navigation list box item in runtime before thenavigation is actually carried out.

ItemSettingsGroup


Configure Items Definition of items included in the navigation list box object; see below.

Height/Width Size of the items in the navigation list box.

Margin Margin between navigation list box items.

Border Width Width of navigation list box item borders.

Corner Radius Corner radius of navigation list box items.

Show Text Selection of whether to show text below navigation list box items.

The individual items in the navigation list box object are handled by clickingConfigure Items. Use theAddandDeletebuttons to add and remove items to/from the navigation list box.

Parameter DescriptionPicture Selection of picture by browsing the PC environment or among the project

files.

Screen Selection of screen to navigate to.




Script Info Optional text to serve as a reminder if scripts are used.

Text Text displayed under each navigation list box item.

Only visible if Show Text is checked under Item Settings.

Use the up and down arrows to facilitate reorganizing of navigation list box items.


7.5.2 ScreenCarouselObject

Screen navigation using the Screen Carousel object is performed via thumbnails in a 3D view. Thescreen carousel can be configured to rotate automatically, or actions can be configured to controlscreen carousel behavior.

Note:The object is supported only for AKI-CDC and controller targets.

Note:If the Kollmorgen Visualization Builder system requirements for the graphic card are not fulfilled, the visualizationof the object will have limitations. Hardware acceleration is required.

GeneralGroup


Number of Visible Items Maximum number of visible items.

Scroll Duration (ms) Time used for an item to move to the next position in the carousel.

Use Reflection Adds a reflecting layout to the object.

Auto Scroll Makes the object rotate automatically.

ItemSettingsGroup


Configure Items Definition of items included in the screen carousel object; see below.

Height/Width Size of the items in the screen carousel.

Margin Margin between screen carousel items.

Border Width Width of screen carousel item borders.

Corner Radius Corner radius of screen carousel items.

Show Text Selection of whether to show text below screen carousel items.



The individual items in the screen carousel object are handled by clickingConfigure Items. Use theAddandDeletebuttons to add and remove items to/from the screen carousel.

Parameter DescriptionPicture Selection of picture by browsing the PC environment or among the

project files.

Screen Selection of screen to navigate to.

Script Info Optional text to serve as a reminder if scripts are used.

Text Text displayed under each screen carousel item.

Only visible if Show Text is checked under Item Settings.

Use the up and down arrows to facilitate reorganizing of screen carousel items.


7.6 DebugTools

Debug tools are used for troubleshooting and monitoring.

Alarm Distributor Viewer Object

–

7.6.1 AlarmDistributorViewerObject

The Alarm Distributor Viewer is a debug tool, used to display information from the Alarm Distributorfunction.




Alarm Distributor Viewer

7.7 WindowsControls

The following Windows controls are described:

Check Box Object Combo Box Object Group Box Object List Box Object

Progress Bar Object Radio Button Object Text Box Object

–

7.7.1 CheckBoxObject

The Check Box object controls a digital tag value. The connected tag gets the value 1 when the box ischecked and the value 0 when the box is unchecked.

The appearance of the text can be adjusted in the Font group of the Home ribbon tab.

Note:Changing font family is only supported for projects designed for AKI-CDC and controller targets.

Settings for the check box are available from the General ribbon tab while the object is selected:

TextGroup



Word Wrap Wraps the text to fit the width of the object. Not available if Autosize isselected.

Auto Stretch Font Resizes the font to fit the height of the object. Not available if Autosize isselected.

Auto Size Resizes the object according to the size of the default text string lengthand font size.



TextAlignmentGroup


Horizontal / Vertical Adjusts the text in the text box horizontally or vertically. Not available ifAutosize is selected.

7.7.2 ComboBoxObject

A Combo Box can be used to create selections from a drop-down list. When a keyboard is connectedto the HMI-panel it is also possible to make selections from the list by typing.

Settings for the combo box are available from the General ribbon tab while the object is selected:

TextGroup

ClickConfigureTexts to enter texts for different values.

Select a tag, and then clickAdduntil there are enough rows in the table. Enter texts and start values.

It is also possible to use script code to control the contents of a combo box.

Example

The following script code relies on the existence of a combo box (ComboBox1) and a set of predefinedrecipes (“Book” and “TV”).



When the screen opens, the script clears the box and writes the recipe name strings in the box.Selection from the combo box triggers loading of a recipe.


Recipe Management

7.7.3 GroupBoxObject

The Group Box is used to draw a labeled frame around a group of objects.

7.7.4 ListBoxObject

The List Box handles a list of predefined texts.

TextGroup

ClickConfigureTexts to enter texts for different values.



Select a tag, and then clickAdduntil there are enough rows in the table. Enter texts and start values.

It is also possible to use script code to control the contents of a list box.

Example

The following script code includes two objects on Screen1, a button (Button1) and a list box (ListBox1).

When the button is clicked, the script is triggered and a string is written to the list box and the valueof an internal counter (count) is incremented.


7.7.5 ProgressBarObject

The Progress Bar displays a meter without numeric scaling, representing an analog value. The valuecan be connected to a tag.

The other properties, such as orientation, minimum and maximum values, and meter color(foreground property) are set in the Property grid.



Related informationProperty Grid

7.7.6 RadioButtonObject

A Radio Button controls the value of a connected digital tag.

The appearance of the text can be adjusted in the Font group of the Home ribbon tab.

Settings for the radio button are available from the General ribbon tab while the object is selected:

TextGroup



Word Wrap Wraps the text to fit the width of the object. Not available if Autosizeis selected.

Auto Stretch Font Resizes the font to fit the height of the object. Not available if Autosizeis selected.

Auto Size Resizes the object according to the size of the default text string lengthand font size.

TextAlignmentGroup


Horizontal / Vertical Adjusts the radio button text horizontally or vertically. Not available ifAutosize is selected.

It is possible to use script code to make a group of radio buttons enable combined control of a tagvalue. Exactly one of the radio buttons is active (set to 1) at any time. The following example includes 3radio buttons and a tag of int16 type.



Radio buttons are grouped based on which screen they belong to.


7.7.7 TextBoxObject

The Text Box is used to include a box with multiple rows of text.

By default, the text can be modified when clicking on the box in runtime. The entered text is not savedin runtime; when the screen changes the value will be reset. The text box can also be configured asread-only.

Settings for the text box object are available from the General ribbon tab while the object is selected:



TextGroup



Word Wrap Wraps the text to fit the width of the object

Read Only Disables input in runtime

TextAlignmentGroup


Horizontal / Vertical Adjusts the radio button text horizontally or vertically

VisibilityGroup

Parameter DescriptionTransparent Makes the object transparent, i.e. everything but the text will be invisible

7.8 AdditionalControls

Kollmorgen Visualization Builder allows using and creating third party controls in order to enhanceapplication functionality and additional customization. This section describes different technologiesand includes configuration examples.

To understand and use all the information in this document, .Net development skills are required.

Caution:Kollmorgenonlyoffers support for theexamplesdescribed in this chapter.

Related informationReferenced Assemblies

Error Related to Third Party Controls

7.8.1 TargetPlatform

Different technologies are used for third party controls depending on the target platform for theKollmorgen Visualization Builder application. The target can be either PC or Windows CE.

controller

Two different technologies can be used for a controller:

• Standard Windows forms and GDI+• WPF (Windows Presentation Foundation)

WPF uses vector graphics, and the appearance of the control is described in XAML. Since KollmorgenVisualization Builder is a WPF application, it is recommended to use WPF when developing



customized controls or user controls for a controller. Controls developed in WPF can bind to a tagvalue in Kollmorgen Visualization Builder, in opposite to Windows forms controls, that cannot bebound to tag values.

WindowsCETarget

Windows CE only uses the .Net Compact Framework (a subset of the .Net Framework used on a PC),and does not support vector graphics (WPF). GDI+ is not supported on Windows CE target.

Limitations

Some of the limitations regarding third party controls are listed below:

• Control Designers (a designer class that can extend design time support) are currently notsupported.

• Type Converters in a separate design dll are not supported.• Complex property editing in the property grid is not supported. All complex properties have to be

set up in script.• .Net Compact Framework controls can include design dll and so called AssmetaData dll to handle

attributes that are not supported in Windows CE. Currently this is not supported by KollmorgenVisualization Builder. Because of this, it is important to always test the code on the target platform.

• The Script Editor allows scripting against properties and methods that are not supported inWindows CE. Because of this, it is important to always test the code on the target platform.

7.8.2 AddingControls to theKollmorgenVisualizationBuilderToolbox

Third party controls can be added to the Objects toolbox in Kollmorgen Visualization Builder, followingthe steps below:

Caution:Kollmorgenonlyoffers limitedsupport for thirdpartycontrols.

1. Select theObjectsgroup on theHome ribbon tab, and fully expand the Objects toolbox by clickingthe lower right arrow.



2. ClickAddControl.



3. Select controls to add among the default controls, or clickBrowse to add customized controls.

4. ClickOK.

The added controls are now available underAdditionalControls in the Objects toolbox.

7.8.3 DefaultControlsand InstalledControls

Default controls include controls added by the user and the .Net 4 controls installed with the .NetFramework.

Installed controls include all controls that are installed in the GAC (Global Assembly Cache) on yourcomputer.

Note:Third party controls that are used in a project are not copied to the project folder. This means that it is not possibleto open a project with third party controls on another development PC without installing the controls. But theapplication will work in runtime on another target, since references are copied to the output folder when buildingthe project.

7.9 WPFControls

WPF (Windows Presentation Foundation) uses vector graphics, and the appearance of the control isdescribed in XAML. Since Kollmorgen Visualization Builder is a WPF application, it is recommendedto use WPF when developing customized controls or user controls for a controller. Controlsdeveloped in WPF can bind to a tag value in Kollmorgen Visualization Builder.

User controls and custom controls are supported in WPF.



7.9.1 WPFUserControls

A WPF user control can be described as a composition of different user interface controls. Creating aWPF user control is similar to creating a window:

• You have a XAML file and C# class file for a user control.• The class file extends the user control class, adding additional behavior and properties.• The XAML file encapsulates the composing controls; styles, templates, animations and whatever

necessary for “Look & Feel”.

7.9.2 WPFCustomControls

WPF custom controls are more flexible, but are more complicated than a user control, and require aprofound understanding of the WPF user interface model.

• A number of certain user interface controls, such as button, progress bar or speedometer hasto be extended.

• The appearance of the custom control has to be defined in XAML, as the custom control itselfhas no look.

Most of the controls in Kollmorgen Visualization Builder are custom controls, which makes it possibleto restyle them to various different layouts without changing the code files; just the XAML.

Figure 7-4: A rounded meter in different styles

7.9.3 CreatingaWPFUserControlwithTagConnection

The following example describes how to create a WPF user control that can be connected to a tag.

The complete code is included at the end of the example.



1. Start Visual Studio to create a new project, and selectWPFUserControl Library.

2. Add [DefaultProperty("Value")] to the class, to define which property the tag should set whenthe value is set.

3. Add a dependency property with same name as the attribute above:static readonly DependencyProperty ValueProperty;

4. Add a static constructor and register to the dependency property.

5. Create a Value property of type object.

6. Open the tab of the .xaml file.

7. Add a TextBox to the user control.

8. Set the name of your control.

9. Add a binding to the TextProperty and bind to the Value Property.

10. Remember to change ElementName to the name of your control.

11. Compile and test by adding the control to the Kollmorgen Visualization Builder toolbox.

Note:When an update is made, the existing control must be updated underC:\Users\Public\Documents\Kollmor-genDanaherMotionServotronixLtd\KollmorgenVisualizationBuilder\Thirdparty\



ExampleCode

7.9.4 CreatingaWindowsFormsUserControl for acontrollerTarget

The following example describes how to create a Windows Forms user control designated for acontroller target.

Note:Windows Forms control objects are placed on top of WPF control objects in controller targets.



1. Start Visual Studio to create a new project, and selectWindowsFormsControl Library.

2. Add a TextBox and a Button to the design surface.

3. Add Event Handler for Button click.

4. Add Event Handler for TextBox lost focus.



5. Add a Value Property and INotifyPropertyChanged implementation:



6. Use the following code to connect the control to a tag value in Kollmorgen Visualization Builder:

The code shows how the value is set on the user control when the tag changes its value, and howthe tag value is changed when the user control changes its value.

7.9.5 CreatingaWindowsFormsUserControl for aCETarget

The following example describes how to create a Windows Forms user control designated for a CEtarget (a AKI-CDA AKI2G-CDA and AKI2G-CDBor AKI-CDB HMI-panel)

Note:Windows Forms control objects are placed on top of control objects created with the Kollmorgen VisualizationBuilder software.



1. Start Visual Studio 2005 or 2008 to create a new Smart Device Project.

2. SelectWindowsCE for Target platform.

3. SelectControl Library.



4. Use the same code as in the Creating a Windows Forms User Control for a controller Target ex-ample.

Note:Always test your code on the target platform, as properties/methods currently not supported may be includedin the code. See Limitations for details.


Kollmorgen Visualization Builder | RIBBON TABS

8 RIBBONTABSEach of the ribbon tabs holds a set of one or more groups. Each group holds a set of one or morecontrols that are used to manage screens and functions in a project.

The behavior of the ribbon tabs can be configured to be context dependent using theOptionsbuttonin the File menu.

Double-click on any of the ribbon tab headings to collapse the ribbon area. A double-click on a ribbontab, when the ribbon is collapsed, brings back the original style. This can also be changed from thecontext menu of the Quick Access toolbar. Tooltips are displayed for all controls on the ribbon tabs.The tooltip offers a brief description of the selected control.

Kollmorgen Visualization Builder contains the following ribbon tabs:

Home Ribbon Tab

Project Ribbon Tab

System Ribbon Tab

Insert Ribbon Tab

View Ribbon Tab

Dynamics Ribbon Tab

General Ribbon Tab

Actions Ribbon Tab

Related informationOptions

Quick Access Toolbar

8.1 HomeRibbonTab

The Home ribbon tab contains groups of controls for editing screens in the project:

Clipboard Group

Screen Group

Objects Group

Font Group

Format Group



Tag/Security Group

Name Group

8.1.1 ClipboardGroup

The Clipboard group contains the paste, cut, copy and format painter controls.

Cut

Cuts the selection to the clipboard. Also available from the keyboard with [Ctrl] +xor from the contextmenu.

Copy

Copies the selection to the clipboard. Also available from the keyboard with [Ctrl] +cor from thecontext menu.

Paste

Copies the clipboard to the current screen. Also available from the keyboard with [Ctrl] +vor fromthe context menu.

Note:Text from a compatible source, e.g. clipboard text, will be converted to a Text Box object when pasted into ascreen.

FormatPainter

The Format Painter control is used to copy formatting from one object to another. This is useful whencreating a uniform appearance for objects.

To apply formatting to another object:

1. Click on an object with the desired format and font properties. Click on theFormatPainter control.The mouse pointer changes to a paintbrush.

2. Click on the object to format.

The format properties from the first object is applied to the selected object.

Format and font properties can be copied between objects of different types, for example from arectangle to an HMI control.

Note:Modification to an object using theOtherColors control is not applied when using the Format Painter.



Related informationOther Colors

8.1.2 ScreenGroup

The Screen control group contains the add screen, background screen, delete screen and currentlanguage commands. Screens can also be added and deleted from other controls, such as theNavigation Manager and the context menu of the Project Explorer.

AddScreen

TheAddScreen command creates a new empty screen that opens for editing. Clicking the lower partof the Add Screen button shows a selection of screen templates that are available for selection.

DeleteScreen

TheDeleteScreen command removes the current screen from the project, and also disconnects anyassociations from other screens to the removed screen.

Note:A deleted screen cannot be restored with the Undo command.

BackgroundScreen

Any screen can be used as background to the current screen.

All objects in a background screen will work as designed in the project application. Objects in abackground screen must be edited in the screen that they reside in. Objects in a background screenwill be dimmed in the current screen in the development environment.

CurrentLanguage

Current language is the language that is being used at the particular moment that the project isdesigned. If multiple languages are not used in the project, onlyDefault is available.

Related informationScreens

Language Management

8.1.3 ObjectsGroup

The Objects control group contains static and dynamic objects that can be added to a screen.




8.1.4 ObjectVariations

For many of the objects it is possible to apply a preset style, using theObjectVariations feature. Forthe Button object and the Circular Meter object there is a large number of different styles available asdefault, whereas for most other objects it is possible to save user-defined styles.

To display theObjectVariationsmenu, click on one of the objects in theObjectsmenu. TheObjectVariationsmenu appears to the right of theObjectsmenu, provided that there are some stylesavailable for the selected object.

To add user-defined styles in theObjectVariationsmenu:

1. Select an object to start from.

2. Modify the object, using the tools under theHome ribbon tab or thePropertyGrid.

3. Select the designed object and right-click to open the context menu.

4. SelectSaveVariations to save the modification.



The new variation will appear in theObjectVariationsmenu when clicking on the object type itoriginated from.

Objects supportingSaveVariationRectangle Ellipse Analog Numeric Button

Text Linear Meter Slider Circular Meter

Trend Viewer Chart Action Menu Animated Label

Digital Clock Alarm Viewer - -

The object properties are shown in thePropertyGrid. When saving the variation the followingproperties are saved (when applicable):



Variationssaved (whereapplicable)

Color Font Rotation Size

Visibility Security groupsrequired

Audit trail description Delay Mouse/ TouchInput

Visibility on accessdenied

Opacity Horizontal and verticalalignment

Picture horizontal andvertical alignment

In addition to the general properties listed above, a number of object specific properties are saved:

Object Property

Action Menu Object View type

Orientation

Alarm Viewer Object Button position

Analog Numeric Object Limit number of characters

Number of characters

Number of decimals

Prefix

Suffix

Animated Label Object Animation direction

View type

Chart Object Chart type

3D view

Show header

Show legend

Show scale

Digital Clock Object Display format

Show seconds

Linear Meter Object Orientation

Scale

Transparency

Slider Object Orientation

Scale

Transparency

Text Object Horizontal alignment

Vertical alignment

Trend Viewer Object Major value ticks

Minor value ticks

Rectangle Radius

Effects



Note:Features only supported in PC environment might not work on other platforms.


8.1.5 FontGroup

All fonts available in the development PC are available for selection when designing the project. Allfonts used in the project are included when downloading the project to the target.

Note:For controller and AKI-CDC non-standard fonts are not transferred or installed to the target. Install non-standardfonts manually on the target.

Note:The number of fonts needs to be considered when calculating the total size of a project.

Note:The default font Tahoma does not support Chinese characters in HMI-panel projects in runtime. The font has tobe changed to a font that supports Chinese characters, e.g. MS Song. Keep in mind that some fonts requirea lot of project memory.

TheFontgroup is used to change text style. The text style is defined for the currently selected object.

Font andFontSize

Select font from the drop-down list. Use the increase/decrease font size buttons or set a specific fontsize.

Note:Objects, for whichAutoStretchFont is selected, will not be affected by these settings. The font size will beautosized when resizing the object height.

Style andColor

An italic, underlined or bold style can be selected for the text. The style stays regular if all the boxes areleft unchecked. Use the Font Color drop-down list to set the color of the text.



8.1.6 FormatGroup

The Format group controls the color and position of a selected object. Predefined quick styles offerselection of uniform appearance for different objects. Selection of multiple objects makes it possible toeasily affect more than one object at the same time.

Clicking the small arrow in the lower right corner of the Format group displays the shadow, fill andoutline properties with a number of additional format settings.

It is possible to use the Format Painter (in the Clipboard group) to copy color and font properties fromone object and paste it to another object.

Related informationSelecting Multiple Objects

Arrange

The Arrange control can be used to order, group, resize, align and distribute screen objects.



OrderObjects

The commands in the Order Objects group are used to send objects to the front or back of each other.

Command Description

Bring to Front Positions the selected object on top of any overlapping objects

Send to Back Positions the selected object behind any overlapping objects

Bring Forward Makes the selected object swap place with the nearest overlapping object

Send Backward Makes the selected object swap place with the nearest obscured object



Note:The Object Browser offers an easy way of arranging objects to the front or back of each other.

Related informationObject Browser

GroupObjects

TheGroupObjects commands are used to manage selections of multiple objects. A grouped objectis moved and treated as one object with respect to formatting and resizing, and can also be storedin the Component Library for reuse.

Any selection of objects on the screen can be grouped.

When multiple objects are selected, one object is the primary selection. This is shown with an orangeframe, while other objects in the group have blue frames. Click on any object in the group to changethis to the primary selection.

A grouped object can be resolved into individual objects using theUngroup command. A propertythat was given to the group will be kept by each of the object, provided that the property is applicable.

MakeSameSize

TheMakeSameSize commands are used to adjust the size of a group of selected objects. The sizewill be determined by the primary selection (the guide object).

PositionObjects

ThePositionObjects commands can be used to align and distribute multiple objects neatly.Objects can be aligned vertically and horizontally using the primary selection for the group asguide object. Objects can be aligned with respect to their center (center/ middle) or their edges(top/bottom/right/left).


Snap Objects to Other Objects

Grid

QuickStyles

TheQuickStyles control contains a number of preset visual object color schemes that can be appliedto screen objects.

The predefined graphical styles make it possible to achieve a uniform appearance on items likemeters and trend viewers. An object that has a style applied can be further customized, for examplewith font settings.

It is also possible to customize the predefined styles to styles of your own preference. The quick stylesare not specific to the current project. They will be available for all Kollmorgen Visualization Builderprojects.



Note:Controls in the Style group on the General tab can be used to reshape objects such as meter, slider and trendviewer to predefined styles. These styles are not the same as the quick styles.

Related informationFont Group

OtherColors

Color settings for special properties of an object, for example scale color for a meter or out-of-rangevalidation of an analog numeric object, are available from theOtherColors control.

ShapeFill

TheShapeFill control is used to alter the fill color and gradient of the selected shape. A preview ofthe colors in the Shape Fill selection window is displayed directly on the object on the screen as thepointer hovers over the different colors.

ShapeOutline

TheShapeOutline control is used to alter the outline color and outline width of the selected shape.

ShapeEffects

ShapeEffectsmakes it possible to add bevel style and shadow effects.

Note:Bevel in combination with fill color “no fill” is only supported for AKI-CDC and controller targets. The bevel willnot be visible in runtime on other HMI-panel targets.

8.1.7 Tag/SecurityGroup

Connection to controller tags as well as object access (based on security groups) and visibility areconfigured from theTag/Securitygroup.

Figure 8-1: Tag/Securitygroup without and with selections




Select Tag Connection to a tag from the tags configuration page. Tags may alsobe added directly, but will be remain internal until connected to acontroller tag. Click ... to configure expressions.



Default: The visibility specified on the General tab of the SecurityManager is used




Note:When access rights are not fulfilled, showing an access denied message or opening a login dialog can beconfigured using the security function.

Related informationExpressions

Adding Tags during Editing

Security Management

8.1.8 NameGroup

All objects and screens are automatically named when they are created. The name is displayed andcan be edited in the Name group. Screen names can also be edited in the Project Explorer.

The name of an object is a symbolic identifier and is an alphanumeric string, beginning with a letter.Name strings can contain letters (a-z, A-Z), numbers (0-9), and underscore (‘_’) characters.

Note:Renaming objects and screens included in scripts will cause the scripts not to function.


Invalid Names



8.2 ProjectRibbonTab

The Project ribbon tab contains a number of project related functions, divided into the followinggroups:

Run Group

Transfer Group

Project Group

8.2.1 RunGroup

The Run group enables validation, rebuilding, simulation and debugging of the project.

Build

The build control validates the script code and compiles the current project.

Recompiling the project using the Build control will result in only the changes being made to project tobe recompiled. To fully recompile the project, instead use the Rebuild control.

Rebuild

The rebuild control validates the script code and recompiles the complete project.

Run

A test of the project can be executed directly on the PC. ClickingRunwill perform a validation and starta simulation, if the project can be built. If errors are found during validation, an error message will bedisplayed.

During simulation, the project will communicate directly with the configured controllers, provided thatthe controllers are correctly connected to the development environment.

If there are unused tags in the project, theRun,Build, andRebuild commands will result in anotification about this. TheCheckForUnusedTags function can be disabled or enabled underOptions in theFilemenu.

Note:If project build fails, check that the absolute path to the project, including its components, does not exceed 260characters.

Note:Projects must be stored on the local hard drive for Kollmorgen Visualization Builder to be able to run or simulatethem.



Simulate

It is also possible to test and run the application on the development PC without connection to theselected controller, by clickingSimulate. If the project is valid, the simulation is started.

Debug

TheDebug command will allow the user to debug scripts in a real c# debugger with the possibilityto set breakpoints etc. User preferences for the script debugger may be entered underOptions,available from theFilemenu.

Note:Debugging of a CE project requires Visual Studio 2008 SP1.

Related informationOutput

Database

Options

Removing Unused Tags

8.2.2 TransferGroup

The Transfer group enables download to HMI-panel, upload database and export to folder functions.

Note:Time zone, region or daylight saving settings will not be transferred if these settings have been changed manuallyin the panel.

Download

The Download control sends the project to an HMI-panel or a controller with an Kollmorgen VisualizerRT installation, in the network environment.




Connected targets Choose a target type to transfer the project to.

Download Start the project transfer.

Click the “Downloadall sourcecode ( for laterupload) ” check box tocompress the project and save it as a ZIP file on target.

Click the “Passwordprotected” check box and enter a password toprotect the ZIP file.

Download is supported for AKI-CDA,AKI2G-CDA, AKI2G-CDB,AKI-CDB, and AKI-CDC targets, and for controller targets with aKollmorgen Visualizer RT installation.

Click the “Copydownloadedproject toMemoryCard” check box tocopy the downloaded project and the targets IP settings to the memorycard. When project is copied to memory card, it can be used for restoringthe project(1).




Verify The verify function enables the user to check if a target platformconfiguration is identical to the project configuration.

Verify is supported for AKI-CDA,AKI2G-CDA, AKI2G-CDB, AKI-CDBand AKI-CDC targets. If greyed out, please update to latest “Systemprogram”.

Log Show the data being logged during the download and verify process.

(1) Supported for panel AKI2G-CDA and AKI2G-CDB (image version 803 or higher).

An automatic check is done for mismatch between the Kollmorgen Visualization Builder version andthe target system versions. All version parameters are considered. If the target is indicated as beingincompatible with the version of the Kollmorgen Visualization Builder that hosts the project, pleaseupdate the target with the latest Kollmorgen Visualizer RT and system program versions.

If the target for the download contains newer files or files that don’t exist in the project, a dialog willappear prompting for which files to be kept, overwritten or deleted.

If the same project is to be downloaded to a panel again, the original datalogger in the panel will bereplaced if any settings have been changed in the datalogger since the last download.

Downloading a project built by an earlier version of Kollmorgen Visualization Builder (downgrading)might result in data loss.

Related informationHMI panel Upgrade

UploadDatabase

The Upload Database command will collect the database from an HMI-panel in the networkenvironment to a file on the development PC. The panel will pause during the upload, and will bestarted automatically afterwards.

The database may only be collected from a panel running the same project (i.e. a project with thesame name and of the same size) as the current Kollmorgen Visualization Builder project.

CollectingaDatabase fromanHMI-panel

1. Connect the HMI-panel to the development PC via an Ethernet connection.

2. ClickUploadDatabase.



3. The Upload Database dialog opens and all panels connected in the network are listed withinformation about IP address and panel type. Select the panel to collect from in the list.

4. Check that the IP address is correct and clickBackUp.

5. Select location of the saved database.

8.2.3 ProjectGroup

The project target, as well as name and title, are available for editing in the Project Group. The projecttitle is displayed in the title bar in runtime by default. Leaving the title empty displays the screenname/screen title only in runtime.

TheProjectGroupalso contains theBackUpProject command, aProjectSettings control and thepossibility to refer to other assemblies using theReferencedAssemblies control.


Settings

Referenced Assemblies

BackUpProject

The project source files can be compressed into a Zip file using theBackUpProject command.The Zip file can be saved to a USB stick or, on the condition that a network connection is configured,directly to a folder in the runtime controller.


Path toZip file Browse to the location to save the Zip file.

Passwordprotected Optional password protection of the Zip file.

Related informationOpening a Project



Settings

Properties such as application behavior in runtime, system font, and settings for mouse and keyboardcan be edited by clickingSettings in the Project group.

Related informationDeployment

Display/Target

Mouse/Touch Input Delay

System Dialogs

Virtual Keyboard

Screen Name and Screen Title

Database

The database used for Kollmorgen Visualization Builder projects is of SQLite type.Upgraded/converted projects will by default be changed to SQLite. When converting from SQL CE toSQLite, some custom queries might need to be updated manually.

Parameter DescriptionBackupdatabaseatstartup

When using this option a backup is created at startup if the integritycheck of the database succeeds. If the integrity check fails theprevious backup is used. The drawback is that the databases usetwice the space on disk and the startup time gets longer.

If there is no backup available and the database has become corrupt,then the corrupt database is replaced by a new empty database.

Maxsize (MB) When the database exceeds this size, the system tagDatabaseMaxSizeExceededwill be set. By pointing the mouse at the lower rightpart of the desktop area, a window will popup and show the memoryusage of different activities. This will give you a hint about what wouldbe a suitable value for theMaxsize (MB) setting.

Deployment




Overwrite Files on Target This setting can be used to determine the default behavior whentransferring projects and the transfer finds critical files alreadypresent on the target.

Pre Transfer Add commands to be executed before the file transfer. Only availablefor standard controller targets.

Post Transfer Add commands to be executed after the file transfer. Only availablefor standard controller targets.

Related informationPre Transfer

Post Transfer

PreTransfer

The following commands can be executed before the file transfer:

Command DescriptionReboot Reboots the target. Possible arguments: TrueandFalse. Using

True, the target tries to start any project present. The argumentFalse, or no argument, prevents the target from starting the projectautomatically.

Wait Pauses the execution of the commands. This can be useful if theuser runs commands that takes time for the target to recover from.Possible arguments: a number, indicating how many whole secondsto wait.

Run Starts any given process. The first argument must always be the pathto the executable to be run. Keep it inside quotes if it contains spaces.

Other arguments:

/p: or -p: are parameters for the process to start. The parametersmust be inside quotes and separated by spaces.

/noshellor -noshellmeans that the process should be run outside ofthe command shell.

/wd: or -wd: means working directory for the process to run. If leftempty defaults to active projects directory. The parameters must beinside quotes.

/wait: or -wait: means that theTargetControlService should waituntil the process has exited before continuing. If the process does notexit by itself, this argument should be left out.

It is possible to use the followingmacros in conjunction with theRun commands:



Macro Description

$projectpath$ Replaced by target project folder. If the user has downloaded anexecutable together with the project and wants to run it, this macrorepresents the destination folder.

Example: "$projectpath$\dbbackup.exe" /p:"backup.bak"-noshell -waitThis runs thedbbackup.exewith the startup argumentbackup.bak,it runs outside thecommandshelldue to -noshell, and the transferdoes not continue until the process has exited due to -wait.

$startproject$ Registers and starts the project. The transfer continues.

$finished$ Tells the system that the transfer is finished and closes connections.The project does not start. Should only be used in Post Transfer.

Note:Only available for AKI-CDC and controller targets.

PostTransfer

The same commands and macros as for the Pre Transfer can be used, but are executed after thefile transfer.

Note:Only available for controller.

Related informationPre Transfer

Display/Target



Parameter DescriptionNo Title Bar(1) Displays the project without title bar in runtime.

Title Bar Displays the project with its title and a set of minimize, maximize andclose buttons in the title bar.

Close Button Displays the project with its title and a close button in the title bar.

Topmost Makes the project the topmost application in runtime.

Only available for AKI-CDC and controller targets.

Maximize On Startup Makes the project maximized in runtime.

Only available for controller targets.

Screen Size Screen resolution.

Only available for controller targets.

Panel Rotate Displays selected rotation. It is possible to change the rotation of thepanel and panel content by 0, 90, 180 or 270 degrees. Only availablefor AKI-CDA-MOD-07T, AKI-CDA-MOD-10T and AKI-CDB targets.

Panel Type Displays selected target. It is possible to select another target.

(1) No Title Bar can not be used for popup screens.

Related informationChanging Project Target

ChangingProjectTarget

When changing to another target, you can select to automatically resize objects to the new target size.Different scale factors are used horizontally and vertically, to optimize conversion to and from widescreen targets. In this case, the aspect ratio of objects changes.

Note:An object might be wrongly positioned after conversion. When this happens you must change the position of theobject manually.

The following items are resized with the same factor when having selected automatic resizing:

Item

Graphical objects

Popup screens

Font(1)

Dynamics size and move

(1)A minimum scaled font of 10 pixels ensures readability in the smaller HMI-panels.

Not all objects and styles are supported for all project targets. When changing to another projecttarget, objects and styles that are not supported in the new target are deleted and are possible to



restore. Removed objects are logged, and displayed in a window after the transformation. The logmay be saved to file. Build files are always cleaned and project saved after transformation.

Note:Changing back to the previous target does not restore removed objects.

Mouse/Touch InputDelay

It is possible to configure a delay of mouse and touch screen input in runtime. This setting is globaland affects all objects for whichDelayMouse/Touch Input is selected. The Property grid is used toenable delay of mouse and touch screen input for individual objects.

Related informationProperty Grid



Advanced


Set default value on all newscreens to cache

When this is checked, all the new screens created in the project willhave the value forCached (under general settings for the screen) aschecked by default. When this is unchecked, all the new screens willhave theCachedoption set to false. As before, this is not applicableto start screen and popup screens. Start screen will always be cacheenabled and popup screens will always be cache disabled.

Set all to cache Clicking this button will set the value ofCached for all the existingscreens to true (except the start screen and popup screens).

Remove all cache Clicking this button will set the value ofCached for all the existingscreens to false (except the start screen and popup screens).

Memory management Set garbage collection mode (Workstation and Server) for theruntime project. By default the workstation mode will be selected.

Workstationmode is suitable for single core/processor targets.Servermode is suitable for multi core/processor targets.

For a single core processor, even if theServermode is selected,in effect the target will be run withWorkstationmode for garbagecollection.

Note:Memory management option is only available for AKI-CDC panels and controller targets.



SystemDialogs

Parameter DescriptionFont Select a system font that is used as the default font.

Font Size Use the increase/decrease font size buttons or set a specific defaultfont size.

VirtualKeyboard



Parameter DescriptionEnable Virtual Keyboard Select whether a virtual keyboard is to be displayed when

alphanumerical input is needed.

Keyboard Layout The following layouts are available for the virtual keyboard: Arabic,French, German, Hebrew, Italian, Korean, Russian, SimplifiedChinese (Compact), Simplified Chinese, Spanish, Swedish,Traditional Chinese, US

The virtual keyboard that is displayed in runtime depends on settings made for the Multiple Languagesfunction. If only the default language is used, the project settings (above) are used.

Note:Asian keyboard layouts do not work in PC projects.


ReferencedAssemblies

The Referenced Assemblies command makes it possible to refer to your own or third-party .Netassemblies (.dll). Their methods and properties are made available when scripting and are includedby the name completion function, in the same way as for built-in components.

1. Click onReferencedAssemblies.

2. ClickAdd.

3. Browse to the desired dll file in your PC environment and clickOpen.

The methods and properties of the added dll file are now available for scripting.

When referencing your own third-party assembly (.dll file) make sure not to have two files with thesame fully qualified assembly name in the same folder:



Example:You have the files "Iocomp.Instrumentation.CF2005.Ultra.dll" and "Iocomp.Instrumentation.CF2005.Ul-tra.WindowsCE.asmmeta.dll" in the same folder. Both have the same fully qualified assembly name (butdifferent file names). Trying to add a control from the first assembly seems to work. However when the applicationuses namespaces in the XAML to locate the correct assembly it picks one of them, and it might be either of them. Ifit is the wrong assembly you get a message saying that there is an error in the XAML.

Note:When importing third-party assemblies for use on a Windows Embedded Compact 2013 panel (AKI2G-CDA,AKI2G-CDB), it is important that the supplier supports running the code on Windows Embedded Compact 2013and that the assembly targets compact framework 3.5.

8.3 SystemRibbonTab

The System ribbon tab controls system settings. These settings are divided into the following groups:

Date, Time, and Region Group

Buzzer Group

Backlight Group

Serial Ports Group

Servers Group

Output Devices Group

Service Menu Group

8.3.1 Date, Time,andRegionGroup

National settings are made in the Date, Time and Region group.

Select time zone, whether to adjust for daylight saving, and region. If no time zone is selected, the timezone that has been selected for the panel or controller will be retained.

Note:After changing the Adjust for Daylight Saving setting, the operator panel must reboot for the changes to takeeffect.



Choose SNTP time synchronization if the panel clock is to be synchronized against an external SNTP(Simple Network Time Protocol) server. Enter the name of the SNTP server and the time interval forthe synchronization.

Note:The SNTP time synchronization is supported from AKI-CDA version 920 and AKI-CDB version 244.

The date and time display format (for example using AM/PM for time) is based on the operating systemsettings. For HMI-panel projects, this format may be altered by selecting another region.

For a controller the regional settings for date and time display need to be changed in the systemaccount to be carried out correctly.

1. Go to theControlPaneland selectClock,LanguageandRegion, thenRegionandLanguage.

2. Make the regional settings in the dialog box under theFormats tab.

3. Then go to theAdministrative tab and clickCopysettings.

4. In the dialog box that appears, checkCopycurrent settings to: Welcomescreenandsystemaccounts, and clickOK.

5. Reboot the system to apply the new settings.

Note:AKI-CDC targets only:If the regional settings are changed only for the user account without copying them to the system account, the newsettings will not be applied when downloading a project, even after a reboot.

8.3.2 BuzzerGroup

Select whether to let a key beep sound when making keyboard input in runtime. Only available whenan HMI-panel is selected as target.

8.3.3 BacklightGroup



Select to automatically turn off the backlight after a certain number of seconds, and whether to keepthe backlight on if a notifier window (e.g. alarm indicator or communication error message) is visible.

Backlight settings are supported only for HMI-panel targets. For other targets, the Microsoft Windowsscreen saver may be used.

8.3.4 SerialPortsGroup

For each of the COM ports, select if it is to be configured as an RS232, RS422 or RS485 port. Onlyavailable when an HMI-panel is selected as target.

The number of available ports and possible configuration differ depending on selected target.

For Panel AKI-CDA, AKI-CDBAKI2G-CDA, AKI-CDC and IPC, four COM ports can be configured:

Port Description Label onbackofpanel

COM1 RS232 incl. CTS/RTS

COM2 RS422 or RS485

Port 1

COM3 RS232 excl. CTS

COM4 RS422 incl. RTS or RS485

Port 2

8.3.5 ServersGroup

The Servers group contains the FTP, Web Server, OPC UA Server and Remote Access commands.The FTP and Remote Access commands are only available when an HMI-panel is selected as target.

It is highly recommended to set a password when enabling a server, especially when it is exposedto the internet. To get high security on the password, it must include upper and lowercase letters,numbers and special characters.

FTP

When enabled, it is possible to upload/download files to/from the HMI-panel provided that there is anFTP client program in the development PC, e.g. Internet Explorer, Windows Commander or someother standard FTP program.

It is possible to set up access to the FTP server with login requirements and/or as anonymous. Ananonymous user has read-only access rights. A user that logs in with the correct user name andpassword gets read/write access rights.



It is possible to allow access to an SD card or a USB stick used in the target. If multiple USB sticks areused in the target, only the first one can be accessed.

FTP is only available when an HMI-panel is selected as target. The functionality is not supportedby AKI-CDC and controller.

Username and password is only supported in Western European languages.

RemoteAccess

The Remote Access function makes it possible to access, reflect and control an HMI-panel from a PCby using the free VNC client program Remote Access Viewer together with the built-in VNC server inthe HMI-panel.

It is possible to set up Remote Access with a view only password and/or a full access password. Theview only password allows reflecting the panel remotely; the full access password allows also controlof maneuverable objects in the panel.

The maximum length of the password is eight characters according to the VNC standard.

Only one VNC client can connect to the VNC server.

Only available when an HMI-panel is selected as target.

To protect secrecy when entering a password via Remote Access Viewer, it is recommended to usethe PC keyboard. Otherwise it is possible that the cursor on the remote HMI-panel displays whichkeys are pressed on the alphanumeric keyboard.

When a panel is remotely controlled, it will beep as if it was touched.

For more information about Remote Access, refer to the documentation for Remote Access andRemote Access Viewer.

WebServer

Enables the possibility to host project files for a web client.




Enable Web Server Click this check box to enable the web server.

Port Enter a server port number.

Enable formsauthentication

Click this check box to enable forms authentication and enter username and password.

The password can be any alphanumeric string. The passwordsminimum length is four characters and the maximum length is 20characters.

Related informationWeb Server

OPCUAServer

Enables the possibility to publish tags with an OPC UA Server.


Enable OPC UA Server Click this check box to enable the OPC UA server.

Port Enter a server port number.

Allow anonymous login Click this check box to enable anonymous login. For a secured loginenter user name and password and leave the check box unchecked.

Addressspace

All tags, except array tags, defined in project will be shown.

The tags will be put in a folder named Tags in Namespace TagProvider on the server.

The NodeClass of all tags will be Variable.

All tag values will be published scaled with the offset and gain of the tag.



TagPropertiesMapping

Parameter DescriptionTag property UA Server Attribute

Name DisplayName /

BrowseName

Data Type DataType

Access Right AccessLevel /

UserAccessLevel

Description Description

Poll Group Interval MinimumSamplingInterval

Certificate

A certificate will be auto generated and self-signed when the server first starts up.

The certificate will be valid for 20 years.

The certificate contains no IP address since this could change after the certificate has beengenerated.

Limitations

Limitation DescriptionDiscovery Not supported

Encoding / Transport Only UA TCP Binary

User authentication Only user name / password

Only one account

Security No encryption support

Related informationOPC UA Client

8.3.6 OutputDevicesGroup

Printer devices can be set up by clicking the Settings control in the Output Devices group.



PrinterDevice

USBPrinterConnection

When printing from a AKI-CDC/controller, the default printer in Windows will always be used ifUSB isselected asPrinterConnector.


Printer Connector Select USB

Printer Type Select printer type. Selection possibilities: PCLINKJET andPCLLASERJET.

Printer supports PCL 5c Click this check box if the printer supports the PCL 5c color printerprotocol.

This option is only available if the printer type is set to PCLLASERJET.

Network settings Not available

Serial settings Not available

Page Orientation Portrait or landscape orientation of the printout

EthernetPrinterConnection

When printing from a AKI-CDC/controller, the default printer in Windows will always be used ifETHERNET is selected asPrinterConnector.




Printer Connector Select Ethernet

Printer Type Select printer type. Selection possibilities: PCLINKJET andPCLLASERJET.

Printer supports PCL 5c Click this check box if the printer supports the PCL 5c color printerprotocol.

This option is only available if the printer type is set to PCLLASERJET.

Enter Printer name / path

Enter user name

Network settings

Enter password

Serial settings Not available

Page Orientation Portrait or landscape orientation of the printout

Serial PrinterConnection

When printing from a AKI-CDC/controller, the data will be sent out on the selected COM port ifSERIALis selected asPrinterConnector.




Printer Connector Select Serial

Printer Type Not available

Printer supports PCL 5c Not available

Network settings Not available

PortName: Select which COM-port the printer is connected to

BaudRate: Select the baud rate for transmission of data.

DataBits: Select the number of data bits in each character.

Parity: Set the parity bit. The parity bit in each character can be setto none , odd, even, mark or space.

StopBits: Select the number of stop bits to be sent at the endof every character. Selection possibilities: None, One, Two orTwoPointFive.

HandShake: Select which handshaking protocol to be used.Selection possibilities: XON/XOFF, CTS/RTS.

Serial Settings

NewLineCharacter: Select end of line character. Selectionpossibilities: None, CR/LF, CR or LF.




PageLength (lines): Select the number of lines to be printed outbefore form feed. Form feed will not take place if the page lengthis set to 0.

PageWidth (characters): Set the page width specified as themaximum characters in a single line of text.

Serial Settings

Codepage: The code page consists of a table of values thatdescribes the character set for a particular language. The defaultcode page in Kollmorgen Visualization Builder is 850.

Page Orientation Not available

PrintoutsviaHMI-panel

When printing to a serial printer from an HMI-panel, the printer must support IBM character set (850).

When printing to a USB printer from an HMI-panel, the printer must support PCL levels according tothe table below:

Printer type Printer class requirementRecommendedprinter

model

Color laser printer USB + PCL 5c HP LaserJet 2700

Monochrome laser printer USB + PCL 5e HP LaserJet 1320

Color ink-jet printer USB + PCL 3e HP Deskjet 5652

When printing via Ethernet from an HMI-panel, the network printer must be a shared resource in theWindows network.

Connecting a printer via Ethernet requires that a PC is connected between the HMI-panel and theprinter.

Printing to a color laser printer via Ethernet is not supported for HMI-panels.

PCL 6 is not supported at all on HMI-panels.

8.3.7 ServiceMenuGroup

The Service Menu group provides a possibility to protect the service menu with a pin code.

Parameter DescriptionPincode Enter a pincode for the service menu. No pincode enables the service

menu for all users. Only numbers (0–9) are allowed.

Related informationService Menu



8.4 InsertRibbonTab

The Functions group, available from the Insert ribbon tab, contains functions and screen that can beadded to the project.

Functions Group

8.4.1 FunctionsGroup

All added components are available from Project Explorer folders. The Project Explorer alreadyincludes alarm server, multiple languages, security functions and tags. All functions are managedthrough their configuration pages.

Parameter DescriptionText Library With the text library function, text tables can be created, where values

are linked to texts.

Data Logger Data can be logged and saved to a database on time intervals ordepending on changed values.

Alarm Distributor Alarms can be distributed between HMI-panels, with notification viaprinter, SMS or e-mail using the alarm distributor.

Script A script module can be included to program features not covered byincluded functions and actions, or to be used to share functionalityamong functions.

Recipe Management Several recipes can be inserted in the project. Each recipe functionhandles a pre-defined set of recipe items.

Function Keys Function keys for HMI-panels as well as for the regular PC keyboardcan be configured.

Scheduler A scheduler can be used to control events in the process at specialtimes.

Audit Trail The Audit Trail function enables tracking of operator actions.

Reports The reports function allows adding Excel report templates to theproject.

Screens The Screen control adds new screens to the current project.


Configuration Pages



8.5 ViewRibbonTab

The Windows group, available from the View ribbon tab, contains controls to toggle visibility of the toolwindows:

Windows Group

8.5.1 WindowsGroup

The tool controls in the Windows group are highlighted when active.

Toolwindow Description Default PositionProject Explorer Shows all screens and components included

in the applicationDocked to the left part of theapplication window

Output Displays detailed information concerning theproject validation and build

Docks to the lower part of theapplication window

CrossReference

Provides an overview of where a specific tagis used

Docks to the right part of theapplication window

Error List Displays information about problems anderrors detected during build

Docks to the lower part of theapplication window

NavigationOverview

Provides an overview of all screens included inthe project, with zooming facilities.

Floating window

NavigationManager

Manages screens and screen navigation Desktop area

Property Grid Shows detailed properties of a selectedscreen or object

Docks to the right part of theapplication window as a tab

Object Browser Displays an overview of all objects in thecurrent screen and enables setting visibilityand locking objects easily, as well as placingobjects in front or back of each other.

Floating window

ComponentLibrary

Contains predefined as well as user-definedgraphical components

Docks to the right part of theapplication window as a tab

8.6 DynamicsRibbonTab

The Dynamics ribbon tab includes the following groups:



Layout Group

Color Group

General Group

The controls on the Dynamics tab are used to change the properties of an object depending ona changed tag value.

A lock icon resembling a chain indicates that a specific dynamic setting is made for the selected object.

If, for example, dynamic fill settings are made, it is not possible to make fill settings for the object fromthe Format group on the Home tab.

Note:Security has higher priority than dynamics.Visibility has higher priority than blink.

Note:Scripting to a property for which Dynamics has been configured disables the dynamic settings.

To release an object from a dynamic control, click the control with the lock icon and clickClearDynamics in the appearing dialog.

8.6.1 LayoutGroup

Move

The Move control in the Position group changes an object’s position, based on a tag value.

Position coordinates on the screen are given in pixels of the screen resolution. The position 0,0corresponds to the upper left corner of the screen.

To move an object vertically when a tag value changes:

1. Draw and position the object at the start position. Keep the object selected.

2. Click onMoveon the Dynamics tab to open the Move Dynamics Editor.



3. Select the tag to control the movement.

4. Enter a start and end value for the tag.

Start and end positions are suggested based on the current start position. A ghost object willappear at the suggested finish position. A guide line that connects the center of the original objectwith the ghost object appears.

5. Move the ghost object in the screen to its final position.

The coordinates for the object is updated. An animation of the move appears on the screen.Coordinate values can also be updated directly in the numerical fields (End Top, End Left). Thecoordinates for start and finish will limit the movement of the object irrespective if the tag value isoutside its start and end value.

6. ClickOK to save and close the Move Dynamics Editor.

When Position or Size dynamics is applied, moving or resizing of the object will be disabled. A lockicon resembling a chain in the upper left corner of the object (when selected) indicates that the objecthas a dynamic control applied and that it cannot be moved or resized.

Size

The Size control in the Size group changes an object’s size, based on a tag value.

Dynamic resizing of external picture files may result in a resolution loss if the picture is enlarged to asize larger than what is used elsewhere in the current project.

Width and height of an object are given in pixels of the screen resolution.

To resize the width of an object when a tag value changes:

1. Draw and size the object at its start size. Keep the object selected.



2. Click onSizeon the Dynamics tab to open the Resize Dynamics Editor.

3. Select the tag to control the resizing.

4. Fill in the values that for start and finish. Size is given in screen resolution pixels.

Start size is suggested based on the current start size. A finish size is suggested as a fixedincrease of the start size horizontally and vertically. A ghost object will appear with the finish size.

The object can only be resized from left to right and top to bottom.

5. Resize the ghost object in the screen to its final size.

The coordinates for the object is updated. An animation of the resizing appears on the screen.Coordinate values can also be updated directly in the numerical fields (End Width, End Height).The coordinates for start and finish will limit the size of the object irrespective if the tag value isoutside its start and end value.

6. ClickOK to save and close the Resize Dynamics Editor.

When Position or Size dynamics is applied, moving or resizing of the object will be disabled. A lockicon resembling a chain in the upper left corner of the object (when selected) indicates that the objecthas a dynamic control applied and that it cannot be moved or resized.

8.6.2 ColorGroup

The Fill and Outline controls in the Color group change an object’s fill color or outline (border) color,based on a tag value.

To alter the fill color of an object when a tag value changes:

1. Draw the object. Keep the object selected.

2. Click onFillon the Dynamics tab to open the Color Dynamics Editor.

3. Select the tag that is to control the color.

4. Fill in values to trigger color change.

5. Select color and gradient from the color menu.

6. ClickOK to save and close the Color Dynamics Editor.



8.6.3 GeneralGroup

Visibility

The Visible control in the Visibility group determines if an object is to be displayed in the screen or not,based on a tag value.

To hide an object when a tag value changes:

1. Draw the object. Keep the object selected.

2. Click onVisibleon the Dynamics tab.

3. Select the tag that is to control visibility. The object will be visible on the screen at a certain tagvalue.

The selected value will be treated as True (visible). All other values will be treated as False (invisible).

Blink

It is possible to select a tag to enable blinking depending on the tag’s current value.

The selected value will be treated as True (blink enabled). All other values will be treated as False(blink disabled).

The blink interval can be set dynamically or constantly.

Note:Security has higher priority than dynamics.Visibility has higher priority than blink.



Related informationBlinking Objects

General

The general control offers a possibility to alter the properties of objects in Kollmorgen Visualizer RT.

ConverterOperators

Converter operators are used to alter the properties of the objects. The converter operators can beselected from theEdit general dynamicsdialog.


BoolConverter Converts 0 to false and all other values to true.

ColorConverter Converts value intervals to specified colors.

LinearConverter Converts values according to the linear equation.

RawConverter Converts the value to a new value matching thetarget type.

TextLibraryGroupconverter Converts a value to a text.

EditGeneralDynamics

TheEdit general dynamicsdialog contains different properties depending on which object isselected. The dialog is accessed by clicking theGeneral control on theGeneralgroup.

Parameter Converter Object Description3DView ·bool Chart Set a 3D look and feel for the chart

Acknowledgeall ·bool Alarm viewer Set visibility for the AcknowledgeAll button.

Acknowledgeselected

·bool Alarm viewer Set visibility for the AcknowledgeSelected button.

Address ·raw

·text library group

Web browser Change the default URL.



Parameter Converter Object DescriptionAlternatebackgroundcolor

·color interval Animated label Set background color.

Alternate foregroundcolor

·color interval Animated label Set foreground color.

Animationspeed ·linear Animated label Set animation speed.

Auto-size ·bool Resize the object according tothe size of the default text stringlength and font size.

Buttoncolor ·color interval Alarm viewer Set the button color

Buttonheight ·raw

·linear

Alarm viewer Set the height of the buttons.

Buttonwidth ·raw

·linear

Alarm viewer Alter the width of the buttons.

Clear ·bool Alarm viewer Set visibility for the Clear button.

Clockwise ·bool Circular meter Set the rotation orientation.

Columnheader color ·color interval Set the column headerbackground color.

Endangle ·raw

·linear

Circular meter Set the end angle.

PDF-file ·raw


PDF viewer Select PDF file to add to the PDFviewer.

Filter ·bool Alarm viewer Set visibility for the filter button.

Fontcolor ·color interval Set font color in for instance thetext object.

Fontsize ·raw

·linear

Set font size in for instance thetext object.

Groupbackground ·color interval Action menu Set the group background color.

Group foreground ·color interval Action menu Set the group foreground color.

Header ·raw


Chart Set the header.

HighRegionColor ·color interval Circular meter Set the high region color.

HighRegionMax ·raw

·linear

Circular meter Set the maximum value of thehigh region indicator.

HighRegionMin ·raw

·linear

Circular meter Set the minimum value of the highregion indicator.

Indicator color ·color interval Set the indicator color in forinstance the circular meter object.



Parameter Converter Object Description

Info ·bool Alarm viewer Set visibility for the info button.

Active ·bool Chart Activate or stop the data input.

Enabled ·bool Enable or disable an object.

Showheader ·bool Chart Set visibility for the header.

Show legend ·bool Chart Set visibility for the legend.

Readonly ·bool Control whether for instance ananalog numeric object editable ornot.

Auto-scaleX-axis ·bool Chart Used with the chart object totoggle whether KollmorgenVisualizer RT automaticallyshould calculate the minimumand maximum X Axis values ornot.

ShowX-axisgrid ·bool Chart Set visibility for the X Axis grid.

ShowX-axis ·bool Chart Set visibility for the X Axis.

Auto-scaleY1-axis ·bool Chart Used with the chart object totoggle whether KollmorgenVisualizer RT automaticallyshould calculate the minimumand maximum Y1 Axis values ornot.

ShowY1-axisgrid ·bool Chart Set visibility for the Y1 Axis grid.

ShowY1-axis ·bool Chart Set visibility for the Y1 Axis.

Auto-scaleY2-axis ·bool Chart The bool converter can be usedwith the chart object to togglewhether Kollmorgen VisualizerRT automatically should calculatethe minimum and maximum Y2Axis values or not.

ShowY2-axisgrid ·bool Chart Set visibility for the Y2 Axis grid.

ShowY2-axis ·bool Chart Set visibility for the Y2 Axis.

Lockaspect ratio ·bool Multi picture Used with the multi picture objectto toggle the height/width ratio ofthe object.

Lowregioncolor ·color interval Circular meter Set the low region color.

Lowregionmax ·raw

·linear

Circular meter Set the maximum value of the lowregion indicator.

Lowregionmin ·raw

·linear

Circular meter Set the minimum value of the lowregion indicator.



Parameter Converter Object DescriptionMajor ticks ·raw

·linear

Set the number of labeled timemarks in for instance the linearmeter object.

Maximum ·raw

·linear

Set the end value of the scalein for instance the linear meterobject.

Major value tics ·raw

·linear

Trend viewer Set the number of labeled scalemarks on the scale.

Maxvalue ·raw

·linear

Trend viewer Set the end value of the scale.

Minvalue ·raw

·linear

Trend viewer Set the start value of the scale.

Minorvalue ticks ·raw

·linear

Trend viewer Set the number of scale ticksbetween two adjacent major tickson the scale.

Mediumregioncolor ·color interval Circular meter Set the medium region color.

Mediumregionmax ·raw

·linear

Circular meter Set the maximum value of themedium region indicator.

Mediumregionmin ·raw

·linear

Circular meter Set the minimum value of themedium region indicator.

Minimum ·raw

·linear

Set the start value of the scalein for instance the linear meterobject.

Minor ticks ·raw

·linear

Set the number of scale ticksbetween two adjacent major ticks.

Lower limit ·raw

·linear

Analog numeric Set the minimum value that canbe entered.

Opacity ·raw

·linear

Set the opacity of for instance thePDF viewer object.

Outline thickness ·raw

·linear

Set the outline thickness of forinstance the rectangle object.

Pictureheight ·raw

·linear

Button Set picture height.

Picturename ·raw


Picture Set the picture shown in thepicture object.

Picturestretch ·bool Button Stretch a picture.

Picturewidth ·raw

·linear

Button Set the picture width.

Play/Pause ·bool Alarm viewer Set visibility for the pause button.



Parameter Converter Object Description

Prefix ·raw


Analog numeric Set a prefix to the digits entered.

RadiusX ·raw

·linear

Rectangle Set the radius of the X axis in therectangle object.

RadiusY ·raw

·linear

Rectangle Set the radius of the Y axis.

Scale color ·color interval Circular meter Set the scale color.

Scale ·bool Circular meter Set visibility for the scale.

Selectedbackground ·color interval Action menu Set the background color of theselected action.

Selected foreground ·color interval Action menu Set the foreground color of theselected action.

Selectedgroupbackground

·color interval Action menu Set the background color of theselected menu group.

Selectedgroupforeground

·color interval Action menu Set the foreground color of theselected menu group.

Separator color ·color interval Set the separator color.

Source ·raw


Media player Set the source file.

Start angle ·raw

·linear

Circular meter Set the start angle.

Stretch ·bool Adjust the height and width to theselection frame in for instance thepicture object.

Suffix ·raw


Analog numeric Set a suffix to the digits entered inthe analog numeric object.

Text ·raw


Set the text shown in for instancethe text object.

Title ·raw


Roller panel Set the title.

Title backgroundcolor

·color interval Roller panel Set the title background color.

Title foregroundcolor ·color interval Roller panel Set the title foreground color.

Transparent ·bool Set the transparency of forinstance the button object.

Upper limit ·raw

·linear

Analog numeric Set the maximum value that canbe entered.

Value ·raw

·linear

Progress bar Set the value.



Parameter Converter Object DescriptionX1 ·raw

·linear

Line Set the X1 pixel coordinates

X2 ·raw

·linear


X3 ·raw

·linear


X4 ·raw

·linear


X-axisgrid color ·color interval Chart Set the grid color of the X axis.

X-axismaxvalue ·raw

·linear

Chart Set the maximum value of the Xaxis.

X-axisminvalue ·raw

·linear

Chart Set the minimum value of the Xaxis

Y1-axisgrid color ·color interval Chart Set the grid color of the Y1 axis.

Y1-axismaxvalue ·raw

·linear

Chart Set the maximum value of the Y1axis.

Y1-axisminvalue ·raw

·linear

Chart Set the minimum value of the Y1axis.

Y2-axisgrid color ·color interval Chart Set the grid color of the Y2 axis.

Y2-axismaxvalue ·raw

·linear

Chart Set the maximum value of the Y2axis.

Y2-axisminvalue ·raw

·linear

Chart Set the minimum value of the Y2axis.


8.7 GeneralRibbonTab

The General ribbon tab contains different property groups and controls for different objects.Appearance can be modified for graphical shapes and objects. Scale settings can be made for metersand trend viewers. Additional settings can be made for some objects.

The Tag/Security group is available also on the Home ribbon tab.

The general properties are described separately for each object.

Related informationHMI Controls in the Objects group

Media Controls in the Objects group

Special Controls in the Objects group



Related informationWindows Controls in the Objects group

Tag/Security Group on the Home Ribbon Tab

8.8 ActionsRibbonTab

Actions can be triggered in various ways, for example by clicking a button. The Actions tab controlsare used to define actions for objects. Alternatively, a script can be used to trigger an action.

An action is something that is performed, for example closing a screen. An action trigger is the act thatgenerates an action, for example clicking a button.

The Actions ribbon tab contains different control groups for different objects.

Figure 8-2: A Click action configured for a button

Note:It is not recommended to use multiple trigger methods, as this may lead to undesired behavior. It is recommendedeither to use a script or to program actions with the controls in the Actions tab. For example, avoid usingClick Action Trigger in combination with Mouse Button Action Triggers.


8.8.1 ClickActionTrigger

Most objects can be assigned click actions, that will be executed when the object is clicked in runtime.

8.8.2 MouseButtonActionTriggers

The Mouse Down and Mouse Up action triggers can be used to create two-step actions when clickingwith the left mouse button on an object.

Parameter DescriptionMouse Down A Mouse Down action will be performed when the left mouse button is

pressed down on the object in runtime.

Mouse Up A Mouse Up action will be performed when the left mouse button is releasedfrom the object in runtime.

Mouse Enter A Mouse Enter action will be performed when the cursor enters theboundaries of an object in runtime.

Mouse Leave A Mouse Leave action will be performed when the cursor leaves theboundaries of an object in runtime.



For AKI-CDAAKI2G-CDA, AKI2G-CDB and AKI-CDB targets the object boundaries are not adaptedto the visible outline of the shape. Instead the active area of the object is extended to a rectangularbox. This will result in a mouse action as soon as the mouse pointer is placed inside the rectangularbounding box of the object:

8.8.3 FunctionKeyActionTriggers

The Key Down and Key Up action triggers can be used to create two-step actions for function keys.

Parameter DescriptionKey Down A Key Down action will be performed when a function key is pressed in

runtime.

Key Up A Key Up action will be performed when a function key is released inruntime.

8.8.4 ValueChangedActionTriggers


Input Value Changed The Input Value Changed action will be performed when a value is enteredby the operator.

Value Changed The Value Changed action will be performed when the value of the objecthas changed.

8.8.5 TagsActionTriggers


Value Changed (tagwill always be active)

The tag will always be active.

Value Changed(tag will be polledas needed)

The event will only trigger if the tag is active. The tag can be deactivated ifit is not in use by anything else. When the tag is deactivated the event willremain idle until the tag is activated.



8.8.6 FocusActionTriggers


Got Focus The Got Focus action will be performed when the object is selected.

Lost Focus The Lost Focus action will be performed when the object is no longerselected.

8.8.7 NavigationActionTriggers

Parameter DescriptionNavigated The Navigated action will be performed when having navigated to the

address entered in the address field of the Web browser object.

Navigating The Navigating action will be performed when having entered, but notreached, an address in the address field of the Web browser object.

8.8.8 DataLoggerActionTriggers

The LogItemValueChanged and LogValuesUpdated are available for the Data Logger.

8.8.9 AlarmServerActionTriggers

Alarm server actions can be configured for the entire alarm server, for alarm groups or for individualalarm items. The actions will be activated upon alarm status changes.

Related informationAlarm Server Events and Actions

Actions and Events for Alarm Items and Alarm Groups

8.8.10 ActionGroups

Actions are divided into action groups.

Actiongroup Action Description

Close Screen Closes the current screen

If triggered from a tag in a popup screen, this willclose both the popup and the parent screen.

Print Screen Prints the current screen on printer or to a .PNGfile.

Selecting Print to file enables the followingoptions:

Project files folder: The file will be saved ina folder named “Project Files” in the projectsexecution path.

Browse: A save dialog will be shown in runtime.(controller only).

Screen




Path: The file will be saved to a specified path.(controller only).

Show Next Screen Shows next screen

Show Previous Screen Returns to previous screen

Show Screen Shows the specified screen. If the screen is apopup the position of the screen can be defined byentering (X,Y) coordinates.

Show Start Screen Shows the screen set to Startup screen

Address Book Open Address Book Opens the address book for editing. This action isused for Alarm Distributor purposes.

Open Print Settings Modifies alarm distributor print settingsAlarm DistributorServer Open Routes

ConfigurationModifies routes for the distributed alarm server

Acknowledge All Alarms Acknowledges all alarms in all Alarm Viewers

Acknowledge SelectedAlarm

Acknowledges the selected alarm in the AlarmViewer

Alarm Info Performs the action configured for the Alarm eventinfo requested in the Alarm Server. The action isperformed on the selected Alarm Viewer.

Clear All Alarms Remove all alarms in all Alarm Viewers

Filter Alarms Shows the filter configuration dialog for theselected Alarm Viewer

Pause Viewer Starts and pauses the selected Alarm Viewer

Alarm Viewer(1)

Audit Trail Back Up Audit TrailDatabase

Exports the audit trail database to a USB stick(HMI-panel) or to a folder (controller). When this isdone the audit trail log is cleared.

Pan Down Pans down in selected chart

Pan Left Pans left in selected chart

Pan Right Pans right in selected chart

Pan Up Pans up in selected chart

Reset View Resets any panning and zoom in selected chart

Zoom In Zooms into selected chart

Chart

Zoom Out Zooms out of selected chart



Actiongroup Action DescriptionBack Up Alarm, DataLogger and RecipeDatabase

Performs a backup of the project database

Back Up all Databases forrecovery

This action backs up all databases. The backup isused at startup if the integrity check fails.

Database Cleanup Removes empty space and runs a defragmenta-tion of the database. This reduces the databasesize and optimizes performance.

Database

Database Export Exports selected database in csv format

Clear Datalogger Clears the specified datalogger

Log Once Makes the specified datalogger log once

Start Logging Enables the specified datalogger

Datalogger

Stop Logging Disables the specified datalogger

Email Configuration Shows the e-mail configuration page. This actionis used for Alarm Distributor purposes.

Printer Configuration Shows the printer configuration page.

Output Devices

SMS Configuration Shows the SMS configuration page. This action isused for Alarm Distributor purposes.

Delete Recipe Deletes recipe

End Offline RecipeEditing

Sets the tags in the specified recipe in onlinemode.

Export Recipe Exports a recipe to a .CSV file

Import Recipe Imports a recipe from a .CSV file

Load Recipe Loads recipe

Save Recipe Saves recipe

Recipe

Start Offline RecipeEditing

Sets the tags in the specified recipe in offlinemode.

Reporting Generate Report Generates a report file that can be output to aprinter or saved as an Excel file.

Selecting “File” enables the following options:

Project files folder: The file will be saved in asubfolder named ”Reports” in the “Project Files”folder.

Browse: A save dialog will be shown in runtime.(controller only).

Path: The file will be saved to a specified path.(controller only).



Actiongroup Action DescriptionExport User Accounts Exports user data to a location that the operator

states

Import User Accounts Imports user data from a location that the userstates

Login Displays a login dialog

Logout Logs out the current user

Security

Show Users Dialog Displays a dialog where users can be added,edited or removed

Clear Non-Volatile Values Clears all stored values for tags marked asnon-volatile

Decrement Analog(2) Decrements tag value

Increment Analog(2) Increments tag value

Reset Tag(2) Resets tag to 0

Set Analog(2) Sets tag to the specified value

Set String(2) Sets tag to the specified string

Set Tag(2) Sets tag to 1

Tag

Toggle Tag(2) Toggles tag between 0 and 1

Show Trend ViewerLegend

Displays the legend tool in the selected trendviewer, with a possibility to show and hide curvesand to display values of a specific trend viewersample.

Trend Viewer

Trend Viewer History The Trend Viewer History action includes thefollowing choices (all applicable to the selectedtrend viewer):

On: Shows trend history from when the action wastriggered (including offset settings made usingtrend viewer dynamics).

Off: Returns to showing real time trend viewerdata.

Toggle: Allows entering and terminating historymode using the same object (for example abutton).

ShowDialog: Lets the user select a period oftime, for which to show trend viewer history.




Change ActiveControllers

Defines which controllers are to be active afterhaving restarted the project

Run Script Executes a script method saved in a script module.

Close Application Closes the runtime application.

Copy Debug Log to USBMemory

Copies the debug log to a USB memory.

Disable Debug Logger Disables the debug logger.

Enable Debug Logger Enables the debug logger.

Run Starts an external application

Scroll Left Scrolls the screen carousel object left

Scroll Right Scrolls the screen carousel object right

Set Date and Time Allows changing date and time in the HMI-panel

Set Language Sets the language in the HMI-panel to the selectedlanguage

Set Time Zone, Regionand Daylight Saving

Allows changing time zone, region and daylightsaving settings in the HMI-panel

Show Backlight Settings Allows changing backlight settings in theHMI-panel

When approaching 0% backlight, changes inbrightness level may no longer be noticeable in thepanel.

Complete dimming (to 0%) is only possible toachieve with the marine panel types, such as .

Other

Show IP Settings Shows the IP settings in the HMI-panel

(1)All Alarm Viewer actions must be associated with an Alarm Viewer in the same screen as the object with theaction configured. This also applies to actions that affect all Alarms.(2)This action can be used with Aliases.

8.8.11 ScriptAction

Script actions are used to execute script methods in script modules, triggered by actions. Scriptmodules in the project can be selected, and for each script module all methods are listed along withtheir exposed parameters. Static methods are not supported.



To apply a script to a selected object:

1. Go to the Actions group and select the appropriate action trigger.

2. Select actionRunScriptunderOther.3. Select one of the scripts from Script Modules.

4. This results in a list of available script methods for that specific script module. Select scriptmethod.

5. The parameters for the script appears in a dialog with information about the parameter name andtype. Complete the settings by entering a tag or a fixed value for each parameter, and click OK.

The script action will now be executed when the object is triggered.

Note:Script actions will have precedence over other script code for an object.


8.8.12 MultipleActions

Multiple actions can be configured by clicking small arrow in the lower right corner of any action group.

Figure 8-3: Note the small arrow in the lower right corner

The properties window allows configuring and sorting additional actions. The actions availabledepend of which object is selected in the screen prior to selecting the Actions ribbon tab.



After configuring multiple actions, this is indicated for the action group on the Actions tab.


Kollmorgen Visualization Builder | TREND VIEWER

9 TRENDVIEWERThis section describes the trend viewer object. Trend Viewers are used to present chronological datafrom controller tags. The curves in a trend viewer can have different sources of data.

The source of data can be a log item for a data logger. The values of the tag connected to the log item isthen stored in the projects database.

The source can also be a Tag. The trend viewer curve then only shows real-time values and is storedin a RAM cache.

When changing the system time in the panel to a later time, then data will be logged with the new time.In the trend viewer there will be a straight line between the last point logged for the old time and the firstpoint logged for the new time.

If the power to the panel is cut or if there is a communication error, then there will be a gap in the trendviewer curve for the time period where no signal was received.


Database Export

9.1 DefiningTrendViewerObjects

It is possible to define several independent trend viewer objects, in the same screen or in differentscreens. The number of trend viewer curves is limited only by the available amount of memory inthe panel.

Note:A large number of trend viewer pens and short sampling intervals may affect communication performance.

Related informationCommunication Performance

9.1.1 AddingaTrendViewerObject

A trend viewer object is added to a screen from the Objects group on the Home ribbon tab.

Settings for the trend viewer object are available from the General ribbon tab while the trend viewerobject is selected:

CurvesGroup

Trend viewer curves are defined using theEditCurves control.



Parameter DescriptionAdd Adds a new curve to the trend viewer object

Remove Removes the selected curve from the trend viewer object

Name The symbolic name of the curve. This name is shown if aTrend Viewer Legend is used.

Tag The tag to present values for

Log Item The item to be logged

Expression Expression on a curve is evaluated and applied when the curve isdrawn. If the expression value when the tag is logged or cached is ofinterest, the expression on the log item or the tag can be used. Seesection Expressions

Color The color of the curve

Thickness Line thickness

Minimum Value Tag A tag that dynamically sets what value on the curve that correspondsto the minimum value of the Y axis. This property will scale the curvewhen the value of the tag is different from the minimum value of the Yaxis (optional).

Maximum Value Tag The tag that dynamically sets what value on the curve thatcorresponds to the maximum value of the Y axis. This propertywill scale the curve when the value of the tag is different from themaximum value of the Y axis (optional)

DynamicsGroup

Several trend viewer properties can be made dynamic, i. e. dependent on tag values. This may beuseful, for example, when wanting to present trend viewer values of different formats in the sametrend viewer object.

If dynamic trend viewer properties are used, the corresponding property settings made in the ValueScale group for the trend viewer object are ignored.


Value Scale Min / ValueScale Max

Minimum/maximum value of the Y-scale. The design mode valueis used only for increased understanding in design time when tagvalues do not affect the minimum and maximum values.

Time Span The time span of the X-axis in seconds.

Time Offset in HistoryMode

Makes it possible to use an offset to step back in history mode. Thestart value is when history mode was entered. The unit is seconds.

If theTimeSpan value is increased, the trend viewer will initially display only the previous number ofentries (that was displayed before the increased time span). It will not collect older data for display.Only when the additional time added onto the time span has elapsed, the cache will be filled with dataand a full curve is displayed.



ValueScaleGroup

The value scale group controls the vertical scale (y-axis). If dynamic trend viewer properties are used,the settings made for these properties in the value scale group will be ignored.


Min Value/Max Value Start/end value of scale

Major Ticks Number of labeled scale marks on the scale


TimeScaleGroup

Parameter DescriptionTime Range Visible time span for a trend viewer in Hour:Minute:Second format.

Allowed values range from 00:00:00 to 23:59:59.

Major Ticks Number of labeled time marks. This property will be ignored inHistorical Mode in Trend Viewer.

StyleGroup


Style Predefined graphical styles for the trend viewer

VisibilityGroup


Scale When unchecked, the scale color of the trend is made transparent.Scale color is set fromOtherColors in the Format group on the Homeribbon tab.

Grid When unchecked, the grid color of the trend viewer is madetransparent. Grid color is set fromOtherColors in the Format groupon the Home ribbon tab.

9.1.2 TrendViewerLegend

In runtime, it is possible to display a trend viewer legend tool using the Show Trend Viewer Legendaction. The trend viewer legend tool is a floating window that displays the name and color of the curvesin the current trend viewer object. Curves can be made invisible by clicking the visibility icon.

Use the needle directly in the trend viewer to select a specific occasion. The values of all curves at thecurrent position are displayed in the trend viewer legend tool.



9.2 HistoricalMode inTrendViewer

To be able to show historical data in a trend viewer, the curves needs to be connected to log itemsfrom a data logger.

To show trend viewer history, it is necessary to define trend actions to show and close the historicaltrend viewer. These actions can for example be programmed as button click actions. It is also possibleto let the user select a time period.

Major ticks settings for time axis will be ignored in historical trend viewers. In historical trend viewersthe date and time will be viewed at start and end time. The text “history” is visible in the middle of thetime axis.

Related informationPerformance in the HMI-panel

Database



Kollmorgen Visualization Builder | DATA LOGGER

10 DATALOGGERData can be logged and saved in the Kollmorgen Visualization Builder database.

Any number of tags can be connected to a data logger, and data values irrespective of type can belogged. A project can have multiple data loggers with different sampling alternatives.

If you want to open a database file to inspect logged data, then you need to install an appropriate thirdparty database viewer tool.

Logged data can also be viewed in the trend viewer object by selecting a LogItem for a curve in the EditCurves dialog.

If Kollmorgen Visualizer RT is restarted at some point during the data logging, an additional empty rowis added in the Data Logger table in order to clearly visualize the interruption in the Trend Viewer.

Note:Logging of data consumes system resources and memory. To save memory, it is preferable that all LogItems thatshould be logged with the same sampling intervals are placed in the same data logger.


Any individual data logger database can be exported in csv format using theDatabaseExportaction.It is recommended to use the database export method rather than the backup method.


Database Export

Adding a Trend Viewer Object

10.1 DataLoggingStrategies

Logging of data can be made at time intervals or based on changed tag values.

Logging of data can be made either by collecting all samples at every log event, or by collecting onlychanged values. Collecting only changed values saves memory and improves performance.

10.1.1 LoggingBasedonTime Interval

To collect data that changes frequently, logging data based on time interval is recommended.

10.1.2 LoggingBasedonChangedTagValue

To control sampling of data by other means than regular time interval, you have to set up a separatetag to be used as a trigger. When the value of the trigger tag changes the log item is logged.

10.1.3 Maximizing theLifetimeof theStorageMedia

The storage media in the HMI panel is based on Flash SSD (Solid State Drive). Flash SSD hasno moving or mechanical parts, which gives high and reliable performance. The Flash SSD can



handle data very fast and efficiently and the data is controlled by the drive manufacturers’ confidentialalgorithm. As the algorithm is intellectual property it is not possible to calculate the lifetime, the drivemanufacturers only publish the numbers of reads and writes.

Best practice is to minimize number of writes to maximize the lifetime of the Flash SSD. Follow theadvice below to reduce the risk of premature wear out (before the estimated lifetime). A non workingFlash SSD stops the panel from operating.

• Do not log values with higher accuracy than needed. For example, avoid logging of floating pointvalues.

• Reduce high fluctuating values by using the hysteresis functionality in the connected controller.• Collect values with high fluctuating values in the same logger and do not mix with stable values.

Collect slow changing values in other loggers.• Do not log with higher refresh rate than needed.• Disable logging completely when information is not needed, for example when the machine

is not running.• Use default settingLogchangesonly in the property setting of the logger.• Keep the log size to a minimum, as few rows as needed.• Avoid extensive file writing when controlling storage via script.

10.2 AddingaDataLogger

A data logger can be added to the project from the Insert ribbon tab. The data logger configurationpages are used to set up which values to log.

Parameter DescriptionName Symbolic name for the logged tag

Tag Tag to log

Expression See section Expressions

Clicking theSettingsbutton accesses the Data Logger settings.



Related informationGeneral Settings

Actions

10.2.1 GeneralSettings

Parameter DescriptionLog with interval To collect data that changes frequently, use theLogwith interval

ofoption, and define time interval in seconds. Minimum interval is 1second.

Log on tag event To control sampling of data by other means than regular time interval,select theLogon tageventoption, and select the tag to use astrigger. Data will be sampled when the tag value changes.

Log changes only By logging changes only saves memory. The optionLogchangesonly can be combined with either the “Logwith interval of” or the“Logonobject event” option. Data will only be logged if the valuediffers from the last logged value.

Max number of loggedrows

The maximum number of tag values to save in the database. Whenthe number of collected items becomes larger than the set value, theoldest item will be overwritten. The value must be within the size ofthe available amount of memory in the HMI-panel in runtime.



10.2.2 Actions

Event DescriptionLog item Value changed When a value of an particular log item has changed

Log values updated When any log value is updated


Kollmorgen Visualization Builder | SCHEDULER

11 SCHEDULERA scheduler is used to control tags in relation to the real-time clock. This function is used to controlevents in the process, for example starting and stopping motors, at specific predefined calendartimes.

11.1 SchedulerSetUp

The scheduler configuration pages are used to set up scheduler jobs, which can include a set of tagswith associated start and stop times.

11.1.1 AddingaScheduler

A scheduler can be added to the project from the Insert ribbon tab.

The scheduler configuration page will open in the desktop when a scheduler function is created orselected.

Parameter DescriptionName A symbolic name for the scheduled event.

Period Set to Once (default) or to a regular interval (every minute, hour, day,week, month or year).

Start Date/Start Time The date and time for the first scheduled event.

Duration The length of the event.

Tag A digital tag, which is set to 1 during the specified interval.

Stop Time Enable When checked, Stop Date and Stop Time can be used to determinethe end of the event.

Stop Date/Stop Time The end date and time of the event. Also resets the defined Tag to 0.Used when Stop Time Enable is checked.

Action Click the button to configure an action to be performed when thescheduled event is activated/deactivated.

Note:Make sure not to use the same trigger tag for two different schedulers. When the first scheduler is finished, itstrigger tag is reset, and the second scheduler will not be triggered.


Kollmorgen Visualization Builder | REPORTS

12 REPORTSThe report generator allows generating Excel reports based on an Microsoft Excel made reporttemplate.

The generated report can be output to a printer or saved as an Excel file.

12.1 ReportsTemplateSetup

The tag data to be displayed in the report file are set up in the template file using “placeholders”.

The placeholders acts as substitute for the actual tag data that is to be inserted when the report isgenerated in Kollmorgen Visualizer RT.

To add a placeholder, enter the following text inside a cell in the Excel report template:

<#Tag(TagName)>

Replace “TagName” with the actual name of the tag to be displayed.

When the template file is complete it needs to be added to the Kollmorgen Visualization Builderproject.

Note:The tag placeholders can only be used in the cells of the Excel template file, they can not be used in, for example,Microsoft Excel WordArt texts.

12.1.1 Limitations

• Microsoft Excel xlsx format is not supported by the report generator.• Microsoft Excel xls format only supports 65536 rows. If more data is stored in the report,

information may be lost.• Reports containing charts and pictures can not be printed from a panel target.• The report generation is not an instant process. It may elapse a shorter period of time between the

first sampled tag and the last sampled tag, depending on the number of tags to process.

12.1.2 DatabaseDrivenReports

To be able to create database driven reports, the report template must be prepared as described inthese instructions:

Note:Queries have to be written in a language supported by the selected database. See Database for moreinformation.

ConfigurationSheet

The configuration sheet is a repository where configurations on the Microsoft Excel report templatecan be made. This sheet is not visible in the generated report.

1. Create a new worksheet in the report template. Name the sheet <#Config>.



2. Row 10, and all rows below, in column A and B can be used to configure the SQL queries. Enterthe SQL query in column B. Use the corresponding cell in column A to enter a name for the query.The name is used to refer to the query in the report template.

Enter the SQL queries in the following format:

SQL(DatabaseName; SQL query)

Example: SQL(General; SELECT * FROM DataLogger1)

There are two available databases: General and AuditTrail.

Present theDatabaseData in theReport

The data retrieved from the SQL database, using the queries in the configuration sheet, can bepresented in the report using “named ranges” in Microsoft Excel.

A named range is created in Microsoft Excel by following these steps:

1. Select the cells to be included in a named range.

2. Click theDefinename command from the Insertmenu. (In Excel 2007, go to theFormulas taband chooseNameManager).

3. Enter a name for the range. The name must be entered in the following format:“__QueryName__”.Replace “QueryName” with the name that you have chosen for your SQL query.

To present the data in the report, enter the following syntax into the cells included in the named range:

<#QueryName.DatabaseColumnName>

Replace the “DatabaseColumnName” entry with the actual name of the table in the SQL databasethat you wish to present in the report.

Note:It is possible to use the named range cells in Microsoft Excel charts and functions.To be able to use the named range in functions, an empty row must be inserted under the named range cells.This empty row must also be included in the function.

Related informationAdding a Report

12.2 ReportsSetUp

The reports configuration page are available from the Insert ribbon tab.

Related informationInsert Ribbon Tab

12.3 AddingaReport

Add a Microsoft Excel report template by pressingAdd in the reports configuration page. In theappearing Add report dialog, type in or browse to the location of the Excel template file.

If any changes are made to a report template after it has been uploaded to the project, the templatehas to be uploaded again.

The template files being added to the project must have unique file names.



Parameter DescriptionName A symbolic name for the report.

File name The name of the Microsoft Excel report template.

TheShowSelection/ShowAllbutton can be used to set up a filter of displayed items.

Related informationPerformance in the HMI-panel

Filtering Items

Configuration Pages

Action Groups

Output Devices Group


Kollmorgen Visualization Builder | RECIPE MANAGEMENT

13 RECIPEMANAGEMENTRecipes make it possible for a set of tags to be saved in the HMI-panel to be downloaded at latertime. The operator can download a saved recipe to the controller, which will start working with thenew values. Recipe libraries consisting of recipes with different sets of parameters can be created,allowing reuse of large sets of parameters.

Recipes can be created during the design of the project or from the HMI-panel.

Recipe data is stored in the HMI-panel database. Recipe handling functions such as loading, storing,copying and deleting recipes are handled with actions.

Recipe data is not stored in a database during the design of the project. The recipe data is transferredto the target, and the database on the target is updated, if needed, at first startup of project which thenmight take longer time than normal.

This makes it possible to change a recipe without deleting any existing recipes when transferring theproject to the target. The same applies for data loggers, changing the configuration of one data loggerdoesn't affect the other data loggers and recipes.


Actions Ribbon Tab

13.1 RecipeSetup

Recipes consist of a set of recipe tags and of recipe data (values).

13.1.1 AddingaRecipeManager

The recipe function is added to the project from the Insert ribbon tab. The recipe configuration pagesare used to manage tag sets and values via the Tag Configuration tab and the Runtime Data tab.

TagConfigurationTab

First add tags to be used by the recipe function from the tags configuration page. Then define a setof recipe items on the Tag Configuration tab of the Recipe function, and connect them to the tags youdefined. The data type is already set in the configuration of the tags.



RuntimeDataTab

The actual recipes are created under the Runtime Data tab. Give the recipe a title, and type a value foreach recipe item. A recipe can include a maximum of 256 items.

The recipe name has to be an alphanumeric string, beginning with a letter. Name strings can containletters (a-z, A-Z), numbers (0-9), and underscore (‘_’) characters. Some system device names suchas COM1 and AUX are invalid.

Related informationInvalid Names



13.2 Recipes in theHMIpanel

Some recipe actions can be performed by the operator in runtime.

13.2.1 LoadingRecipes

Recipes can be transferred to the controller using aLoad recipeaction when the HMI-panel isrunning. This means that the recipe values are transferred to the controller. A list of available recipesis displayed when theLoad recipeaction is activated. Select a recipe in the list and press [Enter] tomake the controller run with the downloaded values.

13.2.2 SavingRecipes

TheSave recipeaction can be used when the HMI-panel is running. Tags defined on the TagConfiguration tab are included in the recipe. Corresponding tag values are stored in the selectedrecipe file whenSave recipe is performed. It is possible to define an explicit recipe, that will beoverwritten if it already exists when performing the Save Recipe action.

13.2.3 CreatingRecipes in theHMIpanel

The Save recipe action is also used to create recipes in runtime. Instead of defining an explicit recipeto overwrite, the recipe data field is left open. In this case, the operator will be prompted to save therecipe with any name, or to overwrite an existing recipe.

13.2.4 EditingRecipesOffline

It is possible to edit existing recipes in the panel without transferring values to the controller, by settingthe recipe tags in offline mode. Recipe tags in offline mode will not receive any data from the controller,and no values will be written to the controller.

In offline mode, the Load recipe and Save recipe actions will not affect values in the controller.

Internal tags may be used for recipes, but will not be affected by offline mode.

Actions are used to start and end offline mode:



Action Description

Start offline recipe editing Sets the tags in the specified recipe in offline mode. A notificationmessage is shown.

End offline recipe editing Sets the tags in the specified recipe in online mode, and the tags areupdated from the controller.

A notification message is displayed during offline mode.

Example

1. ClickRecipeon the Insert ribbon tab.

The Recipe configuration page opens in the desktop area.

2. Add recipe tags on theTagConfiguration tab of the Recipe configuration page and connectthem to controller tags.

3. Add a recipe on theRuntimeData tab.

4. Create a screen with four buttons.

5. Connect two of the buttons to theLoadRecipeandSaveRecipeactions. Select the recipe titlefrom the Runtime Data tab forRecipeData.

6. Connect the other two buttons to theStart offline recipeeditingandEndoffline recipeeditingactions.

7. Run the project and test the functionality:a. ClickStart offline recipeediting.

The tags are set in offline mode.

b. ClickStart offline recipeediting.

The tags are filled with data from the recipe.

c. Change the data.d. ClickSave recipe.

The data in the tags is written to the recipe.

e. ClickEndoffline recipeediting.

The tags are set in online mode and the values are updated with data from the controller.

13.3 RecipeExport

A recipe can be exported as a .csv file and saved to a USB stick, an external memory card or to theproject files folder. The export is configured through the “ExportRecipe” action available from theRecipe action group.

Note:Recipe export is not supported during project simulation.



13.3.1 RecipeExport fromanOperatorPanelTarget

It is possible to selectExport to theProject FilesFolder,Export toUSB, orExport to externalmemorycard, and also to set another name of the export file.

It is also possible to select the requested delimiter in the .csv file (comma or semicolon).



13.3.2 RecipeExport fromacontrollerTarget

It is possible to selectBrowseandSelect anexport path,Export toPathor theExport toProjectFiles folder, and also setting another name of the export file.

TheBrowseandSelect anexportpathoption allows browsing for desired export destination inruntime. This may be useful if available folders in runtime are unknown when designing the project.

Select theExport toPathoption when you want to set the path when designing the project. If thepre-defined path is not valid in runtime, the operator may browse the PC environment by clicking abrowse button.


13.4 Recipe Import

A recipe that previously has been exported as a .csv file, can be imported back into recipe database.The import is configured through the “ImportRecipe” action available from the Recipe Action group.



Note:Recipe import is not supported during project simulation.

13.4.1 Recipe Import toanOperatorPanelTarget

It is possible to import the csv file using the Import fromUSB, Import fromexternalmemorycardorthe Import fromProject Files folder selections and also setting the name of the import file.


It can be selected whether to ignore the new data or replace the old data, if the recipe data alreadyexists.



13.4.2 Recipe Import toacontrollerTarget

It is possible to selectBrowseandSelect apath for import file, Import frompathor Import fromProjectFiles folder, and also setting the name of the import file.

TheBrowseandSelect apath for import fileoption allows browsing for desired import destination inruntime. This may be useful if available folders in runtime are unknown when designing the project.

Select the Import frompathoption when you want to set the path when designing the project.


It can be selected whether to ignore the new data or replace the old data, if the recipes already exists.


Kollmorgen Visualization Builder | FUNCTION KEYS

14 FUNCTIONKEYSFunction keys can be configured to run actions or to run scripts.

14.1 Definitions

A function key can be configured to affect only a particular screen or to be global. Global function keysbehave identically for all screens. A global definition can always be accessed when the HMI-panelis running, provided that the current screen does not have a screen definition for that function key.Screen function keys have higher priority than global function keys. Function keys included inbackground screens have lower priority than screen function keys, but higher priority than globalfunction keys.

For touch panel and controller targets, the Function keys function is added via the Insert ribbon tab,and allows configuration of up to 24 function keys (even if the connected keyboard does not supportmore than 12 function keys).


14.2 ConfiguringFunctionKeys

Function keys can be configured to run actions or to run scripts.

14.2.1 FunctionKeyActions

To define function key actions:

1. Click onFunctionKeys in the Project Explorer to open the function keys configuration page.

2. SelectGlobalorScreen.

3. Select the function key to be defined.



4. Click on the button next to the action to display the actions editor. Define the action to beperformed when the function key is pressed or released.

5. In the columnSecuritygroups required it is possible to specify security group accessibility forthe function key.

Multiple actions can be configured for a function key.

It is only possible to activate two tags connected to function keys at the same time. This means that ifmore than two function keys are pressed at the same time, only the first two will be activated.

Should further function key actions be needed in addition to those available for the panel in question,this could be solved by adding buttons or other objects on screen, connecting these to the desiredactions.

For a keypanel, the function is carried out by navigating to the object and pressing Enter.

Note:The function keys will be disabled if the backlight of the panel is disabled.

Related informationFunction Key Action Triggers

Multiple Actions



14.2.2 FunctionKeyScripts

To define a script for a function key:

1. Click onFunctionKeys in the Project Explorer to open the function keys configuration page.

2. Select the function key to be defined.

3. Select script view mode by clickingScript in the lower part of the desktop area.

4. Click on the desired button node. Double-click on theKeyDownnode. Edit the script code tobe performed.

Example:

The following C# code sets up function key F12 to perform an acknowledge of all alarms:


14.2.3 MomentaryFunction

In order to configure a function key with a momentary function, you need to combine aSetTagactionforKeyDownwith aResetTagaction forKeyUp.



ChangeofScreenDuringMomentaryExecution

There are a few special cases to be aware of when, during execution of the momentary function,another screen is opened that contains settings for the function key in use.

Then, dependent on theFunctionKeyContext settings,GlobalorScreen (local), there will bedifferent outcomes:

• Case1: A local function key is pressed.A change to another screen occurs.Result: The up action for the local key is executed. No new down or up actions are executed onthe second screen as long as the key is pressed.

• Case2: A global function key is pressed.A change to another screen occurs, in which there is no local setting for the same key.Result: Nothing happens at screen change. The up action for the global key is executed whenthe key is released.

• Case3: A global function key is pressed.A change to another screen occurs, in which there is a local setting for the same key.Result: The up action for the global key is executed. No new down or up actions are executed onthe second screen as long as the key is pressed.

Note:A Screen (local) function key command has priority over a Global function key command.


Kollmorgen Visualization Builder | ALARM MANAGEMENT

15 ALARMMANAGEMENTAn alarm is used to call attention to an event that requires immediate action. An alarm is set when acertain condition is met. An alarm condition is designed as a logical evaluation of a tag value. Alarmscan be divided into groups to create an order of priority.

Alarm notification can be made in the following ways:

Alarm Indicator

Alarm Viewer

Distribution via SMS, e-mail or printer via the Alarm Distributor

The alarm server database can be exported in csv format using theDatabaseExportaction.

Related informationDatabase Export

15.1 AlarmConditions

Alarms can assume the following conditions:

Alarmcondition DescriptionActive The alarm condition is met, and the alarm is not acknowledged

Inactive The alarm has returned to normal condition, but has not beenacknowledged

Acknowledged The alarm condition is still met, but the alarm is acknowledged

Normal The alarm has returned to normal condition and has beenacknowledged

15.2 AlarmServer

The alarm server function is predefined in the Project Explorer. Clicking on it opens the alarm serverconfiguration pages in the desktop.

General alarm server properties are available by clicking theSettingsbutton.

The Properties window is divided into General, Alarm Distribution and Actions.



15.2.1 GeneralSettings

Settings

Some alarm server functions are based on changed tag values:

Alarm function DescriptionRemote acknowledge Performs remote acknowledge of all current alarms when the tag

value is 1

Clear alarms Removes all alarms from the alarm server when the tag value is 1

Enable/disable alarms Enables the alarm server when the tag value is 1

ShowAlarm Indicator

Select for which alarm statuses the alarm indicator is to be displayed.

LogSettings


Max Number of LoggedRows

The maximum number of alarms to save in the database. If thenumber of collected items becomes larger than the set value, theoldest item will be deleted. The value must be within the size of theavailable amount of memory in the HMI-panel in runtime.

RepeatCounter

To avoid that an alarm that is triggered repeatedly results in multiple entries in the alarm list,RepeatCount can be used. The current alarm will then only appear once in the alarm list, and number of timesthe alarm is triggered will be included in the alarm text. For display in the Alarm Viewer and for logging,select whether to show the time of the first or last occurrence of the alarm.



15.2.2 AlarmServerEventsandActions

Actions can be configured for the entire alarm server. One or multiple actions can be configured whena particular alarm server event occurs.

SelectActions in the Alarm Server properties page to configure actions for the alarm server.

Actions for the following alarm server events can be configured:

AlarmAcknowledge

The specified actions are triggered once for every alarm that is acknowledged.

AlarmActive

The specified actions are triggered once for every alarm that becomes active.

AlarmDeleted

The specified actions are triggered once when theClearbutton in the Alarm Viewer is pressed, ifat least one alarm is deleted.

AlarmEvent InfoRequested

The specified actions for the selected alarm are triggered when the Infobutton in the Alarm Vieweris pressed.

The actions are applied for the individual alarm first. If no action is specified for the alarm, the actionsare applied for the group. If no action is specified for the group, the actions are applied for the alarmserver.

Alarm Inactive

The specified actions are triggered once for each alarm, for which the alarm condition is no longer met.

AlarmNormal

The specified actions are triggered once for each acknowledged alarm, for which the alarm conditionis no longer met.

AlarmsChanged

This event is intended primarily for scripting, in order to avoid performance loss that may occur whenmany alarms change status at once. Alarms Changed includes status changes based on AlarmAcknowledge, Alarm Active, Alarm Normal and Alarm Inactive, but not Alarm Deleted.

The specified actions are triggered once when the status of several alarms change at one occasion. Acollection of alarms is returned.

AlarmsDeleted

This event is intended primarily for scripting, in order to avoid performance loss that may occur whenmany alarms are deleted at once, by pressing theClearbutton in the Alarm Viewer.

The specified actions are triggered once when a number of alarms are deleted at one occasion. Acollection of alarms is returned.



AnyAcknowledged

The specified actions are triggered based on alarm logic: when the alarm server toggles betweencontaining acknowledged alarms or not.

AnyActive

The specified actions are triggered based on alarm logic: when the alarm server toggles betweencontaining active alarms or not.

Any Inactive

The specified actions are triggered based on alarm logic: when the alarm server toggles betweencontaining inactive alarms or not.

15.2.3 AlarmDistributionSettings

To enable sending alarms to printer, or via SMS or e-mail, the Alarm Distributor is used. In addition tothe settings below, theEnableDistributionoption for the alarm groups or alarm items also has to bechecked.


Internal/External Selection of internal or external alarm distributor

IP Number Server The IP address of the external alarm distributor

Queue Length The number of alarms to be kept in queue for the external alarmdistributor. When the queue is full, no more alarms will be added tothe queue.

Port Number The port number of the external alarm distributor

Related informationAlarm Distributor

Alarm Groups

Alarm Items



15.3 Alarm Indicator

As long as there are active alarms in the alarm server, the alarm indicator notify window will bedisplayed, regardless of which screen is active. The color shows the current alarm status, and can beconfigured for each of the alarm groups. The indicator starts in the upper left corner of the screen inruntime, but can be moved to any position on the monitor in runtime.

The appearance of the alarm indicator depends on the current alarm status. It will show the mostsevere status of the alarms in the list. The Alarm Indicator disappears when all alarms have beenacknowledged, and all alarms have returned to inactive status.

SelectGeneral settings in alarm server properties page to decide for which alarm statuses to show thealarm indicator.

Alarmcondition DescriptionDefault alarmindication

Active The alarm condition is met, and the alarm is notacknowledged

Flashing red

Inactive The alarm has returned to normal condition, but hasnot been acknowledged

Flashing green

Acknowledged The alarm condition is met, and the alarm isacknowledged

Flashing green

Normal The alarm has returned to normal condition, and hasbeen acknowledged

-

Related informationGeneral Settings

15.4 Alarm Items

Alarm items are added from the Alarm Items tab of the alarm server configuration pages.

ClickAdd to define a new alarm.

Parameter DescriptionName Symbolic name for the alarm item that will show in an Alarm Viewer.

Text An optional alarm text that will be shown in the Alarm Viewer. Parts ofthe text can be made dynamic by clicking ...



Parameter DescriptionTag The tag (digital or analog), which generates the alarm when it

assumes the specified status.

Expression See section Expressions

Condition Equal to/Notequal to: The alarm is set when the value of the tag isequal/not equal to the value specified in theTriggerValue field.

Greater than/Less than: The alarm is set when the value of the tag isgreater/less than the value specified in theTriggerValue field.

Equal togreater than/Equal to less than: The alarm is set when thevalue of the tag is equal to or greater/less than the value specified intheTriggerValue field.

Rising/FallingEdge: The alarm is set when the specified tag goesto one/zero.

Trigger Value Numeric value to trigger alarm with when:

<tag value> <condition> <trigger value> = true.

History Specifies when the alarm is to be removed from the alarm list.Checking this box means that the alarm will remain in the list untilthe list is full. Leaving it unchecked means that the alarm will beremoved from the list when it is acknowledged and no longer active. IfAcknowledgeRequired is not checked, the alarm will be removedfrom the list as soon as it is no longer active.

Acknowledge Required Indicates whether the alarm is to be acknowledged or not. Checkingthe box means that the alarm must be acknowledged, leaving itunchecked means that the alarm returns to normal directly when thealarm status becomes inactive.

Remote Acknowledge A digital tag that acknowledges all the alarm when set to 1

Remote Ack Expression See section Expressions

Enable Distribution Enables distribution of the alarm via printer/SMS/e-mail. Onlyavailable if alarm distribution is enabled for the alarm server. IftheEnableDistributionoption for the alarm group is checked,distribution of individual alarms in the group are automaticallyenabled.

Repeat Count To avoid that an alarm that is triggered repeatedly results in multipleentries in the alarm list,RepeatCountcan be used. The current alarmwill then only appear once in the alarm list, and the number of times thealarm is triggered will be included in the alarm text. It is also possibleto show aCount column in the Alarm Viewer. The active time can beshown either for the first time or for the last time the alarm occurred.

Action Makes it possible to configure one or multiple actions when aparticular alarm event occurs for the current alarm.

Note:An alarm condition is triggered by a fixed value. The trigger value defined for an analog alarm tag cannot becontrolled from a register. It is not supported to trigger alarms on intervals.



Related informationActions and Events for Alarm Items and Alarm Groups

15.4.1 Exportingand ImportingAlarm Items

Alarm items can be exported and imported using the Import/Exportbutton in the Alarmsconfiguration page. The procedure is similar to exporting and importing tags.

Related informationImporting and Exporting Tags

Tag Import Example

15.5 AlarmGroups

Alarms can be divided into groups, for example to indicate the priority of the alarms. One alarm groupis defined by default.

Color attributes can be individually set for each alarm group. Alarms can be sorted by group in theAlarm Viewer.

15.5.1 DefiningAlarmGroups

Alarm groups are added from theAlarmGroups tab of the alarm server configuration pages.

Parameter DescriptionName An optional name for the alarm group.

Text An optional text for the alarm group.

Colors Select foreground and background color for each alarm status

Remote Acknowledge A digital tag that acknowledges all the alarms in the group when set to 1

Remote Ack Expression See section Expressions

Enable Distribution Enables distribution of the alarms in the group via printer/SMS/e-mail.Only available if alarm distribution is enabled for the alarm server.

Action Makes it possible to configure one or multiple actions when a particularalarm event occurs for the current alarm group.

Note:TheAlarmFilterwill revert to the default settings if theAlarmGroup is renamed.

Related informationActions and Events for Alarm Items and Alarm Groups



15.6 ActionsandEvents forAlarm ItemsandAlarmGroups

Actions can be configured for individual alarms or for alarm groups. One or multiple actions can beconfigured when a particular alarm event occurs for the current alarm or alarm group.

Actions for individual alarms are configured from theAction column for the alarm on theAlarm Itemstab.

Actions for alarm groups are configured from theAction column for the alarm group on theAlarmGroups tab.

15.6.1 ActionsandEvents

Actions for the following alarm events and alarm group events can be configured:

AlarmAcknowledge

The specified actions will be triggered when the selected alarm/an alarm in the selected alarm group isacknowledged.

AlarmActive

The specified actions will be triggered when the selected alarm/an alarm in the selected alarm groupbecomes active.

AlarmEvent InfoRequested

The specified actions are triggered when the Info button in the Alarm Viewer is pressed.

These actions are applied for the individual alarm first. If no action is specified for the alarm, theactions are applied for the group. If no action is specified for the group, the actions are applied forthe alarm server.

Alarm Inactive

The specified actions are triggered when the alarm/an alarm in the selected alarm group becomesinactive.

15.6.2 Example

The following picture shows two actions configured for when the current alarm goes active, andanother action for when the operator presses the Infobutton in runtime.



15.7 RemoteAlarmServer

The alarm server in the Kollmorgen Visualization Builder project can operate as a stand-alone alarmserver, processing alarms and showing these in the Alarm Viewer and alarm indicator. Alternatively,the alarm server can distribute alarms to clients. Each alarm server can function as alarm serverand/or alarm client. The remote alarm server functionality is set up via properties.

15.7.1 RemoteAlarmServerLimitations

Most functions work exactly the same regardless if a local or remote alarm server is used, but thereare a few limitations:

• In projects where multiple languages are used, switching language in the alarm server results inusing the current language for all new alarm texts. Alarms distributed before the language wasswitched in the server will remain in the previous language in the client.

• Pressing the Info button in the Alarm Viewer in runtime does not result in any actions for aremote alarm, unless the same project is used for the server and the client. The script eventAlarmInfoRequested can be used instead.

• Unless the same project is used for the server and the client, filtering (pressing the Filter buttonin the alarm viewer) can only be made in runtime for remote alarms, since the remote servermay include e.g. alarm groups that are different from the project in which the alarm viewer wasconfigured.

15.7.2 RemoteAlarmServerProperties

The following properties, located in theServerModegroup under theSettingsbutton, need to be setup for the remote alarm server:



Property DescriptionMaximum numberof alarm events todistribute

The number of events to distribute to the clients. The number ofdistributed alarms affects performance.

Server Mode The alarm server can assume the following modes:

Disabled: The alarm server is disabled and no alarms are processed

Local: The alarm server processes alarms of its own.

Remote: Alarms are distributed to remote clients.

Both: The alarm server processes alarms of its own and also distributesthem to remote clients

Server Port Any available port. The port needs to correspond to the port setting forthe remote alarm client.

15.7.3 RemoteAlarmClient

The properties for the remote alarm client are set by adding the Alarm Viewer object, found in theObjects group under the Home tab.

The settings are done in the Property Grid underExtended.

Property Description

Server address The IP address of the remote alarm server.

Server port Any available port. The port needs to correspond to the port settingfor the remote alarm server.



15.8 AlarmDistributor

The Alarm Distributor makes it possible to send alarm notification via printer, SMS or e-mail. Thefunction can be enabled internally in a project, or in another HMI-panel that acts as a server towardsseveral connected clients. Regardless of acting as server or client, distributed alarms are savedtemporarily in the local project database to ensure that information is not lost in case of e.g. interruptedpower. After receiving alarms from a client, the server will send a confirmation to the client. The alarmswill then be removed from the client’s database.

The Alarm Distributor must be created before actions related to it are created.

15.8.1 AlarmDistributionRoles

Using InternalAlarmDistributionServerFunctions (ActingasClient andServer)

The following actions are required for using distributed alarm functions in the current project:

Action Component Location

Activating distribution of alarms inthe project

Alarm Distribution Server Insert ribbon tab

Enabling internal distribution ofalarms

Alarm Server Settingsbutton/AlarmDistributionproperties




Enabling distribution of alarmgroups or individual alarms

Alarm Server AlarmGroupsorAlarm Itemstab

Configuration of alarm distributionroutes

Alarm Distribution Server Receivers,AlarmFilterandScheduler tabs

Configuration of alarm distributiondevices

Alarm Distribution Server ConfigureDistributionDevicesbutton (e-mail, printerand/or SMS)

UsingExternalAlarmDistributionServerFunctions (ActingasClient)

The following actions are required for using distributed alarm functions in anotherHMI-panel/controller project:




Enabling external distribution ofalarms

Alarm Server Settingsbutton/AlarmDistributionproperties

Enabling distribution of alarmgroups or individual alarms

Alarm Server AlarmGroupsorAlarm Itemstab

CollectingAlarms forDistribution (ActingasServer)

The following actions are required for using distributed alarm functions in anotherHMI-panel/controller project:




Configuration of alarm distributionroutes

Alarm Distribution Server Receivers,AlarmFilterandScheduler tabs

Configuration of alarm distributiondevices

Alarm Distribution Server ConfigureDistributionDevicesbutton (e-mail, TCPserver, printer and/or SMS)

15.8.2 AddinganAlarmDistributor

The Alarm Distributor can be added to the project from the Insert ribbon tab. The configuration pagesare opened in the desktop area.

Route

A route defines a number of filtering rules for distribution of alarms. Multiple routes makes it possible tosend different kinds of notifications to various receivers.



ReceiversTab

The receivers of distributed alarms for each route are set up on theReceivers tab.

AddressBook

Click on theAddressBookbutton to enter names, e-mail addresses and/or phone numbers of thepersons that are to be available for selection for distributed alarm messages.

TheShowSelection/ShowAllbutton can be used to set up a filter of displayed items.

The contents of the address book can be exported as a .csv file, and then be imported again aftermodification using the Import/Exportbutton.




ReceiverSelection

Click on theReceiverSelectionbutton to set up receivers of each alarm distribution route; via e-mail,SMS and/or printer.

The selected receivers are displayed underReceivers.

AlarmFilter Tab

Filtering of each alarm distribution route can be configured on theAlarmFilter tab. The filteringoperates using “and” logic, i.e. the alarm will only be distributed if all conditions are fulfilled. An emptystring does not generate a filter condition (acts as a “wild card”).



Parameter DescriptionAlarm Name The alarm item to distribute.

Alarm Group The alarm group of which alarm items are to be distributed.

Alarm Text All alarms including this text will be distributed.

Alarm Status(es) todistribute

Selection of alarm to be distributed, based on alarm status. At leastone status must be selected.

SchedulerTab

Scheduling of each alarm distribution route can be configured on the Scheduler tab. Only alarms thatoccur between the start and stop times will be distributed.



Parameter DescriptionPeriod Select daily or weekly alarm distribution

Day Select weekday, ifWeeklywas selected forPeriod

Start Time/Stop Time Select start and stop time of the alarm distribution

Name The name is automatically filled in based on start and stop time, andcannot be edited

15.8.3 ConfigureDistributionDevices

Click theConfigureDistributionDevicesbutton to set up the different devices.

Related informationModifying Alarm Distribution Settings in Runtime

AlarmVariables

Variables collected from the alarm server definitions can be included in distributed alarm information.Variables are enclosed by curly brackets; for example “Alarm text: {3}”. The following variables can beused:

Number Variable Description0 State The current state of the alarm

1 StateTime The time the alarm entered the current state

2 AlarmId A unique alarm ID

3 AlarmText Alarm item text

4 AlarmItemDisplayName Alarm item name

5 Count The number of times the alarm has occurred

6 ActiveTime The time the alarm became active

7 InactiveTime The time the alarm became inactive



Number Variable Description8 NormalTime The time the alarm became normal

9 AcknowledgeTime The time the alarm was acknowledged

10 AlarmGroupName Alarm group name

11 AlarmGroupText Alarm group text

E-mailDevice

Parameter DescriptionFrom Name The name of the sender of the e-mail

From E-mail Address The e-mail address of the sender of the e-mail

SMTP Server Name/IP The name or IP address of the SMTP server for sending e-mail



Parameter DescriptionPort The port number of the e-mail server

Encryption Mode SelectNone, ImplicitSSL, orExplicitSSLAdvanced Encryption Clear the check box to use only RSA encryption.

Select the check box to use advanced encryption, like DSS, DHE andDH (1).

Code Page The code page consists of a table of values that describes thecharacter set for a particular language. The default code page inKollmorgen Visualization Builder is 65001 (UTF-8).

Authentication Mode SelectNoneorAuthenticatedLogin

User Name/Password User name and password ifAuthenticatedLoginwas selected

Retry Sending Number of retries if the e-mail cannot be delivered

Time Interval Number of seconds between retries

Subject The e-mail subject; Alarm Variables can be used

Body The e-mail body; Alarm Variables can be used

(1) Note that usingAdvancedEncryptionhas a negative effect on the performance on CE targets.

PrinterDevice


Buffer settings Set up the printers buffer settings

Text Font Size The font size of the text to be printed

Body The body of the printout; Alarm Variables can be used

Related informationOutput Devices Group



SMSDevice

To be able to send alarms via SMS, you have to purchase an SMS Gateway Service.


Basic URL for web SMS The URL configuration string according to the SMS Gateway Servicesupplier that must include two variables: {0} for telephone numberand {1} for SMS body

Retry Sending Number of retries if the SMS cannot be delivered

Time Interval Number of seconds between retries

Body The SMS body; Alarm Variables can be used

TCPServer

Define the TCP server port. This must correspond to the port defined for theAlarmDistributionsettings for the alarm server.

15.9 AlarmDistributorViewer

The Alarm Distributor Viewer is a debug tool, used for test and verification of the alarm distributionsetup.

Clicking theSettingsbutton in runtime makes it possible to edit the address book and make settingsfor alarm distribution.



Related informationModifying Alarm Distribution Settings in Runtime

15.10 AlarmViewer

The Alarm Viewer can be used to show more detailed alarm information than the alarm indicator.Alarms presented in the Alarm Viewer presents alarm texts from the alarm server. The alarm listshows the latest alarms. It is arranged in alarm group order.

The default design of the alarm viewer depends on the size of the selected HMI-panel target, in orderto allow full visibility and usability of the alarm viewer in the smaller HMI-panels.

Settings such as font and button width are available in the Property grid.

The colors of the Alarm Viewer object can be set from the Property grid. The colors of the differentalarm statuses are set in the Alarm Server settings.

Note:Some of the color effects require thatVistaStyle is activated underExtended in the property grid (defaultsetting).

Settings for the Alarm Viewer are available from theGeneral ribbon tab while the object is selected:

15.10.1ButtonsGroup

Parameter DescriptionPosition Controls to which of the borders the buttons will line up

Acknowledge Selected Acknowledges the selected alarm in the Alarm Viewer



Parameter DescriptionAcknowledge All Acknowledges all alarms in all Alarm Viewers

Clear Removes all alarms in all Alarm Viewers

Filter(1) Shows the filter configuration dialog for the selected Alarm Viewer

Info Performs the action set by Alarm Event Info Requested

Play/Pause Starts and pauses the selected Alarm Viewer

Enable Context Menu Shows Alarm Viewer commands in context menu in runtime

(1)Not supported in keyboard operated panels

15.10.2DisplaySettingsGroup


Configure Columns Selection and configuration of columns to display in runtime

Filter Settings(1) Filter alarm statuses to display in runtime

Max Number of Rows The maximum number of alarms to display. If the number of alarmsdoes not fit in the object in runtime, scroll bars will be made available.If the number of alarms exceeds the maximum number, the oldestitem will be deleted.

Show Column Headers Shows/hides the alarm viewers column headers

Show Summary Shows status information in the bottom of the Alarm Viewer

(1)Not supported in keyboard operated panels

15.10.3AlarmViewerCommands

In addition to using the Alarm Viewer buttons, the same functions are available using actions.


Property Grid

15.11 AlarmManagement inRuntime

Alarm notification can be made in the following ways:

Alarm Indicator

Alarm Viewer

Distribution via SMS, e-mail or printer via the Alarm Distributor

15.11.1AlarmAcknowledgement

An alarm can be acknowledged in the following ways:



• right-clicking on the alarm line and selectingAcknowledge• selecting the alarm line and pressing on theAcknowledgeSelectedbutton• pressing theAcknowledgeAllbutton to acknowledge all current alarms• script actions

Inactive alarms that have been acknowledged can be removed from the list by pressing theClearbutton.

15.11.2Sorting

Pressing on the column heading in runtime sorts the alarm list by that column. This pauses the AlarmViewer.

15.11.3Filtering

Pressing the Filter button in the Alarm Viewer opens a dialog that allows the user to enter a filteringprofile to control which alarms to display in the alarm list.

Filtering can be made based on any combination of the following conditions:

• Alarm group: The first column in the filter window shows the alarm group name. Check the Enablebox to show alarms from the group.

• Alarm status: Displays alarms with the status corresponding to the checked status values.

Note:TheAlarmFilterwill revert to the default settings if theAlarmGroup is renamed.

15.11.4Play/PauseButton

The Alarm Viewer window can be paused from being updated with incoming alarms using thePlay/Pause button. This allows the operator to inspect and sort the list without interference from anyincoming alarms. The list also pauses when an alarm is selected.

The alarm list starts updating again when

• the Play button is pressed• the operator changes screen and returns to the same screen (or goes to another screen showing

the Alarm Viewer)• after a 5 minute time-out

15.11.5InfoButton

Pressing the Info button in the Alarm Viewer triggers the action specified in theAlarmEvent InfoRequestedgroup on theActions tab, when an item in the alarm server is selected.

Any action in the list can be selected.



This action will be applied for the individual alarm first. If no action is specified for the alarm, the actionwill be applied for the group. If no action is specified for the group, the action will be applied for thealarm server.

Related informationAlarm Groups

Alarm Conditions

Alarm Event Info Requested

15.11.6ModifyingAlarmDistributionSettings inRuntime

It is possible to configure actions, or to use the Alarm Distribution Viewer to modify the address bookand alarm distribution settings in runtime.

Note:If the Alarm Distribution Viewer or alarm distribution actions are used in runtime, it is possible that alarmdistribution settings have been modified. Next time you download a project to the HMI-panel, you will get anotification, and selection to overwrite panel settings or not.

Related informationAddress Book Action Groups

Output Devices Action Groups

15.11.7ManageAlarms

It is possible to manage enable status of alarms in a popup window by enabling the Manage Alarmsfunction.

The scripts/actions are connected to the Alarm Viewer object. The actions are located under theAlarm Viewer.

All relevant properties like font, size, colors are copied from the Alarm Viewer when the ManageAlarms popup is opened. It is not possible to set properties individually for the Manage Alarms screen.

Filter and group functions are available when disabling/enabling alarms. Select and Enable/Disableonly affects filtered alarms.



Note:Multi-select functionality is only available on controller.

Figure 15-1: Example of filtering on “Group 2” in Manage Alarms popup window.


Kollmorgen Visualization Builder | SECURITY MANAGEMENT

16 SECURITYMANAGEMENTUsing security groups and passwords in the HMI-panel makes it possible to create a security systemfor the project. Operators can easily be assigned different authorizations in the project to restrictaccess to objects and functions. Security group information and passwords are stored in the projectdatabase.

It is not necessary to use this function if unrestricted access is acceptable. The security function is apredefined component of the Project Explorer.

16.1 GeneralSecuritySettings

General settings for the security function are available by clicking onSecurity in the Project Explorer,selecting theUsers tab and clicking theSettingsbutton.


Select action onaccess denied

When a users’s access rights are not sufficient to e.g. modify an object orcarry out an action, it is possible to display an access denied message oropening a login dialog. SelectingNoneperforms no action.

Select visibility When a user with insufficient access rights tries to affect an object, it ispossible to specify visibility for those objects:

Disabled: Only users with sufficient access rights can affect the object.The object is visible, but disabled, for users with insufficient access rights.

Hidden: Only users with sufficient access rights can see the object. Theobject is invisible for users with insufficient access rights

Normal: Only users with sufficient access rights can affect the object. Theobject looks normal for users with insufficient access rights

Automatic logout Checking the box makes it possible to log out users automatically aftera certain number of minutes of inactivity. After an automatic logout isexecuted, a screen jump to the start screen will be performed.



Note:The automatic logout will not be carried out if a communication error (COM error) is active in the panel. Afterremoving the communication error from the panel, the automatic logout will be performed within the specifiedtime, calculated from when the communication was reestablished.

16.1.1 PasswordRulesProperties

Allows setting a minimum number of characters for passwords.

Related informationLogging In and Logging Out

16.2 SecurityGroups

Security groups are defined on theGroups tab of the security configuration page. When objects andscreens have been set up with restricted access, the current user must belong to a specific securitygroup in order to control or see the object or screen.

16.2.1 CreatingSecurityGroups

A new security group in a project is defined by clicking onSecurity in the Project Explorer, selectingtheGroups tab and clickingAdd.



Parameter DescriptionName Any alphanumeric string, beginning with a letter (a-z, A-Z)

Users Selection of users defined on theUsers tab to be included in thegroup

Users Invisible in Runtime When the box is checked, the users in the current group will not beavailable for selection from theLogindialog in runtime. It will still bepossible to type in the user name and password to login.

HMI-panel targets only: In order to enable the possibility to manuallyenter a user name and password, it is necessary to click the “Login”header on the Login dialog in runtime. Doing so and then clicking ontheUser—field will present the user with a keyboard on which a username can be entered.

16.3 Users

Users and passwords for login are defined on theUsers tab of the security configuration page.

Parameter DescriptionName Any alphanumeric string, beginning with a letter (a-z, A-Z)

Password Any alphanumeric string; minimum length according toPasswordRulesproperties. The password is converted to asterisks as youleave the password input cell.

Description An optional description of the user

Groups Selection of security groups for the user

It is also possible to add users and change passwords directly in a running project, using theShowUsersDialogaction.



16.3.1 Logging InandLoggingOut

The login dialog can be displayed in runtime by, for example, clicking a button, for which theLoginaction has been specified. It is possible to change password from the login dialog.

The login dialog lists all users that have been configured for the current project, except for users ingroups for whichUsers Invisible inRuntimewas selected.

It is also possible to configure a general behavior that brings up the login dialog any time a user tries toaffect an object that is not within the current user’s access rights. This behavior is configured from theProperties window for the Security function, and selectingShowLoginDialog for action on accessdenied.

TheLogoutaction is used to perform a logout.

Users may also be logged out automatically after a certain number of minutes of inactivity byconfiguringAutomatic logout in thePropertieswindow for the Security function.

Note:After logging out, the functionShowPreviousScreen for function keys and touch keys will be ignored. This is asecurity feature to prevent unauthorized persons from accessing screens protected by passwords.

Related informationGeneral Security Settings

Actions Ribbon Tab

16.4 ObjectSecurityandVisibility

Object access can be restricted to a certain security group. Each security group contains a set of usersand each user has an individual password. To be able to control an object with a security setting, theuser must belong to the defined security group, and has to login.

Object security is controlled by selecting the object, and then opening the Tag/Security group of theHome or General ribbon tabs.

When no security is set for an object, the object will be available to everyone, i.e. login will not berequested.

Note:Security has higher priority than dynamics.It is not possible to set security on function keys.



The visibility and behavior settings specified in the security manager will be used when a securitygroup is set but no explicit visibility is specified. The following options can be set:

Visibility Description

Default The object looks normal and is visible for anyone.

Disabled Only users in the selected security groups can affect the object. Theobject is visible but disabled and greyed out, for users with insufficientaccess rights.

Hidden Only users in the selected security groups can see the object. Theobject is invisible for users with insufficient access rights.

Normal Only users in the selected security groups can affect the object. Theobject looks normal for users with insufficient access rights.

Related informationTag/Security Group

Function Keys

Screen Security

16.5 CyberSecurityBestPractice

It is recommended to configure network firewalls to restrict access to the panel. For more information,contact your IT administrator. Some procedures, for example updating Image, requires access topanel and is then specified in the corresponding instructions in the reference manual.

Caution:Anysecuritymeasuresdescribed in thismanual, for example, foruser access,passwordsecurity, networksecurity, firewalls, virusprotection, etc., representpossible steps that auserofKollmorgenVisualizationBuilder,KollmorgenVisualizationBuilder andRuntimemaywant toconsiderbasedona riskassessment for aparticular applicationand installation. Thisriskassessment, aswell asaproper implementation, configuration, installation, operation,administration, andmaintenanceofall relevant security relatedequipment, softwareandproceduresare the responsibility of theuserof theKollmorgenVisualizationBuilder.

Caution:It is the responsibility of theuserof thePanel 800 todeploy theproduct appropriate, includingprocedures/policies regardingorganizationalmeasureswith requiredprecautionsandmeasures toensureKollmorgenVisualizationBuilder functionality.

16.5.1 WebServerSecurity

The web server is disabled by default. It can be enabled on request using the Enable Web serveroption available in Kollmorgen Visualization Builder. For more information on accessing the EnableWeb server option in Kollmorgen Visualization Builder and general handling of web server incontroller, refer to Kollmorgen Visualization Builder 800 6.1-0 Programming and Installation for moreinformation.



The web server provides a login form, that is used for clients to authenticate, by default. Refer tosection Login Form for more information. Replace this with a password that conforms with yourorganization's security policy at the first possible opportunity. See your organization security policy forsetting a password, refer to customer password security configuration.

Caution:If thedefault password isnot replaced, thesystemwill besusceptible tounauthorizedaccess.

The password can be any alphanumeric string. The passwords minimum length is four characters andthe maximum length is 20 characters.

Caution:After firmwareupdate tosystemversion6.1, thecontroller passwordmustbeconfiguredagain, as thepreviously configuredpassword is clearedand replacedwith thedefaultpassword.

16.5.2 FTPServerSecurity

The FTP Server Security is disabled by default. When enabled, it is possible to upload/download filesto/from the operator panel provided that there is an FTP client program in the development PC, e.g.Internet Explorer, Windows Commander or some other standard FTP program.

It is possible to set up access to the FTP server with login requirements and/or as anonymous. Ananonymous user has read-only access rights. A user that logs in with the correct user name andpassword gets read/write access rights. Refer to Section Servers Group in Reference manual formore information.

16.5.3 RemoteServerSecurity

The Remote Access function is disabled by default. The Remote Access function makes it possible toaccess, reflect and control an operator panel from a PC by using the free VNC client program RemoteAccess Viewer together with the built-in VNC server in the operator panel.

It is possible to set up Remote Access with a view only password and/or a full access password. Theview only password allows reflecting the panel remotely; the full access password allows also controlof maneuverable objects in the panel.

Only one VNC client can connect to the VNC server.

Only available when an operator panel is selected as target.

Caution:Toprotect secrecywhenenteringapasswordviaRemoteAccessViewer, it is recommendedtouse thePCkeyboard. Otherwise it is possible that thecursoron the remoteoperatorpaneldisplayswhichkeysarepressedon thealphanumeric keyboard. Refer toSectionServersGroup inReferencemanual formore information.



16.5.4 OPCUASecurity

The OPC UA Server is disabled by default. When enabled by the Enable OPC UA Server optionavailable in Panel 800 it is possible to publish tags with an OPC UA Server.

A certificate will be auto generated and self-signed when the server first starts up. The certificatewill be valid for 20 years. The certificate contains no IP address since this could change after thecertificate has been generated.

LimitationsDiscovery Not supported

Encoding/Transport Only UATCP Binary

User authentication Only user name/password. Only one account.

Security No encryption support.

Refer to Section Servers Group for more information.

16.5.5 ProjectTransferSecurity

Selecting Back Up Project compresses the project and saves it as a ZIP file. The user will be promptedfor a path where to save the ZIP file and will also be offered the possibility to password protect theZIP file.

Upload: Starts the transfer of the ZIP file from the selected target. The user will be prompted for apath where to decompress the ZIP file. If the ZIP file is password protected, the user must enter thepassword to be able to upload and decompress the ZIP file. Upload is not supported for all panels. Ifgreyed out, please update to latest “System program”.

Verify: The verify function enables the user to check if a target platform configuration is identical tothe project configuration. Verify is not supported for all panels. If greyed out, please update to latest“System program”.

16.5.6 Email (Alarmdistributer)

User name and password protected if Authenticated Login is selected. Refer to Section ConfigureDistribution Devices in Reference manual for more information.

16.5.7 EthernetPrinterDevices

User name and password protected if Authenticated Login is selected. Refer to Section OutputDevices Group in Reference manual for more information.

16.5.8 PasswordSettings

Password protection for Remote Access, Web server, OPC UA Server and FTP server is set in designtime when creating projects. Any changes to passwords has to be done to the project in design timeand the project has to be re-downloaded.

Password protection for Define Security User and Alarm Distributor Security is set in runtime, but canbe set in design time as well. Default setting is set to “No password” when enabling a function.



Caution:It is highly recommended toset apasswordwhenenablinganew function, especiallywhen itis exposed to the internet.Togethighsecurityon thepassword, itmust includeupper and lowercase letters, numbersandspecial characters.

16.5.9 DefineSecurityUsers

Using security groups and passwords in the operator panel makes it possible to create a securitysystem for the project. Operators can easily be assigned different authorizations in the project torestrict access to objects and functions.

Security group information and passwords are stored in the project. Security level is set per usergroup. The security groups are set in design time, and only the members of a security group canbe modified in runtime. Refer to Section Security Management in Reference manual for moreinformation.

When a user with insufficient access rights tries to affect an object, it is possible to specify visibilityfor those objects:

Disabled: Only users with sufficient access rights can affect the object. The object is visible, butdisabled, for users with insufficient access rights.

Hidden: Only users with sufficient access rights can see the object. The object is invisible for userswith insufficient access rights.

Normal: Only users with sufficient access rights can affect the object. The object looks normal forusers with insufficient access rights.

It is recommended to use visibility Hidden for sensitive functions only visible for example serviceengineers. Refer to Section Security Management in Reference manual for more information.

16.5.10ServiceMenuPasswordSetting

Enter a pin code for the service menu. No pin code enables the service menu for all users. Onlynumbers (0–9) are allowed. Refer to Section Service Menu Group in Reference manual for moreinformation.

16.5.11Audit Trail

The Audit Trail function makes it possible to track operator actions. When enabling the Audit trailfunction to a project, select which actions to log. No actions are set in the default setting. Refer toSection Audit Trail in Reference manual for more information.

The following actions that can be logged, are specified in the table below:

• Show unit conversion dialog• Acknowledge All Alarms• Acknowledge Selected Alarm• Alarm Info• Clear all Alarms• Filter Alarms• Pause Viewer• Enable/Disable Alarms• Zoom In• Zoom Out• Pan Down



• Pan Up• Pan Right• Pan Left• Trend Viewer History• Show Backlight Settings• Set Date and Time• Set Time Zone, Region and Daylight Saving• Copy Debug Log To USB Memory• Disable Debug Logger• Enable Debug Logger• Show IP Settings• Print Screen• Close Application• Run• Show Next Screen• Show Previous Screen• Show Start Screen• Back Up Alarm, Data Logger and Recipe Database• Back Up Alarm, Data Logger and Recipe Database for Project Restore• Back Up all Databases for recovery• Database Cleanup• Database Export• Decrement Analog• Increment Analog• Reset Tag• Set Analog• Set String• Set Tag• Toggle Tag• Open Address Book• Open Print Settings• Open Routes Configurations• Back Up Audit Trail Database• Clear Data Logger• Log Once• Start logging• Stop logging• Email Configuration• Set Language• Change Active Controllers• Clear Non-volatile Values• Printer Configuration• Delete Recipe• Load Recipe• End Offline Recipe Editing• Export Recipe• Import Recipe• Save Recipe• Start Offline Recipe Editing• Generate Report• Show Screen• Close screen



• Run Script• Login• Export User Accounts• Import User Accounts• Logout• Show User Dialog• SMS Configuration

16.5.12Antivirusprogram

It is recommended to have a antivirus program installed on your PC.

Note:The Panel 800 has been tested while the antivirus program, McAfee Virusscan Enterprise and Symantec, hasbeen active.

16.6 PhysicalSecurity

Physical security considerations elaborate measures that shall be in place to prevent unauthorizedaccess via physical channels into the system. Measures can be security guards, locks, limitations inaccess to the equipment and similar.

Kollmorgen Visualization Builder runtime is supported both on virtual and on physical machines.There is the possibility that removable assets/communication lines can be used in both thesesystems.

Caution:Theusershall implementnecessaryphysical precautions topreventunauthorizedaccess tothesystemand to removable assets/communication lines.

Kollmorgen Visualization Builder uses different modules for power supply, communication, IO’s andCPU. These modules can be replaced with spare parts if needed

16.7 OpenPorts

Communication drivers uses either dynamic ports or static ports and both are opened forcommunication. It is not always a fixed port that opens, this differs from driver to driver. Refer tospecific driver helpfile.

Type Description (Port) Openbydefault

TCP FTP (21) Yes (PP87X) No (remaining) (*)

TCP HTTP (80) No (*)

TCP DCOM (135) Yes

TCP OPC UA (Default 4840) No (*)

TCP Remote access viewer (Default 5800) No (*)

TCP Remote access viewer (Default 5900) No (*)



Type Description (Port) Openbydefault

TCP Alarm distributor, send Email.(Depends on the server)

No (*)

UDP Project Transfer (9999) Yes

UDP Netbios (137) Yes

UDP Netbios (138) Yes

TCP Transfer download (9999) No

*) Open by configuring the Kollmorgen Visualization Builder.

16.8 Clientports

The Kollmorgen Visualization Builder can use the ports, presented in the table below, when actingas a client to a server.

Type Description (Port)

TCP DHCP (135)

TCP DNS (135)

TCP WINS (135)

TCP


Kollmorgen Visualization Builder | LANGUAGE MANAGEMENT

17 LANGUAGEMANAGEMENTKollmorgen Visualization Builder supports multilingual applications. Translation of texts and systemtexts can be performed directly in the application, or via export to a text file to be translated in othersoftware. The file is imported to the application after translation.

The application language can be changed in runtime, for example based on a tag value.

17.1 SettingUpMultipleLanguages

The multiple languages function is included in the application by default and is located in the Functionsfolder in the Project Explorer.

The multiple languages configuration pages consist of the Texts, System Texts and Languages tabs.

17.1.1 AddingLanguages

1. Click on theMultipleLanguages function to open its configuration pages.

2. Select theLanguages tab.

3. Add languages by selecting them from the drop-down list.

TheUse inRuntime setting makes the language available in runtime. UnderKeyboardLayout, it ispossible to select different layouts for the virtual keyboard, used for alphanumerical input in runtime.



Note:The size of the virtual keyboards vary between languages.Examples of keyboard sizes (the values are approximative)

• Arabic: 18 MB• Chinese - simplified: 12 MB• Chinese - traditional: 36 MB• Hebrew: 6 MB• Korean: 21 MB• Latin alphabets: 0.1 MB.

Each added language is assigned an index number. Index number 0 is reserved for the defaultlanguage (the language that the application was first created in).

TheAddandDeletebuttons can be used to add and delete languages.

TheSettingsbutton allows connecting the language to a tag. This makes it possible to change theproject language based on a changed value.

Use theShowSelection/ShowAllbutton if you want to filter the languages in the current view.

Note:If scripting is done against texts which are mentioned in theMultipleLanguages, the value mentioned byscripting can be overridden by the text value in the Multi Language Server.

If the user tries to change the text value through scripting, there is a risk of it being overridden by thevalues mentioned in theTexts tab in theMultipleLanguages screen.

If the user want the value mentioned through the script to have priority, the entry for those texts in theText column in theTexts tab should be left empty. Make sure to add all multi lingual alternatives inthe script.

Related informationVirtual Keyboard

Filtering Items



17.2 SystemTexts

System texts belong to functions (e.g. alarm server or security), to the system (e.g. time zone) and toobjects (e.g. buttons or sliders), excluding text that the developer has entered.

Select theSystemTexts tab in the Multiple Languages configuration pages to edit system texts.

Several preinstalled translations of the system texts are available for selection:

• English• German• French• Brazilian Portuguese• Chinese, traditional• Chinese, simplified

Use theShowSelection/ShowAllbutton if you want to filter the current view.

The Import/Exportbutton can be used to export a system language to a text file for translation, andthen import the language after translation.

Note:Regional expressions for time, date, and weekdays are by default equal to the settings in the system account, butcan to some extent be changed in the Date, Time and Region Group under the System Ribbon tab.




Exporting Languages

Importing Languages

Date, Time, and Region Group

17.3 UserTexts

Texts that have been added to objects by the developer are available from theTexts tab in the MultipleLanguages configuration pages. The texts in the default language can be edited as well.



Note:When an object is connected to a text in the Text library, the object’s internal denomination (that is not displayed inruntime) will be presented in grey color in the Texts list, to indicate that editing the text will not affect the runtimeproject.


Exporting Languages

Importing Languages

Text Library

17.4 Text ID

TheText ID function is available from theText IDs tab on theMultipleLanguages configurationpage.

To enable theText ID function, check the “Text IDsenabled” check box on theText IDs tab.



TheText IDs tab consist of the following columns: Text ID,Default Textand one column foreach language. The text in the columnDefault Text corresponds to the default language used inKollmorgen Visualization Builder.

ClickingAddadds a row with aText ID that is equal to the highest existingText IDplus 1.



Related informationScreen Group

Filtering Items

Exporting Languages

Importing Languages

17.4.1 Text IDBrowser

If theText ID function is enabled, all text box controls in Kollmorgen Visualization Builder, includingtexts used in Kollmorgen Visualizer RT, will be replaced with theText IDbrowsercontrol.

TheText IDsare accessed from a popup list by clicking the combo box arrow next to theText IDbrowsercontrol.

TheText IDbrowser consists of two tabs, one for usingText IDand one for usingDynamicText ID.

• If the requestedText ID text is known in Kollmorgen Visualization Builder, theText ID tab shouldbe used.

• If the requestedText ID text is to be decided dynamically in runtime, then theDynamicText IDtab should be used.

Text ID

The popup list consist of the following columns: Text ID,Default Textand one column for eachlanguage. Right-clicking the column header opens up a context menu that lists all available columns.The context menu offers a possibility to configure which columns to be displayed in the popup list.



Parameter DescriptionAdd Adds a row with aText ID that equals to the highest existingText ID

plus 1

Reset Removes theText ID connection and the text falls back to thepreviously unconnected text

OK Connects the object text to the selectedText ID

Cancel Closes the popup list. No changes are made.

When an object is connected to aText ID, the displayed text in theText IDbrowser control will bepresented in the following manner:

“Text ID–Text”Text corresponds to the default language used in Kollmorgen Visualization Builder.

When opening the popup list, the text field acts as a filter for the popup list.

The object itself will only show the corresponding text, withoutText ID, which is disabled for editing.

When the language in Kollmorgen Visualization Builder or in Kollmorgen Visualizer RT is changed, atext connected to aText IDwill be updated to the corresponding text entered in theText IDs tab.

DynamicText ID

TheDynamicText ID tab consist of two tabs —TagsandAliases— and acts as a normal tag/aliasselector.



In addition, it is also possible for the graphical components to set aDefault ValueUsed inDesignMode. This value will be displayed in the object in design time, but not be used in runtime.

Parameter DescriptionAdd Adds a tag/alias

Reset Removes theDynamicText ID connection and the text falls back tothe previously unconnected text

OK Connects the object text to the selected tag/alias

Cancel Closes the popup list. No changes are made.

When an object is connected to a tag, the displayed text in theText IDbrowser controlwill bepresented as “TagName”, where TagName is the name of the tag.

When an object is connected to an alias, the displayed text in theText IDbrowser controlwill bepresented as “#AliasName”, where AliasName is the name of the alias.

When configured, the tag value in runtime represents the key (Text ID) to the Text ID table. Thedisplayed text is the corresponding translation for current language for the given key (Text ID). If thetag value is not found as a key in the Text ID table, an empty text is displayed.

17.5 AutomaticTranslation

Kollmorgen Visualization Builder includes a translation tool that uses Microsoft Translator (www.mi-crosoft.com/translator) or Google Translate (translate.google.com) to offer quick translations ofuser-defined texts or system texts. Due to license requirements you have to sign up for an accountat one of the translation providers to get the required keys. If no keys are entered KollmorgenVisualization Builder uses Microsoft Translator to translate a limited number of words per month.


http://www.microsoft.com/translator/

http://www.microsoft.com/translator/

https://translate.google.com/


Note:Automatic translations provide limited functionality; especially combination of words or words with synonymsmay be returned as incorrect translations.

The translation tool is available by clickingTranslateon the Texts or System Texts tabs of the MultipleLanguages configuration pages. Each language is translated separately.

Parameter DescriptionTranslation Provider Select translation provider among available providers.

Microsoft Translator ClientId

Type a Client Id. You need to get an account onWindows Azure Marketplace and subscribe toMicrosoft Translator API to get aClient Idand aClientSecret.




Microsoft Translator ClientSecret

Type a Client Secret key. You need to get an accounton Windows Azure Marketplace and subscribe toMicrosoft Translator API to get aClient Idand aClientSe-cret.

Google user Key Type a Public API Access Sever key. You need to create a GoogleDevelopers account and use the product Google Translate API to getthe key.

Save Key Saves the Microsoft Translator Id and Client Secret or the Googleuser Key in your user profile on the development PC.

Translatate from Selection of source language for the translation operation; the defaultlanguage (reference language) or one of the languages that havebeen added to the project.

Translate to Selection of target language for the translation operation.

Reference Language Select reference language; i.e. the language in which the project wascreated.

Only translate itemsthat have not yet beentranslated

Clear the check box to replace also already translated items in theproject.

Note:Since the translation tool accesses online translation providers, the translation operation may sometimes bepaused or delayed due to an excess of online users.

17.6 ExportingLanguages

Languages can be exported to a text file for e.g. translation.

1. SelectExport from the Import/Exportbutton.

2. Specify format, location, delimiter (for text file format) and language selection, and clickOK.



Parameter DescriptionFormat Select format of the exported file; text file or Excel file.

Path Browse to the location for the exported file

Delimiter IfText file format was selected, select delimiter from the drop-downlist; comma, semicolon, space or tab

Languages Select which languages to export

The exported file will also include the default language.

Note:To display certain characters (such as Chinese or Arabic) correctly in Excel select Unicode (UTF-8) in the Excelimport dialog.


17.7 ImportingLanguages

After translation or other editing, the updated language file can be imported to the project again.

1. Select Import from the Import/Exportbutton.

2. Specify location and language selection, and clickOK.



Parameter DescriptionFormat Select format of the file to import; text file or Excel file.

Path Browse to the location of the file to import

Languages Select which languages to import

Import Strategy SelectingKeyperforms the import according to theDesignerandObject columns in the multiple languages configuration page.ReferenceTextperforms the import according to theText column.If you have changed the texts of the default language after exportingthe languages, it is recommended to selectKey.

The imported file will also include the default language.

Note:Make sure to make a backup copy of the project before importing languages, in case there are mismatchesbetween the existing and the imported languages.



Kollmorgen Visualization Builder | AUDIT TRAIL

18 AUDITTRAILThe Audit Trail function makes it possible to track operator actions.

The Audit Trail database can be exported in csv format using theDatabaseExportaction. It isrecommended to use the database export method rather than the backup method.

Related informationDatabase Export

18.1 LoggingStrategies

To meet FDA (Food and Drug Administration) demands, it is possible to log actions in a strict manner.FDA logging implies that no log entries will ever be overwritten. If the size of the audit trail databaseis close to being exceeded (approximately 80% of the limit), a notification window will be displayed,where the user is warned, and demanded to export the data.

Alternatively, the size of the Audit Trail database can be increased. If the limit of the database isexceeded, the logging is terminated and the HMI-panel will be blocked for any further operatoractions. This is indicated by an error message.

With circular buffering, the oldest log entry is overwritten when the database is full. No warningmessage is displayed when reaching the limit of the database.

The database can be exported using an action, regardless of logging strategy. The log entries aresaved in the Audit Trail database, and the information can be displayed using the Audit Trail Viewer.

18.2 Using theAuditTrail Function

The function is enabled by selectingAudit Trail from the Insert ribbon tab. The configuration pageopens in the desktop area. All actions available for logging are listed. It is possible to log all or onlysome actions. It is also possible to log tag changes only (without logging actions).




Log All/Log None Click the buttons to quickly select all or no actions from the list

Logging strategy Select FDA or Cyclic Buffering

Max size of database The maximum size of the Audit Trail database

Value change on tags, performed by user actions, can be logged by selectingLog toAudit Trail in thetags configuration page. This option is enabled only if the audit trail function is activated in the project.

Related informationOthers in Adding Tags section

18.2.1 Audit TrailDescription

It is possible to add a description for each object that is logged to the Audit Trail database using theProperty Grid.

The description will be saved to theDescription column of the Audit Trail database, and is limited to255 characters.

18.3 Audit Trail Viewer

The Audit Trail Viewer is selected from theObjectsgroup on the Home ribbon tab. It displays theinformation from the Audit Trail database.

SelectingConfigureColumnson theGeneral tab when the Audit Trail Viewer object is selectedmakes it possible to choose and configure columns to display in runtime.



18.4 Audit Trail Export

An audit trail database can be exported as a .csv file and saved to a USB stick, an external memorycard or to the project files folder. The export is configured through theDatabaseExportactionavailable from theDatabaseaction group.

Note:The export will not delete the audit trail log from the project.

Related informationAction Groups



18.4.1 Audit Trail Export fromanHMIpanelTarget

It is possible to selectexport toUSB,export to externalmemorycardorexport to theProjectFiles folder, and also setting another name of the export file.


18.4.2 Audit Trail Export fromacontroller

It is possible to selectBrowseandSelect anexport path,Export toPathor theExport toProjectFiles folder, and also setting another name of the export file.

TheBrowseandSelect anexportpathoption allows browsing for desired export destination inruntime. This may be useful if available folders in runtime are unknown when designing the project.



Kollmorgen Visualization Builder | TEXT LIBRARY

19 TEXTLIBRARYWith the text library function, text tables can be created, where values are linked to texts. The textlibrary function can be used for presentation of each sequence step in sequence control. Anotherpossible application is to present error codes, where an analog signal generates error codesconnected to texts in a text library. The function can also be used to give analog values specific values,depending on the selected texts.

The text library function is activated by selecting it from the Insert ribbon tab.

Texts and groups can be added from theAddbutton.

It is also possible to add start and end values for each message, that makes the text in the connectedobject change depending on the value of the tag.

Note:TheStartValueandEndValue can only be given as integers. This could result in problems updating the textwhen the input value is entered with decimals, especially if the input value jumps in and out of the given range.If this is the case, use theConfigureText function instead. This is available under theGeneral tab when theobject is selected.

Note:A default text that has been entered inConfigureTextwill not be presented outside a range that has been definedin theTextLibrary. In this case, useConfigureText to define all text presentations for the object.

Related informationHMI Controls

19.1 ConnectingObjects toTextLibraryTexts

Perform the following steps to connect an object to a text library text:

1. Select the object on the screen.

2. Click onGeneralon the Dynamics tab.


Kollmorgen Visualization Builder | TEXT LIBRARY

3. Select theTextproperty, and selectTextLibraryGroupConverter.4. Browse to the tag and select the text library group.

The object will now present the texts from the text library instead of the value.

19.2 Exportingand ImportingTextLibraryTexts

The texts in the text library can be exported and imported using the Import/Exportbutton in the Textlibrary configuration page. The procedure is similar to exporting and importing tags.

Related informationImporting and Exporting Tags

Tag Import Example


Kollmorgen Visualization Builder | DATABASE EXPORT

20 DATABASEEXPORTSome databases in the project can be exported as a .csv file to a USB stick, an external memory cardor to the project files folder. The following databases are available for csv export: alarm server, audittrail, data logger and trend viewer.

Database export is not supported during project simulation.

Tip:To display certain characters (such as Chinese or Arabic) correctly in Excel, import the csv file as text, and set thefile origin toUnicode (UTF-8).

20.1 SettingupDatabaseExport

The export is triggered via an action,DatabaseExport, in theDatabasegroup.

Figure 20-1: Individual database tables may be selected for export by clicking the + sign.

The default properties for the database export is exporting the database to the project files folderwith the name as given in the project.

Note:To facilitate exporting multiple databases at once, configuring multiple actions is recommended.

Clicking the ... button next to the selected database opens a dialog from which the default databaseexport properties may be altered.



20.1.1 DatabaseExport fromHMI-panelTarget

It is possible to select export to USB stick or external memory card, and also setting another name ofthe export file. Leaving theOverwritebox unchecked adds date and time to the export file name,thus avoiding overwriting an existing export file.

Note:When exporting from a CE target (a AKI-CDAAKI2G-CDA, AKI2G-CDB, or AKI-CDB HMI-panel) note that theoptions External Memory Card and USB are not available on a controller. If the Target Type in the project ischanged from a CE target to a controller the selection is cleared and has to be made again.

20.1.2 DatabaseExport fromcontroller



It is possible to set another name of the export file. Leaving theOverwritebox unchecked adds dateand time to the export file name, thus avoiding overwriting an existing export file.

TheBrowseandSelect anExportPathoption allows browsing for desired export destination inruntime. This may be useful if available folders in runtime are unknown when designing the project.


Note:When exporting from controller to a CE target (AKI-CDA AKI2G-CDA, AKI2G-CDB or AKI-CDB HMI-panel) it isnot possible to use paths to an External Memory Card or a USB. If the Target Type in the project is changed from acontroller to a CE target the selection is cleared and has to be made again.


Simulate

Multiple Actions


Kollmorgen Visualization Builder | DATABASE CLEANUP

21 DATABASECLEANUPTheDatabaseCleanupaction can result in reduced database size and better database performance.The following are some scenarios where this action could be used:

• When a large amount of data is deleted from the database file it leaves behind empty space. Thismeans the database file might be larger than necessary. Running theDatabaseCleanupactionreclaims this space and reduces the size of the database file.

• Frequent inserts, updates, and deletes can cause the database file to become fragmented, wheredata for a single table or index is scattered around the database file. Running theDatabaseCleanupaction ensures that each table and index is stored continuously within the database file.Having indexes in order improves performance.

Note:TheDatabaseCleanupaction works by copying the contents of the database into a temporary database file andthen overwriting the original with the contents of the temporary file. When overwriting the original, a rollbackjournal or write-ahead log WAL file is used just as it would be for any other database transaction. This means thatwhen performing aDatabaseCleanupaction on a database, as much as twice the size of the original databasefile is required in free disk space.

Note:TheDatabaseCleanupaction will fail if there is an open transaction, or if there are one or more active SQLstatements when it is run.

Example:Before performing an export of a project the project size could be shrunk. This is done by first using theClearDataloggeraction, and then theDatabaseCleanupaction.

Example:If an unusually big amount of database transactions has been performed, aDatabaseCleanup could help boostdatabase performance.


Kollmorgen Visualization Builder | HMI PANEL SYSTEM SOFTWARE

22 HMIPANELSYSTEMSOFTWAREIn the HMI-panel, Kollmorgen Visualizer RT comes pre-loaded on delivery.

Kollmorgen Visualizer RT can be replaced, that is, updated to a newer version, either via PC or viaexternal memory card.

An Image Loader is used to download system programs to the HMI-panel via a PC. The Image Loaderis available from the web site.

Note:When updating an HMI-panel, it is important to ensure that power is not interrupted during the transfer.It is not recommended to downgrade the system software to a previous version.Kollmorgen Visualization Builder can not be run on the same PC as Kollmorgen Visualizer RT.

22.1 WelcomeScreen

When the HMI-panel is started, the welcome screen is displayed. The following items about theHMI-panel are listed:

• Size of internal memory card, if applicable• IP address• Image version

If there is a project in the panel, it will be loaded automatically.

If there is no project in the panel, touching the screen will display the Service menu.

Related informationService Menu

22.2 ServiceMenu

The service menu for the HMI-panel can be accessed before a project is downloaded.

22.2.1 ServiceMenu inanEmptyPanel

When no project is loaded in the panel memory, the panel will boot, displaying the Welcome screen.

• Press anywhere on the panel display to enter the service menu.

22.2.2 ServiceMenu inAKI-CDA/AKI-CDB/AKI2G-CDA/AKI2G-CDBPanels

Perform the following steps to enter the service menu:

1. Apply power to the panel.

2. When the hourglass appears, press a finger on the screen and hold for approximately 20 seconds.

3. If the service menu is password protected, you will be prompted for a pin code. Enter pin code.

4. The touch calibration screen will display the following message:“Tap anywhere on screen or touch calibrate will start in 10 seconds.”

5. Press finger once again to enter the service menu.



22.2.3 ServiceMenuOptions

The service menu is only available in English.

IPSettings

Select to obtain an IP address automatically via DHCP, or specify an IP address. The IP addresscan also be set during project transfer.

For panels with two Ethernet ports, select port according to the illustration below.

The port that is currently connected is recognized by a *.

Date/Time

Use theDate/TimeSettingsdialog to set the time zone, date and time for the panel.

EraseProject

The erase function will detect if the project is located in the panel memory or on a memory card.PressingEraseProjectwill completely remove the project and all its components from the panelmemory/the memory card.

CopyProject

SelectingCopyProjectwill copy a project from a connected memory card to the panel memory.

If there is already a stored project in the target panel, the copy command will result in a dialog asking ifa backup of the existing project should be saved on the memory card.

If IP settings are stored in the memory card, a dialog will appear, asking if the IP settings should beapplied to the target panel. It is necessary to reboot the panel for the IP address to be updated.

The copy function can also be used to copy a project from a USB memory, however without thepossibility to transfer IP settings.

TouchCalibrate

SelectTouchCalibrate if the touch screen needs to be calibrated. Follow the instructions on thescreen to perform a calibration.

Close

PressClose to exit the service menu.

22.3 HMIpanelUpgrade

The HMI-panel can be upgraded using the Image Loader application.



22.3.1 Requirements

Updating of the HMI-panel system program requires the following:

• A PC with Image Loader application.• An Ethernet connection between the PC and the HMI-panel.• The HMI-panel IP address.• The Image file from the web site.

22.3.2 Transfer Image

1. Double-click on the executable Image Loader file to start the transfer program.

2. Follow the instructions.

Transferprocedure inAKI-CDApanels

The image transfer procedure is completely menu-driven. The HMI-panel will be ready for transferdirectly afterwards, provided that all steps are performed and completed.

The following steps outline the transfer procedure:

1. Disconnect the power supply from the panel.

2. Press a finger on the screen and apply power

3. Start the Image loader software on the computer, and follow the instructions on screen.

4. Select the HMI-panel to upgrade by entering its IP address.

5. ClickUpgrade.

6. When the upgrade is finished, disconnect power from the HMI-panel.

7. Reconnect power to the HMI-panel.

8. Once the system files have been updated, a project can be downloaded to the HMI-panel.

Note:When updating an HMI-panel, it is important to ensure that power is not interrupted during the transfer.

Transferprocedure inAKI-CDBpanels


The AKI-CDB panels can be updated either by using a USB flash drive, or using the Ethernetconnection to transfer the files.

TransferprocedureusingaUSB flashdrive

1. Start the Image loader software on the computer.

2. Plug an empty USB flash drive into the computer running the Image loader software.

3. Select the USB flash drive in the Image loader software.

4. ClickCreate.

5. Disconnect power from the HMI-panel

6. Plug the USB flash drive into the HMI-panel.




8. Once the system files have been updated, any existing project in the panel will be started.


Transferprocedureusing theEthernet connection



3. ClickUpdate. Any project running in the panel will be stopped, and the update sequence willbegin.





Transferprocedure inAKI2G-CDA/AKI2G-CDBpanels


The AKI2G-CDA/AKI2G-CDB panels can be updated either by using a USB flash drive, a recovery SDcard, or using the Ethernet connection to transfer the files.

Note:AKI2G-CDA panels does not support USB flash drive or SD Card updates.

TransferprocedureusingaUSB flashdrive


2. Plug an empty USB flash drive into the computer running the Image loader software.

3. Select the USB flash drive in the Image loader software.

4. ClickCreate.

5. Disconnect power from the HMI-panel

6. Plug the USB flash drive into the HMI-panel.






Transferprocedureusing theEthernet connection



3. ClickUpdate. Any project running in the panel will be stopped, and the update sequence willbegin.





Transferprocedureusing theRecoverySDCard

Note:You should only use the Make Recovery SD Card option after first consulting with Kollmorgen support.


2. Click check boxMakeRecoverySDCard.



3. Select the drive where the SD Card is connected.

4. ClickCreate.

5. Disconnect power from the HMI-panel.

6. Insert the SD card to the HMI-panel.


8. Follow the instruction on the HMI-panel.




Kollmorgen Visualization Builder | MULTIPLE CONTROLLERS

23 MULTIPLECONTROLLERSIt is possible to use multiple devices or controller controllers with one HMI-panel. This means thatthe operator can communicate with different controllers simultaneously. The controllers can beconnected to either the serial port or the Ethernet port.

Note:If the same tag is connected to addresses in more than one active controller, there is no way to control from whichcontroller the value is read in runtime.

23.1 AddingaController

Click onTags in the Project Explorer, select theController tab and clickAdd to add a new controller inthe current project, and select which controller model and driver that is to be used.

Tags are added and controller is selected on the Tags tab.

Related informationAdding a Controller

23.1.1 Addressing

Addressing of the tags in the controllers is carried out according to the help file for each driver.


Kollmorgen Visualization Builder | MULTIPLE CONTROLLERS

When assigning a tag to an object, all tags, regardless of controller connection, are available forselection.

23.1.2 Examples

The following examples show configurations where multiple drivers are used in the HMI-panel.

Figure 23-1: The HMI-panel communicating with one controller and one frequency converter.

Figure 23-2: The HMI-panel communicating with two controllers of different makes via Ethernet.


Kollmorgen Visualization Builder | TROUBLESHOOTING

Kollmorgen | April 2017

24 TROUBLESHOOTING 24.1 Troubleshooting KVB

This section describes tools to use in case of unexpected behavior in Kollmorgen Visualization Builder.

24.1.1 Trouble Installing Kollmorgen Visualization Builder on Windows 8.1 If you get an error message about .NET Framework 4.5.X when installing Kollmorgen Visualization Builder on Windows 8.1, then run Windows Update and try to install Kollmorgen Visualization Builder again.

24.1.2 Project Build Failure If project build fails, check that the absolute path to the project, including its components, does not exceed 260 characters.

24.1.3 Back Up Project Issues Make sure that project that is fetched using the Back Up command is identical to the current Kollmorgen Visualization Builder project; i.e. has the same name and is of the same size.

Related Information Upload Database

24.1.4 Invalid Names If using system device names when naming objects such as controllers, screens, recipe managers, data loggers and script modules, an error message will be displayed, stating that this is an invalid name. Examples of system device names: AUX, COM1, CON, LPT3, NUL, PRN.

Related Information Name Group

24.1.5 Adobe Reader not Recognized For the PDF Viewer object to recognize that Adobe Reader is installed in the development PC as well as in the target, the setting Display PDF in browser must be enabled in Adobe Reader.

1. Open Adobe Reader and select Edit/Preferences/Internet. 2. Check the Display PDF in browser box.

24.1.6 Expressions Cannot Be Found If an error indicating that an expression cannot be found is generated at project validation, make sure that objects inserted from the Component library uses global expressions only.

Related Information Upload Database



24.1.7 Performance Issues Related to Graphics When designing Kollmorgen Visualization Builder projects, the CPU load may suddenly increase when performing actions such as moving objects on the screen or hovering over buttons, depending on which graphics card is used.

This problem may be solved by turning off the hardware acceleration of the graphics card. In Windows this is done under the advanced display settings on the Troubleshooting tab.

Note: Should you experience problems with the graphic rendering, make sure the latest graphical driver is used. If the latest graphical driver is used and rendering issues still occur, upgrade to a better graphics card.

Related Information System Requirements and Limitations

24.1.8 Error Related to Third Party Controls When opening a project including third party controls, the third-party controls must be included in the Kollmorgen Visualization Builder third party control folder. Otherwise the project may terminate, or unexpected error messages may be displayed.

When referencing third-party assemblies (.dll files), make sure not to place two files with the same fully qualified assembly name in the same folder, otherwise errors may occur.

24.1.9 Performance Issue When Navigating in Script Tree View If you are working with a large Kollmorgen Visualization Builder project, especially a project with many tags and alarms, you may find that navigating the script tree view is slow. The performance can be improved by saving the project.

Related Information Script

24.1.10 Performance Issue When Navigating in Script Tree View If you are working with a large Kollmorgen Visualization Builder project, especially a project with many tags and alarms, you may find that navigating the script tree view is slow. The performance can be improved by saving the project.

24.2 Troubleshooting Common System Issues Using an AKI Terminal with a PxMM This section describes troubleshooting common problems with KVB and the AKI terminal with PxMM.



24.2.1 How Do I Get Started with KVB When It Is Used in A KAS System with A PxMM? The KVB software has a separate install file, which is available from Kollmorgen.com. After installation on a PC, KVB can be opened from the KAS IDE (Integrated Development Environment) by double clicking on the KVBProject item in the Project tree once the KVB Project item has been added.

24.2.2 Should I Create A KVB Project at The Controller Level or At the System Level in The KAS IDE?

The difference between the options is that at the controller level, the brief setup in the IDE does not select a specific AKI panel. The AKI panel selection is done inside the KVB environment. When added at the System level you are prompted to select a particular AKI HMI model. The AKI model information is transferred to KVB when it is opened.

Note: Some New Project templates already include KVB projects in the controller section.

At the system level:

At the controller level:



24.2.3 To Make Variables Accessible to KVB I Selected the KVB Box in The IDE Dictionary, But It Never Made It Into KVB. Why?

Variables are transferred to KVB from the IDE at the point when KVB is opened from inside the IDE. The variables transferred are those selected (box checked) prior to the last .KAS project compiled by the IDE. Changes to the list, including additions, will transfer after the next compilation and opening the KVBProject from the IDE.

24.2.4 I Cannot Download the Program to The AKI HMI 1. If the .KVB project will not compile, review the error log at the bottom of KVB and try to

correct the issues. 2. Check the AKI terminal to verify the address in the Target field is the same as set in the

Terminal.



24.2.5 I Cannot Run a Project from Inside KVB With the KAS Simulator This capability allows testing both the KVB screens and the KAS application code without hardware. Without the PxMM not all functionality may be able to be tested, yet for many applications basic code flow and operations can be tested.

To use this capability, make sure the KAS project has a controller address of 127.0.0.1 in the IDE. Clicking on the Simulator button in the IDE will adjust the IP address to this. The IP address is sent when KVB is opened (inside the IDE). If KVB is open when setting this address, close KVB and reopen it.

24.2.6 How Do I Check the IP Address of The AKI Terminal? During power-up and before the loaded project is started, the IP address will appear on the bottom left corner of the AKI screen

24.2.7 How Do I Set Up or Change the IP Address of The AKI Terminal? Perform the following steps to enter the service menu:

1. Apply power to the panel. 2. When the hourglass appears, press a finger on the screen and hold for approximately 20

seconds. 3. If the service menu is password protected, you will be prompted for a pin code. Enter pin

code. 4. The touch calibration screen will display the following message: “Tap anywhere on screen

or touch calibrate will start in 10 seconds.” 5. Press finger once again to enter the service menu.

24.2.8 How Can I Find More Information on How to Add C# Coding to the KVB Project? Read the KVB Users Manual. Do a search for “C#” on KDN in the PxMM sections. This will give you information to start. If you need more detail, contact your Kollmorgen representative.

24.2.9 How Do I Set the PxMM Address In KVB? The IP address set in the IDE is sent to KVB when it is opened.



The IP address is stored here in the KVB project:

24.2.10 What Are System Variables and How Do They Get Added To a .KVB Project? System variables are local variables (or internal tags) in KVB that can be used in the C# language to get information that can then be sent back to the PxMM or used to trigger or change operation in the AKI.



24.2.11 How Can I Change the Modbus Update Rate for Communications Between the PxMM And AKI Terminal?

In KVB, go into the Poll Groups tab within the Tags section. Here the update rate of tags can be set by Groups with each Group settable down to 100 msec.

In the Tags tab of the Tag section variables can be linked to a polled group.

24.2.12 Can an AKI Terminal Be Connected to Multiple PxMMs? Yes, additional addresses can be added

Then click on the Settings button, then the Stations tab



24.2.13 Can Modbus TCP/IP (To the PxMM) And Modbus RTU (To A Third-Party Device) Be Used and Be Functional at the Same Time?

Yes. The Modbus TCP/IP connects to the PxMM and the Modbus RTU connects to the third-party device. For setup of Modbus RTU communications: http://kdn.kollmorgen.com/content/kas-modbus-rtu-communications-through-aki-terminal

24.2.14 What Are Common Ways to Load A KVB Project into the AKI Terminal? Use the Download button to load via a URL address Use the Export button to export to a memory stick, to then be inserted into the AKI

24.2.15 How Do I Setup Multiple HMI Panels to Communicate with One PDMM at the Same Time?

Multiple AKI HMI panels (Modbus Master) can talk to a PDMM (Modbus slave) at the same time. Each Modbus master via the .KVB project is set up to communicate to the same PxMM address.

24.2.16 In KVB, How Do I Check or Setup the .KVB Program to Download to A Particular AKI Model?

Go to Settings, then Display/Target.

http://kdn.kollmorgen.com/content/kas-modbus-rtu-communications-through-aki-terminal

Kollmorgen Visualization Builder | APPENDIX


25 APPENDIX 25.1 How Do I Start a KVB Project from Within KAS?

From within the KAS IDE, double-click on KVBProject in Project Tree. The project is found at the System or Controller level, depending on where you created it.

25.2 What is Imported from the KAS IDE When I Open KVB? When you open KVB from within the KAS IDE, vital information is transferred. This includes: The IP Address Variables (Tags) that have been flagged as applicable to KVB. Please note that only

those items which were selected at the last compile command will be sent to KVB. The selected AKI panel type if KVBProject was created at the system level.

25.3 How do I Designate the Variables in the KAS IDE That Will Be Mapped to KVB? Transferring variables from KAS IDE to KVB is a simple process in the dictionary. This process assumes you have created all necessary variables.

1. Open the Variables list editor in the Dictionary toolbox.2. For each required variable, select the KVB checkbox to tab that item.



Once the project is compiled, these tagged variables will automatically be mapped and transferred when you create the KVB project. This may be done at any time; should you add a new variable which needs to be transferred, simply tag it as “KVB”, re-compile your KAS project, and open the KVBProject.

25.4 How to Download a Project to an AKI Terminal Use the Download button to load via a URL address and an Ethernet connection. Use the Export button to export to a USB memory stick, to then be inserted into the AKI

25.5 Simulating or Testing Your Project with KVB and the KAS Simulator Just as you can simulate your project in the KAS IDE and run it on the KAS Simulator, you can test your KVB-created HMI screens in KVB (not downloaded to a panel) connected to either the KAS Simulator or an actual PxMM controller. Following are instructions on how to achieve this. You can replicate this same example by creating a new KAS project using a 2 Axes FFLD PLCopen template. This template is one of several that have pre-defined KVB projects and HMI.

Following are two important points which must be set before you can use KVB to simulate a project. The template we selected already meets these criteria:

The IP address is set to 127.0.0.1 (“home”); this is required to run with the KAS Simulator. This project type, in addition to having a pre-defined KVB project, has had the necessary

variables selected to be transferred to KVB.

To proceed, use the following directions.

1. Click the Simulated Device button. 2. Click the Compile button. 3. Launch KAS Simulator. 4. Click the Connect button.

At this point you can simulate within KAS and use the built-in control panel. 5. Click the Run button. This will load the axes into the KAS Simulator, they are light blue

which means they are Simulated, Power Off.



6. Double-click the KVBProject item in the Project Tree to launch KVB, and click Yes to

open the project.

7. From KVB’s Project menu, click Run. This will open a virtual HMI panel.

Note: The Simulate button renders the KVB screens, but it cannot be used to connect to a simulation or actual controller.

8. Click the green Enable button. This will activate the Ready light and the axes in the Simulator are light green, which means they are Simulated, Power On.

9. Click the Show Geared Move Commands button to switch screens.



10. Click the Run/Stop toggle switch to spin the axes. From here you may adjust the axes speeds and increments as you wish. You are simulating your project, including the HMI.

AboutKOLLMORGEN

Kollmorgen is a leading provider of motion systems and components for machine builders. Through worldclassknowledge in motion, industry-leading quality and deep expertise in linking and integrating standard and customproducts, Kollmorgen delivers breakthrough solutions that are unmatched in performance, reliability and ease-of-use,giving machine builders an irrefutable marketplace advantage.

Join the Kollmorgen Development Network for product support. Ask the communityquestions, search the knowledge base for answers, get downloads, and suggestimprovements.

NorthAmerica EuropeKOLLMORGEN KOLLMORGENEuropeGmbH203A West Rock Road Pempelfurtstraße 1Radford, VA 24141 USA 40880 Ratingen, Germany

Web: www.kollmorgen.com Web: www.kollmorgen.comMail: [email protected] Mail: [email protected].: +1 - 540 - 633 - 3545 Tel.: +49 - 2102 - 9394 - 0Fax: +1 - 540 - 639 - 4162 Fax: +49 - 2102 - 9394 - 3155

SouthAmerica ChinaandSEAKOLLMORGEN KOLLMORGENAvenida Tamboré - 1077 Tamboré - Room 202, Building 3, Lane 168Barueri — SP Brasil Lin Hong Road, Changning DistrictCEP: 06460–000, Brazil Shanghai, China

Web: www.kollmorgen.com Web: www.kollmorgen.cnMail: [email protected] Mail: [email protected].: +55 11 4191- 4771 Tel.: +98 - 400 661 2802

.

http://kdn.kollmorgen.com/