Diffo.Provider.Instance.Extension

DSL Extension customising an Instance.

Provides two top-level sections:

structure

Describes the static shape of the Instance kind — what it is, what values it carries, and what parties it relates to. All structure declarations are baked into the resource module at compile time via persisters and are introspectable at runtime via Diffo.Provider.Instance.Info or directly as generated functions on the resource module.

• specification do — the TMF Specification (id, name, type, version, description, category). The id is a stable UUID4 that is the same across all environments for this Instance kind.
• characteristics do — typed value slots carried by instances of this kind, each backed by an Ash.TypedStruct.
• features do — optional capabilities of this kind, each with its own typed characteristic payload and an enabled/disabled default.
• parties do — the party roles that instances of this kind relate to, with multiplicity, reference, and calculation options.
• places do — the place roles that instances of this kind relate to, mirroring parties do in structure and options.

behaviour

Declares which Ash actions should be wired for instance build lifecycle management. Currently supports create declarations; future sections will cover triggers and other lifecycle concerns.

Declaring create :name in behaviour do actions do causes the TransformBehaviour transformer to inject :specified_by, :features, and :characteristics arguments onto the named Ash create action. These arguments carry the UUIDs of the TMF entities created by build_before/1 and consumed by the Ash relationship management in the action.

See the DSL cheat sheet for the full DSL reference. See Diffo.Provider.BaseInstance for full usage documentation including generated functions.

structure

Defines the structural shape of the Instance — its specification, characteristics, features, parties, and places

Nested DSLs

• specification
• characteristics
  • characteristic
• features
  • feature
    • characteristic
• parties
  • party
  • parties
• places
  • place
  • places

Examples

structure do
  specification do
    id "da9b207a-26c3-451d-8abd-0640c6349979"
    name "DSL Access Service"
    type :serviceSpecification
  end

  characteristics do
    characteristic :circuit, Diffo.Access.Circuit
  end

  parties do
    party :provider, MyApp.Provider
  end

  places do
    place :installation_site, MyApp.GeographicSite
  end
end

structure.specification

Defines the Instance Specification

Examples

specification do
  id "da9b207a-26c3-451d-8abd-0640c6349979"
  name "DSL Access Service"
  type :serviceSpecification
  major_version 1
  description "An access network service connecting a subscriber premises to an access NNI via DSL"
  category "Network Service"
end

Options

structure.characteristics

List of Instance Characteristics

Nested DSLs

• characteristic

Examples

characteristics do
  characteristic :dslam, Diffo.Access.Dslam
  characteristic :aggregate_interface, Diffo.Access.AggregateInterface
  characteristic :circuit, Diffo.Access.Circuit
  characteristic :line, Diffo.Access.Line
end

structure.characteristics.characteristic

characteristic name, value_type

Adds a Characteristic

Arguments

structure.features

Configuration for Instance Features

Nested DSLs

• feature
  • characteristic

Examples

features do
  feature :dynamic_line_management do
    is_enabled? true
    characteristics do
      characteristic :constraints, Diffo.Access.Constraints
    end
  end
end

structure.features.feature

feature name

Adds a Feature

Nested DSLs

• characteristic

Arguments

Options

structure.features.feature.characteristic

characteristic name, value_type

Adds a Characteristic

Arguments

structure.parties

List of Instance Party roles

Nested DSLs

• party
• parties

Examples

parties do
  party :provider, MyApp.Provider, calculate: :provider_calculation
  parties :technician, MyApp.Technician, constraints: [min: 1, max: 3]
  party :owner, MyApp.InfrastructureCo, reference: true
end

structure.parties.party

party role, party_type

Declares a singular party role on this Instance

Arguments

Options

Introspection

Target: Diffo.Provider.Instance.Extension.PartyDeclaration

structure.parties.parties

parties role, party_type

Declares a plural party role on this Instance

Arguments

Options

Introspection

Target: Diffo.Provider.Instance.Extension.PartyDeclaration

structure.places

List of Instance Place roles

Nested DSLs

• place
• places

Examples

places do
  place :installation_site, MyApp.GeographicSite
  places :coverage_areas, MyApp.GeographicLocation, constraints: [min: 1]
  place :billing_address, MyApp.GeographicAddress, reference: true
end

structure.places.place

place role, place_type

Declares a singular place role on this Instance

Arguments

Options

Introspection

Target: Diffo.Provider.Instance.Extension.PlaceDeclaration

structure.places.places

places role, place_type

Declares a plural place role on this Instance

Arguments

Options

Introspection

Target: Diffo.Provider.Instance.Extension.PlaceDeclaration

behaviour

Defines the behavioural wiring for the Instance — actions, and in future triggers and tasks

Nested DSLs

• actions
  • create
  • update

Examples

behaviour do
  actions do
    create :build
    update :define
  end
end

behaviour.actions

Declares which actions to wire for instance behaviour

Nested DSLs

• create
• update

Examples

actions do
  create :build
  update :define
end

behaviour.actions.create

create name

Marks a create action for instance build wiring, injecting :specified_by, :features, and :characteristics arguments

Arguments

behaviour.actions.update

update name

Marks an update action for instance behaviour wiring

Arguments