Use redaction policies

View as MarkdownMarkdown

Set up your AI agent

Give your coding agent live access to the GroupDocs documentation and API reference through the GroupDocs Docs MCP server — no install, no API key. Learn more

claude mcp add --transport http groupdocs-docs https://docs.groupdocs.com/mcp

Also process documents locally

The GroupDocs.Redaction MCP server lets your agent work with files on your machine; they are never uploaded. It needs the .NET 10 SDK or Docker.

claude mcp add groupdocs-redaction -- dnx GroupDocs.Redaction.Mcp --yes
Folders, licensing and more →

On this page

If you have a corporate sensitive data removal policy as a list of redaction rules, you don’t need to specify them in your code. You can specify an XML document with a list of pre-configured redactions.

Below is an example of redaction policy XML file (code properties mapping is obvious):

RedactionPolicy.xml

<?xml version="1.0" encoding="utf-8"?>  
<redactionPolicy xmlns="http://www.groupdocs.com/redaction">  
  <regexRedaction regularExpression="(dolor)" actionType="ReplaceString" replacement="foobar" />  
  <exactPhraseRedaction searchPhrase="dolor" caseSensitive="true" actionType="DrawBox" color="Red" />   
  
  <cellColumnRedaction regularExpression="(foo)bar1" replacement="[red1]" columnIndex="1" worksheetIndex="2" /> 
  <cellColumnRedaction regularExpression="(foo)bar2" replacement="[red2]" wokrsheetName="Sample" /> 
  
  <eraseMetadataRedaction filter="All" />  
  <metadataSearchRedaction filter="Title, Author" replacement="foobar" valueExpression="(metasearch)" keyExpression="" />  
  
  <annotationRedaction regularExpression="(anno1)" replacement="foobar" />  
  <deleteAnnotationRedaction regularExpression="(anno2)" />  
  
  <imageAreaRedaction pointX="15" pointY="17" width="200" height="10" color="#AA50FC"  />  
  <imageAreaRedaction pointX="110" pointY="120" width="60" height="20" color="Magenta"  />  
</redactionPolicy>

You can use RedactionPolicy.save() method to create XML documents of this structure, configuring redactions in runtime.

The following example demonstrates how to save a RedactionPolicy to an XML file.

const redaction = require('@groupdocs/groupdocs.redaction');
const java = require('java');
const Color = java.import('java.awt.Color');

const policy = new redaction.RedactionPolicy(java.newArray('com.groupdocs.redaction.Redaction', [
  new redaction.ExactPhraseRedaction('Redaction', new redaction.ReplacementOptions('[Product]')),
  new redaction.RegexRedaction('\\d{2}\\s*\\d{2}[^\\d]*\\d{6}', new redaction.ReplacementOptions(Color.BLUE)),
  new redaction.DeleteAnnotationRedaction(),
  new redaction.EraseMetadataRedaction(redaction.MetadataFilters.All)
]));
policy.save('MyPolicyFile.xml');

You can have as much policies, as you need, loading them to redact your documents.

The example below loads a redaction policy from an XML file and applies every rule it contains to a document in a single apply call:

const redaction = require('@groupdocs/groupdocs.redaction');

const policy = redaction.RedactionPolicy.load('redaction_policy.xml');
const redactor = new redaction.Redactor('sample.docx');
try {
  const result = redactor.apply(policy);
  if (result.getStatus() !== redaction.RedactionStatus.Failed) {
    const saveOptions = new redaction.SaveOptions();
    saveOptions.setAddSuffix(true);
    saveOptions.setRasterizeToPDF(false);
    saveOptions.setRedactedFileSuffix('redacted');
    redactor.save(saveOptions);
  }
} finally {
  redactor.close();
}

redaction_policy.xml is the policy file used in this example. Click here to download it.

sample.docx is the document redacted in this example. Click here to download it.

Binary file (DOCX, 17 KB)

Download full output

On this page