|
PDF - Get signature(s) |
Declaration
<AMPDF ACTIVITY="get_signature" SESSION="text" SOURCE="text" PASSWORD="text (encrypted)" RESULTDATASET="text" />
Description
Retrieves all signatures contained in a PDF file and then creates and populates a dataset with the results.
Practical Usage
Used to retrieve all signatures contained in a PDF file and then create and populate a dataset with the results.
Parameters
Resource
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Resource | --- | --- | --- | --- | Specifies the source of the PDF file. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Session | Text | Yes, if the Resource parameter 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 the Resource parameter is set to File | (Empty) | SOURCE="C:\temp\source.pdf" | The PDF path and file name of where to retrieve all signatures. This parameter becomes active and is required if the Resource parameter is set to File. |
Password (optional) | Text | Yes, if the Resource parameter is set to File | (Empty) | PASSWORD="encrypted" | The password required to open the existing PDF file (if required). |
Data
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Create and populate dataset | Text | Yes | (Empty) | RESULTDATASET="myDataset" | The name of the dataset to create and populate with all retrieved signatures. See PDF - Get signature(s) for more information on the fields this dataset creates. |
Additional Notes
Datasets
A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned was theDataset).
Name | Type | Return Value |
---|---|---|
theDataset.ContactInfo | Text | The contact information (for example, company name) entered for the document. |
theDataset.CoversWholeDocument | Yes/No | Indicates whether the signature covers the whole PDF file. |
theDataset.FileName | Text | The location and file name of the PDF file. |
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.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This sample task retrieves all signatures found in a PDF file and then creates and populates a dataset with that information.
<AMPDF ACTIVITY="get_signature" SOURCE="C:\temp\source.pdf" RESULTDATASET="theSignatures" />