##### Type tab Enter the necessary information about the report you are creating. See table below. Click Accept or Apply.
Field | Notes
--- | ---
Display name | The name that will appear in the Reports button drop-down list.
ID | A unique ID for the report (letters, numbers, underscores, and hyphens only; no spaces or special characters).
Show in Reports menu | By default, the report name will appear directly in the Reports button drop-down list, not in a category. You can: Check this box and then select a category for the report. See To organize custom reports by category. Uncheck this box so that this report does not appear in the Reports button drop-down list. For example, you could uncheck this box if the report will provide data to a Graphics page but does not provide valuable information as a stand-alone report.
Primary column | Select the type of information that you want the report to be based on. NOTE If you change your initial selection, click Change to have your new selection take effect.
| Select... | Then...
| Control Programs | Do one or both of the following to create the list of control programs. The primary column will list the equipment that use those control programs. Enter a control program name, and then click Add. You can use wildcards. See the help text to the right of this field. Select from the list of existing control programs.
| Locations | Do one or both of the following to create the list of locations that will appear on each row in the primary column: Select locations in the Geographic or Network tree. Enter a location name, and then click Add.
| Reference Names | Enter a reference name and then click Add. You can use wildcards. See the help text to the right of this field. Add more reference names, if desired, to build a list of reference names. The primary column will list the locations that have the reference names. Select the type(s) of reference names that you added.
| Date Range | Choose one of the following: Previous: A specified number of previous days, weeks, months, quarters, or years. You can choose to include the current time period. From date: A specified number of days, weeks, months, quarters, or years starting at a specific date (yyyy/mm/dd). NOTE You can enter a value or variable name in the fields for these 2 options. If you enter a variable, it must be defined on the Variables tab. Frequency: If you choose Months or Days in the Previous or From date fields, you can choose how often the data is to be reported. For example, if you choose a frequency of Every 15 minutes, the primary column could look similar to the following: Date Range format in report: Type the date format that you want to see in the report. See Date formats for a list of supported formats.
| Existing Report | Select an existing report from the drop-down list or enter a report name in the text field. The existing report will be embedded in the new report so that you can add columns to it. Any changes to the existing report will also be reflected in the new report.
| Color Map | Select this option to show colors on a Graphics page. For example, you could have a campus map where each building would show green for good energy usage or red for high energy usage. See To produce a color map.
Hide Primary column in report | Check to have this column not appear in the report.
Primary column header | If you do not hide the Primary column, type the header that you want to appear at the top of this column.
###### Date formats If your Primary column is a Date Range, use the following information to enter a format in the Date Range format in report field.
For | Type... | Example
--- | --- | ---
Year | yyyy yy | 2017 17
Month | MMMM MMM MM | September Sep 9
Week in year | w | 27
Week in month | W | 2
Day in year | D | 189
Day in month | d | 12
Day of week in month | F | 2 (2nd Thursday in June)
Day name | EEEE E | Tuesday Tue
Day number in week | u | 1 (Monday), 2 (Tuesday), etc.
Examples of combinations:
yyyy-MM-dd MMMM yy MMM/yyyy MM/dd/yy D | = = = = | 2017-06-02 June 17 Jun/2017 06/02/17 153
NOTES To include a single quote, type two single quotes. Example: MMM ''yy = Jun '17 To include static text, enclose it in single quotes. Example: 'Year' yyyy = Year 2017 For more information on date formats, search the Internet for "java simple date format".