Employee Workspace Installation Manual

From SmartHCM Wiki
Jump to navigation Jump to search


Contents

Objective

This document describes all the installation process for SmartESS version 1.0 starting from scratch. This document covers all aspect of its installation including all various software needed and how to deploy the application in your machine.

About This Documentation

This preface discusses:

  • Understanding This Documentation
  • Audience
  • Comments and Suggestions

Understanding This Documentation

This documentation is designed to direct you through a basic SmartESS version 1.0 installation. It is not a substitute for the database administration documentation provided by your relational database management system (RDBMS) vendor, the network administration documentation provided by your network vendor.

Audience

This documentation is written for the individuals responsible for installing and administering the SmartESS environment. This documentation assumes that you have a basic understanding of the SmartESS system.

One of the most important components in the installation and maintenance of your SmartESS system is your on-site expertise.

You should be familiar with your operating environment and RDBMS and have the necessary skills to support that environment.

Comments and Suggestions

Your comments are important to us. We encourage you to tell us what you like, or what you would like changed about our documentation, SofDigital Online Help, and other reference and training materials. Please send your suggestions to: support@sofdigital.com While we cannot guarantee to answer every email message, we will pay careful attention to your comments and suggestions. We are always improving our product communications for you.

System Requirements

The system requirements for SmartESS application are:

  • Processor: Intel® Xeon® CPU E5430 @ 2.66GHz (2 processors)
  • Operating System:
    • Windows 2012 Server 64bit
    • Windows 2008 server R2 64bit
    • Windows 7 64bit
  • Installed Memory (RAM): 12GB
  • System Type: 64-bit Operating System

Software Installation Prerequisites

Following softwares must be installed before installing SmartESS applications:

.NET Framework 4.0

The Microsoft .NET Framework 4 re-distributable package installs the .NET Framework run time and associated files that are required to run and develop applications to target the .NET Framework 4.

File Name: dotNetFx40_Full_x86_x64.exe

Following link is available for installation guide of .NET Framework 4.0

[1]


SAP Crystal Reports Runtime Engine For .NET Framework 4 (32-bit)

SAP Crystal Reports runtime engine for .NET Framework 4 32-bit is a software program developed by SAP.

File Name: CRRuntime_32bit_13_0.msi

Following link is available to download SAP Crystal Reports Runtime Engine For .NET Framework 4 (32-bit)

[2]

Direct download Link: [3]

Oracle Database 11g 64 bit release 2 (11.2.0.1.0)

Oracle Database (commonly referred to as Oracle RDBMS or simply as Oracle) is an object-relational database management system produced and marketed by Oracle Corporation.

Oracle 12c Release 2 (12.1.0.1.2) is also compatible with SmartESS.

Following link is available to download and for installation guide of Oracle Database 11g 64 bit release 2 (11.2.0.1.0)

Make sure that Character set should be “Unicode Standard UTF8 AL32UTF8” while installation of Oracle Database.

Download: [4]

Installation Guide: [5]


Oracle Data Provider for .NET for 12c Release 2 (12.1.0.1.2)

Oracle Data Provider for .NET allows Oracle database to connect from .NET and makes using Oracle from .NET more flexible, faster, and more stable and take advantage of advanced Oracle database functionality.

Following link is available to download and for installation guide of Oracle Data Provider for .NET for Oracle 12c Release 2 (12.1.0.1.2).

[6]

Internet Information Services (IIS)

Internet Information Services (IIS) formerly called Internet Information Server is a web server application and set of feature extension modules created by Microsoft for use with Microsoft Windows. You don’t need to download anything for IIS because this feature is available in Microsoft windows server 2008 R2. You just need to Click Start -> All Programs -> Administrative Tools -> Server Manager -> Add Roles and Features and complete the installation. Following link is available for installation guide of Internet Information Services (IIS).

[7]

Post Installation Settings of Internet Information Services (IIS)

Some of the common settings are required after installing Internet Information Services (IIS).

  • Change .net framework version to 4.0 in IIS. Click on Application pool for SmartESS like DefaultAppPool and go to Basic Settings and change .net framework version to v4.0 and Managed pipeline mode to Integrated.
Error creating thumbnail: Unable to save thumbnail to destination





.

  • In the application pool section, Click on Application pool for SmartESS like DefaultAppPool and go to Advance Settings and change .net framework version to v4.0 and change Enable 32-bit application property to true.
Error creating thumbnail: Unable to save thumbnail to destination






.

Recommended Browsers

Recommended Browsers for SmartESS application are “Google Chrome” or “Mozilla Firefox”. Following links are available to download “Google Chrome” or “Mozilla Firefox” respectively.

[8]


Supporting Tools

Following software are not mandatory for completing the installation but it will help you to set some configuration and database queries etc:

PLSQL Developer

PL/SQL Developer is an Integrated Development Environment that is specifically targeted at the development of stored program units for Oracle Databases.

PL/SQL Developer will be used to connect to SmartESS database and access its Tables, Stored Procedures etc.

Following link is available to download PLSQL Developer

[9]

Product Installation

Following are the step by step solution to install SmartESS application.

Copy Published folder

First you need to copy the published folder to any path in the directories.

Error creating thumbnail: Unable to save thumbnail to destination


Upload Product to IIS

Following are two ways to upload our product SmartESS to IIS.

Add Website to IIS

Following are the step by step solution to create website in IIS.

Refer Section 4.5.1 Post Installation Settings of Internet Information Services (IIS) to set the configuration of Application Pool.

Start IIS and right click on “Sites” folder and click on “Add Web Site”.

Error creating thumbnail: Unable to save thumbnail to destination
Site Name

Following window will appear when we click on “Add Web Site”. Provide any Site name for the application like SmartESS. This site name will appear in the navigation panel of IIS.

Error creating thumbnail: Unable to save thumbnail to destination




.

Application Pool

When we add a new website, “Application Pool” will be created automatically. Although if we want to select already existing “Application Pool” then we can click on the Select… button and choose an existing application pool. Following window will appear when you click on Select… button.

SmartESS Installation 6.png




.

Physical Path

Provide physical path of the copied published folder. Following window will appear when we click browse button in “Content Directory” panel in Add Website window.

Error creating thumbnail: Unable to save thumbnail to destination





.

Binding Section

Following is the information provided in binding section.

  • Type : http
  • IP address : IP address of the web server
  • Port: Port for the application(already assigned port to another web site can’t be set here)

Add Application to IIS

Once you have created website in IIS you can add application to that website. Start IIS and right click on "Default Web Site" or any other website like SmartESS and select "Add Application" option. To add stand alone website for SmartESS see section 6.2.1 Add Website to IIS.

Error creating thumbnail: Unable to save thumbnail to destination





.

Alias Name

Following window will appear when you click on "Add Application". Provide any Alias name for the application like SmartESSTest.

File:SmartESS Installation 9.png





.

Application Pool

When we add a new application, “Application Pool” will be used from the main web site automatically. Although if we want to select other existing “Application Pool” then we can click on the Select… button and choose an existing application pool. Following window will appear when you click on Select… button.

File:SmartESS Installation 10.png





.

Physical Path

Provide physical path of the copied published folder. See the image from section 6.2.2.1 Alias Name for reference.


Configuration folder settings

Configuration folder is available in published folder. This folder is used for Company logos and icons.

Following is the snapshot for SmartESS configuration folder.

File:SmartESS Installation 11.png




.

Database connection settings in web.config

web.config file is used for adding assemblies references or 3rd party dynamic link libraries references. We can also use this file to make some application and database connections settings which can be used in application code.

We have used following settings in web.config file for database connection

File:SmartESS Installation 12.png




.

Import Database Dump

Following are the installation steps to import database dump in the Oracle Database 11g.

Installation Steps

Following are the steps to follow when creating database for SmartESS. First you need to start PLSQL Developer and login with System administrator user.

Case Sensitive Passwords

SEC_CASE_SENSITIVE_LOGON enables or disables password case sensitivity in the database. Run following command in PLSQL Developer.

ALTER SYSTEM SET SEC_CASE_SENSITIVE_LOGON = FALSE

Create Table Space

Create TABLESPACE in oracle database for SmartESS by using following command in “PL/SQL Developer”

CREATE TABLESPACE SMARTESS DATAFILE 'D:\Oracle11g\oradata\ora11g\SMARTESS.dbf' SIZE 1024M AUTOEXTEND ON NEXT 1024M MAXSIZE 10240M;

Create User

Create user “SMARTESS” by using following command in PLSQL Developer CREATE USER SMARTESS IDENTIFIED BY SMARTESS DEFAULT TABLESPACE SMARTESS;

Give Rights to SMARTESS user

Give rights to SMARTESS database user by using following command in PLSQL Developer.

GRANT CONNECT, RESOURCE TO SMARTESS;

Create ORACLE_DUMP Directory

Create ORACLE_DUMP Directory in Oracle database user by using following command in PLSQL Developer.

CREATE DIRECTORY ORACLE_DUMP AS 'C:\ORACLE_DUMP';

Give Rights to SMARTESS user on ORACLE_DUMP Directory

Give rights to SMARTESS user on ORACLE_DUMP directory by using following command in PLSQL Developer.

GRANT READ, WRITE ON DIRECTORY ORACLE_DUMP to SMARTESS;


Create TOM_FILE Directory

Create TOM_FILE Directory in Oracle database user by using following command in PLSQL Developer.

CREATE DIRECTORY TOM_FILE AS '… SMARTESS\CONFIGURATION';

Note: define “CONFIGURATION” folder path exists in SmartESS project folder.

Give Rights to SMARTESS user on TOM_FILE Directory

Give rights to SMARTESS user on TOM_FILE directory by using following command in PLSQL Developer.

GRANT READ, WRITE ON DIRECTORY TOM_FILE to SMARTESS;

Copy SMARTESS database dump into Directory

Copy SMARTESS database dump into 'C:\ORACLE_DUMP'

Import Database Dump

Following steps should be followed for importing database dump. Run Command Prompt with “Run as Administrator”.

Import SMARTESS database dump by using following command in Command Prompt IMPDP SYSTEM/PASSWORD REMAP_SCHEMA=SMARTESS:SMARTESS DIRECTORY=ORACLE_DUMP DUMPFILE=SMARTESS.DMP LOGFILE=SMARTESS_EXPORT.LOG TRANSFORM=oid:n

If this command ask for user name while you have provided correct username and password and you get following error message in importing dump “ORA-28547: connection to server failed, probable Net8 admin error” “UDI-28547: operation generated oracle error”

Then check the sqlnet.ora (exists in same folder in which tnsnames.ora exists). And change the following entry and try. Original entry ------ SQLNET.AUTHENTICATION_SERVICES = (NTS) Modified entry ------ SQLNET.AUTHENTICATION_SERVICES = (NONE) And then run IMPDP command again and then Connect with SMARTESS user in PLSQL Developer.

Compile Invalid Objects

Compile Invalid Objects is the option available in PLSQL Developer. You just need to start PLSQL Developer and use the “Compile Invalid Objects” in the tools menu to compile invalid objects. See the snapshots.

File:SmartESS Installation 13.png




. We will see the following window when we click “Compile Invalid Objects” in the tools menu. In this window we will see all the objects likes procedures and functions that have errors. See the snapshots.

File:SmartESS Installation 14.png




. We need to compile all the invalid objects and remove the errors to complete the installation.


SMS Configuration

Connect as System or Sys User in Database and issue the following commands.

BEGIN 

 DBMS_NETWORK_ACL_ADMIN.CREATE_ACL(acl         => 'sms.xml',
                                   description => 'SMS Gateway ACL',
                                   principal   => 'SMARTHCM',
                                   is_grant    => true,
                                   privilege   => 'connect');
  DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(acl       => 'sms.xml',
                                      principal => 'SMARTHCM',
                                      is_grant  => true,
                                      privilege => 'resolve'); 
   DBMS_NETWORK_ACL_ADMIN.ASSIGN_ACL(acl  => 'sms.xml',
                                   host => 'www.jawalbsms.ws');
   COMMIT;

END; /


Note:

  • Where “host” is the SMS Service Provider
  • Where “principal” is the Schema / Database Username where import the database
  • To verify the above script is successfully executed

SELECT * FROM dba_network_acl_privileges; SELECT * FROM dba_network_acls; SELECT utl_http.request('www.jawalbsms.ws') FROM dual; (where 'www.jawalbsms.ws' is the service provider URL)


Email Configuration

Connect as Sys User in Database and issue the following commands. GRANT EXECUTE ON UTL_HTTP to SMARTHCM; GRANT EXECUTE ON UTL_TCP to SMARTHCM; GRANT EXECUTE ON UTL_SMTP to SMARTHCM; GRANT EXECUTE ON UTL_INADDR to SMARTHCM;


BEGIN 

 DBMS_NETWORK_ACL_ADMIN.create_acl (
   acl          => ‘email.xml', 
   description  => 'The ACL functionality for Email',
   principal    => 'SMARTHCM',
   is_grant     => TRUE, 
   privilege    => 'connect',
   start_date   => SYSTIMESTAMP,
   end_date     => NULL);
 COMMIT;
 DBMS_NETWORK_ACL_ADMIN.add_privilege ( 
   acl         => ' email.xml', 
   principal   => 'SMARTHCM',
   is_grant    => TRUE, 
   privilege   => 'connect', 
   position    => NULL, 
   start_date  => NULL,
   end_date    => NULL);
 COMMIT;
 DBMS_NETWORK_ACL_ADMIN.assign_acl (
   acl         => ‘email.xml',
   host        => '192.16.1.*', 
   lower_port  => 25,
   upper_port  => NULL); 
 COMMIT;

END; /


Note:

  • Where “host” is the IP of the Email Server (‘*’ means auto find the specific email server)
  • Where “principal” is the Schema / Database Username where import the database
  • To verify the above script is successfully executed

SELECT * FROM dba_network_acl_privileges; SELECT * FROM dba_network_acls;

Troubleshooting

Following are the solution of possible errors that can occur after installation.

Credential Retrieval Failed

If you get error message "ORA-12638 credential retrieval failed" then check the sqlnet.ora (exists in same folder in which tnsnames.ora exists) and change the following entry and try.

Original entry ------ SQLNET.AUTHENTICATION_SERVICES = (NTS) Modified entry ------ SQLNET.AUTHENTICATION_SERVICES = (NONE)

Domain Network Firewall

If you found problem to load login page then turn off Domain networks Firewall in Windows Server and try again.

Server Error in Application

If you found following error (see snapshot) then register IIS with the following command on DOS prompt. C:\Windows\Microsoft.NET\Framework64\v4.0.30319> aspnet_regiis –i

File:SmartESS Installation 15.png





Retrieving the COM Class Factory Error

If you found following error (see snapshot) then rename the files with name “cryptocme2.dll” and “cryptocme2.sig” to “cryptocme2 .dll” and “cryptocme2 .sig” respectively on the following directory.

C:\Program Files (x86)\SAP BusinessObjects\Crystal Reports for .NET Framework 4.0\Common\SAP BusinessObjects Enterprise XI 4.0\win32_x86

File:SmartESS Installation 16.png





.

Conclusion

I welcome feedbacks, queries, and suggestions from the readers so that I can improve it further and get some benefit out of it. Your inputs, clarifications, and feedback in this regard would be highly appreciated.

Retrieved from "https://wiki.smarthcm.com/index.php?title=Employee_Workspace_Installation_Manual&oldid=627"