UserManual rvsEVO
UserManual rvsEVO
UserManual rvsEVO
Version 5.04
User Manual
Content
Introduction .....................................................................................................................9
1.1
1.2
1.3
1.4
1.5
1.6
1.7
Installation .....................................................................................................................15
2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.8
2.9
2.10
2.11
2.12
Configuration ...............................................................................................................37
3.1
3.1.1
3.1.2
3.1.3
3.1.4
3.2
3.2.1
3.2.2
3.2.3
3.2.4
3.2.5
3.2.6
3.2.7
3.3
3.3.1
3.3.2
4.5
4.5.1
4.6
4.7
4.8
4.9
4.10
4.11
4.12
4.13
4.14
4.15
4.16
4.17
4.18
4.19
4.20
4.21
4.22
5
6.8
6.9
Content
9.1
9.2
10
11
Introduction ......................................................................................................171
Command Tools of the Central Administration ................................................172
How to work with the central administration features? .....................................174
How to exchange a license key file? ................................................................175
How to change a station parameter? ...............................................................176
How to make an update of rvsEVO? ...............................................................178
15
Derby ................................................................................................................167
Oracle ...............................................................................................................167
How to Drop and Create the Database Tables? ..............................................169
How to view job data from a database? ...........................................................170
14
Introduction ......................................................................................................161
Configuration ....................................................................................................161
Configuration of stations ..................................................................................161
PKI configuration file ........................................................................................162
13
12
Appendix ......................................................................................................................191
15.1
Index ............................................................................................................................................1
Change History
The follwing changes of User Manuel were made:
Version 5.04
New parameters for SEND command (rvsbat): INITTIME, TSTAMP,
ALG, COMPRESSION, ENCRYPTION, FILEDESC, SFS, SIGN,
SIGNRESP, XID
additional functionality of rvsbat: managing jobstarts
new environment varibles for parameterHandling=ENV:
RVS_ERROR_TEXT and RVS_ERROR_ID
new start/stop scripts for installations on UNIX systems
default settings for creating new transmissions
revision files are configurable via MaxRevisionLogSize and
MaxRevisionLogCount paramters
installation of rvsEVO with default values
stationlist as table configurable
new chapter about setting up a virtual station
saving Monitor Messages in Oracle database
key management reachable via tab Key
new chapter about the functionality connection pooling
new depiction command tools: rvsbat, restartJob,
convertFile, getCertificateList, sendJournal,
startKeyMgn
description of working with CA certificates
description of batch files in $RVS_HOME\bin\jobstart directory
minor updates
Version 5.03
Update of chapter Customizing the JobStarts
JobStart configuration in case of failed jobs.
new JobStart parameters
update of chapter Displaying Monitor Messages
configuration of display of Log Messages
after new start of the GUI: displaying of the last 25 Log Messages
new chapter about license key details
minor updates
Version 5.02
Update of installation chapter:
Introduction
Introduction
In this chapter you will find a short description of rvs and rvsEVO as
well as an explanation of typographic conventions used in the present
manual.
1.1
What is rvs
rvs = RechnerVerbund-System
The abbreviation rvs stands for the German word Rechner-VerbundSystem. The rvs computer communication system is a well established
base service for electronic data interchange, EDI.
rvs serves to ensure transmission of electronic data between
heterogeneous computer platforms using different network protocols.
To do so, rvs implements a universal network model, which you can
configure in each network node.
rvs provides an efficient and reliable transport service for both
standardized EDI message types and files of any format or contents. You
can receive only such files that are explicitly destined for rvs. This
means that rvs does not allow any unauthorized access to remote or to
own data files.
The system was originally developed by Volkswagen AG and has been
used in the German and European automobile industries for a number of
years but also by banks, insurances and industry worldwide.
rvs uses the OFTP protocol.
What rvs is not
rvs is not an online system. It neither supports direct terminal-like
access to other sites, nor does it provide a communication pipe from
application to application on a data record level. You cannot directly
execute transfers in your own application. You rather can place send
orders from within you application to rvs which will be handled
asynchronously.
rvs is not a job scheduling system.
rvs does not care about the contents of the files it is transporting. It only
acts as a transparent transport medium and performs no semantic
interpretation of the data it carries.
rvs is not an EDI converter. You can, however, purchase additional
components for converting between specific message formats (e.g. VDA,
ODETTE, EDIFACT, XML) using rvs as transport service from
T-Systems GmbH.
rvs is not a network control or monitoring tool.
What is rvsEVO
rvsEVO
available features
10
Introduction
1.2
The Tiny Edition supports the communication with only one neighbour
station: rvs center. The number of partner station is restricted to 1. Other
stations can be reached via routing. Therefore rvsEVO Tiny Edition is
particularly suitable for star topology.
rvs Tiny
rvs Tiny
rvs Tiny
rvs center
rvs Tiny
rvs Tiny
rvsTiny
Tiny
rvs
rvs Tiny
rvs Tiny
11
central administration
1.3
1.4
12
Introduction
1.5
rvsEVO Enterprise Edition provides all the basic requirements for secure
data transfer with a simultaneous continuous performance even at high
loads. rvsEVO Enterprise Edition includes an automatic adjustment of the
processing capacity and uses a professional external database.
Features of rvsEVO Enterprise Edition (subject to modifications):
no limit of partner stations (direct or routing partner)
no limit of parallel connections (sessions)
routing functionality
all communication components
encryption and compression
Derby database embedded
Oracle database connection
Central Journal
SNMP Agent
code conversion (PC-Mainframe)
central administration
PKI connection
File Service Proxy
remote GUI (10 users)
one virtual station
Additional the follwing components can be linked:
rvs OFTP Proxy for OFTP2
further virtual stations
The available features are limited by the license key.
For more Information on rvsEVO Editions please contact your sales partner (Phone: +375 606 19 902; E-Mail: rvs-service@t-systems.com)
13
1.6
Representation means
Courier
Inverted commas
Bold
Directories
$RVS_HOME
1.7
Target group
14
Installation
Installation
System requirements
2.2
Obtaining a license
Please contact the rvs Service Support Center to receive a license key.
phone from Germany: 0800 664 77 45
phone from other countries: +375 606 19 902
email: rvs-service@t-systems.com
To receive a license key:
Please send the hostname and the Odette ID to the rvs Service
Support Center. You get the hostname as typing hostname in the
command prompt window (Run -> cmd). You can request the Odette
15
2.3
ISDN connection
Network Requirements
Important Note: ISDN is only for Windows platform available. For Unix
platforms XOT should be used.
If you want to use rvsEVO to exchange data via the ISDN network you
need the following equipment:
ISDN type telephone connection with s0 bus having at least two data
channels (B-channel) and one control channel (D-channel)
ISDN adapter
CAPI 2.0 driver software for operation of the ISDN card under
Windows XP.
This is how you install the ISDN interface:
Install the ISDN card into your computer and attach the ISDN card to
the ISDN connection.
Make sure that the ISDN card works properly.
Note: Many card manufacturers supply suitable software for a selftest, such as a call from one data channel to another. Restart your
computer after installation and the test in order to make the CAPI 2.0
driver available for other applications.
External
ISDN router
16
If you use an external ISDN router with remote CAPI Interface (e.g.
BinTec Brick), you do not need an internal ISDN card. In this
configuration, several applications can share the same Brick router. The
Brick router supports the "Remote CAPI" interface. This means that every
computer in your LAN uses the Brick router as if it were a local ISDN card
in the computer.
Installation
Note: T-Systems has successfully tested the following ISDN devices for
use with rvsEVO:
Device
Manufacturer
Eicon, http://www.eicon.de
Eicon, http://www.eicon.de
Eicon, http://www.eicon.de
Remarks
rvs Service Support Center will provide you with the current list of
tested devices:
phone from Germany: 0800 664 77 45
phone from other countries: +375 606 19 902
email: rvs-service@t-systems.com
XOT
XOT connection
2.4
Installation steps
17
With the next two dialogs you get information on installation and the
version of rvsEVO.
If there is already an rvsEVO installation on your machine, you have to
decide whether you would like to install a new version or to update
your current rvsEVO.
If you decide for installing a new version you will be asked whether
you wish to delete previous rvsEVO.
Next you have to choose between a Server installation and a Client
installation (see chapter 9 "Remote GUI").
18
Installation
In the next dialog you can indicate the rvsEVO destination directory.
This directory may not contain another rvsEVO installation.
19
Client Installation
20
The next two dialogs relate to the Client installation only. Please
indicate the IP address (or hostname) and the RMI port (Standard:
Installation
21
1.5._X onwards.
Hint: If you choose to install the Java Virtual Machine especially for
rvsEVO, you have to answer the next question Install JCE Files with
Yes (We recommend this).
Due to import control restrictions of some countries, the JCE
jurisdiction policy files shipped with the Java 2 SDK, v 1.5 allow
"strong" but limited cryptography to be used. rvsEVO uses an
extension of the Java runtime environment - JCE (Java Cryptography
Extension) of Sun Microsystems, Inc - to implement the cryptographic
features. It is necessary to install these extension of the Java runtime
environment to use unlimited cryptographic strengths. This is available
for most countries.
Hint: If you do not allow the installation routine to install this
component (i.e. you answer the question Install JCE Files with No), or
if you choose to use a JVM already existing on your system, you have
to install the JCE files belated.
If you try to transfer encrypted files and you did not install JCE, youll
get the following message: invalid key length.
For more information about JCE files read the $RVS_HOME/docu/
readme.txt file.
Subsequent please define the username and the password of the
default user with administrator rights as well as the IP address or
hostname (default: hostname of your machine) and the RMI port
(standard: 3755).
Hint: Due to the special role of the default user concerning the local
Client Server communication you cannot change his data in the User
22
Installation
Management.
23
The following three dialogs are related to Oracle database only. You
can ignore them if you decided for a Derby database yourself. Please
set your database connection parameters:
jdbc.url: has the following syntax:
jdbc:oracle:thin:@<server>:<port>/
<service_name>
server is the name or IP address of the machine where Oracle
server is installed.
Default port for Oracle is 1521.
service_name is Oracle service name.
jdbc.user is the user setting up on Oracle database
jdbc.password is his passwordNet Service Name: name of the
Oracle network service
For more information see chapter 12.2 "Oracle".
24
Installation
If you will not import the settings, the following dialog deals with the
settings of the local station. Please read the chapter 3.2 for more
information about setting station parameter (e.g. how to obtain the
ODETTE ID). The neighbour station will be configured after installation
via GUI. (Please read 3.2.3Setting up of a neighbour
station page 58)
In the next dialog you are given a brief overview of selections you
have made (installation directory, link directory). The required and the
currently available disk space is also indicated. Press the Install
button to start installation and to copy the installation files into the
directories you specified.
The last dialogs informs you of the successful installation of rvsEVO.
UNIX Systems
25
GUI
2.5
By using the GUI you need not much practise for working with rvsEVO.
The picture below indicates the GUI in the Send file window:
In the title bar the name of the program and the stationID of the local user
is shown. Thereunder you can find the menu bar and the function bar.
26
Installation
With a click on one of the symbols (Send file, Transfer, Stations, Admin,
Help and Exit) you can open the special menu item or terminate the GUI.
The middle part is composed in a navigation range and a work range.
At the bottom of the GUI the log messages were displayed. Thereunder
the status line is arranged and gives information of rvsEVO installation:
number of stations, user name, role of user, IP address / host name and
port of rvsEVO server, service name, version of rvsEVO and extended
version of rvsEVO.
The rvsEVO version can also be shown via the
$RVS_HOME\tools\rvsver.bat command tool.
2.6
Successful start:
Start
27
startGUI
-local
-console
-reset
-help
-?
Requestshelp information
28
Installation
2.8
-i
-r
-s
-h
usage
Example:
29
2.9
The system variable RVS_HOME is to be set for the logged on user (the
value of RVS_HOME is the installation directory of rvsEVO). Set
RVS_HOME by choosing Start -> Control Panel -> System ->
Advanced -> Environment Variables
Note: During the update installation a new $RVS_HOME/conf/rvssystem.properties.new file is added. Please take over the
configurations of your old rvs-system.properties file to the new one
and rename rvs-system.properties.new in rvssystem.properties.
Please read chapter 13 to learn how you can use the Central
Administration to update other rvsEVO installations.
For migration of settings from rvs portable you have to consider the
following requirements:
an executable rvs portable must be installed on your system
migration should only be started if the absence of communication has
been assured (no file reception/transmission and no encryption/
compression)
the system variable RVSENV is to be set for logged on user. Set
RVSENV by choosing Start -> Control Panel -> System ->
Advanced -> Environment Variables
The following steps need to be done for migration from rvs portable to
rvsEVO:
Install rvsEVO on the same machine where rvsXP / rvsX is installed
and follow below instructions:
30
Installation
If you are asked whether you wish to search through your system for
an existing rvs portable installation, press the Yes button.
If you are asked whether you wish to import the settings from rvs
portable, press the Yes button.
Only with encrypted transmission: import your own key pair with the
program importComSecureKeyPair (see below).
Only with encrypted transmission: import the public keys of your
partners (see chapter 6.6 "How to import and export ComSecure
public keys").
Create the users which were defined in rvs portable. They will not be
created automatically.
importComSecure
KeyPair
-s <sid>
31
Optional parameters:
-help
-?
Important: If the public key is not existent in format X.509 you have to
insert the additional information in the file
$RVS_HOME\tools\csi\certificate-properties.xml.
Sample file (certificate-properties.xml):
- <!-- common-name -->
<entry key="subject.cn">rvsEVO-comsecure-j</entry>
- <!-- organisastion-unit -->
<entry key="subject.ou">rvs</entry>
- <!-- organisastion -->
<entry key="subject.o">T-Systems International GmbH</
entry>
- <!-- locality -->
<entry key="subject.l">Berlin</entry>
- <!-- state -->
<entry key="subject.st">Berlin</entry>
- <!-- country-code -->
<entry key="subject.c">de</entry>
- <!-- email -->
<entry key="subject.email">rvs-support@t-systems.com</
entry>
$RVS_HOME\tools\portable2stationlist.bat
32
Installation
Beschreibung
Company
Components
Key
KeyBackup
see Key
Neighbours
Partners
ProxyStations
Routings
33
Components
Sessions
Users
number of users
Virtuals
34
Installation
In the next dialog, you can decide, whether you would also like to
delete the created or changed directories and files after the
installation. We do not recommend this, since you would thus delete
all the received files and archived file. The program has been
uninstalled.
In the following window, it is displayed, which components have not
been deleted. Click on <done> in order to end the uninstall program.
35
36
Configuration
3 Configuration
The present chapter describes how to customize rvsEVO via the GUI or
via the XML configuration files.
3.1
37
3.1.1
rvsEVO Environment
In the following table you will find the parameters, which refers to the
rvsEVO environment.
38
ELEMENT
DESCRIPTION
ARCDIR
BackupStartup
Browser
CentralJournalInstance
Cleanupdays
Cleanupinterval
Cleanuptime
Specify time in the format HHmmss for archiving of completed and failed jobs. The archiveJobs program will
save any jobs older than the time specified in this parameter to the RevisionLog.xml file (see chapter 4.11,
see also the PersistenceArchive parameter).
Note: You can set only one of cleanup parameters:
cleanupdays or cleanuptime.
Configuration
ELEMENT
DESCRIPTION
ConnSetupFailWaitTime
DB
Description
Free text
EngdatConfigFile
FirstLanguage
HelpFile
HostAllowFile
HostDenyFile
INBOX
LOGDIR
LooptestNeighbourSID
39
ELEMENT
DESCRIPTION
MailSMTPHost
Hostname or IP address of the mail server of the originator of warnings. (Please see also parameter Mail and
Send e-mail if certificate expires/expired in Chapter
3.1.4 "Resource Check")
ManagementCon- Name of the configuration file for the central administration (see chapter about the central administration in this
figFile
manual).
without function
MaxRevisionLogCount
MaxRevisionLogSize
MaxSessions
OUTBOX
PersistenceArchive
RedoLog
40
RMIServiceHost
RMIServiceName
Configuration
ELEMENT
DESCRIPTION
RMIServicePort
RvsStartScript
$RVS_HOME/bin/startServer.bat
or as Windows service:
$RVS_HOME/bin/startService.bat
SendJournalInter- Time interval in seconds between sending of two Journal
files to the rvs destination station (defined by the Cenval
SessionAliveTimeout
SessionWaitTime
Timestamp
41
ELEMENT
DESCRIPTION
TraceItem
3.1.2
Notification (SNMP)
In this table are the parameters, which refer to the feature rvs SNMP
Agent.
rvs SNMP Agent is an application that can respond to Network
management systems (NMS) queries and send rvsEVO status
information to NMS.
You can find the installer of rvs SNMP Agent in the $RVS_HOME/
SNMP_Agent directory. For more information about this feature, please
read the rvs SNMP Agent User Manual. After installation of rvs SNMP
Agent the manual is stored in C:\Programme\rvsSNMPAgent\doc
directory by default.
You must edit the following parameters in rvsEVO to be able to work with
rvs SNMP Agent:
42
ELEMENT
DESCRIPTION
Active
<AgentActive>
Configuration
ELEMENT
DESCRIPTION
IP address
<AgentHostname>
Port
<AgentPort>
3.1.3
Observer
43
station EVO5410D2
44
ELEMENT
DESCRIPTION
Directory
Mask
The regular expression, which should be applied. Example: MKL* means, that the observer checks for files
beginning with MKL. If it findes them, it will create a
send entry.
State
Time
Configuration
All other parameters from an Observer panel are for the sending a file.
These are: SID of Originator, SID of Destination, VDSN,
Output Format, Record Length, Record Mode, Code Table,
Serialization, Disposition, Label, Security feature
set, Compression, Encryption, Encryption algorithm,
File signature and Request signed EERP/NERP.
To which values these parameters can be set, please read in the chapter
4.5. The program createSendJob or GUI are using the same
parameters, when sending a file.
Note: You can also use the original filename as file description. This
function is controlled by the properties file $RVS_HOME/conf/rvssystem.properties with the definition
observer.sfiddesc.usefilename=true.
3.1.4
Resource Check
All active directories of rvsEVO will be checked (these are the directories,
which are configured in the file $RVS_HOME/conf/rvsConfig.xml
for the following variables: <DB>, <TEMP>, <INPUT>, <OUTPUT>,
<ARCDIR> and <LOGDIR>.
In case of the low disk space you can see in the Monitor Log a message,
that informs you in which rvsEVO directories is not enough disk space. At
the same time an E-mail to the responsible administrator can be sent.
There are three levels of resource lack:
first level: a warning will be dispayed.
second level: all receivers will be stopped, so that no file transfer will
be possible
third level: all processes and rvsEVO itself will be ended.
For all 3 levels a message in the log file will be issued and the
responsible administrator can be informed.
certificate check
45
ELEMENT
DESCRIPTION
DiskSpace
Number of kilobytes, that has to be free in every checking rvsEVO directory, before a warning in Monitor Log
will be issued. If the disk space is less than given in this
parameter also an e-mail can be sent to the address
defined in Mail parameter.
Default: 150 000.
Error certificate
expiration
RcvStopDiskSpace
Number of kilobytes, that has to be free in every checking rvsEVO directory, before a warning in Monitor Log
will be issued. If the number of free kilobytes is less than
a value of this parameter all rvsEVO receiver processes
will be stopped. No file transfer will be possible.
Default: 120 000
rvsEVO server
stop disk space
Number of kilobytes, that has to be free in every checking rvsEVO directory. With this parameter the critical
limit for the resource deficit should be configured. If the
number of free kilobytes is less than a value of this
parameter all rvsEVO processes and the rvsEVO server
will be stopped. You have a possibility to start a script
(see parameter System in this table).
Default: 100 000.
Send e-mail if cer- E-mail address for sending warnings if the certificate
tificate expires/ex- expiration is reached in less days than defined in
parameter Warning certificate expiration and error
pired
46
SuspendTime
System
Configuration
ELEMENT
DESCRIPTION
Time
<TEMP>C:\Programs\rvsEVO\temp</TEMP>
You are free to choose the names for the rvsJobstart and
rvsStationlist files; the only requirement is that they are specified
in the respective XML element, are valid XML files and are located in the
conf directory. The same also applies to HostAllowFile and
HostDenyFile. (Please see parameters of rvsEVO Environment).
47
Example:
<StationsConfigFile>stations.xml</StationsConfigFile>
48
Configuration
3.2
Station
Configuration
$RVS_HOME\conf\rvsStationlist.xml
station configuration file has been appropriately adapted. This
configuration is also visible in the GUI. In Chapter 3.2.3 "Setting up of a
neighbour station" (page 58) you can read how to set up a neighbour
station, in chapter 3.2.4 "Setting up a routed station" you can read how to
set up a routed station and in chapter 3.2.5 "Setting up a virtual station"
you can read how to set up a virtual station.
3.2.1
To open the station window, select the Stations icon in the function bar.
49
On the left side of the stations window you will see the station tree; to the
right is a station parameter table.
Alternative to the station tree the stations can be shown as a list. This
functionality is to configure in $RVS_HOME/conf/
rvsEvoClient.prefs file with hte following defintion:
<entry key="client.stationlist.stationtree.enabled"
value="false"/>.
The station tree/list depicts all of the stations which exist in rvsEVO (e.g.
your local station, the virtual stations, the neighbour station and the
routing station) as well as the connection type of the local station and the
neighbour station (TCP/IP, TLS, ISDN , XOT, Proxy TCP/IP and Proxy
TLS). With a click on the small button below the local station you can
show or hide the neighbour stations and the virtual stations. The small
button below a neighbour station blends or masks out the routing
stations.
The station table on the right-hand side of the window displays all of the
parameters for the station currently selected. With the aid of the various
station tabs (OFTP, TCP/IP, ISDN, XOT, Proxy TCP/IP and Proxy TLS)
you can configure various parameter groups.
Grayed fields indicate that these parameters cannot be edited.
The parameters which are obligatory for station configuration are marked
in the column Re.. (Required) with the symbol .
3.2.2
Normally the local station parameters are already set during the installation. In this chapter you will find the explanation of all for local station
possible parameters.
As mentioned above the configuration of the stations are possible via
GUI or via XML configuration files. Thus you will find in the parameter
table the name of the parameter from the XML file in <>.
The possible tabs for the local station configuration are: Local Station,
Key, OFTP (Odette parameters), and network tabs for TCP/IP, TLS,
ISDN, XOT, Proxy TCP/IP or Proxy TLS. A right click on the local station
opens a context menu with the possibility to add a new receiver: TCP/IP,
TLS, ISDN, XOT, Proxy TCP/IP or Proxy TLS. A TLS receiver is needed,
if you want to encrypt all data over the network connection.
50
Configuration
Local Station: the mandatory parameters in this tab is SID and the
network. The parameter SID is locally unique station ID which can
consist of up to sixteen characters. It is a strictly local definition;
remote stations do not have access to these names; they only know
the ODETTE IDs. The parameter network was assigned during
rvsEVO installation, while setting TCP/IP parameters. The rest
parameters are optional and are contact data.
OFTP (ODETTE Parameters): For the local station it is necessary only
to set the ODETTE ID. ODETTE ID is a worldwide unique identification of all nodes using the ODETTE file transfer protocol (OFTP). This
25 character name consists of
the letter O,
an 18 character organization identifier provided by the ODETTE
codification group, and
a 6 character computer sub address that is administrated by each
organization.
Note: If you communicate within your own closed network only, the
ODETTE ID may be freely chosen as long as it remains unique in your
network.
Key (key administration): Please look at chapter 6 "Encrypted
transmission with rvsEVO" for further information.
TCP/IP
In the next table you will find the description of the TCP/IP parameters:
TCP/IP parameters
Parameter
Description
enabled
<enabled>
IP Address
<IPAddress>
max. incoming
sesions
<Sessions>
Port
<Port>
51
Receiver Number
<ReceiverNumber>
restart timeout
<RestartTimeout>
timeout
<TimeOut>
Time Out in seconds after which the communication program the connection closes, if the partner
station does not answers.
TLS
The TLS parameters are necessary for the encrypted communication
with a partner. TLS (Transport Layer Security) is an encryption protokol
for data transmission in an internet. It provides an encryption during the
communication way, on the session level.
In the following table the most parameters are the same as for the TCP/IP
network; added are some parameters important for the encryption.
Please read the chapter 3.2.6 "How to configure a TLS receiver?" for
configuration of the TLS receiver (listener).
52
Configuration
TLS parameters
Parameter
Description
client authentication
Sometimes is for the TLS connection necessary, that a client (in this case a partner, from
<ClientAuthentication>
whom you receive data) should be authenticated. With this parameter you can choose, if
this is:
NONE (no authentication)
WANTED or
NEEDED
Note: The authentication should be done with
the X.509 certificates.
enabled
<enabled>
This parameter defines whether or not the TLS listener is enabled or disabled: Default: Y (Yes).
Possible values: Y (Yes) or N (No)
IP Address
<IPAddress>
$RVS_HOME/system/data/
tlsKeyManagerKeyStore.p12 Please
read the chapter 3.2.6 for more information, which
steps are needed.
Port
<Port>
Receiver Number
<ReceiverNumber>
restart timeout
<RestartTimeout>
timeout
<TimeOut>
53
system/data/
tlsTrustManagerKeyStore.p12.
Please read the chapter 3.2.6 for more
information, which steps are needed.
Parameter
Description
Card number <Device- Number of the ISDN card installed in the computer, beginning with "0"
ReceiverNumber>
54
enabled
<enabled>
ISDN
Address<Address>
ISDN Facilities
ISDN
Protocol<Protocol>
Configuration
ISDN Terminal
Identifier
ISDN Userdata
max.incoming
sessions
<sessions>
OrdinalNumber
<ReceiverNumber>
RCV timeout
<RestartTimeout>
timeout
<TimeOut>
Type <DeviceCardNumber>
X.25 Address
<X25Address>
X.25 DBit
55
X.25 Facilities
Special information or facilities for an X.25 transmission; see the information of the X.25 service
in use
X.25 PacketSize
<PacketSize>
X.25 Userdata
User data for an X.25 transmission; see the information of the X.25 service in use.
XOT
XOT (X.25 over TCP/IP) routers are able to route X.25 packets between
a TCP/IP network on one side and an X.25 or ISDN network on the other
side.
System requirements:
Please read the chapter 2.3 "Network Requirements" for XOT system
requirements. On demand a separat document with an example
description of a XOT router configuration can be sent.
The XOT parameters for a local station are described in the following
table.
XOT parameters
56
Parameter
Description
enabled
<enabled>
Local IP address
Local port
Configuration
max.incoming
sessions
<sessions>
OrdinalNumber
<ReceiverNumber>
RCV timeout
<RestartTimeout>
Router IP address
Router Port
timeout
<TimeOut>
X.25 Address
<X25Address>
X.25 DBit
X.25 Facilities
Special information or facilities for an X.25 transmission; see the information of the X.25 service
in use
X.25 Modulo
X.25 PacketSize
<PacketSize>
X.25 Userdata
User data for an X.25 transmission; see the information of the X.25 service in use
57
3.2.3
A right click on the local station opens a context menu with the possibility
to add a new neighbour station. You can choose one of the following
networks: TCP/IP, TLS, ISDN, XOT, Proxy TCP/IP or Proxy TLS. A TLS
receiver is needed, if you want to encrypt all data over the network
connection.
The possible tabs for the neighbour station are: Neigbour Station, Key,
OFTP (Odette parameters), Line Type and network tabs: TCP/IP, TLS,
ISDN, XOT, Proxy TCP/IP or Proxy TLS.
Neigbour Station: the mandatory parameters in this tab are SID and
the network. The parameter SID is locally unique station ID which can
consist of up to sixteen characters. A-Z, 0-9, -, _ and . are
possible characters. . may not rank first. SID is a strictly local definition; remote stations do not have access to these names; they only
know the ODETTE IDs. The network parameter was assigned during
adding a neigbour station. The rest parameters are optional and are
contact data.
Key (key administration): Please look at chapter 6 "Encrypted transmission with rvsEVO" for further information.
OFTP: In the following table you will find detailed explanation of
ODETTE group parameters.
OFTP parameters
58
Parameter
Description
Authentication
<Authentication>
Configuration
Certificate Validation
Type
<CertificateValidationType>
Compression
<Compression>
Exchange Buffer
Credit
<Credit>
=true in
$RVS_HOME\conf\rvssystem.properties
file to resolve this problem.
59
Encryption
<Encryption>
Encryption Algorithm
<EncryptionAlgorithm>
OFTP Version
<Level>
Odette ID
<OdetteID>
Receive Password
<PasswordReceive>
Send Password
<PasswordSend>
PKI
<PkiEnabled>
INTERNAL
EXTERNAL
Please see chapter 8 "File Service Module" for
detailed explanation.
60
Restart
<restart>
Configuration
Security
<SecuritySet>
Sign
<Sign>
Sign ERP
<SignERP>
SFIDDESC as Filename
<UseDescAsFilename>
VDSN charset
<VdsnCharset>
Line Type: the only parameter in this tab is Active connection setup.
It is occasionally necessary for files to be made only available and not
to be sent immediately. On the contrary, the partner station is to
establish the connection and fetch the available files as and when
required. The partner bears the costs for the connection. Active
connection establishment must be switched off for this case.
TCP/IP and TLS: For the partner station it is necessary to set the IP
address and the port.
61
ISDN
The ISDN parameters for a partner station are described in the following
table.
ISDN parameters
Parameter
Description
Card number
Number of the ISDN card installed in the computer, beginning with "0
ISDN Address
ISDN Facilities
ISDN Protocol
62
ISDN Terminal
Identifier
ISDN Userdata
ReceiverNumber
<ReceiverNumber>
timeout
<TimeOut>
Time Out in seconds after which the communication program the connection closes, if the
partner station does not answers.
Type
X.25 Address
<Address>
Configuration
X.25 DBit
X.25 Facilities
Special information or facilities for an X.25 transmission; see the information of the X.25 service in
use
X.25 PacketSize
<PacketSize>
X.25 Userdata
User data for an X.25 transmission; see the information of the X.25 service in use.
XOT
Please read the chapter 2.3 "Network Requirements" for XOT system
requirements. If desired, it is possible to receive a separate document for
the configuration of an ISDN router.
The XOT parameters for a partner station are described in the following
table.
63
XOT parameters
Parameter
Description
ReceiverNumber
<ReceiverNumber>
Router IP address
Router Port
timeout
<TimeOut>
Time Out in seconds after which the communication program the connection closes, if the partner
station does not answers.
X.25 Address
<>
X.25 DBit
X.25 Facilities
Special information or facilities for an X.25 transmission; see the information of the X.25 service in
use
X.25 Modulo
In X.25 data transmission exist two modulo operationg standards: Modulo 8 and Modulo 128.
Modulo 128 means, that you must select bigger
window size via parameter FACILITIES. The
standard window size for modulo 8 is 2.
X.25 PacketSize
<PacketSize>
X.25 Userdata
64
User data for an X.25 transmission; see the information of the X.25 service in use
Configuration
3.2.4
65
3.2.5
What are virtual
stations?
Virtual stations are used to represent stations outside the OFTP network
for the OFTP network. They allow files to be sent to destination stations
outside the OFTP network.
ODETTE-IDs uniquely define the stations in an OFTP network. Each
virtual station must also be assigned an own ODETTE ID. A virtual
station can also send and receive.
Click the local station with the right mouse button and choose Add
Virtual Station.
The possible tabs for this type of station are:
Virtual Station: the mandatory parameter in this tab is SID. The
parameter SID is a unique station ID which can consist of up to sixteen
characters. The other parameters are optional and are contact data.
OFTP (Odette parameters): the mandatory parameter in this tab is
Odette ID. Please refer to the section 3.2.2 "Configurating a local
station" for the explanation of the Odette ID. Please refer to the
section 11 "PKI Bindung" for the explanation of parameters PKI and
Certificate Validation Type.
Delete virtual
stations
A right-click on the routed station opens the context menu, which offers
then an option Delete station.
Hint: In the station configuration on the partner side the virtual stations
should be configurates as routed stations.
3.2.6
A right click on the local station opens a context menu with the possibility
to add a new TLS receiver (listener)
In this chapter we will describe how to configure an encrypted part of the
TLS connection. This applies to the two parameters in the receiver
configuration list: keystore file name and trusted certs
keystore file name. The other parameters are described in
chapter 3.2, table TLS for local station.
Hint: The encrypted part of the TLS connection cannot be configured via
Remote GUI.
Which steps are needed for the TLS communication?
The following steps need to be done before you start with the TLS
communication.
create an own key pair for the TLS communication
export an own public key in form of X.509 certificate
send you own public key to the partner with whom you should
communicate per TLS
66
Configuration
The partner has to import your X.509 certificate (public key) and send
to you his X.509 certificate.
You have to import the partners X.509 certificate into your
TrustManager key file.
now try to activate the partner station and when OK send a test file
Hint: Do not forget to activate (enable) your TLS receiver.
Creating an own key pair
When adding a TLS receiver (listener) to you local station the first step is
to create a key pair for the encrypted TLS communication.
To create a key pair click on the value of the parameter key store file
name. In this line you will find two symbols: ... and -->.
The symbol ... opens a dialog to select an other key store file and not the
default one. Default is: $RVS_HOME/system/data/
tlsKeyManagerKeyStore.p12. We recommend to use the default
one.
The symbol --> starts a program Portecle for the creation of a key pair.
The following steps are necessary:
Start Portecle with -->
To open the functionality Generate Key Pair, select the Tools icon in
the function bar.
In the window Generate Key Pair use as the Key Algorithm RSA and
as default key size 1024.
Press the button OK and the next window Generate Certificate
opens.
In the window Generate Certificate are the following fields to set:
67
The field Entry Alias is only for your internal use, to distinguish the
certificates. It should only not be left empty. You can fill it with Common
Name as proposed or with your Station ID.
After pressing OK a key pair should be created successfully.
Export of the own public key as a certificate
Click again on the value of key store file name and then on symbol
-->. Porticle user interface appears.
Click on your key pair and press the right mause button. The context
menu appears with the function Export.
The following windows appears:
68
Configuration
Use the default settings for the export: Export Type: Head
Certificate; Export Format: DER Encoded.
Confirm your settings with OK.
In the next window you should name your certificate and store it. We
recommed the file name with ending .cer or .crt. Hint: Make a
copy of your certificate on another computer.
Import of a partner X.509 certificate
Click on the value of trusted certs keystore file name and then on
symbol -->. Portecle user interface appears.
Select the Tools icon in the function bar and then the function Import
Trusted Certificate.
Select the certificate file in the next widow
The field Entry Alias is only for your internal use, to distinguish the
partners. It should only not be left empty. You can fill it with Common
Name as proposed or with the Station ID of the partner.
After you have done all steps mentioned at the beginning of this chapter
try to activate the partner station and send a test file.
Procedure with CA certificates
This chapter describes the procedure for working with CA certificates:
Generate CSR
69
Send the request to the TrustCenter (CA). With Odette CA you can
make your application online: https://www.odetteca.com.
Please see https://forum.odette.org/repository/
odette-ca-help.pdf for more information.
You receive your server certificate (your public key signed by CA), a CA
root- and a CA certificate if all entries of your certificate order are correct.
Import of own
certificates
70
Configuration
Import the CA Root certificate via function Tools -> Import Trusted
Certificate
Import the CA certificate via function Tools -> Import Trusted
Certificate
At last import the server certificate via function Import CA Reply.
Highlight your key pair and after a right click on your key pair the
context menu offers the option Import CA Reply.
Save and close your keystore.
At least you must send your CA certificates to your partner and import
whose certificates:
Import certificate of
partner
Open $RVS_HOME/system/data/tlsTrustManagerKeyStore.p12 keystore file via Portecle (trusted certs keystore file
Name and -->).
Import the CA Root certificate of your partner via function Tools ->
Import Trusted Certificate.
Import the CA certificate of your partner via function Tools -> Import
Trusted Certificate.
Save and close your keystore.
Hint: You must not import the server certificate. Server certificates are
exchanged during connection setup.
3.2.7
rvsStationlist.xml
On the other hand the station configuration can be done editing the XML
station configuration file $RVS_HOME/conf/rvsStationlist.xml
rvsStationlist.xml. The StationLoc element in the
configuration file is equivalent to the Local Station in the GUI,
StationNeighbour is Neighbour Station, StationRouted is the
Routed Station and StationVirtual is the virtual station in the GUI.
<?xml version="1.0" encoding="ISO-8859-1"?> <rvsStationConfig>
<StationLoc>
....
<Line>
<ReceiverNumber>1</ReceiverNumber>
<Sessions>3</Sessions>
<TcpBasic>
<IPAddress>localhost</IPAddress>
<Port>3305</Port>
</TcpBasic>
<TcpRec>
<Enabled>Yes</Enabled>
<RestartTimeOut>0</RestartTimeOut>
</TcpRec>
<Timeout>0</Timeout>
<Type>TCP</Type>
</Line>
<Line>
71
<ReceiverNumber>1</ReceiverNumber>
<Sessions>1</Sessions>
<TcpBasic>
<Port>3305</Port>
</TcpBasic>
<Timeout>0</Timeout>
<TlsRec>
<ClientAuthentication>NONE</ClientAuthentication>
<Enabled>No</Enabled>
<KeystoreFileName>tlsKeyManagerKeyStore.p12</KeystoreFileName>
<RestartTimeOut>0</RestartTimeOut>
<TrustManagerKeystoreFileName>tlsTrustManagerKeyStore.p12</
TrustManagerKeystoreFileName>
</TlsRec>
<Type>TLS</Type>
</Line>
<Pki>
<CertificateValidationType>NONE</CertificateValidationType>
<PkiEnabled>false</PkiEnabled>
</Pki>
<Protocol>
<Oftp>
<BufferSize>0</BufferSize>
<Credit>0</Credit>
<OdetteID>OLOCAL</OdetteID>
</Oftp>
<Type>OFTP</Type>
</Protocol>
<Sid>LOC</Sid>
</StationLoc>
<StationNeighbour>
<Fileservice>
<SecuritySet>NO</SecuritySet>
</Fileservice>
<Line>
<ReceiverNumber>1</ReceiverNumber>
<Sessions>1</Sessions>
<TcpBasic>
<IPAddress>139.1.34.76</IPAddress>
<Port>3678</Port>
</TcpBasic>
<Timeout>0</Timeout>
<Type>TCP</Type>
</Line>
....
<Protocol>
<Oftp>
<ActiveConnSetup>Yes</ActiveConnSetup>
<BufferSize>0</BufferSize>
<Compression>ODETTE</Compression>
<Credit>0</Credit>
<EerpIn>NORMAL</EerpIn>
<EerpOut>NORMAL</EerpOut>
<Level>2.0</Level>
<OdetteID>OFDST 001398XDSC</OdetteID>
<PasswordReceive>111111</PasswordReceive>
<PasswordSend>111111</PasswordSend>
<VdsnCharset>ODETTE</VdsnCharset>
</Oftp>
<Type>OFTP</Type>
</Protocol>
<Sid>RVS</Sid>
</StationNeighbour>
<StationRouted>
<Gateway>RVS</Gateway>
72
Configuration
<Pki>
<CertificateValidationType>NONE</CertificateValidationType>
<PkiEnabled>false</PkiEnabled>
</Pki>
<Protocol>
<Oftp>
<BufferSize>0</BufferSize>
<Credit>0</Credit>
<EerpIn>NORMAL</EerpIn>
<EerpOut>NORMAL</EerpOut>
<OdetteID>OPOSTKLJG654NKA</OdetteID>
<VdsnCharset>ODETTE</VdsnCharset>
</Oftp>
<Type>OFTP</Type>
</Protocol>
<Sid>STATIONNAME</Sid>
</StationRouted>
<StationVirtual>
<Contact/>
<Pki>
<CertificateValidationType>NONE</CertificateValidationType>
<PkiEnabled>false</PkiEnabled>
</Pki>
<Protocol>
<Oftp>
<ActiveConnSetup>Yes</ActiveConnSetup>
<Authentication>false</Authentication>
<BufferSize>10000</BufferSize>
<Compression>ODETTE</Compression>
<Credit>999</Credit>
<EerpIn>NORMAL</EerpIn>
<EerpOut>NORMAL</EerpOut>
<Level>2.0</Level>
<OdetteID>OEVOE</OdetteID>
<Restart>true</Restart>
<UseDescAsFilename>false</UseDescAsFilename>
<VdsnCharset>ODETTE</VdsnCharset>
</Oftp>
<Type>OFTP</Type>
</Protocol>
<Sid>EVOV</Sid>
</StationVirtual>
</rvsStationConfig>
Lines starting with (<!--) and ending with (-->) are interpreted as
comments.
Edit this file if you have to change mandatory parameters (ODETTE ID,
TCPIP_Basic) or if you wish to assign values to other optional
parameters such as Contact.
Use a text editor (e.g. Edit, TextPad) to do so. Please make sure to
save your XML files as valid XML documents after editing as rvsEVO
otherwise will not be able to read them and may fail to start correctly.
The changes in the GUI will be visible immediately (afer saving) in the
XML station configuration file; the changes in the XML station
configuration file will be visible in the GUI only after a new start of the
rvsEVO (command startGUI).
73
Note: For correct TCP/IP communication you must ensure that the IP
ports for RMI (1099) and for Odette (e.g. 3305) are free.
For the description of the parameters in the rvsStationlist.xml
file please refer to the description of the GUI parameters.
updateStationList
74
Configuration
3.3
If more than one jobFilter applies to the send job, receive job or failed job,
the job is started whose jobFilter applies most exactly (eg while using
wildcards: testdoc* is more exactly than testd*).
It is possible to customize JobStarts via the GUI or via the JobStart
configuration file.
Hint: Within rvsEVO installation already configurated jobstarts are saved
in $RVS_HOME\bin\jobstart directory. The description of the
Jobstart scripts can be found at the end of this chapter.
3.3.1
At first you should open the Administration window selecting the Admin
icon in the function bar. Then select the item Jobstart in the
Administration tree on the left hand side. How to start GUI read please in
the chapter 2.6.
It is possible to choose between Jobstarts in receive direction, Jobstarts
in send direction and Jobstarts after failure. A Jobstart in receive direction
is equivalent to a resident receive entry in rvs. A Jobstart in send
direction is equivalent to a Jobstart after send attempt in rvs. From
version 5.3 onwards it is possible to choose Jobstarts after processing
error.
A new Jobstart will be created with a right-click on a Jobstart after
receive, a Jobstart after send attempt or a Jobstart after fail in the
Administration tree (Add new entry). To select the already existing
Jobstart, double-click the appropriate line of the appropriate JobStart in
the right-hand window.
The following JobFilters entries are possible:
all JobStarts: Comment, Enabled, Sid of Originator, Sid of Destination,
VDSN, Process, Parameter Handling, Shell, Synchronized and
Timeout (Sync.)
JobStart after receive: New Filename, New Directory, Replace,
Timestamp, Timestamp Format, Conversion table and Recordhandling
JobStart after send attempts: Send Attempts
Please refer to the table of the JobFilters for a detailed description.
75
Examples (GUI)
76
Configuration
77
78
Configuration
3.3.2
Like most of the other rvsEVO configuration files this file is in the XML
format as well.
<jobstarterData>
<jobfilters>
<jobfilter>
<vdsn></vdsn>
<direction>SND</direction>
<sidOrig>LOC</sidOrig>
<sidDest>RVS</sidDest>
<sendAttempts>0</sendAttempts>
<process>C:\jobstart.bat</process>
<processingClass/>
<enabled>true<enabled>
<conversionTable>ANSI-IBM037</conversionTable>
</jobfilter>
<jobfilter>
...
</jobfilter>
...
</jobfilters>
</jobstarterData>
jobFilter elements
This file comprises any number of jobFilter elements. The table below
gives a detailed description of individual jobFilter sub elements.
jJobFilter elements
Parameter
Description
Comment
free text
79
Conversion table
80
Direction
Enabled
New Filename
New Directory
Parameter Handling
Configuration
Process
Process (Server)
Record Handling
Replace
With replace you decide how to handle receiving files which own the same name like existing files.
Possible values:
true (Yes): replace the existing file
false (No): create new data set with unique
name; timestamp is added (default)
Send Attempts
Shell
SID of Destination
SID of Originator
81
Parameter handling
Synchronized
Timeout (Sync.)
Timestamp
Timestamp Format
VDSN
82
Configuration
83
84
Configuration
ASCII: US-ASCII ISO 646; the ASCII character set defines 128
characters (0 to 127 decimal). This character set is a subset of many
other character sets with 256 characters, including the ANSI character
set of MS Windows.
ANSI: Windows ANSI, Values 0 to 127 are the same as in the ASCII
character set, values 128 to 255 are similar to the ISO Latin-1
character set.
EBCDIC 037: support characters, which are used in the following
countries: Australien, Brasilien, Kanada, Neuseeland, Portugal,
Sdafrika, USA.
EBCDIC 273: supports characters (especially umlauts), which are
used in the following countries: Germany, Austria and Switzerland.
Note: char value is equivalent to the source code and the value in
<> is equivalent to the target code.
store the XML file in the directory
$RVS_HOME\conf\conversiontables
to add your table to the list of conversion tables, edit the XML file
$RVS_HOME\conf\conversiontables\
characterSetConverters.xml.
Next you find an abridged version of the file
characterSetConverters.xml:
<characterSetConverters coding="">
<!-- -->
<converter cid="ANSI-IBM037">conversion_ANSI_IBM037.xml</converter>
<converter cid="IBM273-ASCII">conversion_IBM273_ASCII.xml</
converter>
.
.
</characterSetConverters>
In the example above cid="ANSI-IBM037" (cid="IBM273ASCII") is the used name in rvsEVO and
85
conversion_ANSI_IBM037.xml
(conversion_IBM273_ASCII.xml) is the name of your XML file.
Please restart rvsEVO after your complement.
Scripts for Jobstarts:
The $RVS_HOME\bin\jobstart directory contains jobstart tools as
batch files, delivered by rvsEVO. You have the possibillity to conform the
files to your requirements or to generate new batch files.
delaftersend.bat
This tool deletes a file after successful send attempt.
handleMangement.bat
This Tool refers to Central Administartion. For further information please
read chapter 13 "rvsEVO Central Administration".
jobstart.bat and jobstart_detailed.bat
This tools write information about the sended file and transmission in
$RVS_HOME\log\jobstart.out file. With jobstart_detailed
the dump in jobstart.out is formatted, with jobstart the dump is
unformattted.
journal.bat
This script starts the sendJournal tool. sendJournal creates a
journal and sends this to CentralJoural.
Bentigter Parameter:
-f <filename>
86
Configuration
Example: Program 1 (P1) shall be started after one send attempt and
program 2 (P2) shall be started after three send attempts, then:
1. send attempt -> P1
2. send attempt -> P1
3. send attempt -> P2
4. send attempt -> P1
5. send attempt -> P1
6. send attempt -> P2
Delete a Jobstart
If you want to delete a JobStart, select it at first with a double-click. Now
you can remove it with the Delete button.
Jobstart Processes
Jobstart scripts
87
Required parameters:
-f <filename>
88
4
Batch files
The present chapter describes all programs available for everyday use of
rvsEVO. These programs are located as batch files in the
$RVS_HOME\bin directory or available via the rvsEVO GUI.
Note: To launch an rvsEVO program you must change to the
$RVS_HOME\bin directory.
4.1
startServer
startServer
It is not possible to specify any parameters.
A successful start is indicated as follows:
*
* rvs Server has started.
*
Note: The RMI port 1099 is necessary for the RMI registry, so if this port
is occupied, rvsEVO Server will not start successfully.
4.2
stopServer
89
.
Parameter
Description
-m <mode>
-help
-?
Example:
stopServer
Result: The server stops after 120 seconds.
Example:
stopServer -m 3
Result: The server stops after 20 seconds.
*
* rvs Server has stopped.
*
4.3
Displaying messages
rvsEVO messages and warnings are saved in the log files in directory
$RVS_HOME\log.
The monitor.log file contains the Monitor messages, the rvs.log
file contains the messages from rvsEVO Server and the
rvsClient.log file the messages from the command prompt and the
rvsEVO clients.
4.3.1
Log Messages are normally displayed in the bottom of the GUI window.
You can view old Monitor messages via the GUI or via the program
showMonitorLog.
90
monitor.log
GUI
Log messages
After a new start of the GUI the last 25 log messages are shown. Set the
parameter rvs_evo.monlog.initial_buffer_size in the file
$RVS_HOME/conf/rvs-system.properties to change this setting.
Delete # at the beginning of the line, because otherwise the modification
will be ignored. In the following example the last 50 log messages are
shown after a new GUI start.
Example:
rvs_evo.monlog.initial_buffer_size=50
You can configure the display of the Monitor messages. This function is
controlled by the properties file
$RVS_HOME/conf/rvs-system.properties with the following
definition: rvs_evo.monitorlog.client_layout.
Example:
rvs_evo.monitorlog.client_layout=%1$-11s * %3$-4s *
%4$-36s * %8$-s
Explanation of the example:
In the first term (%1$-11s * )1$ is the parameter, - means leftaligned (default is right-aligned), 11 is the column width and * is the
seperator. The last parameter has no column width. Each term begins
with % and ends with s.
The following table shows the possible parameters.
Parameter
Beschreibung
1$ (time)
91
2$ (level)
3$ (module)
4$ (messageKey)
Message key
5$ (sessionID)
ID of OFTP session
6$ (stationID)
7$ (jobID)
rvsEVO JobID
8$ (localized
message)
History messages
You can also view old Monitor messages. Select the Admin icon in the
function bar of rvsEVO GUI. The Administration window opens with the
Admin tree and the sub-entry Log History Messages. How to start of
rvsEVO GUI please read the chapter 2.6.
Choose a log file in the selectbox on the right hand side of the window
and press the button Load log file for viewing the history messages.
92
showMonitorLog
Command Line
Use the showMonitorLog program to trace the current Monitor
messages and to analyze error messages.
Usage:
showMonitorLog [-verbose]
Optional parameters:
-verbose
-help
-?
-sp <password>
-sh <host:port>
93
showMonitorLogFile
Optional parameters:
-?
-help
-i
4.3.2
The warnings and error messages of the command prompt and the
rvsEVO clients are saved in $RVS_HOME\log\rvsClient.log.
The maximum file size and maximum number of log files can be defined
in the element appender name="Standard" in the
$RVS_HOME\conf\rvsClientLogger.xml file.:
Maximum size: use the function maxFileSize
Syntax: <param name="maxFileSize" value="2097152"/>
Maximum number of log files: use the function maxBackupIndex
Syntax: <param name="maxBackupIndex" value="10"/>
94
4.4
activate
Station
Activating a station
-help
-?
-sp <password>
-sh <host:port>
4.5
Sending a file
It is possible to send a file via the GUI or via the command line. How to
start GUI, please read the chapter 2.6.
GUI
Select the icon Transfer in the function bar and thereafter the sub-entry
Create New Transmission in the Transfer tree. An other way to open the
Create New Transmission window is to select the Send file icon in the
function bar.
In the Create New Transmission window you can type or select the
send parameters and launch the sendjob with a click on the Send button.
95
Use the Store as Default button to save the settings and the Default
values button to access the saved settings if required. By pressing the
Reset button you can reset the settings to system default.
Send parameters
Required parameters:
SID Destination
File
VDSN
96
Conversion table
Disposition
File description
File signature
Format
97
Label
MaxRecl
NoCopy
Offline Compression
98
1 / None: no encryption
2 / ComSecure (V1)
3 / ComSecure (V2)
4 / OFTP 2.0 (CMS)
99
Serialization
SID Originator
Command Line
createSendJob
-s <receiver sid>
-v <vdsn>
100
ODETTE compression
-D <disposition>
-desc <description>
-F <format>
-help
-idf <filename2>
-j <start job>
without function
-l <label>
-M <length>
-nocp
101
-rsr
-S <serialize>
-sfs <set-id>
-Sh
-sif
-sifcsn <serial number> certificate serial number for file signature (only
for sfs 4)
102
station ID of originator
-t <conversion table>
-verbose
-Y <encryption>
-Yalg <encryption
algorithm>
-su <user>
-sp <password>
-sh <host:port>
Examples:
103
Examples:
4.5.1
104
Note: Please see chapter 15.1 "ODETTE Protocol" for ODETTE protocol
sequences (such as EFNA, SFID, EFID, EERP, ...).
105
4.6
-s <receiver sid>
-v <vdsn>
106
-F <format>
-idf <filename2>
-l <label>
-M <length>
-S <serialize>
107
-Sh
station ID of originator
-t <conversion table>
-verbose
-za <attempts>
-zt <timeout>
108
-cf
-cf2
-ct
-cd
-cd2
-cl
-cs
-cI
-ce
-sp <password>
-sh <host:port>
Examples:
convertAndSend
-d C:\INTEGRATION\test.txt -s RVS -v TEST
-cf C:\rvsET\system\fmtDesc\fw.kanban.ineas.xml
-ct C:\rvsET\system\stylesheets\ineas2deljit.xslt
-cf2 C:\rvsET\system\fmtDesc\edifact.97.orig.xml
In this example the C:\INTEGRATION\test.txt file is sent to the
station RVS with a virtual name TEST. The test.txt file was also
converted with the EDI converter WEDIConv (installed in the directory
C:\rvsET\); first from the inhouse format test.txt to the XML
format (fw.kanban.ineas.xml) and then to the EDIFACT message
(edifact.97.orig.xml). In the first step was used a stylesheet
ineas2deljit.xslt for the special presentation.
Note: If you use convertAndSend to send files, you must pay
attention to the fact, that with this feature a new send job after an occured
error can cause a double transmission (e.g. if the file is already
transmitted, but the in the -zt parameter defined time out period passed
without receiving the EERP. The transmission can be still active
independent from the own local station. In this case, the new sending of
the file can cause double transmission. The application above rvs must
109
be able to handle this particular situation. A possible solution is: the file
name must be unique or it must get a unique counter (a counter stamp)).
110
4.7
Active Panel
This tool gives you the additional details of the status of an active
transfer.
In the GUI, you reach the active panel using the symbol transfer.
The following information is available in the active panel:
Filter
End session
Parameter
Description
- Neighbour
- State
- Command
- Originator
- Destination
- Direction
Sending
Receiving
- File Name
- Progress
- Line Speed
- Start File
- SessionID
- Start Session
- Line Type
network type
Using the button filter in the area of the window below, it is possible to
restrict the display of the transfer status to particular networks.
In order to cancel the current transfer, mark the corresponding session
and press the button Terminate Session.
111
4.8
The most important information about the send and receive jobs can be
shown via the GUI or via the command line. How to start rvsEVO, please
read the chapter 2.6.
GUI
Select the icon Transfer in the function bar. The Transfer window opens
with the sub-entry Transmissions in the Transfer tree. Now you can
select between the Active Receive/Send Transmissions, Ended
Transmission and Failed Transmissions.
112
113
Release NERP
Delete EERP
Show
With a click on the Show button the content of the received file is shown.
Back
A click on the button Back shows you again the overview of Active
Receive Transmissions.
Hint: Operations can also be activated by a right click on a particular job
line. A context menu opens and the following functions can be choosen:
Release EERP, Delete EERP, Release NERP Restart SP or Delete
forced (allows to delete a current transfer. The originator gets the
information that the job was cancled and the file is transmitted again with
a new jobID but the same timestamp).
Active Send Transmissions: If you click on the line Active Send
Transmissions and then double-click on a particular job line, you will see
all details about the particular send job in transmission. The buttons on
the right-hand side of the window allow several activities:
Hold
Release
Delete
Back
Use the button marked Hold to pause the active job. The same
functionality is available by the program holdJob.
The button Release releases a job in status HOLD. The same
functionality is available by the program releaseJob.
The button Delete deletes a job. If the job is active, you must pause it
first. The same functionality is available by the program deleteJob.
A click on the button Back shows you again the overview of Active Send
Transmissions.
Hint: Operations can also be activated by a right click on a particular job
line. A context menu opens and the following functions can be choosen:
Hold Transmission, Release Transmission, Delete Transmission, Restart
SP or Delete forced (allows to delete an active job without pausing it
before).
The following information is for encrypted transmission only:
Jobs which can not be decrypted or encrypted by the Service Provider
were changed to the SP_FAILED status. Use the button Error to display
the error number and the description. After bug fixing you can activate the
job with a click on button Restart SP.
114
Optional parameters:
-help
prints help
-verbose
-?
deleteJob
-su <user>
-sp <password>
-sh <host:port>
115
Optional parameters:
-f
-help
prints help
-verbose
-?
releaseJob
-f
forced
-su <user>
-sp <password>
-sh <host:port>
Optional parameters:
-help
prints help
-verbose
-?
restartJob
-su <user>
-sp <password>
-sh <host:port>
116
Optional parameters:
-help
prints help
-verbose
-?
getJobList
-su <user>
-sp <password>
-sh <host:port>
getJobList [-a][-e][-f][-verbose]
Optional parameters:
-a
-ac S
-e
-f
-h
-verbose
-?
-sp <password>
117
-sh <host:port>
If you call getJobList without parameter the display contains a list of all
jobs currently being processed.
Example:
getJobList -e
Result:
getJobList -a
Result:
getJob
Optional parameters:
118
-a
-help
-verbose
-?
-sp <password>
-sh <host:port>
Example:
getJob -n 040329173456000
Result: job 040329173456000 (RCV): state: ENDED
4.9
handleEERP
-d <num>
-n <num>
-r <num>
Optional parameters:
-help
-verbose
-?
-sp <password>
-sh <host:port>
119
Optional parameters:
-f <filename>
filename
-sp <password>
-sh <host:port>
120
conversionTable
creationDate
deleteAllowed
direction
dispositiion
encryption
encryptionAlgorithm
encryptionCertificateIssuerName
encryptionCertificateSerialNumber
errorID
errorText
errorType
externalJobId
fileDescription
121
122
filename
filenameSrc
filePos
holdAllowed
jobNumber
rvsEVO-JobID
lable
lastByteRead
Value of the last read byte of a file to be sent in decimal representation as a character string. Standard: -1.
lastByteSend
Value of the last sent byte of a file to be sent, in decimal representation, as a character string. Standard: -1
lastStateChange
Time of the last change in the job status in the format DD.MM.YY HH:MM:SS.
lengthOriginFile
oidDest
oidNeighbor
oidOrig
recCount
recordFormat
Format of the file to be transferred: T (Text): a consequence of ASCII-characters, F (Fixed): fixed record length, V (variable): variable record length, U
(unstructured): binary file.
recordLength
releaseAllowed
restartPos
scheduleDateTime
securityFeatureSet
sendAttemps
serialisation
This option means that your files are there in a serial order. All the files which should be sent in the
same group, should have the same ID (Label).
Possible values: true(yes) or false(no). Standard
value: false
SFIDTIME Counter
SID
sidDestination
sidOriginator
sign
signCertificateIssuerName
signCertificateSerialNumber
signEERP
status
timeStartFile
transferFileLength
123
transmittedBytes
user
VDSN
virtualSID
waitTime
Time in milliseconds, for a new start of transfer, af(TransmissionFailWaitTi- ter a failure (TransmissionFailWaitTime). Should
me)
be set in case of an SFNA(Start File Negative
Answer) or EFNA (End File Negative Answer)..
Example:
<JobInfoList>
<JobExtendedDetails>
<JobDetails>
<externalJobId>5006</externalJobId>
<JobID>
<direction>0</direction>
<jobNumber>091222132218000</jobNumber>
</JobID>
<compression>false</compression>
<conversionTable></conversionTable>
<creationDate>22.12.09 13:22:18</creationDate>
<deleteAllowed>false</deleteAllowed>
<disposition>K</disposition>
<direction>SND</direction>
<encryption>false</encryption>
<encryptionCertificateSerialNumber></encryptionCertificateSerialNumber>
<encryptionCertificateIssuerName></encryptionCertificateIssuerName>
<fileDescription></fileDescription>
<filename>C:/rvsEVO/files/outbox\rvsenv.dat.091222132218000</filename>
<filenameSrc>C:\rvs\rvsenv.dat</filenameSrc>
<filePos>789</filePos>
<holdAllowed>false</holdAllowed>
<lastStateChange>22.12.09 13:22:20</lastStateChange>
<lastByteRead>-1</lastByteRead>
<lastByteSend>-1</lastByteSend>
<lengthOriginFile>789</lengthOriginFile>
<oidDest>OXP</oidDest>
<oidNeighbor>OXP</oidNeighbor>
<oidOrig>OGEDASEVO</oidOrig>
<recordFormat>U</recordFormat>
<recordLength>0</recordLength>
124
<recCount>0</recCount>
<releaseAllowed>false</releaseAllowed>
<restartPos>0</restartPos>
<scheduleDateTime></scheduleDateTime>
<sendAttemps>0</sendAttemps>
<serialisation>false</serialisation>
<SID>XP</SID>
<sidOriginator>LOC</sidOriginator>
<sidDestination>XP</sidDestination>
<signCertificateSerialNumber></signCertificateSerialNumber>
<signCertificateIssuerName></signCertificateIssuerName>
<status>ENDED</status>
<timeStartFile>1261484539412</timeStartFile>
<transmittedBytes>789</transmittedBytes>
<transferFileLength>789</transferFileLength>
<user></user>
<VDSN>WEIH6644</VDSN>
<virtualSID></virtualSID>
<waitTime>0</waitTime>
<jobSecurityAndSign>
<securityFeatureSet>1</securityFeatureSet>
<encryptionAlgorithm></encryptionAlgorithm>
<sign>false</sign>
<signEERP>false</signEERP>
</jobSecurityAndSign>
</JobDetails>
125
As an alternative you can also start this function by launching the script
archiveJobs at the command prompt.
Usage:
Optional parameters:
-r
-help
-verbose
-?
126
Syntax:
deliverCertificate -s <stationID>
[-i <keyIndex>]-r <stationID>
[-su <user> -sp <password> -sh <host:port>][-help]
[-?] [-verbose|-v]
Reqired parameters:
-r <stationID>
-s <stationID>
Optional parameters:
-i <keyIndex>
-verbose
-?
-sp <password>
-sh <host:port>
127
Optional parameters:
-help
-verbose
-?
-sp <password>
-sh <host:port>
StationID of the individual station, whose certificate should be sent and replaced.
-r <stationID>
StationID of the partner-station, to which the separate certificate (certificates) are sent. The old
(belonging to the individual station in case of the
partner) certificate (certificates) are replaced and
are cancelled.
Optional parameters:
128
-i <keyIndex>
-help
-verbose
-?
-sp <password>
-sh <host:port>
Optional parameters:
-help
-?
-?
129
Optional parameters:
-i <keyIndex>
-help
-verbose
-?
Hint: Set your Proxy alignments in $RVS_HOME/conf/rvssystem.properties file with the following definitions:
http.proxyHost: IP address or hostname of Proxy-Server
http.proxyPort: Port of Proxy-Server
http.nonProxyHosts: Hosts which should be connected directly
and not through the proxy server
http.proxyUser: Username
http.proxyPassword: Password of user
4.18 Import a TSL
With this tool, a TSL (Trust Service Status List) can be imported into the
keystore file (keystore).
Syntax:
importTSL -f <TSL filename> -k <keystore filename>
[-help] [-?] [-verbose|-v]
130
Reqired parameters:
-f <TSL Filename>
-k <keystore filename>
Optional parameters:
-help
-verbose
-?
Optional parameters:
-help
-verbose
-?
-f <filename>
131
Optional parameters:
-help
-?
-verbose (-v)
-sp <password>
-sh <host:port>
The possible values are described in Conversion table parameter in the table jJobFilter elements on page 79.
-s <filename>
-d <filename>
Optional parameter:
-?
132
rvsEVO lets you back up all relevant data and recover them if necessary.
This is particularly important when an error has occurred in rvsEVO and
the user wishes to revert to the old status prior to the error.
5.1
Backup
As an alternative you can also start this function by launching the script
createBackup at the command prompt.
Syntax:
133
-verbose
-help
-?
5.1.1
5.1.2
Redo Log
134
5.2
-r
135
-verbose
-help
-?
136
Introduction: basics
Electronic signature
6.2
System requirements
Hint: In rvsEVO 5.0 the following steps for installing JPS are done by the
installation procedure (see the chapter 2).
Please note the following system requirements if using offline encryption
and compression:
Using Unlimited Strength Jurisdiction Policy Files:
--------------------------------------------------------------------------------------------rvsEVO uses the JCE (Java Cryptography Extension) of Sun Microsystems, Inc to implement the cryptographic features. Due to import control
137
http://www-128.ibm.com/developerworks/java/jdk/
security/50/
6.3
He provides the public key to each partner he expects files from. This
allows the data to be exactly encrypted for the partner who sent this
public key. You can safely distribute the public key since this key alone is
not sufficient for decryption.
Each participant keeps his private key and stores it safely.
Three keys are required for decryption (the own key pair and the
partners public key). It will no longer be possible to decrypt files sent by
the partner if one of the three necessary keys is lost.
For the key management you should open the GUI and choose the tab
Key on the right side of the stations window.
The following window appears:
138
The following functions are available (symbols for some of them are
visible as icons on the bottom of the key management window; and
others are available with the context menu):
Get Key and Certificate List
Generate Key Pair
Import Certificate
Export Certificate (not available via Remote GUI)
Export Certificate to ComSecure (not available via Remote GUI)
Import ComSecure Public Key (not available via Remote GUI)
Create a new Keystore
Delete key
Create Certification Request
In the next chapters we will describe the functions of the key management for the file encryption.
The following steps are necessary to perform, if you want to send
encrypted files with rvsEVO:
create an own key pair for encryption of files
export an own public key in form of X.509 certificate
send your own public key to the partner with whom you should
exchange encrypted files (by E-Mail or rvsEVO)
139
The partner has to import your X.509 certificate (public key) and send
to you his X.509 certificate.
You have to import the partners X.509 certificate into your
TrustManager key file.
now try to activate the partner station and when OK send a test file
with option Encryption Y.
How to send a file, please read in chapter 4.5 "Sending a file"
6.4
140
Certificate
UsageDefinition
If you hold several own key pairs, please edit xml file $RVS_HOME/
conf/CertificateUsageDefinition for assigning activities to the
private keys . The following activities can be choosen:
F-ERP-SIGN => EERP/NERP signature (OFTP2)
F-SIGN => file signature (OFTP2)
F-COMSECURE-SIGN => file signature (ComSecure)
1st example:
Key with serial number 4D623B3B is to be used for file signature
(OFTP2) by locale station LOCALSTATION.
<entry key="LOCALSTATION.F-SIGN.SERIALNUMBER">4D623B3B</
entry>
2nd example:
Key with serial number 4D623B3B is to be used for EERP/NERP
signature by virtual station VIRTUALSTATION.
<entry key="VIRTUALTATION.F-ERP-SIGN.SERIALNUMBER">4D623B3B</entry>
6.5
rvsEVO enables to import trusted certifcates from partners into the key
management and to export already imported certificates from the key
management into a file.
To import an X.509 cetificate into a key management, press on the
Import Certificate botton:
In the next dialog Import Trusted Certificate you can select a file, which
should be imported. Normally the certificate file has an ending .cer.
After the acknowledgement with OK the certificate will be visible with the
following symbol in the key management.
In the another direction it is also possible to export an certificate from the
key management into a file. A right click on the marked line with the certificate symbol
141
6.6
6.7
142
Send the request to the TrustCenter (CA). With Odette CA you can
make your application online: https://www.odetteca.com.
Please see https://forum.odette.org/repository/
odette-ca-help.pdf for more information.
You receive your server certificate (your public key signed by CA), a CA
root- and a CA certificate if all entries of your certificate order are correct.
Import of own
certificates
143
Files, encrypted with ComSecure can be received decryted and decompressed or encrypted and compressed.
This function is controlled by the properties file
$RVS_HOME/conf/rvs-system.properties with the following definition:
144
rvs_evo.serviceprovider.receive_job.process_comsecure=false
false = off (no decryption/no decompression)
true = default / on (decryption / decpmpression)
After receipt not decrypted / decompressed files are stored in the
directory $RVS_HOME/files/inbox.
6.9
A right klick on the key or cetrificate line opens a a context menu with the
function Delete a Key Entry. This function deletes a key pair and a
appropriate certificate from the key management.
145
146
Basics
The rvs OFTP Proxy is run with two instances: bastion instance and
connection instance, which is integrated in rvsEVO. Following figure
should illustrate these facts:
147
The connections are received from the external network using bastion
instance. These external connections are forwarded to rvsEVO.
The other way round rvsEVO uses the bastion instance for establishing a
connection to the OFTP station in the external network.
Communication between rvsEVO and bastion instance is executed exclusively through the connections built by rvsEVO. Communication is restricted to one port, the configurable RMI-port of the bastion instance.
Proxy Listener
For beeing accessible for the external stations one or more Proxy listener
are launched by rvsEVO. rvsEVO uses this Proxy listener to establish a
connection to the partner station.
Altogether, all functional configurations, keys and certificates required for
TLS communication are stored exclusively in rvsEVO.
The Bastion Instance is installed with the program rvs OFTP Proxy. You
can download rvs OFTP Proxy using the following website:
https://servicenet.t-systems.de/tsi/de/267072/Startseite/Business-Integration/rvs
148
7.3
Configure Proxy
Listener
Parameter
Description
Instance
Command
Server
Service
Port
Port of the Bastion Instance for the RMI-communication, on which a listener is started.
keep connektion
Hint: You can configure a time interval for sending heartbeats to prevent
the interrupt of connection if there is no transmission. This functionality is
to be set up in parameter listener.controller-thread.sleeptime and listener.controller-thread.keep-alive-counter
in $RVSPROXY_HOME\conf\RemoteListenerProperties.properties file of rvs OFTP Proxy program.
149
150
8.1
Basics
The File Service Proxy works as a OFTP router and de- and encrypted
files for internal stations substitutional before he forwards them.
The following image shows the File Service Module architecture.
151
152
153
154
Remote GUI
Remote GUI
9.1
You can start rvsEVO with the help of the rvsEVO-program group:
Start -> All programs -> rvsEVO -> rvs GUI.
Alternatively, this function can be started in the command line, with the
script $RVS_HOME\bin\rvsGUI -r -u <user> -p <password>.
The following window is opened and one can log in to the server:
Required specifications:
rvs account: Login to rvsEVO (to the server) with the user set up in
the user management (user ID)
rvs password: Password of the user
middleware server: Name or IP-address of the remote computer
and port, to which the computer adheres to. The following syntax is to
155
9.2
In order to transfer a file to the server, you can select the menu item
uploading in the transfer tree.
You can select the file to be sent, on the left side. In the field File on the
right side, you can allocate a new name to the file. In the lower area, you
have the option of specifying the format of the file to be sent.
With execute, you confirm the entries and starts the transfer. The file is
stored on rvsEVO Server in the directory $RVS_HOME\files\outbox.
Hint: For the upload the server connects via a port, opened by the client.
The port can be set up by the definition <entry key=
"client.remotefileloader.port" value="3756" /> in the
$RVS_HOME/conf/rvsEvoClient.prefs file.
downloading
In order to receive a file from the server, you select the menu item
downloading in the transfer tree.
In the area on the right, the files provided on the server (in the directory
$RVS_HOME\files\inbox) for downloading are listed. One selects the
file which is to be downloaded. On the left side of the window, you can
select the directory, in which the file should be saved and in the field
File, the file should be allocated a new name.
With execute, you confirm the entries and starts the transfer.
Command Tools
156
The user ID and password of the user arranged with the user
administration should be specified for all the command line calls which
are started remotely.
Remote GUI
Example:
updateStationList -f <xml-filename> -u <user> -p <password>
157
158
User Management
10
User Management
159
rvsEVO Benutzerhandbuch
160
PKI Bindung
11
PKI Bindung
In this chapter the configuration and the functionality of the rvsEVO PKI
binding will be described.
11.1 Introduction
In a PKI (Public Key Infrastructure) are stored public keys with their
certificates. The access to the PKI normally occurs via LDAP. rvsEVO
supports LDAP version 3.
Note: LDAP is a network protocol, which manages the communication
between a LDAP Client and a LDAP Directory Server. This protocol offers
the following features: login from client to the server, search queries for
the information stored in the directory and if necessary: modification of
information. This means relating to the PKI: in the LDAP Directory Server
the public keys and certificates are administrated.
Following features are available for rvsEVO PKI binding:
Access of public keys and certificates for a partner station via LDAP.
certificate validation with OCSP (Online Certificate Status Protocol),
CRT or CertPath.
Transfer of information from a OCSP server by HTTP.
11.2 Configuration
The following steps must be done to configure the PKI binding in rvsEVO:
configuration of stations, which should use PKI instead of a local key
management file (see chapter 11.2.1).
The configuration file $RVS_HOME/conf/PkiParameter.xml
with the access parameters for the PKI binding must exist.
161
Example (rvsStationlist.xml):
<Pki>
<CertificateValidationType>NONE</CertificateValidationType>
<PkiEnabled>true</PkiEnabled>
</Pki>
<CertificateValidationType>
<PkiEnabled>
Parameter
Description
Hint: If you use as validation type OCSP or CRL, the configuration file
$RVS_HOME/conf/PkiParameter.xml with the valid configuration
must exist.
Which validation method will be used is depending on security standards
in the company. The strongest validation method is OCSP, then CRL
following by CERT_PATH.
If you use OCSP as validation method, the OCSP service must be
available (Internet, Intranet) and your station must be able to access it.
The validation with CRL can be done offline, too. The rvsEVO user/
administrator must provide the list of certificate (CRL) and store it
manually. The disadvantage of this way is, that certificate can expire
between two updates.
11.2.2 PKI configuration file
The PKI access parameters must be configured in the PKI configuration
file $RVS_HOME/conf/PkiParameter.xml.
162
PKI Bindung
Example:
<pkiParameter>
<pkiProfile>
<pkiProfileId>default</pkiProfileId>
<!-- ==================== -->
<!-LDAP Einstellungen -->
<!-- ========================== -->
<ldapParameter>
<!-- ================ -->
<!-- ldap server info -->
<!-- ================ -->
<ldapServer>
<!-- server name or ip-address -->
<name>localhost</name>
<!-- ip-port -->
<port>10389</port>
<!-- LDAP version to use -->
<version/>
</ldapServer>
<!-- ================ -->
<!-- access info
-->
<!-- ================ -->
<ldapSecurity>
<user/>
<password/>
</ldapSecurity>
<!-- ============================================================ -->
<!-- search pattern definition, how to retrieve X.509 Certificates -->
<!-- ============================================================= -->
<ldapCertificateSearchPattern>
<!-- root node (distinguishedName) in the X.500 directory,
where search start from -->
<root>ou=Prozesse,o=Volkswagen AG,dc=VW,dc=vwg,dc=com</root>
<!-- common name pattern where to find the right certificate -->
<commonName>cn=VW_OFTP </commonName>
<!-- attribute which includes the X.509 certificate-->
<certificateAttribute>userCertificate</certificateAttribute>
<reverseOrder>false</reverseOrder>
</ldapCertificateSearchPattern>
</ldapParameter>
<!-- ============================== -->
<!--
OCSP Einstellungen
-->
163
<crlParameter>
<!-- directory where the actual used CRLs are stored -->
<location>g:\CRL\</location>
<url/>
<!-- defines the handling of CRL-failures -->
<crlFailureHandling>
<!--- if set true, CRL and CRL issuer are not verified -->
<skipCRLValidation>false</skipCRLValidation>
</crlFailureHandling>
</crlParameter>
</pkiProfile>
</pkiParameter>
164
accessLocation
certificateAttribute
commonName
crlFailureHandling
crlParameter
cspFailureHandling
ignoreMissingServer
issuerDistinguishedName
PKI Bindung
ldapCertificateSearchPattern
This parameter describes rules for the DN (distinguished name) structure of a certificate in the
LDAP directory.
ldapParameter
ldapSecurity
ldapServer
location
name
ocspParameter
ocspResponderDistinguishedName
Parameter
Description
password
Password
port
reverseOrder
root
165
166
skipCrlValidation
skipOcspResponseValidation
user
User name
rvsEVO Database
12
rvsEVO Database
From the rvsEVO version 5.0 the job data are written into a database and
not anymore into the directory $RVS_HOME/jobs with the subdirectories
ENDED, FAILED, SND or RCV.
Since version 5.02 also the data of user mangement are written into the
rvsEVO database.
The following databases are available:
Derby Embedded
Oracle
12.1 Derby
Derby database is a free, java based relational database from Apache
Foundation.
If you select Derby Embedded during the installation procedure, a
database will be automatically (by rvsEVO) installed in the directory
$RVS_HOME/db.
The following Derby databases were tested:
Derby 10.3.1.4
Derby 10.2.2.0
12.2 Oracle
The following preconditions must be fulfilled if you decided yourself for an
Oracle database:
an Oracle database user was set up with the user rights connect,
resource, create session and create table.
your Oracle configuration is accurate. If an Oracle client is installed on
your machine, you can test the configuration with the following
command:
sqlplus ORACLE-user@ORACLE-Network servername/password
Example:
sqlplus skk@RVS.TSYSTEMS.DE/skk
If this command could be executed successfilly (if a user exists and a
database is available), you can start the rvsEVO installation.
The following Oracle databases were tested:
Oracle 9i
Oracle 10g
167
Oracle 11g
While installation of rvsEVO (see Chapter 2.4 "Fresh installation of
rvsEVO") the following Oracle connection parameters have to be set:
jdbc.url
jdbc.user and jdbc.password
host connect string.
jdbc:oracle:thin:@localhost:1527/rvsORA
The default port for Oracle is 1521.
Note: If Oracle is running on an external computer, this computer must be
defined in the Oracle configuration file:
$ORACLE_HOME/network/admin/tnsnames.ora.
Example (tnsnames.ora):
#TNSNAMES.ORA Network Configuration File: /opt/oracle/product/8.1.7/
network/admin/tnsnames.ora
# Generated by Oracle configuration tools.
RVS.TSYSTEMS.DE =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = rvsaix3)(PORT = 1521))
)
(CONNECT_DATA =
(SERVICE_NAME = rvs)
)
)
168
rvsEVO Database
169
170
13
RCI
rvsEVO
rvsEVO
LCI
RCI
rvsEVO
RCI
rvsEVO
RCI
RCI
rvsEVO
rvsEVO
RCI
rvsEVO
RCI
RCI
rvsEVO
rvsEVO
171
172
orderConfiguration.bat
-s SID
C:\rvsEVO\management\mgmtdatastore\TINYPW
In this example TINYPW is the SID of RCI (of
the station, that should be administrated).
prepareUpdateStation.bat gets a RCI configuration copy out of CRep to
-s <SID>
the WorkDir in order to serve as starting point
for modifications.
Example for the WorkDir:
In the directory C:\rvsEVO
\management\mgmt-workspace the
following subdirectory will be created
TINYPW\UPDATE_STATION_040826_11
4418\out.
This is a subdirectory for the TINYPW station;
the date of the creation is 2004-08-26, the time
of the creation is 11:44:18.
commitUpdateStation.bat sends a modified configuration from the
-s <SID> -d <WorkDir>
WorkDir (without out subdirectory) to an RCI
(RCI should be set with the option -s for
stationID).
Example:
commitUpdateStation.bat
-s TINYPW
-d C:\rvsEVO\management\mgmtworkspace\TINYPW\UPDATE_STATION
_040826_114418
Note: The name of the WorkDir directory consists of CRep (see 13.1);
RCISID (TINYPW in the table example), directory UPDATE_STATION
with the timestamp (consisting of date and time; in the table example
040826_114418) and the directory out.
WorkDir contains all essential rvsEVO directories and files: By changing
these files the following configuration actions for example are possible:
Modify station configuration by modifying $RVS_HOME/conf/
rvsStationlist.xml.
Modify jobstarts by modifying $RVS_HOME/conf/
rvsJobstart.xml.
Update the software by replacing .jar files in the directory
$RVS_HOME/lib .
173
orderConfiguration -s TINY11
This command generates a configuration request file cfg.req.jar
(see the chapter 13.1 for the explanation of the meaning of
cfg.req.jar) and sends it via OFTP to the station TINY11. The
transmission of the file cfg.req.jar may be watched in the
rvsEVO GUI (Admin window). When the RCI (TINY11) receives the
file cfg.req.jar the configuration process will be started. The
configuration process stops rvsEVO (station TINY11), archives the
actual configuration in a file cfg.rsp.jar, starts rvsEVO (TINY11)
again and sends the configuration container file cfg.rsp.jar back
to the LCI (rvsEVO station of the administrator). If this step was
successful, you will receive a message OrderConfiguration exited
with return code 0 in the console. All these steps are part of the
program orderConfiguration and will be executed
automatically.
The next step is to get a copy of the RCIs configuration, that arrived
as the file cfg.rsp.jar. This should be done by the program
prepareUpdateStation on the command line. This program will
copy for you the arrived configuration file cfg.rsp.jar and store it
to the WorkDir (see chapter 13.2 for the explanation of WorkDir).
Example:
prepareUpdateStation.bat -s TINY11
Result: The directory C:\rvsEVO\management\mgmt-
workspace\TINY11\UPDATE_STATION_040828_113315
\out with the complete configuration of the station TINY11 will be
created. If this action was successfull, you will find a corresponding
174
workspace\TINY11\UPDATE_STATION_040828_113315)
with the command:
commitUpdateStation.bat -s TINY11 -d
C:\rvsEVO\management\mgmtworkspace\TINY11\UPDATE_STATION_040828_113315
This command will store the whole modified directory and send it to
the RCI (TINY11) again as a file cfg.req.jar.
After successfully receiving a file cfg.req.jar at the RCI
(TINY11), rvsEVO will be stopped (it all happens with the process
commitUpdateStation, you do not have to do any particular
steps); the modified configuration will be updated; the update job
checks, if all was correct and sends back a response as a file
cfg.rsp.jar. The result of the update is again logged in the file
activity.log.
Note: In case of non success the old configuration will be activated again.
13.3.1 How to exchange a license key file?
This chapter describes the typical case in administrating rvsEVO, how to
exchange an invalid license key. In this example the station TINY01 will
administrate the station TINY02.
Prerequisites: The station TINY01 must have the station TINY02 in
the station table as a neighbour station (please read the chapter for the
explanation how to set up stations) and the station TINY02 must also
have station the TINY01 as a neighbour station.
To be able to replace a license key file of TINY02, TINY01 must at
first get the configuration of TINY02 with the command:
orderConfiguration -s TINY02
If this step was successful, you will receive a message
OrderConfiguration exited with return code 0 in the console and the
file cfg.rsp.jar will be received. (see in the Ended
Transmissions, Admin-window of the TINY01 GUI).
The next step ist to get a copy of the TINY02 configuration, that
arrived as the file cfg.rsp.jar. This must be done with the
following command:
175
prepareUpdateStation.bat -s TINY02
Result: The directory C:\rvsEVO\management\mgmt-
workspace\TINY02\UPDATE_STATION_040828_113315
\out with the complete configuration of the station TINY02 will be
created. If this action was successful, you will find the message in the
file activity.log. This log file is stored in the directory
$RVS_HOME/management/mgmt-log.
Now you can rename the old license key from the directory
C:\rvsEVO\management\mgmtworkspace\TINY02\UPDATE_STATION_040828_113315
\out\conf to licenseOLD.properties and copy the new
license key license.properties to the directory
C:\rvsEVO\management\mgmtworkspace\TINY02\UPDATE_STATION_040828_113315
\out\conf. How to obtain the new license key, please read the
chapter 2.2.
Send the modified configuration to TINY02 (you must send the whole
directory C:\rvsEVO\management\mgmt-
workspace\TINY02\UPDATE_STATION_040828_113315)
with the command
commitUpdateStation.bat -s TINY02 -d
C:\rvsEVO\management\mgmtworkspace\TINY02\UPDATE_STATION_040828_113315
This command will store the whole modified directory and send it to
the station TINY02 again as a file cfg.req.jar.
After successfully receiving the file cfg.req.jar at the station
TINY02, rvsEVO at TINY02 will be stopped (it happens all with the
process commitUpdateStation, you do not have to do any
particular steps); the modified configuration will be updated; the
update job checks, if all was correct and sends back a response as a
file cfg.rsp.jar. The result of the update is again logged in the file
activity.log.
Note: In case of non success the old configuration will be activated again.
13.3.2 How to change a station parameter?
This chapter describes a typical case in administrating rvsEVO, how to
change a rvsEVO parameter e.g. the ODETTE-ID. It is the same
procedure for changing any other rvsEVO parameter. In this example the
station TINY20 will administrate the station TINY22.
Prerequisites: The station TINY20 must have the station TINY22 in the
station table as a neighbour station (please read the chapter for
explanation how to set up stations) and the station TINY22 must also
have station TINY20 as a neighbour station.
176
orderConfiguration -s TINY22
If this step was successful, you will receive a message
OrderConfiguration exited with return code 0 in the console and the
file cfg.rsp.jar from the station TINY22 will be received as a
response of this request; please see in the Ended Transmissions,
Admin-window of the TINY20 GUI.
The next step ist to get a copy of the TINY22 configuration, that
arrived as the file cfg.rsp.jar to the WorkDir of TINY20. Please
see the chapter 13.2 for the explanation of the WorkDir.
prepareUpdateStation.bat -s TINY22
Result: The directory C:\rvsEVO\management\mgmtworkspace\TINY22\UPDATE_STATION_040829_133315
\out with the complete configuration of the station TINY22 will be
created. If this action was successful, you will find a corresponding
message in the file activity.log. This log file is stored in the
directory $RVS_HOME/management/mgmt-log.
Now you can edit the file rvsStationlist.xml from the directory
C:\rvsEVO\management\mgmtworkspace\TINY22\UPDATE_STATION_040829_133315
\out\conf and modify it e.g. parameter ODETTE_ID or TCP/IP
address (parameter IP_ADDR) for the local station of TINY22
(STATION_LOC) or other stations.
The next step is to send the modified configuration to TINY22 (you
must send the whole directory (but without out directory)
C:\rvsEVO\management\mgmtworkspace\TINY02\UPDATE_STATION_040829_133315)
with the command
commitUpdateStation.bat -s TINY22 -d
C:\rvsEVO\management\mgmtworkspace\TINY22\UPDATE_STATION_040829_133315
This command will store the whole modified directory and send it to
station TINY22 again as a file cfg.req.jar.
After successfully receiving a file cfg.req.jar at the station
TINY22, rvsEVO at station TINY22 will be stopped (it all happens
with the process commitUpdateStation, you do not have to
make any particular steps) and the modified configuration will be
updated. Then the update job checks, if all was correct and sends
back a response to the station TINY20 as a file cfg.rsp.jar. The
result of the update is again logged in the file activity.log.
Note: In case of non success the old configuration will be activated again.
177
orderConfiguration -s TINY33
If this step was successful, you will receive a message
OrderConfiguration exited with return code 0 and the file
cfg.rsp.jar will be received, see in the Ended Transmissions,
Admin-window of the TINY30 GUI.
The next step ist to get a copy to the WorkDir of the TINY33
configuration, that arrived as the file cfg.rsp.jar. Type the
follwing command in the command line:
prepareUpdateStation.bat -s TINY33
Result: The directory C:\rvsEVO\management\mgmt-
workspace\TINY33\UPDATE_STATION_040830_113315
\out with the complete configuration of the station TINY33 will be
created. If this action was successful, you will find a corresponding
message in the file activity.log.
Now you must rename the old .jar file rvs.jar from the directory
C:\rvsEVO\management\mgmtworkspace\TINY33\UPDATE_STATION_040830_113315
\out\lib to rvsOLD.jar and replace it with the new one. Please
contact us to receive the actual files for the update (E-Mail: rvsservice@t-systems.com; Tel. +49 30 39971 777).
Send the modified configuration to TINY33 station (you must send
the whole directory C:\rvsEVO\management\mgmtworkspace\TINY33\UPDATE_STATION_040830_113315)
with the command
commitUpdateStation.bat -s TINY33 -d
C:\rvsEVO\management\mgmtworkspace\TINY02\UPDATE_STATION_040830_113315
This command will store the whole modified directory and send it to
TINY33 again as a file cfg.req.jar.
After successfully receiving the file cfg.req.jar at the station
TINY33, rvsEVO of TINY33 will be stopped (it all happens with the
process commitUpdateStation, you do not have to do any
178
179
180
14
rvsbat
rvsbat gives you an additional possibility for automated file transfer and
for managing jobstarts.
The following rvsbat commands are supported by rvsEVO:
SEND: create a send job
RESENTR: create, delete, modify jobstarts after receive (in rvs
portable: resident receive entries)
SENDJOB: create, delete, modify jobstarts after send attempt.
FAILURE: create, delete, modify jobstarts after failure.
14.1 Starting rvsbat
rvsbat is to be started via command line:
Syntax:
rvsbat [/c] [/i<input file>] [/l<language>] [/q]
The command line parameters have the following meaning:
/C: continue with rvsbat after an error occured during execution of a
utility command. By default, rvsbat will terminate after an error.
/I<filename>: read commands from cmdfile. The command input file
may contain the following elements:
- Comment lines (starting with *)
- Commands (may extend over several lines by specifying + as the
last character in the line to be continued)
/L<language>: use message language given by character language.
Values: E (english), D (german)
/Q execute user commands in quiet mode, i.e. do not echo them to
standard output; feedback about success or failure of the operation
will still be provided.
The rvsbat commands (SEND, RESENTR, SENDJOB und FAILURE)
can be imported via input file or written into the command prompt. In the
second case, rvsbat can be breaked by <STRG> C. In both cases, the
syntax of the command strings is identical.
Example:
SEND /C SIDORIG=LOC DSN=C:\docs\test.txt (SID=EVO54E
DSNNEW=TESTVDSN)
Import a command via input file:
Using the expamle of SEND command you see what steps are needed to
perform a send job by using an input file:
181
rvsEVO Benutzerhandbuch
SID
Optional parameters:
CODEIN
182
DISP
FORMAT
INITTIME
LABEL
MAXRECL
SERIAL
TSTAMP
VFTYP
183
rvsEVO Benutzerhandbuch
184
ALG
CODEOUT
CODETABLE
COMPRESSION
DSNNEW
ENCRYPTION
FILEDESC
SIDORIG
virtual station
(GUI name: SID Originator)
SFS
SIGN
SIGNRESP
XID
185
rvsEVO Benutzerhandbuch
RESENTR parameters:
Required parameters: DSN, SID
Optional parameters: CODETABLE, CODETRANS, COMMENT, DSN,
ENABLED, EXECSYNC, EXECTIMEOUT, JOB, NEWDIR, NEWNAME,
PARAMHANDLING, REPLACE, SHELL, SIDDEST, TSTAMP,
TSTAMPFORMAT, VFTYP
Parameters without function (for compatibility with rvs portable):
ACCOUNT, DISP, FLAGCOMP, FLAGCRYPT, LUID, UID
The table in chapter 14.3.4 shows the description of the parameters.
1. Expample:
RESENTR/CREATE LUID="*" DSN="TENNIS" UID="*" SID="*"
SIDORIG="*" DSNNEW="" REPLACE="N" DISP="K" TSTAMP="N"
JOB="C:\rvsTest\scripts\resentr.bat"
After receiving files with the virtual file name "TENNIS" the Job
"C:\rvsTest\scripts\resentr.bat" is to be started. Existing files
which own the same name are not replaced, a timestamp is to be added
only if necessary. The parameters LUID, UID and DISP are without
function.
2. Expample:
RESENTR /D DSN="Test.txt" SID="*"
Jobstarts which are to be launched after receiving the file Test.txt are
deleted.
14.3.2 The SENDJOB Command
Use the SENDJOB command to create, edit or delete a jobstart after send
attempt.
Commands:
/CREATE or /C: create a jobstart after send attempt
/UPDATE or /U: edit a jobstart after send attempt
/DELETE or /D: delete a jobstart after send attempt
SENDJOB parameters:
Required parameters: SID (= SIDDEST), VDSN
Optional parameters: ATTEMPTS, COMMENT, ENABLED, EXECSYNC,
EXECTIMEOUT, JOB, PARAMHANDLING, SHELL, SIDSENDER =
SIDORIG, UID
The table in chapter 14.3.4 shows the description of the parameters.
1. Example:
SENDJOB /C VDSN="Test.txt" SID="RVS" ATTEMPTS=0
SIDSENDER=LOC JOB="C:\rvsTest\scripts\sendjob.bat"
CODETRANS="" CODETABLE="" FLAGCOMP="N" FLAGCRYP="N"
186
After sending the file "Test.txt" from station LOC to station RVS the job
"C:\rvsTest\scripts\sendjob.bat" is to be started. There is no code
conversion; the FLAGCOMP and FLAGCRYP parameters are without
function.
2. Example:
SENDJOB /D VDSN="Test.txt" SID="RVS"
Required parameters:
DSN
SID
oder SIDDEST
187
rvsEVO Benutzerhandbuch
SID
VDSN
Optional parameters:
188
ACCOUNT
ATTEMPTS
CODETABLE
CODETRANS
COMMENT
free text;
DISP
DSNNEW
ENABLED
EXECSYNC
EXECTIMEOUT
FLAGCOMP
FLAGCRYPT
JOB
LUID
NEWDIR
NEWNAME
PARAMHANDLING
REPLACE
189
rvsEVO Benutzerhandbuch
190
SHELL
SIDDEST
SIDORIG
SIDSENDER
alternativ to SIDORIG
TSTAMP
TSTAMPFORMAT
UID
VFTYP
Appendix
15
Appendix
Connect
Responder (receiver)
----- network
connect ----->
<----- SSRM -----
ODETTE ID
password, buffersize,
credit
191
n data records
Change Direction
network disconnect
192
------ CD ------>
<----- EERP ----or
<----- NERP -----
End-to-End Response/
Negative End-to-End
Response (acknowledgment)
End-Session ID
network disconnect
Index
showMonitorLogFile 94
startKeyMgn 129
startServer 89
startService 28
stopServer 89
terminateSession 131
updateStationList 74
userManagerClient 132
Index
A
Active Panel 111
B
bastion 147
Batch file 89
C
CA certifcate 69, 142
certificate-properties 32
CertificateUsageDefinition 141
Client 155
Command Tools
activateStation 95
archiveJobs 126
commitUpdateStation 173
convertAndSend 106
convertFile 132
createBackup 133
createSendJob 100
deleteJob 115
deliverCertificate 127
doRecover 135
getCertificateList 129
getJob 118
getJobInfoList 120
getJobList 117
handleEERP 119
holdJob 115
importCRL 130
importTSL 130
login 132
orderConfiguration 173
prepareUpdateStation 173
releaseJob 116
replaceCertificate 128
requestCertificate 127
restartJob 116
rvsEVOService 132
rvsservice 29
sendJournal 131
setclientcp 132
setcp 132
showMonitorLog 93
Comment 79
Configuration files 79
Connection type
ISDN 16
TCP/IP 17
CONTACT 73
Customizing configuration files 37
D
delaftersend.bat 87
Derby 167
E
EERP 59
EERP_OUT 119
Encryption
CentralJournalInstance 38
Cleanupdays 38
Cleanupinterval 38
Cleanuptime 38
ConnSetupFailWaitTime 39
DB 39
Description 39
EngdatConfigFile 39
HelpFile 39
HostAllowFile 39
HostDenyFil 39
INBOX 39
JobstartConfigFile 39
JournalFilenamePrefix 39
LOGDIR 39
LooptestNeighbourSID 39
ManagementConfigFile 40
MaxMonLogCount 40
MaxMonLogSize 40
MaxRevisionLogCount 40
MaxRevisionLogSize 40
MaxSessions 40
OFTPTimeout 40
PersistenceArchive 40
RedoLog 40
RMIServiceHost 40
RMIServiceName 40
RMIServicePort 41
RvsStartScript 41
SendJournalInterval 41
SessionAliveTimeout 41
SessionWaitTime 41
StationsConfigFile 41
TEMP 41
Timestamp 41
TraceItem 42
TransmissionFailWaitTime 42
Record Handling 81
Replace 81
Send Attempts 81
sendAttempts 81
Shell 81
SID of Destination 81
SID of Originator 81
Synchronized 82
Timeout (Sync.) 82
Timestamp 82
Timestamp Format 82
jobstart.bat 87
jobstart_detailed.bat 87
JobstartConfigFile 43, 44
journal.bat 87
K
Kommandozeilentools
rvsbat 181
startGUI 28
M
Migration 30
G
GUI 26
N
network parameters
H
handleEERP 59
handleMangement.bat 87
I
importComSecureKeyPair 31
ISDN connection 16
J
jobFilter 75
JobStart 75
JobStart parameters
Conversion table 80
Direction 80
Enabled 80
New Directory 80
New Filename 80
Parameter Handling 80
Process 81
Processing Class 81
processingClass 81
ReceiverNumber 62, 64
restart timeout 52, 53
Router IP address 57, 64
Router Port 57, 64
SDN Userdata 55
timeout 52, 53, 55, 57, 62, 64
trusted certs keystore file name 54
Type 55, 62
X.25 Address 55, 57, 62, 64
X.25 Closed User Group 55, 63
X.25 DBit 55, 57, 63, 64
X.25 Facilities 56, 57, 63, 64
X.25 Modulo 57, 64
X.25 PacketSize 56, 57, 63, 64
X.25 Userdata 56, 57, 63, 64
X.25 Window Size 56, 58, 63, 65
O
ODETTE parameters
Authentication 58
Certificate Validation Type 59
Compression 59
Encryption 60
Encryption Algorithm 60
End to End Response in 59
End to End Response Out 59
Exchange Buffer Credit 59
Exchange Buffer Size 58
File Service Proxy 60
Odette ID 60
OFTP Version 60
PKI 60
Receive Password 60
Restart 60
Security 61
Security Feature Set 60
Send Password 60
SFIDDESC as Filename 61
Sign 61
Sign ERP 61
VDSN charse 61
Odette port 74
OFTP Proxy 147, 151
OUTBOX 40
R
Receive 60
Remote GUI 155
RMIServiceHost 48
RMISeviceName 48
$RVS_HOME 14
RVS_HOME 30
rvsbat
S
sendback.bat 88
SNMP 42
SNMP parameters
Active 42
Interval 43
IP address 43
Log-Level 43
Port 43
StationsConfigFile 43, 44, 46
T
Typographic conventions 14
U
User Management 159
V
VDSN 82
virtual station 66
W
What is rvs 9
What rvs is not 9