Skip to content
13. Sync OHMS Studio Records with Aviary Resources

An OHMS Studio record and an Aviary resource in the same organization can be linked as a synced pair. Once they are linked, the interview’s metadata, index, transcript, and media can be passed between the two in either direction. Archivists can catalog and index an interview in OHMS Studio, publish it as an Aviary resource, continue refining the transcript in the Aviary transcript editor, and send those corrections back to the OHMS record so the OHMS XML export and the OHMS Viewer stay current.
This page covers how to create a synced Aviary resource from an OHMS Studio record, how to update a synced pair in each direction, and what each sync changes.

13.1. How the sync works

Each OHMS Studio record can be linked to one Aviary resource, and each Aviary resource can be linked to one OHMS Studio record. The link is created the first time an OHMS Studio record is used to create an Aviary resource, and Aviary keeps a record of the link and the date of the last sync.
A synced pair always belongs to a single organization. Aviary creates or updates the resource in the organization that owns the OHMS Studio record, even when the person running the sync is a member of more than one organization.
There are two sync directions:
OHMS Studio → Aviary creates a new Aviary resource from an OHMS Studio record, or updates the linked resource with the record’s current metadata, index, transcript, and media.
Aviary → OHMS Studio updates the linked OHMS Studio record with the resource’s current metadata and transcript, including edits and annotations made in the Aviary transcript editor.
Each sync updates the existing linked record or resource in place. A sync never creates a second Aviary resource or a duplicate OHMS Studio record for the same interview.

13.2. Before you begin

User role. Organization Owners and Organization Admins can create an Aviary resource from an OHMS Studio record. The Create Aviary Resource & Upload Media button is not displayed to Organization Users or Assigned Users. See the page for more information. [Verify: which roles can run Update Resource in OHMS Studio and Update OHMS on the resource.]
Title. The OHMS Studio record must have a Title. Aviary displays a warning and does not continue if the Title field is empty.
Available resources. Each new synced resource counts toward the organization’s Aviary resource limit. If the organization has reached its limit, Aviary displays an error and does not create the resource. See the page for information about upgrading an OHMS organization to a paid Aviary subscription. [Verify: current number of resources included with free OHMS subscriptions.]
Transcript format. Records with an OHMS Aviary (VTT) transcript, or with no transcript, can be synced. If a record has a legacy OHMS transcript (<transcript> and <sync>), convert it first with Convert a Legacy OHMS Transcript, described on the page. [Verify: whether legacy-transcript records are still blocked from syncing, or are now converted automatically.]
Media. The record’s media can come from a file on your computer, a YouTube link, or a Vimeo link. Private or unavailable YouTube and Vimeo videos cannot be retrieved. [Verify: support for Kaltura, Brightcove, SoundCloud, Avalon, Internet Archive, and Local Host media.]

13.3. Create an Aviary resource from an OHMS Studio record

In OHMS Studio, open the record you want to publish in Aviary, or create a new record. A new record must be saved before it can be synced.
In the Metadata Editor, confirm that the Title and other descriptive metadata are complete.
Click the Create Aviary Resource & Upload Media button.
Aviary displays a notice that adding resources and media files may require a higher Aviary subscription level. Click to proceed.
The Create Synced Aviary Resource & Upload Media window opens. Review the settings and click Create Aviary Resource.
Add the media file. Upload a file from your computer, or let Aviary retrieve the media from the record’s YouTube or Vimeo link.
Aviary creates the resource and imports the media. Media retrieval and import can take some time for long recordings and large files. A status message shows while the sync is in progress and when it finishes or fails. Do not start the sync again while it is running.
[Verify: exact button and window labels against the current UI, and add screenshots for steps 3 to 7.]

What the first sync creates

Resource description. OHMS metadata is mapped to the Aviary resource’s descriptive metadata fields. Multiple Keywords or Subjects separated by semicolons in OHMS become separate Keyword and Subject entries in Aviary, in the same order.
Index. The OHMS index becomes an Aviary index on the resource.
Transcript. The OHMS transcript becomes an Aviary transcript on the resource, with timecodes and speaker names.
Media file. The media is imported into Aviary once and attached to the resource.

What changes in the OHMS Studio record

After the media is imported, Aviary updates the OHMS Studio record so that it points to the new Aviary media file:
Media Host is set to Aviary.
Media URL is set to the Aviary media file’s embed link (for example, https://[your-subdomain].aviaryplatform.com/embed/media/[ID]).
Duration and Media Filename are set from the imported media file.
The OHMS Viewer then plays the interview from Aviary.

13.4. Identify a synced pair

In OHMS Studio, a synced record shows Resource record synced and the date of the last sync in place of the Create Aviary Resource & Upload Media button, along with two buttons:
Resource opens the linked Aviary resource.
Update Resource sends the record’s current data to the linked Aviary resource (see 13.5).
In Aviary, a synced resource shows OHMS Studio record synced and the date of the last sync below the Resource Metadata section, along with two buttons:
OHMS opens the linked OHMS Studio record.
Update OHMS sends the resource’s current data to the linked OHMS Studio record (see 13.6).

13.5. Update an Aviary resource from OHMS Studio

Use this direction when the OHMS Studio record has changed, for example after revising the index or descriptive metadata in OHMS Studio.
In OHMS Studio, open the synced record.
Click Update Resource.
Confirm the update. The sync runs, and the last-sync date is updated when it finishes.
The update brings the linked resource’s metadata, index, transcript, and media in line with the OHMS Studio record. It updates the existing resource rather than deleting and recreating it. If the media has not changed, Aviary does not download or import it again. If the media has changed, Aviary imports the new media once and does not leave a duplicate copy on the resource.
[Verify: whether Update Resource lets the user choose which parts to update (description, index, transcript, media), and whether it replaces or merges each part.]

13.6. Update an OHMS Studio record from Aviary

Use this direction when transcript work has continued in Aviary, for example correcting text, adjusting timecodes, adding speaker names, aligning the transcript with Gentle, or adding annotations. Without this update, the OHMS Studio record, its OHMS XML export, and the OHMS Viewer continue to show the earlier transcript.
In Aviary, open the synced resource.
Click Update OHMS.
Confirm the update. The sync runs, and the last-sync date is updated when it finishes.
The update writes the resource’s current data back into the linked OHMS Studio record and replaces the record’s transcript with the current Aviary transcript, including its text, timecodes, and speaker names. This works for VTT transcripts and Gentle-aligned transcripts. Standard transcript annotations and carry over to the OHMS Studio record, including NER entity types, geolocation, and Wikidata links.
After the update, preview the record in the Preview Viewer to confirm the transcript, and export the OHMS XML if the interview is published in an external OHMS Viewer.
If the resource is not linked to an OHMS Studio record, the Update OHMS button is not displayed. If any part of the update fails, Aviary displays an error and leaves the OHMS Studio record unchanged.
info
Choose one place to edit each transcript. Update OHMS replaces the OHMS Studio transcript with the Aviary transcript, and Update Resource sends the OHMS Studio transcript to Aviary. Edits made to the transcript in both places between syncs are not merged: the most recent update in either direction determines the transcript. Decide whether transcript editing happens in OHMS Studio or in Aviary, and sync after each round of edits. [Verify: overwrite behavior when the transcript was edited on both sides since the last sync.]

13.7. Link an existing OHMS Studio record to an existing Aviary resource

If an interview already exists as both an OHMS Studio record and an Aviary resource, for example after a migration, the two can be linked as a synced pair without creating a new resource. Linking does not change the content of either one; after the link is in place, use Update Resource or Update OHMS to send changes in the direction you choose. Contact Aviary support to link existing records and resources. [Verify: whether this remains a support request for all organizations.]

13.8. Troubleshooting

“Title required to create Aviary resource and upload media.” Add a Title to the OHMS Studio record and try again.
The subscription does not allow more resources. The organization has reached its Aviary resource limit. An Organization Owner can upgrade the subscription, or contact Aviary support.
The media did not import. Confirm that the YouTube or Vimeo video is public and available, then run Update Resource. Aviary displays an error when media cannot be retrieved and does not leave a partial or duplicate media file on the resource.
The sync is taking a long time. Media retrieval and import for long recordings can take a while. Wait for the status message before running the sync again; a second request for the same record is not started while one is in progress.
Keywords or Subjects appear as a single combined entry. Resources synced before October 2026 may show semicolon-separated values as one entry. Run Update Resource to replace the combined entry with separate entries.
The resource is missing its transcript. Resources synced from records with Local Host media before October 26, 2026 may not have received the transcript. Run Update Resource to sync the transcript again. [Verify: whether affected records were re-synced for customers, and whether Local Host is a user-facing Media Host label.]
If a sync fails for another reason, contact Aviary support and include the OHMS Studio record ID and the Aviary resource ID.
Want to print your doc?
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.