Ver código fonte para 1876 Configuracao Servicos


[[Area_Ferramentas|Área de Ferramentas]]

O recurso '''Configuração de Serviços''' centraliza os parâmetros utilizados por serviços e rotinas integradas do Touch ERP. Entre eles estão a distribuição de documentos fiscais, tarefas automáticas, consulta de preços, estatísticas comerciais, conciliação financeira e precificação de produtos.

Cada cadastro possui uma '''Descrição''', uma '''Chave única do serviço''' e uma lista de '''Itens de configuração'''. Os itens exibidos dependem do serviço selecionado.

'''Acesso:''' Ferramentas > TI > Configurações > Configuração de Serviços — recurso '''1876'''.

__TOC__

== Configuração e execução do serviço ==

Este cadastro informa '''como o serviço deve funcionar'''. O agendamento e a execução, quando necessários, são definidos na tarefa ou na rotina que utiliza a configuração.

'''Salvar uma configuração não significa executar o serviço imediatamente.''' Para serviços em segundo plano, confira também a tarefa do servidor e seu resultado de processamento. Para configurações utilizadas em telas, selecione o cadastro na operação correspondente.

== Antes de começar ==

Identifique o serviço que será configurado e reúna os dados solicitados por ele, como:

* Identificadores das empresas e das configurações de certificado.
* Ambiente de homologação ou produção, quando aplicável.
* Credenciais da integração, quando solicitadas.
* Endereços de consulta e modelos de apresentação, no caso de terminais de preços.
* Avaliadores, tabelas de variáveis e critérios de custo, no caso da precificação.

Quando um item solicitar um '''ID''', informe o identificador do cadastro indicado, e não sua descrição. O ID da empresa, por exemplo, não é o CNPJ.

== Como cadastrar ==

# Acesse o recurso e inicie um novo cadastro.
# Informe uma '''Descrição''' que identifique o serviço e sua finalidade. Exemplo: <code>Distribuição de CT-e — empresa principal</code>.
# Selecione a '''Chave única do serviço'''.
# Aguarde o carregamento dos itens na grade.
# Preencha a coluna '''Valor''' de cada parâmetro necessário, conforme a descrição do item e as orientações do serviço.
# Confira os dados e salve.
# Vincule ou utilize a configuração na tarefa ou rotina correspondente.
# Confira o resultado de uma execução para confirmar o funcionamento.

O nome informado na descrição não escolhe o serviço. Essa escolha é feita pelo campo '''Chave única do serviço'''.

== Campos do cadastro ==

{| class="wikitable"
! Campo
! Como utilizar
|-
| Descrição
| Nome para identificar a configuração. É obrigatório.
|-
| Chave única do serviço
| Selecione o tipo de serviço na lista. É obrigatório e determina os itens exibidos.
|-
| Identificador do item
| Identificação do registro na grade, quando disponível. Não substitui os IDs solicitados na coluna Valor.
|-
| Item
| Nome utilizado pelo sistema para identificar o parâmetro, como <code>id_empresa</code>.
|-
| Descrição do item
| Explica o parâmetro e, em alguns casos, os códigos, separadores ou unidades esperados.
|-
| Valor
| Conteúdo utilizado pelo serviço. É a coluna destinada ao preenchimento dos parâmetros.
|}

Os itens são fornecidos pelo sistema conforme a chave escolhida. Não é necessário criar nomes de parâmetros manualmente.

== Como alterar uma configuração existente ==

# Localize e abra o cadastro.
# Confira a chave do serviço e os valores já informados.
# Altere somente os parâmetros necessários.
# Salve e confira o comportamento na rotina que utiliza a configuração.

Ao abrir um cadastro existente, a tela atualiza a lista de parâmetros disponíveis para o serviço, preservando os valores dos itens que continuam disponíveis. Novos itens podem aparecer sem preenchimento; itens que deixaram de fazer parte do serviço não aparecem na lista atualizada.

'''Trocar manualmente a chave limpa a lista de valores da tela e carrega os itens do novo serviço em branco.''' Não utilize essa troca apenas para consultar parâmetros de outro serviço em um cadastro que deseja manter. Se a troca foi acidental, saia sem salvar e reabra o registro salvo.

== Regras de preenchimento ==

* Informe números sem símbolos monetários, sinais de percentual ou separadores de milhar, salvo orientação específica do item.
* Nos parâmetros decimais desta grade textual, utilize ponto quando o serviço esperar um número decimal, como <code>2.5</code>.
* Utilize <code>0</code> e <code>1</code> para Não e Sim somente nos itens que adotam essa convenção. Outros campos possuem códigos próprios.
* Respeite a unidade indicada: horas, dias, segundos e percentuais não são equivalentes.
* Quando houver listas, utilize o separador indicado pelo próprio parâmetro.
* Um campo em branco pode assumir um padrão ou impedir a execução, dependendo do serviço. Não trate o branco como uma opção geral de desativação.
* Confira as credenciais e os modelos de integração com o responsável pela implantação. Utilize dados ilustrativos em exemplos e solicitações de ajuda, sem divulgar chaves secretas.

Salvar o cadastro confirma os campos gerais obrigatórios. A compatibilidade dos valores, a existência dos cadastros referenciados e a conexão com os serviços precisam ser conferidas na execução.

== Serviços disponíveis ==

=== Distribuição de CT-e ===

'''Chave:''' <code>distribuicao_xml_ctes</code>.

Configura a consulta e distribuição de documentos de transporte. Os parâmetros incluem:

{| class="wikitable"
! Item
! Finalidade
|-
| <code>id_configuracao_certificado</code>
| Identificação da configuração de certificado utilizada pelo serviço.
|-
| <code>id_empresa</code>
| Empresa ou empresas abrangidas pela configuração, conforme o formato utilizado pela rotina.
|-
| <code>homologacao_producao</code>
| Ambiente: <code>0</code> para homologação e <code>1</code> para produção.
|-
| <code>nsu_inicial</code>
| Referência inicial de distribuição, utilizada também quando existe histórico de consulta em outro sistema.
|-
| <code>considerar_emp_destinatario</code>
| Considerar a participação da empresa como destinatário: <code>0</code> Não; <code>1</code> Sim.
|-
| <code>considerar_empresa_remetente</code>
| Considerar a empresa como remetente: <code>0</code> Não; <code>1</code> Sim.
|-
| <code>considerar_empresa_expedidor</code>
| Considerar a empresa como expedidor: <code>0</code> Não; <code>1</code> Sim.
|-
| <code>considerar_empresa_recebedor</code>
| Considerar a empresa como recebedor: <code>0</code> Não; <code>1</code> Sim.
|-
| <code>considerar_empresa_tomador</code>
| Considerar a empresa como tomador: <code>0</code> Não; <code>1</code> Sim.
|}

Para o procedimento específico, consulte [[1673_Tarefas_Servidor/Download_Distribuicao_XML_CTe|Download/Distribuição de XML de CT-e]].

=== Distribuição de NF-e ===

'''Chave:''' <code>distribuicao_xml_nfes</code>.

Os itens disponíveis são:

* <code>id_configuracao_certificado</code>: configuração de certificado.
* <code>id_empresa</code>: empresa ou empresas atendidas pela rotina.
* <code>homologacao_producao</code>: <code>0</code> homologação; <code>1</code> produção.
* <code>considerar_apenas_notas_resp_empresa</code>: considerar apenas notas sob responsabilidade da empresa, conforme o critério da rotina; <code>0</code> Não e <code>1</code> Sim.
* <code>nsu_inicial</code>: referência inicial da distribuição.

O NSU representa a sequência utilizada na consulta dos documentos; não é o número da nota fiscal. Ajuste a posição inicial de acordo com o histórico que será utilizado pelo serviço.

=== Distribuição de NFS-e ===

'''Chave:''' <code>distribuicao_xml_nfses</code>.

Além de certificado, empresa, ambiente e NSU inicial, possui:

* <code>qtd_max_requisicoes_periodo</code>: quantidade máxima de requisições controlada pela rotina de consulta.
* <code>timeout_entre_consultas</code>: intervalo entre consultas, em '''segundos'''.

Na consulta documentada, quando não informados, o limite de requisições e o intervalo assumem o valor '''20''' cada. Ajuste esses parâmetros conforme a operação do serviço; eles não substituem o agendamento da tarefa.

=== Ciência automática de NF-e ===

'''Chave:''' <code>ciencia_automatica_nfe</code>.

Informe a configuração de certificado, a empresa e o parâmetro <code>tipo_ciencia_fornecedor</code>:

{| class="wikitable"
! Valor
! Comportamento
|-
| 0
| Não efetuar ciência automaticamente.
|-
| 1
| Efetuar ciência dos documentos abrangidos pela seleção da rotina.
|-
| 2
| Efetuar ciência desde que o fornecedor esteja cadastrado.
|-
| 3
| Efetuar ciência somente para fornecedores com ordens em aberto.
|}

Selecione o critério definido para a operação da empresa. Ciência automática, confirmação da operação e download de XML são serviços distintos, com configurações próprias.

=== Confirmação automática de NF-e ===

'''Chave:''' <code>confirmacao_automatica_nfe</code>.

Os itens incluem:

* <code>id_configuracao_certificado</code>: configuração de certificado.
* <code>id_empresa</code>: empresa ou empresas atendidas.
* <code>delay_dias_lancamento</code>: intervalo em '''dias''' considerado em relação ao lançamento na seleção dos documentos.
* <code>data_base</code>: data de referência para a seleção dos documentos; precisa estar preenchida para essa execução. Informe no formato <code>dd/MM/aaaa</code>, por exemplo, <code>01/10/2026</code>.
* <code>somente_notas_lib</code>: restringir a seleção às notas liberadas internamente; <code>1</code> Sim e <code>0</code> Não.

Confirme os critérios com o responsável pelo processo de recebimento e manifestação antes de utilizar a rotina automática.

=== Download automático de NF-e ===

'''Chave:''' <code>download_automatico_nfe</code>.

Informe a configuração de certificado, a empresa e:

* <code>delay_apos_confirmacao</code>: intervalo após a ciência ou confirmação da operação, em '''horas''', conforme indicado na descrição do item.

O preenchimento desse intervalo não realiza a ciência nem a confirmação por si só; confira as etapas e as tarefas utilizadas no seu fluxo.

=== Avaliação de críticas de NF de terceiros ===

'''Chave:''' <code>avaliacao_criticas_nf_terceiros</code>.

Reúne critérios para avaliar informações cadastrais e de produtos nas notas de terceiros. Os grupos de parâmetros incluem:

{| class="wikitable"
! Grupo
! Como utilizar
|-
| Avaliações <code>avaliar_...</code>
| Selecionam verificações de país, UF, cidade, logradouro, bairro, número, complemento, CEP, NCM, exceção de NCM e CEST. As opções de avaliação utilizam a convenção numérica Não/Sim.
|-
| Mensagens <code>msg_avaliar_...</code>
| Referenciam mensagens de observação dinâmica pelo identificador, quando utilizadas. Não preencha esses itens como se fossem títulos livres.
|-
| Títulos <code>title_avaliar_...</code>
| Permitem personalizar o título das mensagens correspondentes.
|-
| <code>percentual_avaliacao_similiraridade</code>
| Define o percentual mínimo de similaridade nas comparações de texto, na escala de 0 a 100. Exemplo: <code>90</code> exige similaridade de pelo menos 90%. Confirme o resultado com exemplos conhecidos antes de ampliar o uso.
|-
| <code>id_usuario_responsavel</code>, <code>id_grupo_usuarios</code> e <code>id_prioridade_marketing</code>
| Identificam os responsáveis, o grupo e a prioridade utilizados nos encaminhamentos da rotina.
|-
| <code>id_empresa</code>
| Identifica a empresa da configuração.
|}

Confira quais verificações são relevantes para o fluxo da empresa e as mensagens geradas em uma nota de teste conhecida.

=== Terminal de consulta de preços Gertec HTTP ===

'''Chave:''' <code>terminal_consulta_precos_gertec_http</code>.

Os itens disponíveis são:

* <code>url_consulta</code>: endereços de consulta, separados por <code>;</code> quando houver mais de um.
* <code>html_consulta</code>: modelo HTML da apresentação do produto consultado.
* <code>media_manager_xml</code>: conteúdo XML utilizado pelo Media Manager.
* <code>id_empresa</code>: identificação da empresa utilizada na configuração.
* <code>html_consulta_prod_nao_encontrado</code>: apresentação para produto não encontrado.

Utilize os modelos e endereços definidos para a implantação do terminal. Confira uma consulta com produto existente e outra com código não localizado.

Consulte também [[Touch_Comp_NFCe/Terminais_Consulta_Preco_GERTEC|Terminais de Consulta de Preço GERTEC]], link mantido da documentação anterior.

=== Estatísticas comerciais e IA ===

'''Chave:''' <code>configuracoes_estatisticas_comerciais</code>.

Configura o histórico e as origens de dados utilizadas nas análises comerciais:

* <code>dias_busca_historico</code>: quantidade de dias de histórico a consultar.
* <code>incluir_ped_analise_recom_produtos</code>: inclusão de pedidos na análise de recomendação de produtos.
* <code>incluir_nfe_analise_recom_produtos</code>: inclusão de NF-e nessa análise.
* <code>incluir_nfce_analise_recom_produtos</code>: inclusão de NFC-e nessa análise.

As opções de inclusão utilizam <code>1</code> para Sim e <code>0</code> para Não. Na rotina de recomendação documentada, os pedidos são incluídos mesmo quando o parâmetro de pedidos está em <code>0</code>; confira essa limitação antes de considerar que foram retirados da análise. Para NF-e e NFC-e, confira os valores selecionados e os dados utilizados no resultado.

Consulte [[1876_Configuracao_Servicos/Configurao_Estatisticas_Comercias_IA|Configurações de Estatísticas Comerciais IA]] para as orientações específicas já existentes na wiki.

=== Conciliação financeira API ===

'''Chave:''' <code>conciliacao_financeira_api</code>.

Os parâmetros são:

* <code>cliente_id</code>: identificador do cliente da integração.
* <code>cliente_secret</code>: chave secreta desse cliente.

Esses dados são fornecidos para a integração; não correspondem ao identificador de um cliente comercial cadastrado no ERP. Preencha o par de credenciais da mesma integração e confira a conexão na rotina de conciliação.

=== Precificação de produtos ===

'''Chave:''' <code>precificacao_produtos</code>.

Define parâmetros utilizados nas operações de precificação, incluindo a configuração selecionada na [[1363_Pre_Tabela_Precos|Pré-Tabela de Preços]].

{| class="wikitable"
! Item
! Como preencher
|-
| <code>id_empresas</code>
| IDs das empresas para busca de dados, separados por <code>;</code>. Exemplo ilustrativo: <code>1;2</code>. Na operação da pré-tabela, quando não informado, é utilizada a empresa logada.
|-
| <code>tipo_busca_custo_tab_base</code>
| Critério de custo: <code>0</code> Preço Médio; <code>1</code> Último Custo; <code>2</code> Valor Compra. Na operação da pré-tabela, o padrão sem preenchimento é Último Custo.
|-
| <code>numero_casas_decimais</code>
| Número inteiro de casas decimais. Na operação documentada, o padrão é <code>2</code>.
|-
| <code>fracao_base_arredondamento</code>
| Parâmetro de arredondamento. Veja a observação de compatibilidade abaixo antes de configurar frações.
|-
| <code>avaliadores_precificacao</code>
| Grupos com ID do avaliador, ID da tabela de variáveis e tipo de preço. Veja o formato abaixo.
|-
| <code>tolerancia_acima</code>
| Percentual de tolerância acima utilizado na criação dos cenários de análise.
|-
| <code>tolerancia_abaixo</code>
| Percentual de tolerância abaixo utilizado na criação dos cenários de análise.
|}

==== Formato dos avaliadores de precificação ====

Cada grupo possui três números separados por vírgula:

<pre>ID_AVALIADOR,ID_TABELA_VARIAVEIS,TIPO_PRECO</pre>

Separe vários grupos por ponto e vírgula:

<pre>15,31,0;15,32,1;15,33,2</pre>

Os números são ilustrativos. Nesse exemplo:

* <code>15,31,0</code>: avaliador 15 com tabela de variáveis 31 para o preço de '''venda'''.
* <code>15,32,1</code>: avaliador 15 com tabela de variáveis 32 para o preço '''mínimo'''.
* <code>15,33,2</code>: avaliador 15 com tabela de variáveis 33 para o preço '''máximo'''.

Os tipos válidos são '''0 — Venda''', '''1 — Mínimo''' e '''2 — Máximo'''. Não utilize <code>3</code> como tipo de preço, mesmo que apareça em um exemplo antigo da descrição do parâmetro.

O segundo número é o identificador do cadastro [[1609_Analise_Preco_Venda_Tabela_Variaveis|1609 — Tabela de Variáveis]], e não o código do contexto de avaliação do recurso 1536.

Confira os avaliadores no recurso [[1536_Avaliacao_Expressoes|1536 — Avaliação de Expressões]] e as chaves e valores das respectivas tabelas. Na operação documentada da pré-tabela, esses grupos são utilizados para criar a análise quando o produto ainda não possui uma; alterar a configuração não substitui automaticamente todos os cenários existentes.

==== Compatibilidade do arredondamento ====

Na operação atual da Pré-Tabela de Preços, <code>fracao_base_arredondamento</code> é lido como número inteiro. O exemplo <code>0.05</code> apresentado na descrição do item não é compatível com essa operação na versão documentada.

Para manter o padrão desse parâmetro, informe <code>0</code> ou deixe-o em branco. Para configurar arredondamento por frações de centavos, confirme com o suporte a forma compatível com a versão e a operação utilizadas. O número de casas decimais é configurado separadamente.

== Como conferir o funcionamento ==

# Confirme qual cadastro a tarefa ou operação utiliza. A descrição semelhante de dois registros não garante que ambos sejam consultados.
# Confira empresa, certificado, ambiente e demais identificadores aplicáveis.
# Execute a tarefa ou operação correspondente em um caso conhecido.
# Consulte o resultado, as mensagens e os dados gerados.
# Caso altere os parâmetros, repita a conferência antes de considerar a configuração concluída.

Para tarefas automáticas, confira o cadastro e o agendamento em [[1673_Tarefas_Servidor|Tarefas do Servidor]]. A frequência de execução não é definida pelo nome ou pela descrição deste cadastro.

== Dúvidas e problemas frequentes ==

{| class="wikitable"
! Situação
! O que verificar
|-
| Não é possível salvar
| Preencha a Descrição e selecione a Chave única do serviço.
|-
| A grade está vazia
| Confira se uma chave foi selecionada e se o carregamento dos itens terminou. Verifique eventual mensagem de erro.
|-
| Os valores desapareceram após selecionar outro serviço
| A troca manual da chave carrega os parâmetros do novo serviço em branco. Se a troca foi acidental e não foi salva, reabra o cadastro salvo.
|-
| Surgiram novos itens ao abrir uma configuração
| A tela carrega a lista atual de parâmetros do serviço. Confira se os novos itens precisam de preenchimento.
|-
| O cadastro foi salvo, mas nada foi executado
| Confira a tarefa, o agendamento ou a operação que utiliza a configuração. Salvar não dispara todos os serviços automaticamente.
|-
| O serviço informa empresa, certificado ou cadastro não encontrado
| Confira os IDs informados e se correspondem aos cadastros utilizados pela rotina.
|-
| O serviço informa valor ou formato inválido
| Confira códigos, separadores, datas e unidades. Nos grupos de precificação, cada grupo precisa de três valores separados por vírgula.
|-
| A precificação falha ao informar 0.05 no arredondamento
| Confira a observação de compatibilidade desta página. Na operação documentada da pré-tabela, esse item espera um inteiro.
|-
| A alteração não afeta a operação esperada
| Confira se a operação utiliza esse cadastro e se precisa ser executada novamente. Na precificação, confira também os cenários já existentes no produto.
|}

== Documentação complementar ==

* [[1673_Tarefas_Servidor|Tarefas do Servidor]].
* [[1673_Tarefas_Servidor/Download_Distribuicao_XML_CTe|Download/Distribuição de XML de CT-e]].
* [[1876_Configuracao_Servicos/Configurao_Estatisticas_Comercias_IA|Configurações de Estatísticas Comerciais IA]].
* [[Touch_Comp_NFCe/Terminais_Consulta_Preco_GERTEC|Terminais de Consulta de Preço GERTEC]].
* [[1536_Avaliacao_Expressoes|1536 — Avaliação de Expressões]].
* [[1609_Analise_Preco_Venda_Tabela_Variaveis|1609 — Análise Preço Venda — Tabela de Variáveis]].
* [[1363_Pre_Tabela_Precos|1363 — Pré-Tabela de Preços]].