DocuSign eSignature Spoke
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 Cronogramas jurídicos - Visão geral do IntegrationHub.
Versão do spoke
Spoke do DocuSign eSignature v 4.1.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)
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
O spoke DocuSign eSignature permite que um designer de fluxo:
- Automatizar o processo de envio de um documento de um ServiceNow Modelo de assinatura eletrônica do DocuSign ou anexo a um indivíduo ou lista de destinatários para assinatura digital.
- Descubra e sincronize contas e modelos do DocuSign eSignature em ServiceNow.
- Recupere uma lista de contas e modelos associados da Assinatura eletrônica do DocuSign 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 modelos associados a uma conta de assinatura eletrônica da DocuSign especificada e insira-os 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.
- Pause um fluxo até que um documento seja assinado. Um webhook da REST API com script aguarda o destinatário assinar o documento.
- Use valores de um documento assinado em um fluxo.
- Anexe um documento DocuSign eSignature concluído a um ServiceNow registro para fins de auditoria.
- Gerencie 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 IntegrationHubNota:Certifique-se de ter ativado o suporte do Flow Designer para o plug-in Catálogo de serviços (com.glideapp.servicecatalog.flow_designer).
Consulte DocuSign Developer Center documentação para obter instruções sobre como criar e configurar aplicações personalizadas.
Fluxos de spoke
O spoke do DocuSign eSignature fornece fluxos de amostra para demonstrar a automação de tarefas do DocuSign. Use as ações do spoke 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 a DocuSign para uma assinatura digital quando uma solicitação do Catálogo de serviços é criada pelo Enviar um documento para assinatura digital item. Antes de usar este fluxo, ative o. Enviar um documento para assinatura digital item do catálogo. |
| Envie 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. Modelo de demonstração - Enviar oferta de trabalho ao candidato item do catálogo. |
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. |
| Modelo de demonstração — 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 DocuSign ao registro da ServiceNow | Anexa todos os documentos em um envelope a um ServiceNow registro. |
| Obter e definir dados de campo do DocuSign | Processa uma lista de variáveis de item do catálogo e atualiza um envelope de rascunho com cada valor de 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 ocorrem eventos no ServiceNow. As ações disponíveis incluem:
| Categoria | Ação | Descrição |
|---|---|---|
| Gestão de contas | Pesquisar provedores de assinatura de conta | Recupera uma lista de provedores de assinatura que a conta especificada pode usar. |
| 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 da 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 envelopes em lote de envio em massa | Recupera os envelopes do lote de envio em massa especificado. | |
| Pesquisar status do lote de envio em massa | Recupera o status geral do lote de envio em massa especificado, como número de êxitos, 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 em lote de envio em massa | Executa uma ação em massa (reenviar, corrigir ou anular) no lote de envio em massa especificado. | |
| Atualizar status do 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 do 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: A URL de assinatura fica ativa por 300 segundos e pode ser enviada 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 do DocuSign a um registro da ServiceNow. | |
| Anexar documento do DocuSign a. ServiceNow Registro | Recupera um documento DocuSign assinado e o anexa a um ServiceNow registro. | |
| Pesquisar ID do documento por nome | Recupera o ID do documento de um envelope usando o nome do documento especificado. | |
| Pesquisar documentos em um envelope | Retorna uma lista de documentos com ID e nome no envelope DocuSign fornecido. | |
| Substituir documento em um envelope | Substitui documentos por envelope. | |
| Gestão de envelopes | Adicionar destinatário ao envelope | Adiciona o destinatário especificado ao envelope especificado. Nota:
|
| 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 processo. | |
| Criar envelope de rascunho a partir do modelo | Cria um envelope de rascunho a partir de um modelo DocuSign existente. | |
| Criar envelope a partir do modelo composto | Cria um envelope a partir de um modelo composto existente. | |
| Pesquisar ID do campo | Recupera o ID do campo especificado do envelope de rascunho especificado. | |
| Pesquisar valor do 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 do destinatário por nome da 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 para o usuário | Envia um documento DocuSign associado ao especificado ServiceNow registre para o destinatário especificado para assinatura. | |
| 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. |
|
|
Reenviar envelope |
Envie um lembrete para os destinatários que são os signatários pendentes no momento. | |
| Envelope de bloqueio | Bloqueia o envelope especificado e define o tempo até que o bloqueio expire para impedir que outros usuários ou destinatários alterem o envelope. | |
| Desbloquear envelope |
Desbloqueia o envelope bloqueado especificado. |
|
| 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 para o fluxo para processamento posterior. | |
| Remover destinatário do envelope |
Exclui um destinatário de um envelope. Antes de usar esta ação, a ação Criar envelope de rascunho a partir do modelo deve ser usada para gerar um envelope de rascunho. |
|
| Destinatários de upsert para Envelope | Atualiza ou adiciona destinatários ao envelope. Se um destinatário com o ID de destinatário especificado já existir, suas informações serão atualizadas; caso contrário, um novo destinatário será criado com os detalhes fornecidos. Antes de usar esta ação, a ação Criar envelope de rascunho a partir do modelo será usada para gerar um envelope de rascunho. | |
| Gestão de grupo | Adicionar usuário ao grupo | Adiciona usuário de um grupo. |
| Pesquisar ID do grupo | Recupera um ID de grupo para o nome da função especificado. | |
| Remover usuário de grupo | Remove o usuário especificado de um grupo. | |
| Gestão de modelo | Pesquisar modelos por conta | Recupera os modelos associados à conta DocuSign especificada. |
| Pesquisar campos de modelo | Recupera todos os campos em um modelo definido para um destinatário. Nota:
|
|
| 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 Spoke
O spoke DocuSign eSignature adiciona um módulo DocuSign ao seu ServiceNow instância. O spoke DocuSign eSignature sincroniza e armazena modelos e envelopes no ServiceNow. O spoke 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 agendado Obter contas e modelos que sincroniza modelos e envelopes com sua conta do DocuSign. |
| Contas | Contas do DocuSign sincronizadas com seu ServiceNow instância. Para sincronizar contas, consulte Sincronizar DocuSign com a ServiceNow. O subfluxo Obter contas recupera uma lista de contas e modelos associados do DocuSign e, em seguida, os insere ou atualiza como registros nas tabelas Contas [sn_docusign_spoke_accounts] e Modelos [sn_docusign_spoke_docusign_templates]. |
| Modelos | Modelos do DocuSign de contas sincronizadas do DocuSign. O subfluxo Obter modelos por conta recupera modelos associados a uma conta do DocuSign especificada e, em seguida, os insere ou atualiza como registros na tabela Modelos [sn_docusign_spoke_docusign_templates]. |
| Envelopes | Envelopes do DocuSign de contas sincronizadas do DocuSign. Os registros na tabela Envelopes são atualizados somente quando o webhook está configurado para a conta do DocuSign. |
| Subfluxos de resposta dos webhooks do DocuSign | Lista de subfluxos de resposta do webhook. |
| Tabela | Campos |
|---|---|
| Contas [sn_docusign_spoke_accounts] |
|
| Modelos [sn_docusign_spoke_docusign_templates] |
|
| Envelopes [sn_docusign_spoke_envelopes] |
|
Gatilhos do spoke
ServiceNow Oferece suporte a eventos específicos no DocuSign que criam gatilhos. Primeiro, você deve configurar um fluxo com uma definição de gatilho compatível. Quando ocorre um evento, por exemplo, uma solicitação por push, no DocuSign, ele envia a carga por meio de um webhook para ServiceNow instância. Depois disso, o fluxo que você configurou é acionado em ServiceNow instância para automatizar um fluxo de trabalho. Os eventos compatíveis são:
| Categoria | Gatilho | Definição |
|---|---|---|
| Gestão de envelopes | Envelope concluído | O gatilho é iniciado quando um envelope é concluído por todos os destinatários. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. |
| Envelope recusado | O gatilho é iniciado quando um envelope é recusado por um dos destinatários. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Envelope excluído | O gatilho é iniciado quando um envelope enviado é excluído. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Envelope entregue | O gatilho é iniciado quando todos os destinatários abrem o envelope por meio do site de assinatura do DocuSign. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Envelope enviado | O gatilho é iniciado quando um envelope é enviado ao destinatário. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Envelope anulado | O gatilho é iniciado quando um envelope é anulado pelo remetente ou expirou. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Gestão de destinatários | Destinatário concluído | O gatilho é iniciado quando o destinatário conclui suas ações para o envelope. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. |
| Destinatário recusado | O gatilho é iniciado quando o destinatário se recusa a assinar o(s) documento(s) no envelope. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Destinatário entregue | O gatilho é iniciado quando o destinatário exibe o(s) documento(s) em um envelope por meio do site de assinatura DocuSign. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. | |
| Destinatário enviado | O gatilho é iniciado quando uma notificação por e-mail é enviada ao destinatário, indicando que é a vez dele assinar um envelope. Configure o fluxo para ser executado somente quando as condições do gatilho especificadas forem atendidas. |
Para obter informações sobre como configurar os gatilhos do spoke DocuSign eSignature, consulte Configure gatilhos para o spoke DocuSign eSignature. Para obter mais informações sobre integração de entrada, consulte Integração de entrada condicional e orientada por eventos.
Requisitos de conta do DocuSign
O spoke DocuSign eSignature requer a configuração da sua conta DocuSign para gerar um token de concessão de portador OAuth 2,0 JWT.
Requisitos de aliases de conexão e credencial
IntegrationHub usa aliases para gerenciar conexões e informações de credenciais 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 Alias de conexão e credencial do DocuSign para autorizar ações.
- Você pode optar por configurar o spoke do DocuSign usando concessão do código de autorização ou Concessão JWT .
- Use 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 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 Escolha Tipo de OAuth em Documentação do desenvolvedor do DocuSign .
- Sua empresa pode ter uma conta do 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 de 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.
- Para obter mais informações sobre alias secundário e substituir o alias base, consulte Suporte a várias conexões.
- Para obter informações sobre como configurar várias contas, consulte Crie aliases secundários para contas adicionais do DocuSign.
Se sua empresa tiver apenas uma conta, você poderá usar o padrão DocuSign Alias fornecido com o spoke e prossiga para a configuração do spoke do DocuSign usando concessão do código de autorização ou Concessão JWT .
Requisitos do MID Server
Essas ações usam chamadas REST que podem ser executadas em uma instância ou, opcionalmente, por meio de um MID Server. Use o registro de conexão associado ao alias do DocuSign para configurar onde as ações serão executadas e, se necessário, especifique MID Server atributos de seleção. Para obter mais informações, consulte MID server.
Para configurar o. MID Serverpara este spoke, consulte Configurar MID Server para um spoke.