Add Files to Archive

Source

• Location: Specifies the file system or location for the source folder that contains the files that you want to add to the archive. File systems or locations can include a temporary storage folder, local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, refer to the Administration Console Cloud Storage Page.

• Folder: Specifies the folder location where you want the action to look for the files. You can enter the folder location or click Browse to locate and select the folder that you want (the Browse option is not available when Location is set to Temporary Storage). Alternatively, you can add a variable or add a special character to the value that you enter.

• Last Published Revision: Specifies that the action uses the last published revision of the specified Librarian file. This option takes effect only when the Librarian file is assigned to a workflow. Available when Location is set to Librarian.

• Include child folders: Specifies that the action looks in subfolders for the specified files.

• File Pattern: Specifies the filter that the action uses to identify the files on which you want the action to be run. This filter can include wildcard characters (such as ? and *) or regular expressions (such as (?i)^.*\.csv$). Click to view a list of supported regular expression or wildcard modifiers, and then click a modifier to add it. You can also add a variable that specifies the file pattern or add a special character to the value that you enter.

  • Use Regular Expression: Specifies that the action uses regular expressions to identify the file pattern. When you select this option, you can add regular expression modifiers to the previous property for more control over the search criteria.

• Minimum File Size: Specifies the minimum file size that the file must be for it to be added to the archive.

• Maximum File Size: Specifies the file size that the file cannot exceed for it to be added to the archive.

• Include Files Older Than: Specifies that files that are older than the specified amount of time are added to the archive.

Archive Destination

• Location: Specifies the file system or location of the archive that you want to add the files to. File systems or locations can include a temporary storage folder, local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, refer to the Administration Console Cloud Storage Page.

• File Name: Specifies the archive file that you want to add the files to. You can enter the folder location and file name or click Browse to locate and then select the file that you want (the Browse option is not available when Location is set to Temporary Storage). Alternatively, you can add a variable to specify the file that you want or add a special character to the value that you enter.

Archive Options

• Archive Format: Specifies the file format for the archive.

• Update Mode: Specifies which action to take when the archive is updated. The settings are as follows:

  • Add and replace files: Adds all specified files to the archive and replaces files that already exist in the archive with the new files.

  • Update and add files: Updates existing files in the archive with their newer versions and adds new files to the archive.

  • Freshen existing files: Updates existing files in the archive with their newer versions when these existing files are older than the selected source location files.

  • Synchronize files: Replaces the specified files only if the added files are newer, adds files that are not already in the archive, and deletes from the archive those files that no longer exist in the source location.

• Compression Level: Specifies the amount of compression to apply to the archive. The available options are as follows:

• Normal: Specifies compression that has balanced settings.

• Store: Specifies no compression.

• Fastest: Specifies the fastest available compression.

• Fast: Specifies fast compression.

• Maximum: Specifies compression that is higher than the Normal setting but can be slower and use more memory.

• Ultra: Specifies compression that is higher than the Maximum setting but can be slower and use more memory.

Encryption

• Encrypt archive: Specifies that the archive is encrypted and password-protected.

• Password: Opens the Enter password dialog, where you can specify the password that you want for the archive.

• Encryption Method: Specifies the encryption method that you want to use.

Action

• Name: Specifies the name of the action. You can replace the default name by entering a new name in the field.

• Description: Specifies a description for the action.

• Run Action: Specifies how often you want the action to run.

  • Always: Specifies that the action runs each time the event occurs.

  • Never: Specifies that the action does not run when the event occurs.

  • Conditionally, based on variable: Specifies that the action runs only when a selected variable meets a specified condition. Use this option in situations in which there is only one condition that determines whether the action runs. After you select this option, you can create the conditional statement in the input box.

    Input box controls

    • Variable: Specifies the variable that you want to use for the conditional statement. Enter the variable in the input box. Click to see a list of recently used variables or click More Variables to open the Insert Variable dialog.

    • [Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to display a list of additional operators, and then click the one that you want to use. For more information, refer to Relational Operators. The operators that are available in the list depend on whether you selected Text or Decimal for the Type option.

    • Value: Specifies the values to use for the conditional statement. To add a value, click , click <enter a value>, enter the value that you want, and then press Enter. To delete a value, use the secondary mouse button to click it, and then click Delete. Some operators, such as Is blank and Is not blank, do not require a value to be specified. In these situations, the Value field is not available.

    • Type: Specifies whether the conditional statement is evaluating a text or decimal value.

  • Conditionally, based on expression: Specifies the conditions under which the action runs. Use this option for situations that require more than one conditional statement. When you select this option, you can create the conditional expression in the input box by creating the conditional statements that you want. You create and edit your conditional expression on the Tree View tab. Click the Text View tab to see a read-only text view of the conditional expression.

    Input box controls (Tree View tab)

    • [Conditional Joiner]: Specifies the conditional joiner for the conditional statements within the group. The default conditional joiner is And.

      Click the existing conditional joiner to display a menu that you can use to configure your conditional expression in one of the following ways:

      • And, Or, NotAnd, NotOr: Click the conditional joiner in the list that you want to use for the conditional statements. For more information about the supported conditional joiners, refer to Conditional Joiners.

      • Add Condition: Click to add another conditional statement to the current group.

      • Add Group: Click to add a subgroup of conditional statements to the current group.

      • Remove Group: Click to delete the subgroup. Available when you open the menu from a subgroup.

      • Clear All: Click to delete all conditional statements (including subgroups). Available when you open the menu from the top-most group.

    • : Adds a conditional statement to the group that is associated with that joiner. Visible to the right of each conditional joiner in your expression.

    • :  Deletes the conditional statement. Visible to the right of an existing conditional statement when you point to the statement.

    • Variable: Specifies the variable that you want to use for the conditional statement. Enter the variable in the input box. Click to see a list of recently used variables or click More Variables to open the Insert Variable dialog.

    • [Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to display a list of additional operators, and then click the one that you want to use. For more information, refer to Relational Operators. The operators that are available in the list depend on whether you selected Text or Decimal for the Type option.

    • Value: Specifies the values to use for the conditional statement. To add a value, click , click <enter a value>, enter the value that you want, and then press Enter. To delete a value, use the secondary mouse button to click it, and then click Delete. Some operators, such as Is blank and Is not blank, do not require a value to be specified. In these situations, the Value field is not available.

    • Type: Specifies whether the conditional statement is evaluating a text or decimal value.

Error Handling and Diagnostics

• Ignore errors and continue running actions: Specifies that if the action fails, the remaining actions continue to run. When this option is not selected and the action fails, the resulting behavior depends on several factors, as follows:

  The action is within a Group action

  • If you specified Sequentially for the Execute Actions property on the Group action's Execution tab, no further actions within that Group action are run. No actions outside of this Group action are affected.

  • If you specified In Parallel for the Execute Actions property on the Group action's Execution tab, the errors are ignored, and the other actions within that Group action are run. No actions outside of this Group action are affected.

  The action is not within a Group action

  • If you specified Sequentially for the Execute Actions property on the event's Execution tab, no further actions within the event are run.

  • If you specified In Parallel for the Execute Actions property on the event's Execution tab, the errors are ignored, and the other actions within the event are run.

• Retry if failed: Specifies that if the action fails, BarTender tries to run it again.

  • Maximum retries: Specifies the maximum number of times that BarTender tries to run the action again. Available when the Retry if failed option is selected.

  • Retry interval: Specifies the length of time that BarTender waits after the action fails before it tries to run the action again. Available when the Retry if failed option is selected.