AlgoRex EP7F-Z1 Update of country variants from EP7F-SR2 to EP7F-Z1 Fire & Security Products Siemens Building Technologies
Liefermöglichkeiten und technische Änderungen vorbehalten. Data and design subject to change without notice. / Supply subject to availability. Sous réserve de modifications techniques et de la disponibilité. © 2005 Copyright by Siemens AG, Building Technologies Group Wir behalten uns alle Rechte an diesem Dokument und an dem in ihm dargestellten Gegenstand vor.
1 About this document.............................................................................4 2 2.1 2.2 2.2.1 2.2.2 2.2.2.1 2.2.2.2 Introduction ...........................................................................................5 Components of a country variant.............................................................5 Creation of an EP7F-Z1 country variant ..................................................6 First AlgoRex variant in the country ...........................................
.8 4.8.1 4.8.2 4.8.2.1 4.8.2.2 4.8.2.3 4.8.3 4.8.3.1 4.8.3.2 4.8.4 4.8.4.1 4.8.4.2 4.8.5 4.8.5.1 4.8.5.2 4.8.5.3 4.9 4.10 1 Country specific adaptation/update of the base data variants................25 General procedure.................................................................................25 Update of the AlgoWorks Data Definition (ADD)....................................25 Documentation of changes compared to EP7F-SR2 .............................25 Customizing rules .........................
2 Introduction 2.
2.2 Creation of an EP7F-Z1 country variant There are different possibilities how an EP7F-Z1 country variant can be created. The applicable variant depends on the situation in the country: 2.2.1 First AlgoRex variant in the country If there are no previous AlgoRex country variants like EP7F-SR1 or EP7F-SR2, then there are no country specific definitions and settings that could be re-used and updated to EP7F-Z1. The country variant can be created as described in document [1]. 2.2.
3 Update process EP7F-SR2 to EP7F-Z1 3.1 Introduction This chapter gives a short overview of the update process for the different categories (see chapter 2.2.2). The details of the different steps of the process are described in chapter 4. The existing EP7F-SR2 country environment can be updated to and replaced with EP7F-Z1. For the update processes described in this document it is a precondition that the EP7F-SR2 country variant is installed on the PC. An update from one PC to another is not supported.
3.3 Category 2: in EP7F-SR2 standard texts and AlgoWorks texts have been translated „Category 2 countries” (see chapter 2.2.2; standard texts and AlgoWorks texts (menu, dialogues, messages, online help) have been translated in the EP7F-SR2 country variant but no or only minor changes have been made in the Country Defaults and Station Templates) have to carry out following update procedure: 1. Task Preparatory work by HQ completed Details, see… 2.
3.4 Category 3: in EP7F-SR2 standard texts and AlgoWorks texts have been translated AND Country Defaults and Station Templates have been adapted „Category 3 countries” (see chapter 2.2.2; standard texts and AlgoWorks texts (menu, dialogues, messages, online help) have been translated in the EP7F-SR2 country variant AND Country Defaults and Station Templates have been adapted with many changes compared to the international variant) have to carry out following update procedure: 1.
4 Detailed descriptions 4.1 Introduction This chapter describes in detail the different steps of the update process EP7FSR2 → EP7F-Z1. Please see chapter 3 for an overview of the update process and the sequence of the different steps of the process. 4.2 Creation of an EP7F-SR2 backup copy It is strongly recommended to make a backup copy of the complete EP7F-SR2 environment (including all international and country specific Tool Customizing files → help sources, menu definitions etc.
4.4.2 AlgoWorks program setup The complete TC version of EP7F-Z1 must be installed. A new AlgoWorks country variant with the chosen country code is created. The installation procedure is as described in document [1]. If previously no AlgoWorks version had been installed on the PC additional drivers and utilities have to be installed → see document [1].
4.4.3 Base data variant setup If an EP7F version was installed before, the following steps are carried out automatically during the TC installation of the international J0 BDVs of EP7F-Z1: 1. The 2 new international J0 BDVs for the configuration variants CS1140 and CS1145 are installed 2. The existing J0 help source in the directory ..\BDV\TC_Sources_BDV\HELP\J0\ is replaced with the new help source from EP7F-Z1 Î Mapping tables etc. of the EP7F metadata version 7.
4.5 Manual corrections after installation of EP7F-Z1 4.5.1 Backup of the help sources It is recommended to make a backup copy of the backup directories created during installation of the international EP7F-Z1 BDV (see chapter 4.4.3), before starting manual corrections to the BDV (according chapter 4.5.2). In case of an emergency this data may be used to recover the original state. 4.5.
during execution of the script the following information is queried: – ”Source BDV”: existing BDV stamps to which the new J0 stamps shall be added Î BDV name of the most up-to-date county-specific CS1140 or CS1145 BDV of EP7F-SR2 – “Target BDV”: new BDV stamps which shall be added Î BDV name of the international CS1140 or CS1145 BDV of EP7F-Z1 Î For each source stamp found, the script adds the corresponding target stamp.
After completion of the two described steps (once for the CS1140-BDV and once for the CS1145-BDV) the help sources are ready for adaptation to the EP7F-Z1 functionality. → Chapter 4.8.5 You will find the following stamps in the help sources: – Stamps of the international BDVs for EP7F-SR2 (and possibly older international EP7F-BDVs depending on which service releases were installed and processed by the respective TC).
4.5.3 Takeover of the country specific program helps from EP7F-SR2 EP7F-SR2 country variants with country specific help adaptations may be takenover into the EP7F-Z1 environment and may be adapted to the new functionality. Because help directories contain, among the help sources, additional EP-specific files (e.g. map files) it is not possible to copy the entire help directory. This would cause errors with the new version.
Example using country variant B0_00: The directory sub-structure of HELP_SOURCES will be duplicated in a new, parallel directory HELP_SOURCES_UPDATE. All allowed country specific files will be copied into the respective sub-directories automatically. 3. Copy the country specific EP7F-SR2 help files into the EP7F-Z1 country environment for reuse. Î Copy the entire contents of the EP7F-SR2 sub-directories (sub-directories in ..\TC_Sources_CFG\HELP_SOURCES_UPDATE\) to the respective, equally named sub-direct
Example using country variant B_00: Copy the entire contents of the EP7F-SR2 sub-directories to the respective, equally named sub-directories of the EP7F-Z1 country variants The help source is now ready for adaptation to the new EP7F-Z1 functionality. → see chapter 4.7.4 18 Siemens Building Technologies Fire & Security Products 008455_b_en_--.doc 02.
4.6 Creation of the country specific EP7F-Z1 environment 4.6.1 Creation of the AlgoWorks country variant The country specific AlgoWorks environment has been created during the installation of the AlgoWorks program (4.4.2) and the manual adaptations carried out afterwards (4.5.2). It is ready for the take-over of files prepared by HQ (4.6.4) and the update to EP7F-Z1 (4.7). 4.6.2 Creation of the country specific base data variants During the installation (4.4.
1. Using the file explorer: copy all files from the country specific BDV directory on the CD provided by HQ to the respective directory on the PC Î overwrite all existing files (confirm the message with ‘yes, all’) Example: – directory on the CD: ..\SE\B0_1140_770_03\ – directory on the PC: C:\Program Files\SIEMENS\AlgoWorks\BDV\B0_1140_770_03\ 2. Set the file attributes of all copied files to ‘writable’ BDV name 4.6.
4.7 Country specific adaptation/update of the AlgoWorks program environment 4.7.1 General procedure For the country specific adaptation of AlgoWorks EP7F-Z1 the TC has to proceed as follows: 1. Preconditions: – Installation according chapter 4.4.2 and 4.4.3 completed – Manual adaptations according chapter 4.5 completed – Program files prepared by HQ taken over → see 4.6.4 2. Update AMD → see 4.7.2 3. Update ATD → see 4.7.3 4. Update program help → see 4.7.4 4.7.
4.7.2.3 Update procedure For the AMD update, please proceed as follows: 1. For preconditions see chapter 4.7.1 2. Open the following two AMD files with Excel: – for the adaptation the AMD of the country specific EP7F-Z1 program variant → e.g. ..\AW1_4\B0_00_CFG\TC_Sources_CFG\DEFINITIONS\MenuCfgData.xls – as reference the AMD of the respective international EP7F-Z1 variant → ..\AW1_4\J0_cfg\TC_Sources_CFG\DEFINITIONS\MenuCfgData.xls 3.
4.7.3.3 Update procedure For the ATD update, please proceed as follows: 1. For preconditions see chapter 4.7.1 2. Open the following two ATD files with Excel: – for the adaptation the ATD of the country specific EP7F-Z1 program variant → e.g. ..\AW1_4\B0_00_CFG\TC_Sources_CFG\DEFINITIONS\TextCfgData.xls – as reference the ATD of the respective international EP7F-Z1 variant → ..\AW1_4\J0_cfg\TC_Sources_CFG\DEFINITIONS\TextCfgData.xls 3.
4.7.4 Update of the AlgoWorks program help 4.7.4.1 Documentation of changes compared to EP7F-SR2 All new or changed topics have been marked using the ‘New/Changed Marker’ (“Flash marker”). This marker is visible in the table of contents (TOC) of the compiled help (→ open file directly or call help in AlgoWorks). In addition to these markers, a brief overview of the changes is documented in the release notes. Example for the markers (SAM help): New or changed topics are marked with a „Flash marker“ 4.7.
4.8 Country specific adaptation/update of the base data variants 4.8.1 General procedure Please proceed as follows to update your country specific base data variants to EP7F-Z1: 1. Preconditions: – Installation (see chapter 4.4) and manual adaptations (see chapter 4.5) completed – Country specific BDVs (CS1140 and CS1145) created based on the international J0 variants (see chapter 4.6.2) – BDV files prepared by HQ copied into the country environment (see chapter 4.6.3) 2.
4. Repeat step 3 with all remaining sheets 5. Update version no. and date in the document properties dialog. For syntax see document [1] 6. Save all changes 7. Create new binary files using the adapted country specific ADD according to document [1] 8. Repeat steps 2 - 7 for other country specific EP7F-Z1 BDVs Î depending on the case it may be possible to transfer parts of an ADD into another (e.g. for multiple language variants), but extreme caution is required → see respective information in document [1].
4.8.3.2 Adaptation of “background nodes” Where Station Templates What Country Defaults Following nodes were set to international EP7F-Z1 (J0) during the conversion of the EP7F-SR2 country variants to EP7F-Z1: Remarks All All Menu ‚Site’ → ‚Site Parameters’, Tab ‚Master Clock’ - CC CI CK Menu ‚Site’ → ‚Site Parameters’, Tab ‚Site Config’ - All Default passwords Menu ‚Site’ → ‚Site Parameters’, Tab ‚Passwords - CC CI CT HQ should already have done this setting.
4.8.4 Update of Standard texts 4.8.4.1 Documentation of changes compared to EP7F-SR2 The standard text differences (new/changed/deleted texts) between EP7F-SR2 and EP7F-Z1 are listed in a difference file that is stored on the release CD. The same information can also be found in the Release Notes (see document [2]). Example: 4.8.4.2 Update procedure The procedure as described in document [1] for the update of standard texts from EP5 to EP7F is still valid for the update from EP7F-SR2 to EP7F-Z1.
4.8.5 Update of the BDV help 4.8.5.1 Documentation of changes compared to EP7F-SR2 All new or changed topics have been marked using the ‘New/Changed Marker’ (“Flash marker”). This marker is visible in the table of contents (TOC) of the compiled help (→ open file directly or call help in AlgoWorks). In addition to these markers, a brief overview of the changes is documented in the release notes. Example for the markers (BDV help): New or changed topic are marked by a „Flash marker“ 4.8.5.
4.8.5.3 Error handling if stamps are missing for the new BDVs If the new country specific BDVs have been created before the help sources have been adapted according chapter 4.5.2, then the help sources are still erroneous or incomplete. To correct these deficiencies, please proceed as follows: a) If country specific EP7F-SR2 help sources shall be taken over: Perform manual adaptations according 4.5.2.1, where as the stamp update script has to be executed twice for each the CS1140 BDV and the CS1145 BDV: 1.
Detailed descriptions 31 Siemens Building Technologies Fire & Security Products 008455_b_en_--.doc 02.
Siemens Building Technologies AG Alte Landstr. 411 CH-8708 Männedorf Tel. +41 1 - 922 6111 Fax +41 1 - 922 6450 www.sibt.com Document no. 008455_b_en_--.doc Edition 02.