Skip to content

Account Administration > DataExtract

Creating an Extract

Account Administrators can create one extract per workspace.

  1. Click the Workspace Settings option which appears as the second option from the user menu drop-down. The user menu appears as the username's initials within a circle within the title bar.
  2. Click the DataExtract view.
  3. Make sure you are in the Setup Subview.
  4. Click New Extract.
  5. Enter details for the extract:
  6. Name: Enter a name for the extract.
  7. Owners: Select owners for the DataExtract from the Owners drop-down menu.

The Importance of the Owners Field

When the Data Extract file is generated, all users who appear in the Owners field will receive the Notifications and the Extract zip file in their Downloads Widget.

  1. Notifications: Within the Notifications drop-down menu select an option:
  2. All Extracts: All owners will receive a notification when an extract is completed or if the extract fails.
  3. Failed Extracts Only: Owners will only receive notifications when an extract fails.
  4. Maximum Text Attribute Length: If the system that will be processing the data has a limit on the number of characters it can process in data fields, enter a maximum text attribute length. All fields will be truncated to this length.
  5. Format: Choose the format for your DataExtract:
  6. Check the box next to DataExtract CSV to format the extract file into the traditional CSV format.
  7. Check the box next to RFC 4180 CSV to select the extract file to output in the RFC 4180 format. (RFC 4180 formatted files do not use a backslash to escape the following characters: backslash, double quote, and the carriage return).
  8. Click Create Extract.

You are returned to the Setup view of the extract.

Editing Extract Information

Account Administrators can configure the frequency and interval at which extracts should be run in their workspace.

  1. Click the Workspace Settings option.
  2. Click the DataExtract view.
  3. Navigate to the Setup Subview.
  4. Click the Pencil icon to edit the Extract Information section of the extract details:
  5. Modify the name for the extract.
  6. Modify the Owners of the DataExtract.

The Importance of the Owners Field

Owners receive email notifications for DataExtracts based on the conditions established in Notifications.

Click on the Owners drop-down menu and check the boxes next to the users that should receive notifications.

  • Select All will select all employee users on the list.

  • De-select All to configure no owners.

  • Configure the Notifications:

  • All Extracts: Send notifications to owners for all successful and failed extracts.
  • Failed Extracts Only: Send notifications to owners for failed extracts only.
  • Edit the Maximum Text Attribute Length.
  • Edit the format for your DataExtract:
  • DataExtract CSV
  • RFC 4180 CSV

Click Save to preserve your edits.

Editing Filtering for an Extract

Account Administrators can configure what information is included in extracts generated for their workspace.

  1. Click the Workspace Settings option.
  2. Click the DataExtract view.
  3. Make sure you are in the Setup Subview.
  4. Click an extract name on the left side of the view.
  5. Click the Pencil icon in the extract details on the right to edit the filtering.
  6. Select the Extract Type:
  7. Full: Only schedule full extracts.
  8. Full & Delta: Schedule full and delta extracts.

Modifying the 'Extract Type' setting can cause interruptions to Arena Analytics reporting and downstream business processes. Contact Arena Support before adjusting this setting.

Delta Extract Transaction Type (Trans Type) Description

  • I: Insert (created a new row)
  • U: Update (edited an existing row)
  • D: Delete (deleted an existing row)

Deleted rows may require storage of additional “key” attributes. For deleted BOM rows, only the BOM Row GUID and Trans Type are included.

  1. Use checkboxes to specify what information should be included in the extract.
  2. Click Save Changes.
  3. You are returned to the Setup view of the extract.

Editing the Schedule of an Extract

Account Administrators can configure the frequency and interval at which extracts should be run.

  1. Click the Workspace Settings option.
  2. Click the DataExtract view.
  3. Navigate to the Setup Subview.
  4. Click the Pencil icon to edit the schedule.

Configuring the Full Schedule

For customers using Delta extracts, schedule a weekly full extract as a backup.

  • Manual: Only allow manual DataExtract runs.
  • Scheduled: Configure a scheduled ‘Full’ extract:
  • Use the Start Date calendar widget.
  • Use the Time widget.
  • Select recurrence: Daily, Weekly, Monthly, Yearly.
  • Enter frequency value.

Configuring the Delta Schedule

  • Recurrence options: Minutes, Hours, Days
  • Frequency values:
  • Minutes: 15 - 55 (increments of five)
  • Hours: 1 - 23
  • Days: 1 - 30

Adding Webhooks to the DataExtract

Add a webhook to notify external systems when DataExtract runs are complete.

  1. Click the Workspace Settings option.
  2. Click the DataExtract view.
  3. Make sure you are in the Setup Subview.
  4. Click an extract name.
  5. In the Webhooks section, click the [+].
  6. In the pop-up, select the webhook from the drop-down menu.
  7. Click Save.
  8. You are returned to the Setup view of the extract.