Working with Endpoints via Tooling

You can create a new endpoint or import an existing endpoint from an XML file, such as a Synapse configuration file using WSO2 Integration Studio. 

When you create an endpoint, you need to give it a name, at which point it appears in the Defined Endpoint section of the tool palette in WSO2 Integration Studio. To use a defined endpoint, simply drag and drop the endpoint from the palette to the sequence, proxy service, or other artifact where you want to reference it.

Creating a new endpoint

Follow these steps to create a new endpoint. Alternatively, you can import an existing endpoint.

1. Open WSO2 Integration Studio, and click Miscellaneous → Create New Config Project in the Getting Started tab.

2. Enter a project name and click Finish.

3. The new project will be listed in the project explorer.
4. Right click the project and go to New → Endpoint to open the New Endpoint Artifact dialog.
5. Select Create a New Endpoint and click Next.
6. Type a unique name for the endpoint, and then specify the type of endpoint you are creating.
   • Address Endpoint   - Defines the direct URL of the service.
   • Default Endpoint   - Defines additional configuration for the default target.
   • Configuring Failover Endpoints   - Defines the endpoints that the service will try to connect to in case of a failure. This will take place in a round robin manner.
   • HTTP Endpoint - Defines a URI template based REST service endpoint.
   • Load Balance Endpoint  - Defines groups of endpoints for replicated services. The incoming requests will be directed to these endpoints in a round robin manner. These endpoints automatically handle the fail-over cases as well.
   • Recipient List Group -  Defines the list of endpoints a message will be routed to.
   • Template Endpoint   - Allows to create a custom Endpoint template.
   • WSDL Endpoint   - Defines the WSDL, service and port.
7. Do one of the following:
   
   • To save the endpoint in an existing ESB Config project in your workspace, click Browse and select that project.
   • To save the endpoint in a new ESB Config project, click Create new Project and create the new project.

   • To save the endpoint in a Registry Resource Project, click Make this a Dynamic Endpoint, click the Browse button next to Save endpoint in and select the registry, and then select the registry (Configuration or Governance) where you want to save the endpoint. Lastly, type the endpoint name in the Registry Path box. 

     For instructions on creating a Registry Resource Project, see Working with Registry Artifacts.

8. Click Add Property to open the Properties tab and add the required properties.

   Parameter Name	Description
   Name	The name of the endpoint property.
   Value	The value of the endpoint property.
   Scope	The scope of the property. Possible values are as follows. Synapse Transport Axis2 axis2-client For more information about these scopes, see XPath Extension Functions.
   Action	This parameter allows you to delete a property.

9. Open the Endpoint artifact from the project explorer, go to the Form view, and update the additional configurations (which changes based on the type of endpoint you are creating).

   Field Name	Description
   Suspend Error Codes	This parameter allows you to select one or more error codes from the List of Values. If any of the selected errors is received from the endpoint, the endpoint will be suspended.
   Initial Duration (in mili seconds))	The time duration for which the endpoint will be suspended, when one or more suspend error codes are received from it for the first time.
   Max Duration (Millis)	The maximum time duration for which the endpoint is suspended when suspend error codes are received from it.
   Factor	The duration to suspend can vary from the first time suspension to the subsequent time. The factor value decides the suspense duration variance between subsequent suspensions.
   On Timeout Error codes	A list of error codes. If these error codes are received from the endpoint, the request will be subjected to a timeout.
   Retry	The number of re-tries in case of a timeout, caused by the above listed error codes.
   Retry Delay(in milliseconds)	The delay between retries in milliseconds.
   Timeout Action	The action to be done at a timeout situation. You can select from: Never Timeout Discard Message Execute Fault Sequence
   Timeout Duration (in milliseconds)	The duration in milliseconds before considering a request to be subjected to a time-out.
   WS-Addressing	Adds WS-Addressing headers to the endpoint.
   Separate Listener	The listener to the response will be a separate transport stream from the caller.
   WS-Security	Adds WS-Security features as described in a policy key (referring to a registry location).
   Non Retry Error Codes	When a child endpoint of a failover endpoint or load-balance endpoint fails for one of the error codes specified here, the child endpoint will be marked for suspension and the request will not be sent to the next endpoint in the group.
   Retry Error Codes	When adding a child endpoint to a failover endpoint or load-balance endpoint, you can specify the error codes that trigger this node to be retried instead of suspended when that error is encountered. This is useful when you know that certain errors are transient and that the node will become available again shortly. Note that if you specify an error code as a Retry code on one node in the group but specify that same code as a Non Retry error code on another node in the group, it will be treated as a Non Retry error code for all nodes in the group.

10. Click Finish. The endpoint is created in the endpoints folder under the ESB Config or Registry Resource project you specified, and the endpoint opens in the editor.

Importing an endpoint

Follow these steps to import an existing endpoint from an XML file such as a Synapse configuration file, into an ESB Config project. Alternatively, you can create a new endpoint.

1. Open WSO2 Integration Studio, and click Miscellaneous → Create New Config Project in the Getting Started tab.

2. Enter a project name and click Finish.

3. The new project will be listed in the project explorer.
4. Right click the project and go to New → Endpoint to open the New Endpoint Artifact dialog.
5. Select Import Endpoint and click Next.
6. Specify the endpoint file by typing its full path name or clicking Browse and navigating to the file.
7. In the Save Endpoint In field, specify an existing ESB Config project in your workspace where you want to save the endpoint, or click Create new Project to create a new ESB Config project and save the endpoint there.  
8. In the Advanced Configuration section, select the endpoints you want to import. 
9. Click Finish. The endpoints you selected are created in the endpoints folder under the ESB Config project you specified, and the first endpoint opens in the editor.