2. Computers & electronics
  3. Software
  4. Pro-face
  5. BLUE Open Studio 2023

Pro-face BLUE Open Studio 2023 Owner's manual

  • Hello! I've reviewed the BLUE Open Studio Help Manual and I'm ready to assist you with any questions you may have about the software. This manual provides comprehensive guidance on topics ranging from project creation and tag management to screen design and industrial graphics. Feel free to ask me anything about the software's features, functionalities, and how to effectively use them.
  • What is BLUE Open Studio?
    What does the manual cover?
    What kind of graphics can I create?
    Does BLUE Open Studio supports alarms?
    Can I customize the user interface?
www.pro-face.com
BLUE Open Studio
Help Manual
BOS-TECH_12
08/2023
Legal Information
The Pro-face brand and any trademarks of Schneider Electric SE and its subsidiaries
referred to in this guide are the property of Schneider Electric SE or its subsidiaries.
All other brands may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and
furnished for informational use only. No part of this guide may be reproduced or
transmitted in any form or by any means (electronic, mechanical, photocopying,
recording, or otherwise), for any purpose, without the prior written permission of
Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide
or its content, except for a non-exclusive and personal license to consult it on an "as
is" basis. Schneider Electric products and equipment should be installed, operated,
serviced, and maintained only by qualified personnel.
As standards, specifications, and designs change from time to time, information
contained in this guide may be subject to change without notice.
To the extent permitted by applicable law, no responsibility or liability is assumed by
Schneider Electric and its subsidiaries for any errors or omissions in the informational
content of this material or consequences arising out of or resulting from the use of the
information contained herein.
As part of a group of responsible, inclusive companies, we are updating our
communications that contain non-inclusive terminology. Until we complete this
process, however, our content may still contain standardized industry terms that may
be deemed inappropriate by our customers.
To help keep your Pro-face products secure and protected, we recommend that you
implement the cybersecurity best practices. Following the recommendations may
help significantly reduce your company’s cybersecurity risk. For the
recommendations, refer to the following URL:
https://www.pro-face.com/trans/en/manual/1087.html
Secure the network using Windows firewall during running Database Gateway
features.
Cybersecurity Best Practices
Contents
Page 2
Contents
INTRODUCTION..................................................................................................17
Conventions used in this documentation............................................................................................................................. 19
About this software...............................................................................................................................................................20
Internal structure and data flow........................................................................................................................................... 23
Executing and switching modules........................................................................................................................................ 27
Executing and switching the Background Task....................................................................................................................31
INSTALLATION GUIDE.......................................................................................33
About the software components...........................................................................................................................................34
Differences between the runtime editions............................................................................................................................36
Install the full software..........................................................................................................................................................39
Install the Thin Client software.............................................................................................................................................43
Install the Custom Widget Framework on a client station............................................................................................ 44
LICENSING..........................................................................................................46
License Settings....................................................................................................................................................................47
Product Versions............................................................................................................................................................47
Execution modes........................................................................................................................................................... 48
Hardkey Licenses................................................................................................................................................................. 50
Install a new hardkey license........................................................................................................................................50
Upgrade an existing hardkey license............................................................................................................................50
Softkey Licenses...................................................................................................................................................................52
Install or upgrade a softkey license for a full software installation............................................................................... 52
Remotely install or upgrade a softkey license for HMI Runtime.................................................................................. 53
THE DEVELOPMENT ENVIRONMENT..............................................................55
Title bar................................................................................................................................................................................. 56
Quick Access Toolbar........................................................................................................................................................... 57
File menu.............................................................................................................................................................................. 59
New................................................................................................................................................................................ 59
Open Project..................................................................................................................................................................60
Open Project File...........................................................................................................................................................61
Save............................................................................................................................................................................... 61
Save As......................................................................................................................................................................... 62
Save All..........................................................................................................................................................................62
Save All as HTML......................................................................................................................................................... 62
Save as HTML...............................................................................................................................................................62
Save Screen Group as HMTL...................................................................................................................................... 62
Close.............................................................................................................................................................................. 62
Close All.........................................................................................................................................................................62
Recent Projects............................................................................................................................................................. 62
Print................................................................................................................................................................................62
Options...........................................................................................................................................................................63
Project Settings..............................................................................................................................................................64
Exit................................................................................................................................................................................. 64
Contents
Page 3
Ribbon................................................................................................................................................................................... 65
Home tab....................................................................................................................................................................... 65
View tab......................................................................................................................................................................... 65
Insert tab........................................................................................................................................................................66
Project tab......................................................................................................................................................................66
Draw tab........................................................................................................................................................................ 67
Format tab..................................................................................................................................................................... 67
Help tab......................................................................................................................................................................... 68
Project Explorer.................................................................................................................................................................... 69
Global tab...................................................................................................................................................................... 69
Graphics tab.................................................................................................................................................................. 70
Tasks tab........................................................................................................................................................................71
Comm tab...................................................................................................................................................................... 72
Screen/Worksheet Editor...................................................................................................................................................... 74
Watch window....................................................................................................................................................................... 75
Output window...................................................................................................................................................................... 76
Status bar..............................................................................................................................................................................77
Standard Interfaces...............................................................................................................................................................78
Object Properties dialog box.........................................................................................................................................78
Color Interface............................................................................................................................................................... 78
Fonts.............................................................................................................................................................................. 82
ASCII Character Table...................................................................................................................................................83
Performing Common Tasks.................................................................................................................................................. 85
Accessing Projects and Files........................................................................................................................................ 85
Using Common Dialog Buttons.....................................................................................................................................86
Convert your project's display resolution...................................................................................................................... 86
Using Shortcut Menus................................................................................................................................................... 88
Using Select All............................................................................................................................................................. 88
Cutting, Copying, Pasting Objects................................................................................................................................ 88
Find text in the current document or entire project...................................................................................................... 88
Replace text in the current document...........................................................................................................................90
Using the Tag Properties Toolbar................................................................................................................................. 91
Replacing project tags in a document or screen object............................................................................................... 93
Testing Screens............................................................................................................................................................. 95
Verify the project............................................................................................................................................................95
Running Projects........................................................................................................................................................... 97
Restoring Defaults......................................................................................................................................................... 97
Saving Your Work..........................................................................................................................................................97
Printing Screens and Worksheets.................................................................................................................................97
Focusing the Object Properties Window.......................................................................................................................97
Keyboard shortcuts............................................................................................................................................................... 99
PROJECT OVERVIEW......................................................................................101
Creating a new project....................................................................................................................................................... 102
About target platforms, product types, and target systems........................................................................................104
Changing the target system of an existing project..................................................................................................... 106
Configuring additional project settings............................................................................................................................... 107
Information tab.............................................................................................................................................................108
Options tab.................................................................................................................................................................. 109
Viewer tab....................................................................................................................................................................122
Communication tab......................................................................................................................................................127
Preferences tab........................................................................................................................................................... 133
Configuring your project's default email settings............................................................................................................... 136
Configuring your project's default FTP settings................................................................................................................. 138
Runtime Tasks.................................................................................................................................................................... 140
Run a project as a Windows service................................................................................................................................. 142
TAGS AND THE TAG DATABASE...................................................................148
Contents
Page 4
About Tags and the Project Database............................................................................................................................... 149
Project Tags Folder..................................................................................................................................................... 150
About classes.............................................................................................................................................................. 153
Shared Database folder.............................................................................................................................................. 155
System Tags Folder.....................................................................................................................................................156
Designing a Tag..................................................................................................................................................................159
Tag name syntax......................................................................................................................................................... 159
Choosing the Tag Type............................................................................................................................................... 159
Tag data types.............................................................................................................................................................161
Choosing the Tag Scope.............................................................................................................................................161
Creating and Editing Tags.................................................................................................................................................. 162
Adding Tags to the Datasheet.................................................................................................................................... 162
Creating Tags "On-the-Fly"..........................................................................................................................................163
Configuring a New Tag................................................................................................................................................164
Editing Tags................................................................................................................................................................. 165
About classes......................................................................................................................................................................167
Tag Properties.....................................................................................................................................................................170
Set tag properties using the Project Tags datasheet..................................................................................................171
Set tag properties using the Properties command..................................................................................................... 172
Reference a tag property instead of a project tag......................................................................................................174
Using TagsDB functions to edit the tags database during run time........................................................................... 174
Properties of Integer and Real tags............................................................................................................................176
Properties of Boolean tags..........................................................................................................................................180
Properties of String tags............................................................................................................................................. 183
Complete list of tag properties....................................................................................................................................185
Change how out-of-range tag values are handled..................................................................................................... 191
Using Tags in Your Project.................................................................................................................................................193
Deleting a tag from the project database.......................................................................................................................... 194
Sort or filter the rows in a worksheet.................................................................................................................................195
Using the Tags tools...........................................................................................................................................................198
Global Replace Tool.................................................................................................................................................... 198
Replacing project tags in a document or screen object............................................................................................. 198
Removing unused tags from the project database.....................................................................................................200
Reset Tags Database.................................................................................................................................................. 201
Tagname Text Box.......................................................................................................................................................201
Object Finder Tool....................................................................................................................................................... 201
Cross Reference Tool..................................................................................................................................................202
Set tag properties using the Properties command..................................................................................................... 202
Import Wizard......................................................................................................................................................................204
Import tags and files from a BLUE Open Studio 2023 project database................................................................... 207
Importing from OPC Server Databases...................................................................................................................... 211
Import tags from a CSV database.............................................................................................................................. 212
Importing from ODBC Databases............................................................................................................................... 215
Importing from PanelBuilder32 Databases................................................................................................................. 216
Importing PanelMate programs................................................................................................................................... 217
Importing from OMRON CX Programmer Databases.................................................................................................218
Import from a FactoryTalk application.........................................................................................................................220
Import a Studio XML Screen...................................................................................................................................... 223
Tag Integration.................................................................................................................................................................... 225
Using TagsDB functions to edit the tags database during run time.................................................................................. 226
SCREENS AND GRAPHICS.............................................................................228
Graphics tab........................................................................................................................................................................229
Screens folder............................................................................................................................................................... 230
Screen Group Folder...................................................................................................................................................234
Lay out project screens in a simulation of the client's display................................................................................... 235
Contents
Page 5
Screen Objects and Animations......................................................................................................................................... 237
Editing.......................................................................................................................................................................... 237
Shapes......................................................................................................................................................................... 240
Active Objects..............................................................................................................................................................248
Libraries section...........................................................................................................................................................274
Applying animations to screen objects....................................................................................................................... 311
Use custom properties to set property values when screens are opened................................................................. 324
Define custom keys for screen objects.......................................................................................................................326
Format tab...........................................................................................................................................................................328
Change the properties of multiple screen objects...................................................................................................... 328
Set the tab order of screen objects............................................................................................................................ 329
Bring to front / Send to back...................................................................................................................................... 331
Group and ungroup screen objects............................................................................................................................ 332
Align, Center and Distribute Tools.............................................................................................................................. 334
Rotate Tool...................................................................................................................................................................336
Resize Tools................................................................................................................................................................ 337
Fill Color Tool...............................................................................................................................................................337
Line Color Tool............................................................................................................................................................ 337
Fonts Tool.................................................................................................................................................................... 338
Data Input........................................................................................................................................................................... 339
Data input in screens on Thin Clients........................................................................................................................ 339
Data input in screens on Mobile Access.................................................................................................................... 343
Multi-Touch.......................................................................................................................................................................... 345
About the Multi-Touch settings for project screens.....................................................................................................346
About the different types of multi-touch gestures....................................................................................................... 351
About Touch Events.................................................................................................................................................... 356
Import a Studio XML Screen..............................................................................................................................................364
ALARMS, EVENTS, AND TRENDS................................................................. 366
Alarm worksheet................................................................................................................................................................. 367
Alarm Worksheet Header............................................................................................................................................ 368
Alarm Worksheet Body................................................................................................................................................372
Saving your alarm history / event log to an external database.................................................................................. 376
Format of the alarm history.........................................................................................................................................378
Events..................................................................................................................................................................................382
Enable the event logger.............................................................................................................................................. 382
Saving your alarm history / event log to an external database.................................................................................. 384
Format of the event history.........................................................................................................................................386
Alarm/Event Control object.................................................................................................................................................389
Customize the audible alarm...................................................................................................................................... 398
Trend worksheet................................................................................................................................................................. 400
Sort or filter the rows in a worksheet......................................................................................................................... 402
Creating Batch History................................................................................................................................................ 405
Converting Trend History Files from Binary to Text....................................................................................................408
Converting Trend History Files from Text to Binary....................................................................................................408
Make trend history accessible through OPC HDA..................................................................................................... 409
Trend Control object........................................................................................................................................................... 410
About the trend control runtime interface................................................................................................................... 410
Object Properties: Trend Control dialog......................................................................................................................412
Using the Data Source Text File.................................................................................................................................432
Using the Data Source Database............................................................................................................................... 435
Display text- and image-based trend annotations in a trend control..........................................................................441
Grid object...........................................................................................................................................................................445
Data dialog...................................................................................................................................................................446
Columns dialog............................................................................................................................................................ 449
Advanced dialog.......................................................................................................................................................... 452
INDUSTRIAL GRAPHICS................................................................................. 456
Create a new Industrial Graphics screen.......................................................................................................................... 457
Contents
Page 6
Create a new Industrial Graphics symbol..........................................................................................................................459
Create a new Industrial Graphics toolset...........................................................................................................................460
Embed an Industrial Graphics symbol in a screen............................................................................................................461
Using project tags in Industrial Graphics screens............................................................................................................. 463
Working with Element Styles..............................................................................................................................................464
Understanding Element Styles.................................................................................................................................... 464
Managing Element Styles............................................................................................................................................466
Applying Element Styles to Elements......................................................................................................................... 470
Applying Element Styles to Groups of Elements........................................................................................................472
Configuring an Animation Using Element Styles........................................................................................................ 473
Import an Industrial Graphics symbol library..................................................................................................................... 476
Export an Industrial Graphics symbol library..................................................................................................................... 477
Known limitations of Industrial Graphics............................................................................................................................ 479
BACKGROUND TASKS....................................................................................481
Alarm worksheet................................................................................................................................................................. 482
Trend worksheet................................................................................................................................................................. 483
Recipes............................................................................................................................................................................... 486
Report worksheet................................................................................................................................................................488
Create a new Math worksheet........................................................................................................................................... 490
About the Built-in Language interface.........................................................................................................................491
Using the Goto…Label structure in a Math worksheet...............................................................................................493
Using the For…Next loop in a Math worksheet......................................................................................................... 494
Script worksheet................................................................................................................................................................. 497
Startup Script worksheet............................................................................................................................................. 498
Scheduler worksheet.......................................................................................................................................................... 499
Database/ERP worksheet...................................................................................................................................................501
Azure IoT Hub Connection.................................................................................................................................................506
Sort or filter the rows in a worksheet.................................................................................................................................508
COMMUNICATION............................................................................................ 511
Configuring direct communication with a remote device................................................................................................... 512
Main Driver Sheet........................................................................................................................................................518
Standard Driver Sheets............................................................................................................................................... 520
Read/write status codes for direct communication drivers......................................................................................... 523
Tag Integration.................................................................................................................................................................... 527
Integrate tags from TwinCAT.......................................................................................................................................527
Integrate tags from CoDeSys......................................................................................................................................530
Integrate tags from RSLogix 5000 Family.................................................................................................................. 537
Integrate tags from Allen-Bradley PLC5, SLC500...................................................................................................... 539
Integrate tags from AutomationDirect Do-more H2 Series......................................................................................... 542
Add a Koyo DirectLOGIC PLC as a tag integration source....................................................................................... 544
Integrate tags from AutomationDirect P Series.......................................................................................................... 547
Integrate tags from AutomationDirect PAC 3000........................................................................................................550
Add a GE PACSystems or GE Fanuc device as a tag integration source................................................................. 553
Integrate tags from Schneider Unity Modbus............................................................................................................. 556
Integrate tags from Siemens S7-1200/S7-1500..........................................................................................................559
Integrate tags from OMRON Sysmac Gateway..........................................................................................................561
Add an OPC DA server as a tag integration source.................................................................................................. 563
Add an OPC UA server as a tag integration source.................................................................................................. 565
Use the Object Finder to select integrated tags.........................................................................................................567
How integrated tags may be renamed in your project............................................................................................... 569
Contents
Page 7
OPC Clients and Servers................................................................................................................................................... 570
OPC UA Client............................................................................................................................................................ 570
OPC XML/DA Client.................................................................................................................................................... 596
OPC DA 2.05 Client.................................................................................................................................................... 606
Tag Expansion for OPC Clients.................................................................................................................................. 608
Array Distribution for OPC Clients.............................................................................................................................. 610
OPC UA Client Supported Data Types.......................................................................................................................612
OPC UA Server........................................................................................................................................................... 613
OPC DA 2.05 Server...................................................................................................................................................623
Communicate with another project runtime server............................................................................................................ 624
SECURITY SYSTEM......................................................................................... 626
Using the Security System Configuration Wizard.............................................................................................................. 627
Using the Security System dialog box............................................................................................................................... 632
About security modes......................................................................................................................................................... 634
Configuring the server settings for Distributed – Client..................................................................................................... 635
Configuring the server settings for Local Plus Domain (LDAP).........................................................................................637
LDAP Settings............................................................................................................................................................. 638
LDAP Advanced Settings............................................................................................................................................ 640
LDAP Query Customization........................................................................................................................................ 642
Extending the LDAP schema to allow saving of security rights................................................................................. 644
LDAP Language Considerations................................................................................................................................. 650
Creating and configuring groups........................................................................................................................................ 651
About access levels.....................................................................................................................................................656
Creating and configuring users.......................................................................................................................................... 658
Backing up the security system configuration....................................................................................................................660
Logging on/off..................................................................................................................................................................... 662
Blocking or unblocking a user............................................................................................................................................663
Password-protecting screens, symbols, and worksheets.................................................................................................. 664
PROJECT LOCALIZATION...............................................................................665
Add a target language to the Translation Table.................................................................................................................666
Configure fonts for a target language................................................................................................................................ 668
Examples of font configuration....................................................................................................................................669
Set the project's language at startup................................................................................................................................. 671
Set the project's language during run time........................................................................................................................672
Disable translation of selected screen objects...................................................................................................................674
Configure the advanced translation settings......................................................................................................................675
Import a legacy translation file into the Translation Table................................................................................................. 677
About the date format and how to change it..................................................................................................................... 678
DEBUGGING TOOLS........................................................................................680
Watch window..................................................................................................................................................................... 681
Using the Watch tool................................................................................................................................................... 681
Opening the Watch page for Mobile Access.............................................................................................................. 683
Output window.................................................................................................................................................................... 687
Configure the log settings for the Output window...................................................................................................... 687
Save log messages from the Output window to a file................................................................................................693
About the LogWin tool........................................................................................................................................................695
Open the LogWin tool................................................................................................................................................. 695
Configure the log settings for the LogWin module..................................................................................................... 697
Save log messages from the LogWin tool to a file.................................................................................................... 700
REMOTE MANAGEMENT................................................................................ 702
Contents
Page 8
Enable security in Remote Agent and add users for Windows Embedded target station................................................. 703
Customize Remote Agent's encryption key................................................................................................................ 705
Enable security in Remote Agent and add users for Linux target station......................................................................... 706
Remotely install or upgrade a softkey license for HMI Runtime........................................................................................710
Download your project to the target device....................................................................................................................... 712
Run or stop your project on the target station...................................................................................................................714
Configure Remote Agent to autorun a project...................................................................................................................715
HMI RUNTIME................................................................................................... 716
Supported features in HMI Runtime...................................................................................................................................717
Remotely manage the runtime software on a target station..............................................................................................724
Remotely install or upgrade a softkey license for HMI Runtime........................................................................................728
Enable security in Remote Agent and add users for Linux target station......................................................................... 730
Run or stop your project on the target station...................................................................................................................734
About the runtime log for HMI Runtime.............................................................................................................................735
THIN CLIENTS AND MOBILE ACCESS..........................................................736
Thin Clients......................................................................................................................................................................... 738
The Underlying Technology.........................................................................................................................................738
Examples of Client/Server Architecture...................................................................................................................... 739
Configuring the Data Server....................................................................................................................................... 743
Configuring a web server to host your project pages.................................................................................................744
Install the Thin Client software................................................................................................................................... 747
Configure and run Secure Viewer...............................................................................................................................749
Implementing Security for Web-based Applications................................................................................................... 752
List of network ports used by this software................................................................................................................757
View or disconnect client sessions............................................................................................................................. 759
Mobile Access.....................................................................................................................................................................761
Supported features in Mobile Access......................................................................................................................... 761
Developing for Mobile Access.....................................................................................................................................770
Mobile Access Installation........................................................................................................................................... 772
Configuring the Mobile Access web interface.............................................................................................................781
Navigating the Mobile Access web interface.............................................................................................................. 794
Troubleshooting project screens in Mobile Access.....................................................................................................804
View or disconnect client sessions............................................................................................................................. 810
DATABASE INTERFACE.................................................................................. 813
SQL Relational Databases................................................................................................................................................. 814
Studio Database Gateway..................................................................................................................................................816
Manually install Studio Database Gateway................................................................................................................ 824
Manually running Studio Database Gateway..............................................................................................................825
Secure Channel Communication.................................................................................................................................827
Database Configuration...................................................................................................................................................... 853
Configuring a Default Database for All Task History......................................................................................................... 857
Support for AVEVA Insight and Historian...........................................................................................................................858
Connect to AVEVA Insight using AVEVA Insight Publisher........................................................................................ 858
Connect to AVEVA Insight using CSV/JSON (HMI Runtime)..................................................................................... 862
Connect to an AVEVA Historian database located on-premises................................................................................ 864
Database Troubleshooting..................................................................................................................................................868
Appendices..........................................................................................................................................................................871
Using ODBC Databases..............................................................................................................................................871
Using Microsoft SQL Server....................................................................................................................................... 872
Using Oracle Databases............................................................................................................................................. 875
Using Microsoft Access or Microsoft Excel.................................................................................................................875
Using Sybase...............................................................................................................................................................877
Using MySQL...............................................................................................................................................................878
Contents
Page 9
TROUBLESHOOTING.......................................................................................879
General Troubleshooting.....................................................................................................................................................880
Frequently Asked Questions.............................................................................................................................................. 882
Proxy Settings.....................................................................................................................................................................887
Configure the proxy settings on a Windows computer or device............................................................................... 887
Configure the proxy settings on a Linux computer or device.....................................................................................888
Help tab...............................................................................................................................................................................889
Help..............................................................................................................................................................................889
Communication Drivers............................................................................................................................................... 889
License Agreement......................................................................................................................................................889
Product Web Site........................................................................................................................................................ 890
Release Notes............................................................................................................................................................. 890
Support.........................................................................................................................................................................890
About............................................................................................................................................................................890
TUTORIAL: BUILDING A SIMPLE PROJECT.................................................891
Creating a new project....................................................................................................................................................... 892
Specifying the startup screen.............................................................................................................................................894
Creating tags.......................................................................................................................................................................895
Creating the main screen................................................................................................................................................... 897
Drawing the main screen's title...................................................................................................................................898
Drawing a button to open another screen.................................................................................................................. 900
Saving and closing the main screen...........................................................................................................................902
Creating the summary screen............................................................................................................................................ 903
Drawing the summary screen title.............................................................................................................................. 903
Drawing "Date" and "Time" displays........................................................................................................................... 903
Placing an "Exit" icon.................................................................................................................................................. 905
Testing the project....................................................................................................................................................... 906
Placing an animated tank............................................................................................................................................906
Placing a level slider................................................................................................................................................... 909
Drawing a tank selector.............................................................................................................................................. 911
Testing the project....................................................................................................................................................... 912
Configuring the communication driver................................................................................................................................913
Monitoring device I/O during run time........................................................................................................................ 915
APPENDIX: SECURITY GUIDELINES............................................................. 917
Securing the Host............................................................................................................................................................... 918
General Guidelines for Securing the Host..................................................................................................................918
Windows Updates........................................................................................................................................................918
ICS Software Updates.................................................................................................................................................919
Scanning the Host....................................................................................................................................................... 919
Protecting the Applications and Content on the Host.................................................................................................919
Securing the ICS Network..................................................................................................................................................920
Managing Network Services and Ports.......................................................................................................................920
Securing Communication between the Client and Server..........................................................................................920
Cloud-based Systems.........................................................................................................................................................922
Web server security............................................................................................................................................................923
Securing Systems through Authentication and Authorization............................................................................................ 924
Managing Users and Groups Through Windows........................................................................................................924
Managing Users and Groups Through ICS Software.................................................................................................925
Contingency Planning......................................................................................................................................................... 926
Auditing and Logging...................................................................................................................................................926
Business Continuity Planning......................................................................................................................................926
Disaster Recovery Planning........................................................................................................................................ 926
Conclusion...........................................................................................................................................................................928
Contents
Page 10
APPENDIX: BUILT-IN LANGUAGE..................................................................929
Logic and arithmetic operators...........................................................................................................................................930
String expressions.............................................................................................................................................................. 932
Function descriptions explained......................................................................................................................................... 935
List of available functions................................................................................................................................................... 937
ActiveX and .NET Control functions...................................................................................................................................948
XGet............................................................................................................................................................................. 948
XRun............................................................................................................................................................................ 948
XSet............................................................................................................................................................................. 949
Arithmetic functions.............................................................................................................................................................951
Abs............................................................................................................................................................................... 951
Div................................................................................................................................................................................ 951
Format..........................................................................................................................................................................952
GetBit........................................................................................................................................................................... 955
Mod.............................................................................................................................................................................. 956
Pow.............................................................................................................................................................................. 956
ResetBit........................................................................................................................................................................957
Round...........................................................................................................................................................................957
SetBit............................................................................................................................................................................958
Sqrt...............................................................................................................................................................................958
Swap16........................................................................................................................................................................ 959
Swap32........................................................................................................................................................................ 959
Trunc............................................................................................................................................................................ 960
Database/ERP functions.....................................................................................................................................................961
DBCursorClose............................................................................................................................................................ 961
DBCursorColumnCount............................................................................................................................................... 962
DBCursorColumnInfo................................................................................................................................................... 964
DBCursorCurrentRow.................................................................................................................................................. 965
DBCursorGetValue.......................................................................................................................................................967
DBCursorMoveTo.........................................................................................................................................................968
DBCursorNext.............................................................................................................................................................. 969
DBCursorOpen.............................................................................................................................................................971
DBCursorOpenSQL..................................................................................................................................................... 973
DBCursorPrevious....................................................................................................................................................... 976
DBCursorRowCount.....................................................................................................................................................977
DBDelete......................................................................................................................................................................979
DBExecute................................................................................................................................................................... 981
DBInsert....................................................................................................................................................................... 983
DBSelect...................................................................................................................................................................... 985
DBUpdate.....................................................................................................................................................................987
SyncAlarm....................................................................................................................................................................989
SyncAlarmStatus..........................................................................................................................................................990
SyncEvent.................................................................................................................................................................... 990
SyncEventStatus..........................................................................................................................................................991
SyncTrend.................................................................................................................................................................... 992
SyncTrendStatus..........................................................................................................................................................992
Date & Time functions........................................................................................................................................................994
ClockGetDate...............................................................................................................................................................994
ClockGetDayOfWeek................................................................................................................................................... 995
ClockGetTime...............................................................................................................................................................996
DateTime2Clock...........................................................................................................................................................997
DateTime2UTC............................................................................................................................................................ 998
GetClock...................................................................................................................................................................... 999
GetTimeZone............................................................................................................................................................. 1000
GetTimeZoneCount....................................................................................................................................................1001
GetUTC...................................................................................................................................................................... 1002
Hour2Clock................................................................................................................................................................ 1002
SetSystemDate.......................................................................................................................................................... 1002
SetSystemTime.......................................................................................................................................................... 1003
SetTimeZone..............................................................................................................................................................1003
UTC2DateTime.......................................................................................................................................................... 1005
Contents
Page 11
Email functions..................................................................................................................................................................1007
CnfEmail.....................................................................................................................................................................1007
GetStatusSendEmailExt.............................................................................................................................................1008
SendEmail..................................................................................................................................................................1009
SendEmailExt.............................................................................................................................................................1010
Event Logger functions.....................................................................................................................................................1012
SendEvent..................................................................................................................................................................1012
File functions.....................................................................................................................................................................1014
DeleteOlderFiles........................................................................................................................................................ 1014
DirCreate....................................................................................................................................................................1015
DirDelete.................................................................................................................................................................... 1016
DirLength....................................................................................................................................................................1017
DirRename................................................................................................................................................................. 1018
FileCopy..................................................................................................................................................................... 1019
FileDelete................................................................................................................................................................... 1020
FileLength.................................................................................................................................................................. 1021
FileReadFields........................................................................................................................................................... 1022
FileReadMessage...................................................................................................................................................... 1023
FileRename................................................................................................................................................................1024
FileWrite..................................................................................................................................................................... 1025
FileWriteFields............................................................................................................................................................1027
FileWriteMessage...................................................................................................................................................... 1028
FindFile...................................................................................................................................................................... 1029
FindPath.....................................................................................................................................................................1031
GetFileAttributes........................................................................................................................................................ 1032
GetFileTime................................................................................................................................................................1033
GetHSTInfo................................................................................................................................................................ 1034
GetLine.......................................................................................................................................................................1035
HST2TXT................................................................................................................................................................... 1037
HST2TXTIsRunning................................................................................................................................................... 1040
ImportXML..................................................................................................................................................................1040
LookupContains......................................................................................................................................................... 1042
LookupGet..................................................................................................................................................................1042
LookupLoad............................................................................................................................................................... 1043
OpcUaBrowseToJson.................................................................................................................................................1044
OpcXMLDABrowseToJson.........................................................................................................................................1045
OpcXMLDaListServers...............................................................................................................................................1046
PDFCreate................................................................................................................................................................. 1047
Print............................................................................................................................................................................1048
RDFileN......................................................................................................................................................................1049
WebGetFile................................................................................................................................................................ 1050
FTP functions....................................................................................................................................................................1052
CnfFTP.......................................................................................................................................................................1052
FTPGet.......................................................................................................................................................................1053
FTPPut....................................................................................................................................................................... 1054
FTPStatus.................................................................................................................................................................. 1055
Graphic functions.............................................................................................................................................................. 1057
AutoFormat................................................................................................................................................................ 1057
GetScrInfo.................................................................................................................................................................. 1057
GetURLParams..........................................................................................................................................................1058
PrintSetup.................................................................................................................................................................. 1059
PrintWindow............................................................................................................................................................... 1059
ResetDecimalPointsTable.......................................................................................................................................... 1061
RGBColor...................................................................................................................................................................1061
RGBComponent.........................................................................................................................................................1062
SaveScreenShot........................................................................................................................................................ 1063
SetDecimalPoints.......................................................................................................................................................1064
SetDisplayUnit............................................................................................................................................................1065
SetTagDisplayUnit......................................................................................................................................................1066
Contents
Page 12
Internet of Things (IoT) functions..................................................................................................................................... 1067
AzureIoTHubClearQueue...........................................................................................................................................1067
AzureIoTHubClose.....................................................................................................................................................1068
AzureIoTHubGetMsgId.............................................................................................................................................. 1069
AzureIoTHubGetQueueSize...................................................................................................................................... 1070
AzureIoTHubGetStatus.............................................................................................................................................. 1071
AzureIoTHubOpen..................................................................................................................................................... 1072
AzureIoTHubSendMsg...............................................................................................................................................1074
Log Message functions.....................................................................................................................................................1076
Trace.......................................................................................................................................................................... 1076
Logarithmic functions........................................................................................................................................................ 1077
Exp............................................................................................................................................................................. 1077
Log............................................................................................................................................................................. 1077
Log10......................................................................................................................................................................... 1077
Logical functions............................................................................................................................................................... 1079
False.......................................................................................................................................................................... 1079
If................................................................................................................................................................................. 1079
Toggle.........................................................................................................................................................................1080
True............................................................................................................................................................................ 1081
Loop functions...................................................................................................................................................................1082
For…Next...................................................................................................................................................................1082
Module Activity functions.................................................................................................................................................. 1083
AppActivate................................................................................................................................................................ 1083
AppIsRunning.............................................................................................................................................................1084
AppPostMessage....................................................................................................................................................... 1085
AppSendKeys............................................................................................................................................................ 1086
CleanReadQueue...................................................................................................................................................... 1086
CloseSplashWindow.................................................................................................................................................. 1087
DisableMath............................................................................................................................................................... 1087
EnableMath................................................................................................................................................................ 1087
EndTask..................................................................................................................................................................... 1088
Exec........................................................................................................................................................................... 1089
ExecIsRunning........................................................................................................................................................... 1090
ExitWindows...............................................................................................................................................................1091
IsScreenOpen............................................................................................................................................................ 1092
IsTaskRunning............................................................................................................................................................1092
IsViewerInFocus.........................................................................................................................................................1093
KeyPad.......................................................................................................................................................................1094
LogOff.........................................................................................................................................................................1096
LogOn........................................................................................................................................................................ 1096
Math........................................................................................................................................................................... 1097
PostKey......................................................................................................................................................................1097
Recipe........................................................................................................................................................................ 1099
Report........................................................................................................................................................................ 1100
RunGlobalProcedureAsync........................................................................................................................................1101
RunGlobalProcedureAsyncGetCurrent...................................................................................................................... 1103
RunGlobalProcedureAsyncGetStatus........................................................................................................................1103
RunGlobalProcedureOnFalse.................................................................................................................................... 1105
RunGlobalProcedureOnServer.................................................................................................................................. 1106
RunGlobalProcedureOnTrigger................................................................................................................................. 1107
RunGlobalProcedureOnTrue......................................................................................................................................1108
RunVBScript...............................................................................................................................................................1110
SecureViewerReload................................................................................................................................................. 1110
SendKeyObject.......................................................................................................................................................... 1111
SetAppPath................................................................................................................................................................ 1113
SetViewerInFocus...................................................................................................................................................... 1114
SetViewerPos.............................................................................................................................................................1114
ShutDown...................................................................................................................................................................1115
StartTask.................................................................................................................................................................... 1116
TaskUpdateConfig......................................................................................................................................................1117
ViewerPostMessage.................................................................................................................................................. 1118
Multimedia functions......................................................................................................................................................... 1119
Play............................................................................................................................................................................ 1119
Contents
Page 13
Screen functions............................................................................................................................................................... 1120
Close.......................................................................................................................................................................... 1120
Open.......................................................................................................................................................................... 1121
OpenPrevious............................................................................................................................................................ 1124
ShowInplaceInput.......................................................................................................................................................1125
ShowMessageBox..................................................................................................................................................... 1127
Security functions..............................................................................................................................................................1129
BlockUser...................................................................................................................................................................1129
CheckESign............................................................................................................................................................... 1130
CheckSecurityLevel................................................................................................................................................... 1131
CreateUser.................................................................................................................................................................1132
ExportSecuritySystem................................................................................................................................................1134
GetLastESignUser..................................................................................................................................................... 1135
GetSecuritySystemStatus.......................................................................................................................................... 1135
GetUserFullName...................................................................................................................................................... 1137
GetUserNames.......................................................................................................................................................... 1137
GetUserPwdAging......................................................................................................................................................1139
GetUserState............................................................................................................................................................. 1139
ImportSecuritySystem................................................................................................................................................ 1140
RemoveUser.............................................................................................................................................................. 1141
SetPassword.............................................................................................................................................................. 1143
SetUserGroup............................................................................................................................................................ 1145
UnblockUser...............................................................................................................................................................1147
Statistical functions........................................................................................................................................................... 1149
Avg............................................................................................................................................................................. 1149
Max............................................................................................................................................................................ 1149
Min............................................................................................................................................................................. 1150
Rand...........................................................................................................................................................................1151
String functions................................................................................................................................................................. 1152
Asc2Str.......................................................................................................................................................................1152
CharToValue...............................................................................................................................................................1152
CharToValueW........................................................................................................................................................... 1153
ClassMembersToStrVector.........................................................................................................................................1154
DecryptData............................................................................................................................................................... 1155
EncryptData............................................................................................................................................................... 1156
NCopy........................................................................................................................................................................ 1157
Num............................................................................................................................................................................1157
Str...............................................................................................................................................................................1158
Str2Asc.......................................................................................................................................................................1159
StrCompare................................................................................................................................................................1159
StrCompareNoCase...................................................................................................................................................1160
StrFromInt.................................................................................................................................................................. 1160
StrFromReal...............................................................................................................................................................1161
StrFromTime.............................................................................................................................................................. 1162
StrGetElement............................................................................................................................................................1163
StrLeft.........................................................................................................................................................................1163
StrLen.........................................................................................................................................................................1164
StrLower.....................................................................................................................................................................1164
StrRChr...................................................................................................................................................................... 1165
StrRight...................................................................................................................................................................... 1165
StrSetElement............................................................................................................................................................ 1166
StrStr.......................................................................................................................................................................... 1167
StrStrPos....................................................................................................................................................................1167
StrTrim........................................................................................................................................................................1168
StrTrimAll....................................................................................................................................................................1169
StrUpper.....................................................................................................................................................................1169
ValueToChar...............................................................................................................................................................1170
ValueWToChar........................................................................................................................................................... 1170
Contents
Page 14
System Info functions....................................................................................................................................................... 1173
DBVersion.................................................................................................................................................................. 1173
GetAppHorizontalResolution......................................................................................................................................1173
GetAppPath................................................................................................................................................................1173
GetAppVerticalResolution.......................................................................................................................................... 1174
GetComputerIP.......................................................................................................................................................... 1174
GetComputerName.................................................................................................................................................... 1175
GetCursorX................................................................................................................................................................ 1175
GetCursorY................................................................................................................................................................ 1175
GetDisplayHorizontalResolution................................................................................................................................ 1176
GetDisplayVerticalResolution.....................................................................................................................................1176
GetHardKeyModel......................................................................................................................................................1176
GetHardKeySN.......................................................................................................................................................... 1177
GetIPAll...................................................................................................................................................................... 1177
GetNetMACID............................................................................................................................................................ 1178
GetOS........................................................................................................................................................................ 1179
GetPerformanceMetric............................................................................................................................................... 1179
GetPrivateProfileString...............................................................................................................................................1182
GetProductPath..........................................................................................................................................................1182
GetRegValue.............................................................................................................................................................. 1183
GetRegValueType...................................................................................................................................................... 1184
GetServerHostName..................................................................................................................................................1184
GetTickCount............................................................................................................................................................. 1185
InfoAppAlrDir..............................................................................................................................................................1185
InfoAppHstDir.............................................................................................................................................................1185
InfoDiskFree...............................................................................................................................................................1186
InfoResources............................................................................................................................................................ 1186
IsActiveXReg..............................................................................................................................................................1187
IsAppChangedOnServer............................................................................................................................................ 1188
NoInputTime...............................................................................................................................................................1189
ProductVersion........................................................................................................................................................... 1189
ReloadAppFromServer.............................................................................................................................................. 1189
SaveAlarmFile............................................................................................................................................................1190
SetAppAlarmPath.......................................................................................................................................................1191
SetAppHstPath...........................................................................................................................................................1191
SetDateFormat...........................................................................................................................................................1192
SetKeyboardLanguage.............................................................................................................................................. 1193
SetRegValue.............................................................................................................................................................. 1194
SNMPGet................................................................................................................................................................... 1195
SNMPSet................................................................................................................................................................... 1196
WritePrivateProfileString............................................................................................................................................ 1197
Contents
Page 15
Tags Database functions.................................................................................................................................................. 1199
ExecuteAlarmAck.......................................................................................................................................................1199
ForceTagChange........................................................................................................................................................1200
GetAlarmCount.......................................................................................................................................................... 1200
GetAlarmInfo.............................................................................................................................................................. 1201
GetTagValue...............................................................................................................................................................1202
SetTagValue............................................................................................................................................................... 1204
TagsDBAddClass....................................................................................................................................................... 1204
TagsDBAddClassMember.......................................................................................................................................... 1205
TagsDBAddTag.......................................................................................................................................................... 1206
TagsDBBeginEdit....................................................................................................................................................... 1207
TagsDBEndEdit.......................................................................................................................................................... 1208
TagsDBGetAlarm....................................................................................................................................................... 1208
TagsDBGetClassMember...........................................................................................................................................1210
TagsDBGetClassMemberCount................................................................................................................................. 1211
TagsDBGetFirstClass.................................................................................................................................................1211
TagsDBGetFirstClassMember....................................................................................................................................1212
TagsDBGetFirstTag.................................................................................................................................................... 1213
TagsDBGetLoadStatus...............................................................................................................................................1214
TagsDBGetNextClass................................................................................................................................................ 1215
TagsDBGetNextClassMember................................................................................................................................... 1216
TagsDBGetNextTag....................................................................................................................................................1216
TagsDBGetPreloadCount...........................................................................................................................................1217
TagsDBGetTagCount................................................................................................................................................. 1218
TagsDBGetTagProperty............................................................................................................................................. 1219
TagsDBGetTrend........................................................................................................................................................1220
TagsDBPreload.......................................................................................................................................................... 1221
TagsDBPreloadWait................................................................................................................................................... 1222
TagsDBRemoveAlarm................................................................................................................................................1224
TagsDBRemoveClass................................................................................................................................................ 1225
TagsDBRemoveClassMember................................................................................................................................... 1225
TagsDBRemoveTag................................................................................................................................................... 1226
TagsDBRemoveTrend................................................................................................................................................ 1227
TagsDBSetAlarm........................................................................................................................................................1228
TagsDBSetTagProperty..............................................................................................................................................1230
TagsDBSetTrend........................................................................................................................................................ 1231
TagsDBSync...............................................................................................................................................................1232
Translation functions......................................................................................................................................................... 1234
Ext.............................................................................................................................................................................. 1234
SetLanguage..............................................................................................................................................................1234
TranslationLoad..........................................................................................................................................................1235
TranslationLookupClose.............................................................................................................................................1236
TranslationLookupGet................................................................................................................................................ 1237
TranslationLookupLoad..............................................................................................................................................1238
Trigonometric functions.....................................................................................................................................................1240
ACos.......................................................................................................................................................................... 1240
ASin............................................................................................................................................................................1240
ATan........................................................................................................................................................................... 1241
Cos.............................................................................................................................................................................1241
Cot..............................................................................................................................................................................1241
Pi................................................................................................................................................................................ 1242
Sin.............................................................................................................................................................................. 1242
Tan............................................................................................................................................................................. 1243
OVERVIEW OF VBSCRIPT............................................................................ 1244
VBScript Interfaces in the Software................................................................................................................................. 1245
Global Procedures..................................................................................................................................................... 1246
Graphics Module........................................................................................................................................................1249
Background Tasks..................................................................................................................................................... 1257
Contents
Page 16
Language Reference........................................................................................................................................................ 1260
Operators................................................................................................................................................................... 1260
Constants................................................................................................................................................................... 1261
Objects and Collections.............................................................................................................................................1263
Properties...................................................................................................................................................................1264
Statements................................................................................................................................................................. 1264
Methods..................................................................................................................................................................... 1265
Functions....................................................................................................................................................................1266
Keywords................................................................................................................................................................... 1266
Errors......................................................................................................................................................................... 1267
Tips & Tricks..................................................................................................................................................................... 1270
VBScript Editor IntelliSense...................................................................................................................................... 1270
VBScript Compared to VBA...................................................................................................................................... 1271
Screen Events........................................................................................................................................................... 1273
MsgBox and InputBox Functions.............................................................................................................................. 1273
VBScript Procedures................................................................................................................................................. 1273
Creating Constants.................................................................................................................................................... 1275
Declaring Variables....................................................................................................................................................1275
Scope and Lifetime of Variables............................................................................................................................... 1275
How Boolean tags are handled in VBScript............................................................................................................. 1276
Writing Real Values to Integer Tags......................................................................................................................... 1276
Precedence of VBScript Operators........................................................................................................................... 1277
Logical Operator NOT............................................................................................................................................... 1277
Using Conditional Statements................................................................................................................................... 1278
Looping Through Code..............................................................................................................................................1280
Support for ActiveX Controls.....................................................................................................................................1282
Debugging VBScript..........................................................................................................................................................1283
About the Debug tab................................................................................................................................................. 1283
Set break points in your VBScript code....................................................................................................................1284
Run your project in Debug mode..............................................................................................................................1285
Observe the current state in the Watch window.......................................................................................................1287
Step through your VBScript code............................................................................................................................. 1289
Safety Information
Important Information
Read these instructions carefully, and look at the equipment to become familiar
with the device before trying to install, operate, service, or maintain it. The
following special messages may appear throughout this documentation or on the
equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained only
by qualified personnel. No responsibility is assumed by Schneider Electric for any
consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction
and operation of electrical equipment and its installation, and has received safety
training to recognize and avoid the hazards involved.
The addition of this symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.
This is the safety alert symbol. It is used to alert you to potential personal injury
hazards. Obey all safety messages that follow this symbol to avoid possible injury or
death.
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
!DANGER
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
WARNING
!
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
CAUTION
!
NOTICE is used to address practices not related to physical injury.
NOTICE
About This Manual
Document Scope
This manual describes how to use this product.
Validity Note
This documentation is valid for this product.
The technical characteristics of the device(s) described in the present manual also
appear online at www.pro-face.com.
The characteristics that are described in the present document should be the
same as those characteristics that appear online. In line with our policy of constant
improvement, we may revise content over time to improve clarity and accuracy. If
you see a difference between the document and online information, use the online
information as your reference.
Registered Trademarks
Microsoft®and Windows®are registered trademarks of Microsoft Corporation in
the United States and/or other countries.
QR Code is a registered trademark of DENSO WAVE INCORPORATED in Japan
and other countries.
Product names used in this manual may be the registered trademarks owned by
the respective proprietors.
Related Documents
You can download the manuals related to this product, such as the software
manual, from our website.
https://www.pro-face.com/trans/en/manual/1085.html
Product Related Information
If the equipment is used in a manner not specified by the manufacturer, the
protection provided by the equipment may be impaired.
WARNING
UNINTENDED EQUIPMENT OPERATION
•
Touch panel switches should not be used to make a switch that could
result in human injury or equipment damage. Trouble with the display
unit, units, and cables which keep the output ON or OFF could result in
a serious accident. An output signal that could result in a serious
accident must be equipped with a monitoring circuit such as a limiter.
Please design the system so that important operation switches are
handled by equipment other than the display unit. This will prevent
potential accidents as a result of incorrect output or malfunctions.
•
Touch panel switches should not be used for a device's Emergency
Stop Switch. The Ministry of Health, Labor and Welfare requires all
industrial machinery/systems must be equipped with a mechanical,
manually operate emergency stop switch. Also, for other kinds of
systems, similar mechanical switches must be provided to ensure safe
operation of those systems.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
WARNING
LOSS OF DATA
Save the project periodically.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
NOTICE
LOSS OF DATA
•
Do not turn off your personal computer's power switch during the
execution of a program. The project files could be damaged as a result.
•
Do not change the contents of this product's project files using Text
Editor software. The project files could be damaged as a result.
•
Do not turn off the display unit power or perform reset while using
features that change a project file on the display unit.
The project files could be damaged as a result.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
/