Using Named Database Connections

Many readers, writers, and transformers require you to connect and authenticate to database services in order to use them. For example, to use the Oracle Spatial Relational reader, you need to provide a service name, username, and password. Named connections provide a convenient and secure way to store and reuse these connection parameters. Each time you need to use the same connection in a workspace, you can use the named connection, rather than re-entering the connection parameters. If the connection parameters change, you can edit them in one place, rather than in each workspace that uses the connection.

Running workspaces that use named connections from FME Server is not supported. When uploading a workspace that uses named connections to FME Server, you must first expose any named connections.

When you use a named connection in a workspace, the Navigator displays only the connection name. The service name, username, password, and other connection parameters do not display. For example, here is how connection information displays in the parameters of a reader that uses a named connection.

Managing Named Database Connections

Named connections to database services are managed in the FME Options Database Connections tools (Tools > FME Options > Database Connections). Using these tools, you can edit named connection parameters and remove named connections. It is usually more convenient to add a database named connection at the time you are using one in a workspace. However, you can also add a named connection in Database Connections, and use it later in a workspace.

To Add or Use a Named Database Connection in a Workspace

You can add a named database connection, or use an existing one, at the time you want to use one in an Add Reader, Add Writer, or Transformer Parameters dialog.

For example, when adding an Oracle Spatial Relation reader, in the drop-down menu of the Dataset field, select Add Named Database Connection.

In the Add Database Named Connection dialog, specify the connection parameters, and the give the connection a name (or accept the default), and click Save.

Alternatively, if you do not want to use a named connection, in the drop-down menu of the Dataset field, select Exposed Connection Parameters. Then, click Parameters and specify the connection parameters in the parameters dialog.

The next time you need to use the newly-created named connection in a workspace, it will be listed in the drop-down menu of the Dataset field, along with any others you have created that apply to the format or service.

For more information, see the applicable topic in the FME Readers and Writers or FME Transformers Help.

To Change a Connection to Use a Named Connection in a Workspace

You can change an existing connection in a workspace to use a named connection.

If the object that is using the connection is a reader or writer, right click on the reader or writer in the Navigator, and select Use Named Database Connection.

If the object that is using the connection is a transformer, in the Transformer Parameters dialog, open the drop-down menu of the dataset connection.

To use an existing named connection, select the connection name.
To create one and use it right away, select Add Named Database Connection.

To Change a Named Connection to Use Exposed Connections in a Workspace

You can switch from using a named connection to using exposed connections.

If the object using the named connection is a reader or writer, right click on the reader or writer in the Navigator, and select Expose Connection Parameters.
If the object using the named connection is a transformer:
1. In the Transformer Parameters dialog, open the drop-down menu of the dataset connection, and select Exposed Connection Parameters.
2. Click the Parameters button. In the database parameters dialog, specify the connection parameters and click OK.
3. In the transformer parameters dialog, click OK.
For more information, see the applicable topic in the FME Transformers Help.

To Switch to a Different Named Connection in Multiple Places in the Workspace

You can change the same named connection that is used in multiple places in a workspace to use a different named connection.

From the menu, click Tools and select Edit Named Connections.

On the Change Named Connections dialog, locate the named connection that is currently being used in the workspace.
Click inside the Named Connection field and open the dropbox.
Select the named connection you want to use instead.
Click OK.