Skip to main content

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 screenMeaningName in records and settings
Registered agentAn agent built as a container image, registered by an administrator under “Marketplace AI Agents” in the admin consoleruntime_kind: marketplace
Use in workflowsThe admin console setting that lets a registered agent be placed on workflow steps. Turn it on and register a contractworkflow_contract
ContractThe agreement on the parameters, files, artifacts and connections a registered agent receives, its effect on external systems and its execution limitworkflow_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 workflowcertification
Supported run rulesThe basic rules (Open / Guarded / Strict) the agent supports. One of the certification detailssupported_policies
Effect on external systemsRead only / Writes (safe to retry) / Writes (retry may duplicate). “Effect mode” in the admin consoleeffect_mode (read_only / idempotent_write / non_idempotent_write)
Execution limitThe time limit for one execution. “Execution timeout (seconds)” in the admin consolelimits.execution_timeout_seconds
Connection slotA slot for a connection, settled in the contract. The project assigns a connector to itconnection_slots

Steps and placements​

Word on screenMeaningName in records and settings
Step settingsThe parameters, connectors and input bindings for each placement in a workflow
ParametersValues 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 bindingsBinding 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 agentplacement_env.denied_names

Cases​

Word on screenMeaningName in records and settings
CaseOne run of a workflow with registered agents placedproject_runs
Start caseThe operation that starts a case from the screen. Corresponds to the SaaS edition's “Run now”
Instruction filesEditable text files entered when a case starts
Case settings / Settings revisionThe parameters, connectors and files for each case, and their versions
Artifacts & filesThe agent's outputs and the versions people have edited
Version passed to the next stepThe version of an artifact used as the input of the next step
Cancelling a caseThe operation that stops a case. Corresponds to cancelling a run in the SaaS edition
Waiting to launch / Launching / Launched / Launch failed / CancelledThe launch status of a step's agentpending / leased / dispatched / failed / cancelled

Reviews​

Word on screenMeaningName in records and settings
External waitA review method that moves on to the next step according to the state of an external servicewait_source: external
External conditionWhat has to hold for it to move on. For now, only “GitLab merge request merged”gitlab.mr_merged
Connection used to check itThe connector read to check the external condition
Output that identifies the targetThe previous step's JSON output identifying the target (MR) of the external conditiongitlab_project_id, mr_iid, expected_head_sha
Advanced on an external conditionA decision by which the platform moved it on because the external condition helddecided_by: system
External-wait webhook secretThe secret for accepting GitLab webhooksconnect_secret
Review content versionThe version of the case settings and artifacts the reviewer decides on

Records​

Word on screenMeaningName in records and settings
Run ended (completion not measured) / Not measuredAn execution in which a cycle agent ended normally but did not report whether it completedrunner_exited
Runtime imageThe container image that ran in that execution
Case Config ChangedThe record made when the case settings are saved as a new version
Service accountA client created in the admin console for calling the external API

Action needed​

Word on screenMeaningName in records and settings
Action neededThe list of things that need a person. Eight kinds, ordered by priority (P1 to P4)
Waiting on externalA kind of action-needed row: a review waiting on an external condition whose connector state cannot be read before the review deadline (after the deadline it becomes “Overdue”)external_wait_blocked
Past deadline (run)A kind of action-needed row: a case not finished after its deadlinerun_deadline_overdue
StalledA kind of action-needed row: a running case that has not progressed after the “hours before a run counts as stalled” (a case past its deadline appears as “Run deadline exceeded”)run_stalled
Kind of reviewThe kind of review step: “Review” (a person judges the Agent's result) or “Manual work” (a person does the work, then proceeds)review / manual
Delegate for review requestsA personal setting that hands review decisions to one person in the same organization while you are away

Different names for the same thing​

The left column is the word this documentation uses. The screens basically show the same word, but in some places they show a different one.

WordHow it may appear on screen
A case starting at a set timeScheduled
A run of a cycle's sweepScheduled run
The decision that advances a review requestApproved (to the next step), Approved (case completed). One that advanced on an external condition shows “Advanced on an external condition”
The result “Completed”Completed normally (KPI)
A case (a workflow's run)“Case”, in descriptions on the screens and elsewhere

Similar but different​

WordEasily confused withDifference
ExecutionCaseAn execution is one run of a registered agent; it appears in Execution history and opens as an execution record. A case is one run of a workflow and appears in Workflow history
Execution recordRecords (audit trail)An execution record is the details of one execution. Records (audit trail) is a list of set operations and events inside the project
An execution's result (Completed, Failed, Timed out, and so on)A case's state (running, awaiting review, completed, failed, rejected, cancelled)They appear in different columns. The unit that is counted differs
Review requestAwaiting reviewA review request is the request itself that reaches the reviewer. Awaiting review is the state of not yet being decided
ReviewApprovalReview is the general act of looking at the content and deciding. “Approved” is the screen word for a decision a reviewer made to proceed. One that advanced on an external condition shows “Advanced on an external condition” and is not an approval
Basic ruleTenant-wide basic ruleThe basic rule is what you choose in the project. The tenant-wide basic rule is decided for the whole tenant, and the stricter one becomes the run's basic rule
Review stepRun by AgentKinds of step. No agent runs on a review step; the reviewer decides. A registered agent is placed on a “Run by Agent” step
ScheduledScheduled runBoth mean it started at a set time. “Scheduled” appears for a workflow, and “Scheduled run” on the execution record of a cycle's sweep
“Resume” (top of the project screen)Resuming a closed case“Resume” at the top starts a paused project again. To redo a closed case, start a new case
Review deadline (a review request)Deadline (a case)A review deadline is set per review request. It does not decide automatically when it passes. A deadline is set per case; the case does not stop when it passes, and it only appears in “Action needed” and in notifications
Awaiting review (a kind of action needed)Awaiting review (a case's state)“Awaiting review” in “Action needed” is the row of a review request not yet decided. A case's “Awaiting review” is the state of a case waiting for a decision
StepRegistered agentA step is where registered agents are placed, and the unit of the project's flow. A registered agent is a container agent the administrator registered