Download pdf - Visual Explorer Getting Started - MindSphere · Visual Explorer Getting Started Getting Started 03/2020 V1801.Mar/2020.1 Document history 1 Introduction 2 ... Tricks" Tips and Tricks

MindSphere

Visual Explorer Getting Started

Getting Started

03/2020V1801.Mar/2020.1

Document history 1

Introduction 2User rights in "Visual Explorer" 3Connecting "Visual Explorer" to MindSphere data 4

Creating Visualizations 5

Legal informationWarning 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.

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

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

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

NOTICEindicates 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 PersonnelThe 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 productsNote the following:

WARNINGSiemens 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.

TrademarksAll 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 LiabilityWe 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 AGDivision Digital FactoryPostfach 48 4890026 NÜRNBERGGERMANY

V1801.Mar/2020.1Ⓟ 03/2020 Subject to change

Copyright © Siemens AG 2020.All rights reserved

Table of contents

1 Document history..........................................................................................................................................7

2 Introduction...................................................................................................................................................9

2.1 Getting Started .........................................................................................................................9

2.2 Overview of "Visual Explorer" in MindSphere ..........................................................................9

3 User rights in "Visual Explorer"...................................................................................................................11

4 Connecting "Visual Explorer" to MindSphere data .....................................................................................13

4.1 User Interface "Data Sources" ...............................................................................................13

4.2 Creating a new data source ...................................................................................................144.2.1 Step 1: "Choose data source mode" ......................................................................................154.2.2 Step 2: "Select sources".........................................................................................................154.2.3 Step 3: "Choose update mechanism" ....................................................................................194.2.4 Step 4: "Save data source" ....................................................................................................224.2.5 Managing IDL data sources ...................................................................................................224.2.6 Limits and restrictions ............................................................................................................234.2.7 Tips and Tricks.......................................................................................................................24

5 Creating Visualizations ...............................................................................................................................27

5.1 Using a data source in "Visual Explorer"................................................................................27

5.2 Further Help ...........................................................................................................................28

Visual Explorer Getting StartedGetting Started, 03/2020, V1801.Mar/2020.1 3

Table of contents

Visual Explorer Getting Started4 Getting Started, 03/2020, V1801.Mar/2020.1

Visual Explorer is an application for MindSphere, the industrial IoT platform from Siemens. In Visual Explorer, customized visualizations can be created that are based on the data sources in Visual Explorer Connector. Getting Started provides the information on creating customized visualizations for assets that are connected to MindSphere. These visualizations can be used to analyze specific assets or can publish visualizations to customers.

This document also describes Visual Explorer Connector and Visual Explorer available on MindSphere Launchpad.



Document history 1Version Date Changes LinkV1801.Mar/2020.1 2020-03-18 Added a new topic "Manag‐

ing IDL data sources"Managing IDL data sources (Page 22)

V1801.Feb/2020.1 2020-02-10 Modify images in the whole document and fixed broken links.

-

V1801.Jan/2020.1 2019-12-08 Revision of the entire docu‐ment

-

V1801.Dec/2019.1 2019-11-19 Added a Chapter "Tips and Tricks"

Tips and Tricks (Page 24)

Updated Limitations and Re‐strictions section.

Different Environment (Page 23)

V1801.Nov/2019.1 2019-11-06 Updated Roles and Permis‐sions in user rights

User rights in "Visual Explor‐er" (Page 11)

Added note for region devia‐tion in chapter "Further Help"

Further Help (Page 28)

V1801.Oct/2019.1 2019-10-25 New chapter is added named Different Environment

Different Environment (Page 11)

V1801.Oct/2019.1 2019-10-24 Update Roles in User Right section


V1801.Sep/2019.1 2019-09-07 Added Quota Enforcement section in User Rights


V1801.Apr/2019.1 2019-04-04 Updated user rights table User rights in "Visual Explor‐er" (Page 11)

Updated status table User Interface "Data Sour‐ces" (Page 13)

V1801.Mar/2019.1 2019-03-01 Notes on Subtenant use -Note on data rate limitation added information on folder structure

Creating a new data source (Page 14)

V1801.CW.EU1.K1217 2018-12-18 Updated screenshots Added note in chapter "Creat‐ing a new data source"

Choose update mechanism (Page 19)

Added "Support" in chapter "Further Help"

Further Help (Page 28)


Document history


Introduction 22.1 Getting Started

This document provides information for creating customized visualizations of the assets connected to MindSphere. These visualizations can be used to analyze specific assets or to publish visualizations to customers.

This document also describes Visual Explorer Connector, which is an add on package application that comes with the Visual Explorer. Both applications are available on the MindSphere Launchpad.

Visual Explorer is based on Tableau®. For more information on how to operate Tableau® to its full extent, refer to the chapter named Further Help (Page 28).

2.2 Overview of "Visual Explorer" in MindSphereAfter ordering Visual Explorer from MindSphere Store, Visual Explorer Connector and Visual Explorer will be added to the MindSphere Launchpad.

Visual Explorer ConnectorIn Visual Explorer Connector, administrator can create and manage data sources for the data that is expected to be visualized.

Visual ExplorerIn Visual Explorer, administrator can create customized visualizations based on the data sources created in Visual Explorer Connector.

Visual Explorer is built on Tableau® – a software for data visualization and visual analytics – which offers many possibilities to visualize data.


Introduction2.2 Overview of "Visual Explorer" in MindSphere


User rights in "Visual Explorer" 3Visual Explorer Connector

In order to access Visual Explorer Connector you need the Author role. Subtenant users cannot use Visual Explorer Connector irrespective of the assigned role.

Visual Explorer Visual Explorer adopts the user rights from Settings (https://documentation.mindsphere.io/resources/html/settings/en-US/index.html).

The user rights depend on the following user roles:

● Publisher

● Viewer

● Interactor

Right RolePublisher Viewer Interactor

Use Visual Explorer ✓ ✓ ✓Create visualizations ✓ View visualizations ✓ ✓ ✓Create Alerts ✓ ✓

License types user rightsYou can purchase Visual Explorer in the license types Creator or Viewer. The following table shows the differences between the license types:

License type App access Visual Explorer RoleCreator ● Visual Explorer

● Visual Explorer Connector● Publisher● Interactor

Viewer ● Visual Explorer ● Viewer

See Tableau (https://help.tableau.com/current/online/en-us/users_site_roles.htm)® help for details regarding the roles.

For more information about the license types see MindSphere Supplemental Terms.

Quota for license typesFor each license type and package size you have a specific quota of licenses.


https://documentation.mindsphere.io/resources/html/settings/en-US/index.html

https://documentation.mindsphere.io/resources/html/settings/en-US/index.html

https://help.tableau.com/current/online/en-us/users_site_roles.htm

You consume a license if the following conditions apply:

● The tenant administrator assigned a role to a MindSphere user.

● The same user is logged into Visual Explorer.

A user cannot log in when all the licenses of a license type are consumed. However, the existing users will not be affected.

NoteAll licenses in use

Sharing a license among multiple users is not permitted and therefore, licenses cannot be reassigned frequently. In case you need to reassign one of your licenses, contact the MindSphere support. The tenant administrator cannot reassign licenses.

E.g. Revoking the access to Visual Explorer via Settings application does not withdraw the license from the user. As a consequence, the user cannot log in but remains on the server and still consumes a license.Example

Visual Explorer with Viewer offering small, grants access to 20 users with Viewer role. The first 20 users with the Viewer role can access the application. After the 20th user, no other user can access the application. From the 21st user, an error message will be displayed informing about the acquired and consumed licenses.

User rights in "Visual Explorer"


Connecting "Visual Explorer" to MindSphere data 4To connect Visual Explorer to MindSphere you have to open the Visual Explorer Connector application. In Visual Explorer Connector, you can create and manage data sources for the data that is expected to be visualize.

You can assign the visual explorer roles in the settings application. For more information on user roles, see chapter User roles for "Visual Explorer" (Page 11).

Note

Subtenant users cannot work with Visual Explorer Connector.

4.1 User Interface "Data Sources"

This page lists the data sources of the tenant. Pagination can be used to scroll through the list or can use the 'filter and sort' search bared to list a specific tenant. The term will be searched in the data source 'name' as well as in the 'tags'. An indicator is available at the left side to display the current data source state.


Symbols The table below describes data source status:

Status DescriptionThe data source is in the creation process.The data source is currently synchronizing.The data source is fully synchronized with the data in Mind‐Sphere.The data source is functioning, but there were problems de‐tected. Some data may be missing. The problems are repor‐ted on the data source overview page. If you cannot solve the problem on your own, contact the MindSphere support.The data source was not updated. An outdated version of the data source may still be available in Visual Explorer. The problem is reported on the data source overview page. If you cannot solve the problem on your own, contact the Mind‐Sphere support.

Depending on the width of your screen, more information is displayed such as 'name of the project' the data source is hosted by, the 'tags' and the 'size of the data source'. By clicking the button in the column “more”, you can find further details and perform further actions:

● Go to the detail page for periodically updated data sources.

● Delete the data source.

● Edit the data source: change the configuration and save the changes under the same name.

● Copy the data source: reuse the configuration but save under a new name.

4.2 Creating a new data sourceTo create a new data source in Visual Explorer Connector, click .

Visual Explorer Connector leads to the following user interfaces:

1. "Select data source mode" (Page 15)

2. "Select sources" (Page 15)

3. "Select update mechanism" (Page 19)

4. "Save data source" (Page 22)

Connecting "Visual Explorer" to MindSphere data4.2 Creating a new data source


4.2.1 Step 1: "Choose data source mode"In this step, you can select between three different data source modes:

Data source mode Description"Assets" This mode allows you to create a data source for specific assets from a list of assets."Asset Types" This mode allows you to create a data source for all assets of a certain asset type. This

mode ensures that the newly connected assets of the selected asset types are contin‐uously included in the data source and synchronized.

"Simulation Twins" Assets with the property twinType= "simulation" require additional settings to work with Tableau®, the technology behind the Visual Explorer.

4.2.2 Step 2: "Select sources"In this step, you can select the sources for the 'data source' mode that has selected in step 1:

Data source mode "Assets"With this data source mode, you can select specific assets and aspects. The created data source will contain data from all selected assets that are connected to MindSphere.

To select assets and aspects for the data source, click on the respective assets and check the boxes next to the respective aspects.

The number next to an asset shows the number of the selected aspects in this asset.



Note

The data source type "Simulation Twins" has a restriction that only one asset can be a part of the data source. Selection of the aspect and the asset should be clear before the new item is added.

Data source mode "Asset Types"With this data source mode, you can select specific asset types and aspects. The created data source will contain data from all assets of the selected asset types that are connected to MindSphere.

To select asset types and aspects for the data source, click on the respective asset types and check the boxes next to the respective aspects.

The number next to an asset type shows the number of the selected aspects in this asset type.

If you select an asset type and a new asset of that is subsequently connected, the asset will automatically be inserted into the data source.





Aspect detailsTo view the variables of an aspect and their datatype, click the info icon next to the aspect.

Data fieldsAfter selecting the assets and aspects, the respective data will be saved in a data source, which provides the basis for Visual Explorer visualizations. The data fields of this data source contain three fixed fields and various additional fields, depending on the selection of aspects.

The three fixed fields are as follows:

● Sequential number (Id)

● Asset ID (assetId)

● Time stamp of measurement (_time)



The variable fields are named corresponding to the pattern of "aspectName_aspectTyp_variable".

Name DescriptionaspectTyp Aspect typeaspectName Name of asset in your asset typevariable Name of variable in aspect type

Example

The asset named "sensor2" with type "machine" collects the variables "airTemperature" and "airPressure", and uses the aspect type "StateofEnvironment". In this case, the respective data fields are:

● stateofEnvironment_sensor2_airTemperature

● stateofEnvironment_sensor2_airPressure

These data fields will be listed under "Dimension" or "Measure" in Tableau®, depending on their data type.

This means that the additional number of rows in the table can be created as per the available aspects. If you are using multiple assets of the same type, MindSphere recommends selecting the same aspects for each asset to keep the consistent number of rows in the table.

Note

The number of rows is limited to 100 to maintain the Visual Explorer workflow. Whenever the number of rows exceeds more than100, an information dialog box is displayed on the screen informing the exceeded rows limit.

4.2.3 Step 3: "Choose update mechanism"In this step, you can select between two different update mechanisms.

Update mechanism Description"Fixed Range" This mechanism ensures one-time data extraction from MindSphere to

Visual Explorer."Continuous Update" This mechanism ensures ongoing synchronization between Mind‐

Sphere data and the data source.



NoteUpdate mechanisms and user permissions

While creating or updating a new data source a copy of MindSphere user permissions is also created in the backend. Access rights on assets are checked and transferred to the newly created data source. ● For a data source with the update mechanism "Fixed Range", these access rights will not be

updated.● For a data source with the update mechanism "Continuous Update", these access rights are

identified with every data source update.

For the higher update frequencies (less than 30 minutes) there are additional restrictions in place that are evaluated during the update process. It limits the amount of data to keep latency low. For particular use cases, the limitation is too conservative. Visual Explorer provides ways to override these values:

1. Click "Override limitation".

2. Enter the custom limitation (must be a number).

3. Proceed with the configuration of the data source.

WARNING

Tableau® aggregates and processes data in the background. This may lead to Tableau® Server being unresponsive. Also, for higher update frequencies, a higher limitation may delay the data processing. It will extend the time to finish the data processing.



Update mechanism "Fixed Range"In this update mechanism, you can select a fixed start and end date. This should be the time frame for the data in the data source.

To select the start and end date, click date bar.

Update mechanism "Continuous Update"This update mechanism ensures a continuous synchronization of MindSphere data with the data source.

Select the duration and the interval of the data as described in the user interface.



NoteLimitation of data rates

In the modes "5 minutes", "10 minutes" and "15 minutes" the number of data rates are limited. The limits and information on which data rate is possible without reaching the limitation in MindSphere will be displayed. Once a system arrives at these limits, the data source is available but will not work to its full extent. A warning will be displayed in Visual Explorer Connector.

4.2.4 Step 4: "Save data source"In this step, you can select a name and the save location for the data source. You can also add tags to the data source for organizing and filtering purposes.

The folder structure located on the Tableau® server can also be managed.

On the highest level, MindSphere manages the folder structure. This means that MindSphere creates one folder for every tenant and also one folder for every subtenant, that is displayed below "Subtenants". This structure is not editable. Down the MindSphere main structure, you are free to create folders ("Projects" in Tableau®) as per the requirements.

4.2.5 Managing IDL data sourcesYou can subscribe to subscription API and file changes, if IDL is provisioned for your tenant.

To create a subscription based data source, follow these steps:

1. Click "IDL subscription" and select a project.

2. Enter the name and path of a file. You can either directly enter a path or select the file in a browser.

3. Click "Save".



Note

The file will be transferred to Tableau® server when it is changed in "IDL subscription". To build a visualization based on a file that already exists, you have to re-upload it to trigger the subscription.

Supported files and file sizesCurrently, only CSV files upto 20 MB are supported. The number of subscription based data sources are limited to 10 per tenant.

4.2.6 Limits and restrictions

Limitations and RestrictionsFollowing restrictions are applicable on the working environment and are continuously subjected to update:

● Dashboard extensions are not allowed to be run.

● Technical issues might occur while working with 32-bit Google Chrome Version 71.0.3578.98 (Official Build).

● Embedded views may have some issues in working with Chrome 80. For more information refer Tableau Knowledge Base (https://kb.tableau.com/articles/Issue/embedded-views-fail-to-load-after-updating-to-chrome-80?utm_campaign=CL_Partner%20Communication%20-%20Chrome%2080%20Iss_Email-production_E-53916_ET_0129_0230&utm_medium=Email&utm_source=Eloqua&domain=siemens.com&eid=CTBLS000013683422&elqTrackId=037ba61eb9bc4d9ab6870fe41200136d&elq=14d5ec6a8c4a4123bdf4a0e193ac800f&elqaid=41696&elqat=1&elqCampaignId=40737) .

Region deviationsThe table shows the deviations between available regions:

Feature Europe 1 Europe 2 China 1Tableau® Version 2019.3 2018.1 Subtenancy Fully Functional Limited. There is no automated

project creation for subtenants.

Data Driven Alerts Fully Functional Not Supported



https://kb.tableau.com/articles/Issue/embedded-views-fail-to-load-after-updating-to-chrome-80?utm_campaign=CL_Partner%20Communication%20-%20Chrome%2080%20Iss_Email-production_E-53916_ET_0129_0230&utm_medium=Email&utm_source=Eloqua&domain=siemens.com&eid=CTBLS000013683422&elqTrackId=037ba61eb9bc4d9ab6870fe41200136d&elq=14d5ec6a8c4a4123bdf4a0e193ac800f&elqaid=41696&elqat=1&elqCampaignId=40737







4.2.7 Tips and Tricks

Adding Multiple Data Sources to one WorkbookMultiple data sources can be added to one workbook. Generally, navigation starts from one particular data source in Visual Explorer and then base a workbook on this data source. It is possible to have more than one data source in a workbook by selecting data from "New Data Source".

Using VFC to add Sample DataFollow these steps to add Sample data:

1. In the Asset Manager, add an asset with a particular "Type".

2. Write data in the asset from the Visual Flow Creator and the available corresponding nodes.

3. Create a periodically updated data source in Visual Explorer Connector.

Row-level SecurityThe data sources created by Visual Explorer Connector enable Row-level Security. It protects against the ability to share dashboard among multiple users. Records in a data source belong to assets. Assets displayed on the dashboard are dependent on the logged-in MindSphere user. This enables you to access different data from the same dashboard at the same time. An OEM can create a visualization for a fleet and transfer it to subtenants. The subtenants can access assets that are enabled for them.



Dealing with Numeric OverflowsBy default, Tableau® aggregates measure type values. With every Drag and Drop of a measure from the left side to the visualization, Tableau® tries to sum up the values. This is not convenient with multiple values and when a single value is not distant from the numeric limit of a variable type. For instance, many epoch time stamps may easily exceed the long integer data type. In this case, circumvent the aggregation by first converting the measure into a dimension. Drag it in the left panel from "Measures" to "Dimensions".

Update a Fixed Range Data SourceSwitching between the update modes at any time is possible by editing the data source configuration. Data source without periodic scheduling can be updated by editing it and saving it with the same parameter. Even without changes to the time range, the data source is treated as a new source and accordingly scheduled for updates.



Dealing with Limited Amount of DataMindSphere limits the amount of data per data source, as the Tableau® server cannot optimize too much data at the same time. The User Interface shows the upper limit of records per data source. Processing a data source requires some time and for some frequencies, different limits apply in the continuous mode. These are listed in the User Interface. However, in some cases these limitations may be too conservative. Therefore, Visual Explorer provides a way to override the limitation, refer to the section "Choose update mechanism". Although higher limitations may be feasible in the particular use case, it is not guaranteed that the data transformation process will finish in time. You need to verify whether the update performance is still within the tolerances of the dashboard. To work around those limitations, MindSphere emphasizes on the following points:

● Pre-processing the data with a different tool such as Visual Flow Creator.

● Selecting a shorter time range.

● Dividing the data into multiple sources: one source with much data, but low frequent updates, and another data source with only the latest data, but higher frequency.

CollaborationThe ownership of a workbook lies with the creator. This means that nobody other than the creator can introduce any changes. To change this, the creator must explicitly set permissions. There are two ways to do this:

● Workbook ownership can be transferred to another user.

● Fine-grained permissions can be assigned.

Both options are available in the corresponding menu in the workbook list.



Creating Visualizations 55.1 Using a data source in "Visual Explorer"

To use a data source from Visual Explorer Connector in Visual Explorer, proceed as follows:

1. Open Visual Explorer in the MindSphere Launchpad.

2. Click the project in which the data source is saved.

3. Click "Data sources".

4. Select the box next to the respective data source.

5. Click > "New workbook".

The data source is then displayed in Visual Explorer at "Data sources".

Note

Subtenant users cannot create visualizations, as described in chapter User rights for "Visual Explorer" (Page 11).


5.2 Further Help

SupportIn case of issues that cannot be resolved with the MindSphere knowledge base, contact the support team.

To contact the MindSphere support follow the given steps:

1. Go to MindSphere Launchpad.

2. Click MindSphere Button "powered by MindSphere" in the upper right corner.

3. Select "MindSphere Support".

A new dialog opens, enter your contact details and describe the issue. The support team will then contact and help to resolve the problem.

Creating Visualizations5.2 Further Help


NoteRegion deviation

Instead of opening a new dialog, "MindSphere Support" for region China 1 will open Alibaba Ticket System page to create a new ticket for further support.

Further linksVisual Explorer is based on Tableau®. Following are the useful information on how to get started with Tableau®.

● The Web Authoring Workspace (https://onlinehelp.tableau.com/current/pro/desktop/en-us/web_author_home.htm)

● Build Views on the Web (http://onlinehelp.tableau.com/current/pro/desktop/en-us/help.htm#web_author_build_view.html%3FTocPath%3DUse%2520Tableau%2520on%2520the%2520Web%7C_____2)

● Explore and Manage Web Content (http://onlinehelp.tableau.com/current/pro/desktop/en-us/help.htm#data_explore_analyze_interact.html%3FTocPath%3DUse%2520Tableau%2520on%2520the%2520Web%7CExplore%2520and%2520Manage%2520Web%2520Content%7CExplore%2520and%2520Analyze%2520Data%2520in%2520a%2520View%7C_____0)

● Share and Collaborate on the Web (http://onlinehelp.tableau.com/current/pro/desktop/en-us/help.htm#share_collaborate.html%3FTocPath%3DUse%2520Tableau%2520on%2520the%2520Web%7CShare%2520and%2520Collaborate%2520on%2520the%2520Web%7C_____0)

See alsoAlibaba Ticket System (https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=mindsphere&commonQuestionId=3917&isSmart=true)



https://onlinehelp.tableau.com/current/pro/desktop/en-us/web_author_home.htm

https://onlinehelp.tableau.com/current/pro/desktop/en-us/web_author_home.htm

http://onlinehelp.tableau.com/current/pro/desktop/en-us/help.htm#web_author_build_view.html%3FTocPath%3DUse%2520Tableau%2520on%2520the%2520Web%7C_____2



http://onlinehelp.tableau.com/current/pro/desktop/en-us/help.htm#data_explore_analyze_interact.html%3FTocPath%3DUse%2520Tableau%2520on%2520the%2520Web%7CExplore%2520and%2520Manage%2520Web%2520Content%7CExplore%2520and%2520Analyze%2520Data%2520in%2520a%2520View%7C_____0





http://onlinehelp.tableau.com/current/pro/desktop/en-us/help.htm#share_collaborate.html%3FTocPath%3DUse%2520Tableau%2520on%2520the%2520Web%7CShare%2520and%2520Collaborate%2520on%2520the%2520Web%7C_____0




https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=mindsphere&commonQuestionId=3917&isSmart=true

https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=mindsphere&commonQuestionId=3917&isSmart=true

