Extract Files from Archive

Archive Source

• Location: Specifies the file system or location in which the source folder exists. File systems or locations can include a path that is relative to the folder that contains the process file, 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 contains the files that you want to extract. 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 Relative to Process File or 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.

• 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.

• 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 extracted from the archive.

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

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

Destination

• Location: Specifies the location of the folder that you want to extract the files to. File systems or locations can include a path that is relative to the folder that contains the process file, 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 that you want to extract 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 Relative to Process File or 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.

• Replace file if it already exists: Specifies that if a file that has the same name already exists in the folder, the new content is saved to a file that replaces the existing file.

• Make file name unique by appending serial number: Specifies that if a file that has the same name already exists in the folder, the new content is saved to a file that is made unique by appending a serial number to the file name.

• Make file name unique by appending time stamp: Specifies that if a file that has the same name already exists in the folder, the new content is saved to a file that is made unique by appending a timestamp to the file name.

• Fail if destination file exists: Specifies that if a file that has the same name already exists in the folder, the new content is not saved.

Encryption

• The archive has a password: Specifies that the archive is password-protected.

• Password: Opens the Enter password dialog, where you can specify the password that the action uses to open the archive.

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 to run the action.

  • Always: Specifies that the action runs each time the process file is run.

  • Never: Specifies that the action does not run when the process file is run.

  • 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 Variable or 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 enables you 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.

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

    • :  Click to delete 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 Variable or 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.

User Account

• Inherit from parent action: Specifies that the action inherits the user account credentials that are specified on the Actions property tab. Alternatively, if the action is part of a Group action, it inherits the user account credentials that are specified on the immediate parent Group action’s property tab.

• Specify user credentials: Specifies that the action runs by using the credentials that are specified.

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 Actions Execution tab, no further actions within the process are run.

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

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

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

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