---
sourceDocument: Interface do usuário da Now Platform Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-user-interface

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Interface do usuário da Now Platform Yokohama

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Esquema de opção de widget

# Esquema de opção de widget {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 min. de leitura

As instâncias de widget permitem que os usuários configurem exclusivamente cada widget que adicionam a uma página. Use o esquema de opção para definir os parâmetros do widget.

## Armazenando opções de instância {#c_WidgetInstanceOptions__section_hxc_kmy_h1b}

Ao desenvolver um widget, você pode editar o esquema de opção para criar parâmetros para o widget ou criar uma tabela para armazenar opções de instância. Se você editar o esquema de opção existente, todas as opções de instância definidas serão armazenadas no formato JSON no Opções adicionais, formato JSON campo na tabela sp_instance. Os seguintes tipos de campo estão disponíveis:  
* Cadeia de caracteres
* Booliano
* Inteiro
* Referência
* Escolha
* Field_list (depende da tabela)
* Field_name (depende da tabela)
* Glide_list
{#c_WidgetInstanceOptions__ul_yp3_qxb_f1b}

Para usar outros tipos de campo não compatíveis com o esquema de opção, crie uma tabela de extensão para armazenar o esquema de opção de widget personalizado. O uso de uma tabela permite:  
* Adicione qualquer ServiceNowtipo de campo, incluindo campos com personalização avançada, para o esquema de opção.
* Defina um esquema de opção complexo.
* Opções de instância de pesquisa e filtro.
{#c_WidgetInstanceOptions__ul_ls1_ktd_f1b}  
Nota:  
Embora o armazenamento de opções em uma tabela permita definir opções mais complexas, esse método é mais difícil de manter do que editar o esquema de opções. Para evitar a criação de tabelas sem necessidade e a adição de chamadas de servidor adicionais ao widget, sempre que possível edite o esquema de opções existente. Armazene opções em uma tabela somente quando forem necessárias opções complexas ou pesquisáveis.

## Usando opções em um widget

Acesse as opções no widget do script do cliente e do script do servidor usando o. opções variável global. Você pode acessar qualquer valor de opção no script de cliente de widget ou script de servidor usando `OptionName.OptionName `.  
Client script

    function() {
      /* widget controller */
      var c = this;
        console.log(c.options.text_color) //Outputs the text_color option for this instance
    }

Script do servidor

    (function() {
         $sp.log(options.text_color) //Logs the value of the text_color option to the browser console.
    })();

## Definindo opções padrão

Antes de definir um valor de opção em uma instância, ele aparece como um valor indefinido quando você acessa essa variável de opção. Use o script do servidor de widgets para especificar valores padrão para suas opções.  

    (function() {
      options.text_color=options.text_color||"blue";
      options.maximum_entry_count=options.maximum_entry_count||5;
    })

## Edite o esquema de opção do widget {#ariaid-title2}

As instâncias de widget permitem que os usuários configurem exclusivamente cada widget que adicionam a uma página. Edite o esquema de opção para definir parâmetros básicos para o widget.

### Antes de Iniciar

Você deve ter clonado ou criado um novo widget.

Função necessária: administrador ou sp_admin

### Procedimento

1. Navegar até TudoPortal de serviçosConfiguração do Portal de serviçosEditor de widgets.
2. Selecione o widget para o qual você deseja configurar o esquema de opção.
3. Clique no ícone de menu ( ![Ícone de menu]()) e selecione Edite o esquema de opção .  
   Esta opção só aparece para usuários que têm o direito de editar o widget.
4. Clique em . para adicionar uma opção de widget.
5. Defina um rótulo, nome, tipo, dica e seção de formulário.  
   Mais campos aparecem dependendo de tipo você seleciona.

   A adição de opções flexíveis de widget permite criar widgets mais reutilizáveis. Você pode adicionar valores padrão para ajudar os usuários a entender cada opção de widget. Se você não selecionar uma seção de formulário, o padrão será definido como Outras opções .
6. Clique em Salvar.  
   O esquema de opção definido é armazenado no formato JSON no Esquema de opção campo na tabela sp_widget. Com base neste esquema de opção, cada instância do widget pode usar opções de instância definidas individualmente.
7. Teste o esquema de opção adicionando o widget a uma página no Portal de serviçosDesigner.
   1. Navegar até Portal de serviçosConfiguração do Portal de serviçosDesigner do portal de serviços.
   2. Adicione o widget a uma página e clique no ícone de edição na instância do widget para exibir as opções da instância.
   3. [Configure as opções da instância do widget](https://servicenow-prod.fluidtopics.net/8tij89_RJTq3l0hQT0HHMg "Crie instâncias exclusivas de widgets configurando as opções para cada instância.").
   4. Exiba a configuração navegando até o registro de instância na tabela sp_instance.  
      As opções de instância são armazenadas no formato JSON no Opções adicionais, formato JSON campo.
   {#edit-option-schema__substeps_clj_yj2_31b}

## Armazene opções de instância em uma tabela {#ariaid-title3}

Crie uma tabela para armazenar opções de instância do widget em vez de editar o esquema de opção existente. Ao usar uma tabela como esquema de opção de widget, você pode definir campos personalizados usando qualquer ServiceNowtipo de campo, adicione filtros aos campos e opções de instância de pesquisa ou consulta.

### Antes de Iniciar

Função necessária: administrador ou sp_admin

### Por Que e Quando Desempenhar Esta Tarefa

Para definir um esquema de opção personalizado, adicione campos a uma tabela de extensão sp_instance e defina seu widget para usar a tabela de extensão como fonte de dados. O uso de uma tabela de extensão permite:  
* Adicione qualquer ServiceNowtipo de campo, incluindo campos com personalização avançada, para o esquema de opção.
* Defina opções de widget complexas.
* Opções de instância de pesquisa e filtro.
{#sp-instance-ext-table__ul_ls1_ktd_f1b}  
Nota:  
Embora o armazenamento de opções em uma tabela permita definir opções mais complexas, esse método é mais difícil de manter do que editar o esquema de opções. Para evitar a criação de tabelas sem necessidade e a adição de chamadas de servidor adicionais ao widget, sempre que possível edite o esquema de opções existente. Armazene opções em uma tabela somente quando forem necessárias opções complexas ou pesquisáveis.

### Procedimento

1. Crie uma tabela que estenda uma tabela sp_instance para armazenar seu esquema de opção personalizado.
   1. Navegar até Definição do SistemaTabelas.
   2. Clique em Novo.
   3. Defina um rótulo e um nome.
   4. Em Estende a tabela selecione uma tabela sp_instance que forneça os campos necessários.  
      {#sp-instance-ext-table__table_fgm_prd_f1b__entry__2}

      | Tabela da instância | Descrição |
      |-|-|
      | Instância \[sp_instance\] | Inclui campos de instância base. |
      | Instância com tabela \[sp_instance_table\] | Inclui campos sp_instance e campos para exibir dados da tabela, como Tabela e Filtro. |
      [ ]

      {#sp-instance-ext-table__table_fgm_prd_f1b}
   5. Salve o formulário.
   {#sp-instance-ext-table__substeps_kzj_sqb_f1b}
2. Defina campos personalizados na tabela de extensão.  
   Você pode definir qualquer tipo de campo a ser usado em seu esquema de opção adicionando novas colunas no Colunas lista.
3. Atualize seu widget para usar a tabela de extensão como fonte de dados.
   1. Navegar até Portal de serviçosWidgets.
   2. Abra o widget para o qual você deseja criar opções personalizadas.
   3. Em Tabela de dados selecione a tabela de extensão sp_instance.  
   {#sp-instance-ext-table__substeps_wqw_ftb_f1b}
4. Configure o formulário da tabela de extensão para exibir os campos desejados.  
   Os campos configurados no formulário estão disponíveis como opções de instância.
   1. Navegue até o formulário de tabela de extensão: `<yourInstance>/<your_extenstion_table>.do `.
   2. Clique com o botão direito do mouse no menu do cabeçalho e selecione ConfigurarLayout do Formulário.
   3. Adicione os campos ao formulário.
   4. Clique em Salvar.
   {#sp-instance-ext-table__substeps_rrz_dzc_f1b}
5. Configure o widget para exibir os campos desejados como opções de instância.
   1. Navegar até Portal de serviçosWidgets.
   2. Abra o widget que tem a tabela de extensão definida como a fonte de dados.
   3. Use o. Campos slushbucket para selecionar campos a serem exibidos como opções de instância.  
   4. Salve o formulário.
   {#sp-instance-ext-table__substeps_mng_gnk_f1b}

### O que Fazer Depois

Teste o esquema de opção adicionando o widget a uma página no Portal de serviçosDesigner. Clique no ícone de edição na instância do widget para exibir as opções da instância. Após [configurando as opções de instância do widget](https://servicenow-prod.fluidtopics.net/8tij89_RJTq3l0hQT0HHMg "Crie instâncias exclusivas de widgets configurando as opções para cada instância."), exiba a configuração navegando até o registro de instância na tabela de extensão sp_instance.