Log in / Register Account

This guide is meant to help ease the pain for people who have been using Red Hat 3scale for quite some time and find themselves (a bit) lost in an all new navigation structure with an all-new look and feel.

 

The Big Picture

Navigation Structure

Increasingly, our customers are managing more than one or two APIs. This used to cause a lot of jumping around between Applications, ActiveDocs, Settings, and Analytics. The new navigation gives each API its own space where everything related to that API can be found.

Look and Feel

Red Hat 3scale API Management is part of a family of Red Hat products. And with the look and feel of the new navigation, 3scale fits right in. 3scale will continue to evolve with its product siblings at Red Hat.

Spaces and Switcher

The new navigation structure is divided into spaces that each have their own dedicated navigation. You can always see in which space you are at the top of the page. The three main spaces are: Dashboard, Audience, and API. And there are as many API spaces as there are APIs that you manage. In addition to the three main spaces, there are two additional spaces: All APIs and Account Settings.

At the top of each page, next to the product name, you’ll find a select box that tells you where you are and lets you switch between the three main spaces: Dashboard, Audience, and each one of your APIs. It also lets you search the API you’re looking for.

Dashboard

The dashboard space gives you a quick update on the status of your APIs and the people that use them. At the top, you’ll find the Audience section which links to all major items that directly concern your customers: Accounts, Billing, Portal, Messages, and Forum.

Underneath the Audience section, all your APIs are listed with direct links to the various items that relate to each one of them: Analytics, Applications, ActiveDocs, and Integration. You can also quickly search for a specific API.

Audience

The Audience space is all about your audience. It lets you manage Accounts, Billing, Portal, and Messages. It also lets you change the settings for each one of those features. So, for example, the settings related to the portal are found in the Portal section of the vertical navigation in the Audience space.

API

The API space is all about your API. There are as many API spaces as there are APIs that you choose to manage. From within an API space, you have access to Applications, Analytics, ActiveDocs, and Integration, a. All within the context of that API. Each API space starts with an overview page that summarizes its current status and usage.

All APIs

The All APIs space is a small space that gives you access to some items you might want to see independent of a specific API. It includes Applications, ActiveDocs, Alerts, and Traffic. You can access this space from the Dashboard at the top of the APIs section.

Account Settings

This space lets you manage everything related to your Red Hat 3scale account and personal settings. You can access this space from the top right corner of your screen by clicking the gear icon.

Q&A

Where are the settings?

App settings are managed in-context. So, for example, the settings related to billing can be found in Audience > Billing > Charging & Gateway. Settings related to your 3scale account have a dedicated space in: Account Settings.

 

Why does the navigation look the way it looks?

The navigation is powered by an open source library called PatternFly. The look and feel of the navigation and page header are based on PatternFly 3, the current stable release of PatternFly.

 

Why are not all spaces listed in the Space Switcher?

The space switcher is meant to give you quick access to the main spaces, which are Dashboard, Audience, and your managed APIs. The Account Settings space is accessible from the top right and the items in the All APIs space from the Dashboard.

 

Why, why, why (can I opt out)?

We feel your pain, but no. Give it some time, let it sink in, and then write us on the Customer Portal.

 


About the author