# Copyright (c) 2010 Flowerfire, Inc.  All Rights Reserved.
net_key = {

  plugin_version = "1.0.2"

  info.1.manufacturer = "Netkey"
  info.1.device = "Netkey"
  info.1.version.1 = ""
 
  info.2.manufacturer = "NCR"
  info.2.device = "Netkey"
  info.2.version.1 = ""

  # 2004-04-28 - GMF - 1.0 - Initial creation.
  # 2010-10-04 - KBB - 1.0.1 - Tightened autodetect regular expression to prevent inaccurate detection.
  # 2011-07-07 - 1.0.2 - MSG - Edited info lines.

  # The name of the log format
  log.format.format_label = "NetKey Log Format"
  log.miscellaneous.log_data_type = "firewall"  
  log.miscellaneous.log_format_type = "other"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "[0-9][0-9]/[0-9][0-9]/[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9],[0-9a-f-]+,[^,]*,[^,]*,[^,]*,\\[[^,]*\\],[^,]*,[^,]*,[^,]*,[^,]*,"

  # Parse this data using a regular expression
  log.format.parsing_regular_expression = "([0-9/]+) ([0-9:]+),([0-9a-f-]+),([^,]+),([^,]+),([^,]+),([^,]*),([^,]*),([^,]*),([^,]*),([^,]*),([^,]*)"

  # Treat fields surrounded by square brackets (e.g. the date/time field) as a single quoted field.
  log.format.treat_brackets_as_quotes = "true"

  # Fields are separated by commas
  log.format.field_separator = ","

  # The format of dates and times in this log
  log.format.date_format = "mm/dd/yy"
  log.format.time_format = "hh:mm:ss"

  # Log fields
  log.fields = {

    date = {
      label = "$lang_stats.field_labels.date"
      type = "date"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # date

    time = {
      label = "$lang_stats.field_labels.time"
      type = "time"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # time

    session_id = {
      label = "$lang_stats.field_labels.session_id"
      type = "flat"
      index = 0
      subindex = 0
    } # session_id

    kiosk_id = {
      label = "$lang_stats.field_labels.kiosk_id"
      type = "host"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # kiosk_id

    ntk_filename = {
      label = "$lang_stats.field_labels.ntk_filename"
      type = "flat"
      index = 0
      subindex = 0
    } # ntk_filename

    object_type = {
      label = "$lang_stats.field_labels.object_type"
      type = "flat"
      index = 0
      subindex = 0
    } # object_type

    object_name = {
      label = "$lang_stats.field_labels.object_name"
      type = "flat"
      index = 0
      subindex = 0
    } # object_name

    event = {
      label = "$lang_stats.field_labels.event"
      type = "flat"
      index = 0
      subindex = 0
    } # event

    url = {
      label = "$lang_stats.field_labels.url"
      type = "page"
      index = 0
      subindex = 0
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "true"
    } # url

    info2 = {
      label = "$lang_stats.field_labels.info2"
      type = "flat"
      index = 0
      subindex = 0
    } # info2

    info3 = {
      label = "$lang_stats.field_labels.info3"
      type = "flat"
      index = 0
      subindex = 0
    } # info3

    info4 = {
      label = "$lang_stats.field_labels.info4"
      type = "flat"
      index = 0
      subindex = 0
    } # info4

  } # log.fields


  # Database fields
  database.fields = {

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      log_field = "date_time"
      type = "string"
      suppress_top = 0
      suppress_bottom = 3
      display_format_type = "date_time"
    } # date_time

    day_of_week = {
      label = "$lang_stats.field_labels.day_of_week"
      log_field = "day_of_week"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "day_of_week"
    } # day_of_week

    hour_of_day = {
      label = "$lang_stats.field_labels.hour_of_day"
      log_field = "hour_of_day"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "hour_of_day"
    } # hour_of_day

    kiosk_id = {
      label = "$lang_stats.field_labels.kiosk_id"
      log_field = "kiosk_id"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # kiosk_id

    ntk_filename = {
      label = "$lang_stats.field_labels.ntk_filename"
      log_field = "ntk_filename"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # ntk_filename

    url = {
      label = "$lang_stats.field_labels.url"
      log_field = "url"
      type = "string"
      suppress_top = 1
      suppress_bottom = 3
    } # url

    file_type = {
      label = "$lang_stats.field_labels.file_type"
      log_field = "file_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # file_type

    object_type = {
      label = "$lang_stats.field_labels.object_type"
      log_field = "object_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # object_type

    object_name = {
      label = "$lang_stats.field_labels.object_name"
      log_field = "object_name"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # object_name

    event = {
      label = "$lang_stats.field_labels.event"
      log_field = "event"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # event

    info2 = {
      label = "$lang_stats.field_labels.info2"
      log_field = "info2"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # info2

    info3 = {
      label = "$lang_stats.field_labels.info3"
      log_field = "info3"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # info3

    info4 = {
      label = "$lang_stats.field_labels.info4"
      log_field = "info4"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # info4

  } # database.fields


  # Log Filters
  log.filters = {

    remove_query = {
      label = "$lang_admin.log_filters.remove_query_label"
      comment = "$lang_admin.log_filters.remove_query_comment"
      value = "if (contains(url, '?')) then url = substr(url, 0, index(url, '?') + 1) . '(parameters)';"
    } # remove_query

    detect_page_views = {
      label = '$lang_admin.log_filters.detect_page_views_label'
      comment = '$lang_admin.log_filters.detect_page_views_comment'
      value = "if ((file_type eq 'JPEG') or (file_type eq 'JPG') or (file_type eq 'GIF') or (file_type eq 'ICO') or (file_type eq 'PNG') or (file_type eq 'CSS') or (file_type eq 'SWF') or (file_type eq 'JS')) then page_views = 0; else page_views = 1;"
    } # detect_page_views

    simplify_url = {
      label = "$lang_admin.log_filters.simplify_url_label"
      comment = "$lang_admin.log_filters.simplify_url_comment"
      value = "if (matches_regular_expression(url, '^([^:]+://[^/]+/)')) then url = $1 . '(omitted)'"
    } # simplify_url

    strip_non_page_views = {
      label = '$lang_admin.log_filters.strip_non_page_views_label'
      comment = '$lang_admin.log_filters.strip_non_page_views_comment'
      value = "if (page_views == 0) then url = substr(url, 0, last_index(url, '/') + 1) . '(nonpage)';"
    } # strip_non_page_views

    mark_entry = {
      label = '$lang_admin.log_filters.mark_entry_label'
      comment = '$lang_admin.log_filters.mark_entry_comment'
      value = 'hits = 1;'
    } # mark_entry

  } # log.filters

  log.field_options = {

    sessions_page_field = "url"
    sessions_visitor_id_field = "kiosk_id"
    sessions_event_field = "page_views"

  } # log.field_options


  database.numerical_fields = {

    hits = {
      label = "$lang_stats.field_labels.hits"
      default = false
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
      entries_field = true
    } # hits

    page_views = {
      label = "$lang_stats.field_labels.page_views"
      default = true
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
    } # page_views

    visitors = {
      label = "$lang_stats.field_labels.visitors"
      default = false
      requires_log_field = true
      log_field = "kiosk_id"
      type = "unique"
      display_format_type = "integer"
    } # visitors

  } # database.numerical_fields


  create_profile_wizard_options = {
    date_time_tracking = true
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      kiosk_id = true
      ntk_filename = true
      url = true
      file_type = true
      object_type = true
      object_name = true
      event = true
      info2 = true
      info3 = true
      info4 = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    bandwidth = true
  } # not_supported

} # net_key