Viewing details about deployed runtimes and integrations

You can view information about a deployed integration's underlying APIs or applications, properties, and statistics.

About this task

When you deploy an integration in App Connect, you create an integration runtime, then deploy your integration to the runtime. On the Runtimes tab of the Manage page, tiles represent deployed runtimes, while deployed integrations are shown on the Integrations tab. These tabs also list integrations that are deployed to remote runtimes in other deployment locations that you're connected to. You can view details about all deployed runtimes and integrations on the Manage page.

Viewing details for deployed integrations

Procedure

  • On the Integrations tab of the Manage page, select a deployment location, then click the integration that you want to view.
    The Integrations tab contains tiles for five deployed integrations across all deployment locations. Three of the tiles have a Remote label, which indicates that they're deployed to a remote runtime. The runtime names are included on the tiles.
    Details about the deployed integration are shown in a series of tabs. The available tabs depend on the type of integration.
    Documentation
    The Documentation tab is shown for a REST API and contains documentation for the API. You can download the OpenAPI document from this tab as a JSON or YAML file.

    Contents
    The Contents tab shows the resources in your integration. The resources that you see depend on the type of flow that is deployed. The following examples show that a single tile represents an event-driven or API flow.
    The Contents tab for deployed event-driven and API flows. For each flow, the Contents tab shows a single flow, either an event-driven flow or an API flow.
    And the following example shows that a deployed Toolkit flow can contain resources such as applications, libraries, services, and REST APIs.
    The Contents tab for a deployed Toolkit flow shows 3 applications, 2 libraries, a service, and a REST API.
    Click each tile to see information about that flow or resource. For example, click an API tile to see the API endpoint that you can use to call the API.
    When you click an API tile, you can see the API type, protocol, endpoint, and security information.
    Or click a message flow tile to see the layout and properties for that flow. Select each node in the flow to see the properties for that node.
    The Layout view shows a Callable Input node connected to a Compute node, which is connected to a Callable Reply node. Properties for the flow are shown in tables.

    Properties
    The Properties tab shows properties for resource, flow snapshot, and flow archive statistics, and flow monitoring.

    Security
    The Security tab shows the basic authentication values that you need to make HTTP requests to HTTP or SOAP nodes in your flows.

    Basic authentication provides secure access to HTTP and SOAP input nodes in your deployed flows. If you enable basic authentication, HTTP requests to any HTTP or SOAP nodes on that runtime must specify the correct URL, a username, and a password. If you disable basic authentication, HTTP requests can access any of the HTTP or SOAP nodes on that runtime by using only the correct URL and no username or password.

    You can copy values on this tab by clicking Copy to clipboard Icon that represents copy to clipboard. You can also regenerate the basic authentication credentials on this tab to generate new credentials for all the integrations that are deployed to your instance.

    Other resources
    The Other resources tab shows resources in the integration such as XML schema, JAR files, ESQL files, JSON files, and maps.
  • To download all the data for your deployed integration in JSON format, click Download deployment data. The JSON file contains data that isn't shown in the user interface.
  • Click the tiles on the Contents tab to view more details for that resource. To download all the data for a resource in JSON format, click Download integration data. The downloaded JSON file contains some data that is not shown in the user interface.

Viewing details for runtimes

Procedure

On the Runtimes tab of the Manage page, select a deployment location, then click the runtime that you want to view.
Details about the deployed integration are shown in a series of tabs.
Tabs for a deployed integration to view properties, policy projects, data, credentials, security, and resource managers.
If a runtime that you create in the App Connect capability has multiple replicas, you can view the data for a specific replica. Expand the list of replicas and select the one for which you want to view data. Click Overview to see data for the runtime, or select a specific replica to see data for that replica. The data that is shown depends on whether you select the overview or a replica.
A deployed API flow has a Replicas field that lists an overview and two replicas.
Contents
The Contents tab shows an API tile for a Designer API flow or a Toolkit integration, or shows an Application tile for a Designer event-driven flow. You can click the tile to view further details about the API or application. For example, click an API tile to see the API endpoint that you can use to call the API.
When you click an API tile, you can see the API type, protocol, endpoint, and security information.

You can view the YAML file for an event-driven flow on the Other resources tab. You can also test an API as described in Testing a deployed API flow.

Properties
The Properties tab shows basic and descriptive properties, and properties for resource statistics, flow snapshot statistics, flow archive statistics, and flow monitoring.

Policy projects
The Policy projects tab shows a Policy project tile for any policy projects that are defined in the integration. You can click a tile to view further details about the properties. For more information, see Policies overview in the App Connect Enterprise documentation.

Flow statistics
If you select a replica for a runtime that you created in the App Connect capability, the Flow statistics tab shows message flow statistics and accounting data. This data is collected to record performance and operating details of one or more message flows. The data captures dynamic information about the runtime behavior of a message flow, and the snapshot data is updated automatically approximately every 20 seconds. When you first click the tab, you see a table that lists all the message flows in the integration. To display statistical data that relates to a specific message flow, click the name of the message flow in the table. In the resulting tabs, you can view the message flow's properties, graphical representations of the flow statistics and layout, the activity log, and endpoint information.

In an App Connect Enterprise environment, you can view this data in the Statistics tab of the web user interface, where you can access and administer a deployed integration's resources. For more information, see Analyzing message flow performance in the App Connect Enterprise documentation.

Resource statistics
If you select a replica for a runtime that you created in the App Connect capability, the Resource statistics tab shows performance statistics and operating details of the integration's resources. This data can help to indicate whether the available resources are being used in the most efficient manner. The snapshot data is updated automatically approximately every 20 seconds.

In an App Connect Enterprise environment, you can view this data in the Resource Statistics tab of the web user interface. For more information, see Analyzing resource performance.

Data
To assist with troubleshooting or auditing, you can use record and replay to view messages that pass through configured IBM® App Connect Enterprise message flows. You can then replay selected messages to an IBM MQ queue. If you configured record and replay for your integration, a tile represents a record and replay store on the Data tab. When you click the tile, the Messages tab shows recorded message data that is published for emitted event messages. You can mark (or select) message data on the Messages tab for replay. The selected messages are added to the replay list on the Replay tab, where you can resubmit these messages for processing to a selected IBM MQ message queue. For more information, see Replaying recorded messages (record and replay).

Credentials
The Credentials tab shows the credentials that were created and stored in App Connect Enterprise by using the mqsisetdbparms command or a vault.

Security
The Security tab shows the basic authentication values that you need to make HTTP requests to HTTP or SOAP nodes in your flows that are running in App Connect. You can copy values by clicking Copy to clipboard Icon that represents copy to clipboard. You can also regenerate the basic authentication credentials on this tab to generate new credentials. When you regenerate credentials, new credentials are generated for all integrations that are deployed to the selected integration runtime.

Resource managers
The Resource managers tab shows a list of resource managers in the deployed integration that contain properties for deployed resources, such as callable flows and ESQL. You can click any tile to view further details. For more information, see Resource managers and their properties in the App Connect Enterprise documentation.