Connector Catalog
Use the Connector Catalog application to view the external systems which the platform can connect to. Learn more in Connector Catalog application.
In the Connector Catalog application, identify the record for the external system you want to connect with. The internal record name is used in the Connector Credentials and Connector Management applications.
Connector Credentials
Use the Connector Credential Setup application to specify the URL, authorization type, and authorization credentials for a connector. Learn more in Connector Credentials Setup application.
In the Connector Credentials application, you must:
- Create a new record.
- In the Credentials Name field, create a unique name. This name is referenced in the Connector Management record.
- In the Connector Name field, enter the internal name of the connector catalog record.
- Enter the URL and authorization type. If the authorization type requires additional information, fill in those fields.
- Optionally, enter an environment. If no environment is specified, the default environment from the external system's instance is used.
Connector Configuration Management
Use the Connector Configuration Management application to configure the specifications of their connection to external systems. Learn more in Connector Configuration Management application.
In the Connector Configuration Management application, you must:
- Create a new record and reference the connector catalog and connector credential records. If the external system is JDE World, also reference the gateway appliance record.
- Optionally, enter a default security group which ensures the metadata created by the connector is assigned to that security group.
- Configure your registration.
The configuration steps are different for each type of registration. View the following topics for more information:
Batch Data Sync registration configuration
Application developers configure batch data sync registrations within a Connector Configuration Management record to import data from an external system into a platform table.
Connector Configuration Management application
Inside your connector configuration management record, select the Register Batch Data Sync form action, then:
- Select a Registration Type. You can either send data to an existing table, or create a new table. If you sync to a new table, the table record is created when you save.
- Select the table from the external system which you want to data sync with. If this is the first time you are configuring a connector with that system, or a new table has been added in the external system which you want to connect with, select the Refresh Table field action.
- If the connector is to JDE World, select the Fetch Table Mappings field action. This field action is only available for this connection type.
- Select the Populate Mappings field action to import all of the fields from the external system.
- In the data mappings, select the Include Field checkbox on any fields which should be included.
- Enter a Destination Field for the included fields. If you are importing into a newly created table, you can either select an existing Destination Field or create a new data item by entering a value into the New Data Item Name field. If a value is entered into the Destination Field, the New Data Item Name field is ignored.
- Optionally, use filters to refine which records are included in the data sync. The filters are built over the internal table the data is being imported into, but are applied to the external table's data at runtime. You can only use certain expressions, such as Equal, Not Equal, Greater Than, Greater Than or Equal, Less Than, or Less than or Equal.
- Select the type of data sync you want to configure in the Import Mode field. You can have the data sync run for Inserts, Updates, or both. If the data sync runs for updates, select the match fields which you want included.
- Optionally, select the Enable Net Change checkbox. This ensures better performance for data syncs by only retrieving records that have been inserted or updated since the last sync. If selected, provide a field or fields that contain modified date information. For example, JD Edwards stores their date and time in separate fields, so you would select the date as the primary field and the time as the secondary field.
- In the Data Sync Interval field, select how often you want the data sync to occur. This can be once, recurring, or manual.
Once you save, a data import definition record is automatically created with your data mappings. On the Batch Data Sync page, you can view the data sync registration record you just configured, and:
- Select the Edit row action on the record to access additional scheduling options for your data sync, such as the recurrence rules, start date, and end date.
- Select the Edit Data Mappings row action to open the data import definition record where you can edit and update the mappings.
- Select the Execute Data Sync row action to manually execute the data sync.
Review the status of data syncs in the Data Sync Inquiry application, or on the Connectors dashboard page. Learn more in Connector Sync Inquiry application and Review connector sync statuses with the Connectors dashboard.
Logic Invocation registration configuration
Application developers configure logic invocation registrations within a Connector Configuration Management record to send business data and initiate a logic invocation within an external system.
Inside your connector configuration management record, select the Register Logic Invocation form action, then:
- Select your Logic Invocation Type. The types available are based on the connector catalog record you selected. For example, you may configure logic invocations of type
Orchestrationfor a J.D. Edwards connector. - Select the Reload External Listings form action to ensure you have the most current data from the external system.
- In the External Name field, select the external system invocation.
- In the New Logic Registration Name field, create a name for your invocation. Once saved, a logic block, input table, and output table are all created. The tables are work table which are used to pass input and output data between the external system and internal logic blocks.
- Save the record.
On the Logic Registration page, select the Edit row action on the detail record of your logic invocation, then:
- Review the name of your logic block, input table, and output table. The logic block cannot be updated or changed, but can be referenced by other logic blocks to use the imported data.
- In the Input Mappings and Output Mappings subtables, review the input mappings. The external system fields are automatically filled into the subtables, but you must map internal fields to those external fields. When you select internal field names in the subtables, they are automatically added to the underlying table.
Once created, logic blocks can call the logic registration by referencing the New Logic Registration Name. This is commonly done through use of a row or save action. For example, a transaction logic block could call the connector logic block, use Field Mappings to map data items from Nextworld into the J.D. Edwards invocation call, then map the output data from J.D. Edwards into an internal table.
Real-Time Data registration configuration
Application developers configure real-time data registrations within a Connector Configuration Management record to view data from an external system in real-time within a platform application. This data is not saved or persisted in the platform.
Real-Time Data registrations can be built over external data sources of type Orchestration or Data Service. If you create a registration over an external orchestration, you are registering a logic invocation from the external system to an internal platform table. Data service registrations connect an external table to an internal table.
Orchestration
Inside your connector configuration management record, select the Register Real-Time Data form action, then:
- If this is your first time creating a registration in this connector, or new external data sources have been added, select the Reload External Listings form action. This process runs in the background and sends a notification when it has completed.
- Select
Orchestrationin the External Data Source Type field. - Specify a name for the associated table the system creates for this registration. That table is automatically created in the same Product Family and Module as the connector configuration management record, and holds the real-time data as it comes in. To make changes to the fields, indexes, and other table options, edit the the configuration management record.
- Enter the name of the external orchestration and save the record.
On the Real-Time Data Registration page, select the Edit row action on your Orchestration record, then:
- Optionally, add a security group to secure the underlying table. Security is limited to RUID access.
- On the Field Mappings page, the input and output mappings are automatically populated for the external table.
- In the Output Mappings subtable, map the external grid to a platform subtable. Then, map any other fields you want included from the record.
- In the Subtable Output Mappings subtable, map each value you wanted included from the grid into a field within the platform subtable.
Once you save your registration, build an application of type Standard or Advanced List over the platform table associated with the registration. If the fields change in the external table, select the Refresh Resource row action on your registration and update the mappings.
Data Service
Inside your connector configuration management record, select the Register Real-Time Data form action, then:
- If this is your first time creating a registration in this connector, or new external data sources have been added, select the Reload External Listings form action.
- Select
Data Servicein the External Data Source Type field. - Enter the name of the external table, then select the Populate Mappings field action.
- In the Data Mappings subtable, select the Include Field checkbox on any fields which should be included.
- Enter a Destination Field for the included fields. If the data item you need does not exist, you must create it in the Data Item Definitions application.
Once you save your registration, build an application of type Standard or Advanced List over the platform table associated with the registration.
Route data changes back to the external system
To make changes to the external system's data, you must configure an action block over the real-time registration's internal table. An action block is automatically created and associated with the table once you save the registration. To configure, you must:
- In the connector configuration management record, navigate to the Real-Time Registration page and select the Edit row action on your registration record.
- Navigate to the Action Blocks page and select the Create Action Block field action.
- Select the type of action you want the logic block to perform, such as Insert, Update, or All. Once saved, the logic block is added to the Action Blocks subtable. You can either have an action block that performs ALL action types, or action blocks that perform individual actions.
- Select the View Action Block field action in the subtable to open the logic block, then:
- Delete the existing action.
- Configure the action block to call an external endpoint, or a logic block created in a Logic Registration within the same connector configuration management record. The processing logic block that the action block calls, or the Call External Endpoint action, must call an external API to perform the updates. You cannot configure the action block to directly make record changes.
- Do not change the action block's inputs or outputs. It can only be built over the registration table, and any other inputs or outputs added are ignored. To use additional inputs or outputs, add them to the processing logic block that this action block calls.
Connector Configuration Management application
System administrators use the Connector Configuration Management application to configure the specifications of their connection to external systems.
The Connector Configuration Management application is part of a large configuration process. Learn more in Connectors and Connector configuration overview
Reference the connector record from the Connector Catalog application which contains the correct external system information.
General Configuration page
Define the product module and product family. Optionally, define a default security group.
Enter the name of the credentials record from the Connector Credential Setup application which provides the URL, authorization type, and login credentials needed for the connector.
Batch Data Sync Registrations
Import data from the external system into a platform table.
Select the Register Batch Data Sync form action to open and configure your data sources. Once a data source has been saved, a record is created on the Batch Data Sync Registration page which you can view and edit. Select the Edit row action to open the details of the record. Navigate to the Scheduling page in the detail to configure the schedule for your data sync, such as the recurrence rules, start date, and end date.
Additionally, upon a save, a record is created in the Data Import Definitions application with your mappings and connector information. Select the Edit Data Mappings row action on the record to open the data import record. This allows you to edit or add additional field mappings to your registration.
Learn more in Batch Data Sync registration configuration.
Logic Registrations
Invoke business logic in an external system.
Select the Register Logic Invocation form action to open and configure your logic invocations. Once a logic invocation has been saved, you can select the Edit row action to create the input and output mappings. If the logic invocation has been updated on the external system, select the Refresh Resource form action.
Learn more in Logic Invocation registration configuration.
Real-Time Data Registrations
Show data from an external system within the platform in real-time.
Select the Register Real-Time Data form action to open and configure your data source. Once a real-time data registration has been mapped and saved, a record is created on the Real-Time Data Registration page which you can view and edit.
Learn more in Real-Time Data registration configuration.
Connector Catalog application
System administrators use the Connector Catalog application to view the external systems which the platform can connect to.
Each supported system has a record in the application. Reference the connector record name in the Connector Configuration Management application to configure your connector. Learn more in Connectors.
Currently, the platform allows you to connect to J.D. Edwards with orchestration logic invocation and to data sync.
General Configuration page
Review the supported versions, product family, and product module.
Connector Supported Logic Types page
Review the supported logic invocation types.
Learn more in Connectors and Connector configuration overview.
Connector Credentials Setup application
System administrators use the Connector Credential Setup application to specify the URL, authorization type, and authorization credentials for a connector.
To create a new connector credential, you must reference the name of an existing connector record from the Connector Catalog application. The connector catalog has a record for each external system which the platform can connect with. Then, you must specify the credentials needed for the system. For example, J.D. Edwards requires either a Username and Password, or SSO Authentication.
Optionally, specify an environment from within the external system. If no environment is selected, the default environment for the login credentials is used.
Once your connector credential record has been created, reference its unique key in the Connector Configuration Management application.
Learn more in Connectors and Connector configuration overview.
Connector Sync Inquiry application
System administrators use the Connector Sync Inquiry application to review the status of any syncs which have been attempted for connectors.
Each connector configured in the Connector Configuration Management application has a record in the application. Whenever a sync is attempted, whether manual or scheduled, the record is updated with the most recent information.
This application feeds data to the Connectors dashboard. Learn more in Review connector sync statuses with the Connectors dashboard.
Summary
Review the sync status, time of sync, and time of next sync scheduled sync.
Errors and Details
If the most recent sync failed, provides any internal platform errors related to the failure.
Learn more in Connectors and Connector configuration overview.
Data Sync Run Inquiry application
System administrators use the Data Sync Run Inquiry application to review records for data syncs which occurred as part of a connector.
Connectors facilitate communication between external systems and Nextworld. You can use them to send and receive data in a data sync.
Each record includes general information about the data sync, status of the run, and an attached CSV that includes all of the rows from the data sync. To view the CSV, select the Attachments form action.
Learn more in Connectors.