Metadata Tools

Metadata Tools includes the following scripts:

Add Pages to Empty Documents

Use this to add page stubs based on a page count field for documents without pages.

Setup

  • Page Number Field ("Sets the field containing the number of pages to add to the document.")

Assign Family from Field

Use this script to assign and populate family links based on a ParentID or GroupID field.

Setup

  • Document Link Field ("Select the field to use as the document identifier; this should match values in " + "the Family Link field.")
  • Family Link Field ("Select the a field containing a ParentID or GroupID data value; this should match " + "values in the Document Link field.")

Calculate Field Size

Calculates the length or data size of a text or memo field.

Setup

  • Source Field ("The field to calculate the length or size of data from.")
  • Source Encoding ("The encoding to use when calculating the data size." Default is UTF-8)
  • Size Calc Mode ("Whether to calculate the length of the data or the size in bytes.")

Output

  • Output Field The destination field the length or size result will go to."

Check Field Lengths

Creates a report containing the max length of all imported fields.

Field Lengths

  • Native File Created
  • Native File Modified

Clear Document Family

Use this script to clear and forget the internal family links from documents.

Clear Resource Links

Use this script to clear resource links (native, text, and/or pages) assigned to documents.

Setup

  • Clear Native Links ("Removes the assigned native link from the documents.")
  • Clear Text Links ("Removes the assigned text link from the documents.")
  • Clear Page Links ("Removes the assigned page links from the documents.")

Combine Fields

Use this script to clear resource links (native, text, and/or pages) assigned to documents.

Setup

  • Combine Field
  • Source Field
  • Delimiter
  • Selected Combine Method

Convert File Sizes

Converts a file size data field to the specified file size output format.

Source

  • Source Size Field ("The field containing file sizes to parse.")
  • Source Size Format ("The current format of the file sizes. When using Smart mode, data should have a size suffix (e.g. KB, MB, GB).")

Output

  • Output Size Format ("The format the size data will be converted to. When using Smart mode, data will receive a size suffix (e.g. B, KB, MB, GB).")
  • Output Symbol Suffix ("Whether the outputted size contain a suffix (e.g. B, KB, MB, GB) for all modes besides 'Smart'.")
  • Output Number Format("A number format string to adjust commas, decimals and leading zeros.")
  • Output Size Field ("The new or existing field to output the formatted size data into.")

Create Field

Create Field and populate with given values.

Setup

  • Output Field
  • Output Field Value

Expand Bates Ranges

Use this script to report on all the bates numbers in a bate range.

Setup

  • Beg Doc Field
  • End Doc Field

Field Statistics

Calculates the percent each custom field is populated with data.

Misc

  • Aggregate Type

File Name to Mime Type

Outputs a mime type based on field data from a file name or file extension.

Setup

  • Mime Type Output
  • File Name Field

Fill Field Values

Fills filed value from the previous document if the document field is empty.

Fields

  • Fill Fields ("Sets fields with values to be filled.")

Find Duplicate Documents

Finds duplicate documents based on values using a specified field, such as a MD5 hash field.

Setup

  • Duplicate Data Field ("Sets the field to find and report on duplicate values, such as a hash value field.")
  • Is Duplicate Field ("Sets the output field for finding duplicate documents. Duplicates are populated with a 'Y' value.")
  • Duplicate Count Field ("Sets the output field for putting the number of duplicates found on the parent duplicate document.")
  • Duplicate Id Field ("Sets the field to group together the duplicates found by the parent document's DocID value.")

Find Duplicate Page IDs

Use this script to check for duplicate identifiers.

Find Page (Bates) Gaps

Use this script to find gabs in bates/page ranges.

Bates Source

  • Beg Bates Field ("The document level beginning bates field to test.")
  • End Bates Field ("The document level ending bates field to test.")
  • Inclusive Range

Flag Empty Document Fields

Flags documents with empty or null field values across a list of fields.

Input Fields

  • Fields ("Set of fields to check if they are empty.")

Output Field

  • Has Empty Values

Flag or Delete Empty Fields

Reports on, and optionally deletes, the fields that are completely empty and not populated across a set of documents.

Action

  • Delete Empty Fields ("If checked, the fields that are empty across the document set will be deleted.")

Source Fields

  • Source Fields ("The list of fields to report and/or delete when all documents have empty/null values")

Hash Fields

Generates MD5, SHA-1, or SHA-256 hash values from specified fields.

Output Field

  • Custom Hash Field ("Outputs the calculated hash value to this field.")
  • Hash Type ("Calculates the output hash value based on selected method.")

Source Options

  • Case Sensitive ("All source field values will be ran as lowercase before calculating hash value.")
  • Remove Punctuation ("Punctuation characters will be removed before calculating hash value.")
  • Remove White Space ("White spaces will be removed before calculating the hash value.")
  • Remove Symbols ("Symbols will be removed before calculating the hash value.")

Source Fields

  • Fields ("The fields to be calculated.")

Pad Number Field

Pads a text or number field to include the specified number of digits.

Note: You can also use Field Setup and the Export Mask setting on a Number field to achieve similar results.

Setup

  • Number Field ("The field containing a number that can be padded.")
  • Padding ("The number of characters or digits to ensure the output value has.")
  • Padding Char ("The character or digit to pad the source value with.")
  • Direction ("Whether the padding will be added to the left or the right of the number.")

Output

  • Output Field ("The destination field the padded number will be saved to.")

Page IDs to Field

Outputs page identifiers (bates numbers) to a field per document.

Setup

  • Page IDs (Bates) Field
  • Delimiter

Propagate Child Field to Parent

Propagates child (attachment) field data with delimiter to parent field.

Setup

  • Source Field
  • Output Field
  • Delimiter

Propagate Parent Fields to Children

Propagates parent field data to child document fields.

Setup

  • Source Field

Propagate Fields

  • Propagate Fields

Redact Fields

Redacts text from multiple fields with an optional replacement value.

Replacement Text

  • Redact With Text

Redact Fields

  • Fields

Redact Fields (Delimited)

Redacts text from fields based on a per-document delimited field list.

Redact Text

  • Replacement Text ("Text used to replace the non-empty value on a field from the field list.")

Redact Fields

  • Field Names ("Field containing the delimited list of fields to redact for each document.")
  • Field Names Delimiter ("Delimiter used to separate the list of fields in the 'Field Names' option.")

Redact Status

  • Status Output Field ("Field will be set to 'Complete' if successful and 'Errors' if unsuccessful.")

Remove Control Characters

Removes control characters (formatting & non-printing characters) from all custom fields.

Remove Line Breaks

Remove line breaks from imported fields and replaces with a new symbol.

Text Settings

  • Replace New Line Char ("Optionally replaces line breaks with this symbol.")

Renumber Pages

Use to renumber page (bates) identifiers and, optionally, rename page files.

Setup

  • Starting Number ("Set the starting number to use. Must end with a digit.")
  • Update Doc Id ("Updates the internal DocID to match the starting page number for each document.")
  • Rename Page Files ("Renames the page files to match the new page/bates identifier assigned.")

Split Field

Splits a field based on a delimiter into multiple fields.

Setup

  • Source Field
  • Output Field Prefix
  • Delimiter
  • Max Split

Text Format

Format field data (display or execution order).

Note: This script is also available as a Field Script.

Setup

  • Input Fields

Trim Whitespace

  • Trim Start
  • Trim End

Trim Characters

  • Remove From Start
  • Remove From End

Casing

  • Upper Case
  • Lower Case
  • Title Case

Blank & Empty Values

  • Replace With Text
  • Replace With Field

Special Characters

  • Remove Punctuation
  • Remove Quotes
  • Remove White Space
  • Remove Custom

Truncate

  • Truncate
  • Max Length
  • Truncate Flag

Truncate Fields

Truncates field data based on a maximum length.

Setup

  • Max Length

Fields

  • Fields

XML iManage Field Export

Exports XML files per-document in the iManage format.

Misc

  • Meta Fields
  • System Fields
  • Version Fields
  • Barcode Field