The instructions were written for Windows 7. They have run without problems for Windows 8.

Transcription

1 1 Download and Install CCS for Windows This procedure describes how to install CCS5 on a single Windows PC (client and server running on the same physical machine), and a single user. If you are setting up a more complex client/server system, with multiple users, under a dedicated contract then you will need access to our CCS WIKI; please request an account from your Terma contact point. Even if your ultimate goal is to setup and manage a full CCS, it may be worthwhile for you to try out these instructions first on a private machine; it may help you to understand CCS by starting with a simple installation first. The instructions were written for Windows 7. They have run without problems for Windows 8. NOTE: detailed instructions - especially screen shots - may go slightly out of date over time. If you find an important inconsistency that we missed, please let us know. Preparations Disable Firewall For simplicity, these instructions assume that Windows firewall is off. The CCS is usually installed in a secure environment wherein no external connections are directly connected to the CCS LAN. Clear Settings (optional) Follow these instructions if you have a very old installation, or if you are switching between projects with different settings (for example if you are preparing for CCS training with a user who is normally working on a specific project). Click on the SET application on the desktop, and the CCS settings editor will appear Hit Clear Settings button Hit OK to confirm Quit from the CCS settings editor If settings have been installed under HKEY_LOCAL_MACHINE (at host level rather than individual user), then you will need to clear settings using the windows registry editor regedit Ensure you have administrative privilege Run regedit

2 HINT: enter regedit in the search window in the Windows start menu Navigate to the nodes o HKEY_CURRENT_USER\SOFTWARE\ o HKEY_LOCAL_MACHINE\SOFTWARE\ Delete the TERMA nodes 2 NOTE: this will clear your license; you will need to restore your license if you take this approach! Uninstall Old Version (optional) It is recommended, if not mandatory, to uninstall any previous versions. HINT: CCS uses various dynamically loaded files and libraries. Installing on top of a previous version does not guarantee that out of date libraries have been removed. Unless you have patched any data in the CCS installation itself, then your user-level data is completely safe. Navigate to Start > CCS > Uninstall Install Archive RDBMS (MySQL) MySQL is the most commonly-used database back-end; these short instructions assume this is what you will use. NOTE: in our experience, some RDBMS back-ends prefer a plain host name (lower case, not unusually long, no hyphens, etc). You can avoid problems by using a simple host name. You can download the installer from: HINT: Use the non-web download to avoid repeated downloads, or need for internet access when installing several CCS hosts : e.g. mysql-installer-community msi You could instead download and install XAMPP from: NOTE: XAMPP is required if you plan to use the CCS WEB application Accept the default installation options. Notes: Firewall : should not block the default MySQL port 3306 (in general should be off) Root Account Password : the convention is to use 'leiden1' CCS User Account: the convention is to use - Username: ccsuser - Host: localhost - Role: DBmanager (or full privileges: CCS needs to be able to create new databases) - Password: 'leiden1' HINT: this is the same password used when configuring the CCS (see below) - Allow connectivity from all hosts %

3 Install Notepad++ We recommend installing notepad++, because we will be editing test sequences and a nice editor is preferred to the very basic built-in editor. Notepad++ is what we use in most projects 3 The notepad++ installer is very similar to the one from CCS Install Tortoise SVN We recommend installing Tortoise SVN for configuration control of your user files. CCS will work without Tortoise SVN, but will automatically use some SVN features if the user files came from an SVN repository. Install CCS Download the CCS installer from Execute the installer, we assume you will use the default options throughout Configure CCS Select the Windows Start Menu, and navigate to Start > CCS > Configure NOTE: before a license is installed you may see a popup message stating that no license is installed. This is harmless Configure CCS allows you to get or set up a license. A window like this should appear

4 Please fill in the details as follows Network and Archive Settings CCS Server Host: enter the host name of your CCS server. The current hostname is set up by default. 4 NOTE: do not enter 'localhost' and do not enter an IP address Broadcast address: A suggested broadcast address is set up based on the primary IP address of your workstation, and your current netmask. A pulldown menu shows alternate addresses in cases where you have multiple LAN s installed. NOTE: You should take care to use an appropriate broadcast IP address for the correct LAN, the suggested one should usually be correct, but may not be, especially for example if you connected to a VPN or several networks simultaneously. The broadcast address is needed to broadcast heartbeat packets on the CCS network. The CCS will not function correctly if the client does not receive these heartbeats. On a standalone CCS, the client and server are of course the same machine. Client ID: This must be a number between 1 and 15. It is a unique identifier for the CCS client application (or workstation in a real deployment) on the CCS network. NOTE: the CCS server console is considered to be client ID 0. In addition to the CCS server you can have up to 15 workstations. A client on the CCS server might be client ID 1, so workstations attached to a CCS might use client numbers 2 to 15 Session Root Directory: this is the 'RESULTS' directory that will contain all of the session data for the CCS installation. The default is C:/CCS/VARIABLE/RESULTS NOTE: If this directory path contains any separators using \ (backward slash), normalize them by hitting the Normalize button. Redundancy: Click this check button to set up a hot redundant pair. Leave un-checked if you are setting up a standalone CCS server. If you check this box, then redundancy will be activated, and a second row of server settings will appear for the redundant server. NOTE: Each CCS server should set its sibling as its redundant server, i.e. on the redundant server, set up the primary server as the redundant pair. Data Base Settings Enter the back-end RDBMS settings, e.g: Engine: select MySQL User Role: ccsuser Password: leiden1 NOTE: these must match the user / password when creating the CCS user MySQL account

5 Protocols Configure the protocols that will be used in your system. 5 If you are just trying out CCS, leave these as default. Most projects will use either pure CCS or pure MCS protocols. However it is permitted to set up a hybrid system in which both EGSE and MCS protocols are active. EGSE Protocol Choose the EGSE (SCOE and Front End) protocol for CCS test systems HINT: In a pure MCS, this should be No Protocol MCS Protocol Choose the MCS protocol for operation systems. HINT: In a pure CCS, this should be No Protocol Project Settings If you have already checked out or put in place a TESTENV, this will automatically run the standard InitSettings script to further configure CCS for your specific project. Copy to System button requires administer privileges on your host. It will copy the current settings to the server settings (HKEY_LOCAL_MACHINE). This is convenient when you want the same settings to be applicable for all users on this host. Other CCS users will fall-back to use the host-level settings if there are no user-specific settings, and then save what they find to the local user settings. NOTE: Only do this if the project settings are very stable and will rarely change. Settings copied to the server node in the registry have to be manually cleared using regedit. Do not use this feature if you will frequently switch between projects with different settings. License Key If you are connected to the Internet, you can fill in your company, project and order number into the fields, hit Request License, and a license will be allocated from your pool in our license database. If the license has been accepted, the license key and corresponding end date will show, and both fields will turn green: HINT: If you are just trying out CCS you can opt for a Temporary licence HINT: You can also go to ccs.terma.com from another PC, and allocate a license online Click the ' Configure...' button to save the configurations. The system will tell you that the settings will be saved and it closes afterwards, click on ok. NOTE: your license is stored in the settings. The CCS Settings Editor Clear Settings button does not clear your license, but deleting the CCS nodes in the registry using regedit will clear your license.

6 Starting the CCS Client If you now click the CCS icon on your desktop, the CCS Client Console will appear. 6 The CCS Launch Pad will also pop up: HINT: appearance may be slightly different: you can check / uncheck in the top panel to make the different panels appear or disappear. We want to see the START button. Ready to Start The CCS is now ready to start a session. However, if you have just installed the CCS, you have an empty environment (TESTENV), no spacecraft database, no scripts and no display definitions! You will be able to start a session but you will not be able to do much of any interest! We have provided some example test environments to get started, or to demonstrate the system working.

7 Create a Test Environment The CCS expects a TESTENV directory to be in your 'My Documents' folder. 7 An empty one is created, but it is more useful to have some pre-prepared contents. The CCS client has a toolbar button (the Evil Eye ) that starts the Project Wizard which can be used to copy preprepared test environment files into place. You have 3 options: Use Project Wizard (for standard Self-Test and Training packages) Copy existing project files into place Check out from SVN Option 1 : Using Project Wizard to set up your test environment In the CCS Client tool bar hit Project Wizard A large black window appears; ensure that all applications that have TESTENV open (including Windows Explorer) are closed. Hit the check box to confirm you have closed all applications in TESTENV, and the Install button activates. Select one of NOTE: your TESTENV cannot be moved to a backup if any applications (except CCS console) are holding it open, so you must close any other applications that have this directory open. You will see an error if you don t close applications holding the TESTENV directory open! CcsSelfTest (a regression testing package) Training (for the training course) as appropriate and hit Install.

8 8 You should not need to index the test sequences directories (see below) because the Project Wizard does this automatically. Option 2 : Copy Test Environment files into place This option may be possible if you already have some example files from an existing project. In this option simply copy your files into TESTENV. The files should follow the standard structure under TESTENV, for example TSEQ, TSEQLIB, SYN, data/ascii. NOTE: you will probably need to index the test sequences directories (see below) Option 3 : Check out from SVN In this option you can check out from your own SVN repository or if appropriate the TESTENV may be one from Terma: The URL of the Terma SVN server is here: A read-only SVN account can be used (you will not be able to check in any changes): User: TestPacks Password: TestPacks Check out the selected test pack into your Documents folder. The checkout should be into a single directory with subdirectories, under which you should see TSEQ, data/ascii, TSEQLIB, SYN, etc. NOTE: you will probably need to index the test sequences directories (see below)

9 Re-index test sequence directories Indexing the test sequence directories makes sure that TOPE (TCL) can auto-load procedure files when they are called. 9 HINT: Project Wizard creates the index automatically. It will do no harm to repeat this step. In the Test Sequence Files pane hold down the Check Tcl Indices button and select Index All NOTE: it is important to hold down the menu! Then you will see the Index All button! Before continuing. After configuring the CCS, you may need to restart the CCS client! NOTE: restarting the client is necessary because some projects change configuration settings that are only read when the application starts. These settings will only take effect when CCS client is restarted. Starting CCS Now that you have configured the CCS and installed a test environment you should be able to start a useful CCS session. When the CCS client starts, the CCS launch pad opens automatically. When you are ready, it looks like this (nothing is running, and it is waiting for you to start a local simulation session). HINT: if you do not see all of the panels shown above, click the check buttons to reveal them. Launch Pad will remember which panels have been hidden or revealed. Hit the big green START button. A session name is automatically set and the CCS starts. While the CCS is starting (a few seconds), the launch pad looks like this

10 10 During session start-up: The SESS_SERVER creates a new session directory in the RESULTS directory The client and servers will try to connect to the MySQL database The MIB database(s) will be loaded The client will listen for the heartbeat signals from the server The launch Pad window should display all processes in green When the CCS is running, launch pad looks like this: The different launch pad panels can be hidden and revealed to show more information or to save space. Position the launch pad in a convenient place on your desktop, and it will stay there. HINT: if you accidently quit launch pad and want to restart it, you can find it in the toolbar on the CCS client console (look for the rocket icon). Congratulations, CCS is now running! Simple Demonstration If you are using the CCS SelfTest environment, and want to see something interesting, try this Click Test Sequence Files (top-right panel of CCS Console) Right Click on DemoOrbitPositionScheduling.tcl, and hit Exec Go to LaunchPad and hit the TC button Click AND View in the desktop, and in the resulting display click the quicks tab

11 Open the orbit view You should then see something like this: 11 In this demo, the CCS sends a cyclic TC (CEV_TST1) as a parameter to another (OPS004). The CEV_TST1 command is supposed to execute on each orbit cycle. The script calculates a simple simulated orbit, while at the same time simulating the verification of a TC as it reaches a different orbit position. It continues forever. Try navigating to the QML quick demo example: this should give you an idea of your platform graphical capabilities and performance. Stopping a Session In the CCS Launch Pad, hit the STOP button and wait a few seconds. NOTE: if you abruptly quit the CCS Console, the CCS may still be running a session. If you start the CCS Console again, this would be indicated by the launch pad showing all tasks as green, and offering you to JOIN the current session.

12 Getting Help Online help appears when you hit F1 12 Troubleshooting The most common errors are: The system firewall is blocking one or more of the ports used by CCS. Turn it off. You left a CCS (partially) running before de-installing and re-installing. Kill it. Mistake in the host name, or hostname incompatible with database engine back-end There is a mistake in the broadcast address The network configuration changed since the CCS was configured (maybe VPN) Mistake in the configuration of database users or passwords Empty MIB database (nothing in your TESTENV) You may need to re-index your TOPE directories You should be able to solve these problems by repeating the above procedure and looking closely for incorrect input. Licensed customers have access to our CCS wiki at: This gives all kinds of advice about system configuration and troubleshooting more obscure issues. Killing a Dangling or Zombie CCS Session The CCS uninstall attempts to close any running CCS sessions but there are ways that a CCS session can be left in a not-properly-shut-down state. These instructions should help you to reset the CCS If you look in your Windows desktop icon tool bar, you may see a CCS SESS Server: eg. Right-click on this icon and a terminal window appears. You can kill / abort all managed CCS tasks by typing killzombies You can quit the SESS server by typing exit. The server will normally be restarted by the next CCS client attempting to start a session.