APH - RTLS-Report-Client-V2 13 0 0 - 76

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 17

SIMATIC RTLS Report client

Introduction 1

Security recommendations 2

3
SIMATIC RTLS Functions in the menu bar

Reports 4
Localization systems
SIMATIC RTLS Report client

Application Manual

C79000-G8976-C658-01
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.

DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION
indicates that minor personal injury can result if proper precautions are not taken.

NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualified personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:

WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.

Siemens AG C79000-G8976-C658-01 Copyright © Siemens AG .


Digital Industries Ⓟ 01/2022 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents

1 Introduction ........................................................................................................................................... 5
2 Security recommendations .................................................................................................................... 9
3 Functions in the menu bar................................................................................................................... 13
4 Reports ................................................................................................................................................. 15
4.1 Reports .............................................................................................................................. 15
4.2 Setting changes ................................................................................................................. 16

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 3
Table of contents

SIMATIC RTLS Report client


4 Application Manual, , C79000-G8976-C658-01
Introduction 1
Purpose of this documentation
The document supports you during operation of the "SIMATIC RTLS Report client", which is a
component of the "SIMATIC RTLS Locating Manager" localization software.

Validity of this documentation


This documentation is valid for version 2.13.0.0 of the "SIMATIC RTLS Locating Manager".

Additional information
You can find additional information on the SIMATIC RTLS products mentioned in this
documentation in the Readme file or on the Siemens support pages.
Link: (https://support.industry.siemens.com/cs/en/en/ps/25277)

Trademarks
SIMATIC RTLS ® is a registered trademark of the Siemens AG.

Industry Online Support


In addition to the product documentation, the comprehensive online information platform of
Siemens Industry Online Support offers support at the following Internet address:
(https://support.industry.siemens.com/cs/us/en/)
Apart from news, there you will also find:
• Project information: Manuals, FAQs, downloads, application examples etc.
• Contacts, Technical Forum
• The option submitting a support query: (https://support.industry.siemens.com/My/us/en/)
• Our service offer:
Right across our products and systems, we provide numerous services that support you in
every phase of the life of your machine or system - from planning and implementation to
commissioning, through to maintenance and modernization.
You will find contact information on the Internet at the following address:
(https://www.automation.siemens.com/aspa_app/?ci=yes&lang=en)

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 5
Introduction

SITRAIN - Training for Industry


The training offer includes more than 300 courses on basic topics, extended knowledge and
special knowledge as well as advanced training for individual sectors - available at more than
130 locations. Courses can also be organized individually and held locally at your location.
You will find detailed information on the training curriculum and how to contact our
customer consultants at the following Internet address:
(https://new.siemens.com/global/en/products/services/industry/sitrain/personal.html)

RTLS Technology and Practice (ID-RTLS-TP)


Training and certification
After completing the RTLS certification training, you will be able to plan and implement small
and medium-sized RTLS projects and provide efficient and multifaceted support in large
projects. Your RTLS basics will be strengthened and, building upon them, you will receive
new tools of the trade in order to offer customers the optimal solution for them. The
complete project sequence is taken as a reference and important steps, resources and work
results for each phase are presented. Comprehensive practical exercises in connection with
troubleshooting techniques and a great deal of input from industrial projects allow you to
internalize a confident approach to working with different types of localization projects. With
the training documents, you also receive extensive reference material for your daily work.
Link: (https://www.sitrain-learning.siemens.com/EN/en/rw35251/Industrielle-Identifikation-
RTLS-Technologie-und-Praxis)

Security information
Siemens provides products and solutions with industrial security functions that support the
secure operation of plants, systems, machines, and networks.
In order to protect plants, systems, machines and networks against cyber threats, it is
necessary to implement – and continuously maintain – a holistic, state-of-the-art industrial
security concept. Siemens’ products and solutions form one element of such a concept.
Customers are responsible for preventing unauthorized access to their plants, systems,
machines and networks. These systems, machines and components should only be
connected to the enterprise network or the Internet if and only to the extent necessary and
with appropriate security measures (firewalls and/or network segmentation) in place.
You can find more information on protective measures in the area of industrial security by
visiting: (https://www.siemens.com/industrialsecurity).
Siemens’ products and solutions undergo continuous development to make them more
secure. Siemens strongly recommends performing product updates as soon as they are
available and using only the latest product versions. Use of product versions that are no
longer supported, and failure to apply latest updates may increase customer’s exposure to
cyber threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS
Feed under (https://www.siemens.com/industrialsecurity).

SIMATIC RTLS Report client


6 Application Manual, , C79000-G8976-C658-01
Introduction

Note on firmware/software support


Siemens only provides bug and security fixes for the last released firmware/software version.
This means that Siemens only monitors the current firmware/software version for security
vulnerabilities.

Recycling and disposal


The products are low in harmful substances, can be recycled and meet the requirements of
the Directive 2012/19/EU for disposal of waste electrical and electronic equipment (WEEE).
Do not dispose of the products at public disposal sites.
For environmentally compliant recycling and disposal of your electronic waste, please contact
a company certified for the disposal of electronic waste or your Siemens representative.
Note the different national regulations.

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 7
Introduction

SIMATIC RTLS Report client


8 Application Manual, , C79000-G8976-C658-01
Security recommendations 2
General
Note the following security recommendations to prevent unauthorized access:
• You should make regular checks to ensure that the devices meet these recommendations
and/or other security guidelines.
• Evaluate your plant as a whole in terms of security. Use a cell protection concept with
suitable products (https://new.siemens.com/global/en/company/topic-areas/future-of-
manufacturing/industrial-security.html).
• Keep the software up to date. Check regularly for security updates for the device. You can
find information on this at the Industrial Security
(https://new.siemens.com/global/en/company/topic-areas/future-of-
manufacturing/industrial-security.html) website.
• Only activate protocols that you require to operate your system.
• Whenever possible, always use the variants of protocols that provide enhanced security
(e.g. SNMPv3).
• Connections over unsecured network areas must be secured by security mechanisms such
as SSL VPN.
• Always click on the "Disconnect" button when you have finished working with the clients.
Especially when you work remotely on the host on which the clients are located.
• Restrict access to the software and its add-on programs (e.g. database) to qualified
personnel.
• Use the user and role administration to configure the rights of the users according to their
authorizations.

Users, roles and passwords


• Define rules for the use of the software and assignment of passwords. Configure these
roles using UMC and Active Directory.
• Regularly update the passwords to increase security.
• Change user names and default passwords of the databases before you use the software.
For the SIMATIC RTLS Locating Manager, a changeable user and an editable password is
used for each installation. You can change the password via the respective DBMS version.
• Create users and roles that are tailored to the scope of authorization required by each
user. Do not exclusively use the "System administrator" role that is present by default, and
disable the "System administrator" user that is present by default after new users with
corresponding rights have been created. You disable the "System Administrator" rights for
the UMC administrator by assigning this role to a specific user or a user group.
• Only use passwords with a high password strength. Avoid weak passwords, for example
password1, 123456789, abcdefgh.

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 9
Security recommendations

• Make sure that all passwords are protected and inaccessible to unauthorized personnel.
• Do not use the same password for different users and systems or after it has expired.

Physical access
Restrict physical access to the device to qualified personnel.

Automation License Manager


If you do not require the network functions of the Automation License Manager, deny access
to its functions in your firewall.

Software (security functions)


• Keep the software up to date. Check regularly for security updates for the product. You
can find information on this at the website
(https://new.siemens.com/global/en/company/topic-areas/future-of-
manufacturing/industrial-security.html).
• Only activate the protocols, functions and interfaces that you require to operate your
system.
• Restrict access to the device with a firewall or rules in an access control list (ACL - Access
Control List).
• The option of VLAN structuring provides good protection against DoS attacks and
unauthorized access. Check whether this is practical or useful in your environment.
• Enable the logging functions to record changes and access attempts. Check the logging
information regularly.

Secure and non-secure protocols


• Check whether the use of SNMPv2c is necessary. SNMPv2c is classified as non-secure. The
product provides you with suitable setting options.
• When SNMP is enabled, change the community names. When no unrestricted access is
necessary, restrict access with SNMP.
• Use secure protocols when access to the device is not secured by physical protection
measures. The following protocols provide a secure alternative:
– SNMPv2c → SNMPv3
– SMTP (simple) → SMTP via SSL
– NTLM → Kerberos (UMC connection to Active Directory)
• Avoid or disable non-secure protocols. For historical reasons, these protocols are available,
however not intended for secure applications. Use non-secure protocols on the device
with caution.
• To prevent unauthorized access to the device or network, take appropriate protective
measures against non-secure protocols.

SIMATIC RTLS Report client


10 Application Manual, , C79000-G8976-C658-01
Security recommendations

List of available protocols (local access via a local network)


The following is a list of all available protocols and their ports through which the RTLS
devices/products can be accessed. Note the list when you configure a firewall.
Explanation for table:
• Services/protocols
Services or protocols that support the RTLS devices/products.
• Port number
Port number assigned to the protocol/service.
• Default port status
– Open
The port is open by default.
– Closed
As default the port is closed.
• Authentication
Specifies whether the communication partner is authenticated.
• Loopback only
Specifies whether the protocol only needs local connections.
– Yes: No port must be open within the firewall. Access restrictions are recommended.
– No: The functionality requires this port to be accessed. Restrict access to necessary
hosts.
– Optional: The functionality depends on your system. Restrict access to necessary hosts
if your system requires remote access.

Service/Protocol Port number Default port status Authentication Loopback only


Data export modules TCP/variable Closed No Optional
Internal server TCP/8001 Closed No Yes
communication
Client connection TCP/9500 Open Yes Optional
Client connection TCP/9501 Open No Optional
E-mail TCP/variable Closed Optional No
Wireless network TCP/8000 Open No No
WAMP router TCP/12344 Closed Yes Optional
Microsoft SQL Server TCP/1433 Open Yes Optional
Microsoft SQL Server UDP/1434 Open No Optional

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 11
Security recommendations

SIMATIC RTLS Report client


12 Application Manual, , C79000-G8976-C658-01
Functions in the menu bar 3
Connecting and disconnecting
After the client starts, click the "Connect" button to connect to the Locating Manager and log
in. As an alternative, you can make a connection using the menu "File > Connect".
You can use the "User Configuration" client to assign roles to additional users. Fill in the
"Domain" text box when the user is an Active Directory user.
The status of the connection is displayed on the left in the status bar.
When a connection has been established, the connection symbol changes to "Disconnect",
indicating an existing connection. The red connection symbol "Connect" indicates that there
is no connection.
If a connection to the RTLS locating system could not be established, an error message is
issued after about 20 seconds. The connection symbol changes to "Connect" and
"Disconnected" appears in the status bar.

Connection configuration
Proceed as follows to configure the connections:
1. Adapt the server name and port accordingly if a valid connection to the Locating Manager
has not yet been established. The default port is 9500. The server name is the name of the
server in the RTLS localization network on which the Locating Manager server was installed.
By default, "localhost" is set. You can change these configurations at any time in the
"Options > Connections" menu.
2. Enter "localhost" in the "Host name or IP" text box if the Locating Manager server is on the
same PC as the current client. This is the default setting.
3. Otherwise, enter the appropriate name or the IP address of the Locating Manager server in
the RTLS localization network.

Note
Ensure that communication between the Locating Manager server, the infrastructure and the
current client is not blocked by a firewall or incorrect configuration on the local network.

Change password
You can change the password of the current user under "Options > Change password..". The
password is valid for access of this user to all clients within the Locating Manager.

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 13
Functions in the menu bar

Changing the language


You can switch between "German" and "English" under "Options > Language" .

Search
Under "Options > Search", you can search for any terms, descriptions or even addresses. Any
hits found are displayed in the user interface. If there are several search results, the main
window switches to the selected hit. Using the F3 key, you can switch from one result to the
next.

Search options
Under "Options > Search options", you can restrict the search range to specific node types,
transponders, transponder names, antenna positions or types, or specific text boxes. The text
boxes for selection for the transponders can be individually assigned. You can also open the
"Search options" dialog box by clicking on the "Options" button in the search window.

Check for update


If the "Check for update" option is selected, the system checks to see if new version of the
client is available on the server.

Automatically look for a better picture and display it


You can find this setting under "Options > Automatically look for a better picture and display
it".
When this option is selected, the client automatically tries to switch to the view area that best
matches the currently displayed area. This allows you to use detailed images for close zoom
levels or overview images.

Clear log
Under "Options > Clear log", you can delete the messages displayed in the output window for
logging data. Newly added messages are displayed again.

SIMATIC RTLS Report client


14 Application Manual, , C79000-G8976-C658-01
Reports 4
4.1 Reports

General
This document describes the operation of the "Report client" of the Locating Manager.

Note
The client may only be used by experienced and trained users.

Application
With the Report client, you can generate reports for the current and past system state and
export these as PDF or CSV file.
While connecting, reports are automatically downloaded from the Locating Manager server if
they deviate from the reports saved in the folder "%APPDATA%\SIMATIC_RTLS_LM\Report".
After the reports have been synchronized with the Locating Manager server and downloaded,
if necessary, you can view all available reports with the menu command "Reports > Select
report". The reports are displayed in a tree topology.

Start client
You start the "Report client" (ReportClient.exe) under "Start > Programs > SIMATIC RTLS
Locating Manager > Clients > Report Client".

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 15
Reports
4.2 Setting changes

4.2 Setting changes


To generate a report, you must open it with a double-click on the name of the report in the
tree topology. The "Setting changes" report shows the changes over time to the RTLS
Locating Manager configuration. In the user interface, the time stamps are shown in local
time. However, in the reports the time stamps are shown in UTC (Coordinated Universal
Time).

Header data
Multiple text boxes are available after opening the report. For "Header data", you must fill in
the text boxes "Customer" and "Identification" which form the headline of the report that will
be generated. To the right, you will see the values of the last report generation including time
stamps for information.

Groups
For "Groups", you can initially specify the time as date and time for which the generated
report is to include data. Select the start and end period with "From date" and "To date". Then
you have the option to more closely define the areas that are to be displayed in the report via
selection. The following areas are available for this:
• Infrastructure
• Transponder
• Locating
• Message management
• Routing
• Users
• Parameterization
• System
You can make a quick selection for the areas with the buttons "All" and "None".

Specifying the sorting sequence


In this box you can specify the sorting of the data records to be output for the report to be
generated by selection. The following sorting boxes are available for this task:
• Group
• Key
• Date
• Source
• Action
• Network address
When a sorting box is selected, you can decide to the right of the sorting box name whether
sorting is to take place in ascending or descending order. Sorting in multiple boxes

SIMATIC RTLS Report client


16 Application Manual, , C79000-G8976-C658-01
Reports
4.2 Setting changes

simultaneously is possible by enabling several entries. To change the order of the sorting
boxes, you must select a sorting box so that it is highlighted in blue. Then you can change the
position of the selected sorting box with the two arrow keys.
The buttons "Generate report" and "Create Config file" are enabled as soon as all required text
boxes are filled, and all additional settings have been made without errors. You generate a
report that is displayed as a preview by clicking on the "Generate report" button. Moreover, a
CSV file with the same content is generated automatically and saved in the directory
"%AppData%\SIMATIC_RTLS_LM" under the name "ChangeTracking_[timestamp].csv". You can
either print the preview or export it as a PDF file.
You use the "Create Config file" button to create a template file that can be used with the
command line program "ReportCmd.exe" to generate reports automatically. This template file
contains all settings that you have made in the "Setting changes" dialog. More information on
using the configuration file is included as comments in the configuration file. Prior to the first
use, you must make adaptations, especially for the path to the report DLL and the name of
the output file.

SIMATIC RTLS Report client


Application Manual, , C79000-G8976-C658-01 17

You might also like