Top
Top
LibraryEASYProcess Installation/Upgrade

EASYProcess Installation/Upgrade

Please read the entire document before beginning the Installation or Upgrade

Who Should Use This Document?

Use this document to install, upgrade, or fix an EASYProcess installation.

Prerequisite

  • Access to K-Rise B2BPortal/Download (B2B)

https://b2bportal.krisesystems.com/Downloads/DownloadHome

https://b2bportal.krisesystems.com/BTR/Builds

  • App server with admin access
  • Web server with admin access
  • SQL server database. Admin access is not needed on the server for install or run time, but you will need someone to restore or create the database with admin access.
  • Website folder: If you are upgrading, you will need this from an existing application.
  • Application Database: if you are upgrading, you will need this from an existing application.

SCM
8) Converting MT Mode
1) Naming Conventions
2) Install on App Server
3) Prepare Database
4) Prepare App and Web Server Folders
5) Start Upgrade
6) Set Up App Server
7) Set Up Web Server
SSL Certificate
ECC

Converting MT Mode

If your install is using MT mode, do following steps to convert:

  • Move Toolset/Website folder to Applications/$AppName folder on webserver.
  • Remove appSetting/MultiTenant key.
  • Copy Applications/$AppName/Website/‘_$AppName’/Scripts,Styles,Images folder content to corresponding Applications/$AppName/Website/ folder.
  • Delete Applications/$AppName/Website/‘_$AppName’/ folder.
  • Change ‘EPInstallation.config’ based on template file from B2BPortal/Download.


Naming Conventions

Before beginning, some information such as the naming conventions and port numbers for each environment will need to be determined. We strongly recommend to pick your environment, databse, applicaton, and url naming conventions and port numbers following the examples below.

Environment Name

In order to have multiple environments and allow for a promotion path between the created environments, multiple copies of EASYProcess are created. Those EASYProcess instances are considered environments. A two letter abbreviation should be chosen for each environment in the promotion path. That environment name will be appended to the project name like so:

[ProjectName]_[EnvironmentAbbreviation]

Examples: eCommerce_DV, eCommerce_QA, HR_DV, Procurement_DV

Application Name

Each environment will have its own copy of the Application. This way, when you make a change, the DV version of the Application will be changed, while PD will remain as the last stable version and will not change until the new changes are approved. The Application is the name of K-Rise solution that will be created and edited using EASYProcess. This Application name can be similar to the Project Name.

Examples: EASYCommerce, VSSPortal, EASYBuyer

If you are upgrading do not change the name of your application

Database Name

Each environment will have the Application you have named and a corresponding “Base” application. The Base Application is responsible for running things behind the scenes for EASYProcess and will not be edited. Both of these applications need a corresponding database.

EP_[ProjectName]_[EnvironmentAbbreviation]_[ChosenApplicationName]

EP_[ProjectName]_[EnvironmentAbbreviation]_[Base]

Examples: EP_eCommerce_DV_Base, EP_eCommere_DV_EASYCommerce

URLs

Each environment, or instance of EASYProcess, will have an associated URL.

Website Url: http://server/eCommerce_DV_EASYCommerce

Website Url: http://server/EASYCommerce_DV

Application Server, Port, & Timeout

EASYProcess, starting 4.7, needs an Application server. EASYProcess runs EASYProcess Enterprise Server (EES) on the Application Server on a designated port. You specify the Application Server, port and timeout in the config file, which will be created and configured later.

It is important that you pick a port number. We recommend 45XX for DV, 46XX for QA, 47XX for TR, and 48XX for PD environment.


Install on App Server

EASYProcess Enterprise Manager (EEM)

Location: App server

From B2BPortal/Download/SQLServerComponents.zip: Unzip and install all MSIs.

From B2BPortal/BTR/Builds, download EEM based on your build. Link to download EEM is available right next to EASYProcess download. Make sure it is run as admin all the time (Right Click-> Properties -> Compatibility -> Change settings for all users -> check Run this program as administrator)

EASYProcessRoot Registry

Location: App server

[HKEY_LOCAL_MACHINE\SOFTWARE\K-Rise Systems, Inc\EASYProcess]

"EASYProcessRoot"

This registry is needed. If this does not exist, download ‘EP Registry’ from B2BPortal/Download and then double click to add it to target computer. Default value for this is “C:\EASYProcess\”. You can change it to another directory if you need to.


Prepare Database

Location: Database server

  • If you are upgrading, bring your database with name as established based on naming convention. You can use an existing database to upgrade, but then we strongly recommend you backup first.
  • If you are creating a new application, just create a new database with correct naming conventions.
  • Base Database: Create a new blank database with correct name. If old base db already exists, it is easier to rename current database and then create a new blank database.
  • Default Schema: Schema for the database has to be ‘dbo’. EASYProcess does not support non dbo schema database.


Prepare App and Web Server Folders

Application Server

Prepare Application Server Folders

Create the following folders:

  • $EASYProcessRoot (i.e. C:\EASYProcess).
  • $EASYProcessRoot\$EnvironmentName
  • $EASYProcessRoot\$EnvName\Applications\$AppName
  • If you are upgrading and using any other folder for your programming needs (such as a folder to save PDFs created by EP), you will need to manually move that over from current application. This also requires a knowledge of existing application. Seek advice from current developers for the application.

EPInstallation.config

Location: App server

Download EPInstallation_Template.config from B2BPortal.

  • If $EASYProcessRoot/EPInstallation.config already exists because of an existing installation, then copy Environment node from template file and then paste it inside <Environments> node at the bottom.
  • If EPInstallation.config does not exist, then copy template file to $EASYProcessRoot and then rename to EPInstallation.config.

Then complete new environment node in EPInstallation.config. It is mostly self explanatory based on variables defined before such $EnvName, $AppName etc. Some points to note:

  • Leave License Key blank if this is new EPInstallation.config. You can apply that later on.
  • Env/Version: 4.4.0.0 (if upgrading from 4.4), 4.6.0.0 (if upgrading from 4.6), 4.7.0.0 (if upgrading from 4.7) otherwise leave it what it is.
  • Fill in environment, database, application, and physical path using naming convention as defined above.
  • Start EEM, Right click to add your computer. EEM will try to load installation file. If there is any error in installation file, EEM will throw an error and you will have to fix it before loading.

Web Server

Prepare Web Server Folders

  • $PhysicalPath: This is where you will create IIS website application for EP application. This should be a valid path on webserver. We recommend to use:

$EASYProcessRoot\$EnvName\Applications\$AppName\Website.

  • Create $PhysicalPath folder.
  • If you are upgrading: Copy everything inside the  current website folder (non upgraded) to $PhysicalPath. Do not create a new ‘Website’ folder inside Website folder.
  • If you are upgrading and using any other folder for your programming needs (such as a folder to save PDFs created by EP), you will need to manually move that over from current application. This also requires a knowledge of existing application. Seek advice from current developers for the application.

Web.config/Global.asax

Location: Web server

  • If Upgrading, rename current web.config in $PhysicalPath to Web_OldVersion.config.
  • Download web_template.config template from B2BPortal and rename that to web.config. In AppSettings, change following:
  • ApplicationServer, ApplicationServerPort as picked before.
  • If Upgrading, rename current global.asax in $PhysicalPath to Global_OldVersion.asax.
  • Download global_template.asax template from B2BPortal and rename that to global.asax. Manually move any existing code from global_oldversion.asax that you need to global.asax. Do not change any existing code on global.asax.


If upgrading, complete “Start Upgrade.” If not, you are performing a new install. If this is a blank install, still complete “Start Upgrade”. If the install is a copy of EASYCommerce, or another existing application, skip this.

Start Upgrade

Location: App server

Skipping Tables in Upgrade

If you want to skip a table in upgrade, add following entry in EPInstallation.config for that table.

Upgrade node must be direct child EASYProcess (Top) Node.

&NameX = your table names such as EP_Requests, EP_Worflow_Delegates

<Upgrade>

          <SkipTables>

                  <Table>&Name1</Table>

                <Table>&Name2</Table>

        </SkipTables>

  </Upgrade>

Start Upgrade

  • Go to B2BPortal/BTR/Builds.
  • Download latest build. We always recommend using the latest build.
  • Right click on the environment in EEM and then click upgrade. Then locate downloaded EPP file and click open.
  • Click upgrade at the bottom of the screen.
  • Monitor for upgrade errors. Sometime an error window could be hidden if you are using a remote desktop. Hover you mouse over EEM taskbar icon to see if any error window has popped up. Read error fully, sometime more errors can be there at level2, level3 below.. Typical errors are :
  • Files on lock because you have exe, dll locked by EES, Workbench, batch job etc. You have to close all running EP applications in that environment for upgrade to finish.
  • A table T already has primary key PK defined on it’ : Any time you get this error, just delete existing primary key from table using SQL Management studio and then retry.
  • Size of keys exceeds limit. : If this happens, then you have to reduce some key field lengths to make it equal to size limit.
  • Cannot define PRIMARY KEY constraint on nullable column in table T'. You have to manually allow null on those tables using management studio. If any such column has NULL data in it, you have to update it with blanks/spaces.
  • Table webpages has duplicate urls’ : Webpage’s records will be converted to the EP_CMS_Pages table, and URLs from the webpages will be used as Page name. So webpages cannot have duplicate URLs. When you get this error, follow instruction, find duplicate URLs and then update the pages not used with blanks.
  • In some cases, new primary keys, as needed by EASYProcess on a table, cannot be created because of existing records in the table. Those records have to be deleted or changed to honor new primary keys on the table.
  • Upgrade will finish with all tasks marked as successful.
  • Upgrades are fully safe to rerun if ended for any reason.

Set Up App Server

Create Shortcuts

Location: App server

Navigate to $EPRoot/$EnvName/Toolset/KRise.EASYProcess.ShortCutUtility.exe and run it. You should have the EASYProcess shortcut on desktop.

Start Developer Workbench

Location: App server

You can start EASYProcess developer workbench from ‘Desktop Shortcut,’ or by right clicking on application in EEM.

Setup & Test EASYProcess Enterprise Service (EES)

Location: App server

  • Start EASYProcess.
  • Go to Tests & Setups/Enterprise Server Setup screen. Then Create Windows Services.
  • Note down display name on this screen.
  • Go to windows services console, locate your service using ‘display name’ from setup. Start it.
  • Go to Tests & Setups/Test Setup Schedule Center. Click on Enterprise server connection. Then click on button ‘Test Enterprise Server’. You will see the server will return current date and time. Test a couple of times and make sure date/time is changing.
  • If installing on cloud: in service properties, change “Log on as” to krise\EPUser with password Krise431.
  • If you cannot successfully test EES, then you stop here. Try to troubleshoot EES using logs in $EPRoot\$EnvName\Toolset\Logfiles folder.
  • If you get error like ‘format error’ then it means there may be a port conflict and some other program is using the same port. You should change port in EPInstallation.config, delete and recreate service and then test again.
  • Use “netstat -bano” command to check what program is running on what port.


Set Up Web Server

Setup IIS Website & Ping Website

Location: Web server

  • Open IIS Manager
  • Expand Sites, Right Click on Default Web Site, and Add Application
  • Setup IIS website/Application using the physical path and URL given at website level in install config file. You need to make sure that IIS site/Application opens the URL. If you need to create an application inside the website to point to url, do that.
  • If URL is http://ec.krisesystems.com/eCommerce_DV/  then you should create an Application eCommerce_DV inside this website to point to physical path.
  • If URL is http://ec.krisesystems.com/ then your website path should point to physical path.
  • Ping website : Type URL $Url/EP_Ping.aspx. It should return ‘Good’ as output in browser.

If you cannot get ‘Good’, then you stop here. Try to troubleshoot using logs in Webserver : C:\windows\temp\easyprocess_workfolder, Appserver : $EPRoot\$EnvName\Toolset\Logfiles folder or EASYProcess applications logs. If you are getting any error code, then look for error codes in easyprocess/troubleshooting folder.

Base Html Source/Base Script/Base CSS

EASYProcess website needs base html, scripts and css to run.

Base Html : Base Database/Table: EP_CMS_HtmlSource/Entity Id: Base. You can change base html source. You have to define a newid in config Website/Default/DefaultHtmlSource. And then created this id in App Database/EP_CMS_HtmlSource table.

Base Script and CSS: Base Database/EP_Contants/EP_HeaderInclude. If you want to change this, then you have to add this in your modified html source as defined above.

JS/CSS Includes

If you had custom JS/CSS include files in .master file before, you will need to add these to table EP_CMS_HeaderIncludes as below:

CSS File:

  • Brand :Base
  • Include Type: CSS
  • Path : example: ~/styles/custom.css
  • Media : all
  • Idx : (use this to order CSS include)
  • Active : True

JS File:

  • Brand :Base
  • Include Type: JS
  • Path : example: ~/scripts/custom.css
  • Idx : (use this to order CSS include)
  • Active : True

Powered by EASYProcess (© 2019 K-Rise Systems, Inc).