The Intrexx Connector API defines a Java API for implementing custom Intrexx connectors that make external data available in Intrexx via an external data group. In principle, the API specifies two Java interfaces that developers should implement in order to create, read, update, and delete records and files in the external system (so-called CRUD operations). In addition, a metadata model is stored in the connector's configuration file. This describes the structure of the data groups (fields, relationships, settings) provided by the connector implementation. At runtime, the Connector API provides preconfigured clients for HTTP and OData requests that automatically perform user authentication—if required by the service—using HTTP Basic Auth or OAuth2. Furthermore, any Java library (e.g., JDBC, REST APIs, etc.) can be used in your own code.
Quick Start Guide on GitHub
You can find a Quick Start Guide for the Connector API at the following link: Quick Start Guide for the Connector API.
Use in Intrexx
The Connector for Connector API is used in Intrexx for the following connectors:
Starting the Connector
From the main menu, select "Connector API / New Data Source, " or use the corresponding context menu to open a wizard where you can create a new connection. To do this, the Connector for Connector API must be selected under "Consume Data" in the left pane.
General
Name
Enter the name of the connection here. The name may only contain the letters [a-zA-Z] and numbers [0-9], as well as underscores and hyphens.
Id
Displays the ID of the connector or connection. This is automatically generated from the connector template and the connector's name, separated by an underscore.
Description
You can enter a description of the connector here.
Connector Template
When you create a new Connector API data source, the "basic" template is selected by default.
When you create a new M-Files 2.0 connection, the "mfiles" template is already entered here.
Connection Timeout
Timeout
Here, you can enter the number of milliseconds, seconds, minutes, or hours for the timeout. Select the time unit from the drop-down list to the right of the timeout field.
Active
If you set this option, the timeout settings are enabled.
Data Groups
The names of the entered data groups and fields are displayed here.
/ Edit Data Group
Opens a dialog box where you can add or edit data groups and fields.
Data Group Settings
Enter the name of the data group here.
Data Group Adapter
Displays the name of the data group adapter.
Data Fields
Displays the list of embedded data fields.
/ Edit data field
Opens a dialog box where you can define a data field.
Data Field
Enter the name here and select the field's data type.
Primary Key
With this setting, the data field is treated as a primary key field.
Click "Finish" to save your changes and close the dialog box.
Delete Data Field
Deletes the currently selected data field.
Data Group Settings
Displays the list of data settings. "Value" column
Add a setting
Inserts a line where a new setting can be defined.
Delete Setting
Deletes the currently selected setting.
Click "Finish" to save your changes and close the dialog box.
Delete Data Group
Deletes the currently selected data group.
Authentication
Authentication Type
Select the desired authentication method here. If "OAUTH2" is selected, you will also find the settings described below in the dialog box.
Grant Type
Currently, only the "authorization_code" type is supported here.
Authorized User URI
Enter the URI of the user-authorized server here.
Access token URI
Enter the URI used to obtain the access token here.
Redirect URI
The redirect URI is composed of the portal URI and "service/oauth2/authorize."
Client ID
OAuth2 client ID.
Client Secret
Secret for the client.
Scope
Permissions that the client should be granted.
User Services
This is where static login credentials can be assigned to Intrexx users.
Add a user
Opens a dialog box where you can enter the login credentials and set up the mapping.
User Selection
Search for users
Opens a dialog box where the user can be selected. Next, enter your specific Office 365 login credentials
-
Client ID
-
Client Secret
-
Scope
Click "Finish" to save your changes and close the dialog box.
Remove User
Removes the selected user from the list.
Expert Settings
The name and value of the attribute are displayed here.
Add Property
Adds a line in which another attribute can be defined.
Delete Property
Deletes the currently selected attribute.
Edit Existing Connections
Every connection you've created is listed in the right-hand pane. You can access all editing functions via the main menu or the corresponding context menu when a connection is selected.
Next Steps
Once the connection is fully configured, it can be integrated into applications using an external data group. You can find instructions on how to do this here.