Installation and Configuration Datasul 12.1.7
Installation and Configuration Datasul 12.1.7
TOTVS S.A.
2 Installation and Configuration Datasul 12.1.7
Sumário
TOTVS S.A.
Contents 3
Configuration
.........................................................................................................................................................
for Progress programs access 30
Configuration
.........................................................................................................................................................
for Plan Management access 30
Delivery
.........................................................................................................................................................
configuration of authentication e-mail 30
Translation
.........................................................................................................................................................
Matrix in EMS 5 31
Installation
.........................................................................................................................................................
of Plug-in CRM Outlook 31
Checking
.........................................................................................................................................................
environment after installation 32
5 Update
................................................................................................................................... 32
6 Reinstallation
................................................................................................................................... 32
7 Uninstallation
................................................................................................................................... 33
TOTVS S.A.
3
4 Installation and Configuration Datasul 12.1.7
1 Installation Datasul 12
1.1 Purpose
This guide aims at describing the necessary procedures to install Datasul 11 product, as well as, setting
the product in the supported platforms. Installation media can also be used to update programs.
architecture, database (Progress/Oracle/SQL Server), Java, Flex, Jboss and net environment.
Installation
This chapter describes the procedures that must be run for product installation. It covers since the
installation planning, that is, choosing the proper installation type, until necessary configuration for remote
access.
Update
This chapter describes the product update procedure.
Reinstallation
This chapter describes the procedures to be run for re-installation of each Datasul 11 component,
as well as, the necessary precautions for this routine run.
Uninstallation
This chapter describers the necessary procedures for Datasul 11 uninstallation.
TOTVS S.A.
Installation Datasul 12 5
Jboss Guides
Installation Guide;
Getting Started Guide;
Server Configuration Guide.
Get these and other documents at Jboss AS Documentation and Jboss Wiki.
1.2 Introdução
TOTVS S.A.
6 Installation and Configuration Datasul 12.1.7
Database
It installs and configures the database used by the product, as well as, the scripts to load and drop
these databases.
Application Server
It installs and configures Jboss, as well as, the Datasul Interactive, and these components are
essential for product work.
Document
It installs the product document guides.
TOTVS S.A.
Installation Datasul 12 7
Database, Application Server and Document options, following the maximum limit of six
instances. Each installed instance is named based on the main port used by Jboss, following
the sequence 8080, 8180, 8280, 8380, 8480 e 8580. The folders, scripts and services used in the
first installation of the options mentioned are named after the identifier 8080. To install a
second instance of these options, open the media installer and run these same options
again. At each new run, a new copy is installed and named based on the sequence described
above. The programs area is the same in the environment and shared by all instances.
During Datasul products installation, a notification is displayed for customers using determining
antivirus, accusing the virus identification in the “OCX” and “Interfac” directory files. It happens as files run
routines that some antivirus identify as virus. However, they do not characterize instructions of this type.
Therefore, the message displayed is disregarded.
security and reliability level, the customer desires from the environment. This guide positions are also
changed due to the progress of technologies and our products;
Remember the Web environment used by Datasul 11 has greater complexity than an environment
of standard client/server, as for instance, EMS 2, EMS 5, etc. The proper configuration and tuning of
environment (servers, nets, clients, database, etc.) are important for Datasul 11 working, as in case part of
the environment is improperly configured, the product performance as a whole is affected.
The recommendation and examples mentioned below only take in consideration the softwares
related to Datasul 11 and generic use softwares, such as Office and e-mail. If other softwares are installed
in the same environment, they must be be taken in consideration, wherein the requirements described are
probably not enough for all routines run.
The Infra Structure (DMZ, net etc) and third party softwares (Operational Systems, Java etc)
TOTVS S.A.
8 Installation and Configuration Datasul 12.1.7
configurations necessary for product work are responsibility of the customer. If you need the support of the
Infra Structure team, contact TOTVS Infra Services through e-mail [email protected] or contact
through phone number 4003-0015 in the options 3, 4, 2 - TIS Scheduling Central.
Servidor
30 us ers (whi thout cons i deri ng DCFW, Ci tri x a nd others )
Hardware
Disk 120 GB
Memory 4 GB
Processor Intel Xeon Dual 2.00 GHz
Software
¹ The load and Jboss shutdown scripts are sent to the mentioned operational systems for customer
convenience. For these scripts configuration in other operational systems, contact Jboss support in its
location or access TOTVS phone consultancy for monitoring.
² From version 12.1.1, media is released for Progress 10.2B and another one for Progress 11.3.3, where
the customer must download, as environment migration planning.
In Progress 11.3 was released the implementation of programs with 64-bit client (prowin.exe), but Datasul
12.1.1 is approved to run only with 32-bit client (prowin32.exe).
Customers using Progress 11.3 should apply service pack 3 and FIX 017 (11.3.3.017).
Customers using Progress 11.5 should apply service pack 1 and FIX 005 (11.5.1.005).
Client Station
Wi ndows
Hardware
TOTVS S.A.
Installation Datasul 12 9
¹ For the season the same client that having 64-bit operating system is recommended to be done 32-bit
JRE installation, this due to the applications used by Datasul be 32-bits.
² The Chrome browser can be used only to environments that use MenuHTML
We do not recommend the usage of stations smaller than the minimum mentioned above, as the
performance does not meet the user needs. If the company has several stations with less configurations
than the minimum amount recommended, we suggest you use the Graphic Terminal Servers resources
using the existing hardware.
The configuration recommended meets the majority of the users, but, for the most demanding
users, maybe there is the need of a better configuration. We understand a 'most demanding user' as the
one using heavier processes (the need of a better CPU and a faster network card and/or connected to a
switch port dedicated to it) or a user with several simultaneous application (need of more memory to run
process as Office, e-mail, CAD, EIS etc., at the same time).
We recommend the minimum configuration above mentioned for new equipment, if the company
purchases new stations and want to use them for a long time without the need of upgrade and without
becoming obsolete. Configurations the hardware suppliers are currently offering and that have a new
relation cost/benefit are also taken in consideration.
TOTVS S.A.
10 Installation and Configuration Datasul 12.1.7
For all cases, we recommend the update of network card of first line suppliers.
For other types of installations, such as Application Server, Database and Programs, we
recommend the user of Dimensioning service that can be requested through the contacts below:
Architec
t Flávia Wiliam Victor Antonio Alinne
flavia. wiliam. victor. antonio.
polido@totvs. abreu@totvs. janusz@totvs. rodrigues@totvs. alinne.ciancio@totvs.
E-Mail com.br com.br com.br com.br com.br
Landlin
e phone 11-2099-7520 11-2099-7307 11-2099-7188 11-2099-7398 11-2099-7870
Mobile 11-98853-1479 11-97677-4305 11-98899-4684 11-99953-8025 11-99198-2681
Acre ABM Argentina Brasília Amapá
Centro-Oeste Centro-Norte de
Paulista Jurídica Minas Curitiba Amazonas
Centro-Oeste de
IP São Paulo Minas Goiás Bahia
Mato Grosso Espírito Santo Metropolitana Ceará
Mato Grosso do
Sul Leste de Minas Paulistana Maranhão
Rio de Janeiro México Private Para
Service Roraima Minas Gerais Triah Paraíba
São José do Rio
Preto Nordeste Vale do Paraíba Paraná Central
Norte
Sul Fluminense Fluminense Piauí
Tocantins Sul de Minas Rio Grande do Norte
Triangulo
Mineiro Rio Grande do Sul
Zona da Mata Santa Catarina
Sergipe
TOTVS S.A.
Installation Datasul 12 11
The station client must have Windows operational system installed, as Datasul 11 uses language
Progress in architecture 32-bit (Win32). Additional information in relation to operational platforms and
systems validated can be obtained in Progress site (Product Availability Guide).
1.3.3.2 Progress
Openedge Windows Server It is installed in the database server for Progress base
Enterprise administration routines run.
RDBMS Unix
Openedge Windows Server Only used with Oracle database. As it is installed in
DataServer for clients (DataServer Local) or in server (Remote
Oracle Unix DataServer)
OpenEdge Only used with SQL Server database. As it is installed in
DataServer for Windows Server clients (DataServer Local) or in server (Remote
Microsoft SQL DataServer)
Openedge Windows It is installed in application server for configuration of
Application Server services as AppServer, Webspeed, WebServices etc.
Enterprise Unix
NOTIFICATION: Only one type of license related to database is released (Openedge Enterprise
RDBMS, Openedge DataServer for Oracle or Openedge DataServer for Microsoft SQL) according
to database managerial system used in its company.
1.3.3.3 Java
The JBOSS when configured in an Operational System 64-bit, install Java 64-bit (JRE) in the same
version 7.
For workstations, use version 32-bit of JAVA 8.
TOTVS S.A.
12 Installation and Configuration Datasul 12.1.7
To run Datasul 11 in client stations, you need the Flash Player. If it is not installed, the Flash Player can be
To run Progress programs through Internet, use third party remote access tools. Program Datasul
11 is validated and has remote access configurations for GoGlobal version 4, Citrix (Citrix Presentation
Server Version 4.5) and Terminal Server. To use Server Terminal, the server must have an operational
If you use an existing instance, the following recommendations must prevail against other non
TOTVS products. To check the values of existing base parameters, proceed with the following queries
and analyses the results:
select parameter, value
from nls_database_parameters
where parameter = 'NLS_CHARACTERSET'
NLS_LANGUAGE AMERICAN
NLS_TERRITORY AMERICA
NLS_CHARACTERSET WE8ISO8859P1 OU WE8MSWIN1252
NLS_NCHAR_CHARACTERSET AL16UTF16
TOTVS S.A.
Installation Datasul 12 13
by initialization parameter (db_block_size), it must be recreated. If possible, create a new database for
Datasul products
Cursors Availability: We recommend administrate a value higher than the instance installation
standard in the initialization parameter (open_cursors) Start with value 32000 or higher.
Workstations: Install Oracle Net Service in each station. Never install this product with language
other than English. The NLS_LANG must have the database CharacterSet ( AMERICAN_AMERICA.
The product was validated to be run with SQL Server 2012 and the hardware and software requirements
Confirm the TCP/IP protocol is enabled for SQL Server instance used. SQl Server Express
instances do not have this protocol enabled by standard.
For these workstations, install SQL Server Native Client 10.0, so access to Datasul 11 product is
administrator group.
1.4 Installation
TOTVS S.A.
14 Installation and Configuration Datasul 12.1.7
according to types of installation available in media (Programs, Database and Application Server).
Define environment topology. In this stage, define where each component is installed. Choose
hardware used as database server, files server, application server and the machines that are
available to users as well. For each of theses components, check if hardware and software
requirements are met;
Datasul 11 has the Security by Site functionality, aiming at defining whether each user can view
information of a determined site.
This feature enables the Industrial databases to be used as Multi-Company with information
separated by Sites. The Security by Site can be applied both in Unified Databases (Multi-Company) and
separated.
This functionality has some features and rules that must be clarified and assessed before its application.
1.4.3 Installation
NOTIFICATION: If you receive media in DVD, before starting installation, copy all DVD2 content
for DVD1. Without this, installation is interrupted in the middle of the process. When media
download is performed through the Support Portal, all zip files must be unzipped in the same
directory.
TOTVS S.A.
Installation Datasul 12 15
The stages below are common for all types of Datasul 11 installation:
Special characters are not allowed in this field, as errors may occur in product access.
Drive Screen available
Drives available for product installation are displayed on this screen. Select a drive, then click Next.
Remember only local drives are displayed (mapped units are not displayed).
After clicking Next, a screen indicating whether space in disk is enough for media installation is displayed.
If there is space, only an information screen is displayed, indicating space is enough. If there is space,
installation questions whether you want to select another drive. If negative, installation is not proceeded. In
this case, release space in disk and start installer again.
Installation type screen
Select the installation type run this moment. Remember the displayed order must be followed:
Programs
Database
Application Server
Document
Select “Next” to continue.
Next chapters describe procedures that must be run for each installation type.
TOTVS S.A.
16 Installation and Configuration Datasul 12.1.7
Installer OpenEdege 11.3 has binaries compiled for both 32-bit and 64-bit. Select option "Progress
11.3" for environment using Windows or Linux, 32-bit or 64-bit. Option TTY serves for character
environments and for Web, 32-bit or 64-bit applications.
TOTVS S.A.
Installation Datasul 12 17
To continue this process, select "Next". In this moment, programs start to be installed. At the end of
the process, the installer returns to Installation Type selection screen.
TOTVS S.A.
18 Installation and Configuration Datasul 12.1.7
This screen defines if Progress “conmgr.properties” file is configured. This is a file responsible by
Explorer Tool.
With this installation, a “conmgr.properties” file is also created below the “scripts” directory of
database installation with databases configuration used by Datasul 11.
Save necessary changes for conmgr.properties.new file
When selecting this option, “conmgr.properties.new” file is created below “properties” directory of
Progress installation and Progress original “conmgr.properties” is not changed.
In this case, before starting the AdminService service, rename “conmgr.properties.new” file for
“conmgr.properties” and then, you can view databases by Progress Explorer Tool.
With this installation, a “conmgr.properties” file is also created below the “scripts” directory of
database installation with bases configuration used by Datasul 11.
Do not change
When selecting this option, “conmgr.properties” file is created below database installation “scripts”
directory, with database configuration used by Datasul 11 and “conmgr.properties” file below
TOTVS S.A.
Installation Datasul 12 19
Bases used by product are configured to be started by Progress Explorer Tool (proexp). This
application Progress is a graphic tool enabling you to create, configure, start and stop services managed
by local or remote AdminService as, for instance, database, Webspeed, AppServer, among others.
The administration of databases and services configured in Progress Explorer Tool can also be
run through command line.
The configuration performed in Progress Explorer Tool during database installation is basic, that
is, enough to start databases and run access test to product. After finalizing Datasul 11 installation and
configuration, the parameterization of databases and sessions (.pf) must be revised, adjusting them
according to resources available in database server and connections/processes volume with the purpose
of meeting requirements with better performance.
The analysis of environment and adjustment of parameterization can be performed together to the
Database consultancy by phone number 4003-0015, options "02" Software > "03" Technical Consultancy
> "04" Datasul > "08" Technology > "03" Database. Additional information on this service can be obtained
in phone support by phone number 4003-0015, options "02" Software > "02" Technical Support > "04"
Datasul > "08" Technology > "03" Database.
Installation media does not automatically create database for these operational systems (Linux, AIX,
TOTVS S.A.
20 Installation and Configuration Datasul 12.1.7
HP-UX, HP-UX Itanium, Solaris, etc.). Therefore, database media must be installed in Windows
Bases “emsdev”, “emsfnd”, “payroll2”, “finance”, “ems2sor”, “mdtfrw”, “mdmerge”, “mdtcrm” e "eai2"
have SQL access and must be created according to procedures described below (for operational system
that are not Windows or for databases manually created). Definitions (.df e .dfsql) can be obtained below
pro -Mm 4096 -cpstream ibm850 -d dmy -E -rx -db <database> -1 -p _admin.p
Run definitions (.df) load by “Admin > Load Data and Definitions > Data Definitions (.df file)” for
databases “emsfnd”, “ems2uni” e "eai2";
Create “sysprogress” user, “sysprogress” password and “pub” user, “pub” password by “Admin > Security >
Edit User List”;
Close session Progress and load database with broker SQL
proserve <database> -S <port> -N TCP -H <database server name> <parameters>
proserve <database> -S <port> -N TCP -H <database server name> -m3 –ServerType SQL
<parameters>
Access a client Windows with installed Progress;
Access the “proenv” from Progress in “Start > Programs > Progress > Proenv”;
Run load of definition (.dfsql) for databases “emsdev”, “finance” e “payroll2”;
sqlexp –user sysprogress –password sysprogress -url jdbc:datadirect:openedge://<database server
name>:<port of broker SQL>;databaseName=<database> -infile <file.dfsql>
TIP: The broker port is the one defined for parameter "-Y" when loading the database with
TOTVS S.A.
Installation Datasul 12 21
Connect through SQL Explorer the “mdtfrw” database and give permissions of DBA for “pub” user,
through commands below:
sqlexp –user sysprogress –password sysprogress -url jdbc:datadirect:openedge://<database server
name>:<port of broker SQL>;databaseName=<database>
Below, the files for creation of objects and administration of environment created for installation of
Oracle database.
TOTVS S.A.
22 Installation and Configuration Datasul 12.1.7
The installation media does not automatically create objects in Oracle database. To create these
objects, the “gerenciadorScripts.sql” script must be manually run according to procedures below:
Access the Sql Plus with the “System” user in instance where the objects are created;
Run the command “@<Dir Instal Bancos>\scripts\gerenciadorScripts.sql”;
Check whether errors were created in log files at the end of the process in “<Dir Instal
Bancos>\spool” directory.
TOTVS S.A.
Installation Datasul 12 23
Below, the files for creation of objects and administration of environment created for installation of
The installation media does not automatically created the objects in SQL Server database. To
create these objects, the “gerenciadorScripts.bat” script must be manually run according to procedures
below:
Enter directory “<Dir Instal Bancos>\script”;
Run the script “gerenciadorScripts.bat”;
Check whether errors were created in log files at the end of the process in “<Dir Instal
Bancos>\spool” directory.
The new connection with SQL Server database does not need to be performed in each station,
ensuring information to be centralized in configuration file.
In this case, the better method is to enter all connection parameters in the command line or in
parameters file (file .pf), method also know as DSN-less.
A DN-less (Data Source Name-less, or connection without database) enabling the application to
specify all parameters directly in the connection line to the database, without the need to configure a
ODBC data source.
A line for DSN-less connection with SQL Server driver is:
TOTVS S.A.
24 Installation and Configuration Datasul 12.1.7
(GoGlobal), Citrix or Terminal Server, option “Yes” must be selected. Otherwise, option “No” must be
selected to proceed with the installation. When selecting option “Yes”, the selection screen of remote
access type is displayed. Select the installation type and fill out as requested:
Datasul Connection for Web
URL: URL that has libs of Datasul Connection for Web (GoGlobal);
Server: Enter the server where the Datasul Connection for Web is installed;
Port: Enter a port available in server for communication between the Jboss and
Datasul Connection for Web.
Terminal Server
Port: Enter a port available in server for communication between the Jboss and
Terminal Server;
Server: Enter the server where the application published in Terminal Server;
Metaframe Port: Enter port used by Terminal Server.
Citrix
URL: URL in which the DatasulCtxWI is published (check configuration Citrix in this
TOTVS S.A.
Installation Datasul 12 25
Guide);
Enter server name where database are installed of Datasul 11 product. Select “Next” to continue.
Single Sign On Screen
The Single Sign On (Josso) is installed and configured in the Jboss. Therefore, enter the hostname
of the application server where the Jboss is installed and the communication port with Jboss.
Select “Next” to continue.
Nameserver Screen
Enter the machine name and Nameserver port number of Progress. If not changed, standard port is
5162. This information is used for connection with AppServer created during installation. Select “Next” to
continue.
TIP: This information can be obtained in “ubroker.properties” file located below of Progress
“properties” directory. Parameter defining the communication port with Nameserver is the
“portNumber”, below the structure [Nameserver] or [Nameserver.XXX]. As default, the
TOTVS S.A.
26 Installation and Configuration Datasul 12.1.7
Tool.
“ubroker.properties” and then, you can view “Datasul” AppServer by Progress Explorer Tool.
Do not change
When selecting this option, “ubroker.properties” file is created below database installation “scripts”
directory, with AppServer service configuration used by product and “ubroker.properties” file below
Progress installation “properties” directory is not changed.
In this case, before starting the AdminService service, copy “ubroker.properties” file below “scripts”
directory for Progress “properties” directory, and then, you can view AppServer services by Progress
Explorer Tool.
Screen of License Server Configuration
Enter the License Server and port.
Information screen of installation
This screen has a summary of entered information on previous screen. If any information is
NOTIFICATION: The user password entered cannot have character "&", wherein it causes
failure in Jboss initialization. Enter user and password valid in AD without domain and
extension, otherwise, you cannot configure the authentication file used by Josso.
TOTVS S.A.
Installation Datasul 12 27
These are important objects for management of environment, created in the application server
installation.
TOTVS S.A.
28 Installation and Configuration Datasul 12.1.7
Enter external strings files location (<Dir Instal Programs>\univdata\pt.d), messages (<Dir Instal
Programs>\univdata\msg.d) and literais (<Dir Instal Programs>\univdata\liter.d). Select u to continue.
Also tell whether to ignore the import of the lyrics in English and Spanish. Select ">" to continue.
Initialization screen of “emsdev” database
On this screen, enter parameters file location (<Dir Instal Programs>\fnd\men\importer\parameters-
[instance].properties), according to the instance being initialized. Enter location directory “.jar” files (<Dir
Instal Programs>\fnd\men). Select ">" to continue.
Configuration Screen Database X Company
Database displayed on screen are the same ones configured for “.pf” file connection below the
structure “<Dir Instal Programs>\scripts”. Select “Start” to continue. This screen is only informative, and you
cannot change connection data through it.
Performance Optimizer
This function improves the environment performance to which the dictionary triggers refers. With
this program run, the triggers with codes are enabled, and triggers not being used are disabled. We
recommend the performance optimizer run in initialization (option “Yes”).
In this moment, the product initialization is run.
The last initialization process stage is the database import for “emsdev” database. During this stage,
the initialization screen is locked. At the end, “btb907za.txt” file is displayed on screen generated below the
programs installation root directory. This file is a run procedures log. The initialization screen is released
after closing log file.
After checking the generated log, close file and select finishing the process.
TOTVS S.A.
Installation Datasul 12 29
script below the root directory of programs installation. After running this script, check the
After product initialization, you must configure business so information is displayed according to
desired in Datasul 12 desktop.
But, before accessing the product, the following procedures must be run:
Start database;
You can start the Progress database through OpenEdge Explorer or script “datasulCargaBancos.
bat”.
Start AppServer “datasul-[ID]-[instance]” service;
You can start the AppServer through OpenEdge Explorer or through the command line by “asbman”.
Start Jboss “TOTVS Datasul” in “Control Panel > Management Tools > Services”;
Start TOTVS License Server service;
When the databases automatically created by installation media are not used, you must permit
select and update for user pub in sequences seq_configur and seq_propried. This permission directly
affects the user configuration persistence. If there are no permissions for Sequences, no user configuration
is saved with several errors on screen.
Access the SQL Explorer through the Proenv, connecting the emsfnd database;
Sqlexp –db emsfnd –H <hostname> -S <service> -user sysprogress –password
sysprogress
TOTVS S.A.
30 Installation and Configuration Datasul 12.1.7
At the end of installation, Progress programs are available for access only through server where
installation is made. For the access to these programs to be available to all net stations, follow the
If Plans Management is used, create a shortcut specifically to access it in the product. In this case,
the steps below must be followed:
Create a shortcut in config.xml, pointing to a .INI file where the v6Keys value is = Yes. The Plan
Management programs must be run at this shortcut;
Create a shortcut in config.xml, pointing to .INI file where the v6Keys value is = No. This shortcut is
used to run programs of EMS 2/ EMS 5/ HCM.
When the customer e-mail server demands authentication for e-mail delivery, create an e-mail
specific account for Datasul product and configure it in mail-service.xml file in Jboss.
Check if in mail-service.xml file (located in <Jboss>\server\<instance>\deploy), there is a
configuration below to allow e-mail messages to be sent to external e-mails with user authentication:
<property name="mail.smtp.auth" value="true"/>
If positive, it is configure to use authentication of user, so whenever an e-mail is sent, the recipient is
TOTVS S.A.
Installation Datasul 12 31
the one defined in mail-service.xml file. The a-mail used in "replyTo", that is, for e-mail answer, it will also
After a new installation of Datasul 11 product, a Translation Matrix is created for External
Organization in EMS 5 (prgint/utb/utb118aa), if it does not exist.
The matrix is used to identify the organizational unit of EMS 5 corresponding to organizational unit
of EMS 2 related to the user. It is also used when the user changes company in Datasul system (procedure
“Exchange Company User”).
There must be at least one relationship record between the company of EMS 2 with company of
EMS 5.
The External Organization Translation Matrix must have the name “EMS2” and the “Organization
Origin” must be EMS. If there already is a matrix called “EMS2”, it is the official used in the integration
between EMS 2 and EMS 5.
In the matrix, all companies and sites used in EMS 2 must be registered as below:
To install the plugin, copy the 2 files located in the folder 'crm-outlook' of Datasul 11 product
installation media for a temporary folder in user station.
Run file 'setup.exe', then follow the installation steps. To use the plugin, you must have the Microsoft
Outlook 2010 installed in the station.
TOTVS S.A.
32 Installation and Configuration Datasul 12.1.7
A check-list of the environment enabling the installation and detection of installation failures is
available.
Below the environment check-list:
Check if the items displayed in the requirements chapter were met;
Check if AdminService service is started;
Check if database are loaded
Check if ports used in database load are the same ones defined for their connection;
Check if AdminService service is started;
Check if the Jboss service started without errors in log;
Check if “config.xml” file located below in the structure “<Dir Instal Programs>\scripts-8080” is
properly configured wherein it is the responsible for Progress programs run. If there is any empty tab,
it must be commented or removed;
Check if datasources (“progress-ds.xml” or “oracle-ds.xml” or “mssql-ds.xml”) located in “deploy”
directory of Jboss instance wherein it is responsible for the communication with database. For
Progress environments, this file must point to the ports corresponding to SQL brokers;
Check the existence of “datasul_framework.properties” file located below the structure
“jboss_home\server\instance-8080\conf\datasul” wherein it is responsible for the run of integrated
services with Jboss such as AppServer, Totvs License Server, Flex, among others;
1.5 Update
The product update process is performed through the Update Console. The Update Console
Guidelines are available in “D@ - CAT” Community Documents area in Fluig.
1.6 Reinstallation
Reinstallation is run for any of the product components (programs, database and application
TOTVS S.A.
Installation Datasul 12 33
server), running the installation media setup again. But, before running this process, some verification must
be performed.
NOTIFICATION: It is extremely important to backup current environment before the
reinstallation of any component.
Programs
If the product is operational, select a different programs area from the one used by production
environment. Reinstallation can be used to install programs compiled in Character 32-bit or Character 64-
bit environment for example.
Database
If the product is operational, select a different database server or area from the one used by
production environment. If the same area is entered for reinstallation, all data added until present time are
deleted. Only overlap files if you are sure about your needs. Besides, when reinstalling database, run
initialization run of product again. In Oracle and SQL Server environment, it is recommendable a backup of
Schema Holder before reinstallation to avoid synchronism problems.
Application Server
In Application Server reinstallation, not existing objects are created and existing objects are
substituted. Installation media perform all configurations again.
1.7 Uninstallation
Run uninstallation process only when you do not need components installed in each server wherein this
routine must be run from the server where each component is installed.
To uninstall product in Window environment, select option “delete” from “Datasul 11” in “Start >
Configurations > Control Panel > Add or Delete Programs”. During this process, a deletion confirmation is
requested and a screen of process conclusion is displayed.
This procedure does not delete all files created in the installation process as logs and temporary
files. In this case, check the directories used for installation of components and delete the remaining
objects as necessary.
2 Datasul 12 Configuration
TOTVS S.A.
34 Installation and Configuration Datasul 12.1.7
2.1 Purpose
The purpose of this Guide is to describe Datasul 12 product configurations displaying the file
where each configuration is performed. Additional information can be located in chapter “Important
Documents”.
TOTVS S.A.
Datasul 12 Configuration 35
2.2.1 Database
Database “emsdev”, “emsfnd”, “mdmerge”, “mdtfrw”, “finance”, “payroll2”, “ems2sor”, “ems2cad”
and "eai2" are directly accessed by Jboss. For this access, datasources are created through progress-ds.
xml file (Progress environment) or oracle-ds.xml (Oracle environment).
List the most important attributes and respective functions:
There may be more than one connection for the same database, but with different JNDI. If you
need to change the file, be careful about changes in correct place and for all necessary datasources.
For Progress environment, username must be “PUB”, as tables are created below this user.
2.2.2 AppServer
AppServer configuration is performed in datasul_framework.properties file.
progress.server.name=JAGUARIBE
progress.server.port=5162
progress.server.application=datasul-1151-progress-8080
progress.server.maxconnections=5
Description:
progress.server.name: Server where broker AppServer is configured;
progress.server.port: NameServer Port;
progress.server.application: Broker AppServer Name;
progress.server.maxconnections: Maximum quantity of agents that Jboss uses.
If message “Error connecting” during Flex program run, check if AppServer broker configured in
this file is active and properly configured. AppServer broker log file also helps in problems correction.
TOTVS S.A.
36 Installation and Configuration Datasul 12.1.7
Proprieties described below can be configured for AppServer Progress. Check the configuration
that better suits production scenario. As default, all proprieties are disabled and the system works as state-
reset.
progress.server.mode=1
progress.server.statereset.controlpoolcompanyid=false
progress.server.statereset.numberreqconnsclear=-1
progress.server.statereset.evictionthreadrun=120000
progress.server.statereset.mintimeidleobjects=180000
Description:
TOTVS S.A.
Datasul 12 Configuration 37
2.2.3 Log
In JBoss, logs generation is controlled by “jboss-log4j.xml” file. This file defines a group of
"appenders" basically are log output. As default, JBoss is configured with output for console and log file
(server.log).
The log level to be configured depends on the type of information you need. Datasul 11 product is
configured with log for "ERROR" which means only error messages are displayed in file. This is the proper
configuration for a production environment, so informative messages are not saved in log, making the file
bigger and difficult to be read.
There are six log levels: TRACE, DEBUG, INFO, WARN, ERROR and FATAL. When one of these
levels is defined in the file, all messages above the chosen level are also registered. That is, if level "INFO"
is chosen, all equal messages or superior to this level are written in log (INFO, WARN, ERROR and
FATAL).
The example below is of an appender with output for file, configured as "INFO":
To change the log level, change “Threshold” from "INFO" to desired value. After changing, you do
not need to restart the instance. The jboss-log4j.xml is the only configuration file of JBoss that does not
demand instance restart. The change becomes effective in 60 seconds maximum after saving the file.
In standard configuration of product, the log rotate is performed at each hour. At the beginning of
each hour, the log current log is renamed and log is generated in another file with the same name.
TOTVS S.A.
38 Installation and Configuration Datasul 12.1.7
Configure log according to its need, aiming at not generating huge size files. You can configure a log rotate
by: month, week, day, midday, hour and minute. To change it, edit the value of option “DatePattern” as table
below:
DatePattern Period
'.'yyyy-MM Rotates log at each month
'.'yyyy-ww Rotates log at each week
'.'yyyy-MM-dd Rotates log at each day
'.'yyyy-MM-dd-a Rotates log at midnight and midday at each day
'.'yyyy-MM-dd-HH Rotates log at each hour
'.'yyyy-MM-dd-HH-mm Rotates log at each minute
Besides Appenders, you can create categories The categories have specific configuration for
determined applications. For example, you can keep the log level as “INFO” and configure another
category for messages of determined application as “WARN”. The example below is of a category of
component “org.jgroups” (cluster) configured as “WARN”:
<category name="org.jgroups">
<priority value="WARN"/>
</category>
Therefore, for all applications, only the messages with “ERROR” level are displayed, but “org.jgroups”
application messages with “WARN” log level.
Get information on log levels here.
Description:
license.server: IP address or LS name;
license.port: Port configured for LS (default 5555);
license.timeout: Time (seconds) for connection with LS. If this time is reached without receiving LS
answer, the emergency key is requested;
license.showlog: Log level for LS messages. Types allowed are: none, all, error, debug, info (default:
TOTVS S.A.
Datasul 12 Configuration 39
none).
From Datasul 12.1.1, the validation of product licenses were modified to improve control and
ensure proper use of licenses. This configuration is valid for an installation and updating (Update) of
Datasul 12 where basically it consists of automatic copy of file for work stations.
In this case, when Datasul 12 is accessed by a work station, it automatically copies the dll
for directory c:\windows\, it if does not try to copy for another directory defined in Window PATH
variable due to lack of permission.
When user is not allowed to make copies in any of the directories defined in Window
PATH variable, the administrator must make a manual copy or map the server directory to add the
Windows PATH.
1st suggestion:
Copy file license_client.dll of directory...\ERP\fnd\config\
Important:
If you use remote access (Citrix, GoGlobal, TS), the license_client.dll file must be copied for directory c:
TOTVS S.A.
40 Installation and Configuration Datasul 12.1.7
values. If you need to add a new parameter, you can add one of these files in any one. The basic difference
is that “run.bat” file is used for all instances wherein the parameters defined in this file are the same for all
instances. The “service-8x80.bat” file is used by instance, enabling yo to defined different values for each of
the instances.
2.2.5.1 Linux
Jboss is installed through the media only for Windows environment. For environments where
Jboss is configured in a Linux server, the Jboss load is performed through the “run.sh” script wherein the
Consoles “jmx-console” and “web-console” are used for administrative tasks. All users with
access to the environment also access these consoles and get administrative access in the process of
Datasul 11 product JBOSS.
Some instructions below to configure the authentication for these two JBoss monitors:
1) In ..\deploy\management\console-mgr.sar\web-console.war\WEB-INF\jboss-web.xml file, enable a
security domains removing the tag “<security-domain>” comments as example below:
<security-domain>java:/jaas/jmx-console</security-domain>
<security-constraint>
<web-resource-collection>
TOTVS S.A.
Datasul 12 Configuration 41
<web-resource-name>HtmlAdaptor</web-resource-name>
<description>An example security config that only allows users with the role JBossAdmin to access the
HTML JMX console web application </description>
<url-pattern>/*</url-pattern>
</web-resource-collection>
<auth-constraint>
<role-name>*</role-name>
</auth-constraint>
</security-constraint>
<login-config>
<auth-method>BASIC</auth-method>
<realm-name>jmx-console</realm-name>
</login-config>
<security-role>
<role-name>*</role-name>
</security-role>
<jboss-web>
<!-- Uncomment the security-domain to enable security. You will need to edit the htmladaptor login
configuration to setup the
login modules used to authentication users. -->
<security-domain>java:/jaas/jmx-console</security-domain>
</jboss-web>
<security-constraint>
<web-resource-collection>
<web-resource-name>HtmlAdaptor</web-resource-name>
<description>An example security config that only allows users with the role JBossAdmin to access the
TOTVS S.A.
42 Installation and Configuration Datasul 12.1.7
<auth-constraint>
<role-name>*</role-name>
</auth-constraint>
</security-constraint>
<login-config>
<auth-method>BASIC</auth-method>
<realm-name>jmx-console</realm-name>
</login-config>
<security-role>
<role-name>*</role-name>
</security-role>
<Context>
<Realm className="org.apache.catalina.realm.JAASRealm"
appName="jmx-console"
allRolesMode="authOnly"
debug="1" />
</Context>
6) Change the user password admin in the file ..\conf\props\ jmx-console-users.properties, that are
effective for two monitors as example below:
admin=novasenha
<security-constraint>
<web-resource-collection>
<web-resource-name>HttpInvokers</web-resource-name>
<description>An example security config that only allows users with the role HttpInvoker to access the HTTP
invoker servlets </description>
<url-pattern>/restricted/*</url-pattern>
<url-pattern>/JNDIFactory/*</url-pattern>
<url-pattern>/EJBInvokerServlet/*</url-pattern>
TOTVS S.A.
Datasul 12 Configuration 43
<url-pattern>/JMXInvokerServlet/*</url-pattern>
<http-method>GET</http-method>
<http-method>POST</http-method>
</web-resource-collection>
<auth-constraint>
<role-name>HttpInvoker</role-name>
</auth-constraint>
</security-constraint>
<jboss-web>
<security-domain>java:/jaas/jmx-console</security-domain>
</jboss-web>
changed are for all instances. We recommend you remove this file configuration and put it in “service-
8x80.bat” (according to instance), so the memory configuration is different for each instance.
Below, a row example with Java memory parameters (installation media standard):
TOTVS S.A.
44 Installation and Configuration Datasul 12.1.7
In a production environment, the ideal is the Xms and Xmx equal value. Upon this configuration,
the Garbage Collector is run with less frequency. To get the ideal value of memory, you need a JVM
monitoring.
session.timeout=30
session.timeout.message=2
Description:
session.timeout: Time (minutes) the Web session is active without any user interaction with the system. If
time provided is 0 (zero), the Time Out is turned off.
session.timeout.message: Indicates how long (minutes) before the session.timeout the user message
about session being about to expire is displayed.
The users related to the exception group related to “btb927aa” (TimeOut Basic Parameters) are NOT
disconnected even if these users idleness time exceeds period determined in parameter “session.
timeout”. To disable the TimeOut, change the “session.timeout” parameter value to “0” (zero).
Important: For Progress database, adjust load parameters by adding the following parameters: -basetable
1 –tablerangesize 2500. Time Out Flex is available for Progress and Oracle environment.
2.2.8 Josso
Josso, or Java Open Single Sign-On, is an opensource infrastructure providing a centralized
solution of authentication and authorization of users. It is a component used for users login in Datasul 11
product.
Connection information to Josso are in “josso-agent-config.xml” file. In this file, three inputs are
found with server and port name. If you need to change the server name, this input must be changed.
The authentication configurations are in “josso-gateway-config.xml” file in Ldap. Upon editing the
file, the user to locate information in Ldap is used as well as the password in clear text. If the password is
changed, you can edit the file and manually change it. You can also run the “Domain.vbs” script requesting
information on screen and generating a file (LogDomain.txt) with necessary information to be added in the
TOTVS S.A.
Datasul 12 Configuration 45
file.
The configurations below can be used when you need to access Datasul 11 product through an external
IP (out of local net).
Change in “josso-agent-config.xml” file the tags “gatewayLoginUrl” and “gatewayLogoutUrl”, indicating the
<gatewayLoginUrl>http://189.100.100.100:8080/josso/signon/login.do</gatewayLoginUrl>
<gatewayLogoutUrl>http://189.100.100.100:8080/josso/signon/logout.do</gatewayLogoutUrl>
For this configuration to work properly, parameter “-b” (run.bat file) has “0.0.0.0” value indicating the
instance answers the requirements of all IP address that are configured for server.
2.2.9 Ports
The group of ports to be used by instance in “Jboss-service.xml” file. In example below, the
“ServerName” attribute is pointing to group of ports “ports-8080”:
The “StoreURL” attribute points to “ports-bindings.xml” file that is the file where the group of ports to
be used are found. By the standard installed by media, there are six groups of ports defined in the file: ports-
8080, ports-8180, ports-8280, ports-8380, ports-8480 and ports-8580. The recommendation is to change
these configurations only for Linux environment (as media does not configure the instance for Linux) and in
case you need more instances than the ports configured in “ports-bindings.xml” allow.
If you need to change any port, check if there also is any reference to this same port in the
“datasul_framework.properties” and “jboss-service.xml” files as if there are some ports configured in these
files. The logic is to sum 100 ports for instance 8180, 200 for instance 8280 etc.
TOTVS S.A.
46 Installation and Configuration Datasul 12.1.7
screen is displayed. In the "Run Shortcut" field, you can select the shortcut to run Progress programs.
Information on this screen is stored in “config.xml” file. In this file, you can change the standard shortcut or
even create other shortcuts (for clientlog run, for instance).
To create a new tag <Shortcut>, inside tag <LocalShortcuts>. Change some desired information
in the new line created (Description, Ini, Pf and Alias) and save file. After the change, restart Jboss so the
change works.
In this file, information for remote access to product (Citrix, GoGlobal or Terminal Server) is
located. Further information on this configuration, check Installation Guide, chapter "Remote Access".
The reference for “config.xml” file location is in “di.properties” file. Upon opening the file, “config.
path” attribute is located. It has as value the full path for “config.xml” file location.
In case of slowness in Progress programs load, you can pre load Progress during Datasul 11
initialization. To activate resource to user, select option "Pre load Progress in Initialization". Note: This
resource works only for stations with progress locally installed.
The access preferences can be defined in global level it the user does not know how to configure
or if configuration is not needed, there some tags in "datasul_framework.properties" that serve as
"standard" for all users. These standard values only are ignored when the user defines the own access
preferences.
# indicates the "description" of progress shortcut that must be used as default to load the progress
2.2.11 Menu
In case of slowness in the programs load in product menu, use the menu consolidation solution.
Enter in datasul_framework.properties the propriety "use.menu.key=true". This propriety is not dispatched
in media standard and is not recommended for environment in which slowness is not identified, as to
reflect changes performed in menu structure (program, module, security group, new users), run the update
program in user menu (mer010aa). If menu structure was changed, but this program is not run, accesses
remain the same.
TOTVS S.A.
Datasul 12 Configuration 47
external access must be allowed for proper work. For further security, parameters below have been
created in datasul_framework.properties file where a server and a port allowing external access are
allowed. This server and port make the link that is sent through e-mail to Supplier when Purchaser
requests quotation.
Configurations of RFI - Request for Information - are also used in other functionalities needing to
Enter e-mail account of company server (Exchange, Lotus) to enable e-mail delivery through
functions such as Quotation Request used by Purchaser. This account is not used to receive e-mails, only
for delivery.
Example:
<attribute name="User">purchases_company</attribute>
<attribute name="Password">s3nh4_3m4i1</attribute>
2.2.13 Files Location
Ports-bindings.xml* Jboss_home\binding\ports-bindings.xml
Service-8x80.bat* Jboss_home\bin\service-8x80.bat
Run.bat* Jboss_home\bin\run.bat
Run.sh* Jboss_home\bin\run.sh
Run.conf* Jboss_home\bin\run.conf
Jboss-log4j.xml Jboss_home\server\instance-8x80\conf\jboss-log4j.xml
Jboss-service.xml* Jboss_home\server\instance-8x80\conf\jboss-service.xml
Josso-agent-config.xml* Jboss_home\server\instance-8x80\conf\josso-agent-config.xml
Josso-gateway-config.xml* Jboss_home\server\instance-8x80\conf\josso-gateway-config.xml
Datasul_framework. Jboss_home\server\instance-8x80\conf\datasul\datasul_framework.
properties* properties
Di.properties* Jboss_home\server\instance-8x80\conf\datasul\di.properties
Progress-ds.xml* Jboss_home\server\instance-8x80\deploy\progress-ds.xml
Oracle-ds.xml* Jboss_home\server\instance-8x80\deploy\oracle-ds.xml
TOTVS S.A.
48 Installation and Configuration Datasul 12.1.7
Mail-service.xml* Jboss_home\server\instance-8x80\deploy\mail-service.xml
Config.xml* <Dir installation>\ERP\scripts-8x80\config.xml
installation with media, when database need to connect JDBC, two rows are added as example below:
The first row loads the broker 4GL by using a port defined by parameter -S and other start
parameters, this port is used by Progress programs
The second row loads the broker SQL by using another port defined by parameter -S, defines
parameter -ServerType SQL and other start parameters, this port is used by JAVA programs.
Below, a Progress database list that, as default, is configured with JDBC access in script progress-
ds.xml:
emsdev
emsfnd
mdmerge
finance
ems2sor
payroll2
mdtfrw
ems2cad
eai2
These databases by default are configured in progress-ds.xml file by using the port defined of
Example:
<connection-url>jdbc:datadirect:openedge://server:27621;databaseName=emsfnd</connection-url>
TOTVS S.A.
Datasul 12 Configuration 49
The Jboss service when started uses this file connect the databases opening a connection pool,
If the JBoss tries to open a connection and receives an error because the database rejected it,
due to parameters configured, the user receives an error and something does not properly work in Datasul.
Soon, it is important all JBoss pool connections are dimensioned in database load.
When any program needs to access a database, it requires a "borrowed" connection for
corresponding pool. If any connection is opened and nobody is using it, this connection is borrowed to
program. If there is no connection opened and the pool has not reached the limit size (max-pool-size), the
JBoss opens a new connection with database.
If the pool is in the limit, the program waits a while indicated by parameter "blocking-timeout-
millis" in progress-ds.xml file. If a connection is released, the program takes this one borrowed and
continues; otherwise, the program receives an error.
After the program used and released the connection, it returns to pool to be reused.
It depends on the number of users, the users activity, the programs each user runs, the order and
how long each program remains with the "borrowed" connection before returning it to pool.
In order to follow and dimension this number, use /jmx-console, as article How to define the value of field
<max-pool-size> in progress-ds.xml.
In progress-ds.xml file, the max-pool-size parameters comes with standard value 30 measured for
environment with 300 users, because the following calculation is used: 1 connection for 10 users. This
number used as calculation is an average calculation, it may vary according to environment.
This parameter can be adjusted by defining a value corresponding to the number of users using
Datasul 12. EMSFND database needs the minimum of 6 connections to start JBoss, find below the values
that must be used for file configuration.
TOTVS S.A.
50 Installation and Configuration Datasul 12.1.7
emsFnd
<min-pool-size>1</min-pool-size>
<max-pool-size>1</max-pool-size>
no_tx_emsFnd
<min-pool-size>1</min-pool-size>
<max-pool-size>1</max-pool-size>
ems_josso
<min-pool-size>4</min-pool-size>
<max-pool-size>4</max-pool-size>
It is important to highlight the parameters above are about the minimum connection to be
configured in EMSFND, where for each configured database in file progress-ds.xml, a monitoring of
connections to identify the max-pool-size parameter ideal configuration.
Further details of max-pool-size parameter configuration can be viewed in article How to define
the value of field <max-pool-size> in progress-ds.xml.
TOTVS S.A.
Datasul 12 Configuration 51
databases that you can access whenever you wish. The transaction data are regularly transfered
from the daily transactions to the historical databases. The transaction databases are thus
constantly accessed in the daily processes, becoming "leaner", significantly improving system
performance as a result. You can also use these databases in a multi-company environment. For
EMS 5, you can only use history databases from release 5.06 onwards.
Specific Databases: you can create databases to contain specific tables from customers. Such
databases should not be merged with the default databases of the product. It's up to the customer
to choose the best way to merge his/her specific databases, as long as these databases remain
separate from Datasul default databases.
ScreenOptimizer: you can merge the mgsop database with the product register databases;
however, you cannot merge the mgsor database, which must remain distinct.
International: databases used by the product by customers outside Brazil.
EAI: this database cannot be merged.
Datasul Transportation(TMS): this product has three databases: mgtrp, movtrp and comtrp (all
mono-company). You can merge all three in a single database.
Database MGAPS: available in EMS 2 from release 2.06B onwards.
Database MGADT: database mgadt is mono-company and cannot be merged. It must remain as
a distinct database.
Database MGMP: this database cannot be merged.
Plans Management 1.00: You can merge the databases of this product, which are mono-
company.
DBR (APS): The databases of this product are mono-company. You can merge them with the
other EMS2 mono-company databases.
Fleet: The databases of this product (mgfro and movfro) are mono-company and you can merge
them with the other EMS2 mono-company databases.
TOTVS Generic: Use the TOTVSGEN database to create new product feature tables, initially
found in Ekanban tables.
TOTVS S.A.
52 Installation and Configuration Datasul 12.1.7
TOTVS S.A.
Datasul 12 Configuration 53
TOTVS S.A.
54 Installation and Configuration Datasul 12.1.7
Notes:
The restriction to not merge EMS2 product databases with EMS5 databases or with HCM
databases continues, since tables with the same nomenclature exist.
Databases EMSDEV, EMSFND, MDMERGE, FINANCE, EMS2SOR, PAYROLL2, MDTFRW:
Databases accessed via JDBC via SQL port. Merger not recommended.
TOTVS S.A.
Remote Access Configuration 55
3.1 Introduction
The purpose of this Guide is to describe Datasul 11 product configurations displaying the file
In RemoteApp Programs, click the right button and add “Add RemoteApp Programs” program
TOTVS S.A.
56 Installation and Configuration Datasul 12.1.7
Click “Next”
TOTVS S.A.
Remote Access Configuration 57
TOTVS S.A.
58 Installation and Configuration Datasul 12.1.7
Change name (RemoteApp program name:), in the example used in Datasul 11, but any name
TOTVS S.A.
Remote Access Configuration 59
After the creation, config.xml file of Datasul 11 is configured to access TS, important backup
file before changes.
Configure “config.xml” file below structure “<Dir Instal Programs>\scripts”. Below, items to be
configured in this file, so tags not mentioned are not changed.
RemoteConnectionType
TOTVS S.A.
60 Installation and Configuration Datasul 12.1.7
E.g. <RemoteConnectionType>TerminalServer</RemoteConnectionType>
RemoteServerPort
Enter a port for communication between the Jboss and Terminal Server;
E.g. <RemoteServerPort>8085</RemoteServerPort>
MetaframeServer
Enter IP of Terminal Server address or name.
E.g. <MetaframeServer>jaguaribe</MetaframeServer>
MetaframeServerPort
Enter access port to Terminal Server.
E.g. <MetaframeServerPort>3389</MetaframeServerPort>
MetaframeServerId
Enter application name created in TS server according to examples above.
E.g. <MetaframeServerId>Datasul11</MetaframeServerId>
RemoteShortcut Description
Comments:
After changing JBOSS file, restart it.
In the example, the TS is installed in the same Datasul 11 serve, but it can be configured in
another server available in the company. But, you must have Progress installed and updated with
available services packs.
TOTVS S.A.
Remote Access Configuration 61
Upon accessing Datasul 11, go to Tools\Access Preferences. where information registered in config.
TOTVS S.A.
62 Installation and Configuration Datasul 12.1.7
After this, enter user and net password to validate access to server and open Datasul Interactive.
TOTVS S.A.
Remote Access Configuration 63
3.3.1 Purpose
This content aims at helping the configuration of an environment of Datasul product execution by
using the Citrix execution platform. Necessary steps are approached for Citrix (XenApp and Web Interface)
products configuration and the parameterization needed to Datasul product for proper integration.
3.3.2 Requirements
Some requirements are needed to use this material in Citrix configuration process along with
Datasul product:
XenApp 5.0
XenApp 5.0 FP
XenApp for Windows Server 2008 5.0
XenApp for Windows Server 2008 5.0
XenApp for Windows Server 2008R2 6.0
XenApp for Windows Server 2008R2 6.5
XenApp 7.x
Web Interface 5.x
3.3.4 Citrix Configuration
The installation of Citrix is divided in some application, and each one is responsible by a part of the
configuration execution, as follows:
TOTVS S.A.
64 Installation and Configuration Datasul 12.1.7
The first step is the creation of the folder with Citrix execution application: Copy files citrix.
properties, citrix.bat and datasul-framework-citrixproxy-java-1.0.2.jar,
the directory is located in folder scripts below where Datasul application server is installed for a folder in
Citrix server, example: C:\Datasul12.
In the citrix.properties file, indicate:
After the creation of the folder, the next step is the creation of an application in Citrix AppCenter
tool. For this, browse the tree on the left, to the option XenApp (Citrix AppCenter – Citrix Resources –
XenApp) and with right button go to option Run discovery. After executing this option, new knots are
displayed below in the structure.
By clicking with right button in the knot below, the option New - Publish application displayed,
according to picture below:
TOTVS S.A.
Remote Access Configuration 65
In this option of creation of a new application, enter in the first step name and description of the
application that is executed through Citrix, according to the picture below:
TOTVS S.A.
66 Installation and Configuration Datasul 12.1.7
In the next step, enter the application type that is used. In this case, keep the standard options
suggested (Installed application).
TOTVS S.A.
Remote Access Configuration 67
In the next step, enter the line of application execution command and the work directory. The
command line must point to citrix.bat file, followed by characters %**, example: “C:\Datasul12\citrix.bat" %
**. The work directory, enter the application folder, example C:\Datasul12. As picture below:
The next step is the server information that executes the application. Enter server before option
Add, according to picture below:
TOTVS S.A.
68 Installation and Configuration Datasul 12.1.7
The next step is related to the configuration of user permissions. Enter option Allow only
configured users and Citrix User Selector. In the option Add, enter users with access to application.
Example of the picture below:
TOTVS S.A.
Remote Access Configuration 69
As a last step, visual configurations of application, such as icon are applied. No need to change
default options on this screen, as picture below:
TOTVS S.A.
70 Installation and Configuration Datasul 12.1.7
As the application created, the next step is to execute the publication in IIS through the tool Citrix
Web Interface Management. By accessing the tool, in option XenApp Web Site, click option on the right
Create Site.
A screen of configuration is displayed and the first step is to enter IIS site name, publication name
and path. In the field IIS Site, you can keep option suggested Default Web Site. In option Path, enter the
application publication name, this value is repeated in option Name without bars, according to example:
TOTVS S.A.
Remote Access Configuration 71
TOTVS S.A.
72 Installation and Configuration Datasul 12.1.7
At the end, you can test the publication by accessing the address - as example:
https://<servidor>/Datasul12/
TOTVS S.A.
Remote Access Configuration 73
the default installation of the product, within the application server folder (Jboss), there is a folder name
DatasulCtxWI that must be copied for the server where the Citrix is installed, in the folder previously
created for the Citrix application, example C:\Datasul12. After copied, the full path is C:\Datasul12
\DatasulCtxWI\.
TOTVS S.A.
74 Installation and Configuration Datasul 12.1.7
After the creation of a new Application Pool, execute change. For this, click the new record in the list and
with the right-click button in option Advanced Settings. In this option, exchange the value of the field
Enable 32-Bit Application for True, according to picture below:
As the following step, create a new application, going to IIS tool on the right, in knot Sites -> Default Web
Site, clicking with right-click button in option Add Virtual Directory.
On screen, enter Alias, with the value of DatasulCtxWI and the local path of the copied folder,
according to example C:\Datasul12\DatasulCtxWI:
TOTVS S.A.
Remote Access Configuration 75
The next step is the transformation of the virtual directory in an application. For this, click in the knot of the
virtual directory in the tree with the right-click button in option Convert to Application. On screen, select
Application pool previously created, add user and password in option Connect as and execute
functioning test in option Test Settings.
Finished the creation of the application, change the file Web.Config of folder DatasulCtxWI.
In this file, the following variable are changed:
CtxWIConfigFile: It must have the path for WebInterface.conf file of application created by
Citrix. In the example the file C:\inetpub\wwwroot\Datasul12\conf\WebInterface.conf
TOTVS S.A.
76 Installation and Configuration Datasul 12.1.7
CtxFarmName: Name of Farm previously created along with the application Citrix. In the
As a final step, configure along with Datasul, the access to Citrix, in file config.xml, located below the
structure “<Dir Instal Programas>\scripts”. Below, items to be configured in this file, so tags not
mentioned are not changed.
• RemoteConnectionType
Enter remote connection type (CITRIX).
Ex: <RemoteConnectionType>Citrix</RemoteConnectionType>
• RemoteServerPort
Enter a port for communication between the Jboss and Citrix.
Ex: <RemoteServerPort>8085</RemoteServerPort>
• RemoteShortcut Description
Enter description for connection. The value Path item can be blank,
Ex: <RemoteShortcut Description="Citrix" Path="" />
• MetaframeServer
• ASPHttpServer
Enter the URL for virtual directory previously published:
Ex: <ASPHttpServer>http://citrixserver/DatasulCtxWI</ASPHttpServer>
• MetaframeServerId
Enter application name created in Citrix server.
Ex: <MetaframeServerId>Datasul12</MetaframeServerId>
TOTVS S.A.
Remote Access Configuration 77
Display Name – It is the name of the application is run (for this configuration to work properly, this
field value must be “DI”);
Executable Path – It must point to “java.exe”, below the structure “<Dir Instal Java>\ bin\java.exe”;
Start Directory – Temporary directory for the session;
Startup State – Regular.
TOTVS S.A.
78 Installation and Configuration Datasul 12.1.7
Configure log of “GoGlobal 3” in “Tools > Server Options > Log”. We recommend log level 6, so
all events are displayed.
Configure log of “GoGlobal 4” in “Tools > Host Options > Log”. We recommend log level 6, so all
events are displayed.
TOTVS S.A.
Remote Access Configuration 79
NOTIFICATION: All operational system users must have access and permission to directories
and programs defined in PROPATH of the session, as well as, to files “.ini”, “.pf”, “datasul-
framework-citrixproxy-java-1.0.2.jar” and Progress. If the users are not allowed, access errors are
registered in GoGlobal log.
Configure “config.xml” file below structure “<Dir Instal Programs>\scripts”. Below, items to be
RemoteServerPort
Enter a communication port with Datasul Connection for Web (GoGlobal).
E.g. <RemoteServerPort>8085</RemoteServerPort>
RemoteShortcut Description
Enter parameters for Progress session run.
E.g. < RemoteShortcut Description=" GOGLOBAL" Path="-jar "C:\Datasul11\datasul-
framework-citrixproxy-java-1.0.2.jar" "c:\dlc102b\bin\prowin32.exe"
"C:\Datasul11\datasul.pf" "C:\Datasul11\datasul-progress.ini"
Important: files entered above must be in server of GoGlobal, in the example above, directory C:
\Datasul was created in the server.
MetaframeServer
Enter IP or name of GoGlobal server.
E.g. <MetaframeServer>legacy2</MetaframeServer>
MetaframeServerLibURL
Enter URL where the GoGlobal components (this virtual directory must be published in Web server).
TOTVS S.A.
80 Installation and Configuration Datasul 12.1.7
Ex:<MetaframeServerLibUrl>http://legacy2/goglobal</MetaframeServerLibUrl>
NOTIFICATION: If any of the parameters described above are not properly configured, the
programs are not run. If there is any blank tab, we recommend it to be removed from file
(previously backup file).
TOTVS S.A.
Remote Access Configuration 81
After this, enter user and net password to validate access to server and open Datasul Interactive.
RemoteServerPort
Enter a communication port with Datasul Connection for Web (GoGlobal). Add a free port in the
TOTVS S.A.
82 Installation and Configuration Datasul 12.1.7
E.g. <RemoteServerPort>48085</RemoteServerPort>
Upon installing GoGlobal, check if the machine has a valid domain of product execution, as it
already automatically integrates to LDAP. After installed, configure the type of authentication for the
GoGlobal to transfer user and password information indicated by Datasul product.
For proper work, we select option “Standard authentication” in “GoGlobal -> Host Options ->
Secury”, so GoGlobal requests user and password when opening a session (the user does not need to
enter, as Datasul automatically enters GoGlobal).
Details:
1. When activating the cache option, the user password is stored in cache for some time, however,
when the user changes the password in the domain, the modification of cache in GoGlobal takes
time generating errors (not recommended).
2. When activating “Integrated Windows Authentication”, authentication to open session is not
requested, automatically authenticating user logged in Windows. With this option activated, the
server does not access net resources, not running mappings or scripts. GoGlobal (for the
moment) does not transmit the desktop credentials for server through net. So, you cannot
authenticate the user sessions out for the server (net or other users), disabling programs run.
TOTVS S.A.
Remote Access Configuration 83
After this, enter user and net password to validate access to server and open Datasul
TOTVS S.A.
84 Installation and Configuration Datasul 12.1.7
Interactive.
TOTVS S.A.