Making BMC Helix custom applications available from BMC Helix Portal

Before you begin

Perform the following steps before you configure the custom applications on BMC Helix Portal.

1. Login with tctl .
   For steps to log in by using tctl, see Creating tenants in BMC Helix Platform.

2. Make sure the tenant is configured with Interop OpenID Connect (OIDC).
   To confirm if the tenant is configured with OIDC, run the following command:
   

   tctl get tenant <tenant id> -o json

   This command provides the configuration details of the tenant in JSON format.
   

   Important

   To confirm if the tenant is OIDC type, check if the "type" object is set to "OIDC" under the "auth_context".
   
   For example:
   {

   "auth_context": {

                            "type": "OIDC",

                             }

   }

3.  To synchronize all the BMC Helix Service Management applications built on the BMC Helix Innovation Studio, the BMC Helix Innovation Studio must be registered with Tenant Management System (TMS) as an External service.

   To check the service details, use the following command:

   tctl get service <tenant id> -o json

    This command provides the list of all the enabled services activated for a tenant in JSON format.
   
   In the service details, make sure that  link_route_path is set to the correct URL.
   

   Important

    The link_route_path URL is the actual URL to the applications that is fetched from the BMC Helix Innovation Studio.
   

   For example,

   components": [

                  {
                       "link_route_path": "/helix/index.html#/com.example.lunchtutorial",
                   }
                ]

4. Make sure that the service is activated for a tenant. 
   Create a json file in the current directory with the BMC Helix Innovation Suite host name.

   For example,

   
   

   Response: {

     {
      "service_url": "http://clm-pun-sy3uqp.bmc.com:8008"
     }

    }

   When you launch the Innovation suite service from the BMC Helix Portal, The service_url is prefixed with link_route_path.

To configure custom applications

1. Create a JSON file in the current directory with the following entries: 
   1. api_endpoint_itsm  

   2. label with a valid name for an application source.

      For example,

       "metadata": {
                          "custom_ui_app_sources": [{

                           ....
                          "api_endpoint": <<Identity provider IS endpoint>>/api/rx/application/appinfo   // For example, <<Identity provider IS endpoint>> can be set as "https://itsm-admin.bmc.com
                          "label": "IS_CustomApps" //label that shows on Helix Portal
                                                 }]

                         .....
      
                        }
      }

      Where,

      •  https://itsm-admin.bmc.com  is the BMC Helix Innovation Studio host name.
      • /api/rx/application/appinfo is the Access Endpoint Name (APN) provided by ITSM from version 22.1.x.
        
        

2. To update the tenant-service for a tenant, run the following command:

   tctl update tenant-service <tenant-id> -I <service-id> -f <json-file-path>

3. To check whether the tenant-service is updated with the correct endpoint, run the following command:

   tctl get tenant-service <tenant-id>

4. Log in to BMC Helix Portal. 
   The customized applications are displayed in the list.