Histórico da Página

Reenvia e-mail por documento

(Obrigatório)

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

Objetivo

Disponibilizar uma API com a finalidade de reenviar e-mail de um documento.

(Obrigatório)

Definição da Regra de Negócio

A API será na estrutura WS REST com o nome RestEnvMail e com apenas o método GET, que receberá a mensagem JSON codificada em base64 e chamará a função EnvMailTss() passando a mensagem JSON decodificada.

Através da API de reenviar e-mail por documento, os clientes do TSS poderão reenviar o e-mail do documento.

O envio será para um documento.

O critério para o envio do e-mail será com base nos dados de entrada.

A API terá como retorno verdadeiro, caso envie o e-mail e falso caso não consiga enviar o e-mail.

O consumo da API deverá ser realizado através de mensagens JSON definidas na função EnvMailTss().

O processo de Deserialização de mensagens deverá ser realizado através da função FwJsonDeserialize().

Os códigos de status serão baseados no formato padrão de mensagens HTTP, conforme o link:

https://pt.wikipedia.org/wiki/Lista_de_c%C3%B3digos_de_status_HTTP

Função:EnvMailTss()

Função responsável pela definição da Interface da API retorna xml por documento.

A função EnvMailTss definirá a estrutura da API. A função deverá ser definida em um fonte.prw definido com o mesmo nome da função.

A função EnvMailTss deverá ser implementada apenas como função de interface para a API. Deverá ser totalmente desacoplada de qualquer definição de instrução de processamento, devendo apenas realizar as devidas validações das mensagens. Todo o processamento deverá estar definido em funções auxiliares.

A função EnvMailTss() deverá receber mensagens na estrutura JSON, onde serão convertidas em objeto pela função fwJsonDeserialize().

Caso não haja erro na deserialização de JSON para objeto, será chamada a rotina ValDadosEmail(), passando como parâmetro o objeto.

A função ValDadosEmail () retornará verdadeiro caso envie o e-mail e falso caso não consiga enviar o e-mail. Essa informação será passada como parâmetro na chamada da função getJSONResp() junto com o código de status e mensagem de erro (caso exista). O retorno da função getJSONResp() é a mensagem  já na estrutura JSON.

Todos os parâmetros da mensagem serão obrigatórios.

A rotina EnvMailTss() será finalizada e como retorno será passado a mensagem na estrutura JSON.

Parâmetros: 

Mensagem Json:

{

"empresa":

{"Entidade": "000002"},

 "tipdoc":"nfe",

 "parametros":{"docid":"000001"}

}

Retorno:

Retornará uma estrutura jSon, conforme exemplo:

Retorno negativo -

{

  "result":

   {

    "retproc": ""

   },

  "error": "Estrutura do objeto inválida."

}

Retorno positivo –

{

  "result": "T", //ou "F"

  "error": ""

}

Função: ValDadosEmail()

A função ValDadosEmail() receberá como parâmetro o objeto da requisição, validará todos os campos quanto a obrigatoriedade, tamanho e tipo de dados. Se algum dado estiver inconsistente, deverá retorna a mensagem de validação correspondente informando.

Os dados contidos no objeto recebido como parâmetro, serão validados afim de identificar quais foram preenchidos, todos os campos são necessários para o retorno.

A função validará o tipo de documento, afim de identificar se é válida, esta informação estará contida dentro do objeto recebido como parâmetro.

Com as informações tipo de documento e número da entidade, será chamada a função PrepEnvMail(), para essa função serão passados como parâmetros: o número da entidade do cliente, o tipo de documento, número do documento e série do documento. O retorno desta função será verdadeiro caso consiga enviar o e-mail ou falso caso não consiga enviar o e-mail.

Após obter o retorno da rotina PrepEnvMail (), a função ValDadosEmail () será encerrada, retornando verdadeiro ou falso.

Parâmetros: 

GetXml(oDados,cError)

oDados – Objeto contendo as informações da requisição: entidade, Nfe_Id e série do documento.

cError – Mensagem de erro, caso exista.

Retorno:

lOk – Verdadeiro caso consiga enviar o e-mail e falso caso não consiga enviar o e-mail.

Função: PrepEnvMail()

A função receberá como parâmetro, a entidade do cliente, o tipo de documento, Nfe_Id, mensagem de erro e código do status.

Hoje o TSS só envia e-mail quando o tipo de documento for “NFE”, caso contrário não enviará o e-mail.

A função por meio de Query, localizará o documento na tabela correspondente, obtendo o RECNO do registro, este RECNO será passado como parâmetro para as funções: TSSSendNfE caso o tipo de documento esteja na SPED050 e TSSSendNfS caso o tipo de documento esteja na SPED051.

Parâmetros: 

(cEnt,cTipo,cDoc,cSerie,cError)

cEnt – Código da entidade do cliente.

cTipo – Tipo de documento: ‘NFE’;’NFSE’, etc.

cDoc – Nfe_Id.// Série + número do documento

cError – Mensagem de erro, caso exista.

Retorno:

lRet - Verdadeiro caso consiga enviar o e-mail e falso caso não consiga enviar o e-mail.

Função: TSSSendNFe()

A função receberá como parâmetro, o RECNO do registro da tabela SPED050.

A função validará os dados do documento.

A rotina busca os anexos para o e-mail, .pdf e .xml.

Após obter os anexos, a rotina chamará a função NFeSendMail, passando como parâmetro o RECNO do registro na SPED050, o assunto do e-mail, arquivo .xml e arquivo .pdf, o seu retorno será lógico.

A rotina TSSSendNFE retornará verdadeiro, caso não consiga enviar o e-mail, a rotina retornará falso.

Parâmetros: 

cRECNO – Número RECNO do registro na tabela SPED050.

Retorno:

lRet - Verdadeiro caso consiga enviar o e-mail e falso caso não consiga enviar o e-mail.

Função: NFESendMail()

A função receberá como parâmetro, o RECNO do registro na SPED050, o assunto do e-mail, arquivo .xml e arquivo .pdf.

A função validará os dados do documento.

Após validar os dados a função chamará a rotina SMTPConnecte. Com o retorno desta rotina, a função NFeSendMail validará se o e-mail foi enviado ou não.

Se o e-mail foi enviado a função NFeSendMail retornará verdadeiro, se o e-mail não for enviado, a função retornará falso.

Parâmetros: 

nRECNO – Número RECNO do registro na tabela SPED050.

cAssunto – Assunto do e-mail

cAnexo – caminho mais nome do arquivo .xml

cAnexo2 – caminho mais nome do arquivo .pdf

Retorno:

lRet - Verdadeiro caso consiga enviar o e-mail e falso caso não consiga enviar o e-mail.

Função: GetJSONResp()

A rotina consiste em obter os dados de entrada e gerar a mensagem em estrutura JSON.

A rotina retornará uma string na estrutura JSON

Parâmetros: 

cHttpStatus – Código do Status.

lOk – Variável lógica.

cError – Mensagem de erro.

Retorno:

cJSONResponse – String na estrutura JSON.

Opcional

Protótipo de Tela

<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.

Protótipo 01

 Image Removed

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas

Programa

Descrição

(Max 40 posições)

(Max 40 posições)

(Max 40 posições)

Nome Externo

Nome Menu/Programa

(Max 32 posições)

(Max 32 posições)

(Max 32 posições)

Nome Verbalizado[1]

(Max 254 posições)

(Max 254 posições)

(Max 254 posições)

Procedimento

Template

(Verificar lista de opções no man01211)

(Verificar lista de opções no man01211)

(Verificar lista de opções no man01211)

Tipo[2]

Consulta/Manutenção/ Relatório/Tarefas

Consulta/Manutenção/ Relatório/Tarefas

Consulta/Manutenção/ Relatório/Tarefas

Interface

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

Categoria[3]

Executa via RPC

Sim/Não

Sim/Não

Sim/Não

Registro padrão

Sim

Sim

Sim

Outro Produto

Não

Não

Não

Visualiza Menu

Sim/Não

Sim/Não

Sim/Não

Query on-line

Sim/Não

Sim/Não

Sim/Não

.

Sim/Não

Sim/Não

Sim/Não

Sub-Rotina (EMS)

Localização dentro da Sub Rotina (EMS)

Compact[4]

Sim/Não

Sim/Não

Sim/Não

Home[5]

Sim/Não

Sim/Não

Sim/Não

Posição do Portlet[6]

0 – Top Left

1 – Top Right

2 – Bottom Left

3 – Bottom Right

0 – Top Left

1 – Top Right

2 – Bottom Left

3 – Bottom Right

0 – Top Left

1 – Top Right

2 – Bottom Left

3 – Bottom Right

Informar os papeis com os quais o programa deve ser vinculado

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.