Skip to main content

Signals Registry

Global catalog of signals used across ZAYAZ engines, micro-engines, and modules.

This registry lists:

  • Universally addressable signal names
  • Their data types
  • Descriptions
  • Origin source tables

Example:

  {
"signal_name": "iso_cc_id",
"signal_type": "string",
"signal_description": "Internal surrogate key for ISO country record",
"source_table": "dim_countries",
"source_file": "countries.xlsx",
"family": "id",
"status": "stable",
"used_by_engines": ["zhif", "pef-me"],
"used_by_modules": ["sem"],
"example": ["iso-028"]
}
Signal NameTypeDescriptionSource Table
acl_tagsJSONBArray of policy tags for enforcement (e.g., ['EU_ONLY','NO_PHI']). Validated against ACL Tag Registry (acl_tag_registry).compute_method_registry
alb_dnsstring / aws_alb_dnsAWS-generated DNS name of the regional Application Load Balancer serving this API region. Used as the Cloudflare CNAME target. May be empty until ingress is provisioned.residency_region_policy
apistring / dns_hostnameRegional API hostname used for tenant routing (e.g. api.eu-north-1.zayaz.io). This is the externally visible ingress endpoint.residency_region_policy
aws_regionstring / aws_regionHuman-readable AWS region name and code describing the physical deployment location (e.g. Europe (Stockholm) eu-north-1).residency_region_policy
caller_ipTEXTSource IP for security / anomaly analysis.compute_executions
created_atTIMESTAMPTZRow creation timestamp (UTC).compute_method_registry
created_atTEXTExecution timestamp (UTC).compute_executions
created_attimestamptzTimestamp when the framework record was createdstandards_frameworks
created_attimestamptzTimestamp when the criterion was createdstandards_criteria
created_attimestamptzTimestamp when the tenant-framework link was createdtenant_frameworks
criterion_idstring (pk)Canonical identifier of a policy criterion (e.g. ESRS.data_residency.eu_only)standards_criteria
criterion_idstringCriterion identifierframework_criteria_latest
dataset_hashesTEXTArray/map of dataset artifact hashes used (e.g., ['IPCC-EFDB:sha256-...','IEA_SSP:sha256-...']).compute_executions
dataset_requirementsJSONBArray/object describing required datasets/refs, e.g. ['IPCC-EFDB','IEA_SSP']. Validated against dataset_key registry.compute_method_registry
default_countriesjson / iso_country_listList of ISO-3166-1 alpha-2 country codes that default to this AWS region during tenant onboarding. Used for suggestion only, not enforcement.residency_region_policy
descriptionTEXTHuman-readable summary of what the method computes and when to use it.compute_method_registry
descriptionstringTextual description of scope and purpose of the frameworkstandards_frameworks
descriptionstringHuman-readable explanation of the criterionstandards_criteria
descriptionstringCriterion descriptionframework_criteria_latest
dr_encryptionstring / encryption_policyRequired encryption standard for all DR copies (e.g. sse_kms_required). Applies to both SR and RR modes.residency_region_policy
dr_region_rrstring / aws_region | nullDisaster recovery region used under Resilient Residency (RR) mode. May be cross-zone if explicitly allowed. null when RR is not supported for this primary region.residency_region_policy
dr_region_srstring / aws_regionDisaster recovery region used under Strict Residency (SR) mode. Must remain inside the same residency zone. May equal the primary region in single-region zones.residency_region_policy
effective_fromtimestamptzValid from dateresidency_region_policy
effective_totimestamptzDate of deprecationresidency_region_policy
engineenumRule evaluation engine (jsonlogic, cel)standards_criteria
engineenumRule engine usedframework_criteria_latest
error_codeTEXTMachine-readable error code if status='error' (e.g., SCHEMA_VALIDATION_FAILED).compute_executions
exec_idstring (pk)Globally unique execution ID (ULID). Primary key.compute_executions
framework_idstring (pk)Canonical identifier of a standards framework (e.g. ESRS, ISSB, SEC). Globally stable and later usable as a USO concept anchor, a policy routing key in TR/PG, a compliance scope discriminator in ZADIFstandards_frameworks
framework_idstring (fk)Reference to owning standards frameworkstandards_criteria
framework_idstring (pk, fk)Framework enabled or disabled for the tenanttenant_frameworks
framework_idstringFramework identifierframework_criteria_latest
implementation_refTEXTResolvable entrypoint, e.g. python://zayaz.compute.ghg:intensity_v1 or container/image ref. Loader imports/calls this.compute_method_registry
inputs_hashTEXTCryptographic hash (e.g., sha256:...) of normalized input payload.compute_executions
inputs_schema_jsonTEXTZAR artifact ID for JSON Schema describing required/optional input fields and constraints (units, mins, enums). Enforced at runtime.compute_method_registry
latency_msTEXTEnd-to-end compute latency in milliseconds.compute_executions
method_idTEXT (PK)Surrogate ID for the compute method, e.g. MID-00001. Used as stable contract ID across ZAYAZ.compute_method_registry
method_idTEXTMethod name (e.g., GHG.intensity, Water.abs). Primary key; one 'latest' row per method.compute_method_latest
method_idTEXTMethod ID (e.g., MID-00001). FK part 1 → ref_compute_method_registry.method_id.compute_executions
method_nameTEXTCanonical method name, e.g. GHG.intensity, Water.abs. Human/machine-friendly semantic identifier.compute_method_registry
namestringHuman-readable name of the standards frameworkstandards_frameworks
noteTEXTAdmin/operator note explaining why this version is latest (e.g., 'post–gate promotion', 'hotfix').compute_method_latest
notesstringTenant-specific annotations or governance notestenant_frameworks
notesstring / governance_notesRationale and governance notes explaining regional constraints, DR strategy, and compliance considerations. Intended for auditors, architects, and operators.residency_region_policy
options_hashTEXTCryptographic hash of normalized options payload.compute_executions
options_schema_jsonTEXTZAR artifact ID for JSON Schema describing optional method options (e.g., jurisdiction, scope3_category). May point to a trivial {} schema.compute_method_registry
output_hashTEXTCryptographic hash of normalized output payload. Optional if execution failed pre-output.compute_executions
output_schema_jsonTEXTZAR artifact ID for JSON Schema describing method output payload (e.g., result, unit, provenance). Enforced post-compute.compute_method_registry
primary_regionstring / aws_regionAWS region used as the tenant’s primary data and compute location under normal operation.residency_region_policy
provenance_idTEXTCorrelation ID returned to caller; links UI/API to this audit row.compute_executions
regionTEXTRegion tag where compute ran (e.g., eu-north-1).compute_executions
region_notestring / descriptive_labelHuman-readable short description of the region for internal clarity (e.g. AF Cape Town, AP Tokyo).residency_region_policy
rr_allowedboolean / policy_flagIndicates whether Resilient Residency (cross-zone emergency DR) is permitted for this primary region.residency_region_policy
rrp_idstring / identifierUnique identifier for the residency region policy record. Used for traceability, versioning, and audit references.residency_region_policy
rule_jsonjsonbSerialized rule definition executed by the policy enginestandards_criteria
rule_jsonjsonbLatest executable rule definitionframework_criteria_latest
s3_linkstring / aws_s3_bucket_refCanonical S3 bucket identifier used for tenant production data in this primary AWS region (e.g. zyz-td-eu-north-1).residency_region_policy
secondary_regionstring / aws_regionAWS region used for high availability or fast recovery. Must always remain within the same residency zone as the primary region.residency_region_policy
severityenumEnforcement level (block, warn, info)standards_criteria
severityenumEnforcement severityframework_criteria_latest
statusTEXTLifecycle state: supported | beta | deprecated. Used by discovery and allowlists.compute_method_registry
statusTEXTok | error. Final outcome.compute_executions
statusenumLifecycle status of the framework (supported, beta, deprecated)standards_frameworks
statusenumEnablement state (enabled, disabled)tenant_frameworks
storage_refTEXTPointer to sealed blob with full input/output snapshots if retained.compute_executions
tenant_idTEXTTenant/customer identifier (used for multi-tenant isolation and audit).compute_executions
tenant_idstring (pk, fk)Tenant identifier (E-C-O™ Number or internal tenant key)tenant_frameworks
updated_atTIMESTAMPTZRow last update timestamp (UTC)compute_method_registry
updated_atTIMESTAMPTZTimestamp (UTC) when 'latest' pointer was last changed.compute_method_latest
updated_attimestamptzTimestamp when the framework record was last updatedstandards_frameworks
updated_attimestamptzTimestamp when the criterion was last updatedstandards_criteria
updated_attimestamptzTimestamp when the tenant-framework link was last updatedtenant_frameworks
updated_attimestamptzTimestamp of the latest criterion updateframework_criteria_latest
versionTEXTSemantic version of the method implementation and schema (e.g., 1.0.0). Enables side-by-side versions.compute_method_registry
versionTEXTVersion currently designated as 'latest' for this method (e.g., 1.1.0). FK to compute_method_registry(method_id, version).compute_method_latest
versionTEXTExact version used (e.g., 1.0.0). FK part 2 → ref_compute_method_registry.version.compute_executions
versionstringSemantic version of the criterion rulestandards_criteria
versionstringLatest version of the criterionframework_criteria_latest
vpc_cidstring / cidr_blockCIDR block allocated to the regional ingress VPC. Must be globally non-overlapping across all ZYZ regions.residency_region_policy
zonestring / residency_zoneLogical data residency zone representing the legal/policy boundary (e.g. eu, na, as, af, me, sa).residency_region_policy


GitHub RepoRequest for Change (RFC)