Chapter 1 – Introduction Congratulations on your purchase of the NET SatisFAXtion IP Port Server from FaxBack, Inc. Many years of effort have gone into developing a system that will give you the functionality you desire today and a platform that can accommodate your growing needs in the years to come. How to Use This Manual To make the guide clear and easy to read, symbols have been used to identify information that is critical to the operation of your FaxBack system.
Support E‐mail support@faxback.com Support Telephone (503) 597‐5360 Please be prepared to fully describe your hardware and network setup, the conditions under which the problem is occurring and the effects of the problem.
Chapter 2 – Server Overview The NET SatisFAXtion IP Port Server enables telecom service providers to offer e‐fax services to their customers. It is robust and highly scalable up to DS3 (672 ports) densities. Its modular nature allows it to be adapted to fit nearly any network architecture.
Connection Server The Connection Server is the component that clients log in to in order to send and receive faxes, and administrators connect to in order to manage user accounts, inbound DID routing assignments, and send routing rules. It provides session tracking, authentication, quota and usage tracking functions. Port Server The Port Server is the component that facilitates SIP+T.38 “VoIP Fax” connections with media gateways.
The HTTPS Proxy, Connection Server, Port Server, and SQL Server are all installed on a single server. This is sufficient for small installations of 24–96 ports. Multiple Servers Figure 2‐3: Multiple Server Installation The HTTPS Proxy and SQL Server are installed on separate servers. The Connection Server and Port Server may be installed on separate servers, and there may be multiple Port Servers. This is the typical installation for a regional provider.
Scalability & Reliability By default, the Connection Server will load‐balance amongst the configured Port Servers. Port Servers can also be brought on‐line and dynamically added to routing groups in case of failure. Both Connection Servers and Port Servers can be disabled for maintenance without disrupting connected clients or their faxes. While disabled, that particular server will refuse any new faxes, and any logged in clients will be migrated to another Connection Server.
Firewall considerations The HTTPS Proxy needs only TCP port 443 (https) open to the Internet. From the proxy to the Connection Server & Port Server components, each one’s corresponding port must be open. These ports are configurable but default to 60 (CS) and 61 (PS).
Chapter 3 – Client Overview What features does the Port Server bring your users? NET SatisFAXtion IP Port Server leverages your existing VoIP network to allow your users to send and receive faxes from their desktops transparently. Your users can also continue to use their existing fax machines without the need for a dedicated extra phone line.
Chapter 4 – Port Serve er Installat ion License Ke ey: Each Port Se erver installation will be issued an individual product keyy. This key conttrols the numb ber of ports each Port Server caan be configureed for, as well as enabling licensed featuress. Keep this key in a safe placce and h Port Server iss using which key. k note which Connection n & Port Serrver Installation n from CD: Run setup.exe in n the root of th he CD to begin n the installatio on.
The Next button b will rem main grayed out until a valid Product P Key is entered. Oncee you have enteered the key, click c Next. w you to configgure which SIP P+T.38 media gateway g this Po ort Server will use. You may also a The next sccreen will allow configure a SIP Proxy as well w as a SIP Reegistrar here. You can brrowse the local LAN segmentt for VoIP Gateway devices byy clicking Brow wse. The Browsse feature will only be able to discover Audio oCodes and Cissco devices on the same locaal network.
Next, a listt of configured ports is displayed. This allow ws the per‐portt configuration n of default CSIID and dial preefix. Certain ports can also be e reserved for inbound or outtbound traffic. Figure 4‐4: Settingg Individual Port Settings S w be able to choose if this installation will be a Connecttion Server, a Port P Server, or both. The HTTTPS Next, you will Proxy and the SQL Server is also configured from thiss screen.
Figurre 4‐5: Configuringg Port Server Paraameters HTTPS Proxxy Check the “Http‐proxy on n IIS” checkboxx and enter thee fully qualified d domain name of your IIS seerver, followed d by o the nsps application. The default will be something s similar to: the path to https://seccure.netsatisfaaxtion.com/nsp ps/nsps.aspx Once entered, you will se ee the “Client access a Urls” fo or the Connectiion Server and d Port Server ch hange to point to the HTTPS Proxy.
SQL NET SatisFA AXtion Port Se erver uses the database d for user authenticaation and fax ro outing (NSPorttServerMain), and a billing (NSP PortServerBillin ng). Each table may be independently confiigured and nam med, and may reside in a diffferent database, in the same o a completely separate dattabase server. database, or even each on Figure 4‐‐6: Port Server Databases Figure 4‐7: SQL Database Pro operties Modify eacch entry to poiint to the correect SQL Server and configure authentication as needed.
RADIUS One or more RADIUS servers may be specified. The Port Server will use RADIUS calls to authenticate users, identify ownership of DIDs, and for call logging (CDRs). Please see the Port Server RADIUS Support document for more information about implementing RADIUS. The following tables may be implemented with RADIUS: • • • AccountsDb ReceiveDb BillingDb Note that using RADIUS does not completely remove the need for SQL.
Open IIS Manager and locate the Default Web Site. Right‐click on it and create a new Virtual Directory. Its Alias will be “nsps”: Next, choose the directory the HTTPS proxy is installed in. The default is C:\Program Files\NSPortServer\Http Proxy\. Allow the following permissions: Read, Run scripts (such as ASP). Finish the Wizard. Next, right‐click on the nsps virtual directory and open its properties. Next, go to the ASP.NET tab and verify the ASP.NET version used is 2.0.50727.
Next, go to the Virtual Directory tab, click on Configuration, then the Options tab, and disable both “enable session state” and “enable buffering.” Insure ASP.NET v2.0.50727 is allowed in IIS. Navigate to Web Service Extensions. Select ASP.NET v2.0.50727 and click the Allow button.
It may be necessary n to manually m registeer ASP.NET 2.0 0 with IIS. Run C:\WINDOW WS\Microsoft. .NET\Framewo ork\v2.0.5072 27\aspnet_re egiis.exe /i. Configuringg the HTTPSS Proxy Routting Table If the proxyy is installed on the same serrver as NET SattisFAXtion IP Port P Server, you u may use the GUI within Faxx Hardware Setup to configgure the routin ng table: Figure 4‐8: HTTTPS Proxy Configguration eed to be editeed manually.
http://conserver.netsatisfaxtion.com:60/HttpService.api http://portserver.netsatisfaxtion.com:61/HttpService.api Simply update these URLs to reflect the internal names/IP addresses and ports of the Connection Server and Port Server. These names need only be resolvable from the HTTPS Proxy server.
When running the NET SatisFAXtion Port Server’s Fax Hardware Setup program, it will use the credentials of the current user using Windows Authentication. In order to make use of its automatic database and table creation features, the current user must have sufficient permissions on the SQL Server (e.g. a member of the Domain Admins group). NET SatisFAXtion Port Server will run as the SYSTEM account. This is important because if a remote SQL Server is in use, it will refuse the Connection Server by default.
ServersDb NSPortSeerverMain SERVERSS_TABLE PS / CSS PS – Port Server module CS – Co onnection Server module Specific infformation about these tabless, their column ns, and the datta they contain n may be found d in Chapter 9 – Integration n. RADIUS 4‐9: Porrt Server Database es configured for RADIUS 4‐10: RAD DIUS Database pro operties Set Accoun ntsDb and RcvR RoutingDb to port p 1812. Set BillingD Db to port 1813.
Chapter 5 – Additional Components SMTP Gateway for Fax‐To‐Email Requirements Installation Managing Account–Email Associations Email‐to‐Fax with the SMTP Gateway and the Document Conversion Server The conversion process; advantages and limitations Troubleshooting conversion issues
Chapter 6 – Administrration and Configurati C on 6 NET SatisFAXttion Port Server Manager 6‐1: M For “Manaage Accounts”: please see Chapter 7 – Acco ounts and Clien nts, page 30. For “Manaage Send Routing”: please seee Send Routingg, page 37. Server Passswords There are three t passwords that are useed by the Port Server, beyond d the normal account a passwo ords. These aree Admin, Serrver, and Billing passwords.
Connection n Server Pro operties General Ta b Name: A human‐readabl h e name for thiis Connection Server. S Admin passsword, Serverr password: Seee Server Passw words on page 23. Catch‐all DID: D This allowss an alternate character to be used as the catch‐all c DID. The T default is “*” “ (asterisk). Diagnosticc log level: The e level of detail to log to …\NSSPortServer\LLogs ‐ NSPSConne ectionServer\ \IPFS[%date% %].log.
For “Group ps”: please see e Login and Recceive Routing Groups G on page 35 Accept CDRs: Whether th his Connection n Server will acccept Call Detail Records from m Port Servers when they aree d to send CDRs to a Connectio on Server. configured Include faxx device info: Save S the comp pleted fax’s CASS Tag List with the CDR. This includes somee useful troublesho ooting information such as V2 21 and ECM errror counts. Billing password: See Server Passwords on page 23.
For “Alertss”: please see Alerts A on page 29. These settings control monitoring by th he Port Server Management application. Unlike the otherr Connection Server S nt Port Server Management M a application. Properties tabs, these are local settingss to the curren he server: Disaabling this prevvents the Manaagement appliccation from co onnecting to th he server at all.. Monitor th Seconds be etween updattes: How often to poll the serrver’s performaance counters and status.
Port Serverr Propertiess Name: A human‐readabl h e name for thiis Connection Server. S Admin passsword, Serverr password: Seee Server Passw words on page 23. For “Group ps”: please see e Login and Recceive Routing Groups G on page 35 Diagnosticc log level: The e level of detail to log to …\NSSPortServer\LLogs ‐ NSPSPPortServer\IPPFS[%date%].log. Levels high her than Brief are a only needeed for diagnosttic purposes an nd will cause lo og files to grow w rapidly.
Log targetss: Call Detail Records can be sent directly to the databasee, or to a Connection Server if i the Port Servver and the Co onnection Servver do not share databases. The Conneection Server “iinvolved with the t fax session n” is the Conneection Server where w the send ding or receivin ng client is loggged in. When using a billing password, thee Connection Server S will inform the Port Seerver what its billing b password is i during call se etup. For “Alertss”: please see Alerts A on page 29.
These settings control monitoring by th he Port Server Management application. Unlike the otherr Connection Server S Properties tabs, these are local settingss to the curren nt Port Server Management M a application. Monitor th he server: Disaabling this prevvents the Manaagement appliccation from co onnecting to th he server at all.. Seconds be etween updattes: How often to poll the serrver’s performaance counters and status.
Chapter 7 – Accounts and Clients The Port Server is designed to route faxes through it in real time, similar to a PBX or other telephone equipment. Therefore an account must be currently logged in to send or (more importantly) receive faxes. In the case of multiple Connection Servers, the account can only be logged in to one of the Connection Servers. The minimum required for a valid account is an AccountId and a Password.
Figure 7‐1:: Account Properties tabs
Account Identification Beyond AccountId and Password, there are some additional fields that may optionally be populated, and are useful for storing business‐specific information for each user. These are Customer, Source, and CDR Info. These are free‐ text fields that are limited to 64 characters each. All three are also logged to the BillingDb for every fax sent or received by the account.
Load‐Balance Membership in a Load‐balance Group is indicated by setting the Failover/Alternate/Load‐Balance account to the Load‐balance Group.
Chapter 8 – Fax Routing Call Flow Overview Inbound Faxes 1. 2. 3. 4. 5. 6. The Media Gateway sends a SIP INVITE to one of the Port Servers to establish a call. The Port Server consults its list of Connection Servers – the Receive‐routing Group. The Port Server contacts the lowest‐cost Connection Server and passes it the call’s destination DID to determine if that Connection Server has a logged in account who can take the call.
Login and Receive Routing Groups Figure 8‐1: Inbound Fax Routing, showing how an inbound fax finds the logged in client. There are two types of groups that a Connection Server can be part of, the account‐login group and the receive‐ routing group. Accounts are associated with an account‐login group, meaning that a client using that account can connect to any Connection Server in that account‐login group.
Figure 8‐2: Account, Connection Server, S and Port Server Properties windows w showingg groups Account‐loggin Groups Clients con nsult their asso ociated Accoun nt‐login Group to determine which w Connecttion Servers they may use. A given Connection n Server may only o be in one Account‐login A Group. A given n account mayy only be in onee Account‐login Group. c have a cosst associated with w it.
Receive‐rou uting Group ps Port Servers consult their Receive‐routing Group to determine d whicch Connection Servers to usee, to find a loggged in o receive a fax. A given Conneection Server may m only be in one Receive‐ro outing Group. A given Port Server account to may only be b in one Receive‐routing Gro oup. Each Connection Server can c have a cosst associated with w it.
Starts with: Matches if the input number starts with this text. Ends with: Matches if the input number ends with this text. Contains: Matches if the input number contains this text anywhere. Matches regex: Allows number matching using a regular expression. For information on the regular expression language, see Microsoft’s documentation here: http://msdn.microsoft.com/en‐us/library/hs600312.aspx.
Chapter 9 – Integration Accounts & DID management Billing Management Send & Receive Routing Multiple Media Gateways The Port Server can be configured to send faxes via multiple media gateways. This is a registry setting. Note that these settings can only be used with media gateways that do not require authentication, as per‐gateway usernames and passwords cannot be specified. Navigate to [HKEY_LOCAL_MACHINE\SOFTWARE\FaxBackPortServer\IP_FAX]. Remove the existing key sip_remote_ip_address.
Chapter 10 – Growing the Port Server Adding New VoIP Gateways or SIP Trunks It is recommended to have a dedicated Port Server for each VoIP connection. Adding New Connection or Port Servers When installing a new Connection Server or Port Server, it will automatically add itself to the server list in the ServersDb. By default it will be disabled, and will not accept new connections. When it is fully configured, enable it and it will begin to accept traffic.
Chapter 11 – Disaster Recovery Hot‐Swap Start the replacement server and disable the server that will be taken out of service. Wait for all sessions to complete on the server to remove. In the case of a Connection Server, wait for all clients to migrate to the new server. Finally, stop the server service. Failover Failover will be automatically handled when multiple Connection Servers and Port Servers are used.
Chapter 12 – Testing, Validation & Troubleshooting Initial Testing Install the SDK Client, and configure it to use your HTTPS client URL. Use the default “account” account which is by default associated with the fallback DID “*”. Attempt to send a fax. Attempt to receive a fax. HTTPS Proxy Self‐Signed Certificates For testing, you can use self‐signed certificates for the HTTPS Proxy.
Chapter 13 – Client Documentation Service Connector for Microsoft Fax Desktop installation Small Business Server Installation Fax Machine Client for FXS ATAs Outlook Client & FaxOut Printer Local document conversion with the FaxOut printer Automatic addressing The NET SatisFAXtion Small Business Server as a Client
Chapter 14 – Internals SQL Tables NSPortServerMain – ACCOUNTS_TABLE CREATE TABLE [dbo].
GO ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [PasswordStr] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [Customer] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [Source] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [CDRInfo] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [RcvEmail] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ((0)) FOR [RcvFormat] ALTER TABLE [dbo].
ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ((‐1)) FOR [SndSecsLeft] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ((‐1)) FOR [RcvSecsLeft] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ((‐1)) FOR [SndCfgSecsLeft] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ((‐1)) FOR [RcvCfgSecsLeft] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [AccountCSGroup] ALTER TABLE [dbo].[ACCOUNTS_TABLE] ADD GO DEFAULT ('') FOR [RuleGroup] ALTER TABLE [dbo].
NSPortServerMain – SERVERS_TABLE CREATE TABLE [dbo].
ALTER TABLE [dbo].[SERVERS_TABLE] ADD GO DEFAULT ('') FOR [RawXml] ALTER TABLE [dbo].[SERVERS_TABLE] ADD GO DEFAULT ('') FOR [Version] ALTER TABLE [dbo].[SERVERS_TABLE] ADD GO DEFAULT ('') FOR [SysInfo] NSPortServerMain – SND_ROUTING_TABLE CREATE TABLE [dbo].
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY] GO
Chapter 15 – Error Codes 0x6D00 – IPFax Driver 6D2F Bad open ring 0 / kernel mode driver: There is another instance of the IPFax driver already loaded, or the Windows account attempting to load the driver does not have Administrative permissions. 6D47 WsaSendTo error – The gateway address is not a valid IP address. 6D48 SIP Invite sent 7 times with no response: The gateway did not respond to SIP Invite requests. Check the configured gateway IP address, and any firewall in between.
using a SIT tone. Listen to the RTP stream, or the WAV file in the Queue directory to determine what audio is being received. 6D7A Ring back detected with no answer: Call was not answered in the configured time period. The timer is 45 seconds. 6D7B Fast busy tone detected: The number is not in service or the call has been rejected at a point beyond the TDM network. A destination number on a PRI, T1 or DID trunk when the trunk is down can result in a fast busy.
721F Cause 31, Normal unspecified: The TDM network rejected the call, or terminated a connected call with a Q.850 cause code 31. Q.850 remarks that “call failure information indicating the failure of a call due to the lapse of a timeout or a fault not covered by specific causes (examples: expiry of timers Q.764 not covered by specific causes, release of interconnected circuit, etc.).” 7222 Cause 33, No circuit/channel available: The TDM network lacks capacity to handle this call.
Chapter 16 – Developer API The SDK Client Testing As an Engine API Documentation Overview ActiveX Interface File API Function and Data Tags Utilities Source Samples Diagnostics Driver Configuration / Registry Settings Redistributable Files Pluggable Fax Interface Error Messages
