Solution Envoy

To access the Solutions Overview, click on Solutions in the left navigation. This will display the following information for each of the projects deployed in the namespace:

• Status: Shows the current status of the projects - whether they are running or not
• Open API: A button labelled as Open API. Clicking on the button directs the user to the Swagger UI that displays the APIs populated by the project.There is also the possibility to download the automatically generated IBM Business Automation Workflow tool kit (if defined for the API Namespace)
• Pipeline Run: The last successful pipeline run
• Available Pods: Shows the number of available pods out of the total number of pods. A pod is a group of one or more containers (such as Docker containers), with shared storage/network, and a specification on how to run the containers. The number of pods is assigned during deployment in the pipeline. They can also be increased in the scenario when there is an increase in load
• Agent Health: Shows whether the agents are currently running or not. It is displayed as a Boolean value and assigned as OK/Not OK. Hovering over the value shows the percentage of agents which failed in the last 24 hours. If less than 10% of the agents failed in the last 24 hours, the value's always OK. The value would be Not OK if more than 10% of agents failed in the last 24 hours
• Details: Accessing detail information for a project

To access the Database Overview, click on Storage. This page shows a cumulated overview of the databases and collections used by the projects. Please note, that all information is provided by the database itself and therefore logical integrity cannot be guaranteed.

• URL: The user can view the URL displayed besides the header. The URL is a technical connection string which represents the connection to the database
• Connections used: The number of connections used and the maximal number of possible connections
• Days uptime: The number of days the database is up and running
• Page faults: Shows the number of page faults. Page faults can occur as the database reads from or writes data to parts of its data files that are currently not located in physical memory

For each project also the following database information are presented:

• Status: Shows the current state of the database (OK or not OK)
• Objects: The number of data objects in each database
• Avg. Object Size: Shows the average object size. Average object size is calculated as the total data size divided by the number of objects
• Data Size: Shows the total size of the data in the database. Calculated as the average object size multiplied by the number of objects
• Indexes: Shows the number of indexes in the database

The user can see all message topics along with their partitions.

This area provides information on components that are running as infrastructure in a Solution Envoy or that are needed for developing projects.

Dashboard shows the following information:

• Running status: Shows the current status of the projects - whether they are running or not
• Pods available: Shows the pods available out of the total number of pods
• Build artifact: Displays the internal name of the component
• Build version: The version of the component
• Build ID: The associated build ID of the component

Solution CLI Setup:

Provides a link to download the config file to set up the CLI connection to the Solution Envoy. To be able to use the Solution CLI for implementing and debugging, it has to be set up using the downloaded file and the command provided in the description. For additional information see also Solution CLI.

Maven Dependencies:

Lists all Java dependencies that are needed in a Maven repository in order to develop a Generic Service Projects. All dependencies can be downloaded from here. For a more detailed description about installing and using the dependencies please see download dependencies for development of Java projects .

The user can view the following details of the project:

• Build pipeline run name: The ID of the last successful pipeline run
• Build pipeline timestamp: The timestamp of the pipeline run that deployed this project
• Build sha: The SHA fingerprint of the Git commit (a unique identifier that allows to retrieve the exact code that was used to build the project)
• Build artifact: Build artifact name of the hosting image in the project (domain-server)
• Build version: Build version number of the hosting image in the project
• Build ID: Build ID of the hosting image in the project

Also, all generated tool kits (.twx-files) are available for download there. For an API Namespace of a project a tool kit can be generated.

The user can see a card for each database collection in the solution and its database details. Database collections are defined while modeling the Domain Namespaces of a solution and hold the instances of a Root Entity.

• Size: Shows the total size of the data in the database
• Count: The number of data objects in each database
• Avg. Object Size: Shows the average object size. Average object size is calculated as the total data size divided by the number of objects
• Total Indexes: The number of indexes in the database
• Indexes: Shows the number of indexes in the collection
• Status: Shows the current state of the database

Shows all message topics along with their partitions.

Gives a short overview of which agents are available and their status. This section also provides a list of errors, that recently occurred.

• New: Number of events that are about to be worked on
• Running: Number of events that are currently worked on
• Failed: Number of events that could not be completed due to an error
• Completed: Number of events that were successfully processed