Custom API Guide¶

Portfolio¶

The Portfolio selector allows highlighting different elements of the pilot eyebrow by sending a “utility-nav” -> “portfolio” -> “section” key.

You can specify which section should appear as active with the section property. It should be one of the following:

• ‘account’
• ‘azure’
• ‘billing’
• ‘dashboard’
• ‘datapipe-cloud’
• ‘datapipe-one’
• ‘faws’
• ‘gcp’
• ‘intelligence’
• ‘myrack’
• ‘notifications’
• ‘other’
• ‘rackspace-cloud’
• ‘rms’
• ‘support’
• ‘tickets’
• ‘user’
• ‘vmware’

{
  "utility-nav": {
    "portfolio": {
      "section": "rackspace-cloud"
    }
  }
}

Account menu¶

You should customize the account menu if you want to show additional account or other options specific to your property. Provide a configuration with the “utility-nav” -> “menus” -> “app” key. (We use the “app” key for legacy reasons).

Note that, account menu configuration is not available for Datapipe users. Datapipe portals should not use these options. Portals that serve Datapipe users, should note that those users will not see this menu.

Example:

{
  "utility-nav": {
    "menus": {
      "app": {
          "items": [{
            "label": "Account",
            "uri": "https://app.objectrocket.com/account",
            "external": true
        }, {
            "label": "Billing Information",
            "uri": "https://app.objectrocket.com/billing"
        }, {
            "label": "Timezone",
            "element_id": "object-rocket-timezone-setting"
        }]
      }
    }
  }
}

NOTE Pre-Helix, we supported a label in the top-level app object, which corresponds to the text for the section in the account dropdown. Post-Helix, this is no longer used. If your property continues to send a label, Pilot will silently ignore that label.

Individual Item Schema:

NOTE if neither label or uri are provided, the item will not have hover highlighting

User menu¶

You can provide a “utility-nav” -> “menus” -> “user” key to specify custom content be inserted into the User menu.

{
    "utility-nav": {
        "menus": {
            "user": {
                "items": [
                    {
                        "element_id": "select_timezone",
                        "label": "Time Zone",
                        "uri": "/account#update-timezone"
                    }
                ]
            }
        }
    }
}

The rules for creating items with the “items” list are the same as above for the Account menu.

{
    "utility-nav": {
        "menus": {
            "user": {
                "switch_user_flow": "https://my_control_panel.rackspace.com/switch_user"
            }
        }
    }
}

{
    "utility-nav": {
        "menus": {
            "user": {
                "switch_user_flow": "https://my_control_panel.rackspace.com/switch_user",
                "switch_user_remembered_template": "https://my_control_panel.rackspace.com/login?username=[Username]"
            }
        }
    }
}

{
  "username": "appuser"
}

Support¶

——-DEPRECATED——-

All configuration of the support menu/link is deprecated. Moving forward, Pilot will always contain a Support menu. The support drawer flyout has been removed, and as such, you cannot replace its trigger with a custom link.

Formerly, Pilot showed a button to trigger a support drawer flyout. This flyout has been removed and replaced by a series of links in the “Support” menu, which duplicate the support drawer’s functionality. Pilot will ignore support configuration options as shown below. We recommend that all apps stop sending these options.

Control Panel Selector¶

——-DEPRECATED——-

The control-panel-selector has been deprecated and will be removed in a future pilot release. Please refer to the Portfolio section for updated documentation

The control panel selector is shown at the top left of the utility nav, and allows the user to switch between properties.

You can specify a label that indicates the currently active property.

{
  "utility-nav": {
    "menus": {
      "control-panel-selector": {
        "label":  "Rackspace Intelligence"
      }
    }
  }
}

Hiding Application/Primary nav¶

The primary navigation component is optional. You may choose to not show a primary nav if your project does not fit appropriately with the other items.

{
  "primary-nav": {
    "show": false
  }
}

Logout¶

You can override the logout uri that is shown in the account dropdown.

{
  "logout": {
    "uri": "https://intelligence.rackspace.com/saml/logout"
  }
}

Support Service Level¶

By default, pilot shows a support service level indicator when Rackspace Public Cloud is selected in the portfolio section. This could cause confusion if Rackspace’s support service levels do not apply to your services. There is a boolean option to turn off this visual indicator.

{
  "primary-nav": {
    "service-level-indicator": {
      "show": false
    }
  }
}