The following applications and actions are part of the process to export Nextworld records:
| Process | Description |
|---|---|
| Configuration | Specify the details of an external system and the credentials needed to access it with the File Location Setup application. If you associate a file location setup record with a data export definition, the records can be sent directly into an external system. |
| Configuration | Configure a data export definition that specifies the exact Nextworld data you want to export from a table with the Data Export Definitions application. Select a Nextworld table to export records from, and select a data source to determine their destination. These records can be attached to the corresponding record in the Data Export Run Inquiry application or sent directly into an external system. Data export definitions are built over a single Nextworld table, which means that, by default, only the records in that table or its subtables are exported. |
| Administration | View a history of each execution of a data export definition and access any errors that occurred during the export process with the Data Export Run Inquiry application. Records in this application are automatically created after a data export definition with valid field mappings is submitted. If the data export definition has been submitted before, a new data export run inquiry record is created. |
| Automation | Schedule a job to submit a configured data export definition in the background at regular intervals. Learn more in Scheduled jobs. |
Nextworld customers might use other systems besides Nextworld. That means they might need to export data stored in Nextworld to use it in other systems. Sending data to an external system often requires gathering, filtering, sorting, and modifying the data so that it fits correctly in an external system. Nextworld streamlines this process by allowing application developers and system administrators to configure data exports that are set up for a specific system and purpose. These configurations are reusable and easy to manage. For example, a company may use Nextworld to record their financial transactions but need to export them each year to an external system that’s used to audit the records. After it's configured, the same data export definition can be scheduled to run annually, sending the company's financial transactions for that year to the external system that’s used to audit them.
File formats
The process of exporting Nextworld records varies depending on the format you select for the exported files in the Data Export Definitions application. Choose between the following file formats:
- CSV—Export the fields from the table you're exporting as columns in a CSV file.
- Text—Export a single text-type field from the table you're exporting. To export additional fields, use a logic block to convert the field values to text, concatenate them, and insert them into the single field you're exporting.
- XML—Convert internal platform data into an XML format and export the file. Learn more in Export an XML file.
Based on how they're built, logic blocks can be used in a data export definition to make calculations, format records, add fields from other tables, and more. Add them to the Data Export Definition application in different ways depending on the file format. Learn more in Logic block and data export definition configuration.
Logic block and data export definition configuration
Add logic blocks to a data export definition using the Data Exports Definition application.
Data Export Definitions for CSV exports
In the Data Export Definitions application, you must:
- In the Mapping Logic Blocks subtable, add a logic block built based on your requirements.
- In the Export / Source Table (Subtable) field, enter the table the data export definition is built over, or a related subtable or detail table.
Data Export Definitions for text exports
In the Data Export Definitions application, you must:
- In the Text Mapping Logic Blocks subtable, add a logic block built based on your requirements.
- In the Text Output Field field, enter the field you're exporting from the table.
- In the Final Text Output field, enter the field you're exporting from the table.
Data Export Definitions application
Application developers use the Data Export Definitions application to specify which records from a table and its subtables should be exported as part of a data export definition. Exported data is saved as a file that can be downloaded or sent directly to an external system.
After you configure the data export definition, use the Submit form action to start the export process. You can submit the same definition multiple times. Each time you submit a definition, Nextworld validates that any field mappings are configured correctly. After that, a corresponding record with the same name is created in the Data Export Run Inquiry application. Data export run inquiry records store the date and time each definition was submitted, as well as any errors that occurred during the export process.
General Configuration page
Use the Configuration page to choose a file format for the exported records. Choose between the following Export Format options:
- CSV—The default export format. Allows you to map fields from the table you're exporting to columns in the CSV on the Mappings page. With this format selected, the data export definition ignores any configurations on the Text Exports page.
- Text—Allows you to export records to a variety of file types. You can only export a single data item at a time. That means that logic blocks are needed to configure the records to export. With this format selected, the data export definition ignores any configurations on the Mappings page.
Select any checkboxes which are relevant for your data export, such as:
- Export Since Last Date—Checks the Data Export Run Inquiry application for a corresponding record that stores the time the last record was exported with this data export definition. If this is a new data export definition and no data export run inquiry record exists, all the records in the table are exported.
- Suppress Header Row—Exports the file without a header row.
Filters and Sorts page
Use the Filters and Sorts page to define filters and sorts. You can filter records by workflow states or by data items in the table. Filters added to the Filter subtable are processed in order.
Mappings page
Configurations on this page only apply to CSV exports. Map fields from the table you're exporting to columns in the CSV file. That is, the fields you specify to export make up the columns in the CSV file, and the records make up the rows. By default, if no field mappings are configured, all the fields in the table and its subtables are included in the export. If you add any field mappings, however, only those fields are included. Use the Load Map form action to create mappings for every field in the table and its subtables or add mappings for each field individually in the Custom Field Map subtable. Use the Sort Map form action to set the added field mappings in the order the fields appear in the table you're exporting.
For each mapping, you must enter the table that the data item exists on in the Export / Source Table (Subtable) field. For example, if the field you are mapping is on a subtable, enter the name of the subtable.
The values that Nextworld uses to describe concepts may be different than the values used by an external system. Use list lookup cross references to make sure that Nextworld list lookup values change to match the values used in an external system. Learn more in List Lookup Cross Reference Utility application.
If you include field mappings from subtables, the records in those fields are sent to a separate CSV file after the export process is complete. To preserve the relationship between records from the table and records from its subtables after exporting, include a mapping for the nwId field from the table you're exporting and a mapping for the nwHeaderId field from each of its subtables.
Use the Mapping Logic Blocks subtable to add logic blocks that allow you to modify the records you're exporting, add fields from other tables, make calculations, and more. Learn more in Logic block and data export definition configuration.
For records that contain images or attachments, mappings are configured using the Image Mappings and Attachment Mappings subtables. For each mapping, select a different field from the table in the Name Reference field. The exported images or attachments are named with the associated value in the selected field. The same value is also added to the CSV file to preserve the relationship between the image or attachment and its associated record.
Processing page
Use the File Location page to define the destination, or data source, of your exported records. Choose between the following data source types:
- Attachment—The files are attached to the corresponding record that's automatically created in the Data Export Run Inquiry application when the data export definition is submitted. You can download the files from the Data Export Run Inquiry application.
- External Source—The defined records are sent directly into an external system. This option requires you to associate a record created in the File Location Setup application to your data export definition. These records define the details of an external system and the credentials needed to access it.
Output File Details page
Configurations on this page apply only to text exports. Specify a file type of your export, such as .txt, .csv, .bai, and more. Add the logic blocks built to format the records. Learn more in Logic block and data export definition configuration.
Data Export Runs page
View a list of data exports initiated within this record.
Data Export Run Inquiry application
Application developers and system administrators use the Data Export Run Inquiry application to view a history of each submission of a data export definition and access runtime errors.
After you configure a data export definition with valid field mappings and start the export process, a record is created in the Data Export Run Inquiry application with the same name. If errors occur during the export process, they are added to the data export run inquiry record. View any runtime errors on the Definition page.
You can run the same data export definition multiple times without exporting the same records. The Data Export Run Inquiry application stores the date and time the last record in the data export definition was exported in the Export Last Record Date Time field. This means you can use the Export Since Last Date check box in the Data Export Definitions application. When selected, the export definition excludes any data that was exported with a previous submission of the data export definition.
If your data export definition is configured to be exported as an attachment, access the exported files in the corresponding record in the Data Export Run Inquiry application. If you send your export directly to an external source, a record is created in the Data Export Run Inquiry application, but no files are attached.