Kinetic InstallGuide 2021.2

Kinetic Installation
Guide
Version 2021.2
Disclaimer
This document is for informational purposes only and is subject to change without notice. This
document and its contents, including the viewpoints, dates and functional content expressed herein
are believed to be accurate as of its date of publication. However, Epicor Software Corporation makes
no guarantee, representations or warranties with regard to the enclosed information and specifically
disclaims any applicable implied warranties, such as fitness for a particular purpose, merchantability,
satisfactory quality or reasonable skill and care. As each user of Epicor software is likely to be unique
in their requirements in the use of such software and their business processes, users of this document
are always advised to discuss the content of this document with their Epicor account manager. All
information contained herein is subject to change without notice and changes to this document since
printing and other important information about the software product are made or published in
release notes, and you are urged to obtain the current release notes for the software product. We
welcome user comments and reserve the right to revise this publication and/or make improvements
or changes to the products or programs described in this publication at any time, without notice.
The usage of any Epicor software shall be pursuant to an Epicor end user license agreement and the
performance of any consulting services by Epicor personnel shall be pursuant to Epicor's standard
services terms and conditions. Usage of the solution(s) described in this document with other Epicor
software or third party products may require the purchase of licenses for such other products. Where
any software is expressed to be compliant with local laws or requirements in this document, such
compliance is not a warranty and is based solely on Epicor's current understanding of such laws and
requirements. All laws and requirements are subject to varying interpretations as well as to change
and accordingly Epicor cannot guarantee that the software will be compliant and up to date with such
changes. All statements of platform and product compatibility in this document shall be considered
individually in relation to the products referred to in the relevant statement, i.e., where any Epicor
software is stated to be compatible with one product and also stated to be compatible with another
product, it should not be interpreted that such Epicor software is compatible with both of the
products running at the same time on the same platform or environment. Additionally platform or
product compatibility may require the application of Epicor or third-party updates, patches and/or
service packs and Epicor has no responsibility for compatibility issues which may be caused by
updates, patches and/or service packs released by third parties after the date of publication of this
document.
Epicor® is a registered trademark and/or trademark of Epicor Software Corporation in the United
States, certain other countries and/or the EU. All other trademarks mentioned are the property of
their respective owners.
Copyright © 2021 Epicor Software Corporation Epicor.
All rights reserved. No part of this publication may be reproduced in any form without the prior
written consent of Epicor Software Corporation.
Kinetic Installation Guide
Table of Contents
Getting Started 7
Understanding the Installation Flow 7
Verifying Access to EPICweb 8
Reviewing Release Notes Documents 9
Verifying Windows Operating System Requirements 9
Verifying SQL Server Install and Features 11
Configuring Server Roles (Windows Server 2019 or 2016) 15
Installing Roles and Features 16
Configuring Windows Search 18
Configuring Server Roles (Windows Server 2012 R2) 18
Installing Roles and Features 19
Configuring Windows Search 21
Verifying SQL Server Reporting Services (SSRS) Prerequisites 21
Preparing SQL Server Login Account 23
Setting Up Test Environment 23
Installation and Configuration 25
Installing Kinetic 25
Installing Kinetic 2021.2.x (11.1.200.x) Latest Update 27
Configuring Kinetic Database 28
Adding a Database Server 28
Adding a Kinetic Database 30
Configuring Kinetic SQL Server Login Account 37
Adding Kinetic Server 38
Adding Kinetic Application Server (New Install or Upgrade From Epicor 10.0) 41
Adding an Application Server 41
Defining the Application Server Settings 44
Defining Database Connection Settings 52
Defining Admin Console Settings 53
Configuring Reporting Services 55
Deploying the Application Server 58
Restarting Internet Services 62
Importing the License File and Enabling Modules 63
Adding Companies 65
Post-Installation 68
Configuring the System Agent 68
Defining the Company Email Settings 68
Creating the System Agent User Account 69
3 January, 2022
Creating the System Agent‌ 71

Installing and Configuring the Task Agent 73
Installing the Task Agent 73
Configuring the Task Agent 76
Verifying SQL Search Services for Full-Text Search 78
Installing Extension Applications 79
Installing Enterprise Search 80
Installing Information Worker 83
Installing Data Discovery 84
Installing Classic Web Access 88
Installing Classic Mobile Access 91
Installing Custom Configurator 93
Configuring Extension Applications 96
Configuring Enterprise Search 96
Administrator - Prerequisites 101
Administrator - Distribute Search Anywhere URL to Users 101
Template for Email to Users - Download, Install, and Configure Search Anywhere 102
Configuring Information Worker 105

Configuring Classic Web Access 110
Setting Your Database to Production 116
Configuring Context Indicator (Optional) 117
Enabling Edge Agent Download for Client Printing 119
Configuring an SSRS Database User 121
Testing Your System and Repeating the Installation 124
Installing Kinetic Client on a Workstation 124
Installing .NET Framework 4.8 Runtime 124
Installing Kinetic Client Software 124
Installing Kinetic Client Using Silent Installation 126
Supplemental Installations 128
Configuring Country Specific Functionality (CSF) 128
Configuring CSF in Kinetic 128
Installing a CSF Language File 130
Installing Languages 131
Installing Language Files 131
Changing Language Settings 131
Configuring Epicor Collaborate 132
Installing Credit Card Gateway 134
4 January, 2022
Installing Performance and Diagnostic Tool 134

Updating Product LifeCycle Management 135
Accessing the Data Management Tool 136
Installing Microsoft Service Bus 1.1 136
Installing Service Bus in a Test Environment 136
Installing Service Bus in a Production Environment 140
Installing Application Request Routing 140
Troubleshooting 142
Reviewing Error Message Resolutions 142
Restoring the Demonstration Database 143
Increasing the Number of Threads Available to SQL Server 144
Changing the Free Memory Requirement 145
Managing LOB Data Replication 146
Verifying the SSL Certificate Friendly Name 147
Appendix 149
Changing or Uninstalling Kinetic Application 149
Adding or Removing Program Features 149
Uninstalling Extension Applications 149
Uninstalling the Kinetic Application 150
Uninstalling Kinetic Clients 150
Repairing or Installing the Administration Console 151
Installing Classic Help 152
Configuring Web-Hosted Classic Help 152
Installing Classic Help On Premises 152
Installing and Configuring Classic Education 155
Configuring Web-Hosted Classic Education 155
Installing Classic Education On Premises 156
Enabling Education Module and Testing Access 157
Troubleshooting Education Access 158
Setting Up Automatic Sign On for Kinetic User Accounts 158
Configuring Single Sign-On (Windows Account) 159
Setting Up Kinetic User Accounts for SSO 159
Configuring the Server 160
Configuring the Application Server 161
Configuring the Client 162
Configuring Single Sign-On for Classic Web Access 163
Configuring Azure AD Authentication 164
Configuring Azure Portal 165
Deploying the Application Server with the Azure Endpoint Binding 175
5 January, 2022
Configuring Azure AD Authentication Parameters 176

Configuring Users for Azure AD Authentication 179
Updating Client Configuration to Use Azure AD Authentication 180
Logging into Kinetic with Azure AD 182
Configuring Optional Server Settings for Azure AD Authentication 184
Troubleshooting Azure AD Authentication 185
Understanding CORS Support 188
Setting Up the Information Worker Configuration Manually 189
Verifying Temporary Files Do Not Exist 190
6 January, 2022
Getting Started
Welcome to the Kinetic Installation Guide. This part of the guide explains how to verify the prerequisites
and perform the tasks required prior to installing the application.
Understanding the Installation Flow

Use the following flow to review the process a new customer follows to install Kinetic for the first time.
7 January, 2022
Verifying Access to EPICweb

Use these steps to verify you have appropriate permissions to access the EPICweb site.
1. Verify you have Internet access at your workstation.
8 January, 2022
2. Verify you have a valid User ID and Password for Epicor's Customer Portal (EPICweb). To create
an account go to: https://www.epicor.com/en-us/customers/. If you need assistance, email
Epicweb@epicor.com.
Reviewing Release Notes Documents

Use these steps to download and review the release documents that are available with this Kinetic
version. Each document has been updated specifically for this release.
1. Log on to EPICweb Documentation site. Navigate to Documentation > Release Documents . You
can use this link: https://epicweb.epicor.com/products/kinetic-erp/documentation/on-premises.
2. In the Kinetic section, locate and download the following release documents.
Release Documentation Description
Kinetic 2021.2 Release Notes Provides information for the current release
including the Change List (Resolved Issues,
Enhancements, Software Interface Changes) from
10.2.700 to 2021.2.
Kinetic 2021.2.x Release Notes Provides information on the current update

release including the Change List (Resolved
Issues, Enhancements, Software Interface
Changes) from 2021.2 to 2021.2.x.
Verifying Windows Operating System Requirements

In this article, we cover the operating system requirements for installing the Kinetic application. You
must verify these requirements on the Kinetic Application Server, and not on the machine where you
will be running the Administration Console.
1. For your workstation, verify you have one of the following installed:
l Windows 8.1 x86 / x64 Intel Architecture
l Windows 10 x86 / x64 Intel Architecture
2. For your server, verify that you have one of the following Microsoft Technology Stacks installed.
Note that the stack must be the exact combination of Windows Operating System and
Microsoft SQL Server.
l Windows Server 2012 R2 with SQL Server 2017
l Windows Server 2016 with SQL Server 2017
l Windows Server 2019 with SQL Server 2017 or 2019
9 January, 2022
For your SQL Server, Kinetic supports either the runtime, Standard or Enterprise
versions. The SQL Server Express editions are not supported due to constraints
on the memory, CPU, and database size.
Certifying a platform for Kinetic is an involved task due to the amount of

environment testing required. Therefore, not every combination of hardware,
Windows operating system, and SQL Server version is certified or approved to
successfully run the application. For example, Kinetic is certified with SQL Server
2019 only if it is matched with Windows Server 2019; but it is not certified with
SQL Server 2012 R2 when it is matched with Windows Server 2019.
3. If you want to use the Administration Console to remotely administer machines, you need to
enable the IIS Management Service. To do this, in the Search field, enter Windows Features
and select the Turn Windows features on or off option to run the Windows Features program.
In the Windows Features window, navigate to Internet Information Services > Web
Management Tools and select the IIS Management Service check box. Click OK. Click Close.
If you install the .NET Framework 4.8 or later before you enable IIS, you must run
the ASP.NET IIS Registration tool in order to register the .NET Framework with
IIS and create application pools that use the .NET Framework 4.x. The
registration tool may be located in the following folder:
C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis -i. For more
information, refer to Microsoft Development Network website.
4. For the Administration Console, verify that in the Windows Firewall, the inbound rule "Web
Management Server (HTTP Traffic-In)" is enabled. To do this, open your Windows Firewall. Locate
the inbound rule named "Web Management Service (HTTP Traffic-in)". Right-click on the rule and
select Properties. Enter the following:
a. In the General tab, select Allow the connection in the Action group box.
b. In the Advanced tab, in the profiles section, clear the Public check box. This option should
not be selected.
c. Keep the Domain and the Private options enabled.
The inbound rule "Web Management Server (HTTP Traffic-In)" should be

enabled, if it exists. If that rule is not present, then create your own inbound rule
that opens port 8172 for TCP traffic.
5. With Windows Server, a firewall is installed. The firewall must be disabled in order for
connectivity from other machines to allow for administering of the Kinetic Application Servers.
10 January, 2022
Based on your company practices, you can enable your firewall after the installation process is
complete.
6. It is recommended that Windows Updates are not set to install automatically on your production
server. Based on your company practices, your system administrator should review the Windows
Updates and install when necessary.
Verifying SQL Server Install and Features

Use these steps to verify that a supported version of Microsoft SQL Server is installed on your database
server and that the required Full-Text Search feature is installed on your SQL Server instance.
We recommend that you review the SQL Books Online information to become familiar with the SQL
Server administration functionality. The documentation is typically installed with the SQL Server
application. To access it, navigate to Start > All Programs > Microsoft SQL Server > Documentation
and Tutorials > SQL Server Books Online.
1. On your database server, verify that one of the following Microsoft Technology Stacks is
installed. Note the stack must be the exact combination of Windows Operating System and
Microsoft SQL Server.
l Windows Server 2012 R2 with SQL Server 2017
l Windows Server 2016 with SQL Server 2017
l Windows Server 2019 with SQL 2017 or 2019
If necessary, install SQL Server on your database server using the instructions
that came with your SQL installation. Be sure to install any Microsoft service
pack and patch updates related to your SQL version. For your SQL Server,
Kinetic supports either the runtime, Standard or Enterprise versions. The SQL
Server Express editions are not supported due to constraints on the memory,
CPU, and database size.
Certifying a platform for Kinetic is an involved task due to the amount of

environment testing required. Therefore, not every combination of hardware,
Windows operating system, and SQL Server version is certified or approved to
successfully run the application. For example, Kinetic is certified with SQL Server
2019 only if it is matched with Windows Server 2019; but it is not certified with
SQL Server 2012 R2 when it is matched with Windows Server 2019.
11 January, 2022
If you are migrating from Epicor 9.05.702A and your SQL database is not SQL
Unicode, it will be converted automatically to SQL Unicode during the database
migration process to Kinetic.
2. Verify the following required and optional SQL Server features are installed:
l Database Engine Services:
SQL Server Replication (optional, but recommended with most deployments with certain
3rd party products such as Advanced Financial Reporting)
l Reporting Services:
Native Mode (required to print standard Kinetic reports)
l Management of database engine and databases:

SQL Server Management Studio and/or Azure Data Studio (formerly SQL Operations
Studio)
The steps required to install these features may be different depending on the
SQL server version. For additional information, refer to
https://docs.microsoft.com/en-us/sql/database-engine/install-
windows/installation-for-sql-server.
3. Verify that the Full-Text Search feature is installed on your SQL Server instance. Full-Text Search
is required in order to create databases using the Kinetic application. To verify if the feature is
installed:
a. Open SQL Server Management Studio. Right-click on your server/instance and select
New Query. Enter the following query:
SELECT
fulltextserviceproperty('IsFulltextInstalled')
IF (1 = FULLTEXTSERVICEPROPERTY('IsFullTextInstalled')) print
'INSTALLED'
else print 'NOT INSTALLED'
b. Click Execute. If the query returns 1 or INSTALLED it means that Full-Text Search is
installed.
Your query results may look similar to the following:
12 January, 2022
c. If the query returns 0 or NOT INSTALLED, you must install the Full-Text Search
component. To do this:
l Select Start > Control Panel > Programs and Features. In the list of programs,
right-click MS SQL Server installation and select Uninstall/Change. Click Add.
l Use you MS SQL Server installation media to run SQL setup wizard.
l In the Installation Type window, select the option to Add features to an existing
instance of SQL Server and specify the SQL Server instance you want to modify.
l In the Feature Selection window, select the Full-Text Search (Full-Text and
Semantic Extractions for Search in SQL Server 2017 Setup wizard) check box.
Click Next several times, then click Complete to finish the component installation.
As an alternate method to verify if the Full-Text Search feature is enabled on

your SQL Server, you can review the list of services. To do this, on your SQL
Server select Start > Control Panel > Administrative Tools > Services. Verify
that SQL Full-text Filter Daemon Launcher (SQL Server Instance Name)
service is listed, for example (MSSQLSERVER). Note that if your SQL Server has
multiple instances, you must verify that the service is available for the specific
SQL Server instance.
4. If you are upgrading from Epicor 9.05.702A to Kinetic, you must verify your SQL database
collation. The SQL collation on the Epicor 9.05.702A database server must be the same as on the
Kinetic database server. When you install the database instances for the SQL Epicor 9.05
database and the SQL Kinetic database, be sure to use the same query on both instances. As you
step through each SQL install wizard, select the COLLATE DATABASE_DEFAULT query option.
This ensures the migration process ignores any potential differences between the source SQL
database and the target SQL database.
Use these steps to verify your SQL database collation.
13 January, 2022
a. Review the list of collation settings that are dependent on Regional Settings. You can click
this SQL 2008 R2 link: http://msdn.microsoft.com/en-us/library/ms143508.aspx.
The correct collation setting for Epicor 9.05.702A manufacturing data

bases is SQL_Latin1_General_CP1_CI_AS, which is the default for English
(US) localized systems.
b. If the collation does not match, you must reinstall SQL Server and select custom to allow a
collation setting to be selected. Simply changing the databases to match a different
system collation setting does not resolve the issue.
The SQL installer does not show the codes, it only shows descriptions.
The required selection is under Collation Settings > SQL Collations. An
example is Dictionary Order, Case-Insensitive, 1252 codepage. This
produces the required matching collation: SQL_Latin1_General_CP1_CI_
AS
c. Change the Compatibility Level to SQL 2008 (100) for all databases that will run in the
Epicor 9.05.702A application.
If the collation does not match, searches, such as on Parts Entry or Sales
Order Entry, will not work. This collation is not related to full text
indexing; other full text indexed table searches will run fine. This is an
issue only when the SQL server is not localized for English (US).
5. If your SQL Server is hosted on a different machine than the Kinetic Application Server, verify that
network connectivity exists between the servers. To do this, complete these steps on the two
machines:
a. For the Application Server, do the following:
l Add a domain account with Administrator permissions.
l Log into the Application Server using the domain account with Administrator
permissions.
b. For the SQL Server, do the following:
l Add the domain account login (with Administrator permissions) to the
Administrators group.
l Verify the SQL Server service properties specifies "Log On As" that specific domain
account.
14 January, 2022
l In SQL Server Management Studio, create the domain account as a SQL login
account with sysadmin rights.
6. If you are using Enterprise Search, verify the following SQL Server requirements:
a. Verify that one of the following SQL Server versions is installed and running locally:
l SQL Server 2017
l SQL Server 2019
b. Verify that the SQL Server installation has SQL and Windows Authentication enabled.
c. Verify that the server where Enterprise Search is installed also has SQL Server installed as
the named or primary instance. For example, if your server is named Candy, then SQL
Server must be made available as Candy, and not as a sub or separate installation. Note
that the Kinetic application SQL database can be located on a remote server.
d. Verify that the account you use to log into the system is trusted by the SQL Server.
e. Verify that the account you select for the Service account has the necessary System Admin
rights to access to create and manage a new database on your SQL Server instance.
l Open SQL Server Management Studio and connect to your database.
l Expand Security > Logins. Right-click on NT AUTHORITY\SYSTEM and select
Properties.
l In the Login Properties dialog, select Server Roles. In the server roles list, verify that
sysadmin is selected. Click OK.
l Close SQL Server Management Studio.
Configuring Server Roles (Windows Server 2019 or 2016)

In this article, we cover the required Windows Server Roles, including the File and Storage Services, and
the Web Server (IIS). If the roles already exist, you can still review the list of role features to verify that
your roles are configured properly.
If you do not configure the server roles, you may be prompted with the error "Assembly binding
warning is turned OFF" when you are attempting to add an application server. To resolve the error,
follow the steps in this section to configure your server roles.
For more information on roles, role services, and features on Windows Server use the following links:
l Windows Server 2019 - https://technet.microsoft.com/en-us/windows-server-

docs/management/server-manager/install-or-uninstall-roles-role-services-or-features
l Windows Server 2016 - https://technet.microsoft.com/en-us/windows-server-
docs/management/server-manager/install-or-uninstall-roles-role-services-or-features
15 January, 2022
Installing Roles and Features

1. On the server, open Server Manager. From the Manage menu, select Add Roles and Features.
2. The Add Roles and Features Wizard appears. In the Before You Begin section, review the
information and click Next.
3. In the Installation Type section, keep the default Role-based or feature-based installation
option selected. Click Next.
4. In the Server Selection section, verify your server is selected in the Server Pool list. Click Next.
5. In the Server Roles section, select the following role services to install for the File and Storage
Services role
l File and iSCI Services > File Server
l Storage Services
6. Select the following role services to install for the Web Server (IIS) role and select Next:
In the Management Tools

In the Web Server section:
section:
Common HTTP Features: IIS Management Console (If you

are installing Classic Mobile
l Default Document Access)
l Directory Browsing
l HTTP Errors
l Static Content
l HTTP Redirection
16 January, 2022
In the Management Tools

In the Web Server section:
section:
Health and Diagnostics: IIS 6 Management Compatibility

(If you are installing Classic
l HTTP Logging Mobile Access):
l Tracing
l IIS 6 Metabase
l Request Monitor Compatibility
Performance:
l Static Content Compression
Security:
l Request Filtering
l Windows Authentication
Application Development:
l NET Extensibility 4.7 or 4.6

l ASP.NET 4.7 or 4.6
l ISAPI Extensions
l ISAPI Filters
l Server Side Includes
7. In the Features section, select the following options and select Next:
l NET Framework 4.7 or 4.6 Features

l .NET Framework 4.7 or 4.6
l WCF Services (all)
l Message Queuing
l Message Queuing Services > Message Queuing Services
l Windows Defender Antivirus
l Windows Powershell
l Windows Powershell 5.1
l Windows Powershell 2.0 Engine
l Windows Powershell ISE
17 January, 2022
l Windows Process Activation Service (all)

l Windows Search Service (only if self-hosting Classic Help and not using the web-hosted
online help).
l WoW64 Support
8. In the Add Roles and Features Wizard, confirm installation of the selected services. Click Next.
9. In the Confirmation section, click Install. The server roles and features are installed.
Configuring Windows Search

If you have selected to install the Windows Search Service feature, you must now set it to be automatic.
1. Click Start > Run > services.msc.

2. In the Services dialog, scroll to Windows Search. Double-click the item to open it.
3. In the Windows Search Properties dialog, for the Startup Type, click the drop-down arrow and
select Automatic.
4. Click OK.
Configuring Server Roles (Windows Server 2012 R2)

In this article, we cover the required Windows Server Roles, including the File and Storage Services, and
the Web Server (IIS). If the roles already exist, you can still review the list of role features to verify that
your roles are configured properly.
If you do not configure the server roles, you may be prompted with the error "Assembly binding
warning is turned OFF" when you are attempting to add an application server. To resolve the error,
follow the steps in this section to configure your server roles.
For more information on roles, role services, and features on Windows Server use the following links:
https://technet.microsoft.com/en-us/library/hh831809.
18 January, 2022
Installing Roles and Features

1. On the server, open Server Manager. From the Manage menu, select Add Roles and Features.
2. The Add Roles and Features Wizard appears. In the Before You Begin section, review the
information and click Next.
3. In the Installation Type section, keep the default Role-based or feature-based installation
option selected. Click Next.
4. In the Server Selection section, verify your server is selected in the Server Pool list. Click Next.
5. In the Server Roles section, select the following role services to install for the File and Storage
Services role
l Application Server
l Web Server (IIS)
If you selected to install a role, a confirmation window appears. Click Add Features to confirm
the installation.
6. Verify that you selected the following Role Services to be installed for the Application Server role
and the Web Server role:
In the Web Server Role (IIS) >

In the Application Server section:
Web Server section:
COM+ Network Access Common HTTP Features:
l Default Document
l Directory Browsing
l HTTP Errors
l Static Content
19 January, 2022
In the Web Server Role (IIS) >

In the Application Server section:
Web Server section:
l HTTP Redirection
TCP Port Sharing Health and Diagnostics:
l HTTP Logging
l Tracing
l Request Monitor
Web Server (IIS) Support and its features Performance:
l Static Content
Compression
Windows Process Activation Service Support: Security:
l HTTP Activation l Request Filtering

l Message Queuing Activation l Windows Authentication
l Named Pipes Activation
l TCP Activation
Application Development:
l NET Extensibility 4.5

l ISAPI Extensions
l ISAPI Filters
l Server Side Includes
Management Tools (If you are

installing Classic Mobile Access):
l IIS 6 Management
Compatibility > IIS 6
Metabase Compatibility
7. In the Features section, select the following options and select Next:
l NET Framework 4.5

l Windows Search Service (only if self-hosting Classic Help and not using the web-hosted
online help).
20 January, 2022
8. In the Add Roles and Features Wizard, confirm installation of the selected services. Click Next.
9. In the Confirmation section, click Install. The server roles and features are installed.
Configuring Windows Search

If you have selected to install the Windows Search Service feature, you must now set it to be automatic.
1. Click Start > Run > services.msc.

2. In the Services dialog, scroll to Windows Search. Double-click the item to open it.
3. In the Windows Search Properties dialog, for the Startup Type, click the drop-down arrow and
select Automatic.
4. Click OK.
Verifying SQL Server Reporting Services (SSRS) Prerequisites

Use these steps to verify that you have the required components and features installed and configured
properly for using SQL Server Reporting Services (SSRS).
1. Verify that .NET Framework 4.8 or later is installed on the server where you are going to install
SQL Server Reporting.
2. Verify that you are using SQL Server 2017 or SQL Server 2019.
SQL Server 2017 and 2019 Reporting Services installation is optional and is not
included in the main SQL Server installer. To install it, go to SQL Server
Installation Center > Installation and select Install SQL Server Reporting
Services. You can also download it directly from this Microsoft Download Center
page: https://www.microsoft.com/en-us/download/details.aspx?id=55252.
3. Verify your Reporting Services configuration values using the Reporting Services Configuration
Manager. To do this:
a. Navigate to Start > All Programs > Microsoft SQL Server Reporting Services > Report
Server Configuration Manager.
b. Click Connect to connect to the report server/instance.
c. In Current Report Server information displayed, verify that Report Server Mode is
Native.
21 January, 2022
For more information on installing Reporting Services Native Mode Report

Server, review the Microsoft SQL Server Documentation Online. You can
use this link: http://technet.microsoft.com/en-us/library/ms143711.aspx
d. Verify that Report Server Status is Started.

e. On the left navigation pane, select Web Portal URL. In the Web Portal Site Identification
section that displays, do the following:
l In the URLs field, click the URL to verify that it is valid. Your browser should open
the SQL Server Reporting Services home page.
l Open a text editor, such as Notepad, and enter the URL exactly as it is displayed in
the URLs field. For example, your URL may look similar to:
http://ServerName:xx/Reports. Save the notepad file. Note that you will need to
enter this URL later when adding a Kinetic Application Server and configuring SSRS.
f. Click Exit to close the Reporting Services Configuration Manager.
4. The rsreportserver.config file defines the settings used by the Report Server Web Service, the
Report Manager, and any report processes that run in the background. If you are encountering
issues with SSRS reports timing out, you can adjust the settings in this file to accommodate
larger reports.
a. On your server, navigate to C:\Program Files\Microsoft SQL Server Reporting
Services\SSRS\ReportServer.
b. Locate the rsreportserver.config file. You can modify the following settings in the file:
l The CleanupCycleMinutes setting specifies how many minutes report sessions and
report snapshots can exist before they are deleted from the report server database.
You may want to increase this value, because it determines how long an intensive
operation can run from SSRS.
l The DatabaseQueryTimeout setting defines how many seconds can pass before a
connection to the report server database times out. You may need to increase this
value to handle larger database queries.
The following table displays the recommended adjusted timeout values for these settings:
Setting Default Adjusted

Setting
Attribute Timeout Timeout
<Add Value 180 (Minutes) 1440 (24 Hours)

Key="CleanupCycleMinutes"/>
<Add Value 120 (Seconds) 300 (Seconds)

Key="DatabaseQueryTimeout"/>
22 January, 2022
Preparing SQL Server Login Account

Use these steps to setup the SQL Server login account. Prior to installing Kinetic, you must determine
how you access the Kinetic SQL Server database, either SQL Server Authentication or Windows
Authentication. Note that both methods allow access to the application database using a single SQL
Server login account.
After adding your Kinetic database, use the Configuring Kinetic SQL Server Login Account article to
configure security options for the SQL Server login account that you create.
If you choose SQL Server Authentication, within SQL you will need to grant the user
account specified in theApplication Pool Username field during creation of the
Application Server (on the Application Server Settings tab of the Application Server -
Create Site dialog) at least Dataread and Datawriter permissions to the Reporting
database. If possible, it is recommended that Windows Authentication is used with a
dedicated domain user account in the Application Pool Username and that dedicated
account has DBO permissions to the Kinetic transactional and Reporting databases.
1. Determine your authentication method for accessing the Kinetic SQL Server database, either
using SQL Server Authentication or Windows Authentication. If you need additional information
to make your decision, refer to the "Authentication Options" information in the
KineticArchitecture Guide.
2. Use SQL Server Management Studio to connect to the SQL Server instance where you will be
installing the Kinetic database.
3. Under the Security folder, right-click the Logins folder and select New Login.
4. Based on your selected authentication method, do one of the following:
l SQL Server Authentication. Select SQL Server authentication. For Login Name, enter an
appropriate login name. For example, Kinetic. Enter a Password and confirm the
password. Click OK.
l Windows Authentication. Keep Windows authentication selected. For Login Name, click
Search to select the Windows domain account to use for accessing the Kinetic database, or
if needed, create a Windows account just for accessing it. Click OK after you have selected
the Windows account.
5. Click OK to close the dialog.
Setting Up Test Environment

Use this information to set up a test environment and test your system.
23 January, 2022
It is strongly recommended that you set up a separate test environment prior to installing a new Kinetic
application or upgrading from an existing version. You can use this test environment to test the new
application or to test your current system files, such as custom tools. Custom tools such as
personalizations, customizations, global alerts, Business Activity Queries (BAQs), and Business Process
Management (BPM) methods need to be tested and maintained prior to upgrading. By using a separate
testing environment, you will know what changes you have to make to your live system after the
upgrade, which helps ensure a successful upgrade.
Note that while it is possible to install multiple versions of the Kinetic application on the same server
for testing purposes, it is not recommended.
Do not upgrade to Kinetic 2021.2 without first testing the installation in a separate test
environment.
24 January, 2022
Installation and Configuration

This part of the guide explains how to install and configure Kinetic.
Installing Kinetic
In this article, we cover how to install the Kinetic server framework. To perform these steps, you must
be logged in as a user with Administrator rights.
Note that the Kinetic release is available from EPICweb Downloads if you have
completed the Release Approval process. For more information on the Release
Approval process, contact your Customer Account Manager.
1. Verify your environment is ready to start the installation. To do this:

l Verify all Task Agents have been stopped.
l Verify the Epicor Administration Console is closed.
l Verify that there are no active Administration Console sessions on the server.
l Verify all users are logged off Kinetic/Epicor.
l Verify you have at least free 25 GB disk space available.
2. Log on to EPICweb Customer portal website and navigate to Products > Kinetic/ERP >
Downloads > On-premises > Downloads Kinetic. You can use this link:
https://epicweb.epicor.com/products/kinetic-erp/downloads/on-premises/downloads-kinetic.
3. Go to the Kinetic > Releases folder and locate the release file related to this installation. For
example RL11.1.200.0.zip. Download the file to your local machine. For verification purposes,
you will be prompted to re-enter your EPICweb credentials when you attempt to download the
Kinetic 2021.2 file from EPICweb Downloads.
4. Extract the file. If prompted for a password, enter the one provided by the Epicor Product Group.
Click OK.
5. Right-click on the extracted RL11.1.200.0.iso file and select Mount or Mount (Virtual
CloneDrive). The Kinetic installer is now available as an EXE file located in a virtual DVD drive.
Verify that a 7z folder is also extracted and available.
6. Navigate to the mounted (virtual DVD) drive. Right-click on the *.exe file and select Run as
administrator. The install wizard verifies that the install executable is compatible with your
environment and then prepares for your installation. This verification may take several minutes.
7. The Welcome window appears for installing Kinetic. Click Next.
25 January, 2022
8. The Select Components window appears. Select the program features you want to install, such as
the Application Server and Supplemental Installs. Review the list of components. In the The
Install Wizard will update the following location field accept the default location of
C:\Epicor\ERP11. Click Next.
9. The Configuring Kinetic 2021.2 dialog displays. The installation and configuration begins and
status bars display the progress. The process may take a period of time.
10. The Install Complete window appears when the installation is complete. Based on the availability
of an Update release, do one of the following:
l If an Update release 2021.2.x (11.1.200.x) is available, clear the Launch the Epicor
Administration Console check box. You will need to install the Update release prior to
launching the Epicor Administration Console.
l If an Update release 2021.2.x (11.1.200.x) is not available, keep the Launch the Epicor
Administration Console check box selected. You will now use the instructions in the
following sections to complete the configuration using the Epicor Administration Console.
26 January, 2022
11. Select Finish. Your Kinetic server framework is installed.

12. You can now unmount the DVD drive. In the left tree view, right-click on the DVD drive and select
Eject.
Installing Kinetic 2021.2.x (11.1.200.x) Latest Update

In this article, we cover how to install the latest update to your Kinetic application, if it is available.
Updates are identified by the sequential number added to the end of the release number, for example
2021.2.3.
1. Verify your environment is ready to start the installation. To do this:

l Verify the Administration Console is closed.
l Verify that there are no active Administration Console sessions on the server.
l Verify all users are logged off Kinetic .
l Verify you have at least free 20 GB disk space available.
27 January, 2022
3. In the Kinetic > Version 2021.2 folder, locate the latest release file related to this installation.
For example UD11.1.200.x.zip. Download the file to the machine where you have Kinetic 2021.2
(11.1.200) installed. Go to the directory where you downloaded the file. Extract the file.
4. Right-click on the extracted UD11.1.200.x.exe file and select Run as administrator. The install
wizard verifies that the install executable is compatible with your environment and then prepares
for your installation. This verification may take several minutes.
5. The Welcome window appears for installing the update. Click Next.
6. The Select Components window appears. Review the list of components that were installed with
your base installation. Click Next.
7. The Completing Kinetic 2021.2 Update dialog appears. To begin the install of the update, click
Next. The install begins and status bars display the processing. The process may take a period of
time.
8. The Kinetic 2021.2 Update Complete window appears when the installation is complete. Clear the
Launch the Epicor Administration Console check box and click Finish.
Your update is installed. Now use the instructions in the following articles to complete the configuration
using the Administration Console.
Configuring Kinetic Database

In this article, we cover how to a Kinetic database (new or demonstration) using the Administration
Console.
Adding a Database Server

1. On the server where your Kinetic application is installed, open the Administration Console, if it is
not already opened. For example, navigate to Start > All Programs > Epicor Software >
Administration Console.
2. In the left-hand Tree View, select the Database Server Management node.
28 January, 2022
3. Right-click on the Database Server Management node and select Add Kinetic Database Server.
4. In the Server\Instance field, enter the SQL Server name and the SQL Instance ID. For example,
enter your local server or the network server to which you will be connecting.
5. Select the Authentication mode to connect to the SQL Server. For example, select Windows
Authentication or SQL Authentication. If you select SQL Authentication you must also enter your
SQL Login and Password.
The system passes the specified SQL login and password to the configuration
when you add a new database.
29 January, 2022
6. Select Verify Server to verify that your server name and connection details are valid. Click OK to
the verification message. Click OK again.
After the server is added, the server/instance is displayed as a node under Database Server
Management in the Tree View.
Adding a Kinetic Database

After you add the Kinetic Database Server, you are now ready to add your database. For example, you
can add a new database (for production) or add the demo database (for training).
Prior to adding a database, verify that the Full-Text Search feature is installed on your
SQL Server instance. Full-Text Search is required in order to create databases using the
Kinetic application. Refer to the previous steps in the Getting Started > Verify
Prerequisites > Verify SQL Server Install and Features section.
1. In Administration Console, expand Database Server Management. Right-click on your

Server/Instance and select one of the options to add a database:
l Add New Database - Use this option to launch the Database Migration tool to add a new
database. The new database contains seed data only.
l Add Demo Database - Use this option to launch the Database Migration tool to add a new
Demonstration Database which is used for educational purposes along with the Education
module.
2. For either a New or Demo database, the Add New Database dialog opens. Enter the following and
select OK:
30 January, 2022
l Enter a Name for your database.
Your database name cannot include a space. After the database is created
you cannot change the database name. If the database name already
exists on the server, you will be prompted to confirm the name when the
database creation process starts.
l Enter the Deployment Server path to specify the deployment share location. This path is
used by the Epicor Administration Console to verify that it has the required components to
service the database. These components can then be downloaded from this location.
If you are on the deployment server, enter a fully qualified path such as
C:\Epicor\ERP11\11.1.200.0.
3. The Create Database on Server dialog displays. The tasks required to create a database are listed
by Task ID and the Exec check box is selected to indicate they will be run.
31 January, 2022
Verify that in the background the Work in Progress dialog appears. It states that adding a new
database takes time. This dialog will continue to display the progress status throughout the
creation of the database.
4. You can either start the creation of the database using the default configuration values or you
can change them. To configure the database properties before it is created, on the Create
Database on Server dialog, from the Action menu , select Configuration. The Configuration
dialog opens.
32 January, 2022
a. On the Target Database tab, if you want to use your default configuration settings, select
the Use Existing Database check box. The MDF and LDF sections become read-only.
b. If you want to create SQL Server extended events in your database, do the following:
l Select the Extended Events check box. This option creates the extended events
tracing features for the SQL Server instance connected to your database. Note that it
creates them but does not activate them. You can activate these tracing features
later within SQL Server. The features trace performance issues such as deadlocks,
query efficiency, and system health.
l In the Extended Events Location field, keep the default log file location on the SQL
Server machine or enter any other location in your environment use as log file
storage. Note that when logging Extended Events is activated, this location must
have minimum 10 GB free disk space.
c. For the Target database, verify the Master Database File (MDF) Information. Note that
for more information on MDF settings, refer to your Microsoft SQL Server user guides and
online help.
l In the MDF Location field, verify the default path to the master database file.
l Review the Initial MDF File Size in GB value. We recommend to set this value close
to the size of the future master database file.
33 January, 2022
l Keep the Autogrowth check box selected if you want the file to increase
automatically when new data is added. In the Autogrowth settings section, use the
MDF File Growth fields to specify the file growth rate. Select the Restricted File
Size Growth option and set the maximum size for the MDF file if you want to limit
this value, or keep the Unrestricted File Size Growth option selected. If you use
MDF autogrowth and do not restrict the file size, the MDF file should be regularly
monitored and managed by a database administrator.
d. For the Target database, verify the Log Database File (LDF) Information. Note that for
more information on LDF settings, refer to your Microsoft SQL Server user guides and
online help.
l In the LDF Location field, verify the path to the log database file.
l Specify the Initial LDF File Size in GB value. We recommend to set this value close
to the size of the future log database file.
l Keep the Autogrowth check box selected if you want the file to increase
automatically when new data is added. Define Autogrowth settings. Use the LDF File
Growth fields to specify the file growth rate. Select the Restricted File Size Growth
option and set the maximum size for the LDF file if you want to limit this value, or
keep the Unrestricted File Size Growth option selected. If you use LDF autogrowth
and do not restrict the file size, the LDF file should be regularly monitored and
managed by a database administrator.
e. Select Test Connection to verify. Click OK to the validation message.
f. Click OK to save the configuration values. The Configuration dialog closes.
5. On the Create Database on Server dialog, select Start. The processing begins. This may take a
few minutes. Note that after being clicked, the Start button is inactive (grayed-out). If the Start
button is still active, you need to click the Start button again.
34 January, 2022
If the database name already exists, you are prompted with a message to enter a
password to confirm that the existing database should be deleted in order for
the new database to be created. Enter the password specified in the message
and click OK to confirm.
6. During the creation of the database, if you want to view the processing messages, click the Show
More button. If you want to hide the processing messages, click the Show Less button.
7. During the creation of the database, progress is displayed using green check marks next to the
task. Note that if a task is not successful, a red X is displayed. After each task is completed a
green check mark is displayed next to the task. Verify that your tasks have all completed.
8. After completion, click the Show Log button to display the DB Migration log and review the
information if needed.
35 January, 2022
Click Close to close the log file.
9. Click Close to close the Create Database on Server dialog.
10. Verify that your new database displays under your database server in the tree node.
Your new database has been successfully added. Review the Database Encryption (TDE) field that
identifies the current status of the database. Status options include:
0 = Off (no encryption keys)
1 = Unencrypted
36 January, 2022
2 = Encryption in progress
3 = Encrypted
4 = Key change in progress
5 = Decryption in progress
If you added a demo database for educational use, we recommend that you create a
back-up of this demonstration database. For example, create a backup and name it
DEMO_Kinetic. When you need to refresh (restore) the demonstration database, you
can restore this backup database to the named demonstration database. Refer to the
Appendices > Troubleshooting > Restore Demonstration Database section for more
information.‌
Configuring Kinetic SQL Server Login Account

Now you need to allow the Kinetic SQL Server login account to access the Kinetic database. During
these steps, you will select the SQL Server login account that you created when completing the pre-
installation steps - Preparing SQL Server Login Account.
1. Use SQL Server Management Studio to connect to the SQL Server instance that now hosts the
Kinetic database.
2. Navigate to Security > Logins.
3. Double-click the SQL Server login you previously created to access the Kinetic database. For
example, Kinetic.
4. In the left pane, click User Mapping.
5. In the Map column, select the check box next to the Kinetic database.
6. In the database role memberships list, in addition to public (which is selected), select the db_
owner check box.
After the installation is complete, you can change the security settings for this
SQL Login account. For example, if you do not want the login user to have db_
owner access, you can remove the ability by clearing (unselecting) that check
box in the list of database role memberships. Note that if the db_owner access is
removed, verify that both db_reader and db_writer access are granted.
7. Select OK.
37 January, 2022
Adding Kinetic Server

In this article, we cover how to add your Kinetic server using the Administration Console. You must add
the Kinetic server prior to adding the Kinetic application server. During this process, you also need to
assign an SSL Certificate to use for administering your application servers.
1. On the server where your Kinetic application is installed, open the Administration Console.
2. In the left-hand Tree View, right-click the Server Management node and select Add Kinetic
Server.
3. The server Name defaults using its fully qualified domain name. If you need, delete the default
server machine name and enter a different server in this field.
4. The SSL Cert field contains the name of the SSL Certificate that is assigned to the https binding
(if available) of the web site under which the Kinetic application server is hosted in IIS Manager. If
no certificate is selected or if you want to use another certificate , select Browse (…).
38 January, 2022
The SSL certificate you pick must have a Friendly Name assigned so that the Kinetic server could
recognize it. For information on how to verify and assign a Friendly Name to a certificate, review
the Troubleshooting section.
5. In the SSL Certificate Options dialog, select one of the following options, based on your
requirements:
l Pick an existing SSL Certificate. When you select this option, the Windows Security -
Select a Certificate dialog opens and displays the available certificates. You can click More
choices to view all available certificates. Select the certificate you want to use for your
Kinetic server and click OK.
39 January, 2022
l Generate a new Self Signed Certificate. When you select this option, the Self Signed
Certificate Options dialog opens.
We do NOT recommend to use self-signed certificates for Kinetic servers

that host the production database as they do not assure high security.
Please, study the available options and obtain an SSL certificate form a
trusted Certificate Authority.
Enter a Certificate Friendly Name to identify your certificate and the Certificate
Expiration (Years) to specify for how long it should be valid. Click Create Certificate.
When you generate a self signed certificate, the system adds the Https binding type to the
web site under which the application server is hosted and assigns it with the newly created
certificate.
If you want to review the available Site Binding types, in IIS Manager,
navigate to the web site under which the application server is hosted
(commonly this is the Default Web Site) and in the Actions Panel, click
Bindings. For more information on how to work with site bindings, refer
to the IIS Manager Help.
6. On the Add Kinetic Server dialog, click Ping Server to verify the server name. A message displays
that it is successful. Select OK.
7. Verify that your Kinetic server is added under the Server Management node.
40 January, 2022
Adding Kinetic Application Server (New Install or Upgrade From

Epicor 10.0)
In this article, we cover how to add your Kinetic application server using theAdministration Console.
Note that prior to adding a Kinetic application server, you must add your Kinetic Server.
The process includes the following tasks:
Use these steps if you are installing your Kinetic application for the first time, or you
are upgrading from a previous installation of Epicor 10.0.xxx. If you are upgrading from
Epicor 10.1 or 10.2, you use the "Upgrade Kinetic Application Server" steps instead.
Adding an Application Server

1. In the Administration Console tree view, expand the Server Management node. Verify that the
Kinetic server that will host the new application server is listed.
2. Right-click on the Kinetic server and select Add Application Server. If prompted to select a
Snap-In Version, select the version of the application server you want to add and click OK.
3. If your Kinetic server does not have an SSL Certificate assigned, you may be prompted with the
following error:
41 January, 2022
To resolve the error, do the following:
a. In the left-hand Tree View, right-click on your Server and select Properties. Your dialog
may look similar to the following:
b. The SSL Cert field contains the name of the SSL Certificate that is assigned to the https
binding (if available) of the web site under which the Kinetic application server is hosted in
IIS Manager. If no certificate is selected or if you want to use another certificate , click the
Browse (…) button.
c. In the SSL Certificate Options dialog, select one of the following options, based on your
requirements:
l Pick an existing SSL Certificate. When you select this option, the Windows Security
- Select a Certificate dialog opens and displays the available certificates. Select the
certificate you want to use for Kinetic Server and click OK.
42 January, 2022
l Generate a new Self Signed Certificate. When you select this option, the Self
Signed Certificate Options dialog opens. Enter a Certificate Friendly Name to
identify your certificate.
We do NOT recommend to use self-signed certificates for Kinetic

Servers that host the production database as they do not assure
high security. Please, study the available options and obtain an SSL
certificate form a trusted Certificate Authority.
43 January, 2022
Enter the Certificate Expiration (Years) to specify the number of years it will remain valid.
Click Create Certificate. When you generate a self signed certificate, the system adds the
https binding type to the web site under which the Kinetic application server is hosted and
assigns it with the newly created certificate.
If you want to review the available Site Binding types, in IIS Manager, navigate to the web
site under which the Kinetic application server is hosted (commonly this is the Default Web
Site) and click Bindings in the Actions Panel. For more information on how to work with
site bindings, refer to the IIS Manager Help.
d. On the Add Kinetic Server dialog, click Ping Server to verify the server name. A message
displays that it is successful. Click OK
Defining the Application Server Settings

1. In the Application Server Configuration dialog, select the Application Server Settings tab if it is
not already selected.
44 January, 2022
2. Review or enter the Application Name to identify the name that Internet Information Services
(IIS) uses to create the application. This value is also added to the URL address which the client
installation uses to connect to the application server. For example, the name Kinetic2021_2
means the application server URL will be net.tcp://<servername>/Kinetic2021_2. You can directly
enter the name or click the Browse (...) button to find and select it.
Several fields default based on the Application Name: Web Site Directory and
Application Pool Name on this same tab, and Display Name on the Admin
Console Settings tab. This feature prevents a site that already exists from being
overwritten by the name change.
45 January, 2022
3. Review or enter the Deployment Directory that contains the Kinetic Server installation. For
example: \\ServerName\Epicor\ERP11\11.1.200.0.0. You must be a member of the Administrators
group on the server specified.
4. If available, use the Deployment Version drop-down to select your update version from the list
of updates that are available on your server. If a release update is not available, select Base.
If a release update is available, you would have installed it using the previous
steps in the Install Kinetic2021.2.x Latest Update section. It is recommended
that you select that update version to update your Kinetic version to the latest
build version, for example 11.1.200.x.
5. Use the Skip IIS Related Configuration Steps check box to indicate whether the system should
skip the following steps when deploying the application server to make the process faster:
l Allow Net.Tcp through the firewall
l Ensure IIS user has file access
l Ensure WAS Windows activation service is enabled
l Ensure IIS Http redirect is enabled
You should only select this check box if you are sure your system is configured
correctly.
6. The Web Site Directory identifies the server machine that will contain the application server.
The application server is installed in this location. Verify that the path includes the Application
Name that you just entered. For example: C:\inetpub\wwwroot\Kinetic2021_2.
7. Use the drop-down menu to select your Endpoint Binding to define how this application server
checks for authentication certificates through Internet Information Services (IIS). When a user
logs into the application, the selected protocol option verifies the communications are encrypted
and checks whether the user can access Kinetic.
You can choose one of the three types of protocols: Net.Tcp, Http, and Https. You can select one
protocol binding option for each type. The system uses the first selected type for deploying
Admin Console and Extensions. For example, if you select an Http and an Https protocol option
and leave the Net.Tcp field blank, the system will use the Http option you selected. Other
selected options can be used later to connect client installations to your application server.
Options include:
Net.Tcp Endpoint Binding:
46 January, 2022
In an upcoming version of Kinetic, the Net.Tcp protocol is designated as

deprecated. It will continue to work for two releases (2021.1 and 2021.2) to give
you time to adapt and move to better alternatives. Going forward, the
application is standardizing on Http(s) only and deprecating the use of the
legacy Microsoft proprietary Net.Tcp protocol. You should plan on switching any
net.tcp bindings (UsernameSslChannel, Windows, UsernameWindowsChannel,
TcpBinary) to the Http or Https bindings.
l UsernameWindowsChannel - This Net.Tcp binding authenticates transactions through a

Kinetic Username and Password. Windows checks for existing user accounts to
authenticate logins.
l UsernameSSLChannel - This Net.Tcp binding authenticates transactions using a Secure
Sockets Layer (SSL) X509 certificate. Leverage this method for application servers that
handle smart client installations when users reside in different domains. By using an SSL
certificate, users from different domains can log into the Kinetic application. When you
select this option, the following fields become available:
l SSL Certificate Subject Name. Enter the Subject Name of your Secure Sockets
Layer (SSL) certificate or click the Browse (...) button to find and select it. After you
finish setting up the application server and click Deploy, the server's web.config file
updates with this Subject Name. This value displays under the <behaviors> node in
the <serviceCertificate> setting.
l DNS Endpoint Identity. Enter the expected Domain Name System (DNS) identity of
the server. When an application server uses a Secure Sockets Layer (SSL) Certificate
for endpoint binding, you must enter this identity value. When the system runs X509
SSL Certificate authentication, it uses this identity value to validate the application
server. If the SSL certificate contains a DNS Endpoint Identity with the same value,
the application server is valid and can be accessed by its task agent.
l Windows - This Net.Tcp binding authenticates transactions using a Windows Username
and Password. Any user with a Windows Username and Password within this domain can
successfully log into Kinetic.
Http Endpoint Binding:
l HttpBinaryUsernameSslChannel - This HTTP binding protocol authenticates using a

Secure Sockets Layer (SSL) X509 certificate. The data transfers between the client and
server using Hypertext Transfer Protocol (HTTP). Instead of the transport, the message
which contains the data transfer is encrypted. Because this binding does not use Hypertext
Transfer Protocol Secure (HTTPS), it tends to be slower than bindings which use HTTPS.
47 January, 2022
Use this method for application servers that handle smart client installations when users
reside in different domains. By using an SSL certificate, users from these different domains
can log into Kinetic. When you select this option, the following fields become available:
l SSL Certificate Subject Name. Click the Browse (...) button to open the Windows
Security list. Select your certificate. Click OK
l DNS Endpoint Identity. Enter the Domain Name System (DNS) identity of the
server. When the system runs X509 SSL Certificate authentication, it uses this
identity value to validate the server.
l HttpsOffloadBinaryUserNameChannel - This HTTP protocol binding is a configuration
that offloads encryption handling to an intermediary Application Request Router such as
an F5.
The binding authenticates using a Kinetic Username and Password token. The data
transfers between the client and server using Hypertext Transfer Protocol Secure (HTTPS).
This protocol is configured to move encryption handling to an intermediary Application
Request Router like F5 or a similar router.
l HttpsOffloadBinaryAzureChannel - This HTTPS protocol binding is a configuration that

offloads encryption handling between Kinetic and an intermediary Application Request
Router such as an F5.
The binding authenticates using a security token by specifying a valid authentication claim
between Kinetic and Azure AD. The data transfers between the client and server using
Hypertext Transfer Protocol Secure (HTTPS). This protocol is configured to move
encryption handling to an intermediary Application Request Router like F5 or a similar
router.
For a complete information on how to configure authentication of Kinetic

users against users in Azure Active Directory (Azure AD), see the Azure AD
Authentication section.
Https Endpoint Binding:
l HttpsBinaryUsernameChannel - This HTTPS binding authenticates transactions using a

Kinetic Username and Password. The data transfers between the client and server using
Hypertext Transfer Protocol Secure (HTTPS). HTTPS encrypts the data transfer.
l HttpsBinaryWindowsChannel - This HTTPS binding authenticates transactions using a
Windows Username and Password. The data transfers between the client and server using
Hypertext Transfer Protocol Secure (HTTPS).
48 January, 2022
You can select this method for application servers that handle smart client installations
and Web Access installations where users access the application through the same
domain. Any user with a Windows Username and Password within this domain can
successfully log into Kinetic.
l HttpsBinaryAzureChannel - This HTTPS protocol enables authentication of Kinetic users

against users in Microsoft Azure Active Directory (Azure AD).
This binding relies upon the user authenticating against Azure Active Directory and
obtaining a token to present to Kinetic. The data transfers between the client and server
using Hypertext Transfer Protocol Secure (HTTPS).
For a complete information on how to configure authentication of Kinetic

users against users in Azure Active Directory (Azure AD), see the Azure AD
Authentication section.
8. Define the following options in the Server Information group box:

l If you have custom programs to incorporate with Kinetic, enter the path or click the
Browse (...) button to find and select the Custom Directory that contains these custom
.dll files. After you click OK on this window, these custom .dll files are included in the
application.
As an option, you can enter a relative path in this field. This base path is the directory from
where the application server runs. Through the web.config file, you can define custom
directories that then populate this field.
As a best practice, you should always place custom programs in this separate Custom
Directory. Then the next time the application version is updated, these custom programs
are not overwritten. You can then modify these custom programs to work with the new
version.
When you finish creating or modifying the application server and click OK, the application
server checks each of the following folders (in sequential order) to determine what version
to install:
l Base Directory. This directory contains the primary installation for Kinetic. The
update process always starts with this base version.
l Updates Directory - If an update version is available, the application next updates
Kinetic to use this update.
l Custom Directory. The application lastly checks if customizations are available. If
custom programs are in this directory, tKinetic applies these customizations over
the base version.
49 January, 2022
l Select the Shared Assembly Location check box if you have a network load balanced
(NLB) environment. For example, you may have the Kinetic system installed on multiple
servers. You then must have a central directory that contains all the server assemblies and
Business Process Management (BPM) folders. If your server environment is set up this way,
activate this check box.
You typically select this check box when you add your second and subsequent application
servers. When you install the first application server, the install process creates a
Server/Assemblies folder. You then create a Windows share for this folder.
When you add more application servers, you select this check box and then enter or select
the shared assembly location in the Shared Directory field. Note that you can move the
Assemblies folder to some other disk location. However if you move this folder, you must
manually update the web.config file for the first application server so it points to this new
location.
If your appservers will be on separate machines you must select a

network shared location.
l Use the Cryptography Regime field to specify if encryption used in the application must
comply with the Federal Information Processing Standards (FIPS) security requirements.
The available options include:
l None - the application can use non-FIPS certified encryption.
l FIPS 140-2- the application can only use FIPS 140-2 compliant encryption. If you
already have FIPS activated on the operating system level, the FIPS 140-2 option is
used by default.
If you are migrating or upgrading from a previous version, you can enable FIPS 140-2
regime only after your conversions and migration processes are successfully completed. If
you have FIPS enabled on the operating system level, you must disable it before running
conversions and migration processes.
You need to have TLS 1.x as a default secure protocol before you start
using FIPS cryptography. To do this, use Windows instructions at
https://support.microsoft.com/en-ca/help/3140245/update-to-enable-tls-
1-1-and-tls-1-2-as-default-secure-protocols-in-wi . Enable TLS 1.x as a
default secure protocol on every machine that is going to have Kinetic
client installed.
50 January, 2022
If you need to enable FIPS on the operating system level, use Windows
instructions at https://support.microsoft.com/en-us/help/811833/system-
cryptography-use-fips-compliant-algorithms-for-encryption-hashi.
9. In the Application Pool group box, set the following fields:

a. The Application Pool Name is the name of the application pool associated with the new
or updated application server. It defines a group of related URLs that use the same process
or set of processes. The new application server must be placed in an application pool. By
default, this field uses the value you entered in the Application Name field. To change this
value, click the Browse (...) button next to it. In the Select Application Pool dialog
window, select the application pool you wish your application server to be associated with
from the list of available pools.
The Application Pooldrop-down list displays all application pools that satisfy your
application server requirements. For example, you will only see the pools with matching
.NET CLR version in the list. The properties of the selected application pool can be viewed
in the Properties field of this dialog .
Use this functionality if you need to share one application pool across two
or more application servers.
b. Select the Use Custom Account check box when you need to enter a specific user account
for the Internet Information Services (IIS) application pool this application server uses. If
you select to use a custom account, you must also enter the following:
l Application Pool Username. Enter the domain and the user account. For example,
MyDomain\UserName.
l Application Pool Password Enter the password associated with the user account
for this application pool.
If you do not select this check box, the application pool uses a default
user account. This default account depends on whether you use an SSRS
server:
l If you use an SSRS server, the connection uses the LocalSystem
account. This is the default user account available through the
Windows operating system.
l If you do not use an SSRS server, the connection uses the
ApplicationPoolIdentity account. This is the default user account
available through Internet Information Services (IIS).
51 January, 2022
Do not click Deploy yet. You must complete the other tabs before submitting the information. If you
click Deploy, you may receive a message that your data entry is not complete on the other tabs.
Defining Database Connection Settings

1. Select the Database Connection tab.
2. For the Server Name enter the name of your database server that contains the database that you
will use with the current application server.
3. Click the Authentication drop-down list and select either the Windows Authentication or SQL
Server Authentication option.
l If you select Windows Authentication, the User and Password default to your current login
values.
l If you select SQL Server Authentication, enter the User and Password you use to log into
SQL Server.
4. From the Database Name drop-down list, select the name of the SQL database you want to link
to this application server. All the databases available under the selected database server display
on this list.
5. To verify the application server can connect with this database, click Test Connection and click
OK in the confirmation message.
52 January, 2022
Defining Admin Console Settings

1. Navigate to the Admin Console Settings tab.
2. Review or enter the Display Name to identify the application server in the Administration
Console. The name helps you identify the purpose for the application server.
3. From the drop-down list, select the Endpoint Binding to use for the Admin Console. The options
include the endpoint bindings you selected on the Application Server Settings sheet.
4. Enter your Epicor User Name and Password. You must enter a valid Kinetic User and Password
for the user account who has access to the Kinetic application directories. The credentials differ
based on the database (new or Demo) to which you are adding an application server:
53 January, 2022
l For a new database, enter manager / manager.

l For the Demo database, enter epicor / epicor.
The password is stored in an encrypted format.
5. Enter the Operation timeout value you want for the application server. This value determines
the wait time until an incomplete operation is stopped by the application server. The default
value is 300 seconds.
6. Select or clear the Validate WCF Certificate check box. This indicates whether the client
application and WCF service need to validate their connection through a certificate. If this check
box is selected, a certificate is required for the client installation to communicate with the WCF
service. Your selection must match the value set in the <appSettings><WCFCertValidation>
element of the .sysconfig file:
l Select the checkbox if <WCFCertValidation value="True" />.
l Clear the checkbox if <WCFCertValidation value="False" />.
7. Optionally, in the Epicor Application Launcher section, indicate how you will connect the
Administration Console to Kinetic. If you activate this feature, you can launch User Account
Security Maintenance from within the console. When you expand the Users node, select a user,
and then select Properties from either the context menu or the Actions pane, User Account
Security Maintenance displays with the selected user account. Select one of the following
options:
l Do not allow access to user details - The default option, select this radio button when
you do not want to activate this feature. The Administration Console then cannot launch
User Account Security Maintenance.
l Use Epicor Smart Client - If you select this option, click the Browse (...) button to find
and select the Epicor.exe file you will use to launch User Account Security Maintenance.
l Use Epicor Web Access - If you use Classic Web Access (former Epicor Web Access or EWA),
select this option and click the drop-down list to define the URL for the web access. This
drop-down list contains the web access values defined in the company configuration data
for Web Access (set within the client); you then launch the Web Access version of User
Account Security Maintenance.
54 January, 2022
Configuring Reporting Services

1. Navigate to the Reporting Services tab.
2. If you plan to use SSRS reporting functionality, verify that the Configure SSRS check box is
selected. The reporting services configuration fields open and you can then define how this
application server interacts with SSRS.
Be sure that once you select this check box, you continue to keep it selected
during future updates to this application server. When any SSRS reports are
changed as part of an update, these modified reports are automatically included
when you deploy this update. If you clear this check box during a future update,
it indicates you no longer use SSRS reporting, causing the application server to
reconfigure without the SSRS functions.
If you are not ready to configure your SSRS functionality now, do not select the Configure SSRS
check box. Later when you want to use SSRS reporting functionality, you can update your
application server. To do this, expand Server Management > [server]. Right-click on your
55 January, 2022
application server and select Application Server Configuration. You can select the Reporting
Services tab to define your SSRS settings.
3. Enter the SSRS Web Service URL for the SSRS Report Server. When you install SQL Server, you
set up this URL and this value is typically http://<localhost>/ReportServer.
To find the value you need to enter in this field, go to the server machine and launch Reporting
Services Configuration Manager. From the tree view, click the Web Service URL icon. The value
you need displays in the Report Server Web Service URLs section. Copy this value into Notepad or
a text editor so you can later paste it into the Application Server Configuration window. For
example: http://ServerName:80/ReportServer.
4. Enter the SSRS Web Portal URL for the SSRS Report Server. You define this URL when installing
SQL Server, you set up this URL and this value is typically http://<localhost>/Reports.
To find the value you need to enter in this field, go to the server machine and launch Reporting
Services Configuration Manager. From the tree view, click the Web Portal URL icon. The value
you need displays in the Report Server Web Service URLs section. Copy this value into Notepad or
a text editor so you can later paste it into the Application Server Configuration window. For
example: http://ServerName11:80/ReportServer.
5. Optionally, enter the SSRS Reports Root Folder location. This directory defines the root folder
location where you will deploy the reports. For example, enter Kinetic if you want the reports to
deploy to the Kinetic/Reports folder. If you leave the field blank, this root folder will be the
directory that contains the report server home page file, and the reports will deploy to the
/Reports sub-folder in this directory.
6. In the SSRS Database Connection group box, enter the following:
a. In the Server Name field enter the name of the server where the SSRS database will be
located.
b. Click the Authentication drop-down list and select either the Windows Authentication or
SQL Server Authentication option.
l If you select Windows Authentication, the User and Password default to your
current login values.
l If you select SQL Server Authentication, enter the User and Password you use to
log into SQL Server.
To secure access to your transactional database while running reports,

you should also set up an additional user account that has read-only
privilege to use for connection to your reporting database after you
deploy SSRS. Refer to the Configuring SSRS Database User article in this
guide for instructions.
56 January, 2022
c. In the Report Database Name field enter or select the SQL Server database that will hold
the temporary data used by SSRS to generate the report output. If the Create DB check
box is selected, enter the database name in this field. If the Create DB check box is clear
(not selected), click the Down Arrow next to this drop-down list; select the database you
need from the list of options.
This database can be:
l The same database used by Kinetic - Although this set up is not recommended,
your report server database can be the same as your main database
l A separate database on the SQL Server - This set up method is most common, as
the report data then populates this separate database on the server .
l A database on a different SQL Server - The report data from Kinetic is sent to
another server dedicated to SSRS report processing. If you are a larger organization,
you may set up your system in this way to improve performance.
Do not select the system databases for the SSRS database, as these
databases cannot store temporary report data. The system databases
include: ReportServer, ReportServerTempDB, model, msdb, master,
tempdb
d. If you are setting up SSRS for the first time, select the Create DB check box. When you
select this option and click OK, a new report database is generated using the name you
entered in the Report Database Name field. If you update the SSRS settings later on, you
can select this database again or if needed, create a new database.
e. If you selected an existing database, when you finish defining your SSRS options, click the
Test Connection button. A message should display indicating that this application server
is connected to SSRS. If you receive an error, check your values to make sure they are
accurate and then test the connection again.
7. In the SSRS Deployment group box, enter the following:
a. Select the Import Reports check box to indicate you are ready to deploy your SSRS
reports. These reports are placed in the server directory for the version. This server
directory is a relative directory created where the software is installed. For example, if the
install directory is C:\Epicor\ERP11\11.1.200.0, then the reports install in this location:
C:\Epicor\ERP11\11.1.200.0\Server\reports.zip.
This check box is clear (inactive) by default. You typically just select this check box when
you install SSRS on the current application server for the first time. After the first
installation, you can then clear this check box. When you later install an update that
includes changes to SSRS reports, these updated report definitions install into the
57 January, 2022
\Updates\[version] directory. For example:

C:\Epicor\ERP11\11.1.200.0\Updates\ERP11.1.200.x\Server\reports.zip.
b. For the SSRS ReportServer Location, select the location to define the report server
directory that contains the SSRS installation. If this directory path is on a remote machine,
be sure this directory is shared; you can then both access and copy the report files to this
folder. You also need to have Admin privileges on the report server machine in order to
start and stop reporting services when this is required by the system.
Depending on your SQL Server version, this location is similar to the following example
directories. Notice they all use "ReportServer" for the folder name; substitute the folder
name you use for the Kinetic environment. Your specific directory path will include the
name your system administrator assigned to the SQL Server instance during installation.
These reports are placed in the server directory for the version. This server directory is a
relative directory created where the software is installed. For example, if the install
directory is C:\Epicor\ERP11\11.1.200.0, the reports install in this location:
C:\Epicor\ERP11\11.1.200.0\Server\reports.zip.
l SQL Server 2017 and 2019. C:\Program Files\Microsoft SQL Server Reporting
Services\SSRS\ReportServer
l If the SSRS server is on a separate machine, enter the UNC path to the
\\<RemoteName>\ReportServer directory. The current user account must have
permissions to write to this remote directory. For example, enter:
\\<RemoteName>\C$\Program Files\Microsoft SQL Server\MSRS10_
50.MSSQLSERVER\ReportingServices\<RemoteName>\ReportServer.
If you have multiple SQL Server versions installed, make sure you
select the location that matches the version used by the Kinetic
application
Deploying the Application Server

1. After completing all the tabs in Application Server Configuration, select Deploy. The Deployment
Status window displays a progress bar as it validates deployment data, extracts server and client
files, and configures the site.
58 January, 2022
2. After the site is configured, the Setup Environment dialog appears. Review the progress as the
setup tasks are completed and marked with green checkmarks.
59 January, 2022
3. When the Server Environment is complete, a deployment status message appears saying the
Application Server Setup is successful. Click Close.
4. The Application Server Configuration dialog re-displays. Click OK to save your changes and exit
the Setup Environment. If you receive an error message, resolve the issue and restart these steps
to add an application server.
60 January, 2022
If you click Cancel or the X in the upper corner to exit, you are prompted with a
message to verify that you want to close the Application Server Configuration
dialog without registering your application server. If you click Yes, you will lose
your changes, and your application server will not be registered. If you click No,
you can then click OK which will save your changes and exit the Application
Server Configuration program.
5. Verify that your new Kinetic application server is listed under the Server Management node in the
Tree View. Select the application server. The Administration Console connects to the application
server and the property details are displayed in the central pane.
61 January, 2022
You have successfully added your application server.
If the database uses a different version than the application server you are
deploying, an error message generates in the Windows Event Log. This message
states that the database and application server are not synchronized. To correct
this error, install the latest Kinetic update and then deploy the application server
again. Be sure the Deployment Version on the Application Server Settings tab
matches the current version.
Restarting Internet Services

You must now stop and restart your Internet Services on each Kinetic Server that has an application
server pointing to the database. To do this:
1. From the Action menu, select Stop Application Pool. Click Yes to confirm. Notice the green
button turns to yellow and displays the word "Stopping". When the application pool is stopped,
the button turns to red and displays the word "Stopped". Click OK when finished.
2. Select Start Application Pool. Click OK to confirm. The button turns back to green and displays
the word "Started". All the application servers on that Kinetic Server are restarted.
3. Repeat this step on each Kinetic Server that has an application server pointing to the database.
62 January, 2022
Importing the License File and Enabling Modules

In this article, we cover how to import your Kinetic product license file and enable the modules. You
should use these steps for importing license codes for any type of database (production or
demonstration).
1. In the Administration Console, expand your Server Management > [server] > [application
server].
2. Right-click the Licensing node and select Import License File.
3. Browse to the location where you previously downloaded the license code file. Select the file and
click Open to import the file.
4. In the middle pane, double-click on the licensing code file to open it. The Properties dialog
opens.
5. Select the Modules tab. Select the check box for each module you want enabled. Click OK.
We recommend that you carefully review the modules that you have selected to
enable. Failure to enable your modules may result in possible data corruption.
63 January, 2022
Also, if you enable a new module at this time, you are committing to basic
configuration and implementation steps within the application.
6. If you use Country Specific Functionality (CSF), select the Country Specific Functionality tab.
Select the check box for each country you want enabled. Click OK.
We recommend that you carefully review the CSFs that you enabled. If you
enable a new CSF, you must perform additional steps. Review the Configuring
Country Specific Functionality article in this guide for additional installation
and configuration instructions.
64 January, 2022
7. Repeat the above steps, if you are importing license files for multiple databases.
8. Exit the Properties dialog.
You are now ready to add a company and assign the license file to that company.
Adding Companies
In this article, we cover how to add a company and assign it with the license file.
1. In the Administration Console, expand your Server Management > [server] > [application
server].
2. Right-click the Companies node and select Add Company.
65 January, 2022
3. Enter a Company ID for your company.
4. Enter a Name for your company. It is recommended you use your legal entity name.
5. For the License, click Browse (...) to select your installation license.
6. If you use Country Specific Functionality, for the Country Code, click Browse (...) to select your
country.
7. If the selected country has a Country Group Code (CGC) associated with it, it will display in the
CGC Code field. Certain Country Specific Functionality (CSF) can be equally applied to more than
one country - for example, Australia and New Zealand. Country Group Codes allow enabling the
same features for any country from a group.
8. Enter your Currency Code.
9. Specify the Number of Decimals to use for Cost, Price, and General.
66 January, 2022
10. Select OK to save. Your new company is created. It may take a period of time to finish processing.
After the company is created, you can select the Companies node to view your company and
properties.
Repeat these steps to add more companies, if needed.
67 January, 2022
Post-Installation
This part of the guide explains the steps you perform after installing or upgrading and configuring
Kinetic, right up to logging into the Kinetic client.
Configuring the System Agent

The System Agent is the tool Kinetic uses to communicate with the application server. It regulates the
tasks sent to it from client installations. These tasks include generating reports, processing data, and
refreshing executive queries.
You only need to set up the system agent for your new Kinetic Database. If you have
added the Demo Database, the system agent is ready for work.
Defining the Company Email Settings

Before you create a system agent user, you need to define email settings for your company. The
application will use these settings to send a temporary password for the system agent user account.
1. Log into Kinetic as a user with Security Manager rights.
2. Navigate to System Setup > Company/Site Maintenance > Company Maintenance.
3. Go to the Email and Reporting sheet.
4. In the Email Address field, specify the default From email address used to send global alert
email. This address displays in the From field on the global alert messages.
5. In the Email Labelfield, provide the default From label used to send global alert email. This label
displays on the global alert messages.
6. In the SMTP Server field,enter the name of the server. For example, enter ExchangeServer.
7. The Port field specifies the SMTP port number that handles your company email. This value is
the port number on the SMTP Server, for example, 25 (default port number).
8. Select the Use SSL check box if you want to specify that SMTP communication is encrypted using
SSL/TLS protocols.
9. Select one of the following options to define the way you want to connect to the SMTP Server:
68 January, 2022
l Authenticate Anonymously - used for performing anonymous access to your exchange

server. In order to use this feature, anonymous access must be allowed on the SMTP
server.
l Use Specified Credentials - used to connect to your email server using the specified
account. When selected, this option enables User and Password fields. Use these fields to
enter your SMTP account credentials.
If you select Use Specified Credentials, but do not provide User and Password, the
application uses the Application Pool account to connect to SMTP server.
10. Select Save.
Creating the System Agent User Account

Create a system agent user account and configure it with session impersonation rights to run the
System Agent and Task Agent.
69 January, 2022
1. Log into Kinetic as a user with Security Manager rights.
2. Navigate to System Setup > Security Maintenance > User Account Security Maintenance.
3. Select New.
4. In the User ID field, enter an ID you want to use for the system agent. For example, use "print"
for this purpose.
5. In the Name field, enter a name for the system agent user ID. For example, enter For Printing.
6. Select the Options tab. In the Background Task Permission section, select the Allow Session
Impersonation check box.
7. From the New menu, select New Company.
8. In the Company field, select your company name.
9. Move the items in the List of Available Sites pane to the List of Authorized Sites using the right
arrow button.
10. On the Detail sheet, select the Enable Account button. The Set Temporary Password dialog
displays.
70 January, 2022
11. In the E-mail temporary password to field, enter a valid e-mail address you have access to.
12. When you click OK, the system generates a temporary password and e-mails it to the specified
address. The account is now enabled.
13. Select Save.
Optionally, reset the system agent user password:
1. Open and the email account you specified, check for the email labeled as Temporary Kinetic
Password and copy the temporary password to clipboard.
2. Depending on the home page style you use, do one of the following:
l On the Home Page, select Change User from the Overflow menu.
l From the classic Home screen, navigate to Settings > General Options and select the
Change User option.
3. On the Log In dialog, enter the system agent User ID you created. For example, enter print.
4. In the Password field, paste the temporary password.
5. When the system prompts to change your password, create a new password for your system
agent user.
Keep record of this data. You will need to reference it later.
Creating the System Agent‌

Use these steps to create the System Agent that together with the Task Agent will help to streamline
and automate the flow of data throughout your company.
71 January, 2022
During the installation, the system adds the EpicorData folder to used as the root
directory for any common files created by tasks run by the system agent. Prior to
creating the System Agent, verify the EpicorData folder is shared with the IIS_IUSRS
user group.
1. In Kinetic, navigate to System Setup > System Maintenance > System Agent.
2. Select New.
3. Enter an Agent ID for your system agent. For example, enter SystemAgent.
4. Enter a Description for your system agent. For example, enter System Task Agent.
5. In the System Appserver section, enter your system agent user ID as User Name and its
Password.
6. Verify your directory paths are accurate. For example:
Directory Description Examples
Server specifies the root directory for any common files C:\EpicorData
Data created by tasks run by the system agent
Client Data specifies the UNC path to the directory for any \\<servername>\EpicorData
common files created by tasks run by the system
agent
Client specifies the UNC path to the server deployment C:\inetpub\wwwroot\<IIS

Program directory for the client installation Site Name>\Server
7. Select the Auto Start check box.
72 January, 2022
8. Select Save.
Installing and Configuring the Task Agent

In this article, we cover how to run the Task Agent Service installer and then add a Task Agent. A task
agent handles all scheduled tasks within the Kinetic application. Task agents run against a specific
database. They can be run on either a local machine or a remote machine. You can set up a maximum
of three task agents to run against the same database.
Installing the Task Agent

1. Open the Epicor Administration Console. Navigate to Server Management > [server] >
[application server].
2. Click the Task Agent Configuration button.
73 January, 2022
The system prompts that the Task Agent Service is not installed on this machine. To install it
now, select OK. Note that the Task Agent Installer version is automatically selected based on the
version of your Kinetic application server.
3. On the Welcome dialog, click Next.
4. In the Choose Folder dialog, select the folder where the Task Agent should be installed. The
default path is C:\Program Files (x86)\Epicor Software. Click Next.
74 January, 2022
5. In the Program Group Name dialog, enter a Program Group Name. The default is Task Agent
Service 4.1.xxx. You also select whether to create shortcuts for all users of this computer or only
for yourself. Click Next.
75 January, 2022
6. In the Ready to Install dialog, click Next to proceed. When the Task Agent Service is installed,
select Finish.
Configuring the Task Agent

1. Verify that the Task Agent Service Configuration opens automatically. If it does not open,
navigate to Start > All Programs > Epicor Software > TaskAgent 4.1.x00.0 Service
Configuration.
2. From the File menu, select New Task Agent.
3. In the Add Task Agent dialog, enter a unique Name for your Task Agent or accept the default one.
For example, Kinetic202x_x.
4. Review or enter the AppServer URL that connects the task agent to the application server
(AppServer). You can locate the AppServer URL in the URL field of the Application Server screen.
Your AppServer URL may look similar to the following: https://<server name>/Kinetic202x_x.
5. Use the drop-down menu to select the Endpoint Binding for the task agent. This binding must
match what you previously defined in the Setup Environment screen when adding the
76 January, 2022
Application Server.
6. Based on the binding you selected, enter credentials for the Task Agent. For example:
l If you selected UsernameWindowsChannel, UsernameSslChannel, or

HttpsBinaryUsernameSslChannel enter the User ID and User Password that the Task
Agent uses to access Kinetic.
l If you selected Windows or HttpBinaryWindowsChannel, several additional steps are

required. For details on the steps, from the Help menu, select Help Topics. Expand
Application Server > TaskAgent Service Configuration > Task Agents > Windows
Endpoint Configuration. Review the information.
In addition to the User ID being a valid user for accessing the Kinetic application, it must
also have rights to Allow Session Impersonation.
7. Select the Operation Timeout value to define how long, in seconds, it takes a server call to
generate an error and fail.
8. Specify the Max Concurrent Tasks value to define how many calls the task agent can send to the
application server at the same time. Change the value to reflect the capacity of your application
server.
9. If an error occurs, the task agent will try to send the call back to the server. Select the Max
Connection Attempts value to define how many times the task agent will attempt to send the
call again.
10. If you selected UsernameSSLChannel for the Endpoint Binding, the following two check boxes
become active:
l Validate WCF Certificate. Select this check box to specify that the task agent service must
verify that the Secure Sockets Layer (SSL) Certificate is valid. If you use a self-signed
certificate, do not select this check box.
l DNS Endpoint Identity. Enter the expected Domain Name System (DNS) identity of the
server. When the system runs X509 SSL Certificate authentication, it uses this identity value
to validate the server. If the SSL certificate contains a DNS Endpoint Identity with the same
value, the server is valid and can be accessed by the task agent.
11. Select the Restart Delay value to define how long, in seconds, the Task Agent will wait before
trying to restart an agent in the situation where an error has caused the agent to shut down.
Possible error situations include the Application Server going offline or the system losing network
connectivity. Default is 45 seconds.
12. When all the fields are complete, verify that the Enabled check box is selected.
77 January, 2022
13. Select Save. Your Task Agent is now added and enabled. A green icon indicates it is active.
Verifying SQL Search Services for Full-Text Search

Microsoft Search Service uses Full-Text Catalogs to perform word searches on specific fields in the
database. Full-Text Catalogs are separate files of proprietary data structures, established for the
purpose of evaluating Contains and FreeText queries. These files are not automatically updated along
with the rest of the database.
After installing Kinetic, you need to verify that the Microsoft SQL Search Services are started (running) in
order to use full-text search functionality.
Navigate to Start > Control Panel > Administration Tools > Services.
Confirm that the following Services are set:
78 January, 2022
l SQL Server > Started (or Running) > Automatic
l SQL ServerAgent > Started (or Running) > Automatic
l SQL Full-Text Filter Daemon Launcher > Started (or Running) > Automatic
For any services that are not started (or running), start the service and change the startup configuration
if needed.
Installing Extension Applications

You can install the extension applications after you have configured your Kinetic application server.
Extension applications include: Enterprise Search, Information Worker, Data Discovery. You can also
deploy such applications as Classic Web Access, Classic Mobile Access, and Custom Configurator if
needed.
The Classic Education and Classic Help extensions are also available. If you need to
install these extensions, use the installation and configuration steps for Classic Help
and Education in the Appendix of this guide.
You select the extension features to install during the Kinetic server installation process. To deploy
(install) the selected features, use the Administration Console.
You can also move, or publish, the installed extensions to a remote machine. To do this
you use the Publish Extension Installers feature. For instructions, refer to the online
help in the Administration Console under Application Server > Publish Extension
Installers.
Note that if you use Single Sign On functionality by specifying either binding type
Windows or HttpsBinaryWindowsChannel, you cannot use the Publish Extensions
Installers feature due to a Windows binding limitation. Instead, you must use the
Administration Console to install the extensions on the same server where the
application server is installed.
To access the extension installers:
not already opened.
2. In the tree view, select your Server Management > [server] > [application server].
3. In the Actions pane, click Application Server Configuration.
79 January, 2022
4. Select the Extensions tab.

5. Notice how the Current Deployment section on each extension application tab contains the
details of each extension application installation. Review the information in these fields:
l Status Indicator - Indicates whether the extension is Not Installed (red) or Installed
(Green).
l Installed On - Displays the date on which the current extension version was installed.
l Server - Contains the name of the server on which the extension is installed.
l Version - Displays the version number for the extension. If you have an older version,
consider updating the extension.
l Extension URL - Click the Copy URL button to copy the internet website URL into your
clipboard. You can then paste it in your browser or another field.
Use steps in the following articles to deploy the extension applications.
Installing Enterprise Search
80 January, 2022
1. Select the Enterprise Search tab.
2. Use this sheet to install a new Enterprise Search extension or select an existing extension. You
can also update the current Enterprise Search extension.
l To install a new Enterprise Search extension, click the New button. Enter the Deployment
Name for this Enterprise Search extension. Be sure to enter a name that helps you identify
each Enterprise Search extension available on your system. The fields on the Enterprise
Search sheet activate for data entry.
l To select an existing Enterprise Search extension, click the Browse (...) button. The
Application Server Settings program locates existing Enterprise Search extensions; select
the extension you wish to add or update. After you select the Enterprise Search extension,
the fields activate for data entry.
l To update the Enterprise Search extension, enter the new values in the fields on this sheet.
3. Enter an SSL Certificate Subject Name or click the Browse (...) button to find and select it.
81 January, 2022
4. Enterprise Search connects to the server over HTTPS and requires specifying a valid Secure
Sockets Layer (SSL) Certificate issued by the Epicor Server. Please refer to the Adding Kinetic
Server article for more information on SSL Certificates.
5. Enter the Database Connection details for Enterprise Search:
l Keep the default Server Name for the database server that will contain the Enterprise
Search database.
l Select the type of Authentication to use for connection. If you select Windows
Authentication, the User and Password default to your current login values and these
fields are disabled.
l If you select SQL Server Authentication, enter the User and Password you use to log into
SQL Server.
l Enter the Database Name to identify the Enterprise Search database.
l If you are setting up Enterprise Search for the first time, select the Create DB check box.
When you select this option and click OK, a new database generates using the name you
entered in the Database Name field. If you update the Enterprise Search settings later, you
can select this database again or if needed, create a new database.
l When you save, this database is validated. If the Application Server Setup program cannot
find this database in the location you specified, an error message displays.
l To verify the application server can connect with this Enterprise Search database, click
Test Connection and click OK in the confirmation message.
6. In the Service Account section, enter the credentials for the user identity that will run the Epicor
Search Indexer service:
l For the Built In Account, use the drop-down arrow to select your type of account, typically
Custom Account.
l If you selected a Custom Account, enter the User and Password for the custom account
you wish to use.
7. Click Deploy. The Deployment Status window displays a progress bar as it validates the
deployment process. When finished, click Close. If you receive error messages, update the fields
with correct values and deploy the application again.
8. If the application server can connect to the extension, a confirmation dialog displays. Click OK. A
green Installed icon displays on the sheet. The Enterprise Search extension is now added to your
Kinetic environment.
9. If your Epicor Application Server is configured to use Windows authentication, you need to set up
the Epicor Search Indexer service to use your Application Server Windows account for logon. To
do this:
l In your server navigate to Control Panel > Administrative Tools > Services.
l Open the Epicor Search Indexer service and navigate to the Log On sheet.
82 January, 2022
l Select the This account option.

l Click the Browse button and select the Windows user set to run your application server.
Click OK.
10. You now need to generate a search index of your database. Select which companies you want to
index. To do this:
l Click the Create Search Index button. The Search Index Creation wizard opens.
l Select a Template. Click Next.
l Select a Company for the index. Click Next.
l Enter a Search Index Name. Click Next.
l Review proposed search index. Click Finish.
Prior to using Enterprise Search, you must complete the configuration steps in the Configuring
Enterprise Search article.
Installing Information Worker

1. Determine where you are installing Information Worker Server. It can be installed on the Kinetic
application server or on a separate server. If you are installing Information Worker on a separate
server, verify that you have completed the steps from Verifying Windows Operating System
Requirements and Configuring Server Roles articles in this guide.
83 January, 2022
2. Select the Information Worker tab.

3. Click the Browse button to select an existing Deployment Name and click OK or click the New
button to create a new deployment.
4. Review the following fields that default with values: Install Path, Web Site, and Virtual
Directory.
5. In the Application Pool section, review the default values. These values cannot be changed.
6. In the E-Mail Error Settings section, enter a valid E-Mail Address to identify the account from
where the e-mail will be sent. Review the E-Mail Subject description.
deployment process. When finished, click Close.
Prior to using Information Worker, you must complete the configuration steps in the Configuring
Information Worker article.
Installing Data Discovery
84 January, 2022
1. Prior to installing Data Discovery, verify that Token Authentication is enabled. To do this:
l In the Administration Console,select your Server Management > [server] > [application
server].
l In the Actions pane, select Configure Token Authentication.
l On the Token Authentication Settings dialog, verify the Enable Token Authentication
check box is selected.
l If a Sign Key is not listed, select Generate to create one.
l Set a Lifetime (sec) value and then click OK.
2. Re-open the Application Server Configuration dialog and go to Extensions > Data Discovery.
85 January, 2022
3. To install a new instance of the Data Discovery or upgrade an existing instance, choose one of the
following:
l To install a new extension, click the New button. Enter the Deployment Name for this
Data Discovery instance. Be sure to enter a name that helps you identify each Data
Discovery extension available on this application server.
l To update an existing extension, click the Existing Deployment drop-down list to select
which Data Discovery extension you need to review or update.
86 January, 2022
l To add an existing extension, click the Browse (...) button. The Application Server Settings
program locates existing Data Discovery extensions. Select the extension you wish to add.
After you select the Data Discovery extension, the fields activate for data entry.
4. Enter the Install Path for the extension. You can use the Browse (...) button to the right to find
and select the folder. The default is \inetpub\wwwroot.
5. In the Web Site field, enter your site name. The default is Default Web Site.
6. Enter the Virtual Directory name for the Data Discovery application. The default is
[AppServerName]-EDD. For example, if your AppServer name is Kinetic202x_x your virtual
directory is named Kinetic202x_x-EDD. The name can be changed to any name allowed in IIS. If
the default is accepted, a virtual directory is created in IIS with a physical path and folder located
under the \inetpub\wwwroot folder.
7. If you have the Advanced Data Discovery license, enter the License File to identify your
company's license for Data Discovery. If you do not enter a license file, only the Data Discovery
basic functionality will be installed.
You can import the Data Discovery Advanced license after installation at any
time on the Administration > Licenses page in Data Discovery.
8. In the SSL Domain Name field, you must enter the common name or a subject alternative name
from the SSL (HTTPS) certificate for the server hosting Data Discovery.
9. Select the Override SSL Validation check box to continue the installation even if Data Discovery
detects issues with the selected SSL certificate. When you do so, the installation log records SSL
validation error messages, and the installation completes. You can make the necessary
adjustments to the SSL Certificate later if Data Discovery does not work.
Otherwise, the program will stop the installation if Data Discovery detects SSL issues.
10. Define the Application Pool details:
l In the Application Pool Name field, select the Application Pool that will be used by the
Data Discovery application. The drop-down list displays only the application pools that are
set to use Integrated Pipeline mode. If the list is empty, click the New button to create a
new application pool that uses an Integrated pipeline.
l If you want to use a custom account, select the Use Custom Account check box and enter
Application Pool Username and Password for the account.
87 January, 2022
11. In the Data Discovery Database Connection section, specify connection information to SQL Server
used to create and connect to the Data Discovery database. To do this:
l Enter the Server Name.
l Select the type of Authentication to use for connection
l Enter User and Password to use for authentication if needed.
l In the Database Name field, enter the name of the Data Discovery database.
12. Use the ERP Admin Account section to enter your Kinetic User and Password to use for logging
into Kinetic while connecting it to Data Discovery.
deployment process. When finished, click Close. If you receive error messages, update the fields
with correct values and deploy the application again.
14. If the application server can connect to the extension, a confirmation dialog displays. Click OK.
A green Installed icon displays on the sheet. The Data Discovery extension is now added to your
Kinetic environment.
Installing Classic Web Access
The Classic Web Access extension only displays Classic application forms. If you want
to use a browser for working with Kinetic UX applications, you should use the Home
Page link. For information on how to configure the link and the limitations of the
functionality, refer to the Using Kinetic Applications in Smart Clients and Web
Browsers article in Kinetic Help.
88 January, 2022
1. Select File > New > Classic Web Access.
2. Enter the Deployment Name for this Classic Web Access instance. Be sure to enter a name that
helps you identify each Classic Web Access extension available on this application server.
3. Enter the Install Path for the extension. You can use the Browse (...) button to the right to find
and select the folder. The default is \inetpub\wwwroot.
4. In the Web Site, enter your site name. The default is Default Web Site.
5. Enter the Virtual Directory name for the Classic Web Access application. The default is
[AppServerName]-EWA. For example, if your AppServer name is Kinetic202x_x your virtual
directory is named Kinetic202x_x-EWA. You can change this value to any name allowed in IIS. If
89 January, 2022
Classic Web Access application. The drop-down list displays only the application pools that
are set to use Integrated Pipeline mode. If the list is empty, click the New button to create
a new application pool that uses an Integrated pipeline.
l If you want to use a custom account to access the application pool, select the Use Custom
Account check box and enter Application Pool Username and Application Pool
Password for the account.
7. Define the Report Settings:
l Enable Crystal Reporting - Select this check box only if you use custom Crystal reports.
Leave it clear if you use SSRS reporting.
Refer to the Install Crystal Reports Embedded Server 2013 topic later in this guide for
information on how to set up Crystal Reporting.
l Report AppServer - The Report AppServer defaults to the name of the web server. If
Crystal Reporting is installed on a different server, change this name to identify the name
of the server where it is installed.
l NLB Report Repository - Specify the NLB (Network Load Balancing) report repository
location. This location is a shared repository that can be accessed by other EWA
installations. This is an optional field.
Click Deploy. The Deployment Status window displays a progress bar as it validates the deployment
process. When finished, click Close.
To verify that the installation was successful, copy the Classic Web Access Extension URL and enter it in
your browser. For example, enter https://<your server>/<your site name>/default.aspx where <your
server> is the name you specified as your server and <your site name> is the name you specified as your
Classic Web Access.
If your Classic Web Access installed successfully, a window similar to the following displays:
90 January, 2022
If your application is configured to use Windows authentication, Single Sign-On is used

for login, so this window does not display and you need to skip the next step. For more
information on Single Sign-On, in Kinetic Help, locate the Classic Guides article and
download the Implementation User Guide. Refer to the Security chapter in the guide.
Enter a valid User ID and Password that you use to log in to Kinetic. Note that this sign-in consumes a
user license. Click the Login button (arrow).
If you want to use a Time and Expense (TE) or Customer Relationship Management (CRM) license, go to
the login page using the following URLs respectively:
l https://<your server>/<your site name>/ice.ewa.shell.aspx?LicenseType=TE
l https://<your server>/<your site name>/ice.ewa.shell.aspx?LicenseType=CRM
During deployment of EWA, users of TE and CRM license types should set up browser Favorites using the
appropriate style of URL.
Prior to using Classic Web Access, you must complete the configuration steps in the Configuring
Classic Web Access article.
Installing Classic Mobile Access
91 January, 2022
1. Select File > New > Classic Mobile Access.
2. Enter the Deployment Name for this Classic Mobile Access instance. Be sure to enter a name that
helps you identify each Classic Mobile Access extension available on this application server.
3. Enter the Install Path for Classic Mobile Access. Click the Browse (...) button to search and
select the folder. The default is \inetpub\wwwroot.
4. Enter your site name in the Web Site field. If you do not have a name you wish to use, accept the
Default Web Site value.
5. Enter the Virtual Directory name for the Classic Mobile Access application. The default is
[AppServerName]-EMA. For example, if your AppServer name is Kinetic202x_x your virtual
directory is named Kinetic202x_x-EMA. The name can be changed to any name allowed in IIS. If
92 January, 2022
l In the Application Pool Name field, select the Application Pool that will be used by Classic
Mobile Access. The drop-down list displays only the application pools that are set to use
Integrated Pipeline mode. If the list is empty, click the New button to create a new
application pool that uses an Integrated pipeline.
8. After installing Classic Mobile Access, you need to enable Kinetic users to access it. To do this:
a. In Kinetic, navigate to System Setup > Security Maintenance > User Account Security
Maintenance.
b. Select a user that should be able to log into Classic Mobile Access and on the Options
sheet, select the Allow Mobile Access check box. Note you can also select multiple users
and edit their options on the List sheet.
c. Save the record.
Installing Custom Configurator

Before you begin, verify the following prerequisites:
l You need to have the Dealer Network Management module licensed and enabled before can
deploy Custom Configurator. For information on how enable Kinetic modules refer to the
Importing License File and Enabling Modules article earlier in this guide.
l Verify that the ASP.NET module of your Windows Internet Information Services (IIS) installation is
enabled before you start to install Custom Configurator. For information on how to verify if
ASP.NET is enabled, refer to the Configuring Server Roles article for your Windows Server
version earlier in this guide.
l Install Node JS - required to install Angular CLI. To download Node.js, navigate to

https://nodejs.org/en/ and select the "Recommended for Most Users" download option; follow
the setup instructions to install it on your server.
l Install Angular CLI - you can install it in Windows Command Prompt using the following NPM
command:
npm install -g @angular/cli
93 January, 2022
NPM is part of the nodejs installation. For more information about Angular CLI, visit
https://cli.angular.io/
1. Select File > New > Custom Configurator.
2. Enter the Deployment Name for this Custom Configurator instance. Be sure to enter a name that
helps you identify each Custom Configurator extension available on this application server.
3. In the Deployment Type field, specify whether you want to deploy Custom Configurator for
Generator Only, Runtime Only, or for Both.
4. Define the Custom Configurator Generator settings:
94 January, 2022
l Enter the Install Path for the extension. You can use the Browse (...) button to the right to
find and select the folder. The default is \inetpub\wwwroot.
l Enter your Custom Configurator site name in the Web Site field. If you do not have a name
you wish to use, accept the Default Web Site value.
l Accept the default Virtual Directory name for the Custom Configurator or enter your own.
The name can be changed to any name allowed in IIS. If the default is accepted, a virtual
directory is created in IIS with a physical path and folder located under the
\inetpub\wwwroot folder.
Generator. The drop-down list displays only the application pools that are set to use
application pool.
For Custom Configurator, you must select the Application Pool that uses
LocalSystem identity. You can check your Application Pools identities in
Internet Informational Services (IIS) Manager.
5. Define the Custom Configurator Runtime settings:
Runtime. The drop-down list displays only the application pools that are set to use
application pool.
ForCustom Configurator, you must select the Application Pool that uses
LocalSystem identity. You can check your Application Pools identities in
Internet Informational Services (IIS) Manager.
95 January, 2022
7. In the Current Deployment section, verify that the Extension URL has been updated to include
the latest release version. Click the Copy URL button to copy the URL into your clipboard.
After you deploy Custom Configurator, you need to set up the extension in the companies where you
want to use the Custom Configurator functionality. Note that these companies must have the Dealer
Network Management module enabled.
1. Log into Kinetic and go to System Setup > Company / Site Maintenance > Company
Configuration.
2. Navigate to the Modules > All Modules > General sheet.
3. Locate the Epicor Web Configurator group and paste the copied URL in the Generator URL
field.
4. Go back to the Custom Configurator extension sheet and in the Current Deployment section,
locate the
5. EWC Runtime URL. Click the Copy URL button to copy the URL into your clipboard.
6. Go back to Company Configuration and paste the URL into the Run Time URL field.
Configuring Extension Applications

Use this chapter to configure the extension applications. You can configure them after you have
installed the extension applications and logged into Kinetic for the first time. Extension applications
that require additional configuration include: Enterprise Search, Information Worker, Classic Web
Access, Classic Mobile Access.
If you need to configure Classic Education, refer to the Appendix in this guide.
Configuring Enterprise Search

This section explains how to configure the Enterprise Search extension. Use this information to
configure Enterprise Search after installing it in Application Server Configuration.
Registering the Enterprise Search Server

In this article, we cover how to register your Enterprise Search server, create a search index database,
and deploy the Enterprise Search standalone website. This procedure assumes a new installation in
which there is no previously created search index database or Enterprise Search standalone website.
96 January, 2022
If you previously registered a search server and later uninstalled the components, the registered search
server still appears on the tree. The connection will, however, generate an error when you attempt to
use it. In this case, right-click the outdated search server and select Remove Search Server.
Your search server is in a DMZ in front of an internal firewall, you may need to open
ports for the search service administration (default is 8098) and for SQL Server access
(default is 1433).
1. If your Enterprise Search application pool is configured to use Windows account for
authentication, you need to set up the Search Indexer service to log on with a Windows account
that has access to SQL Server hosting your database. To do this:
a. Navigate to Control Panel > Administrative Tools > Services.
b. In the services list, right-click the Epicor Search Indexer service and select Properties.
c. On the Log On sheet, select the This Account option.
d. Enter the Enterprise Search Windows account credentials as This Account login and
Password. Re-type your password in the Confirm Password field and click OK.
e. Right-click the Epicor Search Indexer service and select Restart.
f. Open Internet Information Services (IIS) Manager. Select your server and in the Actions
pane, click Restart.
2. In Administration Console, right-click Enterprise Search Management and select Register

Search Server. The Enterprise Search Server Configuration Wizard displays.
3. Specify the server and the port where Enterprise Search is installed. To do this:
a. For Name, type the name of the server where the Enterprise Search server components are
installed. Click Ping Server to validate the server connection.
b. For Port, enter the port number of the Enterprise Search server service. Keep the default of
9098 unless the server has been manually configured to a different port. Click Validate
Service to Continue to validate the port assignment.
c. When both validations are successful, click Next.
4. Specify the SQL Server instance and database that will host your search indexes. To do this:
a. For Server Name, select the SQL Server instance on the server where the Enterprise
Search components are installed.
97 January, 2022
b. For Log on to the server, select Use Windows Authentication or Use SQL Server
Authentication.
c. Click Test Connection to validate the server name and credentials.
d. For Enter the name for your Search Index Database, we recommend that you select the
default value. For example, select SearchIndex<Version>.
e. Click Next.
5. The next page presents the option of deploying the Enterprise Search standalone website. Verify
that the Do not deploy web application option is selected and click Next.
6. Confirm your selection details and click Finish.
The new search server is added under Enterprise Search Management in the
Administration Console tree.
1. Create the database. To do this, right-click the new search server and select Create Database.
The databaseSearchIndexversion is created on the default SQL Server instance on the server
where the Enterprise Search server components are installed. For more information on selecting
the SQL Server instance used for the search database and/or selecting its name, see the Set SQL
Server for Search Indexing topic in the Administration Console online help.
1. Create the web application. To do this, right-click the new search server and select Create Web
Application.
Rebuilding Search Index

In this article, we cover how to populate the search index with data before the index can be used.
1. Under Enterprise Search Management, go to Your Search Server Name > Search Indexes.
2. Select the search index you wish to rebuild.
3. From the Actions pane, select Rebuild Index.
4. Click OK on the message box confirming rebuild start.
If you chose to view indexing results the results display in your default text editor when indexing
is finished.If, in the summary log file that displays upon generation completion, there is a BAQ
that has "0 crawl rows" listed, you should navigate to the BAQ in Enterprise Search Manager,
right-click the BAQ and select Properties. Then on the Fields tab, select a field to use as a
98 January, 2022
primary key and select Surrogate Key. Finally, rebuild the index. During a rebuild, the existing
index is still available and is not replaced until the new index is finished building.
5. Go to the Scheduled Tasks node and set up a schedule to rebuild the index automatically.
Setting a Schedule to Rebuild Index

In this article, we cover how to set index rebuilds to automatically take place on a schedule and keep
search results as current as needed. Enterprise Search results are only as current as the last search
index rebuild.
Once you have created a search index definition, that search index must be built regularly to freshen
the index data with data from the Kinetic database. To accomplish this you use Windows Task
Scheduler. For the least complicated setup for index rebuild, you can let Search Manager set one of the
pre-configured tasks for you. Or with a few more steps, you can use the Task Scheduler manually.
When records are deleted in the database, and the search index is not yet updated to
reflect those deletions, the set of records sent to be displayed as a page of results may
have gaps. For example, on page 1 of the results, there might be 1, 2, 3, 4, 6, 7, 9, 10
where 5 and 8 had been deleted so no link could be made. If this happens frequently,
increase the frequency of index builds.
If you want to rebuild indexes with a predefined schedule, do the following. Note that the pre-defined
schedules affect all indexes.
1. Go to the Scheduled Tasks node under the your search server name.
2. From the Actions menu, select one of the Create Hourly/Daily/Weekly Rebuild All Indexes
Task.
3. Verify that the task was created and enabled. You can right-click the task and select Disable task
to temporarily suspend the task.
If you want to manually schedule search index rebuilds, do the following:
1. Go to the Scheduled Tasks node under the your search server name.
2. In the Actions pane, select Launch Task Scheduler.
If you are not on the server where Enterprise Search server components are installed, at this
point, within the Task Scheduler from the Actions menu, select Connect to another computer
and browse to the Enterprise Search server computer.
3. In the Actions pane, select Create Basic Task.
99 January, 2022
4. For Name, type the name you want to use and click Next.
5. Select the interval schedule you want to use. Click Next.
6. Configure the details of the schedule on the next screen. Click Next.
7. Select Start a Program. Click Next.
8. For Program/script, browse to C:\Program Files\Common Files\Epicor Software

Corporation\Epicor Enterprise Search, select ESCmd.exe, and click Open. For Arguments, type
RunIndexer /s:indexname. For example, if your search index name is Kinetic, type RunIndexer
/s:Kinetic. Click Next.
9. Click Finish. Click on the Task Scheduler Library node to view the newly-created task.
Enabling Search Index

In this article, we cover how to set the search index for users (by company) and to grant users access to
the Enterprise Search feature.
1. Log into Kinetic.
3. On the General Settings sheet, configure the URL for user access to Enterprise Search. Under
Enterprise Search:
a. For Search URL, type the URL for Enterprise Search user access in this format:
https://SearchServerName:PortNumber/search/SearchIndexName
For example, if your search server name is KineticApps, the default port for user access is
8098, and your search index name is ERPIndex, the URL would be
https://KineticApps:8098/search/ERPIndex.
The user access port number applied here is different from the
administrative port number used when registering the search server in the
Administration Console.
b. Select Global URL if you want to use this search URL for all companies in your Kinetic
application installation.
4. Open System Setup > Security Maintenance > User Account Security Maintenance.
100 January, 2022

5. For each user you want to have access to Enterprise Search open their record, navigate to the
Options sheet, select Allow Enterprise Search, and save the record. You can also select multiple
users and manage their settings on the List sheet.
6. Make the following adjustment if you are using Classic Web Access:
a. Open the web.config file of your Web Access installation.
b. In the EnterpriseSearchURL element, enter the URL set in step 3.
c. Save the web.config file.
You can override the company-level search URL for an individual user or globally.
l Individual User Override - Under Enterprise Search at the bottom of the Options sheet, clear
Use Default URL and in Search URL, enter an alternate URL.
l Global Override - To globally override all company level enterprise search URLs in the Kinetic
installation, set a URL in the <EnterpriseSearchURL> element in the .sysconfig file that is being
used by Kinetic. The default in the client folder structure is Client\config\default.sysconfig.
Enabling Epicor Search Anywhere for Users

The below article covers how to enable Epicor Search Anywhere for users. Epicor Search Anywhere is a
small application controlled by an icon in the system tray that allows users to trigger Enterprise Search
from any application by performing certain keystrokes.
The idea behind Epicor Search Anywhere is this: users are working in any application (such as a
spreadsheet, a word processing document or an email), they highlight a word, complete a certain
keystroke to submit the highlighted word to Enterprise Search and get back search results. They can
then copy certain results back to the application where they are working.
Administrator - Prerequisites
Search Anywhere users must be set up for single-sign on in the Kinetic application. See your Kinetic
application documentation for instructions on enabling the single sign-on feature.
The search server web application must be created. See the topic Create Web Application in this help
system.
Administrator - Distribute Search Anywhere URL to Users
Search Anywhere functions on the URL for an individual search index. The administrator must distribute
the Search Anywhere URL for the target index.
To find out the Search Anywhere URL for a search index:
101 January, 2022

1. In Administration Console, go to Your Enterprise Search Server Name > Search Indexes.
2. Click the search index that you want to make available to Search Anywhere users.
3. In the Actions pane, select Launch Search.
4. Click OK to use the presented URL.
5. If you need, add the port number of the web site to the URL.
6. Copy the URL from the browser address line and save it for the next step.
7. Prepare and send an email to users who will use Search Anywhere to search this index. In the
email:
l For the email message, paste the entire user setup procedure in the next section Template
for Email to Users - Download, Install, and Configure Search Anywhere.
l In steps 1 and 4 of the procedure, substitute the URL obtained in step 6 above in place of
the placeholder <Provided Search Anywhere URL>.
Template for Email to Users - Download, Install, and Configure Search Anywhere
You must download Search Anywhere from the Search Anywhere site, install it, and configure it (set the
Search Anywhere URL). Obtain the Search Anywhere site URL for the following procedure from your
administrator.
1. Go to <Provided Search Anywhere URL>.
2. On the page, do the following:
l Click the icon in the upper right corner.
l Click Run and then Run again.
l Click Next and then Close.
3. On your Windows Task Bar, right-click the Epicor Search Anywhere icon in the System Tray and
select Set Search URI.
4. Enter <Provided Search Anywhere URL> and click OK.
5. Right-click the Epicor Search Anywhere icon in system tray and select Help to learn about
Search Anywhere and using it in your applications.
102 January, 2022

Re-creating Search Index Definition (If Needed)

In this article, we cover how to re-create Search Index Definition.
1. Right-click Enterprise Search Management > Your Enterprise Search Server > Search Indexes
and select Create Index.
2. Select a search template and click Next. You can select the default template when provided (for
example, the EpicorERP template), or you can use a search template that you have created. You
should now set up the connection to the Kinetic application server.
3. For Server Endpoint, enter the application server URL. Get the correct URL from the
<appSettings><AppServerURL element of the .sysconfig file that points to the application
server. In your Kinetic application installation, .sysconfig files are located in the client\config
folder.
In the URL, use the fully qualified domain name (FQDN). Do not use localhost.
4. For Binding, select the binding type that matches the binding type set in the
<appSettings><EndpointBinding> element of the .sysconfig file.
5. For Operation timeout, adjust the wait time until an incomplete operation is aborted. The
default is 300 seconds. Get the correct value from the <appSettings><OperationTimeOut>
element of the .sysconfig file.
6. Select or clear the For Validate WCF Certificate check box to match the value set in the the
<appSettings><WCFCertValidation> element of the .sysconfig file:
l Select the check box if <WCFCertValidation value="True" />.
l Clear the check box if <WCFCertValidation value="False" />.
7. For DNS Identity, enter the expected DNS server name. Based on the Server Endpoint (Endpoint
Binding) setup in the application server configuration, there are two scenarios where you need to
enter a value in this field:
l UsernameSSLChannel is selected as the endpoint binding: when authenticating using

message-level or transport-level Secure Sockets Layer (SSL) with X.509 certificates, WCF
ensures that the certificate provided during the SSL handshake contains a DNS or Common
Name (CN) attribute equal to the value specified in this field.
l Windows is selected as the endpoint binding: when the service authenticates using
message-level or transport-level SSL with a Windows credential for authentication, and
negotiates the credential, then the negotiation passes the service principal name (SPN) so
103 January, 2022

that the DNS name can be checked. The SPN is in the form host/<dns name>. Get the
correct DNS server name from the <appSettings><DnsIdentity> element of the .sysconfig
file.
8. For User name and Password, enter the Kinetic application user credentials for accessing the
application server.
9. Click Test Connection to verify and click Next.
10. Either select Use all available companies or Select one or more companies to define which
companies to include in the index. If you select one or more companies, select the companies to
use. The available companies are the companies to which the user chosen in the previous screen
has access.
When you choose the Select one or more companies option, and you later add a company, you
then have to modify the index settings to add the new company and regenerate the index to see
the results from the newly-added company.
11. Set up the connection to the Kinetic application database:
l For Server Name, type or select the SQL Server instance that hosts your Kinetic
application database.
l Select Windows or SQL Server authentication.
If you choose SQL Server authentication, type a SQL Server user name/password that has
access to the Kinetic application database. If you chose Windows Authentication, the
logged-on user is used for Windows authentication.
l Click Validate Connection To Continue. When you are creating or later editing a
connection, you cannot proceed until this validation step has been performed successfully.
l For Connect to Database, select your Kinetic application database.
l Click Next.
12. For Name, type a name for this index and click Next.
Do not use any spaces in the name. Using the template name you chose for the
index might be useful.
13. Review the choices you made. To change any information use the Previous button. Otherwise
click Finish to create the search index.
104 January, 2022

14. Next step is to populate the index with data by building it. See the Rebuilding Search Index
article.
Configuring Information Worker

This section explains how to configure the Information Worker extension. Use this information to
configure Information Worker after installing it in Administration Console.
Generating Server Components for BAQs

Use these steps to generate server-side components required for the updatable BAQs.
1. Log into Kinetic as a Security Manager and navigate to System Management > Upgrade/Mass
Regeneration > Updatable BAQ Maintenance.
2. Select the Query ID button.
3. For Basic Search, in the Query ID Starts With field type zIW and select Search.
4. Check Select All and select OK.
5. Select the List sheet. From the Actions menu, select Regenerate All.
Repeat these steps for each company in your Kinetic installation.
Setting Up Server Connection and Initial Configuration

Use these steps to initially set up the server. This procedure must be completed before distributing the
web site URL to users.
1. Navigate to Start > Programs > Windows Administrative Tools > Information Worker
Configuration Manager.
2. In the Actions pane, select Add Application Server. You can skip this step if your application
server has already been registered.
3. In the tree view, expand the Information Worker Configuration Manager node. Select your
application server to display the Server Connection Details page.
4. For Endpoint, enter the application server URL.
You can get the correct URL from the <appSettings><AppServerURL> element of the .sysconfig
file that points to the application server. In your Kinetic application installation, .sysconfig files
are located in the client\config folder.
105 January, 2022

Be sure to use the fully qualified domain name (FQDN). Do not use localhost.
5. For Binding, select the binding type that matches the binding type set in the
appSettings><EndpointBinding> element of the .sysconfig file. The application server will be set
to use one of the following binding types:
l UsernameWindowsChannel- Authenticate using a Kinetic Username and Password.
l UsernameSSLChannel - Authenticate using a Kinetic Username and Password over a

Secure Sockets Layer (SSL) X509 certificate.
l Windows - Authenticate using a Windows Username and Password.
6. For Operation timeout, set the wait time until an incomplete operation is aborted by
Information Worker. You can get the correct value from the <appSettings><OperationTimeOut>
element of the .sysconfig file. The default is 300 seconds.
7. Select or clear the Validate WCF Certificate check box to match the value set in the
<appSettings><WCFCertValidation> element of the .sysconfig file:
l Select the check box if <WCFCertValidation value="True"/>.
l Clear the check box if <WCFCertValidation value="False" />.
8. For DNS Identity, enter the expected DNS server name. Based on the Endpoint (Endpoint
Binding) setup in the application server configuration, there are two scenarios where you need to
enter a value in this field:
l UsernameSSLChannel selected as the endpoint binding: when authenticating using

message-level or transport-level Secure Sockets Layer (SSL) with X.509 certificates, WCF
ensures that the certificate provided during the SSL handshake contains a DNS or Common
Name (CN) attribute equal to the value specified in this field.
l Windows is selected as the endpoint binding: when the service authenticates using
message-level or transport-level SSL with a Windows credential for authentication, and
negotiates the credential, then the negotiation passes the service principal name (SPN) so
that the DNS name can be checked. The SPN is in the form host/<dns name>. You can get
the correct DNS server name from the <appSettings><DnsIdentity> element of the
.sysconfig file.
9. Set up the Kinetic application server connection properties. To do this:
106 January, 2022

a. For Epicor User, and Epicor Password, enter the user name and password for the Kinetic
user account used to access the application server and its configuration data connection.
The password is stored in an encrypted format.
b. Select Test Connection to validate that the provided connection information allows a
session to be created against the application server. On successful connection, the
Configurations node is added to the tree view.
10. Expand the Configurations node and do the following:
a. Expand the Epicor default configuration node and select Data Source to display the
Connection details page. The data source at this point has inherited connection details
from the initial connection setup, with the exception of Kinetic user name and password.
b. Click Test Connection. You are prompted to enter the Kinetic user name and password
that is used to again establish access the application server. This can be the same
credentials you usedbefore, or they can be for a different Kinetic user.
These credentials are now stored with the connection details. The credentials can be
changed as needed by clicking Set Epicor Login.
c. Right-click the Epicor node, and select Deploy to deploy the configuration to the
Information Worker server. Click OK on confirmation.
11. Test the connection and client installer:
a. From the workstation of one of your Information Worker users, go to the Information
Worker web site URL that you established when installing the Information Worker server.
b. At the website, follow the instructions for installing the Information Worker Client.
Deploying Alternate Contact Data Source

Use these steps to create a separate Contacts folder in Outlook for Information Worker contacts. By
default, Information Worker synchronizes all contacts to the Outlook client Contacts folder.
1. Open Information Worker Configuration Manager. To do this, go to Start > Programs >
Administrative Tools > Information Worker Configuration Manager.
2. In the tree view, expand the Information Worker Configuration Manager > Configurations >
Epicor node. Select the Outlook node.
3. In the Outlook Options section, select the Use Alternate Contact Folder check box. In the
activated field, enter a new folder name of hold contacts, such as Kinetic contacts. Save the
107 January, 2022

changes.
4. Deploy your configuration file. To do this, in the Configurations node, right-click your
configuration node (for example, Epicor) and select Deploy. Click OK on confirmation.
5. Log in to Outlook and import the contacts.
Setting Up Information Worker Clients

Use these steps to configure client workstations to run Information Worker. Note that the Information
Worker client installation must be run with local Administrator privileges.
1. Verify the following requirements for the client workstations:
a. Verify you have one of the following operating systems installed on each client
workstation:
l Windows 8.1 x86 / x64
l Windows 10 x86 / x64
b. Verify you have Microsoft .NET Client Profile installed.
c. Verify each client workstation has Microsoft Office 2013 (32- or 64-bit version), Microsoft
Office 2016, or Microsoft Office 2019 installed. Depending on which applications you plan
to use with Information Worker, install Outlook, Word and/or Excel during your Microsoft
Office installation.
d. Verify you have Microsoft Visual Studio Tools for Microsoft Office installed. Note that it is
provided through the Kinetic installation.
e. Optionally, install the Kinetic client to enable additional functionality.
2. In your Kinetic installation, verify each Information Worker user is set up as an Kinetic user and
that the Domain and Domain ID in the user record matches the domain and login name of their
Windows credentials.
3. Install the Information Worker Client. To do this, open the email account on the workstation.
Locate the email message that includes the web address you chose when installing the
Information Worker Server. If you accepted the defaults, the web address is:
http://servername/informationworker.
4. Follow the instructions on the web site to install the Information Worker Client. Review the
troubleshooting information on the site if necessary.
108 January, 2022

Troubleshooting Information Worker Installation Errors

This article includes the troubleshooting information for the common Information Worker Server
installation errors.
Problem Cause Possible Resolutions
During the server Install could not set Go to

installation, an error error email C:\Inetpub\wwwroot\InformationWorker\App_
displays similar to: properties. Data\
"Errors setting configuration If you changed the InformationWorker portion

values; installation will try to of the above address during installation, use
complete, but you may need Notepad to edit the Configuration.xml file.
to manually correct Search for ErrorFormEmailAddress and change
configuration values." the email address value to reflect the email
account you want to use. Exit Notepad and
save.
During the server Anonymous access is ClickStart > Run > inetmgr to open IIS manager.
installation, an error not enabled or the Go to the virtual directory you configured
displays similar to: Information Worker (default name: InformationWorker).
virtual directory is
"Errors setting web site not using the l Verify Anonymous access is enabled
values; installation will try to Information Worker under Authentication.

complete, but you may need application pool.
l Under Basic Settings verify
to manually set the ASP.NET
version, Directory Security, theInformation Worker app pool is
and/or create an application selected.
pool."
If you have a previous install Data Type mismatch l Unsync everything in Microsoft Outlook.
of IW, and you are importing since SysRowID in
customers and associated Epicor 9 is a string l Delete the Epicor folder in Microsoft
contacts, an error displays and in Epicor 10 it is Outlook.
similar to: a GUID.
l Close Microsoft Outlook.
"Unable to add column
l Navigate to the isolated storage files for
named 'SysRowID. This may
Information Worker.
be a reserved name in
Outlook" l Delete the contents of the Schema folder.
109 January, 2022

Problem Cause Possible Resolutions
l Log back into Microsoft Outlook and try

again.
Configuring Classic Web Access

Use these steps to deploy and configure Classic Web Access (former Epicor Web Access or EWA) after
installing the Classic Web Access
You must have Microsoft Internet Information Services (IIS) 7.5 or higher installed. The Classic Web
Access forms and components are an optional installation and are required only if browser-based
access to your Kinetic application environment is desired.
While it is possible to deploy the Classic Web Access forms on your Windows based Kinetic server, it is
not recommended. For optimal performance and ease of maintenance, we recommend using a separate
Internet Information Server. If you used the publish extension installer to install Classic Web Access on a
separate IIS, in order to deploy to the Classic Web Access site, you must use custom credentials (from a
valid domain account) for the Application server App pool.
The custom credentials are needed so that the Setup Environment program on the remote Classic Web
Access site can grant the needed permissions to Write in the remote Classic Web Access Virtual
directory. If you do not use an account with custom credentials for the Application server App pool, you
may receive an error on any deployment to the remote Classic Web Access site.
Classic Web Access is not compatible with 32-bit applications. In Internet Information
Services (IIS) Manager, make sure the Classic Web Access application pool does not
have 32-bit applications enabled. To do this, navigate to Application Pools, right-click
your Classic Web Access application pool and select Advanced Settings. Verify that the
Enable 32-Bit Applications option is set to False. If set to True, Classic Web Access will
not be able to launch.
Deploying Classic Web Access Forms

In this article, we cover how to deploy Classic Web Access forms. The delivered web forms are
generated at the same version as the Kinetic application software deployed in the release. The Web
Menu includes the forms that are available for Classic Web Access.
1. Classic Web Access includes the majority of the Kinetic application forms, with a few exceptions
of the drag-and-drop scheduling forms and most of the system setup forms. Review the list of
form exceptions, which include:
110 January, 2022

l Job Scheduling Board
l Multi Resource Scheduling Board
l Resource Scheduling Board
l Business Activity Query Designer
l BPM Method and Data Directive Maintenance
l Financial Report Designer
l Menu and Security Maintenance
l Mobile, Customer and Supplier Connect Maintenance
l Translation Maintenance
l System Agent
l W2 Processing
To find the complete list of form exceptions, navigate to the ClientDeployment/Client/Res

folder. With a text editor, open the WebAccess.xml file. Scroll through the file to view the
forms that are not included.
2. Determine if you need further control over web forms that you need to exclude from Classic Web
Access.
To exclude a form, in Kinetic, go to Menu Maintenance (using the Smart Client) and on the
Security sheet, select the Exclude Epicor Web Access check box associated with each menu
option. Classic Web form supports group access security so this exclusion is only required when a
form should be available to users from the Smart Client but not the Web Client.
3. Determine if you need to customize any forms or create any user dashboards since these must be
specially generated for Classic Web Access. When deploying customized forms to Classic Web
Access, the following are limitations on what can be converted:
l Forms that have customization code that is written in VB.NET cannot be deployed to
Classic Web Access.
l Forms that have embedded Appbuilt/dashboard panels cannot be deployed to Classic Web
Access.A prerequisite for generation is that any customization script must be supported in
C# rather than VB.Net code. This is due to the fact that the process converts customization
code from C# into Java Script for Browser deployment. This process is not possible from
111 January, 2022

VB.Net code. Although VB.Net is supported for backward compatibility with the Kinetic
application, it is not recommended that new customizations are created using VB.Net with
the Kinetic application since they do not generate for Classic Web Access without
conversion to C#.
4. Determine how to process the customizations and dashboards containing customization code in
VB.Net that were created prior to upgrading your Kinetic application. You must either recreate
those customizations using C#, or manually convert code either by hand or using a commercially
available VB.Net to C# conversion routine. Instructions are available in a the document entitled
Guidelines for Conversion of VB.Net to C# Customization Code in Kinetic. Contact Support for this
documentation.
5. If you want certain users to use a Time and Expense (TE) or Customer Relationship Management
(CRM) license, direct them to use the following URL style to get to the login page:
l Time and Expense (TE): http://<your server>/<your site

name>/default.aspx?LicenseType=TE or
l CRM: http://<your server>/<your site name>/default.aspx?LicenseType=CRM.
Direct users of TE and CRM license types to set up browser Favorites using the appropriate URL.
Setting Up Initial Configuration of Classic Web Access

In this article, we cover how to configure Classic Web Access within Kinetic.
2. On the General Settings tab, in the Web Access section, enter your Web Access URL. For
example, enter https://<ServerName>/Kinetic202x_x-EWA.
If you have already deployed the extension, you can find this value on the Extensions > Classic
Web Access sheet in Application Server Configuration.
3. Enter your Metadata Output Path. This is from the perspective of a client workstation that might
be generating Classic Web Access forms. The default path is C:\inetpub\wwwroot\Kinetic202x_x-
EWA.
For example, enter: \\<your server>\<shared site name> where <your server> is the name of your
web server and <shared site name> is a share on that server to your Classic Web Access site
name. Example: c:\inetpub\wwwroot\<your site name>.
1. Select Save.
112 January, 2022

Generating Web Forms for User Dashboards

1. Verify that the account that runs the Application Server's IIS application pool has Read & Write
permissions to the Classic Web Access MetaData Output Path. To do this, use the instructions in
the previous section for generating web forms for custom forms.
2. In Kinetic, navigate to System Setup > Security Maintenance > User Account Security
Maintenance. On the Options sheet, verify that the Dashboard Developer check box is selected.
3. Go to Dashboard Maintenance and open a dashboard for which you want to generate a web form
using the Developer Mode.
4. From the Tools menu, select Deploy Dashboard.
5. To make this dashboard available as a smart client application, select one of the following
options:
l Select the Deploy Smart Client Application check box. With this option selected, you can
then later add this dashboard as a node on the Main Menu and access from within Classic
Web Access site.
l Select the Add Favorite Item check box. With this option selected, the dashboard
becomes part of the Favorites > Dashboard Assemblies group found on the Classic Web
Access Home Page.
l Select the Generate Web Form check box. With this option selected, the dashboard is
deployed as a web form you can access from the Classic Web Access site.
6. Select Deploy.
7. Once the deployment process completes, click OK.
Generating Web Forms for Customized and Localized Application Forms

In this article, we cover how to generate web forms for customized and localized Kinetic forms.
This step is required because Classic Web Access does not support the Options button by which you
can select the number of rows to return.
1. Navigate to System Management > Upgrade/Mass Regeneration > Customization

Maintenance.
2. Click the Name button. The Customization/Personalization Search window opens.
3. In the Type drop-down list, select Customization.
113 January, 2022

4. Click the Options button. In the Search Options window, select the Return All Rows check box
and click OK.
5. In the Customization/Personalization Search window, click Search. The Search Results panel
displays all customization. Click Select All.
6. From the Actions menu, select Generate All Web Forms. Click Yes in the confirmation window.
7. In the Type drop-down list, select Localization.
8. Click the Options button. In the Search Options window, select the Return All Rows check box.
Click OK.
9. In the Customization/Personalization Search window, click Search. The Search Results panel
displays all customization. Click Select All.
10. From the Actions menu, select Generate All Web Forms. Click Yes in the confirmation window.
Reviewing Supported Browsers

Use these steps to review the browsers and browser configurations that are supported with Classic Web
Access.
Verify that one of the following browsers is installed on your system. Note that Classic Web Access
supports only the latest releases of these browsers.
l Microsoft Edge®
l Mozilla Firefox®
l Apple Safari®for Mac OS® and iOS®
l Google™ Chrome
Installing Crystal Reports Embedded Server 2013 (optional)

If you use Crystal Reports for your report generation from Classic Web Access you must install Crystal
Reports Embedded Server 2013. Note that it must be installed on the web server that is hosting Classic
Web Access.
1. If you have a previous version of Crystal Reports Embedded Server installed, you must first
uninstall it. To do this, navigate to Start > Control Panel > Programs and Features. Select the
option for Crystal Reports Embedded Server and click Uninstall. Refresh the list to verify the
product was successfully uninstalled.
114 January, 2022

https://epicweb.epicor.com/products/kinetic-erp/downloads/on-premises/downloads-kinetic.Go
to theKinetic > Version 2021.2 > Third Party Products > Crystal folder and download the latest
Crystal Reports embedded server file to your workstation. For example, download SAP SVR EMBD
2013 SP06 OEM Win -32B.zip. Extract the file. Move the extracted files to the report server where
the file are to be installed. Do the following:
a. Navigate to the extracted file folder and Data_Units > RAS sub folder. Run the Setup.exe
file.
b. In the Setup dialog, select your language. Click OK.
c. In the Welcome dialog, click OK.
d. If prompted with a prerequisite checklist, review the status of each component. Click Next.
e. Review the license statement and select to accept it. Click Next.
f. In the Configure Product Registration dialog, enter the Product Key. Note that the Product
Key information is listed in the Epicor Keycode Request file which is located in the
extracted folder.
g. In the Configure Destination Folder dialog, specify the folder. Click Next.
h. In the Select Languages Packages dialog, select one or more language packs to install. The
English language is selected by default. Click Next.
i. Select which features you would like to install. Click Next.
j. Click Next to confirm to start the installation. A meter displays the progress.
k. When completed, click Finish.
3. You need to set the Report Directory of the Central Configuration Manager. To do this:
a. Navigate to Start > SAP Business Intelligence > Crystal Reports Server 2013 OEM
Edition > Central Configuration Manager.
b. Right-click on Crystal Reports Server 2013 and select Stop.
c. Right-click on Crystal Reports Server 2013 and select Properties.
d. In the properties dialog, select Parameters.
115 January, 2022

e. In Option Type, select Server.
f. For the Report Directory enter the value: C:\.
g. Click OK to save your changes.
h. Right-click on Crystal Reports Server 2013 and select Start.
Installing Crystal .NET SDK Runtime (optional)

If you use Crystal Reports for your report generation from Classic Web Access you must install Crystal
.NET SDK Runtime on your workstation. Note that Crystal Reports Embedded Server must already be
installed on the web server that is hosting Classic Web Access.
If you have a previous version of Crystal .NET SDK Runtime installed, you must first uninstall it. To do
this, navigate to Start > Control Panel > Programs and Features. Select the option for Crystal .NET
SDK Runtime and click Uninstall. Refresh the list to verify the product was successfully uninstalled.
https://epicweb.epicor.com/products/kinetic-erp/downloads/on-premises/downloads-kinetic.Go
to theKinetic > Version 2021.2 > Third Party Products > Crystal folder and download the latest
Crystal .NET SDK Runtime file to your workstation. For example, download SBOP BI PLATFORM
4.1 SP06 SDK WinRT.zip. Extract the file. Move the extracted files to the report server where the
file are to be installed.
2. Navigate to the extracted file folder. Extract the file in that folder. Navigate to the Data_Units >
BusinessobjectsRuntime sub folder. Select either 32bit or 64bit. Run the Setup.exe file.
3. In the Welcome dialog, click Next.
4. Review the license statement and select to accept it. Click Next.
5. If prompted, confirm the installation. Click Next.
6. When completed, click Finish.
Setting Your Database to Production

When you go live after installing and testing Kinetic, you should perform additional steps to complete
the system configuration in production environment.
In this article, we cover how to set your database to "Production" and indicate your companies are
"Live".
116 January, 2022

1. In the Administration Console tree view, select your Server Management > [server] >
2. In the Actions pane, click Set to Production. The application server icon color changes from
green to blue which means the database is in "Production" mode now.
3. If later you need to indicate the system is not in Production, use the Remove Production Status
action.
Setting your database to Production helps you to easier switch between the
Production and Test mode. For example, you can set up a BPM that would
adjust your system settings depending on whether is in production or not.
We recommend that you change Production status when you take a backup of
your production database and put it to test or pilot as well as when you move
the SQL server to another box and/or SQL instance.
4. Log into Kinetic and navigate to System Setup > Company / Site Maintenance > Company
Maintenance.
5. In the General Settings sheet, select the Is Live check box and select Save.
6. Repeat the steps for each company that goes live.
We recommend that you change the Is Live status when you take a backup of your production
database and put it to test or pilot as well as when you move the SQL server to another box
and/or SQL instance.
Configuring Context Indicator (Optional)

Home Page and Kinetic UX applications have a context indicator that displays the current application
server, user, company, and site. You can customize it by adding a name for the installation and
selecting a color for the indicator. This may be useful when you have multiple environments (for
example, Testing, Production, Education and so on) and you want to easily identify the environment in
use.
In this article, we cover how to configure the indicator:
1. In Administration Console, under Server Management > [Kinetic server] node, select the
application server for which you want to customize the context indicator.
2. Right-click the application server and select Installation Settings.
117 January, 2022

3. Enter a Name for this Kinetic instance and select a Color to use for the indication bar.
When you log in to Kinetic, the context indicator may look similar to the following:
4. You can also select a separate color for the part of the indicator that displays the current user,
company, and site name. To do this, log in to your Kinetic application and open the Site
Maintenance program.
5. Use the Site button to search for and select a site to customize.
118 January, 2022

6. From the Site Color drop-down, select a color to identify this site on the indication bar.
7. Click Save. Then exit and re-login to Kinetic. The context indicator displays the selected colors:
Enabling Edge Agent Download for Client Printing

The Edge Agent is a component you can install on a machine and configure to connect to your
application server. It allows for secure, encrypted communication from the Kinetic UX Browser Client to
the Agent, which as an application is installed and running on that system, has more complete access
to the local devices and its printers.
119 January, 2022

Installing Edge Agent on the machines where users access Kinetic in a browser - for example, Google
Chrome® or Safari® - enables them to send SSRS reports directly to printers in their network using the
Client Print icon in the report screens.
Edge Agent installation requires administrative rights to the local device and, as a rule,
is handled by IT personnel. For the information on how to install and configure the
Edge Agent for client printing from the browser, refer to the Understanding Reports
article in Kinetic help.
By default, the ability to install Edge Agent is disabled, so if you want to allow this option, the
application Security Manager should enable it on the company level.
1. Log in to Kinetic as a Security Manager and go to System Setup > Company/Site Maintenance >
Company Maintenance.
2. Select the Email and Reporting sheet.
3. Select the Allow Edge Agent Installer Download check box.
4. Select Save.
120 January, 2022

Configuring an SSRS Database User

If you use SQL Server Reporting Services (SSRS), you need to adjust the database settings will secure
your transactional database from unauthorized viewers.
In this article, we cover how to configure a user to access your SSRS database while running the
reports. Depending on your company policies, you can either use a Windows or a SQL account for this
purpose.
1. Log into your SQL Server Management Studio and connect to the server where you installed your
reporting database when deploying the application server.
2. Under the Security folder, right-click the Logins folder and select New Login.
l SQL Server Authentication. Select SQL Server authentication. For Login Name, enter an
appropriate login name. For example, SSRSLogin. Enter a Password and confirm the
password. Click OK.
l Windows Authentication. Keep Windows authentication selected. For Login Name, click
Search to select the Windows domain account to use for the reporting database access. If
desired, create a Windows account just for this. Click OK after you have selected the
Windows account.
4. Under the Databases folder, expand [Your reporting database] > Security. Right-click the Users
folder and select New User.
l SQL Server Authentication:
a. Select the SQL user with login user type.
b. For User name, enter an appropriate name. For example, SSRSUser.
c. Click the Browse (...) button next to the Login name field, search for and select the
SQL user login you added in the previous step. For example, SSRSLogin. Click OK.
d. Select the Membership page and select the db_datareader check box. Click OK.
l Windows Authentication:
121 January, 2022

a. Select the Windows user type.
b. Click the Browse (...) button next to the User name field, search for and select the
Windows user name you added in the previous step. Click OK
c. Click the Browse (...) button next to the Login name field, search for and select the
Windows user login. Click OK.
d. Select the Owned Schemas page and select the db_datareader schema check box
for the user. Click OK.
6. Open Report Server Configuration Manager and connect to the SSRS report server instance.
7. Select the Web Server Portal option in the pane on the left. Click the web portal URL to access
the SQL Server Reporting Services portal.
8. In the reports folder, scroll down to the bottom to data sources and select the
SharedDataSource.
9. Under the Credentials title, select the As the user viewing the report option.
10. Edit the Connection string to include the credentials of the database user you configured.
122 January, 2022

11. Select Test connection to verify the connection string is working.
12. Select Apply.
123 January, 2022

Testing Your System and Repeating the Installation

If you completed the Kinetic installation in a Test environment, you are now ready to test the installed
Kinetic application in that environment. After your testing is complete, you must repeat the entire
installation in your Production environment. Note that while it is possible to install multiple versions of
Kinetic on the same server for testing purposes, it is not recommended.
If you completed the Kinetic installation in your Production environment, you are ready to set your
application server and database to Production. Review the Setting Your Database to Production
article for the details.
Installing Kinetic Client on a Workstation

In this article, we cover how to install the Kinetic client on your workstation. New customers adding an
initial client workstation and existing customers adding an additional client workstation should use the
following instructions to install the Kinetic client.
If you are a Public Cloud customer, refer to your Cloud Operations Welcome Letter for
Client installation instructions.
Installing .NET Framework 4.8 Runtime

Microsoft .NET Framework 4.8 Runtime is required on the workstations were you are going to install
Kinetic clients. Use the following steps to install it.
1. Go to the Microsoft download center for .NET Framework 4.8. You can use this link:
https://dotnet.microsoft.com/download/dotnet-framework/net48.
2. Click the Download .NET Framework 4.8 Runtime button to download the .NET 4.8 installer.
3. Use the Microsoft instructions provided to guide you through the installation process.
Installing Kinetic Client Software

Use these steps to install the latest Kinetic client software on your client workstation.
You must perform these steps after the 2021.2 (11.1.200.x) AppServer has been created
and configured. Setting up the AppServer updates the *.sysconfig files necessary for
the Kinetic Client installation and update.
124 January, 2022

1. Make sure you are logged in as the Local Administrator on the client workstation.
2. On your client workstation, use a file explorer to navigate to the
ClientDeployment\ClientInstaller folder on the server where your Classic application is
installed. For example, navigate to
\\<server>\Epicor\ERP11\11.1.200.0\ClientDeployment\ClientInstaller. Double-click to run the
KineticClient.exe file.
3. The Welcome window appears for the client installation. Click Next.
4. The Client Destination Folder window appears. Specify the following paths.
l For the Install Kinetic 2021.2 Client location, accept the default location, or click Change
to browse and select a different location.
l For the Share Location, verify the network path is the correct path to the client installer,
such as \\<server>\ERP11.1.200.0deployment. This folder should not be deleted from the
server.
Select Next.
5. The Shortcut Creation window appears. Select the check boxes for the client shortcuts that you
want to create. If an Auto* shortcut is displayed, do not select it. Select the Create Desktop
Icons check box to create the Kinetic and MES icons on your desktop. Click Next.
125 January, 2022

6. The Ready to Install window appears. Click Next.

7. The client installation begins. A status bar displays the progress of the installation. When the
installation is complete, click Finish. If prompted, reboot the workstation.
8. You can now log in to the Kinetic client. For example, open the Epicor Software folder on your
desktop and navigate to Kinetic 2021.2 Client > [server] and run the Kinetic202x_x Environment
shortcut. Note that when you log in for the first time, the client files are extracted. This may take
a few minutes.
Installing Kinetic Client Using Silent Installation

After running the KineticClient.exe for the first time, the silent.bat file is created and it stores the
parameter information that you entered for the prompts. If you want to install the client on additional
workstations, use the following steps to run the silent.bat file that installs the client without any manual
intervention.
1. Navigate to the client installer location on the server. For example, go to
\\<server>\Epicor\ERP11\11.1.200.0\ClientDeployment\ClientInstaller.
2. To run the client installation, double-click the silent.bat file. The batch file runs the
KineticClient.exe file without requiring any manual intervention to answer prompts.
126 January, 2022

If you move the KineticClient.exe file to a different directory, you must also edit
the silent.bat run command to specify the new path. For example, if you move
the file to c:\epicor, you must update the path from KineticClient.exe /s to
\\server\epicor\clientinstaller\KineticClient.exe /s.
The silent.bat file includes the following flags:
l "/s" initiates the silent install,

l "Silent" confirms the use of the silent install,
l "Desktopico" indicates if the installer creates Desktop icons,
l "SilentInstalls" is the folder name where the shortcuts will be copied,
l "TargetDir" is the install directory for the client,
l "ServerLoc" is the deployment where to pull the client.
127 January, 2022

Supplemental Installations
This part of the guide explains how to complete your Kinetic application set up. Complete the sections
appropriate for the supplemental components and products you intend to use.
Configuring Country Specific Functionality (CSF)

This article covers additional information about CSFs, including which CSFs are available in Kinetic,
additional post-migration steps, and instructions to install CSF Language.
CSFs are part of the Kinetic Installer. Use the steps in the Importing the License File and Enabling
Modules article in this guide to enable CSFs for required countries using the Administration Console.
You can then navigate to the EPICWeb Downloads portal to download supplemental files for Kinetic
CSF, such as Functionality Guides and CSF Language Translations. Note that CSF packages from
previous Kineitc/ERP versions are not compatible with Kinetic.
Configuring CSF in Kinetic

Use this section to review the CSFs that are available in Kinetic. Note that you can enable multiple CSFs
on one Kinetic installation with any number of application servers/databases. Only one country can be
activated for a company.posting rules are derived from the Extended posting rules, not the Standard
posting rules. Functionality included in Standard posting rules may not be available in the CSF posting
rules.
Country Specific Functionality for the following countries are available in Kinetic 2021.2.
Argentina (AR) Germany (DE) Romania (RO)
Australia (AU) India (IN) Singapore (SG)
Belgium (BE) Japan (JP) Sweden (SE)
Canada (CA) Malaysia (MY) Switzerland (CH)
China (CN) Mexico (MX) Taiwan (TW)
Colombia (CO) Netherlands (NL) Thailand (TH)
Czech Republic (CZ) New Zealand (NZ) United Arab Emirates (AE)
128 January, 2022

Denmark (DK) Norway (NO) United Kingdom (GB)
Estonia (EE) Peru (PE) United States of America (US)
Finland (FI) Poland (PL) Vietnam (VN)
France (FR) Portugal (PT)
Country Specific Functionality for the following countries are not available in Kinetic 2021.2.
Russia (RU) South Korea (KR) Turkey (TR)
After the installation or migration to Kinetic refer to the Country Specific Functionality Guides for any
additional steps that can be required to set up your CSFs in Kinetic. The functionality guides are located
on the EPICweb Customer portal website. To access them from EPICweb, navigate toProducts >
Kinetic/ERP > Documentation > On-premises. Expand your specific release and then expandDeliverable
= Country Specific Functionality to display the list of guides.
If you have one of the following CSFs installed, use the Setup > Solution Workbench topic in its
Country Specific Functionality Guide to install the latest CSF solution:
l Australia
l Canada
l Colombia
l Finland
l France
l Germany
l India
l Netherlands
l Norway
l Portugal
l Singapore
l Sweden
129 January, 2022

l Thailand
l United Arab Emirates
l United Kingdom
Installing a CSF Language File

Use these steps to download and install the language file for your Country Specific Functionality (CSF).
The CSF language must be installed after the CSF functionality has been enabled and configured.
These steps are common for all CSF packs, all versions of builds and of translations. You can use any
translation version with any build version. If you are using an old version of the Kinetic build or CSF
pack, and translations are not available for the corresponding branch on the CSF download portal, you
can import translations from the latest build branch.
You will have a proper CSF translation installed only if you have imported both
standard and CSF translation files. Refer to the Installing Languages article earlier in
this guide for instructions on how to install standard translation file.
2. Navigate to Kinetic > Version 2021.2 > Country Specific Functionality ><Country name>.
Download the CSF language XML file.
3. Navigate to System Setup > System Maintenance > Language Maintenance.
4. Select the Language ID button, clear the Installed check box and then click Search.
5. Select the ID of the language you want to install. To create a new language ID, select New menu,
select New Language Name.
6. From the Actions menu, select Import Translations.
7. In the Import Translations window, click the Browse (...) button next to the Translation File
field and navigate to the downloaded CSF language file. Select the file and click Open.
8. Click Import. The import process starts. You must wait till the process finishes prior to
performing the next step.
130 January, 2022

9. In the Language Maintenance window, from the Actions menu select Rebuild Translation Table.
10. Exit Kinetic and open it again.
Installing Languages
In this article, we cover how to install language files, if you want to use other languages than English on
Kinetic.
Installing Language Files

In this article, we cover how to download and install a language file.
2. Navigate to Kinetic > Version 2021.2 > Translations > <Language name>.
3. Select and download the zip file. Extract the language XML file to your workstation.
4. Right-click on your Kinetic shortcut and select Run as administrator.
5. Navigate to System Setup > System Maintenance > Language Maintenance.
6. Enter the ID of the language you want to load. If you do not know the language ID, click the
Language ID button to use the search function. Clear the Installed check box, then click Search.
To create a new Language ID, from the New menu, select New Language Name.
7. From the Actions menu, select Import Translations.

8. In the Import Translations window, click the browse button next to the Translation File field and
navigate to the downloaded language file. Select the file and click Open.
9. Select Import. The import process starts. You must wait till the process finishes prior to
performing the next step.
10. In the Language Maintenance window, from the Actions menu select Rebuild Translation Table.
11. Close Kinetic and open it again.
Changing Language Settings

After installing the language file you can change the application language.
131 January, 2022

l Home Page: select the User Settings button and use the Language drop-down to apply the
required language.
l Tile view: In the main application menu, from the Options menu, select Change Language.
Highlight the required language and click OK.
Optionally, you can also change the language for a user:
1. Log into Kineticas a Security Manager and go to System Setup > Security Maintenance > User
Account Security Maintenance.
2. Select the ID of the user for which you want to change language settings.
3. On the Details sheet in the Language field, select the installed language and save the record.
Configuring Epicor Collaborate

Use these steps to configure access to Epicor Collaborate through your Kinetic client and register the
application.
1. Log in to Kinetic as a System Manager and navigate to System Setup > Collaborate
Maintenance > Collaborate Management.
2. In the Epicor Collaborate Registration window, select the region for your data from the drop-
down.
132 January, 2022

3. For better performance, you should use the closest region to the location where your Kinetic
client is installed. Also, Collaborate messages will be stored in this region which may be
important for data governance requirements.
4. In the Environment Name field enter a name to identify the type of environment you currently
work in. For example, Live, Production, Test, Pilot, and so on. The name does not have to be
unique, it will help to identify your Collaborate environment when you need assistance from
Support.
5. Click Register.
6. In the Recovery Key window, copy your recovery key. If you lose access to the registered
environment, you can easily reconnect to it using the recovery key. Keep it secret and treat it like
your password. After you navigate off the page, you will not be able to see the recovery key
again.
7. Once the registration is complete, the health check window with your environment name
displays.
8. Collaborate widget is now available to be added to your home page as a widget or as a tab. Refer
to the Home Page topics in Kinetic application help for information on how to work with widgets
and tabs.
For Collaborate to send and receive data from Kinetic, you now need to enable CDC Log Processor and
CDC Notification Sender. To enable these processes, refer to the Running CDC Log Processor and
Running the CDC Notification Sender Process topics in the application help.
If you change the Cross-Origin Resource Sharing (CORS) policy from a wildcard, you
need to include the management.collaborate.epicor.com resource to the policy.
Depending on your location, add one of the following resources:
l Central United States: centralus.collaborate.epicor.com

l Western Europe: westeurope.collaborate.epicor.com
For more information about CORS, refer to the CORS Support article in this guide.
If you want to connect to a different Collaborate environment, in the Collaborate Management program,
select the Change button and enter its recovery key, generated on registration.
When you change to another Collaborate environment, you lose access to the current
environment if you do not have its recovery key. If you choose to disconnect from the
Collaborate environment, you lose any rules or unsent notifications associated with
the collaborate subscriber.
133 January, 2022

Installing Credit Card Gateway

Use this section to install Credit Card Gateway. This product is comprised of the components that are
installed with Kinetic, as well as the CRE component that must be installed separately.
1. Verify that you have Kinetic installed and configured on your server.
Open the Version 2021.2 > Third Party Products > CRE for Credit Card Processing folder.
3. Download the Epicor CRE Installation Guide.
4. Use the instructions in that guide to install the product.
Installing Performance and Diagnostic Tool

Use this chapter to install Performance and Diagnostic Tool.
You can use the Performance and Diagnostic Tool to analyze Kinetic logs to measure performance from
both the client and the server. More information on the tool is available in the Performance Tuning
Guide which is available from the Kinetic Help. Use the information in the guide to run the tool. Use
these steps to install the Performance and Diagnostic Tool.
1. In the Administration Console tree view, navigate to Server Management > [server] >
134 January, 2022

2. Select the Performance and Diagnostic Tool button. Click Yes to confirm the installation.
3. On the Performance and Diagnostic Tool Setup welcome dialog, click Next.
4. On the Choose folder dialog, accept the default installation path of select a different location in
the tree. Click Next.
5. Accept the default Program group name or enter a name you want to use and define the
installation scope. You can select the Create shortcuts for all users of this computer or the
Create shortcuts just for me option. Click Next.
6. Click Next on the confirmation dialog. When the installation is complete, click Finish.
7. To open the Performance Diagnostic Tool, double-click the shortcut that was created on your
desktop.
8. From the Help menu, select the help option to open the Performance Tuning Guide. Use the
information in the guide to run the tool.
Updating Product LifeCycle Management

If you have the Product LifeCycle Management software installed, you need to upgrade it to the latest
version.
135 January, 2022

1. Navigate to EPICweb Customer portal website: Products > Kinetic/ERP > Documentation > On-
premises. You can use this link: https://epicweb.epicor.com/products/kinetic-
erp/documentation/on-premises. Go to Release: 2021.2 > Deliverable: Installation Guide.
2. Download the PLM Configuration Guide for the current version.
3. Use the instructions in that guide to install the product.
Accessing the Data Management Tool

Data Management Tool (DMT) is part of Kinetic installation. You can use DMT to accelerate and simplify
the data migration process as well as efficiently maintain your existing system data.
In this article, we cover how to run the DMT application:
1. Navigate to the folder where you installed Kinetic. For example, C:\ Epicor\ERP11\11.1.200.0.
2. Open the ClientDeployment > Client folder.
3. Locate and run the DMT application executable file.
Installing Microsoft Service Bus 1.1

Use this chapter to download and install Microsoft Service Bus for Windows Server 1.1 from the
Microsoft Download Center website.
The Microsoft Service Bus for Windows Server is only required if you use Multi-Company functionality
and you process multi-company transactions between more than one database. Microsoft Service Bus is
the repository through which XML messages are sent and received between the companies. The
Microsoft Service Bus for Windows Server is not required if you process multi-company transactions
within the same database and you use Multi-Company Direct functionality. Using the Multi-Company
Direct method of transfer, XML messages sent and received between companies are held in memory.
It is recommended that you first install Microsoft Service Bus 1.1 in a test environment. After verifying
that your Service Bus installation has connectivity to your Kinetic environment and you can successfully
transfer data, it is recommended that you then install Microsoft Service Bus 1.1 in your production
environment.
Installing Service Bus in a Test Environment

Use this section to install Microsoft Service Bus for Windows Server 1.1 from the Microsoft Download
Center website into a test environment. The following steps to install and configure the test
environment use a basic configuration so that you can test your connectivity between the Service Bus
and Kinetic.
136 January, 2022

1. You must identify a user account to use for the Service Bus installation. To do this, find the user
account that has the ability to access the following:
l Application Server
l SQL Server
l Server where Service Bus will be located
Note that you will enter this user account information during the configuration of Service
Bus in step 5 below. It is required that you enter the user credentials for Service Bus that
are required by your Windows security setup. For example, your user credentials for
Service Bus may match your application server user, or your user credentials may be
included in a Windows security group that has access to your application server.
2. Go to the Microsoft Download Center. Search for Microsoft Service Bus for Windows Server 1.1.
You can use this link: https://msdn.microsoft.com/en-us/library/dn282144.aspx.
3. To install Server Bus installation and test connectivity, select the Getting Started with Service
Bus for Windows Server option.
4. To install the product, follow the instructions on the MSDN page in the Install Service Bus for
Windows Server section. In this section, do the following:
l Run the Web Platform Installer.
l Search and select to install Windows Azure Pack: Service Bus 1.1.
l Follow the prompts to download and install the product.
5. To configure the product, follow the instructions on the MSDN page in the Configure Service Bus
for Windows Server section. Additional details are provided below:
l Create a New Farm. Create a new farm using default settings if you do not already have
an existing farm (cluster of servers).
l SQL Server Instance. Note that it defaults to the first SQL Server instance it finds. You
may need to change the default to a later version. Click Test Connection to verify.
l Configure Service Account. Enter user credentials that you will use to run the Service Bus
services. Refer to the user account identified in step 1 above. Click Test Connection to
verify.
l Certificate Generation Key. Enter a valid key combination. For example, Kinetic1234. To
137 January, 2022

confirm, enter the key again in the accompanying field. If you are on a server that already
has a certificate, enter the existing certificate instead of generating a new one.
6. After you click Next, the Summary dialog appears. It is recommended that you take screen
captures of the entire dialog so that you can use the information later when you configure Multi-
Company functionality within Kinetic.
7. Select Apply (checkmark). The configuration process is applied and the operations are listed as
completed when finished. If any part of the configuration process fails, you must re-start the
wizard to run the configuration again.
8. Verify that the Service Bus databases were successfully created. To do this, connect to your SQL
Server instance that you used during the installation. Confirm that the following databases were
created:
l SbGateway Database
l SbManagementDB
l SbMessageContainerXX (where XX is the number of databases you specified during the

configuration).
9. Verify your Service Bus services and application pool user. To do this, on your server:
a. Navigate to Start > Control Panel > Administrative Tools > Services. Verify that the
following services are started:
l Service Bus Gateway
l Service Bus Message Broker
l Service Bus Resource Provider
l Windows Fabric Host Service
b. For each service, verify that the Log On As user is the Configure Service Account defined
during the configuration of Service Bus.
10. Define the external system and connection information required by Kinetic. To do this:
a. Open Kinetic and navigate to System Setup > External System Integration > Setup >
External System Maintenance.
b. Click the External System button. Click Search.
138 January, 2022

c. Select the MULTI record with Transfer Method = SERVICEBUS.
d. Locate the Summary dialog screen capture. Enter the Service Bus Connection details:
l Server FQDN or Azure URI. Enter the FQDN (Fully Qualified Domain Name) for the
server.
l Namespace. Enter the Service Bus namespace value.
l TCP Runtime Port. Enter the port listed on your Summary screen capture.
l HTTP Management Port. Enter the port listed on your Summary screen capture.
e. Click Save.
f. Click Test Connection. If the connection is successful, click OK. If an error message
displays, review the information, resolve the error and try again.
11. We recommend that you now install Service Bus Explorer 2.1.3. Service Bus Explorer provides a
connection to your Service Bus 1.1 on-premise installation in order to view the queues that the
Multi-Company Server Process creates for sending and receiving messages between companies.
This tool is maintained by a Microsoft developer and is available as a download from OneDrive.
To download the tool:
a. Go to the OneDrive shared location. To do this, click this link:

https://onedrive.live.com/?authkey=%21ANNpNeRFbU7TuIQ&cid=09DBA4A06B360A65&id=
9DBA4A06B360A65%215890&parId=9DBA4A06B360A65%212210&action=locate.
b. Select the ServiceBusExplorer2.1.3.zip file. Save the file to your local machine.
c. Go to the location where you downloaded the zip file. Extract the file. The
ServiceBusExplorer2.1 folder is extracted.
d. In the ServiceBusExplorer2.1 folder, navigate to the bin > debug folder. Verify that the
ServiceBusExplorer.exe file is located in the folder. If you use desktop icons for ease of
access, right-click on the file and select Send To > Desktop.
Note that you will run the Service Bus Explorer when you complete the configuration steps
using the Multi-Company Technical Reference Guide.
Additional information on Microsoft's development of the Service Bus

Explorer tool is available on the Microsoft MSDN site. You can click this
link: https://blogs.msdn.microsoft.com/paolos/2015/03/02/service-bus-
explorer-2-6-now-available/.
139 January, 2022

12. You now must complete your Multi-Company functionality setup. To do this, use the Multi-
Company Technical Reference Guide. The guide is available within Classic Help in Kinetic.
Installing Service Bus in a Production Environment

Use this section to install Microsoft Service Bus for Windows Server 1.1 from the Microsoft Download
Center website into your production environment. The following steps to install and configure the
production environment require you to know specific information, such as your Windows user
credentials, so that you can test your connectivity between the Service Bus and Kinetic.
1. On your production environment, repeat the steps in the previous section "Install Service Bus in a
Test Environment". The steps may include:
l Identify a user account to use for the Service Bus installation
l Using the instructions on the MSDN page, complete the "Getting Started with Service Bus
for Windows Server" section
l Using the instructions on the MSDN page, complete the "Install Service Bus for Windows
Server" section
l Using the instructions on the MSDN page, complete the "Configure Service Bus for
Windows Server" section
l Verify that the Service Bus databases were successfully created
l Verify your Service Bus services and application pool user
l Enter your Service Bus Connection information into Kinetic
l Install Service Bus Explorer 2.1.3.
2. As you did with your test environment, you now must complete your Multi-Company functionality
setup. To do this, use the Multi-Company Technical Reference Guide.
Installing Application Request Routing

You can use the Application Request Routing (ARR) to extend Internet Information Services (IIS). This
extension causes a server farm to also run as a load balancer between application servers. When ARR is
installed, the server farm can route incoming message calls to multiple application servers, improving
network performance and load distributes to an application server with the capacity available to
process it.
140 January, 2022

1. On your server machine, navigate to http://www.iis.net/downloads/microsoft/application-

request-routing. Download and install the ARR extension.
2. Navigate to http://www.iis.net/downloads/microsoft/url-rewrite. Download and install the URL

Rewrite extension.
3. To continue, locate the Kinetic System Administration Guide. Use the instructions in that guide to
configure the ARR functionality.
141 January, 2022

Troubleshooting
The articles in his section cover the troubleshooting of installation and migration issues.
Reviewing Error Message Resolutions

Use this section to review error messages that may occur during your Kinetic installation and possible
resolutions to those errors.
Error Message Possible Resolution
Access to path During the installation, you may receive this error if the attributes of the file being
is denied processed are read-only.
Assembly When adding a new application server, you may receive this error if your server does
binding not have the required roles configured. Refer to the Configuring Server Roles article
warning is for instructions on configuring your server roles.
turned OFF
Insufficient To resolve this server error, you must add or update the MaxUserPort value data in
winsock the registry file. To do this, go to HKEY_LOCAL_
resources MACHINE\SYSTEM\CurrentControlSet\services\Tcpip\Parameters. Add the
available to MaxUserPort parameter, if it does not already exist. If it does exist, open the
complete parameter. The Edit DWORD (32-bit) Value dialog opens. Enter Value Data = fffe.
socket Click OK to save.
connection
initiation
Length of LOB When you have the Replication module enabled in SQL Server that hosts your
data (xxxxxx) database, you may receive this error. To avoid this error, change the Max Text
to be Replication Size value. To do this: Open your SQL Server Management Studio. Right-
replicated click the server with your database and select Properties. In the Select a page pane,
exceeds click Advanced. Under the Miscellaneous title, change the Max Text Replication
configured Size value to -1. Click OK.
maximum
65536
System Out of If you are using the 32-bit client, you may be trying to process too many dashboards
Memory or BAQs at one time. To resolve this issue, consider using the 64-bit client since it
uses more than 2GB memory which should avoid memory issues.
142 January, 2022

System As a post-installation step, you must install and configure the Task Agent.
Configuration
problem. No
default agent
defined.
The While performing a search from a client workstation to the Classic Web Access
authorization server, the time values that are set on the client and server are not accurate
credential is according to the time zone. To resolve, on the client workstation, go to Start >
expired Control Panel > Date and Time. Verify that the time is accurate according to the
time zone. On the Classic Web Access server, go to Start > Control Panel > Date
and Time. Verify that the time is accurate according to the time zone.
Unhandled To resolve the error, set the Format Culture to German to use that language format
Exception (due instead. To do this: In your Kinetic application go to System Setup > Security
to Turkish Maintenance > User Account Security Maintenance. For a specific user, in the
Format Format Culture field, select German. Keep the Language set to Turkish. Save and
Culture) close. Note that the reports are now correct but the report tool bar may display text
in German.
Version To resolve the version mismatch error, you must install the client using the latest
Mismatch: installer available.
Between
Server and
Client
WCF http While creating or updating an application server, the Application Server
activation is Configuration dialog process hangs on the "WCF http activation is enabled" task
enabled when Microsoft Updates are available and haven't been applied. To resolve the issue,
(system hangs install the Microsoft Updates and reboot your system.
on this task)
Restoring the Demonstration Database

In this article, we cover how to restore or "refresh" the Demonstration database used for educational
purposes along with the Hands On Excercises and Classic Education.
1. In the Administration Console, expand Server Management > [server] > [application server],
highlight the name of the Training application server and from the Actions pane, select Stop
143 January, 2022

Application Pool.
2. In the SQL Management Studio, delete the existing Demo database.
3. In the Epicor Administration Console, expand Database Server Management > [server] and do
the following:
4. Highlight the Demo database, right-click and select Remove Kinetic Database.
5. Right-click the name of your database server and select Add Demo DB. Enter the following
details:
l Name: The exact same name of the previous training database.
l Deployment Server: The installation location of your Kinetic environment. For example,
enter C:\Epicor\ERP11\11.1.200.0.Click OK.
6. Click Start in the database creation dialog.
7. When database creation complete, start the Training application server that you stopped in step
1.
8. Import the license file and assign it to your company. Select your Server Management > [server]
> [application server]. Right-click the Licensing node and select Import License File.
9. Browse to the location where you previously downloaded the license code file. Select the file and
click Open to import the file.
10. In the middle pane, double-click on the licensing code file to open it. In the Properties dialog,
click the Modules tab. Select the check box for each module you want enabled. Click OK.
11. Click the Companies node. In the middle pane, double-click your company to open the
Properties dialog. Click the Installation browse (...) to search for a list of installation license
identifiers. Select the appropriate identifier. Click Select. Click OK to save.
Increasing the Number of Threads Available to SQL Server

If you get user traffic related errors, you need to increase the number of threads available to SQL Server
for your system to handle larger user traffic. To do this, update the processModel default settings in the
machine.config file.
1. Log onto your Kinetic server. Your user account must have administrator privileges for modifying
Microsoft SQL Server values.
144 January, 2022

2. Navigate to either the C:\Windows\Microsoft.NET\Framework64\v4.0.30319\Config or

C:\Windows\Microsoft.NET\Framework\v4.0.30319\Configdirectory.
3. Using a text editor, open the machine.config file.
4. Locate the <system.web> section. You should see the <processModel autoConfig="true"/>
setting.
5. Update this setting to display the following values:
<processModel autoConfig="false" minIoThreads="600"

minWorkerThreads="300" maxIoThreads="1000" maxWorkerThreads="1000"
/>
6. Save the machine.config file.
7. For this change to activate, reboot the server machine.
8. Repeat these steps so all application servers (AppServers) on your system use this
<processModel> setting.
Changing the Free Memory Requirement

Your Task Agent Event Viewer log may include the following error:
"The service '[ShareName][ServiceName]svc' cannot be activated due to an exception during

compilation. The exception message is: Memory gates checking failed because the free memory ([#]
bytes) is less than 5% of total memory."
It indicates that the server is under-resourced for the amount of load on it which means the demand for
resources exceeds the available supply.
To prevent this error, you either need to reduce demand (stop any application pool for a Kinetic
appserver that is not in use and any other process that is not needed) or to increase supply (add more
RAM to the server).
You can also use the following steps to bypass the free memory requirement check for the system to be
able to start services when less than 5% free memory is available.
1. Locate your web.config file. To do this:

a. Start IIS Manager.
b. Navigate to your Kinetic application server virtual directory. For example, Kinetic202x_x.
145 January, 2022

c. Right-click on the folder and select Explore to open Windows Explorer. For example, go to
C:\inetpub\wwwroot\ERP111200\Server.
d. Locate the web.config file in the root of the folder that opens.
2. Create a backup of the web.config file.
3. Use a text editor to open the original web.config file and search for the <system.ServiceModel>
node.
4. Place a cursor at the end of that line and press Enter to add a new line.
5. Paste the following on the new line:
<serviceHostingEnvironment
minFreeMemoryPercentageToActivateService="0" />
6. Save the file and close the text editor.

7. Repeat the steps above for each of your application servers.
After this process is complete, we recommend recycling all of your application pools and then restart
the Task Agent service.
Managing LOB Data Replication

The "Length of LOB data (xxxxxx) to be replicated exceeds configured maximum 65536" error may occur
when you have the Replication module enabled in SQL Server that hosts your database. You have
several options to avoid this error.
The first option is to exclude a table or column that causes the LOB data error from the Publishing
Replication.
1. In your SQL Management Studio, run the following query to locate the tables and columns that
may cause LOB issues.
use <YourDatabaseName>
DECLARE @textthreshold int
set @textthreshold = 65536
SELECT
SCHEMA_NAME(T.schema_id) as Schema_Name,
T.Name as Table_Name,
C.name as Column_Name,
C.max_length as Max_Length,
T2.name as Data_Type,
MSP.publication as Replication_Publication_Name
FROM
sys.tables as T
146 January, 2022

INNER JOIN sys.columns as C

ON T.object_id = C.object_id
INNER JOIN sys.types as T2
ON C.user_type_id = T2.user_type_id
INNER JOIN Distribution.DBO.MSarticles AS MSA
ON MSA.source_object = t.name
AND MSA.source_owner = SCHEMA_NAME(T.schema_id)
AND MSA.publisher_db = db_name()
INNER JOIN Distribution.DBO.MSpublications AS MSP
ON MSA.publication_id = MSP.publication_id
WHERE
C.is_replicated = 1
AND (C.max_length = -1 OR C.max_length > @textthreshold)
ORDER BY 1,2,3
2. Navigate to Replication > Local Publications.
3. Right-click the publication on which the error occurred or may occur and select Properties.
4. In the Select a page pane, click Articles.
5. In the Objects to publish window, clear the check boxes of the tables or table columns returned
in the query results.
6. Click OK.
You can also change the Max Text Replication Size value.
1. In your SQL Server Management Studio, right-click the server with your database and select
Properties.
In the Select a page pane, click Advanced.
2. Under the Miscellaneous title, change the Max Text Replication Size value. You can either
change this value to meet the length of LOB data from the error message or use the -1 value.
If you use -1, the Max Text Replication size has no limit. This may reduce your
system performance.
3. Click OK.
Verifying the SSL Certificate Friendly Name

In this article, we cover how to verify the SSL certificate you use for the Kinetic server has a Friendly
Name assigned so that the server could recognize it.
147 January, 2022

1. Launch Microsoft Management Console.
2. Click File > Add/Remove Snap-in.
3. From the list of Available snap-ins, select Certificates and click Add.
4. In the Certificates snap-in window, select the Computer account option. Click Next.
5. In the Select Computer window, select the Local computer option. Click Finish.
6. Expand the Certificates (Local Computer) node.
7. Browse to the Personal > Certificates folder.
8. Right-click the certificate you want to assign to the Kinetic server and select Properties.
9. Verify the Friendly Name field has a value entered or enter a name for the certificate if it is
missing.
10. Click OK.
148 January, 2022

Appendix
This part of the guide includes the additional tasks to help complete Kinetic setup.
Changing or Uninstalling Kinetic Application

Use these steps to add or remove programs and features related to your Kinetic application. This
section also includes steps to uninstall the Kinetic application from your server or Kinetic client from
your workstation.
We highly recommend that you create a backup of all your important files, such as your databases,
prior to uninstalling the application.
Adding or Removing Program Features

Use these instructions if you want to add or remove program features that are related to Kinetic.
1. Navigate to Control Panel > Programs and Features.
2. Right-click Kinetic 202x_x and select Change from the context menu. The Install Wizard verifies
the Kinetic installation. To update the current installation, click Next.
3. On the Select components dialog, select the program features that you want to add or remove
from the current Kinetic installation. Click Next.
4. On the confirmation dialog, click Next. The Kinetic features you selected are added or removed.
5. On the completion dialog, click Finish.
Uninstalling Extension Applications

Use these steps to uninstall a previous installation of an application extension from your server.
Extension applications includeClassic Web Access, Classic Mobile Access, Enterprise Search, Classic
Education, Information Worker, Data Discovery, and Classic Help. You must uninstall the previous
installation if you plan using the same naming convention for the new instance of the extension.
1. On the server where Kinetic is installed, open the Administration Console.
3. In the Actions pane, select Application Server Configuration.
149 January, 2022

4. Select the Extensions tab.
5. Next to the Existing Deployment field, click the Browse (...) button and select the deployment
to uninstall.
6. Select File > Uninstall and choose the extension you wish to remove. Note that only fully or
partially installed extensions display on this menu. If the extension has not been fully or partially
installed, it is not available to select.
7. Repeat these steps for any extensions you need to uninstall.
Uninstalling the Kinetic Application

In this article, we cover how to uninstall the Kinetic application from your server.
We highly recommend that you create a backup of all your important folders and files, such as the
C:\Epicor\ERP11 folder and its subfolders, prior to uninstalling the application. Save this backup in a
safe location. Note that the uninstall process deletes everything from the \Epicor\ERP11 folder. Do not
store your backup in the \Epicor\ERP11 folder.
1. Create a backup of your important folders and files.
2. Navigate to Control Panel > Programs and Features.
3. Right-click Kinetic 2021.2 and select Uninstall from the context menu.
4. On the Uninstall Kinetic 2021.2 dialog, click Next.
5. On the confirmation dialog, click Yes to confirm the removal of Kinetic.
6. On the completion window, click Finish.
7. The uninstall process may not delete files that were added or updated since the initial
installation. To complete the uninstall process, go to the location where you initially installed the
Kinetic application. For example, go to \Epicor\ERP11. Manually delete any existing files and
folders.
Uninstalling Kinetic Clients

If you need to uninstall the Kinetic client from your workstation, do the following:
1. Go to the location where you initially installed the Kinetic client. For example, go to
\Epicor\ERP11\LocalClients.
2. Manually delete any existing files and folders.
150 January, 2022

Repairing or Installing the Administration Console

In this article, we cover how to manually repair or install the Administration Console, if needed. The
Administration Console is installed during the Kinetic application installation, but it can be installed on
a different server or reinstalled on the initial server, if needed. You may also need to install an update to
the base Kinetic application.
1. If your Administration Console does not work, you can try to repair your installation. To do this:
a. Verify the Administration Console is closed.
b. Navigate to Start > Control Panel > Programs and Features. Select Epicor Administration
Console.
c. Click Repair from the options in the toolbar near the top.
d. The installer runs and repairs the console.
e. If you are repairing an update to the base Kinetic application, for example, Kinetic 2021.2.x
(build 11.1.200.x), you must now update the Administration Console to use the latest
version. To do this, skip to the last step.
2. If you need to manually install your Administration Console, you must go to the Administration
folder and run the Setup.exe. To do this:
a. Navigate to the Administration folder in the path where Kinetic is installed. For example,
go to C:\Epicor\ERP11\[version]\SupplementalInstalls\Administration.
b. Right-click the setup.exe file and select Run as Administrator. A Welcome window
appears. Click Next.
c. The Confirm Installation window appears. Click Next.
d. The Installing Administration Console window appears. Click Next.
e. The Installing Complete window appears. Click Close.
f. It is recommended that you open the log file to review the list of changes and any possible
errors.
g. Optionally, you can add an Administration Console shortcut to your desktop. To do this,
navigate to Start > All Programs > Epicor Software > Epicor Administrative Tools.
Right-click the Administration Console and select Send to > Desktop (create shortcut).
151 January, 2022

3. If you also need to repair or install an update to the base Kinetic application, for example, Kinetic
2021.2.x (11.1.200.x), you must go to the AdministrationUpdates folder and run the
AdminConsoleUpdater.exe. To do this:
a. Navigate to the AdministrationUpdates folder in the path where your Kinetic application
update is installed. For example, go to C:\Epicor\ERP11\[product version]\Updates\[update
version]\SupplementalInstalls\AdministrationUpdates.
b. Right-click the AdminConsoleUpdater.exe file and select Run as Administrator.
c. Click the Install button.
d. Exit the installation wizard when the process is complete. We recommend that you open
the log file in the Administration Console folder to review the list of changes and any
possible errors.
Installing Classic Help

In this article, we cover how to access or install Classic Help.
Classic Help gives you access to the Classic form application help by pressing F1 or selecting Help >
Contents. You can also access the field-level help by selecting Help > Field Help.
Classic Help (self-hosted or web-hosted) is only available from the Classic and Tile view
of Kinetic and is not available from Help and Support Center on the Home Page view.
Configuring Web-Hosted Classic Help

If your Kinetic clientshave internet access, you can use web-hosted Classic Help. In this article, we cover
how to configure the web-hosted Classic Help URL.
1. Log onto each of your Kinetic instances (for example test, training and production) and navigate
to System Setup > Company / Site Maintenance > Company Maintenance.
2. In the Epicor Help URL field, enter https://help.epicor.com/Kinetic/111200. Select Global URL
so that all companies in the instance use the same URL.
3. Select Save.
Installing Classic Help On Premises

If your Kinetic clients do not have internet access, you can self-host Classic Help. In this article, we
cover how to install the Classic Help extension on premises.
152 January, 2022

Before you begin the installation, verify the machine where you are going to install Classic Help has the
Https protocol enabled in Internet Information Services (IIS). Refer to the following article for
information on how to configure it: https://support.microsoft.com/en-us/help/324069/how-to-set-up-
an-https-service-in-iis.
not already opened.
3. In the Actions pane, click Application Server Configuration and select the Extensions tab.
4. Select File > New > Classic Help.
5. Enter the Deployment Name for this application help release. Be sure to enter a name that helps
you identify the specific Classic Help release on your system.
6. Enter the Install Path that indicates the location where the files will be placed when you deploy
the application help.
7. The Full Path field displays the directory where the application help will be installed within the
Kinetic application directory. The path includes the Install Path that you entered above and the
\Kinetic202x_x-Help folder.
8. Select the Web Site where you want to install the Classic Help. We recommend that you select
the Default Web Site.
9. Enter the Virtual Directory name for the Classic Help System. The default directory is
Kinetic202x_x-Help. You can change this value to any name that Internet Information Services
(IIS) will accept. After you deploy the Classic Help, a virtual directory is created in IIS using a
physical path and the folder you define in this field. This physical path will be the Install Path
directory.
10. Enter the Session Timeout value in minutes to indicate how long the application help window
can remain open before the system shuts down the current session.
a. If you select an existing application pool, this application pool is configured to use the
Network Service account for its identity by default. If you wish to use a specific account
instead, select the Use Custom Account check box. This activates the Application Pool
User Name and Application Pool Password fields.
You must enter a valid domain account with access rights to the network. If you are
connecting to an application server that uses the Windows endpoint, this domain user
account must also be linked to a valid Kinetic user account. You link a Kinetic user account
153 January, 2022

to a domain account in User Account Security Maintenance; this program is located

within the Kinetic application.
b. If you click New, the Create New Application Pool window displays.
c. Enter the name you will use in the New App Pool Name field. This value identifies the
application pool throughout the system.
d. By default, the application pool is configured to use the ApplicationPoolIdentity account

for its identity. However if you wish to use a different account, open the drop-down list to
select an option.
e. Enter the domain and the user account in the Domain\User Name field; for example, enter
<MyDomain>\<UserName>. To effectively connect with the server, this account must be a
valid domain account with access rights to the network. If this account is not valid, you will
not be able to stop and start the application pool.
If you are connecting to an application server that uses the Windows

endpoint, be sure the application pool you select is configured with a
domain user account linked to a valid Kinetic user account (this means
the Kinetic user record has the Domain and Domain ID fields entered). If
this account is not linked to a Kinetic user account, you will receive a
"Service Authorization failed" error during installation. To link a Kinetic
user account to a domain account, in your Kinetic application, go to
System Setup > Security Maintenance and open User Account Security
Maintenance.
f. Select the Application Pool Name to use for the Classic Help. You can either select an
existing application pool from the drop-down list or click New to create a new application
pool used exclusively for Classic Help.
g. Enter your Password and again in the Confirm Password fields.
h. Click the Create New Pool button. The new application pool is created.
For information on how to configure the application pool, review the Adding Application
Server section in this guide, or the application server topics in the Epicor Administration
Console help system.
154 January, 2022

13. Log into Kinetic and go to System Setup > Company / Site Maintenance > Company
Maintenance. On the General Settings sheet, paste the copied value into the Epicor Help URL
field. Select the Global URL check box if this URL is the central location for the application help
across all companies within your organization. Click Save to record your settings.
Installing and Configuring Classic Education

Starting with Kinetic 2021.1, we are putting Embedded Education for Classic into
Maintenance Mode. The Embedded Education link is removed from the Help and
Support Center panel to provide a single point of access to all education materials -
Epicor Leaning Center.
You can now use Hands On Exercises - new workshop-based courses for use with the
application. These courses are available on Epicor Learning Center (ELC) as part of
learning agendas. Agendas can contain Training on Demand (TOD) videos topped off
with a true in-app experience provided by Hands On Exercises. You can access
education agendas from ELC (Quick Views> Agendas).
If you want to access Classic Embedded Education courses, you can still install their web-hosted or on-
premise version.
In this article, we cover how to install Classic Education, enable the Classic Education module and
configure the client. Note that you should configure Classic Education in your training environment, not
in your live production environment.
In Kinetic, Classic Education (self-hosted or web-hosted) is only available from the

Classic and Tile view and is not available from Help and Support Center on the Home
Page.
Configuring Web-Hosted Classic Education

If the Kinetic clients you use for training have internet access, you can use web-hosted Classic
Education courses. In this article, we cover how to configure the Classic Education URL.
1. Log into your training instance of Kinetic (the instance that uses the demonstration database)
and navigate to System Setup > Company / Site Maintenance > Company Maintenance.
155 January, 2022

2. In the Education Courses URL field, and enter https://education.epicor.com/Kinetic/111200.

Select Global URL so that all companies in the training instance use the same URL.
3. Select Save.
Installing Classic Education On Premises

If the Kinetic clients you use for training do not have internet access, you can self-host Classic
Education. In this article, we cover how to install the Classic Education extension.
Befor you begin, verify that the ASP.NET module of your Windows Internet Information
Services (IIS) installation is enabled .
not already opened.
3. In the Actions pane, click Application Server Configuration and select the Extensions tab.
4. Select File > New > Classic Education.
5. Enter your Classic Education site name in the Web Site field. If you do not have a name you wish
to use, accept the Default Web Site value.
6. Enter the Virtual Directory name for the Classic Education extenstion. The default is
[AppServerName]-EE. For example, if your AppServer name is Kinetic202x_x your virtual
directory is named Kinetic202x_x-EE. The name can be changed to any name allowed in IIS. If the
default is accepted, a virtual directory is created in IIS with a physical path and folder located
Classic Education. The drop-down list displays only the application pools that are set to
use Integrated Pipeline mode. If the list is empty, click the New button to create a new
application pool that uses an Integrated pipeline.
l If you need to enter a specific user account for the Internet Information Services (IIS)
application pool that Classic Education uses, select the Use Custom Account check box.
Enter the Application Pool Username and Application Pool Password for the account.
Note that this account must be a valid domain account with access rights to the network.
156 January, 2022

10. Log into Kineticand go to System Setup > Company / Site Maintenance > Company
Maintenance. On the General Settings sheet, in the Help section, paste the copied value in the
Education Courses URL field. Select the Global URL check box if this URL is the central location
for the embedded courses across all companies within your organization. Click Save to record
your settings.
Enabling Education Module and Testing Access

Use these steps to verify that the Education Module is licensed and enabled so that you can access the
Embedded Education Courses. The Education Module is licensed and enabled similarly to how you
license and enable the other Kinetic modules.
1. Open your Administration Console.
2. In the tree view, expand your Server Management > [server] > [application server].
3. Under your application server, select the Licensing node to list the license details in the middle
pane. Double-click on your license to open the Properties dialog. If you purchased the Education
Module license after licensing your other Kinetic modules, be sure to import your new license file.
4. In the Properties dialog, click the Modules tab.
5. Locate the EducationERPStandardAndEnterprise module name and verify that the Enabled
check box is selected. Click OK.
6. After enabling the Education module, verify that you can successfully launch Classic Education.
Access to the Education Module differs based on your selected view, either Classic or Tile:
l Classic Style. From the tool bar select the Education Courses (stack of books) icon.
l Tile View (Modern). From the home screen, select the Help menu. From the list of options,
select Education Courses. Classic Education (self-hosted or web-hosted) is not available
from Help and Support Center on the Home Page view.
1. From the Education Courses list, select a course. Verify that the course opens successfully. If the
course does not open, use the Troubleshoot Education Access topic in this guide for possible
resolutions or review your configuration instructions in the previous section and try again.
157 January, 2022

Troubleshooting Education Access

If you experience issues with accessing the Classic Education module, review this topic for error
messages that may occur and possible resolutions.
Client side Internet Explorer settings may prevent accessing Classic Education.
error - 401 -
Unauthorized: You need to add your server IP address to the list of trusted sites in Internet Explorer
Access is using Tools > Internet Options > Security Tab > Trusted Sites > Sites > Add. Also,
denied due to verify the Require Server verification https for all sites in this zone option is clear.
invalid
credentials
Error in If there is a single class that does not open, it is likely that a specific module is not
Embedded licensed, and you need to work with your Customer Account Manager (CAM) to
Education: The purchase and license the module.
course is not
licensed If you are not able to open any of the courses, you may need to download and
contact Epicor install your Embedded Ed license. Go to your education environment and open the
Education Epicor Administration Console. Expand your Server Management > [server] >
[application server] > Companies and review the license assigned (if any) to the
EPIC06 company. Then open the Licensing node and double-click that license. Go to
the Modules sheet and enable the EducationERPStandardandEnterprise module.
Setting Up Automatic Sign On for Kinetic User Accounts

In this article, we cover how to set up their Kinetic user accounts to automatically sign into Kinetic.
When you launch Kinetic, you bypass the logon window to directly access the menu. When you activate
this functionality, you create an encrypted login account that only works on the user's client
installation.
1. Navigate to System Setup > Security Maintenance > Password Policy Maintenance.
2. In the Permissions section, select the Allow save password check box.
3. Select Save.
158 January, 2022

4. Now when users log into Kinetic, they can decide whether they want to set up their client
installation to automatically launch. For example, to do this for your account, launch Kinetic.
5. On the Home Page, select the User Settings icon and select More Settings.
6. Verify the General Operations setting group is selected.
7. Select the Preferences... option.
8. Select the Automatically sign on check box.
If you did not activate the Allow save password check box on Password Policy
Maintenance in the previous step, the Automatically sign on check box is not
available to select.
9. Select OK. The client installation saves your user name and encrypts your password. The next
time you launch this client installation, you automatically log into the application.
Configuring Single Sign-On (Windows Account)

Single Sign-On (SSO) is a time-saving feature you implement so users can sign on (log in) using an
authentication method different from standard logon with Kinetic user name and password. When you
enable this feature, users no longer see a Logon window when they launch Kinetic; instead the Home
Page displays.
In this article, we cover how to set up single sign-on access to Kinetic using the same account you use
to log into the Windows operating system.
To set up user accounts for Single Sign-On, you must first configure the client, the server, and the
application server to authenticate logons through Windows. The automated login option only works
within environments where you control access through the User Name authentication protocols
(Windows Net.Tcp or HttpsWindowsBinaryChannel Https bindings). You cannot use this feature
within environments that use token authentication, Windows Channel authentication, or Secure
Sockets Layer (SSL) Channel authentication protocols.
Setting Up Kinetic User Accounts for SSO

Use these steps to set up a user account to use the Windows domain account.
1. Log into Kinetic as a Security Manager and navigate to System Setup > Security Maintenance >
User Account Maintenance.
159 January, 2022

2. Select the User ID button to find and select the user record for which you will activate the
automated login feature.
3. Enter the Domain that the user accesses to log into the computer.
4. Enter this user’s Domain User ID.
When users log in automatically, the Kinetic application only uses this Domain User ID for the log
in value. The account password is ignored. Since Windows validates the password when the user
first logs into the client machine, the application only needs the Windows identity (Domain) User
ID to determine whether the account can access the system.
5. Select the Require Single Sign-On check box if you want to restrict this user account to only use
Single Sign-On for logging into Kinetic.
Select this check box when:
l The user will only access the server through Windows Authentication.
l The server only runs Windows Authentication for all application servers.
DO NOT select this check box when:
l The server is configured for multiple application servers that use different authentication
methods. For example, if one application server uses Windows authentication while
another application server uses UsernameToken via SSL authentication, do not select this
check box.
l The user logs in through different authentication methods in different environments. For
example, if the user logs in through Windows authentication at the office but logs in
through UsernameToken via SSL authentication while working remotely without a VPN
connection, do not select this check box.
6. Select Save.
Configuring the Server

Verify the web configuration file for the application server uses the Windows TCP binding configuration.
1. On the Kinetic server, locate your web.config file. To do this:

a. Start IIS Manager.
b. Navigate to your Kinetic application server virtual directory. For example, Kinetic202x_x.
c. Right-click on the folder and select Explore to open Windows Explorer. For example, go to
160 January, 2022

C:\inetpub\wwwroot\ERP111200\Server.
d. Locate the web.config file in the root of the folder that opens.
2. Create a backup of the web.config file.
3. Use a text editor to open the original web.config file
4. Locate the line that begins with <add scheme=”. Either remove the comments around this
setting or modify it to display
<add scheme="net.tcp" binding="customBinding"

bindingConfiguration="TcpCompressedWindows" /> .
Be sure that you only uncomment the <add scheme> setting. If another <add scheme> setting is
active, comment out this additional setting. Also be aware that all client installations that
connect to the system through this application server will need to use this same Windows
authorization setting.
5. Save your changes. The server is now configured to use Windows authentication.
Configuring the Application Server

You must configure the application server to use the Windows account. You update these properties in
the Administration Console. When an application server uses the Windows account, its task agent also
uses this account to process the tasks users activate on client workstations.
1. On your Kinetic server, launch the Administration Console.
3. In the Actions pane, select Properties.
4. In the <Application Server Name> Properties dialog, from the Binding drop-down, select the
Windows option.
5. In the Authentication Credentials section, enter the Kinetic User Name and Password for the
Windows account. Be sure to enter this value using the <Domain>/User Name format. In some
161 January, 2022

versions of Kinetic, you do not need to enter the Kinetic User Name and Password. The Windows
account you set up on the server is automatically used, so these fields are inactive.
6. Select Apply.
7. Click OK. The application server now uses the same Windows account as the server.
The next time you access the application server properties, the Kinetic User Name and
Password will be blank, as the application server incorporates this account as a default
property.
Configuring the Client

To complete the setup, you now update the configuration settings (.sysconfig) file on each client
installation.
1. Access the Kinetic client workstation. Launch a file explorer.
2. Locate the client .sysconfig file. Right-click the client shortcut and select Properties. The Target
field points to the file location. For example, C:\Epicor\ERP11\LocalClients\ Kinetic2021_2.
3. Using Notepad or a similar text editor, open the .sysconfig file. This configuration file defines the
settings that activate when the user launches the Kinetic client application.
4. Locate the setting that begins with <EndpointBinding value=". Modify this setting to display the
following:
<EndpointBinding value="Windows"
options="UsernameSslChannel|Windows|UsernameWindowsChannel" />
For example:
162 January, 2022

Remember that all client installations connected to this application server will need to use this
Windows configuration setting. Be sure you update all client .sysconfig files with this Windows
endpoint value. The Kinetic client is now configured to use Windows authentication.
5. If you are making the Single Sign-On feature mandatory for all users, locate the setting that
begins with <SingleSignOn value=". Change this line to displaythe following value instead:
<SingleSignOn value="true" bool="" />
6. Save your changes and exit the file.
7. Test the setup by double-clicking the Kinetic client icon. The logon window no longer displays;
the application launches directly to the Home Page.
Configuring Single Sign-On for Classic Web Access

If you use Single Sign-On authentication on the application server where Classic Web Access is
deployed, you need to perform additional configuration for Single Sign-On to work correctly in Classic
Web Access.
1. In the Administration Console tree view, navigate to Server Management > [server] >
2. Right-click the application server with Classic Web Access and select Application Server
Configuration.
3. In the Application Pool section, copy the Application Pool Username value.
4. Navigate to Start > Administrative Tools > Internet Information Services (IIS) Manager.
5. In IIS Manager tree view, expand [your server] > Sites > Default Website. Right-click your
Classic Web Access site and select Manage Application > Advanced Settings.
6. In the Physical Path Credentials field, select the Browse button.
7. In the Connect As dialog, select the Specific user option and click Set.
8. The Set Credentials dialog displays. In the User name field, paste the Application Pool Username
value you copied in Application Server Settings. Enter this user's password in the Password and
Confirm password field. Click OK.
9. Click OK in the Connect As and Advanced Settings dialogs to save the changes.
163 January, 2022

Configuring Azure AD Authentication

Kinetic enables authentication of its users against users in Microsoft® Azure® Active Directory (Azure AD).
Azure AD is Microsoft's multi-tenant, cloud-based directory. It provides centralized identity

management service not only in your on-premise domain, but also across the internet, giving users easy
access to corporate cloud-based applications. Azure AD also offers a rich, standards-based platform
that enables developers to deliver access control to their applications, based on centralized policy and
rules.
With Azure AD Multi-Factor Authentication (MFA), a user is prompted during the sign-in process for an
additional form of identification, such as to enter a code on their mobile device or to provide a
fingerprint scan. This way, user accounts are secured by Azure, making it much more difficult for these
accounts to be externally compromised. As Azure controls access, you can define your password and
account lockout policies centrally - both for internal and external applications. There are advanced
security and monitoring services Administrators can opt into, such as self-service password
management, AI based Identity Monitoring and Identity Protection.
Azure Active Directory supports the ability to use multi-factor authentication, with a range of easy
verification options, such as phone call, text message, or mobile app notification. There are additional
authentication options which may be implemented by customers using higher versions of Azure AD
(Premium1 and Premium P2 editions), such as Identity Protection, end-user self-service or Policy Driven
Access.
For more information, we recommend reviewing the below Microsoft® Azure® sources:
l Multi-Factor Authentication Introduction: https://azure.microsoft.com/en-us/services/multi-

factor-authentication/
l Multi-Factor Authentication Documentation: https://docs.microsoft.com/en-us/azure/multi-
factor-authentication/
l Multi-Factor Authentication Overview: https://channel9.msdn.com/Blogs/Azure/WA-MFA-Overview
Azure AD stores user identities for an Enterprise. For multi-tenant scenarios, an Enterprise is mapped to
a Tenant ID in Kinetic. To work against Azure AD, a user must authenticate against Azure AD. Azure AD
then issues a token that is silently obtained and passed to the Kinetic server as identification.
To support the Azure AD authentication as the source, Kinetic uses dedicated bindings which are
configurable in the Administration Console.
In this section, learn how to implement Azure AD authentication for Kinetic users.
164 January, 2022

Configuring Azure Portal

In this article, we cover the initial Azure Active Directory authentication setup, which includes obtaining
of your Azure Tenant ID and registration of the server and client applications.
Locating the Azure Active Tenant ID

1. Log into the Microsoft® Azure® portal https://portal.azure.com.
2. From the Azure services section on the portal's home page, select Azure Active Directory.
3. In the panel on the left, select Properties and take a note of the Tenant ID value.
165 January, 2022

Registering a Server Application

Now create the application for the Kinetic server installation. This application is used by server-side and
JS applications, like the Home Page.
1. In the panel on the left, select App registrations and then select New registration.
2. Enter a Name. You can use the <ApplicationName> + Server format. For example, enter
Kinetic202xxServer.
3. Keep the default option in the Supported account types section.
4. From the Redirect URI type drop-down, select Public client/native (mobile & desktop). For the
URI, enter the Home page address of your Kinetic application, in the format of
https://<server>/<applicationname>/home/azuread-redirect.html, for example
https://server/kinetic202xx/home/azuread-redirect.html. Note that there must be no ending slash
in the URL.
This address becomes the first Redirect URI for this application registration. This is where a user
is directed when launching Kinetic with Home Page or when accessing Home Page from a
browser.
Azure AD Redirect URIs are case-sensitive, be sure to use lowercase for this URI.
166 January, 2022

5. Select Register.
6. On the newly registered application overview page, take a note of the Application (client) ID
value.
7. In the panel on the left, select Expose an API and then select the Add a scope button.
167 January, 2022

8. In the Add a scope window, accept the default Application ID URI and select Save and
Continue.
9. Define the following properties for the scope and select Add Scope.
l For the Scope name, enter user_impersonation. It is a mandatory name for the scope
used with Kinetic server.
l In the Who can consent? toggle, select Admins and users.
l Provide the Admin consent display name and Admin consent description.
l Optionally, enter User consent display name and User consent description.
l For the State, select Enabled.

.
168 January, 2022

10. If you have the Data Discovery and Classic Web Access extensions deployed, specify additional
Redirect URIs to enable Azure AD authentication for these web applications. In the panel on the
left, select Authentication and in the Redirect URIs grid, enter the URIs as shown in the below
table; be sure to keep URI formats as listed below.
169 January, 2022

Application
Type Redirect URI (Reply URL)
Name
Data Public client https://servername/appname/index.html

Discovery (mobile & desktop)
Classic Web Public client https://servername/appname/ice.ewa.sysloginazure.aspx

Access (mobile & desktop)
Azure AD Redirect URIs are case-sensitive, be sure to use lower case for these
URIs. If needed, verify the exact extension URIs in Epicor Administration Console
> Application Server Configuration > Extensions.
11. In the panel on the left, select Authentication and in the Implicit grant section, select the
Access tokens and ID tokens check boxes.
Enabling the Implicit grant flow sets the oauth2AllowImplicitFlow value in the
application manifest to true which is required for communication with the Kinetic
server. If you do not have the Implicit grant section on the Authentication page, you
can edit your server application properties using the application manifest.
In the panel on the left, select Manifest and set the oauth2AllowImplicitFlow value to
true.
170 January, 2022

Register a Client Application

Now, create another application registration for the Kinetic client.
1. In the panel on the left, select App registrations and then select New registration.
2. Enter a Name. You can use the format of <ApplicationName> + Client - for example,
Kinetic202xxClient.
3. Keep the default option in the Supported account types section.
4. From the Redirect URI type drop-down, select Public client/native (mobile & desktop). For the
URI, we recommend using https://localhost.
This URI is verified during the logon process and does not need to point to any
specific location. If, for any reason, this default value needs to be changed, you
should specify the new URI in the application .sysconfig optional setting
171 January, 2022

<AzureADRedirectUri value="" />.
5. Select Register. The application overview page displays. Take a note of the of the Application
(client) ID value.
172 January, 2022

6. Now, specify that this application is going to connect to the Kinetic server application. In the
panel on the left, select API Permissions and select Add permission.
7. In the Request API permissions window, select My APIs and select the API you have previously
created for the Kinetic server application.
8. Select the user_impersonation permission and select Add permissions.
173 January, 2022

9. The new permission is added to the list on the API permissions page.
10. To review the created permission, in the panel on the left, select Manifest and scroll down to the
requiredResourceAccess setting. The first resourceAppId displays to the Application ID of the
server application.
174 January, 2022

Deploying the Application Server with the Azure Endpoint Binding

Deploy the application server using binding(s) created specifically for communication with Azure Active
Directory. You configure these properties in the Epicor Administration Console.
1. On your server, launch the Administration Console.

2. Expand Server Management > [server], right-click on the application server whose clients you
want to authenticate through Azure AD and select Application Server Configuration.
3. Configure the Endpoint Bindings:
l Net.Tcp Endpoint Binding - Determine your authentication option based on your
company's best practice method for security.
l Http Endpoint Binding - Determine your authentication option based on your company's
best practice method for security.
For scenarios when encryption handling to an intermediary Application Request Router
like F5 or a similar router is implemented, select the HttpsOffloadBinaryAzureChannel
option.
175 January, 2022

l Https Endpoint Binding - select the HttpsBinaryAzureChannel option.
To enable integration with DocStar, you will need to set up another

Kinetic application server connected to the same Kinetic database,
because both Azure AD and DocStar require Https Endoint Binding to
connect to Kinetic. Please contact Epicor Integration Team for details.
4. Deploy the application server. Once complete, click OK. You can verify the selected bindings are
written to the application web.config file in the <protocolMapping> section. For example:
<protocolMapping>
..........
<remove scheme="http" />
<add scheme="http" binding="customBinding"
bindingConfiguration="HttpsOffloadBinaryAzureChannel" />
<remove scheme="https" />
<add scheme="https" binding="customBinding"
bindingConfiguration="HttpsBinaryAzureChannel" />
</protocolMapping>
Configuring Azure AD Authentication Parameters

Azure Active Directory Configuration Maintenance allows you to configure the mapping of
authentication settings between Kinetic and Azure Active Directory.
176 January, 2022

You can have multiple Azure AD Authentication setups in the system. Use the application landing page
to view all existing configuration records.
In this article, we will cover creating a new Azure Active Directory authentication configuration.
1. From the main menu, launch Azure Active Directory Configuration Maintenance.
Menu Path: System Setup > Security Maintenance > Azure Active Directory Settings.
2. Select New to create a new configuration.
Azure Active Directory ID and Web Application ID fields are mandatory for
each configuration.
3. Enter your company's Azure Active Directory ID (Tenant ID). To obtain this value:
l Log on to the Microsoft® Azure® portal https://portal.azure.com.
l In the left navigation panel, select Azure Active Directory.
177 January, 2022

l Click on Properties and take note of the Directory ID value.
4. Enter your Kinetic Server Web Application ID. This values serves as an audience in the security
access token. To obtain this value:
l On the Microsoft® Azure® portal, select Azure Active Directory > App registrations.
l Select the Kinetic Server web application and take note of the Application ID value.
5. Enter a concise Description for this Azure Active Directory configuration.
6. Optionally, in the Authentication Claim field, change the default security token (authentication
claim) used to create a mapping between a Kinetic user and Azure Active Directory user. The
security token issued by Azure AD contains various types of claims that can be used for
authentication. The list of available claims includes:
l http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name -
default claim; corresponds to unique_name claim within the token - for example,
"unique_name": "sample.user@contoso.onmicrosoft.com"
l http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddr
ess - corresponds to email claim within the token - for example, "email":
"frankm@hotmail.com".
In most cases, usage of the default claim should work and there is no
need to specify any value in this field. You may, however, specify any
supported Azure AD claim in this field. You then need to properly specify
External Identity of a user so it matches the authentication claim. You
specify External Identity in User Account Security Maintenance.
Also, if you specify a claim other than default, but it is not found in the
security token issued by Azure AD, the default claim is used instead.
For more information on token claims, see the Microsoft® Azure®

documentation: https://docs.microsoft.com/en-us/azure/active-
directory/develop/security-tokens#claims-in-idtokens..
7. Enter the Native Client Application ID. To obtain this value:
l On the Microsoft® Azure® portal, select Azure Active Directory > App registrations.
l Select the Kinetic native application and take note of the Application ID value.
178 January, 2022

8. Select the Allow Client Persistent Login option if you want to override the default
authentication flow that requires that users provide their Azure credentials when logging into
Kinetic.
The default user authentication process using Azure AD is as follows:
When a user logs in, the system first verifies if the AzureADNativeClientAppID property (Native
Client Application ID) is specified in the client sysconfig file. If missing, the system checks if
there is at least one default Azure AD configuration record. If multiple configurations are set as
default, the first one on the list is used. The client sysconfig file is then updated with Azure
Directory ID, Web application ID and Native application ID. During every subsequent login, the
system goes through the same steps to authenticate the user.
To the cloud-based Kinetic customers, the application first displays the dialog
where they need to enter their 6-digit Kinetic Tenant ID (also known as Site ID).
If you use the Allow Client Persistent Login option, once the client sysconfig files gets updated
with relevant Azure AD settings, the system stores the Azure AD token in a client file folder;
accessing the system happens with the help of this token which doesn’t require users to log in
every time. The client sysconfig file does not get updated.
Use this option only if you are sure that it doesn't compromise your system
security.
9. Select the Use as Default Configuration check box to indicate the current configuration settings
may be promoted to clients' sysconfig files. You can create multiple AAD configuration settings;
however, at least one of them needs to be marked as default.
10. Save the record and exit the application.
Configuring Users for Azure AD Authentication

In User Account Security Maintenance, you create mappings between Kinetic users and users in Azure
Active Directory by adding their Azure AD logins to their user records.
1. Navigate to System Setup > Security Maintenance > User Account Security Maintenance.
2. Open a user record. You can also open multiple records and edit them on the List sheet.
3. In the External Identity field, specify the user's Azure AD identity. Typically, it would be a valid
email address.
179 January, 2022

A value in this field needs to correspond to a claim specified in Azure Active

Directory Configuration Maintenance, Authentication Claim field.
4. Select Save.
Updating Client Configuration to Use Azure AD Authentication

After setting up Azure AD parameters and mapping users, you are ready to update your client
configuration to authenticate with Azure AD. In this article, we cover the mandatory and optional
configuration settings for the client installation .sysconfig file.
1. To locate the .sysconfig file, right-click your client shortcut, select Properties and review the
Target field.
2. Open the file and update the application server URL to use the https scheme, for example:
<AppServerURL value="https://ServerName/Kinetic202x_x" />
3. Set the EndpointBinding value to HttpsBinaryAzureChannel.

<EndpointBinding value="HttpsBinaryAzureChannel" options="..../>
4. Optionally, enter the values for the following settings:

Setting Description
<AzureADDirectoryID value="" Enter Azure Tenant ID (Directory ID) from Azure AD Properties.
/>
<AzureADWebAppID value="" Enter Azure AD Web Application ID of a registered Server

/> application.
<AzureADNativeClientAppID Enter Azure AD Native Client Application ID of the registered

value="" /> Client application.
You can update these properties manually or have the application update these
settings automatically on the first logon to Kinetic. This approach assumes these
values are provided in Azure Active Directory Configuration Maintenance and
the configuration is marked as default. Refer to the Setting Upd Azure AD
Parameters for Kinetic article for more information.
5. Additionally, you can specify the following values:

Setting Description
<AzureADInstance value="" /> Use this property to specify a template for

logon URL other than default:
180 January, 2022

Setting Description
https://login.microsoftonline.com/{0}
<AzureADRedirectUri value="" /> If other location than default

(https://localhost) is used as Redirect URI in a
native client application, use this property to
specify that URI in .sysconfig for each client.
For more information, see the Configure
Azure Portal topic.
When a user logs into Kinetic, the application first verifies if the AzureADNativeClientAppID property
(Native Client Application ID) is specified in the client .sysconfig file. If this value is missing, the
application checks if there is an Azure AD configuration record with the Use as Default Configuration
check box is enabled. If multiple configurations are set as default, the system uses the first one on the
list. The client .sysconfig is then updated with the Azure Directory ID, Web application ID and Native
application ID values provided in Azure Active Directory Configuration Maintenance.
To the cloud-based Kinetic customers, the application first displays the dialog where they need to enter
their 6-digit Tenant ID:
181 January, 2022

Logging into Kinetic with Azure AD

When you launch the client for the first time, the application displays the Microsoft® logon page.
1. Enter your Azure AD login.
2. Provide your Azure AD password.
3. Select Accept in the login confirmation dialog.
182 January, 2022

At this stage, the client obtains the security token issued by Azure AD and user logs into Kinetic. The
token is usually valid for several hours; when it expires, it is automatically retrieved by the application.
The system cashes Security Token after the first use and saves it in encrypted mode
into the AppData subdirectory:
C:\Users\<User>\AppData\Roaming\epicor\AzureAD\<Version>\<AzureADWebAppID>\<A
zureADNativeClientAppID>\token.dat.
4. Next time you log in, the application displays the previously used Azure AD identity.
183 January, 2022

Configuring Optional Server Settings for Azure AD Authentication

Standard Nuget library Microsoft.IdentityModel.Protocols.dll is used to work with Azure AD key
management. Key manager classes are cached; key vales are refreshed periodically, by default once a
day.
Azure AD key management on server does not require any mandatory setting. The below table lists
optional settings thatyou can configure within the appSettings section of an application server
web.config file.
Setting Description
<AzureADInstance Use this property to specify a template for logon URL other than default:
value="" /> https://login.microsoftonline.com/{0}
<add key="AzureADInstance" value-

e="https://login.microsoftonline.com/{0}" />
<AzureADDis- Suffix for the discovery URL. Default value is .well-known/openid-

coveryEndPointSuffix" configuration:
value="" />
<add key="AzureADDiscoveryEndPointSuffix" value-
e=".well-known/openid-configuration" />
<AzureADKeyAuto- Timespan setting to specify how often keys will be re-read from Azure.
maticRefreshInterval" Default value is once in 24 hours. Minimum possible value is 5 minutes. For
value="0" /> example:
<add key="AzureADKeyAutomaticRefreshInterval"
184 January, 2022

Setting Description
value="2.00:00:00" />
<AzureADKeyRe- The minimum time between retrievals, in the event that a retrieval failed,
freshInterval" value="" or that a refresh was explicitly requested. Default value is 30 seconds.
/> Minimum value is 1 second. For example:
<add key="AzureADKeyRefreshInterval" value-

e="00:00:10" />
Troubleshooting Azure AD Authentication

In this article, we cover how to activate server and client logging in order to troubleshoot Azure AD
authentication problems. It also provides answers to common authentication errors users may
experience.
The following diagram illustrates how HttpsBinaryAzureChannel binding handles network transactions.
This scenario assumes your company uses Azure Active Directory as an authentication provider for
applications.
l The user logs in against Azure AD: Office 365 Outlook, Yammer, etc.
l Azure AD provides the client a security token.
185 January, 2022

l Client sends the token to the server on each call.

l The server verifies the token against Azure.
Activating Client Logging

You can activate the client log to see all exceptions that occur during the logon process.
To turn on logging:
1. Locate the Epicor.exe.config (Epicor64.exe.config) file in the client directory.

2. Scroll down to the following section:
<system.diagnostics>
<switches>
3. Uncomment the <add name="DataTrace" value="4" /> switch .

In addition, by activating the client logging, the system also creates the Azure Active Directory
Authentication Library (ADAL) log file in
C:\Users\<User>\AppData\Roaming\epicor\AzureAD\<Version>\<AzureADWebAppID>\<AzureADNativeCli
entAppID>\ folder.
Activating Server Logging

Use the server log if you need to obtain detailed information about the Azure Active Directory
authentication process.
In order to log the authentication process, activate server logs within the Epicor Administration Console
and enable the following trace flag in AppServer.config:
<add uri="profile://system/security" />
For detailed information on how to use server logs, refert to the Performance Tuning
Guide > Customize Logs > Server Log Customization topics.
Resolving Logon Errors

Review the example errors caught while logging into Azure AD along with their resolution.
Error Resolution
An error occurred when verifying security for the message. Https binding is set incor-
rectly in web.config; verify
Error Detail the line <add scheme-
186 January, 2022

Error Resolution
============ ="https" binding=
"cus-
Message: An error occurred when verifying
security for the message. tomBind-
Program: CommonLanguageRuntimeLibrary ing"-
Method: HandleReturnMessage bindingConfiguration=
"HttpsBin-
aryAzureChannel" /> is
present.
Resource permission problem. Permissions are not con-
figured for the client app
Exception Caught in Microsoft.Iden- registration. Refer to the
tityModel.Clients.ActiveDirectory
Configuring Azure Portal art-
Error Detail
icle.
============
Message: Invalid Resource. The client has

requested access to a
resource which is not listed in the requested
permission in the
client's application registration.
Program: Microsoft.Iden-
Method: VerifyAuthorizationResult
Proxy related error. Client machine cannot con-

nect to either Azure AD
Exception Caught in Microsoft.Iden- URL: https://-
login.microsoftonline.com,
Error Detail or, when using federation,
the client machine cannot
============
connect to a federation end-
Message: The browser based authentication dia- point, such as https://st-
log failed to complete. s.yourcompany.com or
https://sso.y-
Reason: The server or proxy was not found.
ourcompany.com. Please,
Program: Microsoft.Iden- contact your company IT
tityModel.Clients.ActiveDirectory administrator.
187 January, 2022

Error Resolution
Method: ShowBrowser
Audience validation failed. In Kinetic, the Azure Active
Directory Settings form is
Exception Caught in Epicor.ServiceModel missing the settings for Dir-
Error Detail ectory ID and Web Applic-
ation ID.
============
Message: IDX10231: Audience validation

failed. Delegate returned
false, securitytoken {…}...
Program: Epicor.ServiceModel.dll
Method: ShouldRethrowNonRetryableException
User is not setup for external provider sign-on. No mapping is added to the
User Account Security Main-
Exception caught in: mscorlib tenance for this Azure user,
Error Detail so no Kinetic user could be
============ mapped with the identity
email provided.
Message: <User> is not setup for external pro-
vider sign-on.
Program: CommonLanguageRuntimeLibrary
Method: HandleReturnMessage
Understanding CORS Support

Cross-origin resource sharing (CORS) is a mechanism that allows restricted resources on a web page to
be requested from another domain outside the domain from which the first resource was served.
By default, cross-domain requests are not allowed because they can perform POST, PUT, DELETE, and
other advanced HTTP requests which should be restricted to authorized clients only. However, through
the CORS restriction configuration, you can authorize any hosts, or specific trusted hosts, to access the
REST services. For example, if you create a web application that uses the REST services hosted on its
own server, you need to enable a CORS exception for that server to access the services.
188 January, 2022

Starting from Epicor ERP version 10.2.300.0, access to any host is enabled by default.
However, you can choose to enable access to only a limited set of hosts, that need
access to the service.
Currently only limited CORS functionality is available with Kinetic. You can set up the web.config file to
use the CorsOrgings application settings to specify the origin of the requests. The available host options
include:
l Enabling access to any host
l Defining a specific host
l Defining a comma-delimited list of hosts
Examples:
l <add key="CorsOrigins" value="*" /> - default option, CORS allows access to all
sites.
l <add key="CorsOrigins" value="https://localhost" /> - CORS only allows

requests from only https://localhost .
l <add key="CorsOrigins" value="https://localhost, https://localhost"

/> - CORS only allows access from https://localhost and https://localhost .
For more information on REST services, refer to the REST Implementation Guide in
Classic Help.
Setting Up the Information Worker Configuration Manually

If you use Information Worker and the initial configuration was not completed during when it was
installed, you can use these steps to manually set it up. Information Worker must be configured before
you distribute web site URL to Information Worker users.
1. Verify the Microsoft Office installation on the Information Worker user workstations complies with
the Information Worker client system requirements.
2. Set up the Information Worker users in Kinetic. Verify that each user is set up as a Kinetic user
with the Domain and Domain ID entered in their user record (matching the domain and logon
name of their Windows credentials).
3. Connect the default Information Worker Configuration to your Kinetic installation.
189 January, 2022

a. In Information Worker Configuration Manager, in the tree, expand Configurations and

expand Epicor.
b. Click Data Source and view the values that defaulted into the screen from the Application
Server setup.
c. For Use default login credentials, note the following:
l Selecting Use default login credentials causes the Information Worker Client and
Configuration Manager to use the credentials of the logged-on Windows user when
either application connects with the Kinetic application server.
l Clearing Use default login credentials results in being prompted for Windows
credentials.
l The setting chosen here becomes the initial setting for the Information Worker
Client. Each user can later set whether or not to use default credentials from the
Kinetic ribbon in the Information Worker-enabled Office applications.
d. Click Test Connection. If you are prompted for credentials, enter the credentials that
match what is set up for single sign-on in your user account in Kinetic. If your connection
information and credentials successfully connect and authenticate, a success message
displays.
e. In the tree, right-click Epicor and select Deploy.
f. Click OK on confirmation.
4. Test the connection and client installer. From the workstation of one of your Information Worker
users, go to the Information Worker web site URL that you established when installing the
Information Worker extension, and follow the instructions for installing the Information Worker
Client.
Verifying Temporary Files Do Not Exist

Prior to installing or migrating Kinetic, use the following steps to clear out any existing temporary
folders and files related to install aware processing. These temporary folders and files may exist due to
prior upgrades that were not fully completed and they may cause your current upgrade to not install
properly.
1. Go to your system Temp folder. The location of the Temp folder differs based on your operating
system. To find the location of this folder, you can do one of the following:
190 January, 2022

l Select Start > Run. In the command window, type: %temp%. Click OK. The Temp folder
location opens in a browser. For example, the browser could open to C:\Users\
[UserId]\AppData\Local\Temp.
l Right-click This PC and select Properties. Select the Advanced system settings link. In
the dialog that displays, select the Environmental Variables button. In the User variables
section, take a note of the TEMP variable value.
2. In the Temp folder and subfolders, delete the following:
l folders that start with MIA*
l files that end with *.TMP
191 January, 2022

Kinetic InstallGuide 2021.2

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Kinetic InstallGuide 2021.2

Uploaded by

Copyright:

Available Formats

Kinetic Installation

Copyright © 2021 Epicor Software Corporation Epicor.

Creating the System Agent‌ 71

Administrator - Distribute Search Anywhere URL to Users 101

Configuring Information Worker 105

Installing Performance and Diagnostic Tool 134

Configuring Azure AD Authentication Parameters 176

Understanding the Installation Flow

Verifying Access to EPICweb

1. Verify you have Internet access at your workstation.

Reviewing Release Notes Documents

Kinetic 2021.2.x Release Notes Provides information on the current update

Verifying Windows Operating System Requirements

Certifying a platform for Kinetic is an involved task due to the amount of

The inbound rule "Web Management Server (HTTP Traffic-In)" should be

Verifying SQL Server Install and Features

Certifying a platform for Kinetic is an involved task due to the amount of

l Management of database engine and databases:

As an alternate method to verify if the Full-Text Search feature is enabled on

Use these steps to verify your SQL database collation.

The correct collation setting for Epicor 9.05.702A manufacturing data

Configuring Server Roles (Windows Server 2019 or 2016)

l Windows Server 2019 - https://technet.microsoft.com/en-us/windows-server-

Installing Roles and Features

In the Management Tools

Common HTTP Features: IIS Management Console (If you

In the Management Tools

Health and Diagnostics: IIS 6 Management Compatibility

l Static Content Compression

l NET Extensibility 4.7 or 4.6

l NET Framework 4.7 or 4.6 Features

l Windows Process Activation Service (all)

Configuring Windows Search

1. Click Start > Run > services.msc.

Configuring Server Roles (Windows Server 2012 R2)

Installing Roles and Features

In the Web Server Role (IIS) >

COM+ Network Access Common HTTP Features:

In the Web Server Role (IIS) >

TCP Port Sharing Health and Diagnostics:

Web Server (IIS) Support and its features Performance:

Windows Process Activation Service Support: Security:

l HTTP Activation l Request Filtering

l NET Extensibility 4.5

Management Tools (If you are

l NET Framework 4.5

Configuring Windows Search

1. Click Start > Run > services.msc.

Verifying SQL Server Reporting Services (SSRS) Prerequisites

For more information on installing Reporting Services Native Mode Report

d. Verify that Report Server Status is Started.

Setting Default Adjusted

<Add Value 180 (Minutes) 1440 (24 Hours)

<Add Value 120 (Seconds) 300 (Seconds)

Preparing SQL Server Login Account

Setting Up Test Environment

Installation and Configuration

1. Verify your environment is ready to start the installation. To do this:

11. Select Finish. Your Kinetic server framework is installed.

Installing Kinetic 2021.2.x (11.1.200.x) Latest Update

1. Verify your environment is ready to start the installation. To do this:

Configuring Kinetic Database

Adding a Database Server