Skip to content

Latest commit

 

History

History
126 lines (88 loc) · 2.52 KB

Configuration.pod

File metadata and controls

126 lines (88 loc) · 2.52 KB
Raw

Configuration Description =pod

Workflows

workflow:

   workflow
      type        $
      description $
      persister   $
      state       \@
          name          $
          description   $
          action        \@
              name            $
              resulting_state $
              condition       \@
                  name $

  • the 'type' and 'description' keys are at the top level

  • the 'extra_data' key holds an array of zero or more hashrefs with 'table', 'field', 'class' and 'context' keys

  • 'state' key holds array of one or more 'state' declarations; one of them must be 'INITIAL'

  • each 'state' declaration holds 'description' and 'name' keys and multiple 'action' declarations

  • each 'action' declaration holds 'name' and 'resulting_state' keys and may hold a 'condition' key with one or more named conditions

Conditions

conditions:

   condition \@
      name  $
      class $
      param \@
          name  $
          value $

  • array of one or more hashrefs with 'name' and 'class' keys

Validators

validators:

   validator \@
      name  $
      class $
      param \@
          name  $
          value $

  • array of one or more hashrefs with 'name' and 'class' keys, plus possibly one or more 'param' hashrefs each with 'name' and 'value' keys

Actions

actions:

  action \@
     name  $
     field \@
        name         $
        is_required  yes|no
        type         $
        source_list  \@ of $
        source_class $
        param        \@
            name  $
            value $
     validator \@
         name $
         arg  \@
             value $

  • array of one or more action hashrefs with 'name', 'class' and 'description' keys

  • each 'action' may have zero or more values used to fill it; each value has a 'name', 'description' and 'necessity' ('required' or 'optional')

  • each 'action' may have any number of 'param' hashrefs, each with 'name' and 'value'

  • each 'action' may have any number of 'validator' hashrefs, each with a 'name' key and array of 'arg' declarations

Persisters

persister:

   extra_table   $
   extra_field   $
   extra_class   $
   extra_context $

AUTHORS

Chris Winters <chris@cwinters.com>, original author.

Jonas B. Nielsen (jonasbn) <jonasbn@cpan.org>, current maintainer.