Side navigation setup

The side navigation is the map of Biz-App.

It answers two questions for every user:

1. “What can I do here?”

2. “Where should I start?”

How the menu is structured

The menu is made of navigation groups.

• A group is a section title (like a chapter heading).

• Each group contains multiple items.

• Each item opens a page.

The two families of groups

A) User-defined groups

These are defined by your organization.

They include:

Standard (user-defined)

Opens an object for normal work:

• view records

• search and filter

• add new entries

Pipeline Standard (user-defined)

Opens an object where records are executable:

• select a record

• execute a pipeline

• upload files

• review outputs

B) System-defined groups

These are provided as part of governance.

Validations (system-defined)

Opens the validations management area.

What each navigation property means

Group properties

• id

  • A unique identifier for the group.

  • Think of this as a stable reference name.

  • Recommendation: keep it short and predictable (for example: data, processing, governance).

• name

  • The title users see in the side menu.

  • This should be written in your business language.

  • Recommendation: treat it like a signboard. If a new user reads only these group titles, they should still understand the app.

• type

  • Determines what kind of experience the items in this group will open.

  • Supported meanings used by Biz-App:

    • standard (user-defined)

    • pipelineStandard (user-defined)

    • rules-system (system-defined)

  • Recommendation:

    • Use standard for “registers” (everyday data work)

    • Use pipelineStandard for “run workflows” (upload/process/review)

• items

  • The clickable items inside the group.

  • Recommendation: keep each group to a manageable number of items so the menu stays readable.

Item properties

• id

  • A unique identifier for the item.

  • Recommendation: keep it stable. It is part of how the menu stays consistent.

• displayName

  • The label users see.

  • Choose a clear, action-friendly name.

  • Examples:

    • Suppliers

    • Facilities

• objectName

  • The object that should open when the user clicks.

  • This must match the object configured in the platform.

Example: a well-structured menu

The following example is a common and effective structure:

• Data (Standard) — everyday registers

• Processing (Pipeline Standard) — executable objects

• Governance (System-defined) — validations

{
  "navigationGroups": [
    {
      "id": "data",
      "name": "Data",
      "type": "standard",
      "items": [
        {
          "id": "suppliers",
          "displayName": "Suppliers",
          "objectName": "supplier"
        },
        {
          "id": "facilities",
          "displayName": "Facilities",
          "objectName": "facility"
        }
      ]
    },
    {
      "id": "processing",
      "name": "Processing",
      "type": "pipelineStandard",
      "items": [
        {
          "id": "uploads",
          "displayName": "Upload Runs",
          "objectName": "upload_run"
        }
      ]
    },
    {
      "id": "governance",
      "name": "Governance",
      "type": "rules-system",
      "items": [
        {
          "id": "validation_rules",
          "displayName": "Validation Rules",
          "objectName": "validation-rules"
        }
      ]
    }
  ]
}