Histórico da Página
Produto | : | Framework Versão: 12.1.33 |
Processo | : | Parâmetros para Config |
Subprocesso | : | Configuração arquivos *.Config |
Data da publicação | : | 04/08/2021 |
Índice |
---|
Os arquivos config's do Host e executáveis contém uma série de configurações importantes para o funcionamento do sistema. Assim sendo, abaixo uma lista das principais opções, seus valores default's e descrições, de forma a facilitar o entendimento das configurações.
Índice |
---|
ActionsPath
- Descrição: Caminho onde estão as actions utilizadas no sistema. Pode conter mais de um caminho, separado por ponto e vírgula.
- Tipo: String
- Default: ..\\RM.net\\;..\\Corpore.net\\
Exemplo:
Bloco de código language xml <add key="ActionsPath" value="c:\rm.net\bin;c:\corpore.net\bin"/>
...
- Descrição: Tem como objetivo definir um único Alias.dat a ser utilizado por todos os hosts do ambiente, para isso devemos adicioná-la nos arquivos RM.AliasManager.exe.config e RM.Host.exe.config ou RM.host.Service.exe.config.
- Tipo: String
- Default: Vazio
Exemplo:
Bloco de código language xml <add key=“Aliaspath” value=“\\rm004066\publico” />
...
AllowAssemblySignCheck
- Descrição: Nome do lugar onde a Store do certificado de segurança do WCF está localizado. Habilitada somente no host.
- Tipo: Valores pré-determinados
- Possíveis Valores:
- CurrentUser
- LocalMachine
- Default: LocalMachine
- Permite que os assemblies carregados pelo host tenham sua assinatura validada. Caso exista algum assembly que esteja com sua assinatura inválida, o host automaticamente o bloqueará e bloqueará todas as outras chamadas consequentes.
- Tipo: Booleano
- Default:False
Exemplo:Exemplo:
Bloco de código language xml <add key<add key="CertificateStoreLocationALLOWASSEMBLYSIGNCHECK" value value="LocalMachinetrue" />
...
AllowOnlyBookedManagementObjects
- Descrição:
...
- Restringe a importação de Objetos Gerenciais onde somente objetos do Book de Objetos Gerenciais da TOTVS poderão ser importados através do TOTVS Compartilhamento.
- Tipo: Valores pré-determinados
- Possíveis valores:
- AddressBook
- AuthRoot
- CertificateAuthority
- Disallowed
- My
- Root
- TrustedPeople
- TrustedPublisher
- bool
- Default: false
- Versão: 12.1.34Default: My
Exemplo:
Bloco de código language xml <add key<add key="CertificateStoreNameAllowOnlyBookedManagementObjects" value value="Myfalse" />
...
ApiPort
- Descrição: Campo pelo qual o certificado de segurança será procurado no Certificate Store. Este valor ajuda a encontrar o certificado correto com que a comunicação do sistema será protegida. Habilitada somente no host.
- Tipo: Valores pré-determinados
- Possíveis valores:
- FindByThumbprint
- FindBySubjectName
- FindBySubjectDistinguishedName
- FindByIssuerName
- FindByIssuerDistinguishedName
- FindBySerialNumber
- FindByTimeValid
- FindByTimeNotYetValid
- FindByTimeExpired
- FindByTemplateName
- FindByApplicationPolicy
- FindByCertificatePolicy
- FindByExtension
- FindByKeyUsage
- FindBySubjectKeyIdentifier
- Porta utilizada para expor serviços de API do RM.
- Tipo: Numeric
- Default: vazia (Se não preenchida utiliza o valor preenchido na tag HttpPort)Default: FindBySubjectName
Exemplo:
Bloco de código language xml <add key<add key="CertificateFindTypeApiPort" value value="FindBySubjectName8051" />
...
CertificateStoreLocation
- Descrição: Valor pelo qual o Nome do lugar onde a Store do certificado de segurança será procurado no Certificate Storedo WCF está localizado. Habilitada somente no host e deve conter o nome do certificado no client. Este valor ajuda a encontrar o certificado correto com que a comunicação do sistema será protegida. Trabalha em conjunto com a chave CertificateFindType. Para que seja levada em conta, a comunicação deve estar ocorrendo em WCF e a chave SecurityEnabled habilitada..
- Tipo: Valores pré-determinados
- Possíveis Valores:
- CurrentUser
- LocalMachine
- Default: TOTVSLocalMachine
Exemplo:
Bloco de código language xml <add key="CertificateFindValueCertificateStoreLocation" value="TOTVSLocalMachine" />
...
CertificateStoreName
Descrição:
...
Nome do Store onde o certificado de segurança do WCF está armazenado. Habilitada somente no host.
- Tipo: Boolean
- Default: True
Exemplo:
Bloco de código language xml <add key="ConfigAutoGenerate " value="true" />
ConfigPath
- Descrição: Tem como objetivo definir um único arquivo de configuração a ser utilizado por todos os aplicativos do ambiente.
- Tipo: String
- Default: Vazio
- Observações: Para mais informações acesse o link: Gerenciador de Config.
Exemplo:
Bloco de código language xml <add key="ConfigPath" value="\\PastaCompartilhadaNaRede" />
DbSchemaCacheMaxSize
- Valores pré-determinados
- Possíveis valores:
- AddressBook
- AuthRoot
- CertificateAuthority
- Disallowed
- My
- Root
- TrustedPeople
- TrustedPublisher
- Default: My
Exemplo:
Bloco de código language xml <add key="CertificateStoreName" value="My" />
CertificateFindType
- Descrição: Campo pelo qual o certificado de segurança será procurado no Certificate Store. Este valor ajuda a encontrar o certificado correto com que a comunicação do sistema será protegida. Habilitada somente no host.
- Tipo: Valores pré-determinados
- Possíveis valores:
- FindByThumbprint
- FindBySubjectName
- FindBySubjectDistinguishedName
- FindByIssuerName
- FindByIssuerDistinguishedName
- FindBySerialNumber
- FindByTimeValid
- FindByTimeNotYetValid
- FindByTimeExpired
- FindByTemplateName
- FindByApplicationPolicy
- FindByCertificatePolicy
- FindByExtension
- FindByKeyUsage
- FindBySubjectKeyIdentifier
- Default: FindBySubjectName
- Descrição: Define a quantidade de Schemas que serão guardados em cache.
- Tipo: Numeric
- Default: 100
Exemplo:
Bloco de código language xml <add key<add key="DBSchemaCacheMaxSizeCertificateFindType" value value="123FindBySubjectName" />
...
CertificateFindValue
- Descrição: Define o tempo máximo que uma Consulta SQL pode levar antes de retornar erro de timeout, em segundos.
- Tipo: Numeric
- Default:120
- Valor pelo qual o certificado de segurança será procurado no Certificate Store. Habilitada no host e deve conter o nome do certificado no client. Este valor ajuda a encontrar o certificado correto com que a comunicação do sistema será protegida. Trabalha em conjunto com a chave CertificateFindType. Para que seja levada em conta, a comunicação deve estar ocorrendo em WCF e a chave SecurityEnabled habilitada.
- Tipo: String
- Default: TOTVS
Exemplo:
Exemplo:
Bloco de código language xml <add key<add key="DBSCommandTimeoutCertificateFindValue" value value="600TOTVS" />
...
ConfigAutoGenerate
- Descrição: Acrescenta extensões à string de conexão atualmente em uso. Habilita a criação automática de arquivos de configuração quando utilizada a funcionalidade de Gerenciamento de Config.
- Tipo: String Boolean
- Default: Vazio True
- Observações: Para alterar o timeout de comandos nativos do SQL, tal qual Rollback, esta tag deve ser utilizada, ao invés da tag DBSCommandTimeout
Exemplo:
Exemplo:
Bloco de código language xml <add key="DBSConnStrExtensionsConfigAutoGenerate " value=";Min Pool Size=5;Max Pool Size=30;true" />>
...
ConfigPath
- Descrição: Banco de dados default para qualquer operação que possa vir a ser realizada antes do momento do login, quando o banco de dados definitivo é definido. Essencial para o uso de APIs Tem como objetivo definir um único arquivo de configuração a ser utilizado por todos os aplicativos do ambiente.
- Tipo: Tipo: String
- Default: CorporeRMVazio
- Observações: Para mais informações acesse o link: Gerenciador de Config.
Exemplo:
Bloco de código language Exemplo:
Bloco de código language xml <add key="DefaultDBConfigPath" value="CorporeRM12133\\PastaCompartilhadaNaRede" />
...
DbSchemaCacheMaxSize
- Descrição: Desabilita compressão de dados em WCF Define a quantidade de Schemas que serão guardados em cache.
- Tipo: Boolean Numeric
- Default: false 100
CamadaExemplo:
VersãoBloco de código Camada Até 12.1.33 Client e Server 12.1.34 e Superiores Server language xml <add
Exemplo:
Bloco de código language xml <add key="DISABLECOMPRESSIONDBSchemaCacheMaxSize" value="true123" />
...
DBSCommandTimeout
- Descrição: Determina se a comunicação WCF utilizará a segurança da camada de transporte garantida por certificados e se permitirá que credenciais sejam enviadas aos serviços. Ao determinar esta tag como true, suas respectivas tags de parametrização também precisam ser configuradas, são elas: CertificateFindValue, CertificateFindType, CertificateStoreName, CertificateStoreLocation, que basicamente definem onde e como encontrar o certificado adequado Define o tempo máximo que uma Consulta SQL pode levar antes de retornar erro de timeout, em segundos.
- Tipo: Boolean Numeric
- Default: False120
- Observações: para mais informações, acessar: HabilitarHabilitar SSL/TLS no HostSSL/TLS no Host
Camada:
Versão Camada Até 12.1.33 Client e Server 12.1.34 e Superiores Server Exemplo: Exemplo:
Bloco de código language xml <add key="EnableSecurityDBSCommandTimeout" value="true600" />
...
DBSConnStrExtensions
- Descrição: Nome da máquina em que o host está sendo executado (não recomendável pois acrescenta o overhead de ir ao DNS). O ideal é informar o IP diretamente Acrescenta extensões à string de conexão atualmente em uso.
- Tipo: String String
- Default: localhost Vazio
- Observações: Para alterar o timeout de comandos nativos do SQL, tal qual Rollback, esta tag deve ser utilizada, ao invés da tag DBSCommandTimeout
Exemplo:
Exemplos:
Bloco de código <add key="Host" value="localhost" />language xml title Utilizando nome da máquina Bloco de código language xml title Utilizando IP <add key="HostDBSConnStrExtensions" value="10.31.8.91;Min Pool Size=5;Max Pool Size=30;" />
...
DefaultDB
- Descrição: Porta utilizada pela comunicação WCF quando o protocolo de comunicação for HTTP. Tanto o Server quanto o Client devem estar configurados sempre na mesma porta, para que possam se comunicar corretamente.
- Tipo: Numeric
- Banco de dados default para qualquer operação que possa vir a ser realizada antes do momento do login, quando o banco de dados definitivo é definido. Essencial para o uso de APIs
- Tipo: String
- Default: CorporeRMDefault: 8051
Exemplo:
Bloco de código language xml <add key="HttpPortDefaultDB" value="1234CorporeRM12133" />
...
DisableCompression
- Descrição: Informa se a aplicação está trabalhando em três camadas. Deve ter o mesmo valor tanto nos config's dos Clients quanto do Host.
- Tipo: Boolean
- Desabilita compressão de dados em WCF
- Tipo: Boolean
- Default: false
Camada:
Default: trueVersão Camada Até 12.1.33 Client e Server 12.1.34 e Superiores Server Exemplo:
Bloco de código language xml <add key="JobServer3CamadasDISABLECOMPRESSION" value="true" />
...
EnableSecurity
- Descrição: Possível provider que irá responder por operações relacionadas a autenticação caso exista a integração LDAP.
- Tipo: String
- Default: Vazio
LibPath
- Determina se a comunicação WCF utilizará a segurança da camada de transporte garantida por certificados e se permitirá que credenciais sejam enviadas aos serviços. Ao determinar esta tag como true, suas respectivas tags de parametrização também precisam ser configuradas, são elas: CertificateFindValue, CertificateFindType, CertificateStoreName, CertificateStoreLocation, que basicamente definem onde e como encontrar o certificado adequado.
- Tipo: Boolean
- Default: False
- Observações: para mais informações, acessar: HabilitarHabilitar SSL/TLS no HostSSL/TLS no Host
Camada:
Versão Camada Até 12.1.33 Client e Server 12.1.34 e Superiores Server Exemplo:
- Descrição: Diretório onde estão as dll's da Lib.
- Tipo: String
- Default: ..\\RM.net\\
Exemplo:
Bloco de código language xml <add key="LibPathEnableSecurity" value="..\\RM\\Bintrue" />
...
Host
- Descrição: Caminho do diretório de log Nome da máquina em que o host está sendo executado (não recomendável pois acrescenta o overhead de ir ao DNS). O ideal é informar o IP diretamente.
- Tipo: String
- Default: Vazio localhost
ExemploExemplos:
Bloco de código language xml title Utilizando nome da máquina <add key="LogPathHost" value="..\\RM\\Logs"localhost" />
Bloco de código language xml title Utilizando IP <add key="Host" value="10.31.8.91" />
...
HttpPort
- Descrição: Inteiro maior que 0 - Número de notificações que o ERP fará no License Server a cada ciclo do mesmo. O License Server exige que a cada intervalo de três minutos, pelo menos uma notificação seja feita pelo cliente. Contudo, por problemas de rede, algumas notificações podem se perder ou atrasar. Devido a isto mais notificações podem ser configuradas. Quanto pior a rede, maior deve ser o número de notificações. Se algum valor inválido for informado, o default três é utilizado. Definido nos config's dos clientes.
- Tipo: Numeric
- Porta utilizada pela comunicação WCF quando o protocolo de comunicação for HTTP. Tanto o Server quanto o Client devem estar configurados sempre na mesma porta, para que possam se comunicar corretamente.
- Tipo: Numeric
- Default: 8051
Exemplo:
Bloco de código language xml <add key="HttpPort" value="8051" />
JobServer3Camadas
- Descrição: Informa se a aplicação está trabalhando em três camadas. Deve ter o mesmo valor tanto nos config's dos Clients quanto do Host.
- Tipo: Boolean
- Default: trueDefault: 3
Exemplo:
Bloco de código language xml <add key="NotificationsPerLicenceServerCicleJobServer3Camadas" value="10true" />
...
JWTRefreshTokenExpireMinutes
- Descrição: Tag utilizada para mostrar o tempo gasto para abrir/editar/gravar dados. Indicado ser utilizada quando o cliente reclamar de performance, coletando os dados para análise. Exemplo: Com a TAG ativada nos arquivos config's ( RM.exe.config, RMLabore.exe.config e etc) o sistema exibirá uma tela mostrando o tempo gasto em operações gerais como abertura de uma tela de visão
- Tipo: Boolean
- Define a duração do refresh token, em minutos. Pode ser configurada entre 1 e 129600minutos.
- Tipo: Numeric
- Default: 960
Exemplo:
Bloco de código language xml <add key="JWTRefreshTokenExpireMinutes" value="60" />
JWTTokenExpireMinutes
- Descrição: Define a duração do access token, em minutos. Pode ser configurada entre 1 e 43200minutos.
- Tipo: Numeric
- Default: 5
Exemplo:
Bloco de código language xml <add key="JWTTokenExpireMinutes" value="30" />
LdapProvider
- Descrição: Possível provider que irá responder por operações relacionadas a autenticação caso exista a integração LDAP.
- Tipo: String
- Default: Vazio
LibPath
- Descrição: Diretório onde estão as dll's da Lib.
- Tipo: String
- Default: ..\\RM.net\\
Exemplo:
Bloco de código language xml <add key="LibPath" value="..\\RM\\Bin" />
LogPath
- Descrição: Caminho do diretório de log.
- Tipo: String
- Default: Vazio
Exemplo:
Bloco de código language xml <add key="LogPath" value="..\\RM\\Logs" />
NotificationsPerLicenceServerCicle
- Descrição: Inteiro maior que 0 - Número de notificações que o ERP fará no License Server a cada ciclo do mesmo. O License Server exige que a cada intervalo de três minutos, pelo menos uma notificação seja feita pelo cliente. Contudo, por problemas de rede, algumas notificações podem se perder ou atrasar. Devido a isto mais notificações podem ser configuradas. Quanto pior a rede, maior deve ser o número de notificações. Se algum valor inválido for informado, o default três é utilizado. Definido nos config's dos clientes.
- Tipo: Numeric
- Default: 3
Exemplo:
Bloco de código language xml <add key="NotificationsPerLicenceServerCicle" value="10"/>
PerformanceLogEnabled
- Descrição: Tag utilizada para mostrar o tempo gasto para abrir/editar/gravar dados. Indicado ser utilizada quando o cliente reclamar de performance, coletando os dados para análise. Exemplo: Com a TAG ativada nos arquivos config's ( RM.exe.config, RMLabore.exe.config e etc) o sistema exibirá uma tela mostrando o tempo gasto em operações gerais como abertura de uma tela de visão
- Tipo: Boolean
- Default: False
Exemplo:
Bloco de código language xml <add key = "PerformanceLogEnabled" value = "true" />
Port
- Descrição: Informa em que porta Host e Client se comunicarão. Tanto o Server quanto o Client devem estar configurados sempre na mesma porta, para que possam se comunicar corretamente.
- Tipo: Numeric
- Default: 8050
Exemplo:
Bloco de código language xml <add key="Port" value="1234" />
SelfHosted
- Descrição: Informa se a aplicação starta o Host automaticamente caso ele não esteja iniciado. Se o serviço RM.Host.Service.exe estiver habilitado, inicia-o. Caso o serviço não esteja ou não exista, inicia o Host desktop. Este parâmetro é configurado nos clientes, não sendo levado em consideração quando configurado no server.
- Tipo: Boolean
- Default: False
Exemplo:
Bloco de código language xml <add key="SelfHosted" value="true" />
ServiceAlias
- Descrição: Define o alias que responderá pelos serviços executados sem autenticação
- Tipo: Boolean
- Default: False
ServicesBaseUrl
- Descrição: Define o endereço base dos serviços HTTP(SOAP) que serão expostos pelo Host.
- Tipo: String
- Default: host:porta
Exemplo:
Bloco de código language xml <add key="ServicesBaseUrl" value="https://meuservicoexposto.com.br" />
SubdomainMask
- Descrição: Tag responsável por realizar a tenantização dos serviços do RM.
- Tipo: String
- Default: vazia
Exemplo:
Bloco de código language xml <add key="SubDomainMask" value="[ALIAS].seudominio.com.br" />
Onde [ALIAS] é tratado como uma variável onde será sobrescrito com o nome de um Alias do banco de dados cadastrado ao inicializar os serviços do sistema, para mais informações sobre tenantização acesse o TDN https://tdn.totvs.com/x/XYu9Mg.Aviso title Atenção É imprescindível que a variável [ALIAS] esteja presente no valor da tag, pois é este valor que será sobrescrito pelo nome do Alias de banco de dados.
TcpPort
- Descrição: Porta utilizada pela comunicação WCF quando o protocolo de comunicação for TCP. Tanto o Server quanto o Client devem estar configurados sempre na mesma porta, para que possam se comunicar corretamente.
- Tipo: Numeric
- Default: 8050
Exemplo:
Bloco de código language xml <add key="TcpPort" value="4321" />
TraceConsole
- Descrição: Loga em arquivo as informações que forem inseridas pela aplicação no console.
- Tipo: Boolean
- Default: falseDefault: False
Exemplo:
Bloco de código language xml <add Key = “PerformanceLogEnabled”key="TraceConsole" value ="True" “True”>/>
Port
TraceFile
- Descrição: Indica se irá salvar algum log de execução do host dentro pasta \Processos\Logs\Descrição: Informa em que porta Host e Client se comunicarão. Tanto o Server quanto o Client devem estar configurados sempre na mesma porta, para que possam se comunicar corretamente.
- Tipo:Numeric Boolean
- Default:8050 false
Exemplo:
Bloco de código language xml <add key="PortTraceFile" value="1234True" />
...
TraceFluigIdentity
- Descrição: Informa se a aplicação starta o Host automaticamente caso ele não esteja iniciado. Se o serviço RM.Host.Service.exe estiver habilitado, inicia-o. Caso o serviço não esteja ou não exista, inicia o Host desktop. Este parâmetro é configurado nos clientes, não sendo levado em consideração quando configurado no server.
- Tipo: Boolean
- Default: False
- Habilita a criação do log de comunicação entre o as integrações "RM x Identity", "RM x Fluig" e integrações SAML, o log será gravado dentro pasta \Processos\Logs\.
- Tipo: Boolean
- Default: false
Exemplo: Exemplo:
Bloco de código language xml <add key="SelfHostedTraceFluigIdentity" value="trueTrue" />
ServiceAlias
- Descrição: Define o alias que responderá pelos serviços executados sem autenticação
- Tipo: Boolean
- Default: False
TcpPort
UpdateServerEnabled - https://centraldeatendimento.totvs.com/hc/pt-br/articles/360003565411-Framework-Linha-RM-Frame-Habilitar-TOTVS-Update
- Descrição: Indica que um determinado Host (RM.Host.exe.config) será utilizado como base/servidor para que máquinas Client possam baixar as atualizações (SmartClient), mas para isso essas máquinas Client precisam da tag UpdateServer habilitada.
- Tipo: Boolean
- Default: false
- Observações: Após inserir as tags no servidor de atualização, é necessário reiniciar o serviço RM.Host.Service.
Exemplo:
- Descrição: Porta utilizada pela comunicação WCF quando o protocolo de comunicação for TCP. Tanto o Server quanto o Client devem estar configurados sempre na mesma porta, para que possam se comunicar corretamente.
- Tipo: Numeric
- Default: 8050
Exemplo:
Bloco de código language xml <add key="TcpPortUpdateServerEnabled" value="4321true" />
TraceConsole
- Descrição: Loga em arquivo as informações que forem inseridas pela aplicação no console.
- Tipo: Boolean
- Default: false
Exemplo:
Bloco de código language xml <add key="TraceConsole" value="True" />
TraceFile
UpdateServer
Âncora | ||||
---|---|---|---|---|
|
- Descrição: Indica que um determinada máquina Client (SmartClient) pode se comunicar com o Server para baixar atualizaçõesDescrição: Indica se irá salvar algum log de execução do host dentro pasta \Processos\Logs\.
- Tipo: BooleanString
- Default: false host:porta
Exemplo:
Bloco de código language xml <add key="TraceFileUpdateServer" value="Truehost:porta" />
TraceFluigIdentity
UseDbSchemaCache
- Descrição: Indica se o sistema guardará em cache os esquemas obtidos pelas consultasDescrição: Habilita a criação do log de comunicação entre o as integrações "RM x Identity", "RM x Fluig" e integrações SAML, o log será gravado dentro pasta \Processos\Logs\.
- Tipo: Boolean
- Default: false
- Observações: Pode ser utilizado na Configuração N camadas, conforme informações em Configuração N Camadas
Exemplo:
Bloco de código language xml <add key="TraceFluigIdentityUseDbSchemaCache" value="Truetrue" />
...
UseRMUser
- Descrição: Indica se o sistema guardará em cache os esquemas obtidos pelas consultas Determina o uso de um usuário do RM para fazer login no RM.Atualizador e RM.TotvsAudit, quando adicionado no respectivo arquivo config.
- Tipo: Boolean
- Default: falseObservações: Pode ser utilizado na Configuração N camadas, conforme informações em Configuração N Camadas false
Exemplo:
Bloco de código language xml <add key="UseDbSchemaCacheUseRMUser" value="true" />
UseSecurityExtCache
...