Installation and Getting Started

Transcription

1 Eurstat Data Transmissin Tls & Services EDAMIS Web Applicatin v3.1 Installatin and Getting Started TABLE OF CONTENTS: 1 Intrductin Installatin Prerequisites EWA installatin User management Basics Assign a user t a dmain Reprting Actin Histry EDAMIS Users List EDAMIS Metadata Parameter settings The Eurstat Validatin Mdule Imprtant ntes Supprt... 8 Dcument prepared by Eurstat Unit B3 Versin 3.7, Versin date: 25 Jan 2013

2 1 Intrductin The EDAMIS Web Applicatin allws transmitting data files t Eurstat in a user friendly and straightfrward manner. This dcument intends t supprt a system administratr in a Cmpetent Natinal Authrity (CNA) respnsible fr the installatin and the deplyment f the EDAMIS Web Applicatin (EWA). The latest versin f this dcument is available at EDAMIS - Help Centre > Tls > EDAMIS Web Applicatin > Dcumentatin Mre detailed infrmatin n the peratin f the EWA can be fund in the Administratr Guide and the Online Help. 2 Installatin 2.1 Prerequisites STATEL needs t be installed n the machine n which the EDAMIS Web Applicatin (EWA) will be installed. Infrmatin abut dwnlading and installing STATEL is available n EDAMIS - Help Centre > Tls > Statel > Presentatin STATEL assures that data files are crrectly delivered at Eurstat s single entry pint fr data receptin. The EWA is written in Java, but when installed n Windws des nt need a Java Runtime Engine (JRE) t be installed n the system, as the installer cntains all the required sftware t run the EWA. The presence f a JRE r full Java Develpment Kit n the system des nt nrmally cause prblems fr the installatin r use f the EWA. If such seems t be the case, please cntact yur system team r the EDAMIS Help Desk. Indicatin fr minimal system cnfiguratin: - Pentium III 800 MHz r higher MB RAM r mre MB Disk space r mre. - Operating Systems: Windws: Windws2000, Windws XP r higher, n Java Runtime Engine required. Linux: Kernel 2.4 r higher (all recent versins SUSE, RedHat, Mandrake, Debian, etc). Slaris: Slaris8 r higher with Java r higher Other UNIX versins (AIX, HP-UX, IRIX): Java r higher. - If the EWA is installed n a VMWare virtual machine, the VMWare Tls are required. Cncerning the disk space it has t be clarified that the applicatin itself des nly need abut 90 MB disk space. The rest f the disk space is needed: - As a temprary strage fr the data files that need t be transmitted. Depending n hw intensive the EWA will be used mre disk space culd have t be allcated fr the EWA. - Fr the strage f the database files used fr the lcal database. The EWA database is cmpacted n every restart, and experience shws that even an extensive histry (five years wrth f data transmissins) des nt require mre than abut 100MB. If a large number f datafiles are transmitted, a mnthly restart rutine will keep the database size in check. Furthermre the prt thrugh which the EWA will be accessible n the LAN needs t be knwn. By default it is set It is advised t define a URL fr internal users which is easy t remember, fr example: Please nte that the prt is fr internal use nly, and nt fr cmmunicatin with Eurstat (as mentined abve, cmmunicatin with 2

3 Eurstat is assured by STATEL, which can use either FTP r HTTP fr data transmissin, but in n way interferes with the prt selected fr internal cnnectins). If n ther Web server is running n the system that hsts the EWA, the prt can be set t the standard HTTP prt (80), thus aviding a nn-familiar lking URL and pssible fire-wall prblems. 2.2 EWA installatin The EWA installatin prcedure described here fr the Micrsft Windws Operating System. EWA fr Linux has als been released, and cmes with Linux specific installatin instructins. WARNING: On Windws Vista and Windws 7, the installatin prcedure has t be perfrmed using the run as administratr ptin. Since versin 2.3x, EWA is packaged as a native Windws Service. This means that the EWA will start when the system starts, des nt require a user t be lgged in, and stps when the system is shut dwn. - Uninstall the previus versin f EWA. The database will nt be deleted, and versin 3.1 f EWA will autmatically upgrade it (and migrate it t an hsqldb database if necessary). All existing infrmatin will remain available after the upgrade. - Lg in as Administratr - D ne f bth: Dwnlad the installatin package frm CircaBC, Start the installatin by running the file EWA_service_3.1.x_eurstat_distrib.exe, r the latest versin f the EWA prgram (the file name will change as a result f bug fixes and/r enhancements, and reflects the versin number f the prduct). Put the EWA installatin CD in the CD drive, if the installatin des nt start autmatically, g t the CD and duble-click EWA_service_3.1.x_eurstat_distrib.exe t start the installatin. - Restart the cmputer after the installatin r start the EWA thrugh the Windws Service Interface (Cntrl Panel Administrative Tls Services). The name f the service is EDAMIS Web Applicatin. - After the installatin prcedure has terminated: At first lgin as Administratr after cnnecting t the URL f the EWA. Remember that the first cnnectin shuld always use prt The URL shuld wrk in all cases. Default User id: Administratr, Passwrd: Eurstat. Please change the default passwrd as sn as pssible. Select the Cuntry Cde frm the Drp-dwn bx, and enter the name (r acrnym) f yur Institutin. The cmplete menu will becme available nce this data has been entered and the Update buttn has been pressed. Check if all parameters are crrect (see Parameter settings ). Make sure that the reference data is present when yu're updating frm a previus versin. If necessary cntact Eurstat. Define users (see User management ). Please nte that nce yu've changed t Prtal mde users can n lnger be created lcally. 3 User management Since versin 2.3x, EWA supprts bth Cmpatibility and Prtal user and dataset management. Cmpatibility mde maintains full cmpatibility with EWA 1.12 and EWA 2.0, and is the system currently used by Eurstat. Prtal mde uses the EDAMIS Prtal t assign datasets r grups f datasets t user accunts. These user accunts use the ECAS lgin credentials instead f EDAMIS 3

4 specific accunts. Migratin t Prtal mde is recmmended and EWA is designed t allw it withut any interruptin f service r re-installatin. The fllwing paragraphs intrduce Cmpatibility mde. Once that the EWA is installed and the STADIUM reference data is received (STADIUM SRR and SRF messages) and integrated in the EWA the users can be defined. Users need t be linked t a dmain in rder t be able t transmit datasets t Eurstat. 3.1 Basics T create a user: 1. Open the User Creatin screen (menu access path: Users >> Create ) 2. Fill ut the necessary fields 3. Define a USER rle fr a standard user 4. Use the CREATE buttn T update a user: 1. Open the User Update screen (menu access path: Users >> Update ) 2. In the Select Username field, type the userid f the cncerned user 3. Use the SELECT buttn 4. Apply the changes 5. When dne use the UPDATE buttn T delete a user: 1. Open the User Delete screen (menu access path: Users >> Delete ) 2. In the Delete Username field, type the userid f the cncerned user 3. Use the VALIDATE buttn 4. Use the DELETE buttn 3.2 Assign a user t a dmain T assign a user t a dmain: 1. Open the Dmain list screen (menu access path: Metadata >> Dmain list ) 2. In the user dmain administratin screen select a dmain, by clicking n the Dmain ID 3. The last entry in the Assigned t clumn is a list bx. Frm this list bx chse a userid. 4. In the Cnfirm clumn use the ADD buttn. 5. The user will be added t the user list f the cncerned dmain. T delete an assignment f a user t a dmain: 1. Open the Dmain list screen (menu access path: Metadata >> Dmain list ) 2. In the user dmain administratin screen select a dmain, by clicking n the Dmain ID 3. Fr the userid t be deleted frm the list, in the Cnfirm clumn use the DELETE buttn. 4 Reprting 4.1 Actin Histry a) LONG Menu access path: Actin Histry >> Lng. Gives an verview f all Transmitted data files and all Received data files. 4

5 b) SHORT Menu access path: Actin Histry >> Shrt. Lists Transmitted data files and received data files. The number f lines presented is based n the parameter Histry lines n lgin (r Lines n shrt activity reprt ). See parameter setting fr further infrmatin. c) Mnth Menu access path: Actin Histry >> Mnth. Lists Transmitted data files and received data files fr the last Calendar Mnth. Please nte that the srt rder f these reprts can be changed by clicking n the srt arrws in the header fields. d) Lng Admin Menu access path: Actin Histry >> Lng Admin. Lists all perfrmed Administrative Actins e) Mnth Admin Menu access path: Actin Histry >> Mnth Admin. Lists perfrmed Administrative Actins fr the last Calendar Mnth. f) CSV Menu access path: Actin Histry >> CSV:xxx. The Send Datafile, Receive Datafile, and Administrative Actins Histry can be exprted in CSV frmat fr detailed analysis. 4.2 EDAMIS Users List Menu access path: Users >> List. This reprt lists all the users that the system administratr has defined. 4.3 EDAMIS Metadata a) Server list Menu access path: Metadata >> Server list. Shws the servers t which the EWA users can send datasets. Typically, this will be a single server fr transmissins t Eurstat. b) Dmain list Menu access path: Metadata >> Dmain list. This reprt lists all statistical dmains fr which the EWA can transmit datasets t Eurstat. IMPORTANT: This list needs t be used t link users t a DOMAIN. See als User management. c) Dataset list Menu access path: Metadata >> Dataset list. 5

6 This reprt lists all datasets which can be transmitted via this EWA. 5 Parameter settings Menu access path: Management >> Parameters. Descriptin: In rder t allw the EWA t functin crrectly the Administratr f the EDAMIS Web Applicatin shuld maintain a number f parameters. These parameters are described here after. general infrmatin client name T define a persnalised name fr the installed EDAMIS web applicatin. This name is visible in the lgin screen. lcatin T indicate the address f the ffice f the persn respnsible fr the EDAMIS web applicatin. Alternatively, the lcatin f the server (in case f multiple installatins). The lcatin is presented in the lgin screen. Cntact The address f the persn respnsible fr the applicatin. A link t this address is address shwn in the Lgin screen. directry and file lcatins Base User Directry The base directry under which all the user subdirectries will be lcated. Please nte that the directry structure has changed since versin 1.0. If upgrading frm 1.0, the administratr shuld ensure that pssible Received Files are mved frm the 1.0 user directry structure t the 1.1 directry structure. The default name f this directry is user, and it is lcated in the main EWA directry (typically C:\Eurstat\EWA). Arrival Directry A subdirectry f the in which incming data files, sent by Eurstat, are stred. Again, each user has their wn subdirectry where the arriving files are placed. The files can be dwnladed t the user s PC thrugh the Receive Data file screen. The default name is ARRIVAL, but it can be changed t any relative directry name as it must be a subdirectry f the user directry. Edi Directry A subdirectry which supprts the autmatic transmissin f fully qualified (e.g. GESMES, naming cnventin cmpliant) data files. EWA will autmatically detect if this directry cntains data files. All data files present in this directry will autmatically be sent t Eurstat. Datafile Save A (sub) directry where EWA will write backup cpies f the datafiles that have been Directry sent t Eurstat. These files can be deleted frm the user interface, r autmatically when the acknwledgement arrives. Delete saved sent A flag that determines whether the backup files will be deleted when the datafiles upn acknwledgement is received. Acknwledgement SRA directry Directry where t save SRA files, if leave empty the SRA files are deleted after their prcessing. Save received A flag that determines if the received files have t be backup in the save directry. datafiles Lg file Indicates in which file the lg file is stred. The lg file cntains an verview f all the prcessing dne by the EWA. The lg file is autmatically rtated t save space. Nn-acknwledged Transmissins File Receive all files fr the rganisatin Message structure Place datafile in ZIP archive user interface behaviur histry lines n lgin This file will cntain the list (in CSV frmat) f the datafiles that have been transmitted but have nt been acknwledged. The file can be used t perfrm external actins based n these nn-acknwledged files. A flag that determines if the administratrs f the EWA receive all the files received by the rganisatin. A flag that determines if the sent datafiles have t be cmpressed by the EWA befre sending. Indicates hw many histrical lines will be visible in the fllwing reprts: received data file status, transmitted data file status, administrative actins status. These reprts are visible n lgin and are furthermre available via the menu path "actin histry >> shrt". 6

7 inactivity timeut (secnds) Defines the time ut perid, after the specified number f secnds f EWA inactivity the user is autmatically lgged ut. Please nte that pending transmissins (i.e. transmissins that have been entered in the Send Datafiles screen, but have nt been transferred by pressing the Perfrm Transfers buttn) are autmatically deleted when the user lgs ut (r is lgged ut thrugh the timeut feature). When checked, users can lg in a secnd time instead f being denied access. Please nt that a user can nly be lgged n nce, and that existing wrk (prepared but nt yet transmitted datafiles) will be irretrievably lst when a secnd lg in is perfrmed. If checked, received datafiles are displayed first in the shrt r lng Activity Reprts. This can be useful if the EWA is primarily used t receive datafiles. When checked, the lgin screen is autmatically displayed after a lg ff. Allw user lgin when already lgged in Display received datafiles first Return t lgin n lgff Shw Gruped If this ptin is checked, the Dmain infrmatin received frm the EDAMIS Prtal will Prtal Dmains be gruped in the Dmain reprt. EWA hst name r Determines the hst name f the applicatin r his IP address. IP address system parameters Stadium base Determines the stadium base directry in statel. Cuntry Indicates the cuntry f yur rganisatin. Organisatin Indicates the name (r acrnym) f yur rganisatin. client id (lcal snn): The value fr this parameter is autmatically filled in. snn means STATEL nick name. This snn identifies a unique pint fr STATEL t and frm which file transfers can be perfrmed. Transactin tcp/ip prt Debug level Lg file size installatin date Last parameter mdificatin date EDAMIS Web Applicatin versin actin buttns Update Cancel Enables t check if all data transmissins have arrived at Eurstat. The transactin number is the unique ID f the file which is available in the XML envelpe. Autmatically incremented. Identifies the prt via which the applicatin can be accessed. When the prt number changes a restart f the applicatin is required. This means that the Administratr lgin shuld d an EWA shutdwn and restart. Indicates the debug level. The minimum is 0 (default value, n debug infrmatin are written t the lg file) and the maximum is 5 (all the debug infrmatin are written t the lg file). The maximum number in bytes f the lg file. If the max size is reach, a new lg file will be created. Date n which the mst recent release f the EWA has been installed. Date n which the last update t the parameters has been made. Indicates the versin f the EWA and the date the versin has been released. If any changes are made t ne r mre f the parameters the usage f this buttn invkes the updating f the changed parameters. Using this buttn will cancel the updating f the parameters 6 The Eurstat Validatin Mdule The Eurstat Validatin Mdule has been integrated int EWA, and if an https access is available in rder t dwnlad the validatin rules, datasets can be validated befre transmissin t Eurstat. Please inspect the Validatin parameters befre the EWA is released fr user access. Nrmally, all the settings are autmatically detected and dn t need t be mdified. Please cntact EDAMIS befre making any changes. If n https access is available fr the EWA, the validatin mdule will remain inactive and the validatin f the datafiles will take place n the EDAMIS server itself after receptin f the datafile. In this case, the validatin f the sent datafile is pssible nly if the datafile is nt encrypted. 7

8 The https access is als required t keep the lcal cpy f the validatin engine up t date. If a new versin f the validatin engine is made available, it will be updated autmatically during the next validatin prcedure. 7 Imprtant ntes 1 If a user tries t send a data file that has already been sent and that has the same cntent the EWA will generate an errr, but the file can be transmitted nnetheless. 2 A data file can be transmitted if the selected metadata have been used already, but a warning will be generated when the Add/Validate Datafile buttn is pressed. 8 Supprt If additinal infrmatin is needed r if the EWA is nt functining crrectly please cntact EDAMIS SUPPORT via ESTAT-SUPPORT-EDAMIS@ec.eurpa.eu 8