wks informatik gmbh rtstand user interface 2015 · the rtstand user interface is a...

Document Dok Nr. QS-ID-036

User Guide Stand Sept 2010 Revision 001

WKS Informatik GmbH Ulmer Straße 8 88212 Ravensburg Tel: ++49 (0)751 / 366 60 – 60 www.wks-informatik.de

Ust-IdNr. DE 203907888 HRB 552079

Geschäftsführer Ronald Kaempf

Bankverbindung IBAN DE91 6505 0110 0048 0755 23

SWIFT-BIC: SOLADES1RVB Kreissparkasse Ravensburg

Erstellung:

Datum: 20.11.2014

Andreea Solomon

Prüfung:

Datum: 20.11.2014

Gisela Lämmle-Steinert

Freigabe:

Datum: 20.11.2014

Ronald Kaempf

Seite 1 von 32

WKS Informatik GmbH RTStand User Interface 2015

User Guide V2.2

Last changed: 13.02.2015

UI Version: 9.4 (and higher)

WKS Informatik GmbH RTStand User Interface


Ust-IdNr. DE 203907999 HRB 552079

Geschäftsführer Ronald Kaempf Seite 2 von 32

Content

1 GENERAL ......................................................................................................................................................... 4

2 MAIN STRUCTURE ........................................................................................................................................ 5

3 FUNCTIONALITY AND DESCRIPTION ..................................................................................................... 6

3.1 USER INTERFACE STRUCTURE .............................................................................................................................. 6 3.1.1 User Logo .................................................................................................................................................. 7

3.1.2 User name and date ................................................................................................................................... 7

3.1.3 Terminate All ............................................................................................................................................. 8

3.1.4 Stop Testing ................................................................................................................................................ 8 3.1.5 Shortcuts .................................................................................................................................................... 8 3.1.6 Debug Window ........................................................................................................................................... 9

3.1.7 Sequence / Execution Display ................................................................................................................. 10

3.1.8 Tabs .......................................................................................................................................................... 11 3.1.8.1 Home tab ......................................................................................................................................................... 11 3.1.8.2 Sequence File tab ............................................................................................................................................. 12 3.1.8.3 Overview tab .................................................................................................................................................... 13 3.1.8.4 Execution tab ................................................................................................................................................... 14 3.1.8.5 Online Report tab ............................................................................................................................................ 15 3.1.8.6 Custom Views tab ............................................................................................................................................ 16 3.1.8.7 Report tab ........................................................................................................................................................ 17

3.1.9 Status list and NI TestStand bar ............................................................................................................... 18

4 ERRORS .......................................................................................................................................................... 19

5 CONFIGURING THE USER INTERFACE THROUGH CONFIG.INI . .................................................. 19

5.1 CREATING A USER LOGO .................................................................................................................................... 19

5.2 ACTIVATING TABS .............................................................................................................................................. 20

5.3 ACTIVATING EDITOR MODE ............................................................................................................................... 20 5.4 DEFINING CUSTOM VIEWS AND OVERVIEW SUBPANELS ..................................................................................... 20

5.5 DEFINING THE PROJECT INI FILE ........................................................................................................................ 20 5.6 DEFINING REPORT TYPE ..................................................................................................................................... 20

5.7 SETTING THE RELOAD OPTION ............................................................................................................................ 21

6 CONFIGURING USER INTERFACE THROUGH NI TESTSTAND ... .................................................... 22

6.1 TOOLS MENU FOR INTERFACE SHORTCUTS ........................................................................................................ 22 6.2 USER MANAGEMENT........................................................................................................................................... 23

7 USER INTERFACE MESSAGES .................................................................................................................. 24

7.1 ACTIVEX UIM COMMAND ................................................................................................................................. 25 7.1.1 Sending Home tab information – UIM Number 28 .................................................................................. 26 7.1.2 Sending Online Report tab information ................................................................................................... 26

7.1.2.1 Sending Column Headers – UIM Number 26 .................................................................................................. 26

7.1.2.2 Sending Online Report data- UIM Number 25 ................................................................................................ 27

7.1.3 Sending Report tab information ............................................................................................................... 28

7.1.3.1 Native NI TestStand Callback ......................................................................................................................... 28

7.1.3.2 Sending Report data – UIM Number 10 .......................................................................................................... 28

7.1.3.3 Sending Status data – UIM Number 6 ............................................................................................................. 29

7.1.3.4 Clearing Status data – UIM Number 7 ............................................................................................................ 29

7.1.3.5 Clearing framework data – UIM Number 27 .................................................................................................. 29



Ust-IdNr. DE 203907999 HRB 552079


8 INTERFACE TO CUSTOM SUBPANELS .................................................................................................. 30

8.1 STOP PROCESS NOTIFIER .................................................................................................................................... 30

8.2 PROJECT INI NOTIFIER ....................................................................................................................................... 30

8.3 UIM QUEUE ....................................................................................................................................................... 31

8.4 ANSWER Q ......................................................................................................................................................... 31 8.5 SUBPANEL SIZE NOTIFIER .................................................................................................................................... 32

9 SYSTEM REQUIREMENTS ......................................................................................................................... 32

10 TECHNICAL SUPPORT ............................................................................................................................... 32



Ust-IdNr. DE 203907999 HRB 552079


1 General The RTStand User Interface is a fully-customizable user interface to NI TestStand. (and optionally to NI VeriStand). It merges the user management, reporting and sequence editing capabilities of NI TestStand and the new, control and visualization power of RTStand.

Fig.1. RTStand user interface for a Valeo project Almost everything is customizable, offering the user the unique opportunity to define his own user interface and extend it with his own code, with very low (or none) programming effort.



Ust-IdNr. DE 203907999 HRB 552079


2 Main Structure Each User Interface installation comes with a file structure as follows:

Fig.2. Folder structure The Documentation folder includes the necessary documentation for the user. The Examples folder includes some NI TestStand Sequences allowing the user to see how the interaction between NI TestStand and RTStand User Interface takes place. The Executable folder has the User Interface executable and also the Subpanel LLBs necessary for the Custom Views (s. Chapter 2.1.7). The Executables\Bin folder contains two subfolders: User and WKS (similar to the NI TestStand folder structure).

Fig.3. Folder structure User/WKS The User Subfolder will contain all the customized necessary files for the configuration, in a similar manner as the WKS folder. As long as the User folder has no content, the default WKS content will be used. In these folders the most important file is the Config.ini file. This file defines the most important settings for the User Interface, such as visible Tabs, Custom Views (s Chapter 4) and Logos. The SourceCode folder can be provided upon corresponding licensing contract with the purchasing company/person. Please contact WKS Informatik GmbH to see if you are entitled to the User Interface source code. The version.txt contains the history of changes/updates made to the User Interface.



Ust-IdNr. DE 203907999 HRB 552079


3 Functionality and description

3.1 User Interface Structure The User interface has several areas of functionality, each having its own customization capabilities, from fixed to fully user-defined. The structure is presented in the following Screenshot:

Fig.4. User Interface Below we will present each area and its functions.



Ust-IdNr. DE 203907999 HRB 552079


3.1.1 User Logo

Fig.5. User logo There are two ways to implement a user logo into the interface:

- Recommended: Saving a logo file as ClientLogo.jpg in the Executables\Bin\User\ folder

Fig.6. User logo path

- Saving a logo file in the Executables\Bin\User\ folder and editing the Config.ini file correspondingly (be aware that relative paths to the Config.ini are needed! S. Chapter 4)

Fig.6. Config.ini – User logo

Important: the size of the Logo must be 60x385 px.

The version displayed is the one defined in the version.txt file.

3.1.2 User name and date According to the user management functionality defined in the user NI TestStand application, the logged in user will be displayed, as well as the current time. The user can logout anytime, as long as the test is not running. Upon logout, several functions may be disabled, as defined in the user management (s. Chapter 5).

Fig.7. Login button



Ust-IdNr. DE 203907999 HRB 552079


3.1.3 Terminate All Next to the Login button, the user can find the Terminate All button. Its main purpose is to terminate all running sequences.

Fig.8. Terminate button

3.1.4 Stop Testing Next to the Login button, the user can also find the Stop Testing button. Its main purpose is to terminate all running sequences according to a pre-defined Shutdown routine. This has to be defined in TestStand and must be linked in the Tools menu to the User Interface under the name “StopTesting”. This button is deactivated if there is no such linkage in the Tools menu.

Fig.9. Stop Testing button

3.1.5 Shortcuts The four buttons in the lower left side of the interface represent a shortcut to well-defined functionality. This functionality is and must be defined in the Tools menu of NI TestStand. (s. Chapter 5) These buttons are deactivated if there is no such linkage in the Tools menu.

Fig.10. Shortcut buttons



Ust-IdNr. DE 203907999 HRB 552079


3.1.6 Debug Window Next to the shortcuts, two displays show the current CPU and system memory usage.

Fig.11. Debug data Upon clicking on the Debug button, the Debug window will be displayed, showing detailed CPU and memory information.

Fig.12. Debug window The user has the possibility to save the values at different times, thus controlling ist system. This is useful when the user changes its system and wants to be sure that the performance stays the same. The window can be hidden at any time.



Ust-IdNr. DE 203907999 HRB 552079


3.1.7 Sequence / Execution Display

The loaded sequences and corresponding executions (at runtime) are displayed on the right side. Using the shortcut menu, the user can start the sequence or open/close other sequences, in a similar manner as in NI TestStand.

Fig.13. Sequence display



Ust-IdNr. DE 203907999 HRB 552079


3.1.8 Tabs The RTStand User Interface consists of 7 tabs, each having a specific purpose.

3.1.8.1 Home tab Upon loading a sequence, the Home tab becomes active.

Fig.14. Home tab The current sequence name is displayed, along with a project description and picture, which are defined in the loaded sequence. This data is stored in files in the root project and can be changed by the user according to his purposes (for how to configure this, s. Chapters 4 and 5). The Home tab also has 3 buttons, allowing the sequence start in 3 modi: run uut, single pass and sequence run, corresponding to the NI TestStand capabilities.

Fig.15. Start sequence buttons



Ust-IdNr. DE 203907999 HRB 552079


3.1.8.2 Sequence File tab If the user has a corresponding NI TestStand license, he has the possibility to edit the sequences inside the user interface, on the Sequence File tab. Most of the NI TestStand functions are available for this purpose.

Fig.16. Sequence file tab This tab can be hidden at runtime, as defined in the configuration file.



Ust-IdNr. DE 203907999 HRB 552079


3.1.8.3 Overview tab Upon starting the sequence, the execution tabs become active. The Overview tab is fully customizable and displays whatever information the user needs. For how to build a custom overview, see Chapter 6. For example, it can display some DUT information, as seen below:

Fig.17. Example Overview tab This tab can be hidden at runtime, as defined in the configuration file. An example from an actual project looks like this:



Ust-IdNr. DE 203907999 HRB 552079


This tab should be used for general information like number of DUTs, their current state, current test state, error display etc. Of course it can be used as well for more specific purposes, if desired.

3.1.8.4 Execution tab The Execution tab displays the current NI TestStand sequencer. This is helpful when wanting to observe the sequence flow. The two buttons on the tab, can Pause and Resume the execution and also Terminate it.

Fig.18. Execution tab



Ust-IdNr. DE 203907999 HRB 552079


This tab can be hidden at runtime, as defined in the configuration file.

3.1.8.5 Online Report tab The Online Report tab displays information which was tagged as relevant by the user in his sequence. This is done using a special custom step type, which is included in the installation. The information can also be filtered on the tab, by result and by step type, thus allowing the user to visualize only relevant data. To see how to send information to the Online Report tab, have a look at Chapter 6.

Fig.19. Online report tab This tab can be hidden at runtime, as defined in the configuration file.



Ust-IdNr. DE 203907999 HRB 552079


3.1.8.6 Custom Views tab The Custom Views tab is probably THE most interesting tab of the RTStand User Interface. It has the possibility to integrate an unlimited number of complex subpanels. The user can select which one he wants to see at a particular moment.

Fig.20. Custom Views tab The list of Custom Views displayed is configured in the Config.ini file, as follows:

Fig.21. Custom Views panel configuration in Config.ini file Under the Custom tag, the Overview subpanel (for the Overview tab – see 3.1.8.3) is defined, along with the Custom View Subpanel paths and their captions. The Subpanels must be saved along with their dependencies in LLBs. Under the CustomProject tag, the specific project INI file path is defined, which the Subpanels may need in order to run properly. Users can program their own Subpanels, using the interface defined by WKS Informatik GmbH. For more information on how to program the Subpanels, see Chapter 7. This tab can be hidden at runtime, as defined in the configuration file.



Ust-IdNr. DE 203907999 HRB 552079


An example of how this views can look like are displayed below:

An interface to the WKS Informatik’s Tube Analyzer

A display of NI Veristand data This views should display complex project data and analysis results. This of course can be adapted to any customer needs.

3.1.8.7 Report tab The Report tab displays the execution reports upon ending the execution. Formats accepted are PDF, HTML, XML, TXT and others. By request, WKS Informatik GmbH can provide with a viewer for specific report formats.



Ust-IdNr. DE 203907999 HRB 552079


Fig.22. Report tab This tab can be hidden at runtime, as defined in the configuration file.

3.1.9 Status list and NI TestStand bar The Status bar displays relevant information as defined in the test sequence, as well as error messages. The NI TestStand bar displays NI TestStand information, such as tester, model and steps active.

Fig.23. Status list



Ust-IdNr. DE 203907999 HRB 552079


4 Errors Errors are displayed either in the Status bar or in popup windows, in critical cases.

5 Configuring the User Interface through Config.ini The Config.ini describes the general configuration of the RTStand User Interface. It is structured as pictured:

Fig.24. Config.ini file In order for the user to customize his interface, he has to copy the .ini file to the User folder, along with the WKSLogo.jpg.

5.1 Creating a User Logo The user has to create a JPG ClientLogo file in the same User folder.

Important: the size of the Logo must be 60x385 px.



Ust-IdNr. DE 203907999 HRB 552079


5.2 Activating tabs The user can decide which tabs he wants to activate, by setting the corresponding values to “true” under the Tabs tag.

5.3 Activating Editor Mode The user can activate the editing mode of the User Interface, by setting the Editor label to “True”, under the Editor tag.

For activating the Editor Mode is necessary to have an editing NI TestStand license.

5.4 Defining Custom Views and Overview Subpanels All Subpanel Vis must be saved in LLBs together with their dependencies. These LLBs must be saved in the Executables\CustomPanels folder.

The communication interface to NI TestStand and to the RTStand User Interface will be discussed in Chapter 7. In the Config.ini file, under the tag Custom, the relative paths (to the Config.ini file) must be defined. Beginning with index 1, the Custom Views must have a caption and a path. The Overview can have an empty path, if the Overview tab is hidden.

5.5 Defining the Project INI file Each user project can have an INI file, which the custom subpanels use. This relative path to this file is defined under the tag CustomProject.

5.6 Defining Report type The Reports can either be displayed using the native TestStand functionality or using a custom WKS Informatik reporting routine. The user can also set the maximum number of reports which are displayed in the report list (the newest will be displayed).



Ust-IdNr. DE 203907999 HRB 552079


5.7 Setting the Reload option The user has the possibility to set the last used sequence or a new empty one as the one to be loaded at startup. The user can also use the supplied Configuration Editor for a more comfortable experience.

Fig.25. Configuration Editor interface



Ust-IdNr. DE 203907999 HRB 552079


6 Configuring User Interface through NI TestStand

6.1 Tools Menu for Interface Shortcuts

Fig.26. Shortcut buttons In order to define the functionality of these 5 Shortcut buttons, the user has to configure the Tools Menu of NI TestStand, as follows: -Select Customize from the NI TestStand Tools menu

Fig.27. Tools menu customize -Click on Add button

Fig.28. Tools menu add item



Ust-IdNr. DE 203907999 HRB 552079


-Choose the corresponding action and define its name as “Documentation”, “Configuration”, “Viewer”, “StopTesting” or “Database” .

Fig.29. Tools menu item type

It is important that the Shortcut names are exactly as specified above.

6.2 User management A user with Admin rights can define the user management, using the User Management functions of NI TestStand:

Fig.30. NI TestStand user management



Ust-IdNr. DE 203907999 HRB 552079


7 User Interface Messages In order for NI TestStand to communicate with RTStand User Interface, WKS Informatik GmbH chose the User Interface Message (UIM), a standard object of communication. For detailed information, follow this link: http://www.ni.com/white-paper/4532/en/ Each UI message contains the following data relating to the execution event:

o message ID - indicates the type of message being sent

o Numeric data

o String data

o Object Reference data

The complete list of message IDs can be found here: http://zone.ni.com/reference/en-XX/help/370052J-01/tsapiref/reftopics/uimessagecodes/ The message IDs used by RTStand User Interface are 10000-based (as described in the link above). The current IDs used by the RTStand Framework are: Status (Runtime info) 10000 + 6 Clear Status 10000 + 7 Custom Report data 10000 + 10 Online Report 10000 + 25 Columns for Online Report 10000 + 26 Clear all 10000 + 27 Home tab data 10000 + 28

This list is subject to modifications.

All IDs between 1 and 899 (+ 10000 base) are reserved by the RTStand User Interface and cannot be used by the user. All IDs over 900 (+ 10000 base) are user-specific and can be used accordingly.



Ust-IdNr. DE 203907999 HRB 552079


7.1 ActiveX UIM Command

In order to send UIMs to RTStand User Interface, the user has to use the ActiveX PostUIMessageEx Method, as shown below.

Fig.31. ActiveX command UIM

There are 3 types of data that can be sent as an UIM, such as in the example above: - Numeric - String - Object Reference of a container

It is important to always use the message base when sending the UIM!



Ust-IdNr. DE 203907999 HRB 552079


7.1.1 Sending Home tab information – UIM Number 28

In order to send the project description and product image for the Home tab, a UIM call is needed. As ActiveX parameter, a container is needed, which holds the paths to the desired files.

The order of the paths is important:

1. Project Description path 2. Project Image path 3. Project Contact path

Fig.32. UIM 28 – Home tab

7.1.2 Sending Online Report tab information

For the Online Report tab there are two UIMs necessary. The user must define the column headers and the actual data posted in the list.

7.1.2.1 Sending Column Headers – UIM Number 26

Before sending any Online Report data, the column headers must be set and sent. The user can send as many headers as he wants (but he should still remain reasonable!). The data must be packed into a container of strings (s. below).



Ust-IdNr. DE 203907999 HRB 552079


If the user send a header string named “Result” or “StepType”, the corresponding column data will be used to filter the list.

Fig.33. UIM 26 – online report tab

7.1.2.2 Sending Online Report data- UIM Number 25

The Online Report data must be packed into a container of strings and must correspond to the header data sent with the UIM 26.

Fig.34. UIM 25 – online report



Ust-IdNr. DE 203907999 HRB 552079


7.1.3 Sending Report tab information There are two ways of sending data to the Report tab.

7.1.3.1 Native NI TestStand Callback The first one uses the NI TestStand native callback functions. This way the report will be displayed at the end of the test, using its own path, as in the following picture:

Fig.35. Native callback display for reports

7.1.3.2 Sending Report data – UIM Number 10 The second one uses the UIM 10, sending a container of two strings, first one being a caption and second one the actual path to the report file.

Fig.36. UIM 10 –report The reports will be displayed using the captions:

Fig.37. UIM display for reports

The order of the strings in the UIM is important:

1. Caption 2. Report file path



Ust-IdNr. DE 203907999 HRB 552079


7.1.3.3 Sending Status data – UIM Number 6 In the same manner,using the Active X method, the user can send data which is displayed in the Runtime info field. This is done using the UIM ID 6 and the desired String value.

Fig.38. UIM for status data

7.1.3.4 Clearing Status data – UIM Number 7 In order to clear the status data, UIM ID 7 is needed.

Fig.39. UIM for clear status

7.1.3.5 Clearing framework data – UIM Number 27 In order to clear the framework controls, the user can use the UIM ID 27.

Fig.40. UIM for clear all



Ust-IdNr. DE 203907999 HRB 552079


8 Interface to custom subpanels

As previously said, the custom subpanels must have a precise interface in order to receive data from NI TestStand and from RTStand User Interface. An example is provided with the installation.

8.1 Stop Process Notifier In order to stop processes at the User Interface shutdown, the user must built in his subpanels a stop routine based on the notifier below:

Fig.41. Stop process notifier

8.2 Project INI Notifier If the project uses an INI file, the subpanels must the following notifier in order to get the file path:

Fig.42. Subpanel project ini notifier



Ust-IdNr. DE 203907999 HRB 552079


8.3 UIM Queue In order to receive UIMs, a queue must be used as pictured below. The UIMs must be then processed according to the type of message: numeric, string or container. The queue must be flushed and destroyed at shutdown.

Each subpanel must ONLY process the UIMs that it uses!

Fig.43. UIM Queue

8.4 Answer Q All UIMs must be acknowledges by the subpanels. In order to do so, an Answe queue must be used. In the Default case, the acknowledge will not be sent.

Fig.44. UIM Answer Q



Ust-IdNr. DE 203907999 HRB 552079


8.5 Subpanel size notifier The notifier informs the subpanel about the current height and width of the custom views tab, so that the subpanel can use this data to accordingly update its size.

Fig.45. Subpanel size noitifier

9 System requirements The RTStand User Interface supports and requires NI LabVIEW 2013 and NI TestStand 2013 or NI LabVIEW 2014 and NI TestStand 2014, offering two different installations. The RTStand User Interface is optimized for Windows 7.

The RTStand User Interface is running only when a valid NI TestStand software is licensed on the target PC.

10 Technical support For technical support, please use following channels: WKS Informatik GmbH Tel. 0049 751 36 660 60 Fax. 0049 751 36 660 66 Email. [email protected]

wks informatik gmbh rtstand user interface 2015 · the rtstand user interface is a...

Documents