---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PdfMergeSignRequestor - com escopo, global

# PdfMergeSignRequestor - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

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](https://servicenow-prod.fluidtopics.net/RfCHRBA0t7Pz~tldc01UmA#PDFGenerationAPIBothAPI "A PDFGenerationAPI fornece suporte para conversão de PDF e manipulação de campos de PDF.").

## PdfMergeSignRequestor - PdfMergeSignRequestor() {#ariaid-title2}

Instancia um novo objeto PdfMergeSignRequestor.
{#PM-PdfMergeSignRequestor__table_twm_hjk_34b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) |   |   |
[Tabela 1. Parâmetros]

{#PM-PdfMergeSignRequestor__table_twm_hjk_34b}  
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) {#ariaid-title3}

Atribui requisitos de tamanho e posição da assinatura no PDF.
{#PM-addSignatureMapping_N_N_N_N_N_S__table_zvh_hkl_j4b__entry__3}

| 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 2. Parâmetros]

{#PM-addSignatureMapping_N_N_N_N_N_S__table_zvh_hkl_j4b} {#PM-addSignatureMapping_N_N_N_N_N_S__table_awh_hkl_j4b__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Retorna]

{#PM-addSignatureMapping_N_N_N_N_N_S__table_awh_hkl_j4b}  
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) {#ariaid-title4}

Cria uma solicitação de assinatura com entradas de origem e destino.
{#PM-createRequest_S_S_S_S__table_ulk_gkl_j4b__entry__3}

| 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 4. Parâmetros]

{#PM-createRequest_S_S_S_S__table_ulk_gkl_j4b} {#PM-createRequest_S_S_S_S__table_vlk_gkl_j4b__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Retorna]

{#PM-createRequest_S_S_S_S__table_vlk_gkl_j4b}  
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() {#ariaid-title5}

Processa solicitações e adiciona as assinaturas.
{#PM-processRequest__table_gyz_3kl_j4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 6. Parâmetros]

{#PM-processRequest__table_gyz_3kl_j4b} {#PM-processRequest__table_erx_h3k_34b__entry__2}{#PM-processRequest__row_pdfgen_ret_attID}

| 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. {#PM-processRequest__ul_yzw_bhm_l4b} <!-- --> * 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\> {#PM-processRequest__ul_tmd_twg_m4b} 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. {#PM-processRequest__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 7. Retorna]

{#PM-processRequest__table_erx_h3k_34b}  
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));