---
seo:
  title: "UI Tour"
  description: "A five-minute tour of the FixSpec platform user interface and the responsibilities of each key page."
llm_context: "Walkthrough of the platform navigation bar and main pages, noting that available sections vary by licence and user role."
category: "guide"
related:
  - "/platform/guides"
  - "/platform/guides/user_access"
  - "/platform/concepts/architecture"
---

## User Interface Tour

:::info Functionality-Based Licences
Your licence may restrict which functionality is available in your installation, so some of the pages described below may not appear in your environment.
:::

In this page, we present a high-level overview of the key pages of the platform, and discuss their responsibilities.

### Navigation Bar

At the top of each page is a consistent navigation bar, which gives access to the main sections of the platform, described below. Not all sections may appear, depending on your licence and user role.

![Figure: Header Navigation](https://docs.fixspec.com/api/docs/image/header_navigation.png)

- [Customers](#customers) is where you manage details about and start conformance.
- [Library](#library) is where you manage your API specifications.
- [Traffic](#traffic) is a real-time picture of API traffic collected from UAT environment(s).
- [Scenarios](#scenarios) is where you define and manage your API conformance scenarios.
- [Admin](#admin) is where you manage administrative settings and user roles.

### Dashboard

The main welcome page after logging in, which contains panels related to activity in your environment.

If you have conformance enabled, the primary panel will be an overview of all active certifications. Clicking on any of these rows will jump to the [detail of that certification](#certification).

![Figure: Active Certifications](https://docs.fixspec.com/api/docs/image/dash_active_certifications.png)

### Customers

This page is focussed on collecting and managing the customer details required to operate conformance.

![Figure: Customers Page Overview](https://docs.fixspec.com/api/docs/image/customers_page.png)

:::warning Mixed Firm Types!
Note that this page handles configurations for both YOUR firm (as platform operator), and your customers.

The set of tabs available will therefore change slightly depending on whether you are looking at your own firm or a customer. See the relevant sections for more information.
:::

Once you have selected a firm, the set of tabs available offer various configuration options.

- **_Contacts_**: Allows you to centralise a list of customer contacts across your team.
- **_Identifiers_**: Set up protocol-specific identifiers (e.g. FIX CompIDs) by environment.
- :color:My Firm Only::rgba(255, 218, 185, 0.6): **_Service Config_**: Defines conformance service configurations.
- **_Service Access_**: Where we grant and configure service access to customers.
- :color:Customers Only::rgba(230, 230, 250, 0.9): **_Certifications_**: A view of current and historic certifications for this customer.
- **_Capabilities_**: A report of customer capabilities by document version.

:::info
As you would expect, all customer and contact data is fully encrypted in our databases.
:::

### Library

The **_Library_** is the home for all of your API specifications, which are grouped together by _Issuer_. Small platforms are likely to only have a single Issuer, but larger organisations with either legacy brands or clearly-segmented business units may set up multiple Issuers to segregate API specifications.

Once API documents are attached to Issuers, the platform also **automatically** creates _Repositories_ by protocol. Repositories are a way of promoting good API governance by making it easy to compare element descriptions across documents, and standardise where appropriate.

![Figure: Library drop-down menu listing documents and repositories](https://docs.fixspec.com/api/docs/image/library_menu.png)

Selecting a Repository from this top menu will take you to the repository for this Issuer / protocol combination.

![Figure: Repository Landing Page](https://docs.fixspec.com/api/docs/image/repository_landing.png)

Selecting an Issuer from the top navigation menu will take you to a view of the documents on file for that Issuer, and have the option of starting (or uploading) a new document.

![Figure: Issuer Landing Page](https://docs.fixspec.com/api/docs/image/issuer_landing.png)

Documents themselves are sub-grouped into a configurable set of tabs (e.g. "Trading"), and we present links to the latest version by status.

- :color:DRAFT:white:rgb(3, 155, 229): specs are working versions that are not yet ready for conformance.
- :color:ACTIVE:white:rgb(236, 64, 122): specs are live versions used for conformance.
- :color:FINAL:white:rgb(67, 160, 71): documents are frozen versions that you have published to customers.

### Traffic

The **_Traffic_** page provides a real-time view of API traffic collected from your UAT environment(s). The subnav allows you to quick-filter by various dimensions such as document, version and customer, and the collapsible query filter (accessed by the :icon:fa-regular fa-chevrons-right: icon) offers even more options. You may also use your mouse to select a time window in the top graph section.

![Figure: Traffic Page](https://docs.fixspec.com/api/docs/image/traffic_page.png)

Below the timeline graph is a timeline of arrows showing traffic, and clicking on an arrow changes the decoded box in the bottom left, from which you can:

- Link to the relevant message in the specification.
- View the raw message or error details by clicking on the :icon:fa-regular fa-xmarks-lines: icon.
- Add a filter based on observed message values using the :icon:fa-regular fa-filter: drop-down.

:::tip
The set of tags shown in the timeline arrows shows sensible defaults, but can be configured at the message level. So if you have custom fields that are important to your workflow, just let us know.
:::

### Certification

The Certification page is your automated report of API conformance status and evidence.

![Figure: Certification Page](https://docs.fixspec.com/api/docs/image/certification_page.png)

Our platform is unique in that it uses a historical search method as opposed to sequential, real-time, box-ticking. This approach has a number of advantages, including:

1. Scenarios and specifications can be adjusted and re-certified without requiring customers to re-enter traffic.
2. The ability to easily flex the window over which certification evidence is considered (using the window slider).
3. The scope of a certification can be easily flexed.
4. Removing the need to watch certifications in real-time; simply visit this page whenever you want to see progress.
5. The ability for a single message to count towards multiple scenarios (to the extent that it meets the criteria for both).

![Figure: Certification Window Slider](https://docs.fixspec.com/api/docs/image/cert_window.png)

Each certification consists of a series of _Capabilities_ which, in turn, include a number of _Scenarios_, some of which will be marked as Mandatory or Core, and some of which may have minimum pass requirements. This page navigates those policies to provide two overall scores:

1. The percentage of Scenarios marked as "Core" that have passed, and
2. The percentage of all Scenarios that have passed.

Once a certification has reached completion (100% and all minimum thresholds met), then the **_Approve & Complete_** button will activate, and you will be able to sign the certification off and download the evidence report and certificate.

### Scenarios

This page is where you define and manage your API conformance scenarios. Scenarios are the building blocks of conformance, and are used to define the expected behaviour of your APIs.

![Figure: Scenarios Page](https://docs.fixspec.com/api/docs/image/scenarios_page.png)

Once you have selected the specification title and version from the navigation filter, you will see a list of capabilities and their nested scenarios. Selecting either a top-level _Capability_ or a nested _Scenario_ will show the relevant details and let you edit them if required. (The above screenshot shows the scenario view.)

:::info
Each specification version has its own set of scenarios, as the logic and functionality of your platform naturally evolves.

Whenever you clone a specification version then - of course - we clone the scenarios as well ready for adjustment, so that you don't need to re-enter them.
:::

### Admin

:::danger Restricted Page
Access to the admin page is restricted to users with the appropriate role.
:::

Within this page, administrators are able to create (human) users, as well as issue API tokens for automated integrations.

This page is also where Issuers are created and editors assigned. By associating protocols with Issuers, administrators are also able to create _Repositories_, creating a governance layer across all documents from that Issuer.

![Figure: Admin page showing issuer management](https://docs.fixspec.com/api/docs/image/admin_issuers.png)
