ERP Analyzer Guide

Version 2022.1
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 © 2022 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.
 ERP Analyzer Guide

Table of Contents

Getting Started with ERP Analyzer 4

Verifying Technical Requirements 5

Epicor Compatibility 5
Operating System Compatibility 5
Browser Requirements 5
Networking Requirements 5
Security Requirements 6
Installing the Analyzer 7

Running the Analyzer in Online Mode 10

Reviewing Your Analyzer Report 15

Running the Analyzer in Offline Mode 16

Running the Analyzer in Debug Mode 19

Frequently Asked Questions 21

I don’t know if I have an Upgrade Services account 21
I’ve forgotten my Upgrade Services password 21
I don’t have an Upgrade Services account 21
When I click Download, nothing happens 21
When I run the installer, nothing happens 21
How can I make sure I’m using the latest version of the ERP Analyzer? 22
I receive an error loading environments 22
My Site ID is not available to select 22
I have another error or problem installing or running the ERP Analyzer 22

3 July, 2022
 ERP Analyzer Guide

Getting Started with ERP Analyzer

Kinetic is a flexible application that can be tailored to fit. When upgrading to the latest version of
Kinetic, it is important to understand your current solution, including modifications and tailoring. The
ERP Analyzer automates this time consuming step.

This guide documents the pre-requisites for the ERP Analyzer, and describes how to complete the
process of running the Analyzer including:

l Accessing the upgrade services portal

l Downloading and installing the ERP Analyzer on your application server
l Running the Analyzer
l Including Altec Doclink in your report (if currently in use in your legacy system)
l Reviewing your Analyzer report
l Running the Analyzer in Offline or Debug mode
l FAQs
If you have difficulty completing this process, please contact Support to request further assistance.

This guide explains how to run the ERP Analyzer in your on-premise deployment of Vista, Vantage, or
Kinetic. If you do not have an on-premise deployment, please review the options noted below:

l If the environment you would like to review is currently hosted in Kinetic Public Cloud, please
refer to the Configuration Upgrade Dashboard within your Kinetic Cloud environment to review
your custom elements. Further information is available on EpicWeb under Products > Epicor ERP
Cloud (Kinetic) > Documentation. It is not possible to run the ERP Analyzer in Kinetic Public
Cloud.
l If the environment you would like to review is currently hosted in Kinetic Private Cloud, also
known as Epicor Managed Services, please open an EpicCare support case to request running
Analyzer for your environment. Once you receive confirmation that the process is complete, you
can review the results in the Upgrade Services Portal.

4 July, 2022
 ERP Analyzer Guide

Verifying Technical Requirements

Epicor Compatibility
You can run the Analyzer for the following versions of Epicor, where “x” indicates any release or patch
level:

l Vista and Vantage 8.x

l Epicor ERP 9.x
l Epicor ERP 10.x

The Analyzer is not compatible with any versions of Vista or Vantage prior to 8.00 such
as 6.x.

Operating System Compatibility

The Analyzer requires Microsoft .NET Framework 4. You can download the standalone installer here:

https://www.microsoft.com/en-us/download/details.aspx?id=17718&e6b34bbe-475b-1abd-2c51-
b5034bcdd6d2=True

You can install version 4 of the .NET Framework on a server with any previous version of .NET
Framework.

Browser Requirements
Use Google Chrome to access the Upgrade Services Portal. Internet Explorer and Microsoft Edge are not
supported.

Networking Requirements
The Epicor application server must be able to access https://upgradeservices.epicor.com.You can find a
specific list of IP addresses to whitelist in your firewall here:

https://www.microsoft.com/en-us/download/details.aspx?id=56519

You can also run the Analyzer in the offline mode and upload the report uploaded using another
machine if necessary. Refer to the Running the Analyzer in Offline Mode article in this guide for more
details.

5 July, 2022
 ERP Analyzer Guide

If your Epicor application server operating system is Windows Server 2003, you must add
https://upgradeservicesproxy.cloudapp.net to your trusted sites. This step is not required for any other
operating system.

1. Launch Internet Explorer and go to Internet Options

2. On the Security tab, select Trusted Sites and click the Sites button.
3. In the Trusted Sites dialog, enter https://upgradeservicesproxy.cloudapp.net and select Add.
4. Select Close.

Security Requirements
You should run the Analyzer under a user account with administrative permissions on the application
server. This account must also have administrative permissions to the database, whether SQL Server or
Progress.

6 July, 2022
 ERP Analyzer Guide

Installing the Analyzer

In this article, we cover how to install the ERP Analyzer for the first time. If you already have an older
version of the Analyzer installed, just launch the Analyzer and log in. The utility will update to the latest
version automatically.

1. Log into the Kinetic application server for the environment you want to analyse using
administrative credentials.

2. Launch your selected internet browser (the recommended browser is Google Chrome) and
browse to https://upgradeservices.epicor.com.
3. Log into the Upgrade Services Portal using your email address and the password you set for
yourself when registering. If you forgot your password, use the Forgot Password? link on the
login screen to reset your account.

For help with this account, select a link below to see more information:
l I don’t know if I have an Upgrade Services account

l I’ve forgotten my Upgrade Services password

l I don’t have an Upgrade Services account

7 July, 2022
 ERP Analyzer Guide

4. On the Home page, locate the ERP Analyzer section and select Download.

5. Review the license agreement. Then select the I Agree check box and click Download.

If the system does not respond, review:

l When I click Download, nothing happens

8 July, 2022
 ERP Analyzer Guide

6. Run the downloaded installer on your current version Kinetic application server. Make sure you
are logged in as a user with Administrative credentials.

If you have issues, review:

l When I run the installer, nothing happens

l I have another error or problem installing the ERP Analyzer

7. The installation window closes once the installation is complete. This typically takes less than
one minute.

9 July, 2022
 ERP Analyzer Guide

Running the Analyzer in Online Mode

Epicor recommends running the ERP Analyzer in online mode. This is the simplest and quickest method
to generate your Analyzer report.

1. Launch the ERP Analyzer from the Start menu or the desktop shortcut.

2. Log in to the Analyzer using the same credentials you use to access the Upgrade Services Portal.

10 July, 2022
 ERP Analyzer Guide

3. When you log in, the Analyzer will check for updates. If a newer version is found, it installs it and
then prompts you to log in again.
4. Enter or select the Site ID corresponding to the database you want to analyze. This is the same
Site ID referenced when you contact Epicor Support.

If you have issues, review:

l Error Loading Environments

l My Site ID is not available to select

5. You are now able to select which environment to analyze from the Environment drop-down list.
Typically, you should select your Production environment. If you run the Analyzer on your Test or
Pilot environment, you may find that the customizations deployed in those slots are different
from the ones you are currently using in Production. This may result in inaccurate information
captured for scoping your upgrade project.

The Analyzer does NOT affect the selected environment; this is a read-only utility that never
updates any reports, custom elements, or data on the server.

6. If you are analyzing your production environment, select the This is a production environment
check box.
7. If you would like to also include your existing deployment of Altec DocLink also known as APM or
APM+ in the report, select the Include Altec DocLink analysis check box.

11 July, 2022
 ERP Analyzer Guide

This step is optional. Ignore this selection if you do not currently use Altec, or if
you do not know the credentials to log into your Altec database.

8. When the Epicor client is on the machine where you are running ERP Analyzer, select the Epicor
Client Installation Path check box. If the client IS NOT available, ignore this check box.

9. Selecting the Epicor Client Installation Path check box shows the Epicor Client Location field.

10. Click the Browse button to locate the client install path. This path is different depending
on your version:
l Epicor ERP 10 or Epicor ERP 11 -- C:\Epicor\ERPXX\LocalClients\ERPXXXXXX (for
example, C:\Epicor\ERP10\LocalClients\ERP101600)
l Epicor ERP 9.XX -- C:\Epicor\EpicorXXX\Client (for example, C:\Epicor\Epicor905\Client)
l Epicor ERP 8.XX -- C:\Epicor\mfgsysXXX\Client (for example, C:\Epicor\mfgsys803\Client)
11. The next step depends on whether you are including Altec DocLink database for analysis:
l If you have not selected to include Altec, select Go.
l If you have selected to include Altec, select Next.

12 July, 2022
 ERP Analyzer Guide

12. Then select the DocLink database, enter the requested information and click Go.

If you do not know how to connect to the DocLink database, click Back, and clear the Include
Altec DocLink analysis check box to continue with the analysis.

13. When you select Go, the Analyzer starts the process. It can take a few minutes or a few hours
depending on the speed of your server and network, the number of custom elements, and the
size of your database. The logging screen displays the process in real time.

13 July, 2022
 ERP Analyzer Guide

14. Once completed, close the Analyzer window.

14 July, 2022
 ERP Analyzer Guide

Reviewing Your Analyzer Report

1. To view your Analyzer report, return to https://upgradeservices.epicor.com.
2. After logging in, click on the main menu in the upper left corner of the screen and select Reports.
3. Select the Site ID for which you wish to review the report. Note if you have run the Analyzer
multiple times, the drop-down list allows you to select the latest or the previous versions of the
report.

4. Work with your Account Manager to review your results and scope your upgrade project.

15 July, 2022
 ERP Analyzer Guide

Running the Analyzer in Offline Mode

If your networking constraints do not allow you to log into the Upgrade Services Portal or the ERP
Analyzer from your application server, you may run the utility in offline mode via the command prompt,
and upload the resulting files from another computer. Note, you still must run the Analyzer on your
application server, even if using the Offline mode.

This is not the recommended approach because it is more difficult and time consuming than the
standard process. You should use it only if your system does not allow following the standard process.

1. Open an elevated command prompt window.

2. Change the directory to the ERP Analyzer installation directory, replacing administrator with the
user name of the Windows User as which you are logged in:
Example from older operating system:

cd "C:\Documents and Settings\administrator\Local

Settings\Application Data\Epicor ERP Analyzer"

Example from newer operating system:

cd "C:\Users\administrator\AppData\Local\Epicor ERP Analyzer"

3. Type the command to run the Analyzer for your Site ID and the selected environment, replacing
00000 with your Site ID and replacing Epicor905 or MfgSys803 with the name of your
environment. You may need to review your Administration Console to locate the correct name for
your environment.
Epicor 9 example:

16 July, 2022
 ERP Analyzer Guide

ERPAnalyzerCLI.exe -o "C:\temp\ERPAnalyzerReport.json" -c -s 00000 -

e Epicor905 –production

Vantage 8 example:

ERPAnalyzerCLI.exe -o "C:\temp\ERPAnalyzerReport.json" -c -s 00000

-e MfgSys803 –production

If needed for troubleshooting, add debug to the end of the command to

generate the debugging log file:
[. . .] -production debug

4. The next command line asks you to enter the install path to the Epicor client location. If the
Epicor client is on the machine where you are running ERP Analyzer, enter this path.

This install path is different depending on your version:

l Epicor ERP 10 or Epicor ERP 11 -- C:\Epicor\ERPXX\LocalClients\ERPXXXXXX (for
example, C:\Epicor\ERP10\LocalClients\ERP101600)
l Epicor ERP 9.XX -- C:\Epicor\EpicorXXX\Client (for example, C:\Epicor\Epicor905\Client)
l Epicor ERP 8.XX -- C:\Epicor\mfgsysXXX\Client (for example, C:\Epicor\mfgsys803\Client)

If the client IS NOT on this machine, press Enter to skip this step.

5. The Analyzer starts the process, generating the logging information within the command prompt
window. As with online mode, wait for the process to finish. Then close the command prompt.

17 July, 2022
 ERP Analyzer Guide

6. Now browse to C:\temp\ and locate the Analyzer output. You should find a json file and a folder:

Copy the ERPAnalyzerReport.json_Files folder as well as the ERPAnalyzerReport.json file to

the computer you will use to upload the report via external drive, file share, or any other file
transfer method. The computer you use for the upload must be able to connect to the Upgrade
Services Зortal.

7. Repeat the steps to download and install the ERP Analyzer on the computer that will be used to
upload the Analyzer report.
8. Open an elevated command prompt and change the directory to the ERP Analyzer directory as in
step 1 of this section. Then run the following command, replacing 00000 with your Site ID:
ERPAnalyzerCLI.exe -i <path to the .json file> -s 00000

9. Enter your Upgrade Services Portal credentials when prompted:

10. The system uploads the report to the Upgrade Services Portal. Follow the instructions to review
the report once the upload completes.

11. To view a list of other available commands available, type this command:
ERPAnalyzerCLI.exe -help

18 July, 2022
 ERP Analyzer Guide

Running the Analyzer in Debug Mode

If the Analyzer does not work as expected, you may need to run the program in debug mode to
generate log files capturing the error details.

1. Locate the ERP Analyzer shortcut on your desktop. Right-click it and select Properties.

19 July, 2022
 ERP Analyzer Guide

2. Within the properties window, add the word debug to the end of the target. Then click OK.

3. Run the ERP Analyzer using the modified shortcut following the same steps you followed before.
Once it reaches the point of failure, locate the generated log file in the following directory,
replacing administrator with the username of the Windows User as which you are logged in:
C:\Users\<administrator>\AppData\Local\Temp\Cirrus\Logs

4. Open a support case in EpicCare for assistance and attach the log files to your case to expedite
the troubleshooting process.

You can also run the Analyzer in debug mode using the Command Line Interface
by adding --debug to the end of the command.

20 July, 2022
 ERP Analyzer Guide

Frequently Asked Questions

I don’t know if I have an Upgrade Services account
If you already have an account, you will be able to log in to the portal with your email and password at
https://upgradeservices.epicor.com/#/login. Use the same email address that is configured with your
EpicWeb account (but the password may be different). These are the same credentials you use to log
into the ERP Analyzer, once installed.

I’ve forgotten my Upgrade Services password

You can reset your password by visiting
https://upgradeservices.epicor.com/#/account/password/forgot, entering your email address, and
selecting Submit. Make sure to use the same email address that is configured with your EpicWeb
account. You will then receive an email with a link allowing you to enter a new password.

You can also start the password reset process using the Forgot Password? link on the log in screen of
the ERP Analyzer.

I don’t have an Upgrade Services account

Your Epicor Account Manager or other contact person can assist in provisioning your account.

When I click Download, nothing happens

Make sure your internet browser is not blocking the download of the ERP Analyzer installation file. You
may need to review your security settings.

When I run the installer, nothing happens

Sometimes, especially on secure servers, the installer may have to be manually unblocked. To do this,
right-click the installer and select Properties, then select Unblock, and click OK.

You may also need to run the installer as an administrator. To do this, run the Command Prompt as an
administrator and then run the installer from there.

21 July, 2022
 ERP Analyzer Guide

How can I make sure I’m using the latest version of the ERP
Analyzer?
When you log in to the Analyzer, it updates automatically if a newer version is available. There is no
need to check for updates or manually install them.

I receive an error loading environments

If you receive an Error Loading Environments immediately after logging into the ERP Analyzer, double
check that you are running the tool on your current version application server.

My Site ID is not available to select

If you are unable to select the correct Site ID to target, this means your Upgrade Services account has
not been associated with that Site ID. Contact your Account Manager or other person who asked you to
run the Analyzer and ask them to help correct your account settings.

I have another error or problem installing or running the ERP

Analyzer
Please contact Epicor Support for assistance:

You can log a ticket in EpicCare at https://epicorcs.service-now.com/, selecting Upgrade Services Tools
as the Asset for your case.

You can also call 1-888-EpicorX.

22 July, 2022