Integration Details

Option

Description

Created on

Displays the date and time when the Integration was created.

Created by

Displays the user who created the Integration.

Stages tabs

Displays different stages of the Integration development. You can pull Integrations from all other stages except from the Development stage.

Overview

Provides an overview of the Integration at each stage, that is, the components used to create the Integration, when the Integration was last modified, who last modified the Integration, when was the last execution, and whether the Integration is scheduled. You can also schedule, run, pause, or expose the Integration as a REST service from this screen.

Last 5 Execution Results

Click this tab to view the last five execution results panel. This screen allows you to view the audit trail of the executions that happened in a stage. See Execution Results for information on the Last 5 Execution Results table columns.

Edit

Click this option to modify the Integration.

Delete

Click to this option delete the Integration from a stage.

Run Now

Click this option to submit the Integration for execution. You can provide inputs to the Integration based on the defined input signature.

Uses

Displays the components used to create the Integration.

Last modified/Last modified by

When and by whom was the Integration last modified.

Scheduled status

If the Integration in a stage is scheduled, the status of the Integration displays Scheduled, else it appears as Not Scheduled. The Status appears as Paused if the Integration has been paused.

Last execution

When was the Integration last executed. A warning message appears if the last execution was not successful.

Next scheduled execution

When is the Integration scheduled to run again.

Schedule

Click this option to define a schedule. Select Run Once if you want to schedule the Integration to run just once immediately or run once at a specified date and time.

Select Run Recurrently if you want to define a recurrence pattern. You can define a recurrence pattern daily, weekly, monthly, and in hours. Select the frequency (Hourly, Daily, Weekly, Monthly) with which the pattern recurs, and then select the options for the frequency. Click the

icon to repeat the execution for daily, weekly, and monthly schedules. Click the

icon to delete the selected execution time for daily, weekly, and monthly schedules.

Click Reset if you want to permanently remove the current recurrence schedule.

Click Next to provide inputs to the Integration based on the defined input signature.

Modify Schedule

Click this option to change the existing schedule.

Pause

Click this option to pause the Integration that was scheduled.

Resume

Click this option to start the scheduled Integration that was paused.

Pull

Click this option to pull an Integration from a preceding stage into this stage. You can pull an Integration after you have configured the Accounts for each stage in the Account Configuration page.

Remove

Click this option to remove an Integration from a stage. You can remove an Integration from all stages except from the Development stage.

Enable executions to be restartable

For an orchestrated Integration, select this option if you want to enable Integration executions to be restartable or resumable. If an operation fails, you can resume the Integration execution from the point where it had failed from the Execution Results page (Resume option). Resuming an execution does not execute the previous successful operations but executes only the failed operations and operations that are not yet executed.

You can also restart an execution from the Execution Results page (Restart option). When an Integration is restarted, the execution occurs from the beginning of an Integration.

Note:

You cannot resume successful Integrations but can only restart them. If an Integration has referenced Integrations, then those referenced Integrations can also be restarted or resumed. Only top level Integrations are displayed in the Execution Results page and the referenced Integrations are displayed in the Execution Details page of that top level Integration execution. The Audit Log will display the "Restart" and "Resume" entries.

See Execution Results for more information.

Note:

If you enable this option, the time taken to complete the execution will increase.

If you change an Integration after an execution, you will not be able to resume or restart that execution.

If the pipeline data contains Object data types like streams, the field will not get serialized. This can cause issues while restarting an Integration as the field data will not be available.

Enable Integration to be invoked over HTTP

Select this option if you want to trigger the execution of an Integration from an external system. This option provides you with one more way to trigger Integration executions from a software application, for example, a REST client, apart from manual and scheduled integrations from the user interface.

Once the Integration is enabled to be invoked over HTTP, the HTTP request URL appears. Click the Show Advanced Options link to view the HTTP Method, sample JSON input, and the parameters that are required to invoke this Integration from an external system.

You need to provide the HTTP URL, Method, required JSON body, and necessary header parameters in the external program, including the required security credentials (user name and password) for invoking the Integration.

After the request is sent, the response will contain a status indicating whether the Integration has been submitted for execution. The response will also contain a reference to the execution result identifier so that a new HTTP call can be made later to get the execution results.

Application Status Codes

0 - SUCCESS: Successfully submitted the Integration for execution.

-1 - ERROR: Problem while submitting the Integration for execution.

HTTP Status Codes

200 - OK

201 - Created

500 - Internal Server Error

401 - Unauthorized User Error

To get the execution results, construct the URL of the new HTTP call from the URI field available in the Response section.

To construct the URL of the new HTTP call, add the response URI obtained from resultReference in the Response section to:

https://<sub-domain>.webMethodscloud.com

Example:

https://<sub-domain>.webmethodscloud.com/integration/rest/external/integration/execution/result?resultReference=76fb5733-6a21-4b02-864f-e958f698373

Application Status Codes

0 - SUCCESS

-1 - ERROR

HTTP Status Codes

200 - OK

500 - Internal Server Error

401 - Unauthorized User Error

404 - Not Found

Note:

You must provide your user name and password to execute the Integration from the external program, else you may encounter the 401 - Unauthorized User Error. Further, if the query response HTTP status code is 404 - Not Found, it means that either the Integration is not yet run or the resultReference is not correct.