Dashboard > Avoka Public > ... > Avoka LiveCycle ES Components > Task Attachment Utilities DSC
Task Attachment Utilities DSC Log In   View a printable version of the current page.
Added by Kendy Yus , last edited by Kendy Yus on Oct 22, 2008  (view change)
Labels: 
(None)

Please check out this following article for scenario where Task Attachment Utilities DSC can be used: 

How to retrieve attachments from an init task (start form) 

Component: com.avoka.livecycle.taskattachmentutils 8.0

TaskAttachmentUtils Service

Task Attachment Utilities: Service to provide utility operations on task attachments. Note: This DSC requires Task Manager DSC.

Operation: addAttachmentToTask

Add Attachment / Note To a Specified Task: Adds attachment / note to a specified task given its Task ID on the behalf of the user who submit the task. To add multiple attachments, please pass in a List of Document; to add multiple notes, please pass in a List of String

Input Parameter Type Description
Task ID long The task ID
Attachment java.lang.Object The attachment to be attached to the task. Type: Document for single attachment; String for single note; List of Document for multiple attachments; List of String for multiple notes.
Permissions java.lang.String Permissions to be enforced on the attachment.
Attachment or Note java.lang.String Select attachment or note

Operation: addAttachmentToInitialTask

Add Attachment To The Initial Task: Adds an attachment to the initial task of this process on the behalf of the user who submit the initial task.

Input Parameter Type Description
Attachment java.lang.Object The attachment to be attached to the task. Type: Document for single attachment; String for single note; List of Document for multiple attachments; List of String for multiple notes.
Permissions java.lang.String Permissions to be enforced on the attachment.
Attachment or Note java.lang.String Select attachment or note
Output Parameter Type Description
Task ID long Specify a process variable to store the Task ID of the initial task. Suggested Type: long

Operation: addAttachmentToMostRecentTask

Add Attachment To The Most Recent Task: Adds an attachment to the most recent task of this process on the behalf of the user who submit the most recent task.

Input Parameter Type Description
Attachment java.lang.Object The attachment to be attached to the task. Type: Document for single attachment; String for single note; List of Document for multiple attachments; List of String for multiple notes.
Permissions java.lang.String Permissions to be enforced on the attachment.
Attachment or Note java.lang.String Select attachment or note
Output Parameter Type Description
Task ID long Specify a process variable to store the Task ID of the most recent task. Suggested Type: long

Operation: retrieveAttachmentFromTask

Retrieve Attachments / Notes From a Specified Task: Retrieves task attachments / notes from a specified task given its Task ID.

Input Parameter Type Description
Task ID long The task ID
Delete Attachments boolean If you select this option, the attachments / notes will be removed from the task after retrieval. This helps to reduce space used in the database, but does permanently remove the attachments / notes from the task tracking.
Attachment or Note java.lang.String Select attachment or note
Output Parameter Type Description
Attachment List java.util.List Specify a list process variable to store the task attachments / notes. Type: List of Document for attachment, List of String for note.

Operation: retrieveAttachmentFromInitialTask

Retrieve Attachments From The Initial Task: Retrieves task attachments / notes from the initial task of this process.

Input Parameter Type Description
Delete Attachments boolean If you select this option, the attachments / notes will be removed from the task after retrieval. This helps to reduce space used in the database, but does permanently remove the attachments / notes from the task tracking.
Attachment or Note java.lang.String Select attachment or note
Output Parameter Type Description
Task ID   Specify a process variable to store the Task ID of the initial task. Suggested Type: long
Attachment List   Specify a list process variable to store the task attachments / notes. Type: List of Document for attachment, List of String for note.

Operation: retrieveAttachmentFromMostRecentTask

Retrieve Attachments From The Most Recent Task: Retrieves task attachments / notes from the most recent task of this process.

Input Parameter Type Description
Delete Attachments boolean If you select this option, the attachments / notes will be removed from the task after retrieval. This helps to reduce space used in the database, but does permanently remove the attachments / notes from the task tracking.
Attachment or Note java.lang.String Select attachment or note
Output Parameter Type Description
Task ID   Specify a process variable to store the Task ID of the most recent task. Suggested Type: long
Attachment List   Specify a list process variable to store the task attachments / notes. Type: List of Document for attachment, List of String for note.

For how to configure license information for this component service - Task Attachment Utilities, please click on the following link:
Avoka LiveCycle ES Component License Configuration

Please send us any questions or comments on this documentation regarding Task Attachment Utilities by clicking on the following link:
Feedback

Licence Configuration:

Parameter Type Description
License Key java.lang.String The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time.
License Organisation java.lang.String The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time.
Powered by Atlassian Confluence 2.7.2, the Enterprise Wiki. Bug/feature request - Atlassian news - Contact administrators