Project ID 604674
FITMAN – Future Internet Technologies for MANufacturing
SEMed ___ Installation and Administration Guide
Author(s): Copyright: Release Date: Revision:
Marco Franke ( BIBA – Bremer Institut für Produktion und Logistik GmbH) © 2015 BIBA – Bremer Institut für Produktion und Logistik GmbH 21-08-2015 1
1/10
FITMAN – Future Internet Technologies for MANufacturing
Project ID 604674
Table of Contents INTRODUCTION .........................................................................................................................................................3 1.
SOFTWARE LICENSE .....................................................................................................................................3
2.
INSTALLING THE SOFTWARE ...................................................................................................................3 2.1. 2.2. 2.3. 2.4.
3.
System Requirements ....................................................................................................................... 3 Download ........................................................................................................................................ 3 Installation and Configuration ........................................................................................................ 4 Sanity Check .................................................................................................................................... 5
ADMINISTRATION PROCEDURES ............................................................................................................8
Table of Figures FIGURE 1 UPLOAD OF A WEB APPLICATION ................................................................................................4 FIGURE 2 FINALIZED UPLOAD OF ALL SEMED WEB MODULES ...........................................................5 FIGURE 3 WEB SERVICE DESCRIPTION OF MEDIATOR WEB SERVICE .............................................6 FIGURE 4 EMPTY O-MI MESSAGE ......................................................................................................................6 FIGURE 5 MAIN PAGE OF SEMANTIC MEDIATOR ADMINISTRATION ................................................7 FIGURE 6 CONSOLE LOG OF SERVICEINVOKER.JAR................................................................................8 FIGURE 7 CONFIGURATIONS OF SEMED ........................................................................................................9 FIGURE 8 DEPENDENCIES BETWEEN THE CONFIGURATIONS ...........................................................10
2/10
FITMAN – Future Internet Technologies for MANufacturing
Project ID 604674
Introduction
This document is a guide for installing SEMed from the binaries which are available in the Fitman catalogue (http://catalogue.fitman.atosresearch.eu/enablers/semed/downloads). Before installing SEMed, it would be advised to be aware that SEMed requires a complex configuration to be applicable. To get a quick look at SEMed’s capabilities, please use the preinstalled and preconfigured version of SEMed. It can be downloaded as a virtual image at ftp://repo.nimbusware.com/fitman_semed_2.00.00_vbox.zip. The image contains a first step readme file. The following guide describes the first steps how to download, install and start SEMed. The configuration and usage of this Specific Enabler is not part of this document but is explained in the document User Guide instead. This guide consists of three chapters, dedicated to the Software License, the Installing of the software and the Administration Procedures, including step by step guidelines, enriched with screenshots and examples. 1. Software License
SEMed satisfy the GPL v3 licence. The source code is available at SourceForge (git clone git://git.code.sf.net/p/fitman-fi/code fitman-fi-code) 2. Installing the Software
2.1. 2..1.1.
System Requirements Hardware Requirements
SEMed has no specific requirements to the performance of underlying hardware. The performance requirements arise as a result of the connected data sources and the number of potential users. The minimal hardware requirements are related to the web service based front end of SEMed. The frontend requires the protocols TCP/IP. In consequence, the only supported hardware is hardware that network interfaces can apply the TCP/IP protocol stack to. 2..1.2.
Software Requirements
The Specific Enabler SEMed is written in Java. Thus, SEMed can be started on each platform which is capable of running a Java Runtime Environment. The compilation requires a Java Development Kit. The minimal supported Java version is 1.7. Higher Java versions have not caused trouble yet. 2.2. Download SEMed can be downloaded in three versions. The binary version und the link to the virtual image are available in the Fitman catalogue and in the FML Portal under the menu entry SEMed and Download. The source code of SEMed is available at the Fitman project from sourceforge. The binary version contains the following modules: 1. Service Invoker.jar (internal name: Information Request Service) 2. MediatorWebservice.war (internal name: Web Service) 3. QLMResponseSEMedService.war (internal name: QLM Web Service) 4. SemanticMediatorAdministration.war (internal name Semantic Mediator Administration)
3/10
FITMAN – Future Internet Technologies for MANufacturing
Project ID 604674
In the following, the file name and not the internal are used to describe the installation steps. In Section 3, the internal names of the modules are used, because different instantiations could use different file names. 2.3. 2..3.1.
Installation and Configuration Installation
The following installation guide describes the installation procedure on an operating system which includes a graphical user interface. Preparation Before installing SEMed, please install Java 7 SDK (SE Development Kit 7 (32 Bit) and the application server Apache Tomcat. After both tools have been installed, configure and start Apache Tomcat. In most cases you can start tomcat through running the *.bat in Windows or *.sh scripts in the bin folder of Apache Tomcat. Installation Please download all mentioned modules of SEMed. Then, start a web browser and open the URL: http://127.0.0.1:8080/manager/. This opens the Tomcat Web Application Manager. After you entered your credentials you can install MediatorWebservice.war, QLMResponseSEMedService.war and SemanticMediatorAdministration.war as web applications. For that purpose, please upload each module via the Browse and Deploy button of the Tomcat Web Application Manager which is shown in Figure 1.
Figure 1 Upload of a Web Application
After you uploaded all modules, the Tomcat Web Application Manager should show the listing of Figure 2.
4/10
Project ID 604674
FITMAN – Future Internet Technologies for MANufacturing
Figure 2 Finalized upload of all SEMed Web Modules
The module Service Invoker.jar need no additional installation step. Now, all SEMed modules are ready to be configured and finally to be used.
2.4. Sanity Check The sanity check satisfies that both the web applications and the Service Invoker.jar are executable. In the following, a sanity check for each of the application is presented. 2..4.1.
Check of all web applications
SEMed contains the web applications MediatorWebservice.war, QLMResponseSEMedService.war and SemanticMediatorAdministration.war which use different technologies in the backend. The sanity check checks whether the web application returns something without existing configuration. MediatorWebservice.war The MediatorWebservice.war is a web service. In consequence, the web service description can be requested as a sanity check. For that purpose, please open the following link: http://127.0.0.1:8080/MediatorWebservice/services/MediatorWebservice?wsdl The result should be a valid web service description. An example of a valid description is given in Figure 3.
5/10
Project ID 604674
FITMAN – Future Internet Technologies for MANufacturing
Figure 3 Web service description of Mediator Web service
QLMResponseSEMedService.war The QLMResponseSEMedService.war is not a web service but a Java servlet. To check the sanity, an information request can be used. The result of the information request is an empty O-MI message, because no configuration exists. For that purpose, please open the following link: http://127.0.0.1:8080/QLMResponseSEMedService/QLMResponseServlet?method=query&j Object={%22namespace%22:%22http://Fitman.eu%22,%22query%22:%22select%20?B%20 where%20{?A%20a%20\u003cSpecifdicEnabler\u003e.%20?A%20\u003cname\u003e%20? B.%20%20%20}%22,%22propList%22:[]} The result should be a valid O-MI message. An example is given in Figure 4.
Figure 4 Empty O-MI message
6/10
Project ID 604674
FITMAN – Future Internet Technologies for MANufacturing
Semantic Mediator Administration The Semantic Mediator Administration is a web application including a graphical user interface. To check the sanity, the main page of the web application can be used. For that purpose, please open the following link: http://localhost:8080/SemanticMediatorAdministration/?database=local
The result should be the main page of the Semantic Mediator Administration. An example is given in Figure 5. In this case, the sanity check passed.
Figure 5 Main page of Semantic Mediator Administration
2..4.2.
Check of all java standalone applications
SEMed contains only the ServiceInvoker.jar as a java standalone application. The ServiceInvoker.jar requires a running instance of the MediatorWebservice.war and a consistent configuration. Without both, the sanity check can only check whether the application is executable. For that purpose, please open a terminal and navigate to your installing folder. Then, please execute the following command: java -jar ServiceInvoker.jar The result should be a set of IO exceptions. The IO exceptions occur because the program does not find the necessary configuration file. In this case, the sanity check passed. An example of a valid console log is given in Figure 6.
7/10
FITMAN – Future Internet Technologies for MANufacturing
Project ID 604674
Figure 6 Console Log of ServiceInvoker.jar
2..4.3.
Configuration
The configuration of SEMed relies to the user and not to the administrator. For that purpose, the configuration procedure is part of the user guide. 3. Administration Procedures
The administration procedure depends on the connected data sources. A change in the set of data sources or in the internal structure of a data source requires the adaption of the SEMed configuration. Thus, the configuration of SEMed should be applied by users in their daily business. In consequence, the configuration procedure is described in detail in the user guide. The role of an administrator is to supervise the configuration activities. For that purpose, the different configuration files and its dependencies are described in the following. 3.1.
Configuration
SEMed is a middleware and is dependent to the linked data sources. Thus, it requires a set of configuration files for its instantiation. An overview to the required different configurations is given in the Figure 7.
8/10
Project ID 604674
FITMAN – Future Internet Technologies for MANufacturing
Figure 7 Configurations of SEMed
As it is illustrated in Figure 7, a minimal configuration of SEMed involves the creation of 2 configurations. The configuration of a wrapper and the configuration of the web service are necessary to achieve the minimal configuration. An additional configuration file is necessary, if you want to use a forwarding service. The dependencies between the configuration files are shown in Figure 8.
9/10
Project ID 604674
FITMAN – Future Internet Technologies for MANufacturing
Figure 8 Dependencies between the configurations
An instantiation of SEMed including a minimal configuration is represented usually as a *.war archive and can be deployed on an application server. The *.war archive has the following internal structure. The web service is the starting point. The web service references to the Reasoning Mediator which references to the wrappers. That means, that if the web service is running properly, all other modules run immediately.
10/1 0