Web Connections

SelectConnections & Parameters > Web Connections.

The Web Connections page lists the web connections you have uploaded toFME Flowalong withworkspaces.

Manyworkspaces that are run fromFME Flowrequire you to connect and authenticate to a web service. For example, aworkspacethat contains an HTTPCaller transformer may require you to authenticate to a web service, such as Google BigQuery, by providing your user name and password.

FME Flowallows you to securely store and reference the authentication parameters to these web services as self-contained objects, in the same manner as they can be stored inFME Workbench. When you run aworkspacefromFME Flowthat requires a web connection, the credentials associated with the stored connection are also referenced, so you do not have to re-enter them.

Adding Web Connections

There are two ways to add web connections:

  • FromFME Workbench: When you upload aworkspacetoFME Flow, and theworkspacecontains a web connection, you can specify whether to upload the connection along with theworkspace. If you choose to upload the connection, it is added to this page.
  • On the Web Connections page: ClickNew. Or, check the box beside an existing connection and clickDuplicate. On the Create (or Duplicate) Web Connection page, provide a name for the connection, and specify the type of service. Provide the remaining connection and authentication parameters, depending on type. ClickOK.
    • Note  "> NoteYou can only add web connections for services whose definitions withFME Floware complete. SeeManaging Web Services, below.

Using Web Connections

To use a web connection, it must be authorized with the web service it references.Workspaces that are uploaded fromFME Formcan run with the authorization credentials provided with the upload, as long as the access token from the web service is still valid. If the access token becomes invalid or cannot be refreshed with the web service, you must authorize the web connection directly withFME Flow. Alternatively, republish theworkspacefromFME Form.

To authorize a web connection withFME Flow

  1. If not already completed, configure the web service definition withFME Flow. For more information, seeManaging Web Services, below.
  2. Authorize the connection:
    1. Click on the connection to open it.
    2. On the Edit page, clickAuthorize.

Managing Web Services

When you upload aworkspacefromFME Formthat includes a web connection, a reference to the associated web service is also uploaded. You can also upload a web service directly from the Manage Web Services dialog inFME Workbench, under Tools > FME Options > Web Connections. To see the services that are uploaded, clickManage Web Services. The Web Services page opens. (To remove a web service from this page, select and clickRemove.)

In most cases,FME Flowpopulates your web service credentials from the web connection information uploaded fromFME Form. These credentials are enough to runworkspace年代,只要web服务访问token is valid. If the access token is no longer valid or cannot be refreshed, you must complete the web service configuration in order to authorize the connection directly withFME Flow.

To configure a web service definition in FME Server

  1. ClickManage Web Services.
  2. On the Web Services page, click on the web service you want to edit.

  3. On the Editing Web Service page, specify the service parameters. For most web services, you must provide authorization and connection credentials.

    Tip  "> TipFor information about creating an app, retrieving the app credentials, and setting the redirect URI , click the link besideExternal Help Links.
    • Client IDandClient Secret(OAuth2) orConsumer KeyandConsumer Secret(OAuth1): Credentials associated with an app. You must create an app in the web service and then retrieve the credentials for that app.
    • Redirect URI(OAuth2) orCallback URL(OAuth1): A web address that resolves to the location of the fmeoauth web application. If yourFME Flowis completely installed in the public domain, such as onFME Flow Hosted, the Redirect URI will have been set correctly when the web service was published. IfFME Flowis on-premises, you will likely need to change the URI. You must set the correct Redirect URI in the app you have created.
      • If yourFME Flowis configured to access web services through an entry in a public DNS service, use the Redirect URI generated from the service.
      • If yourFME Flowis configured to access web services through a DMZ, use the Redirect URI (https://<host>: <port>/fmeoauth) for the custom installation of the fmeoauth web service on thepublicmachine.
  4. ClickOK.

Removing Web Connections

Check the box beside one or more connections you want to remove, and clickRemove. In the confirmation dialog, clickOK.