Making BMC Helix custom applications available from BMC Helix Portal

Use the information in this section to add the custom applications built in BMC Helix Innovation Studio to the BMC Helix Portal.

Before you begin

1. Log in to the tctl utility.
   For more information about the tctl utility, see Creating tenants in BMC Helix Platform in the BMC Helix Service Management Deployment documentation.

2. To confirm whether the tenant is configured with OIDC, run the following command:
   

   tctl get tenant <tenant-id> -o json

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

   Under the JSON object auth_context,confirm if the name type is set to OIDC.

   Example:

   {
       "auth_context": {
                            "type": "OIDC",
   
                       }
   }

To activate BMC Helix Innovation Suite for a tenant

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 verify whether the BMC Helix Innovation Studio is registered with TMS, perform the following steps:

1. To get the list of available services, run the following command:

   tctl get service <tenant-id> -o json

   The command generates a list of all active services for the specified tenant in JSON format.
   
   In the generated JSON list, under the object components, look for link_route_path.
   Assign the  BMC Helix Innovation Studio host name to the link_route_path.
   

   Example:

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

   A new service for the custom application is created on the tenant.
   
   

2. To activate the new service for the custom application on the tenant, perform the following steps:
   1. Create a JSON file in the current directory and save it as CustomApp_ITSM.json.
   2. Add the name service_url in the CustomApp_ITSM.json file.

   3. Assign the BMC Helix Innovation Studio host name to the service_url.
      Example:

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

       When you launch the applications built on the BMC Helix Innovation Studio from the BMC Helix Portal, the service_url is prefixed with link_route_path.

To configure the custom applications

1. Create another JSON file in the current directory with the following JSON objects:
   • api_endpoint

   • label

     "metadata": {
                        "custom_ui_app_sources":
     [{
     
                          "api_endpoint": <Identity provider IS endpoint>/api/rx/application/appinfo  
                          "label": "<IS_CustomApps>" //label that shows on Helix Portal
                            }]
     
                      }
     }

     Replace <Identity provider IS endpoint>  with the BMC Helix Innovation Studio host name; for example, https://itsm-admin.bmc.com.

     Replace <IS_CustomApps> with the Access Endpoint Name (APN) provided by BMC Helix Service Management.

     Example:

     "metadata": {
     
            "custom_ui_app_sources":              
      [{
                    "api_endpoint": "https://itsm-admin.bmc.com",
                    "label": "IS_APPS"
     
                }]   
            }

2. To update the custom application service for the tenant, run the following command:

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

   Replace <tenant-id> with the ID that is assigned to a tenant when you log in to BMC Helix Portal.
   Replace <service-id> with the Service ID of the custom application service that is generated after registering a service for a tenant.
   Replace <json-file-path> with the local path of the CustomApp_ITSM.json file where you have specified the service URL.
   
   

3. To verify 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 and verify that the custom application that you added is displayed under the Custom applications tab.