Export Wizard

Standard list and data exports are accessed through the Export Wizard dialog. The wizard is started by selecting the Export Wizard option on the Tools menu. On the first page of the wizard, the user selects the export type and the file path for the export file. The remaining pages allow the user to enter selection criteria, enter the date range to export, select the fields to export for lists, enter additional file criteria, and finish the export.

Actions

  • Back. This will open the prior page of the Export Wizard.
  • Next. This will open the next page of the Export Wizard.
  • Finish. This will execute the export using default options for the remaining pages of the Export Wizard.
  • Cancel. This will cancel the export and close the Export Wizard dialog.

Select Data Source

The first page of the Export Wizard provides a list of all Export Types that are available in the system. On this page, the user selects the Export Type using the Explorer tree on the left pane, and the export File Name location using the box below the Explore tree. The browse button (...) to the right of the File Name box allows the user to select the location of the export file.

Selection Criteria

The second page of the Export Wizard allows the user to specify items for the export. The selection options on the left side of the dialog control the items. The options are as follows:

  • All Items. When selected, all items for the selected Export Type will be exported.
  • Specified Items. When selected, only the items listed in the window will exported. Selecting this option activates the Browse and Remove buttons. The Browse button initiates dialog where items are selected. The Remove button will remove a selected item from the window.
  • Selected Items. When selected, only those items selected in the List tab for the selected Export Type are exported.
  • Multiple Files. If checked, the data for each selected item will be written to a separate file. The ExportID for the selected item will be included in the file name for each file generated.
  • Export Contributors. If checked, the contributors of the Medium Term Module are exported.

Date Range

For data exports, the third page of the Export Wizard defines the data range. If the date range includes data that does not exists, those rows will not be written to the output file. Three range options are available..

  • Fixed Date Range.

    • Start Date. The first date that will be exported. If the start date box is not marked, all intervals are exported until the end date is reached.

    • End Date. The last date that will be exported. If the end date box is not marked, all intervals after the start date are exported.

  • Rolling Date Range.

    • Start Offset. The offset from the start of the task, expressed in minutes, hours, days, months, gas days, or gas months, to specify the start time of the export.

    • Export Length. The length of time for the data export, expressed in minutes, hours, days, or months.

  • Transformation Options.

    • Use Ramp Rate. If this box is checked the interval data will be exported in ramp rate space.

    • Shift the Data # of Intervals. This input box allows you to shift the interval data a negative or positive number of intervals.

    • Export Status Fields. For Exports that include status fields (e.g. Meter Data.) If not checked the export file will not include the status fields.

    • Observe Daylight Savings Time. If this box is checked the data will be shifted to local time on export based on the Time Zone specified.

    • Time Zone. The Time Zone of the exported data. This is used for shifting the data to local time on export. This box is enabled when the Observe Daylight Savings Time box is selected.

Select Export Fields

For List exports, the third page of the Wizard allows the user to select the fields to include in the export. The page includes two boxes:

Hidden Export Fields: The left-hand box is labeled Hidden Export Fields and includes the list of fields that will be excluded from the export.

Visible Export Fields: The right-hand box is labeled Visible Export Fields and includes the list of fields that will be included in the export.

Between the two boxes are two arrows to move items between from one box to the other. To exclude a field, select the field in the right-hand box and press the left arrow (move to exclude). To include a field that appears in the left-hand box, press the right arrow (move to include).

By default, all fields are included in the right box. For each type of list, the program will remember the settings the user employed on the most recent export and will initialize the boxes with those settings.

File Criteria

The next page in the Export Wizard is the File Criteria page. This page is based on the file name selection. If the file is an Excel format (XLS or XLSX format), then the File Criteria page is configured for Excel Files. If the files is a Comma Separated Value (CSV) format, then the File Criteria page is configured for CSV files.corrected. The following characteristics are provided for the Excel and CSV file formats.

  • Excel Format Criteria. For exports in XLS/XLSX format, the File Criteria page allows the user to specify information about worksheet name. The specific input group is as follows:

    • Include Header. Specifies whether to export a header row in the file.

    • SheetName. This box allows the user to specify the worksheet name for export.

  • CSV Format Criteria. For exports in CSV format, the File Criteria page allows the user to specify information about delimiters and date formats. CSV files are written with UTF-8 encoding. When exporting forecasts or data, the number of decimal places written to the CSV file is controlled by the decimal field for each item. The specific input groups are as follows.

    • Include Header. Specifies whether to export a header row in the file.

    • Field Separator. Typically a comma (,) or a semicolon (;)

    • String Delimiter. Typically double quotes (") or a single quote (‘). Specifying a string delimiter is not required.

    • Decimal Separator. Typically a period (.) or a comma (,)

    • Date Format. Default is MM/dd/yyyy HH:mm for dates. The Date Format box provides a list of date fields in the export and shows the default format options. Users can type alternative valid date specifications in the Date Format column. The Date Formats button brings up a dialog with common date format codes.

Finish Export

The final step in the Export Wizard is the Finish Export page. This page contains two check boxes, Run Now and Show Details.

  • Run Now. When checked, this selection will run the Export when the Finish button is selected.
  • Show Details. When checked, this selection will show an XML representation of the import options that have been configured. This information is useful for developing XML files for scheduled exports and can be saved to an external file using the Save As Job button. More information on the XML configuration options is shown in the options in the Manage Tasks section with specific parameters shown Task Reference section.