~~ODT~~ ====== Guia de Implantação - Módulo de DDO ====== Este guia de implantação tem por objetivo abordar os diversos aspectos envolvidos na implantação da funcionalidade da Declaração de Disponibilidade Orçamentária no Sistema SIPAC. Serão abordados os papeis dos usuários e as tabelas que devem ser preenchidas para o correto funcional do sistema. \\ ===Para a compreensão desta funcionalidade é importante a consulta dos seguintes artefatos:=== ==Especificações de requisitos dos casos de uso da declaração de disponibilidade orçamentária:== * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:cota_orcamentaria:cadastrar|Cadastrar Cota Orçamentária]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:cota_orcamentaria:listar_alterar_cotas|Listar/Alterar Cota Orçamentária]] * Cadastrar Declaração de Disponibilidade Orçamentária: - Contratos: * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_ddo_de_contrato:aditivo|Cadastrar Aditivo]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_ddo_de_contrato:apostilamento|Cadastrar Apostilamento]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_ddo_de_contrato:nova_contratacao|Castra Nova Contratação]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_ddo_de_contrato:prorrogacao| Cadastra Prorrogação]] - Pessoal: * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_ddo_de_pessoal:afastamento|Cadastrar Afastamento]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_ddo_de_pessoal:remocao|Cadastrar Remoção]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:consultas_relatorios:cotas_orcamentarias|Cotas Orçamentárias]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:consultas_relatorios:ddo|Consultar Declaração de Disponibilidade Orçamentária]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:analisar_encaminhar_para_autorizacao|Analisar e Encaminhar para Autorização]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:autorizar_declaracao|Autorizar Declaração]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:cadastrar_resultado_ddo_contratos|Cadastrar Resultado da Declaração de Disponibilidade Orçamentária de Contratos]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:editar_ddo|Editar Declaração de Disponibilidade Orçamentária]] * [[desenvolvimento:especificacoes:sipac:ddo:casos_de_uso:operacoes:ddo:editar_resultado_ddo|Editar Resultado Declaração de Disponibilidade Orçamentária]] ==Manuais dos casos de uso da Declaração de Disponibilidade Orçamentária:== * [[suporte:manuais:sipac:ddo:operacoes:cota_orcamentaria:cadastrar|Cadastrar Cota Orçamentária]] * [[suporte:manuais:sipac:ddo:operacoes:cota_orcamentaria:listar_alterar_cotas|Listar/ Alterar Cota Orçamentária]] * Cadastrar Declaração de Disponibilidade Orçamentária: - Contratos: * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_ddo_de_contrato:aditivo|Cadastra Aditivo]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_ddo_de_contrato:apostilamento|Cadastra Apostilamento]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_ddo_de_contrato:nova_contratacao|Cadastra Nova Contratação]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_ddo_de_contrato:prorrogacao|Cadastra Prorrogação]] - Pessoal: * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_ddo_de_pessoal:afastamento|Cadastrar Afastamento]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_ddo_de_pessoal:remocao|Cadastrar Remoção]] * [[suporte:manuais:sipac:ddo:operacoes:consultas_relatorios:cotas_orcamentarias|Cotas Orçamentárias]] * [[suporte:manuais:sipac:ddo:operacoes:consultas_relatorios:ddo|Consultar Declaração de Disponibilidade Orçamentária]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:analisar_e_encaminhar_para_autorizacao|Analisar e Encaminhar para Autorização]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:autorizar_declaracao|Autorizar Declaração]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:cadastrar_resultado_ddo_contratos|Cadastra Resultado da Declaração de Disponibilidade Orçamentária de Contratos]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:editar_ddo|Editar Declaração de Disponibilidade Orçamentária]] * [[suporte:manuais:sipac:ddo:operacoes:ddo:editar_resultado_ddo|Editar Resultado de DDO]] * [[desenvolvimento:especificacoes:sipac:ddo:negocio|Projeto técnico da Declaração de Disponibilidade Orçamentária]] ==== Importação de Dados ==== * Processo Manual Qualquer tipo de dado pode ser importado pelo processo manual, tanto documentos orçamentários quanto dados auxiliares. Chamamos de dados auxiliares, os dados que são utilizados pelos documentos orçamentários. Exemplos de dados auxiliares: * Fonte de Recurso * Plano Interno * Programa de Trabalho * Natureza de Despesa {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:leitura_importacao_e_extração_de_arquivo.png?direct&700 |}} - **Extração de Dados** \\ \\ A extração de dados do SIAFI é feita através do site https://consulta.tesouro.fazenda.gov.br/sta/. A descrição de como criar e configurar extrações no STA pode ser encontrada no Guia de Implantação da Integração SIPAC – SIAFI. \\ Os arquivos resultantes da extração serão enviados para o email configurado na extração ou poderão ser baixados através do menu “Download”, opção “Extrações”. Os arquivos listados nessa tela ficarão disponíveis para download por 4 dias úteis e se referem a extrações configuradas com destino: * Email: o arquivo gerado será enviado para e-mail e poderá ter tamanho de até 1 Mb. Além de enviado o e-mail, a extração estará disponível para download. * Portal on-line: o arquivo será gerado de imediato, e disponibilizado na área de download. Seu tamanho será limitado a 5Mb. Só é possível incluir extrações desse tipo em horários específicos. * Portal Batch: o arquivo será gerado à noite , e disponibilizado na área de download. Seu tamanho será limitado a 100Mb. \\ \\ - Exemplos de arquivos: * 153107NE_NE_20100604.ref.gz (arquivo de layout) * 153107NE_NE_20100604.txt.gz (arquivo de dados) \\ \\ - **Leitura de Arquivo** \\ \\ Os dados dos arquivos de extração, referentes a tabelas auxiliares, são lidos e armazenados diretamente na base de dados do módulo de orçamentário (SCO) do SIPAC. \\ Os dados dos arquivos de extração, referentes a documentos orçamentários, são lidos e armazenados em uma base de dados intermediária (SIAFI). \\ Os links para a leitura dos arquivos podem ser encontrados na aba “Integração SIAFI” do módulo orçamentário do SIPAC. * Tabelas Auxiliares:\\ \\ {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:integracao.jpg?direct&800 |}} * Documentos Orçamentários: \\ \\ {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:documentos_orcamentarios.jpg?direct&800 |}} \\ \\ Ao informar os arquivos de layout (.ref) e de dados (.txt), que foram salvos e descompactados previamente, e clicar no botão “Processar”, a aplicação valida, lê o arquivo de dados, baseando no arquivo de layout, e importa os dados para a base de dados correspondente. {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:dados.jpg?direct&600 |}} \\ \\ **Validação** \\ \\ Cada tipo de documento gera arquivo com estrutura diferente. Portanto, se o usuário clicar em “Credores” e informar os arquivos de Plano Interno, por exemplo, a aplicação irá apresentar uma mensagem de erro. \\ Alterações na estrutura dos arquivos pelo SERPRO podem ocasionar erros de validação. No momento, essas alterações são realizadas sem o nosso prévio conhecimento. Quando da ocorrência desse tipo de situação, adaptações no código são necessárias para que seja possível realizar a importação correta dos dados.\\ \\ **Tratamento de Duplicidade** \\ \\ Dados duplicados serão descartados na importação de tabelas auxiliares. Portanto, se um mesmo arquivo for processado mais de uma vez, é garantido que os dados já importados não serão perdidos ou sobrepostos. \\ \\ Uma mensagem de sucesso é apresentada se a importação for realizada sem erros. \\ \\ - **Importação de Dados** \\ \\ Os dados orçamentários são lidos para uma base de dados intermediária e, portanto, ainda não estão visíveis pelo SIPAC. \\ Os links para a importação dos arquivos podem ser encontrados na aba **“Integração SIAFI”** do módulo orçamentário do SIPAC. \\ {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:implantacao.jpg?direct&900 |}} \\ Na tela de importação de documentos orçamentários, será apresentada uma lista com os documentos armazenados na base de dados intermediária (SIAFI), mas que ainda não foram importados para a base do módulo de orçamento do SIPAC.\\ Ao selecionar um ou mais documentos e clicar em **“Importar”**, a aplicação chama o processador para realizar a importação de cada documento selecionado. Esse procedimento segue as mesmas regras de validação como se o usuário estivesse efetuando o registro utilizando as telas do SIPAC. \\ Ao final da importação, um comprovante é apresentado com a lista de documentos importados com sucesso e a lista de erros encontrados. Também é possível criar e salvar um arquivo de crítica contando o resumo da importação. \\ Na aba “Integração SIAFI” também é possível recuperar arquivos de críticas de importações anteriores através dos links na seção “Histórico da Migração”. \\ A importação de documentos de Nota de Empenho é detalhada a seguir neste documento. \\ \\ **Pré-Requisito** \\ * Popular Banco de Dados com Tabelas envolvidas. \\ **Papéis de Usuários** \\ * A tabela abaixo descreve os perfis envolvidos na declaração de disponibilidade orçamentária. {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:usuarios.jpg?direct&800 |}} ==== Procedimentos de carga no banco de dados ==== Para que as funcionalidades da declaração de disponibilidade orçamentária transcorram corretamente é necessário ter as seguintes informações na base de dados: * **comum.unidade:** entidade que representa a unidade, o cadastro poderá ser realizado através do SIGADMIN. [[suporte:manuais:sigadmin:portal_admin:gestao:unidades_administrativas_academicas:cadastrar_unidade|Cadastra Unidade]] * sco.plano_interno: entidade que representa o plano interno, um instrumento de planejamento e de acompanhamento da ação programada, usado como forma de detalhamento de um projeto/atividade, de uso exclusivo de cada ministério ou órgão. Um plano interno pode se desdobrar ou não em etapas. Os dados dessa entidade poderão ser importados do SIAFI, conforme as instruções passadas na seção **“Importação de Dados”**. * **sco.programa_trabalho:** entidade que representa o programa de trabalho, representa uma ação da instituição direcionando recursos para uma determinada área. Os dados dessa entidade poderão ser importados do SIAFI, conforme as instruções passadas na seção “Importação de Dados”. * **sco.fonte_recurso:** entidade que representa a fonte de recurso, representa a origem dos recursos do Orçamento. Os dados dessa entidade poderão ser importados do SIAFI, conforme as instruções passadas na seção “Importação de Dados”. * **sco.elemento_despesa:** entidade que representa a natureza de despesa, um elemento de gasto, como por exemplo: - Material Permanente - Passagens - Diárias -. Os dados dessa entidade poderão ser importados do SIAFI, conforme as instruções passadas na seção **“Importação de Dados”**. * **sco.cota_orcamentaria:** entidade que representa a cota orçamentária que corresponde ao valor que cada Órgão terá disponível para Reserva de Dotação, Empenho e Programação de Liquidação da Despesa. * **sco.movimentacao_cota:** entidade que tem a finalidade de armazenar as alterações realizadas na cota orçamentária, mantendo assim um histórico de toda movimentação realizada. * **sco.declaracao_disp_orcamento:** entidade que representa a declaração de disponibilidade orçamentária, trata-se de declaração emitida pela autoridade administrativa (ordenador de despesa) com objetivo de autorizar a execução de despesas orçamentárias com adequação orçamentária e financeira, constituindo condição prévia para empenho e licitação de serviços, fornecimento de bens ou execução de obras. * **sco.detalhamento_ddo:** entidade que tem a finalidade de detalhar a declaração de disponibilidade orçamentária. * **sco.movimentacao_ddo:** entidade que armazenará o histórico da movimentação, assim será possível acompanhar toda o tramite da declaração de disponibilidade orçamentária. * **sco.opcao_contratacao:** entidade que descreve as opções existentes em uma Declaração de Disponibilidade Orçamentária do tipo contratação. INSERT INTO sco.opcao_contratacao(id_opcao_contratacao, descricao) VALUES (1, 'Envolve Serviço de Informática'); \\ INSERT INTO sco.opcao_contratacao(id_opcao_contratacao, descricao) VALUES (1, 'Serviços de Obras e Engenharia'); \\ * **sco.opcao_contratacao_ddo:** entidade que conterá as opções da Declaração de Disponibilidade Orçamentária do tipo contrato. * **sco.tipo_ddo:** entidade que representa o tipo de Declaração de Disponibilidade Orçamentária, classificando a disponibilidade em Contratação ou Pessoal. INSERT INTO sco.tipo_ddo(id_tipo_ddo, descricao) VALUES (1,'Contrato'); \\ INSERT INTO sco.tipo_ddo(id_tipo_ddo, descricao) VALUES (2,'Pessoal'); \\ * **sco.sub_tipo_ddo:** entidade que representa a subclassificação dos tipos de declarações de disponibilidades orçamentárias. INSERT INTO sco.sub_tipo_ddo(id_sub_tipo_ddo, descricao, id_tipo_ddo) VALUES (1, 'Nova Contratação', 1); \\ INSERT INTO sco.sub_tipo_ddo(id_sub_tipo_ddo, descricao, id_tipo_ddo) VALUES (2, 'Aditivo', 1); \\ INSERT INTO sco.sub_tipo_ddo(id_sub_tipo_ddo, descricao, id_tipo_ddo) VALUES (3, 'Apostilamento', 1); \\ INSERT INTO sco.sub_tipo_ddo(id_sub_tipo_ddo, descricao, id_tipo_ddo) VALUES (4, 'Prorrogação', 1); \\ INSERT INTO sco.sub_tipo_ddo(id_sub_tipo_ddo, descricao, id_tipo_ddo) VALUES (5, 'Afastamento', 2); \\ INSERT INTO sco.sub_tipo_ddo(id_sub_tipo_ddo, descricao, id_tipo_ddo) VALUES (5, 'Remoção', 2); \\ * **sco.valor_mensal_ddo_contrato:** entidade que representa os valores estimados de um contrato para análise de uma Declaração de Disponibilidade Orçamentária. * **sco.resultado_ddo_contrato:** entidade que representa o resultado da Declaração de Disponibilidade Orçamentária, armazenando o contrato, data do resultado e o usuário que realizou. ==== Diagrama Entidade Relacionamento do Esquema SCO (Sistema de Controle Orçamentário) ==== {{ :desenvolvimento:especificacoes:sipac:guia_de_implantacao:diagrama_sco.jpg?direct&1300 |}}