Valid Formatter Patterns
In the Field Configuration window, the Formatter selector requires additional details provided in the Formatter Pattern box. Note that only Formatters relevant to the selected report template field will be made available for selection.
Use the following table to determine valid formatting patterns.
Formatter Name | Data Type | Valid Patterns | Description |
|---|---|---|---|
Date | Date | N/A | Date formats are derived from the user's profile. |
Date+TimeZone | Date | N/A | Date formats are derived from the user's profile. |
Group by TimePeriod Start/End Formatter | Date | [S|E]::[D|H|M|S|0|Y|T] S is used to calculate start date when End date is provided based on "group by". E is used to calculate End date when Start date is provided based on "group by". D-> Day H-> Hour M-> Minute S-> Second O- Month Y- Year T- Epoch Time in Milliseconds | Allows the framework to calculate the finish time based on the start time and "group by" selected. |
Date Group By | Date | N/A | Used in charts and graphs to format the legend, based on the "group by" that is selected in the scope selector at run time. This formatter determines the optimum date format for that group by. |
Time Elapsed | Number | (SEC)|(MIN)|(HR)|(DAY) | Displays time in a more readable format, converting minutes to hours, where relevant. For example, 120 min would be displayed as 2 hrs. |
Time Duration | Number | N/A | Formats a time value that is in milliseconds to the following format: hh:mm:ss Applicable only for fields that denote time duration; for example: finish_date minus start_date |
Cron Schedule | Number Varchar2 | N/A | Presents a standard cron expression in a user-readable form. For example, */30**** will display as "Every 30 minutes." |
Numeric | Number | N/A | Format derived from the user's profile. |
Numeric String | String | N/A | Treats numbers as a string without formatting. This allows sorting to be done numerically. |
Custom Number | Number | Enables users to define their own number format which is not tied to the setting in their user profile. | |
Decimal | Number | % converts to % format Otherwise, leave as null. | Formats the value with the number of decimal places specified in the user's profile; can also be used for percentages. |
Speed | Number | N/A | Formats speed values. N/A if speed = 0. |
Currency | Number | N/A | Format derived from the user's profile. |
File Size | Number | (KiB)|(MiB)|(GiB) is the input data type | Formats the file size unit of measure to what is most applicable to the selected field value. For example, 2048 MB would become 2 GB |
File Size No Label | Number | Units::Units | For Backup Manager only. Formats the file size to the most relevant unit of measure, but omits the unit label. Applicable for byte size data. |
Unit Converter | Number | KB::TB KB::_ (for dynamic output) | Determines the value to be used when converting from one unit to another, for example, from KB to GB. The "division by" value is determined from the user's profile settings, either 1000 or 1024. Note that for line charts, if you select Unit Converter for a line, it only formats the mouse-over, not the Y-axis label. |
Char Substitute | Number Varchar2 Date | <value_to_replace>: :<replacement_value> | Replaces specified characters in a string value. For example, if the database returns "Host1, Host2" this formatter would be replaced the "," with "<br/>" |
Null Substitute | Number Varchar2 Date | <string> | Replaces null values with a user-supplied string. |
Percentage | Number | number1:number2:number3 Data values from 0 to number1 will render Green color in the percentage bar. Values between number1 and number2 will render Yellow color and values between number2 and 100 will render Red color. The values number1 and number2 should always be between 0 and 100. The number3 parameter determines the size of the % bar in pixels. | Display a % bar (thermometer) in a chart. |
Full Name | Number | N/A | For File Analytics only. Converts a shortcut name to a full name for NetApp, CIFS, and WinFS. |
Yes/No | Varchar2 | N/A | Translates Y/N to Yes/No. |
Status Icon | Varchar2 Number | Example: 0|Green,2|Red,1|Yellow,*|White If the value = 0, the circle icon will render in green. | Displays status icons depending on the data, which could render in red, yellow, blue, green and white. |
Truncate | Varchar | Number | Truncates a string with ellipsis. The maximum size of the string is 28 characters. Use the pattern to override the maximum size. When using the Truncate formatter, it is recommended to complete the Tool Tip field. |