You are on page 1of 32

Epicor Service Connect Installation and

Implementation Guide
Epicor Service Connect 10.2.500
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
regarding 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-partyproducts 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 © Epicor Software Corporation 2019.
All rights reserved. No part of this publication may be reproduced in any form without the prior written consent of
Epicor Software Corporation.

10.2.500
Revision: October 2019
Total pages: 33
sys.ditaval
Epicor Service Connect Installation and Implementation Guide Contents

Contents

Contents
1 Getting Started ......................................................................................................................... 4
1.1 Introduction to Epicor Service Connect ................................................................................................................ 4
1.2 Hardware and Software Requirements............................................................................................................... 5
1.2.1 Hardware Requirements ............................................................................................................................ 5
1.2.2 Epicor Service Connect Server Software Requirements ....................................................................... 6
1.2.3 Epicor Service Connect Client Software Requirements ........................................................................ 8
2 Installation and Configuration ................................................................................................ 9
2.1 Upgrade to Epicor Service Connect 10.2.500 ...................................................................................................... 9
2.2 Install Epicor Service Connect Server .................................................................................................................. 10
2.2.1 Uninstall Epicor Service Connect Server 8.1 – 8.3 ................................................................................. 10
2.2.2 Install Epicor Service Connect Server....................................................................................................... 11
2.2.3 Permissions Required for the Windows User Associated to the ESC Sca* Services ................... 14
2.2.4 Unattended Installation ............................................................................................................................. 15
2.2.5 Install Epicor Service Connect Server on Windows 2008 R2/2012 Server ......................................... 16
2.2.6 Install Epicor Service Connect Server on Windows 2016 Server ......................................................... 17
2.2.7 Install Epicor Service Connect Server on Windows 2019 Server ......................................................... 18
2.3 Install Epicor Service Connect Client ................................................................................................................... 19
2.3.1 Before You Begin ....................................................................................................................................... 19
2.3.2 Install Epicor Service Connect Client ........................................................................................................ 19
2.4 Configure Epicor Service Connect DCOM ......................................................................................................... 21
2.4.1 Verify DCOM Configuration Prerequisites ............................................................................................ 21
2.4.2 Configure DCOM Security Limits ............................................................................................................ 21
2.4.3 Additional Configurations ........................................................................................................................ 22
2.4.4 Configure Epicor Service Connect Client ............................................................................................... 22
2.4.5 Set the Sharing and Security Model to Classic ..................................................................................... 22
2.4.6 SQL Server ................................................................................................................................................... 23
2.5 Epicor Service Connect Task Monitor ................................................................................................................. 23
2.6 .NET Extensions ..................................................................................................................................................... 24
2.7 SharePoint Component ......................................................................................................................................... 24
2.8 Service Connect Interoperation with Epicor ERP .............................................................................................. 24
2.8.1 Epicor Service Connect Server Setup ..................................................................................................... 25
2.8.2 Set up Epicor to Work with ESC .............................................................................................................. 26
3 Implementation....................................................................................................................... 28
3.1 Concepts .................................................................................................................................................................. 28
3.2 Processes ................................................................................................................................................................. 28
3.2.1 Register Documents .................................................................................................................................. 29
3.2.2 Import Web Services ................................................................................................................................. 29
3.2.3 Set Up Communication Channels ............................................................................................................ 29
3.2.4 Create Workflows ...................................................................................................................................... 29
3.2.5 Set Up Message Map ................................................................................................................................ 29
4 Third-Party Modules ............................................................................................................... 30

Epicor Service Connect | 10.2.500 3


Getting Started Epicor Service Connect Installation and Implementation Guide

1 Getting Started

Welcome to the Epicor Service Connect Installation and Configuration Guide – Version 10.2.500.
This part of the guide explains how to verify the prerequisites prior to installing Epicor Service Connect.

1.1 Introduction to Epicor Service Connect

Epicor Service Connect provides a powerful and flexible environment to support specific collaborative processes,
connecting different business entities, applications or users.
Epicor Service Connect consists of four major parts: Service Connect Framework, Tools, Task Monitor and
Administration Console. These components can be used to create and run custom, flexible workflows that accept
different formats of data and allow processing of this data using various services available with web-service
technology.

Service Connect Framework


Service Connect Framework is a group of system services that provides main system activities like running
communication channels, executing workflows, tracking of documents and system events.

Tools
A group of tools that help to configure system framework, workflows and document types.

Task Monitor
Task monitor is a web interface intended to view, track and process user tasks that are assigned during workflow
execution.

Administration Console
The Service Connect Administration Console is Microsoft Management Console (see Microsoft’s overview) and
is used to configure and maintain settings for Service Connect Framework services.

4 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Getting Started

The following graphic shows an architectural overview of the system:

Important Do not install Service Connect {Standalone} on top of an existing iScala installation. Service
Connect for iScala is installed as part of iScala package.
Service Connect {Standalone} package is created to install Service Connect on a server separate from iScala
in order to use SC with other systems (Epicor, Vantage, E4SE, etc.).

1.2 Hardware and Software Requirements

Review the minimum and recommended hardware and software requirements for Epicor Service Connect
installation.

1.2.1 Hardware Requirements

Review recommended system requirements:


• Intel Core 2 Duo starting from 2.4 GHz or better
• 4 GB RAM or more
• Gigabit network connection

Epicor Service Connect | 10.2.500 5


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

1.2.2 Epicor Service Connect Server Software Requirements

Review software requirements for Epicor Service Connect Server installation:

Server Operating Systems


• Microsoft Windows Server 2008 R2 Standard Edition SP1
• Microsoft Windows Server 2008 R2 Enterprise Edition SP1
• Microsoft Windows Server 2012 Standard Edition
• Microsoft Windows Server 2012 R2 Standard Edition
• Microsoft Windows Server 2016 Standard Edition
• Microsoft Windows Server 2019 Standard Edition

Required Server Software


Database Management Systems (DBMS)
The following database management systems are supported:
• Microsoft SQL Server 2008 R2 Standard Edition SP2
• Microsoft SQL Server 2008 R2 Enterprise Edition SP2
• Microsoft SQL Server 2008 R2 Express Edition SP2
• Microsoft SQL Server 2012 Standard Edition SP3
• Microsoft SQL Server 2012 Enterprise Edition SP3
• Microsoft SQL Server 2012 Business Intelligence Edition SP3
• Microsoft SQL Server 2012 Express Edition SP3
• Microsoft SQL Server 2014 Standard Edition SP1
• Microsoft SQL Server 2014 Enterprise Edition SP1
• Microsoft SQL Server 2014 Business Intelligence Edition SP1
• Microsoft SQL Server 2014 Express Edition SP1
• Microsoft SQL Server 2016 Standard Edition
• Microsoft SQL Server 2016 Enterprise Edition
• Microsoft SQL Server 2016 Express Edition
• Microsoft SQL Server 2017 Standard Edition
• Microsoft SQL Server 2017 Enterprise Edition
• Microsoft SQL Server 2017 Express Edition
Note Epicor recommends that you avoid using Microsoft SQL (all versions) Express Edition for heavily
loaded production environments or such environments where ESC database may get near Express Edition
limits.

All collation types for the SQL server are supported: any dictionary order, character set, case-sensitive
and case-insensitive search.
The following software is required as well:
• Microsoft SQL Server 2012 SP3 Native Client
The required redistributable package is provided in ESC Setup package, if it is not found on the
workstation.
• Microsoft Internet Information Services (IIS) 7.5, 8.0, 8.5 or 10.0 (Common files and WWW Service are
required, SMTP and FTP are optional)
• Microsoft Message Queuing Services (MSMQ) 2.0 (optional).
6 Epicor Service Connect | 10.2.500
Epicor Service Connect Installation and Implementation Guide Installation and Configuration
• IBM WebSphere MQ Server or Client 5.1 (or above) (optional, English language only).
• SonicMQ v7.6 CSharp Client for Windows (optional)
• Windows Service Bus 1.0, Windows Service Bus 1.1 (optional)
• Microsoft .NET Framework 4.7.2 must be installed.
Epicor Service Connect setup does not install the package if it is not found on the system.
• Microsoft Web Services Enhancements (WSE) (optional). Install WSE manually if you want to use Epicor 9
WSE and other WSE references. The package enabling WSE support in .NET Framework (Microsoft WSE 2.0
SP3 Runtime.msi) is located in Support subfolder of ESC Server installer folder.
• Microsoft XML Parser (MSXML) 6.0 SP1. The required MSXML 6.0 SP1 redistributable package is provided in
ESC Setup package. ESC setup installs appropriate package if it is not found on the system.
• One of the following internet browsers:
• Microsoft Internet Explorer 8.0, 9.0, 10 or 11. Typical set of components.
• FireFox 25.0
• Chrome 30.0.1599.101m
• Safari 5.1.7
ESC was successfully tested for compatibility with the above browsers. The later versions were not tested, but
might be compatible as well.
• Universal C Runtime (CRT) in Windows. Appropriate installers for 32 (vcredist_x86.exe) and 64
(vcredist_x64.exe) bit operating systems are located in Support folder near ESC server installer.
Note In order to manually install Universal C Runtime by using the above installers, run the corresponding
installer and either select to install the runtime (if installer indicates that it is not installed yet) or perform
a repair (if installer indicates that it is installed already).

Integration between Service Connect and Windows SharePoint Services 2013, SharePoint Foundation 2013 and
older versions are supported.
Note Epicor Service Connect installer does not add https binding in IIS. If there is no https binding, you
need to add it manually. It is required to work with SCIntegration service (WCF version).

Important Epicor Service Connect installer (SC Server x64, SC Client) will not work on a computer with
iScala Server x64, iScala Client, iScala CRM x64, iScala WebPA, or Reporting Services Connector x64
installed. Service Connect standalone and iScala should not be installed on the same server at the same
time, as this may lead to unpredictable behavior of the resulting installation.
iScala includes its own version of Service Connect, and therefore there is no need to install SC Standalone
and iScala on the same machine.

Note Third-party redistributables are NOT removed when ESC is uninstalled.

Epicor Service Connect | 10.2.500 7


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

1.2.3 Epicor Service Connect Client Software Requirements

Review software requirements for Epicor Service Connect Client installation:

Operating Systems
• Microsoft Windows 7 (Professional, Enterprise or Ultimate Edition) SP1
• Microsoft Windows 8 (Professional or Enterprise)
• Microsoft Windows 8.1 (Professional, Enterprise)
• Microsoft Windows 10
Epicor Service Connect Client also supports all the operating systems listed above in the Epicor Service Connect
Server Software Requirements section.

Required Software
The following software should be installed on the computer hosting Epicor Service Connect Client:
• One of the following internet browsers:
• Microsoft Internet Explorer 8.0, 9.0, 10 or 11. Typical set of components.
• FireFox 25.0
• Chrome 30.0.1599.101m
• Safari 5.1.7
ESC was successfully tested for compatibility with the above browsers. The later versions were not tested, but
might be compatible as well.
• Microsoft SQL Server 2012 SP3 Native Client. The required redistributable package is provided in ESC Setup
package. ESC Client setup installs appropriate package, if it is absent.
• Microsoft XML Parser (MSXML) 6.0 SP1. The required MSXML 6.0 SP1 redistributable package is provided in
ESC Setup package. ESC Client setup installs appropriate package, if it is absent.
• Microsoft .NET Framework 4.7.2 must be installed. ESC Client setup does not install Microsoft .NET
Framework, if it is absent.
Microsoft .NET Framework 4.7.2 requires Windows 2008 or above on servers and Windows Vista or above
on workstations.
• To develop workflows using Windows Workflow Foundation, Visual Studio 2010 - 2015 should be used;
refer to Visual Studio documentation to learn more on how to develop WWF workflows.

• To work with Excel 2007 - 2016 files (xlsx, xlsm, xlsb) or for creating Excel files in legacy format (xls) using
new ACE driver, Microsoft Access Database Engine 2016 Redistributable is required; you can download it
from
https://www.microsoft.com/en-us/download/details.aspx?id=54920

• Universal C Runtime (CRT) in Windows. Appropriate installer for 32 (vcredist_x86.exe) bit operating system
is located in Support folder near ESC client installer.
Note In order to manually install Universal C Runtime by using the above installer, run it and either
select to install the runtime (if installer indicates that it is not installed yet) or perform a repair (if installer
indicates that it is installed already).

Note Third-party redistributables are not removed during ESC Client un-installation.

8 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Installation and Configuration

2 Installation and Configuration

Epicor Service Connect has separate installation packages for SC server and SC client. If you want to install server
and client on the same machine, start with server installation, and then you are prompted to continue with client
installation. You can also install server and client on different machines.
The following features are installed with SC server:
• Framework (required)
• Web-Based Task Monitor (optional)
• Integration Services (optional)
• Integration Wcf Services (optional)
The following features are installed with SC client:
• Administration Console (optional)
• Developer Tools (optional)
• Tools (required)
• Database Converter (required)
• Service Manager (optional)
• DesPoster (optional)
• Workflow Converter (optional)

• Help (optional)
• Samples (optional)
• Shortcut for Task Monitor (optional)

2.1 Upgrade to Epicor Service Connect 10.2.500


Note Starting from Epicor Service Connect 10.2.100 there is no 32-bit version of the product, so if your
current version of Service Connect is 32-bit, it will be upgraded to 64-bit.
If the current x86 version was installed into the default location (under Program Files (x86), after upgrade
the 64-bit version will also be installed to default location (Program Files), and all custom files will be
automatically moved to the new location by the installer.
If you use Epicor Service Connect, you must upgrade to the latest version.
Use the following instructions to verify that you use the latest version of the installation instructions in order to
upgrade to the latest version of Epicor Service Connect.

1. Logon to the EPICweb Customer portal. Navigate to Products > Epicor ERP > Downloads. Expand Epicor
Service Connect > Version 10.2.500.

2. In the Available Downloads list, select and download the latest Epicor Service Connect installation zip file.

3. Extract the files.

4. Navigate to the Documents folder to locate the Epicor Service Connect Installation Guide.

5. Use the latest version of the guide to upgrade Epicor Service Connect.

Epicor Service Connect | 10.2.500 9


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

Before you start the upgrade, perform the following steps:

1. Backup ESC
2. Backup the database.

These steps guarantee that you can roll-back the upgrade in case anything goes wrong.
You are now ready to start the upgrade.

1. From the folder to which you extracted the Epicor Service Connect installation zip file, start Setup.exe.
ESC Installer removes the previous Service Connect installation and installs the new version.

2. Follow the steps starting from step 7 described in the Install Epicor Service Connect Server section.

3. If you are going to retain the database during ESC upgrade, database conversion may be required during
the installation.
If database conversion fails, read the error messages and eliminate the errors, then run the conversion again.

Note
If product upgrade fails, the password specified for ESC services is reset to an empty string. As a result,
the services cannot start. In this case, use built-in Windows Services Administrative Tool or Windows
command line administrative utilities to manually specify the password for ESC services. After that, restart
the services. It might also be necessary to re-register some ESC type libraries manually.

After the server upgrade, and the client upgrade if it is located on the same machine, you must perform the
following steps:

1. Re-import the following entities:


• Web service references
• .NET service references
• REST service references
The references from the previous versions are not going to work in the upgraded environment.
For the detailed re-import procedure, refer to the Re-importing Web Service, Adding .NET References - To
mass-import .NET References, and Re-importing RESTful References sections in ESC help.

2. If you upgrade to the new ESC version from the version that worked with E9, and you upgrade E9 to E10,
you must convert your workflows.
For the detailed procedure, refer to the Workflow Converter section in ESC help.

2.2 Install Epicor Service Connect Server

Use the following steps to install Epicor Service Connect Server.

2.2.1 Uninstall Epicor Service Connect Server 8.1 – 8.3

If a previous version of Epicor Service Connect exists on the server, use the following steps to uninstall it. The
uninstallation process depends on the currently installed version of Service Connect.
• If SC 8.1, SC 8.2, or SC 8.3 had been installed, it needs to be uninstalled manually.

10 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Installation and Configuration

To do this:

1. Navigate to Start > Control Panel > Programs > Uninstall a Program.
2. Select the Epicor Service Connect installation and click Uninstall.

3. Verify that the uninstallation was completed successfully.

• If a Hotfix was installed on SC 8.1, binaries and registration will stay on the server.
• In most cases, SC installer properly cleans up the system, but it is highly recommended to control the cleanup
during SC installation as explained below.

2.2.2 Install Epicor Service Connect Server

Use the following steps to install the Epicor Service Connect:

1. Logon to the EPICweb Customer portal.

2. Navigate to Products > Epicor ERP version 10.2.500 > Downloads.

3. Expand Epicor Service Connect > Version 10.2.500.

4. In the Available Downloads list, select and download the latest Epicor Service Connect installation zip file.

5. Extract the files.

6. In case you need to force ESC installer to run even if it detects that Windows requires a restart, add the
IGNORE_PENDING_REBOOT flag to setup.ini file and assign any value to it.
Sample string from setup.ini:
CmdLine=msiexec.exe /i "%iScalaSetupExePath%\Epicor Service Connect.msi" /l*v %Temp%\Installation.log IGNORE_PENDING_REBOOT=1

7. Double-click Setup.exe.

8. If SC 8.1 with HF was installed on the server, the SC 8.1 uninstaller will start automatically. When uninstallation
is finished and the Next button is enabled, you should verify the system cleanup:

a. Open Windows Task Manager and verify that Sca* processes are not running.

b. Go to the installation folder of the SC 8.1 and verify that it does not contain any binary files (*.exe and
*.dll). Any custom settings, like processes or channels, should not be removed.

c. Go to the common files folder and verify that it does not contain any binary files (*.exe and *.dll) in the
Scala Business Solutions NV folder.

If one or more of these conditions are not met, uninstaller had failed to clean up the system. In this case,
cancel the installation, start ScalaSystemCleaner.exe from the Service Connect Installation package and
direct it to the location where SC 8.1 with Hotfix was installed. After ScalaSystemCleaner.exe finished system
cleanup, start the ESC 10.2.500 installation again.

9. In the Welcome window, click Next.

10. In the License Service Setup window set the following:


• Read *.lic license files from this folder. Defaults to the path where from the installation program is
launched. You can accept the default location or click the Change button to specify custom location.
Select this option, if you do not have server with license service of the Service Connect product installed
yet.

Epicor Service Connect | 10.2.500 11


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

• Select a machine with installed License Service. Defaults to the current machine. Select this option, if
you already have a server with Service Connect License Service installed.

11. In the Destination Folder window, accept the default location or click the Change button to install the
application to a custom location.

12. In the Web Applications window, select if you want to create SC web applications in a separate web site.
If you select the Create new web site for Epicor Service Connect 10.2.500 web applications check
box, a separate web site for SC is created. The scshost host header is assigned to it. The
BPMIntegrationService, Schemas, WorkflowWebServices, and TaskMonitor web applications are added
as subdirectories within this web site.
It is recommended to create new web site for SC, so that the virtual directories created by other applications
do not conflict with SC virtual directories or the settings of the default web site do not conflict with SC
requirements. To do this:

a. In the Web Applications window, click Next. The installer checks if the web site with scshost HTTP
host header (host header with any IP address, port 80 and name scshost) already exists.

b. If the scshost web site exists, you are prompted to delete it.
• Click Yes to delete scshost web site, and continue installation.
• Click No to keep the scshost web site. In this case you can continue installation only if the Create
new web site for Epicor Service Connect 10.2.500 web applications check box is clear. If this
check box is selected, the Web Applications window is displayed again. To continue installation,
either clear the Create new web site for Epicor Service Connect 10.2.500 web applications
check box or select to delete the existing scshost web site.
If you keep the scshost web site, it may cause problems when working with SC. However, you can
manually re-configure or delete the existing scshost web site.

Note Installation may fail, if the default web site does not have an empty host header in its bindings. For
example, if the default Web site in the IIS has just one header - 'scshost', and you run SC Installer,
selectinstallation Web Application to the Default site in the Web Application window, and then
click No; the installation fails.
If the Default web site has both an empty host header and 'scshost' host header, the installation runs
successfully.

13. In the Choose Setup Type window, select the setup type for the SC server. Available options:
• Complete. All the features of SC server are installed.
• Custom. You select, which of the SC server features to install. When selecting this option, you can also
specify where the selected features should be installed. Installation of Framework is required, you cannot
unselect this feature; specify whether you want to install Web-Based Task Monitor and Integration
Services.

14. In the Database Setup window set the following:


• Create a new SC System database. Select this option if you do not have system database installed
yet, or if you want to recreate it. Note that in this case all data in the database will be lost.
The installer creates the two default ESC users: Admin and Epicor. The passwords for these users are empty
by default. It is prompted to provide the passwords in the Default user passwords window. There are no
limitations for the password length and format. The user names are fixed and cannot be changed.
These credentials (usernames and passwords) can be used when the user credentials are asked by ESC
Administration Console. It is recommended to change the blank password during the installation or after
12 Epicor Service Connect | 10.2.500
Epicor Service Connect Installation and Implementation Guide Installation and Configuration
the first logon.
• Select an existing database. Select this option if the system database already exists on the server and
you want to preserve old settings. If your database version is different from the one being installed, the
installer will suggest database conversion. It is possible to convert database either during the installation
or later. Database is migrated with the SC Database Converter. To start SC Database Converter manually,
run <SC install directory>\Tools\ScaDBConvert\ScaDBConvConsole.exe. It is recommended to back up
database before upgrading it.
Note The user, who performs database conversion using SC Database Converter, is a trusted user.
This user should be able to login to the system database being converted, and, in addition to that,
this user should have db_owner rights for this system database. Otherwise, the Database Converter
fails with an error.

• Server Name. The name of the SQL server. Defaults to the current m a c h i n e .
Note The default installation of SQL Server Express creates an instance named SQLExpress. If you
install Service Connect with SQL Server Express Edition (any version), append the instance name
to the server name (for example, myserver\SQLExpress) in order to complete the installation
successfully; otherwise, the installation fails.

• Database Name. This is the database where Service Connect system information is stored. This data
includes various system and administrative settings such as user accounts, communication channels and
document tracking.
• Use NT authentication. If you select this option, the current login account must have access and
necessary permissions in the SQL Server.
• User Name. Complete this field if you did not select to use NT authentication.
• Password. Complete this field if you did not select to use NT authentication.

15. If you selected to use an existing database, the Installer verifies if the database requires conversion. If it does,
the next page displays the Start DB Converter button. Click Start DB Converter.
Note If you click Next instead, you will receive a warning about converter and database version
mismatch and will not be able to proceed without database conversion.

16. In the System Services Account window, enter username and password for the domain user under whose
account the system services will run. Note that the user must have the appropriate rights. You can leave
fields empty. In this case LocalSystem account will be used instead; you can then manually set logon
accounts after installation.

17. Click Install.

18. If you want to install SC Client on the same machine, select the Run Client Setup check box. In the case,
client installation starts immediately after you clicked Finish. If you do not want to install client on the same
machine, clear this check box. In both cases the client installation package is copied to <install
directory>\Client folder, and you can install SC client from this folder at any time.

19. Click Finish.

20. If you are migrating from SC version older than ESC 8.3, relocate Customized Workflows and Email Templates
Move the Customized Workflows and Email Templates from the following folders:
• <SC Installation Folder>\System\Services\Workflow\Processes\Custom
• <SC Installation Folder>\System\Services\Workflow\EmailTemplates\Custom
to:
• <SC Installation Folder>\System\Services\Des\Processes\Custom
• <SC Installation Folder>\System\Services\Des\EmailTemplates\Custom

Epicor Service Connect | 10.2.500 13


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

21. If you are migrating from SC version older than ESC 8.3, and your system has processes that had been
exposed as Web Services before migration to ESC 10.2.500, you should manually move these Web Services
(ScaWebServices/*.asmx) to the new location: <SC Installation Folder>\WebApps\WorkflowWebServices.

22. If you are migrating from SC version older than ESC 8.3, from Task Monitor, publish InfoPath forms to the
new location: Task Monitor folder is moved to <SC Installation Folder>\WebApps\TaskMonitor.

23. If you are migrating from a previous version of Service Connect, and are also upgrading your Epicor installation
to later Epicor ERP version, upgrade your workflows containing references to the older Epicor installations
using WorkflowConverter.exe tool, provided with the latest Service Connect release. You can find
detailed instructions of how to use this tool in the Service Connect Online Help under the following
heading: Epicor Service Connect Documentation Kit > Using Epicor Service Connect > Workflows >
Managing Workflow Processes in Workflow Designer > Workflow Converter and Epicor Service Connect
Documentation Kit > Using Epicor Service Connect > How To’s > Best Practices: Workflow Converter.

2.2.3 Permissions Required for the Windows User Associated to the ESC Sca* Services

Make sure that the account used for the ESC services has the following access rights:
• All services
• Read Access to the HKCR or HKLM\ SOFTWARE \Classes Registry branches.
• Read Access to the %CommonProgramFiles%\Epicor\Epicor Service Connect\ folder and its subfolders.
• ScaDESRouter
• R/W Access to the System database.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• R/W Access to <ESC installation folder >\ System\Services\DES\AsyncPools\.
• R/W Access to <ESC installation folder >\ System\Services\DES\Processes\.
• R/W Access to <ESC installation folder >\ System\Services\DES\EmailTemplates.
• ScaLanSrv
• R/W Access to <ESC installation folder>\System\Services\Lan\.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• ScaLicenseSrv
• R/W Access to <ESC installation folder>\System\Services\License\.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• ScaLockSrv
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• ScaLogonSrv
• R/W Access to the System database.
• R/W Access to <ESC installation folder>\System\Services\Logon.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• ScaLogSrv
• R/W Access to the System database.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
14 Epicor Service Connect | 10.2.500
Epicor Service Connect Installation and Implementation Guide Installation and Configuration

• ScaMessageSrv
• R/W Access to <ESC installation folder>\System\Services\DES\Messages\.
• R/W Access to <ESC installation folder>\System\Services\DES\FailedInput\.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• For folder input channels: access to the folders specified in the input channel settings. Required to enumerate
contained files and read file contents.

• For folder output channels: access to the folders specified in the output channel settings. Required to write files.
• For input channels with queues: access to the queues specified in the input channel settings. Required to receive
messages and message properties.

• For output channels with queues: access to the queues specified in the output channel settings. Required to
send messages and set message properties.

• For IBMMQ input channels: access to the queues specified in the output channel settings. Required to receive
messages and enquire message properties.

• For IBMMQ output channels: access to the queues specified in the output channel settings. Required to send
messages and set message properties.

• For the channels not listed above refer to the corresponding topics in the online help.
• ScaTaskSrv
• R/W Access to the System database.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• ScaTrackSrv
• R/W Access to the System database.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.
• ScaUserProfileSrv
• R/W Access to the System database.
• R/W Access to the HKLM\SOFTWARE\Scala Business Solutions NV Registry branch.

2.2.4 Unattended Installation

Please see the full list of required server software packages in Required Server Software section. All
prerequisites listed there must be preinstalled before installing Epicor Service Connect Server in
silent/unattended mode.

You can simplify the installation procedure by saving the installation parameters in a configuration file.

To create a configuration file:

1. Start setup.exe /V"BUILD_CONFIG=1" or msiexec /i "Epicor Service Connect.msi" BUILD_CONFIG=1.

2. Set installation parameters and specify the name of the configuration file in the Save Configuration window.

3. Click Save to save the configuration file as Default.cfg in the default directory. You can also specify the
alternative directory.

Epicor Service Connect | 10.2.500 15


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

To use a configuration file in the installation:

1. Copy the file to the directory with the installation package.

2. If the configuration file is saved as Default.cfg, run setup.exe. If the configuration file is saved under another
name, run setup.exe /V"CONFIG_FILE_NAME=<configuration file name with full path>.cfg".

Specify service and database passwords. The unattended installation is started.

2.2.5 Install Epicor Service Connect Server on Windows 2008 R2/2012 Server

If Epicor Service Connect is installed on Windows Server 2008 R2 /2012, for proper functioning of ESC features
the following should be installed:

1. Enable the file server role. To do this:

a. Navigate to Start > Administrative Tools > Server Manager.

b. In the Roles menu, click Add Roles.

c. Select File Services.


2. Enable the application server role. To do this:

d. Navigate to Start > Administrative Tools > Server Manager.

e. In the Roles menu, click Add Roles.

f. Select Application Server.

g. Select the following role services:


• Web Server (IIS) Support
• HTTP Activation

3. Enable the WEB Server (IIS) role. To do this:

h. Navigate to Start > Administrative Tools > Server Manager.

i. In the Roles menu, click Add Roles.

j. Select WEB Server (IIS).

k. Select the following role services:


• ASP .NET
• ASP
• CGI
• ISAPI Extensions
• ISAPI Filters
• Basic Authentication
• Windows Authentication

4. Configure DCOM. The configuration is described in detail in the Configure Epicor Service
Connect DCOM chapter.

5. Configure Windows Firewall.

6. Restart IIS.

16 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Installation and Configuration

2.2.6 Install Epicor Service Connect Server on Windows 2016 Server

If Epicor Service Connect is installed on Windows Server 2016, for proper functioning of ESC features the
following components of Web Server (IIS) role should be installed:

1. To do this:

a. Navigate to Start > Administrative Tools > Server Manager.

b. In the TASKS bar, click Add Roles and Features.

c. Select Web Server (IIS), and click Next.

d. In the .Net Framework 4.6 Features group, select the following components:
• .NET Framework 4.6
• ASP.NET 4.6
• WCF Services
- HTTP Activation
- TCP Port Sharing

e. Expand Web Server (IIS), Web Server, Common HTTP Features and select the following
components:
• Default Document
• Static Content

f. Expand Web Server (IIS), Web Server, Application Development and select the following
components:
• .NET Extensibility 3.5
• .NET Extensibility 4.6
• ASP
• ASP.NET 4.6
• CGI
• ISAPI Extensions
• ISAPI Filters

g. Expand Security and select the following components:


• Basic Authentication
• Windows Authentication

2. Configure DCOM. The configuration is described in detail in the Configure Epicor Service Connect DCOM
chapter.

3. Configure Windows Firewall.

4. Restart IIS.

Epicor Service Connect | 10.2.500 17


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

2.2.7 Install Epicor Service Connect Server on Windows 2019 Server

1. To prepare Windows Server 2019 installation for Epicor Service Connect deployment, install the
following components:

a. Navigate to Start > Administrative Tools > Server Manager.

b. In the TASKS bar, click Add Roles and Features.

c. Select Web Server (IIS), and click Next.

d. In the .Net Framework 4.7 Features group, select the following components:
i. .NET Framework 4.7
ii. ASP.NET 4.7
iii. WCF Services
- HTTP Activation
- TCP Port Sharing
e. Click Next
f. Select the following roles:
i. Common HTTP Features
- Default Document
- Static content
ii. Application Development
- .NET Extensibility 4.7
- ASP
- ASP NET 4.7
- CGI
- ISAPI Extensions
- ISAPI Filters
iii. Security
- Basic Authentication
- Windows Authentication

2. Install Epicor Service Connect on Windows Server 2019.

3. To allow Administration Console, Workflow Designer, and Task Monitor access to Service Connect
services from a client installation on another machine, configure DCOM. The configuration is
described in detail in the Configure Epicor Service Connect DCOM chapter.

4. To allow Administration Console and Workflow Designer access to Microsoft SQL Server and RPC
(DCOM/COM+), configure Windows Firewall for Windows Server 2019.

a. To configure a Windows firewall for the Database Engine access in SQL Server, refer to
https://docs.microsoft.com/en-us/previous-versions/sql/sql-server-2012/ms175043(v=sql.110).

Note Additionally, to improve security, you could specify the SQL server service instance under
"Specify the service to which this rule is applied".

18 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Installation and Configuration

b. To create inbound Rules to Support RPC for Epicor services (DCOM/COM+), refer to
https://docs.microsoft.com/en-us/windows/security/threat-protection/windows-firewall/create-
inbound-rules-to-support-rpc.

- Create a rule to allow inbound network traffic to the RPC Endpoint Mapper
service.

Note The "RPC Endpoint Mapper service" rule - alternatively you could enable
the built-in "COM+ Network Access" app/feature under "Allowed apps" for the
required profile.

- Create a rule allowing the inbound network traffic to the RPC-enabled network
services. This rule must be created for every Epicor service installed
(ScaDESRouterSrv, ScaLanSrv, ScaLicenseSrv, ScaLockSrv, ScaLogSrv,
ScaLogonSrv, ScaTaskSrv, ScaTrackSrv, ScaUserProfileSrv, ScaWFHost,
ScaMessengerSrv).

Important Specifically, for Windows Server 2019, choose either "Apply to


services only" or "Apply to all programs and services" under "Specify the
services to which this rule applies", NOT the specific service name!

5. Restart IIS.

2.3 Install Epicor Service Connect Client

You can install ESC client on the same machine with the ESC server immediately after the server installation. You
can also install it on a separate machine either from the installation folder created during the server installation,
or from installation package downloaded from the EPICweb Customer portal.

2.3.1 Before You Begin

Verify the following prerequisites before you install Epicor Service Connect client:
• ESC server should be installed. Without ESC server installed, you will not be able to install ESC client, as the
client installation asks for the name of the machine, on which ESC server is installed.
• To install ESC client on a separate machine from the <install directory>\Client folder created during the ESC
server installation (but not from the installation package downloaded from the EPICweb Customer portal),
share the <install directory>\Client folder on ESC server. This is a recommended way, since it allows ESC
client to access the updated client installation package if the ESC server is upgraded.
• If you install ESC in multiple domain environment (ESC server and ESC client are installed on different machines
in different domains), trust relationship should be configured for these domains.

2.3.2 Install Epicor Service Connect Client

Use the following steps to install the Epicor Service Connect Client on a separate workstation.

1. Run Setup.exe from the <install directory>\Client folder, created by the server installer, or from the
installation package downloaded from the EPICweb Customer portal.

2. In the Welcome window, click Next.

3. In the Logon Service Location window, accept the default machine name or specify it manually to connect
to the logon service to another computer.

Epicor Service Connect | 10.2.500 19


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

Note If the client installation fails with the error message "Unable to connect to Logon service on
the specified computer", then the Remote Activation permission for the ScaLogonSrv COM component
should be set up on the server for the user, for which the ESC client is installed. To do this:

a. Click Start and select Control Panel.

b. In the Control Panel, select Administrative Tools > Component Services.

c. In the Component Services tree view, navigate to Component Services > Computers > My Computer
> DCOM Config and select the ScaLogonSrv node.

d. Right-click the ScaLogonSrv node and select Properties.

e. In the ScaLogonSrv Properties dialog box, open the Security tab.

f. On the Security tab, in the Launch and Activation Permissions section, select Customize and then
click Edit.

g. In the Launch Permission dialog box, in the Group or user name section, add or select the user for
which you want to setup the Remote Activation permission, and in the Permissions for <the selected
user> section, select the Allow check box next to the Remote Activation permission for this user.

h. In the Launch permission dialog box and in the ScaLogonSrv Properties dialog box, click OK.

4. In the Destination Folder window, accept the default location or click the Change button to install the
application to a custom location.

5. In the Choose Setup Type window, select the setup type for the SC client. The following options are
available:
• Complete - All the features of SC client are installed.
• Custom - You can select, which of the SC client features to install. When selecting this option, you can
also specify, where the selected features should be installed.

6. In the Customer Information window, enter your user name and the name of your organization. Click
Next.

7. Click Install.

8. Click Finish.

To install SC Client in silent mode, use the following command line format:
msiexec /i "Epicor Service Connect Client.msi" /q /l*v %Temp%\client.log LOGONS
RVHOST=ServerName
where ServerName is the name of the server with SC Server installed, and %Temp% is system variable, that
keeps the path to the temporary folder specific for the currently logged in user. During installation in silent mode,
all diagnostic information and errors are saved into log file, specified in the command line. Before installing SC
Client in silent mode, make sure that .NET Framework is installed on the destination machine. Otherwise the
silent mode installation cannot be accomplished.
When upgrading Service Connect to the next version, the SC Client Installer notifies about re-import of existing
Web and .NET references.

20 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Installation and Configuration

2.4 Configure Epicor Service Connect DCOM

If Epicor Service Connect is deployed in the client-server configuration, several changes of the operating system
configuration (for example, user permissions) on the server and client machines are required. The section describes
the setup of permissions an end-user must have on a machine running ESC.
For authentication purposes ESC may use the account the end-user is logged in on the workstation. This is why
the so-called Windows domain should be used. Otherwise the system services will not be able to recognize the
user who tries to access them.

2.4.1 Verify DCOM Configuration Prerequisites

Verify the prerequisites before you proceed with configuration:


• Refer to Server Software Requirements for the supported versions of Windows Server.
• Service Connect client requires access to the following components over DCOM:
• ScaDESRouter
• ScaLogonSrv
• ScaLogSrv
• ScaTaskSrv
• ScaLockSrv

• You should add windows group/user that will run ESC client to the DCOM security permissions of the services
mentioned above. The following permissions should be allowed for each component:
• Local Launch and Remote Launch
• Local Activation and Remote Activation
• Local Access and Remote Access

• DCOM security limits should be configured to allow these settings.

2.4.2 Configure DCOM Security Limits

Use the following steps to configure DCOM security limits for Windows Server machine:

1. Navigate to Start > Control panel > Administrative Tools > Component Services.

2. In the Component Services dialog, expand Component Services > Computers > My Computer.

3. Right-click the My Computer node and select Properties from the context menu.

4. Click the COM Security tab.

5. Add windows group/user that will run ESC client to Access Permissions and Launch and Activation
Permissions Limits.

a. To assign the Remote Access and Local Access permissions, in the Access Permissions section, click
the Limits button.
b. To assign the Local Launch, Remote Launch, Local Activation, Remote Activation permissions, in
the Launch and Activation Permissions section, click the Limits button.
6. Permissions should be granted to the default account of the web applications. The default accounts depend
on the version of IIS. So, depending on your IIS version, grant the Local Access, Remote Access, Local
Launch, Remote Launch, Local Activation and Remote Activation permissions to IIS_ IUSRS group.

7. Click OK.
Epicor Service Connect | 10.2.500 21
Installation and Configuration Epicor Service Connect Installation and Implementation Guide

2.4.3 Additional Configurations

Use the following steps to perform additional configurations:

1. Configure the Windows Firewall on the computer, where SC server is installed. To do this:

a. Navigate to Start > All Programs > Accessories > System Tools > Security Center.

b. In the Windows Security Center, click the Windows Firewall link.

c. Either disable the Windows Firewall on the General tab, or configure the proper list of exceptions on
the Exceptions tab.

2. Set the sharing and security model to Classic. To do this:

a. Navigate to Start > Control Panel > Administrative Tools > Local Security Policy. The Local Security
Setting dialog box is displayed.

b. In the left pane, click the Local Policies > Security Options node.

c. In the right pane, double-click Network access: Sharing and security model for local account policy.
In the dialog box, select Classic from the drop-down list.

d. Click OK.

3. Add Anonymous Logon to the COM default Access permissions and to the security limits of Access
Permissions, giving Local Access rights.

2.4.4 Configure Epicor Service Connect Client

Use the following information to configure Epicor Service Connect Client:


• The account used for SC services and components should be included in the local Administrators group on
the client machine. Otherwise, when the client tries to logon to SC, an error occurs (“License server
unavailable”, etc.).
• It is strongly recommended to use domain user accounts for SC services.
However, if for some reason the local user account (not a local system account) is used, the following conditions
should be met:
• The local account should exist on every client workstation. The password for this account should be the
same on each workstation.
• Make sure that sharing and security model is set to Classic (default option for Windows 2008 and later).
The steps for setting the sharing and security model are described below

2.4.5 Set the Sharing and Security Model to Classic

Use the following steps, if you need to set the sharing and security model to Classic:

1. Navigate to Start > Control Panel > Administrative Tools > Local Security Policy. The Local Security
Setting dialog box is displayed.

2. In the left pane, click the Local Policies node, and then the Security Options node.

3. In the right pane, double-click Network access: Sharing and security model for local account policy.
In the dialog box, select Classic from the drop-down list.
22 Epicor Service Connect | 10.2.500
Epicor Service Connect Installation and Implementation Guide Installation and Configuration
4. Click OK.

2.4.6 SQL Server

If SC database is located on the server running on Windows 2008 R2 or later, that server should have the same
DCOM settings and permissions as the Application server for user account under which SC services are running.
Since SC services always access SQL server via trusted connection, the user account, under which they run, should
have rights to access SC database.

Check the following properties for SQL server are Enabled:

1. SQL server properties:


Connections: ‘Allow remote connections to this server’.

2. SQL Server Configuration Manager:


SQL Server Network Configuration: Protocols for MSSQLSERVER:
• "Shared Memory"
• “TCP/IP”

2.5 Epicor Service Connect Task Monitor

The Task Monitor uses dedicated EpicorSCPool Application Pool. Starting from Service Connect 9.05.604, you
should configure the Application Pool to use NET 4.0.
Verify the pool is not assigned to any other Web Epicor application, like EpicorServices. The EpicorServices should
use another pool, usually DefaultAppPool, but not EpicorSCPool. Since IIS 7.0 can work with any pools (.NET 2
and .NET 4) simultaneously the EpicorServices web application can use any other IIS pool with any .NET version
(2 or 4) without conflicts with Service Connect Task Monitor.

Epicor Service Connect | 10.2.500 23


Installation and Configuration Epicor Service Connect Installation and Implementation Guide

2.6 .NET Extensions

The .NET extensions must be allowed for Service Connect to work correctly. After you install Service Connect,
verify that .NET extensions are allowed. To do this:

1. From the Start menu, select Run. The Run window displays.

2. In the Open field, enter inetmgr. Click OK.

3. The Internet Information Services (IIS) Manager window displays. In the middle pane, double-click ISAPI
and CGI Restrictions.

4. On the ISAPI and CGI Restrictions page, for each .NET extension, set the Restriction to Allowed.

2.7 SharePoint Component

If you are going to use SharePoint with Service Connect, you need to perform the following steps to install
SharePoint component:

1. Copy the SharePoint install folder to the SharePoint server.

2. On the SharePoint server, in the appropriate bit folder, run SharePoint Integration setup
(SharePointIntegrationSetup.msi).
Make sure, that the server name and port are valid.

3. Navigate to the ..//windows/system32/drivers/etc folder.

4. Open the hosts file in a text editor and add the following line: <ESC_server_IP_address> scshost.
For example: 192.168.0.123 scshost

For detailed instructions on how to set up SharePoint Workflow refer to ESC online help.

2.8 Service Connect Interoperation with Epicor ERP

Epicor ERP is able to call into ESC in order to initiate workflow creation and execution.
You use a Business Process Management (BPM) directive to put an ESC workflow call action to initiate workflow
execution. In order to create or select an ESC workflow, as well as to call it, BPM uses the WCF service exposed
by ESC.
Updatable BAQs invoke Service Connect workflows in order to apply updates. Therefore, when the updatable
BAQ is created or is being edited, it attempts to create or update the workflow definition, as well as its request
and response schemas. In order to create and update the workflow, BAQ sub-system uses BPM Integration WCF
Service which is installed when the Integration WCF Services feature is installed on ESC server. BPM Integration
WCF Service is used to retrieve and save the updated workflow definition. Usage of this service requires that
BAQ sub-system authenticates in ESC.
When a user attempts to apply the data change through Updatable BAQ, BAQ sub-system generates and sends
the message to the Service Connect workflow which is specified in the corresponding UBAQ. To do so, it uses
BPM Integration WCF Service. In order to access it, it needs to authenticate in Service Connect.

24 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Installation and Configuration

2.8.1 Epicor Service Connect Server Setup


2.8.1.1 Set up IIS for Exposed WCF Services to be Accessible from Epicor

Epicor authenticates in ESC using UserName and Password credentials. For this to work, https protocol should
be enabled in the IIS site hosting ESC WCF services. Enabling the https protocol also requires specifying the
certificate to be used for data encryption by IIS.
To enable the https protocol to be used on the site hosting ESC WCF services:

1. Start Internet Information Services (IIS) Manager.

2. In the Connections pane, select the server name.

3. Under IIS group in the main pane, double-click Server Certificates.

4. Verify there is a certificate with the Issued To matching the full domain name of the server or the name
used to access the server in case a non-default web site is used.

5. Right-click the certificate and select View to check its properties.

6. Verify the certificate has the Ensures the identity of a remote computer property enabled.

7. If there's no such certificate, either create a self-signed certificate or request a certificate from the IT
department.

8. In the Connections pane, select the Default Web Site (or the site hosting ESC WCF Services).

9. In the right (Action) pane, click Bindings.

10. Verify that the list shows the https protocol. If it does not, create a binding, specifying the appropriate
certificate. If it does, verify that a proper certificate is used.
11. Make sure that ESC BPM Integration service can be browsed in Internet Explorer via https without warnings
on the workstation where Epicor client is installed.

Note Use the same server name that was specified for the certificate.
Example:
https://mos-tls-esc-e10.emea.epicor.net/BPMIntegrationWcfService/SCInte
grationWcfService.svc

2.8.1.2 Set up DCOM Permissions

In order for ESC WCF services to be able to access ESC, the account under which their back-ends run (BPM
Integration WCF Service uses the application pool EpicorSCPool which is configured to use NetworkService by
default) needs to have rights to access ESC services locally. This account should have Local Access, Local Activation
and Local Launch permissions in DCOM Security, including per-service rights. These permissions can be configured
in Windows Administrative Tools - Component Services. DCOM Security Limits should not prevent the above
permissions from being applied.

2.8.1.3 Sample Setup of ESC User Rights

In this setup an internal ESC user account is created. This account is then used by Epicor's BAQ and BPM engines
to authenticate in ESC to create and update ESC workflows, and to execute data updates.
In Service Connect Administration Console, create and set up rights for the user account for use by BAQ and
BPM engines.

Epicor Service Connect | 10.2.500 25


Installation and Configuration Epicor Service Connect Installation and Implementation Guide
1. In Security – Users, create a new user with the following parameters which will be used by Epicor:

User Name EpicorSvc


Full Name Epicor Server Calls
Description Epicor: Account used by Epicor to call into ESC
Alias EPICORSVC
Password <password as per the organization policy>

2. In Security – Granted Permissions, create a new role with the following parameters:

Name Epicor Server Calls


Permissions
Developer\Manage Workflows
System\General\System Logon

3. In Security – Enterprise Organigram, create a new OrgNode with the following parameters:

Name Epicor Server Calls


Associated Users EpicorSvc

4. In Security – Role Assignment, select Epicor Server Calls OrgNode and map Epicor Server Calls role to it.
With the above setup, specify EpicorSvc account in Epicor data sources and for Launching SC Workflows in BPM
– sUBAQs. Log on to Epicor using Manager user.

2.8.2 Set up Epicor to Work with ESC


2.8.2.1 Import IIS Certificate

In order for Epicor to be able to access ESC WCF Services, the server hosting Epicor server side needs to know
and accept the certificate used by ESC server IIS https binding.
If Epicor Server is installed on a different server than ESC, export the certificate from ESC Server and import it to
certificates store on Epicor server. Otherwise, verify that the certificate is present in corresponding certificate
branches on the shared server.
On the server hosting the server side of Epicor:

1. Invoke Run (select Start – Run or press Win-R) box and start MMC.exe to start Microsoft Management
Console.

2. Select File – Add/Remove Snap In.

3. In the left pane, double-click Certificates.

4. When prompted by Certificates snap-in, select to always manage certificates for Computer account.

5. Click Next.

6. Click Finish.

7. Click OK.

8. Expand Certificates (Local Computer).


26 Epicor Service Connect | 10.2.500
Epicor Service Connect Installation and Implementation Guide Installation and Configuration

9. Browse to Personal – Certificates and verify that the certificate corresponding to full domain name of ESC
server (which was configured for use in https connection of ESC IIS) is present.

10. Browse to Trusted People – Certificates and verify that the same certificate is present there as well.

11. If the certificate is present only in one of the branches from listed in the above two steps, select it there,
right-click and select Copy, then browse to the other branch, right-click the empty part of the right pane
and select Paste.

12. If the certificate is absent in both places, go to ESC server and get to Certificates of the Local Computer (see
steps 1-6 above). Browse to Personal Certificates, right-click the certificate used by IIS and select All Tasks
- Export. When exporting, do not select to export the private key if prompted; then import the certificate
on Epicor Server machine.
Note Your organization IT policy may require different certificate rollout approach. For example, your
organization might use the Public-key infrastructure.
2.8.2.2 Set up Epicor ERP to Access ESC

For Epicor ERP to be able to call into ESC to create or execute a workflow using UBAQs the following setup is
required in Epicor Client > Business Activity Query Designer > Update > Update Processing:

1. Verify the connection to ESC is set up. Click Server to verify the connection.

2. Select the Service Connect Workflow processing method.

3. Click New to create a new workflow, or Configure to execute an existing workflow.


For detailed steps refer to Epicor ERP online help: Executive Analysis > Business Activity Management Overview
> Business Activity Management Setup Programs > Business Activity Query Designer > Update > Update
Processing

Epicor Service Connect | 10.2.500 27


Implementation Epicor Service Connect Installation and Implementation Guide

3 Implementation

This part of the guide describes Epicor Service Connect implementation concepts and processes.

3.1 Concepts

Review the following section to learn about the main concepts of the Epicor Service Connect implementation.

Business Documents
Business document is a document containing business data. Epicor Service Connect receives business documents
and processes them using custom workflows. Processing documents may include generation of new documents
and sending documents to specific external recipients. Epicor Service Connect is able to receive and send documents
in any format, but it uses only XML documents internally. All input documents that have other format must be
converted to one of the internal XML document types before further processing. If an output document is required
to be non-XML, it can be also converted to any format. Epicor Service Connect provides default converters that
can convert XML, CSV and Microsoft Excel files into internal XML documents. If you need to support other
formats, you may create custom components that support specific interfaces, and use them for conversion.
Epicor Service Connect internal documents always consist of a part containing system data (message envelope)
and a part containing business data.
Documents are sent and received using Communication Channels. Communication Channels enable document
exchange between Service Connect and other systems using various types of communication protocols. When
document is received by communication channel, it can be converted to one of the internal documents for further
processing in workflows. System part of the document may contain information about sender system or component.
Sender credentials together with document type are used to create a type of subscription – Message Mapping.
Message mapping allows launching an appropriate workflow automatically, when the document of certain type
sent by certain sender is received.

Workflows
Workflow defines a sequence of automatic actions and user-performed tasks for processing business documents.
General actions, like document transformation or assigning tasks to user, are provided by Epicor Service Connect
services. More business specific actions can be incorporated into workflow by importing web-services that provide
required functionality. (See the Import Web Services section and Epicor Service Connect Documentation
Kit > Using Epicor Service Connect > System Administration > Connectivity > Configuring Epicor Service
Connect to Use External Web Services for more details)
Workflows are organized in packages. Packages provide a convenient way to group workflows. You can create
packages in Administration Console and Workflow. Administration console also supports backup and restore
operations for workflow packages and individual workflows.

3.2 Processes

This part of the guide describes the order and the processes you perform to implement Epicor Service Connect.
Note that the processes described below do not include achieving agreements with data and service providers
regarding business documents exchange, communications protocols and business operations included into the
workflow.

28 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Implementation

3.2.1 Register Documents

The document is considered registered if the system can access XML schema of the document. The schema that
describes system part of the document is a part of the Epicor Service Connect, so you only need to specify the
schema for business data.
The business document may be registered using three ways:
• Import Web Service. When importing web services, the documents used in document exchange between
Service Connect and web-service are registered automatically. For more information, see the Import Web
Services section.
• Use schema export utility. Schema export utility automatically creates a schema using sample files.
• Copy XML schemas manually. If you already have XML schemas describing XML documents you plan to
use, you can copy them manually to the <SC installation folder>\SCS\UserSchemas folder.

3.2.2 Import Web Services

Importing web-services is done in the administration console (For more information, see Epicor Service Connect
Documentation Kit > Using Epicor Service Connect > System Administration > Connectivity > Configuring Epicor
Service Connect to Use External Web Services). Imported web services become available for using in workflows
and automatically register business documents used in message exchange between web service and Epicor
Service Connect.

3.2.3 Set Up Communication Channels

Communication channels are used for sending and receiving documents. You need to configure communication
channels before using them. During communication channels configuration, you can specify the following settings:
• Communication protocol and protocol specific settings, for example folder path for File channel
• Message encoding and format
• Acknowledgment
• Channel schedule
• Default message attributes
• Conversions
For more information, see Epicor Service Connect Documentation Kit > Using Epicor Service Connect.

3.2.4 Create Workflows

At this stage you are ready to create workflows. Workflows are created and edited in the Workflow Designer
tool. For more information, see Epicor Service Connect Documentation Kit > Using Epicor Service Connect
> Workflows > Managing Workflow Processes in Workflow Designer.

3.2.5 Set Up Message Map

Message map is a type of subscription workflow to certain business documents sent by certain senders. During
message map configuration, when a certain business document sent by a certain user arrives to the channel and
passes necessary conversions, an appropriate workflow is automatically launched. For more information, see
Epicor Service Connect Documentation Kit.

Epicor Service Connect | 10.2.500 29


Implementation Epicor Service Connect Installation and Implementation Guide

4 Third-Party Modules
Portions of Epicor Service Connect use the following third-party modules coming with their corresponding additional
license terms:
• Microsoft.ApplicationInsights 2.6.4 (https://www.nuget.org/packages/Microsoft.ApplicationInsights/2.6.4):
The MIT License (MIT)
Copyright (c) Microsoft Corporation
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
• System.Diagnostics.DiagnosticSource 4.4.1
(https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/4.4.1):
The MIT License (MIT)
Copyright (c) .NET Foundation and Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
• Microsoft.IdentityModel.Clients.ActiveDirectory 4.5.0
(https://www.nuget.org/packages/Microsoft.IdentityModel.Clients.ActiveDirectory/4.5.0):
MIT License
Copyright (c) Microsoft Corporation
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

30 Epicor Service Connect | 10.2.500


Epicor Service Connect Installation and Implementation Guide Implementation

• Newtonsoft.Json 12.0.1 (https://www.nuget.org/packages/Newtonsoft.Json/12.0.1):


The MIT License (MIT)
Copyright (c) 2007 James Newton-King
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
• RabbitMQ.Client 5.1.0 (https://www.nuget.org/packages/RabbitMQ.Client/5.1.0):
Licensed under the Apache License v2 (http://www.apache.org/licenses/LICENSE-2.0).
• Microsoft.Diagnostics.Tracing.EventSource.Redist 1.1.28
(https://www.nuget.org/packages/Microsoft.Diagnostics.Tracing.EventSource.Redist/1.1.28):
Licensed under MS .NET library license (https://www.microsoft.com/net/dotnet_library_license.htm).
• Rebex.Elliptic.Ed25519 1.0.0 (https://www.nuget.org/packages/Rebex.Elliptic.Ed25519/1.0.0):
Copyright (c) 2015 Orson Peters <orsonpeters@gmail.com>, Rebex CR s.r.o.
• WindowsAzure.ServiceBus 4.1.11 (https://www.nuget.org/packages/WindowsAzure.ServiceBus/4.1.11):
Licensed under Microsoft Windows Azure SDK and Microsoft Windows Azure libraries .net license terms, details
available at http://go.microsoft.com/fwlink/?LinkId=218949.

Epicor Service Connect | 10.2.500 31


Additional information is available at the Education and
Documentation areas of the EPICweb Customer Portal. To access
this site, you need a Site ID and an EPICweb account. To create an
account, go to http://support.epicor.com.

You might also like