Delete Folder Smart Service

Overview

The Delete Folder node allows you to select a folder and then completely remove it from the system, along with its sub-folders. Only a System Administrator, Knowledge Center Administrator, or a Folder Administrator (such as the user who created the folder) can perform this task.

CAUTION: Attempting to complete this task without sufficient user rights generates an error message for the Process Administrator and pauses the process.

Properties

  • Category: Document Management

  • Icon:

  • Assignment Options: Attended/Unattended

Configuration Options

This section contains tab configuration details specific to this smart service. For more information about common configurations see the Process Node Properties page.

Data Tab

This tab displays all the Node Inputs and Node Outputs for the Service Node. You can add additional inputs and outputs, if needed. The default inputs are:

Input Type Required Multiple
Folder Folder Yes No
Delete Subfolders Number Yes No

If the node is run without being assigned to a user (or a group) you must specify values for each of the Node Inputs listed in the table above. You can either manually enter data into the text-field, or a value can be generated using the using the Expression Editor. When using the Expression Editor, you can reference and modify Process Variables, rules, constants, and other data. The expressions then specify your Node Input values.

If the node is assigned, the Node Input values are typed by your assigned user(s) into a form.

a!deleteFolder()

The Delete Folder smart service is available as an expression function that can be executed inside a saveInto parameter on an interface component or as part of a Web API.

Syntax

a!deleteFolder(folder, deleteSubfolders,onSuccess, onError)

Inputs

  • folder (Folder): The folder to delete.
  • deleteSubfolders (Boolean): If set to true, deletes all child folders of this folder. Default: false.
  • onSuccess (Any Type): A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a!save() or a!httpResponse().
  • onError (Any Type): A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a!save() or a!httpResponse().
FEEDBACK