Download as pdf or txt
Download as pdf or txt
You are on page 1of 116

Installation Guide

SE Suite 2.1 - Windows

DT21.E N 0003
Rev 00
SoftExpert Excellence Suite (SE Suite) is the most comprehensive corporate solution for integrated
management of excellence and business compliance.

SoftExpert Excellence Suite (SE Suite) offers a set of multilingual modules that are natively integrated and
fully Web-based to automate the processes required to improve and optimize the different business areas at
organizations. This boosts the quality of management, cuts operating costs and facilitates compliance with
the main market norms and regulations.

The solution also supplements and enhances the use of corporate management systems and is integrated
with main market ERPs through connectors that may be developed based on the company’s specific needs.

The information contained herein is subject to change without notice. If you find inconsistent information,
please report it in writing to our support.

The entire risk of the use or the results from the use of this document remains with the user. Unless
otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people,
places, and events depicted in examples herein are fictitious. No association with any real company,
organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be
inferred.

C omplying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under
copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or
transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or
for any purpose, without the express written permission of SoftExpert.

SoftExpert may have patents, patent applications, trademarks, copyrights, or other intellectual property
rights covering subject matter in this document. Except as expressly provided in any written license
agreement from SoftExpert, the furnishing of this document does not give you any license to these patents,
trademarks, copyrights, or other intellectual property.

This software and documentation may provide access to or information on content, products, and services
from third parties. SoftExpert is not responsible for and expressly disclaim all warranties of any kind with
respect to third-party content, products, and services. SoftExpert will not be responsible for any loss, costs,
or damages incurred due to your access to or use of third-party content, products, or services.

C opyright © 2019 SoftExpert Software SA. All rights reserved.


Table of Contents
Chapter 1 - Introduction
.................................................................................................................................... 5
Chapter 2 - Installation overview
.................................................................................................................................... 6
2.1 - Installation plan
.................................................................................................................................... 7
Chapter 3 - Pre-required activities
.................................................................................................................................... 8
3.1 - SE Suite....................................................................................................................................
update 9
3.2 - Network....................................................................................................................................
configuration 10
3.3 - E-mail server configuration
....................................................................................................................................11
3.4 - Windows....................................................................................................................................
configuration 12
3.4.1 - User creation on Windows Server
....................................................................................................................................13
3.4.2 - Java JRE installation
....................................................................................................................................15
3.4.3 - IIS....................................................................................................................................
installation 17
3.4.4 - Apache Tomcat installation
....................................................................................................................................18
3.5 - Database configuration
....................................................................................................................................20
3.5.1 - Microsoft SQL Server
....................................................................................................................................21
3.5.2 - Oracle
....................................................................................................................................24
3.5.3 - PostgreSQL
....................................................................................................................................31
Chapter 4 - Installation activities
....................................................................................................................................40
4.1 - Installation packages preparation
....................................................................................................................................41
4.2 - SE Suite....................................................................................................................................
installation 42
4.3 - System configuration
....................................................................................................................................45
4.3.1 - SSL configuration
....................................................................................................................................46
4.3.2 - Java Security Extension package
....................................................................................................................................47
4.3.3 - Database configuration
....................................................................................................................................48
4.3.4 - Starting the services
....................................................................................................................................53
Chapter 5 - Deletion activity
....................................................................................................................................54
Chapter 6 - Additional procedures
....................................................................................................................................55
6.1 - Post-installation activities
....................................................................................................................................56
6.1.1 - SE....................................................................................................................................
Risk conversion 60
6.2 - Test and....................................................................................................................................
production environment 64
6.3 - Single Sign-On with AD
....................................................................................................................................66
6.4 - FileManager server
....................................................................................................................................67
6.5 - Scale service (SE Asset)
....................................................................................................................................75
6.6 - PDF conversion
....................................................................................................................................76
6.6.1 - OpenOffice PDF conversion service
....................................................................................................................................77
6.6.2 - Conversion to PDF with Microsoft Office
....................................................................................................................................79
6.7 - Workstations configuration
....................................................................................................................................81
6.7.1 - Internet Explorer configuration
....................................................................................................................................82
6.7.2 - Firefox configuration
....................................................................................................................................84
6.7.3 - OpenOffice automation
....................................................................................................................................85
6.7.4 - MSI installation
....................................................................................................................................86
6.8 - Remote ....................................................................................................................................
access configuration 87
6.9 - External....................................................................................................................................
access configuration 88
6.10 - Enable....................................................................................................................................
CURL in PHP 90
6.11 - Starting....................................................................................................................................
and stopping the services 91
6.12 - Troubleshooting
....................................................................................................................................95
6.12.1 - Requirements check
....................................................................................................................................96
6.12.2 - Index server
....................................................................................................................................
101
6.12.3 - System version
....................................................................................................................................
105
6.12.4 - Single Sign-On
....................................................................................................................................
106
6.12.5 - Outlook configuration
....................................................................................................................................
108
6.13 - Environment vulnerability
....................................................................................................................................
112
6.14 - Database - Good practices
....................................................................................................................................
114
Chapter 7 - Document history
....................................................................................................................................
115
Introduction 5

Chapter I

Introduction
The installation should be performed by IT professionals knowledgeable about Windows Server, network
infrastructure, and database. In addition to that, it should be in accordance with the requirements
defined in the "SE Suite - System Requirements" document.

All efforts were made to offer complete installation instructions. New versions of this guide will be
distributed periodically. Check for new available versions.

About this document


This document applies to SE Suite Installer TOOL-2.0 and SE Suite 2.1 or higher. It describes all the
procedures required for installing SE Suite on a Windows environment.

Who should read this document


Any IT professional who needs to know the process of installing SE Suite on a Windows environment, for
the planning of either implementation or support activities.

ATTENTION

Although providing support for recent versions of third-party software packages and patches, SoftExpert has no
control over those software updates and, thus, cannot ensure compatibility with their products. In any case,
contact the supplier for product specifications and further details about compatibility.

Installation Guide — SE Suite 2.1 - Windows


Installation overview 6

Chapter II

Installation overview
This topic covers the installation process overview. See below the diagram that exemplifies the steps
that will be covered in this documentation:

SE Suite installation steps diagram

§ Pre-required activities: This step covers all activities that must be performed and completed prior to
the SE Suite installation, as they include preparation activities for the environment where SE Suite will
be installed, as well as the installation of third-party software required by SE Suite.

§ Installation activities: This step covers the preparation activities of the installation packages and the
installation itself. In the package preparation step, the installer package, which must be unpacked, and
the installation package, must be saved in an unzipped folder of the installer. After preparing the
packages, it will be possible to execute the SE Suite installation. When executing the installer, it will
allow installing, updating, and removing SE Suite. When you select the installation option, the
installation tool will check whether the environment meets the pre-defined installation requirements. in
case any errors occur, it is possible to view the error screen by double-clicking on the step that
presents the error. After that, the installer will ask for the necessary information to configure IIS. The
installer will extract the files and install the complementary tools. During the installation, the system
will ask for the data to add the database(s). At the end of the installation, the services will be
restarted and it will be necessary to configure SE Suite.

§ Additional procedures: This step contains the activities that are executed after installing SE Suite.
Among them, find the post-installation activities that include the SE Suite initial configuration and
activation. Find also in this step the configurations of some SE Suite functions, such as the directory
service configuration on an external server. The workstation configuration activities must be performed
in the browsers that will access SE Suite, such as unblocking SE Suite domain pop-ups and the
configurations in the browsers to use single sign-on.

Installation Guide — SE Suite 2.1 - Windows


Installation overview 7

2.1 - Installation plan


1. Refer to the SE Suite - System architecture overview document to define the architecture to be
used by SE Suite in your environment.

2. Refer to the SE Suite - System requirements document to define the installation environment, as
well as determine which third-party software is compatible and which are required for the
installation and proper execution of the SE Suite. All information contained in this document
assumes you have met all requirements.

3. Revise and perform all pre-required activities: Network Configuration, Windows Configuration and
Database Configuration, so that the environment can be prepared for the SE Suite installation to
run.

4. Familiarize yourself with the tasks to be executed when configuring SE Suite by reading the
following topics:

§ Installation activities

§ Post-installation activities

§ Workstations configuration

5. For better planning of the SE Suite installation in your environment, see below whom the activities
are usually assigned to:

§ Activities to be executed by the network and operating system manager:

o Network configuration

o Windows configuration

§ Activities to be executed by the database manager:

o Database configuration

§ Activities to be executed by the e-mail manager:

o E-mail server configuration

The documentation mentioned above may be found at the Customer center.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 8

Chapter III

Pre-required activities
The activities in this section describe how to prepare the environment for the SE Suite installation. Do
not start the installation step until all relevant prerequisites have been met and all activities in this
section have been executed.

This section covers the following topics:

§ SE Suite update

§ Network configuration

§ E-mail server configuration

§ Windows configuration

§ Database configuration

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 9

3.1 - SE Suite update


Considering the major requirement changes incorporated into SE Suite versions 2.0 and 2.1, compared to
version 1.3, we suggest installing version 2.1 on a new server on which version 1.3 was never installed.
Such procedure will allow the use of new Tomcat and Java versions, and other requirements
automatically installed by the installation process.

However, if the organization wishes to use the same server, version 1.3 must be previously removed,
using the 1.3 version removal tool, in addition, the following steps must be executed manually:

1. Open the ISS administration console. To do that, click the Start menu and type "inetmgr", or
access the Administrative tools in the Control panel, and double-click "Internet Information
Services".

2. Select the server where version 1.3 was installed and, on the right page, open the FastCGI
settings option.

3. Select in the list the PHP used by SE Suite 1.3 and remove it through the action panel, located on
the right side.

4. Go back to the home page, selecting the server where version 1.3 was installed, and, on the right
page, open the ISAPI and CGI Restriction option.

5. Select the "seredirect" item and remove it using the action panel located on the right side.

6. Select the server where version 1.3 was installed, select the site created, and remove it. If you
wish to use the same site, check, in the SE Suite installation section, the "Website" configuration,
in item 7. Note that the HTTPS port must be set for the SSL configuration.

7. Uninstall Tomcat version 6, because, in SE Suite version 2.1, Tomcat version 6 is no longer
supported. For further details, Refer to the SE Suite - System requirements document.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 10

3.2 - Network configuration


The requirements of this activity refer to the network where SE Suite will be installed.

Configure the network

Synchronize the time and date on all servers. The system users may have trouble if one or more servers
are not synchronized with the rest of the system.

In version 2.1, the use of HTTPS to increase security while using the solution is mandatory. We suggest
the use of a valid digital certificate, issued by certifying authorities. If the organization has no available
valid digital certificate, a certificate self-signed by IIS may be generated; however, security warnings
may be issued to the users while using SE Suite.

SE Suite supports multiple databases. To configure this functionality, create a different DNS for each
connection with the database, pointing to the same webserver. There should be a DNS pointing to the
same webserver for each connection with the database.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 11

3.3 - E-mail server configuration


Create an e-mail account to be used to configure the sending of to-do task e-mails for SE Suite to be
able to send such e-mails to the final user. The necessary information includes:

§ E-mail account name;

§ E-mail account password;

§ E-mail server name;

§ Port to the e-mail server (if the SMTP protocol is being used).

These configurations must be executed by the e-mail manager.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 12

3.4 - Windows configuration


This section covers the necessary configurations for the environment to be prepared for the SE Suite
installation execution. See, in the topics below, how to proceed to create a user and install and
configure the main SE Suite dependencies:

§ User creation on Windows Server

§ Java JRE installation

§ IIS installation

§ Apache Tomcat installation

This installation guide covers only the requirements to install SE Suite. Refer to the "SE Suite - System
Requirements" document to verify the other requirements that should be on the SE Suite server for the system to
work correctly.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 13

3.4.1 - User creation on Windows Server


SE Suite needs a local user. To create it on Windows Server 2008 or 2012, execute the following steps:

1. Click on the Windows Start menu. Then, right-click on the My computer button and click on the
Manage option;

2. On the left side, in the hierarchical tree, find Local Users and Groups;

§ On the Windows Server 2008, go to Server Manager Configuration Local Users and Groups;

§ On Windows Server 2012, go to Server Manager Tool Computer Management Local Users and
Groups;

3. Expand Local Users and Groups and right-click the Users folder;

4. Click the New user... option. Fill in the following fields on the screen that will be displayed:

§ User name: Fill this field in with the name of the user being created;

§ Full name: Fill this field in with the full name of the user being created;

§ Description: Enter in this field a description for the user being created;

§ Password: Enter a password for the user;

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 14

§ Confirm password: Retype the password to confirm it;

§ User must change password at next logon: Uncheck this option, if checked;

§ User cannot change password: Check this option;

§ Password never expires: Check this option.

§ The maximum size for the user name (User name field) is 20 characters (uppercase or lowercase), except
for the following characters: \ / " [ ] : | < > + = ; , ? * @. The name may not contain periods (.) or blank
spaces either.

§ It is not allowed using characters | and & in the user password.

6. After filling in the required fields, click Create and then on Close;

7. Right-click the newly created user and select Properties;

8. On the user properties screen, select the Member Of tab;

9. Click Add;

10. On the Select Groups screen, click Advanced;

11. Click Find Now. At this point, a list of groups will be displayed in the search results section;
search for and select the Guests and IIS_IUSRS groups, and click on OK;

12. The group selection screen will look similar to the image below, click OK on this screen:

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 15

3.4.2 - Java JRE installation


To install Java JRE, execute the following steps:

1. Download Java from: http://www.java.com; If the OpenJDK version of Java, which does not need
licensing, will be used, download it from: https://adoptopenjdk.net/;

Refer to the SE Suite - System Requirements document to check the Java version.

2. Execute the Java installation file and proceed with the installation;

JAVA_HOME environment variable configuration


3. After installing Java, click on the Windows Start menu;

4. Right-click on My Computer and select Properties;

5. Select the Advanced tab and click on Environment;

6. In System Variables, click on New;

7. On the New System Variable screen, fill in the following fields:

§ Variable name: Enter JAVA_HOME;

§ Variable value: Enter the JAVA directory, for example: C:\Program Files\Java\jre8

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 16

8. Click on OK;

9. In the System Variables list, select Path and click Edit;

10 In the Variable value field, type: %JAVA_HOME%\bin before the first instruction, as shown in the
image below:

11. Click on OK;

12. Click on OK to close the Environment variables window.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 17

3.4.3 - IIS installation


To install IIS, execute the following steps:

1. Open the Server Manager and add the features to IIS:

§ On Windows Server 2008: Right-click on Roles (panel on the left side) and select the "Add
Roles" option. Go to the "Installation type" screen. Select the "Role based or feature..." option
and advance. Select the server.

§ On Windows Server 2012: Click Manage (at the top right of the screen) and select the "Add
Roles and Features" option.

2. Check the "Web server (IIS)" option with the following items enabled:

Web Server (IIS)

Web Server

C ommon HTTP Features

Static C ontent

Default Document

HTTP Errors

HTTP Redirection

Security

Basic Authentication

Application Development

ISAPI Extensions

ISAPI Filters

C GI

Performance

Static C ontent C ompression

Dynamic C ontent C ompression

Management Tools

IIS Management C onsole

IIS Management Scripts and Tools

3. Click Next on the other screens of the installer and wait for the installation to finish.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 18

3.4.4 - Apache Tomcat installation


To install Apache Tomcat, execute the following steps:

1. Download Apache Tomcat from the site: http://tomcat.apache.org.

Refer to the SE Suite - System Requirements document to check the Apache Tomcat version.

Make sure Java is installed before starting the Tomcat installation since Java JRE is a prerequisite for
Tomcat to operate.

2. Execute the Tomcat installation file.

3. Select Normal type for installation.

4. Choose a directory for the installation or keep the default path.

5. Enter a password or leave this field empty.

6. Select the path Java was installed in your system, for example: C:\Program
Files\Java\jre1.X_XX.

7. Uncheck the Run Apache Tomcat option and click Finish.

Apache Tomcat service configuration


8. Access the Windows Start Run menu.

9. Type services.msc and click OK.

10. Right-click on the Apache Tomcat service.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 19

11. Select Properties.

12. In Startup type, select Automatic and click OK.

Verifying the memory available for Apache Tomcat


13. Access Tomcat Monitor.

14. At this point the Tomcat Setup screen is displayed, go to the Java tab and configure the values of
the following fields:

Java Options: At the end of this field add the following parameters, in case they do not exist:
-Duser.language=en
-Duser.country=US

Initial memory pool: 1024MB

Maximum memory pool: 2048 MB

The values entered above are the minimum necessary for SE Suite to work correctly.

15. Click OK.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 20

3.5 - Database configuration


See in this section how to configure the database server. This section covers the database creation and
configuration, necessary for SE Suite to work in the following DBMSs:

§ Microsoft SQL Server

§ Oracle

§ PostgreSQL

ATTENTION

§ SoftExpert is not responsible for the database management.

§ The configurations must be executed by the Database administrator.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 21

3.5.1 - Microsoft SQL Server


This section covers the procedure to create and configure the database in the SQL Server. See the
steps below:

Refer to the SE Suite - System Requirements document for more details on SQL Server considerations.

This procedure assumes that SQL Server is properly installed.

1. Open SQL Server Management Studio.

2. Connect to the server.

3. Right-click on Databases and then click on New Database.

4. On the left side, on the General page, enter a name in Database name.

Example: sesuite

5. On the left side of the Options page, choose the 'collation' to be used and click OK.

The collations that may be used in western languages for the SE Suite database on the SQL Server are:

§ SQL_Latin1_General_CP1_CI_AS

§ SQL_Latin1_General_CP1_CI_AI

§ Latin1_General_CI_AS

§ Latin1_General_CI_AI

The CI (Case Insensitive) parameter of the collation must always be used. We recommend the use of the
AI (Accent Insensitive) parameter for new databases starting in 2.0. For eastern languages, contact
SoftExpert's Support.

6. In the hierarchical tree, expand the Security item.

7. Right-click on the Logins button.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 22

8. Click on New Login.

9. On the left side of the General page, in the Login name, enter a name for the login.

Example: sesuite

10. Check the SQL Server authentication option.

11. In Password enter a password and confirm it in Confirm password.

12. Uncheck the Enforce password policy option.

13. In Default database, select the database created in steps 3 to 5.

14. In Default language, select the English language.

15. Click on the User Mapping page and, in Users mapped to this login, select a database created
from steps 3 to 5.

16. In the Database Role membership box, check the following options:

§ Public;

§ db_owner.

17. Click on OK.

Network configuration
It is necessary to enable the TCP/IP connections in SQL Server Configuration Manager. See the steps
below:

18. Open SQL Server Configuration Manager;

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 23

19. In the hierarchical tree, expand the SQL Server <version> Network Configuration item.

20. Click on Protocols for MSSQLSERVER.

21. In the box on the right side, right-click on TCP/IP.

22. Click on Properties.

23. On the Protocol tab, in Enable, select the Yes value.

24. Access the IP Addresses tab.

25. In each existing IP, in Enable, select the Yes value.

26. In each existing IP, check whether the port defined in TCP Port is 1433.

27. Click OK and then restart the SQL Server.

If you do not need to configure another database, continue with the SE Suite installation from the
Installation activity section.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 24

3.5.2 - Oracle
This section will cover the Oracle configuration. It will also cover the Oracle client configuration. This
section contains the following topics:

Oracle configuration

Oracle Client configuration

Refer to the SE Suite - System Requirements document for more details on Oracle considerations.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 25

3.5.2.1 - Oracle configuration


This section covers the procedure to create and configure databases in Oracle. See the steps below:

This procedure assumes that Oracle is installed, with created instances, and that TNSNames is duly configured on
the server where SE Suite will be installed.

This procedure requires the Oracle Provider and OJDBC components to be installed on the server where SE Suite
will be installed.

1. Start SQLPlus.

2. Connect to the server using a DBA user.

Creating the tablespaces

3. Create a tablespace called SOFTEXPERT_DATA:

CREATE TABLESPACE SOFTEXPERT_DATA LOGGING DATAFILE


'<tablespaces_directory>\SOFTEXPERT_DATA.DBF' SIZE 2000M AUTOEXTEND ON NEXT 200M
MAXSIZE UNLIMITED;

Substitute the <tablespaces_directory> for the path where the tablespace must be created on the
Oracle server.

2000M is the initial size recommended for the data tablespace.

4. Create a tablespace called SOFTEXPERT_INDEXES:

CREATE TABLESPACE SOFTEXPERT_INDEXES LOGGING DATAFILE


'<tablespaces_directory>\SOFTEXPERT_INDEXES.DBF' SIZE 200M AUTOEXTEND ON NEXT
50M MAXSIZE UNLIMITED;

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 26

Substitute the <tablespaces_directory> for the path where the tablespace must be created on the
Oracle server.

200M is the initial size recommended for the indexes tablespace.

Creating a user for SE Suite

5. To create a user for SE Suite and define the necessary permissions, execute the following steps:

6. Create a user for SE Suite:

CREATE USER <SESUITE> PROFILE DEFAULT IDENTIFIED BY <PASSWORD> DEFAULT


TABLESPACE SOFTEXPERT_DATA ACCOUNT UNLOCK;

Substitute <SESUITE> and <PASSWORD> for the user's name and password respectively.

7. Define the necessary Grants for the user created in step 5:

ALTER USER <user> QUOTA UNLIMITED ON SOFTEXPERT_DATA;


ALTER USER <user> QUOTA UNLIMITED ON SOFTEXPERT_INDEXES;
GRANT CREATE SESSION TO <user>;
GRANT CREATE TABLE TO <user>;
GRANT CREATE VIEW TO <user>;
GRANT CREATE SEQUENCE TO <user>;
GRANT CREATE PROCEDURE TO <user>;
GRANT CREATE TRIGGER TO <user>;

8. Exit the SQLPlus.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 27

9. Click the Windows Start menu.

10. Right-click on My Computer and select Properties.

11. Select the Advanced tab and click on Environment.

12. In System Variables, click on New.

13. Fill in the Variable Name field with NLS_LANG.

14. Open SQLPlus.

15. Type in the following commands to return the NLS parameters:

§ VALUE1:

SELECT VALUE FROM NLS_SESSION_PARAMETERS WHERE PARAMETER = 'NLS_LANGUAGE';

§ VALUE2:

SELECT VALUE FROM NLS_SESSION_PARAMETERS WHERE PARAMETER = 'NLS_TERRITORY';

§ VALUE3:

SELECT VALUE FROM NLS_DATABASE_PARAMETERS WHERE PARAMETER = 'NLS_CHARACTERSET';

16. Fill in the Variable Value field with the information returned by the SQLPlus in the order of the
previous step: VALUE1_VALUE2.VALUE3

Example: AMERICAN_AMERICA.WE8MSWIN1252

17. Click on OK.

18. Click on OK to close the System properties screen.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 28

19. Exit the SQLPlus.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 29

3.5.2.2 - Oracle Client configuration

ATTENTION

§ For the proper operation of the application, 2 Oracle clients must be installed on the SE Suite server. A 64-bit
version for Java operation and a 32-bit version for PHP operation.

§ If the 32-bit Oracle Client is installed first and the 64-bit Oracle Client is installed later, the environment
variables must be configured correctly, otherwise, it will be necessary to configure them again. Note that, after
the installing the 32-bit Client there will probably be a service in execution, this will make it impossible to
install the 64-bit Client. To do that, it is necessary to stop the OracleRemExecServiceV2 service.

§ In the PATH variable on Windows, the 64-bit Client must be first, then the 32-bit Client.

Run the following configuration to make sure that the Path variable is configured correctly:

1. Click the Windows Start menu.

2. Right-click My Computer and select Properties.

3. Select the Advanced tab and click on Environment.

4. In the System Variables, locate the variable of the Path environment and click Edit.

5. In the Variable value field, add the Oracle Client 64-bits and the Oracle 32-bits path. In that
case, the 64-bit Oracle Client path must be the first parameter and the 32-bit Oracle Client must
be the second parameter, as shown in the image below:

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 30

6. Click on OK and then click on OK to close the System properties screen.

7. Now it is necessary to configure the 64-bit Oracle Client and 32-bit Oracle installations. To do
that, click on the Windows Start menu, type regedit.exe and press ENTER.

8. Locate and edit the following registry key:

§ Key: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ORACLE\KEY_OraClient11g_home1

§ Record: ORACLE_HOME_KEY

§ Original Value: SOFTWARE\ORACLE\KEY_OraClient11g_home1

§ Correct Value: SOFTWARE\Wow6432Node\ORACLE\KEY_OraClient11g_home1

Only the path should be adjusted, by inserting "Wow6432Node", leaving the rest as it is.

9. Click OK to save the change.

If it is not necessary to configure another database, continue with SE Suite installation from the Installation
activity section.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 31

3.5.3 - PostgreSQL
This section covers the procedures for creating and configuring the database for PostgreSQL DBMS.
First, it will present the PostgreSQL and pgAdmin III installation procedures.

Refer to the SE Suite - System Requirements document for more details on PostgreSQL considerations.

To use the SE Capture index service, after installing PostgreSQL, it will be necessary to install PostgreSQL Native
OLEDB Provider (pgoledb.msi) on the SE Suite server. After the installation, update the PATH environment
variable with the PostgreSQL Native OLEDB Provider installation directory.

Installing PostgreSQL

To install PostgreSQL, follow the steps below:

1. Download PostgreSQL from the site: http://www.postgresql.org.

2. Execute the PostgreSQL installation file.

3. On the Welcome to the PostgreSQL Setup Wizard screen, click on Next.

4. In Installation Directory, choose a directory for the installation or keep the default path.

5. In Data Directory, enter the directory where the data will be stored. Click on Next.

6. Enter a password for the superuser of the database and the service account (postgre). Click on
Next.

7. Enter the port where the service is listening on. Click on Next.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 32

8. Use the default locale. Click on Next.

9. On the Read to install screen, click on Next.

10 Uncheck the Launch Stack Builder at exit option.

11. Click on Finish.

Installing pgAdmin III

To install pgAdmin III, execute the following steps:

This procedure must be performed on the server where SE Suite will be installed.

12. Download pgAdmin III from the site: http://www.pgadmin.org/download.

13. Execute the installation file and follow the software instructions.

14. Open pgAdmin III.

15. Click on the Add a connection to a server button to add a connection to the database server.

16. In name, enter the connection name.

17. Enter the name of the database server host.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 33

18. In Port, enter the PostgreSQL port. The default port is 5432.

19. Select the database for connection.

View all the databases only after the first connection.

20. Enter the user name and password.

21. Click on OK.

Configuring the PostgreSQL network

This section covers the procedure to create and configure the database in PostgreSQL. To configure
the PostgreSQL Network, execute the following steps:

22. Access the PostgreSQL directory that contains the configuration files.

Example: C:\Program Files\PostgreSQL\8.x\data

23. Open the pg_hba.conf configuration file for editing.

24. Locate the 'IPv4 local connections' configuration block and add a new line with the network data
of the server where SE Suite is being installed:

# IPv4 local connections:


host all all 127.0.0.1/32 md5
host all all 192.168.200.55 255.255.255.0 md5

25. The configuration of this file can also be performed by pgAdmin III (File open pg_hba.conf
,menu), as shown in the following image:

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 34

26. Save and close the configuration file.

27. Open the postgresql.conf configuration file for editing:

28. Locate the listen_addresses parameter and change its value as shown below:

listen_addresses = '*' # what IP address(es) to listen on;

29. The configuration of this file can also be performed by pgAdmin III (File open pg_hba.conf
menu), as shown in the following image:

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 35

30. Save and close the configuration file.

31. Restart the PostgreSQL service.

Creating the Tablespace folders

To create the Tablespace folders, execute the following steps:

32. Access the PostgreSQL directory where the folders will be created or use the PostgreSQL default
Data folder.

Example: C:\Program Files\PostgreSQL\8.x\data

33. In the selected directory, create a new folder named SOFTEXPERT_DATA.

Example: C:\Program Files\PostgreSQL\8.x\data

34. In the selected directory, create a new folder named SOFTEXPERT_INDEXES.

Example: C:\Program Files\PostgreSQL\8.x\data

35. Right-click on the upper-level folder.

Example: C:\Program Files\PostgreSQL\8.x\data

36. Select Properties.

37. Select the Security tab.

38. Select the PostgreSQL service user.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 36

39. Set Full Control permission in the Allow column for this user.

40. Click on OK.

Creating a user for SE Suite

To create a user, execute the following steps:

41. Open the pgAdmin III assistant.

42. On the left side, in the Object Browser menu, select the default server and connect to it.

43. Right-click on Login Roles and select New Login Role.

44. On the New Login Role screen, on the screen that will be displayed, fill in the following fields:

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 37

§ Role name: Enter a name for the new user.

§ Password: Enter the password for the new user.

§ Password (again): Retype the password to confirm it.

§ Account expires: If necessary, enter an expiration date for the account being created.

45. Still, on the user creation screen, access the Role privileges tab and select Superuser.

46. Click on OK.

Creating Tablespaces

To create a Tablespace, execute the following steps:

47. Right-click on Tablespaces.

48. Select New Tablespace and fill in the following fields on the screen that will be displayed:

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 38

§ Name: Type SOFTEXPERT_DATA for the tablespace name.

§ Location: Enter the directory for the SOFTEXPERT_DATA tablespace folder. Example: C:
\Program Files\PostgreSQL\8.x\data\SOFTEXPERT_DATA.

§ Owner: Select the user created for SE Suite. Example: sesuite.

49. Still on the tablespace creation screen, access the Privileges tab.

50. Select the CREATE option and click on Add/Change.

51. Click on OK.

Repeat this process to create the SOFTEXPERT_INDEXES tablespace.

Creating databases

To create a database, execute the following steps:

52. Right-click on Databases.

Installation Guide — SE Suite 2.1 - Windows


Pre-required activities 39

53. Select New Database and, on the screen that will be opened, fill out the following fields:

§ Name: Enter a name for the database.

§ Owner: Select the user previously created for the SE Suite.

§ Encoding: Select UTF8.

§ Tablespace: Select SOFTEXPERT_DATA to be the default tablespace.

The recommended database encoding is UTF-8 because it supports all languages.

54. Still, on the database creation screen, access the Privileges tab and select ALL.

55. Click on Add/Change.

56. Click on OK.

57. Close pgAdmin III.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 40

Chapter IV

Installation activities
This section will cover the obtainment and preparation of the packages required to install SE Suite and
the system. This section contains the following topics:

§ Installation packages preparation

§ SE Suite installation

§ System configuration

Installation Guide — SE Suite 2.1 - Windows


Installation activities 41

4.1 - Installation packages preparation


This section covers the obtainment and preparation of the packages required for the SE Suite
installation.

1. To obtain the installation packages, access the Customer center.

2. On the customer portal page, click on Click here;

3. At this point, you will be directed to Distribution Center. Enter your access data and click on
Login;

4. In the Downloads section, select the desired version (2.1) and download the Installation tool for
Windows.

5. After downloading the installation tool, download the Install Files package of the desired version.

6. After saving the packages, execute the SE Suite installation according to the procedure described
in the following topic.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 42

4.2 - SE Suite installation


This section covers the steps to install SE Suite. At the end of the installation, the services will be
restarted and the process is finished with the installation activation. See the steps of the installation
process below:

First, the SE Suite installer will check whether the environment meets the installation requirements. Because of
that, make sure to execute all the Pre-required activities.

1. Access the installation tool directory as described in the Preparing the installation packages topic
and execute the installation tool downloaded before.

§ During the installation process, we recommend disabling your Antivirus software.

§ The installation tool must be executed with administration permission. To do that, right-click and select
the "Run as administrator" option.

2. On the SE Suite installer welcome screen, click Next.

3. On the "Operation Type" screen, click on the Install button to install SE Suite, if another
instance has started the installation but not finished, a message will be displayed once you click
install. If you choose to continue the installation, it will continue from the step it was canceled in;

4. On the "License Terms" screen, check "I accept the terms of this agreement" and click Next.

5. On the "Environment Check" screen the environment verification step is performed, i.e., the
installation tool will verify whether the environment meets the predefined installation requirements,
if any errors occur, it is possible to view the error screen by double-clicking the prerequisite
presenting the error. If no errors occur, or if the errors are fixed, click Next.

If it is required to stop the installation to correct any errors on this screen, click on "Cancel". After the
error has been corrected, perform the previous steps again.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 43

6. On the "Select Package" screen, select the "Install Files" package downloaded during the
Preparing the installation packages step. To do that, click the Browse button and select the
package. Wait for the installer to validate the selected package; check the status on the progress
bar on the screen.

When the validation ends, verify whether the installation directory will be the default directory "C:
\sesuite" selected automatically. If it is another directory, use the Browse button to choose
another directory. Click Next.

The "Install Files" installation package must be entered.

7. On the "Setup Web Server" screen, fill out the following fields:

§ Username: Enter the Windows username created for SE Suite. It is recommended for the IIS
user to be a member of the Guest group.

§ Password: Enter the user password.

§ User Domain: Enter the domain, hostname or IP address. It is recommended to inform the
domain in this field, because if the IP is informed, it cannot be changed (Static IP).

§ Web app name: It is the directory of IIS. By default, this field is filled in with "se". Change the
field as required.

§ Website: It is possible to use an existing website by checking the "Existing" option and
selecting the website in the field next to it. If you wish to create a new one, check the "Use
new site" option and fill in the Name and Port fields.

8. After completing the fields above, click Next.

If the entered user does not belong to the Guests group, the installer will display the "The specified user is
not a member of the Guests group. It is recommended that the IIS User be a member of this group.
Continue anyway?" message. Click on "Yes" to continue with the installation or "No" to wait on the previous
screen until the user is added to the group.

9. On the "Setup Java Services" screen, check the path of the Apache Tomcat installation directory
in the Tomcat Home Dir field, if necessary, click Search.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 44

10. On the "Perform Installation" screen, several steps will be executed automatically, such as
package extraction, permission definition in files, service installation, among others. Wait for these
steps to be executed. If an error occurs, it is possible to view the error screen by double clicking
the step presenting the error. If no errors occur, or if the errors are fixed, click Next.

If it is required to stop the installation to correct any errors on this screen, click on "Cancel". After fixing
the error, when you run the installer again and select the option to continue the installation, it will return to
the step that the installation was canceled.

11. On the "Perform Final Task" screen, the last steps of the installation are executed automatically,
such as: synchronize, load and save services, and save the SE Suite application configurations.
When this step finishes, click Next.

12. On the SE Suite installation closing screen, two documents that must be viewed will be available.
The first document is an SSL configuration tutorial; follow all the steps in it carefully. The second
document contains the steps to configure the database; execute the configuration steps of your
database according to it. After setting the necessary configurations, click Finish.

The SE Suite activation process occurs after the license key is entered in the SE Configuration component.
Refer to the Post-installation activities section for more details.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 45

4.3 - System configuration


See how to configure the database to be used by SE Suite and how to configure the SSL on the SE
Suite Server:

§ SSL configuration

§ Java Security Extension package

§ Database configuration

§ Starting the services

Installation Guide — SE Suite 2.1 - Windows


Installation activities 46

4.3.1 - SSL configuration


The use of a digital certificate on the web server allows all information traffic between the server and
the client to be encrypted. In version 2.1, the use of certificates is mandatory, since non-encrypted
traffic may be easily captured by hackers, causing the client information to be accessed.

We suggest the use of valid certificates, issued by certification entities (Verisign, Certisign, Thawte,
among others). If the organization chooses to use self-signed certificates, the system will work;
however, during the access, security messages may be issued by the navigator - without being
controlled by SoftExpert.

For further details about how to configure certificates in IIS, we suggest reading and executing the
procedures released by Microsoft (https://technet.microsoft.com/).

Installation Guide — SE Suite 2.1 - Windows


Installation activities 47

4.3.2 - Java Security Extension package


Due to an export rule in the USA, the Java JDK default installation has a limitation regarding encryption
ability. Some system features that use encryption require the extended Java encryption package.

The package is available in the "\tools\thirdparties\oracle\java\UnlimitedJCEPolicyJDK7.zip"


folder of the product installation directory. To install it, just follow the steps described below:

1. Unzip the UnlimitedJCEPolicyJDK7.zip file in the folder:


<sesuite_directory>\tools\thirdparties\oracle\java\

2. Copy the files with .jar extension.

3. Paste the files with .jar extension into the "<JAVA_HOME>\lib\security" directory.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 48

4.3.3 - Database configuration


SE Configurator is a tool responsible for configuring connections to the database and associating it with
a domain (to be used by multiple databases). To configure the system, go to the SE Configurator
(<sesuite_directory>/tools/configurator) folder and execute the run.bat file; at this point, the SE
Configurator screen will be displayed.

New database configuration


See how to configure a new database for SE Suite:

During the database configuration process, the system prompts you to set up the administrator user's e-mail and
password, which must follow the following password strength rules:

§ Must have numbers;

§ Must have alphabetic characters;

§ Must have uppercase and lowercase characters;

§ At least 6 characters;

The administrator's e-mail configuration is not mandatory, but it is highly recommended.

1. On the SE Configurator screen, access the Databases tab. Through this tab it is possible to add,
update, delete, and verify whether the databases were updated correctly:

Installation Guide — SE Suite 2.1 - Windows


Installation activities 49

2. To add a database, click on the button and fill out the following fields of the screen that will be
displayed:

§ Connection name: Enter a connection name.

§ Domain: Enter the domain that will be used to access the system. It must point to the domain
where SE Suite is installed.

§ JDBC Driver: Clicking on the combobox will show all the database options SE Configurator
supports: Oracle, PostgreSQL and SQL Server. When you select one of the options, the screen is
updated according to the selected database and the Port field is filled with the default value of
the database port. Fill in the other fields with the data of the selected database.

3. After filling them out, click on the button. At this point, the SE Configurator will run a test with
the values entered in an attempt to create a connection to the database. Should any of the tests
fail, the Previous button will be enabled to return to the connection screen and then perform the
correction:

Installation Guide — SE Suite 2.1 - Windows


Installation activities 50

4. If no errors occur at the end of the SE Configurator testing, the Next button will be enabled,
allowing you to finish creating the connection to the database.

5. At this point, the system will create, parameterize, and equalize the database. SE Configurator will
display a message; when this process is finished, click on OK. After that, click on Next.

6. SE Configurator will display the data of the configured database. Click on Finish. After the process
finishes, the created database will be displayed.

7. Click on and then on OK.

Database equalization/parameterization
See below how to configure an existing database. This procedure should be performed in a previously
configured base.

1. On the SE Configurator screen, access the Databases tab, select the database that will be
equalized and click on the "Check database" button:

Installation Guide — SE Suite 2.1 - Windows


Installation activities 51

2. At this point, the equalization process will start. In the message window, click on OK.

3. When the equalization process is complete, click on Next and then, click on OK.

4. To finish, click on and then on OK.

Database deletion
See below the procedures to delete the database configuration:

1. On the SE Configurator screen, access the Databases tab. Select the database you wish to
delete and then click on the "Delete" button:

2. Click on Yes to confirm removal of the database.

Installation Guide — SE Suite 2.1 - Windows


Installation activities 52

3. At this point, the deletion process will start. When finished, click on Next.

4. To finish, click on and then on OK.

Changing the SE Suite admin user password (Administrator)

To change the SE Suite administrator user password, first access the SE Configurator folder
(<sesuite_directory>/tools/configurator) via the prompt. After that, execute the following
command:

java -jar "se-configurator.jar" -installDirectory="<sesuite_directory>" -action="3"

Installation Guide — SE Suite 2.1 - Windows


Installation activities 53

4.3.4 - Starting the services


After installing SE Suite and configuring the database, start the services used by SE Suite:

§ During the SE Suite service start up, the system will perform a requirement check. If a requirement does not
meet the system use, the checker will display a message to indicate the configuration that needs to be solved.
Refer to the Requirements check section for details on how to troubleshoot major configuration issues.

§ It is important to remember that, when restarting the database, it will be necessary to restart the SE Suite
service as well.

IIS service

1. Access the Start Run menu;

2. Type iisreset /start

3. Press Enter;

Tomcat service

4. Access the Start Run menu;

5. Type services.msc and press Enter;

6. Search for the Apache Tomcat service;

7. Right-click on that service and click on Start;

PDF Converter service

8. Go back to the services manager (services.msc) and search for the PDF Converter service;

9. Right-click on that service and click on Start;

Installation Guide — SE Suite 2.1 - Windows


Deletion activity 54

Chapter V

Deletion activity
If it is necessary to remove SE Suite version 2.1, check the system for customizations.

To do that, it is necessary to access the following folders and perform their backups.
<sesuite_directory>/wwwroot/Custom_SRV
<sesuite_directory>/include/Custom_SRV

Check your customization documentation for any doubts regarding the required specific files.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 55

Chapter VI

Additional procedures
This section contains the activities that will be executed after the SE Suite installation. Among them,
find the system configuration activities and the pop-up unblocking for the SE Suite domain in the
browser of the workstations that will access SE Suite.

This section covers the following topics:

§ Post-installation activities

§ Release and production environment

§ Single Sign-On with AD

§ File Manager server

§ Scale service (SE Asset)

§ PDF conversion

§ Workstation configuration

§ Remote access configuration

§ External access configuration

§ Enable CURL in PHP

§ Starting and stopping the services

§ Troubleshooting

§ Environment vulnerability

§ Database - Good practices

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 56

6.1 - Post-installation activities


After installing SE Suite, some configuration activities will be required for SE Suite to be suitable for use,
such as the system configuration, access license, system activation, and e-mail configurations. Some of
these activities are described in the documentation of the SE Configuration component. See below how
to execute these activities:

1. When accessing SE Suite for the first time, screen will be displayed. Use it to configure, at least,
the name of the organization that acquired the system and the access password of the admin
user. Refer to the documentation of the SE Configuration component, in the "Configuration
System" section, for further details on how to perform the general configurations of the system.

2. Once the admin user is configured, enter the activation key. Refer to the documentation of the SE
Configuration component, in the "Configuration License key" section, for further details on how
to perform the configurations of the license key.

After any changes in the license key, whether when switching the key or adding a new one, it will be
necessary to activate SE Suite.

If, in the SE Configuration component (in the Configuration System menu), the "Enable automatic
activation" option is selected, it will not be required to perform the activation procedure described below.

Manual SE Suite activation


3. If the automatic activation is not enabled, whenever there is any change in the system
configurations, it will be necessary to activate SE Suite manually. When that happens, the following
screen will be displayed:

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 57

4. To activate the system, click on the System activation button. The system will display a screen
with a brief description of the changes made:

5. Carefully follow the instructions on the system activation screen. Download the file
(activation.hbl) and access the Customer center. Enter your login and password. At this point,
you will be redirected to the activation page.

Note that the Customer center will be opened in a new tab in your browser. The tab displaying the SE Suite
page must not be closed, because, after generating the activation code, it will be necessary to return to it.

6. On the customer center activation page, Upload the file. After selecting the activation.hbl file in
the respective field, click on the UPLOAD button.

7. At this point, the system will display the screen with the activation code. Copy the generated
code, return to the SE Suite screen, and enter the activation code.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 58

8. After that, click on the Enable button. The SE Suite page will be reloaded and now any already
created user may access the system.

Configure the e-mail server


Refer to the documentation of the SE Configuration component, in the "Configuration E-mail server"
section, for further details on how to perform the configurations of the e-mail servers that may be used
to send system notifications via e-mail.

Enable e-mail sending


To enable sending notifications via e-mail, it is necessary for the "Enable sending system e-mails" option
to be checked in the "Configuration E-mail notification (CM022)" menu of the SE Configuration. Refer
to the documentation of the SE Configuration component, in the "Configuration E-mail notification"
section, for further details on how to configure the e-mails that may be sent by the system. It is worth
noting that the e-mail sending feature requires the e-mail server to be properly configured.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 59

Enable thumbnails
To enable the viewing of thumbnails, it will be necessary to install SE Preview on the server on which
SE Suite is installed.

SoftExpert makes available an MSI for the installation of SE Preview on the workstation. This MSI can be
found, compressed, within the SE Suite server directory, or downloaded via the SE Suite URL:

§ SE Suite server :<sesuite_directory>\web\wwwroot\generic\app\viewer\

§ SE Suite URL: https://<sesuite_domain>/se/generic/app/viewer/sepreview.zip

Decompress it and run the installation. Remember that, before executing the MSI, it is necessary to
uninstall SE Viewer.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 60

6.1.1 - SE Risk conversion

The purpose of this section is to guide the SE Suite user on how to convert the data of SE Risk component of
version 1.3 to SE Suite version 2.1. If the conversion from version 1.3 to version 2.0 has been performed, this
procedure must be ignored.

About the data conversion


This section will describe the main changes expected once the conversion process is finished. The SE
Risk component went through several changes to SE Suite version 2.0. From the structural point of view
of the system, we can highlight the new relational tables used in version 2.0, that have the "RI” suffix,
instead of "HA” in the old version, and the new ISOSYSTEM code of the component, which changed from
163 to 215. Only the Object, Process and Project contexts of the SE Suite 1.3 will be converted, that is,
the plans that are from other contexts will not be considered. The control plans from SE Suite 1.3 will
not be converted either since they have been disabled from version 1.3 on. See below the changes
between the versions.

Tokens
There will no longer be token customization by context, as in version 1.3. It is possible to customize a
term in SE Suite 2.0 through the Administration Configuration Customize Token (AD031) menu,
which is valid for the entire system.

Plan revision
In SE Suite 2.0, the plan revision is generic, that is, the same revision method is used for a Scorecard,
Process, etc., and, for a plan to go through revision, its type must be properly configured.

By default, after data conversion, plan types will not be configured to have a revision control. Therefore,
the user will have to do it by accessing the plan type data screen and, in the Revision tab, check the
option to control the revision as well as to fill in the fields.

All plans will be converted as being "not-default”, that is as if they were created from the Management
Plan planning (RI301) menu. Therefore, do not follow the associated object revision (Ex.: Process,
Project, Scorecard).

The SE Suite 1.3 plans that have a revision in execution, and another one in the analysis will be
converted as follows:

§ The revision that was in execution will be finished (released revision).

§ The revision that was under analysis will be converted to planning (revision in the draft step).

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 61

Security
The revision permission in the plan type security of SE Suite 1.3 will no longer exist in SE Suite 2.0. The
plan security in SE Suite 2.0 works as a hierarchy of screens, that is, in the "plan security" tab, on the
plan type screen, the user configures the permissions of all the plans created in that type and, in the
security tab, on the plan data screen, the user configures the structure permissions of that plan. The
plan type also has the type security, where the permissions of that type are configured.

Executing the data converter


For the system to enable the conversion option, it is necessary to insert, in the database, a record in
the ADPARAMS table. The SQL ANSI command to insert the record into the database is:
INSERT INTO ADPARAMS (CDISOSYSTEM, CDPARAM, VLPARAM) VALUES(215, 99, 1);

After entering the record in the database, the user must access the General parameters screen of the
component through the "Configuration General parameters (RI110)" menu, as in the image below.

The data conversion process is performed in two steps, which must, necessarily, be executed in the
following order:

1. Record: Converts all records that understand the configuration and file menus of the system, that
is, attributes, checklist, teams, identification masks, dynamic navigator, all the types (plan type, risk
type, control type, etc.) and all the records (risk, control, treatment, etc.).

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 62

2. Plans: Converts all records that understand the management and execution menus of the system,
that is, risk plans, revisions, risk analysis and their evaluations, and control analysis and their
evaluations.

When clicking on the 1. Record button, a new screen will be displayed. On that screen, the system will
execute a conversion script, which may take a few seconds to finish. The "Processing" message will be
displayed while the screen remains open and, when the process finishes, a message will be displayed
according to the image below.

After executing the first conversion step (records), the user must go to the last part of the conversion
through the 2. Plans button. The process is similar to what was described in step 1.

After executing the two steps, the user may verify whether there are differences between the data of
the two versions of the system, by clicking on the Conversion status button.

The conversion status will show a list with all the tables that were converted. A success icon will be
displayed if all records of each table were converted. A failure icon will be displayed if at least one
record was not converted or if the number of records is different.

It is important to point out that there may be some differences between the number of converted
records of a table, caused by inconsistency in the information coming from the SE Risk component. The
image below shows the conversion status screen.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 63

Finally, the purpose of the Remove all records button is to erase all data from the SE Risks component
of Suite 2.0 and should only be triggered if there is a problem in the conversion of the records. Records
added from version 2.0 will also be deleted.

After the execution of the data converter


The risk and control analyses were converted with the user being logged in SE Suite session during the
conversion. To receive the analysis tasks, the users must edit the responsible user.

The Dashboards of Suite 1.3, now called Portals, were not converted to SE Suite 2.1 because the
widgets have changed. To use them, the users must create them manually through the system Portals
menu.

Since in SE Suite 2.0 there is a unification of the contexts of version 1.3, there may be situations in
which the ID # of type records (plan type, risk type, control type, etc.) and of other records (plan, risk,
control, risk source, etc.) are repeated. To overcome this situation, the converter adds a unique code at
the end of each record ID # to differentiate them.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 64

6.2 - Test and production environment


Aiming to aid in the version migration with no major impact, there are two environment types:
production and test. The production environment is é exclusively dedicated to the actual use of SE
Suite by the organization, whereas the test environment allows testing the new functionalities or testing
other configurations that were not used by the organization previously.

From version 2.0.14 onwards, the definition of the environment type (production or test) must be
performed through the Customer center, and it will be automatically applied to the system when
activating the product. Also from this version onwards, test environments start to display an explicit
message in the system header for all users to be aware of the fact that they are using a test
environment.

It is important to point out that:

§ Only one production environment is allowed per company name;

§ Changing from the release/test environment to the production environment is allowed, but the current
production environment will become a release/test environment;

§ Changing environments can only be performed up to 3 times per month.

Changing test environment for production

1. First, access the Customer center and log into the portal.

2. Next, access the "Activation" section.

3. In the "Server" section, a table with every environment from your organization will be displayed.
The first line on the table refers to the Production environment. The other lines refer to the test
environments.

4. To change the Production environment, click on the Test environment icon. A screen will be
displayed requesting a reason for changing the production environment to be entered. If there are
no changes left, a message will be displayed, informing that the production environment has
already been changed 3 times in the current month.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 65

5. After defining the new production environment, it will be necessary to access the "Configuration
System (CM006)" menu, in SE Configuration, and execute the revalidation, for the system to redo
the activation and apply the environment change:

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 66

6.3 - Single Sign-On with AD


SE Suite allows authenticating users through the LDAP, NTLM, and SAML protocols. See below how to
set the configuration for each one of these authentication modes.

AD integration
Active Directory is an implementation of the directory service in the LDAP protocol. It is a Microsoft
software used on Windows environments. To use AD integration, follow the following procedure:

1. Configure the LDAP server;

to do so, refer to the documentation of the SE Configuration component, in the "Configuration


Authentication Configuring the authentication" section.

2. Select the "SAML 2.0 (ADFS)" single sign-on option.

3. Refer to the Directory and authentication service documentation for further details about the
desired configuration.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 67

6.4 - FileManager server


This section contains the steps for the installation and configuration of the FileManager server to be
used to redirect the PDF conversion and FileManager update.

All the procedures below must be executed on a Windows server, on which FileManager will be installed, not on
the SE Suite server.

1. Access the server where SE Suite is installed;

2. Edit the database_config.xml.

3. In the <domain> field, change to the domain used by the users;

Note: If there is more than one domain used for the same database, change to the most common one.

Example: If the URL to access the system is https://client.softexpert.com/softexpert, enter


'client.softexpert.com' only.

4. In the <connectionName> field, enter the same information that is in the <domain> field;

Note: If it is a multi-database, repeat steps 3 and 4 for all databases.

5. Copy the following files to the server where FileManager will be installed:

§ SESUITE_HOME\conf\database_config.xml

§ SESUITE_HOME\usr\local\se\plugins\FileManagerInstaller.zip

6. Access the server where FileManager will be installed;

7. Install the 32-bit version of Java JRE 8;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 68

8. Add Java to the Windows PATH:

a) Start Menu > type "This PC";

b) Right-click "This PC";

c) Click "Properties";

d) Click "Advanced System Settings";

e) Click "Environment Variables...";

f) In "System Variables", identify the "Path";

g) Double-click on "Path";

h) At the beginning of the line, paste the Java installation path:

C:\Program Files (x86)\Java\jre8\bin;

Note: Do not forget the “;” after bin.

i) Click "OK" to finish.

9. Decompress the "FileManagerInstaller.zip" file copied in step 5;

10. Open the cmd as administrator:

a) Start Menu > type "cmd";

b) Right-click on "Command Prompt" and, after that, click "Run as administrator"

c) On the title bar of cmd must appear "Administrator:"

11. Access the folder where the "FileManagerInstaller.zip" was decompressed in step 9:

cd C:\Users\Administrator\Desktop\FileManagerInstaller

12. Execute the installer:

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 69

java -jar FilemanagerInstaller.jar

13. Enter the path where FileManager will be installed:

C:\SEFILEMANAGER

14. Enter the ports that the FileManager will install.

HTTP Port = 5020


AJP Port = 5009

Note: There must not be an active installation of Tomcat on the same server.

15. Click Next, Next, Finish to finish.

16. Create a local user on Windows, member of the "Administrators" group;

17. Open the Windows service manager:

a) Start Menu > type services.msc, then, press ENTER;

18. Locate the "FileManager Server" service;

19. Right-click on > "Properties";

20. Click on the "Log On" tab and then "This account";

21. Enter the user and password created in step 16;

22. Click OK and confirm the alerts that are displayed;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 70

23. Install and activate 32-bit Microsoft Office;

Note: The version must be equivalent to the one used by the users. This installation must not be logged
with a Microsoft or corporate account. The older version should have the PDF conversion add-in installed.

24. With the cmd opened in step 10, type "mmc comexp.msc /32";

25. Expand "Component Services > Computers > My Computer > DCOM Config";

26. Locate the "Microsoft Excel Application" item;

27. Right-click "Properties";

28. In the "Identity" tab, check "This user" and fill it in with the user created in step 16;

29. Click OK to confirm;

30. Copy the database_config.xml file copied in step 5 into the conf folder of FileManager:

C:\SEFILEMANAGER\conf

31. If Oracle, skip to step 35;

32. Edit the C:\SEFILEMANAGER\conf\ database_config.xml file;

33. Confirm if the <server> field is pointing to the correct database server;

When in doubt, follow the procedure below:

a) Access the server where sesuite is installed;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 71

b) Execute this command:

ping <server field value>

c) Access the server where FileManager is being installed;

d) Execute this command:

ping <server field value>

If the value is different or if it does not respond. Change the <server> field in the
database_config.xml of FileManager to the IP result of item b);

34. If SQL Server or PostgreSQL is used, skip to step 46;

35. Install the 32-bit Oracle client.

Note: During the Oracle client installation, select the "Administrator" mode (complete).

36. Copy the Oracle lib to the FileManager folder:

§ Oracle Client 10: C:\oracle\product\10.2.0\client_1\jdbc\lib\ojdbc14.jar

§ Oracle Client 11: C:\oracle\product\11.2.0\client_1\jdbc\lib\ojdbc5.jar

§ Oracle Client 12: C:\oracle\product\12.1.0\client_1\jdbc\lib\ojdbc6.jar

To the C:\SEFILEMANAGER\lib folder

37. Access the server where SE Suite is installed;

38. Copy the content of the /usr/local/se/apps/oracle-client/tnsnames.now file

39. Access the server where FileManager is being installed;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 72

40. Paste the content copied in step 38 into the file:


C:\oracle\product\11.2.0\client_1\network\admin\tnsnames.ora

41. Still, in the tnsnames.ora file on the server where FileManager is being installed, confirm the HOST
field;

When in doubt, follow the procedure below:

a) Access the server where sesuite is installed;

b) Execute this command:

ping <HOST>

c) Access the server where FileManager is being installed;

d) Execute this command:

ping <HOST>

If the value is different or if it does not respond. Change the HOST in the tnsnames.ora field of
FileManager to IP result of item b);

42. Edit the C:\SEFILEMANAGER\conf\ database_config.xml file;

43. Confirm if the <port> field is correct;

44. In the <db> field, enter the SID of the database;

Note: The SID may be the same as the SERVICE_NAME, but this is not a rule. When in doubt, ask the DBA
for the correct SID.

45. In the <server> field, fill in with the same value as the HOST field configured on tnsnames.ora
(C:\oracle\product\11.2.0\client_1\network\admin\tnsnames.ora);

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 73

46. Ensure that the time of the FileManager server is less than 5 minutes apart from the SE Suite
server;

47. Restart the FileManager service:

a) Start Menu > type "services.msc" and Enter;

b) Locate the "FileManager Server" service;

c) Right-click > "Restart";

48. Restart the SE Suite services.

49. Verify if the 5020 port is released in the SE Suite output server firewall at the input firewall of the
server where FileManager is being installed and whether it is also released on a firewall server
between the two servers.

50. Open a browser and access SE Suite through the URL defined in step 3;

51. Access the Document > Configuration > General parameters (DC035) screen.

52. On the Services tab, check the "Enable service redirection" option;

53. In "Server", enter http://<ip_servidor_filemanager>

54. In "Port", enter 5020;

55. Click on the checkbox next to the "Port" field to test the connection;

56. Click Save and exit to Finish.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 74

Test

§ Create a category and enable PDF conversion;

§ Create a document and associate an electronic file;

§ Verify whether the electronic file was converted to PDF.

If a problem occurs in the conversion to PDF, refer to the following link:

http://stackoverflow.com/questions/4408538/exportasfixedformat-with-excel-fails

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 75

6.5 - Scale service (SE Asset)


For the gage to connect with SE Suite, it is necessary to install ScaleService on the client machine(s).
See how to install that service in the steps below:

1. First, access the "web/wwwroot/asset/app/" directory of the SE Suite server and copy the
ScaleService.rar file to the "C:/" directory of the client machine. After that, decompress the
ScaleService.rar file in the "C:/" directory.

2. With admin privileges in cmd, execute the following command:

cd c:/ScaleService

3. After that, execute the following command:

SEScaleService.exe install

4. After installing the service, it should be started. To do that, click on the Start Windows menu and
type "services.msc". Click on the option and wait for the service manager screen to open;

5. In the service manager, search for SESuite Scale Connection Service and start the service.

For the correct connection with the equipment, the service must always be in execution. Therefore, configure the
service with an automatic startup so that it starts up with Windows.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 76

6.6 - PDF conversion


This section will describe some procedures related to PDF conversion, such as adding the PDF conversion
service with the Windows services, or how to use Microsoft Office as a PDF converter. See further
details in the following sections:

§ Addition of the PDF service

§ Conversion to PDF with Microsoft Office

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 77

6.6.1 - OpenOffice PDF conversion service


The OpenOffice PDF conversion service is required to convert documents in the OpenDocument Text
(.odt) format. To insert the PDF conversion service to the Windows services, execute the following
steps:

1. Download and install OpenOffice;

2. Download and install Windows Server 2003 Resource Kit Tools;

3. Create the C:\sesuite\pdfconverter directory;

4. Copy the srvany.exe file installed by the Windows server 2003 Resource Kit Tools in the "C:
\Program Files (x86)\Windows Resource Kits\Tools" directory to "C:
\sesuite\pdfconverter";

5. Click on the Start Windows menu, type "cmd", click on the option and wait for the screen to open;

6. On the MS-DOS screen, type in the following command:

sc create "PDF Converter" binPath= "c:\sesuite\pdfconverter\srvany.exe"

7. Click on the Start Windows menu, type "regedit", click on the option and wait for the screen to
open;

8. In the registry editor, browse to the following service key:


HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\services\PDF Converter

9. Create a new key named "Parameters";

10. Create a new character chain value (String) named "Application";

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 78

11. Edit the just created value and enter the value:

§ If it is openoffice 6:

"<office_directory>\program\soffice.exe" -headless -
accept="socket,port=5011;urp;" -nofirststartwizard

§ If it is not openoffice6:

"<office_directory>\program\soffice.exe" -headless -
accept="socket,host=0,port=5011;urp;" -nofirststartwizard

12. The registry key must look as shown in the image below:

13. Click the Start Windows menu and type "services.msc". Click on the option and wait for the
service manager screen to open;

14. Search for the PDF Converter service;

15. Right-click on that service and click on Start;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 79

6.6.2 - Conversion to PDF with Microsoft Office


It is possible to use Microsoft Office to convert documents to PDF. To do that, it will be necessary to
configure the SE Suite server and, on this server, Microsoft Office Professional 2010 or higher should be
installed.

This procedure is optional and, if it has not been executed, the system can use LibreOffice for conversion.

Directories

After installing Microsoft Office on the SE Suite server, it will be necessary to create a directory. See
below the location where the folder must be created for each architecture type Windows may have, that
is, 32-bits or 64-bits:

Windows Server x86


§ If the system is installed on a 32-bit Windows Server environment, the following directory must be
created:
C:\Windows\System32\config\systemprofile\Desktop

Windows Server x64


§ If the system is installed on a 64-bit Windows Server environment, the following directory must be
created:
C:\Windows\SysWOW64\config\systemprofile\Desktop

§ If the Windows Server environment architecture version is 64-bits and Microsoft Office Professional
version is 32-bits, the following directory must also be created:
C:\Windows\System32\config\systemprofile\Desktop

Conversion service configuration

The following configuration must be set on the SE Suite server after installing Microsoft Office.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 80

If you wish to use FileManager, configure the following on the FileManager server.

1. Access the Windows registry (regedit.exe).

2. For the conversion service to work correctly, it will be necessary to insert the "Devices",
"PrinterPorts", and "Windows" key registries into [HKEY_USERS\S-1-5-
18\Software\Microsoft\Windows NT\CurrentVersion]:
§ HKEY_USERS\S-1-5-18\Software\Microsoft\Windows NT\CurrentVersion\Devices

§ HKEY_USERS\S-1-5-18\Software\Microsoft\Windows NT\CurrentVersion\PrinterPorts

§ HKEY_USERS\S-1-5-18\Software\Microsoft\Windows NT\CurrentVersion\Windows

3. To do that, import the following code into the registry key:

[HKEY_USERS\S-1-5-18\Software\Microsoft\Windows NT\CurrentVersion\Devices]
"Send To OneNote 2010"="winspool,nul:"
"Microsoft XPS Document Writer"="winspool,Ne00:"

[HKEY_USERS\S-1-5-18\Software\Microsoft\Windows NT\CurrentVersion\PrinterPorts]
"Send To OneNote 2010"="winspool,nul:,15,45"
"Microsoft XPS Document Writer"="winspool,Ne00:,15,45"

[HKEY_USERS\S-1-5-18\Software\Microsoft\Windows NT\CurrentVersion\Windows]
"UserSelectedDefault"=dword:00000000
"Device"="Send To OneNote 2010,winspool,nul:"

4. After importing the records, restart the Tomcat service.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 81

6.7 - Workstations configuration


This section will cover the necessary configurations on the workstations. This configuration section
contains the main following topics:

§ Internet Explorer configuration

§ Firefox configuration

§ OpenOffice automation

§ MSI installation

The activities in this section must be executed on all the workstations that will access SE Suite.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 82

6.7.1 - Internet Explorer configuration


If the workstation environment is Windows and the browser to be used is Internet Explorer, check
whether the Internet Explorer security configurations meet the minimum requirements for SE Suite to
work on the workstations:

1. Access the Start Control Panel menu;

2. In the control panel, access the Internet Options (Network and Internet category) menu;

3. Access the Security tab and in Select a zone to view or change security settings, click Local
intranet;

4. In the Security levels for this zone, click on Custom level and on Settings;

Make sure to add your SE Suite link to the "Allowed sites" section.

5. Verify whether the following items are configured as described:

§ ActiveX controls and plug-ins > Binary and script behaviors: enable

§ ActiveX controls and plug-ins > Run activeX controls and plugins: enable

§ ActiveX controls and plug-ins > Script ActiveX controls marked safe for scripting: enable

§ Downloads > Automatic prompting for file downloads: enable

§ Downloads > File download: enable

§ Scripting > Active scripting: enable

6. Click OK;

7. Access the Privacy tab and in Pop-up Blocker, click Settings;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 83

8. On the window that opens up, in the Blocking level select the "Low: Allow pop-ups from secure
sites" option. See further details in the following image:

Make sure to add your SE Suite link to the "Allowed sites" section.

9. Click Close to close this window and then OK to close the Internet Options screen;

10 Restart Internet Explorer.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 84

6.7.2 - Firefox configuration


Check whether the Firefox configurations meet the minimum requirements for SE Suite to work on the
workstations:

1. Open Firefox and access Tools Options on the menu bar;

2. On the Content tab, in Block pop-up windows, click on the Exceptions button;

3. Enter the SE Suite domain and click on the Allow button;

4. Click Close to close this screen and then click OK to close the Options screen;

5. On the Firefox menu bar, click Tools Add-ons;

6. Access the Plugins tab and check if the installed and enabled Java plugin exists;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 85

6.7.3 - OpenOffice automation


The OpenOffice automation allows disabling the save, print options, among others. To use the
OpenOffice automation, the client machine must have access to the following directories (on the client
machine itself):

C:\Windows\Temp
C:\Program Files\Java\jre8\lib\ext

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 86

6.7.4 - MSI installation


PDF, DWG, and DXF files are viewed, in SE Suite, through SE Viewer. When opening one of these files for
the first time, the system requests the installation of the viewer. If the logged user has no permission to
install the viewer, the administrator will have to execute the following procedure:

Locate the sepreview.zip file, in the SE Suite installation directory (server): "C:
\Inetpub\SE\web\wwwroot\generic\app\viewer\sepreview.zip".

Manual procedure

Uncompress the sepreview.zip file and execute the MSI file on the client workstations that need to
install the viewer.

The execution should be performed by a user with administrator permission on the machine.

Automatic procedure

Decompress the sepreview.zip file and add the MSI file to the network login script so that it is
replicated to all workstations automatically.

It must be parameterized so that it is executed with administrator permission, whenever a new user logs into the
machine.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 87

6.8 - Remote access configuration


If the system is accessed through a remote access environment (Citrix, Terminal Services, etc.), the
following configuration must be set in the Citrix or Terminal Services servers:

1. In the Windows registry (regedit.exe), access:

HKEY_USERS\S-1-5-18\Software\Microsoft\Windows\CurrentVersion\WinTrust\Trust
Providers\Software Publishing

2. In the "State" item, change the value 23c00 to 23e00; this will disable the CRL verification for the
System user account.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 88

6.9 - External access configuration


A reverse proxy is a network server that receives all the external connections and forwards them to the
Web server. See below how to configure the system external access:

For the external access to work correctly, the URL to access the system must be interpreted both on the stations
and on the application server. To do that, the domain used in external access must be recorded in the hosts files
of the application server operating system, pointing to the local IP (or 127.0.0.1).

1. Open to edit the hosts file of the SE Suite server:

C:\Windows\System32\drivers\etc\hosts

2 And add the access domain line according to the following example:

127.0.0.1 <externalaccess>.softexpert.com

There may be not port change in the NAT configuration. If, in the IIS, port 80 is being used, the firewall must
direct to port 80 as well. For instance, it cannot be directed from 81 to 80, only to the same port.

Reverse proxy

Considering that the DNS to be used externally is sesuite.softexpert.com, this very DNS must respond
internally on the proxy server, pointing to the application server where SE Suite is installed, as well as in
the internal network resolve the internal IP of the same server.

To ensure this procedure, we may use the proxy server HOSTS file and force the DNS redirecting to the
desired IP (internal). The same must be performed on the application server.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 89

Follow the mod_proxy configuration example using the sesuite.softexpert.com DNS:

<Proxy *>
Order deny, allow
Allow from all
</Proxy>
ProxyRequests On
ProxyVia On
ProxyPass /se https://sesuite.softexpert.com/se
ProxyPassReverse /se https://sesuite.softexpert.com/se
ProxyPass /softexpert https://sesuite.softexpert.com/softexpert
ProxyPassReverse /softexpert https://sesuite.softexpert.com/softexpert

Below is the diagram this system:

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 90

6.10 - Enable CURL in PHP


This section shows how to enable the CURL feature in PHP.

1. Locate the php.ini file in the directory: SESUITE_HOME/web/php

2. Edit the file and locate the line:

;extension=php_curl.dll

3. Remove the semicolon at the beginning of the line and save the file.

4. Restart SE Suite.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 91

6.11 - Starting and stopping the services


See, in this section, how to stop and start the SE Suite service and the services used by it, individually.

Stopping the services

IIS service

1. Access the Start Run menu;

2. Type: iisreset /stop

3. Press Enter.

Tomcat service

4. Access the Start Run menu;

5. Type services.msc and press Enter to open the service manager;

6. Search for the Apache Tomcat service;

7. Right-click on this service and click Stop;

Memcached service

8. Go back to the services console (services.msc) and search for the memcached service;

9. Right-click on this service and click Stop;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 92

PDF Converter service

10. Go back to the services manager (services.msc) and search for the PDF Converter service;

11. Right-click on this service and click Stop;

Java service

12. Access the Start Run menu;

13. Search for the Task Manager (taskmgr.exe) service;

14. Open the task manager, access the tab that shows the services that are running and enable the
display of a column called Command Line.

The procedure to make this column be displayed may vary according to the version of the Operating System:

§ Right-click on the title of the columns and select the "Select columns" option; or

§ Access the "View > Select columns" menu.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 93

15. Locate and finish the Java service which contains the following command line:

Starting the services

§ During the SE Suite service start up, the system will perform a requirement check. If a requirement for system
use is not met, the checker will display a message to indicate the configuration that needs to be solved. Refer
to the "Additional procedures Troubleshooting Requirements check" section, in the Installation Guide, to
obtain details on how to solve major configuration issues.

§ It is important to remember that, when restarting the database, it will be necessary to restart the SE Suite
service as well.

IIS service

1. Access the Start Run menu;

2. Type iisreset /start

3. Press Enter;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 94

Tomcat service

4. Access the Start Run menu;

5. Type services.msc and press Enter;

6. Search for the Apache Tomcat service;

7. Right-click on that service and click on Start;

Memcached service

8. Go back to the services console (services.msc) and search for the memcached service;

9. Right-click on that service and click on Start;

PDF Converter service

10. Go back to the services manager (services.msc) and search for the PDF Converter service;

11. Right-click on that service and click on Start;

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 95

6.12 - Troubleshooting
The topics in this section contain the steps to solve problems identified in SE Suite.

§ Requirements check

§ Index server

§ System version

§ Single Sign-On

§ Outlook configuration

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 96

6.12.1 - Requirements check


Starting in version 2.0.5, SE Suite contains a requirements checker. This resource is a functionality,
executed during the SE Suite initialization, which aims to make sure the server meets all the
requirements for system use. If a requirement for system use is not met, the checker will display a
message to indicate the configuration that needs to be solved.

See below some configurations that may be required to start the SE Suite service:

Configuring the time zone in Java


By default, the time zone used in Java is the same of that configured in the operating system. To
start the application with a time zone different from the one used by the operating system, it is
necessary to indicate that to Java in the system start up, through the user.timezone attribute,
according to the following examples:

SE Suite in Windows:
§ Execute the "Tomcat monitor" application (TOMCAT_HOME\bin\tomcat7w.exe)

§ Access the Java tab

§ Add a new line in the "Java options" field with the value: -Duser.timezone=America/Los_Angeles

The time zone used in the example is the official USA time zone, the ID # for other time zones can be found
at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (Accessed on Sep/08/2016).

Adjusting the day light saving time


If the system displays the divergence message between daylight saving time between Java and PHP,
the problem may be in the version of the Java time zone database, to update the database follow the
steps:

§ If Java JRE is being used, download the "Timezone Updater Tool" application; If Java OpenJDK is
being used, download the "ZIUpdater Time Zone Tool" application.

§ Run the application with the same Java virtual machine used by SE Suite with the command line
"java -jar tzupdater.jar -f". For Java OpenJDK, execute the "java -jar ziupdater-
1.0.1.2.jar -f" command.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 97

§ If the current directory is different from where >tzupdater.jar is, use the full path up to the tzupdater.jar
file.

§ To compare the time zone database versions of Java and of the application, execute the "java -jar
tzupdater.jar -V" command.

Configuring the time zone in PHP


To set the time zone that will be used by PHP, it is necessary to edit the php.ini file (usually located
in SESUITE_HOME\web\php\php.ini). Locate and edit the following line according to your time zone:

date.timezone = America/Los_Angeles

The time zone used in the example is the official USA time zone; the ID # for other time zones can be found
at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Solving JAVA issues

System Parameter Description

GENERAL HD "HD free space is {SPAC E AVAILABLE IN DISK}, when it should be


at least 5GB."

Solution: Free up physical space on the machine.

GENERAL JavaVersion "The installed Java version is {JAVA VERSION}, when it should be
1.8."

Solution: Remove the java version and install the correct one.

GENERAL TomcatMemory "The Apache Tomcat server is configured to use up to


{C ONFIGURED_MEMORY} MB of memory. At least 1024 MB are
required. See how to perform this operation in the Installation
guide."

Solution: For Windows environments, refer to the memory configuration procedure described in the Apache Tomcat
installation section.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 98

Solving php.ini issues

System Parameter Description

GENERAL output_buffering "Output_buffering variable value is {VALUE}, when it should be 1.


C heck configuration in php.ini."

GENERAL max_input_time "Max_input_time variable value is {VALUE}, when it should be at


least 300. C heck configuration in php.ini."

GENERAL memory_limit "Memory_limit variable value is {VALUE}, when it should be -1.


C heck configuration in php.ini."

GENERAL post_max_size "Post_max_size variable value is {VALUE}, when it should be at


least 500M. C heck configuration in php.ini."

GENERAL upload_max_filesize "Upload_max_filesize variable value is {VALUE}, when it should be


at least 500M. C heck configuration in php.ini."

GENERAL session.name "Session.name variable value is {VALUE}, when it should be se-


authentication-token. C heck configuration in php.ini."

GENERAL session.gc_probability "Session.gc_probability variable value is {VALUE}, when it should


be 0. C heck configuration in php.ini."

GENERAL session.gc_maxlifetime "Session.gc_maxlifetime variable value is {VALUE}, when it should


be 86400. C heck configuration in php.ini."

GENERAL session.cache_expire "Session.cache_expire variable value is {VALUE}, when it should


be 86400. C heck configuration in php.ini."

GENERAL opcache.enable "Opcache.enable variable value is {VALUE}, when it should be 1.


C heck configuration in php.ini."

GENERAL opcache.memory_consumption "Opcache.memory_consumption variable value is {VALUE}, when it


should be 256. C heck configuration in php.ini."

GENERAL opcache.interned_strings_buffe "Opcache.interned_strings_buffer variable value is {VALUE}, when


r it should be 128. C heck configuration in php.ini."

GENERAL opcache.max_accelerated_files "Opcache.max_accelerated_files variable value is {VALUE}, when it


should be 70000. C heck configuration in php.ini."

GENERAL opcache.save_comments "Opcache.save_comments variable value is {VALUE}, when it


should be 1. C heck configuration in php.ini."

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 99

GENERAL opcache.load_comments "Opcache.load_comments variable value is {VALUE}, when it


should be 1. C heck configuration in php.ini."

GENERAL opcache.enable_cli "Opcache.enable_cli variable value is {VALUE}, when it should be


0. C heck configuration in php.ini."

GENERAL max_execution_time "Max_execution_time variable value is {VALUE}, when it should be


at least 200. C heck configuration in php.ini."

GENERAL session.save_path "Session.save_path variable was not configured. C heck


configuration in php.ini."

GENERAL date.timezone Date.timezone Java variable (JAVA_TIMEZONE) must be the same


as the PHP variable (PHP_TIMEZONE). Java uses the time zone
defined by the operating system, while PHP uses the value defined
in the php.ini file."

Solution:

1. Open the SUITE_HOME\web\php\php.ini file and search for the message variable.

2. C heck for other similar variables (repeated).

3. If there are repeated variables, add a “;” (semi-colon) at the beginning of the line for it to be commented, thus
the variable will not be validated. Example of a commented variable:
;cgi.force_redirect = 1

Example of valid variable (uncommented):


cgi.force_redirect = 1

4. After locating the variable, define the correct value, as described in the message.

5. Save the file and restart SE Suite.

WINDOWS realpath_cache_size "Realpath_cache_size variable value is {VALUE}, when it should be


at least 1024k. C heck configuration in php.ini."

WINDOWS cgi.force_redirect "C gi.force_redirect variable value is {VALUE}, when it should be 0.


C heck configuration in php.ini."

WINDOWS fastcgi.impersonate "Fastcgi.impersonate variable value is {VALUE}, when it should be


1. C heck configuration in php.ini."

Solution:

1. Open the SUITE_HOME\web\php\php.ini file and search for the message variable.

2. C heck for other similar variables (repeated).

3. If there are repeated variables, add a “;” (semi-colon) at the beginning of the line for it to be commented, thus
the variable will not be validated. Example of a commented variable:
;cgi.force_redirect = 1

Example of valid variable (uncommented):


cgi.force_redirect = 1

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 100

4. After locating the variable, define the correct value, as described in the message.

5. Save the file and restart SE Suite.

WINDOWS Zend OPcache "zend_extension=ZendLoader.dll extension is not enabled. C heck


configuration in php.ini."

WINDOWS memcache "extension=php_memcache.dll extension is not enabled. C heck


configuration in php.ini."

WINDOWS zip "extension=zip.dll extension is not enabled. C heck configuration in


php.ini."

WINDOWS soap "extension=soap.dll extension is not enabled. C heck configuration


in php.ini."

WINDOWS gd "extension=gd.dll extension is not enabled. C heck configuration in


php.ini."

Solution:

1. Open the SUITE_HOME\web\php\php.ini file and search for the extension described in the message.

2. C heck for other similar extensions (repeated).

3. If there are repeated extensions, add a “;” (semi-colon) at the beginning of the line for it to be commented, thus
the extension will not be validated. Example of a commented extension:

;zend_extension=php_opcache.dll

Example of a valid extension (uncommented):

zend_extension=php_opcache.dll

4. After locating the extension, define the correct value, as described in the message.

5. Save the file and restart SE Suite.

Solving template issues

System Parameter Description

GENERAL ...web\include\template The {NAME_OF_FILE} template is not a template in the JSON


format.

Solution: C ontact SoftExpert.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 101

6.12.2 - Index server


The objective of the index server is to extract data from records and files in SE Suite to index them.
These indexes are used in some system search screens, in addition to the general search. This service
works in parallel with the system; when starting SE Suite, the index service is also started. See below
the steps to verify whether the service is being executed:

1. Open the Task manager (taskmgr.exe), access the tab that shows the services that are running
and enable the display of a column called Command Line:

The procedure to make this column be displayed may vary according to the version of the Operating System:

§ Right-click on the title of the columns and select the "Select columns" option; or

§ Access the "View > Select columns" menu.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 102

2. Locate the Java service with the following command line (column Command Line):
"SESUITE_HOME\tools\se-fts-indexer-server\se-fts-indexer-server.jar".

In some situations, this service may not work adequately. See below a list of possible causes and their
solutions:

Port blocked in the FIREWALL


1. Open the SESUITE_HOME\tools\se-fts-indexer-server\conf\config.properties file for
editing and verify the indexer.server.port parameter port. Example:

#Port used by the index server


indexer.server.port=31712

2. Check whether there is a firewall configuration blocking the port of the 'indexer.server.port'
parameter. After unblocking the port, it will be necessary to restart the system and check
whether the index service is being executed.

Port being used in another service


1. Open the SESUITE_HOME\tools\se-fts-indexer-server\conf\config.properties file for
editing and verify the indexer.server.port parameter port. Example:

#Port used by the index server


indexer.server.port=31712

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 103

2. Check whether there is another service using the port of the indexer.server.port parameter.
If affirmative, select an available port.

Problem with the Oracle database


Check for the following error in the SE Suite logs:

'java.lang.UnsatisfiedLinkError'

If existent, it will be necessary to perform the following procedure:

1. Execute SE Configurator, which may be found at SESUITE_HOME\tools\configurator. On the


screen that will be displayed, edit the connection:

2. At this point, the connection data will be displayed. Click on the 'Save and exit' button:

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 104

3. Wait for the connection tests to finish:

4. After that, click on 'Cancel' and the procedure will be finished.

5. Restart the SE Suite services.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 105

6.12.3 - System version


The system verifies the versioning of the packages, aiming to maintain SE Suite stability.
Incompatibilities between the versions of the installed/updated packages may be found. See below the
solution to stabilize SE Suite:

1. First, stop all the services used by SE Suite:

2. Execute SE Configurator, which may be found in SESUITE_HOME\tools\configurator. On the


screen that will be displayed, click on the button to equalize the base:

3. After equalization, restart the system.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 106

6.12.4 - Single Sign-On


To preempt potential problems in the process of synchronizing and authenticating users in a domain, it is
possible to test the domain configuration in the system authentication configuration (CM008), in the
"Directory integration Domains" section, when creating or editing a record. This procedure will test the
communication from the SE Suite server with the authentication and directory servers informed in the
configuration. The tested protocols are LDAP, using the Connection string, provided user and password,
and communication with the NTLMV2 domain address and port, for NTLMV2 protocol authentication.

Generally, the connection test failure occurs if there are errors in domain configuration or problems in the
network connections between the SE Suite server and the servers that host the directory and
authentication services. Therefore, it is indicated to use tools to perform connection diagnostics or have
the assistance of the network administrator for any verification of addresses and ports used in the
communication.

Possible connection test returns:

§ Error message connecting to the domain controller: The SE Suite server was unable to open a
connection via LDAP protocol using the URL entered in the "Connection String" field. Ensure that the
field is filled correctly, and if a port has not been specified in the URL itself, verify that the server is
accepting connections on the default LDAP port 389, or for 636 and/or 3269 ports, defaults to
LDAPS, or contact the directory service administrator to check the availability of the service.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 107

§ Alert message stating that the connection via NTMv2 failed: The SE Suite server was unable to open
a connection to the domain address and port informed in the configuration. Verify if the respective
fields ("Domain address" and "NTLMv2 port") are correct and if the destination server is accepting
connections on the port informed. If it is not, check the firewall rules or contact the administrator of
your network. Note: If there is no intention to use the NTLMV2 authentication protocol, this alert
can be ignored.

§ Error message stating that the user was not found or the password is incorrect: Communication with
the directory service occurred without problems, but the user and password entered in the "User"
and/or "Password" fields are incorrect. This user refers to a user saved in the directory service, so it
must be verified if the name and password are in accordance with the information recorded in the
service. Remember that in the "User" field should be typed the name, not the login.

§ Alert message informing that authentication via NTMLV2 failed: In this case, the "User
Login" (example: user.test@domain.local) and/or the "Password" entered are incorrect. The user in
question is also a recorded user in the directory service, it is just required to check if the information
is correct. Note: If there is no intention to use the NTLMV2 authentication protocol, this alert can be
ignored.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 108

6.12.5 - Outlook configuration


If there is a problem sending the attachment, that is, the recipient is not receiving the attachment from
the email, it may be a configuration in Microsoft Outlook. In this section, a screen will display with some
settings that you can perform in Outlook to solve this problem.

Cause of problem
This is a common problem that occurs because of Outlook, where when a message is sent in RTF (Rich
Text Format) format and is not properly converted to HTML or Plain text.

Solutions

Submission using HTML format or Plain text

One of the possible issues is if you are sending the attachment in RTF format and the message is not
being translated correctly into HTML or as plain text. In this case, take the following steps to solve
the problem.

1. On Outlook, access the File Options menu (File Options):

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 109

2. On the Outlook options screen, select the Mail menu. Then, in the Compose messages section,
select the "HTML" or "Plain text" option in the Compose messages in this format field:

3. Still, on the Mail menu of the Outlook option screen, locate the Message format section. Then,
make sure that the When sending messages in Rich Text format to Internet recipients field is
set to "Convert to HTML format" or with the "Convert to Plain Text format" option.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 110

4. Click OK to save the changes.

Replying an email

If you need to reply to an incoming email so that you do not have to delete the attachment when
replying to a message, change the formatting of the message to HTML. To do this, first, open the
email in reply mode. Then, configure following settings, according to your Outlook version:

If your Outlook version is 2003

i. Select the Format tab.

ii. Select the HTML option.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 111

If your Outlook version is 2007

i. Select the Options tab.

ii. Select the HTML option.

If your Outlook version is 2010, 2013 or 2016

i. Select the Format Text tab.

ii. Select the HTML option.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 112

6.13 - Environment vulnerability


In Microsoft environments, there are some obsolete protocols and configurations, which the SE Suite
does not use, and, for security reasons, Microsoft itself recommends disabling. Softexpert is not
responsible for the administration of the server and does not apply these settings. It is the customer's
responsibility to contact Microsoft support to configure the server. We remind you that these changes
imply on the server as a whole, and if there are other hosted applications, they will be under these rules,
and it is up to the customer to verify that their applications are not impacted negatively. Enabling or
disabling such settings do not imply the operation of our application, except for customer-specific
customizations of Softexpert. Therefore, it is not a requirement for the operation of the same.

For communication between a Web browser and a secure HTTPS site, there must be a standard internet
authentication protocol, such as SSL/TLS. These protocols can be classified between strong and weak,
which involve cryptography types, key exchange algorithms, and hash functions.

Protocols
The standard internet authentication protocols, already depreciated, maintained only to support legacy,
old systems, in the impossibility of using others, are PCT v.1.0, SSL v.2, SSL v.3, TLS v.1.0.

It is currently possible to disable these weak protocols through Microsoft Secure Channel.

§ If possible, keep the PCT protocol v.1.0 disabled

§ If possible, keep the SSL protocol v.2.0 disabled

§ If possible, keep the SSL protocol v.3.0 disabled

§ If possible, keep the TLS protocol v.1.0 disabled

Cryptographic packages
Not all weak encryption packets are disabled by default on all windows versions, make sure that you can
disable the cryptographic packages based on:

§ RC4

§ RC2

§ DES

§ Null

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 113

Key exchange
An algorithm among those used in the communication exchange between the parties proved to be weak
and breakable with greater ease and can be disabled on the server.

§ If possible, keep the Diffie Hellman algorithm (DH, or DHE for key exchange) disabled.

Installation Guide — SE Suite 2.1 - Windows


Additional procedures 114

6.14 - Database - Good practices


This section addresses the topics related to best practices regarding database management and
maintenance. Make sure to verify each one of these items.

§ Check the possibility to create a routine to update the statistics and defragment the database
objects.

§ Keep a database backup routine; the frequency must be set to meet the technical and business
requirements.

§ Whenever possible, try to simulate the need of backup restoration; this action aims to identify possible
failures in their media and routine.

§ Periodically monitor the free space in the disk where the database files are stored. With that, it will be
possible to avoid any type of failure due to the lack of disk space.

Installation Guide — SE Suite 2.1 - Windows


Document history 115

Chapter VII

Document history
The table below describes the main changes made to this document.

Revision Version Change description

00 2.1.0 Sep/17/2019 220188


ð C reation of the document for version 2.1 based on version 2.0.

Document update history

Installation Guide — SE Suite 2.1 - Windows


Company

SoftExpert is a Market leader in software and services for enterprise-wide business process
improvement and compliance management, providing the most comprehensive application suite
to empower organizations to increase business performance at all levels and to maximize
industry-mandated compliance and corporate governance programs

Founded in 1995 and with more than 2,000 customers and 300,000 users worldwide, SoftExpert
solutions are used by leading corporations in all kinds of industries, including manufacturing,
government and public sector, pharmaceutical sector, hospitals and laboratories, financial
services, high tech and IT, education, energy and utilities, logistics, retail, services, among
others.

Along with its extensive network of resellers spread across all continents, SoftExpert also
provides hosting, implementation, post-sales support, and validation services for its solutions to
ensure that customers realize the maximum value from their investments.

Copyright © SoftExpert Software - Software for Performance Excellence


All rights reserved.

You might also like