PDF - Disable Fields

Declaration

<AMPDF ACTIVITY="disable" SOURCE="text" 
PASSWORD="text (encrypted)" SAVETYPE="text (options)" 
DESTINATION="text" FIELDNAME="text" />

Description: Disables one or more form fields in a PDF document.

Practical Usage

PDF form fields allow information to be entered interactively by the user. A PDF document may contain any number of form fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document. This activity disables interactions to be performed on selected form fields of a PDF document.

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.

Use

Text (options)

Yes if Resource parameter  is set to File

Existing PDF

  1. PDFDOCUMENTFROM="existing_file"

  2. PDFDOCUMENTFROM="new_file"

Specifies whether this activity will be performed on an existing PDF document or on a new document. This parameter is active only if the Resource parameter is set to File. The available options are:

  • Existing PDF (default) - This activity will be performed on an existing PDF document.

  • New PDF - This activity will be performed on a newly created PDF file.

Source PDF

Text

Yes if Use parameter is set to Existing PDF

(Empty)

SOURCE="C:\PDFFileName.pdf"

The path and filename of an existing PDF document to be used as the source. This parameter is active only if the Use parameter is set to Existing PDF.

Password (optional)

Text

Yes if Use parameter is set to Existing PDF

(Empty)

PASSWORD="encrypted"

The password required to open an existing PDF document (if required). This parameter is active only if the Use parameter is set to Existing PDF.

On completion

Text (options)

Yes if Use parameter is set to Existing PDF

Save

  1. SAVETYPE="save"

  2. SAVETYPE="do_not_save"

  3. SAVETYPE="save_as"

Specifies what action should be performed on the existing PDF file upon completion of this activity. This parameter is active only if the Use parameter is set to Existing PDF. The available options are:

  • Save (default) - Changes will be saved under the PDF document's original file name.

  • Do not save changes - Any changes this activity made to the existing PDF document will not be saved.

  • Save As - Changes will be saved to a new path and filename.

Destination PDF

Text

Yes if On Completion parameter is set to Save as

(Empty)

DESTINATION="C:\PDFFileName.pdf"

The new path and/or filename in which to save a copy of the original PDF file. This parameter is active only if the On completion parameter is set to Save as.

New PDF

Text

Yes if Use parameter is set to New PDF

(Empty)

NEWPDF="C:\PDFFileName.pdf"

The path and file name in which to output the newly generated PDF document. This parameter is active only if the Use parameter is set to New PDF.

Data Parameters

Property

Type

Required

Default

Markup

Description

All fields

---

---

---

---

If this parameter is enabled, denotes that all form fields that exist in the PDF document will be disabled. This is a design time parameter and therefore contains no properties or markup. This parameter is enabled by default.

Specific field name(s)

Text

No

(Empty)

FIELDNAME="Field1"

The name of the form field(s) to disable. Use a comma(,) to specify more than one field (e.g., Field1,Field2,Field5). This parameter is active only if the All fields parameter is disabled.

NOTE: Use the Get field(s) activity to retrieve information about one or more form fields contained in a PDF document.

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.)

Example

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

Description: Disable AcroForm field "Field1,Field2,Field3". Existing PDF "C:\temp\sourcePDF.pdf". Save PDF As "C:\temp\NewPDF.pdf".

<AMPDF ACTIVITY="disable" SOURCE="C:\temp\sourcePDF.pdf" 
PASSWORD="AM2SsRQOTDCtfM=aME" SAVETYPE="save_as" 
DESTINATION="C:\temp\NewPDF.pdf" FIELDNAME="Field1,Field2,Field3" />