PDF - List attachment(s)
Declaration
<AMPDF ACTIVITY="get_attachment_info" SESSION="text" SOURCE="text" PASSWORD="text (encrypted)" RESULTDATASET="text" />
Description
Retrieves information related to all file attachments and file annotations contained in a PDF file and then creates and populates a dataset with results.
Practical usage
Used to put information related to any file attachments and file annotations contained in a PDF file into a manageable list in order to perform actions/activities on each item.
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 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 retrieve file attachment- and file annotation-related information. 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). |
Attachment
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 the retrieved file attachment- and file annotation-related information. See Datasets 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.File | Text | The file name of the attachment. |
theDataset.Description | Text | The description of the attachment. |
Examples
- 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 retrieves all attachments found in a PDF file and then creates and populates a dataset with that information.
<AMPDF ACTIVITY="get_attachment_info" SOURCE="C:\Temp\SamplePDF.pdf" RESULTDATASET="theDataset" />