User guideConfiguring an external data object
External data object refers to the Kissflow artifact that enables users to consume data from external platforms through external data connections.
Creating an external data object
To consume data from external platforms, open any app and follow the steps below.
Click the Data icon (
) on the left navigation bar and select External data objects.
Create an external data object window opens. Enter the name and description, and choose the external connection from the drop-down menu.
Click Create.
If you don't have any existing connections listed, you can click + New Connection from the top right corner of the drop-down menu. You’ll be directed to the Create connection page.
Follow the steps outlined in Setting up an external connection to establish the connection.
Configuring an external data object
After creating an external data object, you should configure it to consume the data. This process involves three steps.
Select table
This section will show a list of all the tables available in your external data connection. You can select the specific table you want to consume from this list as an external data object.
Note:
To select a table from the database, the constraints are,
The table must have only one primary column.
Mandatory (constraint) columns must possess compatible data types.
Note:
If you can't find the table you are looking for, click Refresh to retrieve the latest list of tables from the external system.
Select column
All the columns present in the selected table will be displayed under Available columns. Here, you can choose the specific columns that you want your external data object to include.
Note:
All the columns with basic data types are supported in Kissflow. Whereas, any column with complex data type, although listed in the Available columns, will be greyed out and not be supported for consumption within Kissflow, that is, you cannot select these non-compatible columns.
Among the columns, the primary key, a unique identifier for each record in the table, and any column with the Not null constraint, is mandatory and automatically included in the selected columns list.
Configure columns
Before configuring the actual columns in the table, please note two prerequisites mentioned in the header.
- Connection mode: From the drop-down list, select whether you want the external data object to be read-only or write. If you opt for read-only, you cannot make any changes to your table in the external database from Kissflow. By default, the write mode is chosen.
- Time zone: You can select one of the time zones from the provided list. For more details, refer to Time zones in external data objects. By default, the timezone is set to UTC.
Field mapping in Kissflow
Now, when configuring the columns, the list of selected columns will be displayed, with their column name, data type, and constraint.
The kissflow counterparts: the Field name, Field ID, and Kissflow datatype will be auto-populated. Based on the datatypes in your external platform, the same or most compatible alternative will be replicated here. However, you can modify them as per your requirements.
Next to the Kissflow populated fields, you’ll have two options,
Mandatory: You can enable or disable the mandatory option for each field. By default, the primary key’s column (non-editable and considered as a reference item within Kissflow) and any Not null column from the table are mandatory, and you cannot undo them.
Delete: You can remove previously selected columns by clicking on the delete icon. However, this option is disabled for the system-mandate fields: Primary and Not null.
After you’re done with configuring the fields, click Save.
The configuration will be successfully set up and ready for consumption in lookup fields and integrations.
Note:
While the external data object is configured and operational in the development environment, to ensure its functionality in production, follow the steps outlined in Manage external data connections.