OriOasis - Documentação

FAQ / Perguntas | Manual Técnico | Manual do Organizador e Clube-Admin | Manual do OriOasis-Admin | Manual do Desport Escolar / FPO | Manual do Diário de Treino | Manual Forum do OriOasis | Manual Live O Results | Contactos
(a tradução automática poderá conter erros / automatic translation may contain errors)

Índice:

  1. Manual de Especificações do Sistema [ Versão 0.1 - 2005/05/15 - Paulo Franco ]
  2. Manual de Especificações dos Ficheiros de Interface [ Versão 0.1 - 2005/11/03 - Paulo Franco ]
  3. Manual de Registo de Alterações [ Versão 0.3.1 - 2005/12/11 - Paulo Franco ]

  1. Manual de Especificações do Sistema

    1. Introduction

      OASIS is an olnine system that allows services for sport events. Its main focus is entries management and registration.

      The project started in October 2003 and was born with the goal of becoming FPO oficial online system for entries management of all orienteering events in Portugal. This online system is able to interact with other software and systems such as SportIdent (e.g. MT2003, OE2003). The system's architecture is modular which allows the installation plugins and integration of new funcionalities.

      This document will be updated whenever there are relevante changes to the system, therfore there should be check its version short time before the organization of an event.


    2. Funcionalities

      2.1. Users
      • Management (create, edit, delete);
      • Logged in restricted search and view info. Users from the same club can view each other info (contacts, birthdate, etc);
      • 4 user levels:
        • SUPER-USER: user with highest rights, there can be more that one.
        • ADMIN-CLUB: user responsable by its club area in OASIS. There can be more that one.;
        • NORMAL: basic user with access to OASIS private area without administration previligies. Can check most of the info about his club and its users;
        • PUBLIC: OASIS visitor (not logged in);


      2.2. Events
      • Management (new, edit, delete);
      • Public search and view info. Can be integrated with any website (such as the national federation) view example at http://www.fpo.pt/www);

      2.3. Clubs
      • Management (new, edit, delete);
      • Public search and view info. Can be integrated with any website (such as the national federation) view example at http://www.fpo.pt/www);

      2.4. Calendars / Rankings management (new, edit, delete);

      2.5. Entries
      • Management (new, edit, delete);
      • Counting and statistics. Groups and counts the entries by total or stage and club or class
      • Permission and validation:
        • The club can restrict its users the registration of the entries in a specific event setting the the availability, internal (club) deadline and the type of registratin (direct or awaiting clube validation). There can also be configured a club default settings wich is applied to events where no entry settings are specified;
        • 3 states diferentiate the validation of the entries: waiting for club validation, waiting for organization validation and validated;
      • Public search and view info
      • Export to:
        • SportIdent CSV file (MT2003 or OE2003);
        • OASIS XML file;
        • OASIS HTML file;
        • OASIS CSV file;
      • View real time updated entries;
      • Express Entries - Submit entries directly without system login. This is the most appropiate option for entries of non federate athlets or visitors that use the system with low regularity. In this case no login or registration in the system is required.


      2.6. Federate licenses management. It's possible to have several types of licenses being managed by the system in parallel (e.g. FPO - Portugal, FEDO - Spain). The licenses states are used to calculate the appropriate fee of the entry and sport insurance;

      2.7. Send messages between users and administrators;

      2.8. Module integration (a club can develop its own module and integrate it in OASIS);

      2.9. Trust group (entries management permission between system users without administration rights);

      2.10. Online registration in the system (for non-federate users or users that do not belong to a federate club). It's possible to create a club (not federated) during registration;

      2.11. Password Recovery;

      2.12. Multiple seasons co-existence;

      2.13. Multiple language support;

      2.14. Results
      • Import results into system using interface CSV file;
      • Browse results list and filter by club/class
      • Browse results using SplitsBrowser (www.splitsbrowser.org.uk) and SportIdent splits
      • Export results


      2.15. Training Diary - Register the trainings online and view statistics on it by month or week with "on the fly" generated graphics. (view example here , graphics in the bottom)

      2.16. Forum - online discussions about any subject related with the sport.

      2.17. Contact administration Form

      2.18. Help (FAQ, technical manuals, contacts)

      2.19. FPO Rankings
      • Automatic rankings: calculate automatically during results upload;
      • Manual rankings: calculate manually (e.g. using an speadsheet) and are uploaded and linked manually;
      • Browse ranking and filter by club/class
      • Export ranking


      2.20. [TODO] Message Board - post in start page specific messagens for specific users and groups


    3. Use Cases

      3.1. User level PUBLIC

        3.1.2. View Clubs
        Search clubs and browse it's info as well as the names of the respective CLUB-ADMINs
        The search criterias are the following:
        • Name / Nick
        • License (provider, number)
        • Country
        • Region

        3.1.2. View Events
        Search events and view of its info such as specific URLs to specific info (e.g. technical info, photos), summary count of the entries, classes and respective fees, deadlines, available extras, etc
        The search criterias are the following:
        • Name / place
        • Calendar / Ranking
        • Season
        • Country
        • Region
        • Show past events / Show only future events

        3.1.1. Entries.
        Search and view real-time updated entries
        The search criterias are the following:
        • Name / Nick
        • e-Mail
        • National ID
        • Country
        • License (provider, number)
        • Level
        • Club
        • Registration date

        3.1.2. Register in the system:
        It's possible to create 2 type of registration:
        • Associate with a club

        • Individual

        In both cases, the access password is sent to the e-mail inserted in the registration. This passowrd and the choosen user name can be changed at any time.

        3.1.2. Password recovery / Reset:
        After finding user, through club browsing or username / e-mail search), it's possible to recover the password by following the instructions sent to the e-mail.

        3.1.2. View results using the SplitsBrowser and SportIdent splits :
        It's available in 2 forms by using :
        • FPO Sportident CSV database files

        • OASIS Splitsbrowser interface. This funcionality can read a SI splits file (in CSV or HTML format) and open a Splitsbrowser window. The file can be uploaded or supplied through an URL.

        3.1.2. Browse the forum

        3.1.2. Browse public training diaries

        3.1.2. View help items

        3.1.2. Contact the administration (system management or technical suport) by supplying a valid e-mail in the form

        3.1.2. Login into OASIS

      3.2. User level NORMAL

        3.2.1. View Club info
        View club data in which the user is registred such as (contacts, number of members, the CLUB-ADMINs info, etc.);

        3.2.3. Use Private Services
        Each clube can have their own sevices / modules:

        • Balance: View the financial balance of the user towards the club.

        3.2.4. Register entries in events
        After choosing the event the user can register entries supplying the following info:

        • Choose the user he plans to register the entry for. The available users is the list of users that the loogged in user has permission to register (view "Trust Group", plus himself.

        • SportIdent number

        • Stages and respective class of participation

        • Group number (in case the participation in the course will be done in a group)

        • Observation (for the club or for the organization)

        • Extras (dinner, gymnasium floor, etc)

        3.2.5. List all its entries in a given season

        3.2.6. Manage personal data such as:
        • Name (view /edit)

        • Address (view /edit)

        • Sex (view /edit)

        • Identification Document Number (view /edit)

        • Federate license provider and license number (view)

        • Sportident number (view /edit)

        • Email (view /edit)

        • Telephones (infinit) (view /edit / add / delete)


        3.2.7. Access data (view / edit):
        • Username

        • Password. For security reasons, the real password is not kept in the database, but a digest of it instead. If the passowrd is lost it cannot be recovered, only reset, by following the instructions sent by email if a "reset password" is requested.


        3.2.8. Manage the "Trust Group":
        The Trust Group is a funcionality which allows users to register other users from their own private area.

        E.g.: Supposing there are 2 users registred in the system, Maria and John. If Maria adds John to her Trust Group, John (through his private area) can reigster Maria in events. This means that John can register himself and all other users that have him in their "Trust Group".

        In the other hand Maria may register Jonh only if he adds her to his "Trust Group".

        De notar que os utilizadores com poderes de administração (Clube-Admin) podem fazer/alterar às inscrições de todos os utilizadores da sua comunidade (clube).

        3.2.9. Classes Management:
        This funcionality allows the user to set the default classes he belongs to in a certain calendar / ranking.

        3.2.11. Club members. View all club members info

        3.2.11. Send messages to:
        • All the members of the club

        • The CLUB-ADMINs of the club



        3.2.11. Register a club :
        Only for the users registred in the system as individual, it's possible to register a club. The registration of a new club by user (e.g. User-Club-Creator) addresses the following issues:

        • The registry of user User-Club-Creator:
          - Will be associated with the new club;
          - In case it was created by another user ("Parent"), the User-Club-Creator will no longer be under the responsability of the "Parent" user. This means that "Parent" can't access User-Club-Creator data. Nevertheless the "Parent" can still register User-Club-Creator in events as long as User-Club-Creator keeps "Parent" in its "Trust Group".

        • All the users for whom User-Club-Creator is responsable will also be associate with this new club.

        • Will still be possible to register in events as INDIVIDUAL for any of the users, including User-Club-Creator.

        • At any time, it's possible to delete the club. All users (including User-Club-Creato) will be registred in the system as INDIVIDUAL .

        • If the objectiv User-Club-Creator is keep submitting entries as INDIVIDUAL, then this new club registration is senseless.

        3.2.11. All the other funcitonalities PUBLIC user can perform

      3.3. Nível de Utilizador ADMIN-CLUB

        3.1.1. Entries.

        • Register entries for:
          • The users of the club in the several in events of the system.
          • The events in which the club is organizer. In this use case it's possible to edit / add entries for any user / club. The extra field editable are:
            • Date
            • State
            • MTageID (SportIdent)
            • Fixed Fee

        • Manage clubs of event.
          Add, remove and edit the clubs that can only be used whithin the scope of an event.
        • Edit entries definitions:
          • Stabelish the internal default permissions on how the users of the club can register in events. The settings are:
            • Allow / Do not permit
            • Type of Entry: Direct / Indirect
            • Deadline
          • Stabelish the internal permissions on how the users of the club can register in a specific event.

        • Export entries
          Filter entries to export by the followinf
          • Stabelish the internal default permissions on how the users of the club can register in events. The settings are:
            • Allow / Do not permit
            • Type of Entry: Direct / Indirect
            • Deadline
          • Stabelish the internal permissions on how the users of the club can register in a specific event.

        3.3.3. Club:
        • Edit club info:
          • Name

          • Nick

          • License

          • Address

          • Webpage

          • e-mail

          • Telephones


        • Edit club users info:
          • Personal Info

          • Access Info

          • System Info

          • Trust Group Info

          • Classes Info

          • Send access info to user

          • Login as user

        3.3.3. Events
        Add / Edit events where the club is the organizer. The info is:
        • Main Info:
          • Name of event

          • Place

          • Main calendar / ranking

          • Other calendars / rankings

          • Supervisor

          • e-mail for entries

          • homepage

          • URL for general info

          • URL for technical info

          • URL for start list

          • URL for results

          • URL for photos

          • URL for other info


        • Stages:
          • Name of stage

          • Date

          • Main calendar / ranking

          • Other calendars / rankings


        • Types of classes in event, type of fees, insurance and deadlines:
          • Type of classes in event: All the same / Different

          • Type of Entries Fees: Normal, Unique, By number of entries (discount)

          • Insurance fee

          • Deadlines: for registring entries (discount, competition, close), for cancelling entries (competition, open)


        • Extras
          • Name

          • Fee

          • Deadline


        • Classes
          • Name

          • Short Name

          • View Order

          • Fees (8, federate / not federate, discount / no discount, young / adult)


        3.4. Nível de Utilizador SUPER-USER

          3.4.1. All the use cases of CLUB-ADMIN for all the clubs

          3.4.2. Definições das inscrições:
          É possível editar todas as definições das inscrições para todos os clubes em todas as provas de acordo com 3.3.2.

          3.4.3. Administração dos clubes:
          É possível criar, editar (de acordo com 3.3.3.) e remover clubes do sistema.

          3.4.4. Administração das provas:
          É possível criar, editar e remover provas do sistema.

          Cada prova é constituída pela seguinte informação.
          • Nome

          • Local

          • Calendário

          • Clubes Organizadores

          • Número de Etapas

          • Datas das Etapas

          • Nome das Etapas

          • Datas limite para realização de inscrições (3): sem agravamento, escalões de competição, inscrições online.

          • Datas limite para cancelamento de inscrições (2): escalões de competição, escalões abertos.

          • Escalões do evento


          3.3.6. Administração dos utilizadores do sistema:
          É possível administrar todos os utilizadores de cada clube de acordo com 3.3.4

          3.3.7. Administração dos calendários do sistema:
          É possível criar, editar e remover calendários ao sistema

          Cada calendário é constituído pela seguinte informação.
          • Nome

          • Tipo de Calendário (competição ou aberto)

          • Calendário

          • Datas limites para as inscrições (3): sem agravamento, escalões de competição, inscrições online. Estes são os valores de omissão e são definidos em dias (antes da primeira etapa)

          • Datas limite para cancelamento de inscrições (2): escalões de competição, escalões abertos. Estes são os valores de omissão e são definidos em dias (antes da primeira etapa)

          • Escalões do evento


          3.3.8. Definição das variáveis do sistema (disponivel, em manutenção, etc)


    • Manual de Especificações dos Ficheiros de Interface

      0. Introdução

        Este documento pretende especificar o formato de todos os ficheiro de interface entre o OASIS e os softwares de gestão de provas, pontos e inscrições.

        Este documento será actualizado quando houver ajustes ou alterações que o justifiquem, pelo que deverá ser verificada a sua versão pouco antes da organização de uma prova.


      1. Ficheiro de Inscrições para MT2003 v10.2

      • Nome:
        O ficheiro exportado pelo OASIS terá o seguinte nome:
        "[DIA DA PRIMEIRA ETAPA]_[CLUBE ORGANIZADOR].csv"
        Ex.: Se no dia 30 de Janeiro de 2005 o clube Amigos da Orientação organizar uma prova, o ficheiro de exportação terá o seguinte nome: "2005-01-30_Amigos_da_Orientação.csv".

      • Colunas / Campos:
        Todos as colunas / campos e respectivos valores são separados por ';' (ponto e vírgula) e surgem pela seguinte ordem:
        Nome Campo Descrição Tipo Dados Valor Omissão Info exportação
        Stno ID da inscrição, é o número de dorsal (num. federado da FPO ou número atrubuido apenas para a prova, sendo no último caso, inferior a 1000)5 INTNOT NULLMTageID
        SI card1 Número do SI para a etapa 18 INTNULL-
        ...
        SI card6 Número do SI para a etapa 68 INTNULL-
        Database Id Número de FPO ou número do documento de identificação10 CHARNULLMTageDBID
        Surname Útltimo nome do atleta/par/grupo inscrito17 CHARNOT NULL-
        First name Primeiro nome o atleta/par/grupo inscrito 24 CHARNULL-
        YB Ano de Nascimento (útlimo dois digitos do ano) 2 INTNULL-
        S Sexo {M,F}NULL-
        Block1 Valor de dispersão para o sorteio da hora de partida na etapa 1{1,...,9}5-
        ...
        Block2 Valor de dispersão para o sorteio da hora de partida na etapa 2{1,...,9}5-
        E1Inscrição na etapa 1{X,0}0-
        ...
        E6Inscrição na etapa 6{X,0}0-
        nc1Marca se o atleta corre em regime de competição ou extra-competição na etapa 1 {X,0}0-
        Start1 Tempo de partida na Etapa 1 HH:MM:SS TIMENULL-
        Finish1 Tempos de chegada na Etapa 1 HH:MM:SS TIMENULL-
        Time1 Tempos de prova na Etapa 1 HH:MM:SS TIMENULL-
        Classifier1Marca se o atleta (após prova) está classificado na etapa 1 ou não {X,0}0-
        ...
        nc6Marca se o atleta corre em regime de competição ou extra-competição na etapa 6 {X,0}0-
        Start6 Tempo de partida na Etapa 6 HH:MM:SS TIMENULL-
        Finish6 Tempos de chegada na Etapa 6 HH:MM:SS TIMENULL-
        Time6 Tempos de prova na Etapa 6 HH:MM:SS TIMENULL-
        Classifier6 Marca se o atleta (após prova) está classificado na etapa ou não {X,0}0-
        Club no. Número do Clube 8 INTNOT NULLClubID
        Cl.name Nome do Clube. (???)10 CHARNULL-
        City Cidade do Clube30 CHARNOT NULLNick do Clube
        Nat Nacionalidade do inscrito3 CHARNULL-
        Cl. no. Número do escalão do inscrito8 INTNOT NULLClassID
        Short Nome curto do escalão do incrito6 CHARNOT NULLNome curto do esclão
        Long Nome Longo do escalão do inscrito20 CHARNOT NULLNome longo do escalão
        Num1 Campo 1 para números adicionais não definidos5 INTNULLNúmero de Federado/Dorsal
        Num2 Campo 2 para números adicionais não definidos5 INTNULLNúmero do grupo, se aplicável
        Num3 Campo 3 para números adicionais não definidos5 INTNULLNúmero de pessoas que fazem parte da inscrição/grupo
        Text1 Campo 1 para textos adicionais não definidos20 CHARNULLEstado das licenças (FR:Federado Renovado; FNR: Federado Não Renovado; NF: Não Federado)
        Text2 Campo 1 para textos adicionais não definidos20 CHARNULLInformação do User ID e Licença ([USERID]|[LICENSE]|[LICENSE PROVIDER ID])
        Text3 Campo 3 para textos adicionais não definidos20 CHARNULLIdentificação do atleta para efeitos de seguro. Documento de idenfiticação (ex.: BI, CC,Cédula,etc) ou Licença FPO
        Adr.NameNome da Morada24 CHARNULLIdentificação do atleta para efeitos de seguro. Documento de idenfiticação (ex.: BI, CC,Cédula,etc) ou Licença FPO
        Street Morada do inscrito24 CHARNULLIdentificação do atleta para efeitos de seguro. Documento de idenfiticação (ex.: BI, CC,Cédula,etc) ou Licença FPO
        Line2 Morada do inscrito (2ª linha) 24 CHARNULLIdentificação do atleta para efeitos de seguro. Documento de idenfiticação (ex.: BI, CC,Cédula,etc) ou Licença FPO
        Zip Código postal do inscrito10 CHARNULLUserID do último utilizador (excepto organização) a alterar a inscrição
        City Cidade do inscrito30 CHARNULLNome do Contacto
        Phone Telefone do inscrito20 CHARNULLTelefone do Contacto
        Fax Fax do inscrito20 CHARNULLTelefone do Contacto
        EMail E-Mail do inscrito40 CHARNULLe-Mail do Contacto
        Id/Club ID do clube4 INTNULL-
        Rented Aluger de SI{X,0}0-
        Start fee Preço da inscrição{6 INT},{2 INT} 0,00-
        PaidEstado do Pagamento de Inscrição{X,0}0-
        Total: 80 Campos




      • Manual de Registo de Alterações
          0. Introdução

          OASIS v1.0 [2006/08/25]

          OASIS v0.3.1 [2005/12/11]

          OASIS v0.3 [2005/11/10]

          OASIS v0.2 [2005/10/31]

          OASIS v0.1


          0. Introdução

            Este documento especifica a evolução do OASIS através das várias versões desenvolvidas. Para cada uma destas versões são apresentadas as alterações relativamente à versão anterior.

            Este documento será actualizado quando houver ajustes ou alterações que o justifiquem, pelo que deverá ser verificada a sua versão pouco antes da organização de uma prova.


          OASIS v1.0 [2006/08/25]

          Lançamento do OASIS como canal oficial para a realização das inscrições em todas as provas oficiais da FPO.
          • Implementação da ferramenta de exportação de inscrições para o MTage
          • Implementação de procura de inscrições por IDs da inscrição ou utilizador
          • Integração da ferramenta SplitsBrowser para visualização de resultados
          • Opção de filtrar e apagar as Obs-O das inscrições, nas provas em que o utilizador tem poderes de administrador

          OASIS v0.3.1 [2005/12/11]

          • Implementação da opção de Inscrição como Clube Individual (para inscrição individual apenas).
            Apesar de um utilizador estar registado num clube, existe a possibilidade de fazer a inscrição na prova como Clube Individual.

          • Adição de novos critérios de procura no formulário de procura de utilizadores (apenas disponível para SUPER-USER em SISTEMA->UTILIZADORES).

          OASIS v0.2 [2005/10/31]

          • Alteração da estutura de frames para tabela

          • No registo individual há 2 hipoteses:
            * Registo de utilizador + registar clube (sem licença na FPO). O clube pode ser tipo um nome para grupo de amigos, escola, associação,etc
            * Registo de utilizador sem clube

          • Utilizador individual pode registar outros users pelos quais fica responsável. A qualquer momento pode registar um (apenas um) clube.

          OASIS v0.1

          • Implementação de Inscrição Colectiva

          • Implementação de Inscrição em Grupo, especificando o número do grupo