Knowledgesync V10 Installation Manual

Download as pdf or txt
Download as pdf or txt
You are on page 1of 10

KnowledgeSync V10 Installation Manual

1 Welcome to KnowledgeSync! .......................................................................................................................................... 1


2 System Requirements...................................................................................................................................................... 2
3 Upgrading ........................................................................................................................................................................ 2
3.1 From Version 9.x or Older ....................................................................................................................................... 2
3.2 From Version 10.x ................................................................................................................................................... 2
4 Configuring Required Components ................................................................................................................................. 2
4.1 IIS ............................................................................................................................................................................. 2
4.2 SQL Server ............................................................................................................................................................... 3
5 Download KnowledgeSync .............................................................................................................................................. 3
6 Choose the KnowledgeSync Server ................................................................................................................................. 3
7 Install KnowledgeSync ..................................................................................................................................................... 4
7.1 KnowledgeSync License Agreement ........................................................................................................................ 4
7.2 Installation Type ...................................................................................................................................................... 4
7.3 Confirmation of IIS Installed Components ............................................................................................................... 5
7.4 KS Web Portal & Application Server Name(s) .......................................................................................................... 5
7.5 KS Database Server Login Credentials ..................................................................................................................... 6
7.6 KS Installation – Execution....................................................................................................................................... 6
7.7 KS Installation – Completion .................................................................................................................................... 7
8 Configure Windows Service ............................................................................................................................................. 7
8.1 KnowledgeSync User Account ................................................................................................................................. 7
8.2 User Account Specifications .................................................................................................................................... 8
8.3 Configure the KnowledgeSync Service .................................................................................................................... 8
9 Log into KnowledgeSync .................................................................................................................................................. 8
10 Your KnowledgeSync License........................................................................................................................................... 9
10.1 Check Your License Code! ....................................................................................................................................... 9
10.2 What Your License Means ....................................................................................................................................... 9
11 Configuration................................................................................................................................................................. 10
12 For More Help ............................................................................................................................................................... 10

1 Welcome to KnowledgeSync!
Welcome to KnowledgeSync (“KS”), the industry’s leading Business Activity Monitoring (BAM) technology.
This guide helps you install KnowledgeSync version 10 according to the needs of your organization. We hope you enjoy
working with KnowledgeSync and encourage you to contact us with your feedback (contact information is at the end).
Now let’s get started with KnowledgeSync!

V2020-01-08a For Customer Use 1


KnowledgeSync V10 Installation Manual
2 System Requirements
Please see the KnowledgeSync System Requirements document to ensure your system will support KnowledgeSync.

3 Upgrading
Upgrading adds a few steps as shown below. After completing these steps, you must complete the remaining installation
steps in this guide.
3.1 From Version 9.x or Older
Before upgrading from a previous version to v10, you must:
 Be running version 8.x or 9.x of KnowledgeSync
 Migrate your KnowledgeSync installation to a SQL Server database
 Stop the V9 (or V8) Windows Service.
During the installation process:
 Your existing KnowledgeSync settings database will be backed up.
 All your existing KnowledgeSync data (queries, events, subscribers, etc.) will be carried over to the installation of
v10.
After installing version 10, please uninstall the earlier version.
3.2 From Version 10.x
If KS V10.0.0 has been installed on a machine, you must uninstall it before installing KS V10.1.0. Databases will remain
intact and all data will be upgraded in place.
In most cases, after installation you must clear your browser cache for each client browser accessing KnowledgeSync to
see the user interface updates for the newer version.

4 Configuring Required Components


4.1 IIS
KnowledgeSync uses a web component requiring that IIS be enabled and that specific IIS components be enabled in
Windows. The installation will not be successful if IIS is not detected, and if specific IIS components are not enabled.
To enable IIS and its required components (e.g., on Windows Server 2016), follow these steps:
1. Open Server Manager and click Manage, Add Roles, and Features. Click Next.
2. Select role-based or feature-based installation and click Next.
3. Select the appropriate server. The local server is selected by default. Click Next.
4. Enable Web Server (IIS) and click Next.
5. No additional features are necessary to install the Web Adaptor, so click Next.
6. On the Web Server Role (IIS) dialog box, click Next.
7. On the Select role services dialog box, verify that the web server components listed below are enabled. Click Next.
8. Verify that your settings are correct and click Install.
9. When the installation completes, click Close to exit the wizard.
The IIS components listed below satisfy the minimum requirements to run the KnowledgeSync web application. If other IIS
components are enabled, they do not need to be removed.
Web Server Management Tools

V2020-01-08a For Customer Use 2


KnowledgeSync V10 Installation Manual
 Common HTTP Features  IIS Management Console
o Default Document  IIS 6 Management Compatibility
o Static Content o IIS 6 Metabase Compatibility
 Security  IIS Management Scripts and Tools
o Request Filtering  Management Service
o Basic Authentication
o Windows Authentication
 Application Development
o .NET Extensibility 4.6
o .NET Extensibility
o ASP.NET 4.6
o ASP.NET
o ISAPI Extensions
o ISAPI Filters

4.2 SQL Server


You must have access to Microsoft SQL Server on either your local computer, network, or hosted service. Before
beginning the installation, you must have:
 The network name or address of the SQL Server instance, and
 The username and password of the SQL Server user with read and write permissions to the server so the
KnowledgeSync installer can create its databases.

5 Download KnowledgeSync
The first step is to download KnowledgeSync as instructed in your welcome email, or if you are an ECI ERP customer, from
your ECI ServiceCloud account.
The installation is password-protected, and you will be emailed the corresponding password upon your submission of
the download form. If you did not receive such an email, check your spam or junk mail folders, or contact
KnowledgeSync Support using the form on the KnowledgeSync website.

6 Choose the KnowledgeSync Server


The KnowledgeSync engine is installed on a single machine – a server from which it can access the sources of data (e.g.,
the databases) you wish it to monitor. Additionally, the KnowledgeSync web client portal may be installed on the
KnowledgeSync engine server as well as on remote systems.
All set-up and maintenance of KnowledgeSync is done from the browser portal.
If you would like some assistance with choosing the machine on which you would like to install, please read our FAQ
document: http://03c0901.netsolvps.com/lit/ks_faq.pdf
When you purchased KnowledgeSync, you were provided with a license that enables you to install and run the
KnowledgeSync server on a single named server. Do not install the KnowledgeSync server on any machine other than
the one you have a license for because your license will not activate KnowledgeSync on that server.
KnowledgeSync does not need to be installed on the same server as the database(s) it is monitoring. If KnowledgeSync
can access your applications’ data, it can be installed anywhere on your network.

V2020-01-08a For Customer Use 3


KnowledgeSync V10 Installation Manual
7 Install KnowledgeSync
As you install KnowledgeSync, you will receive several prompts that you need to reply to (the acceptance of license
agreement, installation location, IIS installation confirmation, port number, SQL instance name), and then you will be
prompted to specify the KnowledgeSync components that you wish to install.

KNOWLEDGESYNC INSTALLATION WINDOW


7.1 KnowledgeSync License Agreement
After reviewing the KnowledgeSync License Agreement, be sure to click on the option that reads “I accept the terms of
the license agreement”.

LICENSE AGREEMENT WINDOW


7.2 Installation Type
If a new installation (or upgrade from an earlier version), click on “Complete”.

V2020-01-08a For Customer Use 4


KnowledgeSync V10 Installation Manual

INSTALLATION TYPE
7.3 Confirmation of IIS Installed Components
Be sure to review the IIS installation instructions in the following window; once you have confirmed that you have all
required IIS components installed on the KnowledgeSync server, click on “Yes” to continue the installation of
KnowledgeSync.

IIS INSTALLATION CONFIRMATION


7.4 KS Web Portal & Application Server Name(s)
Because KnowledgeSync uses a web browser interface, the installation will prompt you to select a port for the
KnowledgeSync website installation. Select an available IIS port, or create a virtual directory under the default port. Since
port 80 is the standard default, you may wish to select some other port for KnowledgeSync (such as port 82).
The following window prompts you to specify the port from which the KnowledgeSync web portal will run, as well as the
name of the KnowledgeSync application server. You will need to enter multiple server names only if you have the portal
(web server) running on a different machine than the engine (Windows service). In this case, the server names should be
separated by commas.

V2020-01-08a For Customer Use 5


KnowledgeSync V10 Installation Manual

WEB PORTAL & APP SERVER NAME(S)


7.5 KS Database Server Login Credentials
Be sure to confirm the name of the database server for KnowledgeSync, specify the database authentication method, as
well as the login details for that server.

DATABASE SERVER LOGIN CREDENTIALS


7.6 KS Installation – Execution
The final installation window:

V2020-01-08a For Customer Use 6


KnowledgeSync V10 Installation Manual

BEGIN INSTALLATION
7.7 KS Installation – Completion
When the KnowledgeSync installation is complete, you’ll see the following window:

INSTALLATION COMPLETION MESSAGE

8 Configure Windows Service


8.1 KnowledgeSync User Account
Configure the account that the KnowledgeSync Windows Service will run under.
 This account must be a domain user account and a member of the “Power Users” group. (You may wish to create
a new user such as “Ksync”.)
 If KnowledgeSync will be using an Outlook/Exchange based e-mail system, be sure that the account is also a
domain controller authenticated user.

V2020-01-08a For Customer Use 7


KnowledgeSync V10 Installation Manual
 Because many KnowledgeSync events are triggered by date and/or time values, make sure that the
KnowledgeSync service is running from an account that has the correct regional settings.
8.2 User Account Specifications
The KnowledgeSync account should have local admin rights on the computer on which the KnowledgeSync service will
run. If local admin rights are not possible, give the user account the following minimum rights:
 Act as part of the operating system
 Create a token object
 Create global objects
 Create permanent shared objects
 Lock pages in memory
 Log on as a service
 Log on locally
8.3 Configure the KnowledgeSync Service
Your next step is the configuration of the KnowledgeSync Windows Service.
 Go into the Control Panel, select “Admin Tools” and then “Services”.
 Right-click on the KnowledgeSync service, choose “Properties”, and click on the “Logon” tab.
 Select the “This Account” option.
 Enter the username and password of the account the KnowledgeSync Service will be running under and select
“OK”.
 Start the KnowledgeSync Windows Service.
KnowledgeSync includes a Desktop Service (as an icon displayed to the desktop) that can be used for debugging
purposes if you are unable to start the Windows Service. Please contact KnowledgeSync Support for more details on
using this service.

9 Log into KnowledgeSync


Open a web browser and log into your KnowledgeSync website based on the location and port that you specified during
the installation process, such as:
http://KSServer.Organization-Name.com:8080 (Assumes that KS was installed on port 8080)

You will see a window such as the following (the default username is “admin” and the default password is “password”):

V2020-01-08a For Customer Use 8


KnowledgeSync V10 Installation Manual
KNOWLEDGESYNC LOGIN WINDOW

10 Your KnowledgeSync License


Once you log into KS, the following window will appear:

KNOWLEDGESYNC HOME WINDOW

If you have received a new license for KnowledgeSync, click on the “Update License” button and enter all the fields of
license details. Click on “Save” to validate your license code and return you to the previous window.
10.1 Check Your License Code!
Version 10 of KnowledgeSync requires a new license code; if you are an existing KnowledgeSync user, your Maintenance
& Support contract must be current to receive a v10 license. To receive a v10 license, please contact the KnowledgeSync
licensing department ([email protected]) and include your organization name and KnowledgeSync server name.
If you are installing KnowledgeSync for evaluation purposes, the installation comes with a 30-day, full-function license that
starts on the date you install the software.
10.2 What Your License Means
The KS license code looks like the following:

KNOWLEDGESYNC LICENSE DETAILS

V2020-01-08a For Customer Use 9


KnowledgeSync V10 Installation Manual
 License Owner: Your organization name, or “for evaluation purposes”
 Expiration Date: When this license expires (access to KS is denied)
 License Code: Unique to your organization and installed server name
 License Type: KS consists of three modules; one required and two optional. The required module is “Alerts” (or
“Core”) and allows monitoring and notifications. The optional modules are “Reports” (for running Crystal Reports,
SSRS reports, and charts), and “Workflow” for triggering updates back into various applications. If all three
modules are purchased, the license is referred to as “enterprise-webcaster” (or “Developer”).
 Server Name: The name of the computer on which the KS engine is installed.
 DB Connections: The number of applications/databases capable of being monitored by KS. In version 10, a license
may be for 1, 2, 3, or 0 – the ‘0’ for “unlimited connections”.
 Licensed Users: The number of remote, web-based users who can access the KS application.

11 Configuration
Consult the KnowledgeSync V10 User Manual for configuration details including setting up your database and API
connections as well as getting a head start using EventPaks. Do not install EventPaks until all installation steps in this
guide are complete.

12 For More Help


Contact the KnowledgeSync Technical Support Team via the web at: http://www.KnowledgeSync.com/support.php.
Thank you for your interest in KnowledgeSync and we look forward to helping you with a smooth and successful
implementation of the KnowledgeSync Business Activity Monitoring solution.

V2020-01-08a For Customer Use 10

You might also like