Tikit eMarketing Solution

bubblemessengerSecurity

Nov 5, 2013 (3 years and 10 months ago)

139 views







Page
1

Tikit
eMarketing Solution

EBF

4.5
.3


Install & Configuration

Guide



Setup Notes & Prerequisites

................................
................................
................................
...

3

EBF Web Site Troubleshooting

................................
................................
............................

3

Acknowledgements

................................
................................
................................
...............

3

The EBF Server

................................
................................
................................
.......................

4

The Data Listener

................................
................................
................................
..................

4

The Message Processor

................................
................................
................................
.........

5

The Web Server

................................
................................
................................
....................

5

Server Installation

................................
................................
................................
.................

6

Basi
c Server Configuration

................................
................................
................................
...

6

Server System Configuration

................................
................................
................................

7

Server DataListener URL

................................
................................
................................
.

8

Link Tracking Configuration

................................
................................
................................

8

Message Categories

................................
................................
................................
...............

9

Advanced Server Configuration

................................
................................
..........................

10

Timer Control

................................
................................
................................
.................

10

Email Control

................................
................................
................................
.................

10

Server Security

................................
................................
................................
...............

11

SMTP Throttle

................................
................................
................................
................

12

InterAction Application Server Remapping

................................
................................
...

14

InterAction Application Server Authentication

................................
..............................

14

InterAction Application Server Communications Test
................................
...................

15

Providing Information for Web Analytics

................................
................................
......

15

Server Data Files

................................
................................
................................
.................

16

Server Housekeeping

................................
................................
................................
..........

17

HTML Emails

................................
................................
................................
.....................

17

EBF Web Site

................................
................................
................................
.........................

18

Server System Configuration

................................
................................
..............................

18

Required file system permissions

................................
................................
........................

18

Geographical Distribution Charts

................................
................................
.......................

19

Message Status Information

................................
................................
................................

19

EBF Client Programs

................................
................................
................................
............

20

Client Installation

................................
................................
................................
................

20







Page
2

Required file system permissions

................................
................................
........................

20

Basic Client Configuration

................................
................................
................................
..

20

Client Syst
em Configuration

................................
................................
...............................

21

Advanced Client Configuration

................................
................................
..........................

22

Configuring Contact Information Providers

................................
................................
...

22

InterAction Contact Information Provider Configuration Sets

................................
.......

24

ReAction Server 1.x integration

................................
................................
.....................

24

Configuring SMTP Sender option presets

................................
................................
......

25

Reading Sender Information from Active Directory

................................
......................

26

Configuring
Word content capture

................................
................................
.................

27

Configuring Insert Image Options

................................
................................
..................

27

Configuring system email handling

................................
................................
................

28

Bounceback license Information

................................
................................
....................

28

Confi
guring Default Content

................................
................................
...............................

28

Command Line Arguments

................................
................................
................................
.

29

Plugin Configuration

................................
................................
................................
.............

30

InterAction Activity Plugin

................................
................................
............................

30

Spam Assassin Integration Plu
gin

................................
................................
..................

31

Hyperlink Checking Plugin

................................
................................
............................

31

“View as a Web Page” Plugin

................................
................................
........................

32

Integrating with the InterAction Web Client
................................
................................
......

34

Enabling the Integrati
on

................................
................................
................................
.

34

Implementing the Integration

................................
................................
.........................

35

Licensing
................................
................................
................................
................................
.

36







Page
3

Setup
Notes &
Prerequisites



EBF 4.5
client
components require the Microsoft .NET 3.0 framework
or later
to
have be
en previously installed.



EBF 4.5 server components
(
the
EBF service
and

the EBF web site)
require the
Microsoft .NET 3.0 SP1
(or 3.5SP1)
framework
or later
to have been
previously
installed.



The EBF web site requires IIS to have been previously installed a
nd enabled.



If installing the EBF web site on a computer running Windows Server 2003 or XP,
follow these additional steps before installing the EBF software.

1.

Open the Internet Services Manager

2.

Right
-
click on the Default web site and click “Properties”

3.

Clic
k on the ASP.NET tab

4.

Select 2.0 as the ASP.NET version



The

EBF web site
requires
the Microsoft ASP.NET AJAX extensions
to have been
previously installed. An installation package and further details are available on the
Microsoft web site, at
http://www.microsoft.com/downloads/details.aspx?FamilyID=ca9d90fa
-
e8c9
-
42e3
-
aa19
-
08e2c027f5d6&displaylang=en
.

EBF Web Site Troubleshooting

The f
ollowing table describes various errors that may be displayed on attempting to access the
EBF web site.

An error page is displayed in the browser
including

the message “Parser Error
Message: Unrecognized attribute 'type'”
=
䙯汬潷=t桥h獴数e⁤整~il敤⁡b潶攠eo
r⁳整ti湧=
㈮〠慳=t桥⁤敦慵~t⁁卐⹎b吠q敲獩潮o
=
^渠敲ror⁰慧攠i猠si獰l慹敤⁩渠n桥⁢r潷s敲=
including the message “
偡r獥r⁅rror=
䵥獳慧攺⁃潵l搠湯to慤⁦il攠潲⁡獳敭扬y=
D卹獴敭⹗K戮䕸瑥湳i潮猬o
ser獩潮㴱⸰⸶㄰㈵K〬⁃畬t畲攽e敵er~l
”.
=
f湳n慬l⁴桥⁁h倮mbq⁁g^u⁅=
t敮獩潮猠ss=
摥dcrib敤⁡扯b攮
=
q桥⁅=䘠獩t攠i猠si獰l慹敤Ⱐ扵b⁴桥⁳敲v敲=
捡湮nt⁢攠r敡捨c搠慮搠t桥hm敳獡g攠e湣n畤敳W=

䕸捥btio渺⁃潵l搠d潴=l潡o⁴y灥p
D卹獴敭⹓敲vi捥䵯摥l⹃h~湮敬sK
=
o敭潴故湤灯entj敳獡g敐r潰ortyD
K
=
䕮獵be‮=䕔=㌮こPㄠi猠i湳t慬l敤渠t桥h
獥rv敲
K
=
Acknowledgements



This product includes functionality provided by the HtmlAgilityPack. Further
information is available at http://www.codeplex.com/htmlagilitypack.



This product
integrates with

GeoLite data created by MaxMind, available from
http://www.ma
xmind.com.







Page
4

The EBF Server

In a typical EBF (Email Broadcast Framework) installation,
one computer within the network
will be running as an EBF Server. T
he EBF
S
erver accepts
email broadcast packages
submitted
over the network
from client
computer
s, builds

the
separate emails to each
recipient, and
submits the emails for delivery either via an SMTP server
,

or using SMTP
Express.

The
EBF Server

is
hosted
as

a Windows Service.


The diagram below shows a typical arrangement of EBF components.



The
Data

Liste
ner

The
EBF Server

listens for incoming
requests from EBF clients

on a configurable TCP port
and endpoint.







Page
5

EBF client programs such as E
-
Merge 4 must be configured with the appropriate URL to the
listener on the server so that they can
integrate with the
server for
email broadcast submission
and other functionality
.

See the
section on Basic Client Configuration later in this document

for information on how to do this.

When the server receives an incoming email broadcast package, it will first verify that t
he
package contains enough information for the server to be able to deliver it. Once the
listener

has accepted the message, it
passes

the message
on for processing.

The Message Processor

The message processor
manages

a queue of

email broadcast packages tha
t are awaiting
delivery.
When it processes an email broadcast package, it handles the generation and
delivery of emails.
Only one email broadcast package will be processed at a time.

Whenever a

n
ew

email broadcast package is received by the processor, it g
enerates an
internal
acknowledgement email back to the user who submitted the package
,

as confirmation that it
has been received. The email will also include a link that the user can click on at any time to
check the status of their broadcast.

The message
queue itself is held in memory, but messages are saved to disk on the server
when they are received and at regular intervals as they are being processed. Message files are
saved using the un
ique message ID as the filename,

with

the extension .EBF.

The serv
er stores message files in
various

sub
-
directories under a configurable base location.
The table below lists the different message directories.


Working

Messages that are in the queue or are currently being delivered

Done

Me
ssages that have been completed

(including those that were cancelled part
way through).

Cancelled

Messages that were cancelled without any of the recipient emails being
generated.

Approvals

Messages that are awaiting approval before being placed in the queue for
delivery.

Parked

Mess
ages that were received but
are permanently unable to be processed for
some reason.

Archive

Messages that have been archived.

Queued or partially
completed email broadcasts will be saved to the “working” directory
whenever the service stops.

When the s
erver starts, it will
read any existing message files in
the “working” sub
-
directory and

add

them
back
to the queue for processing. In this way the
service can be stopped an
d started at any point without t
he risk of emails being lost or
duplicated.

The Web

Server

The
EBF
server tools include a web site
(hosted by IIS)
that allows browser based access to
information about messages on the server
, and queue management functionality (for
administrators)
.

This web site is typically installed on the same machine
as the EBF Server
itself, although this is not a requirement.

By default t
he general status page is accessible at http://<server>
/EBFWeb
.








Page
6

Server
Install
ation

1.

Run the install program, read and accept the license agreement, and select the
required install l
ocation.

2.

Select the features you wish installed. Note that initially the server features will be
de
-
selected.
If you
don’t
wish to install the
client

software on this
computer
, deselect
the

Client
Tools” feature

in
the Custom Setup dialog



but note that
you will
generally want to install the Configuration Editor tool, to allow the server to be
configured.

3.

Complete the installation.

By default the EBF Service

must be started manually. If you require the EBF Serv
ice

to start
automatically when the computer
starts, go to the Services view from the Windows Control
Panel, locate the “
Tikit
EBF

Server” entry and modify the Startup type setting to Automatic.

NOTE: You should complete the basic configuration detailed in the next section before
starting the server
for the first time
.

Basic
Server
Configuration

1.

From the Start

menu, choose Programs/Tikit/eMarketing Solution
/
EBF
Configuration
Editor

2.

Click the “New” button on the toolbar

3.

Click the key icon on the child node under the Licenses node.

4.

In the panel on the
right, enter the company name from the license information.

5.

For each license key that you have, i
n the Add License frame enter the module name,
the number of users (if specified


leave blank or enter a zero for a site license), and
the license key itself;

then click the Add button.

You should

add

all applicable license
s


see the section on Licensing later in this
guide.

6.

You can remove a previously entered license by right
-
clicking on it and choosing
Remove License.

7.

Right click on the Delivery Methods node

and choose “New…”

8.

In the Class dropdown in the right
-
hand panel, choose


“Tikit.EBF.DelMethodSMTPImmediate”.

9.

Click the “Configure…” button.

10.

If delivery should be made via an SMTP server:

Click the


Send via an

SMTP server”
radio button
, and enter connecti
on information
to the SMTP server.

11.

If delivery should be made via SMTP Express:

Click the

“Send
using

SMTP Express”

radio button
, and enter the path to the SMTP
Express installation directory.

12.

Click the Envelope Options tab and enter appropriate

sender in
formation.

Note: The

sender information
entered here
will generally only be used for sending
internal emails and alerts created by the server itself. For outgoing broadcast emails,
the envelope information will be determined by the client application.


13.

C
lick the OK button to close the dialog.

14.

Leave the Usage and Fixed controls at their default values.







Page
7

15.

Optionally, enter a name for this delivery method configuration.

16.

Click the Save button and save this file to a suitable location
.

G
enerally,
the file
should

be called
EBFConfig.xml
and
it must

be saved to
the
configured
“basePath”

directory

for the server
. By default this is the <Documents and Settings>
\
All
Users
\
Application Data
\
Tikit
\
EBFServer directory
on Windows XP and Windows
Server 2003, and ProgramData
\
Tikit
\
EBFServer on Windows Vista and Windows
Server 2008
(
see next section

for how to change this if required
).

When only a single delivery method is configured, it will be used for both outgoing external
emails and also for internal system

generated

emai
ls such as acknowledgements and approval
requests.

If internal emails should be delivered
using

a different
delivery method
, create a second
delivery method using the Tikit.EBF.DelMethodSMTPImmediate class and give it a name
starting with “Internal”.

If mu
ltiple delivery methods are defined, external emails will be sent using the first method
with a name beginning “External”, or simply
using

the first one found in the config file if
there are none whose name begins with “External”.

NOTE: You should
check

th
e
system

configuration
settings
detailed in the next section
before startin
g the server for the first time


particularly the location of the EBF
configuration file created in this section.

Server
System Configuration

The .NET configuration file for the se
rver
executable

is called
Tikit.EBFMessageServer.exe.co
nfig and must always be in the same location as the
executable itself.

It is an XML file and
can
be opened and edited using XML Notepad, Windows Notepad, or
any other available text or XML editor.

If y
ou are editing the file with a non
-
XML editor,
ensure that you do not incorrectly modify the structure of the file.

It contains the following items within the <appSettings> node:

Key

Purpose

Default Value

basePath

Identifies the base directory
for
all
da
ta files used by the
server.

<Documents and
Settings>
\
All
Users
\
Application
Data
\
Tikit
\
EBFServer
directory on Windows XP and
Windows Server 2003, and
ProgramData
\
Tikit
\
EBFServer
on Windows Vista and
Windows Server 2008

ebfConfigFile

Identifies the locati
on of the
EBF configuration file
created by the Configuration
Editor.

EBFConfig.xml in the
basePath

directory.

adminEmail

An email address to which
administrative alerts will be
sent.

None







Page
8

traceLog

Identifies the location of the
server log file

Tikit.EBF
MessageServer.Log
in the
basePath

directory.

traceLevel

Identifies the level of detail
to log


one of “Off”,
“Error”, “Info”, “Warning”,
“Verbose”

Info

httpListenerPort

(DEPRECATED)

The TCP port on which the
server will listen for
in
coming email broadca
st
packages from pre 4.5
clients.

65100

httpListenerEndPoint

(DEPRECATED)

The endpoint on which the
server will listen for
incoming email broadcast
packages

from pre 4.5
clients
.

EBFMessageListener

Server DataListener URL

By default, the server will list
en for incoming requests from EBF
4.5
clients
using TCP
on
port 9401 using
an
endpoint
named “
EBFDataListener

. There should be

no need to modify
this setting and we recommend that it is not changed.

The setting appears in the Tikit.EBFMessageServer.exe.co
nfig file as the “address” attribute
of the
“system.serviceModel
\
services
\
service
\
endpoint” node.
If required, t
he port number
and/or endpoint can be modified by editing the file as appropriate and restarting the service.

No other changes should be made to

any part of the system.serviceModel section of this file.

Note that any changes made to this
file

will

be overwritten
if

th
e server
software

is upgraded
or reinstalled.

Link Tracking Configuration

In order to use the Link Tracking functionality of the eMa
rketing Solution, you
must

first
install the ReAction Server Link Tracking software on a suitable internet visible server. For
customers using ReAction Server 1.x, the Link Tracking software can be installed on the
ReAction Server 1.x machine.

Once

you ha
ve a ReAction Server
Link Tracking

server installed and running, you
must

configure the EBF Server to make the link tracking functionality active

and available within
clients connecting to this EBF Server
. To do this, follow these steps:

1.

Run the EBF Config

Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration" node and choose "New".

3.

Enter "linkTrackConfig" as the type, and again as the name.

4.

Click the “Configure…” button.

5.

In the “External URL” field
enter the basic external URL
to the link tracking method
on the ReAction Server
“Link Tracking”

server. This will be of the form
“http://<server>/rs/ct.aspx?ct={0}”.







Page
9

6.

In the Internal URL field, e
nter the URL to the data listener
endpoint
on the ReAction
Server
“Link Tracking”

server

a
s it will be accessed from the EBF Server
. This will
be of the form “http://<server>:9405/RSDataListener”.

7.

If required, you can specify network credentials for requests from the EBF Server to
the ReAction Server Link Tracking server. This may be needed in

certain
environments, for example if the request passes through a proxy server that requires
authentication.

8.

The EBF Server will poll the ReAction Server Link Tracking server at intervals in
order to collect the latest batch of click
-
through data. By defa
ult this happens every
120 seconds. You can modify this interval by
checking the “Override the default
collection interval” box and specifying

a value in seconds of the interval you want to
use.

9.

In some scenarios, multiple
duplicate
“clicks” may be receive
d for a single real event.
By default, the EBF server will ignore duplicate clicks received for the same contact
on the same link in the same message (including opens) if they occur within 30
seconds of each other, and will count them as a single click. Yo
u can control this
behaviour by checking the box labelled “Override default duplicate click through
window length”. Set the value to “
-
1” to disable duplicate removal, or set it to the
number of seconds within which duplicate clicks should be discarded.

10.

Sa
ve the configuration file.

11.

Restart the server.

Note that the Link Tracking functionality will not be available within clients connected to the
server unless it has been configured on the server.

The machine running the EBF service must be able to communica
te with the machine
running the ReAction Server
Link Tracking
service in order for the
l
ink
t
racking
functionality to work. This may require a change to the firewall configuration. The
traffic is http, using port 9405 by default.


A command
-
line utility ca
lled RSListenerTest.exe is installed along with the EBF Server
and can be used to test communications between the EBF Server and the RS Link
Tracking service. To use, simply run the executable and it will test the current
configuration.

Note: The Link Tra
cking configuration will be ignored unless a ReAction Server license key
(module name REACTION) has been added to the license set.

Message Categories

Message Categories are arbitrary values that can be applied to
individual
email broadcasts to
facilitate l
ater
grouping,
analysis and reporting. For example, you could create one category
to allow the type of each email broadcast (newsletter, event invitation, data verification, etc.)
to be captured, another to record which office sent each email broadcast.

Ca
tegor
y definitions can be configured to accept any text value, or be restricted to one or
more of a pre
-
defined list of possible values.

Follow these steps to create a category definition:

1.

Run the EBF Config Tool and open the server configuration file.

2.

Rig
ht
-
click the "Category Definitions" node and choose "New".

3.

Enter a name for the field (see note at the end of this section).







Page
10

4.

If this category field should accept multiple values, check the “Allow Multiple
Values” checkbox.

5.

If the only acceptable values for

this category field are those that are defined here,
check the “Allow Only Predefined Values” checkbox.

6.

To add a predefined value, enter it in the “New Value:” box and click Add.

7.

Save the configuration file.

8.

Restart the server.

Note that once a category f
ield has been used in a message, it will be “disconnected” from it’s
definition if the name of the field on the server is changed. Any existing value for the field
will still be displayed, but it will not be possible to modify it.

Advanced Server Configur
ation

Timer Control

The server can be configured to place itself online and take itself offline at a particular time
each day. When offline, the server will accept email broadcasts and place them in the queue,
but will not actually generate or deliver emai
ls.


By default, the server will be online whenever the service is running.

If the service is not
running, the server will not be available at all and will not accept email broadcasts.

To configure
a scheduled online/offline switch
,
follow these steps:

1.

R
un

the EBF Config Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration" node and choose "New".

3.

Enter "serverTimerControl" as the type, and again as the name.

4.

In the grid, right
-
click and choose "Add…"

5.

Enter "onlineFrom" as the n
ame, then enter the time the server should come onlin
e in
the form "hh:mm", e.g. "00:
30", then click OK.

6.

In the grid, right
-
click and choose "Add…"

7.

Enter "onlineTo" as the name, then enter the time the server should be taken offlin
e in
the form "hh:mm", e.
g. "06:
30", then click OK.

8.

Save the configuration file.

9.

Restart the server.

The scheduled online and offline times will be recorded in the server log, and will also be
displayed in the "Message Processor Status" section on the status page generated by the
web
server.

Email Control

By default, when a user submits an email broadcast to the server, the server will generate and
send a
receipt
confirmation email back to the user as confirmation that the broadcast has been
received.

When the broadcast is complete
d, the server will generate
a further

email back to the user
to
advise them email generation has been completed.

Both of these emails will include a hyperlink which the user can click to get to a web page
containing detailed information about the status o
f their email broadcast. By default this






Page
11

hyperlink will reference the MsgInfo.aspx method of a virtual directory called EBFWeb
which is assumed to be running on the same server as the EBF service itself. This default
reference can be modified if required (
for example, if the EBF web site is running on a
different server to the EBF service).

To configure
changes to the default behaviour
, follow these steps:

1.

Run the EBF Config Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration"
node and choose "New".

3.

Enter "serverEmailControl" as the type, and again as the name.

4.

To prevent the receipt confirmation email from being sent, right
-
click in the grid and
choose "Add…". Enter "sendReceiveConfirm" as the name, "N" as the value, then
clic
k OK.

5.

To prevent the completion confirmation email from being sent, right
-
click in the grid
and choose "Add…". Enter "send
Complete
Confirm" as the name, "N" as the value,
then click OK.

6.

To specify a different URL to the email broadcast status page, right
-
cl
ick in the grid
and choose “Add…”. Enter “msgInfoUrl” as the name, a value in the form
“http://<server>/<directory>/MsgInfo.aspx?msgId={0}”, then click OK.

7.

Save the configuration file.

8.

Restart the server.

Server
Security

The EBF Server contains security fe
atures to prevent unauthorised users from performing
certain actions or having access to information about email broadcasts other than those they
submitted themselves.

U
sers will fall into one of
four

roles
:

Administrator

Full access to all email broadcast
s, queue management functionality,
and rights to change the online status of the server.

Queue Manager

Full

access to all email broadcasts,
and queue management
functionality.

Reporter

Full access to all email broadcasts.

User

Access to their own email
broadcasts only

Security is integrated with Windows Active Directory, and is configured by assigning
Windows group and/or user names to the different EBF roles.

By default, if a user has login name “Administrator” or is in a group whose name contains
“Adm
instrator”, they will be g
iven the Administrator

role.

Any other user will have the
“User” role.

To configure security, follow these steps:

1.

Run the EBF Config Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration" node and choos
e "New".

3.

Enter "
securityConfig
" as the type, and again as the name.







Page
12

4.

To specify one or more Windows groups whose members should be granted the
Administrator role
, right
-
click in the grid and choose "Add…". Enter "
adminGroups
"
as the name,
and a semi
-
colon
separated list of group names

as the value, then click
OK.

5.

To specify one or more individual Windows user accounts which should be granted
the Administrator role, right
-
click in the grid and choose "Add…". Enter
"adminUsers" as the name, and a semi
-
colon s
eparated list of full user IDs (including
the domain name, e.g. DOMAIN
\
USER) as the value, then click OK.

6.

To specify one or more Windows groups whose members should be granted the
Queue Management role, right
-
click in the grid and choose "Add…". Enter
"
m
an
agementGroups" as the name, and a semi
-
colon separated list of group names as
the value, then click OK.

7.

To specify one or more individual Windows user accounts which should be granted
the Queue Management role, right
-
click in the grid and choose "Add…". En
ter
"
m
anagementUsers" as the name, and a semi
-
colon separated list of full user IDs
(including the domain name, e.g. DOMAIN
\
USER) as the value, then click OK.

8.

To specify one or more Windows groups whose members should be granted the
Reporter role, right
-
cl
ick in the grid and choose "Add…". Enter "reportingGroups" as
the name, and a semi
-
colon separated list of group names as the value, then click OK.

9.

To specify one or more individual Windows user accounts which should be granted
the Reporter role, right
-
cli
ck in the grid and choose "Add…". Enter "reportingUsers"
as the name, and a semi
-
colon separated list of full user IDs (including the domain
name, e.g. DOMAIN
\
USER) as the value, then click OK.

10.

Save the configuration file.

11.

Restart the server.

SMTP Throttle

When generating emails on an SMTP server, you can manage the rate at which emails are
sent to the server, and how the EBF server will manage connections to the SMTP server.

The EBF server has two generation rates, one labelled “default”, the other “high”.

The
intention is that the default rate is used for most mailings where the emails can be generated at
a moderate rate so as not to monopolise the
delivery
resources. The high rate can be used
where the emails are time sensitive and should be generated as
rapidly as possible. By default
end
-
users can choose which rate they want to use. They cannot control the actual settings
used for these two rates.

The following parameter
s can be set:

Key

Purpose

Default Value

defaultPauseEvery

For the “default” rate, ho
w=m慮y=
敭慩l猠s桯畬搠扥⁳敮e⁢敦or攠
灡畳i湧⁦潲⁡⁷=il攮
=
N
=
摥d慵ltm慵~eqime
=
For the “default” rate, how long
獨潵s搠dh攠eerv敲⁰慵獥⁢敦潲攠
r敳畭i湧⸠K~l略ui猠s灥pifie搠d渠
milli獥捯湤献
=
㄰〰
㴠ㄠ=e捯湤F
=






Page
13

highPauseEvery

For the “high” rate, how many
email
s should be sent before
pausing for a while.

1

highPauseTime

For the “
high
” rate, how long
should the server pause before
resuming. Value is specified in
milliseconds.

10 (= 1/100th second)

maxPauseWithoutDisconnect

What is the maximum pause that
should
occur without the EBF
server disconnecting from the
SMTP server at the start of the
pause period and then
reconnecting at the end. Value
specified in milliseconds.

Only
applies when messages are being
generated via SMTP server.

2000 (= 2 seconds)

connecti
onCycleEvery

Separate to the above settings, the
EBF server can be configured to
disconnect and then reconnect to
the SMTP server after creating
the specified number of emails.
This can be useful where the
SMTP server has a restriction on
the volume or num
ber of emails
that can be generated in a single
session. Set this to 0 to disable
this feature.

100

connectionCyclePause

How long should the EBF server
wait before reconnecting to the
SMTP Server

after it has
disconnected because of the
“connectionCycleEv
ery” setting.
.
Value specified in milliseconds.

1000 (=1 second)

Unless reconfigured, the “default” rate will pause for 1 second after each email, the “high”
rate will pause for 10ms after each email. The connection to the SMTP server will be closed
after

100 emails have been generated, then re
-
established after a pause of 1 second.

To override these defaults, follow these steps:

1.

Run the EBF Config Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration" node and choose "New".

3.

Ent
er "smtpThrottle" as the type, and again as the name.

4.

Right
-
click in the grid and choose "Add…". Enter the parameter name from the above
table as the name, then the required value as the value, then click OK.

5.

Repeat for each parameter you want to override
.

6.

Save the configuration file.







Page
14

7.

Restart the server.

InterAction
Application Server Remapping

In an InterAction environment,
The EBF server
can

make connections to the InterAction
Application S
erver in various circumstances
-

for example, when processing a m
essage

that
has been configured
to create activities in InterAction when an email is generated,
or when
processing link track
actions that update InterAction
.

InterAction
connection information
will automatically be included
along with the
other
message da
ta
from the client where the message was created and the contacts retrieved, to the
EBF server where the emails are to be generated. This connection information will include the
Application Server URL, and the
InterAction
user account name and encrypted pa
ssword.

In some network
configurations
,
the

URL

passed from the client
may not be
valid for use
from the EBF server, typically either for authentication reasons or because a different server
name or IP address must be used for DNS reasons.
In most cases wh
ere authentication is the
issue, it will be sufficient to change the port from the default to 8100.

To “remap” an Application Server URL supplied from a client for use from the server, follow
these steps:

1.

Run the EBF Config Tool and open the server configu
ration file.

2.

Right
-
click the "Other Configuration" node and choose "New".

3.

Enter "
appServerUrlMap
" as the type, and again as the name.

4.

Right
-
click in the grid and choose "Add…". Enter “originalUrl” as the name, and the
Application Server URL as it will be
received from the client as the value

(e.g.
“http://server/interaction”)
, then click OK.

5.

Right
-
click in the grid and choose "Add…". Enter “replacementUrl” as the name, and
the Application Server URL that should be used from the server as the value

(e.g.
“h
ttp://server:8100/interaction”
, then click OK.

6.

Save the configuration file.

7.

Restart the server.

InterAction
Application Server Authentication

It is also possible to configure network credentials that the EBF server should
supply

when
making requests to the

InterAction Application Server.

To add network authentication information, follow these steps:

1.

Run the EBF Config Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration" node and choose "New".

3.

Enter "
appServerNetworkCredentials
"

as the type, and again as the name.

4.

Click the Configure button, enter the network account ID, password and domain, then
click OK.

5.

Save the configuration file.

6.

Restart the server.







Page
15

InterAction
Application Server Communications Test

A diagnostic command
-
lin
e utility to test communications between the EBF Server and the
InterAction Application Server is installed along with the service executable. The program
should be run from the command line as follows:

IAAppServerTest IAAppServerUrl IAUser IAPassword

e.g.

IAAppServerTest
http://iaserver/interaction

emroberts password

The current configuration (remapping and authentication) will be displayed, tested, and any
communication errors reported.

Providing Information for
Web Analytics

The EBF Server can be config
ured to automatically add extra information about the contact or
the message to some or all of the hyperlinks in an outgoing email.
Although t
his information
will typically not change what the contact actually sees in their browser at all, it
will be
avail
able to the target web site

for logging,

and can be used by web analytics tools to analyse
metrics such as what proportion of the traffic to the web site comes from eMarketing emails,
and what contacts do next after reading the target page.

To enable this
feature, follow these steps:

1.

Run the EBF Config Tool and open the server configuration file.

2.

Right
-
click the "Other Configuration" node and choose "New".

3.

Enter "
hyperlinkExtraInfo
" as the type, and again as the name.

4.

Right click in the Name/Value grid and

choose Add…

5.

In the Name field, enter a
regular expression
pattern

to
specify

the URLs that you
want to add extra information to.

Further d
etails on how to
specify

URLs is provided
below.

6.

In the Value field, enter the extra information
that you want added
to the URL if it
matches the configured pattern.
Further d
etails of how to specify extra information is
provided below.

7.

Click OK.

8.

Repeat steps 4 to 6 if you want to configure more than one URL pattern to process.

9.

Save the configuration file.

10.

Restart the se
rver.

URL Patterns

URLs
that should have extra information added

are
specified

using regular expression syntax


this is a standard and extremely powerful technique for matching patterns in text, but great
care must be taken to ensure the pattern matches
t
he URLs you intend
,

and only those URLs.

General information about regular expression syntax is widely available
on

the internet, and
the EBF Config Editor includes a regular expression tester you can use to ensure your patterns
work as intended

(available

from the Help menu)
.

A key point to remember is that the period
character “.” has special meaning in regular expression syntax and must be escaped with a “
\

to match a literal period in a URL.
For this
purpose, the regular expression processing

is

not
ca
se sensitive.

Some examples are shown below:







Page
16

Pattern

Matches

http://www
\
.tikit
\
.com

Matches any URL on www.tikit.com

http://www
\
.tikit
\
.com/.*ppid
=
2

Matches URLs on www.tikit.com only if the
URL
also
includes “
ppid=2


in the query
string (note this would

match ppid=21,
ppid=22 etc as well).

http://(?!www
\
.tikit
\
.com)

Matches any URL
not

on www.tikit.com.

URL Extra Information

The extra information that will be added to the UR
L can be any literal text value
, and will be
appended to the original URL in th
e message content with an appropriate delimiter
.

Special

tokens
can be included within the value, and

will be replaced with information about
the contact or the message, as shown below:

Token

Value

~id~

The contact’s ID
=
繭敳獡gef摾
=
q桥⁵湩煵攠i摥dtifi敲
=
f潲=th攠e敳獡ge
=
繣~t敧潲yW㱣Yt敧潲yk慭e㹾
=
攮e⸠繣慴敧潲yW偲mcti捥⁁re慾
=
q桥⁶慬略f⁴桥⁳p散ifi敤em敳獡g攠e慴敧潲y=
f潲=t桥敳獡g攮
=
坨tt敶敲⁶慬略ui猠獰scifi敤⁷ill⁢攠=灰敮p敤⁴漠oh攠潲igi湡n⁕o䰠楮it桥敳獡g攠e潮o敮t⸠q桥=
v慬略⁷楬l⁢攠灲数e湤敤⁷et
栠h桥h慰灲潰oi~t攠摥limit敲=t漠o潲m⁡⁶慬i搠do䰮
=
^猠s渠數慭灬攬e
if the original link URL is “http:///www.tikit.com” and that matches a
configured pattern for which the

corresponding extra information
value
is

“Source=EMS&TrackID=~id~”
, the
n the

full URL in

the outgoing email for contact
8589936787
will be
come

“http://www.tikit.com?Source=EMS&TrackID=

8589936787
”.

If the original URL was “
http://www.tikit.com/index.php?ppid=311
”, it would become

http://www.t
ikit.com/index.php?
ppid=311
&

Source=EMS&TrackID=

8589936787
”.

Note that any analysis of this information must be done on the target web site using suitable
web analytics software.

Server
Data

Files

The server maintains a
file called “Server.data”

in the configured basePath directory.

This file
contains
v
arious items of information that need to be persisted when the service is not
running. It should not be deleted or modified by end
-
users.

Each EBF message contains a unique

message

ID for tracking purposes. The server uses this
ID and the data in the files

to ensure that the same email broadcast is not generated multiple
times.

When a message is accepted by a server, the server will assign the message a separate
server ID which is unique to that server.

The “done” directory will contain .EBF files represent
ing completed email broadcasts. The
base name of each file will be the unique
message
ID of the email broadcast it represents.







Page
17

Server Housekeeping

Each completed email broadcast will result in a new .EBF file appearing in the “done”
directory.

Messages in
the “done” folder are considered live and can be accessed by users in
various ways (to track the status of responses, or to add additional recipients for example).

After a variable amount of time, these message files will be
automatically
moved to the
“ar
chive” folder.

Once this has been done

they are no longer live and cannot be accessed
directly
by end
-
users.

The time after which a message will be archived may be controlled
from an EBF client. Three archive options are available: “Short”, which will arch
ive the
message 7 days after completion, “Standard” which will archive the message 30 days after
completion, and “Long” which will archive the message 90 days after completion.

Completed messages can also be archived at any time using the web interface.

Ov
er time, the total volume of files in the “
archived
” directory may become significant. The
contents of this directory should be reviewed periodically and files deleted or archived as
desired.

HTML Emails

The EBF server will generate emails back to internal

users in various scenarios


when an
email broadcast is received, and when it is completed for example.

HTML templates

held within the server executable
are used to create the
se

emails
.

The
default
HTML

can be customised if desired to modify the look and
content of these emails
and web pages.

When the EBF server starts, the default
html files

are written out to the “
html
” directory
underneath the server’s basePath directory
. Each file will have a name

starting “Default…”
.
To customise an email, make a copy

of
the corresponding
HTML

file removing “Default”
from the start of the file name, make the desired changes, then restart the server.








Page
18

EBF Web Site

In a typical implementation scenario, the EBF web site will be hosted on the same server as
the EBF service

itself and no additional configuration will be required.

In the event that the EBF web site is running on a different machine to the EBF service, or
that the EBF service is not using the default listener URL, the EBF web site will need to be
configured so

that it can c
ommunicate with the EBF service


see the “ebfDataListener”
setting in the table below.

Server System Configuration

The .NET configuration file for the web site executable is called Web.config and is located in
the installation directory (by
default, <Program Files>
\
Tikit
\
eMarketing Solution
\
EBFWeb).

It is an XML file and can be opened and edited using XML Notepad, Windows Notepad, or
any other available text or XML editor. If you are editing the file with a non
-
XML editor,
ensure that you do
not incorrectly modify the structure of the file.

Only settings within the <appSettings> node should be modified by end
-
users



these
settings are documented below
.
Changing other settings may prevent the web site from
functioning correctly.

Key

Purpose

D
efault Value

basePath

Identifies the base directory
for data files used by the
server.

<Documents and Settings>
\
All
Users
\
Application Data
\
Tikit
\
EBFWeb
directory on Windows XP and Windows
Server 2003, and
ProgramData
\
Tikit
\
EBFWeb on
Windows Vista and Win
dows Server
2008.

traceLog

Identifies the location of the
site

log file

EBF
Web
.Log in the
basePath

directory.

traceLevel

Identifies the level of detail to
log


one of “Off”, “Error”,
“Info”, “Warning”, “Verbose”

Info

ebfDataListener

Identifies the EBF
service to
which the web site should
connect.

net.tcp://localhost:9401/EBFDataListener

Required file system permissions

The user account used by ASP.NET (by default, ASPNET) requires read & write access to the
configured base directory.

If this director
y does not already exist when the EBF web site starts, the web application will
attempt to create
it
.
If the ASP.NET account does not have permission to create the directory,
this operation will fail and the web site will not be available. In this scenario
, the base
directory should be created and the required permissions assigned manually before accessing
the web site.







Page
19

Geographical Distribution Charts

The web site can produce charts showing the distribution of email opens and clickthroughs by
country. It d
oes this by using a lookup data file to map the IP address the reponse comes from
to the country that each IP address has been assigned to. These results are
about

99
% accurate
and are intended to

provide
a useful qualitative means of gauging

reponses by c
ountry.

The integration works with data files produced by
MaxMind (
www.maxmind.com
). You can
get further details and download an open source data file in binary format (GeoLite Country)
from
http://www.maxmind.com/app/geolitecountry
. This data file should
be unzipped,
renamed to “GeoIP.dat” and copied to the
EBF
web site’s base directory.

The charts will only be available for selection once the data file has been installed as
described.

Message Status Information

The standard web page showing the current s
tate for a message is accessed with the
“MsgInfo.aspx” method, using a “msgId” parameter to identifying the message by ID.

Information about a message is also available
in XML
format
using the “MsgData.ashx”
method, again with a “msgId” parameter to identi
fy the message by ID.


The MsgData.ashx method also supports transforming the XML into other formats using an
XSL stylesheet. Stylesheet files should be located in the basePath directory for the web site as
identified earlier in this section. If the basePa
th directory contains a stylesheet named
“MsgData.xsl”, it will be loaded automatically by the MsgData.ashx method and used to
transform the XML. Alternatively, a stylesheet can be specified with the “xsl” parameter and
the base name of the stylesheet file

to load (e.g. “xsl=test”).

A sample stylesheet named MsgData
Sample.xsl is written to the basePath directory when the
web console is started for the first time. This can be used as an example for customisation.







Page
20

EBF Client Programs

The main EBF client progr
am is E
-
Merge 4. This client is intended for use by marketing or
business development professionals and allows full control over the content to be delivered
and the contacts to which the content should be sent.

Also available
as part of

the separate “Brand

Manager” license is the “Message Wizard”
EBF
client
. This is a
simple
client which can only create email broadcasts based on templates
which were previously created with E
-
Merge 4. These templates
can restrict what content
within the email broadcast can b
e modified by the end
-
user, and also to which contacts the
email broadcast can be sent.

EBF client programs submit email broadcast packages over the network to an EBF server
which
then

generate
s

and deliver
s

the individual emails.

Client Installation

1.

Run t
he install program, read and accept the license agreement, and select the
required install location.

2.

Select the required features from the

Custom Setup dialog.

Initially, the server
features will be deseleted.

3.

Complete the installation.

NOTE: You should co
mplete the basic configuration detailed in the next section before
starting
a client program

for the first time.

Required file system permissions

The client programs require write access to the
\
Documents and Settings
\
All
Users
\
Application Data

folder
(
\
Pr
ogramData on Windows Vista and Windows Server 2008)
and the user’s Local S
ettings
\
Application Data folder (the user’s AppData folder on Windows
Vista and Windows Server 2008).

Basic Client Configuration

1.

From the Start menu, choose Programs/
Tikit/eMarketing

Solution
/
EBF
Configuration
Editor

2.

Click the “New” button on the toolbar

3.

Click the key icon on the child node under the Licenses node.

4.

In the panel on the right, enter the company name from the license information.

5.

For each license key that you have, in th
e Add License frame enter the module name,
the number of users (if specified


leave blank or enter a zero for a site license), and
the license key itself; then click the Add button.

You should

add

all applicable license
s


see the section on Licensing lat
er in this
guide.

6.

You can remove a previously entered license by right
-
clicking on it and choosing
Remove License.

7.

Right click on the
EBF Server

node and choose “New…”

8.

Enter the URL to the EBF Server


unless the server has been reconfigured to use a
non
-
d
efault URL (not recommended) this will be of the form
“net.tcp://<server>:9401/EBFDataListener

.







Page
21

9.

Enter a more readable name for the server (e.g. “Central Server”) and a description if
desired.

10.

Click the “Message Options” tab and set
the
options as
desired
(settings made here
will be used as the default for email broadcasts submitted to this server, but can be
overridden for individual messages if required).

11.

Click the Save button and save this file to a suitable location (generally,
EBFConfig.xml in the
Docu
ments and Settings
\
All Users
\
Application Data
\
Tikit

directory).

NOTE: You should
check

the
system

configuration
settings
detailed in the next section
before startin
g a client program for the first time.

Client System Configuration

The .NET configuration fi
le for the E
-
Merge 4 is called Emerge4.exe.config.

The .NET configuration file for the Message Wizard is
EBFMsgWizard.exe.config
.

These files must be in the same directory as the application executable. They

are XML files
and can be opened and edited usin
g XML Notepad, Windows Notepad, or any other available
text or XML editor. If you are editing one of these files with a non
-
XML editor, ensure that
you do not incorrectly modify the structure of the file. You can easily check this after saving
the file by
double
-
clicking on the file and ensuring that the entire file displays correctly in the
web browser.

EBF client programs look for the following items within the <appSettings> node:

Key

Purpose

Default Value

ebfConfigFile

Identifies the location of
the EBF

configuration
file created by the
Configuration Editor.

Can be a full path, a
UNC name or an http
URL.

Documents and Settings
\
All
Users
\
Application
Data
\
Tikit
\
EBFConfig.xml

(ProgramData
\
Tikit
\
EBFConfig.xml
on Windows Vista and Windows
Server 2008).

messa
geDirectory

The default directory
where the client will load
and save messages.

The user’s My Documents
y
呩qit=
摩re捴oryK
=
m敳獡g敂牯睳敓e~rt
=
q桥=
桩g桥ht=
dire捴ory=
t漠
w桩捨ct桥敳獡g攠
扲潷獥r⁷ill=
giv攠e捣敳献
=
偲m湣i灡lly⁦潲⁵=攠睩t栠
t桥h䵥s獡g攠eiz慲搠

湣攠睩t栠h桡h=捬i敮t⁴桥h
m敳獡g攠扲潷獥r=i猠t桥h
潮oy⁷慹⁴漠潰敮⁡=
m敳獡g攮
=
q桥敳獡g敄楲散tory⁶慬略u
=
tr~捥䱯i
=
f摥湴ifie猠s桥hl潣oti潮o=
t桥h
cli敮e
=
l潧⁦ile
=
㱡灰乡Y放⹬
潧⁩渠t桥h
user’s
=
^灰pic慴i潮⁄~t~
y
qikit=
摩re捴潲yK
=






Page
22

traceLevel

Identifies the level
of
detail to log


one of
“Off”, “Error”, “Info”,
“Warning”, “Verbose”
.

Info

traceSize

Maximum log file size,
in bytes. If the log file
grows larger than this
size, it will be shrunk by
removing the earliest
entries. The log file size
is only checked when

the
program starts.

2000000 (2MB)

defaultTemplate

Path to an EBF file that
will be used to supply
default content for new
messages. See
later
section on default
content.

DEFAULT.EBT in the configured
message directory.

Advanced Client Configuration

Con
figuring
C
ontact
Information
P
roviders

Several

Contact Information Providers are included
with

EBF. Tho
s
e

listed
below are created
by default when an EBF client program starts and will be available for use provided the
availability conditions are met:

Inte
rAction Environment:

InterAction Contact Information Providers allow various InterAction specific parameters (for
example, exclusion rules) to be configured.

Provider

Comments

InterAction List Builder

Allows dynamic creation of a list of source contacts

using the
standard InterAction list builder dialog.

Only available if the InterAction Desktop Integration is
installed.

Class:
Tikit.EBFInterAction.CIPInterActionObjects

InterAction Marked Contacts

Contacts marked in the InterAction Windows client will b
e
used as the source contacts.

Only available if the InterAction Windows client is installed
and running.

Class:
Tikit.EBFInterAction.
CIPInterActionWin32Marked







Page
23

InterAction Folder

Source contacts will be all the contacts present in one of the
folders which

the user selects. Does not require contacts to be
individually selected.

Does not require any InterAction software to be installed on
the client.

Class:
Tikit.EBFInterAction.CIPInterActionFolder

InterAction
CSV File

Source contacts will be pulled from th
e selected CSV file

that
was exported from InterAction.

Class:
Tikit.EBF
InterAction
.CIP
IA
CSVFile

Non
-
InterAction Environment:

Provider

Comments

CSV File

Recipients will be pulled from the selected CSV file. The file
must contain at a minimum columns fo
r the contact’s name
and email address.

Class: Tikit.EBF
.CIP
CSVFile

Unless modified by the configuration file, a single instance of each the available providers
will be available, and the user will be able to select and configure any of them.

Through the
configuration file it is possible to disable any of the providers, provide them with
a non
-
default initial configuration
, or create multiple instances of any of them with differerent
configurations. You can also identify one of them as the initial default.

The table below describes how to carry out configuration tasks. Start by opening the
appropriate configuration file using the Configuration Editor.

Task

Procedure

Mark a provider as the
default

If the provider you want to make the default already has a
c
onfiguration, select it by clicking on it.

Otherwise, r
ight click the “Contact Information Providers”
node and select “New…”
⸠q桥渠n
n the “Class:” dropdown,
灩捫⁴桥⁰r潶i摥r⁹潵⁷慮~=t漠o慫攠e桥⁤hf慵~tK
=
In the “Usage:” dropdown, pick “UseAsDefault”.
=
Cli
捫⁴桥⁓慶攠扵et潮渠nh攠e潯l扡rK
=
a
i獡bl攠e=灲潶i摥r
=
ff⁴桥⁰h潶i摥r⁹潵⁷慮~=t漠摩獡bl攠慬r敡摹⁨慳⁡=
捯湦ig畲慴i潮Ⱐ獥l散t⁩t⁢=⁣li捫i湧渠=t⸠
=
Otherwise, right click the “Contact Information Providers”
node and select “New…”. Then in the “Class:” dr
潰o潷測n
灩捫⁴桥⁰r潶i摥r⁹潵⁷慮~=t漠摩獡bl攮
=
In the “Usage:” dropdown, pick “Unavailable”.
=
Cli捫⁴桥⁓慶攠扵et潮渠nh攠e潯l扡rK
=






Page
24

Pre
-
configure a provider

If the provider you want to pre
-
configure already has a
configuration, select it by clicking on it.


Otherwise, right click the “Contact Information Providers”
node and select “New…”. Then in the “Class:” dropdown,
pick the provider you want to pre
-
configure.

Click the “Configure” button. Complete whatever user
interface is presented. Configuration para
meters will be
displayed in the list.

Click the Save button on the toolbar.

Make a provider the only one
available.

In the “Usage:” dropdown, pick “ReplaceAllOthers”.

Set an initial data directory
for the CSV file based
providers

Manually add a paramete
r named “dataDirectory” to the
provider’s configuration, specifying the path to the desired
directory as the parameter value.

InterAction Contact Information Provider Configuration Sets

For the InterAction Contact Information Providers, you can create mul
tiple sets of
configuration parameters. This allows users to easily switch between alternate configurations,
so they can
quickly
apply different exclusion or contact selection rules. You can also select
one of the sets as the default, so that it will be au
tomatically used when any of the InterAction
providers is initially selected.

To create a configuration set, follow these steps:

1.

From the Start menu, choose Programs/Tikit/eMarketing Solution/EBF Configuration
Editor

2.

Click the “Open” button on the toolbar
and open the appropriate configuration file.

3.

Right
-
click on the “Other Configuration” node and select “New…”.

4.

From the “Type:” dropdown, pick “cipConfigInterAction”.

5.

Enter a name for this configuration set.

6.

If the configuration set should apply to any Appl
ication Server, leave the key value
blank. If the configuration set only applies to a particular Application Server, enter
the URL to the Application Server as the key value.

7.

If this set should be the default, either call it “Default” or select “UseAsDefa
ult” from
the Usage: drop down.

8.

Click the “Configure” button and set up the configuration as required, then click the
“OK” button when complete.

9.

Click the “Save” button on the toolbar to save your changes

ReAction Server 1.x integration

If you have entered

a license key which allows use of ReAction Server, you can add your
ReAction Server 1.x installation(s) to the EBF configuration in the following way:

1.

From the Start menu, choose Programs/Tikit/eMarketing Solution/EBF Configuration
Editor







Page
25

2.

Click the
“Open”

button on the toolbar and open the appropriate configuration file.

3.

Right
-
click on the “Other Configuration” node and select “New…”.

4.

From the “Type:” dropdown, pick “rsConfig”.

5.

Enter a name for this ReAction Server 1.x installation (e.g. “Production system
”)

6.

In the “Key:” field, enter the external URL to the ReAction Server installation (e.g.
“http://reaction.company.com/reaction”.

7.

Additional configuration parameters for this installation can be added by right
-
clicking in the table area and selecting “Add…”
. Refer to the table later in this section
for information on available parameters.

8.

When complete, click the

Save


button on the toolbar to save your changes.

Parameter Name

Comments

rsInternalUrl

The internal URL to the ReAction Server 1.x installation.


This should only be specified if the URL to access the server
from inside your network is different to the external URL that
recipients will use.

rsOpeningPageMethod

The method that should be called to generate the opening page
for an event. Default val
ue is “RSGenPage.asp”
=
r獐so捥s獥摐慧敍整h潤
=
q桥整桯搠hh慴=獨潵l搠扥d捡ll敤et漠or潣o獳⁡渠敶敮e=r敡捴i潮⸠
Default value is “RSProcess.asp”
=
r獌潧i湐慧敍et桯h
=
q桥整桯搠hh慴=獨潵l搠扥d捡ll敤et漠o敮er慴攠e=l潧i渠n慧攮e
Default value is “RSLogin.asp”
=
r獅se
湴䱩獴䵥t桯h
=
q桥整桯搠hh慴=獨潵l搠扥d捡ll敤et漠o敮er慴攠eh攠eist=⁥=敮e猠
from an installation. Default value is “RSEventList.asp”
=
r獅s敮e䱩獴m慳獷srd
=
ff⁴桥⁒敁捴i潮⁓orv敲⁩n獴慬l慴i潮⁨慳⁢敥渠n潮oig畲e搠d漠
r敱eire⁡⁰=獳w潲搠扥f潲攠e整畲湩湧⁴h攠ev
敮e=li獴Ⱐ獥t⁴桥h
灡p獷sr搠桥r攮
=
NOTE: Some features of EBF and ReAction Server integration require v1.6.11 or later
of ReAction Server.
If your ReAction Server installation is at an earlier version,
upgrade it to v1.6.11 or later before using with EBF. I
f you are using InterAction 5.5 or
later, your ReAction Server server should be at v1.6.12 or later.

Configuring

SMTP S
end
er

option

presets

Unless modified by the configuration file, the user will not be able to modify the sender name
or email address of t
he emails they generate


they will
be
set to the name and email address
from the current user in InterAction.

You can allow the user to modify their sender name or address freely, or let them pick from
one of a number of alternate sets, by making changes
to the configuration file.

To add a new set of sender information, follow these steps:

1.

From the Start menu, choose Programs/Tikit/EBF/Configuration Editor

2.

Click the “Open” button on the toolbar and open the appropriate configuration file.







Page
26

3.

Right
-
click on th
e “Other Configuration” node and select “New…”.

4.

From the “Type:” dropdown, pick “smtpSendOptions”.

5.

Enter a name for this set of sender information (e.g. “Event Invitation”).

6.

Click the “Configure” button, complete the information, and then click the “
OK

bu
tton.

7.

If this set of sender information should be used by default, pick “UseAsDefault” from
the “Usage:” dropdown.

8.

If the user shouldn’t be able to modify this set of sender information, check the
“Fixed” checkbox.

9.

When complete, click the Save button on t
he toolbar to save your changes.

You can also create or modify parameters individually if required


see the table below:

Parameter Name

Comments

senderEmail

The email address that the emails should appear to come from.

senderName

The
display
name that t
he emails should appear to come from.

replyTo

The default address that should be used if a recipient replies to
the email (defaults to the sender email).

returnPath

The address that automated replies such as bounces should be
sent to (defaults to the sen
der email).

p
riority

Priority for the message (Normal, Low, High).

requestReceipt

Request a receipt to be returned (Y or N).

Reading

Sender Information

from Active Directory

As an alternative to specifying
sets of
alternate sender information manually,
this information
can also be read from Active Directory. The information in Active Directory is in turn
managed from Microsoft Outlook using the “Delegates” feature.

Using this feature of EBF
allows end
-
users to manage who can send email broadcasts on thei
r behalf, using Outlook
alone.

To add a new set of sender information, follow these steps:

1.

From the Start menu, choose Programs/Tikit/EBF/Configuration Editor

2.

Click the “Open” button on the toolbar and open the appropriate configuration file.

3.

Right
-
click o
n the “Other Configuration” node and select “New…”.

4.

In the “Type:” field, enter “adDelegates”.

5.

In the “Name:” field, enter “adDelegates” again.

6.

Typically the domain name to check for delegates will be read automatically from the
user’s login information. I
f there is a need to manually specify the domain to check,
right
-
click in the grid and choose "Add…". Enter “domain” as the name, and the
name of the domain to check as the value, then click OK.







Page
27

7.

By default the “replyTo” field will be left blank, meaning an
y replies to the emails
will go back to the email sender. If you wish to specify a fixed reply to address, right
-
click in the grid and choose "Add…". Enter “replyTo” as the name, and the email
address replies should go to as the value, then click OK.

8.

By de
fault the “returnPath” field will be left blank, meaning any non
-
delivery reports
will go back to the email sender. If you wish to specify a fixed return path address,
right
-
click in the grid and choose "Add…". Enter “returnPath” as the name, and the
email

address replies should go to as the value, then click OK.

9.

When complete, click the Save button on the toolbar to save your changes.

Configuring Word content capture

You can control the user interface elements available when users access the functionality
to
copy content from Word from the HTML editor toolbar

T
o set these options
, follow these steps:

1.

From the Start menu, choose Programs/Tikit/EBF/Configuration Editor

2.

Click the “Open” button on the toolbar and open the appropriate configuration file.

3.

Right
-
c
lick on the “Other Configuration” node and select “New…”.

4.

In
the “Type:” dropdown

box
,
enter


wordDocumentContentOptions
”.

5.

Add, edit or remove parameters from the list by right
-
clicking. The supported
parameter names are listed in the table below.

6.

When com
plete, click the Save button on the toolbar to save your changes.

Parameter Name

Comments

convertOptionDefault

One of “htmlclean”, “htmlfull”, “textplain”
K
=
捯湶敲tlpti潮o湡nl敤
=
Set to “N” to prevent
=
u獥r猠fr潭⁣桡湧i湧⁴桥⁣o湴e湴=
捯湶敲獩潮otio渮
=
r数
l慣敓e慲tnu潴e獃桥捫ed
=
Set to “Y” to convert smart quotes to normal quotes.
=
r数e慣敓e慲tnu潴e獅湡sled
=
Set to “N” to prevent users from changing the smart quote
捯湶敲獩潮otio渮
=
Configuring Insert Image Options

If users need to add local graphics to the

HTML content, you can control the initial directory
selected when a user uses the Insert Image menu option in the HTML editor.

To set this option, follow these steps:

7.

From the Start menu, choose Programs/Tikit/EBF/Configuration Editor

8.

Click the “Open” but
ton on the toolbar and open the appropriate configuration file.

9.

Right
-
click on the “Other Configuration” node and select “New…”.

10.

In the “Type:” dropdown box, enter “
htmlInsertImageOptions
”.

11.

Add, edit or remove parameters from the list by right
-
clicking. Th
e supported
parameter names are listed in the table below.







Page
28

12.

When complete, click the Save button on the toolbar to save your changes.

Parameter Name

Comments

initialDirectory

The full path to the initial directory to display.

Configuring system email hand
ling

You can set options for dealing with particular email addresses or domains.

You can exclude
particular email addresses or domains, or configure particular addresses or domains to always
receive plain text only emails.

To set these options, follow thes
e steps:

1.

From the Start menu, choose Programs/Tikit/EBF/Configuration Editor

2.

Click the “Open” button on the toolbar and open the appropriate configuration file.

3.

Right
-
click on the “Other Configuration” node and select “New…”.

4.

In the “Type:” dropdown box, e
nter “systemEmailHandling”.

5.

Add, edit or remove parameters from the list by right
-
clicking. The supported
parameter names are listed in the table below.

6.

When complete, click the Save button on the toolbar to save your changes.

Parameter Name

Comments

excl
usion<Anything>

(e.g. exclusion1, exclusion2)

An email address to always exclude from email broadcasts.

plainText<Anything>

(e.g. plainText1, plainText2)

An email address to always send plain text only content to.

For example, to exclude all email addres
ses to domains that start with “boeing”, add a
parameter with a name of “exclusionBoeing” and a value of “*@boeing*”.

Note that a parameter value that starts with a “^” will be treated as a full regular expression,
allowing for complex pattern matching.

B
ounceback
l
icense Information

If the EBF Config file is not in the default location, Bounceback
may display a licensing error
message on startup. If this happens, follow this procedure:

Create a file called
TIKITIA.INI

in the default location (e.g.
Documen
ts and Settings
\
All
Users
\
Application Data
\
Tikit
). The file should contain the following lines:

[License]

EBFConfig=<full path to EBFConfig.xml>

Configuring Default Content

You can configure E
-
Merge 4 with some initial content that should be included in an
y new
blank message. This is typically used to set default styles
for

HTML content


a default
typeface and size for example.

To use this feature, create a new template and configure it with whatever default content you
require.

If you save this template w
ith the name DEFAULT.EBT in the configured message






Page
29

directory, the content it includes will be added automatically into any new message you
create.

Alternatively, you can name the file something else or save it in a different location (to keep it
apart from

“normal” templates”), and then
tell E
-
Merge 4 where it is using the
“defaultTemplate” client configuration parameter.

Command Line Arguments

E
-
Merge 4 supports the following command line arguments. These can be used for integration
with InterAction’s Auto
mated Export process for example.

Argument

Purpose

File

Specify the location of an .EBF or .EBT file to open. If no path is
specified, it is assumed the file is in the default message directory.

IACSVFile

InterAction environments only. Specify the locati
on of a CSV file
containing contact information exported from InterAction.

IACSVFileName

InterAction environments only. Specify the name to be used for this
provider (this is the name that will appear in contact provider selection
lists). Optional.

IACSV
FileDesc

InterAction environments only. Specify the description used for this
provider. Optional.

CSVFile

Non InterAction environment. Specify the location of a CSV file
containing contact information.

CSVFileName

Specify the name to be used for this pro
vider (this is the name that will
appear in contact provider selection lists). Optional.

CSVFileDesc

Specify the description used for this provider. Optional.

Parameters should be specified as /Name=Value and separated by spaces. Where the value
includes

spaces, enclose the value in quote marks.

When configuring Automated Export, you would specify the “Program Name:” field like this:

<Path to E
-
Merge 4 executable> /IACSVFile=%EXP%








Page
30

Plugin Configuration

InterAction Activity Plugin

This plugin should be con
figured for clients only.

Right click the Plugins node, pick New,
then select “Tikit.EBFInterAction.ActivityPlugin” from the Class dropdown on the right
-
hand
pane.

The following parameters are supported:

Parameter Name

Comments

autoShowUI

Set to “N” if yo
甠摯潴⁷~湴⁴h攠䅣eivity⁵獥r⁩湴erf慣攠e漠
慵~潭慴i捡lly⁡灰=~r⁷桥渠愠畳er⁳畢=its⁡敳獡g攠eor=
摥div敲y⸠
=
獥湤nctivityqy灥pd
=
By⁤敦慵~t⁴h攠ee湤⁡ntivity⁷ill⁩niti~lly⁢攠=整=t漠t桥hfir獴=
activity type that contains the word “E
-
Mail”. Use this setti
湧=
if⁹潵⁷慮~⁴漠獥t⁴h攠摥f慵lt⁡=tivity⁴y灥⁴漠獯o整桩湧⁥=s攠

=
y潵⁣o渠畳n=敩t桥r⁴h攠ey灥pfa=⁴桥慭攮
=
潰敮䅣oivityqy灥pd
=
By⁤敦慵~t⁴h攠潰e渠慣tivity⁷ill⁩niti~lly⁢攠=整=t漠t桥hfir獴=
activity type that contains the word “E
-
Mail”. Use this sett
i湧=
if⁹潵⁷慮~⁴漠獥t⁴h攠摥f慵lt⁡=tivity⁴y灥⁴漠獯o整桩湧⁥=s攠

=
y潵⁣o渠畳n=敩t桥r⁴h攠ey灥pfa=⁴桥慭攮
=
捯湴~捴C潵湴
=
^猠s桥h敭慩l猠f潲=愠扲o慤~~獴⁡r攠e敩湧⁣=敡t敤Ⱐt桥⁰lugi渠nill=
慤搠~湤n異摡t攠e捴ivity⁩湦orm慴i潮⁩渠n湴敲^捴i潮o
i渠n慴捨敳=

=
慶潩搠d慶i湧⁴漠o慫攠v敲y慲g攠ee煵敳t猠t漠t桥⁁灰lic慴i潮o
卥pv敲⸠Ky⁤敦慵lt⁴h攠卥湤⁡=tivity⁷ill⁢攠=灤pt敤⁥v敲y‱〠
捯湴~捴猠st桡t⁩猬⁡fter⁥=慩l猠桡v攠扥敮⁧敮er~t敤et漠㄰=
捯湴~捴猠sh攠el畧i渠nill⁣re慴攠er⁵灤慴攠eh攠ee湤⁡ntivity⁦潲=
t桥⁢r潡o捡
st⁷it栠t桯h攠eo湴慣tsF⸠K潵⁣慮⁣h慮~攠ehi猠
i湴敲v慬⁵獩湧⁴hi猠s整ti湧K
=
獥湤nctivitya敦~畬t卥p散ted
=
坨t渠t桥h慣tivity⁤=~l潧⁩猠獨潷渠景r⁴桥⁦ir獴=tim攬⁴he⁳=湤n
慣tivity⁣桥捫扯砠bill=扥⁵湣桥捫敤⸠q漠o慶攠et=慰灥~r=
捨c捫敤⁩湩ti~llyⰠ慤I⁴hi猠s慲慭整
er with a value of “Y”
⸠呯K
灲敶敮e⁵獥r猠sr潭⁣桡湧ing⁴桥⁳t~t攠潦=t桥h捨c捫扯砬⁣桥捫=
the “Value is fixed” checkbox.
=
潰敮
^捴ivitya敦慵ltp敬散ted
=
^猠s扯b攬⁢畴=for⁴h攠潰en=慣tivityK
=
Note that in an environment where the EBF server has been configured w
ith link tracking,
any actions required when a contact opens an email should be configured through that
mechanism rather than through this plugin. In such an environment, the option to create an
activity when a contact opens an email will not be available
via the activity plugin
,

unless the
option was previously configured in the message being worked on.







Page
31

Spam Assassin Integration Plugin

Spam Assassin is an open source tool which provides spam filter analysis of email messages.
More information is available

from
http://spamassassin.apache.org
. Note that Spam Assassin
is neither supplied nor supported by Tikit.

When the plugin is configured, it allows E
-
Merge to pass the current message content to
Spam Assassin,

which will analyse the message and produce a report which can be viewed in
E
-
Merge. Using Spam Assassin in this way can form a useful part of a wider effort to reduce
the spam profile of your emails, but correct interpretation of the results requires a fu
ll
understanding of the technical issues around email transmission and spam filtering processes.

This plugin should

be configured for clients only.

Spam Assassin must have been previously
installed on the client.

To enable the integration,
first
right clic
k the Plugins node, pick New, then
enter

“Tikit.EBF.
Message
SpamAssassinPlugin”
as the

Class
name

on the right
-
hand pane.

The following parameter

is

required
:

Parameter Name

Comments

spamAssassinDirectory

The full path to the directory where Spam Assassin
has been
installed (which contains the spamassassin executable).

Hyperlink Checking Plugin

This plugin checks
any
hyperlinks in th
e email content and matches the hyperlink URL

to a
list of “approved” URLs which you configure. If the content contains a hyp
erlink to a site
which is not on the approved list, the user will not be able to submit the message.


The check will be run when an email broadcast is about to be submitted. The user can also
check the content at any point while they are creating it.

This
plugin should be configured for clients only.

To configure this plugin
, right click the Plugins node, pick New, then select

Tikit.EBF.MessagePlugin
Hyperlink
Check
” from the Class dropdown on the right
-
hand
pane.

The following parameters are supported:

Para
meter Name

Comments

urlAllowed<XXX>

A
n

expression specifying an allowed URL.
If the value starts
with a ‘^’ it will be treated as a regular expression, otherwise
it⁷ill⁢攠tre慴敤⁡猠s=lit敲慬=獴ri湧⁩摥dtifyi湧⁴桥⁳t~rt=of⁡渠
慬l潷敤⁕e䰮i
卥攠扥b潷⁦or
=
數em灬敳K
=
䵵jtipl攠啒䱳i捡渠n攠e潮fig畲敤⁢e⁡摤=湧畬ti灬攠
“urlAllowed<XXX>” parameters. The <XXX> portion can be
慮~⁵湩煵攠獥煵敮e攠潦⁡lp桡湵h敲i挠捨cr慣t敲猠

=
攮eK=
畲l^ll潷敤ㄬ⁵Nl^ll潷敤㈬=畲l^ll潷敤併r卩t攬e整挮
=






Page
32

hideMenu

By default, if any urlAll
owed parameters

are configured,

an
item will be added to the Tools menu in E
-
Merge 4 to allow
the user to check the current content and see the allowed
URLs.

Set this parameter to “Y” to hide this menu item. The plugin
will still check the content before s
ubmitting the message.

topMenuText

Specify the menu text displayed on the Tools menu in E
-
Merge4. Default is “Hyperlink Checker”.

Examples of allowedUrl parameter values:

http://www.tikit.com

C
ontent from
anywhere on
www.tikit.com
.

http://news.bbc.co.uk
/sport1/hi/football

Any page from the football area of the BBC web
site only.

^http://.*
\
.tikit
\
..*

Any content from a site containing “.tikit.”


e.g.
www.tikit.com, www.tikit.co.uk, support.tikit.com
.

More information about regular expression syntax
is
widely available on the internet


for example
from
http://www.regular
-
expressions.info
.

“View as a Web Page” Plugin

When submitting a message to an EBF server configured for Link Tracking, the server can
automatically add a link to each email enabling th
e recipient to view the email content in their
web browser rather than in the email.
This does require any additional configuration or any
changes to the message content.

To configure the default behaviour of this plugin, right click the Plugins node, pick

New, then
select “Tikit.EBF.MessagePluginEMSLinkTrack” from the Class dropdown on the right
-
hand
pane.

The following parameters are supported:

Parameter Name

Comments

vawpLinkBeforeHtml

Set this parameter to “Y” to add the link right at the very
扥bi湮n
湧==t桥⁈呍䰠捯湴敮t==敡c栠敭慩lK
=
ff⁴桩猠s慬略ui猠湯t⁳灥pifi敤⁡湤⁴h攠etml⁣潮=e湴=i湣lu摥d⁡=
㱂Yav㸠>慧ⰠI桥hli湫⁷ill=扥⁡摤敤⁩mm敤e慴敬y⁦ollowi湧=
t桥‼䉏av㸠t慧⸠Kt桥hwis攠e桥hli湫⁷ill=扥⁡d摥搠dt=t桥⁶敲y=
扥bi湮n湧==t桥⁈呍䰠捯湴敮tK
=






Page
33

linkH
tml

Set this parameter to modify the default HTML used for the
link. The value must include the special token

!viewAsWebPageUrl!
”, which will be replaced by the URL
to the recipient specific web page.

For comparison, the default HTML used is:

<div style="
font
-
size:x
-
small">If you
have problems viewing this email, you can
<a href="!viewAsWebPageUrl!">view it as a
web page</a></div>

linkText

Set this parameter to modify the default link in the plain text
version. The value must include the special token

!v
iewAsWebPageUrl!
”, which will be replaced by the URL
to the recipient specific web page.

A ‘|’ character in the value
will be replaced by a newline sequence.

For comparison, the default text used is:

To view this email as a web page, click
the link below:|
!viewAsWebPageUrl!||

Note: If additional customisation of “View as a Web Page” links is required, consider adding
a “View As Web Page Link” calculated token to the content.








Page
34

Integrating with the InterAction Web Client

Both E
-
Merge 4 and the Message Wizard

can be integrated with the InterAction web client so
that users can easily send email broadcast messages to contacts selected from the web client.

To support this integration, various changes need to be made to the InterAction Application
Server. Before m
aking any changes, we strongly

recommend stopping the Application
Server
s
ervice
,

and making backup copies of any files you

are going to

modify. Note that
subsequent
upgrades

applied to
your Application Server will typically result in these changes being l
ost.
In most cases you can simply remake them after completing the upgrade.

To obtain the support files referenced in this section which are needed to enable the
integration, ensure you select the
feature “InterAction Web Client integration” from the
Serve
r section of the Custom Setup dialog. This will copy the following files to the
installation directory:

TikitIAWebUtil.CAB

CAB file containing the client side component required for the
integ
ration. Copy this file to the ia
home
\
scripts directory on the
App
lication Server.

IAWebIntegrationJS.txt

Text file containing additions to Javascript files on the
Application Server. See
the
instructions
later
in this section.

Enabling the

I
ntegration

1.

Open the IAWebIntegrationJS.txt file from the installation director
y.

2.

Copy the entire contents of the file to the clipboard.

3.

Open the GRID.JS file from the iahome
\
scripts

directory on the Application Server
.
Go to the end of the file and paste in the contents of the clipboard. Ensure you leave a
blank line at the end of t
he file. Save the file.

4.

Repeat for the GRID2.JS file.

The changes above make a new Javascript function available to the web client. The function
is called
IA_TikitRunEmerge

and it can accept a number of arguments to control what it does,
as noted in the ta
ble below:

handlerID

Can be blank, or one of EM3, EBF or EBT. If this parameter is EM3, the
integration component will attempt to launch E
-
Merge 3. If it’s EBF, the
捯c灯湥湴⁷ill=慴t敭灴⁴漠l慵湣栠h
-
Merge 4, and if it’s EBT the component
will=慴t敭灴⁴漠l
慵湣栠t桥h䵥獳慧攠eiz慲搮
=
ff漠=慬略⁩猠獰scifi敤ⰠIh攠elie湴=
will=try⁴漠r畮⁅
-
Merge 4 if that’s installed, or the Message Wizard if that is
i湳t慬l敤e扵b⁅
-
Merge 4 isn’t.
=
m敳獡g敆ele
=
^敳獡g攠eil攠t桡t⁴桥⁣lie湴⁳桯畬搠潰敮⁷o敮⁩t⁳t~rt献⁉f⁴桩s
=

lue
=
摯d猠湯t=
include a path, then it’s assumed the file is in the configured message file
摩re捴ory⁦潲=t桥h捬i敮t⸠K潴⁳異灯rte搠dor⁅
-
䵥rg攠e
K
=
數er慁牧s
=
^摤dti潮ol⁡rg畭敮e猠s漠扥=灡p獥搠d漠t桥⁣=i敮t⸠Kot⁳=灰潲t敤ef潲⁅
-
䵥rg攠㌮
=
qhi猠f畮utio渠捡n潷
=
扥bc慬l敤⁦r潭⁴桥敮甠e潮oig畲慴i潮ou䵌⁦il敳K
=






Page
35

Implementing the Integration

Each menu item
that
you want to add requires a
corresponding unique definition in the
appropriate menu XML file. You can add as many of these definitions as you need, so
long as

each has a different ID value.


Consult the InterAction documentation for further details.
Two example menu items

are
shown below:

<!
--

TIKIT MODIFICATION
-

START
--
>

<menuItem id="
contacts
-
grid
-
actions
-
emerge
" multiMarked="true"
inRightClick="false" inDr
opDown="true">


<label>Send E
-
mail Broadcast</label>


<action type="javascript">parent.IA_TikitRunEmerge();//</action>

</menuItem>

<menuItem id="
contacts
-
grid
-
actions
-
emerge
-
newswire
"
multiMarked="true" inRightClick="false" inDropDown="true">


<label>Se
nd Kingsway &amp; Co Newswire</label>


<action type="javascript">parent.IA_TikitRunEmerge("EBT",
"Kingsway_IPNewswire_Wizard.EBT");//</action>

</menuItem>

<!
--

TIKIT MODIFICATION
-

END
--
>

The first of these will just run E
-
Merge 4 if it’s installed, or t
he Message Wizard if E
-
Merge 4
is not present.

The second will run the Message Wizard, and cause it to open the template
with filename Kingsway_IPNewswire_Wizard.EBT from t
he configured message directory
on the client.

In both cases, the contacts that were

selected in the web client will be available
to the client program.

Once menu item
s have been defined, they can be added to the web client menus to actually
implement the integration for end
-
users.
The examples given
below

assume you will want to
add the

menu items to the “Actions” menu on contact grids,
immediately

below

the

default
mail
-
merge integration menu item.

1.

Using a suitable editor (Notepad is fine), open the contactManagementMenus.xml file
from the iahome
\
etc directory on the Application Server.

2.

Locate the comment line:

<!
--

begin actions items
--
>.

3.

On the line immediately after this comment line, add the menu item definitions from
earlier in this section.

4.

Locate the next line that starts:

<include id="contacts
-
grid
-
actions
-
mail
-
merge" />

5.

Add a
new line and add these two lines:

<include id="
contacts
-
grid
-
actions
-
emerge
" />

<include id="
contacts
-
grid
-
actions
-
emerge
-
newswire
" />

6.

Repeat steps 4 and 5


there are likely to be 3 such instances altogether.

Repeat these steps for the projectMenus.xml fi
le. Note that menu item ID values must be
unique across the whole system, so you should prefix the menu ID values in this file with
“project
-
“ (e.g.
project
-
contacts
-
grid
-
actions
-
emerge
).

Repeat these steps for the pageLevelMenus.xml file, prefixing the ID

values with “page
-

(e.g.
page
-
actions
-
emerge
). Also note that for this file the Javascript function must be called
as “
parent.IA_TOPFRAME.IA_TikitRunEmerge()
”.

After completing these changes, restart the Application Server and test that the menu items
ap
pear where you expect and call the client programs in the way you require.







Page
36

Licensing

The following license module names will all enable use of EBF software components,
with

some differences in behaviour as noted below:

Module Name

Comments

PLUSSUITE

Enabl
es use of E
-
Merge 4 and EBF Server.

ReAction Server integration and Brand Manager functionality
will not be available.

IAEMERGE

Enables use of E
-
Merge 4 and EBF Server.

ReAction Server integration and Brand Manager functionality
will not be available.

REACTION

Enables use of E
-
Merge 4 and EBF Server and enables the
ReAction Server integration.

Brand Manager functionality will not be available.

EBFBRAND

Enables Brand Manager functionality.

Must be used with one or more
other

licences.

P4WEMERGE

Enable
s use of E
-
Merge 4 and EBF Server functionality in a
non
-
InterAction environment.

ReAction Server integration

(including Link Tracking)

and
Brand Manager functionality will not be available.