---
structure:

  create_profile_wizard_options:
    snapons:
      # foreach snapon instance
      name:                               string
      label:                              string
      snapon:                             string
      parameters:
      parameters_form:
      prompt_to_attach:                   bool
      default:                            bool

infos:

  - name:               snapons
    comment:            Log format plug-ins can cause one or more snapons to be
                        attached when the profile is created. This is done by
                        adding a subnode "snapons" of
                        create_profile_wizard_options. This node has one
                        subnode (the snapon instance description) for each
                        snapon instance to be attached. Note, it is possible to
                        attach the same snapon multiple times with different
                        parameter values.

  - name:               name
    comment:            The internal name of the snapon instance to create.

  - name:               label
    comment:            The label of the snapon instance to create.

  - name:               snapon
    comment:            The name of the snapon to attach.

  - name:               parameters
    comment:            |
                        Zero, one or more parameters as defined in
                        snapon.parameters.yaml with following exceptions:
                        The validation_type "field_label", "report_label,
                        "report_group_labe" and "snapon_label" are not
                        supported in the new profile wizard because we don't
                        know all fields, reports, etc. before the profile
                        becomes created and do not create the required
                        "final_node_name" node which is required when the
                        snapon becomes attached.

                        Parameters defined in the log format plug-in overrides
                        the snapon parameters.

  - name:               parameters_form
    comment:            Zero, one or more parameters_form groups as defined in
                        snapon.parameters_form.yaml. The parameters_form
                        defined in the plug-in replaces the
                        snapon paramters_form, respectively the parameters_form
                        of the snapon is always ignored!

  - name:               prompt_to_attach
    comment:            When true, the Create Profile Wizard will prompt
                        whether to attach this snapon instance. When false, the
                        instance will be attached without prompting.

  - name:               prompt_to_attach_default
    comment:            This defines the prompt_to_attach default behavior.
                        When true, and prompt_to_attach is true, the default
                        will be to attach (i.e., the prompt checkbox will be
                        checked).  When false, the prompt checkbox will be
                        unchecked.
...

  # Additional information

  #
  # Snapon parameter prompting in the New Profile Wizard
  #

  Snapon parameter prompting in the New Profile Wizard is defined in the same
  way as attaching snapons in Config via the parameters_form node. The
  following table shows when the new profile wizard prompts for parameters.

  A = snapon parameters_form is defined
  B = plug-in parameters_form

  If NOT A and NOT B:   Don't prompt
  If A and NOT B:       Don't prompt

  If A and B:           Prompts as defined in the plug-in.
                        The snapon parameters_form is ignored.

  If NOT A and B:       Prompts as defined in the plug-in.



  #
  # Standard Snapons
  #

  If no snapons are specified in a plug-in, the function
  add_standard_reports() is called to add the standard reports, 8.0-style.
  If snapons are specified, and standard reports are desired, they should be
  added explicitly using the add_standard_reports snapon:

  add_standard_reports = {

    name = "add_standard_reports"
    label = "add_standard_reports"
    snapon = "add_standard_reports"

  } # add_standard_reports

  The internal_optimize snapon is also always attached automatically.
  Finally, if field_info in the plug-in indicates session information, the
  sessions snapon is attached automatically.


  # Example node
  log_formats/log_format_name = {

    create_profile_wizard_options = {

      ...

      snapons = {

        concurrent_connections = { # Attach a concurrent_events snapon to compute concurrent connections

          name = "concurrent_connections"
          label = "$lang_stats.snapons.flash_media_server.concurrent_connections_label"
          snapon = "concurrent_events"

          parameters = {
            date_time_field.parameter_value = "date_time"
            duration_field.parameter_value = "x_duration"
            concurrent_events_name = {
              parameter_value = "$lang_stats.snapons.flash_media_server.concurrent_connections_field"
              final_node_name = "concurrent_connections"
            } # concurrent_events_name
          } # parameters

        } # concurrent_connections

        another_snapon = {

          name = "another_snapon"
          label = "Another snapon"
          snapon = "double_hits"

        } # another_snapon

      } # snapons

    } # create_profile_wizard_options

  } # log_format_name