Application description 08/2016 X-Tools Loading Profile Files (LPF) CMS X-Tools / V 04.03 https://support.industry.siemens.com/cs/ww/en/view/item_number
Warranty and liability Warranty and liability Note The Application Examples are not binding and do not claim to be complete regarding the circuits shown, equipping and any eventuality. The Application Examples do not represent customer-specific solutions. They are only intended to provide support for typical applications. You are responsible for ensuring that the described products are used correctly. These application examples do not relieve you of the responsibility to use safe practices in application, installation, operation and maintenance. When using these Application Examples, you recognize that we cannot be made liable for any damage/claims beyond the liability clause described. We reserve the right to make changes to these Application Examples at any time without prior notice. If there are any deviations between the recommendations provided in these application examples and other Siemens publications e.g. Catalogs the contents of the other documents have priority. We do not accept any liability for the information contained in this document. Any claims against us based on whatever legal reason resulting from the use of the examples, information, programs, engineering and performance data etc., described in this Application Example shall be excluded. Such an exclusion shall not apply in the case of mandatory liability, e.g. under the German Product Liability Act ( Produkthaftungsgesetz ), in case of intent, gross negligence, or injury of life, body or health, guarantee for the quality of a product, fraudulent concealment of a deficiency or breach of a condition which goes to the root of the contract ( wesentliche Vertragspflichten ). The damages for a breach of a substantial contractual obligation are, however, limited to the foreseeable damage, typical for the type of contract, except in the event of intent or gross negligence or injury to life, body or health. The above provisions do not imply a change of the burden of proof to your detriment. Any form of duplication or distribution of these Application Examples or excerpts hereof is prohibited without the expressed consent of the Siemens AG. Entry-ID: 109477785, V1.0, 05/2015 2
Warranty and liability Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants, solutions, machines, equipment and/or networks. They are important components in a holistic industrial security concept. With this in mind, Siemens products and solutions undergo continuous development. Siemens recommends strongly that you regularly check for product updates. For the secure operation of Siemens products and solutions, it is necessary to take suitable preventive action (e.g. cell protection concept) and integrate each component into a holistic, state-of-the-art industrial security concept. Third-party products that may be in use should also be considered. For more information about industrial security, visit http://www.siemens.com/industrialsecurity. To stay informed about product updates as they occur, sign up for a product-specific newsletter. For more information, visit http://support.industry.siemens.com. Entry-ID: 109477785, V1.0, 05/2015 3
Table of contents Table of contents Warranty and liability... 2 1 Preface... 5 1.1 Overview... 5 1.2 Basic Knowledge required... 5 1.3 Required Software... 5 1.4 Required Hardware... 5 1.5 Scope of delivery... 5 1.6 Further Information... 6 1.7 Terms... 6 2 What is an X-Tools Loading Profile File (LPF)?... 7 Siemens 2015 All rights reserved Introduction... 7 2.1 Create a new LPF... 7 2.2 Configure the LPF... 10 3 How to use an X-Tools Loading Profile File?... 13 3.1 Launch the Offline Data Loader... 13 3.2 Load the data using the LPF... 14 4 Further examples... 17 4.1 Data Filter with a list of Excluded Data... 17 4.2 Data Filter with a list of Included Data... 23 4.3 Combined filter (Time and Data)... 26 5 Contact Information... 29 6 History... 29 Entry-ID: 109477785, V1.0, 05/2015 4
1 Preface 1 Preface 1.1 Overview In this application description, we will explain what a Loading Profile File in CMS X-Tools is and how it can be used. Shortly, a Loading Profile File can be of use to filter automatically the offline data that you want to load among a large amount of data, matching various filtering criteria (date and time, included and excluded types of data, and so on). 1.2 Basic Knowledge required In order to understand this application description, general knowledge of automation technology and software package CMS X-Tools (in the following, X-Tools) is required. In addition, you must be familiar with using computers with Windows. 1.3 Required Software This document is valid for the following software: CMS X-Tools Professional V 04.03 The usage of different software versions can lead to variations of the steps described below. 1.4 Required Hardware No specific hardware is required. NOTE The X-Tools Client and Server can also be installed at different systems. 1.5 Scope of delivery No additional files are delivered with this document. Entry-ID: 109477785, V1.0, 05/2015 5
1 Preface 1.6 Further Information 1.7 Terms A detailed description of all software features is not subject of this document. Further information can be found in: CMS X-Tools - User Manual 01-07 The following terms are used in this document: Definition Description Offline Data Loader Loading Profile File ODL LPF Entry-ID: 109477785, V1.0, 05/2015 6
2 What is an X-Tools Loading Profile File (LPF)? 2 What is an X-Tools Loading Profile File (LPF)? Introduction In the Storage System of CMS X-Tools, you can use the Offline Data Loader (ODL) to load manually some offline data to the MDS Explorer. However, it could be interesting to load quickly some data that match your own criteria (for example, time filter, a specific type of data, and so on). The X-Tools Loading Profile Files have been designed to solve this issue. Shortly, a LPF can be configured to filter automatically the data you want to load among an amount of data matching different sorts of criteria. In this chapter we will explain how to create and properly configure an X- Tools LPF. 2.1 Create a new LPF Launch the CMS X-Tools software. Go to the Storage System tab. The locations are displayed in the tree view. Below the chosen location, two folders are displayed: - Storage Profile Files - Loading Profile Files Entry-ID: 109477785, V1.0, 05/2015 7
2 What is an X-Tools Loading Profile File (LPF)? Figure 2-1 Right click on the Loading Profile Files folder, and select New Loading Profile. Figure 2-2 Entry-ID: 109477785, V1.0, 05/2015 8
2 What is an X-Tools Loading Profile File (LPF)? The settings table is displayed within the workspace. Figure 2-3 Entry-ID: 109477785, V1.0, 05/2015 9
2 What is an X-Tools Loading Profile File (LPF)? 2.2 Configure the LPF We will review the main parts of the settings table. The Loading Profile Parameters table In this table you have to specify which type of filtering you want to perform (Data Filter based on lists of included/excluded or no data and/or Time Filter based on time criteria). In this example, we will only use a Time Filter. Therefore Data Filter is set to None. Beside this it is possible to define Default Loading Mode which is then applied to the Loaded Data. Figure 2-4 Entry-ID: 109477785, V1.0, 05/2015 10
2 What is an X-Tools Loading Profile File (LPF)? The Default Time Parameters table In this table you have to set the time filtering parameters. In this example, we would like to load all the offline data that have been created over the last 7 days. For this purpose, we can use the following settings: Figure 2-5 The Included Data table In this example, we don t need to type anything in this table, since we don t use any Data Filter (see figure 2-4). This list is used to define data which shall be included in the loaded. No other data will be loaded. Figure 2-6 The Excluded Data table The same applies to the Excluded Data table. This list is used to define data which shall excluded from the loading process. Entry-ID: 109477785, V1.0, 05/2015 11
2 What is an X-Tools Loading Profile File (LPF)? Figure 2-7 The Data Time Configuration table We will not use this table in this example since no Data Filter has been configured. If you want to use a Data Filter, you can also set a custom Time Filter for each data. You may notice that the fields are the same as in the Default Time Parameters table. Figure 2-8 If you want to use a different Time Filter for each data, you have to fill this table for each list entry in the Included Data. Save the LPF you just created to the corresponding location. Figure 2-9 The configuration of the LPF is now completed. Entry-ID: 109477785, V1.0, 05/2015 12
3 How to use an X-Tools Loading Profile File? 3 How to use an X-Tools Loading Profile File? In this chapter, we will explain how to use the X-Tools LPF we just created. 3.1 Launch the Offline Data Loader Go to the Storage System tab. In the STS Explorer window, open the File menu, and then select Load Offline Data. Figure 3-1 The Offline Data Loader (ODL) has been opened. Entry-ID: 109477785, V1.0, 05/2015 13
3 How to use an X-Tools Loading Profile File? 3.2 Load the data using the LPF Explore the location where the data you want to load are stored. Right click on this folder and then select Advanced Append. Figure 3-2 A window is displayed to set the Appending Parameters. On the first line, you can select the desired Loading Profile: Figure 3-3 Click OK. The data will then be loaded. Entry-ID: 109477785, V1.0, 05/2015 14
3 How to use an X-Tools Loading Profile File? Figure 3-4 Once the loading is completed, you will notice that the corresponding data is now available as Offline Data within the MDS Explorer. Figure 3-5 Entry-ID: 109477785, V1.0, 05/2015 15
3 How to use an X-Tools Loading Profile File? You can check that your LPF has worked properly and that all the data belong to the right time interval: click on the plus sign on the left of an Offline Data to display the object properties. Figure 3-6 Entry-ID: 109477785, V1.0, 05/2015 16
4 Further examples 4 Further examples 4.1 Data Filter with a list of Excluded Data In the first example, we just used a Time Filter to load only the data that have been generated during a precise time interval. It is also possible to use a Data Filter in order to load a precise type of data. The steps are close to the first example: - First, create a new LPF (see step 2.1 for more details) - Once the LPF is created, configure it properly. We will review the main parts of the configuration. Figure 4-1 In the Loading Profile Parameters table, select this Data Filter option: Use excluded Data List. In the Default Time Parameters table, load the data From the beginning Until the end, so that no time filtering will be carried out. Entry-ID: 109477785, V1.0, 05/2015 17
4 Further examples Figure 4-2 The Data Time Configuration table is empty. Figure 4-3 Open the Offline Data Loader. Load the whole data you want to filter without using any LPF: choose Append. Figure 4-4 Entry-ID: 109477785, V1.0, 05/2015 18
4 Further examples All the data should now be displayed as Offline Data within the MDS Explorer. Figure 4-5 Figure 4-6 Drag and drop the data you don t want to load with the LPF from the MDS Explorer to the Excluded Data table. Entry-ID: 109477785, V1.0, 05/2015 19
4 Further examples Your data filter is now properly configured. - Save it to the corresponding location. Figure 4-7 You can now test the LPF you just created. - Remove all the offline data from the MDS Explorer. Figure 4-8 - Go to the Offline Data Loader. Right click on your data location and choose Advanced Append. Entry-ID: 109477785, V1.0, 05/2015 20
4 Further examples Figure 4-9 - Select the just created LPF and click OK. Figure 4-10 Your data have been loaded and displayed as Offline Data within the MDS Explorer. Entry-ID: 109477785, V1.0, 05/2015 21
4 Further examples Figure 4-11, List of Excluded Data: Figure 4-12 Entry-ID: 109477785, V1.0, 05/2015 22
4 Further examples Result without data filter: Figure 4-13 4.2 Data Filter with a list of Included Data The steps of the configuration are almost identical. In the Loading Profile Parameters table, select this Data Filter option: Use included Data List. Figure 4-14 The Default Time Parameters table is identical The Data Time Configuration table is empty Drag and drop the data you want to load from the MDS Explorer to the Included Data table. Entry-ID: 109477785, V1.0, 05/2015 23
4 Further examples Figure 4-15 - Save the LPF to the corresponding location. Figure 4-16 The data filter is now properly configured and you can test it: - Remove all offline data from the MDS Explorer. - Go to the Offline Data Loader. Right click on your data location and choose Advanced Append. - Select the LPF you want to use and click OK. Entry-ID: 109477785, V1.0, 05/2015 24
4 Further examples Your data have been loaded and displayed as Offline Data within the MDS Explorer. Figure 4-17 List of Included Data: Figure 4-18 Result without data filter: Figure 4-19 Entry-ID: 109477785, V1.0, 05/2015 25
4 Further examples 4.3 Combined filter (Time and Data) You can also combine the given examples to carry out a time and data filtering. You just have to fill in the Default Time Configuration table in addition to the other configuration steps in the previous example: Figure 4-20 Entry-ID: 109477785, V1.0, 05/2015 26
4 Further examples Example 4.2 with an additional time filter (654 values and 7 days long time period): Figure 4-21 Entry-ID: 109477785, V1.0, 05/2015 27
4 Further examples Example 4.2 without time filter (4693 values and longer time period): Figure 4-22 Entry-ID: 109477785, V1.0, 05/2015 28
5 Contact Information 5 Contact Information Should you have any questions concerning the software application, please refer to the Industry Sector Technical Support. Department Siemens AG Industry Sector Phone +49 (0) 911 895 7222 (Monday to Friday, 09:00 am to 05:00 pm CET/CEST) Fax +49 (0) 911 895 7223 Internet https://support.industry.siemens.com/cs/ Thank you for using one of the above mentioned contacts to ensure your inquiry is registered and can be processed. 6 History Version Date Modifications V1.0 8/2016 First version Entry-ID: 109477785, V1.0, 05/2015 29