Creating Custom Fields

Custom fields are used to specify rules for automatically populating fields in basic and advanced reports.
  1. Go to Configuration > Custom Fields.
  2. Click New Custom Field.
  3. Select transfer or file from the Level drop-down list, depending on whether the new custom field stores transfer- or file-related content.
  4. Enter a name for the custom field. The name must be unique and lowercase.
    The resulting SQL name is prefixed with "cf_". For example, the field name "metadata" appears as "cf_metadata".
    Note: Custom fields appear in the database with the "cf_" prefix. Custom fields are utilized in the $TBL_FILES and $TBL_TRANSFER tables.
  5. Enter the start date (date on which to start custom field calculation).
  6. Enter a custom field description.
  7. Click Create.
  8. Create and associate new rules for your custom field.
    Rules are conditions that define when the custom field to comes into effect. To set up the rule's conditions, configure the following settings:
    • Select a built-in field from the drop-down list.
    • Enter an operator.
    • Enter an expression.
    • Enter the value Console uses to populate the custom field if conditions are met.
    For a list of field names and definitions, see Reference: Built-In Fields for Custom Field Rules.
    For example, to create a custom field that is populated with your company name, create a new custom field and associate it with the following rule:

    For examples on using matchers, see Using Matchers in Custom Rules.
  9. Click Create.
For each custom field, you can create multiple rules that populate with different values based on various conditions. When multiple rules are present, Console uses the first rule listed (as long as it matches the condition). To modify the order of the custom field rules, use the drag-and-drop function to move the rules in the list.
When creating an advanced report, you can find your available custom fields by clicking the Help link in the SQL Script Text section.

For an example of using a custom field in a report, see Advanced Report Example: Transfer Sessions with High Packet Loss.