#
# Page Field Snapon
#
# This snapon adds a "page" field, with two reports for hierarchical and non-hierarchical views of the page
#

page_field = {
 
  label = "$lang_admin.snapons.page_field.label"
  comment = "$lang_admin.snapons.page_field.comment"
  config_snapon_category = ""

  version = "1.0.1"

  # 2013-03-05 - GMF - 1.0 - Initial creation (based on aggregating_field)
  # 2013-03-07 - GMF - 1.0.1 - Fixed graph_type (made it pie)
  
  parameters = {
  
    field_name = {
    
      parameter_value = ""
      final_node_name = ""

#      compute_empty_parameter_value_from_final_node_name_as_field_name = true      

      validation_type = "field_label"
	  validate_field_label_for = {
	    database_fields = true
		report_fields = true
	  }
      
      form_element_label = "$lang_admin.snapons.page_field.parameters.field_name.form_element_label"
      form_element_type = "text"
	  form_element_width = "380"
      
      description = ""
    
    } # field_name

    report_group_name = {
    
      parameter_value = "New Report Group"
      final_node_name = "new_report_group"
      
      validation_type = "field_label"
	  validate_field_label_for = {
	    database_fields = true
		report_fields = true
	  }
      
      form_element_label = "$lang_admin.snapons.page_field.parameters.report_group_name.form_element_label"
      form_element_type = "text"
	  form_element_width = "380"
      
      description = ""
    
    } # report_group_name

#    category = {
#    
#      parameter_value = "string"
#      
#      form_element_label = "$lang_admin.snapons.page_field.parameters.category.form_element_label"
#      form_element_type = "text"
#	  form_element_width = "380"
#      
#      description = ""
#    
#    } # display_format_type
#
#    graph_type = {
#    
#      parameter_value = "pie"
#      
#      form_element_label = "$lang_admin.snapons.page_field.parameters.graph_type.form_element_label"
#      form_element_type = "text"
#	  form_element_width = "380"
#      
#      description = ""
#    
#    } # graph_type

  } # parameters

  parameters_form = {

    group_1 = {
      description = "$lang_admin.snapons.page_field.parameters_form.group_1.description"
      parameters = {
        field_name = true
        report_group_name = true
#        type = true
#        display_format_type = true
#        category = true
      } # parameters
    } # group 1
    
  } # parameters_form
  

  attach_operations = {

    # Add database field
    add_database_fields = {
      type = "add_database_fields"
      fields = {
        "{= @parameters{'field_name'}{'final_node_name'} =}" = {
          type = "string"
          category = "{= @parameters{'category'}{'parameter_value'} =}"
          suppress_bottom = "0"
          suppress_bottom = "9"
        } # {= @parameters{'field_name'}{'final_node_name'} =}
      } # fields
    } # add_database_fields

    # Add xref group
    add_xref_groups = {
      type = "add_xref_groups"
      xref_groups = {
        "{= @parameters{'field_name'}{'final_node_name'} =}" = {
          use_flat_table = false
          fields = {
            "{= @parameters{'field_name'}{'final_node_name'} =}" = ""
          } # fields
          add_all_aggregating_fields = true
        } # {= @parameters{'field_name'}{'final_node_name'} =}
      } # xref_groups
    } # add_xref_groups

    # Add report fields
    add_report_fields = {
      type = "add_report_fields"
      fields = {
        "{= @parameters{'field_name'}{'final_node_name'} =}" = {
          display_format_type = "page"
          subitems_level = "-1"
        } # {= @parameters{'field_name'}{'final_node_name'} =}
        "{= @parameters{'field_name'}{'final_node_name'} =}_directory" = {
          database_field = "page"
          display_format_type = "page"
          subitems_level = "0"
        } # {= @parameters{'field_name'}{'final_node_name'} =}_directory
      } # fields
    } # add_report_fields

    # When attaching: Add the reports.
    add_reports = {

      type = "add_reports"

      reports = {

        "{= @parameters{'field_name'}{'final_node_name'} =}" = {
          label = "{=capitalize(pluralize(expand(@parameters{'field_name'}{'parameter_value'})))=}"
          report_elements = {
            "{= @parameters{'field_name'}{'final_node_name'} =}" = {
              label = "{=capitalize(pluralize(expand(@parameters{'field_name'}{'parameter_value'})))=}"
              type = "table"
              sort_by = "MAIN_SORT_FIELD" # Sort this report by the main sort field, whatever that may be
              columns = {
                "{= @parameters{'field_name'}{'final_node_name'} =}" = {
                  report_field = "{= @parameters{'field_name'}{'final_node_name'} =}"
                } # {= @parameters{'field_name'}{'final_node_name'} =}
              } # columns
	      add_all_aggregating_columns = true
	      graph_main_field = true
              graphs.graph_type = "pie"
            } # {= @parameters{'field_name'}{'final_node_name'} =}
          } # report_elements
        } # {= @parameters{'field_name'}{'final_node_name'} =}

        "{= @parameters{'field_name'}{'final_node_name'} =}_directory" = {
          label = "$lang_stats.miscellaneous.pages_directories"
          report_elements = {
            "{= @parameters{'field_name'}{'final_node_name'} =}_directory" = {
              label = "{=capitalize(pluralize(expand(@parameters{'field_name'}{'parameter_value'})))=}"
              type = "table"
              sort_by = "MAIN_SORT_FIELD" # Sort this report by the main sort field, whatever that may be
              columns = {
                "{= @parameters{'field_name'}{'final_node_name'} =}" = {
                  report_field = "{= @parameters{'field_name'}{'final_node_name'} =}_directory"
                } # {= @parameters{'field_name'}{'final_node_name'} =}
              } # columns
	      add_all_aggregating_columns = true
	      graph_main_field = true
              graphs.graph_type = "pie"
            } # {= @parameters{'field_name'}{'final_node_name'} =}
          } # report_elements
        } # {= @parameters{'field_name'}{'final_node_name'} =}

      } # reports

      reports_menu = {

        "{= @parameters{'report_group_name'}{'final_node_name'} =}" = {
          label = "{= @parameters{'field_name'}{'parameter_value'} =}"
          items = {
            "{= @parameters{'field_name'}{'final_node_name'} =}" = {
              label = "{= @parameters{'field_name'}{'parameter_value'} =}"
              report = "{= @parameters{'field_name'}{'final_node_name'} =}"
            } # {= @parameters{'field_name'}{'final_node_name'} =}
            "{= @parameters{'field_name'}{'final_node_name'} =}_directory" = {
              label = "$lang_stats.miscellaneous.pages_directories"
              report = "{= @parameters{'field_name'}{'final_node_name'} =}_directory"
            } # {= @parameters{'field_name'}{'final_node_name'} =}
          } # items
        } # "{= @parameters{'report_group_name'}{'final_node_name'} =}"
          
      } # reports_menu

    } # add_reports

  } # attach_operations
  
} # page_field