Glossary
The words that appear only in Project in the Marketplace edition. For words shared with the SaaS edition, see the SaaS edition's Glossary.
Agents and contracts
| Word on screen | Meaning | Name in records and settings |
|---|---|---|
| Registered agent | An agent built as a container image, registered by an administrator under “Agent Settings” in the admin console | runtime_kind: marketplace |
| Use in workflows | The admin console setting that lets a registered agent be placed on workflow steps. Turn it on and register a contract | workflow_contract |
| Contract | The agreement on the parameters, files, artifacts and connections a registered agent receives, its effect on external systems and its execution limit | workflow_contract |
| Certified / Unavailable (not certified) | Whether the contract's certification details are all in place. An agent that is not certified cannot be placed in a workflow | certification |
| Supported run rules | The basic rules (Open / Guarded / Strict) the agent supports. One of the certification details | supported_policies |
| Effect on external systems | Read only / Writes (safe to retry) / Writes (retry may duplicate). “Effect mode” in the admin console | effect_mode (read_only / idempotent_write / non_idempotent_write) |
| Execution limit | The time limit for one execution. “Execution timeout (seconds)” in the admin console | limits.execution_timeout_seconds |
| Connection slot | A slot for a connection, settled in the contract. The project assigns a connector to it | connection_slots |
Steps and placements
| Word on screen | Meaning | Name in records and settings |
|---|---|---|
| Step settings | The parameters, connections and input bindings for each placement in a workflow | |
| Parameters | Values for the contract's settings items. Only the items you enter a value for are saved; blank ones keep the agent's default values | |
| Input bindings | Binding the output of a preceding step to this agent's input file | |
| Environment variables (cycles) | The environment variables passed for each placement in a cycle | |
| Environment variables users cannot override (deny list) | Names that cannot be changed in a placement, set by an administrator for each registered agent | placement_env.denied_names |
Cases
| Word on screen | Meaning | Name in records and settings |
|---|---|---|
| Case | One run of a workflow with registered agents placed | project_runs |
| Start case | The operation that starts a case from the screen. Corresponds to the SaaS edition's “Run now” | |
| Instruction files | Editable text files entered when a case starts | |
| Case settings / Settings revision | The parameters, connections and files for each case, and their versions | |
| Artifacts & files | The agent's outputs and the versions people have edited | |
| Version passed to the next step | The version of an artifact used as the input of the next step | |
| Cancelling a case | The operation that stops a case. Corresponds to cancelling a run in the SaaS edition | |
| Waiting to launch / Launching / Launched / Launch failed / Cancelled | The launch status of a step's agent | pending / leased / dispatched / failed / cancelled |
Reviews
| Word on screen | Meaning | Name in records and settings |
|---|---|---|
| External wait | A review method that moves on to the next step according to the state of an external service | wait_source: external |
| External condition | What has to hold for it to move on. For now, only “GitLab MR merged” | gitlab.mr_merged |
| Connection used to check it | The connector read to check the external condition | |
| Output that identifies the target | The previous step's JSON output identifying the target (MR) of the external condition | gitlab_project_id, mr_iid, expected_head_sha |
| Advanced on an external condition | A decision by which the platform moved it on because the external condition held | decided_by: system |
| External-wait webhook secret | The secret for accepting GitLab webhooks | connect_secret |
| Review content version | The version of the case settings and artifacts the reviewer decides on |
Records
| Word on screen | Meaning | Name in records and settings |
|---|---|---|
| Run ended (completion not measured) / Not measured | An execution in which a cycle agent ended normally but did not report whether it completed | runner_exited |
| Runtime image | The container image that ran in that execution | |
| Case Config Changed | The record made when the case settings are saved as a new version | |
| Service account | A client created in the admin console for calling the external API |