Overview

• You can customize existing Order Hub pages and tables that appear within the user interface. By default, the user interface displays a predefined set of search fields or data fields. You can customize to show any additional data that is retrievable by the IBM Sterling Order Management API. Some supported customization scenarios include:
  • The Order search and Shipment search pages can be customized via configuration to add extra search fields that are supported by the IBM Sterling Order Management API.
  • Tables that are displayed on the Order and Shipment pages include a predefined set of columns. You can add more columns to show any additional data that is retrievable by the IBM Sterling Order Management API.
  • Order, Shipment, and Inventory details pages include a Summary section that display a predefined set of data fields. You can add more fields to show information that is retrievable by the IBM Sterling Order Management API.
  • More fields could be added to the Settings/Configurations/Data fields tab in order to allow the tenant to control its visibility.
• This repository provides:
  • Sample code that you can use as a reference to customize the different areas mentioned in the overview
  • A script to upload the content to your tenant

Setup

• Install yarn (For more information, see Yarn)
• yarn install to install dependencies
• Add or update environment variables with tenant information. For information about how to retrieve the client ID and secret, see Assigning a tenant type.
  • BUC_CLIENT_ID:
    • The Customization client id from the Order Hub user interface
    • if not specified, this will be prompted for
    • e.g., on unix-type systems: export BUC_CLIENT_ID=<value>
  • BUC_CLIENT_SECRET:
    • The Customization auth key from the Order Hub user interface
    • if not specified, this will be prompted for
    • e.g., on unix-type systems: export BUC_CLIENT_SECRET=<value>

Asset deployment

• Use the upload script with parameter all to deploy all assets:
  • search_fields.json (for information about the attributes in the file, see IBM Knowledge Center)
  • buc-table-config.json (for information about creating this file and the attributes in the file, see IBM Knowledge Center)
  • buc-field-details.json (for information about creating this file and about the attributes in the file, see IBM Knowledge Center)
  • buc-tenant-config.json (for information about creating this file and about the attributes in the file, see IBM Knowledge Center)
  • getPage-templates.json (for information about using this file to make the Order Hub pages retrieve extra information using custom API output templates, see IBM Knowledge Center)
  • translation JSON files (For information about translation file naming convention, click here)
• invoke using: yarn upload all [ <app1> [ <app2> [ ... ] ] ]
  • For example yarn upload all buc-app-order

Uploading

• run yarn upload for usage instructions

Translation file naming

• Naming convention for language translation files:
  • de.json: German
  • en.json: English
  • es.json: Spanish
  • fr.json: French
  • it.json: Italian
  • ja.json: Japanese
  • ko.json: Korean
  • pl.json: Polish
  • pt_BR.json: Portuguese
  • ru.json: Russian
  • tr.json: Turkish
  • zh_CN.json: Simplified chinese
  • zh_TW.json: Traditional chinese