Service Parameters

Service Parameters

Boomerang Notification Framework run-time parameters can be managed using MMC snap-in, see Administration section for more details.

Parameter Description Sample Values
db_interval_email Polling interval (seconds) to look for new e-mail jobs 10
db_interval_fax Polling interval (seconds) to look for new fax jobs 10
db_interval_file Polling interval (seconds) to look for new file jobs 10
db_interval_print Polling interval (seconds) to look for new print jobs 3
db_timeout_email Time to wait (seconds) before polling new e-mail jobs after database connection error has occurred 600
db_timeout_fax Time to wait (seconds) before polling new fax jobs after database connection error has occurred 600
db_timeout_file Time to wait (seconds) before polling new file jobs after database connection error has occurred 600
db_timeout_print Time to wait (seconds) before polling new print jobs after database connection error has occurred 600
dial_areacode Whether to dial a prefix (0 = No, 1 = Yes) for fax jobs 1
dial_prefix Dialing prefix for fax jobs 9
fax_server Default fax server to monitor progress notifications server_name.domain_name
monitor_timeout_fax Time to wait (seconds) before resuming listener for notifications from default fax server 60
retry_period_email Default time delay (seconds) before e-mail job will be next tried after a system error 1) 0
retry_period_fax Default time delay (seconds) before fax job will be next tried after a system error 1) 0
retry_period_file Default time delay (seconds) before file job will be next tried after a system error 1) 0
retry_period_print Default time delay (seconds) before print job will be next tried after a system error 1) 0
retry_times_email Default maximum number of e-mail job attempts after a system error untill success 1) 1
retry_times_fax Default maximum number of fax job attempts after a system error untill success 1) 1
retry_times_file Default maximum number of file job attempts after a system error untill success 1) 1
retry_times_print Default maximum number of print job attempts after a system error untill success 1) 1
smtp_auth_mode SMTP authentication mode for outgoing e-mail jobs (0 = none, 1 = clear text, 2 = encrypted) 2
smtp_auth_pass SMTP account password for outgoing e-mail jobs in case smtp_auth_mode is either set to 1 or 2 XXXXXXXX
smtp_auth_user SMTP account user for outgoing e-mail jobs in case smtp_auth_mode is either set to 1 or 2 domain\domain_user
smtp_from Default SMTP from e-mail address for e-mail jobs “Fuel9 Rapid Response” <info@fuel9.com>
smtp_host SMTP relay host for e-mail jobs internalmail.fuel9.com
smtp_log_on_error Whether to write an incoming raw SMTP message to Windows Application Log (0 = No, 1 = Yes) 0
smtp_port_in SMTP listener port for incoming e-mail jobs 25
smtp_port_out SMTP host port for outgoing e-mail jobs 25
smtp_replyto Default SMTP reply-to e-mail address for e-mail jobs info@fuel9.com
smtp_save_headers Whether to save extended SMTP headers for incoming e-mail jobs (0 = No, 1 = Yes) 2) 1
smtp_timeout SMTP connection timeout (seconds) for both incoming and outgoing e-mail jobs 60
sqlrs_format_email Default SQL RS rendition format for e-mail attachments 3) PDF
sqlrs_format_file Default SQL RS rendition format for file output 3) PDF
sqlrs_url_email SQL RS web service URL for e-mail jobs http://reports.fuel9.com/reportserver/reportservice.asmx
sqlrs_url_fax SQL RS web service URL for fax jobs http://reports.fuel9.com/reportserver/reportservice.asmx
sqlrs_url_file SQL RS web service URL for file jobs http://reports.fuel9.com/reportserver/reportservice.asmx
sqlrs_url_print SQL RS web service URL for print jobs http://reports.fuel9.com/reportserver/reportservice.asmx
threads_in_email Maximum number of incoming e-mail jobs handled concurrently 4
threads_out_email Maximum number of outgoing e-mail jobs handled concurrently 4
threads_out_fax Maximum number of fax jobs handled concurrently 4
threads_out_file Maximum number of file jobs handled concurrently 4
threads_out_print Maximum number of print jobs handled concurrently 4
twit_log_on_error
twit_oauth_consumerkey
twit_oauth_consumersecret
twit_oauth_token
twit_oauth_tokensecret
twit_proxy_port
twit_proxy_url
twit_save_headers
twit_status_filter track=canada
threads_out_sms Concurrent outbound workers limit, default -1 = automatically allocated -1
db_interval_sms SMS job polling interval, sec
db_timeout_sms Wait interval if system error occurs, sec
retry_times_sms Number of times to retry SMS job if errors
retry_period_sms Retry time increment, sec
sms_provider SMS services provider 0 (Twilio)
  1. Boomerang distinguishes between business- and system- level errors. Business errors occur when a job is not well-formed, i.e. missing printer path or e-mail recipients. In such cases retrying a job is not appropriate. System errors relate to connection failures and such. Retry-related parameters only apply for system-level errors.
  2. This parameter controls whether or not SMTP headers should be saved to IN_EMAIL_HEADER table.
  3. Other format options include: XLS (or EXCEL), PDF, XML, CSV, MHTML, HTM (or HTML, HTML3.2, HTML4.0), JPG (or JPEG), TIF (or TIFF), GIF, PNG, BMP, or IMAGE. For more info on formats refer to SQL RS documentation.

Service parameters can be changed at any time. There may be a short time delay before a new setting will take affect. Parameter values are stored in a binary form in SYSTEM_VARS table. You may list current service parameter values using the following SQL statement:

-- Service Parameters | Boomerang Notification Framework ----- 
select [Key], 
case [Type] when 1 then convert(nvarchar(4000),convert(int,Value)) 
            when 0 then convert(nvarchar(4000),Value) end Value
from SYSTEM_VARS order by 1

Result:

Key                           Value
----------------------------- ---------------------------------------------
db_interval_email             3
db_interval_fax               3
db_interval_file              3
db_interval_print             3
db_interval_twit              3
db_timeout_email              600
db_timeout_fax                600
db_timeout_file               600
db_timeout_print              600
db_timeout_twit               600
dial_areacode                 0
fax_server                    \\server\fax
monitor_timeout_fax           3
refresh_settings_interval     30
retry_period_email            60
retry_period_fax              0
retry_period_file             60
retry_period_print            0
retry_period_twit             60
retry_times_email             3
retry_times_fax               1
retry_times_file              3
retry_times_print             1
retry_times_twit              3
smtp_auth_mode                2
smtp_auth_pass                passwordforthesmtpuser
smtp_auth_user                smtpaccount@fuel9.com
smtp_from                     "What Can Boomerang Do" 
smtp_host                     smtpout.secureserver.net
smtp_log_on_error             0
smtp_port_in                  25
smtp_port_out                 25
smtp_replyto                  "What Can Boomerang Do" 
smtp_save_headers             1
smtp_timeout                  60
sqlrs_format_email            PDF
sqlrs_format_file             PDF
sqlrs_url_email               http://microsrv/ReportServer
sqlrs_url_fax                 http://microsrv/ReportServer
sqlrs_url_file                http://microsrv/ReportServer
sqlrs_url_print               http://microsrv/ReportServer
threads_in_email              -1
threads_in_twit               16777215
threads_out_email             -1
threads_out_fax               -1
threads_out_file              -1
threads_out_print             -1
threads_out_twit              16777215
twit_log_on_error             0
twit_oauth_consumerkey        ssN4abNWQ
twit_oauth_consumersecret     T1hUdfcSB002v2Jna6Y0
twit_oauth_token              186566175-uGDZDB5YDvJJsaU1N
twit_oauth_tokensecret        K6MF2Q
twit_proxy_port               0
twit_proxy_pwd                
twit_proxy_url                
twit_proxy_usr                
twit_save_headers             1
twit_status_filter            delimited=length&amp;track=sql
 
(59 row(s) affected)