Orientações e FAQ - TOTVS Agro PIMS Server

01. COMO ENCRIPTAR (CODIFICAR) SENHAS NO SERVIDOR DE APLICAÇÃO TOMEE (DATASOURCE)

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Após a instalação e a configuração, deve-se parar o serviço do TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) que se deseja encriptar (codificar) a(s) senha(s) no servidor de aplicação TomEE (datasource).

3. Logo após, deve-se navegar até a pasta bin localizada no diretório inicial do TomEE.

4. Em seguida, abrir o Prompt de Comandos (Windows) ou Terminal (Linux) , navegar até o diretório bin e digitar o seguinte comando:

Ambiente Windows:

tomee.bat cipher <senha original> 

Ambiente Linux:

tomee.sh cipher <senha original> 

5. Após realizada a criptografia (codificação), deve-se copiar a senha encriptada (codificada) e atualizar o arquivo tomee.xml (localizado no diretório "/tomee/conf"). Também se deve adicionar a propriedade PasswordCipher, conforme apresentado abaixo:

PasswordCipher Static3DES

6. Para concluir, basta salvar o arquivo tomee.xml e reiniciar o serviço do TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209).

02. COMO REALIZAR A MANUTENÇÃO DO "ORA-01843: NOT VALID MONTH" NO PIMS SERVER

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Depois, pare o serviço do PIMS Server respectivo ao módulo em utilização.

3. Após a parada do serviço, abra o arquivo service.bat localizado em Totvs/.../Módulo em utilização/tomee/bin com um editor de texto.

4. Na linha 253, após o --JvmOptions, inclua os argumentos abaixo e salve o documento:

-Duser.language=pt;-Duser.country=BR;

5. Abra o Prompt de Comando - CMD como Administrador.

6. Passe o caminho onde está localizado a pasta tome\bin do módulo em utilização que ocorreu o erro no PIMS CS, é obrigatório que a ultima pasta do caminho seja a bin. Exemplo abaixo:

7. Execute o comando abaixo:

service remove

8. Após, execute esse outro comando:

service install

9. Finalizando, feche o CMD e suba o serviço PIMS Server respectivo ao módulo em utilização.

03. COMO DEFINIR A MEMÓRIA NO SERVIDOR TOMEE DO PIMS SERVER

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

1.1 VERSÃO WINDOWS:

2. Depois, pare o serviço do PIMS Server respectivo ao módulo em utilização.

3. Após a parada do serviço, abra o arquivo service.bat localizado em Totvs/.../Módulo em utilização/tomee/bin com um editor de texto.

4. Na linha 24, coloque o valor mínimo de memória que você quer reservar (Ex. 1024):

set ENV_MEMORY_MIN=1024

Na linha 25, coloque o valor máximo de memória que você quer reservar (Ex. 2048) e salve o documento:

set ENV_MEMORY_MAX=2048

5. Abra o Prompt de Comando - CMD como Administrador.

6. Passe o caminho onde está localizado a pasta tome\bin do módulo em utilização, é obrigatório que a ultima pasta do caminho seja a bin. Exemplo abaixo:

7. Execute o comando abaixo:

service remove

8. Após, execute esse outro comando:

service install

9. Finalizando, feche o CMD e suba o serviço PIMS Server respectivo ao módulo em utilização.

1.2 VERSÃO LINUX:

2. Depois, pare o serviço do PIMS Server respectivo ao módulo em utilização.

3. Após a parada do serviço, abra o arquivo catalina.sh localizado em Totvs/.../Módulo em utilização/tomee/bin com um editor de texto.

4. Na linha 128, coloque o valor mínimo e máximo de memória que você quer reservar (Ex. 1024M - 4096M):

JAVA_OPTS="$JAVA_OPTS -Xms1024M -Xmx4096M -XX:MaxPermSize=1024M  -Duser.language=pt -Duser.country=BR"

5. Salve o arquivo catalina.sh e reinicie o serviço que foi parado, após isso, já estará com as novas configurações de memória estabelecidos.

04. COMO SABER A VERSÃO DO TOMEE QUE ESTÁ SENDO UTILIZADO

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Depois, vá até a pasta Totvs/.../Módulo em utilização/tomee/lib

3. Abra o Prompt de Comando - CMD como Administrador.

4. Passe o caminho onde está localizado a pasta tome\lib do módulo em utilização, é obrigatório que a ultima pasta do caminho seja a lib. Exemplo abaixo:

5. Após, execute esse comando:

java -cp catalina.jar org.apache.catalina.util.ServerInfo

6. Finalizando, mostrará no Terminal, as informações importantes sobre o Tomee e o Sistema Operacional.

05. COMO ADICIONAR/MODIFICAR O NOME DO AMBIENTE

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Depois, pare o serviço do PIMS Server respectivo ao módulo em utilização.

3. Após a parada do serviço, abra o arquivo service.bat localizado em Totvs/.../Módulo em utilização/tomee/bin com um editor de texto.

4. Na linha 253, após o --JvmOptions, inclua os argumentos abaixo (a palavra Producao pode ser modificado ao seu critério) e salve o documento:

-Dpimsserver.web.env=Producao;

5. Abra o Prompt de Comando - CMD como Administrador.

6. Passe o caminho onde está localizado a pasta tome\bin do módulo em utilização, é obrigatório que a ultima pasta do caminho seja a bin. Exemplo abaixo:

7. Execute o comando abaixo:

service remove

8. Após, execute esse outro comando:

service install

9. Finalizando, feche o CMD e suba o serviço PIMS Server respectivo ao módulo em utilização, após subir o serviço, observará que estará incluído o nome do ambiente quando abrir o PIMS Server.

06. COMO SABER AS VERSÕES DOS MÓDULOS NO PIMS SERVER

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Devemos acessar o PIMS Server e realizar o Login para ter acesso ao PIMSWeb.

3. Após realizar o acesso, devemos ir até a opção Módulos, na aba PIMS Web:

4. Assim, aparecerá todos os módulos instalados e suas respectivas versões.

07. COMO REINSTALAR O SERVIÇO DO PIMS Server

Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows, conforme descrito no manual de instalação.

1. Abra o Prompt de Comando - CMD como Administrador.

2. Passe o caminho onde está localizado a pasta tome\bin do módulo em utilização, é obrigatório que a ultima pasta do caminho seja a bin. Exemplo abaixo:

3. Execute o comando abaixo:

service remove

4. Após, execute esse outro comando:

service install

5. Finalizando, feche o CMD e suba o serviço PIMS Server respectivo ao módulo em utilização.

08. CONFIGURAÇÃO DO LDAP

No PIMS Server essa configuração é realizada para autenticar a conexão com LDAP e após validação é realizado uma pesquisa no servidor LDAP do usuário informado. Essa autenticação e pesquisa irá ocorrer conforme configurado o ldap.properties, por isso que é importante entendermos os atributos configurados.

Para inicializarmos a configuração do LDAP, devemos parar o serviço do PIMS Server.

 Com o serviço do PIMS Server parado, devemos navegar até a pasta que foi realizado a instalação do PIMS Server e entrar na pasta \tomee\conf:

• Caminho Padrão

  C:\TotvsAgro\pimsserveer\tomee\conf

Logo após, iremos criar um novo arquivo de texto e renomear para ldap.properties. Caso já exista o arquivo, basta abri-lo com editor de texto:

Com um editor de texto, devemos colocar as seguintes informações:

• ldap.properties

  ldap.url=
  ldap.baseDN=
  ldap.authentication=
  ldap.timeout=
  ldap.server=
  ldap.sufixDomainName=
  ldap.concatUIDwithDOMAIN=
  ldap.sufixFilterDomainName=
  ldap.sufixFilterConcatUIDwithDomainName=
  ldap.attribute.uid=
  ldap.attribute.cn=cn
  ldap.attribute.sn=sn
  ldap.attribute.givenName=givenName
  ldap.attribute.memberOf=memberOf
  ldap.attribute.mail=

Após isso, será necessário preencher todas as informações de acordo com o seu servidor LDAP e salvar o arquivo. Para isso temos uma explicação do que é cada configuração e um exemplo utilizado.

• Explicação:

ldap.url= Devemos informar o caminho para conexão com servidor: ldap://IP:PORTA
ldap.baseDN= Definir qual o diretório que estão inseridos os usuários na árvore do servidor LDAP.
ldap.authentication= Qual o tipo de autenticação do servidor LDAP. O principal tipo utilizado pelos servidores LDAP são autenticação "simple"
ldap.timeout= Definir qual o tempo para TIMEOUT do servidor LDAP.
ldap.server= Definir se o servidor é do tipo MS (Microsoft) ou SUN (Sun Java System Directory Server).
ldap.sufixDomainName= Definir o nome do domínio, caso tenha mais que um, utilizar separador com ",". Conforme mostrado no exemplo: "totvs.com.br,totvs-partners.com.br"
ldap.concatUIDwithDOMAIN= Definir true se deseja realizar a concatenação do usuário com domínio para autenticação no LDAP, false caso contrário.
ldap.sufixFilterDomainName= Definir caso seja necessário personalizar o domínio no momento da busca do usuário no LDAP. Por exemplo comparar "fulano@totvs.com.br" você poderá personalizar para buscar como "fulano@*totvs.com.br" para em uma expansão maior dentro do domínio.
ldap.sufixFilterConcatUIDwithDomainName=  Definir true se na busca pelo usuário no LDAP, deve ser concatenado com domínio. Exemplo: com true "fulano@dominio", com false "fulano", nesse caso dependerá de como será utilizado a busca (ldap.attribute.uid)
ldap.attribute.uid= Definir como será realizado a busca pelo usuário através do servidor LDAP, deve-se verificar no servidor qual o padrão será utilizado. Os principais são userPrincipalName e sAMAccountName.
ldap.attribute.cn= Atributo não utilizado no momento. (Definir: cn)
ldap.attribute.sn= Atributo não utilizado no momento. (Definir: sn)
ldap.attribute.givenName= Atributo não utilizado no momento. (Definir: givenName)
ldap.attribute.memberOf= Atributo não utilizado no momento. (Definir: memberOf)
ldap.attribute.mail= Definir o atributo que é utilizado para buscar os e-mail, por padrão o mais utilizados pelos servidores LDAP utilizam: postOfficeBox

• Exemplo de configuração TOTVS:

  ldap.properties - Exemplo

  ldap.url=ldap://totvs.com.br:389
  ldap.baseDN=dc=totvs,dc=com,dc=br
  ldap.authentication=simple
  ldap.timeout=5000
  ldap.server=MS
  ldap.sufixDomainName=totvs.com.br,partners-totvs.com.br
  ldap.concatUIDwithDOMAIN=true
  ldap.sufixFilterDomainName=*totvs.com.br
  ldap.sufixFilterConcatUIDwithDomainName=true
  ldap.attribute.uid=userPrincipalName
  ldap.attribute.cn=cn
  ldap.attribute.sn=sn
  ldap.attribute.givenName=givenName
  ldap.attribute.memberOf=memberOf
  ldap.attribute.mail=postOfficeBox

Agora, temos o LDAP configurado. Também é possível também acompanhar o auth.log para realizar o acompanhamento caso o nível do log esteja em DEBUG.

Para entrar no sistema do PIMSWeb via LDAP, basta inicializar o serviço do PIMS Server e seguir o manual:

Simulação do Acesso - TOTVS Agro PIMS SERVER

09. ATIVAR HTTPS NO PIMS SERVER (TOMEE) UTILIZANDO CERTIFICADO SSL

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Após a instalação e a configuração, deve-se parar o serviço do TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) que se deseja ativar o HTTPS no servidor Tomee.

3. Primeiro, deve-se adiquir um certificado SSL válido, assinado por uma autoridade certificadora no formato *.cer. Para utilizar na configuração, é preciso importar esse arquivo para o formato *.jks (ou *.keystore), através do utilitário keytool que acompanha a instalação do Java. Para importar o certificado, execute o comando keytool via prompt a partir do diretório bin da instalação do Java, informando os seguintes parâmetros:

C:\jdk-11\bin\> keytool -import -alias apelido_certificado -keystore $CAMINHO_CERTIFICADO\mykeystore.jks -trustcacerts -file $CAMINHO_CERTIFICADO\certificado_valido.cer

Caso não tenha ainda um certificado assinado por autoridade certificadora, é possível gerar um certificado auto-assinado através do utilitário keytool. Um certificado auto-assinado tem validade apenas para uso interno. O navegador irá bloquear o carregamento da página ao acessar um servidor HTTPS configurado com certificado auto-assinado, exibindo no lugar mensagem informando que a conexão não é confiável.

Para gerar um certificado auto-assinado, execute o seguinte comando no prompt:

C:\jdk-11\bin\> keytool -genkey -keystore $CAMINHO_CERTIFICADO\mykeystore.jks -storepass senha -keyalg RSA -alias apelido_certificado -validity 3650 -dname "cn=Totvs,ou=Agro,c=Assis,s=SP,c=BR

4. Colocar o certificado SSL no diretório de confiança do TomEE. Isso pode ser feito copiando o arquivo do certificado para o diretório "$TOMEE_HOME/conf" e configurando o arquivo "server.xml" para apontar para ele.

5. Editar o arquivo "server.xml" e adicionar uma seção de conector SSL ao final do arquivo. Você precisará definir o keystore e a senha do keystore para corresponder ao seu certificado SSL.

Novos parâmetros na tag Conector:

maxThreads="200" 
SSLEnabled="true" 
scheme="https"
secure="true" 
clientAuth="false" 
sslProtocol="TLS"
keystoreFile="${catalina.home}/conf/<nome do certificado>.jks"
keystorePass="<senha do certificado>"

6. Para concluir, basta salvar o arquivo server.xml e reiniciar o serviço do TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209).

10. DESABILITAR PÁGINA DE BOAS-VINDAS

1. Para realizar essa operação, deve-se possuir, em seu ambiente, o TOTVS Agro PIMS Server (Modernizado - Releases >= 12.1.2209) em Windows ou Linux, conforme descrito no manual de instalação.

2. Navegue até diretório do seu tomee, entre na pasta conf e abre o arquivo web.xml com editor de texto.

3. No arquivo texto, busque pela palavra welcome-file-list e em seguida encontramos a seguinte estrutura:

    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>

4. Para desabilitar, basta comentar o trecho acima, que ficará da seguinte forma:

	<!--
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list> 
	-->

5. Após isso, podemos reiniciar/reinicializar o serviço e realizar o teste com senha criptografada.

11. DESABILITAR PÁGINA DE ADMINSTRAÇÃO (MANAGER APP)

1. Esta seção foi baseada na documentação do tomcat, disponível em Manager App How-To

2. Para desabilitar, devemos navegar no diretório do tomee, entrar na pasta conf e com um editor de texto abrir o arquivo tomcat-users.xml

3. Por padrão, quando não possuímos usuários disponíveis no tomcat-users.xml, a página de administração é desabilitada. Levando isso em consideração, podemos remover ou comentar os usuários disponíveis no xml, como no exemplo destacado a seguir.

Antes (Habilitado):

Depois (Desabilitado):

4. Após isso, podemos reiniciar/reinicializar o serviço e realizar o teste com senha criptografada.

12. ENCRIPTAR (CODIFICAR) SENHAS DE USUÁRIOS ADMINISTRADORES (ARQUIVO "tomcat-users.xml")

1. Para utilizar usuários com senha criptografas devemos navegar no diretório do tomee, entrar na pasta conf  e com editor de texto abrir o arquivo server.xml.

2. No arquivo server.xml, iremos buscar LockOutRealm e iremos adicionar o seguinte trecho:

<CredentialHandler className="org.apache.catalina.realm.MessageDigestCredentialHandler" algorithm="SHA-256" />

3. Após adicionar, deve-se ficar da seguinte forma:

            <Realm className="org.apache.catalina.realm.LockOutRealm">
                <Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase">
				<CredentialHandler className="org.apache.catalina.realm.MessageDigestCredentialHandler" algorithm="SHA-256" />
				</Realm>
            </Realm>

4. Agora devemos criptografar a senha que será utilizada, para isso, devemos utilizar o prompt de comando e navegar até a pasta do tomee\bin e baseando-se que "testesenha" é o que iremos criptografar, será necessário o seguinte comando:

digest.bat -a SHA-256 -h org.apache.catalina.realm.MessageDigestCredentialHandler testesenha

5. Com isso, será devolvido a senha digitada e a senha criptografada

testesenha:538bb402b84b50005ff09babc83c89f74ee5d6031d4199911cbaa67a4c135ee0$1$54763f2c9a22bb9344ef0a9e79a1a196c848686ac8c2dd1f0da9032787943d98

6. Agora podemos ir até o arquivo tomee\conf\tomcat-users.xml e lá nos usuários podemos especificar a senha criptografada que foi gerada, como no exemplo abaixo:

7. Após isso, podemos reiniciar/reinicializar o serviço e realizar o teste com senha criptografada.

13. HOMOLOGAÇÃO DE SMTP (FUNCIONALIDADE DE ENVIO DE E-MAILS VIA PIMS SERVER)

O produto TOTVS Agro PIMS Server (aplicação Java Web), disponibilizada (publicada) em uma instância do servidor de aplicação Tomcat/TomEE, pode ser configurado para uso de funcionalidade de envio de e-mails.

Atualmente, a funcionalidade de SMTP está homologada para SMTP Google/Gmail (recomendação de Engenharia TOTVS Agro). O uso de configurações específicas para outros SMTP (públicos ou privados/internos) podem ter comportamentos diferentes dos homologados pelo time TOTVS Agro. Neste tema, não há suporte padrão via Produto e/ou Engenharia TOTVS Agro. Desta forma, recomenda-se o uso do SMTP Google/Gmail por padrão.

Para isto, há duas configurações que devem ser realizadas para que, processos que implementam o envio de e-mail, funcionem corretamente:

• Configuração de dados de SMTP (servidor, conta e outros) por meio do arquivo "tomee.xml" (armazenado no diretório de instalação do servidor de aplicação Tomcat/TomEE);

- Configurações realizadas com homologação para SMTP de Google/Gmail (homologado/recomendado):

<Resource id="PimsMailResource" type="javax.mail.Session">
   mail.transport.protocol=smtp
 
   [email protected]
   password=<senha/app password>
   mail.debug=true
   [email protected]
 
   mail.smtp.host=smtp.gmail.com
   mail.smtp.port=587
   mail.smtp.auth=true
   mail.smtp.starttls.enable=true
   mail.smtp.starttls.required=true
 
   mail.smtp.ssl.trust=smtp.gmail.com
   mail.smtp.ssl.protocols=TLSv1.2
   mail.smtp.ssl.enable=false
</Resource> 

• Configuração de dados de SMTP (servidor, conta e outros) por meio de parâmetros do TOTVS Agro Bioenergia;

- A habilitação/configuração de dados do SMTP também se faz necessária via parâmetros do produto TOTVS Agro Bioenergia:

Seção = "GERAIS" | Entrada = "MAIL_SMTP"    : Endereço (host) de acesso/conexão ao SMTP (equivalente ao "mail.smtp.host" no arquivo "tomee.xml")
Seção = "GERAIS" | Entrada = "MAIL_PORTA"   : Porta de acesso/conexão ao SMTP (equivalente ao "mail.smtp.port" no arquivo "tomee.xml")
Seção = "GERAIS" | Entrada = "MAIL_CONTA"   : Usuário ou e-mail (conta) para envio de e-mails (equivalente ao "mail.user" no arquivo "tomee.xml")
Seção = "GERAIS" | Entrada = "MAIL_USUARIO" : Usuário de autenticação do SMTP (equivalente ao "mail.smtp.user" no arquivo "tomee.xml")
Seção = "GERAIS" | Entrada = "MAIL_SENHA"   : Senha de autenticação no SMTP (equivalente ao "password" no arquivo "tomee.xml")

14. (DEV TEAM) PROCESSOR DE EXEMPLO/VALIDAÇÃO DE ENVIO DE E-MAILS (MÓDULO MANFRO)

• DAGROFRAME-3900 - Obtendo detalhes do item... STATUS

15. COMO RESOLVER PROBLEMA DE SALVAR PROCESSO AGENDADO COM ÚLTIMO DIA DO MÊS

1. Parar o serviço do TOTVS Agro PIMSServer
2. Abrir o arquivo tomee\data\hsqldb\pimsserver\pimsserver.script com editor de texto.
3. Buscar no editor de texto por: DAY_OF_MONTH
   
4. Ao encontrar, substituir de DAY_OF_MONTH VARCHAR(2) NOT NULL para DAY_OF_MONTH VARCHAR(4) NOT NULL
5. Salvar o arquivo.
6. Inicializar o servidor de aplicação.
7. Testar novamente.