PdfMergeSignRequestor - escopo, global

. PdfMergeSignSolicitante A API fornece métodos para adicionar uma imagem que representa uma assinatura a um documento PDF.

Esta API faz parte do ServiceNow Plug-in Utilitários de geração de PDF (com.snc.apppdfgenerator) e é fornecido em sn_pdfgeneratorutils namespace. O plug-in é ativado por padrão.

Esta API cria um objeto de assinatura que pode ser implementado em um PDF usando PDFGenerationAPI .

PdfMergeSignRequestor - PdfMergeSignRequestor()

Instancia um novo PdfMergeSignSolicitante objeto.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

Os exemplos a seguir mostram como criar um PdfMergeSignSolicitante objeto.

var v = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

PdfMergeSignRequestor - addSignatureMapping(number pagnumber, number leftmargin, number boxWidth, number boxHeight, SYSID de cadeia de caracteres)

Atribui requisitos de tamanho de assinatura e posição no PDF.

Tabela 2. Parâmetros

Nome	Tipo	Descrição
pageNumber	Número	Número da página na qual inserir a assinatura.
Margem esquerda	Número	Valor em pontos que representa a área da margem esquerda da página na qual a assinatura será inserida.
TopMargin	Número	Valor em pontos que representam a área da margem superior da página na qual a imagem de assinatura será inserida.
Largura da caixa	Número	Valor em pontos que representam a largura da caixa para conter a assinatura.
BoxHeight	Número	Valor em pontos que representam a altura da caixa para conter a imagem da assinatura.
sysId	Cadeia de caracteres	Sys_id da imagem de assinatura na tabela Anexos [sys_attachment].

Tabela 3. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como adicionar o mapeamento de assinatura. Para obter um exemplo completo, consulte ProcessRequest() .

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

// For the purpose of this example, set signature sizes and page number for signature placement
var page = 2;
var leftMargin = 48;
var topMargin = 60;
var signatureWidth = 96;
var signatureHeight = 36; 

requestor.addSignatureMapping(page, leftMargin, topMargin, signatureWidth, signatureHeight, "<signatureSysId>");

PdfMergeSignRequestor - createRequest(cadeia de caracteres targetSysId, cadeia de caracteres targetTable, cadeia de caracteres tableSysId, cadeia de caracteres targetFileName)

Cria uma solicitação de assinatura com entradas de origem e destino.

Tabela 4. Parâmetros

Nome	Tipo	Descrição
targetSysId	Cadeia de caracteres	Sys_id de um PDF na tabela Anexos [sys_attachment]. Use este valor como o PDF de destino no qual adicionar uma assinatura.
targetTable	Cadeia de caracteres	Nome da tabela que contém o registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
tableSysId	Cadeia de caracteres	Sys_id do registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
TargetFileName	Cadeia de caracteres	Nome do PDF de destino sem extensão.

Tabela 5. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como criar uma solicitação de assinatura. Para obter um exemplo completo, consulte ProcessRequest() .

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

requestor.createRequest("<sys_id>", "tableName", "<tableSysId>", "pdfFileName");

PdfMergeSignRequestor - processRequest()

Processa solicitações e adiciona as assinaturas.

Tabela 6. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 7. Retorna

Tipo	Descrição
Objeto	Objeto que contém o tamanho de cada página, se bem-sucedido, caso contrário, mensagem de erro. { "attachment_id": "String", "message": "String", "status": "String" }
<Object>.attachment_id	Se a solicitação for bem-sucedida, sys_id do PDF assinado e anexado. O arquivo está listado na tabela Anexos [sys_attachment]. Tipo de dados: Cadeia de caracteres
<Object>.message	Valores possíveis: A solicitação não pode prosseguir, pois o anexo com sys_id [0] não foi aprovado na verificação de segurança - o PDF não foi aprovado na verificação antivírus. Nenhum mapeamento de assinatura especificado. Não é possível processar esta solicitação. Forneça mapeamento de assinatura usando AddSignatureMapping() método. Solicitação concluída com sucesso. Falha na solicitação. Exceções ao tentar adicionar assinaturas ao documento. Verifique novamente. Esta solicitação não pode ser concluída porque a página solicitada não existe. Número da página: <page number> Tipo de dados: Cadeia de caracteres
<Object>.status	Status que indica se a operação foi bem-sucedida. Valores possíveis: Sucesso - A operação foi bem-sucedida. Falha - A operação não foi bem-sucedida. . messagefornece detalhes. Tipo de dados: Cadeia de caracteres

O exemplo a seguir mostra como processar a solicitação de assinatura.

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

requestor.createRequest("<sys_id>", "tableName", "<tableSysId>", pdfFileName);

// For the purpose of this example, set signature sizes and page number for signature placement
var page = 6;
var leftMargin = 40;
var topMargin = 50;
var signatureWidth = 188;
var signatureHeight = 44; 

requestor.addSignatureMapping(page, leftMargin, topMargin, signatureWidth, signatureHeight, "<signatureSysId>");

var result = requestor.processRequest();
gs.info(JSON.stringify(result));