Redaction reasons allow redacted content to be replaced with a redaction reason that can be configured by the application developer.

What happens to the redaction reasons text:

• It gets burned into the document.
• It replaces the text in the burned in content.
• It is displayed in the Viewer UI.

Redaction reasons are located under the Redaction menu:

To Add & Save a Redaction Reason to a Document

1. Click on the Text Selection redaction icon:

2. Select the text you want to redact and a context menu displays:

3. Hover over the context menu and the available options display:

4. Select the Redaction Reason you want to use or select Enter a reason... to create your own custom redaction reason:

If you hover over the redaction, it is transparent. Note that the redaction reason text is displayed in the redacted area. If there are multiple lines of redacted text, the reason is displayed on each line of text.

5. To edit the Redaction Reason, click on the Redaction and the Comments menu displays:

Click the drop-down to select another Redaction Reason or edit the Custom Reason. You can also add a comment or delete the Redaction from the Comments menu.

6. When you are ready to save your redactions and annotations, click the Save icon:

7. The Save As field displays on the left-hand side of the Viewer:

8. Enter a name for the redaction and click Save.  

How to Load Redaction Reasons

Redaction reason data is automatically loaded from a file named "redactionReason.json" located at the root of each sample provided. If the redaction reason functionality is not needed, then removing this file will disable the ability to add reasons to redactions in the Viewer.  

How to Set a Default Redaction Reason

To set a default redaction reason:

1. Open the redactionReason.json file.
2. Edit the reasons property so at most one item has a property called "defaultReason" set to the value of "true". If more than one item is set as default, then an error will be displayed when the Viewer loads.

The following example shows a reason set as the default in the redactionReason.json file:

Example	Copy Code
... {"reason": "Content is removed from this section.", "defaultReason": true} ...

How to Automatically Apply Redaction Reasons

When the Viewer loads, the values from the redactionReason.json file will be read and viewer options will be appropriately set. If a"autoApplyDefaultReason" is set to true, then newly created rectangle or text selection redaction marks will automatically display the selected default reason text. If the "enableRedactionReasonSelection" is set to true then the reasons listed in the file will be made available as selectable options in the Viewer interface when creating or updating rectangle or text selection redaction marks. If the "enableRedactionReasonSelection" is set to false, then users will not be able to modify the default reason after it has been applied.

JSON Input for Setting Up Redaction Reasons

Use the following example to set up redaction reasons:

{
    "autoApplyDefaultReason": true,
    "enableRedactionReasonSelection": true,
    "enableFreeformRedactionReasons": true,
    "maxLengthFreeformRedactionReasons": 40,
    "reasons": [
        {"reason": "Content is removed from this section.", "defaultReason": true}
        ,{"reason": "Sensitive data removed from the document."}
        ,{"reason": "Confidential."}
       
    ]
}

The following table shows the name, type and description available: 

The following table shows how the options in the JSON file affect what tabs are displayed in the redaction reason context menu: