Orchestration & control

controller.name

controller.name identifies the controller responsible for coordinating a request, resource, device, or workflow. It is commonly used for routing, registration, diagnostics, ownership, and selecting one controller among several.

Field referenceNaming guideAI workflow example
json
{
  "controller": {
    "name": "render-orchestrator",
    "version": "v2",
    "status": "active"
  }
}
01

What does controller.name mean?

A controller receives signals and coordinates what happens next. The name property identifies which controller definition or instance is involved. In an MVC web application, a controller handles requests and chooses application actions. In infrastructure, a controller continuously reconciles actual state with desired state. In hardware or automation, it may operate a device or process.

The field is contextual rather than universal. It can contain a class name, route-level label, registered component name, deployment identity, or friendly display name. The surrounding schema and sibling properties such as namespace, kind, version, or instanceId establish the precise meaning.

02

Controller identity and responsibility

A useful controller name communicates responsibility without claiming more identity than it can provide. Names such as render-orchestrator or timeline-controller tell an operator what the component controls. If several instances share that responsibility, controller.name should identify the controller type while controller.instanceId identifies one running copy.

This separation improves logs and metrics. Teams can aggregate behavior by controller name, then drill into a specific instance when diagnosing a failure. It also avoids changing dashboards every time a container, process, or worker is replaced.

03

Common controller contexts

Although the implementations differ, controllers usually sit at a decision boundary. They validate input, coordinate specialized services, track state, or select the next operation. A name becomes particularly useful when several controllers participate in one end-to-end workflow.

  • MVC applications: grouping request handlers by resource or feature.
  • Infrastructure: reconciling jobs, resources, or deployments.
  • Automation: coordinating state transitions and recovery behavior.
  • Media workflows: scheduling generation, rendering, timeline, and export operations.
04

Common property patterns

These examples illustrate how the property may be nested. They are descriptive patterns, not fields guaranteed by every platform.

render.controller.namerender-orchestrator

Identifies the coordinator for render jobs.

workflow.controller.namescene-pipeline

Names the controller for a multi-step workflow.

timeline.controller.nameeditor-timeline

Identifies timeline state coordination.

export.controller.namedelivery-worker

Names the component coordinating delivery.

Controller names in a generation pipeline

AI video creation involves long-running work and several state transitions. A controller can coordinate a storyboard job, send scenes to specialized generators, monitor their status, and advance the project when required outputs are ready. Naming that controller makes logs, retries, and ownership easier to understand.

The following object is a conceptual observability record, not a public Filmgine API response. It deliberately separates the controller's responsibility from the unique job being coordinated.

conceptual json
{
  "job": { "id": "render_01J...", "type": "scene-render" },
  "controller": {
    "name": "render-orchestrator",
    "attempt": 2
  }
}
05

Naming and implementation guidance

1

Choose a responsibility-based name such as scene-pipeline instead of a person's name.

2

Separate controller type, deployed version, and running instance identity.

3

Keep names stable enough for logs, dashboards, alerts, and access rules.

4

Do not use controller.name alone as proof that a caller is trusted.

5

Document ownership when more than one controller can act on the same resource.

06

Frequently asked questions

Is controller.name always an MVC controller?

No. It can refer to MVC request handling, an infrastructure reconciler, a device controller, or a workflow coordinator.

Should the name include Controller?

Only if it improves clarity in that system. A concise responsibility such as render-orchestrator is often more informative than a repeated type suffix.

Can two controller instances share a name?

Yes, when the name identifies their shared role. Use a separate instance ID to distinguish individual processes.

Turn a workflow into a film

Filmgine brings story development, visual planning, asset generation, and video creation into one creative workspace.

Open the studio