Statel Robot Service Help Eurostat

Transcription

1 Statel Robot Service Help

2 2 SRS help 1 Introduction 1.1 Overview The objective of the STATEL Robot Service is to provide an automatic tool to automate file transfer in a process pipeline using STATEL. The files arriving through the pipeline are deposited in a local directory, the SRS will copy the outcoming files into STATEL. Conversely, all incoming files are read from STATEL and deposited in another local directory. All the actions required to achieve this result occur in a transparent fashion. Also, the SRS manage a comprehensive time schedule to program work session. Finally, the SRS is a service starting at boot time. The following diagram illustrates the principle of the SRS. Of course, the outcoming file deposit and the incoming file processing is not under the control of the SRS. Requirements Hub Machine One PC running Windows NT 4 Server or Workstation (at least service pack 5) or windows TCP/IP installed. STATEL already installed and registered by the STATEL help desk. Disk space The SRS machine should have sufficient free disk space. How much free disk space is needed? The SRS will store temporary all incoming and outcoming STATEL files. Therefore, it is

3 Introduction 3 not easy to make an accurate recommendation. Consider that 100 MB of free space is the minimum recommended. Connectivity An access to external network ( Internet, TESTA ). 1.2 SRS components The STATEL Robot Service contains 3 components: the core service, the external application and the SRS controller. SRS core service The service manages the time schedule. At wake up time, the service will start the external application. SRS External application The application performs the core function of the SRS. It will open a STATEL session in order to receive and send file(s). SRS controller This application which allow monitoring and controlling the service. Also, the controller allows installing the service in Windows Service Control Manager. It contains different tabs to configure the SRS and a tool to display the logs. SRS Notify A small application to display a notification when file arrived. 1.3 Directory structure Program files The STATEL Robot Service files are installed by default into the STATEL32 bin directory.

4 4 SRS help The program directory contains 3 program files related to the SRS: SRSched.exe: this is the scheduler service binary SRSapp.exe: this is the application which is load at wake up time (started by the SRSched.exe) SRScfg.exe: this is the SRS Controller application binary. Data directories Two data directories should be defined for file transfer: The windows data directory. It must contains two sub directories: one for the outcoming files (for example \out) and one for holding incoming files (for example \in). The windows temporary directory: the purpose of this directory is to hold temporary the incoming and outcoming files. The use of temporary directory avoids processing partial files. Note that it is strongly recommended to use the same disk partition to define the two directories. In this way, the file move operation will be atomic. Also, it is not recommended to use a network drive. Using a local disk partition will insure their constant availability. Finally, these directories must be created before to configure the SRS. The SRS Controller does not allow creating directories. 2 SRS controler 2.1 How to use help Browsing help Select Help content in the help menu to display the table of content

5 SRS controler 5 Contextual help Press F1 key to display contextual help. The topic displayed is related to the object which has the focus at this time. 2.2 Starting SRS controller There are two ways to start the controller: 1. Go to the START menu, select STATEL 32 in the Programs group and select SRS Controller. 2. Go to the windows Explorer, locate and open the Program Files directory, locate and open the Statel32\bin directory and double click the SRScfg.exe icon. The main window is displayed. It contains: Configurations elements located into different tabs. The first tab (Service Status) allows the service control (installing, starting, stopping...). Some tools as log viewer accessible via the toolbar or the menus.

6 6 SRS help 2.3 Install and run service It is recommended to completely configure the SRS before to install and particularly before to run the service. Also, stop the service before to change configuration. After modification, save the new configuration and restart the service in order to apply the new settings. SRS configuration Controlling SRS service Installing the service This operation will register the corresponding service into the Windows Service Control Manager database. Hub services are installed with the Startup type automatic: the service will be started automatically at boot time. Nevertheless, user must start manually the service after installation. Start running the service Load the program into memory. Because a service has no graphical interface, possible error messages are not reported in a popup window as usual for an application. The error messages generated during installation or start are reported into the Windows general log. These messages can be displayed using the Event viewer. If a problem occurred after starting the service (i.e. the status panel text remains 'Service is not running" after a few seconds, consult the Windows event viewer. Running the Event Viewer 1. Select Start Programs Administrative Tools Event viewer 2. Select Application log and browse the report view to locate the possible SRS entry and double click the corresponding line. Note the error message and contact the help desk.

7 SRS controler Monitoring and controlling service The Service status pages allows to: Install the service into the Service Control Manager (SCM) Uninstall the service from the Service Control Manager. Note that this uninstallation remove the service form the SCM. To remove the files installed on the hard disk see the topic uninstalling the SRS. Start and Stop the service. Kill the service: should be used when it is impossible to stop the service using the normal way (Stop service). Connect now... to initiate an immediate Statel session. Useful if you want to send or receive data urgently. Important Each time a configuration change is made, the service must be stopped and restart in order to force the service to read the new configuration.

8 8 SRS help Note that the buttons can be enabled or disabled depending on the current context. 2.5 Menus and toolbar icons File Save Save all configuration changes. Remember that to be sure that the new settings will be applied, it is recommended to stop and restart the related service. File Exit Exit from SRS controller. A warning message will displayed if: a configuration element has been changed (except for schedule). the service is not running. Edit Cut, Copy, Paste As usual. Tool log viewer Display the log viewer window. The 3 possible logs are displayed in the same windows. To read one particular log, just click the corresponding tab.

9 SRS core service configuration 9 3 SRS core service configuration 3.1 SNN's, directories & external program SNN (STATEL Nick Name) The SRS is able to control several SNN's. These SNN's must be already configured on the target PC. Select the desired SNN(s) to be controlled by the SRS by checking the corresponding box in the SNN list. Select the SNN desired to display the corresponding setting parameters. Note that: checking SNN and selecting SNN (to display and to change the setting) are two different user actions. the configuration elements are hidden for unchecked SNN's. STATEL directories You can either enter directly the VFS path or click on the folder icon to display the VFS directory content.

10 10 SRS help Inbound directory: enter the STATEL inbound directory path. The file(s) present in this directory (received from the remote party) will be read and move to the local inbound directory. Outbound directory: enter the STATEL outbound directory path. The file(s) move from local directory will be copied into this directory end then send to the remote party. The VFS directory must exist in the STATEL VFS before to use the SRS. The directories can be created either using the STATEL explorer or at remote side by the support staff. Note that the leading AND trailing slash must be present. Using the graphical tool avoid misspelling directory. Local (windows) directories Inbound directory: enter or select the local inbound directory path. This directory holds the file received by STATEL waiting the continuation of the pipeline process. Outbound directory: enter or select the local outbound directory path. All files present

11 SRS core service configuration 11 in this directory will be transfer to STATEL and consequently send to the remote party. The local directory must exist before to use the SRS. The SRS controller does not support directory creation. It is strongly recommended all local directories reside on the same disk partition. In addition, all local directories should be located on a local hard drive (not a network drive) to prevent possible access problem during a transfer session. Recursive Check this option if the propagation of the directory structure contained in the Outbound directories is needed. In other word, if this option is checked, every sub-directories contained in the windows outbound directory will be created in the STATEL VFS and finally, created in the windows inbound directory at the remote end of the link. On the other hand, every file contained in any of the sub-directory (including the windows outbound directory) will be moved to the same location at the remote end. Note the file move means that after a successful transfer, every file will be deleted. Be careful selecting the windows inbound directory; do not select a directory which contains vital file(s). External program Run external program at the end of STATEL session Check the box if you want to run an external program at the end of STATEL session. Do not forget to select the program to run. External program to run Select the program to run. Note that the full pathname is mandatory. If you want to run a external script (such as a perl script), you must select the script file. EDAMIS Settings These settings concern only SNNs communicating with the EDAMIS Central Client. In such case the "Activate EDAMIS function" must be checked. With this function enabled, SRS watches the outgoing windows folder and whenever a new file is placed, it sends an extract of this file to the remote SNN, named as the original file with an extension ".eda". "Pattern Length" defines the size of this extract in bytes. "Statel Directory" defines the Virtual Directory that the extract will be copied.

12 12 SRS help 3.2 Notification It is possible to get a notification when file arrives. There are two possible methods: Using a floating window If you need to be notified when file are coming, check this box and the following floating window will popup when files are coming. Once the window is open, its content will be updated regularly. Using the mail Check the corresponding checkbox and provide the needed information. The SMTP host address: this is the address of the mail server used to send the mail The list of recipient addresses to which the mail should be send. Each mail address must be separated by a comma. IMPORTANT. After changing this parameter, STOP and START immediately the service (Service status tab). This manipulation is needed to change some internal service parameters to allow (or avoid) interaction with the desktop. If you do not the stop/start manipulation, the notification window will not work properly.

13 SRS core service configuration Schedule There are two possible main choices to define the SRS connection behavior: The workstation will be data sender only (Choice B), The workstation will be both data sender and receiver (Choice B). If you want to NOT use a time schedule, check the box Do not use schedule, otherwise uncheck it. Choice A (Data sender and receiver) Two types of time schedules are available, select the desired type (A or B). Type A (simple schedule) This type of time schedule is organized on a recurrent connection basis, make a connection every x minutes between xx:xx and yy:yy. Additionally, it is possible to choose the day of week. To define a simple schedule Select Type A Enter the interval between connection (expressed in minutes) Define the start end the end time Select the day(s) needed. Type B (comprehensive schedule) This type of time schedule is organized on a day of week basis. For each day of week, it is possible to define a different time schedule.

14 14 SRS help To define a comprehensive schedule: Select Type B Select the day of week Enter (using the time selector) the session time needed. Click Add Repeat the procedure to enter other time schedule for the same day or another day. To replace a time event: Select the day and time to replace into the Time to connect list Modify the time edited into the time selector Click Replace To delete a time event: Select the day and time to replace into the Time to connect list Click Delete The comprehensive schedule data are stored in the file timelist.dat located in the application directory. This file could be edit using a text editor. Choice B This choice is for workstation which acts as data sender only. Using this option, the SRS will connect only if file(s) are present in the local outbound directory. As soon as a file will be copied or moved in the directory, the SRS will start to monitor the number of files. When this number will remain stable (i.e. no more file after 2 minute), the sending process will start. Note that sending an incomplete file (because the file is still written) is not possible. To configure the choice B Enter the maximum number of additional connection (at least 1, recommended value: 2)

15 SRS core service configuration 15 Enter the time interval (in minutes) between two connections The help desk can help you to select the best value for these parameters according to your particular user profile. 3.4 Logging Log files location Enter or select the log directory. The local directory must exist before to use the SRS. The SRS controller does not support directory creation. The log directory should be located on a local hard drive (not a network drive) to avoid access problem. Maximum size Enter the maximum size (in KB) for log file. The SRS will perform a roll over when this size limit will be reached. Note that a copy of the previous log file is maintained (.bak) until the next roll over operation. 4 Support & maintenance 4.1 How to obtain support Depending which is the software provider and at which use the STATEL Hub is intended, the Help Desk should be different. Eurostat & DG Agriculture users STATEL Help Desk Phone: Fax: estat-support-statel@cec.eu.int Contact persons: Tasos Chronis & Pierre Evrard Other users Please contact the software provider or consult the documentation to learn more on your Help Desk. 4.2 Log viewer The SRS controller have a log viewer module. There are 3 different logs available:

16 16 SRS help Summary log: this log display the list of file(s) successfully sent and received for each session. Operation log: this log display the list of file operations for each session and finally the next session time scheduled. The possible operations are: Move from windows to temporary directory STATEL read Move from temporary directory to windows directory STATEL delete Statel write Error log: display all error conditions. The toolbar contains a button to refresh the content of the log displayed. This command should useful for checking purposes: starting a session manually, display the log and refresh the content time to time. 4.3 Uninstalling the SRS Prior to delete the installation, the service must be stopped and uninstalled from the Windows Service Manager. To delete SRS files (and remove registry entries), execute the uninstall program. This program (unwise.exe) is located in the STATEL32\bin directory. Open this directory and double click the unwise.exe icon.

17 Support & maintenance 17 Select the automatic method. 4.4 Document version Version: 1.9 Date: September 2004 Author: European Dynamics