Importing Rules via CSV
When creating a Blackout project, sometimes there are more terms than could be manually entered as word/phrase rules. With Blackout Import Templates, up to 100,000 rules can be uploaded to a Blackout project.
Image-based projects, native Excel projects, and PDF projects will use the same import template, with slight variations. The tables below will describe how the import template should be populated if using the plain CSV template along with a links to download the import template with pre-populated dropdowns and the unpopulated CSV file.
What to know
- Each file is a macro-enabled Excel. The Excel file includes dropdowns for the following sections that have a limited number of values that can be entered:
- Markup Type
- Markup Subtype
- Markup Scope
- Before the template can be used it must be saved as a CSV file.
- A CSV file without the dropdowns is also available for download.
Note: If using the macro-enabled Excel file, the Markup Subtype section will change based on the selected Markup Type.
How to use CSV Import Templates
- Download the desired import template
- Fill in the desired information within the template.
- Within Excel, click the ‘File’ button and choose ‘Save As’
- Use the file type drop down and save as a CSV file
- A message will appear alerting you that multiple sheets cannot be saved. This is normal. Click ‘OK’.
After saving the template as a CSV, it can be used with Blackout.
Image Based Template
| Column | Description | Accepted Values |
|---|---|---|
| Word/Phrase | The exact word or phrase being searched (does not support dtSearch or wildcard syntax) | Any text/phrase inputs that are valid in Blackout |
| Regular Expression Name | Sets the name of the regular expression after the job has been run to be easily selected later | Any text that can be used to identify the RegEx later |
| RegEx | Enter the Regular Expression for the rule here | |
| Markup Type | Sets the Markup Type of the rule | Redaction or Highlight |
| Markup Subtype | Sets the Markup SubType for a rule | Redaction Markup Type: Black, Text, Cross, White, Inverse Highlight Markup Type: Yellow, Green, Blue, Orange, Pink, Purple |
| Markup Text | Applies the entered text to a text based redaction | Any text that can be used to identify the redaction |
| Markup Scope | Sets the Markup Scope for a rule | Word, Line, Paragraph, Block, Page, Document |
| Markup Reason | Sets the Markup Reason for a rule | Any text that will allow you to identify the markup reason |
| dtSearch | Enter a dtSearch syntax for the rule here |
Download the image rule template with dropdowns
Download the image template CSV
Excel Based Template
| Column | Description | Accepted Values |
|---|---|---|
| Word/Phrase | The exact word or phrase being searched (does not support dtSearch or wildcard syntax) | Any text/phrase inputs that are valid in Blackout |
| Regular Expression Name | Sets the name of the regular expression after the job has been run to be easily selected later | Any text that can be used to identify the RegEx later |
| RegEx | Enter the Regular Expression for the rule here | |
| Markup Type | Sets the Markup Type of the rule | Redaction, Highlight, Inverse, or InverseHighlight |
| Markup Subtype | Sets the Markup SubType for a rule | Redaction Markup Type: Black, Text, White Highlight Markup Type: Yellow, Green, Blue, Orange, Pink, Purple |
| Markup Text | Applies the entered text to a text based redaction | Any text that can be used to identify the redaction |
| Markup Scope | Sets the Markup Scope for a rule | Cell, Word, Row, Column, Sheet |
| Markup Reason | Sets the Markup Reason for a rule | Any text that will allow you to identify the markup reason |
| dtSearch | Enter a dtSearch syntax for the rule here |
Download the Excel rule template with dropdowns
Download the Excel rule template CSV
PDF Based Template
| Column | Description | Accepted Values |
|---|---|---|
| Word/Phrase | The exact word or phrase being searched (does not support dtSearch or wildcard syntax) | Any text/phrase inputs that are valid in Blackout |
| Regular Expression Name | Sets the name of the regular expression after the job has been run to be easily selected later | Any text that can be used to identify the RegEx at a later time |
| RegEx | Enter the Regular Expression for the rule here | |
| Markup Type | Sets the Markup Type of the rule | Redaction, Highlight |
| Markup Subtype | Sets the Markup SubType for a rule | Redaction Markup Type: Black, Text, White Highlight Markup Type: Yellow, Green, Blue, Orange, Pink, Purple |
| Markup Text | Applies the entered text to a text based redaction | Any text that can be used to identify the redaction |
| Markup Scope | Sets the Markup Scope for a rule | Character, Word, Line |
| Markup Reason | Sets the Markup Reason for a rule | Any text that will allow you to identify the markup reason |
| dtSearch | Enter a dtSearch syntax for the rule here |
Download the PDF rule template with dropdowns
Download the PDF rule template CSV