# Copyright (C) 2013 CEA/DEN, EDF R&D, OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # --------------- 1. Introduction --------------- SIMAN (SALOME Simulation Data Manager) Java based server provides functionality for data management and interaction with client SALOME modules (having implemented interfaces for interaction) using SIMAN Web Services and the SimanIO library. --------------- 2. Installation --------------- 2.1 Pre-requisites The SIMAN server building is based on the standard for Java ant build system (http://ant.apache.org). This means that you have to check (or install if needed) the required software on your system: - Java development environment (jdk 1.6.0, of example java-6-openjdk) - and Java build environment (ant 1.7.1, Apache Ant version 1.7.1) 2.2. Building the SIMAN Java libraries and the SIMAN Server Web archive - siman.war To build all SIMAN required libraries and web archives you will have to extract the source package in a directory where you have write permissions: $ tar xzf siman-x.y.z.tar.gz (x.y.z is a version signature) After that, you will need to perform the following actions to build all libraries and the SIMAN Server Web archive - siman.war including these libraries: - go to the directory Siman (../SIMAN_SRC/Workspace/Siman) - adjust the paths to ANT bin folder, JAVA_HOME as well as required RDBMS (prepare-mysql or prepare-postgres) and Workflows (prepare-edf or prepare-cea) in the file build-war.bat or build-war.sh - run script build-war.bat or build-war.sh - the result web archive siman.war is created in sub-directory dist (../SIMAN_SRC/Workspace/Siman/dist) 2.3. Building the SIMAN Java libraries and the SIMAN Web Services Web archive - Siman-WS.war Then you will need to perform the following actions to build all libraries and the SIMAN Web Services Web archive - Siman-WS.war including these libraries: - go to the directory Siman-WS (../SIMAN_SRC/Workspace/Siman-WS) - adjust the paths to ANT bin folder, JAVA_HOME as well as required RDBMS (prepare-mysql or prepare-postgres) and Workflows (prepare-edf or prepare-cea) in the file build-war.bat or build-war.sh - run script build-war.bat or build-war.sh - the result web archive Siman-WS.war is created in sub-directory dist (../SIMAN_SRC/Workspace/Siman-WS/dist) 2.4. Both SIMAN Web archives are deployed to the Web server and to be properly configured. See details in APPENDIX. ----------- 3. APPENDIX ----------- This paragraph provides some additional information about the SIMAN server building, configuration and testing. 3.1. Building the SIMAN Java libraries and the SIMAN Web archives basing on SALOME installation The source code of the SIMAN Server is delivered as part of the official SALOME distribution; alternatively it can be obtained from CVS repository: $ cvs -d :pserver:@cvs.opencascade.com:/home/server/cvs/SIMAN $ cvs checkout -PRA SIMAN_SRC Building of the SIMAN Java libraries and the SIMAN Web archives is performed in accordance with the procedure described above (paragraph 2). 3.2. Unit Testing The set of the server side unit tests for main SIMAN server functionality is provided in the directory ../SIMAN_SRC/Workspace/Siman-Common/src/test/splat. 3.3. Installation of SIMAN Web archives and Configuration of SIMAN web server and SIMAN database server. Please see all necessary details concerning the configuration and running of SALOME SIMAN client and SIMAN Web server with SIMAN database server in the SIMAN Administration Guide (SIMAN_AdminGuide_vx.y). 3.4. Basic working mode of using SALOME with SIMAN server If installation and configurations have been performed successfully the SIMAN server can be accessible on SALOME client side from your browser using URL : "http://:8080/siman" Normally displaying the SIMAN start page SALOME session connected to SIMAN is automatically started from the browser; this SALOME session will access SIMAN server providing all functionality defined in the SIMAN Detailed Functional Specifications for the current version of SIMAN (see SIMAN_Functional_Specifications_vx.y).