Você está na página 1de 15

ESPECIFICAÇÃO TÉCNICA DE SERVIÇO

(PERFIL DO SERVIÇO)

Portaria

PortariaService
Entidade

Versão 0.1
10/09/2015

Projeto: Implantação SOA TJSC Emissão: 10/09/2015 Arquivo: 527530944.docx 1/15


Contrato 048/2015 - OS 06/2015
Projeto: Implantação SOA TJSC Emissão: 10/09/2015 Arquivo: 527530944.docx 2/15
Contrato 048/2015 - OS 06/2015
HISTÓRICO DE REVISÃO
Data Versão Descrição Autores
10/09/2015 0.1 Versão de análise do Perfil de Ricardo S. Puttini
Serviço Valéria Guimarães
SUMÁRIO

1 INTRODUÇÃO..............................................................................................................................................5
1.1 OBJETIVO...............................................................................................................................................5
1.2 ESCOPO DO DOCUMENTO.....................................................................................................................5
1.3 REFERÊNCIAS........................................................................................................................................5
2 PORTARIASERVICE V1R0........................................................................................................................6
2.1 IDENTIFICAÇÃO DO SERVIÇO.................................................................................................................6
2.2 ESPECIFICAÇÃO TÉCNICA.....................................................................................................................6
2.2.1 Contexto Funcional........................................................................................................................6
2.2.2 Capacidades do Serviço...............................................................................................................6
2.2.3 Tipologia..........................................................................................................................................6
2.2.4 Contrato...........................................................................................................................................7
2.2.5 Descrição da Lógica (opcional)...................................................................................................7
2.2.6 Estruturas de Dados......................................................................................................................7
2.2.7 Regras de Negócio (opcional).....................................................................................................7
2.2.8 Segurança.......................................................................................................................................7
2.2.9 Políticas de Uso.............................................................................................................................7
2.2.10 SLA..............................................................................................................................................7
2.2.11 Especificações Adicionais (Não Funcionais) (opcional).....................................................7
2.2.12 Arquitetura do Serviço..............................................................................................................8
2.2.13 Configuração do Serviço (Implantação)................................................................................8
2.2.14 Dependências............................................................................................................................8
2.2.15 Tecnologias de Implementação..............................................................................................8
2.3 GOVERNANÇA........................................................................................................................................8
2.3.1 Guardião..........................................................................................................................................8
2.3.2 Desenvolvedores...........................................................................................................................8
2.3.3 Contratos Concorrentes................................................................................................................8
2.3.4 Histórico de Versões.....................................................................................................................8
2.3.5 Consumidores Conhecidos..........................................................................................................8
3 CAPACIDADES............................................................................................................................................9
3.1 CONSULTAR............................................................................................................................................9
3.1.1 Identificação.....................................................................................................................................9
3.1.2 Entrada.............................................................................................................................................9
3.1.3 Tipo de Retorno................................................................................................................................9
3.1.4 Saída.................................................................................................................................................9
3.1.5 Descrição da Lógica (opcional).......................................................................................................9
3.1.6 Versão (opcional).............................................................................................................................9
3.2 PESQUISAR...........................................................................................................................................10
3.2.1 Identificação...................................................................................................................................10
3.2.2 Entrada...........................................................................................................................................10
3.2.3 Tipo de Retorno..............................................................................................................................10
3.2.4 Saída...............................................................................................................................................10
3.2.5 Descrição da Lógica (opcional).....................................................................................................10
3.2.6 Versão (opcional)...........................................................................................................................10
3.3 INSERIR.................................................................................................................................................11
3.3.1 Identificação...................................................................................................................................11
3.3.2 Entrada...........................................................................................................................................11
3.3.3 Tipo de Retorno..............................................................................................................................11
3.3.4 Saída...............................................................................................................................................11
3.3.5 Descrição da Lógica (opcional).....................................................................................................11
3.3.6 Versão (opcional)...........................................................................................................................11
3.4 ALTERARDATAPUBLICACAO.................................................................................................................12
3.4.1 Identificação...................................................................................................................................12
3.4.2 Entrada...........................................................................................................................................12
3.4.3 Tipo de Retorno..............................................................................................................................12
3.4.4 Saída...............................................................................................................................................12
3.4.5 Descrição da Lógica (opcional).....................................................................................................12
3.4.6 Versão (opcional)...........................................................................................................................12
3.5 ALTERARPORTARIA..............................................................................................................................13
3.5.1 Identificação...................................................................................................................................13
3.5.2 Entrada...........................................................................................................................................13
3.5.3 Tipo de Retorno..............................................................................................................................13
3.5.4 Saída...............................................................................................................................................13
3.5.5 Descrição da Lógica (opcional).....................................................................................................13
3.5.6 Versão (opcional)...........................................................................................................................13
4 ANEXOS......................................................................................................................................................14
1 Introdução

1.1 Objetivo
Descrever o serviço de entidade PortariaService. Este serviço controla as
informações de Portarias elaboradas e publicadas.

1.2 Escopo do Documento


Nesta versão, a especificação contém os resultados da Análise Orientada a Serviço
e do Projeto Orientado a Serviço (contrato), para uso no projeto de arquitetura e
implementação do serviço. O escopo atual do serviço inclui apenas capacidades
relacionadas à publicação de portarias no contexto do Projeto COMAGIS.

1.3 Referências
- Modelo de Processo de Negócio e Modelo de Informação, Projeto COMAGIS, v2.0
de 19/08/2015.

- Modelo de Candidatos a Serviços (modelo BPMN2.0), Projeto COMAGIS, de


10/09/2015.

- Candidatos a Serviços, Projeto COMAGIS, v1.1 de 14/09/2015.


2 PortariaService v1r0

2.1 Identificação do Serviço


Nome PortariaService
Inventário / Domínio TJSC / COMAGIS
Modelo do Serviço Entidade
Descrição Serviço de Entidade Portaria.
Propósito Controlar informações acerca de portarias, sua elaboração
e publicação.
Palavras-chaves Portaria
Versão v1r0
Status do Serviço Projeto
Data de Entrega 31/10/2015

2.2 Especificação Técnica


2.2.1 Contexto Funcional
Uma portaria é um documento de ato jurídico que contém ordens, instruções acerca
da aplicação de leis ou regulamentos, recomendações de caráter geral e normas
sobre a execução de serviços, a fim de esclarecer ou informar sobre atos ou eventos
realizados internamente em órgão público, tal como nomeações, demissões,
medidas de ordem disciplinar, afastamentos, designações, ou qualquer outra
determinação da competência da autoridade emitente.

2.2.2 Capacidades do Serviço

Capacidade Descrição Status


consultar Consultar uma portaria existente. Projeto
Pesquisar portarias existentes, por Projeto
pesquisar prefixo e ano.
inserir Inserir (registrar) uma nova portaria. Projeto
Alterar a data de publicação no Diário Projeto
alterarDataPublicacao Oficial.
Inserir uma nova portaria alterando Projeto
alterarPortaria uma portaria anterior.

2.2.3 Tipologia
Web Service (SOAP)
2.2.4 Contrato
wsdl/PortariaService_v1r0.wsdl

2.2.5 Descrição da Lógica (opcional)

2.2.6 Estruturas de Dados


Portaria:
PortariaType, xsd/corporativo/Portaria_v1r0.xsd
CodigoType, xsd/corporativo/Portaria_v1r0.xsd

Status do Processamento:
StatusProcessamentoType, xsd/messages/StatusProcessamento_v1r0

2.2.7 Regras de Negócio (opcional)


O código de uma portaria identifica unicamente cada ocorrência e é formado por:
 prefixo: string que identifica a origem da portuária
 numero: inteiro (sequencial)
 ano: ano de publicação
O numero é gerado automaticamente. Deve ser sequencial, sendo reiniciado a cada
ano.

2.2.8 Segurança
TBD

2.2.9 Políticas de Uso


TBD

2.2.10 SLA
TBD

2.2.11 Especificações Adicionais (Não Funcionais) (opcional)


TBD
2.2.12 Arquitetura do Serviço
Padrão de Projeto: Serviço de Entidade com Persistência em Schema Dedicado
Arquitetura de aplicação composta (SCA) implementada em Oracle SOA Suite.
Operação SQL em BD, através de componente DB Adapter. Transformação XLST
(modelo BD <-> modelo canônico) em componente Mediator.

2.2.13 Configuração do Serviço (Implantação)


TBD

2.2.14 Dependências
Legado: SHF e Serviços (rotinas) de replicação SHF/Caché <-> Oracle (Schemas
core e srh).

2.2.15 Tecnologias de Implementação


Arquitetura SCA, com SOA Suite 12c.

2.3 Governança
2.3.1 Guardião
Rafael Guimarães (proprietário).

2.3.2 Desenvolvedores
[Detalha como contatar desenvolvedores do serviço, assim como outros que
contribuíram com essa documentação].

2.3.3 Contratos Concorrentes


N/A

2.3.4 Histórico de Versões


N/A

2.3.5 Consumidores Conhecidos


Processo de Substituição de Magistrados (Projeto COMAGIS)
3 Capacidades

3.1 consultar
3.1.1 Identificação

Nome da Capacidade consultar


Situação de Terminação Membro de Composição (F)
Descrição Consultar uma portaria existente.
Propósito Consultar portaria através de seu código.
Palavras-Chave Portaria
Status da Capacidade Projeto
Data de Entrega 31/10/2015

3.1.2 Entrada
CodigoType

3.1.3 Tipo de Retorno


Síncrono

3.1.4 Saída
PortariaType

3.1.5 Descrição da Lógica (opcional)


Retorna um elemento único ou gera exceção (Código: 404, Descrição: Não Encontrado) caso a opção
informada não seja encontrada.

3.1.6 Versão (opcional)


v1r0
3.2 pesquisar
3.2.1 Identificação

Nome da Capacidade pesquisar


Situação de Terminação Membro de Composição (F)
Descrição Pesquisar portarias existentes, por prefixo e ano.
Propósito Pesquisar portarias existentes, por prefixo e ano.
Palavras-Chave Portaria
Status da Capacidade Projeto
Data de Entrega 31/10/2015

3.2.2 Entrada
“Prefixo” string,
“Ano” gYear

3.2.3 Tipo de Retorno


Síncrono

3.2.4 Saída
Lista de PortariaType

3.2.5 Descrição da Lógica (opcional)


Pode retornar a lista vazia, caso nenhuma instância seja encontrada satisfazendo os
parâmetros da pesquisa (não gera exceção neste caso).

3.2.6 Versão (opcional)


v1r0
3.3 inserir
3.3.1 Identificação

Nome da Capacidade inserir


Situação de Terminação Membro de Composição (F)
Descrição Inserir (registrar) uma nova portaria.
Propósito Inserir (registrar) uma nova portaria.
Palavras-Chave Portaria
Status da Capacidade Projeto
Data de Entrega 31/10/2015

3.3.2 Entrada
PortariaType (o elemento número do código da portaria deverá estar ausente)

3.3.3 Tipo de Retorno


Síncrono

3.3.4 Saída
CodigoType (preenchido com o número gerado)

3.3.5 Descrição da Lógica (opcional)

3.3.6 Versão (opcional)


v1r0
3.4 alterarDataPublicacao
3.4.1 Identificação

Nome da Capacidade alterarDataPublicacao


Situação de Terminação Membro de Composição (F)
Descrição Alterar a data de publicação no Diário Oficial.
Propósito Alterar a data de publicação no Diário Oficial.
Palavras-Chave Portaria
Status da Capacidade Projeto
Data de Entrega 31/10/2015

3.4.2 Entrada
“Codigo” CodigoType,
“novoDataPublicacao” date

3.4.3 Tipo de Retorno


Síncrono

3.4.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 404, Descrição: Não Encontrado (afastamento não encontrado)

3.4.5 Descrição da Lógica (opcional)


A data de publicação deve ser maior ou igual à data de disponibilização da Portaria.

3.4.6 Versão (opcional)


v1r0
3.5 alterarPortaria
3.5.1 Identificação

Nome da Capacidade alterarPortaria


Situação de Terminação Membro de Composição (F)
Descrição Inserir uma nova portaria alterando uma portaria
anterior.
Propósito Inserir uma nova portaria alterando uma portaria
anterior.
Palavras-Chave Portaria
Status da Capacidade Projeto
Data de Entrega 31/10/2015

3.5.2 Entrada
“PortariasAlteradas” Lista CodigoType,
“PortariaAlteracao” PortariaType (o elemento número do código da portaria deverá
estar ausente)

3.5.3 Tipo de Retorno


Síncrono

3.5.4 Saída
CodigoType

3.5.5 Descrição da Lógica (opcional)


Insere uma nova Portaria, cujo conteúdo altera as portaria(s) anterior(es).

3.5.6 Versão (opcional)


v1r0
4 Anexos

Você também pode gostar