TSS Manager

ndice
1 - Introduo ....................................................................................................................................................... 3 1.1 - Primeiro Acesso ................................................................................................................................. 4 1.2 - Licenciamento ................................................................................................................................................. 4 2 - Interface .......................................................................................................................................................... 5 2.1 - Inicial................................................................................................................................................................. 6 2.2 - Monitor ............................................................................................................................................................ 8 2.3 - Configuraes.................................................................................................................................................. 11 2.4 - Ferramentas .................................................................................................................................................... 13 2.5 - Sobre................................................................................................................................................................. 14 3 - EDI ................................................................................................................................................................... 14 Documentos Contemplados pelo EDI................................................................................................................... 15 Arquivo XML ............................................................................................................................................................. 15 Web Service .............................................................................................................................................................. 16 3.1 EDI - Importao ............................................................................................................................................ 22 3.2 EDI - Transmisso ........................................................................................................................................... 23 3.3 EDI - Exportao ............................................................................................................................................. 23 3.4 EDI - Impresso .............................................................................................................................................. 24 3.5 Configurao do EDI ...................................................................................................................................... 24 3.6 Leiaute XML EDI ............................................................................................................................................. 25 XML de Envio .................................................................................................................................................. 25 XML de Retorno .............................................................................................................................................. 30 3.6.1 Leiaute XML dos documentos .................................................................................................................. 33

TSS Manager

1 - Introduo
O TSS Manager uma ferramenta que foi desenvolvida para integrar os sistemas que efetuam transmisses de documentos eletrnicos. Ele est dividido em: EDI. Interface. Atravs dessa ferramenta possvel emitir Nota Fiscal Eletrnica e seus respectivos eventos, tais como, Capa de Lote, Imprimir DANFE e muitas outras funcionalidades que so executadas a partir da interface, mas, apenas algumas podem ser feitas pelo EDI.

Para a utilizao deste produto, deve ser adquirida a licena de uso junto TOTVS por intermdio do executivo de contas.

TSS Manager

TSS Manager

1.1- Primeiro Acesso

Para utilizar a interface deve ser executado o smartclient disponibilizado pelo instalador do TSS. necessrio digitar TSSManager no Programa Inicial e confirmar. exibida uma tela para informar usurio e senha padro (para ambos, utilizar ADMIN em maisculo) e confirmar. A tela seguinte exibida para que essa senha seja alterada. Para que seja possvel acessar o sistema, o administrador deve cadastrar um usurio e os CNPJs que ele deve ter acesso, pois, se esse procedimento no for realizado, no momento em que o usurio acessar o sistema ele notificado que no possui CNPJ.

A senha ADMIN no pode ser esquecida, pois, a senha de administrador do sistema. Apenas ele pode gerenciar os acessos dos usurios.

1.2

- Licenciamento

Para utilizar o TSS Manager necessrio possuir a licena de uso do produto. As licenas vlidas so: On Demand: licena utilizada para a integrao via TSS Manager EDI. Com ela, possvel ter acesso ilimitado a interface sem restrio de usurios e, tambm, utilizada para a emisso do documento via EDI, dessa forma, no momento em que o documento for enviado com sucesso ao TSS debitada uma licena. Exemplo: com uma aquisio de 500 licenas On Demand, ao enviar um documento com sucesso para o TSS, debitada uma licena e sobram 499 para utilizao. Observao: necessrio consultar o contrato do produto adquirido para obter detalhes do licenciamento e regras de utilizao. Usurio: na aquisio do produto TSS Manager sem o EDI, liberada uma licena de uso por usurio e o acesso interface do produto limitado por conexo de usurio. Observao: apenas com a licena de usurio no permitida a utilizao do EDI.

Sem as licenas no possvel fazer o acesso ao sistema, pois, obrigatrio que o License Server esteja em funcionamento com elas aplicadas. Aps a configurao do License Server necessrio configurar o License Client que executar a aplicao.

TSS Manager

TSS Manager
Configurao do License Server O License Server um server padro disponibilizado nos binrios da TOTVS e nele configurado, em seu arquivo .ini, a chave [LICENSESERVER] em que so definidas as opes enable (1 habilitado e 0 desabilitado) e o port em que o License Server est em funcionamento. Na Central de Downloads da TOTVS possvel baixar o instalador: [LICENSESERVER] enable=(1 habilitado e 0 desabilitado) port=(porta que o License Server ser executado)

Configurao do License Client No server utilizado para executar os JOBs de EDI e/ou acessar a interface, deve ser configurado, em seu arquivo .ini, a chave License Client: [LicenseClient] server=(ip onde o server do License Server est executando) port=(porta que o License Server ser executado)

Utilizao do arquivo de licenas e o harlock O arquivo de licenas totvslic.key deve ser colocado na pasta localizada no arquivo .ini do server do License Server junto com o hardlock (token de segurana das licenas do produto) que deve ser colocado no USB ou porta serial da mquina que o server do License Server esta executando.

2 - Interface
A interface do TSS Manager possibilita visualizar, monitorar e, tambm, obter informaes do que processado pelo TSS. Ela dividida em menus: Inicial. Monitor. Configuraes. Ferramentas. Sobre.

Todas as telas possuem um browse/grid com legendas do semforo, disponvel na primeira e/ou segunda coluna. Para analis-las, basta dar um duplo clique na legenda do semforo desejado que para que as informaes sejam exibidas. Para atualizar a tela necessrio clicar no cone .

TSS Manager

TSS Manager

2.1 - Inicial
O menu Inicial oferece uma viso dinmica e est dividido em sub-menus: NF-e. EDI. Ambos apresentam um grid com suas respectivas informaes e, quando acessados, exibem os dados do dia. So disponibilizados filtros pr-estabelecidos de Tempo, CNPJ/CPF e Status do processamento do documento, dessa forma, possvel exibir dados de at 1 dia anterior ao atual. Tambm so fornecidos algumas funcionalidades bsicas que o usurio pode executar de acordo com o sub-menu que estar navegando.

2.1.1 Inicial / NF-e

O sub-menu NF-e exibe de uma forma simples e usual as ltimas notas fiscais eletrnicas emitidas pelo TSS. Com o filtro pr-estabelecido possvel filtrar as informaes exibidas no grid divididos em: Tempo: que possui as opes de Hoje e Desde Ontem. CNPJ/CPF: exibe os CNPJs e CPFs configurados no acesso do usurio logado. Status: possui as opes de Todos, Com Falha, Cancelados e Autorizados. No grid so apresentados os documentos que se encaixam no filtro definido. Na parte inferior possui alguns detalhes da NF-e que est posicionada e as informaes so apresentadas conforme navegao no grid. Os detalhes exibidos para NF-e referem-se ao ambiente em que a NF-e foi emitida, Chave da NF-e e Valor Total. Em Aes Relacionadas esto disponveis as opes: Visualizar: exibe uma tela com os dados do XML da NF-e. Ela separada de maneira que as informaes ficam agrupadas de acordo com seu assunto. Exportar XML: exporta o XML da NF-e em um arquivo que deve ser salvo no diretrio escolhido. Enviar e-mail: envia o e-mail para o destinatrio desejado com alguns dados da NF-e como chave, nmero srie e, tambm, com os anexos DANFE e/ou XML da NF-e. Consulta NF: faz a consulta da situao da NF-e pela chave na SEFAZ e retorna as informaes obtidas pela consulta. Status SEFAZ: consulta o status da SEFAZ da NF-e selecionada no grid. Histrico: mostra todo o histrico de transao entre o TSS e SEFAZ da NF-e. Digitador: possibilita que seja digitada uma NF-e em uma interface. Na tela do sub-menu NF-e tambm esto disponveis as opes:

TSS Manager

TSS Manager
Imprimir DANFE: gera em arquivo o documento fiscal DANFE das notas que esto autorizadas ou que foram enviadas em contingncia. Importar: pode ser importado um XML de uma NF-e (modelo padro da SEFAZ) para que o TSS transmita para a SEFAZ.

A rea Detalhes contempla as seguintes informaes: Ambiente: o ambiente em que a nota foi enviada para a SEFAZ (Homologao ou Produo). Chave: chave da nota. Valor Total: valor total da nota.

2.1.2 Inicial / EDI

O sub-menu EDI exibe de uma forma simples e usual os ltimos documentos que foram enviados para o EDI do TSS Manager. Com o filtro pr-estabelecido possvel filtrar as informaes exibidas no grid divididos em: Tempo: que possui as opes de Hoje e Desde Ontem. CNPJ/CPF: exibe os CNPJs e CPFs configurados no acesso do usurio logado. Status: possui as opes de Todos, Com Falha, Transmitido, Exportado e Impresso. No grid so apresentados os documentos que se encaixam no filtro definido. A parte inferior possui alguns detalhes do documento do EDI e as informaes so apresentadas conforme navegao no grid. As aes disponveis so: Importar: pode ser importado um XML no modelo estipulado pela TOTVS para que os servios do EDI processem o documento. Histrico: mostra todo o histrico de transao entre o EDI e o TSS.

A rea Detalhes contempla as seguintes informaes: Arquivo Importado. Nome do arquivo importado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: ENVIO MT4.XML. Identificao. Identificao enviada dentro do arquivo do EDI. Exemplo: 000000027. Caminho da importao. Nome do caminho de importao utilizado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: \Importar\. Vias impressas. Nmero de vias que sero impressas do documento. Exemplo: 2. Arquivo exportado. Nome do arquivo exportado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: ENVIO MT4.XML. Informaes. Quando existe alguma rejeio este campo informa maiores detalhes dessa rejeio. Exemplo: J existe na base de dados o identificador "000000175" para o mesmo CNPJ e modelo informado .

TSS Manager

TSS Manager
Caminho da exportao. Nome do caminho de exportao utilizado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: \Exportar\rejeitado\04215721000765\

2.2 - Monitor
O menu Monitor fornece um monitoramento mais detalhado com mais filtros que permite refinar uma busca com mais preciso. Assim como no menu Inicial o Monitor tem as aes que so executadas de acordo com o registro selecionado no grid, entretanto, seu diferencial est em algumas aes que podem ser executadas em mais de um registro do grid, como por exemplo, gerar o DANFE de mais de um registro de uma nica vez. No canto superior do monitor existe um cone para que seja possvel forar a atualizao dos dados na tela. Todos os grids do Monitor so de mltipla seleo e dividido em sub-menus: NF-e. EDI. Evento. CL-e. Manifesto.

2.2.1 Monitor / NF-e

O Monitor de NF-e exibe a mesma estrutura de dados que a NF-e no menu Inicial com o diferencial de que mais aes podem ser executadas. Em Aes Relacionadas esto disponveis as opes: Visualizar: exibe uma tela com os dados do XML da NF-e. Ela separada de maneira que as informaes ficam agrupadas de acordo com seu assunto. Exportar XML: exporta o XML da NF-e em um arquivo que deve ser salvo no diretrio escolhido. Enviar E-mail: envia o e-mail para o destinatrio desejado com alguns dados da NF-e como chave, nmero srie e, tambm, com os anexos DANFE e/ou XML da NF-e. Validar Schema: possibilita a validao do schema do XML da NF-e. Histrico: mostra todo o histrico de transao entre o TSS e SEFAZ da NF-e. Status SEFAZ: consulta o status da SEFAZ da NF-e selecionada no grid. Parmetros: atravs dos parmetros possvel reconfigurar o filtro do Monitor. Consulta NF: faz a consulta da situao da NF-e pela chave na SEFAZ e retorna as informaes obtidas pela consulta. Cancelar: processa o cancelamento da NF-e emitida para que o TSS transmita o cancelamento para SEFAZ. Capa de Lote: possibilita que seja feita a capa de lote transmitindo para a SEFAZ.
8

TSS Manager

TSS Manager
Evento: cria o evento de carta de correo. Digitador: possibilita que seja digitada uma NF-e na interface. Na tela do sub-menu NF-e tambm esto disponveis as opes: Imprimir DANFE: gera em arquivo o documento fiscal DANFE das notas que esto autorizadas ou foram enviadas em contingncia. Importar: pode ser importado um XML de uma NF-e (modelo padro da SEFAZ) para que o TSS transmita para a SEFAZ.

A rea Detalhes contempla as seguintes informaes: Ambiente: Ambiente que o documento foi enviado. Exemplo: Homologao. Chave: Chave da Nota Fiscal. Exemplo: 42120953113791001790552000000000151999999848. Valor total: Valor total da Nota Fiscal Exemplo: 1,00. Eventos. Exibe os eventos e ao clicar no mesmo apresenta se foi enviado evento ou no para aquele documento. Exemplo: CARTA DE CORREO.

2.2.2 Monitor / EDI

O Monitor de EDI exibe a mesma estrutura de dados que o EDI exibido no menu Inicial. Em Aes Relacionadas est disponvel a opo Importar que permite importar um XML no modelo estipulado pela TOTVS para que os servios do EDI processem o documento. Na tela do sub-menu EDI tambm esto disponveis as opes: Histrico: mostra todo o histrico de transao entre o EDI e o TSS. Parmetros: atravs dos parmetros possvel reconfigurar o filtro do Monitor.

A rea Detalhes contempla as seguintes informaes: Arquivo Importado. Nome do arquivo importado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: ENVIO MT4.XML. Identificao. Identificao enviada dentro do arquivo do EDI. Exemplo: 000000027. Caminho da importao. Nome do caminho de importao utilizado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: \Importar\. Vias impressas. Nmero de vias que sero impressas do documento. Exemplo: 2. Arquivo exportado. Nome do arquivo exportado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: ENVIO MT4.XML. Informaes. Quando existe alguma rejeio este campo informa maiores detalhes dessa rejeio. Exemplo: J existe na base de dados o identificador "000000175" para o mesmo CNPJ e modelo informado .

TSS Manager

TSS Manager
Caminho da exportao. Nome do caminho de exportao utilizado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo. Exemplo: \Exportar\rejeitado\04215721000765\

2.2.3 Monitor / Eventos

O Monitor de Eventos monitora todos os eventos enviados pelo TSS para SEFAZ. As informaes do evento so exibidas de acordo com o que foi selecionado e, caso seja escolhido o de Carta de Correo, apresentada a correo enviada para SEFAZ. Os eventos contemplados pelo monitor de eventos so: Carta de Correo. Manifestao do Destinatrio. Em Aes Relacionadas esto disponveis as opes: Visualizar: exibe as informaes do evento enviado de acordo com seu tipo. Histrico: mostra todo o histrico de transmisso do evento como data, hora, status etc. Na tela do sub-menu Eventos tambm esto disponveis as opes: Transmitir: conduz os eventos selecionados que esto com status de aguardando transmisso. Parmetros: permite reconfigurar o filtro do monitor.

2.2.4 Monitor / CL-e

O Monitor de Capa de Lote CL-e monitora todas as capas de lote enviadas. Em Aes Relacionadas esto disponveis as opes: Imprimir: gera em arquivo no formato .pdf o DACLE que o documento fiscal da capa de lote. Parmetros: permite reconfigurar o filtro do monitor. Alterar: altera os dados da capa de lote antes da transmisso. Capas que j foram transmitidas no podem ser alteradas, a no ser, que estejam com algum erro acusado pela SEFAZ. Excluir: cancela a capa de lote que ainda no foi transmitida ou que esteja com erro. Na tela do sub-menu CL-e tambm esto disponveis as opes: Transmitir: conduz as capas selecionadas que esto com status de aguardando transmisso. Visualizar: exibe as informaes da capa de lote selecionada. Dados do carro, carreta, placa, notas que compem a capa e outros.

10

TSS Manager

TSS Manager
2.2.5 Monitor / Manisfesto
O Monitor de Manifestao do Destinatrio permite executar o evento de manifestar as opes Confirmada a Operao, Desconhecimento da Operao, Operao no Realizada e Cincia da Operao nas notas emitidas para seus CNPJs, alm, de monitorar suas manifestaes. Como a manifestao tratada como um evento, deve ser utilizado o Monitor de Eventos disponvel para visualizar o status do que foi enviado para SEFAZ. Em Aes Relacionadas esto disponveis as opes: Manifestar: executa o envio do evento de manifestao para a SEFAZ das notas selecionadas no browse. Parmetros: atravs dos parmetros possvel reconfigurar o filtro do monitor. Sincroniza: sincroniza as notas emitidas para os CNPJs selecionados. Na tela do sub-menu Manifesto tambm esto disponveis as opes: Histrico: visualiza as informaes da manifestao. Baixar Zip: faz o download do XML da nota.

2.3 - Configuraes
O menu Configuraes fornecer uma interface de configurao de entidade e seus parmetros, certificado digital, EDI e outros. Ele est dividido em sub-menus: Entidades. Geral. Central de Notificaes. Toda configurao do produto est abaixo deste menu.

2.3.1 Configuraes - Entidades

Fornece acesso total para manipular a entidade e visualizar informaes como, por exemplo, os dados do certificado que est configurado para ela. Pode ser alterado dados secundrios de seu cadastro como Razo Social, Telefone e outras. Dessa forma, toda configurao de entidade torna-se um processo simples e fcil de ser executado, pois, a interface proporciona um entendimento rpido. Toda entidade que for includa, automaticamente, fica disponvel para acesso no TSS Manager. Em Aes Relacionadas esto disponveis as opes: Status SEFAZ: faz a verificao do status SEFAZ da entidade.

TSS Manager

11

TSS Manager
Alterar: alterar a entidade. Incluir: inclui uma nova entidade. Visualizar: exibe as informaes das entidades. Na tela do sub-menu Entidades tambm esto disponveis as opes: Certificado: exibe os dados do certificado configurado como status e data de validade, emissor e outras. Configurar: permite configurar todos os processos do TSS como verso de NF-e, Capa de Lote, Evento, certificado Digital, TSS Portal, envio de e-mail etc.

As alteraes da configurao de entidade implicam em todo sistema e em qualquer processo que essa entidade estiver envolvida. A configurao da entidade est dividida em: Geral: configura processos como o e-mail utilizado na notificao da SEFAZ, envio de e-mail feito pelo TSS Manager que utiliza o e-mail configurado como remetente e outras aes que podem utilizar esse tipo de comunicao. Tambm, possvel configurar o TSS Portal. Para isso, necessrio colocar a URL de onde o portal est configurado que no momento em que enviado e-mail para o destinatrio da NF-e ele pode acessar o portal e verificar as NF-e emitidas para ele. NF-e: permite configurar o ambiente que a emisso da NF-e est processando, a modalidade, verso, o certificado digital utilizado para a entidade e a verso da contingncia DPEC. Eventos: o evento pode ser configurado tanto na carta de correo quanto na manifestao do destinatrio. As configuraes disponveis so as verses e horrios. Capa de Lote: possui apenas a configurao da verso utilizada. EDI: a configurao do EDI para entidade considera apenas se a impresso feita direto na impressora ou arquivo, seu caminho para o local da impresso e se deve ser feita em frente e verso.

2.3.2 Configuraes / Geral

Configura parmetros que so de utilizao geral do TSS que no tem dependncia com a entidade que est processando. O TSS possui apenas configurao geral para o EDI: Tipo de Integrao: seleciona o tipo de integrao que o EDI deve processar; arquivo XML ou Web Service. Com essa configurao, os JOBs do EDI fazem o tratamento adequado para cada tipo de integrao. Diretrio de Exportao: apresenta o caminho onde os arquivos do EDI so exportados. Eles so o retorno do processamento do arquivo originalmente importado. Diretrio de Importao: apresenta o caminho onde existem os arquivos em que o EDI deve ler e processar o documento.

12

TSS Manager

TSS Manager
Exporta Arquivos em pastas Estruturadas: caso seja selecionada a opo SIM, o EDI exporta os arquivos em pastas separadas (Autorizada e Rejeitada) e dentro de cada uma existem pastas com o CNPJ da entidade processada.

2.3.3 Configuraes - Central de Notificaes

A Central de Notificaes comunica um determinado evento atravs de e-mail. No TSS Manager existem algumas notificaes que podem ser configuradas para ser processadas: Vencimento Certificado Digital: permite configurar a partir de quantos dias, antes da data do vencimento do certificado digital, a Central de Notificaes deve enviar um e-mail para os endereos cadastrados com informaes sobre os dias que restam para o certificado expirar. Tambm possvel enviar e-mail com informaes dos certificados que j esto expirados. Status SEFAZ: permite configurar a SEFAZ, modelo e ambiente desejado para que a Central de Notificaes faa a consulta do status SEFAZ e envie um e-mail. Licena On Demand: permite configurar a partir de quantas licenas On Demand a Central de Notificaes pode enviar e-mail para notificar que a licena est se esgotando. Para configurar a Central de Notificaes so utilizadas as opes: Configurar E-mail: deve ser configurado o servidor de e-mail SMTP que utilizado para fazer a conexo e os dados do e-mail que utilizado para ser o remetente da notificao. Essa configurao obrigatria para utilizar a Central de Notificaes e devem ser preenchidos os campos Servidor SMTP, Conta de e-mail, E-mail e Senha, assim como, marcar as opes necessrias entre Autenticao, Conexo SSL e Conexo TLS. Configurar Notificao: configura a notificao onde informada se est habilitada ou no para o processamento, e-mail do destinatrio, assunto tratado, informaes adicionais, a recorrncia que ser executada e a configurao especfica para a notificao.

A utilizao dessa funcionalidade deixa automtica a notificao de algumas informaes relevantes para o funcionamento do sistema. Para configurar o servio/JOB da Central de Notificaes necessrio colocar no arquivo .ini do server o JOB TSSNOTIFYCENTER.

2.4 - Ferramentas
O menu Ferramentas possui as seguintes funcionalidades: Inutilizar: permite enviar um lote de notas de uma determinada srie para a entidade selecionada. Deve ser informada a justificativa e clicar em Inutilizar para que os dados sejam enviados.

TSS Manager

13

TSS Manager
Toda configurao de inutilizao como verso, ambiente (homologao ou produo) e modalidade so considerados da entidade selecionada. Para alterar a configurao dessa entidade conforme desejado, necessrio clicar na prpria tela e em Parmetros. Status SEFAZ: possibilita a verificao do status de qualquer SEFAZ desejada, tanto de NF-e quanto de CT-e. Alem disso, possvel visualizar as URLs utilizadas pelo TSS para a comunicao com a SEFAZ e, tambm, um link rpido para o portal da NF-e ou do CT-e na internet. Consulta Chave: permite consultar qualquer chave de NF-e emitida para a entidade selecionada. Essa funcionalidade faz a consulta na SEFAZ e retorna informaes tal como status da SEFAZ, motivo, Protocolo etc.

2.5 - Sobre
Ao acionar essa funcionalidade, aberta uma tela com informaes de verso do TSS, build do binrio, Sistema Operacional, Nmero do Hardlock e se o License Server est ativo.

exibida uma tela com informaes e um link que direciona para a Documentao do produto e a comunidade da rea responsvel pelo produto na rede social da TOTVS, o By You.

3 - EDI
O EDI um canal de comunicao que visa a integrao de qualquer sistema com o TSS. Dessa forma, qualquer ERP pode emitir documentos eletrnicos como Nota Fiscal Eletrnica, Eventos da SEFAZ, Nota Fiscal de Servio, Capa de Lote e Conhecimento de Transporte. Os Jobs que devem ser adicionados no INI para utilizao do EDI esto descritos no item Configurao do EDI. Para que a integrao ocorra, o EDI do TSS Manager deve receber o documento que pode ser disponibilizado de algumas formas: Arquivo XML. Web Service. Os processos que compem o EDI so: Importao. Transmisso. Exportao. Impresso.

14

TSS Manager

TSS Manager
FLUXO DE PROCESSAMENTO DO EDI
Aps a importao com sucesso pelo EDI, o arquivo transmitido para que o TSS processe o documento eletronicamente, enquanto isso, o processo de Exportao verifica se o arquivo transmitido j tem um retorno para ser exportado. A impresso feita apenas quando o documento enviado est autorizado para uso. Exemplo: NF-e foi autorizada na SEFAZ.

Toda configurao do EDI deve ser feita atravs da interface do TSS Manager em dois locais. Configuraes / Geral Configuraes / Entidades. Selecione a opo Configurar e, em seguida, a pasta de EDI (essa configurao deve ser entidade por entidade).

Importao

Transmisso

Exportao

Impresso
A impresso feita no processo paralelo com a exportao, pois, feita a verificao do status do documento para que seja impresso assim como a exportao.

Documentos Contemplados pelo EDI

Os documentos atendidos pelo TSS Manager na integrao feita atravs do EDI so: Nota Fiscal Eletrnica: o leiaute do documento a ser enviado deve ser o mesmo padro da SEFAZ. o Envio. o Cancelamento. o Inutilizao. Carta de Correo: o leiaute do documento a ser enviado deve ser conforme descrito no item Leiaute XML dos documentos. Capa de lote eletrnica: o leiaute do documento a ser enviado deve ser conforme descrito no item Leiaute XML dos documentos.

Arquivo XML
A integrao com arquivo XML acontece quando o sistema cria o arquivo em uma pasta configurada para leitura que feita atravs de processos do EDI. Esse XML tem um leiaute padro disponibilizado pela TOTVS.

TSS Manager

15

TSS Manager
Quando o processo verifica a existncia de um ou mais arquivos, ele automaticamente importa para o TSS Manager com o objetivo de comear o processo de integrao e envio do documento. O retorno desse processamento ocorre no momento em que o EDI gera um arquivo de exportao, tambm, com um leiaute definido pela TOTVS em uma pasta configurada para exportao, assim, o sistema pode ler o arquivo exportado e alimentar sua base com as informaes deste retorno.

Web Service
A integrao do EDI via Web Service a melhor, segura e mais rpida forma de enviar os documentos de um sistema para o TSS Manager processar o documento. Para isso, necessrio que o sistema utilizado para controlar o envio dos documentos seja preparado para integrar com o Web Service do EDI, de acordo com o seguinte padro: Web Service: TSSManagerEDI. Esse o Web Service responsvel pela integrao do sistema com o EDI do TSS Manager. Mtodos: SendMessageEDI Este mtodo deve ser utilizado para que seja enviado ao TSS Manager EDI o documento que ser processado e enviado eletronicamente.

Estrutura: Parmetros de entrada: <SENDMESSAGEEDI> <USERTOKEN>Alfanumrico</USERTOKEN> <MESSAGES> <MESSAGES> <!--Zero or more repetitions:--> <MESSAGE> <ID>Alfanumrico</ID> <XML>Base64</XML> </MESSAGE> </MESSAGES> </MESSAGES> </SENDMESSAGEEDI>

16

TSS Manager

TSS Manager
Parmetro USERTOKEN Tipo Alfanumrico Tam 006 Pai SENDMESSAGEEDI Observao Token de bilhetagem para execuo do servio. Tag Raiz das mensagens. Tag Raiz da Mensagem. ID de identificao da mensagem. Utilizado apenas para controle do envio e retorno da mensagem (no gravada na base de dados). XML com o documento a ser importado no EDI (Verificar item Leiaute XML EDI deste documento).

MESSAGES MESSAGE

Tag Raiz Tag Raiz

---

SENDMESSAGEEDI MESSAGES

ID

Alfanumrico

unbouded

MESSAGE

XML

Base64

1-500KB

MESSAGE

O elemento ID utilizado apenas para controle do envio e retorno da requisio, dessa forma, no feito nenhum controle por parte do EDI que, simplesmente, o devolve juntamente com as demais informaes no retorno do mtodo. Parmetros de sada: <SENDMESSAGEEDIRESPONSE> <SENDMESSAGEEDIRESULT> <DOCS> <DETDOC> <CODE>Numeric</CODE> <ID>AlfaNumerico</ID> <MESSAGE>AlfaNumerico</MESSAGE> <RESULT>Boolean</RESULT> </DETDOC> </DOCS> </SENDMESSAGEEDIRESULT> </SENDMESSAGEEDIRESPONSE>

TSS Manager

17

TSS Manager

Parmetro
DOCS

Tipo
Tag Raiz

Tam
--

Pai
SENDMESSAGEEDIRESU LT DOCS

Observao
Retorno dos documentos. Informaes do processamento do documento. Cdigo de retorno do processamento de gravao do arquivo. ID de Identificao da mensagem. Descrio do cdigo de retorno. Resultado lgico do processamento: True =gravado com sucesso. False=gravao no realizada, documento rejeitado.

DETDOC

Tag Raiz

--

CODE

Numrico

02

DETDOC

ID MESSAGE

Alfanumrico Alfanumrico

unbouded 0-250

DETDOC DETDOC

RESULT

Boolean

3-5

DETDOC

ReceiveDocEDI Este mtodo retorna os documentos que j podem ser exportados para o sistema e que ainda no foram aprovados pelo mtodo de confirmao do Web Service. Estrutura: Parmetros de entrada: <RECEIVEDOCEDI> <USERTOKEN>Alfanumrico</USERTOKEN> <CPFCNPJ>Numrico</CPFCNPJ> <MODELO>Alfanumrico</MODELO> <MAXRET>Numrico</MAXRET> </RECEIVEDOCEDI>

18

TSS Manager

TSS Manager

Parmetro USERTOKEN

Tipo Alfanumrico

Tam 006

Pai RECEIVEDOCEDI

Observao Token de bilhetagem para execuo do servio. CPF/CNPJ do remetente do documento ao EDI. Modelo do documento: 55=nfe.

CPFCNPJ

Numrico

11-14

RECEIVEDOCEDI

MODELO

Alfanumrico

02

RECEIVEDOCEDI

110110=Carta de Correo
Cle=Capa de Lote

MAXRET

Numrico

unbouded

RECEIVEDOCEDI

Nmero mximo de documentos que devem ser retornados na solicitao.

O parmetro MAXRET opcional, porm, recomendada sua utilizao para melhorar a performance ou at uma possvel perda do retorno dependendo do volume de notas regressadas.

Parmetros de sada: <SENDMESSAGEEDIRESPONSE> <RECEIVEDOCEDIRESULT> <RETDOCS> <RETDETDOC> <IDENTIFICACAO>000000004</IDENTIFICACAO> <XML>String</XML> </RETDETDOC> </RETDOCS> </RECEIVEDOCEDIRESULT> </SENDMESSAGEEDIRESPONSE>

TSS Manager

19

TSS Manager

Parmetro RETDOCS RETDETDOC IDENTIFICACAO

Tipo Tag Raiz Tag Raiz String

Tam --50

Pai RECEIVEDOCEDIRESULT RETDOCS RETDETDOC

Observao Documentos retornados. Dados do documento. Identificao do documento. XML de retorno com o documento importado no EDI (Verificar item Leiaute XML EDI deste documento).

XML

Base64

1-500KB

RETDETDOC

ConfirmDocEDI Confirma que o sistema recebeu do mtodo de retorno do EDI do documento e que no precisa mais ser retornado. Caso o documento no seja confirmado, toda vez que for utilizado o mtodo de retorno o documento retornado mesmo que o sistema j o tenha recebido anteriormente.

Estrutura: Parmetros de entrada: <CONFIRMDOCEDI> <USERTOKEN>Alfanumrico</spod:USERTOKEN> <CPFCNPJ>Numrico</CPFCNPJ> <MODELO>Alfanumrico</spod:MODELO> <CONFIRM> <CONFIRMDOC> <!--Zero or more repetitions:--> <CONFIRMDOC> <IDENTIFICACAO>Alfanumrico</IDENTIFICACAO> </CONFIRMDOC> </CONFIRMDOC> </CONFIRM> </CONFIRMDOCEDI>

20

TSS Manager

TSS Manager
Parmetro USERTOKEN Tipo Alfanumrico Tam 006 Pai CONFIRMDOCEDI Observao Token de bilhetagem para execuo do servio. CPF/CNPJ do remetente do documento ao EDI. Modelo do documento: 55=nfe. MODELO Alfanumrico 02 CONFIRMDOCEDI 110110=Carta de Correo. Cle=Capa de Lote CONFIRM Tag Raiz -CONFIRMDOCEDI Documentos que devem ser confirmados. Tag com as informaes do documento que deve ser confirmado. Identificao do documento.

CPFCNPJ

Numrico

11-14

CONFIRMDOCEDI

CONFIRMDOC

Tag Raiz

--

CONFIRM

IDENTIFICACAO

Alfanumrico

50

CONFIRM

Parmetros de sada: <CONFIRMDOCEDIRESPONSE> <CONFIRMDOCEDIRESULT> <RETCONFIRMDOC> <RETCONFIRMDOC> <CONFIRM>Boolean</CONFIRM> <IDENTIFICACAO>String</IDENTIFICACAO> </RETCONFIRMDOC> </RETCONFIRMDOC> </CONFIRMDOCEDIRESULT> </CONFIRMDOCEDIRESPONSE>

TSS Manager

21

TSS Manager

Parmetro
RETCONFIRMDOC

Tipo
Tag Raiz

Tam
--

Pai
CONFIRMDOCEDIRESULT

Observao
Documentos enviados na solicitao. Resultado da confirmao: True=realizada a confirmao do recebimento. False=confirmao no realizada.

CONFIRM

Tag Raiz

--

IDENTIFICACAO

String

50

RETDETDOC

Identificao do documento.

3.1 EDI - Importao

O processo de importao a primeira frente de entrada do EDI. Este processo faz as primeiras validaes como estrutura do XML, validao de schema, existncia da empresa na base de dados etc. Este JOB nico e pode ter apenas um servio no ar processando para evitar concorrncia de processamento. Aps feita toda a validao, caso todas as informaes estejam corretas, marcado um flag no registro que foi importado informando que ele est apto para ser transmitido. No caso de ter uma rejeio na importao, esse registro importado exportado com a mensagem ou motivo da rejeio.

FLUXO

ERP
Gera arquivo na pasta para importao

EDI
Efetua a leitura do arquivo e o importa

22

TSS Manager

TSS Manager

3.2 EDI - Transmisso

A transmisso o processo responsvel pelo envio ao TSS dos documentos vlidos importados. O processo de transmisso pode ser parametrizado por entidade, sendo assim possvel que um server de processamento rode apenas uma determinada entidade ou at um range de entidade.

Essa parametrizao deve ser feita no arquivo de configurao do server .ini. Para todo o processo do EDI possvel realizar a parametrizao das entidades. No arquivo de configurao do server .ini necessrio adicionar a seguinte informao: TSSENTEDI=000001-000009

EDI
Faz a transmisso para o TSS do documento importado

TSS
Processa o documento enviando para o rgo responsvel

3.3 EDI - Exportao

O processo de exportao a resposta do processamento ao sistema que enviou o documento. No caso do arquivo XML em disco, o processo seleciona o registro que est na base e gera um arquivo XML na pasta designada na configurao feita no TSS Manager. Esse arquivo tem um leiaute padro definido pela TOTVS. Assim que gerado o arquivo exportado nessa pasta, o sistema deve ler este arquivo para ento importar as informaes para dentro de sua base e, assim, atualizar as informaes do processo.

TSS Manager

23

TSS Manager

TSS
Retorna o contedo do processamento do documento

EDI
Faz a leitura da resposta do processamento e exporta

ERP
Busca o retorno exportado pelo EDI para inserir os dados na base

3.4 EDI - Impresso

A impresso pode ser realizada apenas para os documentos autorizados e necessrio informar a quantidade de vias que devem ser impressas. O documento selecionado poder ser impresso direto na impressora ou solicitado para ser gerado um arquivo .PDF, conforme a configurao do TSS Manager.

EDI
Faz a impresso do documento na impressora ou em arquivo de acordo com o configurado

3.5 Configurao do EDI

A configurao dos servios do EDI feito de maneira simples. Para isso, deve ser criado no arquivo de configurao do server .ini os JOBS do EDI.

24

TSS Manager

TSS Manager

Em situaes que apresentam muitas entidades para processarem um volume muito alto de documentos, pode ser adicionado outro server para rodar o mesmo servio, porm, o Job de Importao deve estar operacional apenas em um Server. Exemplo: uma empresa emite por dia 10.000 documentos eletrnicos de uma nica entidade. Podem ser criados dois servers com o mesmo JOB/Servio rodando para que o processamento seja mais dinmico, sempre lembrando que para o processo de importao essa operao no pode ser executada.

JOBS/SERVIOS A integrao de arquivos pelo TSS Manger EDI realizada atravs de servios (JOBS) e cada um deles com sua finalidade: TSSEDIImp: job responsvel pela importao e validao dos arquivos que devem ser processados. Assim que iniciado, ele importa para o TSS Manager EDI os arquivos disponibilizados no diretrio de importao pela aplicao do cliente, conforme configurado. O processamento de importao est dividido em duas etapas: 1) Gravao: nenhuma validao realizada, simplesmente, feita a gravao do arquivo na base de dados do TSS Manager. 2) Validao: aps a gravao realizada a validao da estrutura do arquivo e nas informaes importantes para realizao do processamento como, por exemplo, o CNPJ que deve ter o seu cadastro habilitado na base do TSS Manager EDI, caso contrrio, imediatamente rejeitado e disponibilizado na pasta de arquivos exportados pelo job de exportao. TSSEDITrans: job responsvel pela transmisso do arquivo importado para a fila de processamento. Caso sejam encontradas inconsistncias de informaes no documento, o arquivo rejeitado e transferido para o diretrio de exportao. TSSEDIExp: job responsvel pela exportao dos arquivos processados. TSSEDIPrt: job responsvel pela impresso dos documentos autorizados.

Os documentos so processados apenas atravs dos servios descritos. Dessa forma, imprescindvel que suas configuraes sejam feitas.

3.6 Leiaute XML EDI

Para que o documento seja enviado para o EDI process-lo necessrio seguir um leiaute de XML, de maneira que, o retorno tambm contempla um leiaute prprio.

XML de Envio
Estrutura de schema: TSS Manager
25

TSS Manager

<tssedienvio> <emissor> <cpfcnpj> <prioridade> <modelo> <tipo> <prtvias> <xml> <identificacao> <inutilizar> <serie> <numero>

XML que deve ser validado: # 1 Nome tssedienvio Tipo tctssedienvio Pai Ocorrncia 1-1 Observao

26

TSS Manager

TSS Manager
Formatos padres utilizados: Formato Observao Formato: AAAA-MM-DD, onde: AAAA = ano com 4 caracteres. Date (date) MM = ms com 2 caracteres. DD = dia com 2 caracteres. Formato AAAA-MM-DDTHH:mm:SS, onde: AAAA = ano com 4 caracteres. MM = ms com 2 caracteres. DD = dia com 2 caracteres. Data / Hora (datetime) T = separando a data da hora. HH = Hora com 2 Caracteres. mm = minuto com 2 caracteres. SS = segundos com 2 caracteres. 1. Tipos Simples Tabela com a lista dos tipos simples que so utilizados como tipos de dados. Est dividida em 4 colunas: Campo: nome do tipo simples. Tipo: tipo primitivo de dados utilizados pelo campo: o C: Caractere. o N: Nmero. Descrio: apresenta informaes sobre o campo. Tam.: tamanho do campo: o Quando for caracteres o tamanho define a quantidade mxima de caracteres que o texto pode ter. o Quando for numrico o tamanho pode ser representado das seguintes formas: Nmero inteiro: define o total de dgitos existente no nmero. Exemplo: 15 significa que nmero pode ter, no mximo, 15 dgitos. Nmero fracionrio: define o total de dgitos e quantos deles so designados para a parte fracionria. Exemplo: 15,2 significa que o nmero pode ter, no mximo, 15 dgitos sendo 2 dele s a identificao da parte fracionria. A parte fracionria no obrigatria quando assim definido. o Quando for data, no h definio de tamanho. Leiaute com as validaes dos Tipos Simples e Complexos:

TSS Manager

27

TSS Manager

Tipos Simples Nome tsprioridade Tipo N Descrio Prioridade de processamento do documento: 0 Normal 1 Alta Modelo do documento que est sendo processado: 55 Nota Fiscal Eletrnica. 56 Nota Fiscal de Servio Eletrnica. 57 Conhecimento de Transporte Eletrnico. 110110 Carta de Correo Eletrnica. CLE Capa de Lote Eletrnica. Tipo do processamento: 1 Remessa. 2 Cancelamento. 3 Substituio (NFS-e). tsprtvias tsxml tsidentificacao tsserie tsnumero tscpfcnpj N C C C N C Nmero de vias de impresso do documento autorizado. XML do documento. Identificao de controle do usurio. Srie do documento. Nmero do documento. CPF/CNPJ. 2 400KB 50 3 9 14 Tamanho 1

tsmodelo

tstipo

2. Tipos Complexos A seguir sero detalhadas as tabelas de cada tipo composto e seus campos. A tabela est dividida da seguinte forma: (1) (2) Nome
(4) (3) (4) (5) (6) (7)

Tipo
(5)

Ocorrncia
(6)

Descrio
(7)

1) Nome do tipo complexo. 2) Descrio do tipo complexo. 3) Identifica se a sequencia de campos faz parte de uma escolha (Choice). No utilizado neste Layout. 4) Nome do campo que faz parte do tipo complexo. 5) Tipo do campo (pode ser um tipo simples ou complexo). 6) Quantas vezes o campo se repete na estrutura de dados:
28

TSS Manager

TSS Manager
Formato: x-y onde x a quantidade mnima e y a quantidade mxima. Se a quantidade mxima for indefinida, ser utilizado N no lugar do y; 7) Descrio do campo. tctssedienvio (uma nica ocorrncia) Nome emissor prioridade modelo tipo Tipo tcemissor tsprioridade tsmodelo tstipo Ocorrncia 1-1 1-1 1-1 1-1 Descrio Agrupa informaes sobre o emissor do documento. Indica se o arquivo ter prioridade no processamento. Modelo do documento contido no arquivo. Indica o tipo de processamento a ser realizado. Nmero de vias que ser impresso do documento contido pelo processamento da impresso automtica. XML do documento contido. Identificao de controle do usurio. Informaes sobre uma inutilizao.

prtvias

tsprtvias

1-1

xml identificacao inutilizar

tsxml tsidentificacao tcinutilizar

1-1 1-1 0-1

tcemissor (uma nica ocorrncia) Nome cpfcnpj Tipo tscpfcnpj Ocorrncia 1-1 Descrio CPF/CNPJ do emissor do documento.

tcinutilizar (uma nica ocorrncia) Nome serie numero Tipo tsserie tsnumero Ocorrncia 1-1 1-1 Descrio Srie a ser inutilizada. Nmero a ser inutilizado.

TSS Manager

29

TSS Manager

Estrutura de tags do XML: Estrutura de tags Nome tssedienvio emissor cpfcnpj prioridade Pai -tssedienvio emissor tssedienvio Tag raz do XML. Tag que agrupar informaes sobre o emissor do documento. CPF/CNPJ do emissor do documento. Prioridade de processamento do documento: 0 Normal. 1 Alta. Modelo do documento que esta sendo processado. 55 Nota Fiscal Eletrnica. 56 Nota Fiscal de Servio Eletrnica. 57 Conhecimento de Transporte Eletrnico. 110110 Carta de Correo Eletrnica. CLE Capa de Lote Eletrnica. Tipo do processamento: 1 Remessa. 2 Cancelamento. 3 Substituio (NFS-e). 4 Inutilizao. prtvias xml identificacao inutilizar serie numero tssedienvio tssedienvio tssedienvio tssedienvio inutilizar inutilizar Nmero de vias de impresso do documento autorizado. XML do documento. Deve ser enviado dentro de uma declarao CDATA. Identificao do sistema gerador do XML. Tag raz de inutilizao. Srie do documento a ser inutilizado. Nmero do documento a ser inutilizado. Descrio

modelo

tssedienvio

tipo

tssedienvio

XML de Retorno
Estrutura de tags do XML:

30

TSS Manager

TSS Manager

<tssediretorno> <cnpj/> <cpf/> <docid/> <docxml/> <retxml/> <status/> <docautorizado/> <descricao/> <detalhe/> <impdata/> <imphora/> <modelo/> <doctipo/> <identificacao/> <inutilizar/> <serie/> <numero/>

TSS Manager

31

TSS Manager

Estrutura de tags Nome tssediretorno cnpj cpf docid docxml retxml status docautorizado descricao detalhe impdata imphora Pai -tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno tssediretorno Tag raz do XML. CNPJ do documento processado. CPF do documento processado. ID do documento processado pelo EDI. XML do documento importado pelo EDI. XML de retorno do documento. Status do documento no EDI. Status da autorizao do documento: 0=No autorizado. 1=autorizado. Descrio do status. Detalhe do status. Data de importao do arquivo no EDI. Hora de importao do arquivo no EDI Modelo do documento processado: 55 Nota Fiscal Eletrnica. 56 Nota Fiscal de Servio Eletrnica. 57 Conhecimento de Transporte Eletrnico. 110110 Carta de Correo Eletrnica. CLE Capa de Lote Eletrnica. Tipo do processamento: 1 Remessa. 2 Cancelamento. 3 Substituio (NFS-e). 4 Inutilizao. identificacao inutilizar serie numero tssediretorno tssediretorno inutilizar inutilizar Identificao do sistema que gerou o arquivo enviado para o EDI. Tag raz de inutilizao. Srie do documento a ser inutilizado. Nmero do documento a ser inutilizado. Descrio

modelo

tssediretorno

doctipo

tssediretorno

32

TSS Manager

TSS Manager

3.6.1 Leiaute XML dos documentos

O XML do documento o XML que ser enviado na tag <XML> contida na estrutura do EDI. Este XML deve ser enviado dentro de uma declarao CDATA. Exemplo: <![CDATA[ xml ]]> CARTA DE CORREO

<envEvento> <eventos> <detEvento> <tpEvento>110110</tpEvento> <chNFe>Chave da NFe com 44 posies</chNFe> <xCorrecao>Correo que ser enviada</xCorrecao> </detEvento> </eventos> </envEvento>

Estrutura de tags Nome envEvento eventos detEvento tpEvento chNFe xCorrecao Pai -envEvento eventos detEvento detEvento detEvento Tag raz do XML. Tipo do evento da carta de correo. 110110. Chave da NF-e com 44 posies que ser enviada a carta de correo. Correo que ser enviada com no mnimo 15 posies. Descrio

TSS Manager

33

TSS Manager

CAPA DE LOTE ELETRNICA <CLe> <transportador> <CNPJ>99999999000191</CNPJ> <xNome>TESTE</xNome> <xFant>TESTE</xFant> </transportador> <mdTransp> <rodoviario> <pVeic>DDF2334</pVeic> <cUFVeic>SP</cUFVeic> </rodoviario> </mdTransp> <cUFOrigem >SC</cUFOrigem> <cUFDestino>SP</cUFDestino> <det> <chvAcesso> 42121253113791001790551110001002301998997692 </chvAcesso> </det> </CLe>

34

TSS Manager

TSS Manager

Estrutura de tags Nome CLe transportador CNPJ xNome xFant Pai -CLe transportador Transportador transportador CLe mdTransp rodoviario rodovirio CLe CLe CLe det Tag raz do XML. Dados do transportador CNPJ do transportador Nome do transportador Nome fantasia do transportador. Modalidade do transporte:
mdTransp

Descrio

rodovirio. outro. Dados do transporte rodovirio Placa do veculo UF do veculo UF de origem da entrega UF de destino da entrega Grupo com as chaves das notas Chave da nota

rodoviario pVeic cUFVeic

cUFOrigem cUFDestino
det

chvAcesso

NOTA FISCAL ELETRNICA Deve ser seguido o manual de integrao da SEFAZ.

TSS Manager

35