Crie um modelo de configuração

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 7 min. de leitura

    • Crie um modelo que define as entradas necessárias para configurar um spoke. Defina pares de chave-valor estáticos para criar registros e defina valores que se aplicam a cada integração. Defina pares de chave-valor dinâmicos para coletar entrada do usuário e defina valores de campos que podem variar. Usando este modelo, os administradores e designers de fluxo podem configurar o spoke a partir de um único formulário.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > IntegrationHub > Conexões e Credenciais > Modelos de Configuração.
    2. Selecione Novo.
    3. Selecione o tipo de modelo de configuração que deseja criar.
      Tipo de configuraçãoDescrição
      Conexão HTTP com tipo de concessão de Código de Autorização OAuth Cria um modelo para registrar o sistema de terceiros como um provedor OAuth usando um código de autorização.
      Conexão HTTP com tipo de concessão de Portador JWT OAuth Cria um modelo para registrar o sistema de terceiros como um provedor OAuth usando um token da web JSON.
      OAuth via HTTP com tipo de concessão de Credenciais do cliente

      Cria um modelo para integração a uma aplicação de terceiros por meio da autenticação OAuth 2.0 que usa o tipo de concessão de credenciais do cliente.
      Conexão HTTP com tipo de concessão de Credenciais de cliente OAuth (armazenamento externo)

      Cria um modelo que permite o envio de solicitações de tokens OAuth que compreendem credenciais do cliente armazenadas por um armazenamento externo para um servidor OAuth por meio do MID Server.
      Conexão HTTP com Credencial de Autenticação Básica Cria um modelo para integração com o sistema de terceiros usando autenticação básica.
      Conexão HTTP com Credencial de Chave de API Cria um modelo para integração com o sistema de terceiros usando uma chave de API.
      Outra Configuração Cria um modelo em branco, permitindo que você configure um modelo para autenticação personalizada.
    4. No campo Nome, adicione um nome para identificar o modelo.
    5. No campo Modelo de dados padrão, faça as mudanças necessárias.

      Este campo define informações estáticas que se aplicam a todas as integrações. Por exemplo, é possível definir a API e o URL do token se o valor se aplicar a cada integração.

      Estes objetos no modelo de dados padrão são necessários:

      • credencial: cria um registro de credencial com os campos obrigatórios.
      • conexão: cria um registro de conexão com os campos obrigatórios. Acesse os atributos de conexão que usam o objeto secundário extended_attributes. Por exemplo: 
        "connection": {
            "extended_attributes": {
                "api_version": "v1"
             
             },
        "connection_url": "https://<provider-domain-name>.com",
        "name": "Spoke Connection",
        "table": "http_connection"
    }

      É possível usar o objeto additional para configurar os dados para uma tabela personalizada e usar o script de pós-processamento para inserir os dados na tabela.

      Nota:
      No modelo de dados padrão para o tipo de concessão do Código de autorização OAuth, os valores para o oauth_entity_profile_scope e as chave oauth_entity_scope devem corresponder. No exemplo a seguir, ambas as chaves possuem o valor Ler e-mail do usuário. 
      "oauth_entity_profile": [
        {
          "grant_type": "authorization_code",
          "name": "<provider-name> Profile",
          "default": true,
          "oauth_entity_profile_scope": [
            "Read user's email"
          ]
        }
      ],
      "code_challenge_method": "S256",
      "type": "consumer",
      "oauth_entity_scope": [
        {
          "oauth_entity_scope": "Read user's email",
          "name": "email"
        }
      ],
    6. No campo Esquema de dados dinâmicos, faça quaisquer mudanças necessárias.

      Este campo Define as informações que o usuário deve preencher para configurar a integração. Por exemplo, você pode adicionar pares de chave-valor de nome de usuário e senha para coletar valores definidos pelo usuário.

      Os campos no esquema de dados dinâmicos incluem estas propriedades:

      • nome: o campo para o qual mapeia a entrada do usuário. Por exemplo, para mapear a entrada do usuário para o campo URL de Conexão no registro Conexão, insira connection.connection_url.
      • rótulo: o rótulo do campo que o usuário vê ao preencher o modelo.
      • tipo: o tipo de campo. Certifique-se de que este tipo de dados corresponda ao tipo de dados do campo para o qual você está mapeando o valor.
      • defaultValue: opcional. O valor padrão do campo. Se nenhum padrão for fornecido, será exibida a dica.
      • dica: opcional. Texto de dica a ser exibido quando não há valor padrão.
      Nota:
      Se estiver configurando um modelo para a autenticação do tipo de concessão do Portador OAuth JWT, talvez queira a entrada do usuário para um único par chave-valor na matriz jwt_claim_validation. É possível se referir a um único par chave-valor no esquema de dados dinâmicos, consultando seu índice na matriz. Por exemplo, seu modelo de dados padrão pode incluir este snippet.
      "jwt_claim_validation" : [ {
        "name" : "iss",
        "is_standard" : true,
        "data_type" : "string",
        "value":"<docusign-iss-claim>"
      }, {
        "name" : "sub",
        "is_standard" : true,
        "data_type" : "string",
        "value":"<docusign-sub-claim>"
      }, {
        "name" : "aud",
        "is_standard" : true,
        "data_type" : "string",
        "value":"<docusign-aud-claim>"
      }, {
        "name" : "scope",
        "is_standard" : false,
        "data_type" : "string",
        "value" : "signature impersonation"
      } ],

      Consulte o par chave-valor iss usando o índice baseado em zero do item: credential.jwt_provider.jwt_claim_validation[0].value.

    7. Opcional: No campo Script de pós-processamento, adicione um script que c Cria registros adicionais necessários para a integração. Por exemplo, se o seu spoke incluir tabelas personalizadas, você poderá criar registros nessas tabelas com base na entrada do usuário no modelo de configuração. Este script é executado depois que os registros de conexão e de credencial são criados.
      O script de pós-processamento tem acesso a esses objetos globais.
      Objeto global Descrição
      aliasId Sys_id do registro de alias da tabela Alias de conexão e credencial [sys_alias].
      connectionSysId Sys_id do registro de conexão criado pelo modelo.
      jsonDefaultData Conteúdo JSON do campo Modelo de dados padrão no formato de Cadeia de caracteres.
      jsonDynamicData Conteúdo JSON do campo Modelo de dados dinâmicos no formato de Cadeia de caracteres.
    8. No campo Pré-editar Script, adicione um script que preenche previamente os campos adicionais ao editar uma conexão.

      Este script retorna uma matriz de objetos. Cada objeto tem um par de nome-valor para preencher os campos adicionais. Por exemplo, se a conexão precisar de campos que estão na tabela personalizada, será possível mapear esses campos para a tabela personalizada.

      O Pré-editar script tem acesso aos seguintes objetos globais:
      Objeto global Descrição
      aliasId Sys_id do registro de alias da tabela Alias de conexão e credencial [sys_alias].
      connectionSysId Sys_id do registro de conexão criado pelo modelo.
      jsonDefaultData Conteúdo JSON do campo Modelo de dados padrão no formato de Cadeia de caracteres.
      jsonDynamicData Conteúdo JSON do campo Modelo de dados dinâmicos no formato de Cadeia de caracteres.
      Cada objeto no script tem as seguintes propriedades:
      • nome: nome do campo personalizado para especificar o valor na conexão.
      • valor: valor que você deseja mapear para preencher o campo personalizado. É possível mapear o campo usando uma função, variável ou o codificando.

      Os seguintes tipos de dados são suportados para os campos:

      Tabela 1. Tipos de dados suportados para os campos
      Tipo Descrição
      Texto Valor da cadeia de caracteres.
      Booleano Caixa de seleção. A seleção indica o valor verdadeiro e a desmarcação indica o valor falso.
      Número Valor numérico.
      Data Valor de data no formato aaaa-mm-dd. Também é possível usar o objeto GlideDate.
      Opção Lista de opções válidas definidas no campo Esquema de dados dinâmicos.
      Referência GlideRecord válido.
      Grupo de botões de rádio Grupos que contêm um conjunto diferente de campos. Esses grupos estão disponíveis como uma opção em uma lista suspensa quando você editar uma conexão. Os campos em cada grupo aparecem quando você seleciona o grupo necessário na lista suspensa.
      Por exemplo, considere a seguinte estrutura do grupo de rádios definido no campo Esquema de dados dinâmicos:
                   {
		"name": "radio_groups",
		"label": "Radio Groups",
		"type": "radio",
		"groups": [{
			"name": "radio_group1",
			"label": "Radio Group 1",
			"fields": [{
				"name": "radio_field1",
				"label": "Radio Field 1",
				"type": "text",
				"defaultValue": "efgh",
				"mandatory": true
			}]
		}, {
			"name": "radio_group2",
			"label": "Radio Group 2",
			"fields": [{
				"name": "radio_field2",
				"label": "Radio Field 2",
				"type": "text",
				"defaultValue": "abcd",
				"mandatory": true
			}],
			"default_group": true
		}

      Para este exemplo, é possível usar o seguinte snippet de código para entender como os grupos de rádios são usados no script usando a referência com pontos:

                  {
            	name: "radio_field.first_radio_group.radio_field1",
            	value: "radio field 1"
            }, {
            	name: "radio_field.second_radio_group.radio_field2",
            	value: "radio field 2"
            }, {
            	name: “radio_groups”,
            	value: gr.getValue(‘radio_groups’)
            }

      Para obter mais informações sobre como usar a referência com pontos, consulte Referência com pontos.
      Dica:
      Se os valores preenchidos previamente não estiverem aparecendo nos campos durante a edição de uma conexão, navegue até Diagnóstico do sistema > Depuração de sessão > Depurar Log para diagnosticar o problema.
    9. Adicione o modelo a um alias de conexão e credencial.
      1. Navegar até IntegrationHub > Conexões e Credenciais > Aliases de conexão e credencial.
      2. Abra o registro de alias do spoke.
      3. No campo Modelo de configuração, clique no ícone de pesquisa.
      4. Selecione o modelo que você criou na lista.
      5. Clique em Atualizar.

    Resultado

    Quando o usuário navegar até o alias associado de Conexão e credenciais e selecionar Criar nova conexão e credencial, aparecerá um diálogo para coletar sua entrada. Se você criou um modelo para o tipo de concessão do Código de autorização OAuth, também é possível recuperar um token OAuth a partir deste diálogo.

    O que Fazer Depois

    Teste o modelo navegando até o alias associado de Conexão e credencial e selecionando Criar nova conexão e credencial. Verifique se a caixa de diálogo coleta os dados esperados e cria os registros necessários no sistema.