Choice Tools

Choice Tools includes the following scripts:

Choice Statistics

Reports on the number of documents for each choice in the specified fields.

Setup

  • Delimiter ("Character used to separate multiple choice values.")
  • Case Sensitive ("Toggles whether choice values should be case-sensitive when merging duplicate values.")

Source Fields

  • Fields ("The list of fields to read choice values from.")

Destination Fields

  • Limit Results ("Enable to limit the total number of top results reported on.")
  • Top Results ("The number of top results reported on.")

Choice to Fields

Creates a field for each unique choice and sets a value on that field. Optionally supports nested choices to combine multi-choices into a single field.

Setup

  • Choice Delimiter ("Character used to separate multiple choice values.")

Nested Values

  • Nested Values ("Use to indicate choices are nested and fields should be created using the first level of the nested value.")
  • Nested Delimiter ("Character used to separate nested values (e.g. tag folders) from choice values..")

Source Fields

  • Fields ("The list of fields to extract choice values from.")

Destination Fields

  • Field Type ("When set to Choice, the value of the field will match the choice name. Otherwise, a true/false value will be set for a Boolean type.")
  • Field Name Prefix ("The value set will be added in front of the created field name.")
  • Field Name Suffix ("The value set will be added at the end of the created field name.")

Merge Field Choices

Combines or merges choice values from several fields into a single field. When merged, only unique choice values will be kept and case-sensitivity for choices can be enabled or disabled.

Setup

  • Delimiter ("Character used to separate multiple choice values.")
  • Case Sensitive ("Toggles whether choice values should be case-sensitive when merging duplicate values.")
  • Sort Order ("Toggle sort order mode by specifying ascending or descending direction.")

Source Fields

  • Fields ("The list of fields to read choice values from.")

Destination Fields

  • Output Field ("Output field to create with the list of unique choice values from list of source fields.")

Propagate Choices by Family Level

Populates and propagates choices from the parent level down the entire family chain.

Setup

  • Case Sensitive ("Toggles whether choice values should be case-sensitive when handling duplicate values.")
  • Choice Delimiter ("Character used to separate multiple choice values in a field.")
  • Level Delimiter ("Character used to separate family levels in the source DocId field.")
  • Child Value Annotation ("If enabled, new child values will be propagated with the annotation suffix character.")
  • Child Value Annotation ("This suffix will be used, when ChildValueAnnotation option is enabled, to append a character to the end of propagated child values.")

Source Fields

  • Doc Id Field ("The document identifier that contains indentations for identifying family levels.")
  • Group Id Field ("The group or family link field used to group document sets.")
  • Propagate Fields ("The list of fields to read existing choice values from to propagate down the family level chain.")

Destination Fields

  • Overwrite Source Fields ("If checked, this option will now create new fields and will update the existing fields and values.")
  • Output Field Prefix ("If set, and Overwrite Source Fields is set to false, this value will be used to prefix field names to create new output fields.")

Example

Below is an example when this script is run with the following Source Field options.

  1. Source Fields: Control Number
  2. Doc Id Field: Control Group
  3. Propagate Fields: From, Sent To, CC

Propagate Choices by Group

Combines all the unique choices and propagate those choice values across the entire family, thread, or similarly related group of documents.

Setup

  • Delimiter ("Character used to separate multiple choice values.")

Source Fields

  • Group Field ("The field to group documents on, such as a Group Id or Thread Id field.")
  • Choice Field ("The field to read choice values from.")

Destination Field

  • Output Field ("Output field to create with the list of unique choice values from list of source fields.")

Remove Choice from Choices:

Removes a list of choices values from a choice or pick field. For example, you could remove several custodian names from an All Custodians field.

Setup

  • Choice Source Field ("Fields specified to read the 'Choices' data from.")
  • Remove Choices ("A list of choice(s) to remove from the 'Choices' field.")
  • Delimiter ("Delimiter used to separate the list of choice values.")

Remove Choices (Delimited):

Removes choices from field based on a per-document choice list.

Setup

  • Source Field ("Field specified to read the 'Choices' data from.")
  • Choices Field ("Field containing the delimited list of choices to be removed for each document..")
  • Delimiter ("Delimiter used to separate the list of choice values.")

Destination Field

  • Output Field ("Output field with removed choices.")

Retain Choice in Choices:

Retains chose phrases in the chosen fields and removes all phrases that are not in chosen list.

Setup

  • Choice Source Fields ("Field specified to read the 'Choices' data from.")
  • Retain Choices ("A list of choice(s) to retain from in 'Choices' field.")
  • Delimiter ("Delimiter used to separate the list of choice values.")