Manuais
PHC GO Como criar uma extensão de ecrã
 
Nome da entidade: Nome da entidade que será criada no SQL.

Entidade a estender: Selecionar a entidade que deseja estender.

Tabela da entidade: Campo informativo, representando o nome interno da tabela de entidade.




Descrição: Campo opcional a ser preenchido com a descrição do ecrã.


Neste separador, é possível adicionar campos ou elementos ás várias secções do ecrã, secções estas que passamos a explicar em detalhe:

Campos internos (sem visualização): Os campos internos são campos que não serão renderizados no ecrã, servindo para alojar informação sem que esta esteja visível para o utilizador. Para adicionar um novo campo e/ou elemento a esta secção, deve carregar no botão exibido na tabela abaixo, e de seguida selecionar o tipo de campo/elemento a ser adicionado à secção. Consoante a seleção anterior é exibido o ecrã de propriedades onde serão efetuadas as configurações do elemento/campo.

add
text_fields  Texto
pin  Inteiro
pin  Decimal
check_box  Lógico
today  Data
calendar_view_month  Grelha de edição


Cabeçalho: Secção principal do ecrã. Para adicionar um novo campo e/ou elemento a esta secção, deve carregar no botão exibido na tabela abaixo, e de seguida selecionar o tipo de campo/elemento a ser adicionado à secção. Consoante a seleção anterior é exibido o ecrã de propriedades onde serão efetuadas as configurações do elemento/campo.

add
drive_file_rename_outline  Textbox
edit_note  Textarea
text_format   Rich text editor
today   Datepicker
manage_search   Autocomplete
read_more   Itens de lista dinâmica
check_box   Checkbox
image   Imagem
calendar_view_month   Grelha de edição
table_rows   Tabela de consulta
title   Texto
highlight_alt   Em branco
tips_and_updatesDicas

Quando estiver a consultar um registo guardado neste ecrã, é possível consultar as propriedades de cada campo/elemento configurado sem necessidade de entrar em modo de edição.

Dados gerais (paineis): Primeira secção após o cabeçalho.

add




No separador Ações, é possível adicionar novas ações para o ecrã, e novas ações para os registos do ecrã.

Por defeito, não existe nenhuma ação parametrizada. Para adicionar uma nova ação ao seu ecrã, carregue em  
Adicione ação
 .

Após a ação anterior, é aberta uma nova janela com o assistente de configuração de ações. Nesta é possível parametrizar as ações do ecrã à sua medida, utilizando para tal os seguintes campos:

Título: Nome a atribuir à ação

check_box  Ação sugerida: Ao ativar este campo, a ação terá prioridade sobre as restantes ações de registo, surgindo em primeiro aquando consultadas as ações de registo do respetivo ecrã.
sticky_note_2Notas

O PHC GO permite um máximo de 2 ações sugeridas por ecrã.




check_box  Ação de ecrã:
Ao ativar este campo, a ação criada estará disponível no modo ecrã e automaticamente, escondida do modo registo.

Ao nível da interação com o utilizador, o campo apresenta ainda as seguintes características:

  • Ao ter o campo ativado, a ação "Ação sugerida" fica inativa.
  • O campo "Ecrã de destino" fica apenas de leitura.
  • A descrição dos campos destinados ao código "function runAction" e "function isActionAvailable" oculta o parâmetro "currentRecord" porque nenhum "itemVO" será usado na operação da ação.
  • O campo "Identificador da regra de negócio" disponibilizará apenas as opções das regras de negócio do tipo "A pedido modo ecrã".

    Ecrã de destino: Ecrã associado a ação de registo. Ao clicar no botão de ações de registo do novo ecrã ( playlist_play ), a ação será apresentada no separador colapsável do ecrã selecionado nesta opção. Por exemplo, no ecrã de clientes, a ação Emita fatura tem como ecrã de destino o ecrã Faturação.

    Executa regra de negócio: Ao ativar este campo, está a indicar que a ação executará o código de uma regra de negócio A Pedido do novo ecrã.
    Se esta opção estivar ativa, o editor de código da função runAction ficará desabilitado, enquanto que o campo Identificador da regra de negócio estará disponível para edição.

    Identificador da regra de negócio: Caso tenha selecionado a opção Executa regra de negócio, este campo passa estar disponível para edição por parte do utilizador, devendo ser preenchido com a regra de negócio A Pedido do novo ecrã que será executada ao clicar na ação.

    function runAction: Código que será executado ao clicar na ação caso o campo Executa regra de negócio estiver desmarcado. Neste editor de código, deverá implementar código na linguagem  
    Typescript
      e poderá utilizar as funções disponíveis na biblioteca SDK do Frontend.

    Exemplo:
    sdk.publishMessage("Custom message", AlertTypes.WARNING)

    sticky_note_2Notas

    Para mais informações relacionadas com funções da biblioteca SDK do Frontend, carregue aqui .

    function isActionAvaiable: Permite mostrar a ação consoante uma determinada condição. Neste editor de código, deverá implementar código na linguagem  
    Typescript
     .

    1. Caso defina:
      return true;
      A ação é sempre exibida no registo.

    2. Por outro lado, caso defina:
      return currentRecord.meucampologico;
      A ação apenas é apresentada nos registos que tenham o campo meucampologico igual a 1.
    3. sticky_note_2Notas

      Nos editores de código de linguagem  
      Typescript
       , poderá utilizar o comando console.log para debugar o código implementado.

      Uma vez que a linguagem  
      Typescript
       é derivada do Javascript , as funções do Javascript também poderão ser utilizadas pelo developer.

     

  • No separador comportamento, está disponível um editor de código, o qual poderá utilizar para escrever ou importar código  
    Typescript
      .


    Neste separador, é possível configurar comportamentos específicos para as ações core do PHC GO através de código Typescript, sendo estas:

    • Edite
    • Duplique
    • Apague
    • Imprima
    • Descarregue
    • Envie

    Para adicionar um novo comportamento, comece por carregar em  
    Adicione comportamento
     .
    De seguida, é exibida a janela Ação, através da qual é possível configurar o comportamento desejado:

    • check_box Comportamento para modo de lista: Ao ativar este campo, o comportamento a ser configurado, será executado para a ação selecionada, aquando no modo lista da respetiva entidade.
      sticky_note_2Notas

      • Para comportamentos do modo lista, é necessário certificar que os objetos a serem invocados pelo código  
        Typescript
         , tenham a opção check_box É apresentado no modo de lista do ecrã ativa.

      • Não é possível invocar campos de extensões de ecrã para comportamentos do modo lista.
    • Tipo de ação: É neste campo onde é definida qual a ação a ser configurada, tendo como opções disponíveis as ações referidas anteriormente.

    • check_box Esconde a ação: Ao ativar esta opção, poderá esconder ações de registo ou de ecrã escolhidas no campo Tipo de ação, da entidade selecionada no campo Entidade a esconder.

    • Código: Para configurar o comportamento desejado, está disponível um campo para edição de código  
      Typescript
       . Para expandir este campo, carregue em open_in_full.
      tips_and_updatesDicas

      Pressupondo uma extensão de ecrã (ID: U4902_EXTENSAOCL) para a entidade Clientes, adicionando os campos Pode enviar (ID: cansend), Pode descarregar (ID: candl), seguem alguns exemplos para comportamentos de ações core (ações de regosto):

      • Desabilitar o botão Envie caso registo tenha o campo Pode enviar não ativo:

        return (currentRecord[TABLES.U4902_EXTENSAOCL][FIELDS.U4902_EXTENSAOCL_CANSEND]) ? false : true;

      • Desabilitar o botão Descarregar caso registo tenha o campo Pode descarregar não ativo:

        return (currentRecord[TABLES.U4902_EXTENSAOCL][FIELDS.U4902_EXTENSAOCL_CANDL]) ? false : true;


    Uma vez introduzidos comportamentos, estes serão exibidos no modo de consulta do ecrã/entidade, estando agrupadas em duas categorias:

    • Ações de lista
    • Ações de registo

    Ao carregar no botão more_vert , são exibidas as operações disponíveis para comportamentos:

    • create Edite: Permite editar as configurações do comportamento.

    • delete Apague: Elimina o comportamento do ecrã/entidade.

     

    No separador traduções, é possível definir para os vários idiomas do PHC GO, os diferentes textos que cada campo deve exibir, Por defeito, ao ser adicionado um novo campo no separador Desenho, será criada automaticamente uma entrada para esse campo neste secção.

    Em alternativa, poderá carregar em  
    Adicione tradução
    , para adicionar um nova linha na tabela de traduções para o ecrã.

    A tabela de traduções é composta por 4 colunas, sendo estas:

    • Chave: Identificativo único do campo
    • Português: Texto do campo para o idioma português
    • Español: Texto do campo para o idioma espanhol
    • English: Texto do campo para o idioma inglês
    tips_and_updatesDicas

    • Para adicionar uma nova entrada na tabela de traduções do ecrã, basta carregar em Adicionar ( add ).
    • Para remover uma entrada da tabela de traduções do ecrã, basta carregar no balde do lixo ( delete ) respetivo á linha que deseja remover.
    • Caso tenha sido adicionado um novo campo nas entidades do tipo linhas, é adicionado automaticamente uma entrada desse campo exclusivamente para tratamento da apresentação do campo no ecrã Configuração de relatórios, nos vários idiomas (Ex: ENTITY.U4902_NOME_DA_ENTIDADE_FI).