Managing custom JDBC connectors
Update the status of a custom JDBC connector to edit the connector's properties or to change its availability for users.
As you work on a connector, use the Draft and Inactive statuses and the Create copy action to experiment with the properties and the connection form. Only a connector with an Active status is available for users. It is important to test the connector to ensure that it can be used to create a connection.
You can delete a connector only with an Inactive status.
To change a status, you must have the Admin role for the Platform assets catalog.
Prerequisite
The Connectors tab is not visible by default. An instance administrator must enable users to upload or view JDBC drivers.
To view the statuses of custom JDBC connectors:
- Log in to the IBM® Software Hub web client. From the navigation menu, select .
- Select .
Active status
An active connector is available for users to create a connection from it in the New connection form. Users can create a connected data asset from the connection's data and use it in a job.
Click the overflow menu (
) for the following actions:
- New connection
- Create a new platform connection with this custom JDBC connector.
- View and edit
- Be careful if you edit an active connector. Any changes might disrupt any connections, connected
data assets, or jobs that users have already created with it.
In the Connection properties step, you cannot change the URL template, but you can add new optional properties under the Additional properties tab. You can edit existing properties in the Connection form configuration step but you cannot remove them.
- Create copy
- Create a connector as a copy and modify the properties as needed. By default, the connector's name is <current-name> (1). You can change the name.
- Deactivate
- Change the status to Inactive. If you deactivate a connector, it will be removed from the New connection form. Any connections, connected data assets, or jobs that users have already created with it will fail. After you deactivate a connector, you can delete it.
Draft status
A connector in a draft status is incomplete and is not available to users. It will not be listed in the New connection form.
Click the overflow menu ( ) for the following actions:
- Open draft
- Open the Create connector form at the first step.
- Preview and test
- Open the Connection form preview page to view the connection form and to test the properties.
- Create copy
- Create a copy of the draft. By default, the connector's name is <current-name> (1). You can change the name. You can save the copy of the draft as another draft or create a new connector from it.
- Delete
- Delete the draft.
Inactive status
An inactive connector is not available to create a connection from it. It will not be listed in the New connection form.
Click the overflow menu () for the following actions:
- View and edit
- Be careful when you edit a connector. If you reactivate it, any changes might disrupt any
connections, connected data assets, or jobs that users have already created with
it.
In the Connection properties step, you cannot change the URL template, but you can add new optional properties under the Additional properties tab. You can edit existing properties in the Connection form configuration step but you cannot remove them.
- Create copy
- Create a connector as a copy. By default, the connector's name is <current-name> (1). You can change the name. When you create a copy of an inactive connector, you can save it as a draft or create a new active connector.
- Activate
- Change the status to Active. When you activate a connector, it will be listed in the New connection form and users will be able to create connections from it. Any existing connections that were created from the connector will be available again.
- Delete
- Delete the connector permanently. Any connections that are created from the connector will fail.
Any connected data assets based on those connections will be disconnected from the data
source.
If you delete a connector and then create a new connector with an identical name and identical properties, any connections created with the original connector will fail. Users must re-create the connections with the new connector.