File Handling steps

File manipulation through steps can be executed on files located on the same as well as on different disk systems. Depending on the files' location, two different ways of accessing these files are provided by the respective functions.

Copy Files

This step copies one or more files (via * or ? wildcard characters) into a second file.

Parameter	Description
Source Path or URL	The relative or absolute path, the URL or an environment variable of the existing file to be copied. The name may contain wildcard characters, that is, * and ? , but in this case the target directory must exist; all files corresponding to the source pattern is copied with their original names to this directory.
Source Access User	Check this box if you need to define a specific login to access the source share with the required access rights. The fields below then become available and you can enter your credentials.
Login with Source Share Read Access	The login name with which to access the source share that has at least read access.
Corresponding Source Password	Enter the corresponding password.
Target Path or URL	Supplies the relative or absolute path, the URL or an environment variable of the file to be created. The supplied parameter may be relative or absolute paths or URLs using the http, ftp, smb or file protocols. If a network protocol URL is used, success or failure is determined by whether the server allows the operation. For non-URL paths, if the destination path exists it is overwritten. Also, for a non-URL path, if any part of the destination path does not exist, it is created. You may also use one or more environment variables to indicate the path. The variable must be enclosed in ${} . These variables may be very useful if the configurations of your clients are heterogeneous.
Destination Access User	Check this box if you need to define a specific login to access the destination share with the required access rights. The fields below then become available and you can enter your credentials.
Login with Destination Share Write Access	The login name with which to access the target share and that has write access to it.
Corresponding Target Password	Enter the corresponding password.
Force File Copy	Allows to also copy protected files, that is, if the file to be copied already exists at the target location and is protected. If the option is activated the file is copied to the target, if the option is deactivated the file is not copied.
Allow Partial Execution	If this box is checked, the step executes successfully, even if one of the files matching the filter cannot be processed. In this case, an error is displayed in the Error Details column of the assigned device view. If none of the files matching the filter can be processed, the rule fails.nTo find which files were or were not successfully processed, you need to check the operational rules log (operationalrules.log), if you have activated the "Report Processing Errors" option.
Report Processing Errors	Defines if an entry is to be logged on the OperationalRules.log for files for which the required operation could not be executed.

Check for File

This step checks if a file is present or not.

Parameter	Description
File Name	Enter here the name and directory path of the file of which the existence is to be verified. The file must be defined as the absolute local path. If the file is located on a network drive map the network resource to a "local" letter before entering the path. You may also use one or more environment variables to indicate the path. The variable must be enclosed in ${} .

Delete Files

This step permanently deletes one or more files (via * or ? wildcard characters).

Parameter	Description
Allow Partial Execution	If this box is checked, the step executes successfully, even if one of the files matching the filter cannot be deleted. In this case, an error is displayed in the Error Details column of the assigned device view. If none of the files matching the filter can be deleted, the rule fails.nTo find which files were or were not successfully deleted, you need to check the operational rules log (operationalrules.log), if you have activated the "Report Processing Errors" option.
File Name	Defines is the relative or absolute path, the URL or an environment variable of the existing file to be deleted. The name may contain wildcard characters, that is, * and ? , in this case all files corresponding to the file pattern is permanently deleted. The supplied parameter may be a relative or absolute path or a URL using the http, ftp, smb or file protocols. If a network protocol URL is used, success or failure is determined by whether the server allows the operation. If the file does not exist no error is generated. You may also use one or more environment variables to indicate the path. The variable must be enclosed in ${} . These variables may be very useful if the configurations of your clients are heterogeneous.
Report Processing Errors	Defines if for files that cannot be deleted a entry is to be logged on the OperationalRules.log file.

Delete File Occurrences

This step deletes all occurrences of a file from a root directory downwards (via wildcard characters * or ?).

Parameter	Description
File Name	Enter into this field the file name or a file pattern using the asterisks () and question mark wildcard characters., for example, .ini* or Config?.log or log . This field is case sensitive.
Include Subdirectories	Check this box if the file occurrences are to be searched not only in the indicated directory but also its subdirectories.
Root Directory	Enter into this field the name of the root directory from which the file is to be searched and deleted.

Move Files

This step renames or moves one or more files (via * or ? wildcard characters) to a new location

Parameter	Description
Allow Partial Execution	If this box is checked, the step executes successfully, even if one of the files matching the filter cannot be processed. In this case, an error is displayed in the Error Details column of the assigned device view. If none of the files matching the filter can be processed, the rule fails.nTo find which files were or were not successfully processed, you need to check the operational rules log (operationalrules.log), if you have activated the "Report Processing Errors" option.
Report Processing Errors	Defines if an entry is to be logged on the OperationalRules.log for files for which the required operation could not be executed.
Source Path or URL	The relative or absolute path, the URL or an environment variable of the existing file to be moved. The name may contain wildcard characters, that is, * and ? , but in this case the target directory must exist; all files corresponding to the source pattern is moved with their original names to this directory.
Target Path or URL	The relative or absolute path or the URL of the file to be moved to. The supplied parameter may be a relative or absolute path or a URL using the http, ftp, smb or file protocols. If a network protocol URL is used, success or failure is determined by whether the server allows the operation. In particular a move operation may succeed in creating the destination file but fail to delete the source. You may also use one or more environment variables to indicate the path. The variable must be enclosed in ${} . These variables may be very useful if the configurations of your clients are heterogeneous. For non-URL paths, if the destination path exists it is overwritten. Also, for a non-URL path, if any part of the destination does not exist, it is created.

Check for String in File

This step checks if the given string is in the given file.

Parameter	Description
Match Case	Check this box if the string entered in the field above is case sensitive. If the search operation is not case sensitive, the result for a searched string enterprise is: enterprise, Enterprise and ENTERPRISE .
Error if Found	Check this box if an error is to be raised if the string is found.
File Name	The name and directory path of the file of which the content is to be searched.
Searched String	Enter the string which is to be found in the above listed file.