Skip to content

Process

A Process describes the steps of a statistical process. Each process step can have inputs and outputs (references to other structures), a computation, transitions to other steps, and child steps nested inside it. Documents start ref: "Process=AGENCY:ID(1.0)".

Simple form

The minimal process body is a steps array in which each step has only a name. Process steps are always written as objects keyed by their id (see Identifiables); unlike items, a step with only an English name is not reduced to ID: "name".

format: "fusion-yaml(1.0.0)"
ref: "Process=ACY:PROC(1.0.0)"
name: "TEST"
steps:
- P1:
    name: "Step1"
    steps:
    - P11:
        name: "Sub Process"
- P2:
    name: "Process2"
Source: process/testEmptySteps.yaml (trimmed)

The document starts with the common header. The body is:

  • steps: the top level process steps, in process order. Child steps are written in a nested steps array inside their parent step, to any depth.

Complex form

A step gains fields for its inputs, outputs, computation and transitions.

format: "fusion-yaml(1.0.0)"
ref: "Process=ACY2:PROC(1.0.0)"
name: "TEST"
steps:
- P1:
    name: "Step1"
    input:
    - id: "IO"
      code: "ACY:CL_REF_AREA(1.0.0).UK"
    - id: "IO"
      dataflow: "ACY:DF_EXR(1.1.0)"
    output:
    - id: "IO"
      concept: "ACY:CONCEPTS(1.0.0).FREQ"
    - id: "IO"
      provisionagreement: "ACY:PA(1.1.0)"
    steps:
    - P11:
        name: "Sub Process"
        computation:
          id: "COMP1"
          description: "A Computation"
          description-fr: "La Comp"
          softwareLanguage: "JAVA"
          softwarePackage: "j"
          softwareVersion: "9.0"
        transition:
        - TT1:
            localId: "T1"
            targetStep: "P1"
            condition: "A Condition"
            condition-fr: "La Condition"
        - TT2:
            localId: "T2"
            targetStep: "P1.P11.P112"
            condition: "A Condition"
            condition-fr: "La Condition"
        steps:
        - P111:
            name: "Sub Process 1.1"
        - P112:
            name: "Sub Process 1.2"
- P2:
    name: "Process2"
Source: process/testFullProcess.yaml

  • Inputs and outputs (input, output) are arrays of plain objects (no id key). Each holds an optional local id, the referenced structure as a reference keyed by its lower case class (e.g. dataflow: "ACY:DF_EXR(1.1.0)", code: "ACY:CL_REF_AREA(1.0.0).UK"), and optional annotations.
  • Computation is a single object, written when the step has one.
  • Transitions (transition) are identifiables keyed by their id (TT1). Each holds an optional localId, the targetStep, the localised condition, and optional annotations and links. targetStep is the full id path of the target step from the top of the process, with step ids separated by . (e.g. P1.P11.P112).

Note

The field name transition is singular, although it is an array. It is part of the format version 1.0.0, and the reader expects this exact name.

Field reference

Process

Field Value Written when
steps Array of process steps The process has at least one step.

Process step

Each entry of steps is a single-key object STEP_ID: {...} with these fields, in this order:

Field Value Written when
name, name-xx Localised text The step has the name.
description, description-xx Localised text The step has the description.
uri String The step has a URI.
input Array of input / output objects The step has inputs.
output Array of input / output objects The step has outputs.
computation Computation object The step has a computation.
transition Array of transitions The step has transitions.
steps Array of child process steps, same layout The step has child steps.
annotations Annotations The step has annotations.
links Links The step has links.

Input / output

Field Value Written when
id String, the local id The input / output has a local id.
<class> (e.g. dataflow, code) Short URN of the referenced structure The input / output has a structure reference.
annotations Annotations The input / output has annotations.

Computation

Field Value Written when
id String, the local id The computation has a local id.
description, description-xx Localised text The computation has the description.
softwareLanguage String Set.
softwarePackage String Set.
softwareVersion String Set.
annotations Annotations The computation has annotations.

Transition

Each entry of transition is a single-key object TRANSITION_ID: {...} with these fields, in this order:

Field Value Written when
uri String The transition has a URI.
localId String The transition has a local id.
targetStep String, the full id path of the target step Always, for a valid transition.
condition, condition-xx Localised text The transition has the condition.
annotations Annotations The transition has annotations.
links Links The transition has links.

Reading notes

  • The structure type of an input or output is taken from its key (the lower case class), so no resolver is needed.