Produto Data da criao Pas(es) FNC : TOTVS SERVICE SPED : 19/07/10 : Brasil : 00000013212 Data da reviso : 28/07/10
Esta documentao define qual o processo para instalao e configurao do TOTVS SERVICE SPED TSS. O TOTVS SERVICE SPED consiste em um servidor (appserver) que responder e realizar requisies de servios WebService. Este servidor tem o objetivo de realizar a comunicao entre os servios disponibilizados pelo fisco, especialmente os servios de Nota Fiscal Eletrnica, SPED Contbil, Nota Fiscal Eletrnica de Servio, entre outros.
Instalao do TSS
Para iniciar a instalao do TSS, realize o download do Instalador do TSS por meio do portal do Cliente ou Analista. Com o instalador baixado, realize o procedimento a seguir: 1 Passo 1. Execute o instalador do TSS, arquivo TSS.exe. Ser aberta a tela para seleo do idioma de instalao: 2. Escolha a opo Portugus e clique em OK. 2 Passo 1. Ser apresentada a tela de Boas Vindas, com o Wizard de Instalao do TSS. Nesta tela clique em Avanar: 2. Ser aberta a tela do Contrato de Licena. Leia atentamente e se aceitar todos os termos do contrato, clique em Sim. Ao escolher No, o processo de instalao encerrado. 3. Na prxima tela, escolha a pasta de instalao do TSS em Procurar, por default ser C:\TotvsSped\. Aps a escolha clique em Avanar. 4. Na prxima janela ser configurado o servio de HTTP, que o TSS disponibilizar. Configure o servidor e a porta. Observao: Ateno! No campo Servidor deve ser informado o IP do Servidor no qual est sendo realizada a instalao. Caso este campo seja preenchido como LOCALHOST, o acesso se dar internamente apenas pelo servidor no qual est instalado o TSS, qualquer outra mquina da Rede no enxergar o Servio. 5. Aps preenchimento dos campos Servidor e Porta, clique em Avanar. 6. Neste momento, informe os campos Database, Alias e Servidor. Clique em Avanar. 7. Agora ser definido o Tipo de Instalao, ou seja, quais sero os jobs que o TSS subir ao ser iniciado. As opes so: Nota Fiscal Eletrnica;
2 TSS TOTVS Service SPED
Nota Fiscal Eletrnica Localizado; Nota Fiscal de Servio; Conhecimento de Transporte Eletrnico. 8. Aps definir os servios, clique em Avanar. Antes de copiar os arquivos, confira a configurao realizada. 9. Clique em Avanar para continuar a instalao. Aguarde at que a barra de status da quantidade instalada chegue ao final. 10. Indique se deseja executar o TSS como servio. Ao clicar em Sim, o TSS ser automaticamente classificado como servio do Windows, a opo No faz com que seja somente instalado e iniciado em modo console. 11. Aps a escolha, clique em Concluir. 12. Salve a configurao e inicie o servio do TSS em modo console para verificar se a configurao est correta.
13. Se o server subir corretamente, acesse o endereo configurado na instalao do TSS via HTTP. No exemplo a seguir foi configurado o IP 172.16.70.117 e porta 8060, acessando via IE:
2. Ser aberta a tela do Contrato de Licena, leia atentamente e caso aceite todos os termos, clique em Sim. 3. Na prxima tela escolha a pasta de instalao do TSS, por default ser em C:\TotvsSped\. Aps a escolha, clique em Avanar. 4. Reveja a configurao definida e clique em avanar para iniciar a atualizao 5. Na prxima etapa, se deseja executar o TSS como servio clique em Sim. O TSS ser automaticamente colocado como servio do Windows. Para que seja instalado e executado em modo console, clique em No. 6. Aps a escolha, clique em Concluir.
[SSLCONFIGURE] abaixo desta seo existem as chaves que so responsveis pela comunicao do Web Service, junto com as informaes do protocolo Criptogrfico (SSL Securty Sockets Layer) . Exemplo: [SSLConfigure] HSM=0 SSL2=1 SSL3=1 TLS1=1 BUGS=1 CertificateClient=C:\TSS\certs\000010_all.pem KeyClient=C:\TSS\certs\000010_key.pem [PROXY] caso exista um Proxy para o acesso a internet, a configurao do mesmo dever ser informada nas chaves desta seo. Exemplo: [PROXY] Enable=1 Server=endereo do proxy
TSS TOTVS Service SPED 5
Port=porta do proxy User=dominio\login usurio Password=senha do usurio no proxy [JOBNFE] define o job da NF-e e CT-e. Exemplo: [JOBNFE] main=SPEDWF environment=SPED [NFSE_WF] define o job da NFS-e Exemplo: [NFSE_WF] MAIN=NFSEWF ENVIRONMENT=SPED [JOBLOC] define o job da Fatura Eletrnica (Argentina) Exemplo: [JOBLOC] main=LOCWF environment=SPED [ONSTART] define quais os jobs sero iniciados. Exemplo: [ONSTART] JOBS= JOB_WS ,JOBNFE,JOBLOC,NFSE_WF
TOPMEMOMEGA=1 XMLSAVEALL: permite que seja gravado na Pasta WSLOGXML, todos os XMLs de comunicao dos Mtodos do TSS com a aplicao chamadora. Esta chave deve ser habilitada somente para ajudar na anlise de inconsistncias, pois gera um grande nmero de XMLs. Exemplo: [JOB_WS] TYPE=WEBEX ENVIRONMENT=SPED INSTANCES=5,50 SIGAWEB=WS INSTANCENAME=ws ONSTART=__WSSTART ONCONNECT=__WSCONNECT XMLSAVEALL=1
NFESPED_WF: define se no console de execuo do TOTVS SERVICE SPED, as mensagens referentes ao processamento realizado pelo JOB da NF-e sero demonstradas. Exemplo: [Environment] NFESPED_WF=1
NFSE_WF_DEBUG: define se ser demonstrado no console de execuo do TOTVS SERVICE SPED, as mensagens referentes ao processamento realizado pelo JOB da NFS-e. Exemplo: [Environment] NFSE_WF_DEBUG =1 NFESPED_WFENTIDADES: define um range de entidades que sero processadas pelo JOB da NFE do TSS, parmetro muito utilizado quando existe a necessidade de se ter mais de um TSS utilizando um mesmo banco devido a um grande nmero de Entidades. Exemplo Neste exemplo, foi definido que ser processado pelo JOB da entidade 000005 at a entidade 000020. [Environment] NFESPED_WFENTIDADES=000005-000020
NFSE_WF_ENTIDADES: Define um range de entidades que sero processadas pelo JOB da NFS-e do TSS, parmetro muito utilizado quando existe a necessidade de se ter mais de um TSS utilizando um mesmo banco devido a um grande numero de Entidades. Exemplo Neste exemplo, foi definido que ser processado pelo JOB da entidade 000005 at a entidade 000020. [Environment] NFESPED_WFENTIDADES=000005-000020 NFESPED_WFNFE: define qual o JOB do TSS que ser processado, utilizado quando houver a necessidade de se ter mais de um TSS processando com o mesmo banco de dados, com este parmetro possvel definir um JOB para cada TSS. Contedos vlidos Valor 0 (padro) Todos 1 2 3 4 5 Exemplo Neste exemplo, foi definido que ser processado apenas o JOB de assinatura. [Environment] NFESPED_WFNFE=1 Assinatura Transmisso Cancelamento/Inutilizao/Recepo de lotes Envio do e-mail de distribuio Recepo das Mensagens (emial)de Excees Descrio
SPED_SAVEWSDL: habilita a gravao dos Xmls de comunicao do TSS com os WebService Externos.Esta chave deve ser habilitada apenas em casos que seja realmente necessrio, pois pode causar uma grande lentido na comunicao. Contedos vlidos valor Descrio
X(padro) Desconsidera o parmetro 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K Todos Web Service de Status Servio \ NF-e Web Service de Consulta Cadastro \ NF-e Web Service de Consulta Cadstro_1 \ NF-e Web Service de Cancelamento \ NF-e Web Service de Consulta Nota \ NF-e Web Service de Inutilizao \ NF-e Web Service de Recepo Lote \ NF-e Web Service de Retorno Recepo \ NF-e Web Service de Canelamento \ CT-e Web Service de Consulta \ CT-e Web Service de Inutilizao \ CT-e Web Service de Recepo \ CT-e Web Service de Retorno Recepo \ CT-e Web Service de Status Servio \ CT-e Web Service de Consulta \ DPEC Web Service de Recepo \ DPEC Web Service de Cancelamento \ NFS-e BH Web Service de Consulta Lote \ NFS-e BH Web Service de Consulta NFS-e \ NFS-e BH
L M N O P Q
Web Service de Consulta NFS-e por RPS \ NFS-e BH Web Service de Consulta Situao LOTE \ NFS-e BH Web Service de Recepo \ NFS-e BH Web Service de Gerao de NFS-e \ NFS-e BH Web Service de Recepo \ NFS-e ISSnet Web Service de Consulta Situao LOTE \ NFS-e ISSnet Web Service de Consulta NFS-e por RPS \ NFS-e ISSnet Web Service de Consulta Lote \ NFS-e ISSnet Web Service de Consulta NFSE \ NFS-e ISSnet Web Service de Cancelamento \ NFS-e ISSnet
R S T U
V W X Y Z @ Exemplo:
Web Service de Envio de Lote (ABRASF) Web Service de Consulta de Lote (ABRASF) Web Service de Cancelamento de Lote (ABRASF) Web Service de Envio de Lote (DSFNET) Web Service de Consulta de Lote (DSFNET) Web Service de Cancelamento de Lote (DSFNET)
No exemplo abaixo estou habilitando a gravao do XML que o TSS realizou a comunicao com os Servios de STATUS, CONSULTA e Recepo de Lote da NF-e. [Environment] SPED_SAVEWSDL=268
Exemplo 1 Modo de utilizao padro para empresas com baixo volume de movimentao. Neste exemplo ser demonstrada a configurao padro do TSS. Ser configurado no mesmo servio o HTTP e os JOBS. Estrutura de Diretrios:
Passo 3 - Configurao dos JOBS, e habilitando o start de todos os JOBS atravs da Seco [ONSTART]
Aps a configurao acima, ao iniciar o Servio em modo console, deve aparecer a seguinte tela com os JOBS iniciados:
Exemplo 2 Modo de utilizao com separao de servios, para empresas com mdio volume de movimentaes. Neste modo ser configurado dois servios, um apenas para o HTTP e outro apenas para os JOBS. Servio 1 - HTTP Realizar toda a configurao conforme o exemplo 1, deixando apenas de realizar o Passo 3 da configurao dos JOBS.
Servio 2 JOBS Realizar a configurao conforme o Exemplo 1, deixando apenas de realizar os Passos 2 e 4.
A iniciar o servio em modo console ser mostrado apenas o start dos JOBS:
Exemplo 3 Modo de utilizao com separao de Servios de processamento do JOB, para empresas com alto volume de movimentaes. Neste exemplo ser demonstrado a configurao de 4 Servios, cada NFESPED_WFENTIDADES com um range de entidades configurado. um utilizar a chave
Realize os mesmos procedimentos do Exemplo 1, s que no passo 1 inclua a chave NFESPED_WFENTIDADES da seguinte forma:
Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.
Realize os mesmos procedimentos do Exemplo 1, mas no realize a configurao do HTTP (Passos 2 e 4) e no passo 1 inclua a chave NFESPED_WFENTIDADES da seguinte forma:
Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.
Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.
Servio 4 Entidades de 000010 000012 sem os servios do HTTP. Realize os mesmos procedimentos do servio 2.
Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.
Observao Para que seja apresentado no console as informaes dos jobs, habilite a chave NFESPED_WF = 1 para os jobs da NF-e e NFSE_WF_DEBUG=1 para os jobs da NFS-e. Observao Para o Exemplo 3 tambm possvel realizar a separao do processamento para os jobs da NFS-e, basta utilizar a chave NFSE_WF_ENTIDADES, no lugar da chave NFESPED_WFENTIDADES.