Overview of the Auerswald SFTP Implementation

 

This overview shows the support of SFTP in Auerswald PBX systems.


The SFTP data transfer protocol (also called SSH File Transfer Protocol) is used in the PBX to transfer call data information in a protected way to external applications. General information about the SFTP-protocol may be found here:

http://www.vandyke.com/technology/draft-ietf-secsh-filexfer.txt

This function was designed to support hotel applications, but might be used by every other application as well.

Here is the matrix of supported PBX devices:

Auerswald PBX SystemFirmware VersionComment
COMmander 6000,
COMmander 6000R,
COMmander 6000RX
> V5.0A  
COMpact 5000,
COMpact 5000R
> V6.2A  

Table of Contents

Mandatory Configuration Settings in the PBX


There are several settings in the WEB-UI of the PBX system to enable and configure the SFTP-protocol and data format.

The SFTP-transfer is disabled by default in the PBX. To enable it, you have to navigate to Administration -> IP configuration. There is a section for the SFTP SERVER. You have to check the box behind the SFT server to enable the function. You can also replace the automatically generated password with your own password.

SFTP Server

If you want to use not only the globall call data files, but also the additional subscriber data files for the hotel functionality, you have to purchase the hotel function in the Auerswald Upgrade Center and activate it in the PBX.

Table of Contents

Optional Configuration Settings in the PBX


The files on the SFTP server

The data format can also be configured. Navigate to User data > Call data > Settings.

General settings: The file is provided as CSV-text. Here you can configure the separator character. Also the file header can be disabled or enabled.

Call data file: The period of file generation may be configured between every 60 seconds and every month. Please be aware: If you permanently have a lot of calls, a very long interval may cause loss of data records. This file is generated from the call charge data list, that holds a maximum of 18000 record.

The cleanup period may also be configured here. Files older than the clean-up period will be deleted. In addition to periodical cleanups: If the files use more data than assigned under “Automatic deletion for assignment of”, the oldest file will be deleted. All of these files are created under the directory /calldata/ on the SFTP server.

Hotel function: If you need separate files for each subscriber, like in a hotel, you can configure the parameters here. The hotel function of the PBX has a check-out function, you can select here, if you want to create a special file for each subscriber on check-out of that subscriber. These files are created in the directory /checkoutdata/ of the SFTP server.

SFTP Transfer

 

Table of Contents

The files on the SFTP server


a) The File Names


The file name of the global call data files: These filename are always created from the date and time in the format yyyymmddhhmm.txt.

yyyy = year (2010-2039)
mm = month (01-12)
dd = day (01-31)
hh = hour (00-23)
mm = minute (00-59)

The file names of the hotel subscriber call data files: These filename are always created from the date and time in the format yyyymmddhhmmrrrrrssss.txt.

yyyy = year (2010-2039)
mm = month (01-12)
dd = day (01-31)
hh = hour (00-23)
mm = minute (00-59)
rrrrr = bill number
ssss = internal subscriber number


Table of Contents

b) The File Format of the Global Call Data Files


The file format is a CSV-text (ANSI-coded).

If enabled, the file has a header with these fields. The text strings in the file header are matching with the column headers of the Call charge data list in the Web-GUI and may be edited on the Web-GUI-page User data -> Call data -> Print options. Pleas note: The default names are different for German and English Web-GUI languages and the PBX administrator may enter also other language string here.


Name in headerContent description
No. Record number value starting with 1 in each file
Date Date in the format dd.mm.yy
Time Time in the format hh:mm:ss
Duration Call duration in the format hh:mm:ss
Duration Call duration in the format hh:mm:ss
Scr no. invoice Number in the range 10-9999
Scr name invoice Name with a maximum of 16 characters
Scr no. real Number in the range 10-9999
Scr name real Name with a maximum of 16 characters
Connection no. External Number used for this call on one of the trunk lines of the PBX
External partner Telephone number of the external call partner
External name Name of the external call partner
Proj. Project number of the PBX
Charges Charges in cent in the format xxxxx.xx
Fact. Charge factor multiplier in the format xx.xx
Direction Direction: incoming; outgoing
Bill type Billing type: business; private
Call Fwd. Call forwarding method:
Call forwarding external: CF ext.
Call forwarding scr.: CF int.
Bill type Call success: successful.= successf.;
unsuccessful = unsucc.
LCRNo Call by call number with a maximum of 6 digits
Type of call Type of call:

normal = normal,
remote access = Fernprog.
Alarm call = Alarm call
Door call = Door-Ext.
Call Through = CallThru
Wake-up = Wake-up
LCR-update = LCR-Upd.
VoIP-call = VoIP
Alarm call confirmed = Alarm confirm.
Alarm call rerouted = alarm reroute.
HotId Billing id for hotel application

The header and the single data records are terminated with a [RETURN]-character (0dh). Fields not used for this type of call are left empty or contain a [SPACE].

Here is a sample of this file type:

No.;Date;Time;Duration;Scr no. invoice;Scr name invoice;Scr no. real;
Scr name real;Connection no.;External partner;External name;Proj.;Charges;Fact.;Direction;Bill type;Call Fwd.;Bill type;LCRNo;Type of call;HotId;
1;04.09.12;15:07:43;0:0:14;536;Sales, Gr.;;;92190;0530692000;Gesellschaft;
;0.0;100; incoming; business; ; unsuccessful;;normal;0;
2;04.09.12;15:07:43;0:0:14;574;Fax, Work;574;Fax, Work;921994;05306920099;Fax Test;;0.0;100;outgoing; business;
; unsuccessful;;normal;0;

Table of Contents

c) The File Format of the Hotel Call Data Files


The header of these files and the data records are different to the global files. The header contains several lines. The text strings in these lines is derived from the text entered into the Web-GUI under Functions -> Hotel function -> Create print form. Please note: These text strings may be modified by the PBX administrator and the default text strings are different for German and English language options.

  1. the subscriber name of the room telephone (defined in the Web-GUI of the PBX for the internal subscriber)
  2. invoice number xxxxx
  3. check-in date and time in the format dd.mm.yyyy; hh:mm
  4. check-out date and time in the format dd.mm.yyyy; hh:mm
  5. header for the following call records of this room
    Date;Time;Duration;Telephone number;Amount
  6. -> Nnn. Then the individual call data records for this hotel room follow.
    Nnn. Last call data record.
    After the call records, there are two lines of footer information:
    Nnn+1. Sum (incl. VAT);charges in the format xxx.xx; currency string
    Nnn+2. This line is only included, if the checkbox behind Print is enabled in the Web-GUI under
    Functions -> Hotel function -> Create print form.
    It lists: % of VAT; amount of VAT in the format xx.xx; currency string

Here is a sample of this file type:

Room 21
Invoice no:;17598
Check in:;05.09.2012;11:14
Check out:;05.09.2012;11:15
Date;Time;Duration;Telephone number;Amount
05.09.2012;11:15;00:00:02;053069200xxx;0,0600
05.09.2012;11:15;00:00:02;053069219xxx;0,0600
Sum (incl. VAT);0,12;Euro
19% VAT;0,02;Euro

Table of Contents

d) SFTP Clients and Test Tools


During evaluation and development it might be very helpful to do some data transfer with SFTP standard clients. It might also be possible to integrate some of these external clients into your application. We have successfully used WinSCP as an SFTP client of our PBX. Other clients may work as well. There is a list of SFTP clients on Wikipedia:

http://en.wikipedia.org/wiki/Comparison_of_FTP_client_software#Protocol_support

Table of Contents