Glossary

This glossary provides terms and definitions for the IBM Connector Development Kit™.

A

action

An action is the task that you want your connector to complete. An action can create, retrieve, update, or delete something.

app

A web or mobile device application.

automation

An action that is performed in response to an event or schedule. For example, sending an email on a weekly basis, or sending an email in response to an incoming email.

B

bot

Attended or unattended software that automates repetitive, tedious, and time-consuming back-end office tasks while you focus on high-value tasks. Bots can be created to complete a wide variety of tasks, as well as manage and schedule the bots based on the nature of the task.

C

completed

A connector must be marked as completed before you can download or publish it. A tick indicates that an item is complete. The pending icon (3 dots in a circle), as highlighted in the following screen capture, indicates that the item needs more work before the connector is considered complete. Check any fields highlighted in red.
Item incomplete

connector

The means by which a data source is connected to a product or service. For example, when you add an app, you are configuring a connector between the app and Connector Development Kit.

G

global parameter

A global parameter can be used with any action. It can only be created in the Schema tab for a connector. For more information see, Global parameters.

group

A group is a container for actions. Before you can add an action you must create a group.

H

header parameter

A parameter that is used to provide metadata about the request, such as the format of the request body, authentication credentials, or authorization. Header parameters are included in the request header and are not visible in the URL.

L

local parameter

A local parameters is only available within the action that you created it for. It cannot be used with other actions. For more information, see Adding query and header parameters.

Q

query parameter

A parameter that is used to sort or filter resources.

P

path parameter

A parameter that points to a specific resource. For more information, see Path parameters.

R

relationship

When you define a relationship, you are specifying the parent and grandparent relationships to get to the target object. For more information, see Defining relationships.

S

Software as a Service (SaaS)

Software that is fully managed by a provider, such as IBM, and available to customers on the cloud.