Edit a Service Connection

After you create a service connection, you can edit the service connection, for example, to add and remove endpoints, modify requests and add functions for filtering and sorting responses.

Edit Service Endpoints

After you create a service connection and select the service endpoints, you can edit the endpoint settings, request parameters and response for each endpoint in the Endpoints tab.

If you edit an endpoint after you have created a type from it, you will need to manually edit the type to use any of the changes to the endpoint. A type created from an endpoint is not updated automatically when the endpoint is modified.

To edit a service endpoint:

  1. Open the Endpoints tab of a service connection.

    Description of service-connections-editortabs.png follows
    Description of the illustration service-connections-editortabs.png

    Tip:

    You can use the Replace definitions button to update the service definitions of all selected endpoints with the latest updated definitions from the service. The Replace Definitions button is available when the registered service connection is registered via the Catalog (Fusion Applications) or a service specification document ("ADF Describe"). The button opens the service wizard and you are prompted to verify the definitions that will be replaced.


    Description of service-connections-replace-endpoints.png follows
    Description of the illustration service-connections-replace-endpoints.png
  2. Click the endpoint you want to edit.

    For each endpoint the editor provides tabs for editing the endpoint’s settings, the request sent to the endpoint and the structure of the response.


    Description of service-connections-edit-endpoints.png follows
    Description of the illustration service-connections-edit-endpoints.png
  3. Click the service connection link in the breadcrumb to return to the list of service endpoints.

Add More Endpoints to a Service Connection

After you create a service connection, you can add more endpoints from the same source or add custom endpoints.

To add an endpoint to a service connection:
  1. Open the Endpoints tab of a service connection.
  2. Click + Endpoint and select Custom or From Original Service in the dropdown list.
  3. Select or define the new endpoint in the Add Endpoint dialog box.

    The options in the Add Endpoint dialog box for adding an endpoint depend upon the type of service connection and if you choose Custom or From Original Service. For example, if your service connection was created for a service from the catalog, if you choose to add an endpoint from the original service you can choose from the list of endpoints available in that service. If your service connection was created from an endpoint, you will need to specify details about the request and response to add a new endpoint from the same source.


    Description of service-connections-edit-addendpointdb.png follows
    Description of the illustration service-connections-edit-addendpointdb.png

Edit the Authentication Details of a Service Connection

After a service connection is created, you can edit the authentication details in the Authentication tab.

You might want to edit the authentication details when the authorization requirements of your app change, for example, you need to allow anonymous access to the service, you need to override the Tenant Settings for a service, or the authentication mechanism used during development won't work when you publish the app.

To edit a service's authentication settings:

  1. Open the Authentication tab of the service connection.
  2. Select Enable authentication / proxy.

    If the connection is to a service in your Service Catalog, you can select the Override option in the Authentication tab to override the default authentication options for the service.

  3. Select the Authentication Mechanism for authenticated users from the dropdown list and provide the required authentication details.
  4. (Optional) Select Allow anonymous access and select the Anonymous Authentication Mechanism from the dropdown list and provide the required authentication details.

Add Filtering, Sorting and Pagination Functions

You can write custom JavaScript functions to interpret requests to and responses from the service.

The Transforms tab contains a JavaScript editor that you use to edit the transform.js file that contains your transform functions. You typically use transform scripts to perform the following types of functions:
  • Pagination functions that limit the number of records that are displayed on a page in the REST client.

  • Filtering functions that define filter operations to specify the data to be returned and displayed in the REST client.

  • Sorting functions specify how to sort items returned from a collection resource.

To add transformation functions to a service connection:

  1. Open the Transforms tab of a service connection.
  2. Select Enable filtering, sorting and pagination transforms to display the JavaScript editor.

    When you enable the transform functions, the JavaScript editor displays some code fragments that provide examples of transform functions for requests and responses. The code is provided only as an example and should not be used in your application.

    You should deselect the checkbox and disable the transform functions if you are not going to write any functions.


    Description of service-connections-edit-transforms.png follows
    Description of the illustration service-connections-edit-transforms.png