Create or Edit a Custom Export Format Definition

Use the Export Format Editor to create and edit custom format definitions you can use to export project data in text files. A format definition defines the record type and the fields to be included in each export record when the definition is selected in the Export pane.

To create or edit a custom export format definition:

  1. If you want to test an export format definition while you are editing or creating it, select a sample of the type of project data that would typically be exported with the definition (for example, points) before you open the Export Format Editor dialog as described in the next step.

    You will test the definition using this data later in this procedure.

  2. Do one of the following:
    • Select Export Format Editor in Home > Data Exchange.
    • In the Exportdialog, click the Export Format Editor icon in the toolbar.

    The Export Format Editor dialog displays. This dialog is a wizard that allows you to create or edit an export format definition.

  3. On the Export Format Definitions page, do one of the following:
    • To create a new format definition, click the New button to add a new row to the table. In the Definition Name field, enter a name for the definition. Then click the Next button.
    • To create a new format definition based on an existing definition, select the existing definition in the table and click the Copy button to add a new row to the table. In the Definition Name field, enter a name for the definition. Then click the Next button.
    • To edit an existing format definition, select it in the table. Then click the Next button.
    • To rename an existing format definition, select it in the table and click the Rename button. In the Definition Name field, enter a new name for the definition.
    • To delete an existing format definition, select the definition in the table and click the Delete button.

    Use the Enabled check box to specify whether a format definition should be displayed in the Export command pane.

    When you click the Next button, the Export Record page displays.

  4. Optionally, enter a description for the format definition.
  5. Select the Include header check box if you want to include field names as the first record in the exported file.
  6. Select the appropriate export record type:
    • Delimited creates records whose fields are each separated by a character (for example a comma, tab, new line, and so on).
    • Fixed width creates records whose fields are each based on a specified width (number of characters). When you add fields to the definition as described later in this procedure, a default width is specified for each field; but, you can specify a different width if necessary.
    • Text delimited creates records whose fields each start and end with specified text strings. When you add fields to the definition as described later in this procedure, you must specify the start and end text for each field.

    The record type you select determines the properties displayed in the lower half of the page.

  7. Enter properties for the selected record type as follows:

    Delimited record type only:

    • Delimiter - In the drop-down list, select the character to use to separate fields in the record. If you select <other>, you must type the character in the field.
    • Text qualifier - Select to insert single or double quotes around text values.

    All record types:

    • Default file extension - Enter the default extension for the export file.
    • Encoding - Select to use the UNICODE or ASCII character set for the export file.

      Note: The correct choice (UNICODE or ASCII) depends on the software that will be receiving the .csv file. Be aware that this choice may impact the ability of the receiving software to read the file.

    • Decimal separator - Select whether to use a point or a comma as a decimal separator.
  8. Click the Next button.

    The Export Fields page displays.

  9. In the Data type drop-down list, select the data type for which you want to export data (for example, select Point to export point data).

    Fields associated with the selected data type display in the Available fields list.

  10. In the Available fields list, double-click each field you want to add to the format definition. Or, right-click the field and select Add to Record. Optionally, right-click an expandable field group node and select Add All Fields in Group to add all of the fields in the group to the definition.

    Note the following:

    • The selected fields are added to the Export record tab set.
    • The sequence of the field tabs from left to right in the Export record tab set represents the sequence of the fields in the export record. To move a field to a different location in the export record, click and drag its tab title in the Export record tab set.
    • If a field tab includes property fields, be sure they are completed correctly.
    • To remove a field from the Export record tab set, right-click the tab and select Remove Field. Or, right-click the field in the Available fields list and select Remove from Record
  11. To preview the results of the export format definition, click the Test button.

    To preview results, you must have first selected appropriate project data as described in step 1.

    When appropriate project data has been selected, sample export records are displayed in the Export Preview frame. If you make additional changes to the format definition, they are immediately reflected in the Export Preview frame.

  12. When you are done adding fields, click the Finish button.

    You are done creating or editing an export format definition. Unless you unchecked the Enabled check box for the definition on the Custom Format Definition page of the wizard, the definition will display on the Custom tab in the Export command pane.

Related topics

Export Data in a Custom Format

Export Data