Administration

Manage environment groups

Customers implement their solutions with IBM webMethods iPaaS products spanning multiple environments (one product installed in each environment) as well as each environment having stages like Development, Test, and Production. This feature helps in providing a more granular view of the transaction data by allowing you to filter the transactions based on the environment group and the related stages.

Using the environment group, you can view the transactions that span across more than one environment. Using the stages filter, you can further filter the transaction data based on the different stages the environments of the selected environment group are mapped with.

For example, let us assume there are two environments T1 and T2. A transaction starts from T1 and moves to T2. If the tenant is logged into T1, then the transaction details can be traced as the transaction starts from T1. However, if the tenant is logged into T2, then the transaction details are unavailable. To solve this, we have the Environment groups using which you can get the transaction details.

Creating an Environment Group

When you access End-to-End Monitoring from the App Switcher, you will see the following screen providing you the details on how to create environment groups. Select Next to start the environment creation process. This Environment group creation flow window will appear until you disable it using the Don’t show this message again checkbox.

You can skip this step and create the Environment groups at a later stage, by clicking the Later option.

If you selected Later on the onboarding screen, you can also create environment groups by following these steps:

1. Select End-to-End Monitoring. Go to User Profile > Administrator > Manage environment groups.

   

2. On the Manage environment groups page, click Create.

   

3. In the Create environment group window, provide an environment group name.

   Note

   You cannot change this name once you create the environment group.

   

4. In Filter by stage, select the stages based on which you want to filter the environments. You can select more than one stage. Stages may include the following:

   • Development
   • Testing
   • Production

   The application auto-populates the environments list based on your selection of Stages.

5. Select all the environments that you want to include in your group and click Save.

   Note

   After you select an environment, it will no longer be available for selection when you create another environment group. You can map an environment to a single environment group only.

6. On successful creation of the environment group, the application shows you a confirmation message and you will see the newly created environment group in the Environment group listing table.

   

Editing an Existing Environment Group

1. Go to User Profile > Administrator > Manage environment groups.

2. On the Manage environment groups page, click in the row of the environment group that you want to edit.

   

3. Make the required edits.

   Note

   You cannot edit the environment group name.

4. After you make the changes, click Save.

Deleting an existing Environment Group

1. Go to User Profile > Administrator > Manage environment groups.

2. In the Manage environment groups section, click in the row of the environment group that you want to delete.

   Note

   The deletion of an environment group is a permanent action.

   

3. On successful deletion, the application shows you a confirmation message and the environment group listing is updated.

Non IBM webMethods iPaaS tenants

If you are an IBM webMethods API Gateway tenant, the environment creation process is different from the above mentioned steps. Non IBM webMethods iPaaS tenants will need to contact IBM webMethods iPaaS Operations with the following questionnaire to assist in the creation of the environment groups.

1. What is the Account Name?

   The account name links the various environment groups together and is usually the customer name or the master account name in IBM webMethods iPaaS.

2. What are the environment groups, and the environments within each group?

   Specify a list of environment groups and the list of environments within each environment group and the stages (Development, Test, Pre-Live, Live) each environment belongs to. The list of environments within an environment group are used to filter the information when a given environment group is selected as part of the stages filter. All the environment groups will be linked to the same account name. Environment is also referred to as tenant in IBM webMethods API Gateway terminology.

The following table explains some valid and invalid configurations. You can use the same table template when you contact IBM support. Consider all these configurations for a given Account ID UPS.

Valid and Invalid Configurations

Dashboard and Alert Changes

The main dashboard page of End-to-End Monitoring contains a listing of all groups. There are new column entries available on this table as a part of the environment groups and stages feature. To view these entries, click . You can add the following additional columns for table sorting purposes:

• Environment
• Stage
• Environment Group

On the Dashboard page, All groups table, click . You will notice the additional column entries.

On the Alert page, Rule violations table, click . You will notice the same additional column entries as in the Dashboard page.

On the Alert page, Rule list table, click . You will notice the same additional column entries as in the Dashboard page.

Masthead Filters

After environments have been grouped as per your need, you can use the filters on the mast head to conveniently refine information listed on the Dashboard or Alert pages as per the Environment group or Stage in view or both.

The Dashboard page All groups table listing is filtered as per Logistic Environment group on the masthead:

Dashboard page All groups table listing filtered as per Development Stage in view on the masthead:

Alert page Rule list table listing filtered as per Sales Environment group on the masthead:

Example

Consider a scenario where the Environment groups in your account are mapped in the following manner:

On the masthead, when you select All Environment group and All Stage in view, you will notice that all the dashboard page widgets and All groups listing automatically update information as per the masthead selections.:

Next, create a group test2 which is linked to environment devuhm02 and save the group. Change the masthead selections to Fin1 Environment group:

You will now notice that the four widgets reflect new data and the new listing only shows test2 apart from All transactions.

You will notice similar filtering capabilities on Alert page:

Next, create a group test1 which is linked to environment prodenv1 and save the group. Change the masthead selections to Logistics Environment group:

You will now notice that the four widgets reflect new data and the new listing only shows test1 apart from All transactions.

Corresponding changes in Alert page:

Migration

Consider a scenario where you have an account with groups prior to account mapping. None of these groups are mapped to an environment group or stage. Let us take the following journey of migrating these groups to an environment groups and stages mapped account.

Let us start with creating two groups, Old_Success and Old_fail, with the below selected criteria:

At this stage, the masthead is empty and does not provide any options related to environment groups or stages:

Now let us create the environment group mapping with the below criteria:

Select the edit button against Old_Success and Old_fail groups and select Development stages for both groups:

The masthead filters are now able to filter the Old_Success and Old_fail groups. Hence, these groups have been successfully migrated to the new mapping.

Detailed Step-by-Step Tutorial

For a detailed tutorial, see Step-by-Step Tutorial - Stages.

Migrate assets

You can now export and import assets from one environment to another in End-to-End Monitoring. The term Assets is applicable to:

• Groups
• Rules

You can find the asset migration user interface at User Profile > Administration > Migrate assets.

Exporting assets

1. Go to User Profile > Administration > Migrate assets and click Export assets.

2. You will be able to view all environments that belong to your account. Current logged-in environment is selected by default.

   

3. You can export assets from a single environment or from multiple environments.

4. Click Export to download your assets. The downloaded .ZIP file follows this naming convention: e2em_assets_<datetime>.zip.
   For example: e2em_assets_2023-01-09_11-10-35.zip

You can use this .ZIP file to import your assets to any envioronment that supports the import assets functionality.

Importing assets

1. Go to User Profile > Administration > Migrate assets and click Import assets.
2. Select the .ZIP file that was generated when your assets were exported. Export again if your .ZIP file is modified or corrupted.
3. All source environments included in the asset export are now listed. Expanding each source environment, lists the groups and rules exported from that environment.

4. Against each Source environment, select a Target environment to which you need to import the assets. You can also partially import your assets by selecting Groups and Rules from the Source environment.

   

   

5. The target environment list contains all those environments within your logged-in account.

6. You will be provided an option to Skip or Overwrite, if your target environment contains assets with the same name as the imported assets. When you select Skip, only those assets that already exist in the target environment are skipped. When you select Overwrite, target assets are overwriten with source assets.

   

7. After a successful import, click the Download import summary button to download the import summary in .PDF format. This summary contains:

   • Overall import status
   • Import ID
   • Import date
   • Import user
   • Source and target environments
   • Individual asset import status

   

   

8. Import status can be Success, Partially imported, or Failed.

   

9. The following table explains individual asset import status. In certain situations, asset import can fail and backup asset restoration can also fail resulting in an inconsistent state of the asset. For such situations, it is recommended for you to take a backup of your target environment using the Export assets functionality, before attempting an asset import. Alternatively, contact IBM Global Support with the Import Summary PDF Report.