qrm labview client

Document Name Document Class Date Version

QRM LabVIEW Client Documentation May 2014 1.3

Author Document Nr Page

Mattias Ericsson 4-100-203 1 (22)

1 (22)

QRM LabVIEW Client

Documentation

The Compatible with LabVIEW logo is a trademark of National Instruments Corporation and is used

under a license from National Instruments Corporation.





2 (22)

Contents

1 Document Change History ..................................................................................... 3 2 Documents and Abbreviations ............................................................................... 3

2.1 Reference Documents ..................................................................................... 3 2.2 Abbreviations .................................................................................................. 3

2.3 Readers Guide ................................................................................................. 3 3 Overview ................................................................................................................ 4

3.1 QRM Client ..................................................................................................... 5 3.2 Evaluation........................................................................................................ 5

4 QRM Web Service ................................................................................................. 6

4.1 Installing .NET Framework 3.5SP1 (Windows 8 only) .................................. 6

4.2 Installation QRM Web Service ....................................................................... 7

4.3 Configuring Forwarding to Test Server .......................................................... 9 5 View Results in QRM Web Application ............................................................. 10 6 LabVIEW QRMClient ......................................................................................... 13

6.1 Requirements ................................................................................................. 13

6.2 Installation ..................................................................................................... 13 6.3 Examples ....................................................................................................... 14

6.4 Result Types .................................................................................................. 17 6.5 Attachments ................................................................................................... 19 6.6 Issues to Consider.......................................................................................... 20

6.7 Error Codes ................................................................................................... 21 7 Support ................................................................................................................. 22

8 Troubleshooting ................................................................................................... 22





3 (22)

1 Document Change History Version Comment Author

1.0 First version. Mattias Ericsson

1.1 Updated after review. Mattias Ericsson

1.2 Added information of how to use the AddQ test

server.

Mattias Ericsson

1.3 Added information of enabling .NET 3.5 on

Windows 8.

Mattias Ericsson

2 Documents and Abbreviations

2.1 Reference Documents

Ref Doc Nr Document Name Content

[1] http://grouper.ieee.org/groups/scc20/tii/ ATML specification

[2] 4-100-88 QRM Windows Installation Guide Install guide

[3] 4-100-201 QRM Web Application Manual Manual

2.2 Abbreviations

ATML Automated Test Markup Language – XML Schema for test results

defined in the ATML standard IEEE Std 1671

GUID Globally Unique Identifier - A unique id that couldn’t be duplicated.

IIS Internet Information Server. Microsoft web hosting server.

QRM Quality Result Management SOAP Simple Object Access Protocol TBD To Be Defined

UTC Coordinated Universal Time

UUT Unit Under Test

VPN Virtual Private Network

2.3 Readers Guide

The purpose of this document is how to install and use the LabVIEW QRM Client.





4 (22)

3 Overview The QRM result management system has been created in order to store and maintain

test results. It is a Windows based (Windows 7/8/2008R2 Server/2012 Server)

distributed system based on web services, databases and ATML XML data. QRM

consists of two main parts:

QRM Web Service – This part is responsible for storing and synchronizing test

data in the system.

QRM Web Application Server – This part are responsible for presenting and

statistical analysis of test data through a web page based system.

QRM Database

QRM Web Service

Laptop

Test

Program

IIS Web Server

Test Station Server Client

QRM Web Service

Figure 1. QRM overview. This is typical setup. A test program on a test station post ATML

results to the QRM Web Service that forwards the ATML to another QRM Web Service that

store into the QRM database. A client makes a request to the IIS web server to get the results.

The only interaction between the two major parts is through the data storage, in all

other senses they are totally separated.

The QRM is a client-server based distributed system using web services. All

communication between the web services and clients are using HTTP protocol, which

means that it is very “firewall friendly”. All test data is sent as XML data, using the

ATML standard with some QRM extensions. This is a standard developed especially

for test results in automated systems. It is always the client who initiates the

communication to the web service. Notice that the web service itself could act as a

client. The database has been designed to meet all the data required by the ATML

standard.





5 (22)

3.1 QRM Client

The QRM client is quite simple and only formats test results as ATML XML report

and posts them by HTTP to a QRM Web Service. The typical setup is a local QRM

Web Service on the same machine as the QRM client. This local QRM web service is

always available even if the network is temporary down. The client is not robust

against network problems, but the QRM Web Service is and will continue trying to

forwarding the ATML reports until it succeeds even if the test program running the

client has stopped executing, since it is a Windows background process.

3.2 Evaluation

In order to test the QRM LabVIEW client without a QRM license, there exists a test

server on addq4.se that can be used to test the test station client without using a

license. The steps below needs to be performed:

1. Install the QRM Web Service and configure it to forward the addq4.se

2. Install the LabVIEW QRM Client VIPM.

3. Run a QRM example or build your own generator.

4. View the results in the QRM Web Application at addq4.se

The database at addq4.se will be recycled every night and all data will be lost. There

are some default example test results already stored in the database that also can be

viewed.

If you want to setup your own server with databases and QRM Web Application on

an IIS server, please contact AddQ for an evaluation license and instructions. Please

contact [email protected] or [email protected].

mailto:[email protected]






6 (22)

4 QRM Web Service

4.1 Installing .NET Framework 3.5SP1 (Windows 8 only)

By default, the .NET framework 3.5SP1 is not installed on Windows 8 (already

preinstalled on Windows 7).

In Control Panel, choose Programs and Features, choose Turn Windows features on or

off, and then select the .NET Framework 3.5 (includes .NET 2.0 and 3.0) check box.

This option requires an Internet connection. You do not need to select the child items.

For more information follow the link below:

http://msdn.microsoft.com/en-us/library/hh506443.aspx

http://msdn.microsoft.com/en-us/library/hh506443.aspx





7 (22)

4.2 Installation QRM Web Service

The QRM Web Service is a background Windows Service that is installed by a

standard installer. This is a 32-bit windows service that is used on both 32-bit and 64-

bit operating systems. The purpose of the QRM Web Service is to receive XML

ATML test data and store the data in the database and/or forward XML ATML test

data to another QRM Web Service. It is recommended to use a multicore computer,

since performance is increase by parallel processing of the XML results.

1. Browse to <Install Path>\QRM\QRM Web Service\<version>. Right-

click on the setup.exe and select Run as administrator.

2. Click Next.





8 (22)

3. Click Next.

4. Click Next. Installation is complete. If there is any error messages regarding

timeout, just ignore these. Reboot if prompt.

5. Test the QRM Web Service by opening the following URL in your web

browser: http://localhost:8080/QRMResult/Info

It should look like the picture below.

6. Done!

http://localhost:8080/QRMResult/Info





9 (22)

4.3 Configuring Forwarding to Test Server

In order to make the QRM Web Service forward the generated ATML reports to the

addq4.se test server where it will be stored in a database and available to view in the

QRM Web Application.

1. Open the QRM Web Service configuration file:

C:\Users\Public\Documents\QRM\QRMWebServiceConfig.ini

2. Change the following key as shown below:

ForwardingActive=TRUE

3. Restart the QRM Web Service by entering the following URL in your web

browser:

http://localhost:8080/QRMResult/shutdown

Enter username qrmuser and password qrm123! when prompt.

4. Press the Start button and then the Info button.

http://localhost:8080/QRMResult/shutdown




Mattias Ericsson 4-100-203 10

(22)

10 (22)

5. Scroll down on the info start page to the field Forwarding. It should state

TRUE http://addq4.se:8080/QRMResult as shown below.

6. Done. Your QRM Web Service is now forwarding ATML reports to

addq4.se:8080 as shown in Figure 1.

Your LabVIEW QRM client will post ATML results to

localhost:8080/qrmresult and the QRM Web Service will forward them to

addq4.se.

Please note that all test results that are posted to addq4.se test server is public

to everyone and all stored data will be destroyed each night and the database

recreated.

5 View Results in QRM Web Application

Test results in QRM are available from a web browser. You can view your test results

for evaluation purpose at:

http://addq4.se/qrm

Login with the following user:

Username: TestUser

Password: qrm123!

http://addq4.se/qrm





(22)

11 (22)

Please notice that the QRM database at addq4.se will be recycled every night and all

data will be lost. There is some example data always available in database as well.

To just view your test results do the following simple steps:

1. Click Test Results tab and then the Execute button.

2. Expand any of the dates by clicking on them. The available result sets will be

shown.

3. Click any of the result sets to view the individual UUT test results.





(22)

12 (22)

Figure 2. The QRM Web Application at the demo test server at addq4.se/qrm

Please refer to reference [3] QRM Web Application Manual how to use the QRM

Web Application in full.

Figure 3. Example data in the QRM Web Application at addq4.se/qrm.





(22)

13 (22)

6 LabVIEW QRMClient

6.1 Requirements

LabVIEW 2010 or later.

QRM Web Service installed as described in section 4.2.

.NET Framework 3.5

No license is required for the LabVIEW QRM Client, but QRM Web Service requires

an activated license in order to enable database storage and forwarding (only

forwarding to the addq4.se test server is allowed).

6.2 Installation

The LabVIEW QRMClient is distributed as VIPM package and is available from

LabVIEW 2010 or later.

The package name is: addq_lib_qrmclient-<ver>.vip

This installs into the following locations:

<LabVIEW>\vi.lib\addons\_AddQ\QRMClient

<LabVIEW>\examples\AddQ\QRMClient

<LabVIEW>\examples\exbins\AddQ_QRMClient.bin3

<LabVIEW>\help\AddQ_QRMClient_Help.vi

<LabVIEW>\help\_AddQ\QRM LabVIEW Client 4-100-203.pdf (This document)

<LabVIEW>\project\errors\AddQ_QRM-errors.txt

Figure 4. QRMClient VIPM Package installation.





(22)

14 (22)

There is a QRM menu installed with all available VIs in the tool kit as shown in

Figure 5. To understand how to use the QRM Client VIs, please refer to the installed

example VIs. Open the NI Example Finder and search for qrm as shown in Figure 6.

Figure 5. QRMClient menu installed in the Addons->QRM

6.3 Examples

Figure 6. QRM Examples in the LabVIEW NI Example Finder.

Example 1 is the simplest QRM example. It stores the minimum information required:

Operator, Station, UUT type and UUT Serial along with some dummy fixed results.

Figure 7 shows the LabVIEW code and Figure 8 what it looks like in the QRM Web

Application. Select the Test Results tab and press Execute to fetch the results.





(22)

15 (22)

Figure 7. Example 1 - The simplest possible QRM storage.

Figure 8. Example 1 as it is shown in the QRM Web Application. Select the Test Results tab and

press Execute to fetch the results.

Example 5 is a more advance example using loops to generate some results for a

number of UUTs. Figure 9 shows the LabVIEW code and Figure 10 what it looks like

in QRM Web Application.





(22)

16 (22)

Figure 9. Example 5 - Typical application. Loops are used to generate random QRM results.

Figure 10. Example 5 - Typical Application shown in the QRM Web Application.





(22)

17 (22)

6.4 Result Types

QRMClient have the following result types:

Result Set – main result container. There must be one and only one for each

posted result. There are four required inputs: Outcome, result set name, array

of Result Groups and Start Date Time. A Result Group can be a Test Group,

Session Action or Test.

Session Action – not actually a test, only a outcome Done or Abort. Compare

to a TestStand Action Step. There are two required inputs: Outcome and name.

TestGroup – a grouping container of Test Group, Session Action or Test. The

purpose of this step is to group results into a hierarchy. There are three

required inputs: Outcome, items and name. The items can be Test Group,

Session Action or Test. Compare to a TestStand subsequence.





(22)

18 (22)

Test – the actual test that contains one or more measurements called Test

Result. There are three required inputs: outcome, name, test results

Test Result – the actual measurement that is part of a Test. There are three

required inputs: Outcome, name and value.

Figure 11 shows Example 2 that demonstrates how test groups can organize results

into groups. Figure 12 shows what it looks like in the QRM Web Application.

Figure 11. Example 2 – Test Groups. This shows how results can be grouped together using test

groups in different levels.





(22)

19 (22)

Figure 12. Example 2 - Test Groups. This is shows the QRM result hierarchy quite well.

6.5 Attachments

QRM is able to manage attachment files to be sent along with the ATML result set.

The result set will contain a reference to the attached file. Attachment can be stored as

file that will be stored in a location on the same server as the database or stored as a

binary in the database itself. It is strongly recommended to store attachment as file

and not as a binary in the database. Figure 13 shows the LabVIEW example and

Figure 14 shows how attachments are treated in the QRM Web Application. If the file

is an image (jpg, bmp, gif) or text file (txt) it will be opened and displayed in a new

tab, else downloaded as a regular web browser download.

Figure 13. Example 3 – Attachments. Additional result files can be sent along with the result set.

Figure 14. Example 3 with attachments. Note that the attachment will be shown as a link in the

web application.





(22)

20 (22)

6.6 Issues to Consider

There are a few things to consider that will improve the use of QRM.

1. Outcome is not generated automatically. You have to set outcome correctly,

even though you enter minimum and maximum requirement among with the

measurement value, you still need to set correct outcome in your code. QRM

just views whatever you input.

2. Make sure you set the comparator (GELE, LE, GE, EQ) of your requirements

correctly. If you don’t have a requirement and just want to add the

measurement, use the outcome N/A.

3. Make sure you use a good result set name. Result set names are very good for

grouping result sets together like a couple of UUTs executed in the same test

sequence. Example 5 automatically creates a new result set name for all the

UUTs that are executed at the same time. With a good result set name,

statistics and presentation will be much better in the QRM web application.

4. Use quite short result names and result group names. Make sure you setup

QRM web application and check what it looks like in the QRM web

application.

5. Make sure to use correct data types. Numeric results should use INT or DBL

and Booleans as BOOL. The QRM Client VIs has variants as inputs and

senses the data type automatically.

6. Use Unit for numeric values if possible.

7. Avoid storing binary data or large arrays and graph. This will consume a lot of

database space. For graphs, it is much better to store an image of the graph as

a picture file to send as attachment or if raw data is needed, store the data in a

file and post along as an attachment instead.

8. There are many ways you can organize your results in a hierarchy. Make sure

you carefully analyze what the best naming and result hierarchy will be for

your system.





(22)

21 (22)

6.7 Error Codes

The QRM Client uses error codes in the range 402700-402719.

Error Code Definition

402700 Unknown error!

402701 Input 'reference' is required and may not be empty

402702 Input 'session action' is required and may not be empty

402703 Input 'test method' is required and may not be empty

402704 Input 'test' is required and may not be empty

402705 Input 'test result' is required and may not be empty

402706 Input 'operator' is required and may not be empty

402707 Input 'test description' is required and may not be empty

402708 Input 'test program' is required and may not be empty

402709 Input 'equipment' is required and may not be empty

402710 Input 'test station' is required and may not be empty

402711 Input 'pre test repairs' is required and may not be empty

402712 Input 'uut' is required and may not be empty

402713 Input 'parameter' is required and may not be empty

402714 Input 'attachment' is required and may not be empty

402715 HTTP post error. There was a problem posting the results to the

QRM Web Service.

402716 Cannot convert parameter value for parameter to string or

double. It is not a supported type.

402717 Missing info for item(s). This info is required to make a valid

ATML file.

402718 ATML validation failed!

402719 Info already set! Table 1. QRM Client error codes.





(22)

22 (22)

7 Support If you have questions, please post them at the QRM Community:

https://decibel.ni.com/content/groups/qrm

If you don’t have access to the community, please click Ask to join this group. For

any question, feel free to contact AddQ support at: [email protected]

8 Troubleshooting There are few things to check if you have problems with your LabVIEW QRM Client.

Problem Solution

Can’t post results to QRM Make sure that you can reach the

connection URL. It is strongly

recommended to install a QRM Web

Service at the same machine as the QRM

Client.

QRM Web Service doesn’t start Make sure .NET 3.5 is installed

(Windows 8) and also try to reboot your

computer.

For other problems, please refer to the troubleshooting section in reference [2] QRM

Windows Installation Guide.

https://decibel.ni.com/content/groups/qrm
