QM1206 Seneca Client Add-Ins and Optional Components ... · Microsoft Office Add-Ins plus any additional components. Important - Windows user accounts require Read and Write access

Seneca Client, Add-Ins and Optional Components

Installation

QM1206 Seneca Client, Add-Ins and Optional Components Installation

Page 2 Saved as: QM1206 Seneca Client Add-Ins and Optional Components Installation.doc

© Copyright Egton Medical Information Systems Limited 2018

Controlled Document Version 6: 11 June 2017.

Title: QM1206 Seneca Client Add-Ins and Optional Components

Installation

Saved as: QM1206 Seneca Client Add-Ins and Optional

Components Installation.doc

Published by EMIS Documentation

Egton is a trading name of Egton Medical Information Systems

Limited

No part of this document may be sold, hired, reproduced or

transmitted in any form or by any means, electronic or

mechanical, including photocopying, recording and information

storage and retrieval systems for any other purpose than the

purchaser’s use without the express written permission of Egton.

Every effort is made to ensure that your Egton documentation is

up to date, but our commitment to constantly improve our

software and systems means that there may have been changes

since this document was produced

Associated documentation

QM1210-Seneca System Requirements and Supported Platforms

Overview

QM1209-Seneca Server Components Installation and

Configuration


Saved as: QM1206 Seneca Client Add-Ins and Optional Components Installation.doc Page 3

Contents 1 Purpose ...................................................................................................................................... 4

2 Seneca Client Installation ........................................................................................................... 5 2.1 Installation Requirements ................................................................................................................. 5

2.1.1 Data Execution Prevention (DEP) ................................................................................................................. 5 2.1.2 .NET 3.5 ......................................................................................................................................................... 5 2.1.3 Windows Firewall - SenecaCM Patch ........................................................................................................... 5 2.1.4 Windows Firewall - Port 40000-50000 for Sending Objects .......................................................................... 5 2.1.5 Folder permissions ........................................................................................................................................ 6

2.2 Installing the Seneca Client .............................................................................................................. 6 2.2.1 Changing the FTP Application Server Address ............................................................................................. 7 2.2.2 Changing or Adding Database Connections ................................................................................................. 7 2.2.3 Additional Registry String Values .................................................................................................................. 8

2.3 Configuration of Windows Registry Keys .......................................................................................... 9

3 Seneca Microsoft Office Add-Ins .............................................................................................. 10 3.1 Add-Ins Installation ......................................................................................................................... 10

3.1.1 Testing the Add-Ins ...................................................................................................................................... 10 3.1.2 Updates to the Add-Ins ................................................................................................................................ 10

4 Seneca Adobe Plug-In .............................................................................................................. 12 4.1 Installation Requirements ............................................................................................................... 12 4.2 Installation - First Method - Through Seneca .................................................................................. 12 4.3 Installation - Second Method - Deployment .................................................................................... 13

4.3.1 SenecaCM.API ............................................................................................................................................ 13 4.3.2 ProtectedModeWhitelistConfig.txt ............................................................................................................... 13 4.3.3 DWORD Value - bUseWhitelistConfigFile ................................................................................................... 13 4.3.4 Testing the Adobe Plug-In ........................................................................................................................... 13

4.4 Microsoft Windows 10 Operating System ....................................................................................... 14



1 Purpose

The purpose of this document is to detail the installation process for the Seneca client software, the Seneca

Microsoft Office Add-Ins plus any additional components.

Important - Windows user accounts require Read and Write access to parts of the Windows Registry and

certain Windows folders on each client computer. The Registry and security requirements should be

preconfigured by those responsible for a customer’s IT management.

The software installations should be performed using a Windows user account which is a member of the

Administrators group on the computer or Windows domain.



2 Seneca Client Installation

The installers for the Seneca client and Seneca Microsoft Office Add-Ins can be downloaded from the

Egton FTP server:

ftp://ftp.senecacm.co.uk/SenecaInstalls

Please contact Egton for logon details - [email protected] or call 0845 1 22 33 42.

2.1 Installation Requirements

Before installing Seneca there are several prerequisites which must be considered.

2.1.1 Data Execution Prevention (DEP)

Data Execution Prevention (DEP) must be set when installing the Seneca client software on a Windows

Server Operating System. If this is not configured the Seneca client will not be able to connect to the SQL

database via the ODBC Windows database drivers.

To change the DEP settings, navigate to Start -> Control Panel -> System and Security -> System ->

Advanced system settings. On the new window, navigate to the ‘Advanced’ tab -> Settings (under the

performance section). A new window will appear, select the Data Execution Prevention tab, click the

“Turn on DEP for essential programs and services only” radio button, select OK and then restart the

computer.

2.1.2 .NET 3.5

.NET 3.5 must be enabled/installed on Windows 8 & Windows Server 2012 Operating Systems onwards.

This can be enabled via ‘Programs and Features’ and may require the original installation disk or access

to Windows Updates.

2.1.3 Windows Firewall - SenecaCM Patch

If the Firewall is enabled on the computer, you may need to create an Inbound Rule to allow

SenecaCM.exe to connect to the local patch server.

If required, launch the Command Prompt and type the following command (for the relevant Operating

System):

32-Bit Operating Systems

netsh advfirewall firewall add rule name="Seneca Client - Patching" dir=in action=allow

program="C:\Program Files\Seneca\SenecaCM.exe" enable=yes


netsh advfirewall firewall add rule name="Seneca Client - Patching" dir=in action=allow

program="C:\Program Files (x86)\Seneca\SenecaCM.exe" enable=yes

2.1.4 Windows Firewall - Port 40000-50000 for Sending Objects

If the Firewall is enabled on the computer, you may need to create an Inbound Rule to allow Seneca to

send and receive objects from the FTP Server.

If required, launch the Command Prompt and type the following command:

ftp://ftp.senecacm.co.uk/SenecaInstalls

mailto:[email protected]



netsh advfirewall firewall add rule name="Seneca Client - FTP Ports" dir=in action=allow protocol=TCP

localport=40000-50000

2.1.5 Folder permissions

Regardless of whether the Windows user account being used to install the Seneca client application is an

administrator or not, you must configure Read and Write permissions for all Windows users to the

Windows folders locations below so that the Seneca application can function and update correctly. This

should ideally be applied to all users or an appropriate Windows user group in case other Windows users

access the computer.


C:\Temp (Temporary file location)

C:\Program Files\Seneca (Seneca application)

C:\Program Files\Egton (Seneca office add-ins)


C:\Temp (Temporary file location)

C:\Program Files (x86)\Seneca (Seneca application)

C:\Program Files (x86)\Egton (Seneca office add-ins)

The ‘Seneca’ folder will not be created until after the Seneca client installation is complete. However, the

folder can be created manually beforehand if you wish to set the permissions in advance.

The Seneca client will write to the “c:\Temp” folder and a sub folder within that named “SenecaCM”

which will be created after the Seneca client installation is complete. Seneca will write to these folders

frequently. When a Windows object is added to Seneca or opened from Seneca, a copy is sent to

“C:\Temp\SenecaCM”. This folder is cleared out each day when the Seneca client is closed and

relaunched. If the Seneca ‘CITRIX’ registry key is set to ‘1’, the folder will be cleared after 2 days to avoid

affecting other sessions.

2.2 Installing the Seneca Client

During the installation process, a window will appear asking for the following to be specified:

Seneca FTP Application Server Address - This should be completed with the FTP Application

Server IP Address or Hostname.

Seneca SQL Server Connection Name - This should be completed with the name/alias you wish

to assign to the Seneca database connection.

Seneca SQL Server Address (including the instance) - This should be completed with the SQL

Server IP Address or Hostname. If SQL server is running on a named instance, a forward slash

and the name of the instance must be added after the server IP/hostname e.g. sqlserver/SENECA.

Seneca SQL Database Name - This should be completed with the required Seneca SQL Server

database name. The database name must be uppercase and start with the name SENECA.



Once you have entered these details, click Save and the installation will continue.

Once the installation is complete, a “SenecaCM” shortcut will be placed on the desktop. You will then be

able to launch Seneca using that shortcut.

2.2.1 Changing the FTP Application Server Address

The FTP Application Server Address is stored within the Windows Registry on the client as a String

Value called ‘FTPSERVER’. It can be found in the Registry Editor via the following path(s):


HKEY_LOCAL_MACHINE\SOFTWARE\EMIS\SENECA


HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\EMIS\SENECA

2.2.2 Changing or Adding Database Connections

The database connection details are stored in the following Windows Folders:

32-Bit Operating System

C:\Program Files\Seneca\SMConnect.stu


C:\Program Files (x86)\Seneca\SMConnect.stu

Additional database connections can be configured if there is more than one Seneca database.

When Seneca has been launched, click on the ‘Manage Connections’ icon (spanner + glasses), to open the

Seneca Connection window.



With the Seneca Connections window on screen, select Add to create a new connection or double click an

existing connection to edit it.

In the Connection Details window, enter the following:

Name - The name/alias you want to assign to the connection.

Server - The IP address or Hostname of the database server.

Database - Select the database you want to connect to from the drop list.

Once the details have been entered, click OK to both windows to complete the connection details.

2.2.3 Additional Registry String Values

There are additional String Values which may be required on the client and must be added manually to

the following Windows Registry locations (depending on the client Operating System):





MULTICM

When the data is set to ‘1’ multiple copies of Seneca can be run on the same machine. Each Seneca

instance will create a new SQL server database connection; the SQL server may be limited to a number of

concurrent connections via its license.

AUTOSAVELOCATION

The registry key points to a folder (local or shared path) to store telephone notes, file notes etc. This

overrides the standard “C:\Temp\SenecaCM\AutoSave” location. The Windows user(s) must have full

Read and Write access to the specified location.

CITRIX

This String Value is only applicable to Citrix application servers. It tells the Seneca application that it is

running within a Citrix environment. When this is set, Seneca will run an application on logon which will



determine the IP Address of the local machine on which Seneca is running. The Seneca home page will

display the Citrix icon with a tool tip giving the local IP Address.

2.3 Configuration of Windows Registry Keys

For the Seneca application to function correctly, you must configure Read and Write permissions to the

following Windows Registry locations for the Windows user account as part of the installation process:



HKEY_LOCAL_MACHINE \SOFTWARE\ODBC

HKEY_LOCAL_MACHINE \SOFTWARE\Microsoft\MSSQLServer\Client

HKEY_LOCAL_MACHINE \SOFTWARE\Philips Speech\SpeechMike Control

HKEY_LOCAL_MACHINE \SOFTWARE\Policies\{AdobeVersion}



HKEY_LOCAL_MACHINE \SOFTWARE\Wow6432Node\ODBC

HKEY_LOCAL_MACHINE \SOFTWARE\Wow6432Node\Microsoft\MSSQLServer\Client

HKEY_LOCAL_MACHINE \SOFTWARE\Wow6432Node\Philips Speech\SpeechMike

Control

HKEY_LOCAL_MACHINE \SOFTWARE\Wow6432Node\Policies\{AdobeVersion}



3 Seneca Microsoft Office Add-Ins

Warning - The Seneca Office Add-Ins are only supported on the 32 bit versions of Microsoft Office. They

DO NOT function with the 64 bit versions of Microsoft Office.

Once the Seneca client installation is complete the Seneca Microsoft Office Add-Ins must be installed.

Note - All Microsoft Office applications must be closed down before running the Add-Ins installer.

3.1 Add-Ins Installation

The Seneca Add-Ins installer will be stored on the machine after patching in one of the following locations

(depending on the Operating System):


C:\Program Files\Seneca\SenecaOfficeAddins.msi


C:\Program Files (x86)\Seneca\SenecaOfficeAddins.msi

The installer can also be found within the Seneca CM Master folder on the local patching server.

The Add-Ins installation process is a simple Next > Next operation once the installation file has been

downloaded and launched.

3.1.1 Testing the Add-Ins

Once the installation is complete, the SenecaCM button should appear in the ‘Add-Ins’ tab of the ribbon

for the following Microsoft Office applications:

Outlook

Word

Excel

PowerPoint

It is advised to test each button and attach an E-mail, a Word Document, an Excel Workbook and a

PowerPoint Presentation to a Seneca File to ensure that the buttons are all working after the installation.

3.1.2 Updates to the Add-Ins

By default the Seneca Microsoft Office Add-Ins DLL’s will be stored in the following folder location(s)

(depending on the client Operating System):


C:\Program Files\Egton\SenecaOfficeAddins


C:\Program Files (x86)\Egton\SenecaOfficeAddins



Any updates to the Add-Ins are controlled by the Seneca client. When a new Seneca version is available

the Seneca client will update the DLL’s in this location once Seneca has been launched and logged into on

the client.

Warning - In order for the Seneca Microsoft Office Add-Ins to update (i.e. following a new Seneca

release), Seneca must be launched first before any Microsoft Office applications. If not, a warning will be

displayed on the client (and will vary depending on which Microsoft Office application is currently open

and which Operating System the client is running):

“Microsoft Outlook is open. Please close all copies the select ‘Yes’. Seneca is unable to update the file

SenecaCMOutlookAddIn.dll in C:\Program Files (x86)\Egton\SenecaOfficeAddins\ Retry copy?”

If the above warning appears at any time, you must close the Microsoft Office application which has been

detected then click ‘Yes’ to retry the copying of the Add-In DLL file for the update.



4 Seneca Adobe Plug-In

Installation of the Seneca Adobe Plug-In can be done via 2 methods. The first method explains how an

end user is able to install the Plug-In themselves.

The second method explains the process of deploying the Plug-In with no user interaction.

Once the Plug-In has been installed, it should appear under the toolbar name ‘SenecaCM’ in Adobe:

4.1 Installation Requirements

To install the Plug-In, if the Windows user account is not an Administrator, the user account must have

Read and Write permissions to the following Windows folders and Windows Registry locations.

Note - These permissions are only required as a one-off for the Adobe Plug-In installation.


C:\Program Files\Adobe\Reader {version}\Reader

C:\Program Files\Adobe\Acrobat Reader {version}

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\{AdobeVersion}

64-Bit Operating Systems location

C:\Program Files (x86)\Adobe\Reader {version}\Reader

C:\Program Files (x86)\Adobe\Acrobat Reader {version}

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Policies\{AdobeVersion}

4.2 Installation - First Method - Through Seneca

A full installation of the Seneca client must be completed first.

To install the Adobe Plug-In, launch Seneca, log in, then navigate to Support -> Module Versions -> A-

Adobe Plug-In.

The Seneca Adobe Plug-In installation screen will appear listing any installed Adobe products (Acrobat

or Reader) from version 10 and above. Place a tick to select the appropriate product and press F8 on the

keyboard or click F8-Install to proceed.

A message will appear ‘Please ensure that any copies of Adobe Acrobat or Adobe Reader are closed.’ Ensure any

instances of Adobe Acrobat or Adobe Reader are closed and click OK on the confirmation message to

proceed with the installation.

The Seneca Adobe Plug-In installation screen will display the installation status showing a log of the

install activities. The ‘Done’ status indicates that the installation is complete.



4.3 Installation - Second Method - Deployment

This section explains the installation process via deployment and helps provide information to IT staff

who wish to deploy the Adobe Plug-In via Group Policy or another Desktop Management Tool.

In summary, 2 files (which can be found within the Seneca CM Master folder on the patching server) are

copied to a specific location and a DWORD Value is also added into the Windows Registry.

4.3.1 SenecaCM.API

The SenecaCM.API file is used to display and control the SenecaCM Plug-In button which is present in

Adobe Reader/Acrobat.

This file needs to be copied from the Seneca folder (or Seneca CM Master folder) into either:


C:\Program Files\Adobe\Reader {version}\Reader\plug_ins


C:\Program Files (x86)\Adobe\Reader {version}\Reader\plug_ins

4.3.2 ProtectedModeWhitelistConfig.txt

Adobe Acrobat/Reader has security built in. The ‘ProtectedModeWhitelistConfig.txt’ file tells Adobe that

it needs to allow the Plug-In to write to the folder ‘C:\Temp\SenecaCM’.

This file needs to be copied from the Seneca folder (or Seneca CM Master folder) into either:


C:\Program Files\Adobe\Reader {version}\Reader\plug_ins


C:\Program Files (x86)\Adobe\Reader {version}\Reader\plug_ins

4.3.3 DWORD Value - bUseWhitelistConfigFile

Within the Windows Registry on the user account, a DWORD Sting Value named

bUseWhitelistConfigFile (data = 1) must be added to the following Windows Registry location

(depending on the client Operating System):


HKEY_LOCAL_MACHINE\SOFTWARE\Policies\{AdobeVersion}


HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Policies\{AdobeVersion}

4.3.4 Testing the Adobe Plug-In

Once the installation is complete, the Plug-In should appear under the toolbar name ‘SenecaCM’ in

Adobe.

It is advised to test the Plug-In and attach a PDF to a Seneca File to ensure that the Plug-In is working

correctly after the installation.



4.4 Microsoft Windows 10 Operating System

Seneca is fully supported running on Microsoft Windows 10 but does require the correct installation

procedure being followed.

It is advised to install the SenecaCMClient.msi and SenecaOfficeAddins.msi under a Windows

Administrator account. The Windows folders and registry key permissions must be set.

Once this is configured correctly, standard users (without administration rights) can log onto the

computer and use the application correctly.

It is not advised to adjust application elevation levels as this can cause issues with the Seneca Office

integration. Running as a standard Windows account will prevent any issues with the integration

between Seneca and the Microsoft Office applications.

QM1206 Seneca Client Add-Ins and Optional Components ... · Microsoft Office Add-Ins plus any additional components. Important - Windows user accounts require Read and Write access

Documents