PDF - End session

Declaration

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

Related Topics

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 where other activities are currently linked.

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"
  • SAVETYPE="save_as"
 Specifies how changes to the PDF file are saved upon completion of this activity. The available options are:
  • Save (default) - Changes are saved under the PDF file's original file name.
  • Do not save changes - Any changes made to the existing PDF file are not saved.
  • Save As - Changes are saved to a new path and file name.
File Text Yes if On completion parameter is set to Save as (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 becomes active and is required 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.
  • 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 ends a PDF session and then saves it using a different file name.

Copy 
<AMPDF ACTIVITY="end_session" SESSION="myPDFSession" SAVETYPE="save_as" DESTINATION="C:\Temp\MyPDFFile.pdf" />