![Exaquantum Explorer Users Manual Vol 1 [PDF]](https://pdfs.asia/img/200x200/exaquantum-explorer-users-manual-vol-1.jpg)
4 0 2 MB
Instruction Manual
Exaquantum/Explorer User’s Manual Volume 1 – General Information IM 36J04A12-01E
IM 36J04A12-01E © Yokogawa February 21st 2014 13th Edition Issue 1
Exaquantum/Explorer User’s Manual – Volume 1
i
Copyright and Trademark Notices © 2013 Yokogawa Electric Corporation All Rights Reserved All rights are reserved in this document, which is the property of Yokogawa Electric Corporation. Information contained herein is the property of Yokogawa Electric Corporation. Unless agreed in writing by Yokogawa Electric Corporation, the licensee shall not remove, release, disclose, reveal, copy, extract all or part of the documentation. Trademark Acknowledgements Exaquantum, Exaopc and CENTUM are trademarks of Yokogawa. Microsoft, Windows, Windows Vista, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows 7 Professional, Windows 8 Pro, Microsoft Word, Microsoft Excel, Microsoft Office 2010, Microsoft Office 2013, Visual Basic, Visual C++, SQL Server, MDAC, Microsoft .NET and ActiveX are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Exaquantum uses Microsoft SQL Server as part of an Integrated Value Added Solution. Adobe and Acrobat are registered trademarks of Adobe Systems Incorporated, and registered within particular jurisdictions. Ethernet is a registered trademark of XEROX Corporation. Basic Scripting Engine provided by Cypress Software Inc., Copyright 1993 – 2000, all rights reserved. All other company and product names mentioned in this manual are trademarks or registered trademarks of their respective companies. We do not use TM or ® to indicate trademarks or registered trademarks in this manual. .
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
ii
Contents
Highlights The Highlights section gives details of the changes made since the previous issue of this document. Summary of Changes This is 13th Edition of this document. Detail of Changes The changes are as follows. Chapter/Section/Page
Change
P7-3
Added Windows 2012
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 Exaquantum Document Set The documents available for Exaquantum are: Exaquantum General Specification (GS 36J04A10-01E)
Exaquantum Technical Information (TI 36J04A10-01E)
Exaquantum/PIMS User's Manual (IM 36J04A11-01E)
Exaquantum/Explorer User's Manual Volume 1 General Information (IM 36J04A12-01E) Exaquantum/Explorer User's Manual Volume 2 Custom Controls (IM 36J04A12-02E) Exaquantum/Explorer User's Manual Volume 3 Microsoft Excel Reports (IM 36J04A12-03E) Exaquantum/Explorer User's Manual Volume 4 Advanced Configuration (IM 36J04A12-04E)
Exaquantum Installation Guide (IM 36J04A13-01E)
Exaquantum API Reference Manual (IM 36J04A14-01E)
Exaquantum Engineering Guide Volume 1 Administration (IM 36J04A15-01E)
Exaquantum Engineering Guide Volume 2 Network Configuration (IM 36J04A15-02E)
Exaquantum Engineering Guide Volume 3 Support Tools (IM 36J04A15-03E)
Exaquantum Engineering Guide Volume 4 Web Authoring (IM 36J04A15-04E) Exaquantum Engineering Guide Volume 5 PI Connection (IM 36J04A15-05E)
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
iii
iv
Contents Table of Contents Copyright and Trademark Notices .....................................................................................i Highlights ......................................................................................................................... ii Exaquantum Document Set ............................................................................................. iii Table of Contents .............................................................................................................iv
Chapter 1
Exaquantum/Explorer Introduction...................................................................... 1-1
1.1
Exaquantum Overview ....................................................................................................... 1-1
1.2
Exaquantum System Components ...................................................................................... 1-2
1.3
About this Manual .............................................................................................................. 1-4
1.4
Using Exaquantum/Explorer .............................................................................................. 1-7
1.5
Exaquantum/Explorer Desktop .......................................................................................... 1-9
1.6
Exaquantum/Explorer – Run Mode.................................................................................. 1-11
1.7
Exaquantum/Explorer Command Line Parameters .......................................................... 1-13
1.8
Mimics.............................................................................................................................. 1-14
Chapter 2
Desktop Menus and Icons Overview ..................................................................... 2-1
2.1
General ............................................................................................................................... 2-1
2.2
Design Mode Menus and Icons .......................................................................................... 2-1
2.3
Run Mode Menus and Icons............................................................................................. 2-26
2.4
Common Buttons.............................................................................................................. 2-30
Chapter 3
Palette ....................................................................................................................... 3-1
3.1
General ............................................................................................................................... 3-1
3.2
View or Hide the Palette .................................................................................................... 3-2
3.3
Add Controls to the Palette ................................................................................................ 3-2
3.4
Remove a Control from the Palette .................................................................................... 3-3
3.5
Change the Control Properties ........................................................................................... 3-4
Chapter 4
Application Launcher ............................................................................................. 4-1
4.1
General ............................................................................................................................... 4-1
4.2
View or Hide the Application Launcher ............................................................................ 4-2
4.3
Add an Item to the Application Launcher .......................................................................... 4-2
4.4
Add a Group to the Application Launcher ......................................................................... 4-3
4.5
Rename a Group in the Application Launcher ................................................................... 4-3
4.6
Remove an Item from the Application Launcher ............................................................... 4-3
4.7
Rename an Item in the Application Launcher .................................................................... 4-4
4.8
Remove a Group from the Application Launcher .............................................................. 4-4
4.9
Change the Application Pointed at by an Icon ................................................................... 4-4
4.10 Launch an Application ....................................................................................................... 4-4 IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 Chapter 5
v
Data Selector ............................................................................................................ 5-1
5.1
General ............................................................................................................................... 5-1
5.2
View or Hide the Data Selector ......................................................................................... 5-4
5.3
Expanding a Node .............................................................................................................. 5-4
5.4
Collapsing a Node .............................................................................................................. 5-4
5.5
Search Facility.................................................................................................................... 5-5
5.6
Applying a Filter ................................................................................................................ 5-6
5.7
Removing a Filter............................................................................................................... 5-7
5.8
Time Selector ..................................................................................................................... 5-8
5.9
Displaying a Description .................................................................................................... 5-9
5.10 Displaying Tag Quality .................................................................................................... 5-10 5.11 Tag Panel.......................................................................................................................... 5-11 5.12 Drag and Drop Variable Creation .................................................................................... 5-16
Chapter 6
Workbook Viewer ................................................................................................... 6-1
6.1
General ............................................................................................................................... 6-1
6.2
View or Hide the Workbook Viewer ................................................................................. 6-2
6.3
Display the Workbook Contents ........................................................................................ 6-2
6.4
Open a Document from the Workbook Viewer ................................................................. 6-2
6.5
Hide the Workbook Contents ............................................................................................. 6-2
6.6
Refresh the Workbook Directory ....................................................................................... 6-3
6.7
Show File Extension .......................................................................................................... 6-3
Chapter 7
Working with Documents ....................................................................................... 7-1
7.1
General ............................................................................................................................... 7-1
7.2
Create a New Document .................................................................................................... 7-1
7.3
Create a New Template ...................................................................................................... 7-2
7.4
Save a Document................................................................................................................ 7-2
7.5
Add a Control to a Document ............................................................................................ 7-3
7.6
Change the Properties of a Control .................................................................................... 7-4
7.7
Selecting Controls .............................................................................................................. 7-6
7.8
Change the Layout or Position of Controls ........................................................................ 7-6
7.9
Remove a Control from a Document ............................................................................... 7-14
7.10 Cut or Copy a Control from a Document ......................................................................... 7-15 7.11 Paste a Control to a Document ......................................................................................... 7-15 7.12 Navigate between Documents .......................................................................................... 7-15 7.13 Grid Settings..................................................................................................................... 7-15 7.14 Options ............................................................................................................................. 7-16
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
vi
Contents 7.15 Set Global Report Times .................................................................................................. 7-19 7.16 Set Report Times .............................................................................................................. 7-19 7.17 Set Data Range and Update Rate ..................................................................................... 7-20 7.18 Running an Ad-hoc Document ......................................................................................... 7-23
Chapter 8
Workbook................................................................................................................. 8-1
8.1
General ............................................................................................................................... 8-1
8.2
New Workbook Window ................................................................................................... 8-2
8.3
Configure Workbook.......................................................................................................... 8-3
8.4
Secure Workbooks ............................................................................................................. 8-7
Chapter 9
Property Sheet ......................................................................................................... 9-1
9.1
General ............................................................................................................................... 9-1
9.2
View the Properties ............................................................................................................ 9-3
9.3
Change Properties .............................................................................................................. 9-5
9.4
Provide Event Handlers...................................................................................................... 9-8
Chapter 10
Property Binder ..................................................................................................... 10-1
10.1 General ............................................................................................................................. 10-1 10.2 Constant (Unbound) Properties ........................................................................................ 10-2 10.3 Data Binding Method ....................................................................................................... 10-2 10.4 Script Binding Method ..................................................................................................... 10-9 10.5 Display the Property Binder ........................................................................................... 10-10 10.6 Thresholds ...................................................................................................................... 10-10 10.7 Format Field Specifications ........................................................................................... 10-13
Chapter 11
Exaquantum/Explorer Connectivity.................................................................... 11-1
11.1 Connectivity Issues .......................................................................................................... 11-1 11.2 Detection Of Network Loss.............................................................................................. 11-1 11.3 Single Server System ....................................................................................................... 11-2 11.4 Multi Server System ......................................................................................................... 11-5
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 1 1.1
1-1
Exaquantum/Explorer Introduction
Exaquantum Overview Exaquantum (Figure 1-1) is a Plant Information Management System (PIMS) combined with a powerful user interface. Figure 1-1 Exaquantum Functional Overview
The primary functions of Exaquantum/PIMS are to gather, store and aggregate process and other business data. This information can then be accessed throughout the enterprise’s desktop using Exaquantum/Explorer and other tools such as Microsoft Excel. The data flow can be summarized as follows: Raw process data is gathered from the PCS, via OPC servers, into a proprietary Real-Time Database. Here, the raw data can be combined in real-time calculations to produce derived, higher value information. Both derived and raw values are historized so that their data can be accessed over long time periods by the Business Historian. In addition to normal historisation, the Exaquantum/PIMS Business Historian calculates ‘aggregation values’. This is a process of data reduction (e.g. mean value calculation, minimum/maximum tracking, standard deviation, summation) over user-defined periods. The aggregations are themselves stored on disc to allow them to be retrieved over long time periods. Real-time, historized and aggregation information are made available to users’ desktops via Exaquantum/Explorer; this software is able to present the data in a wide variety of formats. Exaquantum/PIMS is event-driven. When new data arrives, any calculations that use the new data values are triggered and the business historian is informed by an event. Any user applications (such as Exaquantum/Explorer displays) which have a registered interest in the data are informed of the change. IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-2
1.2
Chapter 1 Exaquantum/Explorer Introduction
Exaquantum System Components The Exaquantum system (Figure 1-2) components are: Exaquantum/Explorer Exaquantum/PIMS Open Interfaces for third party applications to access Exaquantum data. Exaquantum has a client-server architecture, with Exaquantum/PIMS acting as the server and Exaquantum/Explorer forming the user interface. Figure 1-2 Exaquantum System Components Third Party Clients Exaquantum
Client
Client OLE DB and Open Interfaces
Exaquantum/Explorer
Viewing, Analysis and Reporting
Exaquantum/PIMS
Exaquantum/Web
Web Services and Components
Server Server
Role Based View Configuration Tools
Real-time Database
Server Historian
PCS Interface
OPC Server TIC1-3
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
1-3
Exaquantum/Explorer Exaquantum/Explorer is a powerful, flexible user interface environment through which business information may be presented in graphical displays and reports. It is run on user PCs. Summary of Features Reporting/Analysis – easily configured reporting using Exaquantum/PIMS-resident data Trending – live or historical data for display in a combined graphical and tabular format Design mode and Run mode – reports can be built in a WYSIWYG way in design mode, then run immediately to see live values. Alarms and Events – scrollable view of all OPC alarm and events that have occurred over time as well as updating with new events. Data Selector – a hierarchical structure that represents Exaquantum data. ‘Drag and drop’ can be used between the Data Selector and the Property Sheet to set the properties of an object. Application Launcher – enables Exaquantum/Explorer to be used as a desktop by placing shortcuts on it (e.g. start Microsoft Excel with a pre-defined document for monitoring the plant key variables during a start-up). Excel Add-In – allows access to live and historical Exaquantum data through an Excel spreadsheet and combines Exaquantum data with other business data in an easy but powerful way. Scripting – a scripting facility is provided for advanced control of properties, for handling events etc. The Visual Basic (VB) script-editing environment and script wizard allows access to Exaquantum/Explorer objects, functions and data. Web Browser Support – Exaquantum/Explorer documents may be viewed on a company Intranet through Microsoft’s Internet Explorer and Web pages may be embedded within Exaquantum/Explorer documents. Exaquantum/PIMS The three main features of Exaquantum/PIMS are outlined below. Real-time Database The Real-time Database is a high performance real-time store for plant data that also provides flexible, user-defined calculations, and aggregations (mean, max, min etc.) over pre-defined time periods, e.g. Shifts, Months. Business Historian Exaquantum’s optimized, long-term Business Historian provides efficient storage and fast retrieval of vast amounts of plant data, over long time periods. Management and Configuration Tools A suite of easy-to-use tools is provided to install, build, deploy and manage the Exaquantum PIMS.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-4
Chapter 1 Exaquantum/Explorer Introduction
Exaquantum/Web Exaquantum/Web enables users to deploy thin clients over the Internet/Intranet. The scope of supply is similar to that provided by Exaquantum/Explorer. Exaquantum/Web components can handle multiple Exaquantum servers transparently. Open Interfaces Automation interfaces to the Exaquantum data are provided in the Exaquantum system. These enable the user to write applications alongside Exaquantum data and build interfaces to other systems using standard tools such as Microsoft Excel Visual Basic for Applications (VBA) or Visual Basic.
1.3
About this Manual This manual describes the configuration, administration and usage of Exaquantum/Explorer. The manual is split into these volumes: General Information Custom Controls Excel Reports Advanced Configuration. The chapters contained in these volumes are described below.
Volume 1 – General Information Chapter 1: Exaquantum/Explorer Introduction – provides an overview of the Exaquantum system. Chapter 2: Desktop Menus and Icons Overview – describes the menus available from the desktop. Chapter 3: Palette – describes the main features and explains how to customize the Palette. The Palette is the source of all the controls that can be added to documents to form views, reports and schematic diagrams or mimics etc. Intrinsic and ActiveX controls can be added to the Palette if required. Chapter 4: Application Launcher – describes the main features and how to use the Application Launcher. It can be used to quickly open a frequently used application, such as Microsoft Word, Excel, or Exaquantum/Explorer workbooks and documents. It can be divided into groups to help organize applications. Chapter 5: Data Selector – describes the main features and explains how to use the Data Selector. The Data Selector shows the hierarchical structure that represents the available Exaquantum process data. Chapter 6: Workbook Viewer – describes the main features and explains how to use the Workbook Viewer. The Workbook Viewer shows a hierarchical tree view of the contents of a workbook, if one is open, and any libraries. Chapter 7: Working with Documents – describes the main features and explains how to create and format Exaquantum/Explorer documents.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
1-5
Chapter 8: Workbook – describes the main features and explains how to use the Workbook. The Workbook stores the initial configuration of a user interface. Use workbooks to specify the active document, and to control the startup and configuration options of the documents in Run mode. Chapter 9: Property Sheet – describes the main features and explains how to use the Property Sheet. The Property Sheet allows you to view and/or change the properties of a control. It is only available in Design mode. Chapter 10: Property Binder – describes the main features and explains how to use the Property Binding function. The Property Binder can be used to change the values of some of the properties of controls. Chapter 11: Exaquantum/Explorer Connectivity - describes how Exaquantum/Explorer responds when the connection to the Exaquantum server is lost. Volume 2 – Custom Controls Chapter 1: Introduction – lists the chapters contained in the four volumes. Chapter 2: Trends – describes the main features and explains how to use and configure the Trending control. The Trending control is an ActiveX control that allows real-time (live) or historical data to be displayed in graphical and/or tabular form. Chapter 3: Trend Comparison Control – describes the main features and explains how to use and configure the TrendComparison. The TrendComparison is an ActiveX control that allows real-time (live) or historical data to be displayed in graphical and/or tabular form. Chapter 4: Alarms and Events – describes the main features of the Event Summary and Event Update controls. This chapter also explains how to configure the controls. Chapter 5: Data Entry Grid – describes the main features and explains how to configure the Data Entry Grid control. The Data Entry Grid allows manually entered data for the plant or process to be shown in a tabular form. The Data Entry Grid also allows you to correct, update and enter data values. Chapter 6: X-Y Plot – describes the main features and explains how to use and configure the X-Y Plot control. The X-Y Plot is an ActiveX control that allows the values of tags to be plotted against a single reference tag. Chapter 7: Tabular Trend - describes the main features and explains how to use and configure the Tabular Trend control. The Tabular Trend is an ActiveX control that allows a tome series display of tags in tabular form. Chapter 8: Controls - describes the controls available on the default Palette and additional controls supplied with Exaquantum/Explorer. The supported properties and events for each control are also listed. Chapter 9: Trend Analyze Window – describes the main features and explains how to use and configure the Trend Analyze. The Trend Analyze screen is a screen created with Explorer, which allows Trend display or Alarm and Event display linking with Trend display only by defining tag information. In Run mode, it is possible to display the trend or alarm & events of a tag only by setting the tag definition information without creating a new document in Explorer.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-6
Chapter 1 Exaquantum/Explorer Introduction Chapter 10: Trend Template – describes the main features and explains how to use and configure the Trend Template. With the goal of improving engineering efficiency, Trend Templates are supplied beforehand in various formats as preparation in order to adapt to various situations. Because these templates have been supplied in Exaquantum/Explorer format, the explorer trend screen can be easily displayed using the explorer function.
Volume 3 – Excel Reports Chapter 1: Introduction – lists the chapters contained in the four volumes. Chapter 2: Excel Add-In – describes the main features and explains how to use and configure the Excel Add-In and the report templates. Chapter 3: Exaquantum Excel Report Templates - describes the main features and explains how to use and configure the Exaquantum Excel report templates. Volume 4 – Advanced Configuration Chapter 1: Introduction – lists the chapters contained in the four volumes. Chapter 2: Scripting – describes the scripting environment and explains how to use the Scripting Facility. The scripting facility allows you advanced control of properties and event handling. Chapter 3: Data Parameterization – describes the main features and explains how to use the Data Parameterization function. Data parameterization allows you to define the sources of data variables so they can change dynamically in Run mode. Chapter 4: Navigation - describes how to load documents into windows using the Exaquantum/Explorer navigation functionality. Chapter 5: Data Write Back - describes the main features and explains how to use the Data Write Back function. Chapter 6: OLE DB/ODBC Client Access - details the type of access to Exaquantum data that is available to OLE DB/ODBC clients. The types of data that can be read and the applications that can be used are described.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
1.4
1-7
Using Exaquantum/Explorer Exaquantum/Explorer is a desktop environment that provides an easy-to-use user-interface and a comprehensive set of configuration tools to build the Run mode displays. Exaquantum/Explorer desktop has been designed using the standard Microsoft Multiple Document Interface (MDI) and ActiveX technology. This gives it a Microsoft look and feel so that users who are familiar with Microsoft products will feel comfortable with most of its interactions and the terminology used in this document.
Exaquantum/Explorer User Interface Overview What users see on their computer screen is organized in Exaquantum/Explorer by what are called ‘documents’. Documents in turn can be organized into workbooks. An Exaquantum/Explorer document can contain: Controls The controls allow user interaction, e.g. buttons to click on as well as displaying plant information in the form of live bar-graph indicators, updating text-boxes, trends, etc. These controls are either ‘intrinsic’ (i.e. they are part of the Exaquantum/Explorer kernel) or they can be ActiveX controls that are supplied with the Exaquantum/Explorer package or even bought-in third-party controls. Navigation Navigation buttons to other documents and links to embedded OLE-compliant documents and applications. Script Script files provide the document with specific behavior (such as to turn on normally hidden detail information in the document). Scripts are small user-written program segments that are executed under certain pre-defined conditions, in order to carry out specific actions. For example, a script may be written and associated with a button click event, to call up a trend display or to invite a user to enter a new value in a text box.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-8
Chapter 1 Exaquantum/Explorer Introduction References References to Exaquantum tags, this is the mechanism whereby dynamic controls are ‘bound’ to specific tags in order to display their values. This is commonly referred to as data binding. This versatility of content allows a wide range of user interface screens to be produced covering: Sophisticated trends – both real time and historical trend data Dynamic graphics – live updates of actual process conditions Plant schematics (mimics) – schematic representations that provide context to help users assimilate the presented information Lists, spreadsheets, charts and tables – summary information for quick decision support Reports, including any or all of the above – on-screen or printed reports that can contain all the above elements Web browser displayable pages, including any or all of the above – the ability to view any Exaquantum/Explorer document in a standard web browser on the company intranet.
Exaquantum/Explorer Configuration Tools Exaquantum/Explorer provides a comprehensive and controlled environment for configuring the documents that make up the end users' interface to their process. It allows the creation of a wide range of applications ranging from ad-hoc reports through operating screens to full data management applications. To give the power and flexibility to deliver more advanced users’ requirements, Exaquantum/Explorer provides an extensive tool kit that includes: Trend Configuration The ability to customize trends to suit particular requirements that are not covered by their default behavior. For example, you can configure trend to show the plant conditions against the operational limits of the processes various operating modes. Script The ability to manipulate the controls on a document based on current conditions. In the previous example, the plant’s operational limits might be updated by the script – depending on the value of particular real-time data points. Property Sheet Each control has properties which alter its appearance or behavior. In Design mode, the Property Sheets are used to enter the desired property values, such that the control exhibits the appropriate characteristics in Run mode. Drawing Tools These allow the drawing of static schematic information that helps focus users’ attention using familiar representations (such as the plant schematic, tabular reports that map the current paper reports, etc.).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
1-9
Controls The dynamic data display controls (such as live text-boxes, bar graphs, etc.) and actioninducing controls (e.g. data-entry grids, command buttons, etc.) can be added and positioned on the document. This will typically be done in a way that aids the clear, safe interpretation of the information the document contains as well as to allow quick navigation to documents that contain related information (e.g. other plant areas). 21 CFR Part 11 For 21 CFR Part 11 purposes, both the user account name and the user name are permanently displayed in the bottom right corner of the desktop.
1.5
Exaquantum/Explorer Desktop The Exaquantum/Explorer desktop (Figure 1-3) comprises the following components: Work Area – used to create, configure, customize, and organize the documents and view information. Application Launcher – used to quickly open frequently used applications, such as Microsoft Word, Excel or Exaquantum/Explorer workbooks and documents Palette – contains all the controls available for building up documents (present in Design mode only) Workbook Viewer – shows the hierarchy of folders and files within the current workbook directory and in the shared directories (present in Design mode only) Data Selector – shows the hierarchical structure that represents the available Exaquantum process data values Property Sheet – allows the user to view and/or change the properties of a control or document Main Menu Bar - the Main Menu Bar and the Toolbar shortcut buttons give access to the functions and options in Exaquantum/Explorer.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-10
Chapter 1 Exaquantum/Explorer Introduction Figure 1-3 Exaquantum/Explorer Desktop Components (Design Mode) Main Menu Bar Toolbar
Application Launcher
Documents
Data Selector or Workbook Viewer
Work Area Property Sheet
Palette
In Design mode, you can: Draw mimic schematics Draw report-like tables and assign text boxes to report the desired key variables Position live data controls on a mimic in the correct locations and specify to these controls which Exaquantum/PIMS tags will be the source of its data, (this also known as 'data binding'; the display control is bound to its data source). This is done via the Property Binding and Variables windows. Write script that interprets when a button is clicked and performs the appropriate action (e.g. calling up a trend display, making a data-entry form appear, etc.) Create navigation ‘Hot-Spots’ on a mimic, with associated script to call up the relevant related mimic.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
1.6
1-11
Exaquantum/Explorer – Run Mode In Run mode Exaquantum/Explorer has all the features and functionality needed to monitor the plant and analyze data effectively. It has the same ‘easy-to-use’ features found in many contemporary software packages. Figure 1-4 Example of an Exaquantum/Explore Run Mode Display
Data Selector
Application Launcher
Document
Work Area
The Exaquantum/Explorer desktop, in Run mode (Figure 1-4) comprises the following components: Work Area – this where the documents are displayed and where the user interacts with them Application Launcher – used to quickly open frequently used applications, such as Microsoft Word, Excel or Exaquantum/Explorer workbooks and documents Data Selector – shows the hierarchical structure that represents the available Exaquantum process data values In Run mode when a mimic is called up, the following happens: Exaquantum/Explorer loads the document The mimic is drawn Any live data controls register themselves with the Exaquantum/PIMS server The Exaquantum/PIMS server responds by sending its current data, and if the mimic is a live updating one, the server sends Exaquantum/Explorer updated values whenever they change. You will see the latest process values being displayed on your screen. Exaquantum/Explorer monitors the input controls (e.g. command buttons) and, when they are pressed, executes the associated script. This then makes the pre-programmed actions occur.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-12
Chapter 1 Exaquantum/Explorer Introduction This versatility of content allows a wide range of user interface screens to be produced as shown by the examples in Figure 1-5 and Figure 1-6. Figure 1-5 Example of a Tabular Report Document in Run Mode
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
1.7
1-13
Exaquantum/Explorer Command Line Parameters Exaquantum/Explorer can be run from the command line with specific parameters that control the behavior and appearance of the application. The command line with parameters takes the form: [/R][/S][/X][/C:”Caption”][/P:][/G:=…]
The purpose of each parameter is shown in the following table:
Table 1-1 Exaquantum/Explorer Command Line Parameters Parameter
Purpose
/R
Run mode only. This is always set if you are not in QExplorerDesignGroup. The Secure Workbook function is not applicable if a user is a member of QExplorerDesign group therefore you must specify a document or workbook to open.
/S
Start up in run mode but allow switching back to design mode. You can only switch back to design mode if the user is a member of “QExplorerDesignGroup”.
/X
Do not display the splash screen.
/C
Change the Explorer Title caption to the specified string.
/P
Print the document on the default printer after the specified number of seconds.
/G
Set the global variables with the specified values. The valid variables are ReportStart, ReportEnd and SpotTime. Spaces should be replaced with underscores (_).
Document or workbook file.
The name of the Explorer document or workbook. If the name contains spaces then the complete name should be enclosed in double quotes (“).
Example of use: To run a workbook in run mode only with a new caption: QExplore /R /C:”My Explorer” MyWorkbook.pxw
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
1-14
1.8
Chapter 1 Exaquantum/Explorer Introduction
Mimics Exaquantum/Explorer provides mimics almost identical to that found on contemporary process control systems e.g. HMI and SCADA systems. A mimic consists of a static schematic representation of the production process. An example of a mimic is shown in Figure 1-6. The mimic is superimposed with data in the form of bar-graphs, updating textual values, etc. which reflect the current state of the process. Various button controls can be added allowing easy navigation and accessing of other functions such as tag details, trend pages, etc. Figure 1-6 Example of a Mimic Document in Run Mode
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 2
2-1
Desktop Menus and Icons Overview
This chapter describes the main features of the main menu bar and toolbars. It also describes the sub-menus and windows.
2.1
General Exaquantum/Explorer can be operated in Design mode or Run mode. The associated menus and toolbars differ depending on the mode. The menus and toolbars for each mode are described in this chapter.
2.2
Design Mode Menus and Icons In Design mode, new controls such as buttons, text boxes and graphs can be added, sized and positioned within a document. Existing controls can be resized, moved, deleted or copied to another document. The main menu bar (Figure 2-1) has a number of menus available, each of which has further sub-menus and windows. Note:
The Workbook menu is only displayed on the main menu bar when a workbook is open. Figure 2-1 Typical Main Menu Bar and Toolbars (Design Mode)
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-2
Chapter 2 Desktop Menus and Icons Overview The toolbars contain shortcuts to commands. The toolbars can be organized the way you want so you can find and use the commands quickly. Figure 2-2 Standard Toolbar (Design Mode)
Figure 2-3 Layout Toolbar (Design Mode)
Figure 2-4 View Toolbar (Design Mode)
Figure 2-5 Play Toolbar (Design Mode)
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-3
File Menu – Design-mode The File pull-down menu has these options: Figure 2-6 File pull-down menu (Design Mode)
New Workbook Creates a new blank workbook. This creates a folder that contains all the files to be associated with the workbook such as documents, images, etc. New Document Creates a new blank document. Open Opens or finds an existing document or workbook. Note:
‘Open workbook’ will close any currently open workbook as only one workbook can be open at any one time.
Save Workbook Saves any changes to the currently opened workbook. Save Document Saves the document on which you are working. If the document has not been saved before, this process has the same effect as the Save Document As option. Save Document As Saves the current document and allows you to specify a different name and location. You can also use this option to save a document in another file format. For example, you can save a document as a template (.pxt). Save Document As HTML Creates an HTML file that wraps the document in a format that allows it to be displayed by a web browser. The document path is included with the HTML file: if the location changes then the HTML file will need to be re-created. Gives a prompt to save the document with a different file name if the document is not already saved. IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-4
Chapter 2 Desktop Menus and Icons Overview Close Closes the active document. If a document contains any unsaved changes, you will be prompted to save or abandon the document before closing. Close All Closes all open documents, and the workbook if it is open. This is the only way to close a workbook and keep Exaquantum/Explorer open. If a document or workbook contains any unsaved changes, you will be prompted to save or abandon before closing. Templates Opens a new document, based on an existing template. Print Displays the print dialog as shown in Figure 2-7. Specify the options for the Color/Greyscale, Range and Page Setup. Figure 2-7 Print Dialog
Printer The dropdown list displays a list of the currently configured printers available to the computer. Clicking on the Properties button will display a print setup dialog allowing the user to set the printer properties e.g. layout, paper etc.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-5
Range Select one of the following options to print. Current Document All Open Documents Colour/Greyscale Select one of the following options: Color Greyscale. The option will become available to select Reverse (X), Reverse Video printing. Page Setup The page setup section specifies the paper size, print orientation and print scaling. Paper Size: Displays a dropdown list of optional paper sizes for the printer. Orientation Select either Portrait or Landscape. Scaling: The following options are available from the dropdown list: “25%”, “50%”, “100%”, “200%”, “400%”, and “Fitting to paper”. Manual entry is allowed. Options…: Clicking the Options button will display the detailed page setup dialog. OK button The selected document(s) will be printed as defined by the Print setup. Cancel button No documents will be printed and the Print setup will be cancelled. Note:
If a document is not maximized during printing, a document may not be printed properly. When starting printing, display the document in the foreground or maximize it.
Exit Closes Exaquantum/Explorer and gives a prompt to save any unsaved documents or workbooks.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-6
Chapter 2 Desktop Menus and Icons Overview
Edit Menu – Design mode The Edit pull-down menu has these options: Figure 2-8 Edit pull-down menu (Design Mode)
Undo This allows you to sequentially undo previously performed editing operations. Redo This allows you to sequentially redo previously undone editing operations. Note:
The Undo/Redo stack is cleared when the document is closed or Exaquantum/Explorer is set to Run mode.
Clear Undo Stack Clears the entire undo and redo information. Cut Deletes the selected text or control, keeps the cut information on the clipboard (‘clipboard’ is a Windows term meaning the store for cut or copied data, so that the data may be pasted to another location – see Paste). Copy Copies the selected text or control into the clipboard. Paste Inserts previously copied or cut information from the clipboard to the current cursor location. Note:
The paste function is not available when pasting graphics into a document for the first time. Right click in the document and select the Paste option from the menu to insert copied or cut information from the clipboard.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 Clear Deletes highlighted text or control. Select All Selects all the text and controls in the document. Select None Removes the selection from the text and controls. View Menu – Design mode The View pull-down menu allows you to show or hide the main parts of the Exaquantum/Explorer desktop. The View pull-down menu has these options: Figure 2-9 View pull-down menu (Design Mode)
Workbook Viewer Shows or hides the Workbook Viewer. Data Selector Shows or hides the Data Selector. Palette Shows or hides the Palette. Application Launcher Shows or hides the Application Launcher. Zoom In Provides a close-up view of an area within the document. Zoom Out Shows more of the document at a reduced size. Reset Zoom Returns to the normal view (1:1).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-7
2-8
Chapter 2 Desktop Menus and Icons Overview Toolbars Select Toolbars and the toolbar pop-up menu appears. Figure 2-10 Toolbar pop-up menu
Click on an option to view or hide the applicable toolbar. The toolbars available are: Standard (Table 2-1) View (Table 2-2) Layout (Table 2-3) Play (Table 2-4). The icons in each toolbar are described in the following tables. Full Screen If selected, when the document is run it will appear in full screen mode. Table 2-1 Standard Toolbar Icon
Name
Function
New
Creates a new blank document.
Open
Opens or finds a workbook or document.
Save
Saves any changes made.
Print
Displays the print window. Sends the current or all open documents to the selected printer.
Cut
Deletes the selected text or control, keeps the cut information on the clipboard.
Copy
Makes a copy of the selected text or control onto the clipboard.
Paste
Inserts previously copied or cut information from the clipboard to the currently selected location. Note: The paste function is not available when pasting graphics into a document for the first time. Right click in the document and select the Paste option from the menu to insert copied or cut information from the clipboard.
Undo
This allows you to sequentially undo previously performed editing operations.
Redo
This allows you to sequentially redo previously undone editing operations.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-9
Table 2-2 View Toolbar Icon
Name
Function
Workbook Viewer
Shows/hides the Workbook Viewer.
Data Selector
Shows/hides the Data Selector.
Palette
Shows/hides the Palette.
Application Launcher
Shows/hides the Application Launcher.
Zoom In
Provides a close-up view of an area within a document. The Zoom In feature can increase the image size by up to 800%.
Zoom Out
Shows more of the document at a reduced size. The Zoom Out feature can reduce the image size to 10%.
Reset Zoom
Returns to normal view (1:1).
Zoom to %
Zoom in to a particular percentage.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-10
Chapter 2 Desktop Menus and Icons Overview Table 2-3 Layout Toolbar Icon
Name
Function
Bring to Front
Brings the selected control to the front of the display order (z-order).
Send to Back
Sends the selected control to the back of the display order (z-order).
Align
Aligns a control to a specified parameter.
Make Same Size
Makes all the selected controls the same size.
Centre in Form
Controls can be centered horizontally or vertically.
Group
Combines the selected controls into a group.
Ungroup
Divides a group into individual controls.
Regroup
Combines controls into the original group.
Free Rotate
Allows a control to be rotated to any angle on the document.
Rotate by 90º
Allows a control to be rotate by 90º clockwise.
Reset Rotate
Removes all rotations applied to a control, returns it to its original state of rotation.
Edit Polyline
Allows a polyline to be modified.
Table 2-4 Play Toolbar Icon
Name
Function
Play
Changes the display from Design mode to Run mode.
Stop
Changes the display from Run mode to Design mode.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-11
Workbook Menu – Design mode Note:
The Workbook menu is only displayed on the main menu bar when a workbook is open.
The Workbook menu allows you to copy Exaquantum/Explorer documents, graphics, and other files to the folder of the currently open workbook. This menu also allows you to set the workbook properties. Figure 2-11 Workbook pull-down menu (Design Mode)
The Workbook pull-down menu has these options: Import Explorer Document Includes an Exaquantum/Explorer document in the current workbook. You can import stand-alone documents, or documents that are already in another workbook. Import Picture Includes a graphic file for use in the current workbook, by copying the selected image to the workbook picture directory. Once imported the image files can be used in documents. (Use the web-browser control to display GIF and JPEG files). You can import bitmap, icon, GIF and JPEG formats. Import Other Includes a specified file in the current workbook. For example, you can use this command to import a spreadsheet that displays Exaquantum data. Workbook Properties Displays the Configure Workbook window. Use this window to specify the Run mode settings for the workbook and its documents. For example, you can use this command to specify which document is opened first, the document position, size and state. For more information about how to create and use Workbooks, see Chapter 8.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-12
Chapter 2 Desktop Menus and Icons Overview
Document Menu – Design mode The Document pull-down menu has these options: Figure 2-12 Document pull-down menu (Design Mode)
Grid Settings Use the Grid Settings window (Figure 2-13) to control the display and positioning of design aids in the active document. Figure 2-13 Grid Settings Window
The Grid Settings window has these components: Show Grid Displays a grid in the active document. To hide the grid, deselect the box. Snap to Grid Aligns controls to the nearest grid intersection when they are dropped or moved on the active document. Spacing The spacing group has these sub-divisions: Width - Sets the horizontal distance (in pixels) between grid lines. To change the horizontal grid spacing in the active document, enter a new value in this field. Height - Sets the vertical distance (in pixels) between grid lines. To change the vertical grid spacing in the active document, enter a new value in this field. Note:
The values for Width and Height must be even numbers. IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-13
Guidelines Helps you align objects or act as margins in the active document. For example, to place the top guideline 50 pixels from the top of a document, enter 50 in the top Guidelines field. Tab Order This function sets the order of the tab selection in a document. In Design mode all controls are shown and, when Tab is pressed, you can move from control to control. Note 1: Graphics controls (lines arcs, etc.) cannot get input focus. They will be shown in blue, without a tab order number in front of them. Note 2: You can exclude a control from the tab order in Run mode (i.e. the control will not become active when you use the Tab key to move between controls). Use the Property Sheet for the applicable control and set the Tabstop property to No. Note 3: Tabbing does not work in embedded controls. In Run mode: When Tab is pressed, the active frame moves from control to control in the order specified by the Tab Order window The initial active frame is the first control in the Tab Order list box. Figure 2-14 Tab Order window
Select a control from the list box. Once a control is highlighted, the Tab Order window (Figure 2-14) has these options available: Up Moves the highlighted control up the tab order. Down Moves the highlighted control down the tab order. Delete Deletes the highlighted control from the document.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-14
Chapter 2 Desktop Menus and Icons Overview ObjectCode Shows the name of the selected control. Layers Layers are groups of controls you can create within an Exaquantum/Explorer document. Layers are useful during the creation and maintenance of document. For example, in the case of a mimic, all pipe-work could be drawn on one layer, with process components and equipment on other layers. Layers enable you to select which parts of a complex document you want to work with. They also enable you to hide and lock parts that are not currently required. The Layers Sheet (Figure 2-15) shows all the layers specified for the document and the properties set for each layer. Figure 2-15 Layers Sheet
For more information about how to create and use Layers, see Chapter 7. Note:
If no layers have been created or selected, controls are added to the default layer.
The Layers Sheet is used to do the following: Add Creates a new layer in the active Exaquantum/Explorer document. Type the name of the new layer in the Name field. Delete Removes the selected layer from the layers list. Any controls in the deleted layer are added to the next highest entry in the Layers list. You cannot delete the default layer. Select Selects the layer. Selects all controls on the current layer.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-15
View Hides or displays the selected layer. When the check box is unchecked, the selected layer is not shown in the active Exaquantum/Explorer document. Lock Locks or unlocks the selected layer. When a layer is locked, you cannot edit the controls on that layer. Declarations Displays the VBS Mini-Editor window (Figure 2-16). This is a scripting facility which provides the advanced control of properties and for handling events. Figure 2-16 VBS Mini Editor Window
Use this window to define functions and subroutines, which may be used in more than one script. This creates a library of shared routines for this particular document. For more information about Scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E). Variables Displays the Variables window (Figure 2-17). Use this window to configure the sources of data variables so they can dynamically change in Run mode. Use the Variables window to change time individual control times. Figure 2-17 Variables window
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-16
Chapter 2 Desktop Menus and Icons Overview For more information about Data Parameterization, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E). Report Times Report times provide a mechanism for time navigation. It can be used to enable a document to show values for different points in time in Run mode. Three report times are provided: Report Start Time, Report End Time and Spot Time. Although their names suggest there is a relationship between the report times, this is not the case. Each report time is in effect a label associated with a point in time. For example, Report Start equals “NOW”, Report End “NOW+10 SECONDS”, etc. Note:
The Exaquantum server time is used for the value of NOW.
Report Times can be global to the Exaquantum/Explorer application or set for a specific document. If a document does not have local report times configured then it will take the global values. Report Times can be configured in Design or Run mode. Changes to the Report Times in Run mode are lost when switching back to Design mode. The report times can also be read and set through scripting. For more information about scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E). The Trend and the Alarm and Events Summary controls do not support report times. Figure 2-18 Set Report Times window
For more information about report times, see Chapter 7.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-17
Layout Menu – Design-mode The Layout pull-down menu has these options: Figure 2-19 Layout pull-down menu (Design Mode)
Most of these options have further options available. For more information about layout options, see Chapter 7. Align This function aligns the selected controls with each other. Figure 2-20 Align pop-up menu
The Align pop-up menu has these options: Lefts – align the selected controls to the left edge of the first selected control on the document. Rights – align the selected controls to the right edge of the first selected control on the document. Tops – align the selected controls to the top edge of the first selected control on the document. Bottoms – align the selected controls to the bottom edge of the first selected control on the document.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-18
Chapter 2 Desktop Menus and Icons Overview Make Same Size This function makes all of the selected controls the same size. Figure 2-21 Make Same Size pop-up menu
The Make Same Size pop-up menu has these options: Width Height Both. Space Horizontally This function equally spaces the selected controls horizontally, irrespective of any difference in size. It does not align the controls (use the Align function first if alignment is required before horizontal spacing). Space Vertically This function equally spaces the selected controls vertically, irrespective of any difference in size. It does not align the controls (use the Align function if alignment is required before vertical spacing).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-19
Centre in Form Controls can be arranged so they are in the center of the document. Figure 2-22 Centre In Form pop-up menu
The Centre In Form pop-up menu has these options: Centre Horizontally Centre Vertically. Rotation This is only applicable to the shape controls (line, polyline, border, arc and ellipse). This function allows a selected control to be rotated to any angle, or in set steps. Figure 2-23 Rotation pop-up menu
The Rotation pop-up menu has these options: Free Rotate Rotate by 90º Reset Rotate.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-20
Chapter 2 Desktop Menus and Icons Overview Order This function allows the stack order of controls in a document to be changed. You can overlap controls in a document to create different effects. Figure 2-24 Order pop-up menu
The Order pop-up menu has these options: Bring to Front – Places the selected control in front of overlapping controls. Send to Back – Places the selected control behind other overlapping controls.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-21
Grouping Controls can be selected and combined into a group, which can then be moved as if it was a single control. This is particularly useful when drawing a complex shape, such as a tank, on a document. Figure 2-25 Grouping pop-up menu
The Grouping pop-up menu has these options: Group – Assembles two or more controls into a single group. This allows controls to be move, cut and pasted in unison. Ungroup – Disassembles a group of controls into individual controls. Each control can be moved or changed. Regroup – Reassembles a group of controls that have been disassembled using the Ungroup option. Note 1: Grouped controls cannot be sized or rotated. Note 2: Grouping controls does not affect their tab order. Note 3: Controls can be grouped across layers. Edit Polyline This option is only available when a polyline control is selected. The Edit Polyline function allows you to modify a polyline. Note 1: Points can be added to the polyline by clicking on the line between two existing points. Note 2: Points can be removed by dragging a point to an adjacent one. Note 3: Dragging the first point to the last can close open polylines. Note 4: Double clicking on any point can open closed polylines.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-22
Chapter 2 Desktop Menus and Icons Overview
Play Menu – Design-mode The Play pull-down menu has these options: Figure 2-26 Play pull-down menu (Design Mode)
Start Click on Start or press the F5 key to change from Design mode to Run mode. Stop Click on Stop or press the Shift and F5 keys to change from Run mode to Design mode. Tools Menu – Design-mode The Tools pull-down menu has these options: Figure 2-27 Tools pull-down menu (Design Mode)
Global Report Times The Global Report Times option opens the Set Report Times window. For more information about Report Times, see Chapter 7. The difference in this case is that the settings made here will apply to ALL documents within a Workbook.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-23
Options Use this window to specify the default folder for saving and loading files, and to specify which folders are displayed in the current workbook. The Options window has two tabs General and Path. General Figure 2-28 Options window showing the General tab
Use the General tab to configure the default document appearance and behavior in Design mode, for ALL documents within a Workbook: Grid – Displays or hides the grid in all documents. Snap – Enables or disables the snap-to-grid function for all documents. When Snap is selected, controls in a document are moved so that they align with the nearest intersection of gridlines. Note 1: When a New document is created, the initial settings will be those specified in this Options window. Note 2: Grid and Snap can be specified for individual documents by selecting Grid Settings from the Document menu.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-24
Chapter 2 Desktop Menus and Icons Overview Paths Figure 2-29 Options window showing Paths tab
Use the Path tab to set the Exaquantum/Explorer search paths. Default path – The Default Path specifies the default storage location for Exaquantum/Explorer documents. It is also used as the default folder for opening Exaquantum/Explorer documents. Libraries – A library is a collection of folders, files or documents that you frequently use. Essentially, they are used to provide a pool of resources such as document templates, bitmaps, Excel templates and so on, which a number of designers can access to assist them with the design of their documents. This eases the design process and helps standardize the designs. Note:
A library is not linked to a specific workbook, folder or document.
Add Library button Click on this button to add, in the Libraries list, the details of folders, files or documents that you frequently use. Remove Library button Click on this button to remove a folder, file or document from the Libraries list.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-25
Window Menu – Design-mode Multiple windows can be displayed simultaneously, overlapping or side-by-side. The Window pull-down menu has these options: Figure 2-30 Window pull-down menu (Design Mode)
Tile Horizontally Shows all open/active documents and positions them horizontally (one above the other). Tile Vertically Shows all open/active documents and positions them vertically (side by side). Cascade Shows all open/active documents and positions them (offset) one on top of the other. Arrange Icons Arranges all minimized documents at the bottom of the work area. Document List The Windows menu also shows a list of the open documents. Help Menu – Design-mode The Help pull-down menu has these options: Figure 2-31 Help pull-down menu (Design Mode)
Contents and Index This provides access to all the Exaquantum/Explorer online Help information. Yokogawa Marex on the Web This takes you to the Yokogawa Marex web site (if an internet connection is available). About Exaquantum/Explorer This gives the user the details about Exaquantum/Explorer. These details are; the version number, copyright for the product and system information.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-26
2.3
Chapter 2 Desktop Menus and Icons Overview
Run Mode Menus and Icons The main menu bar and the toolbars (Figure 2-32) give access to the functions and options available in Exaquantum/Explorer when in Run mode. Figure 2-32 Main Menu and Toolbars (Run Mode)
The following menus are available in Run mode: File View Play Tools Window Help. File Menu – Run mode The File pull-down menu has these options: Figure 2-33 File pull-down menu (Run Mode)
Open Opens or finds an existing document. Close Closes the active document. Print Displays the print window. Prints the current or all open documents on the selected printer. Exit Closes Exaquantum/Explorer.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 View Menu – Run mode The View pull-down menu allows you to show or hide the main parts of the Exaquantum/Explorer desktop. The View pull-down menu has these options: Figure 2-34 View pull-down menu (Run Mode)
Data Selector Shows or hides the Data Selector. Application Launcher Shows or hides the Application Launcher. Toolbars Select Toolbars and this pop-up menu appears. The toolbars (which can be selected from the View menu) are: Standard (Table 2-5) View (Table 2-6) Play (Table 2-7). The icons in these toolbars are described in more detail in the following tables. Table 2-5 Standard Toolbar Icon
Name
Function
Open
Opens a document.
Print
Prints a document. Table 2-6 View Toolbar
Icon
Name
Function
Data Selector
Shows/hides the Data Selector.
Application Launcher
Shows/hides the Application Launcher.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-27
2-28
Chapter 2 Desktop Menus and Icons Overview Table 2-7 Play Toolbar Icon
Name
Function
Stop
Stops Run Mode.
Play
Changes the display from Design mode to Run mode.
Play Menu – Run mode The Play pull-down menu has this option: Figure 2-35 Play pull-down menu (Run Mode)
Stop Changes the display from Run mode to Design mode Tools Menu – Run mode The Tools pull-down menu has these options: Figure 2-36 Tools pull-down menu (Run Mode)
Global Report Times Use the Global Report Times option to specify report start, end or spot times for all documents. For more information about Report Times, see Chapter 7.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
2-29
Window Menu – Run-mode Multiple windows can be displayed simultaneously, overlapping or side-by-side. The Window pull-down menu has these options: Figure 2-37 Window pull-down menu (Run Mode)
Tile Horizontally Shows all open/active documents and positions them horizontally. Tile Vertically Shows all open/active documents and positions them vertically (side by side). Cascade Shows all open/active documents and positions them (offset) one on top of the other. Arrange Icons Arranges all minimized documents at the bottom of the work area. Document List The Windows menu also shows a list of the open documents. Help Menu – Run-mode The Help pull-down menu has these options: Figure 2-38 Help pull-down menu (Run Mode)
Contents and Index This provides access to all the Exaquantum/Explorer online Help information. Yokogawa Marex on the Web This takes you to the Yokogawa Marex web site (if an internet connection is available). About Exaquantum/Explorer This gives the user the details about Exaquantum/Explorer. These details are; the version number, copyright for the product and system information.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
2-30
2.4
Chapter 2 Desktop Menus and Icons Overview
Common Buttons There are some buttons that appear on several windows and/or pop-up menus throughout Exaquantum/Explorer. A description of these buttons is not given at every occurrence. The ‘common’ buttons are therefore described here. Table 2-8 Common buttons Button
Function
OK
Saves any change made, and close the window.
Apply
Saves any changes made, without closing the window, allowing further changes to be made.
Cancel
Cancels the window without saving any changes.
Help
Opens Help files associated with a window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 3
3-1
Palette
This chapter describes the main features and explains how to use the Palette.
3.1
General The Palette (Figure 3-1) displays all the controls that can be added to documents, and is thus the source for controls when creating documents. A control can be used to show static information of a process schematic diagram (e.g. lines, arcs and blocks) or it can be employed to display dynamic information about the process (e.g. live trend graphics, updating tag values etc.). Controls can be added to or removed from the Palette. Controls can also have their properties changed in a document or on the Palette. Note 1: You can only change the properties of Native Object controls. These are controls supplied as standard in Windows development tools such as Visual Basic, for example: buttons and text boxes (a list of Native Object controls can be found in Figure 3-4). Note 2: If you change the properties of a control on the Palette, the next time the control is added to a document, it will exhibit the modified properties. Previous versions of that control in documents will not be modified. Note 3: If you change the properties of a control on the Palette, they are only valid during the current session. The control will not retain the changes when you close Exaquantum/Explorer. Note 4: The Palette is only available in Design mode. Note 5: For more information about the controls available on the default Palette, see the Exaquantum/Explorer User's Manual Volume 2– Custom Controls (IM 36J04A1202E). Figure 3-1 Typical Palette
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
3-2
3.2
Chapter 3 Palette
View or Hide the Palette There are three ways to view or hide the Palette: On the main menu bar, click on View. The View pull-down menu appears. Click on Palette to view or hide the Palette. On the view toolbar, click on the Palette button
to view or hide the Palette.
On the keyboard, use the shortcut keys Ctrl + E to view or hide the Palette. Note:
3.3
You can resize the Palette by moving the mouse pointer onto its border and dragging the border until the Palette is the size you want.
Add Controls to the Palette 1 Right-click in the Palette background and the pop-up menu appears. Figure 3-2 Palette pop-up menu
2 Click on Add ActiveX Control or Add Native Object as required. The Insert ActiveX Control window (Figure 3-3) or Insert Native Object window (Figure 3-4) is displayed. Figure 3-3 Insert ActiveX Control Window
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
3-3
Figure 3-4 Insert Native Object Window
3 Select the control required from the window and click on OK or double-click on the required control. Note:
Multiple controls can be selected from this list by holding the control key down and clicking on the required controls.
4 The icon and control name appear on the Palette. Note:
Only one instance of each ActiveX control can be placed on the Palette. It will, however, accept multiple instances of native controls. Right clicking on the control and editing the Property Sheet can customize each instance. Once customized, the next time it is dropped on a document, it will exhibit these customized properties.
For more information about the controls available on the default Palette, see the Exaquantum/Explorer User's Manual Volume 2– Custom Controls (IM 36J04A12-02E).
3.4
Remove a Control from the Palette 1 Right-click on the control and the pop-up menu appears. Figure 3-5 Palette Control pop-up menu
2 On the pop-up menu, click on Delete. The control is removed from the Palette.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
3-4
3.5
Chapter 3 Palette
Change the Control Properties 1 Right-click on the control and the pop-up menu is displayed. Figure 3-6 Palette Control pop-up menu
2 On the pop-up menu, click on Properties. The Property Sheet window (Figure 3-7) is displayed. Figure 3-7 Property Sheet - Normal Tab
Note 1: For more information about ActiveX controls and how to change or set the properties, see Chapter 9 Property Sheet. For more information about how to add and arrange controls on a document, see Chapter 7. Note 2: It is possible to have two versions of a control on the Palette. When you have changed the properties of a control on the Palette, the associated icon does not change. Note 3: It is recommended that you retain the controls on the Palette as templates. Changes to controls are not retrospective. Documents that contain a previous version of the control will not automatically be updated.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 4
4-1
Application Launcher
This chapter describes the main features and explains how to use the Application Launcher.
4.1
General The Application Launcher (Figure 4-1) is used to contain shortcuts (placed there by users) to frequently used documents, objects, workbooks and Windows applications. The Application Launcher can be divided into groups to help organize the shortcuts. It can also provide an alternative method of navigating between documents. The Application Launcher allows you to start applications without the need to first minimize or reduce the size of the Exaquantum/Explorer interface, thereby providing an alternative desktop environment. Figure 4-1 Example Application Launcher
The Application Launcher consists of multiple groups that are identified by tabs. The example in Figure 4-1 shows three groups, called General, Reports and Business Applications. Each of these groups can contain any number of application shortcuts, with an icon representing each application. For example the Reports groups could contain Exaquantum/Explorer documents that summarize daily production totals and Excel workbooks which calculate monthly production efficiencies. The Application Launcher is available in Run mode and Design mode. All the procedures described in this chapter can be performed in either mode.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
4-2
4.2
Chapter 4 Application Launcher
View or Hide the Application Launcher There are a number of ways to view or hide the Application Launcher: On the main menu bar, click on the View option. The View pull-down menu is displayed. Click on Application Launcher to view or hide the Application Launcher. On the View toolbar, click on the Application Launcher button Application Launcher.
to view or hide the
On the keyboard, use the shortcut keys Ctrl + L to view or hide the Application Launcher. In the Workbook Configuration window, check the Disable Run Time Application Launcher check box to specify that the Application Launcher is hidden in Run mode. Note:
4.3
You can resize the Application Launcher by moving the mouse pointer onto its border and dragging the border.
Add an Item to the Application Launcher To add a document, workbook or object to the Application Launcher, drag the object from the Microsoft Explorer windows, and drop it on the Application Launcher. Alternatively, to search for the item: 1 Right-click in the Application Launcher and the pop-up menu (Figure 4-2) appears. Figure 4-2 Application Launcher Pop-up Menu
2 In the pop-up menu, select Add Item. The Open window is displayed. 3 In the Open window, navigate to the item you want to add. Select the item. 4 Click Open, or double-click on the item, to close the window and add the item to the Application Launcher. Note 1: Documents may also be dragged from the Workbook Viewer onto the Application Launcher. Note 2: When you create a link from Microsoft Windows Explorer, you create a file with a .lnk extension.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
4.4
4-3
Add a Group to the Application Launcher Groups are tabs within the Application Launcher that can be used to divide objects into related sections. For example, you could create a group for the documents of each workbook. 1 Right-click in the Application Launcher background and the pop-up menu shown in Figure 4-2 appears. 2 In the pop-up menu, select Add Group. A new tab is added to the Application Launcher. 3 Rename the group as required; by default the name given to the new group is New Group. Note:
4.5
If you create multiple New Groups, numbers after the group name identify them (e.g. New Group 1, New Group 2, etc.).
Rename a Group in the Application Launcher 1 Click on the group you want to rename then: Right-click in the Application Launcher background and the pop-up menu appears. - or Right-click on the desired group name and the pop-up menu appears. 2 In the pop-up menu, select Rename Group. This makes the group name into an editable field. 3 Enter a new group name, or modify the existing name, then press the return key. Note:
4.6
If a group is renamed to be the same name as an existing group, a number will be added to the end of the new group name.
Remove an Item from the Application Launcher 1 Right-click on the item you want to remove. The pop-up menu appears. Figure 4-3 Application Launcher Item pop-up menu
2 Click on Remove, and the Remove Confirmation window is displayed. 3 Click on Yes to remove the item.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
4-4
4.7
Chapter 4 Application Launcher
Rename an Item in the Application Launcher 1 Click on the item you want to rename, then: Right-click in the Application Launcher background and the pop-up menu appears. - or Right-click on the group name and the pop-up menu appears. 2 In the pop-up menu, select Rename Item. This makes the item name in to an editable field. 3 Enter a new item name, or modify the existing name, then press the return key.
4.8
Remove a Group from the Application Launcher 1 Click on the group you want to remove. 2 Right-click in the Application Launcher background and the pop-up menu is displayed. 3 Click on Remove Group, the Remove confirmation window is displayed. The Remove confirmation window will display the name of the group you are removing. Figure 4-4 Remove confirmation window
4 Click on Yes to remove the group. Note 1: When a group is removed, all of its contents will also be removed. Note 2: The Application Launcher must contain at least one group.
4.9
Change the Application Pointed at by an Icon 1 Right-click on the icon of the item you wish to change, the pop-up menu is displayed. 2 Select Shortcut, the Open window is displayed. 3 In the Open window, navigate to the required file or application. 4 Click on OK to close the window and change the associated shortcut.
4.10
Launch an Application 1 There are two ways to launch an application. In the Application Launcher: Click on the application icon - or Right-click on the application icon and select Launch from the pop-up menu.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 5
5-1
Data Selector
This chapter describes the main features and explains how to use the Data Selector.
5.1
General The Data Selector (Figure 5-1) shows the hierarchical structure that represents the available Exaquantum process data. The structure of this display will represent the Plant Model that has been configured for the user, and which the user is permitted to access. The Plant Model is a list of Exaquantum tags from the Exaquantum data servers and historical information from archive servers, configured in Exaquantum. The hierarchical structure can list for example, all the plants, the unit in these plants, the equipment in each unit and the tags that measure the equipment performance. What each user sees is defined in the Role Based Namespace for the user, or for the group to which he belongs. Use the Data Selector to search for and select specific data. You can attach data to the controls in a document by dragging the applicable attribute or tag from the Data Selector onto the control. This function binds the data to the control, in Run mode the data is displayed on the document. Figure 5-1 Data Selector Example
Note:
The Exaquantum/PIMS Administrator will have created folders, Function Blocks, tags and specific properties or values using the Configuration Tools. For more information, see the Exaquantum/PIMS User's Manual (IM 36J04A11-01E).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-2
Chapter 5 Data Selector
Data Selector Icons The Data Selector provides a hierarchical view of Exaquantum data in terms of folders, Function Blocks, tags and attributes. The following icons are used in the Data Selector. Folder Object (Green icon) Tag - expanded (Green icon) Tag - unexpanded (Cyan icon) Item (Magenta icon) Default item (expanded) (Magenta icon) Default item (unexpanded) (Blue icon) Function Block (expanded) (Blue icon) Function Block (unexpanded) (Yellow icon) Invalid shortcut (Yellow dot) Property or attribute (Magenta dot) Default attribute When tag quality is displayed the following icons are also used in the Data Selector: (Green icon red exclamation mark) Bad Quality Tag – expanded (Green icon red exclamation mark) Bad Quality Tag – unexpanded (Green icon yellow question mark) Uncertain Quality Tag – expanded (Green icon yellow question mark) Uncertain Quality Tag – unexpanded (Green icon orange pause symbol) Assumed Quality Tag – expanded (Green icon orange pause symbol) Assumed Quality Tag – unexpanded The Data Selector is available in Run mode and Design mode. All the procedures described in this chapter can be performed in either mode.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5-3
Data Selector Pop-up Menu The pop-up menu (Figure 5-2) is displayed when you right-click in the background of the Data Selector window. Figure 5-2 Data Selector Pop-up Menu
The pop-up menu has these functions: Instance Filter Displays the Filter window. A filter may be applied to a folder to limit the number of items displayed under it. Please refer to section 5.6 Applying a Filter for more information. Times Displays the Set Data Range/Update window. Use this window to specify the start time, end time and refresh rate you want for the values of displayed tags. Please refer to 5.8 Time Selector for more information. Search By Name Opens a search facility at the bottom of the Data Selector. Use this facility to locate Tags, Function Blocks and Folders by name without needing to expand nodes in the tree. Search By Description Opens a search facility at the bottom of the Data Selector. Use this facility to locate Tags and Function Blocks by description and Folders by name without needing to expand nodes in the tree. Display Description Selecting this menu item displays the tag descriptions in the Data Selector window. Deselecting the menu item will remove the tag descriptions. For further information please refer to 5.9 Displaying a Description. Display Quality Selecting this menu items displays the tag quality in the Data Selector window. Deselecting the menu item will remove the tag quality indication. For further information please refer to 5.10 Displaying Tag Quality
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-4
Chapter 5 Data Selector Tag Panel When an appropriate item is selected in the Data Selector window it is possible to select this menu item to open a tag details window. For further information please refer to 5.11 Tag Panel Refresh Node When you make changes to folders, tags or properties, the changes may not be immediately visible on the Data Selector. To see the changes you made, click Refresh Node.
5.2
View or Hide the Data Selector There are four ways to view or hide the Data Selector: On the main menu bar, click on View. The View pull-down menu appears. Click on Data Selector to view or hide the Data Selector. On the View toolbar, click on the Data Selector button
to view or hide the Data Selector.
On the keyboard, use the shortcut keys Ctrl + D to view or hide the Data Selector. In the Workbook Configuration window, check the Disable Run Time Data Selector check box to specify that the Application Launcher is hidden in Run mode. Note 1: In Design mode, by default, the Workbook Viewer is displayed on top of the Data Selector. Click on the Data Selector button just above this viewer to bring the Data Selector to the front. Note 2: You can resize the Data Selector by moving the mouse pointer onto its border and dragging the border until the Data Selector is the size you want.
5.3
Expanding a Node Expanding a node will show all attributes directly under each item. Any node can be expanded to show the data hierarchy. The nodes that can be expanded have a + symbol next to the title.
5.4
Collapsing a Node Collapsing a node will close all items directly under that node. The node can be collapsed so that not all of the attributes and items for that node are shown on the Data Selector.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5.5
5-5
Search Facility The search facility allows Tags, Function Blocks and Folders to be located without needing to expand nodes in the tree. There are two different Search types: Search By Name matches the search string against Tag, Function Block and Folder names. The results of the search will be displayed in the results list, showing the Name(s) and Location(s). Search By Description matches the search string against Tag and Function Block descriptions and Folder names. The results of the search will be displayed in the results list, showing the Name(s), Location(s) and Description(s). To use this facility: 1 Right click in the Data Selector and a pop-up menu is displayed. 2 Click on either Search By Name or Search By Description. 3 Enter the ‘string’ to be found. The Data Selector will only show the Tags, Function Blocks and Folders that contain the search string anywhere in their name or description. Folders don’t have descriptions so the search string will always be compared against the Folder name. You can use the * filter, to represent one or more wildcard characters in the string. You can use the ? filter, to represent any single character in the string. 4 Select the Folder to be searched. 5 Check the Search Sub Folders option to include lower level folders in the search. The results of the search will be displayed in the results list, showing the name(s) and location(s). A drag operation can be performed from the search results.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-6
5.6
Chapter 5 Data Selector
Applying a Filter A filter may be applied to a group to limit the number of items displayed under it. Only those matching the filter will be listed, and the filter used will be displayed on the group node. 1 Click on the node you want to filter. 2 Right-click in the Data Selector background, a pop-up menu is displayed. 3 Click on Instance Filter and the Filter window is displayed. Figure 5-3 Filter window
4 Enter the required filter string using * to match unspecified characters and click OK. The Data Selector will show only those tags that match the filter. Examples You can use the * filter, to represent one or more wildcard characters in the string. For example to display only the tags with names that include the string PID, enter *PID*. The Data Selector will display: 001PID001, 002PID001, 999PID999 etc. You can use the ? filter, to represent any single character in the string. For example, enter 001F?001. The Data Selector will display: 001FA001, 001FB001, 001FC001 etc.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5-7
The following example shows the result of choosing a filter using both the ? and the * wildcards. The filter chosen is: F*3?PID*01:
Note:
5.7
In this example the filter would first list all tags starting F03, but would equally list any that started F003 or F0003 if they existed. Next it would then list tags between F030 and F039, but note that it could also list any tags that started F03A or F03-. Finally, in this example only tags that have PID in the middle and end with 01 will be listed.
Removing a Filter To remove a filter and show all the available data, do the following procedure. 1 Click on the node you want to remove the filter from. 2 Right-click in the Data Selector background, a pop-up menu is displayed. 3 Click on Instance Filter and the Filter window is displayed. 4 Replace the filter with a ’*’ character – this will cause all tags to be matched and displayed by the filter.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-8
5.8
Chapter 5 Data Selector
Time Selector The time selector is used to specify the start time, end time and refresh rate you want for the tags’ values in Exaquantum/Explorer. Note:
If you want to use these times, you must set them before dragging and dropping data onto Exaquantum/Explorer control properties.
When you have specified the data that you want to display, you must specify the refresh rate you want to use for that data. You must also choose whether you want live or historical data to be displayed. The Set Data Range/Update window is used to do this. 1 Right-click in the Data Selector background, a pop-up menu is displayed. 2 In the pop-up menu, select Times. The Set Data Range/Update window (Figure 5-4) is displayed. Refer to the Working with Documents Chapter for more information on how to specify the refresh rate. Figure 5-4 Set Data Range/Update Window
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5.9
5-9
Displaying a Description If a tag has an associated description, then this will be displayed after the tag name with “ / ” as a separator. If there is no description associated with the tag, the “ / “ character string will not be displayed. The displaying of the tag descriptions can be set on or off by using the right-click menu and selecting [Display Description]. When checked the descriptions will be shown and when unchecked, will not be shown.
Use of Display Description •
Tag Example: Root.EQTAG001.PV
(No description displayed)
Root.EQTAG001.PV / Description of EQTAG001.PV (Description displayed) The following figure shows an example of the display of the tag description: Figure 5-5 Tag Description Display Example
The tag descriptions can be displayed using the following data selector windows: •
In the Data Selector in Exaquantum Explorer.
•
The Excel Add-In Data Selector
•
In the Item Selector
•
In the Data Selector in Graphic Editor
•
In the Plant View of the Web client
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-10
Chapter 5 Data Selector
5.10
Displaying Tag Quality The displaying of the tag quality can be set on or off by using the right-click menu and selecting [Display Quality]. When this option is checked the following icons are displayed to indicate the tag quality: •
tags with bad quality display an exclamation mark in a red circle,
•
tags with uncertain quality display a question mark in a yellow circle,
•
tags with assumed quality display a pause symbol in an orange circle.
If a tag is good quality the normal tag icon is displayed. An example of the tag quality display activated in the Data Selector window is shown in Figure 5-6 Tag Quality Display Example Figure 5-6 Tag Quality Display Example
The tag quality can be displayed using the following data selector windows: •
In the Data Selector in Exaquantum Explorer.
•
The Excel Add-In Data Selector
•
In the Item Selector
•
In the Data Selector in Graphic Editor
•
In the Plant View of the Web client
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5.11
5-11
Tag Panel When an appropriate item is selected in the tree view, a tag panel can be opened from the right-click menu. The Tag Panel has three pages which can be used to display information about the selected tag. •
The Trend page displays a graphical trend of the tag for the previous hour plus the configuration of the tag and any related target tags.
•
The Hourly and Minute History page shows the minute averages of the tag for the previous 30 minutes and the hourly averages for the previous 24 hours.
•
The Tag Settings page shows OPC settings for the tag if it is an OPC tag and provides the user with the ability to set a tag offline.
The tag panel can be displayed using the following data selector windows: •
In the Data Selector in Exaquantum Explorer.
•
The Excel Add-In Data Selector
•
In the Item Selector
•
In the Data Selector in Graphic Editor
•
In the Plant View of the Web client
Trend Page This page displays graphical trend data for the selected tag. By default the window displays data from the last hour, but the start and end times can be altered by using the time bar. More information about the tag can be found in the area below the graph. Figure 5-7 Tag Panel Trend Page
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-12
Chapter 5 Data Selector Graph The Graph on the trend page displays the data plotted against the Y (values) and X (time) axes. Data Point Quality Representation on the Graph The plotting of data points on the graph is governed by the following rules: Data Point Primary Quality GOOD UNCERTAIN
BAD
Action The data point is plotted normally. The data point is plotted normally if the secondary quality is not shutdown. If the secondary quality is shutdown, the data point is not plotted. This is displayed as a break in the Trend pen. The data point is not plotted. This is displayed as a break in the Trend pen.
Time Bar The time bar (Figure 5-8) is used to control the times and amount of data displayed. For example, by specifying a later start time, and an earlier end time, the resolution of data displayed on the Graph is increased. The fields on the left set the start time. The fields on the right set the end time. Figure 5-8 Time Bar Undo Button Click on this button to undo and not apply any changes made to the start or end times. Apply Button Click on this button to apply changes made to the start or end times. Synchronise to Current Time Button Click on this button to set the End Time to the current time. The Start Time will be set to be the new End Time minus the current overall time period.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5-13
Scroll Buttons All scroll buttons change both the Start Time and the End Time. The scroll buttons quickly change the start or end times by set amounts: The single arrow buttons The double arrow buttons
change the time period by half the overall time period. change the time period by the overall time period.
For example: Start time
12:00:00
End time
14:00:00
Therefore the graph extends over a period of two hours. 1 Click the left single arrow button 11:00:00). Note:
To keep the time period at 2 hours, the End Time will also move back by one hour.
2 Click the right single arrow button 14:00:00 in this example). Note:
to move the Start Time back by two hours (to
To keep the time period at 2 hours, the End Time will also move back by two hours.
4 Click the right double arrow button 14:00:00). Note:
to move the End Time forward by one hour (to
To keep the time period at 2 hours, the Start Time will also move forward by one hour.
3 Click the left double arrow button 10:00:00). Note:
to move the Start Time back by one hour (to
to move the End Time forward by two hours (to
To keep the time period at 2 hours, the Start Time will also move forward by two hours.
Cursor When you move the cursor along a pen on the graph, the cursor will change to a pointing finger when it is over a data point.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-14
Chapter 5 Data Selector Target Tags The target tags shown on the Tag Panel form are only applicable if the tag shown in Tag Panel is under a function block and the tags exist at the same level as the tag under the function block. The display of the Target Tags is also governed by the registry key. HKEY_LOCAL_MACHINE\SOFTWARE\Quantum\Client\TagPanelTargets
Setting the value of this registry key to 1 will display the Target Tags, a value of 0 will always hide the Target Tags. The following table shows which tags are used for the target tags. Target name
Tag Name
Hi-Hi
.HH
High
.H
Lo-Lo
.LL
Low
.L
Flow Comp
.CF
The value for a target tag will not be shown if the target tag doesn’t exist or if its value is >999999 or < -999999 Hourly Data and Minute History Page The Hourly Data and Minute History page shows mean hour aggregations for the previous 24 hours and raw tag values every minute for the previous 30 minutes, sampled every minute. Figure 5-9 Tag Panel Hourly Data and Minute History Page
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5-15
Tag Settings Page The Tag Settings page shows (for an OPC tag) the OPC settings and also allows the user to set a tag offline or online and update its value. If an aggregation tag is being viewed in Tag Panel then the OPC settings will be retrieved from the aggregation tags raw tag. For Manual or Calculation tags the tab doesn’t show any relevant data. Figure 5-10 Tag Panel Tag Settings Page
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-16
5.12
Chapter 5 Data Selector
Drag and Drop Variable Creation
Single Byte Operating Systems On dragging and dropping an item from the Data Selector, Exaquantum/Explorer will create a data variable. The data variable name is from the access string, for example: Consider the tag: Root.Folder.Tag.Value:Value
On dragging and dropping into Exaquantum/Explorer, a variable would be created with the name: RootFolderTagValueValue
With an access string of:
Root.Folder.Tag.Value:Value
Spaces in the tag name are a special case and are replaced by underscores. Table 5-1 Example single-byte character translations Access String
Variable Name
Root.Folder.Tag.Value:Value
RootFolderTagValueValue
Root.Folder.Tag.Value:TimeStamp
RootFolderTagValueTimeStamp
Root.Folder.Tag.Aggregations.Hour. Maximum.Value:Value
RootFolderTagAggregationsHour MaximumValueValue
Root.Folder XX.Tag YY.Value:Quality
RootFolder_XXTag_YYValueQuality
If the same tag is dragged and dropped onto the document but has different time parameters, for example a live value or historical, then the container will recognize that a variable already exists with the desired name so it will add a number to the variable name. For example: RootFolderTagValueValue1, RootFolderTagValueValue2 and so on.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
5-17
Multi-byte Operating Systems (Japanese) On a Japanese PC (or other multi-byte system) where characters can be multi-byte they will have to be translated into single-byte characters. For an access string you should consider the component parts and identify which parts can be multi-byte characters. Tag name, Folder name and Aggregation name can be in Japanese language, Root, Aggregations, Maximum etc. and Value/Quality /Timestamp will always be in English. For the creation of the variable name, if one of these parts of the access string is represented by multi-byte characters, they will have to be translated. If the characters in the composite part are all single-byte, then they can remain so. Note:
Multi-byte characters include the double-byte representations of A, B etc.
The translation of multi-byte characters will be: Tagname -> Tag
Folder -> Folder
Aggregation –> AggregationName
Consider the following examples:
Table 5-2 Example multi-byte character translations Access String
Variable Name
Root.MultiByteFolder.MultiByteTag.Value:Value
RootFolderTagValueValue
Root.MultiByteFolderX.MultiByteFolderY. MultiByteTag.Value:TimeStamp
RootFolderFolderTagValueTimeStamp
Root.MultiByteFolderX.SingleByteFolderY. MultiByteTag.Value:Quality
RootFolderSingleByteFolderYTagValue TimeStamp
Root.MultiByteFolder.MultiByteTag.Aggregations. MultibyteAggregationName.Maximum.Value:Value
RootFolderTagAggregationsAggregation NameMaximumValueValue
Root.MultiByteFolder.MultiByteTag.Aggregations. SinglebyteAggregationName.Maximum.Value: Value
RootFolderTagAggregationsSingleByte AggregationNameMaximumValueValue
Where any tag, folder, or aggregation names contain multi-byte characters that need to be translated into an equivalent English string, there will be an increased number of times when the variable names will clash. To resolve, this if the desired variable name exists then a number (n) will be appended to the variable name. For example: RootFolderTagValueValue1, RootFolderTagValueValue2
and so on.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
5-18
Chapter 5 Data Selector
This page intentionally left blank
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 6
6-1
Workbook Viewer
This chapter describes the main features and explains how to use the Workbook Viewer.
6.1
General The Workbook Viewer (Figure 6-1) shows a hierarchical tree view of the contents of a workbook, if one is open, and any libraries. A workbook is similar to a folder, it is used to group and hold all documents, Excel reports and other files that are used in a project or process. Figure 6-1 Typical Workbook Viewer
The Workbook Viewer allows you to quickly search for and access the folders, files and documents contained in a workbook. The Workbook Viewer also allows you to drag and drop files onto controls (e.g. bitmap and web browser controls). You can specify shared libraries and allow many users to access documents and templates in Design mode. All shared libraries are displayed on the Workbook Viewer. The Workbook Viewer is only available in Design mode. The Workbook Viewer can be viewed or hidden as required.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
6-2
6.2
Chapter 6 Workbook Viewer
View or Hide the Workbook Viewer There are three ways to view or hide the Workbook Viewer: On the main menu bar, click on View. The View pull-down menu appears. Click on Workbook Viewer to view or hide the Workbook Viewer. On the view toolbar, click on the Workbook Viewer button Workbook Viewer.
to view or hide the
On the keyboard, use the shortcut keys Ctrl + W to view or hide the Workbook Viewer. Note 1: The Workbook Viewer and the Data Selector share the same area on the Exaquantum/Explorer desktop. If the Data Selector is displayed, click on the Workbook Viewer button just above the Data Selector to bring the Workbook Viewer to the front. Note 2: You can resize the Workbook Viewer by moving the mouse pointer onto its border and dragging the border until the Workbook Viewer is the size you want.
6.3
Display the Workbook Contents A workbook can be expanded to show the contained folders, files and documents. The workbooks or folders that can be expanded have a + symbol next to the title. They can be expanded using the mouse. Click on the + symbol in the directory tree Double click on the workbook or folder title.
6.4
Open a Document from the Workbook Viewer There are two methods available: Double-click on the document title Click on a document title. Drag and drop the document onto the work area.
6.5
Hide the Workbook Contents The directory can be collapsed so that all the folders and documents are not shown on the directory tree. This can be done with the mouse. Click on the – symbol next to the workbook icon Double click on the workbook or folder title.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
6.6
6-3
Refresh the Workbook Directory When you make changes to folders or documents, the changes may not be immediately visible on the Workbook Viewer. To see the changes you made: 1 Right-click in the Workbook Viewer background and the context menu appears. Figure 6-2 Workbook Viewer context menu
2 Click on Refresh. The Workbook Viewer directory updates.
6.7
Show File Extension If you want to see all filename extensions: 1 Right-click in the Workbook Viewer background and the context menu appears. 2 Click on Show File Extension. In the Workbook Viewer (Figure 6-3), the file extension shows next to each file. Figure 6-3 Typical Workbook Viewer Showing File Extensions
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
6-4
Chapter 6 Workbook Viewer
This page intentionally left blank
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 7
7-1
Working with Documents
This chapter describes the main features and explains how to create and format Exaquantum/Explorer documents.
7.1
General The basic building block of a user interface is the document. When you create a user interface using Exaquantum/Explorer, you develop the functions and features inside documents using controls and script. The documents you create can be ad-hoc reports or used in conjunction with workbooks to provide a complete user interface.
7.2
Create a New Document Use this procedure when you are creating a new document. This method adds a new, blank document to the Exaquantum/Explorer work area. 1 On the main menu bar, click on File. Select New Document from the File pull-down menu. A new blank document appears in the work area (Figure 7-1). 2 Add controls to build up a user interface screen or an ad-hoc report. Figure 7-1 Typical Work Area with Documents
Document or Graphics Conversion CENTUM CS 1000/CS 3000 source documents and/or graphics can be converted into Exaquantum/Explorer documents. For further information about this process, refer to Exaquantum/Engineering Guide Vol 4 (IM 36J04A15-04E).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-2
7.3
Chapter 7 Working with Documents
Create a New Template A template can be used to determine the basic structure for a document and can contain: controls, scripting, page layout settings, special formatting, and styles. 1 To base a new template on an existing document, click Open on the File menu, and select the document you want. 2 To base a new template on an existing template, click Template on the File menu. Select a template that is similar to the one you want to create. 3 In the File menu, click Save Document As. 4 In the File Name field enter the name for the template. 5 In the Save as type field, select Explorer Document Template (.pxt). 6 Click on Save to create and save the new template. 7 In the new template, add the controls, text and graphics you want to appear in all new documents that you base on the template, delete any controls you do not want to appear.
7.4
Save a Document Use this procedure when you want to save a document. Note:
When the document made with old revision, please do not overwrite on the new revision environment. This is because the document on the Explorer client will not be shown on the old revision environment.
1 On the main menu bar, click on File. Select Save Document from the File pull-down. The Save As window is displayed (the Save As window will only be displayed the very first time a document is saved). Figure 7-2 Save As Window
Note:
The default folder, where new documents are saved, is: ♦ The currently open workbook ♦ The Default Path, specified in the Options window.
2 To save the document in a different folder, click on the Save in and select a different folder. 3 In the File name field, type a name for the new document. 4 Click on Save to save the document and close the window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 Note:
7.5
7-3
This applies to Explorer clients running on Windows 2008, Windows 2012, Windows Vista, Windows 7 or Windows 8, with Virtualization enabled (Local Security Policies, “User Account Control: Virtualize file and registry write failures to per-user locations”). Virtualization was introduced in these Operating Systems, as part of the security enhancements. This feature controls write access to files and folders, to which the user does not have write access (for example, to the windows “Program Files” folder). If a user creates a folder or saves a document to such a location, the Operating System writes the actual file or folder to the users Virtual Store Folder. This location is determined by the value of the userprofile environment variable. The effect of this is that users other than the user who created the file or folder, will not be able to read that location. Therefore, users wishing to create shared documents should be careful when selecting the location of where to save the stored files.
Add a Control to a Document 1 On the Palette, click on a control icon. 2 Move the mouse pointer to where you want the control to be located on the document, then either: Click and hold the mouse button; drag the control to size as required. Release the mouse button. Click the mouse button; a default sized instance of the control is displayed which will need resizing.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-4
7.6
Chapter 7 Working with Documents
Change the Properties of a Control The Property Sheet for the controls can be viewed either on the Palette or in a document. For more information about the Palette, see Chapter 3.
View the Property Sheet In a Document 1 Right-click on a control in a document and the pop-up menu is displayed (Figure 7-3). Select Object Property and the Property Sheet window is displayed. Figure 7-3 Pop-up Menu for Changing Control Properties
On the Palette 1 Right-click on the control and the pop-up menu is displayed. 2 Click on the Properties option and the Property Sheet window (Figure 7-4) is displayed.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 Change a Property 1 In the Property Sheet window, click on the Normal tab. Figure 7-4 Property Sheet Window
2 In the left column, click on the title of the property to be changed. Figure 7-5 Property selection 3 In the right column, type in the new value. The changes take place immediately. 4 On the Property Sheet, click on the Note:
to close the window.
For more information about the Property Sheet, see Chapter 9.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-5
7-6
7.7
Chapter 7 Working with Documents
Selecting Controls Select the controls on a document by: Placing the cursor on the control and clicking the mouse button. Pressing the TAB key until the required control is highlighted. Note:
7.8
Multiple controls may be selected by holding down the shift key and clicking on the required controls.
Change the Layout or Position of Controls 1 Click on the control to be changed; the control frame appears. 2 Change the position of the control by: Dragging the control to the new location Selecting an option from the Layout menu Using the icons on the Layout toolbar. Note:
When the Layout menu is used, the controls will change to the size or move to the position of the first control selected.
Move a Control Move the mouse pointer onto the control until the move pointer appears. 1 Click and hold the mouse button then drag the control to the required position. Release the mouse button. 2 Controls can also be moved with the cursor keys and the CTRL key. Once a control has been selected, and both the CTRL key and the cursor keys are held down, a ‘snapto-grid’ functionality exists. This is not the case when only the cursor key is pressed. Resize a Control 1 Move the mouse pointer onto the frame handles at the edge of the control. The resize pointer appears. 2 Click and hold the mouse button, drag the frame handles to the required position. Release the mouse button. - or 1 Hold down the Shift key and use the cursor keys to resize the control. Holding down the CTRL key at the same time results in the control being resized using the grid settings. 2 Alternatively, in the Property Sheet, set the left, right, top, bottom, width and height properties.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-7
Align a Control 1 Push and hold the Shift key, click on the controls you want to align. The control frames appear. 2 The control frame handles appear on the control to which you want the other controls to align. Note:
The default behavior is for the controls to align to the first control you clicked on.
3 On the main menu bar, click on Layout. The Layout pull-down menu appears. 4 Click on Align, and then select the required alignment. Lefts Rights Tops Bottoms. Note:
When Align operations are performed on items that have previously been grouped, each item in the group will be treated as an individual item. For example, if a group of items is included in an align left operation, each item in the group will be aligned to the left.
Make Multiple Controls the Same Size 1 Click on the first control. 2 Push and hold the Shift key, click on the controls that you want to make the same size. Note:
The default behavior is for the controls to resize to size of the first control you clicked on.
3 On the main menu bar, click on Layout. The Layout pull-down menu appears. 4 Click on Make Same Size, and then click on the required option: Width Height Both.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-8
Chapter 7 Working with Documents
Space Horizontally Use this procedure when you want to distribute the controls evenly spaced in a horizontal direction. 1 Click on the first control. 2 Press and hold the Shift key, click on the controls you want to space. Note:
This function does not align the controls. Refer to the Align paragraph if alignment is required before horizontal spacing.
3 On the main menu bar, click on Layout. The Layout pull-down menu appears. 4 Click on Space Horizontally. Space Vertically Use this procedure when you want to distribute the controls evenly spaced in a vertical direction. 1 Click on the first control. 2 Press and hold the Shift key, click on the controls you want to space. Note:
This function does not align the controls. Refer to the Align paragraph if alignment is required before vertical spacing.
3 On the main menu bar, click on Layout. The Layout pull-down menu appears. 4 Click on Space Vertically. Centre In Form Click on a control. 1 On the main menu bar, click on Layout. The Layout pull-down menu appears. 2 Click on Centre In Form then click on the required option: Centre Horizontally Centre Vertically.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-9
Rotation Basic shapes such as rectangles and ellipses can be rotated. 1 Click on the control. The control frame appears. 2 On the main menu bar, click on Layout. The Layout pull-down menu appears. 3 Click on Rotation and select an option: Free Rotate Rotate by 90º Reset Rotate. Free Rotate 1 Click on Free Rotate – the frame handles become circular and the cursor changes to reflect the change in mode. 2 Select a point on the frame. 3 Click, hold down the left mouse button and rotate the control to the required position. 4 Release the mouse button – this exits rotate mode, the frame handles and cursor return to normal. Rotate by 90° 1 Click on Rotate by 90°. 2 The control rotates 90° clockwise. Reset Rotate 1 Click on the Reset Rotate. 2 The control is reset to its original state of rotation.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-10
Chapter 7 Working with Documents
Order The Exaquantum/Explorer objects are drawn in planes that relate to the class of object to which they belong, as shown in the table below: Table 7-1 Exaquantum/Explorer object planes Interactive objects plane Button
ActiveX objects plane
Drawing objects plane
Trending Control
Polyline
Checkbox
Alarm and Event Summary
Line
Radio button
Time Bar Control
Arc
Combo box
Data Grid Control
Border
Multi-edit box
Update Control
Frame
Edit box
Summary Control
Circle
List box
Absolute Date/Time Picker
Bitmap
Slider
Date Picker
Pointer
Spinner
Interval Picker
Gauge
Production Calendar
Textbox
Excel Viewer For display, the planes are stacked on top of each other, which will determine the order that the controls will be shown on the screen. Starting with the closest to the observer and moving away, the order of the planes is: 1. Interactive objects. 2. ActiveX objects 3. Drawing object Thus certain controls will never appear in front of others. For example it is not possible to display a drawing object in front of an interactive object, however, within each plane, objects can be ordered as required. For controls that can take focus, for example input boxes and buttons, the stacking order is the same as the tab order (page 7-13). Changing the order in which they are stacked will alter the tab order and vice versa. When two or more controls overlap you can specify which control is at the front and which is at the back: 1 Click on the first control. 2 On the main menu click on Layout. The Layout pull-down menu appears. 3 Click on Order. 4 Click on Bring to Front. The control is set to the front or on top of the other control. 5 Click on Order.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-11
6 Click on Send to Back. The control is set to the back or under the other control. Grouping There are three options available: Group – Assembles two or more controls into a single group. This allows controls to be moved, sized, cut, pasted and have their common properties set in unison. Ungroup – Disassembles a group of controls into individual controls. Each control can now be individually selected and moved or changed. Regroup – Reassembles a group of controls that have been disassembled using the Ungroup option. Group 1 Click on the first control. 2 Push and hold the Shift key, click on the controls you want to group. 3 On the main menu bar, click on Layout. The Layout pull-down menu appears. 4 Click on Grouping, and then click on the Group option. The controls combine into one group. Ungroup 1 Click on the control group. 2 On the main menu bar, click on Layout. The Layout pull-down menu appears. 3 Click on Grouping, and then click on the Ungroup option. The control divides into individual controls. Regroup 1 On the main menu bar, click on Layout. The Layout pull-down menu appears. 2 Click on Grouping, and then click on the Regroup option. The previously ungrouped controls combine into one group. Note 1: Controls within groups may still be rearranged and resized by using the Layout menu options: align, make same size and spacing. If multiple groups are selected, the Layout will be performed on all controls in all of the groups. However, when Align operations are performed on items that have been grouped, each item in the group will be treated as an individual item.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-12
Chapter 7 Working with Documents
Layers Use the Layers window to create and delete layers within the active Exaquantum/Explorer document, and to specify which layers you want to work with. For more information about Layers, see Chapter 2. 1 On the main menu bar, click on Document. The Document pull-down menu appears. 2 Select the Layers option. The Layers Sheet window is displayed (Figure 7-6). Figure 7-6 Layers Sheet
3 To create a new layer in the active Exaquantum/Explorer document, click on Add, and type the name of the layer in the Name field. Note:
It is recommended that you use easily recognizable names for layers (e.g. Pipe for a layer containing pipe work, Pumps for layers containing pump equipment, Dynamic for a layer containing live, updating values).
4 To add controls to a layer, select the layer in the list and click on OK. When you add new controls to the document, they become part of the currently selected layer. 5 To hide a layer and all the controls it contains, select the layer in the list and deselect View. 6 To prevent changes to a layer, select the layer in the list and check Lock. Note:
When you are satisfied with the position and properties of the controls on a layer, lock the layer. Use the Send to Back function, from the Layout menu select Order then Send to Back. Controls on other layers can be accurately positioned relative to the controls on the locked layer.
7 To delete a layer, select the layer in the list and click on Delete. Note:
When you delete a layer all the controls on that layer are added to the next layer.
8 To select all the controls on a layer, in the layer list select the layer. Click on Select. All the controls will now be selected.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-13
Tab Order Setting the tab order is a Design mode activity that determines the order in which controls get focus (become active) for user input in Run mode in response to the TAB key being pressed. In Run mode, the tab order is relevant only to controls that can accept an input focus, for example edit boxes, combo boxes, radio buttons, etc. Graphic controls such as lines, rectangles, circles and polylines do not feature in the tab order. You can also enable or disable the tab order properties of controls through their Tabstop property in the Property Sheet. The control will not become active if you set its Tabstop property to 0 - False in the Property Sheet, irrespective of where it appears in the Tab Order list This section describes how you set the Run mode tab order, or how to exclude a control from the tab order. Setting the Tab Order 1 On the main menu bar, click on Document. The Document pull-down menu appears. 2 Click on Tab Order, and the Tab Order window (Figure 7-7) is displayed with the default order selected. Figure 7-7 Example of a Tab Order Window
3 Select a control you want to move in the order list. 4 Click on Up or Down as appropriate to change the order in which the controls receive the input focus. 5 Click on OK to close the Tab Order window. Note:
In Design mode all controls are shown in the tab order. Controls that cannot accept input focus are shown in blue in the Tab Order window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-14
Chapter 7 Working with Documents
Edit Polyline 1 Click on the polyline to be changed. The control frame appears. 2 On the main menu bar, click on Layout. The Layout pull-down menu appears. 3 Click on Edit Polyline. The control points are now shown. Figure 7-8 Example Edit Polyline Screen
4 Move the mouse pointer to a position on the line. 5 Click and drag the line to the new position. 6 Move the mouse pointer outside the control frame and click. Notes: Points can be added to the polyline by clicking on the line between two existing points. Points can be removed by dragging a point to an adjacent point. Dragging the first point to the last can close open polylines. Double clicking on any point can open closed polylines.
7.9
Remove a Control from a Document 1 Click on the control. The control frame appears. 2 On the main menu bar, click on Edit. 3 Select Clear, the control is removed. 4 Alternatively, use the Delete key.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7.10
7-15
Cut or Copy a Control from a Document Controls you cut or copy from a document can be pasted into another document. 1 Click on the control. The control frame appears. 2 On the main menu bar, click on Edit. 3 Select Cut or Copy, a copy of the control is placed in clipboard. 4 Alternatively, use Ctrl+X to cut and Ctrl+C to copy the control.
7.11
Paste a Control to a Document Use this command to insert the contents of the clipboard into the current document. The Paste command is only available if you have cut or copied a control. 1 Click on the control. The control frame appears. 2 On the main menu bar, click on Edit. 3 Select Copy, a copy of the control is placed in clipboard. 4 On the main menu bar, click on Edit. 5 Select Paste, a copy of the control is placed in the document. Note:
7.12
The paste function is not available when pasting graphics into a document for the first time. Right click in the document and select the Paste option from the menu to insert copied or cut information from the clipboard.
Navigate between Documents It is possible to use the Property Sheet to allow navigation between documents in Run mode. Otherwise, it can be done with script. For more information about Navigation, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E).
7.13
Grid Settings Use the Grid Settings window to assist the display and positioning of controls in the active document. 1 On the main menu bar, click on Document. The Document pull-down menu appears. 2 Select Grids Settings. The Grid Settings window (Figure 7-9) is displayed. Figure 7-9 Grid Settings window
To display the grid in the document, select Show Grid. IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-16
Chapter 7 Working with Documents To change distance between grid points, type the new spacing (in pixels) in the Width and Height fields. Note:
The values entered in the Width and Height fields must be even numbers between 4 and 50.
To align controls to the nearest grid intersection when they are dropped or moved on the active document, select Snap to Grid. To reposition the guidelines, type a new value in the appropriate Guidelines field. Note: The values entered in the Guidelines field must be between 0 and 100. 3 When you have finished, click on OK to close the window and apply the changes.
7.14
Options Use this window to set the display properties for Exaquantum/Explorer. Note:
For more information about the Options window, see Chapter 2.
General Tab Figure 7-10 Options window, General tab
1 In the Tools menu, select Options. The Options window is displayed. 2 Select the General tab. 3 If you want to display the grid in all Exaquantum/Explorer documents open in Design mode, select Grid. 4 If you want to align controls with the grid when they are placed or moved in a document, select Snap. 5 Click OK to save your changes and close the window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-17
Path Tab Figure 7-11 Options window, Paths tab
Use this window to specify the default folder for saving and loading files, and to specify the location of shared Libraries. Change the Default Path The default folder specifies the default storage location for Exaquantum/Explorer documents when no location is provided. It is also used as the default folder for opening Exaquantum/Explorer documents. To change the default folder: 1 In the Tools menu, select Options. The Options window is displayed. 2 Select the Path tab. 3 In the Default Path field, type the fully qualified pathname of the default folder, or click on
to search for the folder using the Browse for Folder window.
4 Click on OK to save your changes and close the window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-18
Chapter 7 Working with Documents Add a Library to the List A library is a collection of folders, files and documents that you frequently use or wish to be shared as a resource by many workbooks or other designers. The Libraries list can contain any folders you want to use when you work with Exaquantum/Explorer. 1 In the Tools menu, select Options. The Options window is displayed. 2 Select the Paths tab. 3 Click on the Add Library button
to add a blank entry to the list.
4 In the blank entry, type the fully qualified pathname of the folder, or click on search for the folder using the Browse for Folder window.
to
5 Click on OK to save your changes and close the window. Remove a Library from the List To remove a Library from the list: 1 In the Tools menu, select Options. The Options window is displayed. 2 Select the Paths tab. 3 In the Libraries list, select the folder you want to remove. 4 Click on the Remove Library button
.
5 Click on OK to save your changes and close the window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7.15
7-19
Set Global Report Times Use the global Set Report Times window to specify report start, end or spot times set for all documents contained in a workbook. 1 On the main menu bar, click on Tools. The Tools pull-down menu appears. 2 Select the Global Report Times option, the Set Report Times window (Figure 7-12) is displayed. Figure 7-12 Set Report Times Window
3 Set the Report Times as required.
7.16
Set Report Times The Set Report Times window allows you to specify the start, end or spot times for data contained in the currently selected document. 1 On the main menu bar, click on Document. The Document pull-down menu appears. 2 Select the Report Times option, the Set Report Times window (Figure 7-12) is displayed. 3 Set the Report Times as required.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-20
7.17
Chapter 7 Working with Documents
Set Data Range and Update Rate When you have specified the source of the data that you want a document to display, you must specify the refresh rate you want to use for each data item. You must also choose whether you want live or historical data to be displayed. The Set Data Range/Update window is used to specify the default times. The way in which data is refreshed depends on the type of data involved. There are three data types: Live data - data that is displayed as it is received, or after a short time lag. History data - data recorded at a specified date and time (you can use it to set up documents that show such things as values recorded at the end of the previous shift, as well as current readings). History Replay data - similar to live data displays except that the values are refreshed from previously saved data. (This feature enables you to set up documents that replay particular incidents, or to show current and past data for comparison purposes.) Notes: Use the Set Data Range/Update window from the Data Selector before the data is bound. If you have bound data to control properties and then use the Set Data Range/Update window from the Data Selector, the data will not reproduce the changes. For changes made after binding, use the Variables window for each bound variable. You can make changes to the default times through the Variables window or the Property Binder window. The server time is used for the value of NOW.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-21
To open the Set Data Range/Update window: 1 Right-click on the Data Selector. A pop-up menu is displayed. 2 In the pop-up menu, select Times. The Set Data Range/Update window (Figure 7-13) is displayed. Figure 7-13 Set Data Range/Update Window
Live Data Example; Specify that you want a document to refresh data every minute: 1 In the Data Type group, select Live. 2 In the Data Range group, select Point. 3 In the Point Time group, select Now in the first drop-down list. 4 In the Update Rate group: a Select Custom to specify that you want to set the rate at which the data on screen refreshes. (The default refresh rate is 5 seconds.) b Type 1 in the first field and select Minutes in the second field; this specifies that you want the data to be refreshed every minute. 5 Click on OK to save your changes and close the window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-22
Chapter 7 Working with Documents
History Data Example; Display the data value at the start of the day: 1 In the Data Type group, select History. 2 In the Data Range group, select Point. 3 In the Point Time group, select Report Start. 4 Click on OK to save your changes and close the window. History Replay Data History replay is the function whereby the screen is updated regularly with data that comes from the historian. This gives you the ability to go through a period of process history in order to reconstruct what happened, e.g. reviewing the last day’s history in the space of a minute. The Update Rate is how often fresh data is placed on the screen (in real time), while the Update Rate Increment is how far apart (in historical time terms) successive data values are. For example, to set up a history replay: 1 In the Data Type group, select History Replay. 2 In the Data Range group, select Point. 3 In the Point Time group: a Select Pick Date. b In the date list, select the date on which you want the replay to start. c In the time list, select the time at which you want the replay to start. 4 In the Update Rate group, click Default to use the default refresh rate of 5 seconds. 5 In the Update Rate Increment group: a Click Custom to specify that you want to set the interval between displayed readings. b Type 30 in the left field and select Seconds from the drop-down list to specify that you want to display readings at 30-second intervals. 6 Click OK to save your changes and close the window. Notes: If you set an update rate increment that is higher than the update rate, the replay is speeded up because intervening records are skipped. It also means that eventually live data will be displayed, when the display catches up with the present. To replay data at the original display rate, choose equal update and update increment rates. Values Type This may be used to control the timestamp returned for historical data. Edge – Data is returned with the timestamp requested (Default) Bounding – Data is returned with the timestamp of the value change
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
7-23
Future Time Issues When selecting a time or time range, it is valid to choose a point or period in the future. If such settings are chosen, the result will be that the last stored value will be propagated forwards to the requested time or end time. When choosing an historical replay, the update will continue until the time or end time reaches beyond the current time. When this point is reached, updating will stop.
7.18
Running an Ad-hoc Document Ensure that all workbooks are closed and the document to run is open before performing this function. Failure to do so will result in the workbook being run and not the document. 1 On the main menu bar, click on Play. The Play pull-down menu appears. 2 Click on Start or press the F5 key, the document runs in Run mode. 3 To view the document in full screen mode, press the F11 key. 4 Click on Stop or press the Shift and F5 keys to return to Design mode.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
7-24
Chapter 7 Working with Documents
This page intentionally left blank
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 8
8-1
Workbook
This chapter describes the main features and explains how to use the Workbook.
8.1
General A Workbook is a hierarchical collection of files and folders. Use workbooks to specify the active document, and to control the startup and configuration options of the documents in Run mode. The workbook is a very powerful tool that: Specifies which documents are opened in Run mode Specifies which document is opened first Defines the properties of a document when in Run mode Defines the appearance of Exaquantum/Explorer in Run mode; whether the Data Selector, Application Launcher and menus are available or disabled. Workbooks are .PXW files that hold the initial configuration details for the Exaquantum/Explorer user interface. It is recommended that documents and files within a workbook are located in the same directory as the workbook. This enables the document to be present in the Workbook Viewer for easy access in Design mode. The Workbook Viewer is used to quickly search for and access the folders, files and documents contained in a workbook. The Workbook Viewer also allows you to drag and drop files onto controls (e.g. bitmap and web browser controls). For more information about the Workbook Viewer, see Chapter 6. Note 1: The Workbook menu is only displayed on the main menu bar when a workbook is open. Note 2: You can open only one workbook at a time. When you create a new workbook, the application automatically closes the current one after prompting you to save your changes.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
8-2
8.2
Chapter 8 Workbook
New Workbook Window The New Workbook window (Figure 8-1) is used to create a new workbook. Figure 8-1 New Workbook Window
The New Workbook Window comprises these fields and controls: Name This is the name of the workbook you want to create. The name can be up to 255 characters long. Directory The drive and path of the directory where you want to store the workbook. This may be browsed for using the button. Create a New Workbook 1 On the main menu bar, click on File. The File pull-down menu is displayed. 2 Click on New Workbook; the New Workbook window (Figure 8-1) is displayed. 3 In the Name field, type the name of the workbook. 4 In the Directory field, type the location of the folder where you want to save the workbook. If the directory you specified does not exist, the system asks you to confirm that you want to create it. 5 Click on OK to create the workbook and close the window. Note:
You can open only one workbook at a time. When you create a new workbook, the application automatically closes the current one after prompting you to save your changes.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
8.3
8-3
Configure Workbook The Configure Workbook window (Figure 8-2), opened by selecting Workbook Properties from the Workbook menu, lists the Exaquantum/Explorer documents displayed when a workbook is run. This window is used to control the properties and Run mode behavior of Exaquantum/Explorer documents run from this workbook. Figure 8-2 Configure Workbook Window
Configure Workbook Control Buttons The Configure Workbook window comprises these control buttons: Add Document Adds a document to the document list. Remove Document Removes the selected document from the document list. Configure Document List For each Exaquantum/Explorer document you want to display, complete the following fields: File Name Use this field to specify the name and folder location of the document. Target Name The Target Name is used to refer to the window in scripts. For more information about Scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E). Caption Use this field to specify the title for the window in which the document is displayed. By default, the caption is set to the file name of the document.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
8-4
Chapter 8 Workbook Window State Use this field to specify whether the Exaquantum/Explorer window is initially minimized, maximized or normal. Window Style Use this field to specify the type of window in which the document is displayed. The options are: Sizeable – Allows you to change the size of the window Fixed – Does not allow you to change the window size Always On Top – Opens the window ‘on top’ of any other windows Sizeable Scroll – Allows you to change the size of the window and displays the scroll bars Fixed Scroll – Displays the scroll bars Always On Top Scroll - Opens the window ‘on top’ of any other windows and displays the scroll bars. Width Use this field to define the initial width (in pixels) of the window. Height Use this field to define the initial height (in pixels) of the window. Top Use this field to define the initial vertical position (in pixels) of the window relative to the top-left of the workbook window. Left Use this field to define the initial horizontal position (in pixels) of the window relative to the top-left of the workbook window. Shell Configuration
Shell Configuration allows you to specify the appearance of the whole display screen. It comprises the following options: Disable Run-time Menus Hides all menus when the workbook is in Run mode. Disable Run-time Application Launcher Check the Disable Run-Time Application Launcher check box to specify that the Application Launcher is disabled in Run mode. This also removes the Application Launcher entry from the View menu in Run mode. Disable Run-time Data Selector Check the Disable Run-Time Data Selector check box to specify that the Data Selector is disabled Run mode. This also removes the Data Selector entry from the View menu in Run mode. IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
8-5
Document Windows
Document Windows allows you to further specify the appearance of the whole display screen. It comprises a single check box: Start With Windows Maximised When checked, means that all documents will be displayed in their maximized state in Run mode. Note:
When checked this option overrides the Window State property for individual documents.
Start In Full Screen Mode When checked, means that the workbook will be displayed full screen in Run mode. The menus, toolbars, data selector and application launcher will not be displayed. Pressing the F11 key toggles the display between full screen and normal modes. Add a Document to a Workbook Every document present in the same folder as a workbook will appear in the Workbook Viewer. However, this does not necessarily mean that it is part of the workbook. To add a document to the workbook: 1 In the Workbook menu, select Workbook Properties. The Configure Workbook window is displayed. 2 Click on the Add Documents button standard Open window appears.
to add a blank row to the document list. The
3 Select the document you wish to add, and click OK. 4 Optionally, specify a title for the window in the Caption field. 5 Optionally, click on the Window State field, then click on the down arrow and select the initial state for the document window. 6 Optionally, click on the Window Style field, then click on the down arrow and select the type of window you want to display the document in. 7 Optionally, specify the document’s initial dimensions (in pixels) in the Width and Height fields. 8 Optionally, specify the initial position of the document window (in pixels) in the Top and Left fields. 9 Optionally, set the document to be the active document when the workbook is run: a Right-click the document you want to display first in Run mode. The pop-up menu is displayed. b Click on Set As Active Document. 10 Click on OK to save your changes and close the window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
8-6
Chapter 8 Workbook
Remove a Document from a Workbook 1 In the Workbook menu, select Workbook Properties. The Configure Workbook window is displayed. 2 Select the File Name you want to remove. 3 Click on the Remove Documents button
to remove the document from the list.
4 Click on OK to save your changes and close the window. Specify the Workbook Run Mode Settings 1 In the Workbook menu, select Workbook Properties. The Configure Workbook window is displayed. 2 If you want to hide all menus at run time, check the Disable Run-Time Menus check box. 3 If you want to disable the Application Launcher during Run mode, check the Disable Run-Time Application Launcher check box. 4 If you want to disable the Data Selector during Run mode, check the Disable RunTime Data Selector check box. 5 If you want to maximize all windows at run time, check the Start With Windows Maximized check box. 6 If you want to view the workbook in full screen mode at run time, check the Start In Full Screen Mode check box. Pressing F11 then toggles the view between full screen and normal. Import a Document, Picture or File into a Workbook This procedure allows documents, pictures or any other files to be copied from a selected location into the directory associated with the currently open workbook. 1 In the Workbook menu, select Import Document. The Open window is displayed 2 Select the File Name field, then type the path and file name of the document you want to open, or click on to search for the document in the Open window. 3 Click on Open to save your changes and close the window. Note:
Importing means the file is copied. Make sure all future edits of the file are done to the new copy in the workbook directory.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
8.4
8-7
Secure Workbooks Explorer provides for two types of users: Users with the ability to design and run workbooks and documents. Users who may only run workbooks/documents. Secure workbooks are provided for users with run-time only permissions, causing Explorer to go straight to run mode when started, and a workbook to be automatically opened.
Access To be able to modify workbooks and documents, you must be a member of the following group: Legacy Security Model: QExplorerDesignGroup; Standard Security Model: QTM_EXPLORER_DESIGN If you are not a member of the above group, you will not be able to edit any workbooks or documents. When you start Exaquantum/Explorer the: Command line switches and file names are ignored A folder name is read from the registry on the Exaquantum Server computer. Exaquantum/Explorer looks for the first, readable workbook file in the folder If such a workbook file is found in the folder then the workbook is opened and Exaquantum/Explorer is set to Run mode. Otherwise, Explorer is set to Run mode with no workbook or documents opened. Secure Workbook Configuration The secure workbook location folder is configured during the Exaquantum Server installation procedure. For more information about the installation procedure see; IM 36J04A13-01E Exaquantum Installation Guide. This folder should be used to store the secure workbooks for all Exaquantum Client computers and users. To allow different secure workbooks to be used by different users, add multiple workbooks to the folder, and change the security settings on each workbook so that they only have read access for the correct users.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
8-8
Chapter 8 Workbook
This page intentionally left blank
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 9
9-1
Property Sheet
This chapter describes the main features and explains how to use the Property Sheet.
9.1
General The Property Sheet allows you to view and/or change the properties of a control. It is only available in Design mode. Each control has properties that alter its appearance or behavior. The Property Sheet is used to enter the desired property values so that in Run mode, the control exhibits the appropriate characteristics. ActiveX controls such as the Trending Control (for more information about Trends, see the Exaquantum/Explorer User's Manual Volume 2 – Custom Controls (IM 36J04A12-02E) also have Properties Windows via which ActiveX properties can be changed (ActiveX properties are only relevant for an ActiveX control). The property sheet shows all read/write properties which are of a basic type. Properties which are read-only, write-only or where the type is some control defined class are not shown in the property sheet and can only be accessed via script. Data can be ‘bound’ to certain properties of controls. For more information about the Property Binding, see Chapter 10. In Exaquantum/Explorer the Property Sheet is typically used to define the Run mode: Appearance of the control (e.g. font size, font type, foreground and background colors) Behavior of the control. For example, you might specify the control with its Visible property set to False initially, then use scripting to make the control appear (i.e. set Visible to True) when certain conditions in the script are met. For more information about Scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
9-2
Chapter 9 Property Sheet The Property Sheet window has either two tabs (Figure 9-1) or three tabs (Figure 9-2). The ActiveX tab only appears in the case of ActiveX controls. Figure 9-1 Property Sheet (Normal and Events Tabs)
Figure 9-2 Property Sheet (Normal, Events and ActiveX Tabs)
The events tab allows the advanced user to write ‘event handlers’ using VB script (For more information about Scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
9.2
View the Properties The properties of a control can be viewed either on the Palette or in a Document. On the Palette: 1 Right-click on the control and the pop-up menu is displayed. Figure 9-3 Palette Control pop-up menu
2 Click on the Properties option and the Property Sheet window is shown In a Document: 1 Right-click on a control in a document and the pop-up menu is displayed. 2 Select Object Property and the Property Sheet window is displayed. Figure 9-4 Document Control pop-up menu
- or 1 Double-click on the control. The Property Sheet window is displayed.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
9-3
9-4
Chapter 9 Property Sheet
Using the Property Sheet The Property Sheet can be set ‘always open’ for ease of use. In this way, if a different control is selected, the Property Sheet will stay open and the properties will reflect the newly selected control. This is done as follows: 1 Move the mouse pointer onto the Property Sheet window title bar. 2 On the Property Sheet window, click the pin button window.
to lock the position of the
Note 1: Any changes made on the Property Sheet are reflected immediately. Note 2: The drop-down list at the top of the Property Sheet window (Figure 9-5) can be used to select a different control. Figure 9-5 Property Sheet with Drop-Down List
Note 3: To close the Property Sheet, click on
.
Grouped Controls When a set of grouped controls is selected, the Property Sheet will show the properties which are common to all of the controls in the group, except the following properties: Left, right, top, bottom, height, width, rotationangle.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
9.3
9-5
Change Properties There are three methods available for changing the value of a Normal or an ActiveX property (the third tab, Events, is explained in Provide Event Handlers). These methods are: Method 1: Change the value directly Method 2: Change the value via an option button Method 3: Change the value via the Property Binder window Note:
Not all of the methods will apply to all properties. Some properties may only acquire certain values, so they will typically be set via an option window or dropdown list.
If there is an option (or window) button and/or Property Binder button associated with a property, it will appear in the input field (right column) when the property is selected. Note:
These descriptions relate primarily to Normal properties, but they can apply equally to ActiveX properties (For more information, see the Exaquantum/Explorer User's Manual Volume 2 – Custom Controls (IM 36J04A12-02E).
Method 1 (This example shows the position of the bottom line of the cursor button; 75 is the distance from the top margin.) 1 In the Property Sheet window, click on the Normal tab. 2 In the left column, click on the title of the property to be changed. Figure 9-6 Property selection 3 In the right column, type in the new value. The changes take place immediately.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
9-6
Chapter 9 Property Sheet Method 2 (This example shows how to change the cursor pointer, using the option button.) 1 In the Property Sheet window, click on the Normal tab. 2 In the left column, click on the title of the property to be changed. Figure 9-7 Property selection
3 In the right column, click on the option button displayed.
; a menu or a window will be
Figure 9-8 Property Sheet with drop-down menu for the CursorPointer Property
4 Select a new value from the menu or window. The changes take place immediately.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
9-7
Method 3 (This example shows how to change the ForeColor (foreground color) of a control, using the Property Binder button.) 1 In the Property Sheet window, click on the Normal tab. 2 In the left column, click on the title of the property to be changed. Figure 9-9 Property selection 3 In the right column, click on the Property Binder button window (Figure 9-10) is displayed.
and the Property Binder
Figure 9-10 Property Binder Window
4 Select the binding type required, and complete the details as necessary. For more information about the Property Binding, see Chapter 10
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
9-8
9.4
Chapter 9 Property Sheet
Provide Event Handlers The Events tab of the Property Sheet lists all events supported by the selected control. The simplest example of an event is a mouse click on the control. Through the Events tab, users are able to write ‘event handlers’. These are procedures, written in VBScript, by which Exaquantum/Explorer should handle the events. Note:
A list of all events, and the controls that support the events, are given in the Exaquantum/Explorer User's Manual Volume 2 – Custom Controls (IM 36J04A12-02E.
1 In the Property Sheet window, click on the Events tab. Sample Events supported by the button control are shown (Figure 9-11). Figure 9-11 Property Sheet Window – Events Tab
2 In the left column, click on the title of the event for which a handler is required.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1 3 In the right column, click on the option button (Figure 9-12) is displayed.
9-9 and the VBS Mini-Editor window
Figure 9-12 VBS Mini-Editor Window
4 Event handlers are written in VBScript using the VBS Mini-Editor. (For more information about Scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
9-10
Chapter 9 Property Sheet
This page intentionally left blank
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 10
10-1
Property Binder
This chapter describes the main features and explains how to use the Property Binding function.
10.1
General The Property Binder (Figure 10-1) can be used to change the values of some of the properties of controls. The main function of the Property Binder is to attach or bind a value to a property of a control. This value can be the value of a variable or the result of a script function. This can provide the mechanism to change a property value dynamically. By default properties have constant values; this does not mean that the value will always remain the same. It is possible to change the value externally from another script-bound property or an event handler when in Run mode. Exaquantum/Explorer supports three methods of setting property values: Constant (or Unbound) Data Binding (Bound to a variable) Script Binding (the property value is set according to the outcome of a function evaluation). The binding type is selected by using the radio buttons at the top of the Property Binder window. To reset a property (to constant or unbound state) that was previously set to data or script binding, check the constant radio button. Figure 10-1 Property Binder Window
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-2
10.2
Chapter 10 Property Binder
Constant (Unbound) Properties Most control properties are not bound to a variable or to script. They have a constant value as set in the Property Sheet. The property value is fixed until it is changed either by the user in Design mode or by some external mechanism in Run mode. For example, a script on a click event of a button may change the value of the text property of a text control. Whenever you change a value via the Property Sheet using the drop-down list, the menu option or entering a value directly into the value field, you are changing the value of the property directly. Notes: This is not the case if you drag a value from the Data Selector. In this case the property will be data bound. You do not have to use the Property Binder to change the constant value of that property. The constant value of a property can be changed in the Property Sheet.
10.3
Data Binding Method The Data Binding method attaches either an external or internal data variable source to the property. The value of this variable will directly or indirectly affect the value of the property. This method can be used for the following purposes, which is to: Assign a value obtained from a remote Data Server Indirectly affect the property value rather than directly, (as in the Constant method) Provide a more intuitive and flexible way to implement dynamic data visualization. In Exaquantum/Explorer, external data source variables are referred to as Data Variables and internal data source variables are referred to as Local Variables. For more information, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E).
Direct Affect The value of a direct data-bound property will be the value of the associated variable. The simplest way to configure a data binding is to drag a data node from the Data Selector directly into a property on the Property Sheet. This will automatically change the binding from Constant to Data without any need to display the Property Binder window. Indirect Affect Data binding provides the ability to indirectly change the value of the property based upon the value of a variable, through a mechanism known as the threshold table. This is the simplest way to translate the input variable to a value more suitable to the property. For example, it is not meaningful to bind a real number representing a temperature or pressure to the color property of a control. The threshold table mechanism provides a way of mapping the real number to a set of colors. A value in the range 0 to 10 could be mapped to blue, and from 11 to 40 could be mapped to orange, etc. The threshold table mechanism therefore allows a numeric to be translated to some other output type such as color, text, or font, which is required by the property being bound to. The value of the variable is used to index into a table, which maps the variable value to a property value.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-3
Data Binding Window The components of the Data Binding Option window (Figure 10-2) are described in the following sections. Figure 10-2 Property Binder Window (Data Binding Option)
Variables The Variables group indicates which types of variables are displayed in the source dropdown list. You can choose from: Data - External data variables. Local - Internal variables configured in the document. The Variables group acts as a filter for the amount of data displayed in the Source dropdown list; this makes selection of the required variable easier. The source type resets when the property binder is closed (the default being for both type boxes to be checked). Source The Source field provides a drop-down list of all the data source variables configured in the document that match the specification set by the Source Type group. To add new data source variables, click on Edit to display the Variables window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-4
Chapter 10 Property Binder Format The Format field governs the format in which the value will be displayed. It governs the type and precision of the data display. This field can be left blank, indicating that the default format should be used. A format specification consists of optional and required fields. An example of a format field is: 8.2f The above format applies only to real numbers. With this format, the value would be eight characters wide and have two digits displayed after the decimal point. Note:
Trailing zeros are always removed.
For more information on the Format field, see paragraph 10.7. Output The Output group has two options: Direct, the value of the variable will be used directly to set the value of the property Via Threshold, the value of the variable will be compared with that stored in a threshold table to determine the value of the property. Selecting the Via Threshold option enables the Threshold field and the New button.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-5
Threshold Field The name of the assigned threshold table is displayed in the Threshold field. The Threshold field (Figure 10-3) allows the user to select an existing threshold table. The New button allows the user to create a new threshold table (via the Create Threshold window). If a threshold is set, then the name of the threshold and associated variable are displayed next to the Threshold Var: heading. Note:
Only threshold tables compatible with the type of property are displayed in the drop-down list. Figure 10-3 Property Binder showing Threshold Table
Note:
The threshold tables are unique within a document. However, multiple variables can bind to the same threshold table.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-6
Chapter 10 Property Binder Threshold Tables The threshold values are displayed in the threshold table. A threshold table consists of one or more threshold values. Each table entry is made up of an input value representing the threshold(s) on the left and an associated output value on the right. During Run mode, the value of the input variable is compared with the value in the left-hand column of the threshold table. A value from the right-hand column is then retrieved, depending on which interval the input value falls in. For example, the table in Figure 10-4 maps a range of numbers to colors. If the value of the input variable is 33, the threshold will return green (RGB 128, 255, 128), which is the color associated with the interval between 25 and 50. The type of input variable need not be the same as that of the property whose value is to be affected. For example, to change the foreground color of a gauge control, depending on a specific value of an external data variable, requires a color threshold but associated with it a floating-point variable. The Create Threshold window (Figure 10-4) is used to create threshold tables. To display the Create Threshold window, in the Property Binder window, click on New. The Create Threshold window is used to set the: Threshold name Threshold type Threshold limits Threshold output Out of range value. Figure 10-4 Create Threshold Window
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-7
Name This field is used to set the name of the threshold table. Output This is the type of output; Exaquantum/Explorer supports five data types for setting threshold tables: Color - this changes when the value of the variable is more than the value set in the threshold table. It will change again when the value of the variable is less than the value set in the threshold table. Boolean - this can be used for all Yes/No type properties which have access to the Property Binder. String - this is used to display different text information at different times. For example, to give an error message depending on the Quality attribute of a Tag. Double (floating point) - this can be used: For numeric output values to allow some offset to be applied When one variable is used to affect a number of different property values that require a different range of values. Font - this is used for the font property, allows special emphasis to be dynamically applied depending on the value of the associated variable. Input/Output List The Input column is used to specify the value at which the property will change; the input value is ‘up to and including’. The Output column is used to select the data type for the property. For example: if the Input has a value of 25, the Output color is blue, and the Out of Range color is red, any numbers up to and including 25 will return the color blue; numbers above 25 will return red. Out of Range The Out of Range box is used to select the option for values less than the lower limit value and greater than the higher limit value.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-8
Chapter 10 Property Binder Understanding Threshold Tables and their Associations There is only ever one copy of a threshold table with a given name within a document. There may, however, be different variables bound to the same threshold table. The implication here is that if you change a given threshold table, all bindings using that table will be affected. (Also note that once loaded, thresholds are maintained within the document. Changing a table in one document, therefore, cannot affect the threshold tables in others.) For each combination of a threshold table and an input variable, Exaquantum/Explorer automatically creates a new “threshold variable”. The new variables are bound to the control properties. For example, a document can have three controls called Ctrl1, Ctrl2 and Ctrl3, and we wish to set a particular property of each of them (Figure 10-5). Ctrl1 and Ctrl3 are to use the same input variable called Data1; and Ctrl2 will use a different variable called Data2. These variables are to be bound to a threshold table called Thr1. This indicates that there will be one threshold table called Thr1 and two threshold variables called Thr1:Data1 and Thr1:Data2. This is internal data mapping. Figure 10-5 Example of Threshold Data Mapping
Ctrl1
Thr1:Data1
Ctrl2
Thr1:Data2
Ctrl3
Thr1
Data1
Data2
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10.4
10-9
Script Binding Method This is the most flexible, but the most complex method to bind a value to a property. With this method a user-written script function is used to calculate a value. The return value from this function determines the result at any point in time. The script binding method is used when: More than one variable is involved (such as quality information). For example, setting a bad status rather than the value if the quality attribute indicates that the data is bad. A calculation is required before a value can be set. For example, calculating a percentage. To bind a script to a property, check the Script radio button on the Property Binder window. The Property Binder window will display the script mini editor. Figure 10-6 shows an example of the Script option. For more information about Scripting, see the Exaquantum/Explorer User's Manual Volume 4 – Advanced Configuration (IM 36J04A12-04E). Figure 10-6 Script Binding Option Window
In this example, the background color of a gauge control (Gauge1) changes from red to green based on the value of the local variable Boolvar. The new value is returned to a local variable called Retn, which is assigned as the output of the function. The required property value must be assigned to the variable called Retn. Retn is then assigned to the property value prior to the function end. Note:
The property should NOT be modified directly in the script. The new value should be returned from the function.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-10
10.5
Chapter 10 Property Binder
Display the Property Binder 1 In the Property Sheet window, click on the Normal tab. 2 In the left column, click on the title of the property to be changed. Figure 10-7 Property selection 3 In the right column, click on the Property Binder button window is displayed.
and the Property Binder
4 To select the Binding Type, click on the appropriate radio button on the Property Binder window.
10.6
Thresholds
Create a New Threshold Table 1 In the Property Binder window, click on the Data radio button. 2 In the Output group, click on the Via Threshold radio button. 3 In the Threshold field, click on New. The Create Threshold window (Figure 10-8) is displayed. Figure 10-8 Create Threshold Window
4 In the Name field, type a name for the threshold. This name must be unique within the document. 5 In the Input field, click on the down arrow. Select a Type from the drop-down list. Note:
This step is required to create a threshold table of a Type different to the one expected by the property through which you entered the window. If you change the Type it will not appear in the drop-down list for the property in the Create Threshold window.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-11
6 In the Output field, click on the down arrow. Select an option from the drop-down list. 7 In the table under the Input field, type a value for the threshold limit (e.g. if you type 25, that signifies a threshold limit up to and including 25). 8 In the table under the Output field, enter the output or action for that limit (e.g. select a color from the drop-down menu). 9 Repeat steps 7 and 8 if other threshold limits are required. 10 Click on the
button to save the threshold table.
11 Click on OK to set the threshold into the Property Binder. Note:
If you click on OK and the threshold table has not been saved you will be asked if you wish to save the table. You can create numerous threshold tables but only those valid for the particular property that is being bound will be displayed in the drop-down list of the Property Binder. Dragging a value from the Data Selector will create a threshold binding. Press and hold the Ctrl Key before dropping the value onto the Property Sheet. This will cause the Property Binder window to be displayed.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-12
Chapter 10 Property Binder
Change a Threshold Value Note:
The only way to change a threshold value is through the Property Binder. The Create Threshold window is just used to create new threshold tables.
1 In the Property Sheet window, click on the Normal tab. 2 In the left column, click on the title of the property to be changed. Figure 10-9 Property selection 3 In the right column, click on the Property Binder button window is displayed.
and the Property Binder
4 In the Property Binder click on the Data radio button. The Property Binder (Data Binding option) window (Figure 10-10) is displayed. 5 In the threshold table, click on the Limit or Output value to be changed: To change a value, type the new value To delete a value, clear the limit field. There will now be a prompt to confirm you want to delete the value. Figure 10-10 Property Binder with Data Binding Option Selected
Add a Threshold Value 1 In the threshold table, scroll to the bottom of the table and click on an empty field. 2 In the Input field, type a value for the threshold limit (e.g. 40). 3 In the Output field, type the output or action for that limit (e.g. select a color from the drop-down menu). 4 On the keyboard, press the enter or tab key. Note:
There is only one copy of each threshold table. Changing the values for any property will change them for all properties using that threshold table.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10.7
10-13
Format Field Specifications The Format field (in the Property Binder (Data Binding option) window) controls the format in which the value will be displayed. It also controls the type and precision of the data display. If this field is left blank the default format is used. A format specification consists of optional and required fields. An example of the code in a format field is: [flags][width][.precision] [{h| I|I64|L}]type Where: The fields in [] are optional The group in {} indicates a list of available values for this field Only one of the entries separated by the | is valid. Each field of the format specification is a single character or a number signifying a particular format option. The simplest format specification contains only the type character (for example,‘s’ indicates an arbitrary length text string). If a character is specified which is not valid then that character will be displayed as entered.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-14
Chapter 10 Property Binder
Flags This is an optional field that controls justification of the output and printing of signs, blanks, decimal points, and octal and hexadecimal prefixes. More than one flag can appear in a format specification. The following table lists the supported flags (the integer formats are described below). Table 10-1 Flags Flag
Meaning
Default
+
Prefix the output value with a sign {+|-} if the output value is of a signed type.
Sign appears only for negative signed values.
0
If width is prefixed with 0, zeros are added until the minimum width is reached. If 0 and – appear, the 0 is ignored. If 0 is specified with an integer format (i,u,x,X,o,d) the 0 is ignored.
No Padding.
Blank (' ')
Prefix the output value with a blank if the output value is signed and positive. The blank is ignored if both the blank and + flags appear.
No blank appears.
#
When used with the o, x, or X format, the # flag prefixes any nonzero output value with 0, 0x or 0X respectively.
No prefix.
#
When used with e or f format, the # flag forces the output value to contain a decimal point in all cases.
Decimal point appears only if digits follow it.
#
When used with the g or G format, the # flag forces the output value to contain a decimal point in all cases and prevents the truncation of trailing zeros.
Decimal point appears only if digits follow it. Trailing zeros are truncated.
#
Ignored when used with c, d, i, u, or s.
-
Adds the padding to the left or the right. Specify the – (minus) flag for left alignment.
Right alignment.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-15
Width Specification The width specification is an optional non-negative number that specifies the minimum number of characters in the output. If the number of characters in the output value is less than the specified width, blanks are added to the left or right of the value, until the minimum width is reached. Whether the padding is added to the left or the right depends on whether the - flag (for left alignment) is specified. If width is prefixed with 0, zeros are added until the minimum width is reached. This is not useful if a number is left aligned. The width specification never causes a value to be truncated. If the number of characters in the output value is greater than the specified width, or if width is not given, all characters of the value are displayed (subject to the precision specification).
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-16
Chapter 10 Property Binder
Precision Specification The precision specification is an optional non-negative decimal integer preceded by a period character. The period character specifies the number of characters to be displayed, the number of decimal places, or the number of significant digits. Unlike the width specification, the precision specification can cause either truncation of the output value or rounding of a floating-point value. If precision is specified as 0 and the value to be converted is 0, then no characters will be output. The format type determines the interpretation of precision and the default when precision is omitted. The following table indicates the effect of precision for the various types. Table 10-2 Precision effects Type
Meaning
Default
C, c
The Precision has no effect.
d, i, u, o, x, X
The precision specifies the minimum number of digits to be displayed.
Default is 1.
If the number of digits in the argument is less than precision, the output value is padded on the left with zeros. The value is not truncated when the number of digits exceeds precision. e
The precision specifies the number of digits after the decimal point. The last printed digit is rounded.
Default is 6.
If precision is 0 or the period appears without a number then no decimal point is printed. F
The precision specifies the number of digits after the decimal point.
Default is 6.
If a decimal point appears, at least one digit appears before it. The value is rounded to the appropriate number of digits. If precision is 0 or the period appears without a number, then no decimal point is printed. G, g
The precision specifies the maximum number of significant digits displayed.
The default is 6 with any trailing zeros truncated.
S, s
The precision specifies the maximum number of characters to be displayed.
All characters are displayed up to the first null character.
Characters in excess of this will not be displayed.
If the argument corresponding to a floating-point specification is infinite, indefinite, or NAN, the following output will be generated:
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-17
For + infinity the number 1.#INFrandomdigits (random digits will be displayed) For - infinity the number -1.#INFrandomdigits (random digits will be displayed) For Indefinite the number digit.#INDrandomdigits (random digits will be displayed) For NAN the number digit.#NANrandomdigits (random digits will be displayed). Size of Argument Specification These are optional prefixes to the type specifications (h|l|I64|L) and specify the size of the argument. Type If a format type is specified it will override the default type. The default types are: Table 10-3 Default format types Values
Default
Integer values
d
Real, Floating point values
f
String values
s
Character values
c
Data values
No default
It is not necessary to specify the type if the default is to be assumed. The minimum format required, if the default is not to be used, is width with an optional precision. For example a format for a floating-point number might be 5.2, indicating a width of 5 with 2 digits after the decimal point. The default formatting will be as shown in the table, unless global formatting has been configured. See Engineering Guide Volume 3 for more information.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-18
Chapter 10 Property Binder
Numeric and Character Data Types Valid numeric and character types are described in the following table. Table 10-4 Numeric and Character Data Types Type Format Character
Output Format
c
Specifies a single-byte character
d
Signed decimal integer
i
Signed decimal integer
o
Unsigned octal integer
u
Unsigned decimal integer
x
Unsigned hexadecimal integer, using lowercase "abcdef"
X
Unsigned hexadecimal integer, using uppercase "ABCDEF"
e
Exponent or Engineering notation. Signed value having the form [-]d.dddd e[{+|-}]ddd Where d is a single decimal digit, dddd is one or more decimal digits, and ddd is exactly three decimal digits. [{+|-}] indicates an optional + or - sign, + will be assumed if not specified. Signed value having the form
f
[-]dddd.dddd Where dddd is one or more decimal digits. The number of digits before the decimal point depends on the magnitude of the number, and the number of digits after the decimal point depends on the requested precision. g
Signed value displayed in f or e format whichever is more compact given values and precision. The e format is used only when the exponent of the value is less than -4 or greater than or equal to the precision argument. Trailing zeros are truncated and the decimal point appears only if one or more digits follow.
G
Identical to g format except E replaces e in the exponent where appropriate.
s
Specifies a single-byte character string. Characters are displayed up to the first null character or until the precision value is reached. Note:
Care must be taken to properly match up the format specification with the type of the variable. Giving an integer variable a format field of “s “(string output), for example, will result in an unpredictable output. IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
10-19
Date Formats Valid date format types are described in the following table. Table 10-5 Date Format Types Type Format Character
Output Format
a
Abbreviated weekday name (Mon).
A
Full weekday name.
b
Abbreviated month name (Nov).
B
Full month name.
c
Date and time representation appropriate for locale.
d
Day of month as decimal number (01-31).
H
Hour in 24-hour format (00-23).
I
Hour in 12-hour format (01-12).
j
Day of year as decimal number (001-366).
m
Month as decimal number (01-12).
M
Minute as decimal number (00-59).
p
Current locale's AM/PM indicator for a 12-hour clock.
S
Second as decimal number (00-59).
U
Week of year as decimal number, with Sunday as first day of the week (00-51).
w
Weekday as decimal number (0-6; Sunday is 0).
W
Week of year as decimal number, with Monday as first day of the week (00-51).
x
Date representation for current locale.
X
Time representation for the current locale.
y
Year without century, as decimal number (00-99).
Y
Year with century as decimal number.
Z or z
Time-zone name or abbreviation; no characters if time zone is unknown.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
10-20
Chapter 10 Property Binder A # flag may prefix any formatting code. When one is present the meaning of the format code changes as follows: For a, A, b, B, p, X, z, Z the # flag is ignored #c gives long date and time specification, appropriate to the current locale e.g. "Wednesday, July 29, 1998". For d, H, I, j, m, M, S, U, w, W, y, Y the # flag causes any leading zeros to be removed. Note:
These formats are only valid when applied to variables of type ‘Date’.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
Chapter 11
11-1
Exaquantum/Explorer Connectivity
This section describes how Exaquantum/Explorer responds when the connection to the Exaquantum server or network is lost.
11.1
Connectivity Issues Exaquantum/Explorer has constant interactions with the Exaquantum servers, even when it is in Design mode. When users are viewing key production data in Run mode, it is very important that they are informed immediately if the data (they are viewing) is no longer being refreshed. This could be due to the: Loss of network connection Exaquantum servers being shutdown. The response of Exaquantum/Explorer in its various modes of operation to network connection issues is covered in subsequent sections. Note:
11.2
For more information about how the Excel Add-In handles connectivity, see the Exaquantum/Explorer User's Manual Volume 3 – Excel Reports (IM 36J04A1203E).
Detection Of Network Loss The client computer while Exaquantum applications are running (Exaquantum/Explorer and Excel with the Exaquantum/Explorer Add-in) monitors the network to check that the Exaquantum servers are reachable. This is done by a message being sent to the servers every 60 seconds to which a response is expected within 30 seconds. If the response is not received then the client applications are notified and take the appropriate action as outlined in this chapter. The message from the client is invoked by a timer, therefore the time between when the network was lost and the time at which it was detected by the client could be in the range of 30 to 90 seconds. This is because the network connection could be lost just before or after the message is sent from the client. If the network is lost and then re-established (minimum 30 second loss, maximum 90) the client applications will recover.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
11-2
11.3
Chapter 11 Exaquantum/Explorer Connectivity
Single Server System
Exaquantum/Explorer Start-up No Network Connection or Server Available If Exaquantum/Explorer is started up when there is no network connection or Exaquantum server available, a pop-up screen (Figure 11-1) appears. Figure 11-1 No Network Connection or Server Available
There are two options available, press either Retry or Cancel: Retry Pressing Retry attempts to retry the connection to Exaquantum. Cancel Pressing Cancel abandons the Exaquantum/Explorer session and closes the pop-up.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
11-3
Design and Run Modes Loss of Network Connection If the network connection is lost in design or run modes, a pop-up screen (Figure 11-2) appears. Figure 11-2 Loss of Network Connection
When you press OK, a message box pop-up appears (Figure 11-3) advising you to press Retry or Cancel. Figure 11-3 Network Retry / Cancel Message Pop-up
Retry Pressing Retry attempts to retry the connection to Exaquantum. Cancel Pressing Cancel abandons the Exaquantum/Explorer session and opens a message box pop-up (Figure 11-4), advising you to and save any unsaved document changes. Figure 11-4 Save Changes Message Pop-up
Once all document changes are saved (or discarded), the Exaquantum/Explorer session closes.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
11-4
Chapter 11 Exaquantum/Explorer Connectivity Server Unavailable or Shut Down If the Exaquantum server becomes unavailable or shut down, a pop-up screen (Figure 11-5) appears. Figure 11-5 Shutdown Message Pop-up
When you press OK, a message box pop-up appears (Figure 11-6) advising you to press Retry or Cancel. Figure 11-6 Server Retry / Cancel Message Pop-up
Retry Pressing Retry attempts to retry the connection to Exaquantum. Cancel Pressing Cancel abandons the Exaquantum/Explorer session and opens a message box pop-up (Figure 11-7), advising you to and save any unsaved document changes. Figure 11-7 Save Changes Message Pop-up
Once all document changes are saved (or discarded), the Exaquantum/Explorer session closes.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
11.4
11-5
Multi Server System
Exaquantum/Explorer Startup No Network Connection or Server Available At startup in a multi server system, the Client PC will attempt to connect to the Primary Server. If this is unavailable it will attempt to connect to the Secondary Server. If a connection is made to either server, this then becomes the system ‘Master’ server. If a connection to either the Primary or Secondary Server cannot be made, a pop-up screen (Figure 11-8) appears advising you to press Retry or Cancel. Figure 11-8 No Network Connections or Servers Available
Retry Pressing Retry attempts to retry the connections to Exaquantum. Cancel Pressing Cancel abandons the Exaquantum/Explorer session and closes the pop-up. Design and Run Modes Loss of network Connection to Master Server The Master Server is either the Primary or Secondary Server, depending on which server was available at startup. If the network connection to the Master Server is lost in design or run modes, a pop-up screen (Figure 11-9) appears. Figure 11-9 Loss of Network Connection to Master Server
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
11-6
Chapter 11 Exaquantum/Explorer Connectivity When you press OK, a message box pop-up appears (Figure 11-10) advising you to press Retry or Cancel. Figure 11-10 Network Retry / Cancel Message Pop-up
Retry Pressing Retry attempts to retry the connections to the Primary and then the Secondary Exaquantum Servers. Cancel Pressing Cancel abandons the Exaquantum/Explorer session and opens a message box pop-up (Figure 11-11), advising you to and save any unsaved document changes. Figure 11-11 Save Changes Message Pop-up
Once all document changes are saved (or discarded), the Exaquantum/Explorer session closes. Master Server Unavailable or Shut Down If the Exaquantum Master server is unavailable or shut down, a pop-up screen (Figure 11-12) appears. Figure 11-12 Master Server Unavailable or Shut Down
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
Exaquantum/Explorer User’s Manual – Volume 1
11-7
When you press OK, a message box pop-up appears (Figure 11-13) advising you to press Retry or Cancel. Figure 11-13 Server Retry / Cancel Message Pop-up
Retry Pressing Retry attempts to retry the connection to the Primary and then the Secondary Exaquantum Servers. Cancel Pressing Cancel abandons the Exaquantum/Explorer session and opens a message box pop-up (Figure 11-14), advising you to and save any unsaved document changes. Figure 11-14 Save Changes Message Pop-up
Once all document changes are saved (or discarded), the Exaquantum/Explorer session closes. Other Server Unavailable or Shut Down Design Mode If another server that is part of the multi-server environment (not Master) becomes unavailable whilst the user is designing a new document, then the tree for the related elements in the Data Selector will not be expanded. Run Mode If the user is viewing a document in run mode, then the tag values for the unavailable data will default to zero and the quality will become Bad/Unavailable.
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
11-8
Chapter 11 Exaquantum/Explorer Connectivity
This page intentionally left blank
IM 36J04A12-01E 13th Edition Issue 1 February 21st 2014
