1
FaxCore eV5 – Services Configuration
Version 2.0.0
FaxCore eV5
Services Configuration Guide
BR20130226
2
FaxCore eV5 – Services Configuration
Contents
Disclaimers ........................................................................................................................................................ 3
Support .............................................................................................................................................................. 4
U.S. & Europe ................................................................................................................................................. 4
Asia Pacific ..................................................................................................................................................... 4
Introduction ....................................................................................................................................................... 5
FaxAgent ........................................................................................................................................................ 5
DispatchAgent ............................................................................................................................................... 7
RenderAgent.................................................................................................................................................. 7
SMTPGatewayAgent ...................................................................................................................................... 8
GatewayAgent ............................................................................................................................................... 9
BR20130226
3
FaxCore eV5 – Services Configuration
Disclaimers
This document outlined the FaxCore services configuration for FaxCore eV5.
Default settings for FaxCore services are preconfigured to work in a standalone installation environment.
They are meant to plug and play. This guide provides the outline and definition for each FaxCore services.
++
This document will be updated from time to time. Please check with FaxCore Support for the latest
updates.
FaxCore and FaxCore eV5 are registered trademarks of FaxCore, Inc.
Windows is a registered trademark of Microsoft Corporation. All other trademarks are the property of their
respective owners.
BR20130226
4
FaxCore eV5 – Services Configuration
Support
FaxCore customers are encouraged to purchase a FaxCore Support Contract which provides them with
unlimited telephone, email and web based product support from Monday to Friday 8.00 am to 5.00 pm
Mountain time (GMT -7). FaxCore Partners can also provide on-site support and training when needed.
FaxCore Support Contract holders are entitled to all FaxCore product service packs and upgrades at no
additional charge.
Web Support: www.faxcore.com
This site contains technical information as well as a list of frequently asked questions.
U.S. & Europe
Email Support: Email support is available at support@faxcore.com
Phone Support: FaxCore support technicians can be reached at +1 (720) 870 2900
Asia Pacific
Email Support: Email support is available at support@faxcore.com.my
Phone Support: FaxCore support technicians can be reached at +60 (3) 3324 3226
BR20130226
5
FaxCore eV5 – Services Configuration
Introduction
There are five Windows Services in FaxCore eV5 installation. Each service is responsible for specific
task and they are required to run on start up. They are:





FaxAgent
DispatchAgent
RenderAgent
SMTPGatewayAgent
GatewayAgent
Each service will have its own configuration file. The configurations contain settings required by
the respective service during start up to initialization. The settings are pre-configured during
installation but you can change the value according to your requirement.
FaxAgent
This service handles the physical board, FoIP and hybrid (EtherFax) fax driver. It is responsible for all
inbound and outbound fax transmission.
File name: FaxAgent.exe.config
Section
Key Name
Virtual/EtherFax
Address*
Virtual/EtherFaxDR
Account*
User*
Password*
EtherFax user account
EtherFax username
EtherFax password
AgentID
Secondary FaxAgent
unique ID
EtherFax service address
Address*
Account*
User*
Password*
CountryCode*
AreaCode1
ReceiveFormat
AgentID
EtherFax user account
EtherFax username
EtherFax password
Your country code
Your area code
Instruct the fax driver to
receive incoming faxes
in G4/G3 compression
Instruct the fax driver to
resume from previous
page for fail outbound
faxes.
Auto convert incoming
faxes to fine resolution
FaxAgent unique ID
PLK
DriverType*
FaxAgent internal serial
Tells FaxAgent which fax
AutoResume
AutoAdjustResolution
appSettings
BR20130226
Description
EtherFax service address
Value
https://na.connect.etherfax.net/etherfax/
etherfax.svc
EFAX-0000-0000 (sample value)
Jsmith (sample value)
[encrypted password]
[value will be provided by FaxCore during
FaxAgent registration]
https://na.connect.etherfax.net/etherfax/
etherfax.svc
EFAX-0000-0000 (sample value)
JDoe (sample value)
[encrypted password]
44
01752
G3 or G4
0 = disable
1 = enable
0 = disable
1 = enable
[value will be provided by FaxCore during
FaxAgent registration]
[ignore]
Brooktrout
6
FaxCore eV5 – Services Configuration
driver to load
ChannelsIni
LogLevel*
LogFileSize*
LogFileCount*
Server*
Port*
BarCode
CountryCode*
AreaCode1
DTMFTerminator1
ReceiveFormat
Buffer
AutoResume
AutoAdjustResolution
1
*
optional
required
BR20130226
How many channels to
initialize on startup
Service logging filter
Service logging file size
Maximum log files to
generate. When
maximum log file
reached, oldest file will
be overwritten
FaxCore server URL. If
net.tcp is used, you need
to find out the specific
port is used in IIS for this
protocol.
FaxAgent service port
Barcode OCR setting
Your country code
Your area code
Specify a custom DTMF
termination value. This
is to allow user to
specify custom DTMF
termination value if PBX
is using nonconventional terminator
Instruct the fax driver to
receive incoming faxes
in G4/G3 compression
Set buffer size for
FaxAgent
Instruct the fax driver to
resume from previous
page for fail outbound
faxes.
Auto convert incoming
faxes to fine resolution
Eicon
FaxBack
EtherFax
[ignore, value will be provided by license
manager]
ALL
ERROR
DEBUG
10240KB [=10MB]
10
http://localhost:2372/webservices/wfFaxA
gent.svc
or
net.tcp://faxcore_IP:2376/webservices/wf
FaxAgent.svc
2373 [do not change]
[ignore, value will be provided by license
manager]
44
01752
Leave blank when not in use.
# [Sample value]
G3 or G4
8192 [default value in bytes]
Value must be in multiple of 4KB, max
value is 64 KB
0 = disable
1 = enable
0 = disable
1 = enable
7
FaxCore eV5 – Services Configuration
DispatchAgent
This service handles all time based schedule processing such as fax scheduling queue, fax purging and user
account auto-sync.
File name: DispatchAgent.exe.config
Section
Key Name
appSettings
Interval*
SyncInterval*
PurgeInterval*
Server*
Port
PurgeDebug*
Description
Interval setting for
the service to ping
server message
queue
Interval for user
auto-sync
Interval for data
purge
FaxCore server URL.
If net.tcp is used, you
need to find out the
specific port is used
in IIS for this
protocol.
Port value for service
Purge fail safe
setting. This is set to
false by default to
prevent fax record
removed accidentally
Value
5 [value in seconds]
2 [value in minutes]
5 [value in minute]
http://localhost:2372/webservices/wfDispatcher.svc
or
net.tcp://faxcore_IP:2376/webservices/wfDispatcher.
svc
2372 [ignore]
True = set purge process to simulate mode
False = set purge process to production mode.
1
*
optional
required
RenderAgent
This service handles all rendering process.
File name: RenderAgent.exe.config
Section
Key Name
appSettings
Timer*
DitherMode
PageType
OutputType
Resolution
Timeout*
Mode
ManipulateTif*
EnableColorImg
PDFRenderingEngine*
BR20130226
Description
Service interval
value.
Obsolete setting
Obsolete setting
Obsolete setting
Obsolete setting
Rendering process
timeout value
Obsolete setting
Process or skip TIF
attachment
Obsolete setting
Choose render
engine to process
PDF file type
Value
5 [value in seconds, min value is 2 seconds]
[ignore]
[ignore]
[ignore]
[ignore]
30 [value in seconds, if constantly render high page
count files, set higher value]
[ignore]
1 = process all TIF files
0 = ignore TIF files [TIF files submitted must be in fax
format]
[ignore]
Aspose – use FaxCore internal rendering
Ghostscript – use third party rendering component
8
FaxCore eV5 – Services Configuration
Server*
FaxCore server URL.
If net.tcp is used,
you need to find out
the specific port is
used in IIS for this
protocol.
http://localhost:2372/webservices/wfRendering.svc
or
net.tcp://faxcore_IP:2376/webservices/wfRendering
.svc
1
*
optional
required
SMTPGatewayAgent
This service handles all email to fax transaction. Please refer to SMTP Connector documentation for further
information on how to set up email to fax.
File name: SMTPGatewayAgent.exe.config
Section
Key Name
SMTPGateway baseDirectory*
/
SMTP
inboxDirectory*
treatEmailBodyAsDocument*
faxAsRaw*
inBodyAuth*
maxAttempts
attemptIntervalSec
removePrefix1
bufferSize1
IMESEQ
BackupTimerInterval*
DoubleByteAddress*
faxExtension1
BR20130226
Description
Based working directory
for the service
Value
xgateway\smtp
This is the folder where
SMTP listener drop
outgoing email
Convert email body to
separate attachment or
set email body to cover
page note section
Fax address collect from
email will be treated as
raw fax format
Enable service to scan
for authentication token
in email subject
xgateway\smtp\inbox
Obsolete setting
Reserved setting for
future application
Remove prefix from
recipient email address
Set buffer size for
service
[ignore]
30 [value in seconds]
Reserved setting for
future application
Wait interval when
processing large email
file
Parse all email recipient
as double byte value
Check email recipients
for extension value and
replace with preset
value
0 = email body to cover page note
1 = email body as separate attachment
0 = treat as standard fax format
1 = treat as raw fax format
0 = disable
1 = enabled
FAX [case-sensitive]
16384 [default value in bytes]
Value must be in multiple of 4KB, max
value is 64 KB
[ignore]
500 [value in milliseconds]
0 = disable
1 = enable
x|, [sample value]
ext value | replace with preset value
9
FaxCore eV5 – Services Configuration
Server*
SMTPGateway
Agent.Properti
es.Settings
SMTPGatewayAgent_FXAPI_
wfApi
FaxCore server URL. If
net.tcp is used, you need
to find out the specific
port is used in IIS for this
protocol.
FaxCore API URL
http://faxcore_IP:2372/
or
net.tcp://faxcore_IP:2376/
http://localhost:2372/webservices/wfap
i.asmx
1
*
optional
required
GatewayAgent
This service handle all file gateway processing. File gateway is a FaxCore production add-on module.
Embedded codes gateway is available as standard across all FaxCore editions. For more detail please
contact your sales rep.
File name: GatewayAgent.exe.config
Section
Key Name
Description
appSettings
Server
FaxCore server URL. If net.tcp is used, you
need to find out the specific port is used in
IIS for this protocol.
Value
http://localhost:2372/webservices/wfDi
spatcher.svc
or
net.tcp://faxcore_IP:2376/webservices/
wfDispatcher.svc
1
*
optional
required
For detail configuration, please refer to “File Gateway and Custom Config” documentation. If you do not
have a copy, please get in touch with FaxCore support.
BR20130226