Create a report

Create a new customised report and set when the report runs and how often it runs.

Follow the instructions below:

  1. From the Reports menu, select Data Extract. The Data Extract Definition screen appears.

  1. Click the + New Data Extract button on top left of the screen. The Data Extract (Add) screen appears.

This screen is divided into several areas, at the top is the Extract Definition area.

Extract Definition

The fields in this area set the parameters for the data you will extract to make the report. The fields are all compulsory, except the Active checkbox. The fields are:

Create a new encryption key

Each report must have an encryption key. This key can be an existing key, or you can create a new key.

To create a new encryption key for the new report:

  1. Click the Create a new Encryption Key button. The Create a new Encryption Key screen appears.

  1. Enter a name for the encryption key in the Name field.

  2. Click the Create a new Encryption Key button.

  3. A confirmation screen appears, click the OK button to return to the Data Extract Definition (Add) screen. The new encryption key name appears in the Encryption Key field at the top of the list of encrypted keys.

Data Sources

The fields in this area define the areas the system searches to collect the data. The fields are:

Select the hierarchies

To select the hierarchies that contain the data for your report:

  1. The available hierarchies are in the Available list on the left. You can scroll down this list, and use the Refine data by field to search for a particular hierarchy or hierarchies.

  2. Scroll through the list of available hierarchies, select the hierarchies you want to include in your report. Use the Control key on your keyboard to select multiple hierarchies and click the right arrow.

  3. The Selected list contains the hierarchies which contain the data that will appear in the report. You can select hierarchies in this list and use the left arrow to move them back to the Available list.

  4. To assign all the hierarchies to your report, click the Select All checkbox next to the Available list and click the right arrow. To deselect all the selected hierarchies from the report, click the Select All checkbox above the Selected list, and click the left arrow.

Extract As Rows

This is the default option for your new report. The system presents the data in a series of rows with several columns. There are two types of column, the Column and the Extracted Detail Column. To select the columns you want:

  1. Click the Extracted Columns box. The Extracted Columns screen appears.

  1. The available columns are in the Available list on the left. You can scroll down this list, and use the Refine data by field to search for a particular column or columns.

  2. Scroll through the list of available columns, select the columns you want to include in your report. Use the Control key on your keyboard to select multiple columns and click the right arrow.

  3. The Selected list contains the columns that will appear in the report. You can select columns in this list and use the left arrow to move them back to the Available list.

  4. To assign all the columns to your report, click the Select All checkbox next to the Available list and click the right arrow. To deselect all the selected columns from the report, click the Select All checkbox above the Selected list, and click the left arrow.

  5. The procedure (steps 1 to 4) is identical for the Extracted Detail Columns.

  6. Click the Save Changes button to confirm your choice of columns to include in the report. You return to the Data Extract Definition (Add) screen. The columns you selected appear in the blue Extracted Columns and Extracted Detail Columns boxes on the screen.

  7. If you change your mind or see a mistake in your choice of columns, click the Click to change button to display the Extracted Columns screen.

Extract as Pivot

This is an alternative way to present your report, in the form of a pivot table. A pivot table allows you to reorganise and summarise selected columns and rows of data in a database to create exactly the type of report you want. To use a pivot table to set up the report:

  1. Click the Extract As Pivot button. Three boxes appear, called Rows, Columns and Values.

  1. Click in one of the boxes, for example the Rows box. The Pivot Configuration screen appears.

  1. Drag and drop a field from the Available Fields list into the Rows, Columns or Values boxes. You must drag at least one field into each box.

  2. Click the Save Changes button to confirm your choice of columns, rows and values to include in the report. You return to the Data Extract Definition (Add) screen. The configuration you selected appears in the blue Rows, Columns and Values boxes on the screen.

  3. If you change your mind or see a mistake in your choice of columns, click the Click to change button to display the Pivot Configuration screen.

Filters

There are several filters you can apply to a new report. See the Filters topic.for details.

Schedule

The fields in this area control when the report runs.

You can also control the time range of the records that feature in your report. For example, you can restrict your report to records from 2019 only.

Run the report now

To run the report as soon as possible:

  1. Click Run as soon as possible.

Run the report at some point in the future

To run the report in the future:

  1. Click Run in the future. Extra fields appear.

To run the report once at a specific time:

  1. Use the calendar to give the date in the Run the extract on this date field.

  2. Specify a time, otherwise the report runs 1 second after midnight on the date you specified.

To run the report at regular intervals:

  1. Click Yes on the Repeat the extract more than one time? field. Extra fields appear.

  1. Use the calendar to enter the date you want the first report to run in the Begin the extract on this date field.

  2. Use the Repeat the extract every field to select the day and time of the intervals.

  3. Enter the number of repetitions in the Repeat this many times field.

Note:  The maximum total time for a report repetition is one year. If you want your report to run for more than one year, you will have to confirm these settings once each year.

Report records timespan

To set the time span and the trigger event (for example, the load date):

  1. Select the trigger event from the include records where drop down list.

  2. Select a time range from the is within drop down list.

Advanced options

This section of the screen has some general settings:

Complete the report

To complete the report you've just created, do the following:

  1. Click the checkbox next to the statement I have read and agree to the terms and conditions of using this data.

  2. An optional step is to click the Show Sample of extracted data button. The sample screen appears.

  1. Click Schedule this extract or Done. You return to the Data Extract screen with the various reports listed. When the report you just created runs, the system sends you a confirmation email. The email contains some basic information about the report, including its file name, hierarchy, and SFTP (Secure File Transfer Protocol) path.

Note:  You cannot change the data type of the report, or the encryption key associated with the report.

Guide feedback?
Email us at: guides@worldpay.com

© Worldpay 2019, LLC and/or its affiliates. All rights reserved.