Test and publish integrations

Announcement: Application Integration is now available for your Google Cloud project. You can now use both Apigee Integration and Application Integration within the same Google Cloud project. Learn more

You can test or publish an integration from the integration editor after you have added and configured the integration with the necessary triggers, tasks, and edge connections. When you test or publish an integration using the Google Cloud console, the integration is executed in the synchronous mode.

Before you begin

If the integration you want to test or publish has a service account attached, grant the tester or publisher user account with the Service account user role on that service account.

For information about granting roles to a service account, see Manage access to service accounts.

Test an integration

Optionally, if you want to verify that your integration is working as intended, you can test it before publishing. Testing an integration lets you experiment with the integration input variable values, and helps in identifying any faults in the integration connection flow.

Note: Integrations that are configured with suspension-based tasks, such as Approval task, Suspend task, or Timer task, cannot be tested before publishing the integration.

To test run an integration, perform the following steps:

1. In the Apigee UI, select your Apigee Organization.
2. Click Develop > Integrations.
3. Select the integration that you want to test.

4. In the designer navigation bar, click Test.

   If you have multiple triggers configured in your integration, then select the trigger from which you want to test run your integration. The Test Integration dialog appears.

5. Click Test integration.

   Apigee Integration test runs the integration and displays the execution result in the Test Integration dialog:

   • To edit the input variables, click Edit input variables.
   • To retest the integration, click Retest integration.
   • To view and inspect the execution logs of the test run, click View logs.
   • If you have enabled Cloud Logging, then to view logs in Cloud Logging, click View Cloud logs.
   • To edit the integration without creating a new version of the integration, click Edit integration.
   • To close the test operation and return to the integration editor, click Close.

Publish an integration

Publishing an integration version deploys that integration version, and puts it in an active state. Any previously published version of the integration will automatically be unpublished, and all the services that rely on the previously published integration version will automatically use the latest published version.

To publish an integration, perform the following steps:

1. In the Apigee UI, select your Apigee Organization.
2. Click Develop > Integrations.
3. Select the integration that you want to publish.

4. In the designer navigation bar, click the Version dropdown, and select the integration version that you want to publish.
5. Click Publish.

   The Autogenerate Integration description dialog appears. If you want to generate a description, click Sure, continue. Otherwise, click No, just publish.

Upon successfully publishing your integration, you can view and inspect the execution logs of the published integration. To view logs, click Logs in the toolbar of the integration editor.

By default, Apigee Integration locks an integration from editing when it is published. To make any changes to the published integration, click Enable editing in the integration editor. Editing a published integration will create a new version of that integration.

Unpublish an integration

Unpublishing an active integration version undeploys that integration version, and puts it in a snapshot state. Any services that rely on the published version of the integration will automatically be stopped.

To unpublish an integration, perform the following steps:

1. In the Apigee UI, select your Apigee Organization.
2. Click Develop > Integrations.
3. Select the integration that you want to unpublish.

4. In the designer navigation bar, click the Version dropdown, and select the integration version that you want to unpublish.
5. Click Unpublish.

   After the integration is successfully unpublished, you can click Enable editing in the integration editor to edit the integration. Editing the integration will create a new version of that integration.

Best practice

Define the usability of a variable (input variable or output variable) before testing your integration. See Integration variables.