What is a page?
A page displays Entity data in different forms, such as a table, data summary, etc.
The basic concepts of a page
- When a Blueprint is created, a page is automatically generated. You can find it in the navigation bar, and it contains a single table widget;
- Pages are dynamic - you can create multiple pages that display diverse data, according to the filters you set in advance;
- Entity pages automatically appear for each new Entity you create.
Widgets enhance your developer portal by providing diverse visuals, based on the data ingested into Port.
A page can hold a single widget or multiple widgets, for example:
- Full table view widget;
- Markdown widget with the README of a service;
To learn more, refer to the Widgets section.
A tab is a sub-page within a page.
Pages can be separated into several tabs, each of which is a page that holds one or more widgets.
- Audit Log.
This page displays a table widget that details all the Blueprints specific Entities.
Each page type has a set of operations that can be performed from the UI.
The table below summarizes the available operations for every type:
|Page type||Save a view||Save view as|
a new page
|Edit page||Delete page||Lock page|
|Blueprint page (Default Page)||✅||✅||❌||❌||✅|
|Audit log page||✅||❌||❌||❌||✅|
|Custom page (generated from save as new page)||✅||✅||✅||✅||✅|
The default page is automatically generated when a new Blueprint is created. That page is directly tied to its Blueprint and it cannot be edited or deleted.
In order to edit or delete the default Blueprint page, you need to edit or delete the Blueprint itself.
It's possible to filter, sort, group by, and use the table widget controls to change the layout of the default Blueprint page directly from the default page.
All page operations are available on the right top bar, as shown here: (in line with the table above)
Save a view
Every change made on a specific page, such as filtering or sorting, enables the
Save this view button.
Clicking on it will save the new view for all users.
The ability to save a view for all users is available only for the Admin role
Save a new page
Each time a change is made on a page, and the
Save this view becomes enabled, you can press the small arrow on its right side to open the dropdown menu:
After clicking the
Save as a new page button, a window will pop up:
When saving a new page or editing an existing one, a set of icons is available to you:
Edit, lock or delete a page
By clicking the
... button on the top right corner, you can edit the page name and its icon.
Editing a page:
Locking a blueprints' page disables the option to hide columns or apply filters to modify the data shown in the page.
Locking pages gives you a way to specifically curate pages to your developers' needs and make sure they can't modify the views, this prevents them from seeing data that isn't relevant to them.
To learn how to lock pages, refer to the tutorial
An Entity page is deleted automatically when the connected Entity is deleted.
Table operations are used to define the user’s view of the Port platform.
We highly recommend using the table operations to provide a clean and accurate view of the platform for your developers.
All table operations are available on the top bar of the table:
You can filter a table by using the following menu:
To filter, you can define any filtering operator with a suitable value.
You can filter one or more values while setting the relation between each field filter with a:
My Teams Filter
By using the my teams filter you will only see entities that belong to one of your teams. This means you will only see entities from teams that you are a member of.
This filter works on:
stringproperties with the format
- The meta property
You can sort the table on the following menu:
You can sort by one or more fields of any kind.
To sort a specific column, click on the column title.
You can hide table columns on the following menu:
You can decide whether each field is viewable to users or not.
We highly recommend hiding irrelevant data from users, to provide them with a clean work environment, relieving them from any irrelevant distractions.
You can group by Entities on the following menu:
You can group results according to any field in the table.
Group by is recommended when you want to create custom views for users, such as "microservices by owners".
Just create your
group by setting, add additional viewing settings if needed, and save a new page from the custom view.
We provide a free text search option on tables. To search on a table, click the left side of the top bar:
Explore how to control page visibility with basic examples