Core Platform Functions

The Core Platform Functions component provides platform-agnostic process definitions to perform file operations on platform agents.

Prerequisites

Version 9.2.9
At least one platform agent
A user with sufficient privileges to perform the file operations on the platform agent
Privileges Required to use Core Platform Functions

Object Type	Name	DEscription
Application	GLOBAL.Redwood.REDWOOD.Core_Platform_Functions	Provides definitions to run core functions on a server (1.0.0.0)
Process Definition	REDWOOD.Redwood_Core_CopyFile	Copy a file on a server
Process Definition	REDWOOD.Redwood_Core_DeleteFile	Delete a file from a server
Process Definition	REDWOOD.Redwood_Core_DirectoryListing	Perform a directory listing on a server
Process Definition	REDWOOD.Redwood_Core_MoveFile	Move or rename a file on a server
Library	REDWOOD.Redwood_Platform_Extensions	Library for core platform functions

Copy a file on a server.

Name	Description	Documentation	Direction	Default Expression	Values
`sourceDirectory`	Source Directory	The directory containing the file to copy	In
`sourceFile`	Source File Name	The name of the file to copy (wildcards `*` and `?` allowed)	In
`targetDirectory`	Target Directory	The directory to copy the file(s) to	In
`targetFile`	Target File Name	The new name to give to the file in the destination. If left blank, the original file name will be used (will be ignored when wildcards are used in the Source File Name)	In
`overwrite`	Overwrite Target File?	Overwrite the file in target location when existing	In	`N`	`Y`=Yes,`N`=No
`JCS_USER`	Run As User	The user under which the command needs to be executed	In
`RUN`	Command	This runtime parameter is set by the component for the actual command to execute	In

Delete a file from a server.

Name	Description	Documentation	Direction	Default Expression	Values
`sourceDirectory`	Source Directory	The directory containing the source file to delete	In
`searchPattern`	Search Pattern	The source file and/or directory name pattern to delete (wildcards `*` and `?` allowed)	In
`deleteDirectories`	Delete matching sub-directories?	Delete matching sub-directories and their content	In	`N`	`Y`=Yes,`N`=No
`JCS_USER`	Run As User	The user under which the command needs to be executed	In
`RUN`	Command	This runtime parameter is set by the component for the actual command to execute	In

Perform a directory listing on a server.

Name	Description	Documentation	Direction	Default Expression	Values
`sourceDirectory`	Source Directory	The directory to list the files from	In
`sourceFile`	Source File Pattern	The file pattern to match to list on (wildcards `*` and `?` allowed)	In
`hiddenFiles`	Show hidden files?	When set to `Y`, hidden files and folders will be included in the results. When set to `N`, hidden files and folders will not be included in the results.	In	`N`	`Y`=Yes,`N`=No
`JCS_USER`	Run As User	The user under which the command needs to be executed	In
RUN	Command	This runtime parameter is set by the component for the actual command to execute	In

Move or rename a file on a server.

Name	Description	Documentation	Direction	Default Expression	Values
`sourceDirectory`	Source Directory	The directory containing the file to move	In
`sourceFile`	Source File Name	The name of the file to move (wildcards `*` and `?` allowed)	In
`targetDirectory`	Target Directory	The directory to move the file(s) to	In
`targetFile`	Target File Name	The new name to give to the file in the destination. If left blank, the original file name will be used (will be ignored when wildcards are used in the Source File Name)	In
`overwrite`	Overwrite Target File?	Overwrite the file in target location if it already exists	In	`N`	`Y`=Yes,`N`=No
`JCS_USER`	Run As User	The username of the user under which the command needs to be executed	In
RUN	Command	This runtime parameter is set by the component for the actual command to execute	In

Navigate to Definitions > Processes, locate Redwood_Core_MoveFile, choose Submit from the context menu.
Fill the Source Directory, Source File Name, Target Directory, and optionally Target File Name parameters.
Choose Submit, if you can see more than one platform agent, you select the appropriate agent queue and choose Submit once more.
Navigate to Monitoring > Processes, locate the process Move or rename a file on a server, if its status is Completed, the operation was successful.