Warning message

Log in to add comments or rate this document.

New navigation in 3scale admin portal – October 30th, 2018

Updated 2018-11-01T15:08:51+00:00

The Why’s

Navigation Structure

Our customers increasingly manage larger numbers of APIs. This leads to a lot of jumping around between Applications, ActiveDocs, Settings & Analytics. The new navigation gives each API its own space where everything related to that API can be found. Another often-hear complaint was the difficulty to find the settings for a certain feature. The new navigation gives access to feature specific settings, in the same submenu as the actual feature.

Look & Feel

The look & feel of the new navigation is in line with the look & feel of other Red Hat Middleware products. This will reduce the learning curve and improve the experience of using multiple Red Hat products.

Spaces

Spaces & Switcher

The new navigation structure is divided into spaces that each have their own dedicated navigation. The three main spaces are: Dashboard, Audience, and API.

At the top of each page, next to the product name, you'll find a select box (Switcher) that tells you which space you are at and lets you switch between the main spaces: Dashboard, Audience, and each one of your APIs.

There are as many API spaces as there are APIs that you manage. So if you manage and have access to three API's you will have three API spaces.

Masthead

Dashboard

The dashboard space gives you an overview of 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, Developer Portal, Messages & Forum. When you click any of those links you will find yourself in the Audience space.

Audience section

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, or create a new API.

APIs section

Audience

The Audience space is all about your audience in the broadest meaning of the word. It lets you manage Accounts, Applications, Billing, Developer 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 Developer Portal section of the vertical navigation in the Audience space.

Audience space

API

An API space is all about your API. From within an API space, you have access to Applications, Analytics, ActiveDocs, and Integration, all within the context of that API. Each API space starts with an overview page that summarizes its current status and usage.

API space

Account Settings

The Account Settings 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.

Account settings space

Q&A

Where is our logo?

We're sorry to inform you custom logo's on the 3scale dashboard are no longer supported. As you can see we've shrunken the header size to focus on the content. Furthermore the dark background of the masthead doesn't lend itself to flexible branding.

Where is my APIs page?

The dashboard is the replacement.

Where is the Analytics page?

Analytics for each API can be found within each API space.

How do I attach an existing ActiveDoc to an API?

When you edit an ActiveDoc you can select the service it should belong to.

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.

Where's the Traffic Report?

The Traffic Report feature (previously under 'Analytics') has been deprecated due to lack of usage. If you're actively using the Traffic Report, please reach out, we'd like to hear more!

Close

Welcome! Check out the Getting Started with Red Hat page for quick tours and guides for common tasks.