GUIA DE UTILIZAÇÃO CONSOLA WEB DE CONFIGURAÇÃO SOFIA2

(1)

GUIA DE UTILIZAÇÃO

CONSOLA WEB

DE CONFIGURAÇÃO

SOFIA2

FEVEREIRO 2015 Versão 6

(2)

1 ÍNDICE

1 ÍNDICE ... 2

2 INTRODUÇÃO ... 6

2.1 REQUISITOS ... 6

2.2 OBJETIVOS E ÂMBITO DO PRESENTE DOCUMENTO ... 6

3 ACESSO À CONSOLA WEB ... 7

3.1 SOLICITAR O REGISTO DE UTILIZADOR ... 7

3.2 ACESSO À CONSOLA WEB ... 9

4 ACESSO ROL UTILIZADOR ... 12

5 ACESSO ROL COLABORADOR ... 14

6 ACESSO ROL ADMINISTRADOR ... 17

7. GESTÃO DE ONTOLOGIAS ... 20

7.1. INTRODUÇÃO DE ONTOLOGIAS ... 20

7.2. INTRODUÇÃO DE ONTOLOGIAS, CAMPO A CAMPO ... 23

7.3. CRIAÇÃO DE ONTOLOGIAS A PARTIR DO EXCEL ... 27

7.4. ESTADO DE TRANSFERÊNCIA DE EXCEL ... 33

7.5. CRIAÇÃO DE UMA ONTOLOGIA A PARTIR DA COLEÇÃO ... 34

7.6. LISTA DE ONTOLOGIAS ... 35

7.7. MODIFICAÇÃO DE ONTOLOGIAS ... 36

7.8. ELIMINAÇÃO DE ONTOLOGIAS... 39

7.9. SUBSCRIÇÃO A ONTOLOGIAS ... 39

7.10. AUTORIZAÇÕES DAS MINHAS ONTOLOGIAS ... 42

8. GESTÃO ONTOLOGIAS DE GRUPO ... 45

8.1. LISTA DE ONTOLOGIAS DE GRUPO ... 46

8.2. MODIFICAÇÃO DE ONTOLOGIAS DE GRUPO ... 48

8.3. ELIMINAR ONTOLOGIAS DE GRUPO ... 48

(3)

8.5. AUTORIZAÇÕES DE ONTOLOGIAS DE GRUPO ... 52 9. GESTÃO DE KPS/APPS ... 55 9.1. CRIAÇÃO DE KPS/APPS ... 55 9.2. LISTA DE KPS ... 57 9.3. MODIFICAÇÃO DE UM KP ... 58 9.4. GESTÃO DE TOKENS ... 60 9.5. GESTÃO DE INSTÂNCIAS DE KPS ... 62 10. CONTENTOR KPS/APPS ... 66

10.1. CRIAR KPS/APPS NO CONTENTOR ... 66

11. REGRAS ... 68

11.1. CRIAR REGRA COM WIZARD ... 68

11.2. CRIAÇÃO SCRIPT ... 69

11.2.1. Scripts do tipo Timmer ... 69

11.2.2. Scripts sobre ontologias ... 72

11.2.2.1. Scripts sobre Ontologias Principais ... 73

11.2.3. Scripts de tipo Cep ... 75

11.3. LISTA DE SCRIPT ... 77 11.4. DETALHE DE SCRIPT ... 78 11.5. EDIÇÃO DE SCRIPT ... 79 11.6. REGRAS CEP ... 80 11.7. EVENTO CEP ... 81 12. GESTÃO DE ASSETS ... 84 12.1. CRIAR ASSET ... 84 12.2. LISTAR ASSETS ... 86 12.3. DETALHE DE ASSETS ... 87 12.4. MODIFICAÇÃO DE ASSETS ... 88

(4)

12.6. LISTAR TIPOS DE ASSET ... 92

12.7. DETALHE DE TIPO DE ASSET ... 93

12.8. MODIFICAR OS TIPOS DE ASSET ... 94

12.9. CRIAR NÓ ... 95 12.10. LISTAR NÓS ... 97 12.11. DETALHE DE NÓ ... 97 12.12. MODIFICAÇÃO DE UM NÓ ... 98 13. VISUALIZAÇÕES ... 100 13.1. MEUS GADGETS ... 100 13.1.1. Criar Gadgets ... 100 13.2. MEUS DASHBOARDS ... 101 13.2.1. Criar Dashboards ... 101 14. FERRAMENTAS ... 103 14.1. CONSOLA BDTR E BDH ... 103

14.2. GESTÃO CONSULTAS PREDEFINIDAS ... 109

14.3. KPS ATIVOS ... 112

13.3.1 Pesquisa e consulta de instâncias de KPs Ativos ... 114

13.3.2 Realizar consultas BDTR sobre o KP Ativo ... 115

13.4. ENVIO DE MENSAGENS SSAP ... 115

13.5. VALIDAR UMA MENSAGEM JSON ... 117

13.6. VISUALIZAÇÃO DO ESTADO DE PROCESSOS ... 120

15. GESTÃO SW ... 122

15.1. GESTÃO DE CONFIGURAÇÃO DE SOFTWARE ... 122

15.2. ATRIBUIÇÃO DA CONFIGURAÇÃO DE SOFTWARE EM KPS ... 125

16. ADMINISTRAÇÃO ... 127

16.1. GESTÃO DE UTILIZADORES ... 127

(5)

16.1.2. LISTAR UTILIZADORES... 129

16.1.3. MODIFICAÇÃO DE UTILIZADORES ... 130

16.2. GESTÃO DE MODELOS DE ONTOLOGIAS ... 131

16.2.1. CRIAR UM NOVO MODELO ... 131

16.2.2. LISTAR MODELO ... 134 16.2.3. EDIÇÃO DE MODELOS ... 135 16.3. GESTÃO DE PEDIDOS ... 136 16.4. GESTÃO DE OPERAÇÕES ... 137 16.5. OPÇÕES DE ADMINISTRAÇÃO ... 138 17. API MANAGER ... 139

17.1. MINHA API KEY ... 141

17.2. MINHAS APIS ... 142

17.2.1. Janela de Criação de API ... 144

17.2.2. Janela de Consulta de API ... 156

17.2.3. Janela de Modificação de API... 156

17.3. AUTORIZAÇÕES APIS ... 161 17.4. SUBSCRIÇÃO A APIS ... 162 17.5. MINHAS SUBSCRIÇÕES ... 164 18. SOCIAL MEDIA ... 169 18.1. UTILIZADORES TWITTER ... 169 18.2. PESQUISA ... 169 18.3. TENDÊNCIAS ... 169 18.4. CONFIGURAÇÕES DE ACESSO... 170

(6)

2 INTRODUÇÃO

2.1 Requisitos

Antes de ler este guia, recomenda-se a leitura do guia SOFIA2-Conceitos SOFIA2.doc

2.2 Objetivos e âmbito do presente documento

O presente documento apresenta os conceitos básicos da Consola Web integrada na Plataforma de SOFIA2.

Através da Consola Web, os utilizadores em função de seu rol poderão realizar um conjunto de ações, como subscrever-se a ontologias, criar KPs, criar Ontologias,…

(7)

3 ACESSO À CONSOLA WEB

SOFIA2 pode implementar-se numa infraestrutura própria ou na Cloud. Existe uma versão Cloud de SOFIA2 que será a utilizada neste guia. A consola da Web está acessível na URL:

http://sofia2.com/console

3.1 Solicitar o registo de utilizador

Se é a primeira vez que acede a esta consola e não dispõe de utilizador será necessário solicitar o registo, para isso deverá carregar no link (link) para solicitar o registo de utilizador.

(8)

Uma vez enviado o pedido, validar-se-á o mesmo e, se este estiver correto ativar-se-á o utilizador com o rol de UTILIZADOR.

(9)

3.2 Acesso à Consola Web

Uma vez criado o utilizador poderá aceder à Consola Web com o novo utilizador:

Quando se cria um utilizador na Plataforma, cria-se com o Rol UTILIZADOR, o que implica apenas um acesso limitado e de leitura à Plataforma.

(10)

Pode solictar-se acesso à Plataforma com o Rol de COLABORADOR, o que permite inserir dados na Plataforma.

Para isso, deve carregar no link que se encontra na parte superior da página, onde se indica o

utilizador com login efetuado na plataforma: Utilizador: xxxx [ROL_UTILIZADOR]. No formulário que se apresenta a seguir, carregue no botão Alterar para Colaborador:

(11)

Enviar-se-á um pedido de alteração de Rol para o rol de Colaborador ao Administrador. Quando o Administrador receber o pedido, este poderá aceitá-lo ou recusá-lo, informando o utilizador através de um correio eletrónico da resolução do pedido. Caso o pedido de alteração seja aceite, o utilizador poderá, ao efetuar o login novamente na consola, verificar se tem acesso a mais funcionalidades.

(12)

4 ACESSO ROL UTILIZADOR

Um utilizador com o rol de Utilizador tem acesso a estas opções de menu: ONTOLOGIAS Minhas Subscrições  ONTOLOGIAS DE GRUPO Minhas Subscrições  KPs/APPs SOFIA2 Meus KPs/APPs Meus Tokens

Minhas Instâncias KP/APP



FERRAMENTAS

Consulta BDTR e BDH

KPs Ativos

Envio de Mensagens SSAP

Validar Mensagens SSAP

(13)

API MANAGER

Subscrição a APIs

Minhas Subscrições

(14)

5 ACESSO ROL COLABORADOR

Um utilizador com o rol de Colaborador tem acesso a estas opções de menu: ONTOLOGIAS

Criar Ontologia

Criar Ontologia campo a campo Criar Ontologia a partir de Excel Minhas Ontologias

Minhas Subscrições

Autorizações das minhas Ontologias



ONTOLOGIAS DE GRUPO

Criar Ontologia de Grupo Minhas Ontologias de Grupo Minhas Subscrições



KPs/APPs SOFIA2

Meus KPs/APPs Meus Tokens

Minhas Instâncias de KP/APP

o

REGRAS DE ASSETS

(15)

Minhas Regras CEP Meus Eventos CEP

ATIVOS Meus Assets Visualizar Assets Tipos de Assets Nós  VISUALIZAÇÕES Meus Gadgets Meus Dashboards FERRAMENTAS Consola BDTR e BDH Gestão Consultas Predefinidas KPs Ativos

Envio de Mensagens SSAP Validar Mensagem SSAP

Visualização de Estado de Processos



GESTÃO SW

(16)

Atribuição Configuração API MANAGER Minhas APIs Autorizações APIs Subscrição a APIs Minhas Subscrições Minha API Key

(17)

6 ACESSO ROL ADMINISTRADOR

Um utilizador com o rol de Administrador tem acesso a estas opções de menu: ONTOLOGIAS

Criar Ontologia

Criar Ontologia campo a campo Criar Ontologia a partir de Excel Minhas Ontologias



ONTOLOGIAS DE GRUPO

Criar Ontologia de Grupo Minhas Ontologias de Grupo Autorizações das minhas Ontologias



KPs/APPs SOFIA2

Meus KPs/APPs Meus Tokens

Minhas Instâncias de KP/APP

o

REGRAS DE ASSETS

Criar Regra com Wizard Meus Scripts

(18)

ATIVOS Meus Assets Visualizar Assets Tipos de Assets Nós  VISUALIZAÇÕES Meus Gadgets Meus Dashboards FERRAMENTAS Consola BDTR e BDH Gestão Consultas Predefinidas KPs Ativos

Envio de Mensagem SSAP Validar Mensagem SSAP

Visualização de Estado de Processos



GESTÃO SW

Minhas Configurações SW Atribuição Configuração

(19)

ADMINISTRAÇÃO

Gestão de Modelos de Ontologias Gestão de Operações Gestão de Pedidos Gestão de Utilizadores API MANAGER Minhas APIs Autorizações APIs Minhas Subscrições Minha API Key

(20)

7. GESTÃO DE ONTOLOGIAS

Permite realizar uma Gestão Completa de Ontologias, isto é:  Criar e Modificar Ontologias

 Procurar Ontologias por critérios

 Procurar Ontologias e subscrever-se às mesmas.

O objetivo das ontologias é ser o esquema através do qual se validarão as inserções de ontologias por parte dos KPs.

7.1. Introdução de Ontologias

Através da opção de menu Ontologia, um utilizador com o rol colaborador ou rol de administrador poderá definir e introduzir no Sistema novas ontologias. Pode aceder ao formulário a partir do menu, na opção Criar Ontologia, o utilizador deverá indicar:

 Nome com o qual pretende identificar a nova ontologia  Versão atual do modelo selecionado. Campo não editável  Se a ontologia será ativa

 Se a ontologia será pública para os utilizadores restantes.

 Tempo de passagem da informação armazenada na Base de Dados de Tempo Real (BDTR) para a Base de Dados de informação Histórica (BDH). Selecionar-se-á uma programação para esse passo. Se pretende que o campo permaneça vazio, não se ativará esse passo.

 Se em vez de realizar a passagem da informação da BDTR para a BDH, se desejar eliminar a informação. Ao selecionar esta opção, o período selecionado como Tempo de passagem, passa a considerar-se como Tempo de eliminação da informação armazenada na BDTR.

(21)

 Classe pré-processamento passagem da BDTR para a BDH: inclui uma caixa de verificação que disponibiliza um campo de texto para introduzir o nome de uma classe (deve existir no classpath, através de um plugin) que realizará o MapReduce na passagem dos dados da BDTR para a BDH. Quer a caixa de verificação, assim como a caixa de texto apenas estão disponíveis para os utilizadores administradores.

 Dependências entre Ontologias: Inclui uma caixa de verificação que indica se a ontologia será uma ontologia principal ou não. Se selecionar esta opção, poder-se-ão criar ontologias que se estendem a partir de esta. Além disso inclui uma caixa de combinação, na qual (não sendo uma ontologia principal) poderá selecionar-se a ontologia principal a partir da qual se estenderá (cujo esquema utilizar-se-á para a nova ontologia secundária).

Se não se selecionar nenhuma opção, a ontologia será uma ontologia que se tratará de forma normal.

Definir-se-ão 3 tipos de Ontologias:

o Ontologias Principais. Serão Ontologias abstratas (sem instâncias) sobre as quais não se poderá realizar nenhum tipo de operação.

o Ontologias Secundárias. Serão ontologias que se estenderão a partir de uma Ontologia Principal (utilizarão o respetivo esquema). Manterão a sua própria configuração quanto à segurança e backup nas BD.

o Ontologias de tipo geral. As ontologias que se conhecem até agora (a gestão e funcionamento das mesmas utilizadas até agora).

A Ontologia Principal apenas será visível para os utilizadores Administradores, para o utilizador criador e para os utilizadores que tenham sido autorizados a aceder à mesma. Para cada um destes utilizadores, apresentar-se-á a Ontologia Principal na listagem de Ontologias e na caixa de combinação Ontologia principal a partir da qual se estende

este componente.

 Modelo ou ficheiro xsd a utilizar na definição da ontologia: Caso selecione o ficheiro xsd após examinar o ficheiro, deverá carregar no botão Gerar Ontologia para que no editor se carregue o esquema associado ao mesmo.

(22)

 O esquema da ontologia

(23)

Os utilizadores com o rol de Administrador ou Colaborador terão privilégios para criar ontologias.

No caso particular do Colaborador, uma vez que este tenha criado a ontologia adquirirá as permissões ALL sobre essas ontologias. Embora não seja o proprietário, o administrador terá plenos privilégios sobre todas as ontologias.

Como ajuda para a introdução de uma ontologia, existe um gerador de Instâncias JSON. Se carregar no botão Gerar Instância, apresentar-se-á na secção Instância JSON um exemplo de uma instância da ontologia que se pretende introduzir, tendo em conta o esquema da ontologia.

7.2. Introdução de Ontologias, campo a campo

De forma análoga, ao introduzir ontologias, um utilizador poderá criar ontologias sem a necessidade de escrever diretamente o esquema JSON da respetiva ontologia.

Para isso, a consola de administração oferece no menu, na secção de Ontologias, a opção Criar Ontologia campo a campo.

Oferece ao utilizador as mesmas opções que a janela de Introdução de ontologias da secção anterior, com as mesmas funcionalidades (Ver secção 10.1 Introdução de Ontologias), em conjunto com um formulário para a definição das propriedades, que deve ter a ontologia ao ser introduzida:

(24)

Neste formulário é possível introduzir todas as propriedades da ontologia a criar, incluindo o respetivo tipo de dados e indicando se se trata de uma propriedade exigida ou não.

Uma vez definida a propriedade, ao carregar no botão Adicionar, esta será incluída na tabela de propriedades da ontologia.

(25)

Os tipos de dados disponíveis para criar propriedades, a partir do assistente são os básicos de JSON-Schema, em conjunto com os tipos timestamp e geometry para explorar as capacidades da BDTR, processando estes tipos de dados.

Uma vez definidas todas as propriedades da ontologia, estas serão apresentadas na tabela de propriedades, onde poderão ser eliminadas, caso se detete que alguma propriedade não deve fazer parte da ontologia.

Antes de gerar o esquema da ontologia, é possível indicar se aceita propriedades adicionais às declaradas ou não. Para isso, dispõe da caixa de combinação Additional Properties (Propriedades Adicionais).

Caso não se indique o valor ou se se indicar como false (falso), a ontologia não permitirá adicionar instâncias da ontologia com outras propriedades diferentes às indicadas. Caso se indique como true (verdadeiro), serão admitidas outras propriedades diferentes das indicadas. Uma vez especificadas as propriedades e a restrição Additional Properties (Propriedades Adicionais), é possível gerar o esquema da ontologia ao carregar no botão Gerar ontologia. Isto fará com que no editor de ontologias da página apareça o esquema JSON da ontologia com a definição das propriedades indicadas.

(26)

Este esquema é editável, para que antes de criar a ontologia na plataforma, seja possível editar manualmente o esquema para por exemplo adicionar outros campos com outros tipos de dados.

A estar conforme com o esquema, é possível criar a ontologia ao carregar no botão criar.

NOTA:

Não é possível gerar uma ontologia sem propriedades, exceto se especificar a restrição additional properties a true. Isto é, para não existirem ontologias que imponham nas suas instâncias de ontologia a restrição de ontologias vazias.

(27)

7.3. Criação de Ontologias a partir do Excel

Através desta opção, é possível criar automaticamente uma ontologia a partir de um ficheiro Excel ou csv.

Esta opção de menu está disponível para o Rol de Colaborador e Rol de Administrador. A janela apresentada nesta opção será a seguinte:

Este ecrã é similar à janela Criar Ontologia, mas inclui um controlo para permitir a seleção de um ficheiro de tipo Excel/CSV. Esse ficheiro conterá a informação referida numa ontologia nova

(28)

que se pretende criar ou adicionar a uma ontologia já existente. Esta situação pode configurar-se na opção Modo de carregamento.

Também existem duas opções a partir das quais pode fazer o download do ficheiro: Local e Servidor. Se selecionar a opção Servidor aparecem os ficheiros Excel/CSV carregados previamente nesse servidor.

Por outro lado, se marcar a origem do ficheiro Local, permitir-se-á selecionar o Excel/CSV a transferir, ao carregar em Selecionar arquivo. Se o arquivo for de tipo CSV, apresentar-se-á um campo adicional que servirá para indicar que carácter delimitador se utilizará nesse ficheiro (para poder analisá-lo).

(29)

Este campo (Delimitador CSV) será editável e esse carácter utilizar-se-á para a análise do arquivo para o carregamento dos respetivos dados. Também deve selecionar-se o carácter decimal utilizado no ficheiro.

Adicionalmente, indicar-se-á se o arquivo a carregar inclui cabeçalhos que contenham os ids das colunas e que servirão para identificar os atributos da ontologia a gerar.

Uma vez selecionados estes dados, carregar-se-á no botão Transferir atributos em Excel/CSV. Uma tabela que incluirá os dados do Excel será carregada:

- Caso a primeira fila contenha cabeçalhos:

(30)

- Na primeira coluna mostra-se o Identificador da mesma. Se não selecionou a caixa “Ids da coluna na primeira fila” estão apresentar-se-ão vazios/não preenchidos. Em ambos os casos é um campo editável.

- Na segunda coluna apresentam-se os dados correspondentes à segunda fila do ficheiro, para servir de exemplo.

- Na terceira coluna apresenta-se o tipo de dados a que pertencem. Na versão atual são permitidos os tipos: String, Boolean, Number, Geometry-LAT e Geometry-LON. É modificável e o utilizador deve defini-lo. Em princípio está selecionado o tipo String.

o Quanto aos tipos, apenas se permite um tipo geográfico (uma caixa de combinação de Geometry-LAT e Geometry-LON). Sempre que houver um desses tipos, também tem de estar presente o outro. Para validação adicional, não se podem selecionar vários tipos desses dois (mais de um LAT ou mais de um

Geometry-LON).

- A quarta coluna apresenta uma caixa de verificação que permitirá selecionar as colunas que serão carregadas durante o processo.

Por baixo da tabela incluem-se dois botões. Gerar Esquema e Selecionar outro ficheiro. O botão Selecionar outro ficheiro eliminará o ficheiro selecionado e eliminará os atributos, o esquema gerado e a instância associada ao esquema da tabela.

Ao carregar em Gerar Esquema, gerar-se-á o esquema correspondente, utilizando para isso os atributos selecionados na tabela (com os respetivos identificadores e tipos associados) e o nome da ontologia.

(31)

Por baixo do esquema, encontra-se o botão Gerar Instância.

Se se carregar em Gerar Instância, gerar-se-á uma instância da ontologia utilizando o esquema gerado.

(32)

Para terminar, deverá carregar em Criar, para criar a ontologia e carregar os dados incluídos no Excel. Finalizado o processo, será reencaminhado para a janela de consulta, onde se apresentará um relatório de carregamento de dados:

Para além de se criar a ontologia, transferir-se-á a informação desta na BDTR, ficando assim pronta para ser consumida.

(33)

7.4. Estado de transferência de Excel

Através desta opção, é possível consultar o estado de transferência de ficheiros Excel nas Minhas ontologias. Esta funcionalidade está concebida para ficheiros de grande tamanho onde o processo de carregamento pode ser longo.

Esta opção de menu está disponível para o Rol de Colaborador e Rol de Administrador. A janela apresentada nesta opção será a seguinte:

Aparece uma lista com os processos de carregamento das Minhas ontologias a partir do Excel/CSV onde se indica o Nome da ontologia, Estado em que se encontra, número de registos carregados e a data/hora do último carregamento realizado. Se se selecionar o botão

apresenta-se um resumo do último carregamento.

Ao carregar em “Atualizar estado de carregamento” voltam a carregar-se os dados da tabela com a informação atualizada dos processos carregados.

(34)

7.5. Criação de uma Ontologia a partir da Coleção

Através desta opção é permitido criar ontologias a partir de coleções de MongoDB. Ao ligar-se a uma instância de MongoDB já existente, converte-se visualmente uma coleção numa ontologia.

Esta opção de menu está disponível para o Rol de Colaborador e o Rol de Administrador. A janela apresentada nesta opção será a seguinte:

Ao selecionar uma coleção das existentes na BDTR aparece o Registo da Coleção com o botão Gerar Esquema.

(35)

Por último, no ponto Parametrização podemos configurar a ontologia: ativa, pública/privada e configuração BDTR e BDH. Para guardar a ontologia carregue no botão Criar.

7.6. Lista de Ontologias

Apenas os utilizadores registados na plataforma com roles de Colaborador e Administrador terão a possibilidade de listar ontologias na plataforma. Os utilizadores Administradores terão plenos direitos sobre todas as ontologias, por outro lado o Colaborador poderá gerir todas as ontologias que sejam da sua propriedade.

Ao aceder à funcionalidade através da opção de menu Minhas Ontologias apresentar-se-á a seguinte página:

(36)

Será permitido realizar pesquisas sobre as ontologias às quais tem permissões. Para filtrar a informação apresentada na lista, podem ser preenchidos os campos:

 Nome. Será permitido realizar pesquisas parciais, isto é, se se introduzir um A e se carregar no botão “Procurar” serão apresentadas as ontologias que começam por essa letra.

 Descrição: Poderão realizar-se pesquisas sobre textos que posam estar contidos nas descrições.

Para aceder ao detalhe das ontologias que se apresentam na listagem, deverá carregar-se no botão situado à direita de cada uma das entradas apresentadas na listagem.

As opções que se permitem realizar a partir desta janela dependerão das permissões que tem o utilizador, que está a visualizar a ontologia:

 Utilizadores com sessão iniciada e com o rol de Administrador: Todas as opções (modificar e eliminar).

 Utilizadores registados com o rol de Colaborador: Todas as opções aplicáveis às ontologias das quais é proprietário, para as restantes ontologias poderá apenas visualizá-las em modo de consulta.

7.7. Modificação de ontologias

As ontologias poderão ser modificadas a partir da opção de menu Minhas Ontologias e apenas se tiver permissões para esse efeito. Tem de clicar no ícone ver, que aparece na lista de ontologias: e posteriormente no botão Modificar.

(37)

É possível modificar toda a informação de uma ontologia (descrição, esquema, identificação, etc.). Os campos Versão e Versão de Modelo utilizada fazem referência à Versão de Modelo Atual e à Versão com a qual se criou a ontologia, são campos unicamente informativos, tal como o campo Nome.

Aparecerá um formulário como o da criação, mas com a informação da ontologia introduzida no momento da criação:

(38)

(39)

As ontologias poderão ser editadas pelos utilizadores que têm privilégios para esse efeito:  Administradores: Poderão editar qualquer ontologia.

 Colaboradores: Apenas poderão editar as suas próprias ontologias ou as ontologias nas quais tem permissões.

7.8. Eliminação de ontologias

A partir da Consola Web também é possível eliminar ontologias. Ao modificar uma ontologia é possível indicar se a ontologia estará ativa ( ) ou não ( ). Pode considerar-se a eliminação lógica da ontologia.

As permissões para poder eliminar a ontologia são idênticas às de edição:  Administradores: Poderão editar qualquer ontologia.

 Colaboradores: Apenas poderão editar as suas próprias ontologias ou sobre as quais tem permissões.

Também é possível eliminar uma ontologia se tiver permissões para isso ou se for o proprietário da mesma. É necessário aceder ao detalhe da ontologia, a partir da listagem de ontologias e carregar no botão “Eliminar”. Caso se trate de uma Ontologia Principal, apenas poderá eliminar-se se não existir nenhuma Ontologia secundária que se estenda da mesma.

7.9. Subscrição a Ontologias

Pode aceder-se a esta opção de menu a partir do Rol de Colaborador e Rol do Utilizador. A partir da opção de menu Minhas Subscrições é possível pesquisar ontologias pelos seguintes filtros:

(40)

 Descrição

Ao clicar no botão “Pesquisar” pesquisar-se-ão todas as ontologias que cumpram os filtros indicados.

As ontologias apresentadas nas duas listas que aparecem na página serão:

 Lista de Ontologias: As ontologias públicas às quais pode subscrever o utilizador registado e que ainda não foram subscritas.

 Lista das minhas Subscrições: As ontologias próprias, as que já foram subscritas e às quais o administrador concedeu permissões ao utilizador.

(41)

A partir de qualquer uma das duas listas, os utilizadores poderão subscrever ou anular a subscrição às ontologias apresentadas. Para isso, na lista carregará na opção de detalhe da ontologia à qual pretende subscrever ou eliminar a subscrição.

Ao fazer clique em aparecerá outra vista na qual se apresentará informação sobre a

ontologia e os botões para efetuar a subscrição ou eliminar a mesma.

(42)

Se carregar em Subscrever, aparecerá uma janela como a seguinte:

Ao carregar em “Aceitar” o utilizador estará subscrito à ontologia e receberá notificações sobre a mesma de forma periódica. É importante indicar que uma vez que um utilizador se subscreveu a uma ontologia, este adquire as permissões de QUERY nesse mesmo momento. O utilizador poderá anular a subscrição às ontologias, a partir da lista “lista das minhas subscrições” ao clicar em e ao carregar no botão Anular subscrição. Aparecerá uma janela como a seguinte, que permitirá anular a subscrição à ontologia.

Ao carregar em “Aceitar”, o utilizador deixará de receber notificações de inserções de ontologia.

7.10. Autorizações das minhas Ontologias

Apenas os utilizadores com o rol de administrador terão acesso e poderão alterar as permissões que têm os utilizadores sobre as ontologias do Sistema.

A Plataforma conta com três roles:  Administrador

 Colaborador  Utilizador

Conforme o rol, os utilizadores terão ou não determinadas permissões para interoperar na Plataforma.

 ROL_UTILIZADOR: Utilizadores com permissões básicas. Os utilizadores com este rol poderão subscrever e realizar consultas sobre as ontologias e dados públicos, assim

(43)

como criar os seus próprios KPs. O detalhe pode verificar-se no ponto “4 Acesso Rol

Utilizador”.

 ROL_COLABORADOR: São utilizadores que poderão criar KPs e ontologias, definir consultas e subscrever-se a ontologias. O detalhe pode verificar-se no ponto “5 Acesso

Rol Colaborador”.

 ROL_ADMINISTRADOR: São utilizadores que poderão gerir todas as áreas da Consola Web da Plataforma, poderão registar utilizadores, ontologias, KPs, outro tipo de informação, definir autorizações entre utilizadores e ontologias. O detalhe pode verificar-se no ponto “6 Acesso Rol Administrador”.

As permissões que um utilizador tem numa ontologia estão limitadas pelo rol e pelas permissões que o administrador aplicar através desta funcionalidade.

As permissões que se podem associar a cada utilizador em relação com uma ontologia são as seguintes:

 QUERY: Permitirá realizar consultas sobre as inserções de ontologias realizadas pelos KPs, introduzidos pelo utilizador proprietário.

 INSERT: Permitirá realizar inserções de ontologia através dos KPs introduzidos pelo utilizador proprietário.

 ALL: Com estes privilégios, o utilizador poderá incluir as permissões QUERY e INSERT numa antologia.

Ao aceder à funcionalidade através da opção de menu, observa-se a lista das permissões que tem cada utilizador para cada uma das ontologias:

Para criar uma nova autorização, deve selecionar-se um utilizador, uma ontologia e o tipo de permissão que se pretende conceder ao utilizador selecionado para a ontologia e carregar no botão Guardar.

(44)

Uma vez aplicadas as permissões, estas serão apresentadas na lista inferior. A lista de autorizações está localizada na parte inferior da página, permitindo a eliminação dos registos apresentados ao carregar no botão situado à direita de cada associação de privilégios. Para que um utilizador possa criar Ontologias Secundárias a partir de uma Principal, o utilizador criador (o um utilizador com o ROL_AMINISTRADOR) deve autorizar o utilizador a utilizar a Ontologia Principal previamente.

(45)

8. GESTÃO ONTOLOGIAS DE GRUPO

Através da opção de menu Criar Ontologia de Grupo um utilizador com o rol colaborador ou o rol administrador poderá definir e criar no Sistema novas ontologias de grupo.

O formulário está acessível a partir do menu na opção de Ontologias de Grupo, o utilizador deverá indicar:

 Nome com o qual deseja identificar a nova ontologia de grupo

 Tempo em segundos durante o qual o SIB deve compor as instâncias de grupo.  Se a ontologia será pública para os restantes utilizadores.

 Descrição para indicar o que pretende representar a ontologia de grupo.

 Deverá selecionar as ontologias que compõem a ontologia de grupo. As ontologias disponíveis para selecionar são ontologias públicas e sobre as quais o utilizador tem permissões.

 O utilizador poderá criar uma ou várias instâncias de ontologia de grupo. Para criar uma instância de ontologia, deverá definir-se um nome de instância

o Deverá selecionar-se para cada uma das ontologias de grupo que compõem a ontologia de grupo, o atributo de agrupamento.

o E para cada atributo de agrupamento o valor pelo qual se pretende agrupar, também para cada uma das ontologias.

(46)

Os utilizadores com rol de Administrador o Colaborador terão privilégios para criar ontologias de grupo e poderão criar as ontologias sobre as quais têm permissões.

8.1. Lista de Ontologias de Grupo

Apenas os utilizadores registados na plataforma com rol de Colaborador e Administrador terão a possibilidade de Listar ontologias de grupo da plataforma. Os utilizadores Administradores

(47)

terão plenos direitos sobre todas as ontologias, por outro lado o Colaborador poderá gerir todas as ontologias que sejam da sua propriedade.

Ao aceder à funcionalidade através da opção de menu Minhas Ontologias Grupo apresentar-se-á a seguinte página:

Permitir-se-á realizar pesquisas nas ontologias, nas quais tem permissões. Para filtrar a informação apresentada na lista, poderão preencher-se os campos:

 Nome. Permitir-se-á realizar pesquisas parciais, isto é, se se introduzir um A e se carregar no botão “Procurar” apresentar-se-ão sob a forma de uma lista as ontologias de grupo que começam por essa letra.

 Descrição

Para aceder ao detalhe das ontologias de grupo que se apresentam na lista, deverá carregar no botão situado à direita de cada uma das entradas mostradas na lista.

Ao aceder ao detalhe da ontologia de grupo apresentar-se-á o detalhe da ontologia e poder-se-á modificar ou eliminar a ontologia de grupo se tiver permissões para esse efeito.

As opções que se permitem realizar a partir desta janela dependerão das permissões que tem o utilizador que está a visualizar a ontologia:

 Utilizadores com sessão iniciada e com rol o Administrador: Todas as opções.

 Utilizadores registados com o rol Colaborador: Todas as opções sobre as ontologias de que é proprietário, para as restantes ontologias que pode visualizar apenas poderá aceder em modo consulta.

(48)

8.2. Modificação de Ontologias de Grupo

As ontologias de grupo poderão ser modificadas a partir da opção de menu Minhas

Ontologias de grupo, ao clicar na ontologia de grupo que se pretende alterar, no ícone de

edição que aparece na lista de ontologias: .

É possível modificar toda a informação de uma ontologia de grupo (descrição, temporizador, identificação, etc.). Também é possível modificar os valores das instâncias definidas, assim como criar novas instâncias ou eliminá-las, ao clicar na instância que se pretende modificar. Aparecerá um formulário como o de criação, mas com a informação da ontologia introduzida no momento da criação:

Os utilizadores com permissões poderão editar ontologias:  Administradores: Poderão editar qualquer ontologia.

 Colaboradores: Apenas poderão editar as suas próprias ontologias.

8.3. Eliminar Ontologias de Grupo

A partir da Consola Web também é possível eliminar ontologias de grupo, ao modificar uma ontologia de grupo é possível indicar se a ontologia estará ativa ( ) ou não

(49)

As permissões para poder eliminar a ontologia são as mesmas que para opção de edição:  Administradores: Poderão editar qualquer ontologia.

 Colaboradores: Apenas poderão editar as suas próprias ontologias.

8.4. Subscrição a Ontologias de Grupo

Pode aceder-se a esta opção do menu com o Rol de Colaborador e Rol de Utilizador.

A partir da opção de menu Minhas Subscrições é possível procurar ontologias de grupo através dos seguintes filtros:

 Nome da ontologia de grupo  Descrição:

Ao clicar no botão “Procurar” procurar-se-ão todas as ontologias de grupo que cumprem os critérios dos filtros indicados.

As ontologias que serão apresentadas nas duas listas que aparecem na página serão as seguintes:

 Lista de Ontologias de grupo: As ontologias de grupo públicas às quais o utilizador não está subscrito.

 Lista das Minhas Subscrições: As ontologias de grupo às quais o utilizador está subscrito ou sobre as quais o administrador concedeu permissões ALL, INSERT ou QUERY ao utilizador.

(50)

A partir das listas, os utilizadores poderão subscrever ou anular a subscrição das ontologias apresentadas ao carregar na ontologia de grupo à qual pretende subscrever-se ou anular a subscrição.

Ao clicar em na lista de ontologias de grupo, aparecerá outra visualização na qual se

(51)

Se carregar em Subscrever aparecerá uma janela com a mensagem seguinte:

Ao carregar em “Aceitar” o utilizador estará subscrito à ontologia e receberá notificações sobre a mesma de forma periódica. É importante indicar que uma vez que um utilizador se subscreveu a uma ontologia, este adquire as permissões de QUERY na mesma altura.

O utilizador poderá anular a subscrição das ontologias a partir da lista “lista das minhas subscrições”, ao clicar em e ao carregar no botãon Anular Subscrição. Aparecerá uma janela como a seguinte, que permitirá anular a subscrição à ontologia.

(52)

8.5. Autorizações de Ontologias de Grupo

Apenas os utilizadores com o rol de administrador poderão aceder à ontologia e alterar as permissões que têm os utilizadores sobre as ontologias do Sistema.

A Plataforma conta com três roles:  Administrador

 Colaborador  Utilizador

Conforme o rol, os utilizadores terão umas ou outras permissões para interoperar com a Plataforma.

 ROL_UTILIZADOR: Utilizadores com permissões básicas. Os utilizadores com este rol poderão subscrever e realizar consultas sobre as ontologias e dados públicos, assim como criar os seus próprios KPs. É possível ver o detalhe no ponto “4 Acesso Rol

Utilizador”.

 ROL_COLABORADOR: São utilizadores que poderão introduzir KPs e ontologias, definir consultas e subscrever-se a ontologias. É possível ver o detalhe no ponto “5

Acesso Rol Colaborador”.

 ROL_ADMINISTRADOR: São utilizadores que poderão gerir todas as áreas da Consola Web da Plataforma, poderão registar utilizadores, ontologias, KPs, outro tipo de informação, definir autorizações entre utilizadores e ontologias. É possível ver o detalhe no ponto “6 Acesso Rol Administrador”.

As permissões que um utilizador tem sobre uma ontologia são limitadas pelo rol e pelas permissões que o administrador aplica através desta funcionalidade.

As permissões que se podem associar a cada utilizador em relação com uma ontologia são as seguintes:

 QUERY: Permitirá realizar consultas sobre as inserções de ontologias que realizam os KPs introduzidos pelo utilizador proprietário.

 INSERT: Permitirá realizar inserções de ontologia para os KPs introduzidos pelo utilizador proprietário.

 ALL: O utilizador com estes privilégios sobre uma ontologia englobará as permissões QUERY e INSERT.

Ao aceder à funcionalidade através da opção de menu, observar-se-á a lista das permissões que tem cada utilizador para cada uma das ontologias:

(53)

Para criar uma nova autorização, é necessário selecionar o utilizador, a ontologia de grupo e a permissão que se pretende aplicar ao mesmo e carregar no botão de Guardar.

Uma vez aplicadas as permissões, aparecerá na lista inferior a nova autorização junto com as restantes autorizações. É possível eliminar uma autorização ao carregar na lista no botão situado à direita de cada associação de permissões:

(54)

(55)

9. GESTÃO DE KPs/APPs

Permite gerir os KPs com os quais vai interatuar a Plataforma:  Criar e modificar KPs

 Procurar KPs  Ver KPs Ativos

 Gerir os Tokens e instâncias associadas a um KP.

9.1. Criação de KPs/APPs

Através da opção de menu Meus KPs/APPs, qualquer utilizador registado na plataforma poderá criar no Sistema novos KPs. Ao clicar na opção Criar KP o utilizador deverá completar o formulário com a seguinte informação:

 Identificação do KP

 Chave de encriptação: Esta chave permitirá enviar mensagens encriptadas através de

XXTEA. No guia APIs SOFIA2 pormenoriza-se a utilização da interface de KP para

utilizar este método de encriptação.  Descrição do KP

 Poder-se-ão selecionar as Ontologias ou ontologias de grupo com as quais vai trabalhar o KP

 Outra meta-informação de interesse para o KP.

Os campos obrigatórios são o Identificador de KP e uma ou várias ontologias associadas ao KP. Os campos restantes são opcionais, mas é recomendável definir o KP da forma mais clara possível para que represente bem a sua tarefa.

Pode aceder-se dentro da Consola Web à criação de KPs, a partir do formulário de pesquisa de KPs.

(56)

Preencher-se-á a informação do nosso novo KP. Uma vez preenchidos os campos para definir um novo KP carregar-se-á no botão “Criar” situado na parte inferior direita do formulário. Se não se preencher algum dos campos obrigatórios, não será permitido criar o KP apresentando uma mensagem informativa.

Uma vez guardada a informação do novo KP, apresentar-se-á o detalhe do KP criado:

Conforme mencionado anteriormente neste ponto, qualquer utilizador poderá criar KPs na plataforma, mas dependendo das permissões de que dispõe o utilizador, poder-se-ão criar KPs sobre umas ontologias ou outras:

 Utilizador com o rol de Administrador: Poderá criar KPs em qualquer ontologia criada na plataforma.

(57)

 Utilizador com o rol de Colaborador e Restantes Utilizadores: Poderá criar KPS nas ontologias sobre as quais tem algum tipo de privilégio:

o Poderá criar KPs Consumer nas ontologias sobre as quais tem permissões QUERY ou ALL.

o Poderá criar KPs Producer nas ontologias sobre as quais tem permissões INSERT ou ALL.

o Poderá criar KPs Proconsumer nas ontologias sobre as quais tem permissões ALL.

É importante sublinhar que não se especifica o tipo de KP na criação de KP a nível do fornecedor/consumidor de informação, é um aspecto intrínseco às ontologias com as quais está relacionado e os privilégios que tem o utilizador sobre essas ontologias.

9.2. Lista de KPs

A partir desta funcionalidade permite-se listar todos os KPS sobre os quais o utilizador com sessão iniciada tem privilégios.

Ao aceder à funcionalidade a partir da opção de menu “Meus KPs/APPs” apresenta-se o formulário de pesquisa com a lista de KPs sobre os quais o utilizador tem acesso:

Permite realizar-se pesquisas nos seguintes campos:

(58)

 Ontologia de grupo: Ontologias de grupo com as quais pode estar relacionado o KP  Nome: Nome ou Identificador do KP. Permitir-se-á realizar as pesquisas parciais, isto é,

se se introduzir um A e se carregar no botão “Procurar” serão apresentados os KPs que começam por essa letra.

 Descrição: O funcionamento é como o do campo Nome.

Uma vez introduzidos os valores para realizar o filtro deve carregar-se no botão “Procurar” situado na parte inferior direita do formulário.

Adicionalmente, a partir do formulário tem a opção de criar um novo KP e aceder à funcionalidade descrita no ponto 9.1.

A partir da lista, poder-se-á aceder ao detalhe do KP, modifica-lo ou eliminá-lo

Os KPs que se apresentarão em função do rol do utilizador com sessão iniciada na Consola Web serão os seguintes:

 Utilizadores com o rol de Administrador: Poderão realizar toda a operativa definida em todos os KPs criados na plataforma.

 Utilizadores com o rol de Colaborador e restantes utilizadores: Poderão gerir os KPs que criaram na plataforma.

9.3. Modificação de um KP

A partir da opção de menu “Meus KPs/APPs”, ao carregar na opção , os utilizadores poderão modificar toda a informação do KP (identificação, descrição, ontologias, etc.)

(59)

As validações e restrições realizadas nesta página são as mesmas que as definidas para a criação do KP.

Após efetuar as alterações necessárias no KP, carregar-se-á no botão “Guardar” situado na

parte inferior direita do formulário para registar essas alterações. Se efetuou esta ação corretamente, registar-se-ão as alterações e apresentar-se-á o detalhe do KP, com as alterações aplicadas.

(60)

Os KPs poderão ser editados, em função dos roles do utilizador registado na Consola Web. Estão são:

 Utilizadores com o rol de Administrador: Poderão realizar toda a operativa definida em todos os KPs criados na plataforma.

 Utilizadores com o rol de Colaborador e restantes utilizadores: Poderão gerir os KPs que criaram na plataforma.

9.4. Gestão de Tokens

A partir desta funcionalidade, permite-se gerir os Tokens associados a um KP. Todos os utilizadores registados na plataforma terão acesso e poderão gerir os Tokens nos KPs sobre os quais têm permissões:

 Utilizadores com o rol de Administrador: Poderá gerir os Tokens de todos os KPs introduzidos na plataforma.

 Utilizadores com o rol de Colaborador e restantes Utilizadores: Poderá gerir os Tokens de todos os KPs de que são proprietários.

Ao aceder à funcionalidade através da opção de menu “Meus Tokens” apresentar-se-á a

seguinte página:

Para poder Gerir os Tokens de um KP deve selecionar-se primeiro o KP. Poder-se-ão realizar pesquisas através dos seguintes campos:

 Proprietário.

(61)

começam por essa letra. Função apenas visível para utilizadores com o rol de Administrador.

Preencha os campos com os quais pretende efetuar o filtro e carregue no botão “Procurar”

situado por baixo à direita:

Uma vez apresentada a lista de KPs filtrada, poder-se-á selecionar um KP para aceder aos seus Tokens. Carregar-se-á no registo da tabela do KPs sobre o qual se pretende ver o detalhe.

Apresentar-se-á na parte inferior da janela os Tokens relacionados com o KP. Pode realizar-se a seguinte operativa sobre os Tokens apresentados na lista:

 Ativar ou Desativa um Token: Ativar-se-á ou desativar-se-á através do campo da caixa de verificação incluído na coluna da lista “Ativo”. É importante assinalar que a opção Desativar o Token implicará que os consumidores/produtores de informação não poderão comunicar entre si através do SIB até que se ative novamente.

(62)

 Eliminar o Token: implica uma eliminação física do Token, sendo assim realizar esta ação implicará uma alteração na configuração de todas as instâncias do KP afetado, caso se pretenda que estas sejam novamente ligadas ao SIB.

Para gerar mais Tokens para o KP selecionado, deverá selecionar-se um número entre 1 e 10 no campo de seleção situado à esquerda do botão “Gerar Tokens” localizado na parte inferior esquerda da lista de Tokens. Uma vez selecionado o número de Tokens que se pretende gerar, carregar-se-á no botão “Gerar Tokens.”

Ao gerar o número de Tokens selecionados, apresentar-se-á uma mensagem informativa indicando que a operação se realizou corretamente.

Uma vez criados, os Tokens serão apresentados numa lista no estado Desativo por defeito:

9.5. Gestão de Instâncias de KPs

Na Sofia2, são permitidos dois tipos de instâncias de KPs, as Instâncias de KP Dinâmicas e as Instâncias de KPs Estáticas:

 Instâncias de KPs Estáticas: São as Instâncias de KP registadas na plataforma através da Consola Web. Este tipo de instância está associado a um KP em concreto. Permite-se a respetiva gestão a partir da Consola Web conforme pormenorização a seguir.

 Instâncias de KPs Dinâmicas: São geradas em função das mensagens SSAP JOIN que enviam os KPs para ligar-se ao SIB e destroem-se uma vez que o KP envia a mensagem SSAP LEAVE para finalizar a sessão. O seu tempo de vida é o tempo de duração da sessão SSAP.

(63)

 Os utilizadores que tiverem um rol de Administrador associado poderão aceder à Gestão de Instâncias de KPs para todos as Instâncias de todos os KPs introduzidos na plataforma.

 Os restantes utilizadores poderão gerir as Instâncias dos KPs, dos quais são proprietários.

Ao aceder à funcionalidade através da opção do menu “Minhas Instâncias KP/APP” é apresentada a seguinte página:

A partir desta página efetua-se um primeiro filtro dos KPs sobre os quais pretende atuar. Uma vez localizado o KP sobre o qual se pretende trabalhar, deverá carregar no botão situado na parte direita do KP na lista.

(64)

Conforme pode verificar no ecrã, a informação seguinte é apresentada:  Identificação: Apresenta o identificador da Instância.

o Instâncias Dinâmicas: para o caso das Instâncias dinâmicas, fará referência ao identificador enviado na mensagem SSAP JOIN, que não fará a validação, exceto para verificar de que não se trata de uma Instância Estática registada pela plataforma. Uma mensagem JOIN com um identificador de instância utilizado para abrir uma sessão prévia, provoca a expiração da sessão prévia e abre uma nova sessão com a sessionKey que é enviada na resposta da segunda mensagem JOIN.

o Instâncias Estáticas: Informa o valor introduzido pelo criador da Instância.  Último IP: Indica o último IP com a qual se conectou a instância do KP.

 Modo IPStrict: O valor da coluna fará referência às Instâncias Estáticas, indicando se se utiliza ou não este modo de controlo:

 Se o modo IPStrict está desativado: Uma segunda JOIN com o mesmo identificador de KP gerará uma nova sessão SSAP encerrando a antiga sem verificar o IP do qual provém. Contudo, atualizará o campo do último endereço IP.

 Se o modo IPStrict está ativado: Uma segunda JOIN com o mesmo identificador de KP gerará uma nova sessão SSAP encerrando a antiga, apenas se provir a partir do IP que tenha essa instância de KP armazenada. Caso provenha de um IP distinto, esta é rejeitada.

 Instância Estática: Apresentar-se-ão as Instâncias de KP geradas dinamicamente como as instâncias de KP registadas de forma estática. Quando esta coluna estiver

(65)

marcada indicará que a Instância apresentada é do tipo estático, caso contrário indicará que se trata de uma instância dinâmica.

Para as instâncias geradas dinamicamente, não é permitida a edição nem a eliminação das mesmas.

É permitido realizar as seguintes operações nas Instâncias de KPs Estáticas introduzidas na plataforma a partir da lista:

 Eliminação: Para poder eliminar uma Instância Estática deverá carregar no botão situado à direita das Instâncias de KP apresentadas. Ao carregar no botão eliminar, se estiver uma sessão aberta, está tornar-se-á inválida nesse preciso momento, não permitindo à Instancia do KP comunicar com o SIB.

 Edição: Para poder editar uma Instância Estática, deve carregar-se no botão situado à direita das Instâncias de KP apresentadas.

Uma vez localizada a Instância Estática sobre a qual se pretende trabalhar, carregar-se-á no botão indicado, acedendo à seguinte página de edição:

No formulário indicado, permitir-se-á editar a seguinte informação:

 Identificador do KP: Permitir-se-á modificar o nome identificativo da instância do KP. É necessário ter em conta que ao alterar o nome identificativo com uma sessão ativa, essa instância tornará a mesma inválida.

 Modo IPStrict: Permitir-se-á ativar e desativar o modo de controlo. As alterações realizadas ao modo de controlo afetarão a sessão ativa, se aplicável.

(66)

10. Contentor KPs/APPs

O contentor de KPs consiste num novo modelo que permite a implementação de Apps Sofia2, gerindo a respetiva execução e encarregando-se do envio ao SIB da informação gerada pelo KP.

10.1. Criar KPs/APPs no Contentor

Para criar um KP em Contentor deve aceder-se à opção de menu “Contentor KPs/APPs”, “Criar KPs/APPs em contentor” e é apresentada a seguinte janela:

Nesta janela é necessário especificar a informação acerca do KP que vai ser criado.  KP: Identificador do KP registado em Sofia2 a registar no contentor.

(67)

 Instância de KP: Identificador de KP a registar no contentor

 Tipo de contentor de KP: Na versão atual todos os KPs são temporizados e executam-se periodicamente conforme a expressão CRON.

 Linguagem: Linguagem de programação do KP, permite ao contentor selecionar o

runtime com o qual executa o KP.

 Timeout: Tempo em segundos que o contentor atribui ao KP para completar a sua execução. Se o KP não finalizar a execução nesse tempo, o contentor abortará a execução.  Descrição: Descrição informativa do contentor.

 Prefixo de ficheiros de mensagens: Prefixo que terá os ficheiros de mensagens gerados pelo ficheiro executável.

 Propriedades: Pares chave-valor, com as propriedades que necessita o programa. Estas propriedades são utilizadas pelo contentor de KPs para criar um ficheiro no diretório de execução com essas propriedades. O ficheiro de propriedades terá o mesmo nome que o programa em conjunto com a extensão .properties.

Para consultar a lista de KPs no contentor de KPs, dispõe-se na consola da opção: Contentor KPs/APPs > Meus KPs/APPs em Contentor. A partir desta lista pode visualizar-se , modificar e eliminar os KPs em contentores.

(68)

11. REGRAS

A partir desta funcionalidade, permitir-se-á a gestão de Regras CEP e Script para os seguintes tipos de utilizadores:

 Para os utilizadores registados na plataforma que tenham um rol de Administrador associado, é-lhes permitido gerir todas as regras introduzidas na plataforma.

 Para os utilizadores registados na plataforma que tenham o rol de Colaborador associado, estes poderão criar Regras CEP e Script em Ontologias nas ontologias onde têm permissões Insert ou All. Apenas poderão visualizar e modificar Regras CEP

e Script em Ontologias que introduziram.

11.1. Criar Regra com Wizard

A partir desta funcionalidade, podem criar-se Regras CEP e Script de uma forma simples. Acede-se à mesma ao selecionar a opção de menu “Criar Regra com Wizard” e aparece a seguinte janela:

Ao selecionar a opção que se pretende realizar e ao carregar no botão “Seguinte” acede-se à criação da Regra com o assistente, passando por vários passos para agilizar e simplificar a respetiva criação.

(69)

11.2. Criação Script

Para aprofundar o conhecimento sobre o desenvolvimento de Scripts em SOFIA, recomenda-se a leitura do Guia de Script.

Pode aceder-se à funcionalidade através da opção de menu “Meus Script” e ao carregar no botão “Criar Script”. Visualizar-se-ão as seguintes páginas em função do tipo de Script a criar. (Scripts do tipo Timmer, Scripts em Ontologias, Scripts em Ontologias Principais e Scripts do tipo Cep):

11.2.1. Scripts do tipo Timmer

Os Script do tipo Timmer têm a característica principal de que são executados apenas num determinado período de tempo configurável e não estão associados a nenhum outro evento.

Para criar Script temporizados deverão preencher-se os campos seguintes:  Identificação: Deverá indicar-se o nome identificativo do Script.

(70)

 Temporizador: Tempo em segundos que indica a frequência com a qual se executará o Script sempre que estiver Ativo. Permite-nos introduzir expressões CRON.

 Operações disponíveis: Pode selecionar-se entre as operações criadas anteriormente as opções que se pretende adicionar nos diferentes blocos (If, Then, Ose, Error) para facilitar a criação do Script.

 Timeout: Tempo em segundos que permitirá cancelar um Script que demora mais tempo a executar-se do que o indicado.

 Bloco THEN: Para este tipo de Script dever-se-á indicar este campo.

Os restantes campos opcionais na criação de um Script Temporizado são os seguintes:  Ativo: Deverá marcar-se este campo para que se execute o Script.

 Bloco IF: Caso se indique este campo, sempre que executar o script, avaliar-se-á a condição que se indica, devolvendo o controlo ao contentor de Script. Para poder devolver neste bloco os valores true ou false ao contentor de Script, deverá utilizar-se a instrução return true ou return false dentro do bloco de Script para que o contentor de Script possa controlar o fluxo pretendido na sua execução.

 Bloco ELSE: Para este tipo de Script, este campo é opcional. É necessário que o Bloco IF seja indicado para selecionar o Bloco ELSE, não faria sentido o Bloco ELSE não indicar o bloco IF. Para que se execute este bloco de Script, o resultado do Bloque IF deve ser false

 Bloco ERROR: Embora opcional, este campo é importante, caso haja algum erro não controlado na execução do Script, o contentor de Scripts executaria esse bloco. Um exemplo de criação de Script temporizado seria o seguinte:

(71)

Conforme indicado anteriormente, apenas poderão criar Scripts Temporizados os utilizadores registados na plataforma com o rol associado de Administrador. Caso tenha a sessão iniciada com um utilizador com o rol associado de Colaborador, apresentar-se-á a seguinte mensagem na parte inferior do formulário de criação de Scripts:

Caso se inclua alguma instrução que viole as restrições de Segurança Ativa conforme se demonstra na imagem, apresentar-se-á uma mensagem com a informação do erro:

(72)

11.2.2. Scripts sobre ontologias

Os Scripts sobre Ontologias têm a principal característica de que se executam sempre que se realiza uma inserção de determinada ontologia indicada pelo criador do Script.

Para criar um Script sobre ontologias dever-se-á preencher os campos:  Identificação: Dever-se-á indicar o nome identificativo do Script.

 Ontologia: Apresentar-se-á um quadro com as ontologias disponíveis sobre as quais o utilizador com sessão iniciada tem as permissões de INSERT ou ALL. Conforme a seleção, apresentar-se-ão no quadro de Ontologias Selecionadas da direita.

 Bloco IF: Sempre que se executar o script, avaliar-se-á a condição que se indica neste campo, devolvendo o controlo ao contentor de Script. Para poder devolver neste bloco os valores true ou false ao contentor de Script, dever-se-á utilizar a instrução return

true ou return false dentro do bloco de Script para que o contentor de Script possa

controlar o fluxo pretendido na respetiva execução.

 Bloco THEN: Neste bloco indicar-se-ão as ações a executar pelo contentor de Script uma vez avaliada a condição do Bloco IF com o resultado true. Para este tipo de Script dever-se-á indicar este campo.

Os restantes campos opcionais na criação de um Script sobre ontologias:  Ativo: Dever-se-á marcar este campo para que se execute o Script.

 Bloco ELSE: Para este tipo de Script, este campo é opcional. É necessário que o bloco IF seja indicado para assinalar o bloco ELSE, não faria sentido o Bloco ELSE, se não se indicasse o Bloco IF. Para que se execute este bloco de Script, o resultado do bloco IF deve ser false.

 Bloco ERROR: Embora opcional, este campo é importante, caso haja algum erro não controlado na execução do Script ou o contentor de Scripts executaria esse bloco.

(73)

Uma vez preenchidos os dados para criar um novo Script, para se guardar os dados, dever-se-á carregar no botão “Criar” situado na parte inferior direita do formuldever-se-ário. As validações que se realizarão para este tipo de Script são as mesmas que para os Script Temporizados, exceto os campos obrigatórios exigidos.

Uma vez guardado o Script, apresentar-se-á a página de detalhe do Script criado, conforme explicado no ponto 10.4 Detalhe de Script.

11.2.2.1. Scripts sobre Ontologias Principais

Os Scripts sobre Ontologias Principais têm a principal característica de que se executam sempre que se realiza uma inserção de determinada ontologia principal indicada pelo criador do Script.

(74)

 Identificação: Dever-se-á indicar o nome identificativo do Script.

 Ontologia: Apresentar-se-á um quadro com as ontologias disponíveis sobre as quais o utilizador com sessão iniciada tem as permissões de INSERT ou ALL. Conforme a seleção, apresentar-se-ão no quadro de Ontologias Selecionadas da direita.

Os restantes campos opcionais na criação de um Script sobre ontologias:  Ativo: Dever-se-á marcar este campo para que se execute o Script.

 Bloco ELSE: Para este tipo de Script, este campo é opcional. É necessário que o bloco IF seja indicado para assinalar o bloco ELSE, não faria sentido o Bloco ELSE não indicar o Bloque IF. Para que seja executado este bloco de Script, o resultado do bloco IF deve ser false.

 Bloco ERROR: Embora opcional, este campo é importante, caso haja algum erro não controlado na execução do Script ou o contentor de Scripts executaria esse bloco.

(75)

Uma vez preenchidos os dados para criar um novo Script, para se guardar os dados, dever-se-á carregar no botão “Criar” situado na parte inferior direita do formuldever-se-ário. As validações que se realizarão para este tipo de Script são as mesmas que para os Script Temporizados, exceto os campos obrigatórios exigidos.

Uma vez guardado o Script, apresentar-se-á a página de detalhe do Script criado, conforme explicado no ponto 10.4 Detalhe de Script.

11.2.3. Scripts de tipo Cep

Os Scripts de tipo Cep têm a principal característica de que se executam sempre que se produz uma ocorrência indicada pelo criador do Script.

Para criar o Script de tipo Cep, dever-se-ão preencher os campos:  Identificação: Dever-se-á indicar o nome identificativo do Script.

 CEP: Apresentar-se-á um quadro com as regras Cep disponíveis. Conforme a seleção, apresentar-se-ão no quadro de Cep Selecionadas da direita.

(76)

Os restantes campos opcionais na criação de um Script de tipo Cep são:  Ativo: Dever-se-á marcar este campo para que se execute o Script.

 Bloco ELSE: Para este tipo de Script, este campo é opcional. É necessário que o bloco IF seja indicado para assinalar o bloco ELSE, não faria sentido o Bloco ELSE não indicar o Bloco IF. Para que se execute este bloco de Script, o resultado do bloco IF deve ser false.

 Bloco ERROR: Embora opcional, este campo é importante, caso haja algum erro não controlado na execução do Script, o contentor de Scripts executará esse bloco.

(77)

11.3. Lista de Script

Poder-se-á aceder à funcionalidade através da opção de menu “Meus Scripts”. Os utilizadores que tiverem permissões para aceder a esta funcionalidade visualizarão a seguinte página: