cscfscrm (Deleting a common folder)
- Organization of this page
Format
cscfscrm [-h]
-user login-user-ID
-pass login-password
{-csc HCSC-server-name|-cluster cluster-name}
{-folder common-folder-definition-name
[-targetfilename file-name-or-folder-name|-t deletion-start-date-and-time|-d number-of-days]
|-all [-t deletion-start-date-and-time|-d number-of-days]}
[-retrycount retry-count]
[-retryinterval retry-interval-(seconds)]
[-recursive]
Function
Deletes the files in a common folder and files under subfolders. This command does not delete the common folder and the folders in the common folder. If the common folder contains a subfolder, you can recursively delete the files in the subfolder.
The retry count and the retry interval are used to obtain a lock. If you specify multiple files, the retry count and the retry interval are enabled for each file.
The processing will be cancelled after an error occurs when you delete multiple files.
By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.
For details on how to use this command, see 5.4.22 Deleting files in the common folder in the uCosminexus Service Platform Setup and Operation Guide.
Arguments
-h
Displays the usage of commands. When you specify this option, all other options are ignored even if specified.
-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the user ID that is used to log in to HCSC-Manager. The characters are case sensitive.
-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the password that is used to log in to HCSC-Manager. The characters are case sensitive.
-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the HCSC server name. The characters are case sensitive.
-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the cluster name. The characters are case sensitive.
-folder common-folder-definition-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 64 characters))
Specifies the common folder definition name. The characters are case sensitive.
-targetfilename file-name-or-folder-name ~ ((1 to 200 bytes))
Specifies the name of the file or subfolder to be deleted. If you specify a subfolder, the command deletes the files directly under the subfolder. To recursively delete the files under the subfolder, you must also specify the -recursive option. To specify a file or folder in a subfolder, specify the relative path from the common folder root.
Specify the files existing in the common folder. To reference the files in a common folder, execute the cscfscls command.
-t deletion-start-date-and-time
Deletes the files in the common folders older than the specified date and time. If the -recursive option is specified, the command also deletes the files in the subfolders older than the specified date and time. Note that you can specify the date and time in the following format. You must specify an existing date and time in 14 digits.
- YYYYMMDDhhmmss
-
YYYY: Year (1970
![[Figure]](GRAPHICS/ZUENGUX0.GIF)
YYYY)
MM: Month (01
MM 12)
DD: Date (01
DD 31)
hh: Hours (00
hh 23)
mm: Minutes (00
mm 59)
ss: Seconds (00
ss 59)
-d number-of-days ~ <Integer> ((0 to 365))
Deletes the files older than the specified number of days, in the common folder. If the -recursive option is specified, the command also deletes the files in the subfolders older than the specified number of days. Specify the number of days in days. If you specify 0, all the files in the common folder will be deleted.
-all
Deletes the files from all common folders.
-retrycount retry-count ~ <Integer> ((0 to 10000))
Specifies the retry count. The default value is 0.
If 0 is specified, the operation is not retried.
-retryinterval retry-interval-(seconds) ~ <Integer> ((0 to 86400))
Specifies the retry interval in seconds. The default value is 1.
If 0 is specified, the operation is retried without an interval.
-recursive
Recursively deletes files in the subfolders.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
The command terminated normally. |
|
1 |
The command terminated abnormally. |
|
2 |
A communication timeout occurred. |
|
3 |
An exclusion error occurred. |
|
9 |
An error occurred when checking the execution permission. |
Notes
-
Files in common folders are not automatically deleted. We recommend that you determine the retention period of files in advance and periodically delete old files.
-
Before you execute this command, make sure that the required files do not exist in the common folder.
-
Make sure that no business process is accessing the files to be deleted.
-
When executing this command during execution of a business process, you must consider the possibility that you might not be able to obtain a file lock due to conflict with other processes. Set the appropriate lock retry count and lock retry interval for this command and for each function that accesses common folders.