especificação tecnica

Upload: juliana-cardoso

Post on 04-Nov-2015

3 views

Category:

Documents


0 download

DESCRIPTION

Exemplo de especificação tecnica referente a processo de integração via web service.

TRANSCRIPT

  • Senior Sistemas

    CONSTRUO DE USE CASE

    www.openport.com.br

    Fone/Fax: (27)3335-0783

    CONSTRUO DE USE CASE:

    Core

    Executar Integrao

    Verso 1.0

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 2 de 8

    HISTRICO DA REVISO

    Data Verso Descrio Autor

    20/04/2015 1.0 Verso Original Wilson Aires

    HISTRICO DA IMPLEMENTAO

    Data Verso Descrio Autor

    20/04/2015 1.0 Verso Original Wilson Aires

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 3 de 8

    NDICE ANALTICO

    1. INTRODUO 4

    2. CONTEXTO 5

    2.1. Identificar Operao 6

    2.2. Validar Credenciais 6

    2.3. Validar XML 6

    2.4. Registrar Execuo da Operao 6

    2.5. Registrar Execuo Destino 6

    2.6. Transformar XML 6

    2.7. Enviar XML 6

    2.8. Gravar Transao 6

    2.9. Finalizar Execuo Destino 6

    2.10. Finalizar Execuo 6

    3. MODELO DE DADOS 7

    4. STATUS 7

    4.1. Status da Execuo 7

    4.2. Status da Entrega 8

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 4 de 8

    1. INTRODUO

    Este documento apresenta o modelo de implementao do servio Executar integrao. Essa uma porta de entrada do

    OPHUB. Atravs deste servio, os sistemas de origem enviam os dados e o OP HUB se encarregar de entreg-los.

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 5 de 8

    2. CONTEXTO

    Para se contextualizar o funcionamento deste caso de uso, importante verificar o diagrama de sequncia apresentado mais

    abaixo:

    Este caso de uso se inicia na invocao do mtodo ExecutarIntegracao, com os seguintes parmetros (j descritos no DUC)

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 6 de 8

    Campo Tipo

    Usuario Usurio criptografado String

    Senha Senha criptografada String

    idOperacao Identificador da operao Int32

    xml Contedo do XML String

    Atravs dele, o sistema far a parte de processamento da chamada para invocar o web service de destino ou retornar a

    mensagem de erro mais adequada. Abaixo seguem os passos

    2.1. Identificar Operao

    Nesse mtodo, o sistema dever realizar a consulta na tabela de operaes (OPHUB_OPERACAO) para identificar o

    servio atravs do Id informado. Ser necessrio trazer os dados da Origem e os Destinos da Integrao. Caso o Id operao

    no seja encontrado, o sistema dever devolver uma mensagem de erro com cdigo 1001.

    2.2. Validar Credenciais

    Com os dados da origem, o sistema dever descriptografar o usurio e a senha utilizando o algoritmo padro e a chave do

    sistema. Caso os dados no coincidam ou no seja possvel descriptografar os dados, o sistema dever devolver uma

    mensagem de erro com cdigo 1002.

    2.3. Validar XML

    Nesse mtodo o sistema dever validar o XML de acordo com o XSD cadastrado para a Operao (obter o XSD na tabela

    especfica). Caso o XML no seja vlido, o sistema dever devolver uma mensagem de erro com o cdigo 1003 e os

    detalhes do problema encontrado.

    2.4. Registrar Execuo da Operao

    Nesse mtodo o sistema dever criar um objeto da classe Execucao. Ele precisa ser persistido nesse momento. A data inicial

    o momento da criao da classe

    2.5. Registrar Execuo Destino

    Nesse mtodo, o sistema dever criar um objeto da classe ExecucaoDestino. Ele no precisa ser persistido nesse momento.

    A data inicial o momento da criao da classe.

    2.6. Transformar XML

    Nesse mtodo, o sistema verificar se existem transformaes a serem aplicadas no XML, afim de acrescentar ou modificar

    alguma informao.

    2.7. Enviar XML

    Nesse mtodo o sistema far a chamada ao web service de destino, passando o XML transformado pelo passo anterior. Caso

    ocorra alguma execeo nesse mtodo , o sistema dever devolver uma mensagem de erro com o cdigo 1000.

    2.8. Gravar Transao

    Nesse mtodo o sistema invocar a classe responsvel por gravar aquela transao em banco de dados. Caso ocorra alguma

    exceo nesse mtodo, o sistema dever devolver uma mensagem de erro com o cdigo 2000.

    2.9. Finalizar Execuo Destino

    Nesse mtodo, o sistema dever atualizar a data de trmino da execuo destino e persisti-la no banco de dados

    2.10. Finalizar Execuo

    Nesse mtodo, o sistema dever atualizar a data de trmino da execuo e registrar xml de retorno.

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 7 de 8

    3. MODELO DE DADOS

    4. STATUS

    Existem duas tabelas para controle de status:

    4.1. Status da Execuo

    O status da execuo controla o processo inteiro. Uma execuo s pode ter status completa quando todos os XMLs forem

    entregues aos destinos.

    Cdigo Descrio Detalhes

    1 Executada Todos os XMLs foram entregues nos destinos com sucesso

    2 Em Execuo A integrao est sendo executada

    1000 XML no Entregue O XML no foi entregue um ou mais destinos e a integrao foi

    interrompida. Ao retornar esse status, entende-se que o OP HUB j

    esgotou todas as tentativas de entregar o XML

    1001 Operao invlida A operao passada na chamada ao servio no est cadastrada no

    OP HUB

    1002 Credenciais invlidas As credenciais (usurio e senha) no coincidem com as cadastradas

  • INTEGRAO OP HUB Core

    01.01 - Executar Integrao

    www.senior-rj.com.br Fone/Fax: (21) 3077-6800 Pgina 8 de 8

    no OP HUB para o sistema que a origem da operao passada

    1003 XML Invlido O OP HUB identificou um erro ao realizar a validao do XML com

    o XSD cadastrado para a operao

    1004 Problema ao gravar dados Transacionais O OP HUB no conseguiu gravar os dados transacionais passados

    como parmetro dentro do XML

    4.2. Status da Entrega

    O status da entrega controla cada entrega individualmente.

    Cdigo Descrio Detalhes

    1 Entregue A entrega foi realizada com sucesso

    2 Aguardando Nova Tentativa A entrega no pode ser realizada e o sistema tentar novamente

    1000 Erro Todas as tentativas foram esgotadas