Dashboard Backoffice - Configurações Necessárias

01. IMPLANTAÇÃO DO DASHBOARD

Informações Importantes 🛑

O Dashboard necessita do Microsiga Protheus® Release 12.1.33 ou superior.

O Dashboard necessita do Binário de outubro/2021 ou superior.

O Dashboard necessita de Lib de 06/01/2021 ou superior.

O Dashboard é compatível com os módulos do Backoffice Protheus.

Siga o passo a passo abaixo para implantação e utilização do Dashboard Backoffice.

1. Ajuste os arquivos appserver.ini e smartclient.ini, com a Porta Multiprotocolo e outras chaves necessárias, conforme explanado a seguir.

Insira no appserver.ini as chaves abaixo, independente do tipo de comunicação utilizado no ambiente:

[GENERAL]
App_Environment=ENVIRONMENT

[DRIVERS]
MultiProtocolPort=1

Efetue os passos abaixo caso deseje utilizar comunicação segura:

1.1. Instale no servidor e na(s) máquina(s) onde será executado o Smartclient, o certificado totvs_certificate_CA.crt contido na pasta appserver. Mais informações em Application Server - Porta Multiprotocolo.

1.2. Execute o totvs_certificates.exe disponível em Porta Multiprotocolo - Geração de Certificado, a fim de gerar o certificado do servidor (arquivos totvs_certificate.crt e totvs_certificate_key.pem).

1.3. Copie para a pasta appserver os dois arquivos gerados no passo anterior.

1.4. Insira no appserver.ini as chaves:

[DRIVERS]
MultiProtocolPort=1
MultiProtocolPortSecure=1

[SSLConfigure]
SSL2 = 1
SSL3 = 1
TLS1_0 = 1
TLS1_1 = 1
TLS1_2 = 1
Bugs =1
State =1
CertificateServer=C:\Protheus12\totvs\tec\appserver\totvs_certificate.crt (adeque para o caminho onde foram colocados os certificados)
KeyServer=C:\Protheus12\totvs\tec\appserver\totvs_certificate_key.pem (adeque para o caminho onde foram colocados os certificados)

1.5. Insira no(s) smartclient.ini a chave:

[tcp]
secureconnection=1

Efetue os passos abaixo caso não deseje utilizar comunicação segura:

1.1. Insira no appserver.ini a chave:

[DRIVERS]
MultiProtocolPort=1
MultiProtocolPortSecure=0

1.2. Insira no(s) smartclient.ini a chave:

[tcp]
secureconnection=0

Exemplo de appserver.ini com SSLConfigure

[ENVIRONMENT]
SOURCEPATH=C:\Protheus12\totvs\protheus\apo
ROOTPATH=C:\Protheus12\totvs\protheus\Protheus_data
STARTPATH=/system/
RPODB=TOP
RPOLANGUAGE=PORTUGUESE
RPOVERSION=120
LOCALFILES=CTREE
LOCALDBEXTENSION=.dtc
StartSysInDB=1
TOPMEMOMEGA=1
PICTFORMAT=DEFAULT
DATEFORMAT=DEFAULT

;sql 
DBDATABASE=MSSQL
DBSERVER=LOCALHOST
DBALIAS=ENVIRONMENT
dbport=7892

[TDS]
AllowApplyPatch=*
AllowEdit=*

[DRIVERS]
ACTIVE=TCP
MultiProtocolPort=1 
MultiProtocolPortSecure=1

[SSLConfigure]
SSL2   = 1
SSL3   = 1
TLS1_0 = 1
TLS1_1 = 1
TLS1_2 = 1
Bugs    =1
State   =1
CertificateServer=C:\Protheus12\totvs\tec\appserver\totvs_certificate.crt (adeque para o caminho onde foram colocados os certificados)
KeyServer=C:\Protheus12\totvs\tec\appserver\totvs_certificate_key.pem (adeque para o caminho onde foram colocados os certificados)
 
[TCP]
TYPE=TCPIP
PORT=1232

[GENERAL]
App_Environment=ENVIRONMENT 
BUILDKILLUSERS=1
MAXSTRINGSIZE=10

[LICENSECLIENT]
server=LOCALHOST
port=8009

[HTTP]
ENABLE=1
PORT=88
ENVIRONMENT=ENVIRONMENT

[WEBAPP]
PORT=1255
WebSocket=0
LastMainProg=SIGAADV

[WebApp/webapp]
MPP=

Exemplo de appserver.ini sem SSLConfigure

[ENVIRONMENT]
SOURCEPATH=C:\Protheus12\ENVIRONMENT\totvs\protheus\apo
ROOTPATH=C:\Protheus12\ENVIRONMENT\totvs\protheus\Protheus_data
STARTPATH=/system/
RPODB=TOP
RPOLANGUAGE=PORTUGUESE
RPOVERSION=120
LOCALFILES=CTREE
LOCALDBEXTENSION=.dtc
StartSysInDB=1
TOPMEMOMEGA=1
PICTFORMAT=DEFAULT
DATEFORMAT=DEFAULT

;sql 
DBDATABASE=MSSQL
DBSERVER=LOCALHOST
DBALIAS=ENVIRONMENT
dbport=7892

[TDS]
AllowApplyPatch=*
AllowEdit=*

[DRIVERS]
ACTIVE=TCP
MultiProtocolPort=1 
MultiProtocolPortSecure=0
 
[TCP]
TYPE=TCPIP
PORT=1232

[GENERAL]
App_Environment=ENVIRONMENT 
BUILDKILLUSERS=1
MAXSTRINGSIZE=10

[LICENSECLIENT]
server=LOCALHOST
port=8009

[HTTP]
ENABLE=1
PORT=88
ENVIRONMENT=ENVIRONMENT

[WEBAPP]
PORT=1255
WebSocket=0
LastMainProg=SIGAADV

[WebApp/webapp]
MPP=

Exemplo de appserver.ini MASTER com SSLConfigure

[P12_DB_27_EXP]
SourcePath=C:\Protheus\Apo64
RootPath=C:\Protheus\Protheus_Data
STARTPATH=\system\
RPODB=Top
RPOLANGUAGE=portuguese
RPOVERSION=120
LOCALFILES=CTREE
TRACE=0
LOCALDBEXTENSION=.dtc
SpecialKey=FCO_P12
TopMemoMega=1
DBDATABASE=MSSQL
DBSERVER=LOCALHOST
DBALIAS=P12_DB_27_EXP
StartSysInDB=1

[LICENSECLIENT]
server=localhost
port=8009

[Drivers]
Active=TCP
MultiProtocolPort=1
MultiProtocolPortSecure=1

[SSLConfigure]
SSL2   = 1
SSL3   = 1
TLS1_0 = 1
TLS1_1 = 1
TLS1_2 = 1
Bugs    =1
State   =1
CertificateServer=C:\Protheus\Bin\64\appserver\totvs_certificate.crt
KeyServer=C:\Protheus\Bin\64\appserver\totvs_certificate_key.pem

[TCP]
TYPE=TCPIP
Port=1227

[General]
consolemaxsize=15728640 
MAXSTRINGSIZE=10
MaxQuerySize=65536
App_Environment=P12_DB_27_EXP

[ServerNetwork]
MasterConnection=1
Servers=SLAVE

[SLAVE]
Type=TCPIP
;ip do server:
Server=10.111.1.11 
Port=1228
Connections=1

[HTTP]
enable=1
port=8282

[WEBAPP]
Port=1210

[WebApp/webapp]
MPP=

Exemplo de appserver.ini SLAVE com SSLConfigure

[P12_DB_27_EXP]
SourcePath=C:\Protheus\Apo64
RootPath=C:\Protheus\Protheus_Data
STARTPATH=\system\
RPODB=Top
RPOLANGUAGE=portuguese
RPOVERSION=120
LOCALFILES=CTREE
TRACE=0
LOCALDBEXTENSION=.dtc
SpecialKey=FCO_P12
TopMemoMega=1
DBDATABASE=MSSQL
DBSERVER=LOCALHOST
DBALIAS=P12_DB_27_EXP
StartSysInDB=1

[LICENSECLIENT]
server=localhost
port=8009

[Drivers]
Active=TCP
MultiProtocolPort=1
MultiProtocolPortSecure=1

[SSLConfigure]
SSL2   = 1
SSL3   = 1
TLS1_0 = 1
TLS1_1 = 1
TLS1_2 = 1
Bugs    =1
State   =1
CertificateServer=C:\Protheus\Bin\64\appserver\totvs_certificate.crt
KeyServer=C:\Protheus\Bin\64\appserver\totvs_certificate_key.pem

[TCP]
TYPE=TCPIP
Port=1228

[General]
consolemaxsize=15728640 
MAXSTRINGSIZE=10
MaxQuerySize=65536
App_Environment=P12_DB_27_EXP

[HTTP]
enable=1
port=8283

[WEBAPP]
Port=1210

[WebApp/webapp]
MPP=

Exemplo de smartclient.ini com SSLConfigure

[config]
lastmainprog=sigaadv
envserver=P12_DB_27_EXP

[drivers]
active=tcp

[tcp]
;ip do server:
Server=10.111.1.11
port=1227
secureconnection=1

Nota

Não será necessário configurar REST, pois será utilizado o REST Server da Porta Multiprotocolo.

Importante

Caso seja utilizado Load Balance, a comunicação usada no appserver.ini dos slaves deverá ser a mesma do master, conforme explicado em Porta Multiprotocolo.

02. POSSÍVEIS ERROS

Erro 503

Possíveis Motivos	Solução
Serviço de API fora do ar	Verifique se serviços do Protheus estão no ar
API pode estar chamando um endereço que não existe	Verifique se tabelas A1N, A1O, A1P, A1Q e A1R estão populadas
Instabilidade do servidor	Verifique se servidor está ativo

Servidor não está respondendo

Possíveis Motivos	Solução
O serviço pode não estar configurado de maneira correta	Verifique se as configurações de appserver.ini e smartclient.ini estão de acordo com o ponto 1 desta documentação
O serviço pode estar fora do ar ou instável	Verifique se serviços do Protheus estão no ar
O Servidor pode estar desligado	Verifique se Servidor está ativo

NOFUNCW - Opção Não Disponível no Protheus

Possíveis Motivos	Solução
Funções padrões responsáveis pelo funcionamento do Dash não estão compiladas	Aplique o patch do Dashboard disponibilizado para Download

Esta pagina não está funcionando

Possíveis Motivos	Solução
O serviço pode estar fora do ar	Verifique se serviços do Protheus estão no ar
O serviço pode não estar configurado de maneira correta	Verifique se as configurações de appserver.ini e smartclient.ini estão de acordo com o ponto 1 desta documentação

03. ASSUNTOS RELACIONADOS

Árvore de páginas

Dashboard Backoffice - Configurações Necessárias

01. IMPLANTAÇÃO DO DASHBOARD

02. POSSÍVEIS ERROS

03. ASSUNTOS RELACIONADOS