SETUP MANUAL

CAT83 SYSTEM INSTALL / UPDATE / SETUP MANUAL CAT83 SYSTEM INSTALL / UPDATE / SETUP MANUAL TABLE OF CONTENTS PREFACE .................................
Author: Dwayne Long
1 downloads 0 Views 717KB Size
CAT83 SYSTEM INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

INSTALL / UPDATE / SETUP MANUAL

TABLE OF CONTENTS PREFACE .....................................................................................................................................................1 HOW TO GET THE MOST FROM THIS MANUAL......................................................................................1 ABOUT THE TECHNICAL SUPPORT ....................................................................................................1 LATE GUIDELINES ....................................................................................................................................1 CAT83 SYSTEM...........................................................................................................................................2 CAT83 SYSTEM INSTALL ...........................................................................................................................2 INSTALL PREREQUISITES .......................................................................................................................2 INSTALL....................................................................................................................................................4 RUNNING INSTALLATION SOFTWARE ..................................................................................................4 DATABASE SETTINGS .............................................................................................................................6 APPLICATION SETTINGS.........................................................................................................................6 PROPERTY FILE...................................................................................................................................6 WEBSPHERE SETTINGS – CAT83 SYSTEM...............................................................................................8 PREREQUISITES..................................................................................................................................8 BUSES AND JMS..................................................................................................................................8 CREATING A NEW JMS DESTINATION...............................................................................................9 ACCESSING THE DATA BASE ........................................................................................................... 10 SETTING THE TRANSACTION LIFETIME TIMEOUT ..........................................................................17 PROPERTIES SETTINGS.....................................................................................................................17 CAT83 SYSTEM DEPLOY IN WEBSPHERE............................................................................................ 19 CAT83 SYSTEM UPDATE ..........................................................................................................................21 PREREQUISITES .....................................................................................................................................21 UPDATE...................................................................................................................................................21 DATA BASE TABLES AND VIEW UPDATE.............................................................................................22 JAVA EE APPLICATION SERVER UPDATE ............................................................................................23 IBM WEBSPHERE V7 APPLICATION SERVER SETUP.............................................................................26 DATABASE ACCESS...............................................................................................................................26 UNINSTALLING CAT83 ............................................................................................................................29 Latest update: 09/20/2016

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

PREFACE This Manual describes the necessary procedures for the correct product installation/update and setup.

HOW TO GET THE MOST FROM THIS MANUAL • New users with no CAT83 System follow the procedures on CAT83 System Install section of this manual; • Older customers, the update procedures are on CAT83 System Update section of this manual

ABOUT THE TECHNICAL SUPPORT For special aid on technical issues that exceeds the informations of this manual, count on Mastersaf Thomson Reuters Support team. The Technical Support works from Mondays to Fridays (9:00 AM - 6:00 PM) or open a support ticket (“chamado”). Call us on: +55 (11) 2159-0600 - option 2 (Atendimento Produto Mastersaf GF).

LATE GUIDELINES If you already are an user, please check the late updates in this document and its guidelines: In Update section (access here), if you use “estrutura de produto” (product structure) during cost calculation, perform the steps available.

Latest update: 09/20/2016

1

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

CAT83 SYSTEM CAT83 SYSTEM INSTALL INSTALL PREREQUISITES HARDWARE • Processor: Intel 4-core or further • Memory: 4 GB RAM for Java application server • Hard disk free space –

50 Gb for Java application server’s files installation and log backup



150 Gb for 5 years of CAT83 System data’s database in a environment where exists 800,000 stock movements per mouth

• File server area: mínimo de 1 Gb (minimum) in web server (Windows or Linux) SOFTWARE • Installation Software (setup) Download the Sistema Apuração do Crédito Acumulado do ICMS (CAT83 System) Setup Software on Contact Center Mastersaf GF: www.mastersaf.com.br Access: Contact Center > Meus Serviços > Contact Center MastersafGF Atualização de Versões/

Patches > CAT83: • Java: JDK 1.6.0 Update 45 • Operational Systems 32 or 64-bit: –

Windows Server 2003 SP2 or further



Red Hat Enterprise Linux 5 or further

• Database –

Oracle 11g Release2 (11.2.0.4) or 12C



Microsoft SQLServer 2008

Latest update: 09/20/2016

2

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

• Database area: Create CAT83 tables in the same Mastersaf GF database/schema. • File Server area: Minimum required in web server, Windows or Linux): 1 Gb For IBM WebSphere 7: http://www-304.ibm.com/support/docview.wss?rs=180&uid=swg27012369 For JBoss 5.1.0.GA: http://br.redhat.com/resourcelibrary/articles/jboss-enterprise-application-platformsupported-configurations • Java EE 5 Application Server: JBoss 5.1.0.GA or IBM WebSphere Application Server v7 fix Pack 15 The required settings must be performed by the DBA. Each application server producer have a validated platform list. Check if your operational system is in it by searching the sites bellow: For IBM WebSphere 7: http://www-304.ibm.com/support/docview.wss?rs=180&uid=swg27012369 For JBoss 5.1.0.GA: http://br.redhat.com/resourcelibrary/articles/jboss-enterprise-application-platformsupported-configurations • Workstation browser: Microsoft Internet Explorer (8 or 9) and Firefox (7 or further) IMPORTANT: The browser security settings must be set up to default level (medium-high and medium-low) in the Internet and Intranet zones to be able to run JavaScript.

Latest update: 09/20/2016

3

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

INSTALL Installing the CAT83 System consists of the following process: 1. Running Installation Software, Database Settings and Application Settings 2. WebSphere Settings – CAT83 System and CAT83 System Deploy in WebSphere

RUNNING INSTALLATION SOFTWARE Access the folder where the installation sofware (setup file) is located: 1. Run “CredAcum-2.2.XX.exe”; The system displays the installation home screen – Bem-vindo ao Assistente de Instalação de Mastersaf GF - Crédito Acumulado do ICMS 1.1 Click Avançar (Next button); The system displays Mastersaf GF - Crédito Acumulado do ICMS 2.2.XX screen 1.2 Click Avançar; On Tipo de Instalação (Choose Installation Type) 1.3 Select Instalação Completa (Complete Install) and click Avançar; On Licença de Uso (User License) 1.4 Enter the license code in Código da Licença and click Avançar; On Integração do Sistema (System Integration) 2. Select the integration type: “Mastersaf GF” or “Mastersaf DW”.

When you choose “Mastersaf GF”: On Banco de Dados (Database) 3. Select database (Oracle or SQL Server) then click Avançar;

Latest update: 09/20/2016

4

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM Oracle users:

On Versão do Banco de Dados Oracle (Oracle Database version) –

Select database version and click Avançar;

On Servidor de Aplicações (Application Server) 4. Select the application server and click Avançar; On Segurança (Security) 5. Select the security option and click Avançar; The options available are: Banco de dados (Database): The user and profile control will be done by the application. LDAP (requires application server settings): The user control will be done by the LDAP server installed previously. On Arquivos Temporários (Temporary Files) 6. Enter the folder where the temporary files will be extracted and click Avançar; On Escolha a pasta de Destino (Choose destination folder) 7. Enter the folder where will be installed CAT83 System and click Avançar; On Pronto para Instalar (Ready to Install) 8. Check the info about the installation and click Instalar (Install button); The system displays Instalando (Installing screen). Check the install process; On Finalizando o Assistente de instalação de Mastersaf GF - Crédito Acumulado do ICMS (last screen), click Concluir.

Latest update: 09/20/2016

5

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

DATABASE SETTINGS The database scripts are available in: (Mastersaf GF installation folder) > 2.2.XX > scripts > Criar Run the files in the following order: 1. criacao.sql 2. carga_inicial.sql

APPLICATION SETTINGS PROPERTY FILE ATTENTION: If you have already done this procedure, please ignore this step. The CAT83 System has some properties that may cause some malfunctions if it is not set properly. Avoid this kind of problem as follows: 1. Create a folder named Alliance on the Application Server root directory. Example: for Windows, C:\Alliance, and for Linux, /Alliance 2. Copy the “proffis.properties” file from (Mastersaf GF install folder) > 2.2.XX > conf to the “mastersaf” folder.

Latest update: 09/20/2016

6

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

3. The following settings may be made depending on the client environment proffis.extracao.numMaxProcessoParalelo

proffis.paginacao proffis.calculo.baixaparcial

Full values higher than zero. 4 is standard Full values higher than zero. 100 is standard “true” (default) “false” “true” (default)

proffis.codigoExpandido

proffis.properties

proffis.codigoExpandido.openFlex

proffis.database proffis.lancamentoGenerico proffis.creditoOutorgado proffis.desconsiderarLancamentosZerados proffis.estorno proffis.estorno.openflex

proffis.estorno.openflex.value

proffis.portaria221 proffis.estruturaProduto proffis.ajuste.LLC

“false” OpenFlex 01 OpenFlex 02 OpenFlex 03 OpenFlex 04 OpenFlex 05 (default) OpenFlex 06 OpenFlex 07 OpenFlex 08

ORA (default) MSSQL “true” “false” (default) “true” “false” (default) “true” or “false” (default)

If the user choose “Definir períodos” (Determine Periods) on the “Geração do arquivo” (File generation screen) the time period will be divided into date ranges. The amount of intervals is the property value. It informs the standard quantity of registers which must be recovered by a query on the Data Base. It informs that the company operates on partial stock write-offs. Sometimes the input material sent to the production is not fully consumed. The leftover material uses the 5G form. It informs that the company uses generic codes on its products and that these codes are changed through the concatenation of values from the OpenFlex table fields “LANCTO_ESTOQUE”

It informs which OpenFlex field from LANCTO_ESTOQUE have an “X” sign if the stock movement refers to a settable product output.

It informs the Data Base: Oracle (ORA) or Microsoft SQLServer (MSSQL) It informs if the customer uses LEGE table for complementary stock movement. It informs if the company that have right to credit granted

It informs if the system must disregard the stock movements

with quantity equal to zero. It informs if the system must disregard the returned production “true” or “false” (default) movement of semi-finished materials or finished product. It informs the openflex text field of “lançamentos de estoque” NUM01 (default), NUM02, table (LANCTO_ESTOQUE) that must be used to select the NUM03, VAR01, VAR02, returned payment requests. It requires “proffis.estorno=true” VAR03, VAR04, VAR05 property. It informs the value that will be recorded on openflex text field set in “proffis.estorno.openflex” property. If the text field is equal Numeric or alfanumeric to NUM01, NUM02 or NUM03, the value must be a numeric value required. Default value: 999 “true” or “false” (default) It informs “true” if it will use the “Portaria CAT221/2009”. “true” or “false” It informs that the user uses the registry of product structure. It informs “true” if the customer want to use the Low Level Code “true” or “false” settings process window.

ATTENTION: Clients (frigorific) that have right to credit granted must follow these steps: 1. Copy “proffis.properties” file located at (diretório de instalação do Mastersaf GF) > 2.2.XX > conf and paste it in the folder “Alliance” located at the server root where the application server is installed, overwriting the previous file.

Latest update: 09/20/2016

7

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

2. Open the “proffis.properties” file and change the variable value “proffis.creditoOutorgadoFrig” from FALSE to TRUE. Save the changes.

WEBSPHERE SETTINGS – CAT83 SYSTEM PREREQUISITES • IBM WebSphere v7 installed and running • Fix Pack 15 (or further) installed on the Application Server

BUSES AND JMS 1. On Websphere Administrative Console > Service Integration > Buses, click on New button. On Create a new Service Integration Bus 2. Enter the name for your new bus (e.g. CatBus), keep “Bus security” deselected and click Next On Confirm create of new bus 2.1 Confirm to create of new bus Click on Finish and then on Save 3. Click on the new bus 3.1 Click on the Local Topology tab; 3.2 Expand the treeview until appears the Add... link. Click Add... 4. On Add a new bus member, select Server 4.1 Click on the dropdown list and select the server in which the Bus will be installed, then click Next 5. On Select message store type select File store, then click Next 6. On Specify file store properties fill the properties, then click Next; 7. On Improve Messaging Performance click Next; 8. On Add a new bs member click Finish 9. Back on Buses click Save Latest update: 09/20/2016

8

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

CREATING A NEW JMS DESTINATION 1. On Websphere Administrative Console > Service Integration > Buses, click on the new Bus. 2. On Buses click on Destinations in the side menu and then on New 3. On Create new destinations select Queue and then click Next 4. On Create new queue fill Identifier with “SIB_JMS_PROFFIS_AUDITORIA_QUEUE.IN” and then click Next Back on the new Queue screen 5. Select the Bus Member (the one created on the Local Topology tab), click Next and then Finish. 6. Back on Buses click Save Repeat these steps to the following destinations: Use these names on the Step 4, everything remains the same on the other steps. –

SIB_JMS_PROFFIS_ARQUIVO_COMPL_QUEUE.IN



SIB_JMS_PROFFIS_CALCULO_COMPRADOS_QUEUE.IN



SIB_JMS_PROFFIS_DEVOLUCAO_QUEUE.IN



SIB_JMS_PROFFIS_EXPORTACAO_QUEUE.IN



SIB_JMS_PROFFIS_EXTRACAO_ARQUIVO_QUEUE.IN



SIB_JMS_PROFFIS_EXTRACAO_ESTOQUE_QUEUE.IN



SIB_JMS_PROFFIS_EXTRACAO_NF_QUEUE.IN



SIB_JMS_PROFFIS_FICHA_5B_QUEUE.IN



SIB_JMS_PROFFIS_FICHA_5C_QUEUE.IN



SIB_JMS_PROFFIS_FICHA_5D_QUEUE.IN



SIB_JMS_PROFFIS_FICHA_5F_QUEUE.IN



SIB_JMS_PROFFIS_FICHA_5H_QUEUE.IN



SIB_JMS_PROFFIS_MODULO_QUEUE.IN



SIB_JMS_PROFFIS_ESTORNO_QUEUE.IN



SIB_JMS_PROFFIS_AJUSTELLC_QUEUE.IN

Latest update: 09/20/2016

9

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

ACCESSING THE DATA BASE CREATING AN USER AND PASSWORD 1. On Websphere Administrative Console (side menu) > Security, select Global Security. On the Java Authentication and Security Authorization Service, click J2C authentication data. On Global Security 2. Click New and on Alias enter “mastersafGF”. Fill the users ID and Password and click OK 3. Click on Save CREATING A JDBC PROVIDER XA 1. On Websphere Administrative Console (side menu) > Resources > JDBC > JDBC Providers 2. Select on combo the scope “Node=xxx,Server=xxx” and click New Example: “Node=e30node01,Server=server1” 3. On Create a new JDBC Provider, fill the blanks on the dropdown lists as follows: FILED

ORACLE

MSSQL

Database type

Oracle

SQL Server

Provider type

Oracle JDBC Driver

Microsoft SQL Server JDBC Driver

Implementation type

XA data source

XA data source

Name

Oracle JDBC Driver (XA)

Microsoft SQL Server JDBC Driver (XA)

4. On the Create a new JDBC Driver For Oracle –

Locate the JAR file (e.g. C:\Mastersaf\DriverJDBC), click on Next, Finish and then Save.

For MS SQL –

Fill the Directory location for “sqljdbc.jar” which is saved as WebSphere variable ${MICROSOFT_JDBC_DRIVER_PATH} text box with the path to “sqljdbc4.jar” driver. Keep Native library blank.



Click on Next and Finish

On JDBC Provider Latest update: 09/20/2016

10

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM –

Click Save, then click on the Microsoft SQL Server JDBC Driver (XA) link



On Classpath text box edit the string ${MICROSOFT_JDBC_DRIVER_PATH}/sqljdbc.jar to ${MICROSOFT_JDBC_DRIVER_PATH}/sqljdbc4.jar, click OK and then click Save on the next screen.

CREATING A DATASOURCE On Websphere Administrative Console (side menu) > Data Sources > JDBC 1. Select on combo the scope “Node=xxx,Server=xxx” and click New Example: “Node=e30node01,Server=server1” On Create a data source 2. Enter “GF Datasource” on Data source name text box 3. Enter “jdbc/GFAlllianceDS” on JNDI name text box and click Next On Select JDBC provider 4. Select the option Select an existing JDBC provider, choose the proper provider for your Data Base then click Next. For Oracle 4.1 Fill the URL on Value to access the Data Base that will be used (e.g.: jdbc:oracle:thin:@[IP]:[PORT]:[SID]). Click Next For MS SQL 4.2 On Enter database specific properties for the data source fill Database name, Port number and Server name text boxes matching your SQL Server environment then click Next. 5. On Set up security aliases select the user that has just been created for the Authentication alias for XA recovery, Component-managed Authentication Alias and Container-managed Authentication Alias text boxes. Click Next and Finish. 6. On Data sources click Save.

Latest update: 09/20/2016

11

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM JMS CONNECTION FACTORY

On Websphere Administrative Console (side menu) > Resources >JMS > Conection Factories 1. Select on combo the scope “Node=xxx,Server=xxx” and click New Example: “Node=e30node01,Server=server1” 2. Select Default messaging provider and click OK 3. Write ConnectionFactory on Name and JDNI Name text boxes 4. On Bus Name, select the Bus Name you have just created and click OK. JMS QUEUES 1. Select on combo the scope “Node=xxx,Server=xxx” and click New Example: “Node=e30node01,Server=server1” 2. Select Default messaging provider and click OK 3. Fill the text boxes as follows: • Name: SIB.JMS.PROFFIS.ARQUIVO.COMPL.QUEUE.IN JNDI name: jms/mdb/ProffisGeracaoArquivoComplementarQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_ARQUIVO_COMPL_QUEUE.IN 4. Click OK and Save and repeat this procedure to the following queues: • Name: SIB.JMS.PROFFIS.AUDITORIA.QUEUE.IN JNDI name: jms/mdb/ProffisAuditoriaQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_AUDITORIA_QUEUE.IN • Name: SIB.JMS.PROFFIS.CALCULO.COMPRADOS.QUEUE.IN JNDI name: jms/mdb/ProffisCalculoCompradosQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_CALCULO_COMPRADOS_QUEUE.IN • Name: SIB.JMS.PROFFIS.DEVOLUCAO.QUEUE.IN JNDI name: jms/mdb/ProffisDevolucaoQueue Latest update: 09/20/2016

12

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_DEVOLUCAO_QUEUE.IN • Name: SIB.JMS.PROFFIS.EXPORTACAO.QUEUE.IN JNDI name: jms/mdb/ProffisExportacaoQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_EXPORTACAO_QUEUE.IN • Name: SIB.JMS.PROFFIS.EXTRACAO.ARQUIVO.QUEUE.IN JNDI name: jms/mdb/ProffisExtracaoArquivoQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_EXTRACAO_ARQUIVO_QUEUE.IN • Name: SIB.JMS.PROFFIS.EXTRACAO.ESTOQUE.QUEUE.IN JNDI name: jms/mdb/ProffisExtracaoEstoqueQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_EXTRACAO_ESTOQUE_QUEUE.IN • Name: SIB.JMS.PROFFIS.EXTRACAO.NF.QUEUE.IN JNDI name: jms/mdb/ProffisExtracaoNotaFiscalQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_EXTRACAO_NF_QUEUE.IN • Name: SIB.JMS.PROFFIS.FICHA.5B.QUEUE.IN JNDI name: jms/mdb/ProffisFicha5BQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_FICHA_5B_QUEUE.IN • Name: SIB.JMS.PROFFIS.FICHA.5C.QUEUE.IN JNDI name: jms/mdb/ProffisFicha5CQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_FICHA_5C_QUEUE.IN • Name: SIB.JMS.PROFFIS.FICHA.5D.QUEUE.IN JNDI name: jms/mdb/ProffisFicha5DQueue

Latest update: 09/20/2016

13

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_FICHA_5D_QUEUE.IN • Name: SIB.JMS.PROFFIS.FICHA.5F.QUEUE.IN JNDI name: jms/mdb/ProffisFicha5FQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_FICHA_5F_QUEUE.IN • Name: SIB.JMS.PROFFIS.FICHA.5H.QUEUE.IN JNDI name: jms/mdb/ProffisFicha5HQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_FICHA_5H_QUEUE.IN • Name: SIB.JMS.PROFFIS.MODULO.QUEUE.IN JNDI name: jms/mdb/ProffisModuloQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_MODULO_QUEUE.IN • Name: SIB.JMS.PROFFIS.ESTORNO.QUEUE.IN JNDI name: jms/mdb/ProffisEstornoQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_ESTORNO_QUEUE.IN • Name: SIB.JMS.PROFFIS.AJUSTELLC.QUEUE.IN JNDI name: jms/mdb/ProffisAjusteLLCQueue Bus Name: select the Bus Name you have created and click OK Queue Name: SIB_JMS_PROFFIS_AJUSTELLC_QUEUE.IN ACTIVATION SPECIFICATIONS On Websphere Administrative Console (side menu) > Resources > JMS > Activation specifications 1. Select on combo the scope “Node=xxx,Server=xxx” and click New Example: “Node=e30node01,Server=server1” 2. Select Default messaging provider and click OK; 3. Fill the text boxes as follows: Latest update: 09/20/2016

14

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM • MDB: ExtracaoArquivoComplMDB JNDI name: eis/ExtracaoArquivoComplMDB

Destination JNDI: jms/mdb/ProffisGeracaoArquivoComplementarQueue Bus Name: Seleciona o barramento criado anteriormente 4. Click OK and Save and repeat this procedure to the following queues: • Name: AuditoriaMDB JNDI name: eis/AuditoriaMDB Destination JNDI Name: jms/mdb/ProffisAuditoriaQueue Bus Name: select the Bus Name you have created and click OK • Name: CalculoCustoMedioMDB JNDI name: eis/CalculoCustoMedioMDB Destination JNDI Name: jms/mdb/ProffisCalculoCompradosQueue Bus Name: select the Bus Name you have created and click OK • Name: DevolucaoMDB JNDI name: eis/DevolucaoMDB Destination JNDI Name: jms/mdb/ProffisDevolucaoQueue Bus Name: select the Bus Name you have created and click OK • Name: ExportacaoMDB JNDI name: eis/ExportacaoMDB Destination JNDI Name: jms/mdb/ProffisExportacaoQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoArquivoMDB JNDI name: eis/ExtracaoArquivoMDB Destination JNDI Name: jms/mdb/ProffisExtracaoArquivoQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoEstoqueMDB JNDI name: eis/ExtracaoEstoqueMDB Destination JNDI Name: jms/mdb/ProffisExtracaoEstoqueQueue Latest update: 09/20/2016

15

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoFicha5BMDB JNDI name: eis/ExtracaoFicha5BMDB Destination JNDI Name: jms/mdb/ProffisFicha5BQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoFicha5CMDB JNDI name: eis/ExtracaoFicha5CMDB Destination JNDI Name: jms/mdb/ProffisFicha5CQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoFicha5DMDB JNDI name: eis/ExtracaoFicha5DMDB Destination JNDI Name: jms/mdb/ProffisFicha5DQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoFicha5FMDB JNDI name: eis/ExtracaoFicha5FMDB Destination JNDI Name: jms/mdb/ProffisFicha5FQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoFicha5HMDB JNDI name: eis/ExtracaoFicha5HMDB Destination JNDI Name: jms/mdb/ProffisFicha5HQueue Bus Name: select the Bus Name you have created and click OK • Name: ExtracaoNotaFiscalMDB JNDI name: eis/ExtracaoNotaFiscalMDB Destination JNDI Name: jms/mdb/ProffisExtracaoNotaFiscalQueue Bus Name: select the Bus Name you have created and click OK • Name: ModuloMDB JNDI name: eis/ModuloMDB Destination JNDI Name: jms/mdb/ProffisModuloQueue Bus Name: select the Bus Name you have created and click OK Latest update: 09/20/2016

16

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM • Name: EstornoMDB JNDI name: eis/EstornoMDB

Destination JNDI Name: jms/mdb/ProffisEstornoQueue Bus Name: select the Bus Name you have created and click OK • Name: AjusteLLCMDB JNDI name: eis/AjusteLLCMDB Destination JNDI Name: jms/mdb/ProffisAjusteLLCQueue Bus Name: select the Bus Name you have created and click OK

SETTING THE TRANSACTION LIFETIME TIMEOUT On Websphere Administrative Console (side menu) > Servers > Server Type > Websphere Application

Servers > Runtime tab. 1. Click on Container Services and then on Transaction Service 2. On Total transaction lifetime timeout enter “28800”; 3. On Maximum transaction timeout enter “32400” and click OK; 4. Click Save.

PROPERTIES SETTINGS In order to CAT83 work properly you must set up some properties so do it as follows: On WebSphere Administrative Console (side menu) > Servers > Server Types > WebSphere Applica-

tion servers. 1. Click on the server name On the Application Servers screen 2. Select the Configuration tab on Server Structure frame, On Java and Process Management click Process definition. On Additional Properties screen, click Java Virtual Machine 3. Click on Custom properties 4. On the Custom properties screen click on New 5. Fill Name with “mastersaf.jpa.provider” and Value with “openjpa” then click OK Latest update: 09/20/2016

17

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM On Application Servers 6. Click Save and New again to add more properties

7. Fill Name with “mastersaf.servidor” and Value with “websphere” 8. Click OK and Save. SETTING MEMORY We strongly recommend you to increase the JVM heap area used by the application server to its maximum size 1024 MB. Proceed as follows to change the heap area size: On WebSphere Administrative Console (side menu) > Servers > WebSphere Application servers >

Application servers, 1. Click “WebSphere Application servers” in Server > Server Types. Click server name 2. On the Configuration tab, open Java and Process Management, click Process definition and then Java Virtual Machine 3. The lower value for Maximum heap size is 1024 Mb. However, we recommend 2048 Mb. 3.1 At Initial heap size text box, enter “2048”. 3.2 At Maximum heap size text box, enter “2048”. Other JVM options that should be setup as Generic JVM arguments: –

Xgcpolicy:optthruput



Xmine640m



Xmaxe640m



Xss512k Important: The options above are generic. It is important to collect performance metrics for each server for a better setuo. The metrics can be collected accessing the “Monitoring and Tuning” menu.

4. Click OK then Save. ATTENTION: After changing the heap area size you must restart the server. Latest update: 09/20/2016

18

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM SECURITY

During the setup, if you chose the via LDAP security, you must create a realm named “AllianceRealm” with mapping settings for LDAP server. You must follow these steps when CAT83 System Deploy in WebSphere indicates it. After create the realm, follow as bellow: 1. On Websphere Administrative Console (side menu) > Applications > Application Type > Websphere

enterprise Applications. 2. Click on alliance-proffis-ear On Details Properties, click Security role to user/group mapping 3. Select CatUser and click Map Users Now those users on this Role have access to the application If you want to map groups of LDAP, click Map Group... – instead of Map Users... On Map Group 4. Select the Realm that will be used by the application on User Realm dropdown list and click Search to view the LDAP users 5. Select the users who must have access to the application and click OK 6. Repeat the user/groups mapping steps (3 and on) but now selecting CatSecurityAdmin role. This role displays which users will have access to CAT83 System Security Module. 7. On the new screen click OK and Save.

CAT83 SYSTEM DEPLOY IN WEBSPHERE After perform previous steps, proceed as bellow: 1. Access WebSphere administrative console. Select “New Enterprise Application” on menu Applications > New Application; On Preparing for the application installation 2. Click Browse... then select “alliance-security-ear.ear” file on the folder

(CAT83 System installation folder) > 2.2.XX > ear and click Next 3. Select “Fast Path” then click Next Latest update: 09/20/2016

19

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

3.1 On Step 1: Select installation options, keep the default data and click Next 3.2 On Step 2: Map modules to servers, keep the default data and click Next 3.3 On Step 3: Map resource references to resources, on section javax.sql.DataSource Copy all JNDI-DataSource displayed in Resource Reference column to Target Resource JNDI Name column then click Next 3.4 On Step 5: Summary screen, keep the default data and click Finish The system displays a new screen. Check the following message: “Application alliance-proffis-ear installed successfully” 4. Click Save to confirm the settings 5. If you selected LDAP security, follow the steps in the Security section before proceed the process. Run the application accessing the side menu Applications > Application Types > WebSphere enter-

prise applications; 6. Select alliance-proffis-ear checkbox then click Start The system displays a success message: “Application alliance-proffis-ear on server server1 and node v11Node01 started successfully” 7. Check if there is some error in WebSphere log: (PATH_PROFILE_WEBSPHERE) > logs > server1 > SystemOut.log and (PATH_PROFILE_WEBSPHERE) > logs > server1 > SystemErr.log. 8. Run the application by the new URL: http://:/mastersafgf. • For security via database: Access the application on the URL: http://:/mastersafgf. Login with “admin” username and password, keeping empty Empresa (Company text box) and Filial (Branch text box). • For security via LDAP: Access the application on the new URL: https://:/mastersafgf. Login with LDAP username and password mapped in CatSecurityAdmin role, keeping empty Empresa (Company text box) and Filial (Branch text box). The installation and setting process is finished.

Latest update: 09/20/2016

20

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

CAT83 SYSTEM UPDATE PREREQUISITES Before update be sure you have the following items: • Update setup The CAT83 update setup is available on the Mastersaf GF Contact Center www.mastersaf.com.br. Download the setup file on Contact Center > Meus Serviços > Contact Center MastersafGF

Atualização de Versões/Patches > CAT83: • Software Installation area 30 Mbytes on the Windows Network Server

UPDATE The update process is made by: 1. Update Setup running process 2. Data Base tables update 3. Application deployment on Java EE Application Server

UPDATE SETUP RUNNING PROCESS On the update setup folder: 1. Run the “CredAcum-2.2.XX.exe” 1.1 In Welcome click on Avançar (Next button) 1.2 In Technical Support info click on Avançar (Next button) 1.3 In Tipo de Instalação (Installation Type), select Atualização (Update) In Integração do Sistema (System Integration) 2. Select the type of Integration that will be used: “Stand Alone”, “Mastersaf GF” or “Mastersaf DW” If choose “Mastersaf GF” the Banco de Dados (Data Base screen) opens Latest update: 09/20/2016

21

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM –

Select the Data Base type and click Avançar (Next button).

3. If choose Oracle Data Base the Versão do Banco de Dados (Data Base Version) screen opens –

Select the Data Base version and click Avançar (Next button)

4. The Servidor de Aplicação (Application Server) screen opens, select the Application Server that will be used and click Avançar (Next button) 5. When the Segurança (Security) screen opens, select the security type that will be used and click Avançar (Next button) 6. The Arquivo temporários (Temporary Files) screen opens, inform where the temporary file will be deployed and click Avançar (Next button) 7. The Escolha a Pasta de Destino (Deploy folder) screen opens, inform where you want to install the CAT83 System and then click Avançar (Next button) 8. The Pronto para Instalar (Installation) screen opens, click on Instalar (Install button) The Install process begins, at the end of it the final screen (Finalizando o Assistente de instalação do Mastersaf GF CAT83) opens, click Concluir (Finish button).

DATA BASE TABLES AND VIEW UPDATE This version have data base update scripts. When there are changes on the Data base, the Proffis Data Base Tables scripts are located at:

(Mastersaf GF install folder) > 2.2.XX > scripts > Atualizar > Proffis > 2.2.XX The previous versions to the current one may be processed only if the run version is prior to the latest one and must be run on increasing order, as the following examples (considering “2.2.50” as the current version): • If the user uses the 2.2.48 version, then run the 2.2.49 and 2.2.50 • If the user uses the 2.2.49 version, then run the 2.2.50 script only. ATTENTION: Backup your database before running the update scripts. We recommend that this update operation be processed by a Data Base specialist.

Latest update: 09/20/2016

22

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

ATTENTION: Disregard the following messages in “atualizacao_proffis.sql” script: – There is already an object named '' in the database. – Table '' already has a primary key defined on it. – Violation of UNIQUE KEY constraint ''. Cannot insert duplicate key in object ''. The duplicate key value is ().

JAVA EE APPLICATION SERVER UPDATE Update the application on IBM WebSphere v7 proceeding as follows: 1. Access WebSphere Administrative Console Access: Websphere Administrative Console (side menu) > Applications > Application Types > WebS-

phere applications 2. Select “security-server” application then click Uninstall. Follow the steps to uninstall the security application. Note: from 2.2.32 version and on, the Security Module was integrated to CAT83 System and installing this package is unnecessary. 3. Select the application alliance-proffis-ear and click Stop 4. Select the application alliance-proffis-ear and click Update 5. On the following screen select Replace the entire application 6. Access the application on the URL http(s)://:/mastersafgf.

ATTENTION: Disregard the following steps if you performed it in the 2.2.43 version:

1. Add a new JMS queue: 1.1 Access: Service Integration > Buses – Click the bus name – On the right menu, Destination Resources, click Destinations – Click New to add a new run destiny

Latest update: 09/20/2016

23

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM – Select Queue and click Next

– Enter SIB_JMS_PROFFIS_ESTORNO_QUEUE.IN to identify the destiny and click Next – Select the run, click Next and then click Finish. – Save changes. 1.2 Access: Resources > JMS > Queues – Click New – Select “JMS resource provider default” and click OK – In Name, enter SIB.JMS.PROFFIS.ESTORNO.QUEUE.IN – In JNDI name, enter jms/mdb/ProffisEstornoQueue – In Bus name, enter the bus selected – In Queue name, select SIB_JMS_PROFFIS_ESTORNO_QUEUE.IN – Keep the other fields with default value then click OK. – Save changes. 1.3 Access: Resources > Activation specifications – Click New – Select “JMS resource provider default” and click OK – In Name, enter EstornoMDB – In JNDI name, enter eis/EstornoMDB – In Destination JNDI Name, enter jms/mdb/ProffisEstornoQueue – In Bus name, select the bus selected. – Keep the other fields with default value then click OK. – Save changes.

Latest update: 09/20/2016

24

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

ATTENTION: If you use “estrutura de produto” (product structure) during cost calculation, enable the “proffis.estruturaProduto=true” property: 1. Access the “proffis.properties” file in C:\Mastersaf or C:\Alliance. 2. To enable the property, remove the hashtag “#” from where the line starts.

ATTENTION: Disregard these steps if you performed it in a previous version:

3. Users that have right to credit granted must follow these steps: Set the “proffis.creditoOutorgadoFrig” variable in the “proffis.properties” file as TRUE. 4. Backup files and folders in case of some necessary downgrade. Conserve only the “proffis.properties” file in “Mastersaf” folder in server root (Windows - C:\mastersaf or Linux - /mastersaf), removing the other properties files that may be in this “mastersaf” folder. Remove also the “Alliance” folder. In case of InterDW setup is installed, remove it because it is no longer necessary. 5. If you activated LDAP security, perform this step: After EAR update, set the new roles (“CatUser” and “CatSecurityAdmin”) following the steps in Security section. (Note: the role “User” was changed to “CatUser”).

Latest update: 09/20/2016

25

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

IBM WEBSPHERE V7 APPLICATION SERVER SETUP To install and run CAT83 System properly, you must setup IBM WebSphere v7 Application Server performing the following steps. Note: This manual do not describes the installation process of the application server installation process.

DATABASE ACCESS ATTENTION: In case of data sources settings (ProffisDS e GFAllianceDS) are already done, please ignore this step. CREATING USERNAME AND PASSWORD TO ACCESS DATABASE 1. Access WebSphere administrative console. On the side menu select “Security” then select “Global security” Click the “Java Authentication and Authorization Service” option A new menu is displayed. Click J2C authentication data On Global security 2. Click New Enter mastersafGF in Alias text box In User ID text box fill with user information to access the database Click OK 3. Click Save to confirm settings. CREATING JDBC PROVIDER XA 1. Access WebSphere administrative console and select “JDBC providers” on menu Resources > JDBC 2. Select on combo the “Node=xxx,Server=xxx” scope Example: “Node=e30node01,Server=server1” Click New Latest update: 09/20/2016

26

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM On Create a new JDBC Provider

3. Fill the text boxes selecting the itens on the dropdown lists, as follows: TEXT BOX

ORACLE

MSSQL

Database type

Oracle

SQL Server

Provider type

Oracle JDBC Driver

Microsoft SQL Server JDBC Driver

Implementation type

XA data source

XA data source

Name

Oracle JDBC Driver (XA)

Microsoft SQL Server JDBC Driver (XA)

4. Access Create a new JDBC Driver screen. Oracle users 4.1 Enter the file path where is located the JAR file. Example: C:\Mastersaf\DriverJDBC 4.2 Click Next then click Finish. MS SQL users 4.3 Enter the sqljdbc4.jar file path in Directory location for “sqljdbc.jar” which is saved as WebSphere variable ${MICROSOFT_JDBC_DRIVER_PATH} text box Do not fill Native library path text box 4.4 Click Next then click Finish On JDBC Provider 4.5 Click Save to confirm settings 4.6 Click “Microsoft SQL Server JDBC Driver (XA)” link 4.7 In Classpath text box, change the string ${MICROSOFT_JDBC_DRIVER_PATH}/ sqljdbc.jar to: ${MICROSOFT_JDBC_DRIVER_PATH}/sqljdbc4.jar 4.8 Click OK. The system displays a message box 4.9 Click Save to confirm settings.

Latest update: 09/20/2016

27

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM CREATE A DATASOURCE 1. Access WebSphere administrative console. Select “Data Sources” on menu Resources > JDBC 2. Select “Node=xxx,Server=xxx” scope. Click New The system displays the Create a data source screen 3. Enter GF Datasource in Data source name text box Enter jdbc/GFAlllianceDS in JNDI name text box 4. Click “Select an existing JDBC provider”

Choose the created provider according to your database and click Next. Oracle users 4.1 Enter URL in Value text box in order to access the database and click Next. MS SQL users 4.2 The system displays Enter database specific properties for the data source. Fill Database name, Port number and Server name text boxes according to installed SQL Server environment and click Next. Access Create a data source screen 5. In Authentication alias for XA recovery and Component-managed Authentication Alias text boxes, select the user you have created on step “Creating username and password to access database” Click Next Access Data sources screen 6. Click Save to confirm settings In order to test the created connection, select “GFAllianceDS” data source then click Test connection button. The system displays the following message: “The test connection operation for data source GFAllianceDS on server server1 at node e30node01 was successful.” Repeat all previous steps to create a new data source. On step 3 (Create a data source screen), fill the Data source name and JNDI name text boxes with “Proffis Datasource” and “jdbc/ProffisDS”. Latest update: 09/20/2016

28

INSTALL / UPDATE / SETUP MANUAL

CAT83 SYSTEM

UNINSTALLING CAT83 Remove the CAT83 system application proceeding as follows: 1. Remove the Application from the Java EE Application Server 2. Remove the Data base tables 3. Run “drop_views.sql” and “drop_tables.sql” scripts located in the folder:

(Mastersaf GF install folder) > 2.2.XX > scripts > Remove 4. Remove the Local Files; 5. Remove the “.properties” files located at C:\mastersaf (Windows) or /mastersaf (Linux); 6. Uninstall the CAT83 system in Windows Control Panel > Add and Remove programs.

Latest update: 09/20/2016

29