FNP8_CreateFolder

Creates a subfolder on a specified target class and object.

Syntax

bool FNP8_CreateFolder(StrParam)

Parameters

A string value or a predefined Smart Parameter variable which specifies the name of the folder to create.

The allowed predefined variables are: @BATCHID, @ID, @STATUS, @TYPE, @VALUE, @JOBID, @JOBNAME, @OPERATOR, @STATION, @TASKID, and @TASKNAME. Please refer to the smart parameter documentation for more information on these values.

Returns

False if the parameter cannot be parsed, the set up information is invalid, or the folder cannot be created. Otherwise, True.

Attention: If the action returns False, the action directs the Rulerunner task to finish with a status of Aborted.

Level

All levels.

Details

This action creates a subfolder on a specified target class and object. Like the Upload actions, this action must be preceded by SetURL, Login and SetTargetClassID actions.

Example

FNP8_SetDestinationFolder("/1040EZ/Export/")
FNP8_CreateFolder("@BATCHID")

This example creates a subfolder under the \1040EZ\Export\ folder and change the destination folder to the newly created folder. If the folder is created successfully, the action adds a variable Folder_ID to the current DCO with the folder ID returned from FileNet® Web Service.