Módulos do DocuSign

Os módulos do Adobe Workfront Fusion DocuSign permitem que você monitore e recupere o status dos envelopes, pesquise e recupere envelopes, ou baixe e envie um documento para entrar em sua conta do DocuSign.

Para obter instruções sobre como criar um cenário, consulte os artigos em Criar cenários: índice do artigo.

Para obter informações sobre módulos, consulte os artigos em Módulos: índice do artigo.

Requisitos de acesso

Você deve ter o seguinte acesso para usar a funcionalidade neste artigo:

Adobe Workfront plano*
Pro ou superior
Adobe Workfront licença*
Plan, Work
Adobe Workfront Fusion licença**

Requisito de licença atual: nenhum requisito de licença Workfront Fusion.

Ou

Requisito de licença herdada: Workfront Fusion para Automação e Integração do Trabalho

Produto

Requisito atual do produto: se você tiver o Plano Select ou Prime Adobe Workfront, sua organização deve comprar o Adobe Workfront Fusion e o Adobe Workfront para usar a funcionalidade descrita neste artigo. Workfront Fusion está incluído no plano Ultimate Workfront.

Ou

Requisito de produto herdado: sua organização deve comprar o Adobe Workfront Fusion e o Adobe Workfront para usar a funcionalidade descrita neste artigo.

Para saber que plano, tipo de licença ou acesso você tem, contate o administrador do Workfront.

Para obter informações sobre Adobe Workfront Fusion licenças, consulte Adobe Workfront Fusion licenças.

Pré-requisitos

Para usar módulos DocuSign, você deve ter uma conta DocuSign.

Informações da API do DocuSign

O conector DocuSign usa o seguinte:

Tag da API
1.18.11

Conectar DocuSign a Workfront Fusion connect-docusign-to-workfront-fusion

Para criar uma conexão para seus módulos do DocuSign:

  1. Clique em Add ao lado da caixa Connection quando você começar a configurar o primeiro módulo DocuSign.

  2. Insira o seguinte:

    table 0-row-2 1-row-2 layout-auto html-authored no-header
    Connection name Digite um nome para a nova conexão DocuSign
    Account type Selecione se a conta à qual deseja se conectar é uma conta de produção ou uma conta de demonstração.
  3. Continue conforme descrito em Criar uma conexão com Adobe Workfront Fusion - Instruções básicas.

DocuSign módulos e seus campos

Ao configurar módulos do DocuSign, o Workfront Fusion exibe os campos listados abaixo. Junto com esses, campos DocuSign adicionais podem ser exibidos, dependendo de fatores como seu nível de acesso no aplicativo ou serviço. Um título em negrito em um módulo indica um campo obrigatório.

Se você vir o botão de mapa acima de um campo ou função, poderá usá-lo para definir variáveis e funções para esse campo. Para obter mais informações, consulte Mapear informações de um módulo para outro.

Alternância de mapa

Acionadores

Watch envelopes

Esse módulo de acionamento inicia um cenário quando um envelope é enviado, entregue, assinado, concluído ou recusado.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Criar uma conexão - Instruções básicas.
Account
Selecione a conta que contém os registros que você deseja observar.
Event type

Selecione o tipo de evento que deseja assistir.

  • Document completed
  • Document declined
  • Document sent
  • Document signed
  • New document in Inbox
Output fields
Selecione os campos que deseja incluir na saída do módulo.
Limit
Insira ou mapeie o número máximo de registros com os quais você deseja que o módulo funcione durante cada ciclo de execução de cenário.

Ações

Custom API Call

Esse módulo de ação permite executar uma chamada de API personalizada.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Insira ou mapeie a conta que deseja usar para acessar a API DocuSign.
URL

Digite o endereço no servidor Web com o qual você deseja que o módulo interaja.

Você pode digitar uma URL relativa, o que significa que não é necessário incluir o protocolo (como http://) no início. Isso sugere ao servidor Web que a interação está ocorrendo no servidor.

Por exemplo: /api/conversations.create

Method
Selecione o método de solicitação HTTP necessário para configurar a chamada de API. Para obter mais informações, consulte Métodos de solicitação HTTP.
Headers

Adicione os cabeçalhos da solicitação no formulário de um objeto JSON padrão. Isso determina o tipo de conteúdo da solicitação.

Por exemplo, {"Content-type":"application/json"}

Observação: se você estiver recebendo erros e for difícil determinar sua origem, considere modificar cabeçalhos com base na documentação Workfront. Se sua chamada de API personalizada retornar um erro de solicitação HTTP 422, tente usar um cabeçalho "Content-Type":"text/plain".

Query String

Adicione a consulta da chamada à API na forma de um objeto JSON padrão.

Por exemplo: {"name":"something-urgent"}

Body

Adicione o conteúdo do corpo para a chamada à API na forma de um objeto JSON padrão.

Nota:

Ao usar instruções condicionais como if em seu JSON, coloque as aspas fora da instrução condicional.

Limit
Insira ou mapeie o número máximo de resultados com os quais trabalhar durante um ciclo de execução.
INFO
Exemplo: Envelopes de Lista
A chamada de API a seguir retorna envelopes a partir da data especificada em sua conta DocuSign:
URL: /v2.1/accounts/{accountId}/envelopes/
Método: GET
Cadeia de Caracteres de Consulta:
  • Chave: from_date

  • Valor: YYYY-MM-DD

Especifica quando a solicitação começa a verificar alterações de status para envelopes na conta.
Exemplo de configuração de Documentação
O resultado pode ser encontrado na Saída do módulo em Pacote > Corpo > envelopes.
No nosso exemplo, 6 envelopes foram retornados:
Exemplo de saída de documento

Download a document

Este módulo de ação baixa um único documento.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Selecione a conta que contém o documento que você deseja baixar.
Envelope ID
Insira ou mapeie a ID do envelope que deseja baixar.
Document ID
Insira ou mapeie a ID do documento que deseja baixar.
Certificate
Selecione Yes se quiser incluir o certificado de assinatura de envelope no download.
Documents by User ID
Selecione Yes se você deseja permitir que os destinatários recuperem documentos por ID de usuário. Por exemplo, se um usuário estiver incluído em duas ordens de roteiro diferentes com visibilidades diferentes, o uso dessa opção retornará todos os documentos de ambos os roteiros.
Encrypt
Selecione Yes se quiser que os bytes de PDF retornados na resposta sejam criptografados para todos os gerenciadores de chaves configurados em sua conta DocuSign.
Language
Selecione o idioma.
Show Changes
Quando definido como Yes, quaisquer campos alterados para o PDF retornado são realçados em amarelo e as assinaturas ou iniciais opcionais são contornadas em vermelho.
Watermark
Selecione No para remover a marca d'água dos documentos do PDF.

Read an envelope

Este módulo de ação lê informações sobre um envelope em DocuSign usando a ID de envelope.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Selecione a conta que contém o documento do qual deseja ler informações.
Envelope ID
Insira ou mapeie a ID que contém o documento do qual você deseja ler as informações.
Outputs
Selecione as propriedades que você deseja que apareçam na saída do módulo.

Upload a file to an envelope

Este módulo carrega um arquivo especificado em um envelope existente no DocuSign.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Selecione a conta que contém o envelope no qual você deseja carregar um arquivo.
Envelope ID
Insira ou mapeie a ID do envelope no qual deseja fazer upload de um arquivo.
Source file
Selecione um arquivo de origem de um módulo anterior ou insira o nome e os dados do arquivo de origem.

Create a new envelope

Este módulo de ação cria um novo envelope a partir de um modelo. Ele retorna a ID do novo envelope, bem como o status do novo envelope.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte os artigos em Criar uma conexão - Instruções básicas.
Account
Selecione a conta que contém o envelope no qual você deseja carregar um arquivo.
Template
Selecione o modelo a partir do qual deseja criar o novo envelope. Os modelos estão disponíveis com base no Account selecionado.
After creation
Selecione se deseja salvar o envelope como rascunho ou enviá-lo para assinatura.
Template recipients
Selecionar o destinatário deste envelope

Add Recipient to Envelope

Este módulo de ação adiciona um ou mais destinatários a um envelope existente. Se o envelope já tiver sido enviado, o recipient receberá um email. Este módulo não é válido para envelopes que já foram concluídos.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Criar uma conexão - Instruções básicas.
Account
Selecione a conta que contém o envelope no qual deseja adicionar recipients.
Envelope ID
Selecione ou mapeie a ID do envelope ao qual deseja adicionar o recipient.
Recipient type

Selecione o tipo de destinatário que deseja adicionar ao envelope.

  • Agent

  • Carbon copy

  • Certified delivery

  • In-person signer

  • Intermediary

  • Signer

Email
Insira ou mapeie o endereço de email do destinatário que deseja adicionar ao envelope.
Name
Insira ou mapeie o nome do destinatário que deseja adicionar ao envelope.
Routing order
Insira ou mapeie o número do roteamento do recipient. O número do banco determina a ordem na qual os destinatários recebem e assinam seus documentos.
Email body
Insira ou mapeie o corpo (conteúdo) do email que é enviado ao destinatário.
Email subject
Insira ou mapeie o assunto do email enviado ao recipient.
Private message
  • Somente o recipient selecionado vê a mensagem privada, bem como a mensagem geral. A mensagem privada é limitada a 1000 caracteres.
Authentication

Selecione o método de autenticação que deseja usar para confirmar a identidade do recipient.

  • None

  • Access code

    Insira ou mapeie o código de acesso.

  • Phone

    Insira ou mapeie o número de telefone

  • SMS

    Insira ou mapeie o número de telefone

Add custom field

Este módulo de ação adiciona um campo personalizado ao documento

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Selecione a conta que contém o documento ao qual você deseja adicionar um campo personalizado.
Envelope ID
Insira ou mapeie a ID do envelope que contém o documento ao qual você deseja adicionar um campo personalizado.
Field name
Insira ou mapeie um nome para o novo campo que deseja adicionar.
Required
Ative essa opção se desejar que o campo adicionado seja um campo obrigatório.
Show field
Ative essa opção se desejar que o campo fique visível.
Value
Insira ou mapeie o valor (conteúdo) do campo adicionado.

Modify custom field

Esse módulo de ação modifica um campo personalizado usando o nome do campo.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Selecione a conta que contém o documento no qual você deseja modificar um campo personalizado.
Envelope ID
Insira ou mapeie a ID do envelope que contém o documento no qual você deseja modificar um campo personalizado.
Field ID
Insira ou mapeie a ID do campo que você deseja modificar.
Field name
Insira ou mapeie o nome do campo que você deseja modificar.
Required
Habilite essa opção se desejar que o campo modificado seja obrigatório.
Show field
Ative essa opção se desejar que o campo fique visível.
Value
Insira ou mapeie o valor (conteúdo) do campo modificado.

Send envelope

Esse módulo de ação envia um envelope de rascunho para seus recipients.

Connection
Para obter instruções sobre como conectar sua conta do DocuSign ao Workfront Fusion, consulte Conectar DocuSign ao Workfront Fusion neste artigo.
Account
Selecione a conta que contém o envelope de rascunho que você deseja enviar aos recipients.
Envelope ID
Insira ou mapeie a ID do envelope de rascunho que você deseja enviar aos recipients.
recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3