How to use IBM App Connect with PostgreSQL

Connecting to PostgreSQL

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your PostgreSQL administrator to obtain these values.

PostgreSQL connection fields:

Application type

Select the PostgreSQL environment that you want to use:

• PostgreSQL on-cloud - (the default)
• PostgreSQL on-premises (client managed)

Then specify values in the connection fields for your chosen environment:

Table 1. Connection fields for your chosen environment. Descriptions of the fields are given after this table.

PostgreSQL on-cloud	PostgreSQL on-premises (client managed)
PostgreSQL hostname and port	PostgreSQL hostname and port
Database	Database
Username	Username
Password	Password
Schema	Schema
PostgreSQL on-cloud certificate	PostgreSQL on-cloud certificate
PostgreSQL character set	PostgreSQL character set
	Network name

PostgreSQL hostname and port

The hostname and port number of the PostgreSQL database in the format <hostname>:<port>, where <port> is the default port of 5432 or a different port if configured

• Required: True

Database

The name of the PostgreSQL database

• Required: True

Username

The username of the PostgreSQL database

• Required: True

Password

The PostgreSQL user password

• Required: True

Schema

The schema qualifier to access the database objects. The default value is public.

• Required: False
• Default value: public

PostgreSQL on-cloud certificate

Required if the database is secured using TLS authentication. Specify the contents of the CA signed certificate for the database, in Base64 format.

• Required: False

PostgreSQL character set

Select the supported PostgreSQL character set

• Required: False

Network name:

Specifies the name of the network that IBM® App Connect on IBM Cloud will use to access your system. Required only if connecting to a system in a private network.

If you have already configured a network in IBM App Connect on IBM Cloud with access to the private network, you can select that network. Otherwise, you need to configure a network (download and configure a Secure Gateway) for use with a private network. For more information about how to configure a network, see Configuring a private network for IBM App Connect on IBM Cloud®.

Important: Ensure that the Secure Gateway Client has been started. If you need to, you can start the Secure Gateway Client as described in Configuring a private network for IBM App Connect: Finally, start and configure the Secure Gateway Client.

• Required: False

To connect to a PostgreSQL endpoint from the App Connect Designer Catalog page for the first time, expand PostgreSQL, then click Connect. For more information about ways to connect to PostgreSQL, see Managing accounts in App Connect.

General considerations

Before you use App Connect Designer with PostgreSQL, take note of the following considerations:

• (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

  For some applications, the events and actions in the catalog depend on the environment (IBM Cloud Pak for Integration or App Connect on IBM Cloud) and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

PostgreSQL events

These events are for changes in this application that trigger a flow to start performing the actions in the flow.

PostgreSQL actions

These are actions on this application that you want a flow to complete.

Accounts

Delete account

Update account

Create account

Retrieve accounts

Activities

Delete activity

Update activity

Create activity

Retrieve activities

Contacts

Delete contact

Update contact

Create contact

Retrieve contacts

Deals

Update deal

Create deal

Retrieve deals

Leads

Delete lead

Update lead

Create lead

Retrieve leads

Opportunities

Delete opportunity

Update opportunity

Create opportunity

Retrieve opportunities

More items are available when you have connected App Connect to PostgreSQL.