Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Home > Analytics > Adding Custom Columns & Formatting Columns

...

Info

The Report Designer does not support exporting custom expressions at this time.

In the Report Designer, you can add a custom column to a report and specify its heading and value. Custom columns are added to the Report Designer panel and can be rearranged, grouped, sorted, and filtered like any other column. 

...

  1. To create a custom column, in the Report Designer panel, click +. The Column Properties panel takes its place; you can format the new column there.

    Image RemovedImage Added
  2. Enter a Heading for the column.

  3. Select a Type.

    • For Type Numeric or DateTime, select a Format.

  4. To define the value using a custom expression, next to Expressionclick the Edit button.

    Image RemovedImage Added

    Note: The Edit Formula form is case sensitive. For example, VoyageStatus=="commenced" is different from VoyageStatus=="Commenced"

    1. Create a formula for the value, following the example formula. You can include:

      • Other custom columns

      • Any of the following functions, which must be in UPPERCASE:

        • ABS(FieldID)

        • AVG(FieldID)

        • COALESCE(FieldID1, FieldID2, ...)

        • CONCAT(FieldID)

        • CONTAINS(FieldID, SearchString)

        • COUNT(FieldID)

        • COUNTDISTINCT(FieldID)

        • COUNTIF(FieldID, TestExpr)

        • DATE(Year, Month, Day)

        • DATERANGE(DateFieldID1, DateFieldID2)

        • DATETIME(Year, Month, Day, Hours, Minutes, Seconds)

        • DATETIME RANGE(DateFieldID1, DateFieldID2)

        • DAY(DateFieldID)

        • DISPLAYVALUE(EnumLiteral)

        • ENDSWITH(FieldID, SearchString)

        • HOUR(DateFieldID)

        • IF(Condition, true, false)

        • INDEX(FieldID, Num)

        • INLIST(Value, Target1, Target2, ...)

        • JOIN(“,”, FieldID)

        • JOINDISTINCT(",", FieldID)

        • LEN(FieldID)

        • MAX(FieldID)

        • MIN(FieldID)

        • MINUTE(DateFieldID)

        • MONTH(DateFieldID)

        • NOW()

        • NOWGMT()

        • ROWOFFSET(n, ORDERBY(FieldA, FieldB)).FieldID

        • SECOND(DateFieldID)

        • SPLIT(FieldID, Delimiter, Index)

        • SQRT(FieldID)

        • STARTSWITH(FieldID, SearchString)

        • SUBSTRING(FieldID, StartIndex, length(optional))

        • SUM(FieldID)

        • TIME(Hours (0-23), Minutes (0-59), Seconds (optional, 0-59), Milliseconds (optional, 0-999)))

        • TODAY()

        • TODAYGMT()

        • TOINT(FieldID)

        • TOLOCALESTRING(FieldID)

        • TOSTRING(FieldID)

        • YEAR(DateFieldID)

    You can create a custom expression using Functions and Operators.
    For details on Functions and Operators, see VIP - Custom Expression Functions

  5. To save the report, click << Report at the top of the Column Properties panel and then click Save.

...

Below is an example to show how you can calculate cargo commission.

...

Note:

Info
  • The internal name follows the column heading after you

...

  • have saved the column. Renaming the column will not change the internal name.

  • Ensure that the internal name does not contain functions (e.g. SUM, COUNT, JOIN). Having functions in the internal name will cause the custom expression to not work properly.

Formatting a Column

  1. To format a column, open the Column Properties panel:

    • For a custom column, follow the steps above.

    • For an existing column, click it in the Report Designer panel.

  2. Edit any of the following fields:

    • BoldItalics: Enter either "Y" (Yes) or "N" (No).

    • Font, Font ColorField Background: Enter a custom expression.

    • Alignment: Select None (default), CenterLeft, or Right.

    • Width: Enter either a specific width (in pixels) or Auto (to automatically size the column).

    • Header Group: Group consecutive columns together under a single heading.

      • For each field to be grouped together, select the field in the Columns pane and add the same Header Group name.

    • Evaluate After Filters: Select to calculate the value for a column with a formula only after filters have been applied.
      Example:

      • Load Port Days is a custom column that will be populated from the Port Days column.

      • Port Function is filtered on Load.

      • Load Port Days column has Eval. After Filters enabled.

      • Filters are applied before calculating the value of the Load Port Days column.

    • Hidden: Select to hide the column in the report output.

    • Hide if Empty: Select to hide the column in the report output if there are no values.

    • Is Multi-Line: Select to wrap the column value onto multiple lines when the column width is not sufficient to display the value.

  3. To save the report, click << Report at the top of the Column Properties panel and then click Save.

...