Assinatura eletrônica do DocuSign Spoke

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 13 min. de leitura

    • Automatize o processo de envio de um documento jurídico para um indivíduo ou uma lista de destinatários para assinatura digital usando o DocuSign eSignature. Por exemplo, automatize a integração e o desligamento de funcionários ou envie acordos de não divulgação, acordos jurídicos e declarações de trabalho. Use dados de ServiceNow em modelos de documento e permita que os usuários carreguem documentos para assinatura conforme necessário.

    Solicitar aplicativos na Store

    Acesse o site ServiceNow Store para ver todos os aplicativos disponíveis e obter informações sobre como enviar solicitações para a loja. Para obter informações sobre notas de versão cumulativa para todos os aplicativos liberados, consulte as ServiceNow Store notas de versão do histórico de versão.

    Assinatura do IntegrationHub

    Este spoke requer uma assinatura do Hub de integração. Para obter mais informações, consulte Programações jurídicas - Visão geral do IntegrationHub.

    Versão do spoke

    Spoke do DocuSign eSignature v 3.0.0 é a versão mais recente.

    Dependências do spoke

    Se você estiver tendo problemas para instalar o aplicativo, verifique se estes plug-ins dependentes estão instalados:

    • Etapa de ação do ServiceNow IntegrationHub — REST (com.glide.hub.action_step.rest)
    • Tempo de execução do ServiceNow IntegrationHub (com.glide.hub.integration.runtime)
    • ServiceNow Flow Designer - Entradas dinâmicas (com.glide.hub.dynamic_inputs)
    Nota:
    Alguns desses plug-ins são recursos licenciáveis e exigem uma licença apropriada, se usados fora da implementação do spoke. Para obter informações sobre licenças, entre em contato com o gerente da sua conta.

    Versões compatíveis

    Este spoke foi criado para a API DocuSign eSignature versão v2 ou v2.1, mas pode ser compatível com versões posteriores.

    Principais recursos

    Spoke do DocuSign eSignature permite que um designer de fluxo:

    • Automatize o processo de envio de um documento de um anexo ServiceNow ou modelo de assinatura eletrônica DocuSign para um indivíduo ou lista de destinatários para assinatura digital.
    • Descubra e sincronize contas e modelos de assinatura eletrônica do DocuSign em ServiceNow.
      • Recupere uma lista de contas e modelos associados da DocuSign eSignature e insira ou atualize-os como registros nas tabelas Contas [sn_docusign_spoke_accounts] e Modelos [sn_docusign_spoke_docusign_templates] usando o subfluxo Obter contas.
      • Recupere os modelos associados a uma conta de assinatura eletrônica do DocuSign especificada e insira ou atualize-os como registros na tabela Modelos [sn_docusign_spoke_docusign_templates] usando o subfluxo Obter modelos por conta.
    • Copie e personalize fluxos de amostra para enviar modelos e solicitações de documentos sob demanda.
    • Pausar um fluxo até que um documento seja assinado. Um webhook de REST API com script aguarda o destinatário assinar o documento.
    • Use valores de um documento assinado em um fluxo.
    • Anexe um documento de assinatura eletrônica DocuSign concluído a um registro ServiceNow para fins de auditoria.
    • Gerenciar envelopes e usuários.

    Requisitos do spoke

    • Conta de assinatura eletrônica do DocuSign
    • Credenciais de administrador do DocuSign eSignature
    • Aplicação DocuSign eSignature configurada para integração com a ServiceNow
    • Detalhes da aplicação DocuSign eSignature, como ID do cliente, chave do integrador, chaves secretas e pares de chaves RSA
    • ServiceNow Assinatura do IntegrationHub
      Nota:
      Certifique-se de ter ativado o suporte ao Flow Designer para o plug-in Catálogo de serviços (com.glideapp.servicecatalog.flow_designer).

    Consulte a documentação do DocuSign Developer Center para obter instruções sobre como criar e configurar aplicações personalizadas.

    Fluxos do spoke

    O Spoke do DocuSign eSignature fornece fluxos de amostra para demonstrar a automação de tarefas do DocuSign. Use ações Spoke do DocuSign eSignature para automatizar todas as tarefas desejadas pela sua organização. Para personalizar um fluxo de amostra, copie-o para um novo escopo da aplicação. Os fluxos de amostra disponíveis incluem:

    Fluxo Descrição
    Enviar um documento para assinatura digital Envia um documento para o DocuSign para uma assinatura digital quando uma solicitação do Catálogo de serviços é criada pelo item Enviar um documento para assinatura digital. Antes de usar este fluxo, ative o item do catálogo Enviar um documento para assinatura digital.
    Enviar oferta de emprego ao candidato usando o modelo DocuSign Envia um envelope DocuSign para um usuário usando um modelo. Por exemplo, use este fluxo para enviar uma oferta de trabalho a um candidato. Antes de usar este fluxo, ative o item do catálogo Demonstrar modelo - Enviar oferta de trabalho ao candidato.

    O Spoke do DocuSign eSignature adiciona itens do catálogo para uso com os fluxos de amostra Spoke do DocuSign eSignature. Antes de acionar um fluxo de amostra Spoke do DocuSign eSignature, ative os itens do catálogo.

    Item do catálogo Descrição
    Enviar um documento para assinatura digital Envia um documento para assinatura digital no DocuSign.
    Demonstrar modelo - Enviar oferta de trabalho ao candidato Envia uma oferta de trabalho usando um modelo DocuSign.

    Subfluxos do spoke

    O Spoke do DocuSign eSignature fornece subfluxos de amostra para demonstrar a automação de tarefas do DocuSign. Para personalizar um subfluxo de amostra, copie-o para um novo escopo da aplicação. Os subfluxos de amostra disponíveis incluem:

    Categoria Subfluxo Descrição
    Gestão de envelopes Anexar envelope do DocuSign ao registro da ServiceNow Anexa todos os documentos em um envelope a um registro ServiceNow.
    Obter e definir dados de campo do DocuSign Processa uma lista de variáveis de item do catálogo e atualiza um rascunho de envelope com o valor de cada variável.
    Gestão de usuários Criar Usuário Cria um usuário, incluindo o perfil de permissão e as associações de grupo.
    Atualizar usuário Atualiza um usuário, incluindo o perfil de permissão e as associações de grupo.
    Gestão de modelos Obter modelos por conta Recupera modelos de uma conta do DocuSign e os armazena na tabela Modelos.
    Padrão Subfluxo de amostra do webhook do DocuSign Recupera os detalhes do destinatário do envelope especificado.
    Gestão de contas Obter Contas Recupera contas e modelos do DocuSign relacionados a cada conta e os armazena na tabela Contas e modelos, respectivamente.

    Ações do spoke

    O Spoke do DocuSign eSignature fornece ações para automatizar tarefas do DocuSign quando os eventos ocorrem em ServiceNow. As ações disponíveis incluem:

    Categoria Ação Descrição
    Gestão de contas Pesquisar contas por alias Recupera contas associadas ao registro de alias de conexão e credencial do spoke.
    Pesquisar ID da função Recupera o ID de funções para o nome de função especificado.
    Gestão de envelopes em massa Criar lista de envio em massa Cria uma lista de envio em massa.
    Criar solicitação de envio em massa Cria uma solicitação de envio em massa com base em uma lista de envio em massa existente usando um envelope ou modelo.
    Criar solicitação de teste de envio em massa Cria uma solicitação de teste de envio em massa para testar a compatibilidade com o envelope ou modelo existente.
    Excluir lista de envio em massa Exclui a lista de envio em massa especificada.
    Pesquisar fluxo de envio de envelopes em massa Recupera os envelopes do lote de envio em massa especificado.
    Pesquisar status de lote de envio em massa Recupera o status geral do lote de envio em massa especificado, como número de sucessos, número pendente, número de erros e assim por diante.
    Pesquisar fluxo de lotes de envio em massa Recupera as informações dos lotes de envio em massa.
    Pesquisar lista de envio em massa Recupera a lista de envio em massa especificada.
    Pesquisar listas de envio em massa Recupera uma lista das listas de envio em massa.
    Atualizar ação de lote de envio em massa Executa uma ação em massa (reenviar, corrigir ou anular) no lote de envio em massa especificado.
    Atualizar status de lote de envio em massa Atualiza o nome do lote de envio em massa especificado.
    Atualizar lista de envio em massa Atualiza a lista de envio em massa especificada.
    Assinatura de documento Pesquisar URL de assinatura integrada Cria um URL de assinatura que é incorporado a uma aplicação. O usuário pode assinar o documento sem sair da aplicação.
    Nota:
    O URL de assinatura fica ativo por 300 segundos e pode ser enviado para um destinatário de cada vez.
    Pesquisar URL de assinatura integrada em linha Recupera um URL que permite incorporar a exibição do destinatário do no DocuSign.
    Gestão de Documentos Adicionar documento ao envelope Adiciona documentos ao envelope.
    Anexar documento combinado ao registro da ServiceNow Anexa documentos DocuSign a um registro da ServiceNow.
    Anexar documento do DocuSign ao registro Recupera um documento DocuSign assinado e o anexa a um registro ServiceNow.
    Pesquisar ID do documento por nome Recupera o ID do documento de um envelope usando o nome de documento especificado.
    Pesquisar documentos em um envelope Retorna uma lista de documentos com um ID e nome no envelope DocuSign fornecido.
    Substituir documento no envelope Substitui documentos pelo envelope.
    Gestão de envelopes Adicionar Destinatário ao Envelope Adiciona o destinatário especificado ao envelope especificado.
    Nota:
    • O ID do destinatário usado nesta ação está associado ao envelope e é diferente do ID do destinatário usado na ação Obter todos os campos de modelo.
    • O administrador insere um valor numérico para este ID de destinatário.
    Adicionar destinatários ao envelope Adiciona os destinatários especificados ao envelope especificado.
    Anexar certificado Docusign ao registro da ServiceNow Anexa um certificado DocuSign a um registro da ServiceNow.
    Cancelar Envelope Cancela um envelope em andamento.
    Criar rascunho de envelope a partir do modelo Cria um rascunho de envelope a partir de um modelo DocuSign existente.
    Criar envelope a partir de modelo composto Cria um envelope a partir de um modelo composto existente.
    Pesquisar ID de campo Recupera o ID do campo especificado do envelope de rascunho especificado.
    Pesquisar valor de campo Recupera o valor do campo especificado do envelope especificado.
    Pesquisar campos Recupera a lista de campos associados a um documento em um envelope de rascunho.
    Pesquisar ID de destinatário por nome de função Recupera o ID do destinatário do nome da função especificado do envelope especificado.
    Pesquisar destinatários em um envelope Retorna uma lista de destinatários com um ID de destinatário e um nome de função no envelope DocuSign fornecido.
    Remover Destinatário do Envelope Exclui um destinatário de um envelope DocuSign.
    Enviar solicitação de assinatura ad hoc ao usuário Envia um documento DocuSign associado ao registro ServiceNow especificado para o destinatário especificado para assinatura.
    Enviar solicitação de assinatura ad hoc aos usuários Envia um documento DocuSign associado ao registro ServiceNow especificado para os vários destinatários especificados para assinaturas de cada vez.
    Nota:
    Quando a opção Usar assinatura sequencial está habilitada, o documento DocuSign é enviado para vários destinatários em uma ordem sequencial. A opção Usar assinatura sequencial controla a ordem na qual os destinatários recebem e assinam os documentos.
    Enviar solicitação de assinatura ad hoc para usuários - Em linha Envia um ou mais documentos carregados de um registro da ServiceNow para vários destinatários.
    Enviar Envelope Envia um envelope para os destinatários especificados.
    Nota:
    Todos os detalhes do destinatário devem ser fornecidos antes de enviar um envelope.
    Definir valor do campo Define o valor do campo especificado no envelope de rascunho especificado.
    Definir Valores de campos Atribui os valores de vários campos associados a um documento em um envelope de rascunho.
    Aguarde a assinatura do DocuSign Pausa um fluxo até que o documento especificado seja assinado ou rejeitado. Retorna o status do documento ao fluxo para processamento posterior.
    Recuperação de metadados Obter lista de documentos Obtém a lista de todos os documentos DocuSign em um envelope.
    Obter lista de grupos (metadados) Recupera metadados de uma lista de grupos.
    Obter funções Recupera uma lista de funções.
    Obter funções (metadados) Recupera metadados para uma lista de funções.
    Gestão de grupo Adicionar usuário ao grupo Adiciona usuário de um grupo.
    Pesquisar ID de grupo Recupera um ID de grupo para o nome da função especificado.
    Remover usuário do grupo Remove o usuário especificado de um grupo.
    Gestão de modelo Pesquisar modelos por conta Recupera os modelos associados à conta do DocuSign especificada.
    Pesquisar campos de modelo Recupera todos os campos em um modelo definido para um destinatário.
    Nota:
    • O ID do destinatário usado nesta ação está associado ao modelo e é diferente do ID do destinatário usado na ação Adicionar destinatário ao envelope.
    • O valor do ID do destinatário é um número exclusivo gerado pelo sistema.
    Pesquisar destinatários do modelo Recupera todos os destinatários definidos para um modelo.
    Gestão de usuários Criar Usuário Cria um usuário do DocuSign com os detalhes do usuário especificados.
    Pesquisar detalhes do usuário Recupera detalhes de um usuário.
    Atualizar usuário Atualiza o usuário especificado.
    Excluir Usuário Exclui o usuário do DocuSign especificado.

    Módulo do spoke

    O Spoke do DocuSign eSignature adiciona um módulo DocuSign à sua instância ServiceNow. O Spoke do DocuSign eSignature sincroniza e armazena modelos e envelopes em ServiceNow. O Spoke do DocuSign eSignature inclui essas tabelas e registros.

    Tabela/Registro Descrição
    Aliases de conexão O alias de conexão do DocuSign.
    Trabalho programado O trabalho programado Obter contas e modelos que sincroniza modelos e envelopes com sua conta do DocuSign.
    Contas Contas do DocuSign sincronizadas com sua instância ServiceNow. Para sincronizar contas, consulte Sincronizar DocuSign com a ServiceNow. O subfluxo Obter contas recupera uma lista de contas e modelos associados do DocuSign e os insere ou atualiza como registros nas tabelas Contas [sn_docusign_spoke_accounts] e Modelos [sn_docusign_spoke_docusign_templates].
    Modelos Modelos DocuSign de contas DocuSign sincronizadas. O subfluxo Obter modelos por conta recupera modelos associados a uma conta do DocuSign especificada e os insere ou atualiza como registros na tabela Modelos [sn_docusign_spoke_docusign_templates].
    Envelopes Envelopes DocuSign de contas DocuSign sincronizadas. Os registros na tabela Envelopes são atualizados somente quando o webhook está configurado para a conta DocuSign.
    As tabelas Spoke do DocuSign eSignature incluem esses campos.
    Tabela Campos
    Contas [sn_docusign_spoke_accounts]
    • ID da conta
    • Nome da conta
    • Descrição
    • E-mail
    • Alias
    • Nome de exibição
    Modelos [sn_docusign_spoke_docusign_templates]
    • Conta
    • ID do modelo
    • Nome
    • Descrição
    • Última modificação
    • Nome de exibição
    Envelopes [sn_docusign_spoke_envelopes]
    • Conta
    • ID
    • Status
    • Data de assinatura
    • Motivo Recusado
    • Nome de exibição
    • Assinatura integrada
    • Data de assinatura Fuso horário
    • Modelo

    Requisitos da conta do DocuSign

    O Spoke do DocuSign eSignature requer a configuração de sua conta do DocuSign para gerar um token de Concessão de Portador OAuth 2.0 JWT.

    Requisitos de aliases de conexão e credencial

    IntegrationHub O usa aliases para gerenciar informações de conexão e de credencial e credenciais de OAuth. O uso de um alias elimina a necessidade de configurar várias credenciais e perfis de informações de conexão ao usar vários ambientes. Se as informações de conexão ou de credencial forem alteradas, não será necessário atualizar nenhuma ação que use a conexão.

    Este spoke usa o registro de alias de conexão e credencial do DocuSign para autorizar ações.

    Importante:
    • Você pode optar por configurar o DocuSign spoke usando a concessão de código de autorização ou a concessão JWT.
      • Use a Concessão de código de autorização se sua integração usar um navegador ou cliente para fazer solicitações a um servidor Web.
      • Use a Concessão JWT se cada usuário da sua integração usar uma única conta do sistema para fazer login.

      Para obter mais informações sobre quando escolher um dos métodos de configuração, consulte Escolher tipo de OAuth na documentação do desenvolvedor do DocuSign.

    • Sua empresa pode ter uma conta DocuSign para cada departamento que usa o DocuSign. Para usar várias contas com este spoke, crie um alias secundário para cada conta. Além disso, certifique-se de substituir o alias base pelo alias secundário em seus fluxos. No tempo de execução, o sistema identifica o alias secundário associado à conta e envia as informações corretas de conexão e credencial na solicitação.

      Se sua empresa tiver apenas uma conta, você poderá usar o alias padrão do DocuSign fornecido com o spoke e prosseguir para a configuração do DocuSign spoke usando a concessão de código de autorização ou a concessão JWT.

    Requisitos do MID Server

    Essas ações usam chamadas REST, que podem ser executadas em uma instância ou MID Server. Use o registro de conexão associado ao alias DocuSign para configurar onde as ações são executadas, bem como definir atributos de seleção do MID Server. Para obter mais informações, consulte MID server.