Customizing the user interface

You can update the IBM® Cloud Orchestrator user interface for a given domain.

1. Create a directory under <server_location>/etc/customizations with the name of the domain that you want to customize. The customization metadata is stored in the customizations.json file in a specific domain directory under the main custom directory. For example: <server_location>/etc/customizations/<Domain1>
   Note: By default, <server location> is the /opt/ibm/ico/ccs/scui directory.
   Note: Branding changes are only visible to the domain they are declared for, except the Default domain.
2. Create a file in the directory that you specified in step 1 and call it customizations.json.
   Note: Copy the customizations.json file from the <server_location>/etc/customizations/template directory to the new domain, for example, Domain1 and edit the file instead of manually creating the file.
   Note: All the files in the customization directory must be owned by the scui user.
3. Create a folder that is called images under the customizations/<domainName> directory. For example: <server_location>/etc/customizations/<Domain1>/images.
4. Copy the image file that is referenced in the content section of the customizations.json file into the same customizations/<domainName>/images directory. This method is used to ensure that all domain-specific customization content is in the correct location.
   Note: You can also add and create new images and add them to the images folder. However, you must update the customizations.json file, based on any new image file that you add.
5. Restart the scui service and clear the custom cache for the changes to be picked up. Restart the service by running the following command:

   service scui restart

   Enter the following link in your browser to clear the server cache:

   http://<ico_server>:<port>/customization/clearcustomcache

6. Log in to the IBM Cloud Orchestrator user interface with the domain that was customized and view the results to ensure that you are satisfied with the style updates. To open the login screen for a specific domain, for example mydomain, enter the following link in your browser:

   http://<ico_server>:<port>/login?domainName=mydomain

   Note: If an error is displayed in the user interface, it indicates that there is a problem with the customization. Perform the following tasks:

   • View the server logs to find more information about the error: /var/log/scui/scoui.log and /var/log/scui/scoui.trc.
   • Ensure that the domain directory is correctly named, the customizations.json file is in the correct format, and its contents are correct.