Boletim Tcnico

TOTVS Service SPED - TSS

Produto

TOTVS SERVICE SPED TSS Verso 10

Chamado

TFIFIN

Data da publicao

05/07/12

Pas(es)

Brasil / Argentina

Banco(s) de Dados

Banco(s) de dados

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.

TSS TOTVS SERVICE SPED

Boletim Tcnico

Procedimento para Implementao

O TSS um aplicativo que responde e realiza somente servios Web Service para se comunicar com o ERP e com o fisco, sendo
necessrio que o hardware de instalao possua conexo internet e tenha alto ndice de confiabilidade.

Trabalha junto com o TopConnect, desta forma ser necessrio ter um banco de Dados relacional homologado pela TOTVS TEC
(Ex: SQL Server, Oracle, DB2, etc.).
Caso exista algum bloqueio de Firewall , este deve ser liberado para a comunicao junto aos Web Services do Fisco.
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:

Instalao do TSS - Windows

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.

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;

Nota Fiscal Eletrnica Localizado;

Nota Fiscal de Servio;

Conhecimento de Transporte Eletrnico.

TSS TOTVS SERVICE SPED

Boletim Tcnico

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.22 e porta 8080, acessando via IE:

TSS TOTVS SERVICE SPED

Boletim Tcnico

Procedimentos para Atualizao - Windows

Para iniciar a atualizao do TSS ser necessrio realizar o download por meio do portal do Cliente ou Analista. Realize o Update e siga o
procedimento a seguir:

1 Passo
1.

Baixe o servio do TSS a ser atualizado. Execute o Update do TSS, arquivo TSS-Update.exe, ao realizar este processo ser aberta
a tela para seleo do idioma da instalao.

2 Passo

1.

Ser aberta a tela de Boas Vindas, com o Wizard de Instalao do TSS. Nesta primeira tela, clique em Avanar.

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

TSS TOTVS SERVICE SPED

Boletim Tcnico

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.
Aps a escolha, clique em Concluir.

Instalao do TSS - Linux

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 install_linux) via Terminal utilizando o comando ./install_linux.

2. Ser apresentada a mensagem de confirmao de instalao. Para continuar digite <ENTER>.

TSS TOTVS SERVICE SPED

Boletim Tcnico

3. O prximo passo ser a configurao do idioma de instalao. Digite 1 para informar a opo Portugus e digite <ENTER> para
configurar o prximo passo.

4. O passo seguinte ser a configurao do Banco de Dados. Digite 1 para selecionar a opo TopConnect e digite <ENTER> para
configurar o prximo passo.

TSS TOTVS SERVICE SPED

Boletim Tcnico

5. Neste passo, ser configurado o servio de HTTP que o TSS disponibilizar. Configure o Servidor e a Porta.

TSS TOTVS SERVICE SPED

Boletim Tcnico

Ateno! No campo Servidor deve ser informado o IP do Servidor no qual est sendo realizada a instalao, pois o
Sistema Operacional Linux no entende como LOCALHOST, onde neste caso necessrio informar o IP 127.0.0.1.
Aps preenchimento dos campos Servidor e Porta, digite <ENTER> para configurar o prximo passo.
6. Neste momento, ser realizada a configurao do TOP. Informe o Servidor, a Porta e Alias. Digite <ENTER> para configurar o
prximo passo.

7. Neste momento ser definido se o JOB da Nota Fiscal Eletrnica subir no momento em que o TSS for iniciado. Informe 1- Sim
ou 2 No. Digite <ENTER> para configurar o prximo passo.

TSS TOTVS SERVICE SPED

Boletim Tcnico

8.

Neste momento ser definido se o JOB da Nota Fiscal Eletrnica Localizado subir no momento em que o TSS for iniciado.
Informe 1- Sim ou 2 No. Digite <ENTER> para configurar o prximo passo.

9. Neste momento ser definido se o JOB da Nota Fiscal de Servio subir no momento em que o TSS for iniciado. Informe 1- Sim
ou 2 No. Digite <ENTER> para configurar o prximo passo.

TSS TOTVS SERVICE SPED

Boletim Tcnico

10. Neste momento ser definido se o JOB do Conhecimento de Transporte Eletrnico subir no momento em que o TSS for
iniciado. Informe 1- Sim ou 2 No.

10

TSS TOTVS SERVICE SPED

Boletim Tcnico

11. Aps
configurao
instalao.

dos

Servios,

digite

<ENTER>

para

que

seja

concluda

12. Salve a configurao e inicie o servio do TSS em modo console para verificar se a configurao est correta.

TSS TOTVS SERVICE SPED

11

Boletim Tcnico

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.155 e porta 8060, acessando via IE:

12

TSS TOTVS SERVICE SPED

Boletim Tcnico

Ateno! A atualizao do TSS realizada a partir da execuo do instalador com a ltima verso disponvel no
Portal do cliente / analista, pois no h pacote de Updates para o Sistema Operacional Linux.

Procedimentos de Configurao
Existem algumas formas diferentes de se configurar o TSS, visando um melhor desempenho no processamento das Notas
Eletrnicas.
Como o TSS no apresenta uma interface, qualquer tipo de alterao na configurao deve ser feita diretamente no
AppServer.INI. Veja a seguir as funcionalidades de algumas Sees/Chaves utilizadas no TSS e tambm alguns exemplos de configurao.
Sees importantes para o TSS:
[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

TSS TOTVS SERVICE SPED

13

Boletim Tcnico

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

Algumas Chaves Importantes:

14

TSS TOTVS SERVICE SPED

Boletim Tcnico

TOPMEMOMEGA: permite que as conexes SGBD (Sistema de Gerenciamento de Banco de Dados), realizadas por meio do ByYou
DBAccess, utilizem campo M (Memo) com at 1000000 de bytes. Este parmetro necessrio, pois o TSS utiliza campos MEMO para
gravao dos XML.
Deve estar dentro da seo que estiver a configurao do TopConnect, geralmente na chave do ambiente [Environment] ou na
chave do TopConnect.
Exemplo:
[Environment]
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

TSS TOTVS SERVICE SPED

15

Boletim Tcnico

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
V

Descrio

alor
0
(padro)

Todos

Assinatura

Transmisso

Cancelamento/Inutilizao/Recepo
de lotes

Envio do e-mail de distribuio

Recepo das Mensagens (emial)de

Excees

Exemplo
Neste exemplo, foi definido que ser processado apenas o JOB de assinatura.
[Environment]
NFESPED_WFNFE=1

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
X(pad
ro)

16

Descrio
Desconsidera o parmetro

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

TSS TOTVS SERVICE SPED

Boletim Tcnico

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

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

V
W
X
Y
Z
@

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)

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

Exemplos Indicados para uso do

TSS

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:

TSS TOTVS SERVICE SPED

17

Boletim Tcnico

Arquivo TOTVSAppserver.ini

Passo 1 - Configurao do Environment [SPED]

Passo 2 - Configurao do HTTP com o Enable = 1 (Habilitado)

18

TSS TOTVS SERVICE SPED

Boletim Tcnico

Passo 3 - Configurao dos JOBS, e habilitando o start de todos os JOBS atravs da Seco [ONSTART]

Passo 4 - Configurando o endereo de HTTP do servio:

TSS TOTVS SERVICE SPED

19

Boletim Tcnico

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.

20

TSS TOTVS SERVICE SPED

Boletim Tcnico

Ao iniciar o servio em modo console ser mostrado apenas servio de HTTP:

Servio 2 JOBS

TSS TOTVS SERVICE SPED

21

Boletim Tcnico

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:

22

TSS TOTVS SERVICE SPED

Boletim Tcnico

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 um utilizar a chave NFESPED_WFENTIDADES com um range
de entidades configurado.
Servio 1 Entidades de 000001 0000003 mais o servio de HTTP.

Realize os mesmos procedimentos do Exemplo 1, s que no passo 1 inclua a chave NFESPED_WFENTIDADES da seguinte
forma:

TSS TOTVS SERVICE SPED

23

Boletim Tcnico

Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.

Servio 2 Entidades de 000004 000006 sem os servios do HTTP.

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:

24

TSS TOTVS SERVICE SPED

Boletim Tcnico

Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.

Servio 3 Entidades de 000007 000009 sem os servios do HTTP.

Realize os mesmos procedimentos do servio 2.

TSS TOTVS SERVICE SPED

25

Boletim Tcnico

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.

26

TSS TOTVS SERVICE SPED

Boletim Tcnico

Ao ser iniciado o servio, apenas sero demonstradas estas entidades em processamento para os JOBS do SPED.

TSS TOTVS SERVICE SPED

27

Boletim Tcnico

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

Certificados Homlogados pelo TSS

Atualmente esto disponveis no mercado dois tipos de certificados digitais, o certificado de tipo A1 (em
formato de arquivo com extenses .pfx ou .p12) e o certificado de tipo A3 ( tipo hardware, podendo ser um
carto ou token).
No TSS est homologado para uso apenas do tipo A1 e do tipo A3.
Abaixo seguem as marcas e modelos de certificados tipo A3 aceitos:
HSMs da marca SAFENET:

LUNA SA
LUNA SP
LUNA PCI
LUNA PCM
PROTECTSERVER Externo
PROTECTSERVER Gold
ProtectHost EFT

Token da marca PRONOVA:

EPASS2000

28

Observao:

Para o pleno funcionamento da NF-e necessrio que o certificado digital no HSM seja importado com as seguintes diretivas:
CKA_PRIVATE
CKA_VERIFY
CKA_SIGN

TSS TOTVS SERVICE SPED

Boletim Tcnico

Configurao manual de URL

Caso o usurio necessite usar uma URL especfica, diferente das padres de funcionamento do TSS,
para comunicao com outros Web Services, disponibilizado um sistema para que sejam includas e
utilizadas no lugar das padres.
Verso 10
Na verso 10, o TSS realiza a leitura do arquivo spedurl.cfg dentro da pasta system do ambiente.
Este arquivo deve ser preenchido da seguinte maneira, cada linha dever conter as informaes sobre
uma URL, sendo separadas por virgula, exemplo:
Orgo,Ambiente,Modelo,Servio,URL
Caso queira alterar a URL do servio externo NFeRecepcao do estado do Amazonas para o ambiente
de homologao, dever ser criada uma linha no arquivo da seguinte forma:
AM,2,55,NFERECEPCAO,HTTP://MINHA.NOVA.URL
O TSS ento, toda vez que precisar utilizar a URL deste servio, usar a que foi definida dentro do
arquivo.
Verso 11
Para a verso 11, dentro do programa TSSINTERFACE, o usurio pode acessar a configurao de URL
pelo menu Configurao > URL.

TSS TOTVS SERVICE SPED

29

Boletim Tcnico

O usurio pode incluir, alterar e excluir as URL que ele deseja que o TSS utilize fora do padro.

Atualizao das URL padres

A partir do release 2.09, o TSS conta com o arquivo tssatuurl.cfg na pasta system de seu ambiente
para a atualizao das URL padres do sistema. Sendo um arquivo encriptado, impossibilitando sua
edio, o TSS em sua primeira execuo realiza a leitura deste arquivo, verificando se um arquivo
mais recente, alimenta sua base com as URL novas, e realiza a excluso do arquivo da pasta.

30

TSS TOTVS SERVICE SPED

Boletim Tcnico

INFORMAES TCNICAS

Tabelas Utilizadas

SPED000 - Tabela de Parmetros; SPED001 - Cadastro de Entidades ;

SPED001A - Complemento de Entidades ; SPED050 - Notas Fiscais
Eletrnicas; SPED050L - Factura Electrnica - Localizada; SPED051 - Notas
Fiscais Eletrnicas de Servio; SPED052 - Lote da NF-e; SPED052L - Lote da
Factura Electrnica; SPED053 - Lote da NFS-e; SPED054 - Relacionamento
Lote versus NF-e; SPED054L - Relacionamento Lote versus Factura;
SPED055 - Relacionamento Lote versus NFS-e; SPED056 - Nota Fiscal
Eletrnica log de Contingncia.

Funes Envolvidas

No se aplica

Sistemas Operacionais

Windows/Linux

TSS TOTVS SERVICE SPED

31