Vynamic™ View Reporting API 5.2.

4
Reference Manual
Version 1.0, 23.1.2020
Table of Contents
1. The Vynamic™ View Reporting API ....................................... 3
1.1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.1. Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.2. Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.3. Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3. Architecture ................................................................. 5
1.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.2. Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2. Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1. Creating an ODBC Database Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2. Creating a New report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.2.1. Creating a New Database Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.2.2. Creating a New Query. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.3. Editing an Existing Report Template ...................................... 19
2.3.1. Editing the SQL Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.3.2. Saving a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.4. Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.4.1. Automatic Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.4.2. User-Defined Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
[Link]. User-Defined Parameter "outputformat" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.4.3. Language-Dependent Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3. Integrating Reports into Vynamic™ View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.1. Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.2. Enabling Reports in the Vynamic™ View Server. . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.3. Configuring a Report Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.3.1. General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.3.2. Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.3.3. Language-Dependent Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.4. Configuring Reports in the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.4.1. Specifying an Individual Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.4.2. Activating the Individual Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
[Link]. Granting User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
[Link]. Extending the Device Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4. Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.1. Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.2. Creating a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.2.1. Specifying the Database Query. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.2.2. Designing the Report Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
 4.3. Configuring the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.4. Configuring the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.4.1. Specifying an Individual Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.4.2. Editing a User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
4.4.3. Editing a Device Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.5. Configuring Functions Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
4.6. Restarting the Vynamic™ View Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.7. Executing the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
 Preface

Trademark Rights
Almost all hardware and software names contained in this document are also registered trademarks
of their respective product owners and should be treated as such. Diebold Nixdorf has, in the main,
followed the manufacturers' spelling for product names.

Confidentiality Undertaking
Copyright © Diebold Nixdorf, Inc. (2019) – All rights reserved - The contents of this document may
not be reproduced, exploited or published, whether in whole or in part, without the prior written
permission of Diebold Nixdorf. This also includes translation into other languages. The copyright
applies to all forms of storage and reproduction in which this information is incorporated including,
but not limited to, magnetic memory, computer printouts and visual displays. Offenders will be liable
for damages.

All rights, including rights created by patent grant or registration of a utility model or design, are
reserved. Right of technical modifications reserved.

Names and Other Data

The names, e-mail addresses, telephone numbers and other data used in this document are purely
fictional (except the e-mail addresses listed below to return feedback to this document). Any
resemblance to actual persons, living or dead, is coincidental.

Technical Support
In case of questions or problems related to all Diebold Nixdorf Software products you should open a
ticket via iSupport: [Link]

If you do not have access to iSupport, please use the live chat to contact a DN Help desk for
immediate assistance ([Link]

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 1

Preface

Related Documents
This section lists documents containing further information about Vynamic™ View and Vynamic™
View Incident Manager, including:

• Vynamic™ View Operation Manual

• Vynamic™ View Incident Manager User Manual
• Vynamic™ View ProAgent Windows API Reference Manual
• Vynamic™ View Reporting API
• PC/E Security Suite User Manual and Operation Manual

2 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 1.1. Introduction

1. The Vynamic™ View Reporting API

Vynamic™ View (formerly named ProView) is a part of Diebold Nixdorf’s
Vynamic™ Software. In version 5.1, the product was rebranded to reflect the new
 name Vynamic™ View and also the corporate Vynamic™ Design. In some
technical parts such as server path names, registry or file names ProView stays.
In the version 5.0 and prior the product is still named ProView.

This chapter describes the pre-requisites for using the Vynamic™ View Reporting Application
Programming Interface (API). The API is designed for creating reports on the monitored network
using the report generator BusinessObjects Crystal Reports XI Release 2 or BusinessObjects Crystal
Reports 2008, further on referenced to as Crystal Reports. This chapter contains the following
sections:

• Introduction
• Prerequisites
• Architecture

1.1. Introduction
The functionality of Vynamic™ View can be extended by adding individual menus and functions to the
Vynamic™ View Console. Besides other functions, reports on the complete monitored network, on
sub-networks, and on devices can be added.

The reports delivered with Vynamic™ View are designed to show you some of the capabilities of
Vynamic™ View for analysis and statistics.

However, you may want to change these reports to fit the requirements of your organization, or you
may want to create your own reports from scratch. This can be achieved using the Crystal
Reports Designer.

After you have created a report template with the Crystal Reports Designer, you have to
integrate the template into Vynamic™ View, which means you need to make the report template
known to both the Vynamic™ View Server and to the Vynamic™ View Console. These steps are
described in the following chapters.

Restrictions
Reports are a powerful tool for analyzing, abstracting, and presenting your data.
However, you should keep in mind that reports can decrease the performance of the
monitoring system when used on a large amount of data.

 In order to keep the additional workload of reports as small as possible, you should
never work directly on the database tables, especially not on eventrelated tables.
Instead, you should work with views that collect your required data

Last but not least, please keep in mind that Vynamic™ View is not designed as a
data mining tool, but as a monitoring system.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 3

1.2. Prerequisites

1.2. Prerequisites
1.2.1. Hardware
The hardware requirements are described in the Vynamic™ View Operation Manual in chapter
System Requirements.

1.2.2. Software
The software requirements are described in the Vynamic™ View Operation Manual in chapter System
Requirements.

Licence required

 Please note that you need to obtain a license for Crystal Reports.
Otherwise, you will not be able to create or modify any report template.

1.2.3. Installation
The installation is described in the Vynamic™ View Operation Manual in chapter System
Installation.

4 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 1.3. Architecture

1.3. Architecture
1.3.1. Overview
The following image shows the global architecture of the Vynamic™ View reporting system:

Figure 1. Architecture of the Vynamic™ View reporting system

As mentioned before, you create a report template with the Crystal Reports Designer. The data
that is used for creating a report is stored in the Vynamic™ View database. However, you can collect
data from any source, as long as Crystal Reports supports that source.

After the report template has been created you add information about the new report to the
Functions Managers registry on the Vynamic™ View Server. If reporting has not been
configured before, you also activate the Crystal Reports function provider for the Functions
Manager.

Next, you specify a new individual function for the report with the Vynamic™ View Console. The
individual function has to be added to all device profiles and to all user profiles for which the report
should be available.

Finally, the reports can by displayed using the Vynamic™ View Console.

1.3.2. Workflow
After the process of creating the report and configuring Vynamic™ View has been finished, the
workflow is as follows:

1. A user executes the individual function in the Vynamic™ View Console.

2. The Vynamic™ View Console sends a request to the Functions Manager.
3. The Functions Manager passes the request to the Crystal Reports function provider.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 5

1.3. Architecture
4. The Crystal Reports function provider loads the report template and executes it.
5. The Crystal Reports function provider generates the output file in the requested format, for
example as a PDF file.
6. The Functions Manager transfers the output file to the Vynamic™ View Console.
7. The Vynamic™ View Console displays the output file to the user:

Figure 2. Example of a report

6 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.1. Creating an ODBC Database Connection

2. Report Templates
This chapter describes how you can create and edit report templates with the Crystal Reports
Designer.
It contains the following sections:

• Creating an ODBC Database Connection

• Creating a New Report Template
• Editing an Existing Report Template
• Parameters

2.1. Creating an ODBC Database Connection

Since the Crystal Reports Designer requires a working database connection, you need to
configure such a connection prior to using it.

No ODBC connection necessary

If you are using this on the computer where the Vynamic™ View Server or the
 Vynamic™ View Console is installed, a suitable ODBC connection already exists
for these applications.
Therefore you do not need to create another ODBC connection.

If you want to use an ODBC connection for accessing the Vynamic™ View database, configure the
connection in Windows:

1. Click on Start  Settings  Control Panel  Administrative Tools  Data

Sources (ODBC) to open the ODBC configuration dialog:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 7

2.1. Creating an ODBC Database Connection

Figure 3. ODBC configuration dialog

2. Click on User DSN or System DSN, depending on the type of ODBC connection you want to
create (see help text in the ODBC configuration dialog).
3. Click on [Add…] to open the driver selection dialog:

Figure 4. Driver selection dialog

4. Select the appropriate database driver from the list, for example "SQL Server" if you want to
connect to a Microsoft SQL Server database.
5. Click on [Finish] to open the first connection properties dialog:

8 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.1. Creating an ODBC Database Connection

Figure 5. First connection properties dialog

6. Enter the logical Name for your ODBC connection into the Name field, for example "vynamic_view".
7. Select the database server’s computer Name from the Server list, or enter it into the field, for
example "dbserver".
8. Click on [Next] to open the second connection properties dialog:

Figure 6. Second connection properties dialog

9. Depending on your security policies, select the authentication method for the database server, for
example "…SQL Server authentication…".

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 9

2.1. Creating an ODBC Database Connection
10. Depending on your selection above you may have to enter a database user Name into the Login
ID field (for example "vynamic_view") and the user’s password into the Password field (for
example "1pizza2go").
11. Click on [Next] to open the third connection properties dialog:

Figure 7. Third connection properties dialog

12. If more than one database exists in the database system (which is very likely), activate the
Change the default database to option and enter the Name of the database into the text field, for
example "vynamic_view".
13. Click on [Next] to open the fourth connection properties dialog:

10 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.1. Creating an ODBC Database Connection

Figure 8. Fourth connection properties dialog

14. Normally you simply have to click on [Finish] in this dialog. However, if your database system
requires special options, ask your database administrator which options you should activate.
15. After you have closed the last connection properties dialog, a summary dialog is displayed:

Figure 9. Last connection properties dialog

16. Click on [Test Data Source…] to test the connection.

17. Close all open dialogs by clicking on [OK].

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 11

2.2. Creating a New report Template
The ODBC connection is now configured and working properly.

2.2. Creating a New report Template

This section describes the general steps you need to perform for creating a new report template.
Please note that this description cannot replace the description in the Crystal Reports user
manual on how to use the program.

2.2.1. Creating a New Database Connection

1. Click on Start  Programs  BusinessObjects XI Release 2 (or 2008) 
Crystal Reports  Crystal Reports XI Release 2 (or 2008) to start the
Crystal Reports Designer.
2. Click on the menu entry File  New  Standard Report… to open the wizard for creating a
new report template:

Figure 10. Creation Wizard dialog

3. Expand the Create New Connection branch in the Available Data Sources box. A list
of available database drivers is displayed.
4. Expand the database driver branch that you need to connect to your Vynamic™ View database.
In most cases the ODBC (RDO) driver is the correct one:

12 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.2. Creating a New report Template

Figure 11. Creation Wizard dialog 2

5. A dialog box displayed where you can enter the required connection information. For the ODBC
(RDO) driver, a data source selection dialog is displayed:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 13

2.2. Creating a New report Template

Figure 12. Connection information dialog

6. Select the correct Vynamic™ View database connection from the Data Source Name (DSN) list,
for example "vynamic_view".
Remember that you have to configure the DSN you want to use before you start the creation
wizard (see section Creating an ODBC Database Connection).
7. Click on [Next] to open the connection information dialog:

14 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.2. Creating a New report Template

Figure 13. Connection information dialog 2

8. Depending on your security policies, either activate the Trusted Connection option or not.
9. Depending on your selection above you may have to enter a database user name into the User
ID field (for example "vynamic_view") and the user’s password into the Password field (for
example "1pizza2go").
10. For any connection type, select the database you want to connect to. Normally this is the
database that you already have specified in the ODBC connection configuration, for example
"vynamic_view".
11. Click on [Finish] to close the dialog. The new database connection is now configured and
displayed under the ODBC (RDO) driver branch.
12. If you expand the database driver branch, the newly created connection, and the database
specified for the connection, you should see a dialog similar to this one:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 15

2.2. Creating a New report Template

Figure 14. Connection information dialog 2

You can now continue with creating a new database query. This is described in the next section.

2.2.2. Creating a New Query

The graphical query builder

You can create your query using the graphical query builder. However, this tool
 creates a query that is strongly related to the selected database.
Therefore this section describes how to create the query manually, in order to be
more flexible when copied to another Vynamic™ View installation.

13. In the database connection branch, double-click on Add Command to create a new database
query. The Add Command dialog is displayed:

16 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.2. Creating a New report Template

Figure 15. Add command to Report dialog

14. Enter a valid SQL query command into the left text field, for example the command in the image
above. If you want to insert variable parameters into the SQL command, follow these steps:
a. Click on [Create…] to open a Command Parameter dialog:

Figure 16. Add command to Report dialog 2

b. Enter the parameter ID into the Parameter Name field, for example "startdate".
c. Enter an optional text that should be displayed in the Crystal Reports Designer’s preview

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 17

2.2. Creating a New report Template
window into the Prompting Text field, for example "Start Date".
d. Select the parameter type from the Value Type list box, for example "Date".
e. Enter an optional default value that should be displayed in the Crystal Reports Designer’s
preview window into the Prompting Text field, for example "1/1/2009".
f. Click on [OK] to save the parameter.
g. Repeat steps ’a’ to ’f’ until you have defined all required parameters.
h. To insert a parameter into the SQL command, put the cursor to the correct location and double-
click on the Parameter Name. The parameter is inserted and represented by the string
"{?<parameter_name>}".

15. After you have finished entering the SQL command, click on [OK] to save it.
The new query is now executed immediately to verify its syntax. Therefore it is required that you
enter example values for the parameters:

Figure 17. Enter Values dialog

16. The image above shows a query containing the two parameters "startdate" and "enddate". Either
select the default value from each list box, or enter a valid value for each parameter. Please note
that the Crystal Reports Designer automatically sorts the parameters by their names. In
the example, this leads to the effect that you have to enter the end date prior to the start date.
17. Click on [OK] to execute the query. If your SQL command is correct, the dialog is closed and you
see the Report Creation wizard again. If an error occurred during the query, an error box is
displayed and you see the Add Command dialog again. In this case, please correct your input and
try again.
18. When everything is working correctly, close all open dialogs by clicking on [Finish] or [OK].
19. Click on the menu entry File  Save to save your new report template.

18 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.3. Editing an Existing Report Template
You can now edit the new report template in the Crystal Reports Designer as described in
section Editing an Existing Report Template.

2.3. Editing an Existing Report Template

This section describes the general steps you need to perform for editing an existing report template.
Please note that this description cannot replace the description in the Crystal Reports user
manual on how to use the program.

2.3.1. Editing the SQL Command

1. In the Crystal Reports Designer, open your report template.
2. Click on the menu entry Database  Database expert…:

Figure 18. Database Expert

3. Right-click on the desired command in the Selected Tables list box. A context menu is
displayed.
4. Click on Edit Command. If you have not connected to your database system yet, you need to
enter your database login in the dialog.
5. The Modify Command dialog is displayed, which you can use similar to the Add Command
dialog (see section Creating a New Query) to edit your SQL command and its parameters.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 19

2.4. Parameters

2.3.2. Saving a Report Template

All report templates that should be available in Vynamic™ View have to be saved on the computer
where the Vynamic™ View Server is installed.
They are located in the folder :

<ProgramData>\Wincor Nixdorf\Data\Reports\Templates

for example in :

C:\ProgramData\DieboldNixdorf\{productname}\DATA\Reports\Templates

2.4. Parameters
A report normally contains both static texts and variable fields. Variable fields are filled either with
data from the SQL query or with parameter values provided by Vynamic™ View. The following
sections describe the three different types of parameters provided by Vynamic™ View.

Generally, the easiest way for viewing or editing parameters in the Crystal Reports Designer is
the Field Explorer:

Figure 19. The Crystal Reports Designer Field Explorer

20 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.4. Parameters


Please refer to the [Crystal Reports User Manual] for instructions about the Field
Explorer.

2.4.1. Automatic Parameters

A user at a Vynamic™ View Console can issue reports for the complete network, for a sub-
network, for a group of devices, or for a single device. Depending on the type of report, Vynamic™
View automatically includes several parameters in the report command:

• devicename
If a report is issued for a single device, the parameter "devicename" contains the name of the
device, for example "MT_AIR_CRS_01".
• hierlevel
If a report is issued for a sub-network, the parameter "hierlevel" contains the hierarchy level
number of the sub-network, for example "0.1.1".
• language
The parameter "language" contains the four-digit country code of the preferred language, for
example "0049" for "German". You can find the complete list of supported languages in the
[Operation Manual] in section National Language Support (NLS).
• network
If a report is issued for a sub-network, the parameter "network" contains the name of the sub-
network, for example "Airport".
• devicelongname
If a report is issued for a group of devices, the parameter "devicelongname" contains the name of
the group; if a report is issued for devices in a hierarchy, the"devicelongname" contains the name
of the hierarchy, for exmaple "Lanneret Bank".
• hiercond
If a report is issued for a sub-network, the parameter "hiercond" contains a part of a WHERE
clause to limit the result within the selected hierarchy, for example "[Link] = '0.1.1' or
[Link] like '0.1.1.%'".
• groupcond
If a report is issued for a group of devices, the parameter "groupcond" contains a part of a WHERE
clause to limit the result within the selected group, for example :

[Link] IN ( SELECT deviceid FROM viewDynamicGroup WHERE groupid = 1

).

Limitation on reports with "Hierarchy/Group" context

The two parameters, "hiercond" and "groupcond", are supposed to be used at the
same time for reports with the context "Hierarchy/Group".
 And in run time, only one parameter takes effect and the other is set to an empty
string.
The conditions require that the table "device" must be referred as alias "d".
Please refer to the standard released templates when creating a new one.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 21

2.4. Parameters

2.4.2. User-Defined Parameters

You can specify your own parameters which can be used in reports. These parameters have to be
configured in the Vynamic™ View server as described in section Parameter Configuration and in
the Vynamic™ View Console as described in section Specifying an Individual Function.

A user at a Vynamic™ View Console has to enter values for the user-defined parameters in an
input dialog prior to generating the report.

Unicode parameter names

 Please do not use unicode (MBCS) parameter names, but only names in the ASCII
character set. This makes error analysis and support much easier.

[Link]. User-Defined Parameter "outputformat"

The user-defined parameter "outputformat" contains information about the document format of the
generated report output file, for example "PDF" or "XLS".

As described in the previous section, you need to configure this parameter in the Vynamic™ View
Server and in the Vynamic™ View Console. The type of the parameter has to be "list":

The list entries have to be as follows (in capital letters):

• CSV
Comma-Separated Values. You need a spreadsheet program for displaying this format, for
example Microsoft Excel or OpenOffice Calc.
• DOC
Microsoft Word Document. You need a word processing program for displaying this format,
for example Microsoft Word or OpenOffice Writer.
• PDF
Portable Document Format. You need the Adobe Acrobat Reader 8.0 or newer for
displaying this format.
• RTF
Rich Text Format. You need a word processing program for displaying this format, for example
Microsoft Word or OpenOffice Writer.
• TXT
Text Document. You need a text editing program for displaying this format, for example
Microsoft Notepad. Please note that this format cannot be used for displaying diagrams and
other graphics. Therefore the output may contain less information compared to the other output
formats.
• XLS
Microsoft Excel Sheet. You need a spreadsheet program for displaying this format, for
example Microsoft Excel or OpenOffice Calc.


Of course you can omit list entries that your applications do not support or that you
do not want the users to be able to select.

22 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 2.4. Parameters

2.4.3. Language-Dependent Parameters


You only need to specify language-dependent parameters if your report should
support more than one language.

The syntax of a language-dependent parameter name is :

<Parameter name>@@<Message number>@

Whenever Vynamic™ View detects a parameter formatted in the syntax above, it tries to find it in the
Vynamic™ View database table "message<nnnn>", where "<nnnn>" represents a four-digit country
code of the preferred language, for example "0049" for "German" (you can find the complete list of
supported languages in the Vynamic™ View Operation Manual in section National Language
Support (NLS)).

Vynamic™ View looks for an entry in the corresponding message table where the field "textno"
equals the "<Message number>" of the parameter name, and where the field "texttype" matches the
value "11", which stands for "report text". The messages have to be configured in the Vynamic™
View database as described in section Specifying an Individual Function.

Unicode parameter names

 Please do not use unicode (MBCS) parameter names, but only names in the ASCII
character set. This makes error analysis and support much easier.

Example 1. Language-Dependent Parameters

Your system language is set to "English", and you have specified the language-dependent
parameter "conn_time@@1296@".

Vynamic™ View detects the parameter and searches the database: "select messagetext from
message0001 where textno = 1296 and texttype= 11". This returns the text "Effective
Connection Time".

Vynamic™ View replaces the parameter "conn_time@@1296@" in the report with the text
"Effective Connection Time".

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 23

3.1. Overview

3. Integrating Reports into Vynamic™ View

This chapter describes how you can configure Vynamic™ View for using the report templates.

It contains the following sections:

• Overview
• Enabling Reports in the Vynamic™ View Server
• Configuring a Report Function
• Configuring Reports in the Console

3.1. Overview
The general procedure for enabling reporting in Vynamic™ View is as follows:

1. Enable the reporting component for the Vynamic™ ViewSever in the Vynamic™ View registry.
This is described in section Enabling Reports in the Vynamic™ View Server.
2. Configure every report as individual function in the Vynamic™ View registry. This is described in
section Configuring a Report Function.
3. Configure every individual report function in the Vynamic™ View Console. This is described in
section Specifying an Individual Function.
4. Assign individual report functions to the user profiles in the Vynamic™ View Console. This is
described in section Granting User Permissions.
5. Assign individual report functions to the device profiles in the Vynamic™ View Console. This
is described in section Extending the Device Profile.

After you have finished integrating and configuring the reports, be sure to restart
 the Vynamic™ View Service in order for the changes to take effect.

3.2. Enabling Reports in the Vynamic™ View Server

Normally the Vynamic™ View Server installation program enables the reporting feature. But the
user can insert or change several entries in the Functions Manager branch of the Vynamic™
View registry. This includes the sample reports delivered with the Vynamic™ View Server.

24 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 3.2. Enabling Reports in the Vynamic™ View Server
Example 2. Following is an extract of a report-enabled registry

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider]
"UseCmdCrystalReport"="Y"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport]
"ReportTargetPath"="C:\ProgramData\Diebold Nixdorf\Vynamic View\Data\Reports\Output"
"ReportTemplatePath"="C:\ProgramData\Diebold Nixdorf\Vynamic
View\Data\Reports\Templates"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\200
]
"ReportName"="[Link]"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\200
\Parameters\1]
"value"="startdate"
"type"="2"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\200
\Parameters\2]
"value"="enddate"
"type"="7"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\200
\Parameters\3]
"type"="4"
"value"="outputformat"

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 25

3.3. Configuring a Report Function

3.3. Configuring a Report Function

3.3.1. General Configuration
Besides the global enabling, which can be done with the Vynamic™ View Server installation
program, you also have to add your created reports to the registry.

Every report entry consists of a unique function number (specified by yourself) and a number of
optional parameters. The function number is located in the registry key :

[HKLM\Software\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\F
unctions]:

Parameter Name
Range Default Meaning Vers. D C
<Function number>
1000-9999 - Number of the individual report function. 3.2/00 1 Y
The numbers from 1 to 999 are reserved
for internal use.

 Vers.: Introduced in version; D: Dependencies; C: Customizable

Dependencies:

• The function number of the report has to be unique in Vynamic™ View and has to correspond to
the function number specified in the Vynamic™ View Console.

The report name is located in the registry key :

[HKLM\Software\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\F
unctions\<Function_number>]:

Parameter Name
Range Default Meaning Vers. D C
Report Name
Text - Name of the report template. 3.2/00 1 Y

 Vers.: Introduced in version; D: Dependencies; C: Customizable

Dependencies:

26 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 3.3. Configuring a Report Function
• The report name has to correspond to the name you have selected in the Crystal Reports
Designer for the report template.

3.3.2. Parameter Configuration

If your report requires parameters (see section Parameters), you have to specify one registry key for
every parameter, sequentially numbered from 1 to nn.

Parameter number requirements

 Every parameter number has to correspond to the parameter number specified in

the Console .

Every parameter is configured in the registry key

[HKLM\Software\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\F
unctions\<Function_number>\Parameters\<Parameter_number>]:

Parameter Name
Range Default Meaning Vers. D C
Type
1-7 - The parameter type. 3.2/00 - Y
Valid types are:

0: Text
1: Multi-byte text
2: Start date (time set to 00:00:00)
3: Date and time
4: List
5: Number
6: Static text
7: End date (time set to 23:59:59)
Value
Text - The parameter name. 3.2/00 1 Y

 Vers.: Introduced in version; D: Dependencies; C: Customizable

Dependencies:

• The parameter name has to correspond to the parameter name you have chosen in the report
template created with the Crystal Reports Designer.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 27

3.3. Configuring a Report Function
Example 3. Parameter Configuration

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\100
0]
"ReportName"="[Link]"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\100
0\Parameters\1]
"value"="startdate"
"type"="2"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\100
0\Parameters\2]
"value"="enddate"
"type"="7"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\100
0\Parameters\3]
"type"="4"
"value"="outputformat"

3.3.3. Language-Dependent Parameter Configuration

If your report requires language-dependent parameters (see section Language-Dependent
Parameters), you have to specify one database record for every parameter and every language that
should be supported.

To insert the texts for a language-dependent parameter, follow these steps:

1. Start an SQL tool that supports your database system, for example the Microsoft SQL Query
Analyzer or the Oracle SQL Developer.
2. Establish a connection to your Vynamic™ View database.
3. Enter the following SQL command for every language: insert into message<nnnn> (textno,
texttype, messagetext) values (<Number>, 11, '<Text>'); "<nnnn>" represents a four-digit country
code of the language, for example "0049" for "German" (you can find the complete list of
supported languages in the [Operation Manual] in section National Language Support
(NLS)).
"<Number>" represents the text number that has to match the number you have specified for your
language-dependent parameter.
"<Text>" represents the text that is displayed in the generated report.

28 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 3.4. Configuring Reports in the Console

Range of numbers
The text numbers 1 - 99,999 are reserved for internal use. Please use the text
numbers from 100,000 - 999,999 for your purposes.
 You also should never edit the internal texts, since they are adapted to the
Vynamic™ View sample reports and will be overwritten during the next Vynamic™
View update.

4. Execute the commands.

5. Exit the SQL tool
6. Restart the Vynamic™ View Service

Example 4. Parameter Configuration

Assumed you have specified the language-dependent parameter "devicenum@@120001@" and

want to insert the text "Number of Devices" in English and German into the Vynamic™ View
database.
The SQL commands to do this are :

insert into message0001 (textno, texttype, messagetext) values (120001, 11, 'Number of
Devices');

insert into message0049 (textno, texttype, messagetext) values (120001, 11, 'Anzahl der
Geräte');

3.4. Configuring Reports in the Console

3.4.1. Specifying an Individual Function
Configuring the required individual menus and functions is described in detail in the [Console User
Manual], section "Individual Functions". Here is a brief description of the required steps.

1. In the Console, Open the Customization Management Window  Open Perspective 

Customization  Individual Functions ….
2. Click on [New] and enter the function properties. Please ensure that the following requirements
are fulfilled:
◦ The function ID matches the function number you have configured in the Functions
Manager’s registry key (see section General Configuration). for example "1000".
◦ The option Function is executed on the server is activated.
◦ The parameter ID matches the parameter number you have configured in the Functions
Manager’s registry key (see section General Configuration). For example, the parameter ID
"1" in the Console matches the parameter number "1" in the Functions Manager’s
registry.
◦ The parameter type matches the parameter type you have configured in the Functions
Manager’s registry key (see section General Configuration). For example, the parameter
type "Text" in the Console matches the parameter type "0" in the Functions Manager’s

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 29

3.4. Configuring Reports in the Console
registry.
3. Click on [Save].

3.4.2. Activating the Individual Function

[Link]. Granting User Permissions

Users at the Vynamic™ View Console can only see the individual menus and functions if you
grant them the corresponding permissions. This procedure is described in detail in the `[User
Operation Manual], section "Edit Profiles").

Here is a brief description of the required steps:

1. In the Console, Open the Users Management Window  Open Perspective  Users….
2. Click on [Roles] and select the profile you want to change.
3. Enter the profile properties.
Please ensure that you select the newly created individual function to be included in the profile.
4. Click on [Save profile].

[Link]. Extending the Device Profile

If you have created a report that should appear in the detailed device view in the Vynamic™ View
Console, you have to extend every device profile that is affected. This procedure is described in
detail in the [User Operation Manual], section "Managing Device Profiles").

Here is a brief description of the required steps:

1. In the Console, Open the Resources Management Window  Open Perspective 

Resources…
2. Click on [Device profiles…] and select the profile you want to change.
3. Click on [Edit] and enter the profile properties.
Please ensure that you select the newly created individual function to be included in the profile.
4. Click on [Save].

30 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.1. Overview

4. Example
This chapter describes a complete example for a simple report.

It contains the following sections:

• Overview
• Creating a Report Template
• Configuring the Database
• Configuring the Console
• Configuring Functions Manager
• Restarting the Vynamic™ View Service
• Executing the Report

4.1. Overview
Suppose you want to create a report on the numbers of defined basedata for all devices in your
network, to see which device might need some more basedata.

The report should support the English and the German language, since your organization is located in
Valletta, Malta (English) and Frankfurt, Germany.

Follow the instructions in the next sections and you should get a report that fulfills your needs and
can be issued by all permitted users.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 31

4.2. Creating a Report Template

4.2. Creating a Report Template

4.2.1. Specifying the Database Query
1. Start the Crystal Reports Designer.
2. Click on the menu entry File  New  Standard Report… to open the Standard Report
Creation Wizard.
3. Double-click on Create New Connection to expand the branch.
4. Double-click on ODBC (RDO) to open the source selection dialog:

Figure 20. ODBC data source selection dialog

5. Double-click on the ODBC connection to the desired Vynamic™ View database.

The connection information dialog is displayed:

32 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.2. Creating a Report Template

Figure 21. ODBC connection information dialog

6. Enter the password for the database user, for example "1pizza2go".
7. Click on [finish] to close the dialog and return to the wizard:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 33

4.2. Creating a Report Template

Figure 22. Report wizard with defined database connection

8. Double-click on Add Command to open the command dialog:

Figure 23. Command dialog

9. Enter into the SQL query field:

34 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.2. Creating a Report Template

select id, count(id) as counter from basedata where id <> '1' group by
id;

10. Click on [OK], since the query does not require any input parameters. The report wizard should
now look like this:

Figure 24. Report wizard with defined database query

11. Click on [Finish] and continue with the steps described in the next section.

4.2.2. Designing the Report Layout

In the Crystal Reports Designer you now see a report preview page containing the current date
and the current page number.

1. Click on the Design tab to switch to the report design page:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 35

4.2. Creating a Report Template

Figure 25. Report design page

2. Click on View  Field Explorer to open the Field Explorer.

3. Double-click on Database Fields and on `Command to see the list of database parameters:

Figure 26. Field Explorer

4. Click on "id: String [16]", hold down the mouse button and drag/drop the parameter to the left side
of the report’s Details area.
5. Drag and drop the "counter: Number" parameter to the right side of the Details area. The design

36 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.2. Creating a Report Template
page should now look like this:

Figure 27. Report design page with inserted parameters

6. Note that the names of the parameters have been inserted additionally as text fields into the
Page Header area. Right-click on them and delete them, since you should insert language-
dependent parameters here.
7. Click on the separator line between the Page Header area and the Details area, hold down the
mouse button and expand the Page Header area a little bit.
8. Move the "Print Data" field to the top of the Page Header area.
9. Right-click on Parameter Fields in the Field Explorer and select New… from the context
menu.
10. Enter "head_device@@100000@" into the Name field. This adds the language-dependent
parameter "head_device" with the text number "100000" to the report (see section Language-
Dependent Parameters).
11. Click on [OK] to save the parameter.
12. Right-click on Parameter Fields in the Field Explorer and select New… from the context
menu.
13. Enter "head_basedata@@100001@" into the Name field. This adds the language-dependent
parameter "head_basedata" with the text number "100001" to the report (see section Language-
Dependent Parameters).
14. Click on [OK] to save the parameter. The Field Explorer should now look like this:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 37

4.2. Creating a Report Template

Figure 28. Field Explorer with language-dependent parameters

15. Drag and drop the "head_device@@100000@" parameter to the Page Header area, above the
"id" parameter in the Details area.
16. Drag and drop the "head_basedata@@100001@" parameter to the Page Header area, above the
"counter" parameter in the Details area.
17. Select both parameters and change the text to bold characters.
18. Create a horizontal line on the bottom of the Page Header area. The design page should now
look like this:

Figure 29. Formatted report design page

19. You may want to switch to the preview page to see the output of the report:

38 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.2. Creating a Report Template

Figure 30. Formatted report preview page

20. If you want to adjust the layout of the report, either format the fields directly on the preview page,
or switch back to the design page and format them there.
21. You may want to add a graphical representation of the basedata statistics to your report.
Use the features of the Crystal Reports Designer to add a chart to the Report Header or
the Report Footer area.
After the whole beautifying process has been completed, the report may look like this:

Figure 31. Formatted report preview page

22. Click on the menu entry File  Save to open the Save As dialog.
23. Select the target folder

<ProgramData>\Diebold_Nixdorf\Data\Reports\Templates

for example in

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 39

4.3. Configuring the Database

C:\ProgramData\Diebold_Nixdorf\{productname}\DATA\Reports\Templates

24. Enter "[Link]" into the File name field.

25. Continue with the steps described in the next section.

4.3. Configuring the Database

You have to add the language-dependent parameters to the Vynamic™ View database so that they
will be displayed in your report. You need an SQL tool to perform the steps described in this section.
For our example, we use the database-independent tool DbVisualizer. However, the general
workflow should be the same in every other tool.

1. Start the DbVisualizer.

2. Open the connection to your database.
3. Open the SQL Commander window.
4. Enter the following SQL commands for inserting the English and German texts for your report into
the command window:
insert into message0001 (textno, texttype, messagetext)
values (100000, 11, 'Device Name');
insert into message0001 (textno, texttype, messagetext)
values (100001, 11, 'Configured Basedata');
insert into message0049 (textno, texttype, messagetext)
values (100000, 11, 'Geraet');
insert into message0049 (textno, texttype, messagetext)
values (100001, 11, 'Konfigurierte Stammdaten');
5. Click on [Execute]. The SQL Commander window should now look like this:

40 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.4. Configuring the Console

Figure 32. SQL tool, result

6. Continue with the steps described in the next section.

4.4. Configuring the Console

In the Console you have to specify an individual function and assign it to an individual menu, as
described in section Specifying an Individual Function.

You also have to activate the individual function in the user profile and in the device profile, as
described in section Activating the Individual Function.

1. Start the Console.

2. Continue with the steps described in the next section.

4.4.1. Specifying an Individual Function

1. Open the Customization Management Window  Open Perspective  Customization.
2. Click on the Individual Functions area.
3. Right-click anywhere in the list box and select New Function from the context menu. The New
Individual Function wizard is displayed:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 41

4.4. Configuring the Console

Figure 33. Console, individual function

4. Enter "Reports: Defined basedata" into the Description field.

5. Click on the [Globe] button on the right side of the Function name list box. This opens a
window where you can define new function names.

42 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.4. Configuring the Console

Figure 34. Console, function name

6. Enter "Cash Statistics" into the English text field.

7. Enter "Stammdatenstatistik" into the German text field.
8. Click on [Finish] to save the entered text and return to the edit window for the new individual
function.
9. Select the entry "Reports" from the Icon list box. The icon is displayed on the right side of the list
box.
10. Select the entry "Report" from the Category list box
11. Activate the option Function is executed on the server.
12. Click on [Add] to specify the parameter "outputformat
13. The edit window for the new individual function now displays fields for specifying the new
parameter:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 43

4.4. Configuring the Console

Figure 35. Console, individual function, parameter details

14. Select the entry "Output Format" from the Name list box.
15. Select the entry "Please select an output format." from the Tooltip list box.
16. Select the entry "Value list" from the Type list box. The layout of the Parameter Details area
changes to let you specify the list entries:

44 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.4. Configuring the Console

Figure 36. Console, individual function, parameter details, value list

17. Click on [Add] to create a new list entry.

18. Select the entry "PDF" from the list box beneath the List entries table.
19. Enter the entry value "0" into the text field of the dialog.
20. Click on [Add] to create another list entry.
21. Select the entry "TXT" from the list box beneath the List entries table.
22. Enter the entry value "1" into the text field of the dialog.
23. Click on [Add] to create a third list entry.
24. Select the entry "XLS" from the list box beneath the List entries table.
25. Enter the entry value "2" into the text field of the dialog.
26. The edit window for the new individual function now should look like this:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 45

4.4. Configuring the Console

Figure 37. Console, completely defined individual function

27. Click on [Save] to store the definition in the Vynamic™ View database and the funcion ID will
be generated automatically; you can see the function ID for cash statistics is 2005:

46 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.4. Configuring the Console

Figure 38. Console, individual function ID

28. Continue with the steps described in the next section.

4.4.2. Editing a User Profile

The "Cash Statistics" report function has to be enabled for the users of the Vynamic™ View
Console:

1. Open the User Management Window  Open Perspective  Users

2. Select a profile, for example "test"
3. Switch to General tab and Click on [Pencil] to edit.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 47

4.4. Configuring the Console

Figure 39. Console, user profile

1. Select the newly created individual function "Cash Statistics" from the Individual server
functions list box.
2. Click on [Save profile] to store the definition in the Vynamic™ View database.
3. Repeat steps 1 to 5 for all user profiles you want to change.

4.4.3. Editing a Device Profile

Since the "Cash Statistics" report collects data from the complete network, you do not have to assign
it to the detailed device view of the Vynamic™ View Console.

Therefore, you do not have to edit the device profile to enable the individual function for devices.

48 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.5. Configuring Functions Manager

4.5. Configuring Functions Manager

1. Enable reporting with the Vynamic™ View Server installation program as described in section
Enabling Reports in the Vynamic™ View Server.
2. Click on Start  Run… and enter "regedit" into the Open field to start the Windows registry
editor.
3. Open the registry key

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystal-
Report\Functions]

The registry editor window should look like this:

Figure 40. Registory editor

4. Right-click on the "Functions" key and select New  Key from the context menu.
5. Enter "2005" as the new key name, it’s the function ID that is generated in console.
6. Right-click on the "2005" key and select New  String Value from the context menu.
7. Enter "ReportName" as the new value name.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 49

4.5. Configuring Functions Manager
8. Right-click on the "ReportName" value and select Modify from the context menu.
9. Enter "[Link]" into the Value data field. This is the name of the report template
that you have created in section TODO.
10. Right-click on the "2005" key and select New  Key from the context menu.
11. Enter "Parameters" as the new key name.
12. Right-click on the "Parameters" key and select New  Key from the context menu.
13. Enter "1" as the new key name.
14. Right-click on the "1" key and select New  String Value from the context menu.
15. Enter "type" as the new value name.
16. Right-click on the "type" value and select Modify from the context menu.
17. Enter "4" into the Value data field. This is the type of the record template parameter that you have
created in section TODO.
18. Right-click on the "1" key and select New  String Value from the context menu.
19. Enter "value" as the new value name.
20. Right-click on the "value" value and select Modify from the context menu.
21. Enter "outputformat" into the Value data field. This is the name of the record template
parameter that you have created in section TODO. The registry editor window should now look
like this:

Figure 41. Registory editor

22. Continue with the steps described in the next section.

50 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.6. Restarting the Vynamic™ View Service
Example 5. Configuring Functions Manager

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider]
"UseCmdCrystalReport"="Y"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport]
"ReportTargetPath"="C:\ProgramData\Diebold Nixdorf\Vynamic View\Data\Reports\Output"
"ReportTemplatePath"="C:\ProgramData\Diebold Nixdorf\Vynamic
View\Data\Reports\Templates"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\200
5]
"ReportName"="[Link]"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor
Nixdorf\Proview\CurrentVersion\Common\PVFUNC\Provider\CmdCrystalReport\Functions\200
5\Parameters\1]
"type"="4"
"value"="outputformat"

4.6. Restarting the Vynamic™ View Service

To activate the new report in the Functions Manager you have to stop and restart the Vynamic™
View Service:

1. Click on Start  Programs  Vynamic™ View  Stop Vynamic™ View Service. A

command shell window is displayed and the service is stopped:

Figure 42. Stopping the Vynamic™ View Service

2. Enter "exit" at the command prompt to close the command shell.

3. Click on Start  Programs  Vynamic™ View  Start Vynamic™ View Service.
A command shell window is displayed and the service is restarted:

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 51

4.7. Executing the Report

Figure 43. Restarting the Vynamic™ View Service

1. Enter "exit" at the command prompt to close the command shell.

2. Continue with the steps described in the next section.

Using a command Shell

 Starting and stopping the service is done in a command shell so that you can see
the result of these commands.

4.7. Executing the Report

1. Restart the Vynamic™ View Console.
2. Switch to Monitoring perspective and click on the menu entry Server  Execute
Individual Server Functions…
3. The Execute Individual Function window is displayed:

52 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.7. Executing the Report

Figure 44. Console, execute individual function window

1. Select "Cash statistics"report. An input dialog is displayed, showing the parameter that you have
defined for the individual function in the Console.

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 53

4.7. Executing the Report

Figure 45. Console, report input dialog

5. Select "PDF" from the Output Format list box to generate a PDF file.
6. Click on [Finish]. The report is now generated as described in section Workflow.
7. After the report has been generated and transferred to the Console, the output dialog is
displayed, showing the report:

54 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0

 4.7. Executing the Report

Figure 46. Console, report output dialog

Congratulations, you have successfully defined and generated your own report!

Doc. Version: 1.0 Vynamic™ View Reporting API - Reference Manual 55

Publisher

Publisher
Published by
Diebold Nixdorf Global Solutions B.V.
Papendorpseweg 100
3528 BJ Utrecht
The Netherlands
[Link]

All rights reserved, particularly in relation to the grant of a patent or the registration of a utility model.
Subject to availability and technical modifications.

Copyright © Diebold Nixdorf, Inc. (2019) – All rights reserved

56 Vynamic™ View Reporting API - Reference Manual Doc. Version: 1.0