Maintenance COMOS. Platform Maintenance. Trademarks 1. Information on version change. Switching the licensing technique

Transcription

1 Trademarks 1 Information on version change 2 COMOS Platform Switching the licensing technique 3 plan for the SQL server 4 Backup and recovery 5 Operating Manual 09/2011 A5E

2 Legal information 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 with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken. CAUTION without a safety alert symbol, indicates that property damage can result if proper precautions are not taken. NOTICE indicates that an unintended result or situation can occur if the relevant information is not taken into account. 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 Industry Sector Postfach NÜRNBERG GERMANY A5E P 09/2011 Copyright Siemens AG Technical data subject to change

3 Table of contents 1 Trademarks Information on version change Definitions Testing new version Create a copy of the database Installing a new COMOS client Adjusting the COMOS index and the database scheme Database adjustment Increasing the document version Increasing the database version Test Changeover Recommended: Complete changeover of all clients Possible: Mixed installation Switching the licensing technique Content of the document Communication Conversion when using a local license Reversion scenario when using a local license Switch when using a license server Reversion scenario when using a license server Technical sequence Registering Comos.LicenseLib.dll plan for the SQL server Backup and recovery Disclaimer Split COMOS data COMOS data backup Database accessibility Backup of the CLS data...22 Operating Manual, 09/2011, A5E

4 Table of contents 4 Operating Manual, 09/2011, A5E

5 Trademarks 1 Trademarks Registered trademark: COMOS Operating Manual, 09/2011, A5E

6 Trademarks 6 Operating Manual, 09/2011, A5E

7 Information on version change Definitions COMOS version The COMOS version is maintained as a two-digit number. Example: "COMOS 9.2" This may be followed by a third digit representing a release number. A code number for an update may also be included. Example: "COMOS 9.2 Update 200" To display the COMOS version, select "Help > Comos Info" from the menu bar. Database scheme All object properties available in COMOS are stored in the COMOSDB. When a new object property is introduced for a current COMOS version, the COMOSDB must be expanded so that this new property can be incorporated. COMOS index The COMOS index is a function for boosting the performance of database adjustment. This tool carries out a number of tasks for the administrator concerning the administration of base data. Database version The COMOSDB is assigned specific version numbers whenever relevant enhancements are made. The change of a database version has the result that older COMOS clients can no longer work with the database. COMOS document version Similar to the database model, there is a continuous development of options for documents. The document version regulates the range of options available for the user. New options can only be set when the document version has been increased. Operating Manual, 09/2011, A5E

8 Information on version change 2.2 Testing new version 2.2 Testing new version The COMOS version and the COMOSDB are interwoven with one another in many ways. In particular, the display of documents or certain operating methods can change. Databases that are in productive use must not be converted unchecked under any circumstances. In any case, a version test requires the following steps: 1. Create a copy of the database (Page 8) 2. Installing a new COMOS client (Page 8) 3. Adjusting the COMOS index and the database scheme (Page 8) 4. Database adjustment (Page 9) 5. Increasing the document version (Page 9) 6. Increasing the database version (Page 9) 7. Test (Page 10) Create a copy of the database Make a copy of the database and test it with the current COMOS version. Do this by creating a physical copy of the database plus document directory while retaining the RDBMS. On a server database that would be a dump which is loaded into a new database. In Access, a physical copy of the mdb file and the document directory are sufficient. You have the option of exporting the data from a server database into an Access database, which can then be tested. Not only is this a quick way to make a copy of the server database, but the performance of the RDBMS is also improved if you use an Access database Installing a new COMOS client It is not possible to run different COMOS versions in parallel on one PC. The installation of the current COMOS version requires a full removal of the old COMOS version. You can find additional information on this topic in the "Installation" manual Adjusting the COMOS index and the database scheme If a current COMOS version offers new object properties, you need to adjust the database scheme. You cannot use the current COMOS version unless the database scheme has been adjusted. If a current COMOS version offers new database indices, you need to adjust the COMOS index. Once you have done this, you will be able to enjoy improved performance. Performance will not be improved unless you adjust the COMOS index. 8 Operating Manual, 09/2011, A5E

9 Information on version change 2.2 Testing new version The database scheme and COMOS index will be checked and adjusted together. If you have administrator rights and use these to open a current COMOS version with an older COMOSDB, a dialog window appears. "No" button If you click the "No" button, the database remains unchanged and is not opened. COMOS remains open and you can select a suitable database. "Yes" button To adjust the database scheme and the indices, click the "Yes" button. Both the older and the new, current COMOS clients can continue to work as usual. No kind of data loss can occur. However, the older clients use the options that were made available only by updating the database model. If you have administrator rights and open a current COMOS version with an older COMOSDB, you will be notified that the tables and indices need to be adjusted. After the message, COMOS remains open and you can select another suitable database Database adjustment This tool carries out a number of tasks for the administrator concerning the administration of base data. On the one hand, this pertains to new base data without which the specific new functionalities cannot be used. On the other hand, this pertains to conversions that offer a higher degree of efficiency. You can find more information on this topic in the "COMOS Administration" manual, keyword "Database adjustment" Increasing the document version The document version is managed in COMOS with the help of the Support dialog. You will find additional information on this topic in the "COMOS Administration" manual, keyword "Adjusting versions". Once the document version has been increased, this cannot be fully undone. The documents saved or created after the increase cannot be reconverted Increasing the database version The database version is managed in COMOS with the help of the Support dialog. You will find additional information on this topic in the "COMOS Administration" manual, keyword "Adjusting versions". Once the database version has been increased, this cannot be undone. Operating Manual, 09/2011, A5E

10 Information on version change 2.3 Changeover Test A test must include all activities and COMOS tools that are relevant for the production processes of the company. 2.3 Changeover Recommended: Complete changeover of all clients A complete changeover involves the following steps: Log off all COMOS clients from the database. Install the new COMOS version on all clients. Adjust the database scheme and indices, then carry out database adjustment. If necessary adjust the document version and the database version. See also section Testing new version (Page 8) Possible: Mixed installation To perform a mixed changeover/mixed installation, proceed as follows: Install the new version on the individual computers. Log off all COMOS clients from the database. Adjust the database scheme and indices. The clients may log in again. New and old clients can work. However, some new functionalities are not yet available at this point, as neither the database version nor the document version have been increased. Change over all the remaining clients and adjust the databases. Once all clients have been changed over, adjust the document version and database version (if applicable). See also section Increasing the document version (Page 9) and section Increasing the database version (Page 9). 10 Operating Manual, 09/2011, A5E

11 Switching the licensing technique Content of the document Conversion of the licensing technique for all COMOS versions earlier than COMOS 9.0 (Vega). Background In older COMOS versions, the FlexLM software from the third-party vendor, Macrovision, is used as a license server. Since April 1, 2008, a proprietary development of Siemens AG has been in use: COMOS LS. COMOS LS offers new options for license configuration and, together with the Server Monitor, provides a comprehensive overview of all available and currently used licenses. The conversion of the licensing technique also affects the use of new local licenses. Old systems and Updates If the license file does not need to be changed, you can continue using the existing COMOS FlexLM license server on old systems up to COMOS 8.2. If the license file does not need to be updated, you can continue using the local licenses on mixed systems. Mixed systems Let's assume you are working with a local license or a single license server. From a technical point of view, there are no objections to operate mixed networks. But it is not possible to run the old and new licensing technique simultaneously on the same Server PC. Mandatory conversion It is mandatory to change the licensing technique in the following cases: Upgrade to COMOS 9.0 or higher Installation of a license file that was created after April 1, 2008 Operating Manual, 09/2011, A5E

12 Switching the licensing technique 3.2 Communication 3.2 Communication Requirement The following options must be activated on both the client and the server: HTTP protocol Port Client configuration of the port/configuration of the port for the RemoteLicenseService: "Comos.LicenseLib.config" file Key: <setting key="comoslicenseserverport" value="27011" /> Default value: This value is also used in the case of a missing key or an empty value. Server configuration of the port: "ComosLicenseServer.exe.config" file Node: <appsettings> Key: <add key="comoslicenseserverport" value="27011" /> Default value: This value is also used in the case of a missing key or an empty value. Monitor configuration of the port: "ComosLicenseServerMonitor.exe.config" file Node: <appsettings> Key: <add key="comoslicenseserverport" value="27011" /> Default value: This value is also used in the case of a missing key or an empty value. 12 Operating Manual, 09/2011, A5E

13 Switching the licensing technique 3.3 Conversion when using a local license 3.3 Conversion when using a local license Required components COMOS update via COMOS 8.2 Update 424 (or higher) Microsoft.NET Framework 3.5 SP1 License file, starting April 1, 2008 Procedure To convert the license, proceed as follows: 1. Quit COMOS. 2. Carry out a COMOS update via an update. 3. Install Microsoft.NET Framework 3.5 SP1, if not yet installed. When.NET Framework 3.5 SP1 is installed, the PC must be restarted. The corresponding setup can be found on the Siemens AG FTP server or on the Microsoft website. 4. Run the "<comos>\bin\comoslicenselib_register.cmd" file. See also section Registering Comos.LicenseLib.dll (Page 18). 5. Move the "<comos>\ocx\license.dat" file to a backup folder. 6. Place the new "ComosLicense.xml" file in the "<comos>\config" directory. 7. Start COMOS. The first login after the conversion may take a while. See also section Technical sequence (Page 18). Changes on the computer Updating COMOS Installation of Framework 2.0 (if not yet installed) Registration of Comos.LicenseLib.dll Operating Manual, 09/2011, A5E

14 Switching the licensing technique 3.4 Reversion scenario when using a local license 3.4 Reversion scenario when using a local license Requirement You must not be using any local licenses at the same time as using a license server. 1. Quit COMOS. 2. Move the "ComosLicense.xml" file to a backup folder. 3. Return the backed up "License.dat" file to the "<comos>\ocx\" folder. 4. Start COMOS. The first login after the conversion may take a while. See also section Technical sequence (Page 18). 3.5 Switch when using a license server Required components COMOS update via COMOS 8.2 Update 424 (or higher) Setup: "CLS license server.zip" Contains: Microsoft.NET Framework 2.0 and Windows Services Enhancement 3.0 for.net License file, starting April 1, 2008 Optional: Setting up a test system No test environment can be set up on the license server of the production system. The current "ComosFlexLM" license server and the new "Comos LS" license server cannot run simultaneously on the same dongle. You have the option of setting up a test server. For further information, please contact your customer adviser. 14 Operating Manual, 09/2011, A5E

15 Switching the licensing technique 3.5 Switch when using a license server Step 1: Install COMOS LS The PC that runs the Windows Service for the license server is called the "Server PC" in the following. In normal cases, the conversion can be done directly on the production system, as there is a reversion scenario in the unlikely case that a problem should arise. 1. Unpack the "CLS license server.zip" file. 2. Run the "Setup.exe" file. 3. Follow the setup instructions. The new COMOS LS can be installed as long as the old "ComosFlexLM" service is still running. The monitor automatically identifies the machine name of the PC on which the software is installed. 4. Follow the setup instructions. "Microsoft.NET Framework 2.0". The installation of.net Framework 2.0 requires a restart of the Server. If necessary, setup installs: "Windows Services Enhancement 3.0 for.net". Setup requests a license file. If you wish to copy the license file to the license directory at a later point, click the "Cancel" button. Step 2: Updating COMOS workstations If you are using a Client PC, carry out a COMOS update via a service pack. 1. Quit the client. 2. If you have changed the default value of the port for communicating with the license server, enter the new values on the clients as well. "config\comos.licenselib.config" file, <setting key="comoslicenseserverport" value="" /> Adjust the file once and add the edited file to the service pack. Then distribute the service pack. 3. Update the client via the service pack. 4. Install Microsoft.NET Framework 2.0, if not yet installed. The corresponding setup can be found on the Siemens AG FTP server or on the Microsoft website. 5. Run the "<comos>\bin\comoslicenselib_register.cmd" file. See also section Registering Comos.LicenseLib.dll (Page 18). After the update, the Clients can continue to work as usual. The Clients can be converted one by one. However, all clients must be converted before you can carry out the next step. Operating Manual, 09/2011, A5E

16 Switching the licensing technique 3.5 Switch when using a license server Step 3: Commission COMOS LS/Start license server Convert License Server. 1. Log off all clients. COMOS clients cannot work without a license server. If you shut down the license server, all active COMOS clients will be terminated automatically; data that has not been saved will be discarded without a query. 2. Quit the COMOSFlexLM Windows service. 3. Switch the start mode from "Automatic" to "Manual". Do not uninstall COMOSFlexLM. 4. If the "ComosLicensexxx.xml" license file is not yet inside the directory you specified during setup, copy it into this directory now. 5. If you are not using the default value of "27011" for the port, adjust the following: "ComosLicenseServer.exe.config" file, <appsettings>, Key: <add key="comoslicenseserverport" value="27011" /> 6. To start the ServerMonitor of the new COMOS license server, go to the Windows Start menu and select "Programs > ComosLicenseServer", followed by the "ComosLicenseServerMonitor.exe" file. 7. Check the "License Server" tab to ensure that the license file has been recognized and is valid. 8. Click the "Start License Server" button. Step 4: Restart COMOS clients The first login after the conversion may take a while. See also section Technical sequence (Page 18). Effect on the NamedUser list The NamedUser list is reset with the conversion to the new licensing technique. The number of NamedUser licenses is retained, but the valid users are no longer determined. The participant list is created anew, based on the logins. 16 Operating Manual, 09/2011, A5E

17 Switching the licensing technique 3.6 Reversion scenario when using a license server Changes on the computer Clients Updating COMOS Installation of Framework 2.0 (if not yet installed) Registration of "Comos.LicenseLib.dll" Server Installation of the new license server Installation of Framework 2.0 (if not yet installed) Installation of WSE 3.0 (if not yet installed) 3.6 Reversion scenario when using a license server Up to COMOS 8.2, the previous technique remains fully functional. For this reason, you should merely deactivate COMOSFlexLM, instead of uninstalling it. To reactivate the old licensing technique, proceed as follows: 1. Quit all clients. COMOS clients cannot work without a license server. If you shut down the license server, all active COMOS clients will be terminated; work that has not been saved will be discarded without a query. 2. Quit the "ComosLicenseServer Service" Windows service. 3. Switch the start mode of the Windows service from "Automatic" to "Manual". 4. Start the "ComosFlexLM" Windows service. 5. Please note that you must use the same Server PC. 6. Switch the start mode of the Windows service from "Manual" to "Automatic". 7. Start the COMOS clients. The first login after the conversion may take a while. See also section Technical sequence (Page 18). Operating Manual, 09/2011, A5E

18 Switching the licensing technique 3.7 Technical sequence 3.7 Technical sequence After the update, COMOS proceeds as follows: To obtain a license using the old technique, COMOS searches for the local "License.dat" license file. If COMOS does not find this local license file, it searches for the COMOSFlexLM license server. If COMOS is unable to obtain a license using the old technique, it uses the new technique instead and searches for the local "ComosLicensexxx.xml" license file. If COMOS does not find the local license, it searches for the COMOSLicenseServer license server. On the clients, the name of the license server is copied from the Registry both for the old and the new licensing techniques. If you are using the same computer for the license server as you did before, then COMOS finds the valid entry in the Registry and hence also the license server. If you are using a different computer for the license server, you must set the new server name on each client using the "<comos>\bin\setlicpath.exe" tool. If COMOS has found a license with the help of the new licensing technique, information will be set in COMOS stating that the new licensing technique is being used. The new licensing technique will be used to activate a license during the next login. Subsequent logins are then somewhat faster than the first login. In a reversion scenario, the system attempts to obtain a license using the new technique first. If this fails, it then attempts to obtain a license using the old technique. 3.8 Registering Comos.LicenseLib.dll The "Comos.LicenseLib.dll" library has been developed for COMOS LS. This library uses the.net technology, and as such cannot be registered using older registration tools..net technology requires that such components are registered using the "RegAsm.exe" tool. This file is an integral part of the Microsoft.NET Framework 2.0. setup. Thus, it is possible to search for the "RegAsm.exe" file and to register the "Comos.LicenseLib.dll" in a DOS box using this file. Support The "RegAsm.exe" has also been copied into the "<Comos>\bin" directory under the name "RegAsm_V exe". A command file has been added to the "<Comos>\bin" directory: "ComosLicenseLib_Register.cmd". This file activates "RegAsm_V exe" in the "bin" directory for the purpose of registering "Comos.LicenseLib.dll". The counterpart to this is "ComosLicenseLib_Unregister.cmd". This is used to unregister "Comos.LicenseLib.dll". If you wish to switch to the old license server, the "ComosLicenseLib.dll file" can remain registered. 18 Operating Manual, 09/2011, A5E

19 plan for the SQL server 4 During a longer operation it may occur that the MS SQL server still administers the indices but does not work ideally anymore. Microsoft offers the " plan" tool to solve this kind of problem. options For Microsoft SQL Server, the following three options have proven themselves to be a reliable combination for creating a maintenance plan for the COMOSDB: Reorganizing the index Updating statistics Checking the integrity of the database To access these options, start the the " Plan Wizard" in the SQL Server 2005 maintenance program. Run the Plan Wizard once a week. Multiple times a week with a high load of new or changed data. When the maintenance plan is run for the first time, it creates a high load on the server. Therefore, you should start the maintenance plan outside of working hours. With this in mind, you should use the wizard to set up a schedule when creating the maintenance plan. You are free to modify this schedule at a later date. In the case of a highly fragmented index you can use the "Create new index" option once. This usually takes a lot longer than the "Reorganize index" option but the results are practically identical. Detecting the fragmentation degree SQL Server 2000: DBCC SHOWCONTIG( dbo.lc_spec ) with fast SQL Server 2005: DBCC SHOWCONTIG( LC_SPEC ) with fast A single apostrophe is used in the above commands in order to state the parameter. Other possibilities apart from LC_SPEC: LC_CDEVICE LC_DEVICE LC_DOCUMENT If the level of "logical scan fragmentation" exceeds 20%, you should recreate the indices. SQL Server 2005: Setting via the user interface within a one-time maintenance plan. SQL Server 2000: Manual conducting via the DBCC DBREINDEX( dbo.table name ) command for the most affected tables. Operating Manual, 09/2011, A5E

20 plan for the SQL server Downsizing storage space After recreating the index the reserved area of the database may have many gigabytes of free storage space. Therefore, those customers who do not experience high volumes of new data can reduce the database once so that there is 10% of free storage space remaining. This function can be reached the following way: Context menu of the respective database "Tasks > Downsize > Database" Database maintenance plan Via the DBCC SHRINKDATABASE(`name`, 10) command This function strains the resources largely and needs about 5 minutes per gigabyte database size. When you select the option, a dialog window is displayed for entering the target size. This process can also take up to 5-10 minutes for each gigabyte. Downsizing the log file for the "Complete" recovery model In order for the "Entire" recovery model to work, you must save the database at least once after its creation. The SQL server additionally saves all transactions of the "Complete" recovery model into a log file. This log file is not automatically downsized for a backup and grows continuously. It is not usually necessary to enter all transactions in the log file. All you need to do is save the transactions performed since the last backup. In light of this, you can downsize the log file after carrying out a database backup. The following options are available: "Downsize files" option The DBCC SHRINKFILE ('log. file name', 0) command Parameter: Logical file name: To be taken from the database properties dialog in the "SQL Management Studio" maintenance tool. Number (here: 0): Free storage space in percent. 0 means that no free storage space is entered. 20 Operating Manual, 09/2011, A5E

21 Backup and recovery Disclaimer Data backup is the sole responsibility of the COMOS licensee. Siemens AG does not offer any guarantee or accept any liability in connection with backup and recovery. The following information is non-binding and intended only to provide assistance. 5.2 Split COMOS data COMOS data consists of two components: The actual database in which information regarding the COMOS objects and all administrative information is stored. An associated document directory in which the report files are stored. In case of an Access database, the database (MDB file) and document directory are located next to each other in a directory on a file server. In the case of server databases (MS SQL or Oracle), in the interest of performance you should use two separate server systems: a database server and a file server for the documents. 5.3 COMOS data backup Shared backup time of both data components To ensure data consistency, back up the database and the document directory at the same time. Do not carry out any work in the database from the moment the backup process starts until it has been completed. Consequently, although the backup process is not critical for Access databases, by contrast server databases usually involve the use of different backup mechanisms (file backup of the documents, database backup by agents, dumps, etc.). Operating Manual, 09/2011, A5E

22 Backup and recovery 5.4 Database accessibility 5.4 Database accessibility In order to increase the availability of the COMOSDB you can resort to familiar redundancy mechanisms such as mirroring of hard disks or servers. Remember to duplicate both the database and the document directory. COMOS supports Microsoft cluster services for SQL Server 2005 and Veritas cluster services for Oracle, enabling you to achieve system stability for the database via a hot standby cluster configuration. In case of a failure of a cluster node the previously inactive cluster node takes over the work. You will need to restart any database operations that were already in progress, e.g. the creation of an evaluative report. The cluster services only mirror the database functionality, not the Random Access Memory/CPU of the database server. 5.5 Backup of the CLS data The COMOS license server stores information regarding the current license usage in the subdirectories "\data" and "\license". The location of the directory usually is a subdirectory of the installation location of the CLS. You also have the option of specifying a folder on the network during installation. Back up these directories to retain the original user mapping of the Named User Licenses following a restore operation or after the license server has been reinstalled. 22 Operating Manual, 09/2011, A5E