Scale Intelligence■ Docs
Docs / The model / Source

Source.

Anywhere the market is read, with its rights and its role

Figure 1Sourcespecified
SOURCErow at platform scopenametextmarkettextjurisdictiontextrightsRightsroleenum:owns the record|a copy of …copy_ofSourceoptionalunknown makes the source not ready with the reason (SR-0730)legality_tierenum:1|2|3|not allowed|unknowncaptured is when the source or an exporter took the reading, imported when it entered the system that held it, retrieved when it was fetched from that systembasis_of_timesenum:published|scheduled|first …stateReadinessthe law or rule that forces the source to publish, where one does; a register a regulator keeps names itforced_open_bytextoptionalRIGHTSthrough rightsREADINESSthrough state
Source 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
sources

Fields#

fieldtyperequirednote
nametextyes
markettextyes
jurisdictiontextyes
rightsRightsyes
roleone of owns the record | a copy of another platform's reading | a one-off catch-up | derived from other sources | a tenant's own | an extract with no chain of custodyyes
copy_ofSourceno
legality_tierone of 1 | 2 | 3 | not allowed | unknownyesunknown makes the source not ready with the reason
basis_of_timesone of published | scheduled | first seen | captured | imported | retrievedyescaptured is when the source or an exporter took the reading, imported when it entered the system that held it, retrieved when it was fetched from that system
stateReadinessyes
forced_open_bytextnothe law or rule that forces the source to publish, where one does; a register a regulator keeps names it

Routes that use it#

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