COPYMINDER NETWORK SERVER GUIDE

Transcription

1 COPYMINDER NETWORK SERVER GUIDE Contents Installing the GeoEnviron CopyMinder Network Server... 2 CM Server Installation Procedure... 2 Manual Installation of CMServer... 3 Client Installation... 3 Managing the CMServer Service... 5 Checking if the Service is running... 5 Checking the Status of Licences using CMViewer... 5 Adding/Removing Products... 6 Troubleshooting... 7 Licence manager says that licences are all in use but they are not?... 7 General Errors... 7

2 Installing the GeoEnviron CopyMinder Network Server CM Server Installation Procedure The general procedure for setting up the CMServer is as follows: 1. Download the CMServer files using the following link: All GeoEnviron Database Modules and ArcGIS Extension Extract the folder. Depending on the software you are installing, you will find the following files: FILE NAME CMInstall.exe CMServer.exe CASEMAN.dll.cm CONTAM.dll.cm EPR.dll.cm FLOODING.dll.cm GEOMAP.dll.cm PRODUCT DESCRIPTION Do Not Use Licence Manager application Licence file for GeoEnviron Case Management Module Licence file for GeoEnviron Contaminated Land Module Licence file for GeoEnviron Environmental Permits Module Licence file for GeoEnviron Flooding Module Licence file for GeoEnviron GeoMap Module 3. Put CMServer.exe and the.cm file of each product (you will need to check products you are licensed to use) that you wish to install in a directory on the server. Ensure that the CMServer must have write access to this folder. 4. Run CMServer. It will display the configuration window. You should see an entry in the products list for each.cm file that you provided CMServer with. You will now need to decide whether you want to run CMServer as an application or a service. Choose the Service option. 5. The Network Configuration section allows you to configure the network settings that CMServer will use. In Automatic mode, CMServer will automatically choose the settings based on the best defaults combined with any existing configuration settings. This is the recommended setting. Custom mode allows you to manually specify the IP address and port that CMServer will listen on. When you have made your choice, continue to the next step. Important Note: If you are installing more than one CMServer Licence Manager then you should ensure that each one is listening on its own port. You should in this case use the custom mode and manually select the port for each server. 6. You are now ready to hit the Start button! When you do so, CMServer will perform a protection check for each product (.cm file) that you provided. Any un-

3 activated.cm files will require activation now using a product key configured to allow network installation. When all protection checks are complete the server will become operational. Manual Installation of CMServer There may be instances where the server that CMserver is to be installed is not permitted to access the internet anonymously. In this case you can install and activate the application manually. The procedure for doing this is as follows: 1) Create a copyminder ini file (<program name>.cm.ini) and add the following line: ActivationByProductKey = manual Do this step for each product that needs to use the cmserver. 2) Start the CMServer by double clicking on the cmserver.exe file 3) Select the Service option if you want to set up the application as a service (you will in nearly all instances) 4) Follow the prompts to complete the installation 5) After the cmserver is installed, you will be prompted to activate each client when you attempt to use the protected program. Select the Network Client option in each case and follow the prompts. Client Installation 7. Once CMServer is running, your protected software must be installed on the workstation computers. The first time each installation of your software is run, you will be prompted to specify what type of installation you want. You should choose Configure as a Network Client. In most cases the software will automatically detect the presence of the CopyMinder Network Server and the details will be filled in for them - all they need to do is click OK. 8. If the server details do not appear in the text field then it may be that the server is not running or that a firewall is blocking communication between the client and server machines. It will usually be preferable to find and resolve the problem that caused the auto-detection to fail, as this problem could also affect the server and client's ability to communicate with each other during protection checks. 9. If auto-detection fails, you can manually specify the server details to use, in the form SERVER:PORT where the SERVER part can either be a hostname or an IP address. For example, OFFICESERVER:10589 or : Things to note CMInstall.exe

4 The CMInstall.exe program is distributed along with the program. This program copies cm files to a directory to which the user had unrestricted access. You may need to run CMInstall.exe if: Your users are running under Windows Vista or later. They have Windows User Account Control (UAC) enabled. They want to install to their Program Files folder (or a sub-folder off it). They want to run in non-administrator mode. They want different users to be able to log on and run your application. Typically CMInstall.exe copies the files to the C:\Users\AppData folder. If virtualization is enabled the files may be copied to the C:\Users\USER\AppData\Local\VirtualStore\Program Files (x86)\ folder. If you are having trouble locating the folder search the C: drive for files containing the cm.ini. Firewalls Like most server software, CMServer accepts incoming connections by "listening" on a given IP address and port. If the machine running CMServer also has a firewall (including Windows firewall as well as third party firewall software), then the firewall software will need to be explicitly told to allow the incoming connections to get through to CMServer. Likewise, if a firewall exists on a machine between the server machine (the one running CMServer) and the client machines then this will need to be configured too. Important Failure to correctly configure your firewall(s) could result in the CopyMinder Server being inaccessible by client machines. Firewall Checklist Your firewall(s) must allow both TCP and UDP traffic through to CMServer. Your firewall(s) must allow CMServer to accept incoming connections on the IP address and port that you chose when setting up CMServer. Clients auto-detect CMServer by performing a multicast broadcast to and whichever port you configured CMServer to listen on. Your

5 Logfile firewall(s) must not block traffic destined for this address/port, or auto-detection will not work. CMServer maintains its own logfile in which it records various important events during its execution. While the server is running, all events are recorded to this file rather than being displayed on-screen. The most common reason for needing to view the logfile is to begin diagnosing a problem. You can view the logfile by running CMServer.exe with the /logfile command-line parameter. Alternatively, you can access it from the CMServer Viewer's menu. The logfile is actually stored on disk in the 'All Users' profile under the CMServer/<DID> directory (where <DID> is your Developer ID). Managing the CMServer Service Checking if the Service is running If CMServer is installed as a service, it can be controlled through Windows Services Management like any other service. Once Copyminder has been installed you will see the services in the Services console. The service for the GeoEnviron database is entitled CMServer_ABH whilst that for the MapEagle and ArcGIS Extensions is entitled CMServer_LR. From here you can see the status of the service (i.e. running or stopped) or you can stop or start the services as required. To uninstall the service, run CMServer.exe with the /u command-line parameter. Checking the Status of Licences using CMViewer CMViewer is utility that displays the status of the CopyMinder Network Server, the products it is serving and the network users currently connected to it. If CMServer is running as a service (which it will in all instances after being installed) you can start

6 CMViewer by running the CMServer.exe with the /viewer command-line parameter in a command prompt window. Make sure you have navigated to the directory in which the Cmserver.exe is located before running the command. The CMViewer dialog will be displayed showing the products available, the number of users currently logged onto each application and the maximum number of licences that are available for each application. You can click on the product to see the users that are logged onto the application. Adding/Removing Products If you ever need CMServer to serve a new/additional product then the.cm file for that product can be placed in the CMServer directory and CMInstall can be run all while the server is running. However, you will need to repeat steps 2-4 described in Installing the CopyMinder Network Server above before CMServer will start allowing network users to use that product. If you ever need to remove a product from CMServer then you must stop CMServer first.

7 Troubleshooting Licence manager says that licences are all in use but they are not? This can happen if the software has not shutdown properly for whatever reason. If possible check each PC to ensure that the software is no longer running as a process using the Task Manager. If this is not the problem then you can release all licences by restarting Licence Manager. To do this, stop the server using Windows Services Management. To restart it, right click on the cmserver.exe file and select Run as Admin. The protected program was unable to connect to the CopyMinder Network Server (CMServer). General Errors Whenever you get an error related to Copyminder you can find descriptions of the error numbers in the CopyMinder Knowledgebase which can be accessed at