ACTIVE server package - Active Project

knifedamagingInternet and Web Development

Feb 2, 2013 (4 years and 6 months ago)

206 views

1


ACTIVE Knowledge Workspace Server Package

README

D5.3.2
,
Version
1
.
1
6

Table of
Contents

Introduction

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

5

Changes from previous release

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

5

1.16

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

5

1.15

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

7

1.14

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

8

1.13

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

8

1.12

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

9

1.11

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

10

1.10

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

10

1.9

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

11

1.8

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

12

1.7

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

12

1.6

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

13

1.5

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

13

1.4

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

15

1.3

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

16

1.2

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

16

Prerequisites

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

16

Automated Server Installation

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

18

Initial ACTIVE server installation

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

18

Step 1: Installing Java virtual machine

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

18

Step 2: Installin
g SQLCompact

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

19

Step 3: unzipping the ACTIVE server package to the server system

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

19

Step 4: Modify the PATH environment variable

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

19

Step 5: Run the setup script

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

19

2


ACTIVE server upgrade
................................
................................
................................
............................

20

Ste
p 1: unzipping the ACTIVE server upgrade package to the server system

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

21

Step 2: Run the upgrade script

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

21

ACTIVE server removal

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

21

Manual Server Installation

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

23

One
-
time server installation and setup

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

24

JDK

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

24

Apache ActiveMQ

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

24

InstantRails 2.0

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

24

Rmagic
k

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

26

SQLCompact

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

27

Semantic MediaWiki

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

27

Create ACTIVE directori
es

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

27

Workspace server package installation and setup

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

28

Fresh package installation

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

28

Upgrade installation

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

28

Package installation steps

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

28

User monitoring configuration

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

37

Configuration of the supplementary ACTIVEprocessor

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

38

Workspace client package installation and setup

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

39

Operational instructions

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

39

Workspace server deployment view

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

39

Automatic ACTIVE server startup

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

41

Manually starting the ACTIVE server

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

41

Automating the ACTIVE server startup

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

41

ACTIVE server load balancing setup

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

42

Deploying the ACTIVE client

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

45

Deploying the Local Workspace package

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

45

Acceptance scenarios

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

46

Workspace setup

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

46

ACTIVE Web portal

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

46

3


Workspace user profile

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

46

Context management


top
-
down part

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

46

Context s
witching


top
-
down part

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

47

Context
-
related user information

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

47

Info resources

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

48

Document shadowing

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

49

Workspace resources

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

49

Resource access permission management

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

49

Workspace search

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

50

Simple search

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

50

Advanced search

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

51

Resources in context

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

51

Team context management

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

51

TaskService

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

52

ContextMiningService

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

53

Context discovery

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

53

Context detection

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

53

Context switch


bottom
-
up part

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

53

Preparing the workspace for context mining
-

initializing with pre
-
existing logs

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

54

Experimentation: simulating events

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

54

Expected behavior scenario

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

54

MetadataRecommenderService

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

55

Workspace Primitive events

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

55

Observation of resource changes

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

56

Vi
ewer of PrimitiveEvents

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

57

SMW ACTIVE extensions

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

57

Usage

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

57

Fun
ctionality

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

58

Scenarios

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

58

Troubleshooting

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

60

Changing logging l
evels in log files

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

60

4


Support for tag recommendation on larger files.

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

61

ACTIVE Client in VPN setup

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

62

ACTIVE Client proxy settings

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

63

ACTIVEsearch service cannot be started

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

63

Support

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

63


5


Intro
duction


This document describes how to set up
the ACTIVE Knowledge
Workspace

and how to inst
all
subsequent versions of the w
orkspace.
This version of the document describes the
fully
functional
prototype
of the AC
TIVE Kn
owledge Workspace (D5.3.2
).

ACTIVE Knowledge Workspace is composed of several software packages:



ACTIVE server package



ACTIVE client package



ACTIVE shell extension package



ACTIVE local workspace package

Note that
ACTIVE server package

is mandatory, so yo
u have to install it first. You need to deploy the
server package to only one system in your intranet.

Each Workspace user has to install the
ACTIVE client package

on his/her desktop system.

This will
extend the MS Office tools and IE with ACTIVE features.

However, those features will be available
only when the desktop system is connected to the ACTIVE server.

In order to use the Workspace also in offline mode, the
ACTIVE local workspace package

has to be
installed to the user’s desktop system on top of the

client package. This is an optional package.

ACTIVE shell extension package

can be installed on top of the ACTIVE client package to allow
insertion of arbitrary Windows files into the Workspace directly from Windows File explorer. This is
an optional pack
age.


Changes from previous release

This paragraph describes major additions/changes
of the functionality
made in every new
release of
the w
orkspace. Note that for simplicity reasons this paragraph summarizes the changes of both the
server and

the client
package. Version 1.14

is the
f
ully functional prototype (D5.3.2) and versions
1.9
-
1.13

are intermediate versions made during the development of the

fully functional prototype
.

1.16

1.

Support for Office 2010 was verified. In summary all AKWS features provided

by ACTIVE
Office add
-
ins work fine in Office 2010. There are, however, some differences in the
position of add
-
in functions in the office 2010 GUI, which are caused by redesigned GUI in
Office 2010. This means that some functions are not accessible as ha
ndy as they are on 2007
6


version. The differences are described in the client readme file, which is located in the
download area of the ACTIVE web portal (part of the active server package).


2.

Bugfix in workspace and local workspace database setup script wa
s made to deal with the
differences in command execution in various Windows setups.


3.

Improved Working context suggestion: either the context mining service or ACTIVEprocesor
can submit suggestions for the current context to the ACTIVE Taskbar. Based on the

suggestions the user can perform the context switch or decide to stay with his current
context. Environment variable TOP_DOWN_SUGGESTIONS can be set to TRUE or FALSE and
based on this setting context suggestion will be provided by either the bottom
-
up o
r top
-
down part of the context management.


4.

File pathnames are automatically adjusted in the Workspace when files are moved or
renamed on the file system. See the Shell extension readme file for the instruction how to
configure this feature.


5.

Windows 7 su
pport for all client packages was verified. All client packages can be used on
Windows 7 in case that the user is member of the Administrators group. See the client
readme file for instructions.


6.

Watchdog for the ACTIVEmonitor service was added to the ACTI
VE Taskbar. This service will
be automatically started in case it is not running.


7.

Improved visual appearance to denote associated or de
-
tached Info resources in MS Office
clients.


8.

Capability of setting
/unsetting

the current task in the Task Pane
.


9.

Acces
s of shadow files from the Task Pane.


10.

URL drag and drop from the IE to the Task Pane.


11.

Commands to display Workspace tag cloud and context cloud are available from the
Commands pull
-
down menu in the Taskbar.


12.

Reconnect capability is available for the ACTI
VE Taskbar and Outlook add
-
in when they are
used in the network setup. Please note that this feature is only available in the client
package with offline support, which is bundled with the v1.16 Release candidate 3 server
package. This feature is not avail
able for earlier versions.


13.

Automated
ACTIVE
server setup is added. When ACTIVE server package is
installed for the
first time
on
a server which does not have any of the required software prerequisites
installed, an automated ACTIVE server setup script i
s available to perform complete setup of
all required software. This eliminates a lengthy and error
-
prone manual setup process which
7


was in place until v1.16.

In addition, active_server_setup.rb script can be used also for
upgrade and deletion of the ACTIV
E server package.


14.

T
he offline support is added. Local Workspace package
is available from the Download
section of the ACTIVE portal and
should be installed on user’s desktop in addition to the
client package. Separate readme file for Local Workspace insta
llation is available

in the
Download section, too.

ACTIVE server has to be upgr
aded to the latest version (1.1
6) to
support offline operation.


15.

ContextMining Service and AKWSLogger Service are redesigned to hide plain text of the
mined documents on the se
rver disk.


16.

Https pages are not transmitted to the server (unless configured so in the config file)


17.

TaskPane in the Taskbar can be moved around and is not
ke
pt

always on top anymore.


18.

By typing <ctrl>T when Taskbar is in focus, TaskPane can be mapped off/
on the screen.


19.

More than one Taskbar
-
related

window can be opened at once. Taskbar windows for
search, list of users and list of resources in current context can remain on the screen until
they are closed by the user. However, information in those windows

is not automatically
updated.

1.15

20.

ACTIVE Shell extension package is now bundled with the server package. End users can
download this package and related readme file from the Workspace server in the same way
as they can download the ACTIVE client package
(see Admin
-
>Download page on the ACTIVE
web portal). Note that ACTIVE Shell extension MUST be installed on user’s desktop system
AFTER the ACTIVE client package.

21.

Outloo
k add
-
in: “tag on close” dialog

is applied only to new emails

and forwards.

22.

Knowledge pr
ocess concept is introduced in the TaskService and TaskPane.

23.

User monitoring support is added. Administrator can manage user event counters and user
probes from the Monitor section of the web portal. NOTE that environment variable
USER_MONITORING must be s
et to ON to enable user monitoring in the ACTIVE server.
Make sure that this is set before the ACTIVE services are started.

NOTE that user monitoring
should be properly configured for meaningful operation. See User monitoring section.

24.

Bulk association of r
esources to the named context: when a discovered context is named by
the user it is possible to associate resources which were identified as characteristic for the
discovered context, to the newly named context in one step

8


25.

ACTIVE Taskbar: Workspace desktop

search: Taskbar crash in situa
tion when right
-
click was
made
on a file with “content only ” hit status.

26.

Improved error reporting in clients when offline mode is detected.

27.

Web portal search now works ok in situations with empty search string.

28.

Client loggi
ng default interpretation has changed. By default (AKWS_LOG_DETAIL = 0) only
errors are logged. When AKWS_LOG_DETAIL is set to 1 then more detailed log is produced


1.14

29.

Excel Primitive ev
ents are now carrying complete E
xcel documents, not extracted text.
This
way the delays during opening large excel documents are reduced because text extraction
takes place in the mining instead in the foreground in the Excel client.

30.

Detailed documentation for ContextMiningService setup and configuration is provided.

1.13

31.

SMW ACTIVE extensions are incorporated into the ACTIVE server package. Installation,
configuration and usage instructions are provided later in the document. Note that for
proper interoperability between AKWS and SMW you have to incorporate AKWS and SMW
us
er names and passwords into both servers. This is explained later in this document.

32.

Active web portal user roles are

introduced. At present three roles are configured: Admin,
ContextManager and Regular User. The availability of portal functions is now subj
ect to the
roles a particular user is assigned to.


33.

Context Visualizer
(CV)
is included in the client package and is integrated with the Taskbar.


34.

TaskWizard functionality was expanded. SMW server
has to be
entered during the AKWS
client setup time and
SMW

login
username
and password
must be set
into the AKWS user’s
profile
.

35.

Task
P
ane was extended with task recording. Currently the following actions

can be
recorded
:
Navigate, Word Doc Open, Word Doc Save, Send Mail, View Mail and Reply to
mail
.

36.

Improved Cont
extMining service and context naming and switching dialog in the TaskBar.

37.

Selection of contexts and sub
-
context menus in ACTIVE Taskbar is now conducted with left
mouse click.

9


38.

Support for document shadowing

in MS Office tools
.
Document shadowing, triggered

from
the Start button, is possible for all supported MS office clients. Shadowed document
(= copy
of the latest version of the document)
can be downloaded from the ACTIVE portal via the
link under the document type icon on the InfoResource

list or on any
search hit list.
InfoResources without shadow are only marked with the document type icon.

This is a
snapshot of the work
-
in
-
progress so it was not fully tested yet.

If user
’s

profile flag
‘auto_shadowing’ is set then clients will automatically make a docu
ment shadow when the
document is updated.


NOTE: User service
and Meta Data service
WSDL
s

ha
ve

changed in order to
support
shadow
ing. User profile attribute ‘auto_shadowing’ was
introduced.


NOTE: for upgrade to v1.13 it is necessary to run the “make_work
space.rb upgrade “ script
to migrate the database with shadowing support.

1.12

39.

Preliminary support for document shadowing. Note that a new directory
‘…ACTIVE/shadows/’
with read
-
write access to all
must be created before upgrading to this
version. See the
installation part below.

40.

Blanks are allowed in Context names.

41.

Support for top
-
down/bottom
-
up integration of contexts has been introduced into the
server and ACTIVE Taskbar. Several new web services are available to handle the
integration. WSDLS for
context
,

user

and
resource

service have changed so web services
client stubs have to be re
-
generated (ContextStruct, ExtendedContextStruct, UserStruct,
ResourceStruct have new attributes)

42.

ContextMiningService conforms to the top
-
down/bottom
-
up integration of cont
exts.

43.

Preliminary version of TaskWizard

is incorporated into the AKWS client package.

44.

ACTIVE Taskbar GUI has been significantly redesigned and enhanced.

45.

Workspace search service provides a metadata search method with endless pager. This
method is now used
by all workspace search
-
related pages on the ACTIVE web portal. This
removes the “sparse” result pages effect from the previous version.

46.


Startup of the ACTIVated MS Excel has been optimized.

47.

ACTIVE web portal has new feature for managing team contexts (
Contexts
-
> Manage team
Context) which guides the user through the process of context creation and users and
resources assignment.

10


48.

Support for context hierarchy was added. Workspace search by context is now expanded
with an option to search for all resour
ces which are attached to a particular context and all
its subcontexts.

In Taskbar use the left mouse button to select context in a drop down menu
and right mouse button on the (eventual) arrow next to the context name to expand to the
sub
-
context level me
nu.

49.

Untagging and context detach were added to workspace resources and info resources.

50.

ACTIVE Client now uses default proxy settings from .NET machine.config file or from Internet
Explorer if these parameters are missing in
machine.config
file.

New configu
ration
parameter

is also added which supports setting specific proxy for web service request
s

made by ACTIVE Client.

1.11

51.

ACTIVated
MS Excel is
available.

Please note that this is a preliminary version which lacks
some of the features. In particular the pr
ogram startup time is not optimized yet.

52.

Workspace search has been considerably changed. Workspace search queries are now more
intuitive. Search results pages may in
clude variable number of Info resources. This is due to
a defect in the underlying search
engine.

53.

Search index re
-
build is available in the administration page of the Web portal.

In case you
are upgrading from previous Workspace version, you should delete the index directory and
re
-
build the index.

1.10

54.

Support for Workspace upgrade. Starting
from this version it is possible to automatically
convert the existing Workspace database to conform to the newly installed server package
version.

55.

Support for the creation of an empty Workspace. For a fresh installation it is possible to
request the creat
ion of a completely empty Workspace database where only the super
-
user
is initialized.

56.

Support for the creation of a demo Workspace. For a fresh installation it is possible to
request the creation a demo Workspace database with a number of preconfigured us
ers and
contexts. This is the functionality which was provided as the only alternative in the previous
versions.

57.


Search for contexts by entering the part of the context name in developed in an Ajax
-
like
fashion.

58.

Workspace TaskBar search supports cancellat
ion.

11


59.

TaskPane/TaskService are migrated to the latest WSDLs and are again operative.

60.

Extended
tag recommendation feature: a
utomatic_tagging parameter in user profile: when
set to 2
, the user can manually request
the tag recommendatio
n

from the tagging dialo
g in
W
orkspace clients.


1.9

61.

Optimized startup time for ACTIVated Office tools and IE.

62.

Changed WSDLs for all infrastructure and context management web services. A re
-
build

of
all workspace clients which are using the client C# library is need. Workspace cl
ients which
are interfacing the AKWS web services in some other way should re
-
generate their stubs to
adhere to the latest WSDLs.

63.

ACTIVE Taskbar version of t
he workspace search is enhanced with more filtering options.

64.

MetaDataRecommender is now integrated
with Word, Power
P
oint and IE.

65.

Word documents which are e
-
mail attachments and which are opened from within Outlook
are not inserted into the Workspace right now. This is experimental to prevent the
proliferation of Info resources for the same word attachme
nt if opened many times from
the Outlook.

66.

Workspace search is now implemented as a separate Windows service for better response
time and scalability support. Consequently
the installation
and server setup
process for the
ACTIVE server has
slightly
changed!

Some Ruby gems have to be installed on the server


see the initial software installation part (InstantRails section).

67.

Developer notes section is now available in SDK documentation. This section
explain
s

how
to re
-
build the clients to work with the
1.9 WS
DLs and C# client library.

68.

Instructions for establishing a fully automated startup of all workspace services are provided
in the server readme file (see below).

69.

Instructions to set up load balancing for the ACTIVE server are provided in the server
readme f
ile (see below).



12


1.8

70.

Workspace search and advanced search is implemented. This allows simple and advanced
search over
the
Workspace resources (and specifically Information resources).

71.

Microsoft desktop search is integrated into the
desktop version of the

Workspace search to
provide the full
-
text search over the Info resources on user’s desktop.

72.

Tags and
attached
c
ontext names

are embedded in Word Documents and Ou
tlook Messages
to simplify meta
data creation when documents are copied around and mail message
s are
sent around.

73.

ContextMiningService is added to the Workspace services.

74.

TaskService is added to the Workspace services.

75.

ACTIVE Taskbar is extended with the Task Pane which provides basic task management for
the TaskService.

76.

Microsoft PowerPoint add
-
in
is added to the client package.

77.

Installation of pre
-
requisites for the optional ACTIVEprocessor service has changed.

1.7

78.

Registration of shared folder is now obsolete and it was removed from the web portal.
Client programs will assign global scope to any f
ile which resides on a shared folder (whose
name begin
s with
\
\
).

79.

Instructions about running the ACTIVE server in development mode have been removed.

80.

New web service (client_sign_on) to register an ACTIVated application into the workspace is
available. Thi
s service aggregates a number of elementary web services and was introduced
to optimize the application registration process.

81.

Unified tagging dialog for Windows desktop is available and was incorporated into the
ACTIVE toolbars of Outlook, IE and Word. Tag

recommender part is currently provisional and
will be fully functional when the tag recommender service is ready.

82.

TaskBar window geometry has changed
to a horizontal bar which is auto
-
placed either on
the top or the bottom of the desktop space. TaskBar is

minimized into the Windows tray.


13


1.6

83.

Search_by_ident_and_scope_and_type()

is a new method in the
meta_data_service
. This
method can be used to determine if a specified file, email, URL etc. is already
present
in the
w
orkspace as an InfoResoruce (that is
:
W
orkspace
metadata is available for it).

84.

Create_with_perm()
is a new method in the
meta_data_service
.
This method provides

an
alternative way of the InfoResouerce creation. With the existing c
reate()

method

the
initial
permission access
settings
of the c
reated InfoResource
are implicitly derived from the
resource scope.
Create_with_perm
() makes it possible to set the initial permission access
settings to one of the three modes. See SDK documentation for details.

85.

SDK documentation includes a client C# cod
e example for
dealing with the InfoResoruces by
the ACTIVated applications.

86.

MS Word plug
-
in can create Word InfoResoruces with global and local scope. Documents on
network shares
will be treated as global. Note that this only works for documents residing
o
n
network shares which are known to the workspace. Network shares can be added to the
workspace on the Web portal (Admin
-
> Configure network shares).

87.

New InfoResource attributes:
author
,
subject_or_title

and
last_modification_date

were
added to the
meta_d
ata_struct

of the
meta_data_service
.


1.5

88.

Resource access policy is extended with context support. Now access to a resource can be
granted to all users who are currently assigned to the specified context(s)

89.

Primitive Events monitoring service
was added. T
his service resides in
a Windows OS service
(named “ACTIVEprocessor”)
that can be deployed on the ACTIVE server. Its purpose is to
collect all Primitive Events emitted by the workspace clients and to store them in the
workspace event repository. This servi
ce was introduced as a developer’s aid. Web portal
was extended with the context
-
based Primitive Events monitor page where short
descriptions of received Primitive Events are periodically displayed (see Events pane).

90.

Workspace resource change monit
oring su
pport was added to the w
orkspace. This support
consists of



additional Workspace Resource web service interface to register for particular resource
changes,



Generation of resource change messages in Workspace infrastructure services.

14




Dispatching of resour
ce change messages. Dispatching service resides in
Windows OS
service (named “ACTIVE
processor
”) which can be deployed on the ACTIVE server. Its
purpose is to dispatch all Event Bus messages, related to resource changes, to the
registered resource change mo
nitors and to store the latest change records for Web
portal browsing.



Testing
monitor of resource change

messages
.
This monitoring service resides in
Windows OS service (named “ACTIVE
processor
”)
which
can be deployed on the ACTIVE
server
. Monitoring servi
ce is used to
collect and to log the specified resource change

messages
. This service was introduced as developer’s aid.


91.

Shared folder registration. Web portal was extended with the registration of the
Workspace
-
wide Windows shared folders. Web service in
terface for querying the list of all
registered shared folders is also available. This interface will be used by Workspace clients
for automatic resource scope determination of InfoResources like Word documents.

92.

Changes in WSDL for ‘user’ service: several
User attributes were added.

93.

Changes in WSDL for ‘resource’ service: resource change observation registration was
added.

94.

New WSDL ‘allowed_context’: through this interface the access policy service has now
support for allowed contexts.

95.

ACTIVE toolbar
is b
eing
added to MS Word, Outlook and Internet Explorer add
-
ins

(work in
progress)
. At present the toolbar displays the current working context and supports a
button for contextual tagging of the current resource (where this is appropriate).

96.

Meta
data support
for Outlook mail messages and I
nternet Explorer URLS is being added
(work in progress).

97.

SDK documentation for the C# clients APIS has been restructured to support documentation
generation directly from C# client source code.

98.

C
hanges were made to PrimitiveE
vents.xsd schema

to align it with actual generation of
Primitive Events in client programs.

a.

In EmailPrimitiveEventParameter type defi
n
tion name of the body element is
changed form “body” to “Body”

b.

In ProcessStopEventParameter type definition TerminationTim
e and ProcessName
elements switched their places in sequence definition.

15


c.

In ReplyMailEvent type definition restricting value for Operation element was
changed from “ReplyMail ” to “ReplyMailEvent”

d.

In SendMailEvent type definition restricting value for Oper
ation element was
changed from “SendMail ” to “SendMailEvent”

e.

In WordUpdateFile type definition restricting value for Operation element was
changed from “UpdateFile ” to “WordUpdateFile”

f.

In WordReadFile type definition restricting value for Operation ele
ment was
changed from “ReadFile ” to “WordReadFile”

g.

In NavigateEvent type definition restricting value for Operation element was
changed from “Navigate ” to “WebBrowserNavigate”

99.

Word and Outlook are now generating WordReadFile and ViewMailEvent Primitive
Events as
soon as Word document is opened or email is view
ed

through Inspector window in Outlook.

100.

Primitive event messages that have file associated with them are send to

the

Event Bus
via proxy to

free
-
up

ACTIVated applications (Word and Outlook) from sen
ding file over
network. ACTIVEmonitor service serves as proxy
. This implies that
Primitive Event
generation
requires

ACTIVEmonitor service
to
be started. If PrimitiveEvents do not contain
large files then they are sent directly without proxy.

101.

Client confi
guration file
was extended with the
MAXFILESIZE parameter that indicates
maximum file size that is send to

the

Event Bus. If file exceeds this limit it will not be send to

the

Event Bus.
In this case only file

path is included in

the P
rimitive
e
vent header

message.

102.

Files in

Open From Context


menu in Word have a tooltip that displays fullpath.

103.

Fixed bug Primitive Event xml messages where TaskContext element in xml messages
contained uuid of user_context and not context.


1.4

1.

ACTIVE server port can now be c
onfigured from client configuration file.

2.

Recent files list problem in Word is fixed.

3.

TaskBar includ
e
s a button to launch the ACTIVE web portal
.

4.

Active Toolbar in Internet Explorer is automatically displayed at statup.

16


5.

Fixed problem with large network time
outs when connecting to ACTIVE server. New
parameter named AKWS_Timeout has been added in config file with default value of 5
seconds.




1.3

1.

ACTIVE SDK documentation in html form is included in the ACTIVE server package

2.

Tagging and contextua
l tagging is a
vailable for all W
orkspace resources, not just information
resources.

3.

Context switching is optimized.

4.


Primitive events for process start/stop and context switch are added.

5.

Windows service “ACTIVE monitor” is added (captures process stop/start

activity) to

the
client package.

6.

Client package setup script was extended and improved.

7.

Context switching and ACTIVE tool bar is added to IE

8.

Network deployment is now possible (server and clients deployed on different systems).


1.2

9.

Production mode of ACTIVE server op
eration is supported. This significantly improves the
responsiveness of the system. For extended debugging purposes development version is
also available. Readme file describes how to switch between the two operational versions
on the same server.

Note: us
e script init_production.bat to establish an initial production
database instead of b.bat which is used for the development environment.

10.

Outlook add
-
in features an ACTIVE
-
specific toolbar which currently only displays the current
context name.

Prerequisite
s

Operating System: Windows XP SP2, Windows 2000.

.NET Framework 3
.5 sp1 (software may work on newer .NET versions but it has not been tested due
to testing equipment availability constraints and budget restrictions)

Java Development Kit
1.4.x or newer


17


Ap
ache ActiveMQ 5.1.0

or

5.2.0

(5.3.0 is not properly configured out of the box)

InstantRails 2.0

(including Ruby, RubyOnRails, MySQL)

RMagick
2.7.1

or higher

Microsoft SQL Server Compact 3.5


Semantic MediaWiki


optional:
see details below


Hardware: for d
emonstration purposes both server and client package will run on a single system
with at least 2GB of RAM.

18


Automated Server
Installation

Automated server installation
process is used to
automatically
install the ACTIVE server bits and all
bundled software

packages which are needed for the ACTIVE server operation (with the exception
of JVM and
Microsoft SQL Server Compact
)
.
In situations where automated server installation is not
appropriate

(some pre
-
requisite packages are already available on your system)
, manual insta
llation
process
must be applied. Manual installation process is described in the next chapter. With manual
process
the administrator can combine the already existing software packages with software from
the ACTIVE package.

In any case
, Java v
irtual machine and
Microsoft SQL Server Compact 3.5

software packages are not
bundled

with the ACTIVE server package. Therefoe
they must be installed
separately
if they a
re not
already available on your server.

The following software packages are bundled a
nd will be automatically installed to the system
together with the ACTIVE server bits:



InstantRails ( with Ruby, RubyOnRails, MySQL, Apache server, PHP
)



Lighttpd



Apache ActiveMQ and



ImageMagick

You can download the initial version of the ACTIVE server p
ackage (file active_server.zip) from the
ACTIVE project’s home page (
www.active
-
project.eu
).
F
or the instructions how to perform an
upgrade of the ACTIVE server package
,

see the next section in this chapter.

Not
e that ports 3000, 4001, 4002 and 4003 must be available because they will be used in the
default automatic setup.

Initial ACTIVE server installation

Initial ACTIVE server installation must be performed the first time an ACTIVE server package is
deployed
on a system. It
consists of five

steps:


Step 1: Installing Java virtual machine

Java virtual machine

must be installed

on the server system before the ACTIVE server package
installation can take place.

Java RE can be downloaded from:

http://java.sun.com/javase/downloads/index.jsp

19


Note that JDK is available in several bundles on that website. Since the packaging naming structure
may change in time please make sure that you download the JDK
-
related

bundle like for example
‘Java SE for Business’ or ‘JDK 6 Update 16’.

The
JAVA_HOME environment variable must be set

to the directory where the JDK is installed, e.g.,
c:
\
Program Files
\
jsdk.1.4.2
-
09
. You can use Windows XP Control panel
-
> System for thi
s.


Step 2: Installing
SQLCompact

Microsoft SQL Server Compact 3.5
:
You can download the SQL Server from
http://www.microsoft.com/d
ownloads/details.aspx?FamilyId=DC614AEE
-
7E1C
-
4881
-
9C32
-
3A6CE53384D9&displaylang=en
.


Step

3
: unzipping the
ACTIVE server
package to the
server
system

Download the ACTIVE server package in zip format from the projet’s website.

Use an external unzip utility

like WINRAR to extract the downloaded zip file to your hard drive.
Suggested directory for unpacked files is


C:
\
Program Files
\
ACTIVE

Note that
unzip which is built into the Windows XP will NOT work properly.

Note that this operation will take several mi
nutes.


Step 4
: Modify the PATH environment variable

Add the following directories to the system’s PATH variable:

C:
\
Program Files
\
ACTIVE
\
system
\
ruby
\
bin

C:
\
Program Files
\
ACTIVE
\
system
\
mysql
\
bin

and make sure that your PATH variable includes also c:
\
WIND
OWS and C:
\
WINDOWS
\
system32
directories.

Step 5
: Run the setup script

Open a new command shell window and run the
active_server
_
setup.rb

script from the
c:
\
Program
Files
\
ACTIVE
\
system
directory
:

cd c:
\
Program Files
\
ACTIVE
\
system

ruby
active_server
_setup
.rb create

20


During the setup
you will be asked
a number of questions
by

the setup scripts of the particular
services. For example, you will be asked to
start the lighttpd service (enter N<enter> and press any
key to continue).
In general you should confirm
the suggested settings.

However, if you are running a localized Windows version, you have to make sure, that the
pathnames where individual services will be installed are matching the pathname where you
unpacked the server package. During the setup you wi
ll be offering the default installation
pathnames for the AKWSLogger, ContextMining and Tagging Service. Make sure to modify them if
needed to match the pathname prefix of your server package (i.e. C:
\
Program Files
\
ACTIVE) if you
decided to install the ser
ver bits there.

The script will install all required services and start them. Services will be automatically started at
system startup, too.

NOTE: Semantic Mediawiki (SMW) and respective ACTIVE extensions will not be automatically
installed. In case you wo
uld like to experiment with it, please install them manually as it is described
in the Manual installation chapter.

When the setup is completed, all ACTIVE
-
related services should be started on your server:

ACTIVEserver1

ACTIVEserver2

ACTIVEserver3

ACTIVEs
earch

ACTIVEprocessor

LightTPD

ContextMiningService

AKWSLogger

TaggingService

ACTIVETaskService

MySQL

ActiveMQ.

From here you can skip to the
Operational
instructions
Operational instructions section or you can
log into the ACTIVE Web portal and start con
figuring the system for your needs (adding users,
contexts, download client package etc). Point to
http://localhost:3000/login

in InternetExplorer and
login as a super
-
user with user name “root”, password “root” in

the ACTIVE Knowledge Workspace
Web portal.


21


ACTIVE server upgrade

You can download the ACTIVE Server Upgrade package from the project’s website (file
active_server_upgrade.zip). The difference between the initial and upgrade package is that initial
packag
e includes also a number of software prerequisites while the upgrade package includes only
ACTIVE server


related files. Please note that you have to follow different installation steps for the
upgrade (see below):

Step

1: unzipping the ACTIVE server upg
rade package to the server system

Download the ACTIVE server Upgrade package in zip format from the ACTIVE’s website.

Use an external unzip utility like WINRAR to extract the downloaded zip file to your hard drive, but
this time to
a temporary

directory. S
uggested directory for unpacked files is


C:
\
temp

Note that
unzip which is built into the Windows XP may NOT work properly.

Special note

to the ACTIVE Workspace users already running server version < 1.16: after you

unzipped the upgrade package to the C:
\
temp, create a directory C:
\
Program Files
\
ACTIVE
\
system
and copy all files from the C:
\
temp
\
system to this directory.
Only files from that directory should be
copied, no subdirectories.
This will place the newly developed setup script and related batch fi
les to
the appropriate directory for the execution.


Step 2: Run the upgrade script

Open a new command shell window and run the
active_server
_setup.rb

script from the
c:
\
Program
Files
\
ACTIVE
\
system
directory

but
this time with different parameters:

cd c:
\
Program Files
\
ACTIVE
\
system

rub
y active_server
_setup.rb upgrade C:/
temp

First parameter determines that this will be an upgrade setup and second parameter is the
pathname where the upgrade package was unzipped to the system (note forward slashes in the
p
athname!).
During the setup the ACTIVE server services will be stopped and a number of files will
be replaced with a new version from the upgrade package. Then the
ACTIVE server
services will be
re
-
started again.


ACTIVE server removal

You can remove the A
CTIVE server package with all bundled software packages and ACTIVE data
from your server system by executing the ‘delete’ option of the active_server_setup.rb script.

cd c:
\
Program Files
\
ACTIVE
\
system

22


ruby active_server
_setup.rb delete



23


Manual Server
I
nstallation

NOTE: In general manual server installation is not needed because the automated installation,
described
in the previous chapter,
will do the work for you. However, i
n situations where
automated server installation is not appropriate

because of
the actual situation on your server
,
manual installation process must be applied.

This is the case when some of the required software
packages are already in use on the server system, so automatic installation might cause some
conflicts with the existing s
oftware.

In such situations it is possible to perform ACTIVE server
installation step by step and avoid the installation of components that are already installed on the
system. However,
it is important, that exactly the same versions of the prerequisite so
ftware are
used as it is described in this document

because the system was not tested against other versions.


I
nstallation process consists of
three
phases:




One
-
time

installation and setup of the
software pre
-
requisites
for
the
ACTIVE Server system




Inst
allation and setup of the
Workspace server package

(for
each

subsequent
release
)



Installation and setup of
Workspace client package

(for each desktop connected to the
workspace)


24


One
-
time server installation and setup


JDK

On the server machine Java Devel
opment
Kit 1.4.x or greater must

be installed
in order to run the
ActiveMQ broker
. We recommend using the latest version. Java RE can be downloaded from:

http://java.sun.com/javase/downloads/index
.jsp

Note that JDK is available in several bundles on that website. Since the packaging naming structure
may change in time please make sure that you download the JDK
-
related bundle like for example
‘Java SE for Business’ or ‘JDK 6 Update 16’.

The JAVA_HO
ME environment variable must be set to the directory where the JDK is installed, e.g.,
c:
\
Program Files
\
jsdk.1.4.2
-
09
.

You can use Windows XP Control panel
-
> System for this.


Apache ActiveMQ

D
ownload Apache ActiveMQ broker
(version 5.1.0 or 5.2.0)
fro
m

http://activemq.apache.org/download.html
.

Extract
the downloaded
zip file to some loca
tion on your hard drive e.g., C
:
\
ActiveMQ.

Note that
version 5.3.0
has not been tested.
It was reported that ver
sion 5.3.0 does not work out of the box
for ACTIVE needs because STOMP channel is not started automatically. Therefore we recommend
that you work with v
ersion 5.2.0 unless you are fam
iliar with ActiveMQ and know how to configure
STOMP channel.
Now you can
run the broker by executing activemq.bat file from ActiveMQ bin
directory.

Note
: later when the ACTIVE server is installed you have to enter the hostname of the ActiveMQ
server in the ACTIVE server configuration file config/broker.yml file.

It is assumed t
hat ActiveMQ broker runs on the ACTIVE server. If this is not the case you should
modify the IP address for the ActiveMQ broker in all
client configuration files
: see notes later in this
document an
d in client package readme file
.


InstantRails 2.0

Downloa
d
zip file
InstantRails
-
2.0
-
win.zip

with
InstantRails 2.0
distribution
from


http://rubyforge.org/frs/?group_id=904
.

Unzip this file (
InstantRails
-
2.0
-
win.zip
) to
C:
\
InstantRails2.0

(this will take a whi
le
;
in case of custom
path name, m
ake sure the installation path does not contain any space characters
)

25


From

the C:
\
InstantRails2.0 directory and
run
Instantrails.exe

program.

The system may ask you to confirm that you will install from un
-
trusted source.
Just confirm this and
continue with the installation.

Instant Rails will detect that it is being started from a new directory and ask if you want to have it
update the paths in all of the configuration files... Just say

OK
.

Then your firewall might ask yo
u to unblock the Apache program. Unblock it.

Add the following pathname
s

to the system PATH:

C:
\
InstantRails2.0
\
ruby
\
bin

C:
\
InstantRails2.0
\
mysql
\
bin

Detailed installation and troubleshooting instructions for InstantRails 2.0 are available at

http://instantrails.rubyforge.org/wiki/wiki.pl?Getting_Started
.

Warning
: In case that port 80 on your server is already occupied by some web server you can
reconfigure the apache server to so
me other port. See the instructions provided on
the getting
started link above. Relevant file to change the port is
C:
\
InstantRails2.0
\
apache
\
config
\
httpd.conf
.

Note that Apache web server is only used to power the database web administration.

ACTI
VE serve
r
by default
operates on port 3000, but this is
not

configured in the
Apache
-
related
configuration files
C:
\
InstantRails2.0
\
apache
\
config
\
httpd.conf

or
C:
\
InstantRails2.0
\
conf_file
\
httpd.conf
file.

Therefore you should
not

configure port 3000 as a listen
p
ort in any of the Apache
-
related configuration files.

In case you have port 3000 occupied, you can start it on a different port (option

p on ruby
script/server command ). Please check the mongrel server documentation how to start it on a
different port.

In addition, you must configure the AKWS_PORT parameter in each client
configuration file to the new port number.

Installation of additional gems which are not included in the InstantRails package.

IMPORTANT NOTE
S
: for some language environments
it is not

possible to simply copy&paste the
command line examples
from this documen
t to the W
indows shell because some un
expected extra
characters may

appear in the pasted lines

and the command will not be executed correctly
.

In such
cases it is recommended to typ
e the command in the shell directly.

It is necessary to install
exactly the gem versions

specified in the following text.

1.

Upgrade RubyGems:

gem update
--
system

26



2.

Install following
gems
:

gem install
win32
-
ap
i

--
version 1.4.5

gem install

windows
-
pr
--
ver
sion
1.0.8

gem install getopt
--
version 1.3.8


3.

T
he 0.6.1 version
of win32
-
service

gem
is provided by the server package and is available at
C:
\
Program files
\
ACTIVE
\
server
\
vendor
\
win32
-
service
-
0.6.1
-
x86
-
mswin32
-
60.gem
. It can be
installed
like this:

cd C:
\
t
mp

copy
C:
\

Program files
\
ACTIVE
\
server
\
vendor
\
win32
-
service
-
0.6.1
-
x86
-
mswin32
-
60.gem

.

gem install win32
-
service
--
local



Now you should have the following gems installed on your system: (use ‘
gem list


command to
obtain the current list of gems on you
r system)


windows
-
pr(1.0.8)

windows
-
api(0.3.1)

win32
-
api(1.4.5)

getopt(1.3.8)

win32
-
service(0.6.1)



Rmagick




Download

zip file
RMagick
-
2.7.1
-
ImageMagick
-
6.4
.5
-
3
-
Q8.zip

or higher
from RubyForge
Rmagick project website

(
http://rubyforge.org/projects/rmagick
) or at
http://github.com/rmagick/rmagick/do
wnloads
.


NOTE

1
: go

to the
rmagick
-
win32

download link and locate the specified zip file.
Make sure

that
you downloaded the
windows
-
sp
e
cific

package which is usually not on the top of the section!


NOTE 2
: You have to install two packages which are incor
porated in that download depot: the
native windows package and Ruby gem package. Follow the instructions below.




Unzip

the downloaded f
ile to some temporary directory, say
C:
\
tmp
.



In
C:
\
tmp
directory
run

the ImageMagick installer
application
and select the

suggested defaults
during the installation process.



Run

the following dos shell command
in C:
\
tmp
directory:

27


Gem install rmagick
--
l
ocal


SQLCompact




Microsoft SQL Server Compact 3.5
:
You can download the SQL Server from
http://www.microsoft.com/downloads/details.aspx?FamilyId=DC614AEE
-
7E1C
-
4881
-
9C32
-
3A6CE53384D9&displaylang=en
.


S
emantic MediaWiki




NOTE:
it is possible to confi
gure the workspace without the Semantic MediaWiki, but then you
are not able to work with knowledge process templates.



MediaWiki Version 1.16

or higher (which is considerably higher than SMW requires). The
unified user management requires the GetPreferenc
e Hook that was only added for the most
current version of MediaWiki. Since Version 1.16 has not been released yet, the ACTIVE
extensions require actually the current SVN version of MediaWiki. The MediaWiki SVN version
can be obtained as described here:
ht
tp://mediawiki.org/wiki/Download_from_SVN



For the ActiveMQ message queuing the system requires the
STOMP library for PHP
. The ACTIVE
extensions were developed using Version 1.0 for PHP5. The Stomp library is available here:
http://stomp.codehaus.org/PHP



F
or SOAP calls, we are using the
NuSOAP

library. We developed the ACTIVE extensions using
Version 0.7.3 of NuSOAP. NuSOAP is available here
http://sourceforge.net/projects/nusoap



Create ACTIVE directo
r
ies

Create directory
c:
\
Program Files
\
ACTIVE

and
c:
\
Program Files
\
ACTIVE
\
shadows

and make it
accessible for read and write to all.


28


Workspace server package installation and setup


This paragraph describes how to install a new version of the Workspace se
rver package.

The
installation process is slightly different for
fresh
installations and for upgrades.

Fresh package
installation

For the fresh installation it is assumed that Workspace was not running on the server before.

In case that Workspace was runni
ng on the server before
then
all Workspace services have to be
stopped and unregistered and the entire file tree C:
\
Program files
\
ACTIVE
\
server has to be removed
before the installation.

There are two possibilities for the fresh installation. In first case
, an empty workspace is created and
in second case a preconfigured minimal workspace
with a number of users and
context
s

is created.

Upgrade installation

In case you are already running a Workspace on the server, it is possible to install new server
packag
e in upgrade mode. This way the Workspace data collected so far is preserved.

Package installation steps

Please note that the following text provides the instructions for both fresh and upgrade
installations. Sections which are specific for a particular ty
pe of installation are marked accordingly.

Fresh installation
-
specific steps will be enclosed in


<FRESH_INSTALLATION SECTION>

</ FRESH_INSTALLATION SECTION>

and upgrade
-
specific steps will be enclosed in


<UPGRADE SECTION>

</UPGRADE SECTION>.



<
UPGRADE

SECTION >

I
n case you are
already running

a version of the ACTIVE server
software
you should
:




stop all workspace
-
related services,



un
-
install ACTIVE client package

if deployed on server machine



un
-
install
AKWSLogger
,
ContextMiningService
,
ACTIVETaskServ
ice
, and
TaggingService

packages if deployed on the server and un
-
register the
ACTIVETaskService

and remove the
related files from the services subdirectories.



save the file
s



C:
\
Program Files
\
ACTIVE
\
server
\
config
\
broker.yml

29



C:
\
Program Files
\
ACTIVE
\
serve
r
\
config
\
ferret_server.yml


C:
\
Program Files
\
ACTIVE
\
server
\
config
\
lighttpd.conf (if used)


and
restore them

after the

server package
unzi
p.



in case you have customized the database username and password you should save the file
C:
\
Program Files
\
ACTIVE
\
serv
er
\
config
\
database.yml and restore it after the

unzip
.





r
emove

all files and
directories
except the ‘index’
sub tree

in

the
C:
\
Program
Files
\
ACTIVE
\
server

directory before

the

unzip
.
Index sub

tree
C:
\
Program
Files
\
ACTIVE
\
server
\
index

contains the search
index for the existing workspace and should
remain unchanged.


</
UPGRADE

SECTION >


1.

Un
zip

the
active_server.zip

file to
the
C:
\
Program Files
\
ACTIVE

directory.


<FRESH_INSTALLATION SECTION>


Create

index


direct
ory
in
C:
\
Program Files
\
ACTIVE
\
server
directo
ry

mkdir C:
\
Program Files
\
ACTIVE
\
server
\
index


</ FRESH_INSTALLATION SECTION>



2.

You have to
specify

the host name

of your ACTIVE server
and ActiveMQ server
in
two
configuration
files

(
config/
feret_server.yml and
config/
broker.yml) as describ
e
d in the foll
owing steps.


3.

Restore the
config/ferret_server.yml

file
in upgrade mode
or modify the
ferret server
host

name
in
this file to your ACTIVE server host name as shown below
:


production:


host:
name_of_your_ACTIVE_server


port: 9010


pid_file: log/ferret.p
id

30



#log_file: log/ferret_server.log


log_level: info



4.

Restore the
config/broker.yml

file
in upgrade mode
or modify the following lines in the
development:

and
production:

section of the
broker.yml

file:


development:


…….


adapter: stomp


host:
name_of_your_activeMQ_server


…….

production:


…….


adapter: stomp


host:
name_of_your_

activeMQ_s
erver


…….

5.

If you have customized the database username and password you should restore the
C:
\
Program
Files
\
ACTIVE
\
server
\
config
\
database.yml

in upgrade mode or edit the database.yml file accordingly.


6.

Start the ActiveMQ broker by executing
activemq.bat

file from ActiveMQ/bin directory
. If you are
managing the Workspace through the Windows OS Servi
c
es Console, t
hen use that interface
instead.


7.

Start the InstantRails servers: Run C:
\
InstantRails2.0
\
InstantRails.exe and wait for the green light on
traffic lights at Apache and My
SQL

buttons in Instant Rails window.

If you are managing the
Worksp
ace through the Wind
ows OS Serv
i
c
es Console, then use that interface instead.



8.

Register the ACTIVEsearch Windows OS service and start it
. Note: this service must be running
before the

next installation steps are taken.



cd C:
\
Program Files
\
ACTIVE
\
server
\
script

ruby ferret_
processor_ctl.rb

i

net start ACTIVEsearch


9.

Creation or upgrade of Workspace database
.


31


Please note
that
MySQL, ActiveMQ and ACTIVEsearch

services
must

be running before the commands
from this step are executed
.

If
ACTIVEsearch

is not running the system wi
ll run slowly and workspace
search will not be possible.

<FRESH_INSTALLATION SECTION
>



In C:
\
Program Files
\
ACTIVE
\
server directory
execute
the command




ruby script/make_workspace.rb create



to create the initial empty configuration of the production v
ersion of the ACTIVE Knowledge
Workspace



or



execute the command



ruby script/make_workspace.rb demo



to create a preconfigured demo database of the production version of the ACTIVE Knowledge
Workspace or execute the command


</ FRESH_INSTALLATION S
ECTION>


<
UPGRADE

SECTION >


To upgrade the existing Workspace database to conform to the newly installed version of
the Workspace
software execute the command



ruby script/make_workspace.rb upgrade


</
UPGRADE

SECTION >



32


10.

In C:
\
Program Files
\
ACTIVE
\
serv
er directory
run

the
dos shell
command



ruby script/server

--
environment=production


to start the
production version of the
ACTIVE
server
.



If you are managing the Workspace through the Windows OS Serv
ices

Console
, then use that
interface instead.



11.

Poin
t to
http://localhost:3000/login

in InternetExplorer and login as
a
super
-
user with user name
“root”, password “root”

in the ACTIVE Knowledge W
orkspace Web portal


12.

ACTIVE SDK
documentation
in HTML form is available

at



C:
\
Program Files
\
ACTIVE
\
server
\
doc
\
app
\
index.html.


13.

Semantic Media Wiki (SMW) server setup.



You need
this setup only if you are interested in working wi
th knowledge process templates on your
own SMW server, not on the default project SMW demo serve
r
(
http://km.aifb.kit.edu/projects/active
-
akws
-
demo/
).


Initial SMW software should be obtained and installed as suggested earlier in this document.
Due to
current limitation in AKWS client package setup it is necessary that your SMW URI has the following
structure:
http://yourSMWserver/projects/active
-
akws
-
demo/
. Please make sure to set up your
Apache configuration file to adhere to this requirement.


Next your

SMW
has to be extended with

t
he ACTIVE extensions as follows. ACTIVE extensions
are
available in ACTIVE server package and were unzipped to the in C:
\
Program
Files
\
ACTIVE
\
server
\
services
\
SMWExtensionPackage. They need to be
copied to the MediaWiki
extensions directory into the direc
tory ActiveExtensions. In order to add the ACTIVE extensions, the
following line has to be added to the file LocalSettings.php of the Semantic MediaWiki instance to
be extended.

require_once
(
"
$IP
/extensions/ActiveExtensions/
AE_Settings
.php"
);

Before that
line, we need to set up a number of configuration variables being set up. Currently,
there are four such variables (here you see example values that will connect you to the ACTIVE
server on hope.ijs.si:

$agActiveMQHost
=
'http://
hope.ijs.si
:
8161
'
;

33


$agAKWSS
erver
=
'http://
hope
.ijs.si:3000'
;

$agNuSoapLibrary
=
'
C:
\
\
Programs
\
nusoap
-
0.7.3'
;

$agActiveMQHost
gives the URL of the ActiveMQ host the update messages are sent to.

$agAKWSServer
gives the URL of the AKWS server. Using that, the system queries for the UU
ID
of the user and the context of the user.

$agNuSoapLibrary
gives the path to the NuSoapLibrary.

Now SMW server can be started as described in the SMW documentation on the Web.



14.

I
nstall and c
onfigure the
TaskService.
TaskService
-
related files are

located

in the

C:
\
Program Files
\
ACTIVE
\
server
\
services
\
TaskService

directory.



You can install the TaskService
as a
W
indows
OS
service. This has to be installed from an elaborated
shell (shell with admin rights + visual

studio tools). In the TaskService director
y you have to run
:




For

i
nstallations: C:>installutil

/i TaskServiceConsole.exe




For u
ninstallation: C:>insta
llutil

/u TaskServiceConsole.exe


Installutil

can be found in C:
\
WINDOWS
\
Microsoft.NET
\
Framework
\
v2.0.50727
.


Do not

forget to start the service: In the services control pane
l you have to start the service named
ACTIVETaskService

.



15.

Install and configure the
MetadataRecommenderService
.

This service is provided in form of a self
-
installable msi package which is locate
d
in

the

C:
\
Program Files
\
ACTIVE
\
server
\
services
\
MetaDataRecommenderServicePackage

directory.
Just
start the TaggingServiceSetup.msi program and follow the setup dialog. It is recommended that you
select the following installation pathname instead of the de
fault one:


C:
\
Program Files
\
ACTIVE
\
server
\
services
\
MetaDataRecommenderService.

This directory is already
pre
-
configured on the server.

Setup will install the MetaDataRecommenderService as Windows OS service named
TaggingService
.


You can

uninstall th
e r
ecommender service
by using the Add/Remove Programs from the Control
Panel.


16.

Install and configure the
AKWSLogger.

This service is a prerequisite for the context mining service.
This service is provided in form of a self
-
installable msi package which is lo
cate
d in

the

C:
\
Program Files
\
ACTIVE
\
server
\
services
\
AKWSLoggerPackage directory. Just start the
AKWSLoggerSetup.msi program and follow the setup dialog. It is recommended that you select the
following installation pathname instead of the default one, sug
gested by the setup program:

34



C:
\
Program Files
\
ACTIVE
\
server
\
services
\
AKWSLogger.
This directory is already pre
-
configured on
the server.

Setup will install the logger service as Windows OS service named
AKWS
Logger
.


Before you start the service you shoul
d manually define the name of the ACTIVE server in config file
AKWSLogger.exe.config in the …/ACTIVE/server/services/AKWSLogger directory. Look for the
occurance of active.ijs.si and replace it with your server name.


You can uninstall the logger service
by using the Add/Remove Programs from the Control Panel.



17.

Install and configure the
ContextMiningService
.



This service is provided in form of a self
-
installable msi package which is locate
d in

the

C:
\
Program Files
\
ACTIVE
\
server
\
services
\
ContextMiningSe
rvicePackage directory. Just start the
ContextMiningSetup.msi program and follow the setup dialog. It is recommended that you select
the following installation pathname instead of the default one:


C:
\
Program Files
\
ACTIVE
\
server
\
services
\
ContextMiningServ
ice.

This directory is already pre
-
configured on the server.


Setup will install the Co
ntextMiningService as Windows OS service named
ContextMiningService
.


You c
an uninstall the ContextMiningS
ervice service by using the Add/Remove Programs from the
Contro
l Panel.


Before you start the service you should manually define the name of the ACTIVE server in all config
files in the …/ACTIVE/server/services/ContexMiningService directory. Look for the occurances of
active.ijs.si and replace them with your server n
ame. You have to uncomment some lines, too. See
the inline comments in the config files.


Prerequisite for the context mining service is that the AKWSLogger service is running on the ACTIVE
server.

The installation produces the following artifacts:



A Windo
ws service called ‘
ContextMiningService’
, which consumes the events in real
-
time
and performs context switch detection. Its web service interface is accessible at
http://localhost:8731/ContextMining/?WSDL



A scheduled task “
AKWSLog2TimeFall
”: a batch job, e
xecuted every 5 minutes which
performs context discovery and notification of the Context Service about new discoveries. It
35


can also be executed manually by running the
Log2TimeFall.exe
executable in the
ContextMiningService directory with the parameter “
Lo
g2TimeFall.exe TODAY




A test program,
AKWSMiningTest,
available as A
KWSMiningTest.exe
in the main
directory. Its purpose is to be a diagnostic front
-
end to the Context Mining service and
enables inspection of discovered contexts and simulation of new event
s from existing logs..

Other resources associated within the installation: