Criar e adicionar um ponto de extensão de IU

Ao desenvolver uma aplicação, crie pontos de extensão de IU e adicione-os às macros de IU do lado do servidor, como extensões HTML, ou às páginas de IU no código da aplicação base.

Use um ponto de extensão de IU para designar o local específico para onde dados ou objetos podem ser enviados para uma macro de IU personalizada registrada e onde os resultados retornados são processados.

Criar um ponto de extensão de IU

Crie um ponto de extensão de IU que você pode colocar nas macros de IU, como extensões HTML, no código da aplicação. Ao colocar o ponto de extensão de IU, você designa o local específico no código da aplicação para onde os dados ou objetos podem ser enviados para uma personalização e onde os dados são retornados.

Antes de Iniciar

Função necessária: administrador ou a função específica para o desenvolvedor ou administrador da aplicação

Nota:

Para saber mais sobre funções de administrador específicas da aplicação e desenvolvimento delegado, consulte Regras de controle de acesso em apps de administração de aplicações e Desenvolvimento e implantação delegados.

Por Que e Quando Desempenhar Esta Tarefa

Definir o conteúdo e a estrutura de um ponto de extensão. Esta definição deve descrever como uma personalização deve ser estruturada, como ela interage com o código da aplicação e como os dados retornados por uma personalização no ponto de extensão são processados.

Ao criar uma boa definição, você fornece uma estrutura para a funcionalidade das extensões.

Procedimento

1. Navegar até Tudo > Pontos de Extensão do Sistema > Pontos de Extensão da IU.
2. Clique em Nova.
3. No formulário, preencha os campos.

   Tabela 1. Formulário de Ponto de Extensão de IU

   Campo	Descrição
   Nome	Nome exclusivo do ponto de extensão. O nome pode ter até 100 caracteres alfanuméricos, incluindo caracteres especiais.
   Nome da API	Nome da API do ponto de extensão que é anexado ao escopo da aplicação ao qual se aplica. Este é um nome atribuído pelo sistema e não pode ser alterado.
   Aplicação	Escopo da aplicação em relação ao qual o ponto de extensão está atribuído. Isso é atribuído pelo sistema e não pode ser alterado. Para obter mais informações sobre as proteções oferecidas pelo uso da definição do escopo, consulte Application scope.
   Restringir a este escopo	Opção para restringir o ponto de extensão somente ao escopo da aplicação.
   Permitir o acesso em AJAX/REST	Opção para habilitar ou desabilitar o acesso ao ponto de extensão de IU em AJAX ou REST. Para saber mais sobre essas arquiteturas e técnicas de desenvolvimento, consulte AJAX e REST APIs.
   Descrição	Os requisitos para o script personalizado Macro de IU, por exemplo, como o script de IU deve ser estruturado e como ele deve operar com o código da aplicação.
   Exemplo	Exemplo de como uma macro de IU personalizada que interage com este ponto de extensão deve ser estruturado para operar com o código da aplicação.

4. Clique em Enviar.

Adicionar um ponto de extensão de IU no código da aplicação base

Adicione o ponto de extensão de IU a uma macro de IU ou extensão HTML no código da aplicação base. Para adicionar o ponto de extensão, faça uma chamada de API que identifica o local no qual os artefatos personalizados registrados são executados.

Antes de Iniciar

Função necessária: administrador ou a função específica para o desenvolvedor ou administrador da aplicação

Você deve primeiro criar um ponto de extensão de IU antes de adicioná-lo a uma macro de IU ou página de IU no código da aplicação.

Nota:

Para saber mais sobre funções de administrador específicas da aplicação e desenvolvimento delegado, consulte Regras de controle de acesso em apps de administração de aplicações e Desenvolvimento e implantação delegados.

Procedimento

1. No código da aplicação, acesse a macro de IU existente à qual você deseja adicionar um ponto de extensão com script ou crie um novo.
   Para saber mais sobre como criar macros de IU com marcadores Jelly, consulte Macros de IU e Marcadores Jelly.
2. Na macro de IU, adicione um marcador Jelly com uma linha de código no local que você espera coletar e processar a saída da macro de IU personalizada.
   Normalmente, esta linha de código contém:

   • Um comando call_extension que identifica o nome do ponto de extensão de IU (por exemplo, extension="global.KMArticle.ViewHeader") no qual as macros de IU personalizadas são registradas.
   • Argumentos que são passados para a macro de IU quando ela é renderizada. Por exemplo, para um artigo Base de conhecimento, knowledgerecord="${knowledgeRecord}" passa no registro de conhecimento atual.
   • (Opcional) Se houver várias implementações deste ponto de extensão, o uso de um comando de limite especificará que o número x de implementações deve ser retornado (por exemplo, limit="1"). Esta figura mostra uma macro de IU que contém esses comandos.