This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
bw2:file_operations_tool [2020/12/15 12:28] akoehler created |
bw2:file_operations_tool [2024/09/24 15:47] (current) dlee |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Introduction (File Operations) ====== | ||
| - | |||
| - | This page describes the use of the “File Operations” tool in Bizweaver. Information regarding the associated File Reader and File Writer tools is found in separate documents. | ||
| - | |||
| ====== File Operations Tool ====== | ====== File Operations Tool ====== | ||
| - | The **File Operations** tool (WF_FileOperations) | + | The **File Operations** tool provides |
| - | The standard Windows operations are Copy, Move, and Delete. The Bizweaver function is named Get. | + | The standard Windows operations are Get, Copy, Move, and Delete. |
| ===== Copy and Move ===== | ===== Copy and Move ===== | ||
| Line 13: | Line 9: | ||
| The Copy and Move operations function in the same way and are configured in the same manner. | The Copy and Move operations function in the same way and are configured in the same manner. | ||
| - | {{ :bw:foimage1.png? | + | {{ :bw2:bizweaverfileoperationstool1.png |}} |
| - Select the desired operation (Copy or Move) from the “Operation” drop-down list. | - Select the desired operation (Copy or Move) from the “Operation” drop-down list. | ||
| - Enter or select a **Source Path** (folder where the files are located). | - Enter or select a **Source Path** (folder where the files are located). | ||
| - | - The source path can be anywhere on the local network | + | - The source path can be anywhere on the local network, make sure the user executing the workflow must have the appropriate access. |
| - Enter a **File Name**. | - Enter a **File Name**. | ||
| - Standard Windows wildcard operators can be used to identify multiple files. | - Standard Windows wildcard operators can be used to identify multiple files. | ||
| - | - Enter or select a **Target (destination) Path** (folder where the files will be copied/ | + | - Enter or select a **Target (destination) Path** (the folder where the files will be copied/ |
| - | - The target path can be anywhere on the local network but the user executing the workflow must have appropriate access. | + | - The target path can be anywhere on the local network, but the user executing the workflow must have the appropriate access. |
| - Enter a **file name**. | - Enter a **file name**. | ||
| - Standard Windows wildcard operators can be used to identify multiple files. | - Standard Windows wildcard operators can be used to identify multiple files. | ||
| - When multiple files are referenced in the Source, the names will be the same in the target folder if the wildcard designation *.* is used. | - When multiple files are referenced in the Source, the names will be the same in the target folder if the wildcard designation *.* is used. | ||
| - Indicate if you wish to **Overwrite an existing file** by selecting the checkbox. | - Indicate if you wish to **Overwrite an existing file** by selecting the checkbox. | ||
| - | - When duplicate files are found in the destination folder and you do not want to overwrite the existing ones, you can use the format described in the text just above the “Overwrite existing file option.” | + | - When duplicate files are found in the destination folder, and you do not want to overwrite the existing ones, you can use the format described in the text just above the “Overwrite existing file option.” |
| - Do not use a wildcard (*) for the file extension when using the rename options. | - Do not use a wildcard (*) for the file extension when using the rename options. | ||
| ===== Renaming Files ===== | ===== Renaming Files ===== | ||
| - | Use either the Copy or Move operations to rename a file. Make the target file name the new name and this will effectively rename the file. | + | Use either the Copy or Move operations to rename a file. Make the target file name the new name, and this will effectively rename the file. |
| + | |||
| + | When using the Bizweaver functions to rename a file, you must use the file's extension in the name e.x. If a file had the name of File.pdf using $N#.pdf in the file name, it would rename it as File1.pdf, but the file's extension needs to be used, or the renaming won't take effect. Below is a description of the fuctions. | ||
| + | |||
| + | **$N -** Old file name without extension. | ||
| + | **# -** Assigns next available number if file exists with the same name. | ||
| + | |||
| + | Example: source file name = myfile.xml and target specified as $N_####.xml then the target will be renamed as myfile_0001.xml adding a new number for each subsequent | ||
| ===== Delete ===== | ===== Delete ===== | ||
| - | {{ :bw:foimage2.png? | + | {{ :bw2:bizweaverfileoperationstool2.png |}} |
| - Select the **Delete** operation from the drop-down list. | - Select the **Delete** operation from the drop-down list. | ||
| Line 47: | Line 50: | ||
| File Handler also has a special function called **Get Files**. This operation is used to define multiple files (using * as wildcard) to be processed through subsequent workflow steps. The function can also reference a specific file. | File Handler also has a special function called **Get Files**. This operation is used to define multiple files (using * as wildcard) to be processed through subsequent workflow steps. The function can also reference a specific file. | ||
| - | The Get Files operation is most often used in conjunction with the Bizweaver “looping” function. In this process, the Get Files step creates a list of files, which is the input to the looping process. Whatever actions are needed are defined between the Loop and LoopEnd steps. These actions are performed for each file in the Get Files list. See the **// | + | The Get Files operation is most often used in conjunction with the Bizweaver “looping” function. In this process, the Get Files step creates a list of files, which is the input to the looping process. Whatever actions are needed are defined between the Loop and LoopEnd steps. These actions are performed for each file in the Get Files list. See the **// |
| - | {{ :bw:foimage3.png? | + | {{ :bw2:bizweaverfileoperationstool3.png |}} |
| - Select the **Get Files** operation from the drop-down list. | - Select the **Get Files** operation from the drop-down list. | ||
| - Enter or select a **Source Path** (folder where the files are located). | - Enter or select a **Source Path** (folder where the files are located). | ||
| - | - Enter a file **Name** to be processed | + | - Enter a file **Name** to be processed |
| - Standard Windows wildcard operators can be used to identify multiple files. | - Standard Windows wildcard operators can be used to identify multiple files. | ||
| - In the example above, all files with the “.txt” extension will be processed. | - In the example above, all files with the “.txt” extension will be processed. | ||
| Line 59: | Line 62: | ||
| ====== File Operations Variables ====== | ====== File Operations Variables ====== | ||
| - | There are several variables from the File Operations function that can be used in other workflow steps. In the following examples the file being addressed is named “FileName.txt” and it is found in the folder “C: | + | There are several variables from the File Operations function that can be used in other workflow steps. In the following examples, the file being addressed is named “FileName.txt” and it is found in the folder “C: |
| ^**Variable Name** | ^**Variable Name** | ||
| Line 73: | Line 76: | ||
| | | | | | | | | | | ||
| + | |||
| + | ---- | ||
| + | **[[bizweaver: | ||