Guia de instalação e configuração do Adobe Acrobat Sign for ServiceNow (v2.2)

Visão geral

O aplicativo do Adobe Acrobat Sign for ServiceNow permite enviar documentos para assinatura usando a funcionalidade nativa da plataforma do ServiceNow. A integração do Acrobat Sign com o ServiceNow oferece acesso aos seguintes recursos e funcionalidades:

  • Envio de documentos para vários destinatários assinarem. 
  • Acompanhamento do processo completo de assinatura e identificação dos signatários esperados em cada estágio.
  • Recuperação do documento assinado por meio de um documento de trilha de auditoria incorporado ou separado.
  • Recuperação dos dados de formulário inseridos no documento antes ou durante o processo de assinatura.
  • Criação de rascunhos no processo de assinatura para uma revisão inicial e um envio subsequente. Quaisquer modificações de signatário(a) feitas antes do envio são sincronizadas no ServiceNow.
  • Geração e envio de notificações de email para indivíduos durante o processo de assinatura.
  • Selecione documentos para assinatura dos arquivos locais do ServiceNow ou de uma fonte externa.
  • Use modelos de documento com campos que podem ser preenchidos usando dados de registros do ServiceNow antes do envio. Isso permite usar um único modelo para gerar documentos específicos do usuário com base em um registro de assunto selecionado, como um incidente ou uma solicitação de serviço.
  • Use os modelos de biblioteca da sua conta do Acrobat Sign, que estão sincronizados com o ServiceNow e disponíveis para seleção durante o processo de envio.

guia de instalação e personalização do Adobe Acrobat Sign for ServiceNow fornece instruções sobre como:

Depois de instalar e configurar o Acrobat Sign para o aplicativo ServiceNow, você poderá usá-lo para enviar, assinar, monitorar e gerenciar contratos. Consulte o Guia do usuário do Adobe Acrobat Sign for ServiceNow.

Instalar o aplicativo Acrobat Sign for ServiceNow

Você deve ser um(a) admin do Adobe Acrobat Sign e um(a) admin de sistema do ServiceNow para instalar o aplicativo no ServiceNow.  

  1. Acesse a página ServiceNow Store e procure por Adobe Acrobat Sign.  

    servicenow-store-search

  2. Nos resultados da pesquisa, selecione Adobe Acrobat Sign e clique em Obter.

    Observação:

    Desative qualquer bloqueador de pop-up durante a instalação do aplicativo.

    get-sign-app

  3. Se solicitado, faça logon usando suas credenciais de admin do ServiceNow e siga as etapas de instalação.

  4. Para verificar a instalação, no menu superior da instância do ServiceNow, selecione Tudo > Aplicativos de sistema > Meus aplicativos da empresa e selecione a guia Instalado. Isso exibirá a lista com a versão mais recente do Adobe Acrobat Sign.

    installed-apps

    Observação:

    O plugin Adobe Acrobat Sign for ServiceNow está configurado para funcionar com os seguintes domínios:

    • service-now.com
    • servicenowservices.com

    O domínio servicenowservices.com é para clientes da nuvem governamental e requer uma configuração adicional das propriedades do sistema. Se seu domínio estiver no domínio servicenowservices.com, você deve criar/definir a propriedade do sistema x_adosy_as.oauth_redirect_host com o subdomínio completo de sua instância (como mydomain.servicenowservices.com).

    O menu “Autoatendimento” exibe a nova opção do Adobe Acrobat Sign com os dois módulos a seguir:

    • Meus documentos assinados - Contém uma lista de contratos concluídos nos quais o usuário conectado é o solicitante ou um signatário.
    • Para assinatura - Contém uma lista de contratos que agauardam a assinatura do usuário conectado. Os contratos possuem o status “Enviado para assinatura” ou “Enviado para aprovação”.

    Nota: os menus de autoatendimento são visíveis apenas para usuários com a função Signatário (x_adosy_as.adobe_sign_signer).  

    menu-acrobat-sign

    O menu Todos os aplicativos inclui uma opção do Adobe Acrobat Sign que contém os seguintes módulos:

    • Enviar para assinatura - abre um produtor de registros a partir do qual se cria e envia um contrato.
    • Meus contratos - uma lista de todos os contratos em que o usuário conectado é um solicitante ou signatário.
    • Minhas assinaturas - detalhes de registros nos quais o usuário conectado é um Participante (signatário) de um contrato.

    Operacional

    • Contratos - Detalhes finais do processo de assinatura.  Inclui o JSON e todos os eventos do Adobe Acrobat Sign que estão sendo recebidos e com os quais há interação.
    • Documentos de origem - representa um documento que pode ser adicionado a um contrato. Pode ser Local ou da Biblioteca
    • Participantes - signatários e detalhes de seu processo de assinatura.
    • Eventos - Detalhes finais do que está sendo enviado e recebido por cada evento do Adobe Acrobat Sign.
    • Dados de formulário - Tabela que contém os dados de formulário retornados depois que um contrato é assinado. Esses podem ser usados para relatórios sobre documentos e seus dados de campo.

    Administração

    • Conectar ao Acrobat Sign - A tela de conexão onde uma conta válida do Adobe Acrobat Sign pode ser vinculada ao ServiceNow.
    • Grupos do Acrobat Sign - Contém a lista de nomes e IDs dos grupos do Acrobat Sign.
    • Usuários do Acrobat Sign - Contém os detalhes dos usuários do Acrobat Sign.
    • Selos eletrônicos -
    • Modelos de documento - modelos que podem ser adicionados a um contrato. Pode ser Local ou da Biblioteca.
    • Campos de documento - Detalhes dos campos de formulário que estão incorporados no documento do modelo.
    • Regras de mesclagem - Associa um modelo de documento a um determinado tipo de registro de assunto no ServiceNow.
    • Campos de mesclagem - Registros que vinculam um campo do registro de assunto a um campo contido no modelo de documento relevante.
    • Propriedades - Configurações padrão do Adobe Acrobat Sign para redirecionamento de URI pós-assinatura, notificações e a trilha de auditoria.

    Ajuda e suporte - Links para a seção de ajuda do Adobe Acrobat Sign.

    Observação:
    • Os módulos "Enviar para assinatura", "Meus contratos" e "Minhas assinaturas" são visíveis para os usuários com a função Remetente (x_adosy_as.adobe_sign_sender). 
    • Os menus "Operacional"e "Administração" são visíveis apenas para usuários com a função Administrador (x_adosy_as.adobe_sign_admin) ou Gerente (x_adosy_as.adobe_sign_manager).

    Widgets do portal de serviço

    Caso deseje adicionar o Adobe Acrobat Sign ao portal de serviço, veja uma demonstração desse procedimento no URL /adobe_sign.

    Este portal está restrito às funções “x_adosy_as.adobe_sign_sender” e “x_adosy_as.adobe_sign_signer”.

    Para adicionar essa funcionalidade ao seu próprio portal, duplique os widgets e modifique as funções de acordo.

    • Lista de itens do painel do Adobe Acrobat - A lista de itens usada pelo widget de cabeçalho Lista de contratos.
    • Enviar para assinatura no Adobe Acrobat Sign - Um widget para criar um novo contrato a partir de um modelo ou arquivo.
    • Lista de contratos do Adobe Acrobat Sign - Um widget para exibir a lista de contratos.

    Páginas do portal de serviço

    • Adobe Acrobat Sign - Contém o widget de pop-up do Adobe Acrobat Sign e pode ser usada a partir de registros do ServiceNow para gerar novos contratos rapidamente.
    • Página inicial do Adobe Acrobat Sign - A página inicial do portal de serviço de demonstração incluído no aplicativo.

    Há quatro funções incluídas com o aplicativo:

    • Signatário (x_adosy_as.adobe_sign_signer)
      • Usuários do ServiceNow com a função “x_adosy_as.adobe_sign_signer” recebem acesso aos módulos de autoatendimento do Adobe Acrobat Sign  
      • Esses usuários também recebem acesso ao widget do portal de serviço 
      • Essa função precisa ser adicionada a todos os usuários/grupos que precisam assinar documentos/contratos
    • Remetente (x_adosy_as.adobe_sign_sender)
      • Usuários do ServiceNow com a função “x_adosy_as.adobe_sign_sender” recebem acesso ao aplicativo
      • Essa função precisa ser adicionada a todos os usuários/grupos que precisam rastrear documentos/contratos solicitados ou que precisam assinar
    • Gerente (x_adosy_as.adobe_sign_manager)
      • Usuários do ServiceNow com a função “x_adosy_as.adobe_sign_manager” têm acesso de nível de gerenciamento aos recursos do Acrobat Sign
      • O gerente pode gerenciar os contratos criados por todos os remetentes
      • Esta função concede permissão para cancelar contratos criados por outros usuários
    • Administrador (x_adosy_as.adobe_sign_admin)
      • Os usuários do ServiceNow com a função "x_adosy_as.adobe_sign_admin" têm acesso total a todas as funcionalidades

    Por padrão, o aplicativo inclui uma função que deve ser atribuída aos usuários que podem assinar os documentos. Para permitir que todos os usuários acessem e assinem documentos, você deve atualizar as configurações.

    Cuidado:

    As alterações feitas nos arquivos do aplicativo impedirão que atualizações futuras sejam aplicadas.

    Capture todas as alterações feitas em um conjunto de atualizações para que essas alterações possam ser reaplicadas após uma atualização do aplicativo.

    Sempre teste todas as personalizações em um ambiente de teste dedicado antes de aplicar à produção.

Conectar-se ao Acrobat Sign

O aplicativo Adobe Acrobat Sign for ServiceNow foi desenvolvido para funcionar com contas comerciais e governamentais (FedRAMP). Se não tiver certeza de qual conta possui, siga as instruções para clientes da nuvem comercial.

Para clientes da nuvem comercial:

Depois que o aplicativo do Adobe Acrobat Sign é instalado no ServiceNow, admins de conta ou de grupo do Adobe Acrobat Sign devem conectar o ServiceNow à nuvem comercial do Adobe Acrobat Sign seguindo as etapas abaixo:

  1. Navegue até Adobe Acrobat Sign > Administração > Conectar-se ao Adobe Acrobat Sign.

  2. Na caixa de diálogo exibida, selecione Conectar.

    connect-sign-1

  3. Faça logon na conta do Acrobat Sign com suas credenciais de admin. 

    connect-sign-2

  4. Na caixa de diálogo de permissões exibida, selecione Permitir acesso para conceder as permissões e estabelecer a conexão. 

    connect-sign-3

    Observação:

    A autenticação ocorre em uma janela pop-up.  Se o painel de autenticação não for exibido, verifique se o bloqueador de pop-ups está desabilitado.

    Quando a conexão for concluída, você verá uma mensagem de confirmação com a conta do Acrobat Sign conectada e a conta do ServiceNow à qual ela está associada.

    Acrobat Sign conectado à nuvem comercial

Para clientes da nuvem governamental:

Depois que o aplicativo Adobe Acrobat Sign é instalado no ServiceNow, admins de conta ou de grupo da nuvem governamental do Adobe Acrobat Sign podem conectar o ServiceNow à nuvem governamental do Adobe Acrobat Sign.

  1. No painel esquerdo, selecione Adobe Acrobat Sign > Administração > Propriedades.

    Habilitar o FedRAMP no Sign for ServiceNow.

  2. Na página de propriedades do aplicativo:

    1. Habilite o botão Usar a nuvem governamental do Adobe Acrobat Sign.
    2. Localize a propriedade chamada Dica de logon de conexão e defina o valor como o endereço de email que será usado para fazer logon na nuvem governamental do Adobe Acrobat Sign.
    3. Selecione Salvar.
  3. Navegue até Adobe Acrobat Sign > Administração > Conectar-se ao Acrobat Sign.

  4. Na página exibida, selecione Conectar.

    fedramp-2

  5. Se solicitado, faça logon em sua conta da nuvem governamental do Adobe Acrobat Sign.

    Depois que a conexão é estabelecida, o aplicativo redireciona de volta para o ServiceNow e atualiza automaticamente o status da conexão.

    fedramp-3

Configurar o aplicativo Acrobat Sign for ServiceNow

Definir propriedades do aplicativo

Para acessar e definir as propriedades do aplicativo, navegue até Adobe Acrobat Sign > Administração > Propriedades.

As seguintes configurações padrão serão exibidas:

  • Nome do host [x_adosy_as.redirect_host]se você tiver um URL de instância personalizado, especifique o host totalmente qualificado a ser usado no URI de redirecionamento para retornos de chamada de OAuth e API (por exemplo, webhooks).
    Por padrão, este valor fica em branco, e o host é utilizado como valor da propriedade do sistema “glide.servlet.uri”.
    Aplica-se somente ao redirecionamento de instâncias do ServiceNow. Se quiser redirecionar o(a) signatário(a) para um host diferente após a assinatura, insira esse host na propriedade URI de redirecionamento do signatário (post_sign_uri).
  • URL pós-assinatura padrão [x_adosy_as.post_sign_uri]o local padrão ao qual o usuário é redirecionado após assinar um documento no Acrobat Sign. É usado quando o URI de pós-assinatura não é especificado durante a criação do contrato. Esse URI refere-se ao nome da instância especificado, mas pode ser substituído pela inclusão de um protocolo (como https://www.adobe.com/), que permite que o redirecionamento pós-assinatura leve a um local diferente dessa instância do ServiceNow. O sys_id do contrato criado pode ser inserido no URL utilizando “{sys_id}”. O valor padrão é “/x_adosy_as_agreement_list.do?sysparm_query=requested_byDYNAMIC90d1921e5f510100a9ad2572f2b477fe%5EORsignersDYNAMIC90d1921e5f510100a9ad2572f2b477fe%5Estate=Complete%5EORDERBYDESCsys_created_on”, que levará o usuário a uma lista de contratos concluídos.
  • Atraso de redirecionamento do signatário [x_adosy_as.post_sign_delay]o período (em segundos) decorrido antes de um usuário ser redirecionado após assinar um documento no Acrobat Sign. O valor padrão é 3.
  • Defesa contra clickjacking [x_adosy_as.clickjacking_domains]insira uma lista separada por vírgulas de URLs de domínios primários nos quais os documentos enviados para assinatura podem ser incluídos em um iframe, como service-now.com.
    É obrigatório para clientes da nuvem governamental. Deixar este campo em branco poderá resultar em páginas em branco do Acrobat Sign durante a exibição em um quadro.
  • Permitir emails do Acrobat Sign [x_adosy_as.send_adobe_sign_emails]define se os emails de notificação são ou não enviados pelo Acrobat Sign durante o processo de assinatura. O valor padrão é “falso”.
  • Pop-out de rascunhos de contratos [x_adosy_as.popout_draft]por padrão, clicar no botão “Revisar detalhes” em um contrato abrirá o rascunho no Acrobat Sign, na mesma janela do navegador.
    Defina esta opção como verdadeiro para abrir uma nova janela. O valor padrão é “falso”.
  • Incluir auditoria [x_adosy_as.include_audit]controla a trilha de auditoria inclusa nos documentos assinados. O valor padrão é “verdadeiro”.
  • Usar a nuvem governamental do Adobe Acrobat Sign [x_adosy_as.fedramp]clientes da nuvem governamental da Adobe precisam habilitar essa propriedade para que o Acrobat Sign for ServiceNow use os serviços da nuvem governamental do Acrobat Sign. O valor padrão é “falso”.
  • Dica de logon na conexão [x_adosy_as.login_hint]o valor login_hint usado na primeira conexão com a nuvem governamental do Adobe Acrobat Sign. Isso preencherá automaticamente a página “Conectar-se ao Acrobat Sign”, e geralmente é o email do usuário admin da conta. O valor padrão é nulo.
  • Campos do formatador de atividades do contrato [glide.ui.x_adosy_as_agreement_activity.fields]define quais campos devem ser mostrados no formato de atividade apresentado no registro do contrato.
    O valor padrão é “name, state, status,agreement_id,compose_url,post_sign_uri,etag”.
  • Consulta de “Meus contratos” [x_adosy_as.my_agreements_query]a consulta utilizada ao exibir meus contratos em locais como o portal. O valor padrão é “requested_byDYNAMIC90d1921e5f510100a9ad2572f2b477fe^ORsignersDYNAMIC90d1921e5f510100a9ad2572f2b477fe”, que retorna contratos nos quais o usuário é o solicitante ou um signatário.
  • Extensão de arquivo de várias partes [x_adosy_as.multipart_extension]a extensão do nome do arquivo a ser usada para os anexos temporários de arquivos de várias partes. O valor padrão (e recomendado) é “mpfd”.
  • Log de aplicativos [x_adosy_as.logging.verbosity]controla os logs do sistema. O valor padrão é “info”.
  • Depurar conexão [x_adosy_as.connect_debug]exibe alertas de diagnóstico durante a conexão com o Acrobat Sign. O valor padrão é “falso”.

A propriedade de URL de redirecionamento padrão aplica-se a qualquer contrato no qual o valor do campo “URI pós-assinatura” não tenha sido definido.

Observação:

Caracteres especiais ou espaços não codificados não são compatíveis com os URLs de redirecionamento. Portanto, se o “URL de pós-assinatura padrão” na Propriedade do aplicativo incluir um símbolo de circunflexo (^), você deverá codificá-lo como %5E.

Por exemplo, você deve alterar  /x_adosy_as_agreement_list.do?sysparm_query=requested_byDYNAMIC90d1921e5f510100a9ad2572f2b477fe^ORsignersDYNAMIC90d1921e5f510100a9ad2572f2b477fe^state=Complete^ORDERBYDESCsys_created_on para:

 /x_adosy_as_agreement_list.do?sysparm_query=requested_byDYNAMIC90d1921e5f510100a9ad2572f2b477fe%5EORsignersDYNAMIC90d1921e5f510100a9ad2572f2b477fe%5Estate=Complete%5EORDERBYDESCsys_created_on 

As propriedades restantes determinam se as notificações serão enviadas pelo Acrobat Sign durante o processo de assinatura (padrão = Não) e se a trilha de auditoria estará incluída nos documentos assinados (padrão = Sim).

Configurar componentes personalizados

O aplicativo Adobe Acrobat Sign contém componentes personalizados que podem ser configurados de acordo com os seus requisitos. Consulte a lista de componentes abaixo para ver como modificar cada um deles.

“Assinar com o Adobe Acrobat” é um botão de ação de interface da tabela Tarefa [task]. Ele só pode ser acessado por usuários com a função de Remetente (x_adosy_as.adobe_sign_sender). Permite que os remetentes adicionem documentos e signatários(as) a um contrato e enviem o documento anexado ao Adobe Acrobat Sign para assinatura.

ui-action-1

Admins de sistema podem adicionar a ação “Assinar com o Adobe Acrobat” a outras tabelas da seguinte maneira:

  1. Abra a ação “Assinar com o Adobe Acrobat” existente utilizando um destes dois métodos: 
    • Em qualquer formulário estendido da tarefa (como Incidente), clique com o botão direito do mouse em > Configurar ações de interface.
    • Navegue até Definição do sistema > Ações de interface e procure por Assinar com a Adobe Acrobat
  2. Altere o nome da tabela conforme necessário.
  3. Clique com o botão direito do mouse na barra de ações superior e selecione Inserir e permanecer para criar uma cópia do registro existente com a nova tabela.

A “Lista relacionada do Adobe Acrobat Sign" exibe os contratos relacionados ao registro no qual a lista está configurada. Somente pessoas com a função de Usuário (x_adosy_as.adobe_sign_user), ou seja, aquelas que são solicitantes ou signatários(as) do contrato, podem ver os contratos na lista relacionada.

Admins de sistema ou usuários com a função “personalize_form” podem configurar o formulário e o layout da lista relacionada.

Para adicionar a lista relacionada a formulários:

  1. No formulário em questão, clique com o botão direito do mouse e navegue até Configurar > Listas relacionadas.
  2. Na lista Disponível, selecione Adobe Acrobat Sign
  3. Selecione a seta para a direita para adicioná-lo à lista Selecionado.
  4. Clique em Salvar.

Você retornará ao formulário que estava configurando, e a lista relacionada do “Adobe Acrobat Sign” será exibida na parte inferior do formulário.

related-list-3

Configurar componentes do portal de serviço

O aplicativo Acrobat Sign for ServiceNow inclui os seguintes elementos do portal de serviços que podem ser usados ou copiados com os seus próprios portais de serviços.

O portal de serviços do Adobe Acrobat Sign incluso no aplicativo não deve ser usado nem estendido. Ele é compatível somente com a interface “Enviar para assinatura”.

O portal pode ser acessado em /adobe_sign.

Há duas páginas do portal de serviços inclusas no aplicativo:

  • Adobe Acrobat Sign (x_adosy_as_send)
  • Página inicial do Adobe Acrobat Sign (x_adosy_as_home)

A página Adobe Acrobat Sign (x_adosy_as_send) é usada exclusivamente para a interface Enviar para assinatura e não deve ser modificada.

A Página inicial do Adobe Sign (x_adosy_as_home) é usada como a página inicial do portal de serviços e serve como uma “vitrine” de apresentação dos dispositivos inclusos.

Você pode usar os dispositivos inclusos com o aplicativo de acordo com os seus requisitos. Para monitorar as alterações do dispositivo e obter atualizações do aplicativo, você precisa fazer todas as alterações apenas em um clone do dispositivo.

  • Enviar para assinatura no Adobe Acrobat Sign: é usado para criar um contrato a partir de modelos e/ou arquivos carregados. É acessado por meio do item de menu Enviar para assinatura e da ação de interface Assinar com o Adobe Acrobat. Essa opção está disponível para usuários com função de Remetente.

Opções de dispositivo: os dispositivos podem ser personalizados conforme necessário por meio de suas opções de instância ou parâmetros de URL. Use os modelos de documento e as regras de mesclagem para preencher os dados do formulário automaticamente. Você pode definir as opções booleanas como “verdadeiro” ou “1” ao usar os parâmetros de URL.

Nome

Tipo

Descrição

subject_table

Sequência de caracteres

O nome da tabela à qual o contrato pertence.

subject_id

Sequência de caracteres

O sys_id do registro ao qual o contrato pertence.

agreement_name

Sequência de caracteres

O nome do novo contrato.

anexos

Sequência de caracteres

Uma lista de sys_ids de anexos para uso no contrato.

modelos

Sequência de caracteres

Uma lista de sys_ids de modelos de documento para uso no contrato.

signatários

Sequência de caracteres

Uma lista de usuários ou endereços de email a serem adicionados como signatários.

ccs

Sequência de caracteres

Uma lista de usuários ou endereços de email para adicionar como opções de cópia (CC).

password_protect

Booleano

Exige que o usuário defina uma senha para proteger o contrato. O usuário precisará definir uma senha mesmo se “hide_options” ou “lock_options” for “verdadeiro”.

send_emails

Booleano

Permitir que a Adobe envie notificações por email durante o processo de assinatura.

submit_as_draft

Booleano

Criar um rascunho de contrato em vez de enviar para assinatura imediatamente.

copy_to_subject

Booleano

Copiar o arquivo do contrato assinado para o registro de assunto. É necessário fornecer uma subject_table e um subject_id válidos.

post_sign_uri

Sequência de caracteres

Fornece um redirecionamento personalizado a signatários(as) que terminaram de assinar. O redirecionamento padrão enviará o usuário ao registro do contrato.

hide_options

Sequência de caracteres

Uma lista de opções a serem ocultadas, separadas por vírgulas (password_protect, send_emails, submit_as_draft, copy_to_subject). Defina como “verdadeiro” para ocultar todas as opções do usuário.

lock_options

Sequência de caracteres

Uma lista de opções para transformar em “somente leitura”, separadas por vírgulas (password_protect, send_emails, submit_as_draft, copy_to_subject). Defina como “verdadeiro” para impedir que todas as opções sejam alteradas pelo usuário.

hide_subject

Booleano

Impede que anexos do assunto sejam selecionados.

skip_documents

Booleano

Ignorar o painel de documentos inicial. Será aplicado somente quando os anexos ou modelos forem pré-selecionados.

  • Lista de itens do painel do Adobe Acrobat: pode ser usada para adicionar uma lista de contratos atuais que precisam ser assinados ao seu portal de serviços de cliente ou funcionário. Esta lista é usada no recurso de tarefas da página inicial do Adobe Sign.
    Para acessar os registros mostrados nesta lista, navegue até Autoatendimento > Adobe Acrobat Sign > Para assinatura.
  • Cabeçalho do Adobe Acrobat Sign: usado na página inicial do Adobe Sign para apresentar o recurso de tarefas.
dispositivo

Criar modelos de documento

Um modelo de documento define um modelo que pode ser selecionado para inclusão em um contrato.  Um modelo pode ser usado para oferecer um documento padrão que pode ser reutilizado em vários contratos individuais. O registro “Documento de origem” faz referência a um modelo para disponibilizar os recursos desse modelo ao contrato associado.

O modelo pode ser da instância local do ServiceNow ou um modelo de biblioteca cujos detalhes são sincronizados da conta do Adobe Acrobat Sign conectada.

Sincronizar modelos de biblioteca

Depois que o aplicativo é instalado e configurado, admins podem sincronizar os modelos de biblioteca. Um modelo de biblioteca do Adobe Acrobat Sign é definido na conta do Acrobat Sign, e seus detalhes são sincronizados com o ServiceNow.  O documento que define um modelo de biblioteca também é armazenado na conta do Acrobat Sign conectada e, portanto, nenhum upload é necessário para o envio.

Para sincronizar os modelos de biblioteca com o ServiceNow:

  1. Navegue até Adobe Acrobat Sign > Administração > Modelos de documento.
  2. Selecione Atualizar biblioteca.

Isso atualiza a exibição da lista com os modelos de biblioteca da conta do Acrobat Sign conectada.

refresh-library

Criar modelos locais

O documento que define um modelo local é mantido como um registro de anexo no ServiceNow e precisa ser carregado no Acrobat Sign como parte do processo de envio.

O documento de um modelo pode ou não conter campos de formulário que precisam ser preenchidos previamente com os dados do registro de assunto de um contrato. Você deve usar um modelo se o documento contiver esses campos de formulário.

  1. Navegue até Acrobat Sign > Administração > Modelos de documento.
  2. Selecione Novo. 
  3. Na página do novo registro do modelo:
    1. Dê um nome ao modelo.
    2. Defina o tipo como Local.
    3. Clique com o botão direito do mouse e selecione Salvar.
  4. Para associar um documento ao modelo, selecione e arraste o arquivo para o registro do modelo ou selecione o ícone de clipe de papel no cabeçalho e, em seguida, o arquivo. Quando o arquivo for adicionado, selecione o ícone X para fechar a caixa de diálogo.

O documento é anexado ao modelo de documento e é referenciado no campo “Documento”.

create-template-without-field-1

create-template-without-field-2

create-template-without-field-3

Você precisa seguir as mesmas etapas descritas para criar modelos sem campos. No entanto, depois que o documento for associado, você deverá concluir as seguintes etapas adicionais de configuração, conforme necessário: 

  • Verifique se o campo “Preenchível” está definido como verdadeiro. 

Ele é marcado automaticamente quando um documento que contém campos preenchíveis é associado ao modelo.

  • Criar registros de campo do documento.

Os registros de campo de documento são criados para um modelo de documento principal e definem os detalhes dos campos de formulário incorporados ao documento do modelo.

Para isso, salve o registro do modelo de documento e selecione Atualizar campos.

A lista relacionada “Campos do documento” é preenchida com registros correspondentes aos campos preenchíveis do formulário no documento anexo.

create-template-with-fields

  • Configurar regras de mesclagem

Uma Regra de mesclagem associa um modelo de documento a um determinado tipo de registro de assunto no ServiceNow.

Um único modelo de documento pode ter várias regras de mesclagem vinculadas a ele (uma para cada tipo de registro de assunto usado para pré-preencher os campos do modelo).

Por exemplo, um modelo pode ser preenchido usando dados de um Incidente, uma Solicitação de serviço ou um Registro de solicitação de alteração (nesse caso, o modelo teria três regras de mesclagem, uma para cada tabela de assunto).

Para configurar a Regra de mesclagem:

  1. Navegue pela lista relacionada à regra de mesclagem.
  2. Selecione Novo.
  3. Selecione uma tabela (por exemplo, Incidente).
  4. Clique com o botão direito do mouse e selecione Salvar.
merge-rule

  • Configurar campos de mesclagem

Um registro de campo de mesclagem vincula um campo do registro de assunto a um campo contido no modelo de documento relevante.  Os campos de mesclagem precisam ser criados manualmente ao configurar a regra de mesclagem.

Para criar registros de campo de mesclagem:

  1. Navegue até Adobe Acrobat Sign > Administração > Regras de mesclagem.
  2. No registro de regras de mesclagem, selecione “Atualizar campos”.
    Isso preenche a lista incorporada “Mesclar campos” com os campos do documento. 
  3. Para vincular os campos do documento relevantes a seus campos de registro correspondentes, selecione o link do campo de registro correspondente ao campo do documento que você deseja mapear (por exemplo, o nome).
  4. Selecione o campo de registro correspondente (por exemplo, Autor da chamada) no menu suspenso. 
  5. Selecione Atualizar.

Haverá um redirecionamento ao registro da regra de mesclagemA lista relacionada Mesclar campos agora contém o valor do campo de registro selecionado na etapa anterior.

Para fins de organização, exclua (e confirme a exclusão) os campos de mesclagem restantes que não serão mapeados, para que a lista incorporada de campos de mesclagem contenha apenas os valores que estiverem sendo mapeados.

merge-fields-1

Criar um item do catálogo de serviços

O Acrobat Sign for ServiceNow permite criar novos contratos que os usuários podem acessar no catálogo de serviços por meio da criação de um produtor de registros. Você pode configurar o produtor de registros para coletar quaisquer dados que deseje mesclar com o documento, bem como criar e enviar o contrato ao usuário automaticamente. 

Usuários com funções de catalog_admin ou admin podem criar um item do catálogo. As etapas abaixo explicam como criar um item do catálogo chamado Produtor de registros. Você pode repetir as etapas para criar outros itens de catálogo.

Observação: certifique-se de que o aplicativo Adobe Acrobat Sign não esteja selecionado ao configurar a sua instância.

O processo de criação de cada produtor de registros pode variar de acordo com os requisitos específicos dos campos, modelos, variáveis do documento etc.; no entanto, os princípios são os mesmos.  O exemplo deste guia mostra como criar um contrato de “Credencial de estacionamento”. 

Para criar um Produtor de registros:

  1. Navegue até Catálogo de serviços > Definição do catálogo > Produtores de registros e selecione Novo.

  2. Na página do novo produtor de registros:

    1. Forneça um nome para o registro.
    2. Defina o nome da tabela como “Contrato” [x_adosy_as_agreement].
    3. Insira uma breve descrição.
    4. Defina o campo “Redirecionar para” como Registro de tarefa gerado.
    Gerar um registro de tarefa

  3. Selecione a guia Acessibilidade e defina os campos Catálogos, Categoria e Disponibilidade conforme necessário. Em seguida, clique com o botão direito do mouse na barra do cabeçalho e selecione Salvar.

    Você pode definir estes campos por meio das listas relacionadas “Categorias” e “Catálogos”. 

    Guia Acessibilidade

  4. Usando a lista relacionada “Variáveis”, adicione variáveis conforme necessário para corresponder aos campos de documento. 

    Neste exemplo, adicionamos os campos de nome, funcionário e gerente.

    guia Variáveis

    Observação:

    O valor padrão da variável de pergunta "Nome da permissão" é: ‘javascript:’Licença de estacionamento para ’ + gs.getUserDisplayName()’

  5. Configure o script do produtor de registros, que coletará as variáveis e criará o contrato para enviar para assinatura. No campo “Script”:

    1. Copie e cole o seguinte script, que lê as variáveis de itens de catálogo.
    2. Atualize as definições das variáveis para coletar informações do produtor.
    3. Atualize o sys_id do modelo de documento que estiver usando.
    4. Atualize o post_sign_uri, se quiser que o usuário seja redirecionado após a assinatura.

     

    // Exemplo de produtor de registros do Adobe Acrobat Sign para um modelo de “Credencial de estacionamento”

    (function() {

      // Colete as informações necessárias das variáveis preenchidas pelo usuário

      var employee_id    = producer.employee + '';

      var employee_name  = producer.employee.getDisplayValue() + '';

      var manager_id     = producer.manager + '';

      var manager_name   = producer.manager.getDisplayValue() + '';

      var agreement_name = "Credencial de estacionamento de " + employee_name;

      // sys_id codificado do modelo de documento que está sendo usado

      var document_template = '5a2e0131db4c7c10c39151fcd39619af'; // Credencial de estacionamento

      // Configure os dados a serem mesclados com o modelo de documento acima.

      // Cada propriedade é o nome de um campo de documento para o qual queremos mapear.

      var merge_data = {

        name         : agreement_name,

        employeename : employee_name,

        managername  : manager_name,

      };

      // Configure o novo contrato

      var agreement = new x_adosy_as.Agreement(current);

     

      // Adicione os documentos a serem assinados

      agreement.addDocument(document_template, merge_data);

      // Adicione signatários(as)

      agreement.addSigner(employee_id);

      agreement.addSigner(manager_id);

      // Defina o nome do contrato

      current.name = agreement_name;

      // Defina o URL para o qual signatários(as) serão redirecionados(as) após a assinatura

      current.post_sign_uri = '/x_adosy_as_agreement.do?sys_id=' + current.sys_id;

      // Defina o estado como “Pronto” para enviar para assinatura imediatamente

      current.state = 'Pronto';

    })();

Criar um contrato a partir de uma atividade de fluxo de trabalho

Para adicionar documentos para assinatura aos itens de catálogo existentes, você pode adicionar uma tarefa ao fluxo de trabalho que gera o contrato e uma tarefa de catálogo que o atribui a um usuário para assinatura.

O exemplo a seguir demonstra como usar o aplicativo do Acrobat Sign. No entanto, os detalhes específicos das etapas de configuração podem variar de acordo com os requisitos do seu processo.

Para criar um contrato a partir de uma atividade de fluxo de trabalho, você precisa configurar os seguintes componentes: 

  • Tarefa do catálogo: cria o contrato, envia-o para assinatura e atribui uma tarefa para o(a) signatário(a).
  • Ação de script: responde ao evento acionado quando o contrato é assinado e, em seguida, fecha a tarefa, fornecendo o ciclo de feedback e permitindo que o fluxo de trabalho prossiga. 

Para criar uma tarefa de catálogo:

  1. No Editor de fluxos de trabalho, selecione a guia Principal.
  2. Navegue até Atividades principais > Tarefas e arraste a atividade Tarefa de catálogo até o local apropriado no fluxo de trabalho.
  3. Forneça um nome para a tarefa e defina sua prioridade.
  4. Defina Aguardar conclusão como verdadeiro.
  5. Na seção “Script”, defina o sinalizador Avançado como verdadeiro e, em seguida, escreva o seu código no campo Script avançado. Um código de exemplo é fornecido abaixo.
  6. Selecione Atualizar.
Criar um contrato a partir de uma atividade de fluxo de trabalho.

// Exemplo de criação de atividade de fluxo de trabalho da tarefa

(function () {

  // O usuário que precisa assinar o contrato

  var signer_id = current.request.requested_for + '';

  var signer_name = current.request.requested_for.getDisplayValue() + '';

  // O nome do contrato

  var agreement_name = current.short_description + ' for ' + signer_name;

  // sys_id codificado do modelo de documento do Adobe Sign para esta ação

  // Deve ser uma variável de fluxo de trabalho para direcionar os dados.

  var document_template = '2a9b1f57db508810257e73278c9619dc'; // Meu modelo

  // defina o GUID sem chamar o newRecord() - necessário para o assunto do contrato

  task.setNewGuid(gs.generateGUID(task.getTableName()));

  // Configure a tarefa

  task.short_description = current.short_description;

  task.assigned_to = signer_id;

  task.description = 'Contrato: ' + '\'' + agreement_name + '\'' +

    ' foi enviado para que você o assine.\n' +

    'Para assinar:\n' +

    '- Navegue até: \'Autoatendimento > Adobe Sign > Para assinatura\' ou\n' +

    '- Clique no link do contrato do \'Adobe Acrobat Sign\' '+

    'na lista relacionada (abaixo).';

  // Opções de contrato (campos no registro do contrato)

  var options = {

    submit_as_draft: true // revisar o contrato na Adobe antes de enviar

  };

  // Criar um objeto para auxiliar no processo de assinatura

  var adobe = new x_adosy_as.AdobeSign();

  // Crie o contrato e insira o registro da tarefa como o assunto

  adobe.createAgreement(agreement_name, task, options);

  // Adicione o modelo de documento.

  adobe.addDocument(document_template);

  // Adicione signatários(as). É possível utilizar os endereços de email ou sys_ids dos usuários.

  adobe.addSigner(signer_id);

  // Envie o contrato para a Adobe.

  adobe.submitAgreement();

})();

Agora você pode configurar uma ação de script para definir automaticamente a tarefa de catálogo como “Fechada e concluída” quando o contrato for concluído. Você precisa configurar a ação de script a ser acionada pelo evento x_adosy_as.agreement.complete na tabela de contratos.

Para criar uma nova ação de script:

  1. Navegue até Política do sistema > Eventos > Ações de script e clique em Novo.
  2. Na página da nova ação de script:
    1. Forneça um nome para a ação de script.
    2. Defina o nome do evento como x_adosy_as.agreement.complete.
    3. Marque a caixa de seleção Ativo
    4. No campo “Script”, copie e cole o script da Ação de script: exemplo de código abaixo.
  3. Clique com o botão direito na barra do cabeçalho e selecione Salvar.
worflow-actitivty-script-action

Ação de script: exemplo de código

// Ação de script para definir o estado da tarefa do catálogo como “Fechada e concluída”

(function () {

  var catalog_task = current.subject_id.getRefRecord();

  if (!catalog_task.isValidRecord() || catalog_task.getTableName() != 'sc_task') {

    return;

  }

  catalog_task.state = 3; // Fechada e concluída

  catalog_task.update();

})();

Usar o Acrobat Sign com gerenciamento de contratos

Você pode usar o Acrobat Sign com outros registros além dos baseados em tarefas, conforme descrito acima em Componentes personalizados. As instruções abaixo demonstram como usar o Acrobat Sign para gerenciar contratos. Os detalhes específicos das etapas de configuração podem diferir de acordo com os requisitos do seu processo.

Para usar o Acrobat Sign para gerenciar contratos, você precisa configurar os dois componentes a seguir:

  • Ação de interface: cria o contrato e o envia para assinatura.  Após o contrato ser assinado, um evento será disparado. 
  • Ação de script: responde ao evento e fornece um ciclo de feedback, avançando o processo e atualizando o contrato. 

Observação: somente usuários com as funções “ui_action_admin” ou “admin” podem definir ações de interface. Usuários com a função “admin” só podem definir uma ação de script.

Criar ação de interface

Para criar uma ação de interface no formulário do contrato [ast_contract]

  1. Navegue até Definição do sistema > Ações de interface e selecione Nova.

    Como alternativa, no formulário do contrato [ast_contract], clique com o botão direito do mouse e selecione Configurar > Ações de interface > Nova.

  2. Na página do novo registro de ação de interface, insira os seguintes detalhes:

    1. Verifique se a tabela é “Contrato [ast_contract]”. 
    2. No campo “Nome”, forneça um nome para o registro.
    3. No menu suspenso “Tabela”, selecione uma tabela.
    4. Insira um pedido.
    5. Marque a caixa de seleção Ativo.
    6. Marque a caixa de seleção Mostrar inserção.
    7. Marque a caixa de seleção Mostrar atualização.
    8. Marque a caixa de seleção Botão do formulário.
    9. Depois de concluído, clique com o botão direito do mouse na barra superior e selecione Salvar

    O formulário é salvo e recarregado.

    ui-action-new-record

  3. No campo Condição, insira a sua condição para exibir a ação de interface. 

    O exemplo atual seleciona a condição como: ‘current.state == 'draft' andand current.substate == 'under_review' andand !current.approver.nil()’.  

    Condição

  4. No campo Script, insira um código (confira o código de exemplo abaixo) para criar um registro de contrato, defina determinados valores de campos e envie ao Adobe Acrobat Sign. 

    O código fornecido pode variar de acordo com os seus requisitos, mas o princípio é o mesmo.

    Observação:

    O sys_id codificado do Modelo de documento se refere ao modelo que estamos usando em nosso exemplo. 

    O seu será o modelo que você cria (consulte Criar modelos locais para obter detalhes sobre como criar um modelo).

    // Exemplo de ação de interface para criar um novo contrato do Adobe Acrobat Sign

    (function() {

      // O nome do contrato

      var agreement_name = 'Contrato: ' + current.short_description;

      // sys_id codificado do modelo de documento para esta ação

      var document_template = '6d0cdc26db708c50257e73278c9619c4'; // Contrato

      // Criar um objeto para auxiliar no processo de assinatura

      var adobe = new x_adosy_as.AdobeSign();

      // Crie o contrato e insira o registro atual como o assunto

      adobe.createAgreement(agreement_name, current);

      // Adicione o modelo de documento. É possível utilizar o sys_id de um anexo.

      adobe.addDocument(document_template);

      // Adicione signatários(as). É possível utilizar os endereços de email ou sys_ids dos usuários.

      adobe.addSigner(current.approver);

      // Envie o contrato para a Adobe.

      adobe.submitAgreement();

      // Redirecione o usuário de volta a este registro.

      action.setRedirectURL(current);

    })();

Criar ação de script

É possível acionar ações de script somente por eventosA ação de script é configurada para ser acionada por um dos eventos da tabela “Contrato” fornecida com o Adobe Acrobat Sign: x_adosy_as.agreement.complete

Para criar uma nova ação de script:

  1. Navegue até Política do sistema > Eventos > Ações de script.

  2. Selecione Novo.

  3. Na página do novo registro da ação de script:

    1. Forneça um nome para o script.
    2. Selecione o Nome do evento que aciona a ação de script.
    3. Marque a caixa de seleção Ativo.
    4. Escreva seu código. Confira o código de exemplo abaixo.
    Dê um nome à ação de script

    (function () { 
       
      var contract = current.subject_id.getRefRecord(); 
      
      if (!contract.isValidRecord()    contract.getTableName() != 'ast_contract') { 
        return; 
      } 
      
      contract.state = 'active'; 
      contract.update(); 
    })();

    Neste código, obtemos o contrato do campo subject_id do contrato atual e verificamos se ele é um registro válido na tabela do contrato. Nesse caso, mudamos o estado para ativo e atualizamos.

  4. Selecione Enviar.

Usar APIs de script

Você pode facilmente estender a funcionalidade do aplicativo Adobe Acrobat Sign para trabalhar com qualquer um dos seus processos usando as APIs internas. A API é acessível por meio do namespace x_adosy_as.

AdobeSign()

Cria uma instância do Adobe Sign.

Exemplo:

// Criar uma nova instância do Adobe Sign

var adobe = new x_adosy_as.AdobeSign();

 #addCcUser(String user_id)

Adicione uma opção de cópia (CC) ao contrato atual para compartilhar com usuários não participantes. Usuários não registrados como usuários do ServiceNow podem ser adicionados fornecendo um endereço de email.

Parâmetros:

Nome

Tipo

Status

Descrição

user_id

Sequência de caracteres

Obrigatório

O sys_id ou endereço de email de um usuário.

Retorna:

Tipo

Descrição

void

O método não retorna um valor

Exemplo:

// Adicione um usuário para cópia (CC) ao contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement('My Agreement');

adobe.addCcUser(current.requested_by);

adobe.addCcUser('abel.tuter@example.com');

#addDocument(String doc_selector, Object merge_data)

Adicionar um documento ou modelo ao contrato atual.

Parâmetros:

Nome

Tipo

Status

Descrição

doc_selector

Sequência de caracteres

Obrigatório

O nome de um modelo ou o sys_id de um modelo ou anexo.

merge_data

Objeto

Opcional

Um objeto de valor-chave de nomes de campo de documento para valores de campo de documento.

Retorna:

Tipo

Descrição

Sequência de caracteres

Se bem-sucedido, o sys_id do registro do documento de origem criado.

Exemplo:

// Criar um contrato com um modelo

var template_id = '2a9b1f57db508810257e73278c9619dc';

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement('My Agreement');
adobe.addDocument(template_id);

#addElectronicSeal(String seal_id)

Adicionar um selo eletrônico ao contrato atual.

Parâmetros:

Nome

Tipo

Status

Descrição

seal_id

Sequência de caracteres

Obrigatório

O sys_id, nome ou ID do selo eletrônico a ser adicionado.

Retorna:

Tipo

Descrição

String|Booleano

O sys_id do novo registro de participante, ou “falso” se o selo não for encontrado.

Exemplo:

// Adicionar um selo eletrônico ao contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement('My Agreement');

adobe.addElectronicSeal('<SEAL>');

 #addParticipant(String user_id, String participant_role)

Um método alternativo ao addSigner() permite que participantes sejam adicionados a um contrato com uma função especificada. Participantes não registrados como usuários do ServiceNow podem ser adicionados fornecendo um endereço de email.

Observação: este método só deve ser usado com registros de contrato existentes que estejam salvos no banco de dados.

Parâmetros:

Nome

Tipo

Status

Descrição

user_id

Sequência de caracteres

Obrigatório

O sys_id ou endereço de email de um usuário.

função

Sequência de caracteres

Opcional

A função do(a) participante no contrato. O padrão é SIGNER. Outros valores incluem APPROVER, ACCEPTOR, CERTIFIED_RECIPIENT, FORM_FILLER.

Retorna:

Tipo

Descrição

String|Booleano

O sys_id do novo registro de participante, ou “falso” se o registro do usuário não for encontrado ou não contiver um endereço de email.

Exemplo:

// Adicionar um(a) participante ao contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement('My Agreement');

adobe.addParticipant('abel.tuter@example.com', 'APPROVER');

#addSigner(String user_id)

Adicionar um(a) signatário(a) ao contrato atual. Signatários(as) não registrados(as) como usuários do ServiceNow podem ser adicionados(as) fornecendo um endereço de email.

Parâmetros:

Nome

Tipo

Status

Descrição

user_id

Sequência de caracteres

Obrigatório

O sys_id ou endereço de email de um usuário.

Retorna:

Tipo

Descrição

void

O método não retorna um valor.

Exemplo:

// Adicionar um(a) participante ao contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement('My Agreement');

adobe.addSigner('abel.tuter@example.com');

#copySignedDocumentToRecord(GlideRecord record)

Copie o documento assinado de um contrato para outro registro.

Parâmetros:

Nome

Tipo

Status

Descrição

registro

GlideRecord

Obrigatório

O registro de destino para o qual o documento assinado será copiado.

Retorna: 

Tipo

Descrição

String|Booleano

O sys_id do novo anexo, ou “falso” se a operação falhar.

Exemplo:

// Obter o registro de destino

var target = new GlideRecord('...');

// Copie o documento assinado do contrato para o destino
var adobe = new x_adosy_as.AdobeSign();

adobe.setAgreementRecord(agreement);

adobe.copySignedDocumentToRecord(target);

#copySignedDocumentToSubject()

Copie o documento assinado de um contrato para seu registro de assunto.

Retorna:

Tipo

Descrição

String|Booleano

O sys_id do novo anexo, ou “falso” se a operação falhar.

Exemplo:

// Copie o documento assinado do contrato para o registro de assunto
var adobe = new x_adosy_as.AdobeSign();

adobe.setAgreementRecord(agreement);

adobe.copySignedDocumentToSubject();

#createAgreement(String name, GlideRecord subject, Object option

Cria um contrato. Pode ser usado por scripts que precisam configurar um novo contrato.

Parâmetros:

Nome

Tipo

Status

Descrição

name

Sequência de caracteres

Obrigatório

O nome do contrato.

assunto

GlideRecord

Opcional

O registro do assunto, como, por exemplo, um contrato ou uma solicitação

opções

Objeto

Opcional

Um objeto de valor-chave dos nomes do campo de registro do contrato para valores.

Retorna:

Tipo

Descrição

String|nulo

O sys_id do novo contrato ou “nulo”.

Exemplo:

// Criar um novo rascunho de contrato

var options = {

  submit_as_draft: true

};

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement("My Agreement", current, options);

#getAgreement()

Obter a instância do contrato em questão.

Retorna:

Tipo

Descrição

Agreement|null

A instância do contrato ou “nulo”.

Exemplo:

// Obter a instância do contrato

var adobe = new x_adosy_as.AdobeSign();
adobe.createAgreement("My Agreement", current, options);
var agreement = adobe.getAgreement();

#getAgreementRecord()

Retornar o registro do contrato atual.

Retorna:

Tipo

Descrição

GlideRecord|null

O registro do contrato atual ou “nulo”.

Exemplo:

// Obter o registro do contrato

var adobe = new x_adosy_as.AdobeSign();
adobe.createAgreement("My Agreement", current, options);
var agreement = adobe.getAgreementRecord();

#saveAgreement(String state)

Salvar o registro do contrato atual. Opcionalmente, o estado do contrato pode ser transmitido. Isso não acionará um envio ao Adobe Acrobat Sign, a menos que o parâmetro de estado esteja definido como “Pronto”.

Parâmetros:

Nome

Tipo

Status

Descrição

estado

Sequência de caracteres

Opcional

O estado do contrato.

Retorna:

Tipo

Descrição

Sequência de caracteres

O sys_id do registro de contrato salvo ou “nulo”.

Exemplo:

// Criar um contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.createAgreement('My Agreement');

adobe.addSigner('abel.tuter@example.com');

adobe.saveAgreement();

#setAgreementRecord(String|GlideRecord agreement)

Define o contexto do contrato para o registro em questão.

Parâmetros:

Nome

Tipo

Status

Descrição

contrato

GlideRecord|String

Obrigatório

O registro do contrato.

Retorna: 

Tipo

Descrição

void

O método não retorna um valor.

Exemplo:

// Trabalhar em um contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.setAgreementRecord(agreement);

#setSubject(GlideRecord subject

Definir o registro de assunto do contrato.

Parâmetros:

Nome

Tipo

Status

Descrição

assunto

GlideRecord

Obrigatório

O registro de assunto.

Retorna:

Tipo

Descrição

void

O método não retorna um valor.

Exemplo:

// Obter um registro de assunto
var subject = new GlideRecord('...')

// Atualizar o assunto de um contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.setAgreementRecord(agreement);
adobe.setSubject(subject);
adobe.saveAgreement();

#submitAgreement()

Salve o contrato atual e envie-o ao Adobe Acrobat Sign definindo o estado como “Pronto”.

Retorna:

Tipo

Descrição

Sequência de caracteres

O sys_id do registro de contrato salvo ou “nulo”.

Exemplo:

// Enviar um contrato

var adobe = new x_adosy_as.AdobeSign();

adobe.setAgreementRecord(agreement);
adobe.submitAgreement();

.canSend()

Determina se o usuário atual pode usar a ação de interface “Assinar com o Adobe Acrobat”. O envio é permitido se a instância não for FedRAMP ou se o usuário atual tiver a função de remetente.

Retorna:

Tipo

Descrição

Booleano

Verdadeiro se o usuário tiver permissão para enviar.

Exemplo:

// Verificar se o usuário atual pode enviar para assinatura

if(AdobeSign.canSend()) {

  gs.addInfoMessage('Este usuário pode usar o processo de assinatura.');

} else {

  gs.addErrorMessage('Este usuário não tem permissão para usar o processo de assinatura.');

}

.getAgreements(String subject_table, String subject_id)

Obter uma instância do GlideRecord de contratos relacionados ao assunto.

Parâmetros:

Nome

Tipo

Status

Descrição

subject_table

String|GlideRecord

Obrigatório

O nome da tabela de assuntos ou o próprio registro de assunto.

subject_id

Sequência de caracteres

Opcional

O sys_id do assunto durante a transmissão do nome da tabela.

Retorna:

Tipo

Descrição

GlideRecord

Uma instância do GlideRecord de contratos relacionados ao assunto.

Exemplo:

// Obter contratos usando o nome da tabela e o sys_id

var agreement = x_adosy_as.AdobeSign.getAgreements('sc_req_item', '<sys_id>');

while (agreement.next()) {

  gs.addInfoMessage(agreement.getDisplayValue());

}

// Obter contratos com um GlideRecord

var req_item = new GlideRecord('sc_req_item');

req_item.get('<sys_id>');

var agreement = x_adosy_as.AdobeSign.getAgreements(req_item);

while (agreement.next()) {

  gs.addInfoMessage(agreement.getDisplayValue());

}

.getMyAgreements(String query)

Obter uma instância do GlideRecord de contratos que pertencem ao usuário. Este método depende da propriedade x_adosy_as.my_agreements_query para a consulta inicial. Outros filtros de consulta podem ser adicionados com o parâmetro de consulta.

Parâmetros:

Nome

Tipo

Status

Descrição

consulta

Sequência de caracteres

Opcional

Consulta codificada opcional para restringir ainda mais a lista de contratos.

     

Retorna:

Tipo

Descrição

GlideRecord

Contratos que pertencem ao usuário.

Exemplo:

// Obter contratos concluídos do usuário atual
var query = 'state=Complete^ORDERBYsys_created_on';

var agreement = x_adosy_as.AdobeSign.getMyAgreements(query);

while (agreement.next()) {

  gs.addInfoMessage(agreement.getDisplayValue());

}

.isFedRamp()

Determinar se o sistema está conectado ao Adobe FedRAMP (nuvem governamental).

Retorna:

Tipo

Descrição

Booleano

Verdadeiro se a propriedade x_adosy_as.fedramp tiver sido definida como “verdadeira”.

Exemplo:

// Verificar se estamos usando uma conexão FedRAMP

if(x_adosy_as.AdobeSign.isFedRamp()) {

  gs.addInfoMessage('O Acrobat Sign está usando uma conexão de nuvem governamental.');

} else {

  gs.addErrorMessage('O Acrobat Sign não está usando uma conexão de nuvem governamental.');

}

 Adobe

Receba ajuda com mais rapidez e facilidade

Novo usuário?

Adobe MAX 2024

Adobe MAX:
a conferência da criatividade

14 a 16 de outubro, Miami Beach e online

Adobe MAX

A conferência da criatividade

14 a 16 de outubro, Miami Beach e online

Adobe MAX 2024

Adobe MAX:
a conferência da criatividade

14 a 16 de outubro, Miami Beach e online

Adobe MAX

A conferência da criatividade

14 a 16 de outubro, Miami Beach e online