3.1.4.1 Adding an External Service Widget

The External Service widget enables you to integrate external services into a pipeline. It supports both REST and PLSQL services, allowing pipelines to invoke external APIs or execute stored procedures during pipeline execution.

You can use the External Service widget either as a standalone widget or connect it to other widgets within a pipeline. Before using the widget, you can either create a new external service or select an existing one from the list of configured services. During pipeline execution, the widget invokes the configured external service and processes the response for use within the pipeline.

The following sections describe how to add an External Service widget, configure its properties, create new external services, and use existing services in a pipeline.

The External Service widget can be used independently or connected to other widgets in the pipeline, depending on the workflow requirements.

To add a new external service widget, follow these steps:

1. Go to the DTP Pipeline Designer.
2. Select External Service Widget from the list. The External Service page is displayed. The widget consists of the following tabs:

   Basic Configuration

   Use the Basic Configuration tab to select an external service that has already been created and configured. The selected service is associated with the External Service widget and is invoked when the pipeline is executed. Enter the following fields.

   Table 3-4 Basic Configuration

   Fields	Description
   Name	Select an existing external service from the drop-down list. The list displays all previously created REST and PLSQL services available for use.
   Description	Displays the description of the selected external service. This field is populated automatically based on the selected service and is read-only.

   Note:

   If the required external service is not available in the Name drop-down list, create a new external service using the Add External Service tab. Once the service is saved, it becomes available for selection in the Basic Configuration tab.

   Input Parameters

   Use the Input Parameters tab to view and configure the parameters required by the selected external service. The values entered are passed to the service during pipeline execution.

   Add External Service

   Use the Add External Service tab to create a new external service. You can configure either a REST or PLSQL service by specifying the required service details, endpoint or procedure information, and input/output parameters. Once saved, the service becomes available for selection in the Basic Configuration tab.

   To add a new external service, follow these steps:

   1. Select the Add External Service tab and enter the details in the following fields.

      Table 3-5 Add External Service

      Fields	Description
      EE Service Name	Enter a unique name for the service.
      EE Service Type	Select either REST or PLSQL from the drop-down.
      EE URL/Procedure Name	Specify the REST endpoint URL or the PLSQL procedure name.
      Description	Enter a brief and meaningful description of the external service. The description should clearly indicate the purpose or functionality of the service, making it easier for users to identify and select the appropriate service during pipeline configuration.
      Service Name	Enter the name of the application or service that hosts the external service. NOTE: Service name is applicable only for REST.

   2. Configure the required input parameters, if applicable. Input parameters define the values that are passed to the external service when it is invoke.
   3. To configure Input Parameters, open the Input Parameters section.
   4. Click the + icon to add an input parameter.
   5. Enter the Input Parameter Name, Input Parameter Value, and provide the Short Name, when required.
   6. Repeat the process for additional parameters.
   7. Verify the input parameters.
   8. Click to save the newly added external service.
3. Click Save to save External Service Widget. The saved service can then be selected from the Name drop-down when configuring the External Service widget.
   During pipeline execution, the External Service widget invokes the configured external service based on its selected service type.

   • If the external service is configured as REST, the widget sends a request to the specified REST API endpoint. The input parameters configured for the widget are passed as part of the API request, and the response is returned to the pipeline for further processing.
   • If the external service is configured as PLSQL, the widget invokes the specified stored procedure in the AML DD schema. The configured input parameters are passed to the procedure, and the procedure's output is returned to the pipeline.

   This enables pipelines to integrate with external applications through REST APIs or execute database business logic through PLSQL procedures during runtime.

   Note:

   The external service is invoked only when the pipeline is executed. Ensure that the configured REST endpoint or PLSQL procedure is accessible and correctly configured before running the pipeline.