O Monitor Unificado da Mensagem Padronizada foi construído para funcionar independente da tecnologia adotada em cada produto TOTVS. Construído e pensado para a Web, ele apenas precisa de um servidor HTTP para sua instalação.

A partir deste ponto, os seguintes termos serão usados:

  • Aplicativo - Produto integrado;
  • JSON - Java Script Object Notation, o formato de objetos de Javascript (mas não utilizada somente por ele);
  • Aplicativo Interno - Produto no qual o Monitor Unificado está ligado;
  • Aplicativo externo - Produto ao qual o aplicativo interno se integra.

Para configurar o monitor, os passos a seguir são necessários, de acordo com a linha de produto.

Dependendo da configuração do servidor HTTP, pode ser necessário incluir os tipos MIME correspondentes aos arquivos utilizados pelo monitor (exemplo: ".js" e ".json"). Consulte a documentação específica de cada produto para saber como proceder.

No Protheus

A) Informar na configuração do APPSERVER.INI, na seção "HTTP", a porta na qual o monitor será executado, tendo o Http Server do Protheus como servidor de aplicação. Também deve ser informado em "PATH" o diretório em que serão buscados os fontes do monitor. Conforme demonstrado abaixo:

B) Ainda no arquivo APPSERVER.INI, deve-se habilitar o servidor REST, para disponibilizar os serviços que serão chamados pelo Monitor EAI. Para isso, deve-se realizar as configurações conforme exemplo abaixo:

[HTTPV11]
ENABLE=1
ADDRESSFAMILY=1
SOCKETS=HTTPREST
TIMEOUT=600
CORSEnable=1
AllowOrigin=*

[HTTPREST]
PORT=8085
IPSBIND=
MAXQUEUE=999
SSLPUBLICKEY=
SSLPRIVATEKEY=
SSLPASSWORD=
SECURITY=1
URIS=EAIMONITOR
CORSEnable=1
AllowOrigin=*

[EAIMONITOR]
URL=/totvseai/monitor/v1/
PREPAREIN=<grupo de empresa Protheus>
ONSTART=REST_START
ONCONNECT=REST_CONNECT
ONEXIT=REST_EXIT
INSTANCES=1,30
CORSEnable=1
AllowOrigin=*

Atenção

No Protheus, cada grupo de empresas é um aplicativo diferente para o monitor EAI. Desta maneira, cada grupo de empresas deve possuir um endereço REST diferente. Caso seja recebida uma requisição para um endereço cujo grupo de empresas é diferente do enviado, a seguinte mensagem será apresentada: O grupo de empresas do aplicativo  não corresponde ao grupo de empresas deste serviço. Grupo recebido - (A). Grupo do serviço - (B) , onde A e B são respectivamente o grupo recebido na requisição e o grupo de empresas do endereço REST

Para mais informações sobre como criar um servidor http a partir do Protheus consulte 06. Configurando o Server Protheus para HTTP.

Dúvidas de como configurar o servidor Rest do Protheus consulte 01. Configuração.

C) Após realizar a configuração, realizar o download dos fontes atuais do Monitor EAI (clique aqui para baixar a versão desejada), e copiar os arquivos do monitor para o diretório especificado. Neste caso o caminho do monitor será "D:\Web\totvseai-monitor".

D) Acessar o seguinte endereço http://<servidor>:<porta>/totvseai-monitor/index.html, onde <servidor> é a máquina onde está o HTTP Server do Protheus e <porta> é o valor informado no arquivo de configuração (neste caso, 8066). A tela de wizard abaixo será apresentada para a configuração do arquivo monitor-url-list.json.

E) Nesta tela deve ser informado o servidor HTTP e a porta REST do ambiente desejado (neste caso, 8085). Após preencher os dados, clique em "Carregar", complete os dados relativos aos aplicativos externos, e realize o download do arquivo de configuração, conforme demonstrado a seguir.

F) O arquivo baixado deve ser copiado para o diretório "\totvseai-monitor\config" no servidor Protheus, mantendo, impreterivelmente, o nome de "monitor-url-list.json". Caso seja necessário colocar o arquivo de configuração em outra pasta, consulte a seção Alteração do local do arquivo, ao final deste documento.

G) Depois de executar todos os procedimentos, basta realizar o acesso a página principal do Monitor EAI e o mesmo estará pronto para utilização. Observação: O login deve ser realizado de acordo com o conteúdo informado nos campos "Usuário" e "Senha" da tela do Wizard.

No Logix

A) Executar os passos A e B da configuração do Protheus (ver acima).

Diferenças em relação ao Protheus

Na chave PrepareIn, para o Logix, não é necessário informar o grupo de empresas.

Já nas seções HTTP e HTTPV11, é necessário incluir a chave LOGIX=1.

B) No Logix, a partir da versão 12.1.18, os fontes do monitor são expedidos junto com o produto e podem ser encontrados em <Pasta_Logix>/totvseai-monitor. Caso a pasta não esteja disponível, pode-se fazer o download no link informado no passo C da configuração do Protheus.

C) Executar os passos D a G da configuração do Protheus.

No Datasul

Pasta com fontes do Monitor EAI

A partir da versão 12.1.18 do Datasul, os fontes do Monitor EAI são expedidos junto com o produto e podem ser encontrados em:

Framework JBOSS: <Pasta_Datasul>/ServidorAplicação/jboss-4.2.3.GA/server/<instância>/deploy/datasul-byyou-<versão>-SNAPSHOT.ear/totvseai-monitor-ui-<versão>-SNAPSHOT.war.

Framework Tomcat: <Pasta_Datasul>/<Pasta_Tomcat>/webapps/totvseai-monitor.

Framework Wildfly: <Pata_Datasul>/<Pasta_Wildfly>/standalone/deployments/totvseai-monitor.war.

A) Acesse o endereço http://<servidor>:<porta>/totvseai-monitor/index.html, onde <servidor> é endereço da máquina onde o Datasul está instalado e <porta> é a porta de instalação do produto (por exemplo: 8080).

B) Execute os passos D a G da configuração do Protheus, lembrando que o arquivo baixado deve ser copiado para a pasta "config" situada dentro da pasta relativa ao monitor, conforme indicado no quadro acima. 

No RM

A) A partir da versão 12.1.18, os fontes do Monitor EAI são expedidos com o produto e podem ser encontrados na pasta <Pasta_RM>/atual/release/bin/wwwroot/totvseai-monitor. Caso a pasta não esteja disponível, pode-se fazer o download utilizando o link do passo C da configuração do Protheus.

B) Se for efetuado o download, descompactar o pacote contendo os arquivos do monitor no diretório "root" do servidor HTTP escolhido. Pode ser usado o host do RM como servidor, Exemplo: C:\totvs\CorporeRM\RM.Net\wwwroot\.

C) Seguir os passos D a G da configuração do Protheus.

Sobre o arquivo de configuração (monitor-url-list.json)

O arquivo monitor-url-list.json, situado na pasta config, é fundamental para o correto funcionamento do monitor. Nele estarão contidos todos os aplicativos referenciados numa integração, sejam internos ou externos. Um aplicativo é descrito através de um JSON contendo os seguintes atributos:

Nome do Aplicativo: Este nome, no Protheus, é composto pelo nome do environment utilizado (em upper case) concatenado ao grupo de empresas utilizado, seguido de "@" e "PROTHEUS". Para os demais produtos, usar, depois do "@" "DATASUL", "LOGIX" ou "RM", conforme aplicação.
O nome será um atributo do tipo Objeto JSON, que por sua vez, conterá os seguintes atributos:

  1. "isActive": Deve existir e ter valor igual a "true" somente para o aplicativo interno onde o monitor estiver embarcado.
  2. "userCode": Usuário necessário para acessar os serviços de monitoramento do aplicativo interno (deve estar em base64).
  3. "password": Senha necessária para acessar os serviços de monitoramento do aplicativo interno (deve estar em base64).
  4. "externalApps": Atributo do tipo array de caracteres, contendo o identificador do aplicativo. Por exemplo: "RM@RM".

Os demais aplicativos devem ser referenciados usando as orientações acima. Abaixo, um exemplo de configuração do arquivo, onde um Protheus com um environment de nome pr11_bra, no grupo de empresas 18, comunica-se com um Protheus com environment de nome pr12_bra_migri, também do grupo 18:

Exemplo de configuração do arquivo monitor-url-list.json
{
	"PR11_BRA18@PROTHEUS" : {
        "isActive" : "true",
        "userCode" : "bWVzdHJl",
        "password" : "dG90dnM=",  
        "externalApps" : ["PR12_BRA_MIGRI18@PROTHEUS"]
	},
	"PR12_BRA_MIGRI18@PROTHEUS" : { 
        "userCode" : "YWRtaW4=",
        "password" : "YWRtaW4=",
        "externalApps" : ["Pr11_BRA18@PROTHEUS"]
	}
}


Alteração do local do arquivo

Há situações onde o local padrão do arquivo monitor-url-list.json (/totvseai-monitor/config) não é a mais conveniente. Alguns exemplos são:

  • Ambientes de teste do monitor, onde a atualização do pacote é frequente.
  • Necessidade de compartilhar o arquivo sem ter que expor toda a pasta de fontes do monitor.

Por conta disso, é possível alterar o local padrão através do ajuste do arquivo totvs-app.constant.js, situado na pasta totvseai-monitor/js. Neste arquivo, deve-se ajustar o valor da propriedade (ou variável) EXTERNAL_APPS_URL para apontar para um novo local, o qual deve estar visível como um endereço WEB.

Por exemplo: supondo que o monitor esteja hospedado no servidor http://localhost:8080, e que a nova localização do arquivo seja uma pasta chamada c:\wwwroot\config, o arquivo de configuração deve estar acessível pelo navegador de internet usando o endereço http://localhost:8080/config/monitor-url-list.json. 

Logo, a variável deve ser alterada para:

EXTERNAL_APPS_URL: '/config/monitor-url-list.json',

Dependendo do servidor WEB que hospeda o monitor de EAI, será necessário ajustar algumas configurações para criação da pasta externa ao pacote padrão do aplicativo. Para saber como proceder este ajuste em servidores de aplicação TOTVS, verifique os links abaixo: