PDF - Get Signatures

Declaration

<AMPDF ACTIVITY="get_signature" SOURCE="text" 
PASSWORD="text (encrypted)" RESULTDATASET="text" />

Description: Retrieves all signatures contained in a PDF document and populates a dataset with results.

Resource Parameters

Property

Type

Required

Default

Markup

Description

Resource

---

---

---

---

Indicates where the source PDF should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:

  • File (default) - Specifies that the source PDF derives from a file located on the system. This option is normally chosen if only a single activity is required to complete an operation.

  • Session - Specifies that 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 options is normally chosen if a combination of activities within the same action group are required. Linking several activities to a single session eliminates redundancy and improves efficiency. Several sessions can exist in a single task. In addition, multiple sessions can run simultaneously without interference.

Session

Text

Yes if Resource parameter is set to Session

PDFSession1

SESSION="mySession"

The name of an existing session to associate this activity with. This parameter is active only if the Resource parameter is set to Session.

Source PDF

Text

Yes if Resource parameter is set to File

(Empty)

SOURCE="C:\temp\source.pdf"

The path and file name of an existing PDF document in which to extract contents from. This parameter is active only if the Use previously created session parameter is disabled.

Password (optional)

Text

Yes if Resource parameter is set to File

(Empty)

PASSWORD="encrypted"

The password required to open the existing PDF document (if required).

Data Parameters

Property

Type

Required

Default

Markup

Description

Create and populate dataset

Text

Yes

(Empty)

RESULTDATASET="docInfo"

The name of the dataset to create and populate with information about all signatures that exist in the PDF document. For more details, see Datasets below.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset with the following fields (rows):

Name

Type

Return Value

theDataset.ContactInfo

Text

The contact information (e.g., company name) entered for the document.

theDataset.CoversWholeDocument

Yes/No

Indicates whether the signature covers the whole PDF document.

theDataset.FileName

Text

The location and file name of the PDF document.

theDataset.Revision

Number

The revision number. In Acrobat 9 or higher, the Signature panel provides a revision history of the document. Each signature starts a new revision of the signed document.

theDataset.SignatureDateTime

Date

The original date and time the signature was created.

theDataset.SignatureName

Text

The name of the signature.

theDataset.SignerName

Text

The name of the signer.

theDataset.Verify

Yes/No

Indicates whether the signature can be verified.

theDataset.SignatureReason

Text

The reason the signature was created.

theDataset.SignatureLocation

Number

The document page where the signature is located.

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Get all signatures information and store into dataset "theSignatures". Existing PDF "C:\temp\source.pdf".

<AMPDF ACTIVITY="get_signature" 
SOURCE="C:\temp\source.pdf" RESULTDATASET="theSignatures" />