Professional Documents
Culture Documents
Guide 2.1.0 en - Us Windows
Guide 2.1.0 en - Us 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.
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.
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.
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:
§ 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.
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:
o Network configuration
o Windows configuration
o Database configuration
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.
§ SE Suite update
§ Network configuration
§ Windows configuration
§ Database configuration
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.
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.
§ Port to the e-mail server (if the SMTP protocol is being used).
§ IIS 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.
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;
§ User must change password at next logon: Uncheck this option, if checked;
§ 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.
6. After filling in the required fields, click Create and then on Close;
9. Click Add;
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:
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;
§ Variable value: Enter the JAVA directory, for example: C:\Program Files\Java\jre8
8. Click on OK;
10 In the Variable value field, type: %JAVA_HOME%\bin before the first instruction, as shown in the
image below:
§ 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
Static C ontent
Default Document
HTTP Errors
HTTP Redirection
Security
Basic Authentication
Application Development
ISAPI Extensions
ISAPI Filters
C GI
Performance
Management Tools
3. Click Next on the other screens of the installer and wait for the installation to finish.
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.
6. Select the path Java was installed in your system, for example: C:\Program
Files\Java\jre1.X_XX.
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
The values entered above are the minimum necessary for SE Suite to work correctly.
§ Oracle
§ PostgreSQL
ATTENTION
Refer to the SE Suite - System Requirements document for more details on SQL Server considerations.
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.
9. On the left side of the General page, in the Login name, enter a name for the login.
Example: sesuite
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.
Network configuration
It is necessary to enable the TCP/IP connections in SQL Server Configuration Manager. See the steps
below:
19. In the hierarchical tree, expand the SQL Server <version> Network Configuration item.
26. In each existing IP, check whether the port defined in TCP Port is 1433.
If you do not need to configure another database, continue with the SE Suite installation from the
Installation activity section.
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
Refer to the SE Suite - System Requirements document for more details on Oracle considerations.
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.
Substitute the <tablespaces_directory> for the path where the tablespace must be created on the
Oracle server.
Substitute the <tablespaces_directory> for the path where the tablespace must be created on the
Oracle server.
5. To create a user for SE Suite and define the necessary permissions, execute the following steps:
Substitute <SESUITE> and <PASSWORD> for the user's name and password respectively.
§ VALUE1:
§ VALUE2:
§ VALUE3:
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
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:
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:
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.
§ Key: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ORACLE\KEY_OraClient11g_home1
§ Record: ORACLE_HOME_KEY
Only the path should be adjusted, by inserting "Wow6432Node", leaving the rest as it is.
If it is not necessary to configure another database, continue with SE Suite installation from the Installation
activity section.
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
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.
This procedure must be performed on the server where SE Suite will be installed.
13. Execute the installation file and follow the software instructions.
15. Click on the Add a connection to a server button to add a connection to the database server.
18. In Port, enter the PostgreSQL port. The default port is 5432.
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.
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:
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:
28. Locate the listen_addresses parameter and change its value as shown below:
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:
32. Access the PostgreSQL directory where the folders will be created or use the PostgreSQL default
Data folder.
39. Set Full Control permission in the Allow column for this user.
42. On the left side, in the Object Browser menu, select the default server and connect to it.
44. On the New Login Role screen, on the screen that will be displayed, fill in the following fields:
§ 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.
Creating Tablespaces
48. Select New Tablespace and fill in the following fields on the screen that will be displayed:
§ Location: Enter the directory for the SOFTEXPERT_DATA tablespace folder. Example: C:
\Program Files\PostgreSQL\8.x\data\SOFTEXPERT_DATA.
49. Still on the tablespace creation screen, access the Privileges tab.
Creating databases
53. Select New Database and, on the screen that will be opened, fill out the following fields:
54. Still, on the database creation screen, access the Privileges tab and select ALL.
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:
§ SE Suite installation
§ System configuration
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.
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.
§ The installation tool must be executed with administration permission. To do that, right-click and select
the "Run as administrator" option.
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.
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.
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.
§ 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.
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.
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.
§ SSL configuration
§ Database configuration
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/).
3. Paste the files with .jar extension into the "<JAVA_HOME>\lib\security" directory.
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:
§ At least 6 characters;
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:
2. To add a database, click on the button and fill out the following fields of the screen that will be
displayed:
§ 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:
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.
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:
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.
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:
3. At this point, the deletion process will start. When finished, click on Next.
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:
§ 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
3. Press Enter;
Tomcat service
8. Go back to the services manager (services.msc) and search for the PDF Converter service;
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.
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.
§ Post-installation activities
§ PDF conversion
§ Workstation configuration
§ Troubleshooting
§ Environment vulnerability
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.
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.
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.
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:
Decompress it and run the installation. Remember that, before executing the MSI, it is necessary to
uninstall SE Viewer.
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.
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 under analysis will be converted to planning (revision in the draft step).
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.
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.).
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.
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.
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.
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.
§ Changing from the release/test environment to the production environment is allowed, but the current
production environment will become a release/test environment;
1. First, access the Customer center and log into the portal.
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.
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:
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:
3. Refer to the Directory and authentication service documentation for further details about the
desired configuration.
All the procedures below must be executed on a Windows server, on which FileManager will be installed, not on
the SE Suite server.
Note: If there is more than one domain used for the same database, change to the most common one.
4. In the <connectionName> field, enter the same information that is in the <domain> field;
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
c) Click "Properties";
g) Double-click on "Path";
11. Access the folder where the "FileManagerInstaller.zip" was decompressed in step 9:
cd C:\Users\Administrator\Desktop\FileManagerInstaller
C:\SEFILEMANAGER
Note: There must not be an active installation of Tomcat on the same server.
20. Click on the "Log On" tab and then "This account";
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";
28. In the "Identity" tab, check "This user" and fill it in with the user created in step 16;
30. Copy the database_config.xml file copied in step 5 into the conf folder of FileManager:
C:\SEFILEMANAGER\conf
33. Confirm if the <server> field is pointing to the correct database server;
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);
Note: During the Oracle client installation, select the "Administrator" mode (complete).
41. Still, in the tnsnames.ora file on the server where FileManager is being installed, confirm the HOST
field;
ping <HOST>
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);
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);
46. Ensure that the time of the FileManager server is less than 5 minutes apart from the SE Suite
server;
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;
55. Click on the checkbox next to the "Port" field to test the connection;
Test
http://stackoverflow.com/questions/4408538/exportasfixedformat-with-excel-fails
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.
cd c:/ScaleService
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.
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;
7. Click on the Start Windows menu, type "regedit", click on the option and wait for the screen to
open;
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;
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:
§ 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
The following configuration must be set on the SE Suite server after installing Microsoft Office.
If you wish to use FileManager, configure the following on the FileManager server.
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
[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:"
§ Firefox configuration
§ OpenOffice automation
§ MSI installation
The activities in this section must be executed on all the workstations that will access SE Suite.
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.
§ 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
6. Click OK;
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;
2. On the Content tab, in Block pop-up windows, click on the Exceptions button;
4. Click Close to close this screen and then click OK to close the Options screen;
6. Access the Plugins tab and check if the installed and enabled Java plugin exists;
C:\Windows\Temp
C:\Program Files\Java\jre8\lib\ext
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.
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.
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).
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.
<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
;extension=php_curl.dll
3. Remove the semicolon at the beginning of the line and save the file.
4. Restart SE Suite.
IIS service
3. Press Enter.
Tomcat service
Memcached service
8. Go back to the services console (services.msc) and search for the memcached service;
10. Go back to the services manager (services.msc) and search for the PDF Converter service;
Java 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
15. Locate and finish the Java service which contains the following command line:
§ 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
3. Press Enter;
Tomcat service
Memcached service
8. Go back to the services console (services.msc) and search for the memcached service;
10. Go back to the services manager (services.msc) and search for the PDF Converter service;
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
See below some configurations that may be required to start the SE Suite service:
SE Suite in Windows:
§ Execute the "Tomcat monitor" application (TOMCAT_HOME\bin\tomcat7w.exe)
§ 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).
§ 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.
§ 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.
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.
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.
Solution: For Windows environments, refer to the memory configuration procedure described in the Apache Tomcat
installation section.
Solution:
1. Open the SUITE_HOME\web\php\php.ini file and search for the message variable.
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
4. After locating the variable, define the correct value, as described in the message.
Solution:
1. Open the SUITE_HOME\web\php\php.ini file and search for the message variable.
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
4. After locating the variable, define the correct value, as described in the message.
Solution:
1. Open the SUITE_HOME\web\php\php.ini file and search for the extension described in the message.
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
zend_extension=php_opcache.dll
4. After locating the extension, define the correct value, as described in the message.
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
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:
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.
2. Check whether there is another service using the port of the indexer.server.port parameter.
If affirmative, select an available port.
'java.lang.UnsatisfiedLinkError'
2. At this point, the connection data will be displayed. Click on the 'Save and exit' button:
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.
§ 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.
§ 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.
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
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.
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.
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:
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.
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
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.
§ 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.
Chapter VII
Document history
The table below describes the main changes made to this document.
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.