PDF - Clear signature(s)

Declaration

<AMPDF ACTIVITY="clear" SESSION="text" SOURCE="text" PASSWORD="encrypted text" SAVETYPE="text (options)" DESTINATION="text" SIGNNAME="text" />

Related Topics   

Description

Removes all digital signatures contained in a PDF file or a specific signature according to its name.

NOTE: A signature can only be removed if the system or user has access to the private key used to generate the signature in the first place. For example, if user A signs a PDF, only user A can un-sign that PDF.

Practical usage

Used to remove invalid signatures or clear all embedded signatures in a PDF file in order to alter or re-sign the document.

Parameters

Resource

Property Type Required Default Markup Description
Resource --- --- --- --- Specifies the source of the PDF file. The available options are:
  • File (default) - The source derives from a PDF file located on the system. This option is normally selected if only a single activity is required to complete the operation.
  • Session - The source PDF is obtained from a pre-configured session created in an earlier step with the use of the PDF - Create session activity. This option is normally selected if a combination of related activities is required to complete an operation. Consolidating several activities to a single session can eliminate redundancy. Moreover, a single task supports multi-session executions which can improve efficiency and speed up production.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Session Text (options) Yes, if Resource is set to Session PDFSession1 SESSION="mySession" The existing session to associate with this activity. This parameter becomes active and is required if the Resource parameter is set to Session.
Source PDF Text Yes, if Resource is set to File (Empty) SOURCE="C:\PDFFileName.pdf" The PDF path and file name of where to remove signatures. This parameter becomes active and is required if the Resource parameter is set to File.
Password (optional) Text No (Empty) PASSWORD="encrypted" The password required to open the PDF file (if required).
On completion Text (options) Yes, if Resource is set to File Save
  • SAVETYPE="save"
  • SAVETYPE="do_not_save"
  • SAVETYPE="save_as"
 Specifies how changes to the PDF file are saved upon completion of this activity. The available options are:
  • Save (default) - Changes are saved under the PDF file's original file name.
  • Do not save changes - Any changes made to the existing PDF file are not saved.
  • Save As - Changes are saved to a new path and file name.
Destination PDF Text Yes, if On Completion is set to Save as (Empty) DESTINATION="C:\PDFFileName.pdf" The path and file name where the modified PDF file is stored. This parameter becomes active and is required if the On completion parameter is set to Save as.

Signature

Property Type Required Default Markup Description
All signature(s) --- No All --- If enabled, this option removes all signatures from the PDF file. If disabled, other parameters become available allowing for the selection of a specific signature. This parameter is enabled by default.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Specific signature name Text Yes, if selected (Empty)
  • SIGNNAME="SignatureName"
  • SIGNNAME="Sign1,Sign2"
 The names of the signatures to remove. Use a comma (,) to indicate more than one signature (for example, SignatureName1,SignatureName2,SignatureName4). The Get signature(s) activity can be used prior to this step to retrieve information regarding the individual signatures contained in a PDF file. This parameter is active only if the All signature(s) parameter is disabled.

Description

Error Causes

On Error

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task clears all signatures from a PDF file.

Copy 
<AMPDF ACTIVITY="clear" SOURCE="C:\temp\SamplePDF.pdf" />