Appearance

DAM Instance Settings ​

File Information ​

  • Path: pages/_workspace_id/workspace-settings/dam/_instance_id/index.vue
  • Route: /:workspace_id/workspace-settings/dam/:instance_id
  • Purpose: Individual DAM instance configuration and management

Overview ​

The DAM Instance Settings page provides detailed configuration for a specific DAM instance. It includes instance information, branding settings, user management, notifications, announcements, and other instance-specific configurations.

Key Features ​

  1. Instance Information

    • Instance name and description
    • Instance ID and status
    • Storage usage and limits
    • Creation date

  2. Branding Settings

    • Instance logo
    • Primary color
    • Favicon
    • Banner images
    • Tile images

  3. User Management

    • Instance users list
    • Add users to instance
    • Remove users from instance
    • User roles and permissions

  4. Notifications

    • Notification settings
    • Notification templates
    • Notification delivery

  5. Announcements

    • Create announcements
    • Manage announcements
    • Announcement display settings

  6. Advanced Settings

    • Storage configuration
    • Access control
    • Feature flags
    • Integration settings

Components Used ​

  • WorkspaceNote - Instance notes
  • User management components
  • Branding components
  • Notification components
  • Announcement components

Data Properties ​

javascript
{
  instance: null,          // DAM instance object
  loading: false,         // Loading state
  saving: false,          // Saving state
  users: [],             // Instance users
  notifications: [],     // Notification settings
  announcements: []      // Announcements
}

Computed Properties ​

instanceId ​

Returns instance ID from route

canEditInstance ​

Checks if user can edit instance settings

storageUsage ​

Returns storage usage percentage

Methods ​

loadInstance() ​

Loads instance details:

  • Fetches instance from API
  • Loads related data (users, notifications)
  • Updates instance state
  • Handles errors

saveInstance(instanceData) ​

Saves instance changes:

  • Validates instance data
  • Updates instance via API
  • Refreshes instance data
  • Shows success/error message

uploadBranding(file, type) ​

Uploads branding asset:

  • Uploads logo/banner/tile
  • Updates instance branding
  • Handles upload errors

manageUsers() ​

Opens user management:

  • Navigates to user management page
  • Or opens user management dialog

createAnnouncement(announcementData) ​

Creates announcement:

  • Validates announcement data
  • Creates via API
  • Refreshes announcements
  • Shows success message

API Endpoints ​

Get DAM Instance ​

  • Endpoint: GET /dam/instance/details
  • Query Parameters: instance_id, workspace_id
  • Response: DAM instance object with details

Update DAM Instance ​

  • Endpoint: PUT /dam/instance/update
  • Request Body: Instance update data
  • Response: Updated instance object

Upload Branding ​

  • Endpoint: POST /dam/instance/upload-branding
  • Request: FormData with branding file
  • Response: Branding URL

Get Instance Users ​

  • Endpoint: GET /dam/instance/users
  • Query Parameters: instance_id
  • Response: Array of user objects

Create Announcement ​

  • Endpoint: POST /dam/instance/announcement/create
  • Request Body: Announcement data
  • Response: Created announcement object

User Flow ​

  1. User navigates to DAM Instance Settings
  2. Page loads instance details
  3. User views instance information
  4. User updates branding settings
  5. User manages instance users
  6. User configures notifications
  7. User creates/manages announcements
  8. Changes are saved
  9. Success message displayed

Sub-pages ​

  • Users: /workspace-settings/dam/:instance_id/users
  • Announcements: /workspace-settings/dam/:instance_id/announcements
  • Manage Banner: /workspace-settings/dam/:instance_id/manage-banner
  • Manage Tile: /workspace-settings/dam/:instance_id/manage-tile

Notes for Development ​

  • Page requires instance admin permissions
  • Branding uploads use FormData
  • User management may redirect to separate page
  • Announcements have display rules
  • Storage limits enforced