Páginas filhas
  • Parâmetros dos Arquivos de Configuração (*.config)

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Produto:Framework                         Versão: 
11.52                                                                        
12.1.33                                                                        
Processo:Parâmetros para Config
Subprocesso:Configuração arquivos *.Config
Data da publicação:
21
04/
02
08/
2014
2021

...

 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
    languagexml
    <add key="ActionsPath" value="c:\rm.net\bin;c:\corpore.net\bin"/>

Aliaspath

  • 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
    languagexml
    <add key=“Aliaspath” value=“\\rm004066\publico” />

...

AllowAssemblySignCheck

  • Descrição:

...

  • 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:

    Bloco de código
    languagexml
    <add key="ALLOWASSEMBLYSIGNCHECK" 

...

  • value="true" />


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: bool
  • Default: false
  • Versão: 12.1.34
  • Exemplo:

    Bloco de código
    languagexml
    <add key="AllowOnlyBookedManagementObjects" value="false" />

CertificateStoreLocation

  • 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
  • Exemplo: 

    Bloco de código
    languagexml
    <add key="CertificateStoreLocation" value="LocalMachine" />

...

CertificateStoreName

Descrição: String - Nome  Nome do Store onde o certificado de segurança do WCF está armazenado. Habilitada somente no host.

  • Tipo: Valores pré-determinados
  • Possíveis valores:

      ...

        • AddressBook

      ...

        • AuthRoot

      ...

        • CertificateAuthority

      ...

        • Disallowed

      ...

        • My

      ...

        • Root

      ...

        • TrustedPeople

      ...

        • TrustedPublisher
      • Default: My
      • Exemplo:

        Bloco de código
        languagexml
        <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
          • Exemplo:

            Bloco de código
            languagexml
            <add key="CertificateFindType" value="FindBySubjectName" />

          ...

          CertificateFindValue

          • Descrição:

          ...

          •  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

          ...

          CommunicationStyle

          Descrição: String - Plataforma de comunicação a ser utilizada entre host e client. Os valores possíveis são WCF, Remoting e Todos. Caso selecionado o valor "Todos", a comunicação utilizará preferencialmente WCF e, se o serviço não estiver migrado, Remoting.

          Exemplo: <add key="CommunicationStyle" value="Remoting" />

          • : TOTVS
          • Exemplo:

            Bloco de código
            languagexml
            <add key="CertificateFindValue" value="TOTVS" />

          ConfigAutoGenerate

          • Descrição: Habilita a criação automática de arquivos de configuração quando utilizada a funcionalidade de Gerenciamento de Config. 
          • Tipo: Boolean
          • Default: True
          • Exemplo: 

            Bloco de código
            languagexml
            <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
            languagexml
            <add key="ConfigPath" value="\\PastaCompartilhadaNaRede" />

          ...

          DbSchemaCacheMaxSize

          • Descrição: Define a quantidade de Schemas que serão guardados em cache.
          • Tipo: Numeric
          • Default: 100
          • Exemplo:

            Bloco de código
            languagexml
            <add key="DBSchemaCacheMaxSize" value="123" />

          ...


          DBSCommandTimeout

          • 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
          • Exemplo:

            Bloco de código
            languagexml
            <add key="DBSCommandTimeout" value="600" />

          DBSConnStrExtensions

          • Descrição: Acrescenta extensões à string de conexão atualmente em uso.
          • Tipo: String
          • Default

          ...

          • : 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:

            Bloco de código
            languagexml
            <add key="DBSConnStrExtensions" value=";Min Pool Size=5;Max Pool Size=30;" />

          ...


          DefaultDB

          • 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
          • Tipo: String
          • Default: CorporeRM
          • Exemplo:

            Bloco de código
            languagexml
            <add key="DefaultDB" value="

          ...

          • CorporeRM12133" />

          DisableCompression

          • Descrição: Desabilita compressão de dados em WCF
          • Tipo: Boolean
          • Default

          ...

          • : false
          • Camada: 

            VersãoCamada
            Até 12.1.33Client e Server
            12.1.34 e SuperioresServer
          • Exemplo:

            Bloco de código
            languagexml
            <add key="DISABLECOMPRESSION" value="true" />

          ...

          EnableSecurity

          • 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.
          • Tipo: Boolean
          • Default: False

          FileServerPath

          Descrição: Tem como objetivo definir um único diretório para arquivos gerados temporariamente por processos, assim todos os hosts do ambiente irão gerar os arquivos somente neste diretório. Desta forma em ambientes que trabalham em quatro camadas devemos adicionar a tag nos arquivos RM.Host.exe.config ou RM.host.Service.exe.config de todos os servidores de APP e JOBS.

          ...

          • Observações: para mais informações, acessar: HabilitarHabilitar SSL/TLS no HostSSL/TLS no Host
          • Camada: 

            VersãoCamada
            Até 12.1.33Client e Server
            12.1.34 e SuperioresServer
          • Exemplo: 

            Bloco de código
            languagexml
            <add key="EnableSecurity" value="true" />

          Host

          • 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.

          ...

          • Tipo: String
          • Default: localhost
          • Exemplos:

            Bloco de código
            languagexml
            titleUtilizando nome da máquina
            <add 

          ...

          • key="Host" value="localhost" />

          ...

          • Bloco de código
            languagexml
            titleUtilizando IP
            <add 

          ...

          • key="Host" value="10.31.8.91" />

          HostClientPort

          Descrição: Descontinuado

          HttpPort

          • 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
          • Default: 8051
          • Exemplo:

            Bloco de código
            languagexml
            <add key="HttpPort" value="1234" />

          Default: 8061


          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: true
          • Exemplo:

            Bloco de código
            languagexml
            <add key="JobServer3Camadas" value="true" />

          ...

          JWTRefreshTokenExpireMinutes

          • Descrição: 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
            languagexml
            <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
            languagexml
            <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
            languagexml
            <add key="LibPath" value="..\\RM\\Bin" />

          LogPath

          • Descrição:

          ...

          •  Caminho do diretório de log.

          ...

          LSFOV

          Descrição: Indica se há necessidade de alterar o padrão de licenciamento.

          MaxRecords

          ...

          • Tipo: String
          • Default: Vazio
          • Exemplo: 

            Bloco de código
            languagexml
            <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
            languagexml
             <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:

          ...

          Default: False

          • Bloco de código
            languagexml
            <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

          ...

          QueryWaitTimeToLog

          Descrição: QueryWaitTimeLog trabalha em conjunto com BadSyntaxLogEnabled. Ao incluir BadSyntaxLogEnabled nos arquivos CONFIG, o sistema passa a gravar operações ilegais (select * from XXX) no banco de dados. Ao incluir nos config's a tag <add key "QueryWaitTimeLog" value = "120"/>, o sistema passará a gravar operações que superem um determinado tempo.

          Default: 120 segundos

          SecurityExtCacheMaxSize

          ...

          • Exemplo:

            Bloco de código
            languagexml
            <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
            languagexml
            <add key="SelfHosted" value="true" />

          Default: False

          ServerUrl

          Descrição: Descontinuado

          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
            languagexml
            <add key="ServicesBaseUrl" value="https://meuservicoexposto.com.br" />

          ServicePassword

          Descrição: Descontinuado, passou a utilizar a tabela GSERVICO.

          ServiceUser

          ...

          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
            languagexml
            <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: false
          • Exemplo:

            Bloco de código
            languagexml
            <add key="TraceConsole" value="True" />

          Default: False

          TraceEventViewer

          Descrição: Booleano – Loga em arquivo as informações que forem inseridas pela aplicação no Event Viewer

          TraceFile

          • Descrição: Indica se irá salvar algum log de execução do host dentro pasta \Processos\Logs\.
          • Tipo: Boolean
          • Default: false
          • Exemplo:

            Bloco de código
            languagexml
            <add key="TraceFile" 

          ...

          • value="True" />
            

          Default: False

          ...

          TraceFluigIdentity

          • Descriçã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
          • Exemplo: 

            Bloco de código
            languagexml
            <add key="

          ...

          • TraceFluigIdentity" value="True" />

          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: 

            Bloco de código
            languagexml
            <add key="UpdateServerEnabled" value="true" />

          UpdateServer
          Âncora
          UpdateServer
          UpdateServer
          - https://centraldeatendimento.totvs.com/hc/pt-br/articles/360003565411-Framework-Linha-RM-Frame-Habilitar-TOTVS-Update

          • Descrição: Indica que um determinada máquina Client (SmartClient) pode se comunicar com o Server para baixar atualizações.
          • Tipo: String
          • Default: host:porta
          • Exemplo: 

            Bloco de código
            languagexml
            <add key="UpdateServer" value="host:porta"/>

          UseDbSchemaCache

          • Descrição: Indica se o sistema guardará em cache os esquemas obtidos pelas consultas.

          ...

          • 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
            languagexml
            <add key="UseDbSchemaCache" value="true" />

          UseRMUser

          • Descrição: 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: false
          • Exemplo:

            Bloco de código
            languagexml
            <add key="UseRMUser" 

          UseExternalHost

          Descrição: Booleano - Informa se o Host da aplicação trabalhará internamente ou como um executável separado. A partir da versão 11.20 não é mais utilizado, pois o Host será sempre externo. Este parâmetro é configurado no cliente, não sendo considerado quando inserido no Host.

          ...

          • value="true" />

          ...

          UseHostClient

          Descrição: Descontinuado

          UseSecurityExtCache

          • Descrição: Indica se o sistema guardará em cache as informações de segurança estendida obtidas a cada verificação.
          • Tipo: Boolean
          • Default: false
          • Observações: para mais informações: Segurança Estendida
          • Exemplo: 


            Bloco de código
            languagexml
            <add key="UseSecurityExtCache" value="true" />

          WcfProtocol

          • Descrição:

          ...

          •  Protocolo utilizado pela comunicação entre Host e Client  (NamedPipe / HTTP / TCP / Todos).

          Client quando a plataforma utilizada for WCF (CommunicationStyle=WCF) .Caso a comunicação esteja sendo feita em Remoting, desconsidera este parâmetro. Os valores aceitos são HTTP, TCP, NamedPipe e AllTodos. Este parâmetro deve ter o mesmo valor tanto no Server quanto no Client. Somente o host pode ser configurado para "AllTodos". Neste caso, ele publicará os Servers tanto em HTTP quanto em TCP, e os clientes poderão se comunicar com ele em qualquer dos protocolos.

          A opção NamedPipe é a mais rápida das três. Contudo, esta comunicação só pode ser configurada quando host e client estiverem na mesma máquina. Para fazer esta verificação, a chave JobServer3Camadas é conferida. Caso esteja setada para true, utiliza o padrão TCP mesmo que esteja configurado para NamedPipes.Exemplo: <add key="WcfProtocol" value="http" />

          ...

          • Tipo: Valores específicos
          • Default:TCP em 3 camadas, NamedPipes em 1 camada.

          ...

          • Exemplo:

          Consulte o WikiHelp TOTVS

          Image Removed COMUNIDADE  @FRAMEWORK

          Canais de Atendimento:

          Chamado: Através do Portal Totvs www.suporte.totvs.com.br

          ...

          • Bloco de código
            languagexml
            <add key="WcfProtocol" value="http" />