Skip to main content
MediaBeacon University

Bundles

In MediaBeacon, a bundle displays various data structures as assets.

There are five bundle-related functions:

  • Folder Based
    • Info Folder
    • Transparent Bundle
  • Opaque Folder
    • Results-Based
    • Search Bundle
    • Selection Bundle

Creating bundles is only allowed when an administrator has allowed the user's group to have the "Administer Bundles" permission.

Info Folder (aka Folder Info)

metadata-bundle-info-view.png
An info folder in the Directory Browser and in the Infinite Scroll View

To designate a folder as an Info Folder, select "Folder Info" in the contextual menu for a given folder in the Directory Browser component.
metadata-bundles-cm-folderinfo.png

This is the basic bundle type that contains metadata about a folder.

  • It is represented in View components by a folder-style icon.
  • It acts as an asset so it can be tagged with metadata and returned in searches.
  • The contextual menu for a bundle contains a special command: "Show bundle contents". This selects the folder in the Directory Browser, filtering the current view.
    metadata-bundles-cm-showbundle.png
  • Files may be moved in and out of an info folder, the same as any other folder / directory.
  • Unlike the folders in the Directory Browser, bundle icons in view components are not valid drag and drop targets for the purposes of moving or copying assets. Drag and drop will instead prompt the asset linking function.
  • The Info Folder can be returned to a normal folder, removing all metadata by using either the "Remove Metadata" command in the contextual menu, or by clicking the "Remove Metadata" button in the Asset View's General Tab.
    metadata-bundles-cm-removemd.png
    metadata-bundles-cm-assetview-removemd.png

Transparent Bundle

metadata-bundles-transparent-view.png
A transparent bundle in the Directory Browser and in the Infinite Scroll View

This type of bundle has all the functionality of an Info Folder, but with an added feature. Assets in a transparent bundle will inherit the metadata written to "bundle fields" of the parent bundles.

To create a transparent bundle, choose "Bundle" in the contextual menu of a folder and choose "Create Transparent Bundle" in the Folder Bundle Setup Dialog.
metadata-bundles-cm-bundle.png
metadata-bundles-cm-folderbundlesetup.png

The transparent bundle will be shown in the Directory browser with a green icon and a folder icon in view components.
metadata-bundles-transparent-view.png

Metadata Inheritance

Fields can be specifically designated as "bundle fields". When a transparent bundle has a value written in a bundle field, child assets will inherit those metadata values. In this arrangement, the bundle is often referred to as the "parent", and the contained assets as the "children". There are two types of bundle fields:

  • Non-Overridable: This is the standard bundle field. Child assets inside a non-overridable bundle will have bundle field values controlled by their parent.
  • Overridable: This type of field allows child assets to have different metadata in bundle fields.

Bundle Field Icons

Bundle fields act as normal fields except when viewed on bundles or child assets. In this case, they are indicated by an icon on their right. Four different icons indicate status:

metadata-bundle-fieldicons-bundle.png

  • Lock icon: Seen on bundle fields of bundle assets, this icon indicates that the value is synced between parent and children.
  • Unlocked icon: Seen on bundle fields of bundle assets, this icon indicates one or more one child's value in an overridable field is not synced to the parent. Click on the unlock icon to overwrite the values in all child assets to match the parent's values. This icon is only seen on overridable bundle fields.

metadata-bundle-fieldicons-child.png

  • View parent bundle folder (folder icon): Displayed on bundle fields of child assets, clicking this icon will open the parent bundle in the asset view.  
  • Use parent bundle folder value (dimmed icon): Displayed on child assets that have unsynced metadata. Clicking will sync the asset's value with its parent.

Retaining Metadata on Directory Change

When an asset is moved out of a bundle with bundle fields, values in those fields are retained. However, when an asset with values in bundle fields is moved into a bundle, those values may be overwritten.

  • Non-Overridable bundle field values: These values will always be overwritten by a parent bundle folder.
  • Overridable bundle field values: These values are only overridden by a parent bundle if they are blank.

Nested Transparent Bundles

Transparent bundles may be nested within other transparent bundles. In this case, bundles inherit metadata from their parent as other assets would.

The nature of metadata inheritance depends upon the override setting of the field in question. Non-overridable fields inherit the value from the topmost bundle, and overridable fields inherit the immediate parent's value.

An overridable field's asset field icons functions are also more specific in this case:

  • View parent bundle folder: Open the immediate parent bundle.
  • Use parent bundle folder value: Sync the asset's value with its immediate parent.

Opaque Bundle

An opaque bundle obscures all contents from the view component and removes the folder from the directory browser, combining the folder and all contained assets into a single asset.

metadata-bundle-opaque-view.png
Note that the opaque bundle does not appear as a folder.

To create an opaque bundle, choose "Bundle" in the contextual menu of a folder, and choose "Create Opaque Bundle" in the Folder Bundle Setup Dialog.
metadata-bundles-cm-bundle.png
metadata-bundles-cm-folderbundlesetup.png

When the bundle is downloaded, all contained assets are included.

To show the contents of a opaque bundle, click the "Unbundle" button on the opaque bundle's Asset View General Tab. This changes the opaque bundle to an info folder.
metadata-bundles-assetview-unbundle.png

Results-Based Bundles

These bundle types are asset representations of saved searches and saved selections. These bundles do not contain assets the way folder-based assets do, but have "member assets" that are the search results of a saved search or a saved selection. For more information, see the [Saved Searches] and [Saved Selections] sections.

Metadata Inheritance

When bundle fields are used with metadata inheritance bundles, syncing functionality is altered to a metadata "push" functionality. In these cases:

  • Metadata is written to member assets only when it is written to the bundle asset.
  • There is no distinction made between overridable and non-overridable fields. All bundle fields effectively become overridable.
  • Bundle fields in bundle assets will not detect when member assets have differing metadata.

Search Bundle

metadata-bundles-searchbundle-view.png

A search bundle is displayed as an asset:

  • Visible in view components, not in the Directory Browser.
  • Allows complex searches to be saved as an asset.
  • The results of the saved search may be shown using the contextual menu command "Show Bundle Contents".
    • The Record ID of the bundle itself is always included with the original search terms so that it will appear along with results in the above case.

Creating a Search Bundle

  1. Click the "Save" button in the Advanced Search Dialog or the Save Search button in the Search Status component.
    metadata-bundles-advsavesearch.png
    metadata-bundles-compsavesearch.png

  2. Click the "Create Search Bundle" button in the "Save Search" dialog.
    metadata-bundles-newsearchbundle.png

    1. Note: the Privacy settings do not affect the Search Bundle.
  3. A new search bundle will be created in the user's "Index/" folder.

A search bundle's contextual menus have a special command, "Show bundle contents" that changes the current view to the bundle and any assets that would be returned by that search.

Editing Search Bundles

The criteria used to define a search bundle is editable on the General tab in the Asset View, under "Search Bundle Membership Criteria", in an interface similar to the advanced search dialog.

Once edits are made, click "Apply Criteria" to save them. The "View Member Assets" has the same function as "Show bundle contents", above.search-bundle-general-tab.png

Selection Bundle

selection-bundle-asset.png

A selection bundle is displayed as an asset:

  • Visible in view components, not in the Directory Browser.
  • Allows saved selections to be saved as an asset.
  • The results of the saved selection can be shown using the contextual menu command "Show Bundle Contents".

Creating a Selection Bundle

  1. Once a selection is made, choose the "Saved Selection" command in the "Create" menu.
    metadata-bundles-savsel.png
  2. Click the "Create Search Bundle" button in the "Create Saved Selection" dialog.
    metadata-bundles-newsavsel.png
    1. Note: the Privacy settings do not affect the Selection Bundle.
  3. A new search bundle will be created in the user's "Index/" folder.

A selection bundle is displayed as an asset that contains its own metadata and allows complex searches to be recalled using a search. The Discussions function allows user to make comments on collections of assets.

Editing a Selection Bundle

Contents of selection bundles can be edited in a limited way. Assets may be added to, but not removed from, selection bundles.

The current selection may be added to a selection bundle using the "Selection > Add" command. This opens the "Add to Saved Selection" dialog that will allow users to click on a selection bundle to combe the contents of the current selection with the selection bundle's member assets.

metadata-bundles-menu-addtosel.png

metadata-bundles-menu-addtosel.png

  • Was this article helpful?