PDF - End Session

Declaration

<AMPDF ACTIVITY="end_session" SESSION="text" SAVETYPE="text (options)" DESTINATION="text" />

Description:

Ends a session previously created by a Create session activity.

Practical Usage

Sessions typically represent a combination of steps that are used to complete a specific process. Creating sessions enables you to build and organize more customized tasks. Additionally, sessions can eliminate redundant entry of identical properties that may be required by several activities. This activity ends a session in which other activities are currently linked to.

Parameters

Resource

Property

Type

Required

Default

Markup

Description

Session

Text

Yes

PDFSession1

SESSION="PDFSession"

The name of the PDF session to end. Use the Create session activity to create a new session.

On completion

Text (options)

Yes

Do not save changes

SAVETYPE="do_not_save"

Specifies what this activity should do upon its completion.  The available options are:

  • Do not save changes (default) - Any changes made to the existing PDF document will not be saved.

  • Save - Changes will be saved to the existing PDF document's default location and file name.

  • Save As - Allows changes to be saved to a new file name and/or location.

Destination PDF

Text

Yes if On Completion parameter is set to Save Changes

(Empty)

DESTINATION="C:\PDFFileName.pdf"

The new file name and/or location 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.

 

Description

Error Causes

On Error

Example

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

Description: End PDF session "myPDFSession". Save PDF As "C:\temp\myPDFFile.pdf".

 

<AMPDF ACTIVITY="end_session" SESSION="myPDFSession" SAVETYPE="save_as" DESTINATION="C:\temp\myPDFFile.pdf" />