Technical Note: Local Storage

Introduction

This document describes records stored by OraExtension in local storage.

Service Prefix

Several keys include the service's "storagePrefix". In the format definitions, the storagePrefix is indicated by prefix.

Record Status

Status values for records where user has set the status.

Format: "rs.prefix.record-key" : state

States:

• 0 = NONE
• 1 = QUESTIONABLE
• 2 = ENTERED
• 3 = REJECTED
• 4 = PENDING
• 5 = SKIPPED

"None" is the default and no record appears in local storage.

Example

"rs.A.1002::10413999": 2

Collection Field Values

Field names/values from most-recent visit to a collection.

Format: "prefix.collectionId.f" : [items]

Each item in the array is an object with these properties:

• n: Field name
• v: Field value

Example

"A.1002.f": [
  {
    "n": "Birth Date",
    "v": "27 Sep 1893"
  },
  {
    "n": "Birth Place",
    "v": "Grassy Creek, North Carolina, USA"
  },
  {
    "n": "Board Num",
    "v": "1"
  },
]

Collection Properties

Array of templates and other properties for a collection.

Format: "prefix.collectionId" : [items]

Each item in the array is an object with these properties:

• r: Reminder (Auto Type Template), Heading (Text Template), or Name (property)
• t: Template text or property value
• u: Type (1=text template, 2=auto type template, 3=property value)

Example

"A.1002": [
  {
    "r": "Gender",
    "t": "# Gender is set to male, as only males were drafted\n<[Gender]|Male>",
    "u": 1
  },
  {
    "r": "Serial Num",
    "t": "# Upper left corner\n<[Serial Num:uppercase]|Enter>\n",
    "u": 1
  },
  {
    "r": "Order Num",
    "t": "# Upper right corner\n<[Order Num:uppercase]|Enter>",
    "u": 1
  },
  {
    "r": "TMG Add Citation",
    "t": "[var.TMG Cite][lib.TmgRecordId]",
    "u": 2
  },
  {
    "r": "parent",
    "t": "A.2442",
    "u": 3
  }
]

Collection Names

Each item in the collections object is the name of a collection.

Format: "collections" : {items}

Each item in the object has this format:

Format: "prefix.collectionId" : "string"

Example

"collections": {
  "A.1002": "U.S., World War II Draft Registration Cards, 1942",
  "A.1075": "U.S., Border Crossings from Canada to U.S., 1895-1960",
  "A.1079": "Illinois, State Census Collection, 1825-1865",
}

Template Library

Each item in the library object defines a library template.

Format: "library" : {items}

Each item in the object has this format:

Format: "template-name" : "template-string"

Example

"library": {
  "Census_County_Name": "<[County] <[?:State=South Carolina]District|County>>",
  "Census_Title": "Population Schedule"
}

Service Status

Each service status item defines the enabled/disabled status of the service.

Format: "prefix.enabled" : boolean

Example

"GENERIC.enabled": false

Search Targets

An array of Search Target items.

Format: "searchTargets" : [items]

Each item in the array is an object with these properties:

• "enabled" : boolean — True (show in OraPanel) or false (do not show in OraPanel).
• "linkText" : string — The text used in the Search Target's OraPanel button.
• "name" : string — The name of the Search Target. Used only in the Search Targets Panel.
• "predefined" : string — For pre-defined (not user-defined) Search Targets, the version number. Pre-defined search targets may be replaced as part of an ORA update. User-defined (including pre-defined that are edited by the user) are not replaced.
• "template" : string — The templated used to construct the link.
• "trace" : boolean — True (show trace in Developer Console) or false (do not show trace in Developer Console).

Example

"searchTargets": [
  {
    "enabled": true,
    "linkText": "ANC",
    "name": "Ancestry",
    "predefined": "1.67.1",
    "template": "<[??:qf.GivenName:qf.Surname]\nhttps://www.[qf.Ancestry]/search/\n?name=[qf.GivenName:urlParameter]_<[?:qf.MaidenSurname][qf.MaidenSurname:append: :urlParameter]>[qf.SurName:urlParameter]\n<&birth=<[qf.Birth Year]><_[qf.Birth Place:placeAddCountry:replace:, United States:, USA:urlParameter]>>\n<&death=<[qf.Death Year]><_[qf.Death Place:placeAddCountry:replace:, United States:, USA:urlParameter]>>\n<&marriage=<[qf.Marriage Year]><_[qf.Marriage Place:placeAddCountry:replace:, United States:, USA:urlParameter]>>\n<&spouse=[qf.Spouse GivenName:urlParameter]_<[qf.Spouse Surname:urlParameter]>>\n>",
    "trace": false
  },
  // etc.
]

Preferences

Several preferences are stored at the root level of local storage. The keys do not include periods to avoid being mistaken for properties defined above.

Format: "key_without_period" : value

Example

"add_AT_legend": true,
"add_fields_at_top": true,
"ancestryHostname": "ancestry.com",
"ancestry_image_page_CP": true,
"date_format": "dd Mmm yyyy",
"defaultLocale": "us",
"julianFirstDay": 25,
"julianFirstMonth": 3,
"libraryLast": "PostThe1880-1940_CensusEventTag",
"mostRecentCollection": "GENERIC.1950census.archives.gov",
"optional_name_chars": true,
"panel_state": "ora-expanded",
"quarter_date_format": "Qn yyyy",
"searchTargetsLast": "Ancestry",
"target_application": "rootsmagic",
"user_field_name_style": "",
"user_field_value_style": "background-color: #eee8aa; font-weight: bold;",
"version": 4

Preference Objects

Several preferences have values that are objects.

Example

"namePreSurnames": {
  "d'": "d'",
  "de": "de",
  "der": "der",
  "la": "la",
  "le": "le",
  "mac": "Mac",
  "mc": "Mc",
  "o'": "O'",
  "van": "van",
  "von": "von"
},
"namePrefixes": {
  "1st lt.": "1st Lt.",
  "2nd lt.": "2nd Lt.",
  "3rd lt.": "3rd Lt.",
  "capt": "Capt[.]",
  "col": "Col[.]",
  "col.": "Col[.]"
},
"nameSuffixes": {
  "b.s": "B.S.",
  "b.s.": "B.S.",
  "bs": "B.S.",
  "esq": "Esq.",
  "esq.": "Esg.",
  "sr.": "Sr[.]"
}

Panel Locations

ORA saves and restores panel locations.

Format: "panelLocation-service-pageKey" : {item}

The pageKey is defined by the service. Typical values are "-record-details", "-results", etc. Pagekeys should start with a hyphen. Do not use periods in pageKeys.

Each item is an object with these properties:

• x: Horizontal offset, in pixels
• y: Vertical offset, in pixels

Example

"panelLocation-ancestry-family-tree": {
  "x": 0,
  "y": 264
},
"panelLocation-familysearch-record-details": {
  "x": 0,
  "y": 13
},
"panelLocation-findagrave-memorial": {
  "x": 9,
  "y": 45
}