Installing and running the Robotic Automation Log File Cleaner utility
If you are instructed to send log files to Robotic Automation Support and those files contain personal information, use the Log File Cleaner utility to remove personal data elements, such as Social Security and credit card numbers from those log files.
You can use this utility to clean log files that are created by Pega® Robotic Automation Runtime, Robotic Automation Studio, Supertrace, the Robotic Automation Dump utility (OSDump), and WinDbg Process dumps. The Log File Cleaner utility examines each line in the log file and either masks or removes the data elements that you specify, such as Social Security or credit card numbers. You can select to mask or remove only the data elements from a line or you can select to mask or remove the entire line.
Follow these steps to install and run the utility:
- Click the following link and download the Log File Cleaner utility.
Log File Cleaner
- Unzip the file into a folder location of your choice.
- In the folder where you unzipped the Log File Cleaner utility, open a command prompt.
- Start the Log File Cleaner utility by entering OpenSpanLogFileCleaner.exe at the command prompt.
- Select the log file that you want to clean.
- Select whether you want to mask (replace) individual data elements or remove all of the data on any line that contains a personal data element.
- Select the data element types that you want to remove.
- If you elect to mask data elements, specify the replacement characters to use in the associated text fields. For example, if you enter-- SSN -- as the replacement characters for a Social Security number, a Social Security number such as 901-45-6789 is changed to-- SSN --. If you leave the field blank, the Social Security number is removed entirely.
- For credit card numbers, the utility detects all numeric strings that have lengths from 11 to 16 digits. The string can include any number of dashes. If the utility finds this pattern, it removes or masks these numbers with the replacement characters you specify.
- For US taxpayers IDs (SSNs, EINs, ITINs), the utility looks for nine-digit strings in the following formats: XXX-XX-XXXX, XXXXX-XXXX, XXXXXXXXX, XXX-XXXXXX, or XX-XXXXXXX.
- You can also use Regex to define strings to search for when the utility locates data elements.
- Optional: Select to mask HTML source code. This change affects the HTML tags and data within the tags.
- Optional: To delete the original log file after the utility creates the cleaned file, select the Delete the original log file after cleaning option.
- Specify the folder location and name for the cleaned file. The utility appends the extension .cln to the end of the file name.
- Click after you have made your selections.
If the Log File Cleaner utility fails to remove the specified data elements from your log file, contact Product Support
Published December 6, 2016 — Updated July 6, 2018