Epsis TeamBox System Requirements and Installation Guide 2014 Epsis AS. All rights reserved. Revision date 06.02.2014
Contents 1 Introduction... 4 2 Software Components... 5 3 Software environment and Hardware Requirements... 6 3.1 Operating system... 6 3.2 Hardware requirements... 6 3.2.1 Video Conference functionality... 6 3.3 Software requirements... 7 3.4 Network requirements... 7 3.4.1 Collaboration Server (EchoServer)... 7 4 Installation of the Epsis software... 8 4.1 Installation process overview... 8 4.2 Creating the database... 8 4.3 Installing the Collaboration Server (EchoServer)... 9 4.4 Installing Epsis TeamBox... 9 4.4.1 Default database setting... 9 4.4.2 Log files... 9 4.5 Upgrading Epsis TeamBox installations... 10 4.5.1 Database upgrade from Era Connect 4.3 to Epsis TeamBox 5.1... 10 4.5.2 Database upgrade from Epsis TeamBox 5.1 to Epsis TeamBox 5.2 11 4.5.3 Epsis TeamBox... 11 4.5.4 License upgrade... 12 5 Deployment diagrams... 13 5.1 Collaboration server... 13 2
Related Documents Epsis TeamBox Software User Manual Epsis TeamBox Software Release Notes Contact Information Epsis AS Kokstadflaten 31 N-5257 Kokstad Norway www.epsis.no Tel: +47 55 92 57 50 3
1 Introduction This installation guide describes the system requirements and deployment scenarios for the installation of the Epsis TeamBox products. The Epsis Teambox Software replaces the old EraConnect software. It is possible to upgrade from EraConnect 4.3 to Epsis Teambox Software. For legacy reasons, the name EraConnect name may still be observed in this document and in relation to the Epsis Teambox Software product. Epsis TeamBox allows users to build workflows. A workflow controls several other applications and documents and arranges them in predefined layouts. The user can create meetings with other locations that run Epsis TeamBox and share workspaces over the network. Epsis TeamBox could be installed on a Windows workstation equipped with video capture cards. The video capture cards allow external sources such as laptop s, PC s and videoconferencing systems to be connected to the Epsis TeamBox through analogue (VGA) or digital (DVI) cables For more information about the Epsis TeamBox, please contact an Epsis sales representative or go to the Epsis webpage at www.epsis.no 4
2 Software Components An Epsis TeamBox software package contains the following elements: Epsis TeamBox- This program is used for running workflows and collaboration meetings. It is also used for creating workflows, steps and workspaces. SQL script for creating a new database This script should be used by a database administrator to create the databases needed to run Epsis TeamBox. SQL update script - This script should be used by a database administrator to upgrade the databases if the new version requires structural- or data changes to be made to the MS SQL database. 5
3 Software environment and Hardware Requirements 3.1 Operating system Epsis TeamBox can run on Microsoft Windows 7 32-bit / 64-bit Operating System 3.2 Hardware requirements Epsis Teambox o Required disk space 150 MB o Recommended minimum memory: 2 GB Collaboration Server (echoware) (optional) o Required disk space 20 MB o Recommended minimum memory: 100 MB The Epsis TeamBox system in itself does not require very much system resources. However, the workspaces that are launched and controlled by Epsis TeamBox might have specific system resource demands. If some workspaces are system demanding applications or if a very high number of workspaces are to be displayed simultaneously, CPU power, memory, disk space and speed, should be configured accordingly. If other very performance demanding systems are running at the same time as Epsis TeamBox this might influence performance, so scale the system performance to handle the overall load of all running applications. 3.2.1 Video Conference functionality Epsis TeamBox can be used to control a Video Conference system. It is then possible to place outgoing and accept incoming video/audio calls by using Epsis TeamBox. Currently supported systems are Cisco/Tandberg C-series systems and Polycom HDX 7000/8000. 6
3.3 Software requirements MS SQL server 2005 or higher (for database host only) (Free edition of Microsoft SQL server can be downloaded from http://www.microsoft.com/express/database/).net Framework 4.0 Java Runtime Environment (32bit) version 1.6 (or higher) The Epsis TeamBox does not support 64 bit Java. 3.4 Network requirements 3.4.1 Collaboration Server (EchoServer) The collaboration server is typically hosted outside the local area network, either in the DMZ, or at a trusted third party site. We recommend that the server is configured to listen for connections on port 80 since many businesses disallow outbound traffic to other ports. When a remote collaboration session is in place using the External server, no ports on any of the leader or participant machines need to be opened. The initial connection is always outbound. (See System diagram below) Minimum 10 Megabit/s network connections. 7
4 Installation of the Epsis software 4.1 Installation process overview When installing an Epsis TeamBox for the first time the following tasks need to be performed: Create a database The database must be created on Microsoft SQL 2005/2008 server. (Free edition of Microsoft SQL server can be downloaded from http://www.microsoft.com/express/database/) Install Epsis TeamBox - Run the MSI package. 4.2 Creating the database To create the database, save the package containing the necessary files and installation script on the destination server/machine (used for the installation). To create a new database, do the following: 1. Open CMD (click on windows start menu, select RUN and type in CMD). 2. Use CMD and navigate to the directory where the package is stored. 3. Use CMD and the following syntax in order to create a database (we use cfg as an example for a database name): EpsisTeamBox_CreateDatabase.bat <database name> <sqlserver>\<instance>. Replace <database name> with e.g. cfg and <sqlserver>\<instance> with e.g..\. which is default and can be used for local host or on servers with only one sql server instance installed. The following example shows how a new database can be created: EpsisTeamBox_CreateDatabase.bat cfg.\. 4. Press any key to finish the installation procedure (from cmd) 5. Open Microsoft SQL Server Management Studio to check that the new database is created 6. Create appropriate access to the database for the users/user groups. All users of the TeamBox software must be given access rights to this database. A typical setup will define 2 different users (or user groups): a. TeamBox_reader: This user is used for read only access to the data. This group should be member of the public and db_datareader role on the installed database. b. TeamBox_editor: This user is allowed to edit/create/delete workflows and layouts. This group should be member of the public, db_datareader, and db_datawriter roles on the installed database 8
4.3 Installing the Collaboration Server (EchoServer) To install the Collaboration server, run the file echoserver_165_setup.exe. The installation wizard guides you through the installation process of the server. After the installation is complete then you must start the External server. You will find it under Start->All programs named echoserver. Click on it and the server manager will start. Within the server manager you can change the default listening port for the server if needed. This is used by Epsis TeamBox to connect to the server. Go to the Groups tab and delete the Tests group that is present there. Add a new group to the list and enter a group name and password. The password will be used by Epsis TeamBox to connect to the server. Start the server and you should see the server displayed in the tray, and if you mouse over the try icon you will get the status of the server if it is running and on what port. 4.4 Installing Epsis TeamBox To install Epsis TeamBox on a workstation, run the MSI package: Epsis TeamBox -5.4.0.msi. The installation wizard guides you through the installation process of Epsis TeamBox, and will prompt the user to configure database and collaboration server. These will be stored as the default settings for the machine you install on. 4.4.1 Default database setting The default database settings collected during installation will be stored in a configuration file located in the install directory called ERAconnect.exe.config. To change the default values for the database connection string, find the DatabaseConnectionString user setting and enter the correct server name and database name. Example: <usersettings> <setting name="databaseconnectionstring" serializeas="string"> <value>server=yourserver;database=yourdb;integrated Security=SSPI;</value> </setting><connectionstrings> </usersettings > 4.4.2 Log files The Epsis TeamBox log file can be found in C:\Users\<user name>\appdata\local\epsis\ Epsis TeamBox.log Log level can be set in the ERAconnect.exe.config file, default value is Info. 9
4.5 Upgrading Epsis TeamBox installations 4.5.1 Database upgrade from Era Connect 4.3 to Epsis TeamBox 5.1 To upgrade the database, save the package containing the necessary files and installation script on the destination server/machine (used for the installation). To upgrade an existing database, do the following: 1. Use Microsoft SQL Server Management Studio to backup the existing database 2. Open CMD (click on windows start menu, select RUN and type in CMD). 3. Use CMD and navigate to the directory database_upgrader where the package is stored. 4. Use CMD and the following syntax in order to upgrade the databasedatabaseupgrader.exe "Data Source=<sqlserver>\<instance>;Initial Catalog=<database name>;integrated Security=True" An example: a. <database name> with e.g. cfg b. <sqlserver>\<instance> with e.g. pctest\sqlexpress c. The following example shows how an existing database can be upgraded: DatabaseUpgrader.exe "Data Source=. pctest\sqlexpress;initial Catalog=cfg;Integrated Security=True" 5. Press any key to finish the installation procedure (from cmd) 6. Open Microsoft SQL Server Management Studio to check that the version property in the table tbldbinfo is 3.0 After upgrade all workspaces previously defined as EmbeddedDocumentHandler and containing Office documents have been converted to OfficeDocumentHandler. The ones that don t contain Office documents are renamed to EmbeddedWebHandler Please also note that both the window title and the process name of the remote viewer has changed. This means that existing window organizer workspaces used to capture the viewer might need to be updated. More information is given in the User Manual (section Create a participant workflow ). 10
4.5.2 Database upgrade from Epsis TeamBox 5.1 to Epsis TeamBox 5.2 To upgrade the database, run DatabaseUpgrader.exe and a window will appear: Type in database server and database name and click Start Upgrade. A message box will appear when the upgrade is completed. There is no database upgrade between 5.2 and latest version. 4.5.3 Epsis TeamBox When upgrading Epsis TeamBox, perform the following steps: 1. Take a backup of the existing configuration file (EraConnect.exe.config). 2. Uninstall the existing version of Epsis TeamBox Software 3. Install the new Epsis TeamBox software 4. Configure the Epsis TeamBox (EraConnect.exe.config). Use the old configuration file that was backed up as reference. Edit the default settings for database connection, collaboration server and communication ports if needed. 11
4.5.4 License upgrade In order to do a license upgrade, Epsis TeamBox must be started with administration rights. The Upgrade license functionality is available from the About Epsis TeamBox dialog. 12
5 Deployment diagrams The image below shows a system diagram of an Epsis Teambox Software system with two clients 5.1 Collaboration server Collaboration Server: Two clients collaborating across networks with outbound connections to the server. 13