Integrations can take two forms:
- Batch integrations—Collect, store, and process large amounts of data with basic, unchanging parameters.
- Real-time integrations (using REST based Web services)—Import and export data, such as discrete transactions, between systems as part of an operational business process.
Interoperability Quick Start enables you to:
- Import data from a spreadsheet—Select the Data Import Quick Start button, specify the CSV file you want to use and the table where you want to import the data, then save the record. The data mappings subtable is automatically populated with the data from the spreadsheet. Complex data types, such as table lookups, name, and address fields, require you to fill out the Mapping Type and Mapping Sub Type in the mappings subtable.
- Export data from a platform table—Select the Data Export Quick Start button then specify the table you want to export data from, the export format, and the data source type. A record is created in the Data Export Definitions application.
Interoperability applications
Interoperability applications include:
- APIs and endpoints
Application Programming Interfaces (APIs) are the rules which define how a system, also known as a client, can communicate and share resources with the server's API. An endpoint is the location of the information which is being requested by the client, often a URL, and is a component of an API.
- Events
Events, also known as event emissions and subscriptions, communicate changes that occur in business data to external targets and logic blocks.
- Connectors
Connectors facilitate communication between external systems and Nextworld. You can use them to send and receive data, or to initiate logic in an external system, such as J.D. Edwards.
- Webhooks
External systems send webhook notifications into Nextworld when events occur. This allows business logic within Nextworld to execute in response to those events.
- Model Context Protocol (MCP)
Model Context Protocol (MCP) is an open protocol standard for AI integrations. It enables you to build secure, standardized connections between organizational data and AI consumers, such as large language models (LLMs), without requiring custom integrations for each system.
- Environment overrides
Use environment overrides to override previously configured values in a specific environment. Environment overrides are used for data imports, data exports, endpoint definitions, and event definitions.
- Messages
Application developers, system administrators, and implementation teams configure the system to automatically send messages or notifications when message events are completed.
- Data imports
Data imports enable you to import external data into internal platform tables. Imports can be done as part of new environment implementation, or as recurrent processes.
- Data export process
Application developers and system administrators use multiple applications when exporting records from Nextworld. You must configure the data to export, export the records, and view a history of each export. Exported records can be downloaded as a generic file type or sent directly into an external system.
- List Lookup Cross Reference Utility application
Application developers use the List Lookup Cross Reference Utility application to create cross references for values which are represented differently between Nextworld and an external system, but are inherently the same. Cross references can change an external value to a Nextworld value in an import, or change a Nextworld value to an external value in an export.
- File Location Setup application
Application developers use the File Location Setup application to connect Nextworld to external systems through an SFTP server. File location setup records are used in both data import and data export definitions to seamlessly integrate data between systems.
- Troubleshoot integration activity
Troubleshoot integration activity using the inquiry and logging applications available within the platform.
Environment overrides
Use environment overrides to override previously configured values in a specific environment. Environment overrides are used for data imports, data exports, endpoint definitions, and event definitions.
Override definitions are environment specific, and can only be configured on certain fields. Overrides work by applying new values when a definition is called in the specified environment. This enables you to develop and test integrations without having to change values in the original definition.
For example, event definitions specify an Id where event payload information should be sent. If you configure an event to send payload information to an Eventbridge, you would not want to send test data to the Event Bus which has external subscribers. To test your event definition, you can create an environment override definition with an alternate Id. This allows you to test that the configuration works properly without sending test data to the business account which is specified in the original definition. Learn more in Event configuration and Event External Target Definitions application.
Or, you could replace the URL and endpoint secret from an endpoint definition to test the configuration without having to send a real request to the endpoint. Learn more in Endpoint Secret Setup application.
Once an environment override definition is configured, you must assign it to an environment in the Environment Override Assignment Setup application.
Learn more in:
- Environment override configuration
Configure an environment override with the Environment Override Definition and Environment Override Assignment Setup applications. Environment overrides enable you to create environment specific field value replacements for exports, endpoints, and event definitions.
- Environment Override Definitions application
Use the Environment Override Definitions application to define values to override previously configured values in data imports, data exports, endpoint definitions, and event definitions when in a specific environment.
- Environment Override Assignment Setup application
Use the Environment Override Assignment Setup application to assign an environment to an environment override definition.
- Environment Override Definitions application
Environment override configuration
Configure an environment override with the Environment Override Definition and Environment Override Assignment Setup applications. Environment overrides enable you to create environment specific field value replacements for exports, endpoints, and event definitions.
Environment Override Definitions
In the Environment Override Definitions application, you must create a new record and select the Add Environment Override Config Detail button to add an entry for each record you want to override. For each record:
- Select the appropriate override table. Valid tables are:
EndpointConfigDataImportTemplatesDataExportDefinitionExternalEventTargets
- Select the name of the record you want to create an override over. For example, the name of the endpoint definition.
- Select the Edit row action to open the detail detail.
- In the Overrides subtable, enter the name of the field you want to override, and provide the value you want in the field.
Environment Override Assignment Setup
In the Environment Override Assignment Setup application, you must create a new record. Enter the name of your override definition, and the name of the environment you want it applied in.
Environment Override Definitions application
Use the Environment Override Definitions application to define values to override previously configured values in data imports, data exports, endpoint definitions, and event definitions when in a specific environment.
Override definitions are environment specific, and can only be configured on certain fields. Overrides work by applying new values when a definition is called in the specified environment. This enables you to develop and test your integration definitions without having to change values in the original definition. Learn more in Environment overrides.
Select the Add Environment Override Config Detail button to add an entry for each record you want to override. For each record:
- Select the appropriate override table. Valid tables are:
EndpointConfigDataImportTemplatesDataExportDefinitionExternalEventTargets
- Select the name of the record you want to create an override over. For example, the name of an endpoint definition.
- Select the Edit row action to open the detail detail.
- In the Overrides subtable, enter the name of the field you want to override, and provide the value you want in the field.
Once an environment override definition is configured, you must assign it to an environment in the Environment Override Assignment Setup application. Learn more in Environment override configuration.
Environment Override Assignment Setup application
Use the Environment Override Assignment Setup application to assign an environment to an environment override definition.
Environment definitions are configured in the Environment Override Definitions application. Learn more in Environment override configuration.
Messages
Application developers, system administrators, and implementation teams configure the system to automatically send messages or notifications when message events are completed.
Define your message event parameters with logic blocks. Examples of events are received orders, processed payments, or completed manufacturing processes. One or more tables are referenced in every message event definition. This allows you to access records, such as directory information or business data, to use in the message templates.
The content created in the message template is sent to designated recipients when the event occurs. Messages can be sent to specific email addresses, contacts in the platform directory, or user groups. Define the recipients in the Group Definitions application, Logic Block Builder application, or in the message definition itself.
All of the configured components are brought together in a message definition. Message definitions are unique to each environment. Learn more in the following topics:
- Message events
System administrators and application developers use message events to execute actions, such as run a report or send a message, if specific criteria are met during a business process.
- Message templates
Use message templates in message definitions to create automated messages and notifications. Message templates contribute the content for messages.
- Message definitions
Message definitions hold references for message templates, message events, and associated configurations. Together, all of the configurations create automated messages and notifications.
- Message configuration
Configure messages to be sent to external and internal recipients with the Message Event Definition , Logic Block Builder , Message Template Setup , and Message Definitions applications.
Message events
System administrators and application developers use message events to execute actions, such as run a report or send a message, if specific criteria are met during a business process.
Message events tell the system to execute the actions subscribed to or associated with the event. For example, you might want to send an email message to a group of stakeholders when an important milestone is met in a business process, or when a manufacturing process is completed. For more information on how business events are used in message configuration, see the Message configuration topic.
Message events are part of a framework that includes:
- Emitter—This is the condition that executes a message event, and then tells the system that the event has occurred. Some examples of emitters are logic blocks, approval definitions, scheduled jobs, and workflow notification failures.
- Consumer—Detects emissions, then directs event actions that are subscribed to the message event.
- Action—What happens as a result of a message event. Actions are subscribed to message events.
For example, in the AP Payment Remittance application, the following message event framework is included:
- Emitter—A logic block that determines when a payment is processed and then executes an event action.
- Consumer—A message event tells the Nextworld system to execute the action that is subscribed to the event.
- Action—A message definition detects the broadcast, and then sends an email message to the supplier that contains information about the payment
Message Event Definition application
Application developers use the Message Event Definition application to define message events which execute actions if specific criteria are met in a business process.
In message events you can configure one or more payloads where you specify the table which you want to retrieve records from. Your payload can include addresses for your emails, or can be used to provide interpolated values for your message content. This allows a message to reference specific data items from the table.
To create a new message event, select the Add button in the Payload Entries section. Different fields are required based on what Shape Type you select.
Once you have created a message event, define the parameters of the event in the Logic Block Builder application.
See the Queue Event action topic for more information.
Message Event Status application
Application developers use the Message Event Status application to view the status and other information for message events that have been triggered.
A record is created in the Message Event Status application every time a message event runs. The record stores information about when the message event was executed, the status, payload information and the user that executed the event.
Message Template Setup application
Application developers use the Message Template Setup application to create templates to use in recurrent messages, such as workflow notifications, approval messages, or emails.
Message templates are referenced in message definitions in order to provide the content. Message events are referenced in the same message definition to provide the parameters.
You can use values from tables referenced in the message event in the content of your message template. For example, you could reference a directory record to provide recipient information, or you could reference a date or time for when a business process was completed.
To include interpolated values from a table in your message content, use the format of:
{*PayloadEntriesName.DataItemName*}
Where:
- PayloadEntriesName is the name of the payload entry from the message event configuration. The Payload Entry subtable is where you reference a table in the message event.
- DataItemName is the name of the data item from the table that you want referenced in the message content.
If you do not specify the payload entry name, and only use {*dataitemname*} , the first payload entry in the subtable is defaulted.
To learn more about message definitions see Message definitions and Message Definitions application.
Message definitions
Message definitions hold references for message templates, message events, and associated configurations. Together, all of the configurations create automated messages and notifications.
Message definitions are unique to each environment. They may be defined by system administrators, application developers, or members of an implementation team. A message is sent to designated recipients when a defined message event occurs. For example, a message may be sent to all stakeholders when a manufacturing or accounting process is completed.
The message content is created in message templates. Both the message event and message template are specified in the same message definition in order to send the correct message to the designated recipients when the event occurs.
A message definition can also publish an event when a message reaches a status, such as Sent, Delivered, or Bounced. This lets you run logic as soon as the status is known, instead of checking on a schedule.
For more information see Message Definitions application and Message configuration.
Message Definitions application
System administrators and application developers use the Message Definitions application to specify when to send a message, what message to send, and who to send the message to.
There are several considerations when you configure a message definition, such as:
- You must configure message event which defines the parameters for when the messages should be sent.
- You must configure a message template with the content of the message you want sent.
- The message event and message template(s) must be referenced in the same message definition. This allows the messages to be sent to the correct recipients when certain message events occur.
- Messages are only sent if the Active checkbox is selected.
- You can specify the recipients in the message definition, or with logic blocks or decision matrices.
Trigger events based on message status
Use the Status Event Notifications subtable to run logic when a message reaches a status. For example, you can mark a case as Report Sent when an email is sent. For each row, specify:
- Statuses—One or more message statuses, such as
Sent,Delivered,Bounced, orComplaint Received. - Event Definition—The event definition to publish.
When the message reaches any of the selected statuses, the platform publishes the event with the message record as its payload. Use logic that subscribes to the event to act on it.
Learn more in Message events, Message Template Setup application, and Message configuration topics.
Group Definitions application
Use the Group Definitions application to define a group of users from the directory. That group can then be specified in configurations such as approvals, or message definitions.
Create a new group and specify recipients in the Users subtable. Optionally, you can define Backup Approvers for individual users. Once the group has been created, you can reference it in different configurations.
Messages
You can designate a group as the recipients in a message definition. This allows a group of users to receive notifications when a defined business event occurs. Learn more in the Message configuration topic.
Approvals
You can designate different groups in workflow approvals. These groups can be used in Decisions to designate conditionally which group receives the approval notification. Learn more in the Backup Approvers Configuration application topic.
List Lookup Cross Reference Utility application
Application developers use the List Lookup Cross Reference Utility application to create cross references for values which are represented differently between Nextworld and an external system, but are inherently the same. Cross references can change an external value to a Nextworld value in an import, or change a Nextworld value to an external value in an export.
For example, if Nextworld uses the list lookup values Male and Female and an external system uses the values M and F, you can create a cross reference that indicates that M = Male and F = Female. When you export records with the value Female, the value would display as F in the external system. If you import records. If you import records with the value F, they display as Female in Nextworld.
If an external system stores multiple values that describe the same concept, you can create multiple cross references to use with a data import definition. For example, an external system may store data about the month January with multiple values, such as 01, Jan, and january, while Nextworld uses the value January only. When you import data, you can create multiple cross references to indicate that 01 = January, Jan = January, and january = January to ensure all imported values appear as January in Nextworld.
Learn more in:
- List lookup cross reference configuration for data imports
Application developers use a cross reference in the Data Import Definitions application when values from an external system need to align with Nextworld list lookup values after they're imported.
- List lookup cross reference configuration for data exports
Application developers use a cross reference in the Data Export Definitions application when the Nextworld list lookup values need to align with the values in an external system after they're exported.
List lookup cross reference configuration for data imports
Application developers use a cross reference in the Data Import Definitions application when values from an external system need to align with Nextworld list lookup values after they're imported.
After you create a cross reference with the List Lookup Cross Reference Utility application, you associate it with a data import definition. Learn more in List Lookup Cross Reference Utility application.
In the Data Import Definitions application, add data mappings on the Mappings page. After mappings are added, configure the following:
- Select the Cross Reference check box for a data mapping. The external value for this mapping is replaced with the associated Nextworld list lookup value when imported.
- Select the External System for the import data on Data Source page. The External System you select must be the same as the External System specified in the List Lookup Cross Reference Utility application.
Cross references in a data import definition can affect the success or results of an import depending on:
- If the Nextworld field the external value is mapped to is a required field.
- If logic blocks run before or after the import process.
Required and optional fields
Cross references in the Data Import Definitions application process empty values from an external source differently depending on whether the Destination Field in a data mapping is a required field in the Nextworld table the records are being sent to.
If the external value is empty and the Cross Reference check box is selected, the import processes the cross reference in the following ways:
| Required field | Cross reference | Import status | Destination Field value |
|---|---|---|---|
| Yes | 01 = January | Failed import - Error | — |
| No | 01 = January | Successful import | [empty] |
Cross references and logic blocks
In the Data Import Definitions application, cross references modify import values during the import process. Logic blocks added on the Transaction page are configured to run either before or after the import process. This means that the time the logic block runs affects which value it processes.
For example, you can import different month values into Nextworld and have cross references configured as follows:
| External value | Nextworld value | Cross reference |
|---|---|---|
01 | January | 01 = January |
Jan | Jan = January |
A Pre-Process logic block processes the 01 and Jan values before the cross reference changes it to the January value.
A Post-Process logic block processes the January value, because the external values 01 and Jan have already been converted to January.
List lookup cross reference configuration for data exports
Application developers use a cross reference in the Data Export Definitions application when the Nextworld list lookup values need to align with the values in an external system after they're exported.
After you create a cross reference with the List Lookup Cross Reference Utility application, you associate it with a data export definition. Learn more in List Lookup Cross Reference Utility application.
In the Data Export Definitions application, add data mappings on the Mapping page. After mappings are added, configure the following:
- In the List Lookup Options field for a data mapping, select
Apply Cross Reference. For this mapping, the associated external value replaces the Nextworld list lookup value when exported. - In the Target System field, select the external system the export is being sent to. The Target System you select must be the same as the External System specified in the List Lookup Cross Reference Utility application.
File Location Setup application
Application developers use the File Location Setup application to connect Nextworld to external systems through an SFTP server. File location setup records are used in both data import and data export definitions to seamlessly integrate data between systems.
The File Location Setup record specifies the details of the external system and the credentials needed to access it. After the record is configured, you follow the same steps to associate it with either a data import or data export definition. In either the Data Import Definitions or the Data Export Definitions application, you must:
- Navigate to the File Location page and select
in the File Location Type field. - Specify the data source record in the File Location field.