Esquema de opção de widget

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

Armazenando opções de instância

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

Para usar outros tipos de campo não compatíveis com o esquema de opção, crie uma tabela de extensão para armazenar seu esquema de opção de widget personalizado. O uso de uma tabela permite que você:

• Adicione qualquer ServiceNow tipo 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.

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 opções variável global. Você pode acessar qualquer valor de opção em seu 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.
})();

Definir opções padrão

Antes de um valor de opção ser definido 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 widget 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 de widget

As instâncias de widget permitem que os usuários configurem exclusivamente cada widget adicionado 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é Tudo > Portal de serviços > Configuração do Portal de serviços > Editor de widgets.
2. Selecione o widget para o qual você deseja configurar o esquema de opção.
3. Clique no ícone de menu ( ) e selecione Editar esquema de opção .
   Esta opção aparece somente 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.

   Adicionar opções de widget flexíveis 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ços Designer.
   1. Navegar até Portal de serviços > Configuração do Portal de serviços > Designer 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 de instância.
   3. Configure as opções de instância do widget .
   4. Navegue até o registro da 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.

Armazene opções de instância em uma tabela

Crie uma tabela para armazenar opções de instância de 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 ServiceNow tipo 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 personalizada, adicione campos a uma tabela de extensão sp_instance e defina seu widget para usar a tabela de extensão como uma fonte de dados. Usar uma tabela de extensão permite que você:

• Adicione qualquer ServiceNow tipo 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.

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 Sistema > Tabelas.
   2. Clique em Nova.
   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.

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

   5. Salve o formulário.
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 em Colunas lista.
3. Atualize seu widget para usar a tabela de extensão como uma fonte de dados.
   1. Navegar até Portal de serviços > Widgets.
   2. Abra o widget para o qual você deseja criar opções personalizadas.
   3. Em Tabela de dados selecione sua tabela de extensão sp_instance.
      
4. Configure o formulário de 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 Configurar > Layout do formulário.
   3. Adicione os campos ao formulário.
   4. Clique em Salvar.
5. Configure o widget para exibir os campos desejados como opções de instância.
   1. Navegar até Portal de serviços > Widgets.
   2. Abra o widget que tem a tabela de extensão definida como a fonte de dados.
   3. Use Campos slushbucket para selecionar campos a serem exibidos como opções de instância.
      
   4. Salve o formulário.

O que Fazer Depois

Teste o esquema de opção adicionando o widget a uma página no Portal de serviços Designer. Clique no ícone de edição na instância do widget para exibir as opções de instância. Após configurar as opções de instância do widget , exiba a configuração navegando até o registro da instância na tabela de extensão sp_instance.