Use Exporter to export specific domains from a study or an entire study. Exports can be run manually or configured as an Export Definition, which saves settings and supports scheduling through Tasks.
Depending on assigned privileges, data can be exported in one of the following formats:
- Excel
- CSV
- SAS
- SAS XPORT
- Delimited
Exports can also be sent to configured outbound data sources, including Databricks through a linked Amazon S3 export path.
The Exporter window is divided into two sections:
- Top half:
Used to configure export parameters. Select the Snapshot (if available; the default is the current version of the data), the Data Store where the data resides, the domains to be exported, and the export format. - Bottom half:
Displays the results of the most recent export, along with any exports completed during the current session. After logging back into elluminate, only the most recent export displays.
Existing Export Definitions can be viewed by clicking the Export Definitions tab in the lower section of the window.
Create an Export Definition
Export definitions can be created, saved, and either run on demand or scheduled to run through the Tasks module.
From the study home page, select Exporter from the module drop-down. The Exporter window opens.
In the Exporter window, click the + New Definition button.
The Export Definition window opens.
- Enter a name for the Export Definition in the Name field.
- In Study Snapshot, select a study snapshot from the drop-down. The default selection is Current.
- In Group By, select Data Stores or Tags.
- If Data Stores is selected, select a data store where the export is performed. Only data stores that contain data display.
- If Tags is selected, select a tag associated with the data stores or domains to export.
- In Available Domains, review the domains for the selected data store or tag.
- Select the domains to include in the export. Multiple domains can be selected by holding the Shift key (consecutive domains) or the Ctrl key (nonconsecutive domains). Selected domains are highlighted.
- To include all domains in the selected data store or tag, select Include All. This includes domains added after the Export Definition is created.
- To select all currently available domains for the selected data store or tag, click Select All. This does not include domains added after the Export Definition is created.
- In Filename Format, enter the naming scheme. Enter a [ to view available options. A preview of the filename displays below. The default filename includes the study name, user name, and date and time.
- In Domain file naming, select an option from the drop-down to specify the filename case format.
In Format, select an export format from the drop-down. The default is Excel. Available options include Excel, CSV, SAS, SAS XPORT, and Delimited. Depending on the selection, additional checkbox options may display. See the table below for details.
Select Add CheckSum to ensure that the exported data has not been altered upon opening. When this option is selected, an .md5 file is generated along side the export file. Be sure to save the .md5 file with the exported file(s). The recipient must have appropriate software to validate the checksum against the exported file and confirm data integrity. This option is available for all export types.
Tip: CheckSum: A checksum is the result of running an algorithm (typically a cryptographic hash function) on a piece of data, usually a single file. Comparing the checksum generated from the exported file with the one provided by the source helps ensure the file has not been altered. A checksum may also be referred to as a hash sum.
Depending on the selected format, additional options may be available, as outlined in the following table.
FORMAT OPTIONS Excel Output Type
Workbook Per Domain: Select this option to export each domain as its own Excel workbook or file.
Sheet Per Domain: Select this option to include all exported domains in one workbook, with each domain in a separate tab.
Field Headers
Names: Select this option to display the names of the domain variables as headers in the Excel file. For example, exporting Adverse Events with Names selected displays variable headers such as STUDYID, USUBJID, AETERM, AESTDTC, etc.
Labels: Select this option to display the variable labels in the domain as headers in the Excel file. For example, exporting Adverse Events with Labels selected displays headers such as Study Identifier, Unique Subject Identifier, Reported Term for the Adverse Event, Start Date / Time of Adverse Event, etc.
CSV There are no specific selections for the CSV format. SAS Auto Trim and Auto Split options enable exports to meet FDA study submission requirements by resizing and splitting columns.
- Auto Trim: Select to have the Exporter scan each column, determine the actual maximum column length, and adjust the column to that length.
- Auto Split: Select to have the Exporter scan each column and automatically split columns exceeding 200 characters into multiple columns, each no longer than 200 characters.
The new columns are inserted immediately following the original column and are named by appending sequential numbers to the original column name.
For example, if the AETERM column in the AE table contains more than 200 characters, the AETERM content is trimmed (truncated) to the first 200 characters, and a new column, AETERM1, is added to store the next portion, followed by AETERM2, AETERM3, and so on, as needed.
Note: For readability, the text is not split mid-word. The split occurs at the last whitespace before the 200-characters limit; therefore each column may be slightly shorter than 200 characters, depending on whitespace placement.
UTF-8 Encoding: Select to enable a broader text encoding schema, including more special characters than the default SAS option.
SAS XPORT Auto Trim and Auto Split options enable exports to meet FDA study submission requirements by resizing and splitting columns.
- Auto Trim: Select to have the Exporter scan each column, determine the actual maximum column length, and adjust the column to that length.
- Auto Split: Select to have the Exporter scan each column and automatically split columns exceeding 200 characters into multiple columns, each no longer than 200 characters.
The new columns are inserted immediately following the original column and are named by appending sequential numbers to the original column name.
For example, if the AETERM column in the AE table contains more than 200 characters, the AETERM content is trimmed (truncated) to the first 200 characters, and a new column, AETERM1, is added to store the next portion, followed by AETERM2, AETERM3, and so on, as needed.
Note: For readability, the text is not split mid-word. The split occurs at the last whitespace before the 200-characters limit; therefore each column may be slightly shorter than 200 characters, depending on whitespace placement.
Delimited Delimiter
Choose between Tilde (~) or Vertical Bar (|).
Select Export to to export data to a specified outbound data source. If a defined data source exists, the first one displays in the drop-down by default. Select the appropriate outbound data source from the drop-down. If no data source is defined, a grayed-out box displays.
If a Databricks export path is selected, the path uses a linked Amazon S3 data source as the file processing location.Note: When a Databricks export path is selected, the Format field must be set to CSV.
- By default, exported domains are packaged in a .zip file. Select Extract Files to extract the files from the Outbound data source destination.
Click Save. The definition displays on the Exporter home page in the Export Definitions tab.
Manually Export Data
- From a study Home Page, select Exporter from the module drop-down. The Exporter window displays.
- Follow the steps from the Create an Export Definition example above to enter values and make selections in the Exporter window.
Click Export. The export processing displays in the bottom half of the window. Once complete, the status updates to Completed.
Run an Existing Export Definition
- From a study Home Page, select Exporter from the module drop-down. The Exporter window displays.
- Click the Export Definitions tab in the bottom half of the window.
- Click the Run icon next to the desired export definition.
Export processing displays in the bottom half of the window. Once complete, the status updates to Completed in the Recent Exports tab.
Access the Data from an Export
When an export is complete, click the arrow to the left of the export name to view details for the variables that were exported.
To download the exported files, click the Download button on the right side of the export row.
Once the download is complete, open the folder to access the files.
Note: Depending on the export selections, the output includes either separate files for each domain or a single file with domains organized on separate tabs.
After completion, the export displays in the Exports section on the study Home Page. This section provides a history of all exports associated with the study, including scheduled exports.
When exporting to an outbound data source, a copy of the file remains available in the Exports section on the lower half of the study page.