apply_catalog_annotations
Apply catalog annotations to configure the Chaise web interface for a Deriva catalog, setting up navigation menus, display preferences, and bulk upload features.
Instructions
Apply catalog-level annotations to initialize the Chaise web interface.
Chaise is Deriva's web-based data browser. This method sets up annotations that control how Chaise displays and organizes the catalog, including the navigation bar and display settings.
Navigation Bar Structure: Creates a navigation bar with organized dropdown menus:
User Info: Users, Groups, and RID Lease tables
Deriva-ML: Core ML tables (Workflow, Execution, Dataset, Dataset_Version, etc.)
WWW: Web content tables (Page, File)
{Domain Schema}: All domain-specific tables (excludes vocabularies/associations)
Vocabulary: All controlled vocabulary tables from ML and domain schemas
Assets: All asset tables from ML and domain schemas
Catalog Registry: Link to ermrest registry
Documentation: Links to ML docs and instructions
Display Settings:
Underscores in names displayed as spaces
System columns (RID) shown in views
Default landing page set to Dataset table
Faceted search and record deletion enabled
Bulk Upload: Configures drag-and-drop file upload for asset tables.
When to call: After creating the domain schema and all tables. The menus are dynamically built from the current schema structure.
Args: navbar_brand_text: Text in the navigation bar brand area (default: "ML Data Browser"). head_title: Browser tab title (default: "Catalog ML").
Returns: JSON with status and applied settings.
Example workflow: 1. create_catalog("localhost", "my_project") 2. create_vocabulary("Species", "Types of species") 3. create_asset("Image", ...) 4. apply_catalog_annotations("My ML Project", "ML Catalog")
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| head_title | No | Catalog ML | |
| navbar_brand_text | No | ML Data Browser |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |