InfoCenter Suite® Migrating ADP to InfoCenter User's guide CM110773en 07.10.
Siemens Switzerland Ltd. Building Technologies Group International Headquarters Building Automation Gubelstrasse 22 CH-6301 Zug Tel. +41 41-724 24 24 Fax +41 41-724 35 22 www.sbt.siemens.com © 2006 Siemens Switzerland Ltd. Subject to change 2/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter CM110773en 07.10.
Table of contents 1 Introduction ................................................................................................... 5 1.1 Prerequisites ................................................................................................. 5 1.2 Workflow - Migration ..................................................................................... 6 2 Installation..................................................................................................... 7 2.1 General .......
/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Introduction CM110773en 07.10.
1 About this document Introduction This document describes how to install and operate the migration tool. The tool helps read values from the ADP database and provide them for import into the InfoCenter database in the form of csv files. 1.1 Prerequisites Operating system Windows2000-SP 4 is required for .NET-CLR version 1.1. The .NET runtime environment is provided on the CD and will be installed automatically as needed.
1.2 Workflow - Migration We suggest the following workflow for migration: 1. Install InfoCenter server (basic configuration, security, network connection, etc.). 2. Enable data acquisition through InfoCenter, either from DESIGO INSIGHT or SICLIMAT-X. Disable data acquisition by ADP (usually after "run-in/test and/or validation time" 3. 4. 5. 6. 7. with InfoCenter). Migrate historical ADP data (acquired before step 3) to InfoCenter (incl. ADP archives).
2 Installation 2.1 General The ADP2IC migration tool can be installed on any computer meeting the requirements set forth in section 1.1. This computer must be able to communicate with the ADP and the InfoCenter database. 2.2 Setup Setup program The installation CD contains folder "ADP2IC“ with all components required to install the tool on the computer. To do this, start setup.exe from this folder. The installation routine checks if the computer contains the .Net runtime environment.
2.3 New installation 2.3.1 What is installed? The migration tool can be installed in any path. The setup program copies are required data to the installation folder. The following files exist after setup: • • • • • • • • Multilingual ADP2IC.exe ADP2IC.exe.config ADP2IC.ico CompanyLogo.gif DynamicPDF.Generator.Developer.dll GlobalConfig.soap License_de.rtf License_en.rtf The tool supports German (de-DE) and English (en-US) for user interfaces and texts.
DynamicPDF.Generator.Developer.dll This is a program to convert the text format report file to PDF. A license was purchased for this program. GlobalConfig.soap This file contains the basic tool settings that can be set via the user interface (see section 3.2). License_*.rtf These are the license files displayed for confirmation to the user during installation.
2.4 Uninstalling Uninstall the migration tool by restarting the setup program from the CD. If the setup program and tool version are a match, the following dialog box opens: Illustration 2-4 Select "Remove ADP2IC Migration Tool V1.0.0“ and click "Finish“. The setup program removes all files and folders created during installation from the installation folder. You can also uninstall the migration tool via the Add/Remove Programs command in the Windows Control Panel.
3 Operation Start the program by double-clicking the migration tool icon on the desktop or selecting "Start – All Programs – ADP Migration Tool". Illustration 3-1 3.1 Initial tool start Illustration 3-2 The "ADP data migration" dialog box If the folders "CSVFiles“ and „ReportFiles“ do not yet exist in the installation folder, they are created after starting the tool and saved to the configuration file "GlobalConfig.soap“ in the installation folder.
Preferences Illustration 3-4 This group box in the "ADP data migration" dialog box displays all basic settings required for the tool. See section 3.2 to configure the preferences. Name and migration tool version. Login domain and user name. Starts configuration. Creates the data point name mapping file. Starts the basic consistency check for the data point name mapping file. Starts online migration. Migrates the archive. Tests the MD5 file checksum.
3.2 General Configuration Click "Configure" in the "ADP data migration" dialog box to open the tool configuration preferences. This is where you enter all required settings. This dialog box can be opened from any other dialog box within the tool. All settings are saved to the "GlobalConfig.soap“ file in the installation folder, making them available to the tool upon the next start. Illustration 3-5 Connection to ADP database Configures the connection to the ADP database.
Successful connection test. No connection to the database could be opened. Connection to InfoCenter database Configures the connection to the InfoCenter database. After installing an InfoCenter client on the computer, ODBC DSN "InfoCenter“ is available for connection to the InfoCenter database. 14/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Operation CM110773en 07.10.
Enter here this DSN together with the user name and password for the database connection. The two fields for user name and password can be blank as the ODBC connection is set to use trusted connection. Click "Test" to test the database connection. Successful test. No connection to the database could be opened. Checked data point name mapping file The data point name mapping file provided in the tool can be saved anywhere on the computer.
CSV file path Setting for the folder in which the csv files and their MD5 checksum files are saved during data migration. The tool does not support UNC folder names. If the csv files are saved to a different computer, the corresponding path must previously be connected via the Windows Explorer. You can also enter the path name by hand; but even then selection is possible by clicking [...]. Report file path Set the path and folder where the report files will be saved.
3.3 Create a data point name mapping file General This is where you create the data point name mapping file. See section 4.3.1 for more information on this file. Report file During file creation, a report file that can later be displayed is saved to the folder (see section 3.8). Open the dialog box Click "Start" in the "Data point name mapping file to be created" group box to open the dialog box. Illustration 3-6 Configured ODBC DSN connection string to the ADP database.
File name for the data point name mapping file. You can also enter the file name by hand, or select it by clicking [...]. Creates the data point name mapping file. A message informs on the completion of the process. The progress bar informs you on the progress. Closes the dialog box. 18/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Operation CM110773en 07.10.
3.4 General Basic consistency check The file to be checked must be a csv file with the following format: ADP-ReportitemId; IC-PointName; IC-PointDescription; IC-PointDataType; IC-PointUnit The following basic tests are carried out based on the final data point name mapping file provided to the tool for data migration: • • • • • Check the correct number of data points (e.g. 132). Check for continuous number of data points (no gaps). Check for duplicated ADP ReportItemId.
Starts the basic consistency check. A message box tells you that the check is done. Test result without errors. Test result with errors. Closes the dialog box. 20/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Operation CM110773en 07.10.
3.5 General Online migration The "Online migration" dialog box allows you to start the actual migration of ADP data from the online database. The values of the online database are read using the data point name mapping file provided by the tool and converted to a form that can be imported in InfoCenter and saved to the csv files. The csv file does not exceed 50 MB. See section 3.5.1 for a description on how to import the csv files in InfoCenter.
Illustration 3-7 Stop You can stop data migration any time by clicking "Cancel". This button becomes available only after you start migration of ADP data from the online database. The current csv file and the report file are closed. If an error interrupts data migration, the value of the data point where the process was stopped is displayed. Illustration 3-8 The current csv file and the report file are closed. Opens the report file.
Basic settings for data migration (see section 3.2). Opens the "Configure preferences" dialog box to configure the basic settings (see section 3.2). "Test": Checks to see if the ADP database contains ValueLog entries. "ValueLog migration": Imports the ValueLog entries in the InfoCenter database following a successful csv file import. Message boxes prior to starting the ValueLog import: "OK: Start import now. "Cancel: Stop import now.
"Test": Checks to see if the ADP database contains AuditTrail data. "AuditTrail migration": Imports the AuditTrail data in the InfoCenter database following a successful csv file import. “Cancel”: Stops data import in the InfoCenter database. Message boxes prior to starting the AuditTrail import: "OK: Start import now. "Cancel: Stop import now. "Start migration": Start data migration. "Cancel": Stops data migration. The progress bar informs you on the progress.
In addition to the status bar, a status text provides information on the progress of data migration. Data migration completed. After you click "OK", the report file opens as a PDF file. or or Closes the dialog box. For internal use only Building Technologies Building Automation 25/47 Migrating ADP to InfoCenter Operation CM110773en 07.10.
3.5.1 Workflow – Import migrated csv files in InfoCenter 1.) Copy the csv file(s) together with the MD5 checksum files to a folder on the InfoCenter server. 2.) Use the ADP2IC migration tool to verify the MD5 checksum of the csv file (see section 3.7). This is possible by temporarily installing the migration tool on the InfoCenter server. 3.) Log in to Windows as local administrator or InfoCenter administrator. 4.) Start the InfoCenter Administrator client application. 5.
3.6 Migrate archive Import archive The basic requirement to migrate ADP archive data is that the data be imported in table ARCHIV.ARCHIVVALUE of the ADP database. To do this, use the ORACLE import tool. This import tool is not part of the migration tool. Section 3.6.1 describes how to import an ADP archive in table ARCHIV.ARCHIVVALUE. The migration tool checks after the start of the archive migration whether the table ARCHIV.ARCHIVVALUE exists. If this does not exist, is checked whether the table ARCHIV.
Stop You can stop data migration any time by clicking "Cancel". This button becomes available only after you start migration of ADP data from the online database. The current csv file and the report file are closed. If an error interrupts data migration, the value of the data point where the process was stopped is displayed. Illustration 3-10 The current csv file and the report file are closed. Opens the report file. Basic settings for data migration (see section 3.2).
Start data migration. Information message box prior to start: "OK: Start data migration now. "Cancel: Stop data migration now. Message box to find out whether the migration should be continued by the table ARCHIV.VAL: "OK: Start data migration now. "Cancel: Stop data migration now. None of both tables ARCHIV.ARCHIVVALUE and ARCHIV.VAL was found. Test on deleted data points in the archive. Stops data migration. The progress bar informs you on the progress.
Data migration completed. After you click "OK", the report file opens as a PDF file. or Closes the dialog box. 30/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Operation CM110773en 07.10.
3.6.1 Workflow – Import an ADP archive 1.) Delete table archiv.val (ADP version > V1.8 delete table archiv.archivvalue) Make sure that the table archiv.val / archiv.archivvalue does not exist. To do this, use the SQL script with SQL Plus below. drop table archiv.val; Commit; ADP version > V1.8: drop table archiv.archivvalue; Commit; 2.) Read the individual archive files. The command line is in the entry prompt. Adjust the archive name. Migrate each archive file individually.
3.7 MD5 file checksum Test the MD5 file checksum An MD5 file checksum is formed after closing the csv file during data migration and saved to a file under the same name with file extension "md5“. The "Show report file" dialog box also allows for creating an MD5 checksum file for a freely selectable file. Use the dialog box to check if the current file checksum still matches the MD5 checksum file, i.e. the test finds out if anything was changed in the original file.
Here, all files having an MD5 checksum file are located. The path for the csv files entered in the configuration dialog box is used upon opening the dialog box. The tool does not support UNC folder names. You can also enter the path name by hand or select it by clicking [...]. If there are no MD5 checksum files in the selected folder, a message appears accordingly. All existing files are tested. You can limit the number of files to be tested.
Starts the MD5 file checksum test. Displays the test result. The upper list contains the successfully tested files, the bottom list the files tested with errors. Closes the dialog box. 34/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Operation CM110773en 07.10.
3.8 General Show report file Click "Show" in the "Report file" group box to open the dialog box. The report file created last is selected by default. You can display any file formats. The MD5 file checksum can be created for the selected file. Illustration 3-12 Select the file you want to display and for which you want to create the MD5 file checksum. You can also enter the file name by hand, or select it in the selection dialog box. Start the file selection dialog box.
Create the MD5 checksum file for the selected file. The tool does not support UNC folder names. The tool creates an *.md5 file in the same folder containing the MD5 file checksum. A confirmation message box appears. Shows the selected file. Closes the dialog box. 36/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Operation CM110773en 07.10.
General 4 Files 4.1 Report file The migration tool creates a report file in the preconfigured folder upon the following actions: • • • • • • Creating the data point name mapping file. Basic consistency check of the data point name mapping file. Online migration. ValueLog migration. AuditTrail migration. Migrate archive. The file is saved in PDF format. It can be displayed via the "Report file - show“ dialog box. 4.1.
4.1.2 Data point name mapping part In the case of online and archive migration, the part containing all data series follows the information part. The data series are listed according to the data point name mapping file provided to the tool. The following is displayed for each data series: • • • • • • ADP-ID for the data point. InfoCenter data point name. InfoCenter data point description. First entry on:. Last entry on:. Number of values. Illustration. 4-1 4.1.
Illustration. 4-2 Example for a report part during migration Illustration. 4-3 Example for a report part upon creating the mapping file Illustration. 4-4 Example for a report part during basic consistency check For internal use only Building Technologies Building Automation 39/47 Migrating ADP to InfoCenter Files CM110773en 07.10.
Illustration. 4-5 Example for a report part upon testing the ValueLog entries Illustration. 4-6 Example for a report part upon testing deleted data points 40/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Files CM110773en 07.10.
Illustration. 4-7 Example for a report part after a migration with found ValuLog entries and AuditTrail data For internal use only Building Technologies Building Automation 41/47 Migrating ADP to InfoCenter Files CM110773en 07.10.
4.2 CSV file General When migrating ADP data, csv files are created that are then provided for import in the InfoCenter database. The csv file does not exceed 50 MB. The csv files are saved to the folder set in the preferences. CSV and MD5 file The csv files can be moved to any folder together with the associated MD5 checksum files. The checksum information for the MD5 file checksum test continues to be available. Example for csv header # Export program: 'ADP2IC',Version = 'Version 1.
Example for data part 2000-04-19 17:00:00;Monitoring:M:$d111'000.AI;20.77;;C; 2000-04-19 17:30:00;Monitoring:M:$d111'000.AI;20.39;;C; 2000-04-19 18:00:00;Monitoring:M:$d111'000.AI;20.32;;C; 2000-04-19 18:30:00;Monitoring:M:$d111'000.AI;20.45;;C; : : : 2001-07-15 14:30:00;Monitoring:M:$d113'010.AI;16.04;F;C; 2001-07-15 15:00:00;Monitoring:M:$d113'010.AI;16.01;F;C; 2001-07-15 15:30:00;Monitoring:M:$d113'010.AI;16.00;F;C; 2001-07-15 16:00:00;Monitoring:M:$d113'010.AI;16.
General 4.3 Data point name mapping file 4.3.1 Mapping file created by the tool This csv file contains the following data: • Data point names and data point properties from the InfoCenter database in the following format: #PointName; PointDescriptor; PointType; PointUnit • Report ID and data point properties from the ADP database in the following format: #ReportitemId; TechAdr; Parameter; CompressFunction; CompressIntervall • Information on mapping ADP on the InfoCenter collection type.
4.3.2 General Mapping file provided to the tool This file contains the mapping information for ADP data points to InfoCenter data points, and must be provided to the migration tool to carry out migration. To create the data point name mapping file, the csv file created in the "Data point name mapping – creation" dialog box (see section 3.3) in the migration tool must be imported in an Excel worksheet.
/47 Building Technologies Building Automation For internal use only Migrating ADP to InfoCenter Files CM110773en 07.10.
Siemens Switzerland Ltd. Building Technologies Group International Headquarters Building Automation Gubelstrasse 22 CH-6301 Zug Tel. +41 41-724 24 24 Fax +41 41-724 35 22 www.sbt.siemens.com © 2006 Siemens Switzerland Ltd. Subject to change For internal use only Building Technologies Building Automation 47/47 Migrating ADP to InfoCenter CM110773en 07.10.
