Reference10:Concept Faxserver: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
No edit summary
Line 4: Line 4:
The application polls an internal mailbox for arriving emails which are converted to a fax document and sent by an innovaphone FAX interface. Content in the email can be '''plain text''', '''HTML''', '''PDF files''' and all other files which can be '''converted by OpenOffice''' to PDF. The sent document includes a '''cover page''' if configured. The recipient's fax number is taken from the email address and defined as ''fax number''@''fax server domain''. To send an email to the internal mailbox, '''authenticated SMTP''' with the configured user and password must be used.
The application polls an internal mailbox for arriving emails which are converted to a fax document and sent by an innovaphone FAX interface. Content in the email can be '''plain text''', '''HTML''', '''PDF files''' and all other files which can be '''converted by OpenOffice''' to PDF. The sent document includes a '''cover page''' if configured. The recipient's fax number is taken from the email address and defined as ''fax number''@''fax server domain''. To send an email to the internal mailbox, '''authenticated SMTP''' with the configured user and password must be used.


Incoming fax documents are converted to a '''PDF''' file and forwarded to the email address ''PBX user name''@''user domain''.
Incoming fax documents are converted to a '''PDF''' file and forwarded to the email address ''PBX user H.323 name''@''user domain''.


 
== Requirements ==
[[Image:faxserver_application.png|Faxserver Application]]
 
==Requirements==
* It is needed to have the [[Reference10:Concept_Linux_Application_Platform|innovaphone Linux Application Platform]] installed and running.
* It is needed to have the [[Reference10:Concept_Linux_Application_Platform|innovaphone Linux Application Platform]] installed and running.
* It is required that the users have got email addresses of the combination of the PBX user H.323 name and the user domain: ''PBX user H.323 name''@''user domain''. See also the requirement on the [[ Reference10:Concept_myPBX#Email_addresses | email addresses]] for myPBX.


===Email addresses===
== Installation ==
See [[ Reference10:Concept_myPBX#Email_addresses | Email addresses]].
Download the latest version of innovaphone Faxserver.
 
==Installation==
 
Download the latest version of innovaphone faxserver.


Log into the application platform, go to the Applications tag, click on [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.  
Log into the Linux Application Platform, go to the Applications tag, click on [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.  
The installation will start automatically and the page will refresh every two seconds showing the installation process.  
The installation will start automatically and the page will refresh every two seconds showing the installation process.  
If there is no error during the installation you will see at the end "Installation was successful". Otherwise,
If there is no error during the installation you will see at the end "Installation was successful". Otherwise,
you will get "installation failed" and the reason why it went wrong.
you will get "installation failed" and the reason why it went wrong.


===Hotfix===
=== Hotfix ===
If you have already installed the latest version of the faxserver, simply download the Faxserver...HotfixIncremental for your platform (VM or IPxx10) or if you have missed some hotfixes, download the Faxserver...HotfixCumulative archive, which contains all hotfixes since hotfix1.
If you have already installed the latest version of the faxserver, simply download the Faxserver...HotfixIncremental for your platform (VM or IPxx10) or if you have missed some hotfixes, download the Faxserver...HotfixCumulative archive, which contains all hotfixes since hotfix1.
<br>
<br>
Line 30: Line 24:
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].


==Configuration==
== Configuration ==
The Faxserver consists of the Linux application and several parts of an innovaphone device: a PBX SOAP login, a PBX gateway object, the gateway FAX interface and an route to an external line.
 
[[Image:faxserver_application.png|Faxserver Application]]
 
=== Device ===
=== Device ===
The following configurations must be done in the innovaphone device.


==== License ====
==== License ====
Line 48: Line 47:
If the Faxserver Webdav path should not have public access or force HTTPS is enabled, the authentication of the Faxserver Webdav URL must be configured for the device HTTP Client and the ''innovaphone-linux'' certificate must be trusted.
If the Faxserver Webdav path should not have public access or force HTTPS is enabled, the authentication of the Faxserver Webdav URL must be configured for the device HTTP Client and the ''innovaphone-linux'' certificate must be trusted.


===innovaphone Application Platform===
=== innovaphone Linux Application Platform ===
The following configurations are part of the innovaphone Linux Application Platform.


==== Public Webdav access ====
If the faxserver URL/user/password is not configured in your device as authenticated URL, configure '''faxserver/''' as public '''Webdav''' path with write access on the innovaphone application platform [[Reference10:Concept_Linux_Application_Platform#Change_the_Linux_webdav_access_credentials|Public Webdav Paths]].
If the faxserver URL/user/password is not configured in your device as authenticated URL, configure '''faxserver/''' as public '''Webdav''' path with write access on the innovaphone application platform [[Reference10:Concept_Linux_Application_Platform#Change_the_Linux_webdav_access_credentials|Public Webdav Paths]].


===Server Configuration===
==== Server Configuration ====
* Active: Tick if this server should be started.
* Active: Tick if this server should be started.
* Server Name: A freely selectable name for this new server instance.
* Server Name: A freely selectable name for this new server instance.
Line 63: Line 64:
* For an other user language or cover file of a specific slave PBX such a configuration can be added with a PBX name configuration line.
* For an other user language or cover file of a specific slave PBX such a configuration can be added with a PBX name configuration line.


===Mail Configuration===
==== Mail Configuration ====
The fax server includes an email server. To send emails to the faxserver SMTP authorization must be used with the configurable user and password.
The fax server includes an email server. To send emails to the faxserver SMTP authorization must be used with the configurable user and password.
* User: The user for the SMTP authorization. It must be unique for all fax servers.
* User: The user for the SMTP authorization. It must be unique for all fax servers.
Line 69: Line 70:
* Administrator Mail Address: The administrator mail address for error notification mails.
* Administrator Mail Address: The administrator mail address for error notification mails.


===SOAP Configuration===
==== SOAP Configuration ====
It is necessary to add a normal PBX user with at least CF/group rights and set password to use it for the SOAP login. The user must be in the same group as the fax gateway object and the group active flag must be set. To check the Fax license for users in slave PBX it is also required the SOAP login is available in all slave PBX.
It is necessary to add a normal PBX user with at least CF/group rights and set password to use it for the SOAP login. The user must be in the same group as the fax gateway object and the group active flag must be set. To check the Fax license for users in slave PBX it is also required the SOAP login is available in all slave PBX.


Line 80: Line 81:
* Fax User: The ''long name'' of the PBX gateway object.
* Fax User: The ''long name'' of the PBX gateway object.


===Fax Configuration===
==== Fax Configuration ====
* Subscriber Id: The subscriber Id of the T.30 protocol, which will be sent with a fax.
* Subscriber Id: The subscriber Id of the T.30 protocol, which will be sent with a fax.
* Add User Number: If ticked the user number is appended to the subscriber id.
* Add User Number: If ticked the user number is appended to the subscriber id.
Line 88: Line 89:
* Response Timeout: The timeout in seconds within the remote party has to response.
* Response Timeout: The timeout in seconds within the remote party has to response.


===Texts===
==== Texts ====
Customer specific texts can be configured language dependently here. The texts are used for the email correspondence with the users.
Customer specific texts can be configured language dependently here. The texts are used for the email correspondence with the users.


===Covers===
==== Covers ====
Own cover files can be uploaded, downloaded or deleted here. Once uploaded the cover file can be chosen within the server configuration. Only unused files can be deleted.
Own cover files can be uploaded, downloaded or deleted here. Once uploaded the cover file can be chosen within the server configuration. Only unused files can be deleted.


===Database===
==== Database ====
Faxserver installs postgreSQL version 8.4 as database management system and creates the innovaphone-faxserver database to store the configuration and the fax job data.  
Faxserver installs postgreSQL version 8.4 as database management system and creates the ''innovaphone-faxserver'' database to store the configuration and the fax job data.  
PostgreSQL is also available for other applications and any of them could create its own database.  
PostgreSQL is also available for other applications and any of them could create its own database. The default password is '''faxserver'''. It may be changed at the innovaphone Faxserver page under Config/Database.
 
====Password====
The Faxserver creates the database user '''innovaphone-faxserver''' with default password '''faxserver'''.  
This password may be changed at the innovaphone Faxserver page under Config/Database.
 
====Remote Access====
There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from under Config/Database at the innovaphone Faxserver page.


For the PgAdmin III it is important to use innovaphone-faxserver as service DB. The default login credentials are for the user '''innovaphone-faxserver''' with the password '''faxserver'''.
There are tools that allow to connect to application databases remotely. It is first needed to configure the IP you are connecting from under Config/Database at the innovaphone Faxserver page. For the PgAdmin III it is important to use innovaphone-faxserver as service DB. The default login credentials are for the user '''innovaphone-faxserver''' with the password '''faxserver'''.


==Backup and Restore==
== Backup and Restore ==
You can both manually and automatically backup the database and configuration files for the Faxserver application under [[Reference10:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.
You can both manually and automatically backup the database and configuration files for the Faxserver application under [[Reference10:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.


Configuration details for the update server can be found [[Reference10:Concept_Linux_Application_Platform#Backup|here]].
Configuration details for the update server can be found [[Reference10:Concept_Linux_Application_Platform#Backup|here]].


===Configuration Files===
=== Configuration Files ===
'''saveinnovaphone-faxservercfgs''' is the command used to automatically save the cover page files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]]. Other configuration files must not be saved because the configuration of the innovaphone Faxserver is in the Faxserver database.
'''saveinnovaphone-faxservercfgs''' is the command used to automatically save the cover page files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]]. Other configuration files must not be saved because the configuration of the innovaphone Faxserver is in the Faxserver database.


===Data===
=== Data ===
'''saveinnovaphone-faxserverdb''' is the command to automatically backup the whole innovaphone Faxserver database with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]]. The Faxserver database also includes the Faxserver configuration, but not the cover page files.
'''saveinnovaphone-faxserverdb''' is the command to automatically backup the whole innovaphone Faxserver database with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]]. The Faxserver database also includes the Faxserver configuration, but not the cover page files.


===Logs===
=== Logs ===
'''saveinnovaphone-faxserverlogs''' to save log files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].
'''saveinnovaphone-faxserverlogs''' to save log files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].


==Appendix==
== Appendix ==
===Tools===
=== Tools ===
====NetDrive====
==== NetDrive ====
[http://www.heise.de/software/download/netdrive/55134 NetDrive] is a useful webdav client which can be used to access webdav of the innovaphone application platform.
[http://www.heise.de/software/download/netdrive/55134 NetDrive] is a useful webdav client which can be used to access webdav of the innovaphone Linux Application Platform.


====PGAdmin====
==== PGAdmin ====
[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.
[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.


====Putty====
==== Putty ====
[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.
[http://www.putty.org/ Putty] is SSH client to connect to the Linux Application Platform.


== Related Articles ==


[[Category:Concept|Faxserver]]
[[Category:Concept|Faxserver]]

Revision as of 12:26, 25 April 2013

The innovaphone Faxserver application provides an email-to-fax and fax-to-email gateway.

The application polls an internal mailbox for arriving emails which are converted to a fax document and sent by an innovaphone FAX interface. Content in the email can be plain text, HTML, PDF files and all other files which can be converted by OpenOffice to PDF. The sent document includes a cover page if configured. The recipient's fax number is taken from the email address and defined as fax number@fax server domain. To send an email to the internal mailbox, authenticated SMTP with the configured user and password must be used.

Incoming fax documents are converted to a PDF file and forwarded to the email address PBX user H.323 name@user domain.

Requirements

  • It is needed to have the innovaphone Linux Application Platform installed and running.
  • It is required that the users have got email addresses of the combination of the PBX user H.323 name and the user domain: PBX user H.323 name@user domain. See also the requirement on the email addresses for myPBX.

Installation

Download the latest version of innovaphone Faxserver.

Log into the Linux Application Platform, go to the Applications tag, click on Upload/Update and upload the downloaded file. The installation will start automatically and the page will refresh every two seconds showing the installation process. If there is no error during the installation you will see at the end "Installation was successful". Otherwise, you will get "installation failed" and the reason why it went wrong.

Hotfix

If you have already installed the latest version of the faxserver, simply download the Faxserver...HotfixIncremental for your platform (VM or IPxx10) or if you have missed some hotfixes, download the Faxserver...HotfixCumulative archive, which contains all hotfixes since hotfix1.

Upload this hotfix archive here.

Configuration

The Faxserver consists of the Linux application and several parts of an innovaphone device: a PBX SOAP login, a PBX gateway object, the gateway FAX interface and an route to an external line.

Faxserver Application

Device

The following configurations must be done in the innovaphone device.

License

It is required to have Fax licenses installed on your device. Check under Reference10:General/License if you already have one. An user fax license is necessary for each PBX user with fax rights. Set the Fax license flag for each PBX user object on the objects properties page which should be allowed to send or receive fax documents.

PBX TAPI Login

It is required to have a PBX object which can be used for SOAP login. This object and the fax gateway object must be in the same group and the group active flag must be set for this object.

PBX Gateway Object

It is required to have a PBX gateway object the FAX interface can register to. The prefix option should be enabled. The object must be a member of the tapi group.

FAX Interface

Register the FAX interface to the PBX gateway object.

Webdav Access

If the Faxserver Webdav path should not have public access or force HTTPS is enabled, the authentication of the Faxserver Webdav URL must be configured for the device HTTP Client and the innovaphone-linux certificate must be trusted.

innovaphone Linux Application Platform

The following configurations are part of the innovaphone Linux Application Platform.

Public Webdav access

If the faxserver URL/user/password is not configured in your device as authenticated URL, configure faxserver/ as public Webdav path with write access on the innovaphone application platform Public Webdav Paths.

Server Configuration

  • Active: Tick if this server should be started.
  • Server Name: A freely selectable name for this new server instance.
  • Description: A freely selectable description for this new server instance.
  • User domain: The user domain is used to send the mail to the users. The user email address is generated with the user H.323 name in the PBX and the here configured user domain.
  • Fax Server Domain: Incoming mails are checked against the fax server domain.
  • Language: The default language for this fax server.
  • Cover: The cover file which is used to send a cover page by this fax server.
  • Trace: If ticked, the FAX interface trace on the innovaphone device is enabled.
  • For an other user language or cover file of a specific slave PBX such a configuration can be added with a PBX name configuration line.

Mail Configuration

The fax server includes an email server. To send emails to the faxserver SMTP authorization must be used with the configurable user and password.

  • User: The user for the SMTP authorization. It must be unique for all fax servers.
  • Password: The password for the SMTP authorization.
  • Administrator Mail Address: The administrator mail address for error notification mails.

SOAP Configuration

It is necessary to add a normal PBX user with at least CF/group rights and set password to use it for the SOAP login. The user must be in the same group as the fax gateway object and the group active flag must be set. To check the Fax license for users in slave PBX it is also required the SOAP login is available in all slave PBX.

  • PBX IP address: The PBX IP address for the SOAP connection.
  • Port: The port for the SOAP connection.
  • Dyn-PBX-Id: An Id if a dyn-PBX is used.
  • User: The user name for the SOAP login.
  • Password: The user password for the SOAP login.
  • HTTPS: Tick if HTTPS instead of HTTP is to use.
  • Fax User: The long name of the PBX gateway object.

Fax Configuration

  • Subscriber Id: The subscriber Id of the T.30 protocol, which will be sent with a fax.
  • Add User Number: If ticked the user number is appended to the subscriber id.
  • Subscriber Name: The subscriber name which will be printed within the header line of each fax page.
  • Max Call Tries: The maximum number a call tries, if a call is not successful.
  • Resend Delay: Delay in minutes after which a fax is resend.
  • Response Timeout: The timeout in seconds within the remote party has to response.

Texts

Customer specific texts can be configured language dependently here. The texts are used for the email correspondence with the users.

Covers

Own cover files can be uploaded, downloaded or deleted here. Once uploaded the cover file can be chosen within the server configuration. Only unused files can be deleted.

Database

Faxserver installs postgreSQL version 8.4 as database management system and creates the innovaphone-faxserver database to store the configuration and the fax job data. PostgreSQL is also available for other applications and any of them could create its own database. The default password is faxserver. It may be changed at the innovaphone Faxserver page under Config/Database.

There are tools that allow to connect to application databases remotely. It is first needed to configure the IP you are connecting from under Config/Database at the innovaphone Faxserver page. For the PgAdmin III it is important to use innovaphone-faxserver as service DB. The default login credentials are for the user innovaphone-faxserver with the password faxserver.

Backup and Restore

You can both manually and automatically backup the database and configuration files for the Faxserver application under Administration/Backup in the application platform.

Configuration details for the update server can be found here.

Configuration Files

saveinnovaphone-faxservercfgs is the command used to automatically save the cover page files with the Command File. Other configuration files must not be saved because the configuration of the innovaphone Faxserver is in the Faxserver database.

Data

saveinnovaphone-faxserverdb is the command to automatically backup the whole innovaphone Faxserver database with the Command File. The Faxserver database also includes the Faxserver configuration, but not the cover page files.

Logs

saveinnovaphone-faxserverlogs to save log files with the Command File.

Appendix

Tools

NetDrive

NetDrive is a useful webdav client which can be used to access webdav of the innovaphone Linux Application Platform.

PGAdmin

PGAdmin is an administration tool for PostgreSQL databases.

Putty

Putty is SSH client to connect to the Linux Application Platform.

Related Articles