Adding customizations

To customize Maximo® Manage, create a customization archive that contains your changes, add the contents of the archive to a compressed file, and add the updated files to the application when you deploy it.

Before you begin

Before you can add customizations to the application, you must create one or more archive files that contain your changes. Review the customization guidelines for details about the structure to use for the archive and the types of files that you can add. Then, complete the following tasks to create an archive:
  1. Create a directory that has a structure that matches the /SMP/maximo folder structure that is used for Maximo Manage.
  2. Add files that contain your customizations to the archive.
  3. When the archive is complete, add the archive to a compressed file.
  4. Put the compressed file in a location that is accessible to Maximo Manage.
If you use SSL and have a certificate that is not public, ensure that you provide the certificate details before you deploy the application.

About this task

You can add a single or multiple customization archives through the Maximo Application Suite user interface when you configure Maximo Manage.

Adding customizations by using the Maximo Application Suite user interface

You can add one or more customization archives through the Maximo Application Suite user interface when you configure Maximo Manage.When you configure Maximo Manage, you can add customization archives through the Maximo Application Suite interface.

About this task

Previously, only a single customization archive was available when you configured Maximo Manage. You can now add multiple customization archives when you configure Maximo Manage.

Procedure

  1. Log in to Maximo Application Suite as a system administrator.
  2. To navigate to the application details page:
    1. From the catalog, in the Applications tab, select the Manage tile.
      The application details page displays.
  3. To navigate to the Manage Workspace details page :
    1. Click the gear icon to go to the Suite Administration page.
    2. Click the Workspaces tile to update a previous configuration.
    3. In the Applications section, click the Manage tile.
      The Manage Workspace details page is displayed.
  4. To edit the existing configuration:
    1. Click Actions and select Update configuration.
    2. In the Customization row on the Update Manage configuration window, click the Edit icon.
  5. In the Customization section of the configuration window, click Add customization archive.
    The row in the Customization archives table becomes editable.
    1. Specify a custom alias name in the Alias field or leave the default value.
    2. Specify the URL for the customization archive file in the File address field.
      The following URL protocols are supported: HTTP, HTTPS, FTP, and FTP with SSL certificate.
      Restriction: SFTP protocol, that is, FTP by using an SSH tunnel is not supported.
    Note: To include more customization archives, click Add customization archive again.
  6. Optional: If you applied password security to the wget command to get the files, in the Credentials field, specify the user ID and password in the following format: 
    user=username 
password=password
  7. After you complete all configurations, click Apply changes.

Adding customizations manually to the custom resource

You can also add multiple customization archives to Maximo Manage, manually configure the custom resource for the Maximo Manage workspace.

About this task

If you use both the customization and the customizationList properties, the archive that you add to the customization property is processed last. When you specify a customization list, ensure that you list the files in the order that you want to process them.

Procedure

  1. In the Red Hat® OpenShift® Container Platform console, in the Administration section, select Custom Resource Definitions.
  2. In the CustomResourcesDefinitions window, select the ManageWorkspace custom resource definition record.
  3. In the CustomResourceDefinition details window, on the Instances tab, select the instance that you want to update.
  4. On the YAML tab for the instance, in the Settings sub-section, under the Specs section, specify values for the secret name for the archive credentials, the archive name, and the archive URL for each customization archive that you want to add.
    For Amazon Web Services or Cloud Object Storage (COS):
    1. Create a secret, for example, myawssecret with key as accessSecretKey and value as bucket secret key.
    2. Replace customizationArchiveName, customizationArchiveUrl, accessKey, and secretName with appropriate values as shown in the following example. 
      
  spec:
    settings:
      customizationList:
             - customizationArchiveName: customxml.zip
             customizationArchiveUrl: 'https://sampleBucket.s3.amazonaws.com/customxml.zip'
             useS3:
                 accessKey: #yourBucketAccessKey
                 s3Credentials:
                       secretName: myawssecret
  5. Save the change to the YAML file and allow the ManageWorkspace to reconcile.

    New builds are created and it fetches the customization archive from the S3 or COS bucket and maxinst as well as server bundles are restarted.