Scale Intelligence■ Docs
Docs / The model / Flow

Flow.

A kind of flow, as a row of the register: the only way a unit changes place or a new unit is made

Figure 1Flowspecified
FLOWrow at platform scopenametextmeaningtextunit_kindKindfrom_placetextoptionalto_placetextoptionalfor a flow that makes a factmakes_kindKindoptionalthe one part that emits itemitted_bytextplaneenum:tenant plane|work planeversion_of_shapecountwhat makes a repeat harmlessrepeat_ruletextretention_classRetentionClassthe typed reasons its outcomes may carry, each with its failure classreasons[text]KINDthrough unit_kindRETENTIONCLASSthrough retention_class
Flow is a row at platform scope. The drawing shows its fields and the objects that they point at.
kind
row
scope
platform
key
its name
store
postgres
family
kernel

Fields#

fieldtyperequirednote
nametextyes
meaningtextyes
unit_kindKindyes
from_placetextno
to_placetextno
makes_kindKindnofor a flow that makes a fact
emitted_bytextyesthe one part that emits it
planeone of tenant plane | work planeyes
version_of_shapecountyes
repeat_ruletextyeswhat makes a repeat harmless
retention_classRetentionClassyes
reasons[text]yesthe typed reasons its outcomes may carry, each with its failure class

Routes that use it#

No route takes or returns Flow directly. The record holds it, and the objects that point at it reach it.