Journals OPAC Documentation
Transcrição
Journals OPAC Documentation
Journals OPAC Documentation Release 0.1 SciELO March 28, 2013 CONTENTS 1 User Guides 2 Development Guides 2.1 Documento de Visão . . . . . . . . 2.2 Características da Ferramenta Atual 2.3 Mockups . . . . . . . . . . . . . . 2.4 Data model . . . . . . . . . . . . . 2.5 References . . . . . . . . . . . . . 2.6 StoryBoard . . . . . . . . . . . . . 2.7 Arquivos do projeto . . . . . . . . 2.8 Reuniões do Projeto . . . . . . . . 3 Indices and tables 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 3 5 8 9 14 16 16 17 19 i ii CHAPTER ONE USER GUIDES Aqui vem todos os guias para usuários da aplicação 1 Journals OPAC Documentation, Release 0.1 2 Chapter 1. User Guides CHAPTER TWO DEVELOPMENT GUIDES Guias técnicos e artefatos gerados para definir e explicar os componentes de software e decisões de design. 2.1 Documento de Visão 2.1.1 Motivações • Manter a arquitetura de aplicações e os serviços disponibilizados aos usuário em um padrão internacional de qualidade, diminuir os custos operacionais, de manutenção e suporte a rede SciELO, permitindo a atualização dos aplicações de forma automática equacionando a qualidade tecnologica de todas as coleções da Rede SciELO e de coleções não certificadas que fazem uso das aplicações da metodologia. • Empoderar o desenvolvimento de novas aplicações e serviços, evoluindo a arquitetura das aplicações SciELO para um padrão de profissionalismo equiparado a grandes empresas do mercado disponibilizando API’s de desenvolvimento para todos os novos produtos produzidos dentro do contexto do projeto SciELO. • A evolução contínua e a necessidade inerente as profissões e produtos de tecnologia de se manterem atualizados deve ser considerado um fator primordial para sustentabilidade de projetos que possuem em seu cerne uma diversidade de produtos de tecnologia. A estagnação tecnológica a longo prazo pode significar a falência de projetos onde a tecnologia tem um grande papel. 2.1.2 Antecedentes A necessidade de reestruturar a arquitetura das aplicações de publicação de artigos, fascículos e periódicos no contexto do projeto SciELO veio inicialmente pela equipe de desenvolvimentos que sentia muita dificuldade em manter a arquitetura das aplicações da metodologia SciELO evoluindo de acordo com as novidades do mercado devido ao uso de processos, aplicações, linguagens e sistemas de bancos de dados obsoletos. De acordo com as motivações citadas e a necessidade urgente de reestruturar a arquitetura tecnologica da metodologia SciELO, decidiu-se realizar uma série de desenvolvimentos com a intenção de resgatar a arquitetura tecnológica da SciELO para um novo padrão de qualidade. O Journals OPAC compreende a segunda fase de desenvolvimentos de um pacote de aplicações para a reestruturação da arquitetura de aplicações do projeto SciELO. 2.1.3 Escopo do Projeto Esta aplicação pretende dar suporte ao processo de publicação on-line da metodologia SciELO. Sua função se resume em fornecer funcionalidades que permitam aos gestores de coleções criar seus corpus de publicação para diversas 3 Journals OPAC Documentation, Release 0.1 coleções de países, temáticas e outras. 2.1.4 Objetivo do Projeto Este projeto tem como objetivo criar uma ferramenta como serviço, para suporte a publicação de periódicos científicos operados no contexto da Rede SciELO substituindo a atual ferramenta de publicação de artigos e periódicos. 2.1.5 Quais problemas esta aplicação deve solucionar? • Migrar toda rede SciELO para uso das novas aplicações. • Mudança de paradigma para o uso de aplicações como serviço. (Application as a Service) • Mudança de paradigma de uso de uma arquitetura decentralizada para uma arquitetura centralizada. 2.1.6 Macro Necessidades • Software as a service. • Capacidade de instalação remota. • Interoperação com os dados do SciELO Manager. • Serviços de estatísticas de acessos. • Serviços de interoperabilidade de metadados. (OAI-PMH, SWORD) • Exportação de metadados (WoS, DOAJ). • Gestão de páginas secundárias, seja por um usuário da equipe SciELO ou um usuário do tipo editor. • Gestão de corpo editorial, seja por um usuário da equipe SciELO ou um usuário do tipo editor. • API’s para acesso a todo dado produzido pelas coleções. • Exportação de metadados para formatos legados, json e xml. • Interface Web • Interface Mobile 2.1.7 Requisitos Funcionais • Toda a configuração deve ser realizada via interface web. • Os dados de revista, fascículo, sessões e artigo devem ser sincronizados com o SciELO Manager (ferramenta de gestão do catálogo), de maneira que sempre que houver atualização nos dados estes sejam replicados para o OPAC. • O sistema deve permitir que o administrador controle a visibilidade de revistas, fascículos e artigos. • O sistema deve permitir que o administrador habilite/desabilite/configure as funcionalidades da caixa de serviços. • O sistema deve suportar internacionalidação. • O sistema deve ser capaz de apresentar gráficos de uso do conteúdo acessado. • O sistema deve ser capaz de apresentar de forma diferenciada os artigos que possuem o texto completo marcado. 4 Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 Requisitos não definidos • A criação de coleções fica a cargo apenas de usuários administradores do SciELO, a rede não poderá criar coleções através do OPAC? • Editores terão quais permissões no sistema? para edição de corpo editorial e páginas secundárias apenas, ou para dados do periódico também? • O sistema deve permitir a gestão de alguns dados do periódico, tais como: Sobre a revista, Corpo editorial, Instruções aos autores, Assinaturas e o Rodapé (markdown?). Ou essa funcionalidade será uma aplicação no Journal Manager? • O mockup home_periodico defini serviços de notícias e notas do editor. Esse produto será desenvolvido no contexto deste projeto? – Este serviço poderia ser implementado junto com serviços de redes sociais, ou seja, ao indicar uma url de twitter, facebook ou outros serviços, uma aba é habilitada montrando os highlights postados pelos editores nessas redes sociais. 2.1.8 Requisitos Não Funcionais 2.1.9 Glossário DOAJ JSON (Java Script Object Notation) OAI-PMH O OAIPMH é um protocolo para disseminação de metadados contidos em repositórios. OPAC Software as a service Essa característica é dada a aplicações que podem ser utilizadas apenas criando um usuário e senha, e a partir desta conta de usuário todos os serviços e aplicações ficam disponíveis para este usuário. Essa característica de arquitetura de software vem sendo largamente utilizada em serviços que requerem alto grau de complexidade na manutenção e operação. Com essa arquitetura a complexidade de manutenção e operação passa a ser gerida de forma centralizada, entretanto, todos os recursos e serviços da aplicação são implementados em um ambiente decentralizado de gestão de conteudo. SWORD Web of Science (WoS) 2.2 Características da Ferramenta Atual Neste documento estão descritas as características apontadas no documento de visão que levaram a equipe SciELO a decidir pelo desenvolvimento de uma nova ferramenta de publicação para a metodologia SciELO. Os itens descritos não seguem ordem de prioridade ou relevância. 2.2. Características da Ferramenta Atual 5 Journals OPAC Documentation, Release 0.1 2.2.1 Custos de Operação As coleções da rede SciELO por definição devem ter uma equipe técnica capacitada para dar suporte e manutenção aos aplicativos utilizados pela metodologia, entretanto, esse tipo de requisito não pode ser cumpridor pela maioria das coleções da rede devido aos custos envolvidos para operação plena da metodologia. Resumidamente, os custos estão envolvidos em: • Mater uma equipe técnica dedicada com pelo menos 1 profissional; • Manter infra estrutura de servidores de homologação e produção; • Manter rotinas de backup operando ininterruptamente; • Manter os sites funcionando em 24X7 com uptime de pelo menos 98%; • Manter processos e processamentos de atualização funcionando ininterruptamente; Por outro lado, a equipe de tecnologia do projeto SciELO Brasil se compromete a fornecer suporte as coleções da rede, realizando as seguinte atividades: • Suporte primeiro nível para 12 coleções certificadas, 7 coleções em desenvolvimento, 12 coleções de divulgação ciêntifica totalizando 31 coleções que utilizam as ferramentas da metodologia SciELO. • Suporte operacional para as 31 coleções – Instalação e Configuração de ambientes de homologação e produção totalizando 62 ambientes – Atualização de versões de ambientes de homologação e produção totalizadno 62 ambientes com pelo menos 4 atualizações anuais considerando o volume de novas versões nos últimos 2 anos. – Configuração de procedimentos de atualização de metadados, acessos e bibliometria para 12 coleções certificadas, tais como: Envia dados para scielo, estatísticas de acessos, Scimago, XML Files, DOI Request, DOAJ. • Suporte através de lista de discussão com volume de 25 mensagens mensais com tempo médio de suporte de 60 horas mensais. 2.2.2 Uso da Ferramenta Acessos Mensais A média mensal de acessos do tipo pageview no período de 1 de janeiro de 2012 até 31 de dezembro de 2012 é de 41.236.286. • Africa do Sul: 74.000 • Argentina: 992.400 • Brasil: 32.000.000 • Chile: 3.100.000 • Costa Rica: 8.300 • Colombia: 1.200.000 • Cuba: 875.000 • Espanha: 1.855.000 6 Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 • Saúde Pública: 634.000 • Social Sciences: 24.000 • Pepsic: 437.000 • Portugal: 88.000 • Uruguai: 96.512 2.2.3 Produção Número documentos produzidos em 2010 e 2011 para base de projeção, apenas para coleções certificadas. coleção Argentina Brasil Chile Colombia Costa Rica Cuba Espanha México Portugal Saúde Pública Social Sciences Venezuela Total anual 2010 2.404 19.846 3.734 4.118 416 2.015 2.472 2.519 983 1.979 89 1.045 41.620 2011 2.046 21.013 3.722 3.374 248 1.997 2.373 2.151 270 2.202 267 39.663 total geral 15.321 166.759 29.702 22.655 3.433 14.627 20.587 12.632 5.574 18.589 650 12.882 323.411 2.2.4 Coleções SciELO Certificadas Argentina, Brasil, Chile, Colombia, Costa Rica, Cuba, Espanha, México, Portugal, Venezuela, Saúde Pública, Social Sciences. Em desenvolvimento Africa do Sul, Bolivia, Paraguai, Perú, Uruguai, West Indian Medical Journal, Brasil Proceedings Divulgação Científica e Terceiros Ciência e Cultura, ComCiência, Conhecimento e Inovação, Enfermagem (RevEnf), Psicologia (PEPSIC), Odontologia (RevOdonto), Secretaria de Saúde Pública (SES), EMRO, Tropika, Geologia (PPEGEO), UNESP, Avaliação. 2.2. Características da Ferramenta Atual 7 Journals OPAC Documentation, Release 0.1 2.3 Mockups 2.3.1 Site Público Index do site Não definido Lista de periódicos em ordem Alfabética Não definido Lista de Periódicos por area temática Não definido Página do fascículo Não definido Página de grid de fascículos Não definido Páginas secundárias da coleção Não definido Página inicial do periódico 8 Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 Página do artigo Não definido 2.3.2 Backoffice 2.4 Data model 2.4.1 Resources • List all journals – /journal/ • Get journal – /journal/:journal_id/ • List issues bound to a journal – /issue/:journal_id/ • Get issue – /issue/:journal_id/:issue_id/ • Get article – /article/:article_id/ 2.4.2 Journal { "abstract_keyword_languages": null, "acronym": "AISS", "collections": "/api/v1/collections/1/", "contact": null, "copyrighter": "Istituto Superiore di Sanità", "cover": null, "created": "2010-04-09T00:00:00", "creator": "/api/v1/users/1/", "ctrl_vocabulary": "nd", "current_ahead_documents": 0, "editor_address": "Viale Regina Elena 299, 00161 Italy Rome, Tel.: 0039 06 4990 2945, Fax: 0039 06 "editor_address_city": "", "editor_address_country": "", "editor_address_state": "", "editor_address_zip": "", "editor_email": "[email protected]", "editor_name": "", "editor_phone1": "", "editor_phone2": null, "editorial_standard": "vancouv", "eletronic_issn": "", "final_num": "", "final_vol": "", "final_year": null, 2.4. Data model 9 Journals OPAC Documentation, Release 0.1 "frequency": "Q", "id": 1, "index_coverage": "chemabs\nembase\nmedline\npascal\nzoological records", "init_num": "1", "init_vol": "1", "init_year": "1965", "is_indexed_aehci": false, "is_indexed_scie": false, "is_indexed_ssci": false, "issues": [ { "id": 1, "data": { "cover": null, "created": "2010-04-01T01:01:01", "ctrl_vocabulary": "nd", "editorial_standard": "vancouv", "id": 1, "is_marked_up": false, "is_press_release": false, "is_trashed": false, "label": "45 (4)", "number": "4", "order": 4, "publication_end_month": 12, "publication_start_month": 10, "publication_year": 2009, "resource_uri": "/api/v1/issues/1/", "sections": [ { "id": 514, "articles": [ "AISS-JHjashA", ] } ], "suppl_number": null, "suppl_volume": null, "total_documents": 17, "updated": "2012-11-08T10:35:37.193612", "volume": "45" } } ], "languages": [ "en", "it" ], "logo": null, "medline_code": null, "medline_title": null, "missions": [ {’en’: ’To disseminate information on researches in public health’} ], "national_code": null, "notes": "", "other_previous_title": "", "other_titles": [], "previous_ahead_documents": 0, 10 Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 "print_issn": "0021-2571", "pub_level": "CT", "pub_status": "current", "pub_status_history": [ { "date": "2010-04-01T00:00:00", "status": "current" } ], "pub_status_reason": "", "publication_city": "Roma", "publisher_country": "IT", "publisher_name": "Istituto Superiore di Sanità", "publisher_state": "", "resource_uri": "/api/v1/journals/1/", "scielo_issn": "print", "secs_code": "", "short_title": "Ann. Ist. Super. Sanità", "sponsors": [ 1 ], "study_areas": [ "Agricultural Sciences" ], "subject_descriptors": "public health", "title": "Annali dell’Istituto Superiore di Sanità", "title_iso": "Ann. Ist. Super. Sanità", "updated": "2012-11-08T10:35:00.448421", "url_journal": null, "url_online_submission": null, "use_license": { "disclaimer": "", "id": 1, "license_code": "", "reference_url": null, "resource_uri": "/api/v1/uselicenses/1/" }, "sections": [ { "id": 514, "data": { "id": 514, "resource_uri": "/api/v1/sections/514/", "titles": [ {"en": "WHO Publications"} ] } } ] } 2.4.3 Article { "abstract": { "en": "<p>Trout farming, that represents the most important sector for aquaculture inland product "it": "<p>La troticoltura rappresenta il settore più importante per la produzione ittica in Itali 2.4. Data model 11 Journals OPAC Documentation, Release 0.1 }, "journal-id": "aiss", "lpage": "302", "journal-title": "Annali dell’Istituto Superiore di Sanit\u00e0", "fpage": "299", "contrib-group": { "author": [ { "role": "ND", "given-names": "Ahmet", "surname": "Soysal", "affiliations": [ "A01" ] }, { "role": "ND", "given-names": "Hatice", "surname": "Simsek", "affiliations": [ "A01" ] }, { "role": "ND", "given-names": "Dilek", "surname": "Soysal", "affiliations": [ "A02" ] }, { "role": "ND", "given-names": "Funda", "surname": "Alyu", "affiliations": [ "A03" ] } ] }, "default-language": "en", "volume": "46", "number": "3", "pub-date": { "year": "2010" }, "issn": "0021-2571", "publisher-loc": "Roma", "abbrev-journal-title": "Ann. Ist. Super. Sanit\u00e0", "affiliations": [ { "addr-line": "Izmir", "ref": "A01", "institution": "Dokuz Eylul University", "country": "Turkey" }, { 12 Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 "ref": "A02", "institution": "Dokuz Eylul University", }, { "addr-line": "Izmir", "ref": "A03", "institution": "Ataturk Training and Research Hospital", "country": "Turkey" } ], "keyword-group": { "en": [ "health-care waste", "waste management" ], "pt": [ "rifiuti sanitari", "Uso de Medicamentos", "Inqu\u00e9ritos de Morbidade" ], "it": [ "Personas con Discapacidad", "gestione dei rifiuti" ] }, "subjects": { "wos": [ "PUBLIC, ENVIRONMENTAL", "OCCUPATIONAL HEALTH" ] }, "article-ids": { "publisher-id": "S0021-25712010000300013" }, "publisher-name": "Istituto Superiore di Sanit\u00e0", "title-group": { "en": "Management of health-care waste in Izmir, Turkey", "it": "Gestione dei rifiuti sanitari in Izmir, Turchia" } } 2.4.4 Sponsor { "acronym": "", "address": "", "address_complement": "", "address_number": "", "cel": "", "city": "", "complement": "", "country": "", "created": "2012-11-08T10:34:59.844065", "email": "", "fax": "", "id": 1, "name": "Istituto Superiore di Sanit\u00e0", 2.4. Data model 13 Journals OPAC Documentation, Release 0.1 "phone": "", "resource_uri": "/api/v1/sponsors/1/", "state": "", "updated": "2012-11-08T10:34:59.844096", "zip_code": null } 2.5 References • iso 639-1: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes • iso 8601: http://en.wikipedia.org/wiki/ISO_8601 14 Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 2.5. References 15 Journals OPAC Documentation, Release 0.1 2.6 StoryBoard 16 2.7 Arquivos do projeto 2.7.1 Visão Geral Chapter 2. Development Guides Journals OPAC Documentation, Release 0.1 Download: visao-geral.pdf 2.8 Reuniões do Projeto Esta seção contém apenas reuniões de tomadas de decisões. 2.8. Reuniões do Projeto 17 Journals OPAC Documentation, Release 0.1 18 Chapter 2. Development Guides CHAPTER THREE INDICES AND TABLES • genindex • modindex • search 19