Objects metadata

Biz-App is built to feel "tailored" without needing a separate custom screen for every object.

It does that by relying on metadata:

• Object metadata explains what the object is.

• Field metadata explains how each field should be presented.

Object-level metadata

Every object has a:

• name (internal)

• display name (what users read)

• set of fields (columns)

• record identifier (used when running pipelines or saving edits)

What users feel

When object metadata is well-maintained, users experience:

• clear page titles

• consistent column labels

• forms that feel purposeful

Executable object metadata (what makes an object “pipeline-enabled”)

Some objects are not only meant to be viewed and maintained - but they are also meant to start a processing run.

In Biz-App, these are the objects you typically place under a Pipeline Standard navigation group.

To make an object executable, the object usually includes a metadata section like this:

"citta": {
  "allowExecutionOnRecords": true,
  "executableDefinitions": [
    40001780
  ],
  "jobDefinitionChains": [
    {
      "jobDefinition": 40001780,
      "nextJobDefinition": {
        "jobDefinition": 40001516
      }
    }
  ]
}

What this means in business terms

Think of this metadata as the object’s process permissions and roadmap.

It tells the system:

• Are users allowed to execute a process from a record?

• Which processes (pipelines) are approved for this object?

• If a process has multiple steps, what is the next step after the first one finishes?

Explanation of each property

allowExecutionOnRecords

If this is set to true:

• Users will be able to start an execution journey from a record.

executableDefinitions

This is the list of approved pipeline definitions that are allowed to run for this object.

Business meaning:

• It controls what the user can choose in the “Select pipeline” step.

• It prevents accidental execution of the wrong process.

In the example above, 40001780 is the identifier of a specific job definition in the platform.

jobDefinitionChains

Many workflows are not just one step.

They are a chain, for example:

1. Ingestion (take the upload and write initial outputs)

2. Enrichment / further processing (send outputs forward)

jobDefinitionChains describes this chain.

In the example above:

• jobDefinition: 40001780

  • This is the first pipeline step.

• nextJobDefinition.jobDefinition: 40001516

  • This is the next pipeline step that follows the first.

Why the chain matters for end users

When the chain is defined, Biz-App can guide the user more confidently:

• The Status panel can show what’s completed and what’s expected next.

• After users finish review/correction, the app can support sending the job to the next processing step (where your workflow requires it).

Field-level metadata (the guidance inside the form)

The magic happens in the Description section of your object's field definition. By adding a simple JSON configuration in the description, you control how the field looks and behaves.

You can combine specific settings for each field type with common settings like viewOrder, isRequired, and descriptionText.

Common Settings:

• viewOrder: Controls the display order of the field in both the data table columns and the "Add New Entry" form. Lower numbers appear first (leftmost in the table, topmost in the form).

• isRequired: Marks the field as mandatory.

• descriptionText: Adds a small help text or tooltip next to the field label to guide the user.

1. String (Text Input)

• Description: A standard single-line text box.

• Use Case: Names, Titles, Codes, simple descriptions.

• Configuration:

  {
    "inputType": "String",
    "isRequired": true,
    "viewOrder": 1,
    "descriptionText": "Enter the full name"
  }

2. NumberDecimal (Numeric Input)

• Description: An input field that accepts numbers, including decimals.

• Use Case: Prices, Quantities, Scores, Measurements.

• Configuration:

  {
    "inputType": "NumberDecimal",
    "isRequired": true,
    "viewOrder": 2
  }

3. DatePicker (Date Selection)

• Description: A calendar widget that allows users to select a date.

• Use Case: Birthdays, Start Dates, Deadlines.

• Configuration:

  {
    "inputType": "DatePicker",
    "isRequired": false,
    "viewOrder": 3
  }

4. SearchableDropdown (Lookup/Reference)

• Description: A dropdown menu that lets you search and select a value from another related object.

• Use Case: Selecting a "Manager" (referencing Employee object) or a "Category" (referencing Product Category object).

• Configuration:

  {
    "inputType": "SearchableDropdown",
    "lookupFieldColumn": "name",
    "isRequired": true,
    "viewOrder": 4,
    "lookupDisplayFields": ["bu_name"]
  }

  • lookupFieldColumn: Specifies which field from the referenced object should be shown in the dropdown (e.g., show the "name" of the manager).

  • lookupDisplayFields: Specified which fields from the referenced object should be shown in the grid (e.g. Instead of Id, it would display name).

5. FileRenderer (File Upload)

• Description: A drag-and-drop area to upload files.

• Use Case: Attachments, Images, Documents.

• Configuration:

  {
    "inputType": "FileRenderer",
    "maxFilesUploadable": "5",
    "acceptableFileExtensions": [".jpg", ".png", ".pdf"],
    "isRequired": false,
    "viewOrder": 5
  }

  • maxFilesUploadable: (Optional) Limit the number of files a user can upload.

  • acceptableFileExtensions: (Optional) Restrict the allowed file types.