Skip to content
SurogateDocs

Keel glossary

Every Keel term in one place. Concepts explains how they fit together.

TermDefinition
AgentA Surogate agent of the project, made in Studio. It can work a step, draft a step for a person, take work items as a queue member or a delegate, or start cases as an intake agent.
Agent questionAn agent’s raised hand as it shows in work lists.
Alternate stageA stage off the primary path, such as Withdrawn, that a case reaches only when an outcome, a case event or a supervisor sends it there.
Authority limitThe most a person or an agent may approve in a scope. Supervisors set it on the Team page.
Authority checkA step’s rule that whoever completes it needs a limit in a scope at least as large as an amount field.
BuilderA member of the project in Surogate Studio, who signs in to Keel Builder as an owner, editor or viewer.
Business appThe Keel app where staff and supervisors work cases.
Business timeTime that counts only working hours on working days, by the case type’s calendar.
CalendarA project’s working days, working hours, holidays and time zone. A case type can use one.
CaseOne running instance of a case type version, with its data, files and history.
Case agentThe project’s helper that answers a person’s questions about one case or one process instance, and fills in their form when they ask. It never submits.
Case eventA named signal another system sends to a case. A wait for it moves on; otherwise the case type’s event of that name fires.
Case numberThe case type’s number prefix and a count, such as LR-000001.
Case typeThe definition of one kind of case: its fields, stages, flows, forms and settings. Versioned.
CheckA condition a step’s result must meet, with the message people see when it does not.
ClaimTaking an unclaimed item from one of your queues, so it is yours.
ConditionAn expression in CEL over the case’s fields, used by checks, decisions, rules, waits and optional actions.
ConnectionAnother system a case type’s system steps call: its base URL, authentication and credential.
CredentialThe secret a connection sends. Set on the published connection, never shown again.
DecisionA node that picks a branch from conditions over the case’s data.
DelegateHanding an item you hold to someone else on the staff, or to an agent.
Designer agentThe project’s helper that drafts case types and processes with a builder in Keel Builder, in the open draft. It never publishes.
DraftA set of changes to the project’s definitions, not live until published.
Dry runEvery publish check and scenario, run on a draft without publishing it.
EffectWork Keel does outside a case after a transition: starting an agent, or calling a system.
EscalationAn item that opens in a queue when a service level’s deadline passes. The step stays with whoever works it.
FieldOne piece of a case’s data, with a name, a label and a type.
FlowThe nodes of a stage and how its outcomes connect them.
FormWhat a person fills to start a case or complete a step, made from fields and laid out on the Forms tab.
Get nextThe button that gives you the first item of Needs me, or else the next unclaimed item of your queues.
HelperOne of the two agents Keel sets up for each project: the case agent and the designer agent. A helper never works a step or a work item.
InstanceOne run of a BPMN process version, numbered P-000001 and up in its project. It runs on the version it started on until it is moved to the process’s current version.
Intake agentAn agent allowed to start cases of a case type.
JoinA node that waits until every path leading to it has arrived.
Maker-checkerA step’s rule that it must be done by someone other than whoever did named earlier steps.
MappingThe part of a draft that says where the open cases of an older version go in the new version.
Needs attentionThe Overview’s list of agents, waits and queues a supervisor should look at, each with a link to where to act.
Needs meThe list of work you hold, on the Work page.
Number prefixThe start of a case type’s case numbers.
Optional actionA step people can start from a case’s header, where the case type allows it.
OutcomeHow a step, vote or wait ends, and where the case goes from there.
OverviewThe supervisors’ page of the business app: the project’s figures, what needs attention, its case types and where cases wait. See The Overview.
Parallel splitA node that starts several paths at once.
PerformerWho does a step: an agent, a person or a queue, an agent with a person, or a system.
Pinned ruleA rule each case keeps at the version in effect when it started.
Primary stageA stage of the normal path, shown as a column on the board.
PriorityA queue’s place among queues for Get next: lower numbers first.
ProcessA BPMN 2.0 file among the project’s definitions, processes/<key>.bpmn, published through drafts and run beside case types. See BPMN processes.
Process agentThe case agent, on a process instance’s page, where it answers about the instance and fills in the form of a task you hold when you ask. It never submits.
PublishMaking a draft live. Each changed case type gets a new version.
QueueA team’s shared list of work, with a serving order and a priority.
Raised handAn agent’s question to a person, which pauses its step until someone answers.
ReassignA supervisor giving an open work item, other than a vote, to someone on the staff or to an agent.
ResolutionHow a case closed, such as approved or completed.
RuleA decision table or scorecard, versioned by when each version takes effect.
Rule nodeA node that runs a rule and writes its results into fields.
ScenarioA stored test of a case type: how a case starts, what happens, and what must hold.
ScopeThe name of a kind of authority, such as lending.
Serving orderThe order in which a queue hands out work: kinds first, then oldest or nearest deadline.
Service keyA key another system uses to start cases and send case events in the project.
Service levelA goal and a deadline on a step, a stage or a case, with an optional queue to escalate to.
SessionAn agent’s run of one step or work item, with a record of what it did. Watch shows an agent’s own step read-only; builders list an agent’s sessions on the Agents page.
StaffThe people of a project who sign in to the business app.
StageA phase of a case. A case is always in one stage.
StepWork in a stage, done by its performer, which ends with an outcome.
Stuck timerA process instance’s timer whose firing failed. It is never fired again; the instance shows why, and a supervisor cancels the instance.
SupervisorStaff who also run the Team page, read the Overview and move cases by hand.
VersionOne published state of a case type. A case stays on the version it started on unless it is moved.
VoteA step decided when enough members of a queue choose the same outcome.
WaitA node that holds a case until an event, a time or a condition, with an optional limit.
WarningSomething the checks found that Keel ignores and never runs, such as a vendor extension in a process file. It never stops a publish.
WatchThe read-only view of an agent’s session on a step.
Work itemAn item in someone’s work or a queue: a step, a vote, an agent question or an escalation.