Redact Reports

Redact Reports allow you to create a custom report that contains markup and/or document field information for all of the documents in a saved search. A Markup Report contains a row for each markup applied to documents in the selected saved search. A Document Report contains a single row for each document in the saved search so you can efficiently view document field information. Once a report has been generated, it is downloaded to your workstation as a .csv file.

Available report fields

Redact can report on any field that is currently associated with the document object, Redact specific fields, and fields from the Viewer redaction table. This flexibility allows the creation of many different types of reports.

Note: Avoid using long text fields for Redact reports because they may result in a malfunctioning .csv file.

After choosing the fields for the report, they can re-ordered. The first field selected will be the left-most column in the report, while the bottom will be the right-most column.

Create and download a Markup or Document Report

To download a Markup or Document Report to your workstation, do the following:

  1. Navigate to the Redact Reports tab.

  2. Click the Markup Report button to create a report that contains a row for each markup in the included documents or click Document Report button to create a report that contains a single row of information for each included document.

  3. From the Saved search drop-down menu, select a saved search that contains the documents you wish to generate a report about. Optionally, you can enter a term or terms into search box at the top of the menu to help narrow results and find the desired saved search.

  4. Select the desired fields you wish to be included in the report in the Available Report Fields section and click on the right arrow icon to add them to the Fields Included in Report section.

    Note: Regardless of which report you select, markup and document fields are available to be added to the report. The selected fields may display differently depending on which report you select.

  5. Once all of the desired fields have been added to the Fields Included in Report section, click Generate & Download Report.
    The Markup or Document Report is downloaded to your workstation. A Markup Report will have the following naming convention: RedactionLog_<WorkspaceArtifactID>_<YYYY-MM-DD> and a Document Report will have the following naming convention: DocumentLog_<WorkspaceArtifactID>_<YYYY-MM-DD>.

Redact specific fields

The following fields in the table below are populated by Redact and/or the Viewer Redaction table. In some cases, the data may be collected from both Redact and the Viewer Redaction table simultaneously such as Markup Scope which can be provided by Redact for spreadsheet redactions, but the Viewer redaction table for image redactions.

Field Description Additional Results
Markup Approved Displays TRUE if the markup has been approved in the Redact Navigator card.  
Markup Location Displays the cell name where the markup is located in a spreadsheet document.  
Markup Type The type of redaction placed. Redaction or highlight
Markup Scope The markup scope selected when placing the markup. This value is provided for both Redact and Viewer created markups.

  • Images: Word / Line / Paragraph / Page / Document /

  • Native Spreadsheet: Cell / Sheet / Row / Column
Markup SubType The markup subtype selected when placing the markup. This value is provided for both Redact and Viewer created markups.

  • Redaction: Black / Text / White / Cross / Inverse

  • Highlights: Yellow / Green / Blue / Orange / Pink / Purple
Markup Text The text entered when placing a redaction. This value is provided for both Redact and Viewer created text redactions.  
Markup Set The markup set that a redaction is associated with. This value is provided for both Redact and Viewer created redactions.  
Markup Reason The reason that was specified when creating the Redact rule groups. This field is exclusive to Redact.  
Markup Page Number The page number where the markup is placed.  
Markup Cell The cell location where a native spreadsheet markup is placed.  
Markup Sheet The spreadsheet file that was redacted during an automated spreadsheet job.  
Markup Automated Displays if the markup was created by a Redact automated project or not. This field can display both True and False when generating the privilege log report type.  
Markup Created By Displays the user who created the markup. If the markup was the result of a Redact project, it will display the user who executed the job.  
Markup Timestamp Displays the date and time when a markup was applied.  
Original Text Displays the text that is obscured by each markup. If the text is longer than the character limit, an abbreviated version of the word(s) will display in the report.  
Project Name Displays the name of the Redact project that applied each markup.  
Rule Name Displays the name of the rule that resulted in the match and caused a markup to be applied by the Redact project.