Skip to main content
Skip table of contents

Whole file masking

You can now configure the masking engine to mask the complete file and pass the content of that file as a single input to an algorithm.

Pre-requisite

  • You must create a fixed-width file connector. For more information on creating connectors, see Managing connectors.

  • You must create a fixed-width file format that has only one field defined in it. For more information on creating file formats, see Managing file formats.

Masking a whole file

Here are the steps to process the entire file's content using a single algorithm. This functionality is limited to fixed-width ruleset types only.

  1. Navigate to Environments > Rule Sets.

  2. Click the Actions (…) drop-down to the right of a rule set on the rule set screen, and then select the Edit option.

  3. In the rule set wizard's second step "Data Files", you can select one or more files or regular expression patterns either by clicking on the checkboxes or by clicking anywhere on the rows.

  4. Click on the “Edit Selected” button, located on top of the grid.

  5. The Edit File Properties dialog appears.

    image-20240213-221417.png
  6. From the Select File Format drop-down, select a file format that has only one field defined in it. Selecting any other file format will result in an error.

  7. Select the Mask whole file checkbox to enable whole file masking.
    Selecting this option will make the "End of Record Field" disappear. This configuration is no longer necessary because the masking engine will now read the entire file and send it to the algorithm.

    Note:
    Masking the whole file is applicable only for:

    • Files that are less than 200 MB in size. However, you can modify this limit via API by configuring Whole File Masking Max File Size In MB key in the Application Settings.

    • The file format that has only one field defined in it. The masking whole file is applicable only for: Files that are less than 200 MB in size. However, you can modify this limit via API by configuring Whole File Masking Max File Size In MB key in the Application Settings. File format that has only one field defined in it.

  8. Click on Save.

  9. Go to Environments > Rule Set and click on the hyperlink of the ruleset name associated with the above ruleset. Alternatively, you can navigate to Settings > Data Format and click on the hyperlink of the name of the single-field file format created above. This will bring up an inventory-like screen listing an entry for the single-file field.

  10. The Add Record Types, Add Fields, and Delete options will not be available for file formats marked with whole file masking.

  11. Click the Actions (…) drop-down to the right of the field, and then select the Edit option.

    image-20240403-070241.png
  12. From the Algorithm drop-down list, select the matching extended algorithms that must be applied to the file.

    image-20240213-220428.png

You are not allowed to adjust the length or position of the field defined in a file format if the file format is assigned to any data file in fixed-width ruleset having "Mask whole file" option enabled.

  1. Click Save.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.