workspaceHomeIcon

This reference describes the full structure of workspaceHomeIcon. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.

Structure and values

"activity" \| "alert" \| "arrow-right" \| "bot" \| "briefcase" \| "check" \| "document" \| "inbox" \| "knowledge" \| "marketplace" \| "overview" \| "portfolio" \| "profile" \| "search" \| "users" \| "map" \| "graph" \| "layers" \| "settings"

Reading the contract

A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

"activity"

Related references

Complete Model index · Build a Model

Applied examples : Organize destinations

Choose the Clients collection in navigation and offer the next actions on the home.

Configuration

Contract object workspaceHomeIcon. Properties and accepted values.

"users"

Variation and connection

Fragment placed in homePresentation. Properties and accepted values.

{
  "contract": "WorkspaceHomePresentation@1",
  "header": {
    "intro": "Clients and quotes",
    "primaryNavigation": {
      "destinationKey": "clients",
      "label": "Open clients"
    }
  },
  "launchers": {
    "title": "Move work forward",
    "description": "Choose an action",
    "icons": [
      {
        "actionKey": "create-client",
        "icon": "users"
      },
      {
        "actionKey": "prepare-quote",
        "icon": "document"
      }
    ]
  },
  "blocks": [
    {
      "kind": "section",
      "sectionKey": "recent-quotes",
      "variant": "collection",
      "placement": "main",
      "maximumVisible": 4,
      "viewAll": {
        "destinationKey": "quotes",
        "label": "All quotes"
      }
    }
  ]
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Clients · Data
2. References · Knowledge
3. Preparation · Work
4. Quotes · Product

SurfaceClients / North StudioExample

workspaceHomeIconworkspaceHomeIcon

Clients

MODEL CONTEXTNorth StudioDeclarative configuration

Value

users

Values above follow the configuration fragment; references resolve in the complete Model.