Property

Description

Connection

Resource Name

The name of the resource that you selected in the connector's Properties pane. The resources are defined in the Settings dialog box's Resources section.

Operation

Operation

Select one of the operations from the drop-down list.

The possible operations are:

• Read (Default)

This will let the user fetch the data for a widget/dataset defined in Knowi. The data will be fetched for the Query Object selected by the user.

• Write

This will let the user push the data for the selected entity or dataset to the Knowi endpoint. The Write operation supports additional configuration for Upsert mode and clearing the existing data.

Query Object

This field is available only when you select the Read operation in the Operation field. Click (ellipsis button) to load the available Entity/Query Objects available at the Knowi server.

Query Filter

This field is available only when you select the Read operation in the Operation field. Set the query filter to select the data as required. The SQL like Filter is supported by the Knowi API to manipulate the data returned. Check Knowi API documentation for filter syntax and options.

Limit

This field is only available when you select the Read operation in the Operation field. Enter the number of records to return. The default value is 500.

Entity

This field is available only when you select the Write operation in the Operation field. Click (ellipsis button) to load the Entity/Query Object list dialog. It will load the entities defined by the user on the Knowi Entities dialog on the Knowi resource. Before opening the dialog, use the Refresh schema button to load the available list of entities.

Upsert Mode

This field is available only when you select the Write operation in the Operation field. Use this check-box to update data for a specific set of keys. The keys are defined on the Knowi Entities dialog on the Knowi resource. Running this operation will replace all existing data for the entry containing the key, if the key exists. Otherwise it will insert the records if the record with key is not found.

Clear Data

This field is available only when you select the Write operation in the Operation field. By default, the data is added into the dataset on the Knowi server. Select this check-box to clear the existing data and replace it with the data defined here.

Result

Operation Success

Click (ellipsis button) to open the Variables List. Select a variable of logical type, where you want to store the connector's success or failure status.

This property is mandatory for Write operation.

Response Body

This field is available only when you select the Read operation in the Operation field. Click (ellipsis button) to open the Variables List. Select the variable where you want to store the API response. The default variable for this field will be C.UserBlob.

Error Body

This field is available only when you select the Write operation in the Operation field. Click (ellipsis button) to open the Variables List. Select the variable where you want to store the API error. The default variable for this field will be C.UserBlob.

Button

Description

Fetch Sample Data

This button is available only when the Read operation is selected.

Click this button to fetch the sample data limiting to maximum 10 records from the Knowi server. This data can be used to generate the schema for the selected Query Object.

For the user defined entities, the schema has to be generated using the Write operation.

Refresh XSD

This button is available only when the Write operation is selected.

Refreshes the current schema.

When you click Refresh XSD, the current schema is overwritten. A message dialog opens, and clicking OK confirms the update and the overwrite. Clicking Cancel exits the process without updating the schema.