statel explorer help - europa · the easiest way to copy a file from a windows directory to a...

© 2004... Eurostat

STATEL ExplorerHelp

STATEL Explorer help2

© 2004... Eurostat

1 Introducing the STATEL Explorer

The Statel Explorer is a tool using the STATEL API. The main purpose of STATEL is toorganize file transfer between two well identified parties (the STATEL tuple) and to sharea common storage space (the Virtual File System). All file operations performed into apart of the tuple will be transmitted to the other part (file copy, file delete, directorycreation...).Although, STATEL API is mainly provided to implement a whole automatic file transferprocess, a graphical software is provided to allow manual operation.

Main purposes of the Explorer· Display the content of the Virtual File System (VFS) and check the status of files.· Create directory structure in the VFS.· Copy file(s) in the VFS (i.e. sending files to the remote part).· Copy file(s) from the VFS to the local file system (i.e. receiving files from the remote

part).

Additional purposes of the Explorer· Change telecom settings used for transferring files from and to the remote part of the

tuple.· Run a diagnosis tool.· View the transfer log.· Check the connectivity between the two parts of the STATEL tuple.

2 What's new in version 4.0?

The transport method extended with the HTTP protocol

What's new in version 4.0? 3

© 2004... Eurostat

Now it is possible to send and receive files using the HTTP protocol. Simply add the hostname and port number.

3 Help on the STATEL Explorer

Help DeskFor Eurostat users: the ECAS HD (Eurostat Communications, Applications and SystemHelp Desk) should be contacted.E-mail: [email protected] phone number, please consult the web site.For all other user: please refer to the organization which has provided the software.

STATEL on the webThe STATEL web site is at your disposal. You will find there all software anddocumentation related to STATEL and tools.

http://www.statel.com/http://www.statel.com/


© 2004... Eurostat

4 The user interface: an overview

4.1 The workspace

This section gives you an overview of the STATEL Workspace.Follow this link to go to details.The tool barsContain the command to perform mainly file operations. There are 3 toolbar's: the SNN& VFS directory toolbar (upper left), the STATEL file toolbar (upper right) and thewindows file toolbar (bottom right).

The STATEL VFS panelThere are two panels: the SNNs and directory panels (right part) and the file panel (leftpart). Both panels display VFS structures inside a particular remote SNN only if this SNNhas been opened.

The windows file system panelsThe two panels are similar to the corresponding panels into the windows explorer. Thesecond click (most often the right click) display the contextual menu (like using thewindows explorer). There is no menu or toolbar command available except to select thepresentation of the file display (large icon, report,...).

The user interface: an overview 5

© 2004... Eurostat

4.2 The toolbox: configuration group

Preferences: it allows the user to edit preferences configuration.

SNNs maintenance: display a panel to create new remote SNN and to select andconfigure the desired transport method.


© 2004... Eurostat

4.3 The toolbox: status & log group

SNNs: display the status of every remote SNNs, particularly useful to check thesynchronisation with the other end of the tuple.

Telecom logs: display the logs of FTP and HTTP work sessions. These logs are useful todiagnose the probable cause of connectivity trouble.


© 2004... Eurostat

4.4 The toolbox: tools group

Reset SNN: perform a synchronisation operation for the selected remote SNNs.

This operation should be made at the request of the Help Desk only.

SNN maintenance: edition and creation of default VFS structures (STADIUM andGESMES directory tree).

Help Desk: a very useful tool. It allows the preparation of an information package tosend to the Help Desk.


© 2004... Eurostat

4.5 The toolbox: windows integration group

Configuration: allow to enable and configure the STATEL Shell extension: a specific itemin the file contextual menu.


© 2004... Eurostat

4.6 The STATEL shortcut menu

The STATEL Shell Extension: if enabled a STATEL menu item is added to the filecontextual menu in the windows Explorer. Using this feature, you can quickly copy a fileinto the remote SNN and the directory of your choice. It is recommended to sendGESMES messages by this way.

5 An ordinary worksession


© 2004... Eurostat

If needed, expand the local SNN to display the list of remote SNNs. Most of time, onlyone remote SNN exists (eurostat-1).Then, click on the needed remote SNN to select it.

Opening the remote SNN

There are 3 possible methods to open the remote SNN:1. Make a double click on the remote SNN2. Click on the open door icon in the toolbar3. Make a second click on the remote SNN. A contextual menu is displayed, select Open

SNN.

Receive session

An ordinary worksession


© 2004... Eurostat

Some specific data collection process requires that the file be copied in a particular VFSdirectory.For example, GESMES file send to Eurostat must be copied in the /GESMES/C2Sdirectory.

Copy file(s) from STATEL to windows

Make exactly the same operations in the opposite direction.


© 2004... Eurostat

5.2 using the Shell extension

This a quick and simple method to send data.

Selecting the remote SNN and directory to copy into

1. Select the file(s) to send from the windows Explorer2. Make a second click on that(these) file(s)3. Select the To Statel item, then the Choose recipient sub itemA dialog box is displayed:

Open the remote SNN of your choice (double click or select and click Open SNN) andselect the needed directory to copy the file(s) into.

Click Ok to start the file copy.


© 2004... Eurostat

6.1.2 Windows file panels

The two panels are, in every respect, similar to the windows explorer panels except thatthe file panel (at right ) do not display the folder, only the files.In addition, no menu items are devoted to the windows file and directory although themenus are available (by making a second click).

6.1.3 STATEL directory handling

Expanding directory treeYou can either:· Double click the opened remote SNN or a particular directory or,

· Click the located at the left of SNN or directory or,· Make a second click on the remote SNN or a displayed directory and select Expand in

the contextual menu. In this case, every directory levels will be displayed.

Collapsing directory treeYou can either:· Double click the opened remote SNN (the root) or a particular open directory or,

· Click the located at the left of SNN or directory or,· Make a second click the remote SNN or a opened directory and select Collapse in the

contextual menu.

Selecting directory to display file(s)Just click a closed folder icon. The folder will open and the file(s) contained in the openeddirectory will be displayed in the right panel.

Creating directory· Select the root (remote SNN) or the needed directory· Click the Create directory icon or,· Make a second click the parent directory and select Create STATEL directory in the

contextual menu or,· Select the Create STATEL directory menu item in File Menu.

Deleting directory· Select the directory to delete· Make a second click the directory and select Delete directory in contextual menu

displayed or,· Press the delete keyOnly empty directory can be deleted. Remember that the STADIUM and GESMES directories and subdirectories cannot be deleted.

Copy a Windows directory to an opened VFS· This operation will copy the Windows directory and everything contained in that

directory.· Select and drag the Windows directory over the remote SNN or the VFS directory

needed.· The directory flied over will be automatically selected.· When needed, drop the dragged directory on the target directory.

Copy a STATEL directory to WindowsThis operation will copy the STATEL directory and all its content.· Select and drag the STATEL directory over the Windows directory needed· The directory flied over will be automatically selected.

References 17

© 2004... Eurostat

· When needed, drop the dragged directory.

6.1.4 STATEL file handling

Copy file from windows to VFSThis operation will copy every selected Windows file(s) files to the VFS.· Select and open the target STATEL directory.· Select the needed file(s) and drag it over the STATEL file panel. Others methods are

described in the toolbar topic.· Drop the dragged file(s).

Copy file from VFS to WindowsThis operation will copy all STATEL file(s) selected files into the local file system(Windows).· Select and open the target Windows directory.· Select the needed STATEL files and drag it over the Windows file panel. Others methods

are described in the toolbar topic.· Drop the dragged file(s).

Deleting fileThis operation will permanently delete the selected STATEL file from the VFS. The filedeletion will be transmitted to the other end, the file will disappear from that remote VFS.· Select and open the STATEL directory needed.· Select the STATEL file(s) to delete .

· Click from the STATEL file toolbar or press the delete key from the keyboard.

Displaying file contentThere are two methods:1. By making a double click on the file icon. The associated program will be started to

display the file,2. By making a second click and choosing Default editor to start the program configured

as default editor (SEE).

6.1.5 The toolbars

The SNN toolbar

From left to right, the icons represent:Opened door: to open the selected SNN. This icon is disabled when a remote SNN isopened.Closed door: to close the opened remote SNN. The SNN closure will cause the start of atransmit session (only if file operations has been made).Refresh: close and reopen the opened remote SNN; the icon symbolise a paint brush.This command allows the refresh of the VFS content and the transfer of the lastoperations performed.Unlock: select the locked SNN and click this icon to unlock the SNN. Then, the SNN canbe opened.New folder: create a new directory in the selected directory of the remote SNN. A dialogbox is displayed to enter the directory name.


© 2004... Eurostat

It is possible to enter a directory path to create multiple directories at the same time. Donot enter a trailing slash (/).Open toolbox: Open the toolbox window.The command is disabled when a remote SNN is opened, it is not allowed to change theconfiguration on a working SNN.

The statel file toolbar

Views:

Click on that icon to select the file list view desired. After selecting an item, the file listpanel is updated accordingly.Copy to: make the copy of every files selected in the STATEL file panel after displayingthe browse for folder dialog box.

References 19

© 2004... Eurostat

Click Ok to start the copy.Move To: this command performs the same operations than the command Copy Toexcept that the files are moved instead making just a copy. This implies that after asuccessful file copy, the corresponding is deleted from the VFS; a confirmation will berequested.Delete file: delete every STATEL files selected. A confirmation message will bedisplayed.

The windows file toolbar

Views: see above.Copy To: make the copy of every files selected from the windows file panel to theopened STATEL folder after displaying the browse for VFS folder dialog box.


© 2004... Eurostat

Click Ok to start the copy.Move To: this command performs the same operations than the command Copy Toexcept that the files are moved instead making just a copy. This implies that after asuccessful file copy, the corresponding file is deleted from your PC. Use this commandwith care because combined with the preference No local copy of data, the selected filecould be permanently deleted unintentionally.

References 21

© 2004... Eurostat

6.2 The toolbox

6.2.1 The toolbox window

Click the desired group to jump to the detailed topic.

6.2.2 Configuration

6.2.2.1 Preferences

Preferences


© 2004... Eurostat

Click the Preferences item to display the configuration panel.

The first item (Do not perform a local copy...) allow to spare lot of disk space especially ifyou are sending huge files.When checked, STATEL will not copy the data into the VFS, it creates just a virtual entry(the filename and the file attributes) whilst the data are transferred via the PDUs. Thecorresponding file mode is: virtual mode opposite to Archive mode.

The second preference item (Default file viewer) is the choice of the default editor todisplay the content of STATEL file. Usually, the default editor is a text editor program(like Notepad) because application often creates text file without extension in the VFS.Conversely, file with extension can be edited by their associated program.Enter the path to the executable of the program or click on the ellipsis button and locateand select the needed .exe file.

References 23

© 2004... Eurostat

6.2.2.2 SNNs maintenance

SNN creation

If the desired SNN is not present in the drop down list of existing SNNs, click New SNN tocreate a new one.The SNN creation process will create all the necessary structures:· the tuple directory: a particular directory for the new SNN is created, the directory

name is the SNN.· the main configuration file (CF)· two transfer transit subdirectories: send and receive.

If you are interested getting more technical details about the STATEL installation, pleaseconsult the technical manual on the web.

A dialog box asking the new SNN is displayed.

The SNN naming convention at Eurostat is:iso_country_code-organization_acronym-sequence_numberExample: lu-statec-1

http://www.statel.net/


© 2004... Eurostat

Please check the SNN entered for possible typo before to click Ok. The next action is toconfigure the newly created SNN.

SNN Configuration

First, select the method of transport to use to display the corresponding panel.The three possible methods are:1. Local copy: the PDUs are copied on a network drive accessible by the two parts of the

tuple. This method is intended to be used on a LAN only.2. Connection to a Statel gateway (FTP): the transport protocol is the STATEL protocol

derived from ftp.3. Connection to a Statel gateway (HTTP): the transport protocol is the STATEL protocol

derived from http.

Indeed, the second method is the most common used until now either standalone or inconjunction with the STATEL Hub.

Local copy

Select two directories:· one to store the incoming PDUs· and one to store the outgoing PDUs.

Most of time, those directories are on a network drive.

You can either enter the path or click the ellipsis button.

References 25

© 2004... Eurostat

Connect to a STATEL gateway

The STATEL FTP gateway configurationEnter the parameters needed to connect to the STATEL FTP Gateway which is the entrypoint of the data collection center. For example, the data collection network of theEuropean Commission uses the statelgw.cec.eu.int host.

Host name or AddressEnter the URL or the host name or the IP address of the STATEL FTP Gateway to reach.The default value proposed is the URL of the EC STATEL gateway used by Eurostat andDG Agriculture. In some cases, the machine could not access a DNS in order to performthe name resolution of the URL (DNS address not defined on the machine, connectionusing TESTA).In this case, it is mandatory to use the IP address instead. The IP Address of the ECgateway is:* 158.169.9.32 when connected through the Internet* 62.62.70.32 when connected through TESTA.

Port numberThis the port number on which the server is listening for a connection. When the STATELGateway protocol is derived from FTP, the default value proposed is 21. However it ispossible to use another port number (>1024) only if you have the control of the STATELFTP Gateway. For the EC FTP Gateway, use the port 21.


© 2004... Eurostat

Use passive mode (PASV)Turn this on if you want your PC to establish the data connection to the FTP site insteadof the site establishing the data connection to your PC. It is absolutely necessary forsome firewall and gateway configurations and when you get failed data channel errors.Note, however, that not all FTP sites support passive mode. The EC Gateway supportspassive mode.

The STATEL HTTP gateway configurationEnter the parameters needed to connect to the STATEL HTTP Gateway which is the entrypoint of the data collection center. For example, the data collection network of theEuropean Commission uses the webgate.cec.eu.int host.

Host name or AddressEnter the URL or the host name or the IP address of the STATEL HTTP Gateway to reach.

The settings are similar to FTP.Contact the Help Desk for further details.

Port numberThis the port number on which the server is listening for a connection. When the STATELGateway protocol is derived from HTTP, the default value proposed is 80. However it ispossible to use another port number (>1024) only if you have the control of the STATELHTTP Gateway. For the EC HTTP Gateway, use the port 80.

The firewall - proxy configuration

· Configuration when the transport protocol is FTP

Type of proxy - firewall usedThere are different types of firewall supported:

· No proxy - Sends the FTP client Username and optional Password.· User - Sends the Proxy Username and optional Password, followed immediately by the

FTP client Username and optional Password.· SITE - Sends the Proxy Username and optional Password, sends the SITE command

and the FTP Host property, and the FTP client Username and optional Password.· HOST - Sends the Proxy Username and optional Password, sends the HOST command

with the FTP Host property, and the FTP client Username and optional Password.· CONNECT - Sends the Proxy Username and optional Password, sends the CONNECT

References 27

© 2004... Eurostat

command with the FTP Host property, and the FTP client Username and optionalPassword.

Select the most appropriate item. If needed, contact your network administrator to helpyou in setting the proxy.If your proxy is not supported by the Hub, please contact the Help Desk and provide us with thespecifications of your proxy.

Host name or IP addressEnter the host name or IP address of the firewall (not the FTP remote host).

Port numberEnter the port number of the related service on the firewall (not the port number of theremote host, it could be different).

User name and PasswordEnter them in the corresponding fields as provided by your administrator (take care ofthe possible case sensitivity).

· Configuration when the transport protocol is HTTP

Type of Proxy - Firewall usedThere are three types of firewall supported:

· No proxy - There is no proxy server between Statel Explorer and Statel gateway· HTTP PROXY - There is an HTTP proxy server between Statel Explorer and Statel

gateway· SOCKS 5 - There is a SOCKSv5 proxy server between Statel Explorer and Statel

gateway

Select the most appropriate item. If needed, contact your network administrator to helpyou in setting the proxy.If your proxy is not supported by the Hub, please contact the Help Desk and provide us with thespecifications of your proxy.


© 2004... Eurostat

Host name or IP addressEnter the host name or IP address of the proxy (not the HTTP remote host).

Port numberEnter the port number of the related service on the firewall (not the port number of theremote host, it could be different).

User name and PasswordEnter them in the corresponding fields as provided by your administrator (take care ofthe possible case sensitivity).

6.2.3 Status & log

SNNsPerform several diagnostics involving every remote SNNs and collect the results whichare displayed on the text panel.The system reports:· the sequence number: local, remote and transmitted; useful to check the

synchronization with the other side.· the number of PDUs contained in the transit directories.The results of the diagnose are also added to the support package.

Telecom log (FTP)Display the log of the transmission session when the transmission protocol is FTP. The logis present only when the FTP STATEL protocol has been selected. That log is added to thesupport package as well.

Telecom log (HTTP)Display the log of the transmission session when the transmission protocol is HTTP. Thelog is present only when the HTTP STATEL protocol has been selected. That log is addedto the support package as well.

6.2.4 Tools

Reset SNN

References 29

© 2004... Eurostat

Sometimes it is needed to reset the sequence number to restore the synchronisationbetween the two parts of the tuple.Most of time, a request to do a reset will come from the Help Desk after making theappropriate diagnose. In any circumstances, the Help Desk must be informed when areset is performed because the same operation should be made at the other side.To reset a particular remote SNN:· select the SNN on the list· click either Locally or Locally and propagate.The two methods will reset the sequence number in the CF file and will clear the transitdirectory. The second method will transmit the reset to the other side using a particularprotocol element.In case of doubt on which method to use, contact the Help Desk.

SNN maintenance


© 2004... Eurostat

Some applications which are using STATEL as a transport layer need the presence ofspecific directory structures in the VFS. Usually, those structures are created remotely(on the central side) by the support staff and are carried out in the local VFS at the firstconnection time. It is possible that the structures are missing due to various causes:unexpectedly removed by human, creation oversight,... In this case, an error messagewill be reported and the file sending will be prevented. The error message is:51:API:No such VFS file

This tool allows the (re)creation of the missing structures by the user instead of waiting aremote creation by the support staff.In addition, it is possible to customize the list of structures by adding, removing orchanging the items in the list. The list shown in the illustration is the default values, theyrepresent the STADIUM and the GESMES directory trees.

To create the missing structures:1. Select the needed remote SNNs in the drop down list.2. Click Create VFS Structures.

To add structure item:1. Enter the directory path in the edit field. The structure representation follows the

UNIX convention (in particular the directory structure is case sensitive: TEST and testare different). At the beginning, always enter the root (/) and do not add a trailingslash. Example: /TEST1/TEST2

2. Click Add.3. The item is added to the list.

To remove structure item:

References 31

© 2004... Eurostat

1. Select the needed list element.2. Click Remove.3. The list is updated.

To change structure item:1. Select the list needed to be changed.2. The element is displayed in the edit field.3. Make the change needed.4. Click Replace.5. The list is updated.

Help Desk

Three methods to prepare a package are proposed. Those packages allow the Help Deskto make an accurate diagnosis of a problem.A package is prepared for one SNN at a time. The packages are:1. Basic support package: it contains basic information (every configuration files and

logs in a zip file).2. Detailed support package: the same that the previous plus every files present in the

tuple directory.3. Stopgap solution: sometimes it is not possible to continue the data transfer (network

problem) while the mail is functioning. This function prepares a zipped file containingthe PDUs not yet sent present in the send directory. The archive is split intofragments to prevent mail filtering based on the size. Every fragments should be sendto the Help Desk. Then, the staff will dispatch the PDU to the right location.

Select the remote SNN, click the package of your choice. The Explorer will report wherethe package has been stored an the end of the process. Then, attached the package to amail and send it to the Help Desk.


© 2004... Eurostat

6.2.5 Windows integration

Since the version 2.0, it is possible to enable a windows Explorer shell extension. Theshell extension is STATEL menu item present in the file contextual menu. That menu isdisplayed when a second click occurred on a file from the Windows Explorer. There are 3possible items in the STATEL submenu:1. Choose recipient: allow the user to select the remote SNN as well as the VFS

directory where to copy the selected file.2. A customizable item: the remote SNN and the VFS directory are configured.3. An item to start the STATEL Explorer.

References 33

© 2004... Eurostat

Enable Windows Explorer enhancement: if checked, a STATEL item is added in thecontextual menu providing that the extension will registered.Register Extension: operation to inform the operating system to load the shellextension.Unregister Extension: operation to inform the operating system to unload the shellextension.Add a menu subitem: enable he possibility to add a customized item in the STATELmenu. This option requires further elements to be functional.They are:1. a name for that subitem menu. You can provide anything you want.2. Select the needed remote SNN to send data3. Select the VFS directory path where to copy the selected file(s): the path can be

entered or click the ellipsis button to make a selection.

6.3 Rules to enforce

For all users· Do not open simultaneously the same SNN from several applications like the Explorer

and the Stadium Client to avoid conflict.· Do not make unexpected changes in the settings window. Because STATEL allows file

transfer between two well identified parties, all telecom changes made should bereflected at the other side of the tuple. In other words, changing the configurationshould be coordinated (usually by your Help Desk).

· Do not abort send or receive session (except if a trouble occurs or if the file transfer istoo slow or hanged). In any case, make a connection later to resume the transfer.

For Stadium Client user


© 2004... Eurostat

Consider the STADIUM directory tree as the private domain of the STADIUM Clientapplication. Do not modify or create anything into this directory structure.

In particular:· Do not delete or rename any sub directory,· Do not copy manually file(s) into,· Do not delete or rename any file(s), except at the Help Desk request.

Unexpected change or creation (new subdirectory, file...) could cause trouble on theSTADIUM server.

For sender of GESMES message

A similar directory structures is used to collect GESMES messages. Please do not removethe directory structure. Anyway, in this case, the file copy inside the directory tree isallowed.

6.4 Frequently asked questions (FAQ)

See the FAQ section on the support web site.

http://www.statel.net/

Introducing the STATEL ExplorerWhat's new in version 4.0?Help on the STATEL ExplorerThe user interface: an overviewThe workspaceThe toolbox: configuration groupThe toolbox: status & log groupThe toolbox: tools groupThe toolbox: windows integration groupThe STATEL shortcut menu


statel explorer help - europa · the easiest way to copy a file from a windows directory to a...

Documents