PdfMergeSignRequestor - com escopo, global

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

Esta API faz parte do plug-in ServiceNow PDF Generator Utilities (com.snc.apppdfgenerator) e é fornecida no namespace sn_pdfgeneratorutils. 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 objeto PdfMergeSignRequestor.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

Os exemplos a seguir mostram como criar um objeto PdfMergeSignRequestor.

var v = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

PdfMergeSignRequestor - addSignatureMapping(Number pageNumber, Number leftMargin, Number topMargin, Number boxWidth, Number boxHeight, String sysId)

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

Tabela 2. Parâmetros

Nome	Tipo	Descrição
pageNumber	Número	Número da página na qual a assinatura será inserida.
leftMargin	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 representa a área de margem superior da página na qual a imagem da assinatura será inserida.
largura da caixa	Número	Valor em pontos que representa a largura da caixa que contém a assinatura.
boxHeight	Número	Valor em pontos que representa a altura da caixa que contém a imagem da assinatura.
sysId	Cadeia de caracteres	Sys_id da imagem da assinatura na tabela Anexos [sys_attachment].

Tabela 3. Retorna

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. Retorna

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 for 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>.mensagem	Valores possíveis: A solicitação não pode prosseguir porque o anexo com sys_id [{0}] não passou na verificação de segurança – o PDF não passou na verificação do antivírus. Nenhum mapeamento de assinatura especificado. Não é possível processar esta solicitação – Forneça o mapeamento de assinatura usando o método addSignatureMapping(). 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º 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. O message fornece 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));