Configure segments for export

Last update: 2022-10-04
  • Created for:
  • User
    Admin
IMPORTANT

Read more about Data Workbench’s End-of-life announcement.

You can create a segment of the elements of any countable dimension, then output data for that segment on a batch or ongoing real-time basis into a tab-delimited file.

Each time that you export a segment, you output metric or dimension data for all of the dimension elements included in that segment. You can control how the output data is formatted so that other systems can easily load the data.

NOTE

You cannot export reporting dimensions, because they use a report time.metric file for reference. As a workaround, if you place a hard-coded report time.metric in the profile, the segment export can use it as a reference point for reporting dimensions. However, the report time.metric does not automatically update based on the profile’s As Of Time, so when you want to change the reporting dimension reference, you must change the hard-coded report time.metric file.

To configure a segment for export, you must open and edit a .export file.

  1. In the Profile Manager, click the Export directory in the File column to show its contents.

    If the Export directory does not exist, create it as follows:
    1. Navigate to your Data Workbench installation directory.
    2. Open the directory for the profile with which you are working.
    3. Within the Profile directory, create a new directory named “Export.”

  2. In the Profile Manager, right-click the empty cell in the User column for the Export directory, then click Create > New Segment Export.

    A file named New Segment Export.export appears in the File column for Export.

  3. Rename the new file by right-clicking in the User column for the file and typing the new name in the File parameter.

  4. Open the new file by right-clicking in the User column for the file and clicking Open > from the workbench.

    The configuration window for the .export file appears.

  5. Click Query, then modify the fields of the .export file as described in the following table:

For this parameter... Provide this information...
Command

Optional. A program to be executed after the Output File is created. This field must reference an executable (an .exe file), not a shell command.

Note: The segment export will fail if there is a space in the command parameter.

Filter

Optional. A named filter or a filter expression. You can either create a named filter using a filter editor, then type the name of that filter here, or you can type a filter expression itself.

For more information about filter editors, see Filter Editors . For more information about filter expression syntax, see Syntax for Filter Expressions .

Elements of Level that match the filter are exported, while all other elements are not.

Level

The countable dimension whose elements are to be exported.

Example: A level of Visitor exports one row of data for each visitor.

Output File

Path and file name of the exported data. If the profile is running on a Data Workbench server cluster, each Data Workbench server writes an Output File containing a portion of the data.

The Data Workbench server installation directory contains an Exports directory where you can save the output file. For example, you could enter Exports\Visitor Segment.txt , where Visitor Segment.txt is the name of the file containing the exported data.

Output Format The metric or dimension data to be exported for each Level element. If the output is a tab-delimited file, the fields should be separated by Tab characters, and the format should end with the appropriate new-line characters. For more information, see About the Output Format .
Schedule End Time

Optional. The end date and time for the schedule, including the time zone.

Format: YYYY-MM-DD hh:mm time zone

Example: 2013-08-01 12:01 EDT

Scheduled exports stop at this time; however, the Output File is still regenerated any time its definition is changed. This field is meaningless without defining Schedule Every. For more information about time zone settings, see the Dataset Configuration Guide.

Schedule Every Optional. The frequency at which to regenerate the Output File. Supported values are hour, day, week, and month. The Output File is still regenerated any time its definition is changed.
Schedule Start Time

Optional. The start date and time for the schedule, including the time zone.

Format: YYYY-MM-DD hh:mm time zone

Example: 2013-08-01 12:01 EDT

Scheduled exports start at this time, and the schedule is relative to this time. This field is meaningless without defining Schedule Every . For more information about time zone settings, see the Dataset Configuration Guide.

Time Limit (sec) Optional. The maximum time permitted to elapse while a segment export is being generated. If the specified interval is exceeded, then the export starts over. Setting this value to 0 (zero) removes the limit. The default value is 600 seconds.

  1. Right-click (New) at the top of the window, then click Save.

  2. To make this file available to all users of the working profile, right-click the check mark for the created .export file in the User column, then click Save to > < working profile name>.

    NOTE

    Saving the .export file to the Data Workbench server causes the export to run once immediately, even if the Schedule Start Time is set to a future date and time.

    The following is a sample .export file.

    NOTE

    The Visitor Segment.export file shown in the sample refers to the Visitor Segment filter. Modifying the definition of this filter changes the definition of the export.

Previous page
Next page

On this page