Pular para o conteúdo principal

Configurações de PDF - Rest PKI Core

As configurações da seção Pdf são os padrões da instância para o tratamento de PDFs pelo Rest PKI Core: se o PDF recebe marcas de validação antes da primeira assinatura e como elas são desenhadas e, quando a conversão para PDF/A está disponível, como a conversão se comporta.

Cada organização pode substituir as configurações de marcação na página Configurações PDF do dashboard. Um campo deixado vazio (ou como Usar padrão do sistema, na política de marcação) usa o valor da instância, e a ação Redefinir configurações devolve a organização aos valores da instância. Reinicie a aplicação depois de alterar as configurações descritas aqui.

Configurações de marcação​

Na seção Pdf:

  • MarkingPolicy (v1.10.0, padrão: WhenPossible): política de marcação do PDF da instância, que decide se o PDF recebe marcas de validação antes da primeira assinatura. Os valores são Never (o PDF original é assinado, sem marcas), WhenPossible (tenta adicionar as marcas e, se o PDF enviado já tem assinaturas, assina o original sem avisar) e Always (as marcas são obrigatórias: um PDF enviado já assinado falha com PdfAlreadySigned). Vale para as organizações que não definem a Política de marcação do PDF no dashboard (opção Usar padrão do sistema). Como variável de ambiente: Pdf__MarkingPolicy.

Layout das marcas de validação​

As marcas de validação de um PDF têm três elementos:

  • uma faixa de marca d'água na margem direita, com uma imagem sobre uma cor de fundo, girada para acompanhar a borda da página;
  • o texto de acesso na margem esquerda, escrito na vertical, com o link para validar o documento, sobre uma caixa branca que o mantém legível;
  • um código QR, no canto superior esquerdo.

As configurações abaixo alteram as cores, opacidades, tamanhos e margens desses elementos. A largura da faixa da marca d'água é fixa, de 1,8 cm. Para a imagem da marca d'água, veja Imagem da marca d'água.

Na seção Pdf:

  • WatermarkBackgroundColor (v1.10.0, padrão: F5F8FD): a cor que a faixa da marca d'água mostra sobre uma página branca, como uma cor HTML: #RRGGBB ou RRGGBB. Como variável de ambiente: Pdf__WatermarkBackgroundColor.
  • WatermarkBackgroundOpacity (v1.10.0, padrão: 0.25): a opacidade do fundo da faixa da marca d'água, como uma fração de 0 (transparente) a 1. Ela decide quanto do conteúdo da página sob a faixa aparece: sobre uma página branca, aumentá-la não escurece a faixa. Como variável de ambiente: Pdf__WatermarkBackgroundOpacity. A configuração equivalente WatermarkBackgroundOpacityPercent recebe a opacidade em porcentagem, de 0 a 100: use uma ou outra, nunca as duas.
  • WhiteOverlayOpacity (v1.10.0, padrão: 0.75): a opacidade da caixa branca sob o texto de acesso, como uma fração de 0 a 1. Como variável de ambiente: Pdf__WhiteOverlayOpacity. Também tem um equivalente em porcentagem, WhiteOverlayOpacityPercent, de 0 a 100: use um ou outro, nunca os dois.
  • QRCodeSize (v1.10.0, padrão: 1.8): a largura e a altura do código QR, em centímetros. Um código QR maior também empurra o texto de acesso para baixo. Como variável de ambiente: Pdf__QRCodeSize.
  • QRCodeMargin (v1.10.0; opcional, sem padrão, a partir da v1.11.0): a distância do código QR até as bordas superior e esquerda da página, em centímetros. Quando não é definida, o código QR usa TopMargin e LeftMargin. Como variável de ambiente: Pdf__QRCodeMargin.
  • LeftMargin (v1.11.0, padrão: 0.5): a distância do texto de acesso até a borda esquerda da página, em centímetros. É também a distância do código QR quando QRCodeMargin não é definida. Como variável de ambiente: Pdf__LeftMargin.
  • TopMargin (v1.11.0, padrão: 0.5): a distância do código QR até a borda superior da página, em centímetros, quando QRCodeMargin não é definida. Como variável de ambiente: Pdf__TopMargin.
  • BottomMargin (v2.5.0, padrão: 0.5): a distância do texto de acesso até a borda inferior da página, em centímetros. Não há campo para ela no dashboard: vale sempre o valor da instância. Como variável de ambiente: Pdf__BottomMargin.

Campos do dashboard​

Na página Configurações PDF do dashboard, cada organização pode definir os seus valores. Quando a organização não tem valor para um campo, a página mostra Usar padrão do sistema: seguido do valor da instância. As opacidades aparecem em porcentagem no dashboard e como frações nas configurações da instância.

Configuração da instânciaCampo do dashboard
MarkingPolicyPolítica de marcação do PDF
WatermarkBackgroundColorCor de fundo da marca d'água
WatermarkBackgroundOpacityOpacidade do fundo da marca d'água (em porcentagem)
WhiteOverlayOpacityOpacidade da sobreposição branca (em porcentagem)
QRCodeSizeTamanho do código QR
QRCodeMarginMargem do código QR
LeftMarginMargem esquerda
TopMarginMargem superior
BottomMarginNenhum: só a configuração da instância
Imagem da marca d'águaImagem de marca d'água (PNG)

Imagem da marca d'água​

A imagem da marca d'água é escolhida nesta ordem:

  1. a imagem que a organização enviou na página Configurações PDF do dashboard;
  2. a imagem da instância, descrita abaixo;
  3. a imagem embutida na aplicação.

Para definir a imagem da instância, coloque um arquivo PNG chamado watermark.png na pasta assets do Blob Storage configurado para a instância. Por exemplo, com o tipo FileSystem, o arquivo é <Path>/assets/watermark.png, em que <Path> é o Path do Blob Storage. Não há configuração para isso. Depois de adicionar ou substituir o arquivo, reinicie a aplicação.

Use um PNG. A embutida tem 1120 x 126 pixels, com fundo transparente: uma imagem larga e baixa, já que ela é girada e desenhada ao longo da margem direita da página, na faixa da marca d'água. Use uma imagem com proporções parecidas.

Exemplo de configuração​

Para aproximar o texto de acesso e o código QR da borda esquerda da página, no arquivo de configuração:

[Pdf]
LeftMargin=0.2

Como variáveis de ambiente:

Pdf__LeftMargin=0.2

Configurações de PDF/A​

Estas configurações só valem quando a conversão para PDF/A está disponível na instância. Ficam na seção Pdf, na seção aninhada PdfA:

  • PdfA:DefaultProfile (v4.2.0, padrão: PdfA2b): o perfil PDF/A para o qual converter. Os valores são PdfA1a, PdfA1b, PdfA2a, PdfA2b, PdfA2u, PdfA3a, PdfA3b, PdfA3u, PdfA4, PdfA4e e PdfA4f. Como variável de ambiente: Pdf__PdfA__DefaultProfile.
  • PdfA:ProfileAcceptancePolicy (v4.2.0, padrão: Any): o que fazer com um PDF que já é PDF/A. Com Any, um PDF que já está em conformidade com qualquer perfil PDF/A é aceito como está. Com StrictDefault, o PDF deve estar em conformidade com o DefaultProfile: um PDF que não esteja, mesmo que esteja em conformidade com outro perfil PDF/A, é convertido para o DefaultProfile (se ele já estiver assinado, quem decide é AcceptNonPdfASignedFiles). Como variável de ambiente: Pdf__PdfA__ProfileAcceptancePolicy.
  • PdfA:AcceptNonPdfASignedFiles (v4.2.0, padrão: true): o que fazer com um PDF que já está assinado e não passa na verificação de PDF/A (com StrictDefault, não está em conformidade com o DefaultProfile), já que ele não pode ser convertido sem invalidar as assinaturas. Com true, a assinatura segue sem a conversão. Com false, o PDF é rejeitado. Como variável de ambiente: Pdf__PdfA__AcceptNonPdfASignedFiles.
Ver em Markdown