Skip to main content

Records Reference

This page gathers where the Marketplace edition differs from the SaaS edition for the record of operations inside the project (Records (audit trail)) and for exporting execution records. How to read records is in the Record Guide, and the list of events shared with the SaaS edition is in the SaaS Records Reference.

Events that are added​

EventWhen it is recorded
Case settings changeWhen a case's settings were made a new version
Moved on by the external condition being metIn a review waiting on an external condition, when the condition was met and the platform moved it to the next step (this is distinguished from a person's approval)
Branch decision / Branch asked a personRecorded the same as in the SaaS edition

Common events (kept in the records)​

These have the same names as in the SaaS edition and are also kept in the records of the Marketplace edition (confirmed from the code that writes the records).

Kindevent_type in the CSV
Review requested, decided, reminded, overdue, extended, reviewers reassignedgate.requested, gate.resolved, gate.due_soon, gate.overdue, gate.extended, gate.reassigned
Reviewers reassigned for a caserun.approvers_reassigned
Case started, could not start, deadline set, deadline passed, stalledrun.started, run.start_failed, run.deadline_set, run.deadline_overdue, run.stalled
Sending a notification (queued, sent, failed, unconfirmed)delivery.accepted, delivery.acked, delivery.failed, delivery.unconfirmed
Viewing a body, exporting an execution recordforensic.viewed, forensic.exported
Definition changed, submitted for approval, approved, rejected, withdrawnproject.definition_changed, project.definition_submitted, project.definition_approved, project.definition_rejected, project.definition_withdrawn
Run rules, members, or roles changedpolicy.changed
A Branch decision, a Branch that asked a personbranch.decided, branch.asked_human
A completion report that was ignored because it was for a case that had already closed or for an old attemptcompletion.stale
Definition exported, imported, template, external access, ownership transferred, deletedproject.exported, project.imported, project.template_published, project.template_unpublished, project.created_from_template, project.exposure_changed, project.ownership_transferred, project.deleted

These events exist only in the Marketplace edition. Operations that a registered agent reports through the SDK (tool.invoked, tool.effect, tool.denied) are also kept in the records. context.manifest is stored, but it does not appear on the records screen or in the records CSV. They are not a record of operations the platform stops one by one; they are what the agent itself reported.

event_typeWhen it happens
case.config.changedA case's settings were made a new version (Case settings change)
artifact.createdAn artifact was created (an agent's output, or a person's edited version)
gate.observed_externalIn a review waiting on an external condition, the connector's state was read

Records (audit trail) CSV​

“Export CSV” outputs the records of the kind you are viewing, up to 5000 rows. A reason is required, and it is kept in the record just like viewing a body. The columns are as follows.

ColumnContent
occurred_atThe time (UTC)
event_typeThe kind of event
actorA person's name for a user; otherwise the name of the mechanism that recorded it, or the kind of actor
decisionThe value of a decision or judgment
reasonThe reason
stepThe step name
workitemThe title of the review request
run_idThe ID of the case (run)
root_execution_idThe ID of the execution
metadataReference information attached to the record (JSON)

Events that do not exist​

The following events do not appear in the records.

  • Expiry of a connection confirmation (gate.cancelled)
  • Resuming a run (run.resumed) and merging of parallel lanes (run.lane_joined)
  • Refusing a start by email (mail.rejected)
  • A call of External automation (automation.called)
  • A request to rerun a sweep (sweep.rerun_requested)
  • Consulting on and applying improvement suggestions (consult.*, improvement.applied)
  • Registering a library file or adding a new version (library.*)

What appears in execution records and exports​

An execution record shows the “execution environment image”. An export of execution records also shows the tag of the image that ran. For workflows it shows the image digest (sha256:…) the administrator certified; for cycles it shows the registry, the image name, and the tag.