#
# unique_values snapon
#
# This snapon computes the number of unique values of a field.
#
# 2010-09-03 - GMF - 1.0 - Initial implementation
#

unique_values = {

	label = "$lang_admin.snapons.unique_values.label"
	comment = "$lang_admin.snapons.unique_values.comment"
	config_snapon_category = ""
	
	parameters = {
  
		source_field = {
       
			validation_type = "string"
      
			form_element_label = "$lang_admin.snapons.unique_values.parameters.source_field.form_element_label"
			form_element_type = "select"
			select_options_source = "database_fields"
      
			description = ""
    
		} # source_field
  	
		unique_field_name = {
  	  
			parameter_value = "$lang_admin.snapons.unique_values.parameters.unique_field_name.parameter_value"
		
			validation_type = "field_label"
			validate_field_label_for = {
				database_fields = true
				report_fields = true
			}
		
			form_element_label = "$lang_admin.snapons.unique_values.parameters.unique_field_name.form_element_label"
			form_element_type = "text"
			form_element_width = "380"
		
			description = "$lang_admin.snapons.unique_values.parameters.unique_field_name.description"
  		
		} # field_name
    
	} # parameters
  
  
	parameters_form = {

		group_1 = {
			description = "$lang_admin.snapons.unique_values.parameters_form.group_1.description"
			parameters = {
				source_field = true
				unique_field_name = true
			} # parameters
		} # group 1

	} # parameters_form


	attach_operations = {

		# When attaching: Add the unique_values database field
		add_unique_values_database_field = {
			type = "add_database_fields"
			fields = {			
				"{= @parameters{'unique_field_name'}{'final_node_name'} =}" = {
					label = "{= @parameters{'unique_field_name'}{'parameter_value'} =}"
					type = "unique"
					log_field = "{= @parameters{'source_field'}{'parameter_value'} =}"
					derivation_method = "log_field"
					category = ""
					aggregation_method = "unique"
					index = "true"
					suppress_top = "0"
					suppress_bottom = "2"
					integer_bits = "0"
				} # unique_values
			} # fields
		} # add_unique_values_database_field

		# When attaching: Add the unique_values report field
		add_unique_values_report_field = {
			type = "add_report_fields"
			fields = {			
				"{= @parameters{'unique_field_name'}{'final_node_name'} =}" = {
					label = "{= @parameters{'unique_field_name'}{'parameter_value'} =}"
					column_label = ""
					column_info = ""
					database_field = "{= @parameters{'unique_field_name'}{'final_node_name'} =}"
					display_format_type = "integer"
					show_remainder_value = false
					show_average_value = true
					show_min_value = true
					show_max_value = true
					show_total_value = false
					percent_calculation = "sum"
				} # unique_values
			} # fields
		} # add_unique_values_report_field

		# When attaching: Add the unique_values field to all xref groups
		add_unique_values_xref_fields = {
			type = "add_xref_fields"
			xref_group = "*"
			fields = {
				"{= @parameters{'unique_field_name'}{'final_node_name'} =}" = "unique_values"
			} # fields
		} # add_unique_values_xref_fields

		# When attaching: Add the unique_values column to all report elements
		add_unique_values_report_column = {
			type = "add_report_element_columns"
			report = "*"
			report_element = "*"
			columns = {
				"{= @parameters{'unique_field_name'}{'final_node_name'} =}" = {
					report_field = "{= @parameters{'unique_field_name'}{'final_node_name'} =}"
					show_column = true
					show_percent_column = false
					show_bar_column = false
					show_graph = true
				} # unique_values
			} # columns
		} # add_unique_values_report_column

	} # attach_operations

} # unique_values