Configuring a custom Default Instance Details UI service

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-01-20 10:38
After you upgrade to IBM® Business Automation Workflow 19.0.0.2 or 19.0.0.3, the customized Default Instance Details service from a Heritage Process Portal process app is no longer automatically used as the Default Instance Details UI service. However, you can manually customize your own Default Instance Details UI service and then use the default-instance-details-ui setting in the 100Custom.xml files to configure the service on Workflow Server and Workflow Center.

About this task

To customize a Default Instance Details UI service that can be used in IBM Business Automation Workflow 19.0.0.2 and later versions, copy the Instance Details UI Service Template service from the Dashboards toolkit to any project and then rename it and customize it as needed. After you have finished customizing the service, you can add or update the default-instance-details-ui setting in the 100Custom.xml files and use it to configure the service. For example, to add the setting to a 100Custom.xml file, you would add the following elements under the <properties> element and modify the value as needed:

<server>
   <default-instance-details-ui merge="replace">project_short_name/service_name</default-instance-details-ui>
</server>

For information about the individual 100Custom.xml files that need to be updated and their locations, see the topic Location of 100Custom configuration files.

However, to consistently and reliably change the value of the setting in all of the 100Custom.xml files in your Business Automation Workflow deployment environment, it is recommended that you use the updateBPMConfig command as described in the following procedure:

Procedure

  1. Stop the servers for Workflow Server and Workflow Center.
  2. Start the scripting client in disconnected mode as described in the topic updateBPMConfig command.
  3. Run the following commands to simultaneously update all affected servers: 
    wsadmin -connType none -lang jython
wsadmin> AdminTask.updateBPMConfig( [ '-create', '/server' ] )
wsadmin> AdminTask.updateBPMConfig( [ '-create', '/server/default-instance-details-ui', '-xNodeValue', 'project_short_name/service_name' ] )
wsadmin> AdminConfig.save()
  4. Restart the servers.

Results

The recommended way of updating the 100Custom.xml files is by running the updateBPMConfig command. However, if the updates are unsuccessful, you can manually update the files by following the steps in the topic Creating a 100Custom.xml configuration file.