Clarity
Studio Pages and Tabs

ccppmop1591
Portlets are small windows or snapshots into your data such as grids or charts. While portlets do not replace reports, they can be considered mini-reports. You can arrange portlets on pages with or without tabs.
 
 
2
 
 
A portlet page is composed of a set of portlets that appear for users with the appropriate access rights. You can configure a portlet page to allow users to personalize the page as follows:
  • Decide which portlets to show or hide on the page.
  • Decide where to show the portlets on the page.
Create a portlet page to collect and update information for users.
  • Create a portlet page without tabs to display a single page containing a few portlets. For example, one page with two portlets that display agile retrospective metrics for projects.
  • Create a portlet page with tabs to display a wide range of project information . For example, one page with separate tabs for Team, Tasks, and Financial Plans. Each tab collects a specific type of information about projects.
The following diagram describes how to create a portlet page:
This image shows the steps for creating a portlet page with or without tabs
This image shows the steps for creating a portlet page with or without tabs
Portlet Page Prerequisites
You can create portlet pages for master objects (for example, Project) or custom objects. You can add portlets on a Dashboard tab or any custom tab you create when creating a portlet page.
Consider the following planning information before creating a portlet page:
  • Decide whether the new page contains tabs.
    •  
      Pages without tabs
       display all of the content by organizing it on a single page. Use a portlet page without tabs when the amount of content is minimal and you do not need to group information under different tabs. The System Options page under the Administration menu is a good example of a portlet page without tabs. The page simply groups all of the information under different sections on the same page.
    •  
      Pages with tabs
       help you group several related pages of information under a single menu item. When you click a project instance from the Projects list page, the resulting page is an example of a portlet page with tabs. The following tabs help group various project information on the page:
      •  
        Team
        : Groups all project team-related information.
      •  
        Tasks
        : Groups all tasks and assignments information.
      •  
        Financial Plans
        : Groups all types of financial plans (cost plans, budgets plans, and benefit plans).
  • Determine how a page is used to decide where to place it in the main menu. Place end-user pages in the Home menu. Place administrative pages in the Administration menu.
  • Decide how much control users have for the page. You can control whether a page can be personalized so that users can add portlets and can create additional tabs. Once a user personalizes a page, changes made in Studio (except the addition of required portlets) do not affect those changes. To ensure that all users see the same page and any future changes, disable the Personalizable option.
  • Verify that the portlets exist that you want to display on the portlet page as content. Also verify that the page filters exist that you want to display on the portlet page to allow users to filter the information on the page. This article does not explain how to create portlets and page filters.
  • Verify that any user object actions exist that you add to the portlet page. For example, the project properties page includes the following user object actions by default:
    • Add to My Projects
    • Copy Project from Template
    Without these object actions, users have to navigate to the page that has the Add to My Projects or the Copy Project from Template option to perform these actions. Adding object actions to a page allows users to place the actions where it is most appropriate. They do not need to navigate away from the page they are working on.
  • Assign the following access rights to users so they can access the portlet page and portlets:
    • Portlet - View
    • Portlet - Navigate
    • Page - View
Create a Portlet Page with Tabs
Create a portlet page with tabs to group several related pages under a menu item. For example, the Team tab on the project page groups staff-related information; the Task tab groups all project tasks. If you have numerous portlets, create a portlet page with tabs to help improve the organization of the information. For example, the project properties page is a portlet page with tabs that groups various project information under tabs such as Team, Task, or Financial Plans.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click New.
  3. Complete the requested information. The following fields require explanation:
    •  
      Content Source
      Specifies where the data that appears in a portlet or portlet page originates.
      Default:
       Customer
    •  
      Type
      Specifies the type of page you want to create. Select Page with Tabs to create a portlet page with tabs.
    •  
      Layout
      Specifies how portlets added to a page or a tab appear. The number of columns indicates the number of portlets for each row and the percentage of the page that is given to each portlet. The Row layout can have one to three portlets in a row with equal space provided for each portlet.
    •  
      Personalizable
      Specifies if a user can make personal changes to a page or a tab. Only the user who changes the page or tab sees the changes.
  4. Click Save and Continue.
    The OBS section appears.
  5. If you are using OBS, select an OBS.
  6. To create additional tabs after the initial default tab, enable the Allow End Users to Add Tabs option.
  7. Click Save and Continue.
  8. Click the Tabs tab.
  9. Click New.
  10. Enter a name, ID, content source, and layout for the tab.
  11. To allow users to link to the tab from another page, click the Linkable option.
  12. Click Save and Return to create additional tabs.
Configure a Tab
For a portlet page with tabs, you can configure the tabs to enhance them in the following ways:
  • Add a link parameter to create a link to the tab.
  • Add existing portlets to the tab.
  • Add a filter to filter information on the tab.
  • Design the portlet layout.
For example, to create a portlet page with tabs displaying project retrospective information using Project, Release, and Retrospective tabs, configure the Retrospective as follows:
  • Add a link to the tab from the Project tab.
  • Add existing Release and Project portlets to the tab.
  • Add a filter to allow users to filter on specific project retrospective fields.
  • Arrange the portlets on the tab so that content is evenly distributed.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click the name of the portlet page.
  3. Click Tabs.
  4. Click the name of the tab to configure.
  5. (Optional) Complete the following steps to add a linkable parameter:
    1. Click Link Parameters.
    2. Click New and complete the requested information.
    3. Click Save and Return.
  6. (Optional) Complete the following steps to add portlets:
    1. Click Content.
    2. Click Add.
    3. Select the portlets that you want to add and click Add.
  7. (Optional). Complete the following steps to add a filter:
    1. Click Page Filters.
    2. Click Add.
    3. Select the appropriate page filter and click Add.
  8. (Optional) Complete the following steps to design the portlet layout:
    1. Click Layout.
    2. Place the portlets in the desired columns by selecting them and moving them to the appropriate columns.
    3. Change the number of columns using the Layout field at the top of the page.
    4. Click Save and Return.
Create a Portlet Page Without Tabs
Create a portlet page without tabs to organize the content that you want to display to the users on a single page. The content is organized across one or more portlets on the same page. For example, the License Information page in the Administration menu is a portlet page without tabs.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click New.
  3. Complete the requested information. The following fields require explanation:
    •  
      Content Source
      Specifies where the data that appears in a portlet or portlet page originates.
      Default:
       Customer
    •  
      Type
      Specifies the type of page you want to create. Select Page without Tabs to create a single page.
    •  
      Layout
      Specifies how portlets added to a page or a tab appear. The number of columns indicates the number of portlets for each row and the percentage of the page that is given to each portlet. The Row layout can have one to three portlets in a row with equal space provided for each portlet.
    •  
      Personalizable
      Specifies if a user can make personal changes to a page or a tab. Only the user who changes the page or tab sees the changes.
  4. Click Save and Continue.
    The Linkable option and the OBS section appear.
  5. Specify if you want users to be able to link to the portlet page from another page. If you select the Linkable option, the Link Parameters tab activates and you can set up link parameters for the page.
  6. If you are using an OBS, complete the following fields:
    •  
      Department
      Specifies the OBS department that is associated with the portlet page.
    •  
      Location
      Specifies the OBS location that is associated with the portlet page.
  7. Save your changes.
Configure a Portlet Page Without Tabs
Configure the portlet page without tabs so that you can add existing portlets and can design their layout. You can also add an optional page filter. For example, to create a portlet page without tabs that displays project retrospective information, configure the page as follows:
  • Add portlets to the page displaying content about projects, releases, and retrospectives.
  • Add a filter to allow users to filter on specific project retrospective fields.
  • Arrange the portlets on the page so that content is evenly distributed.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click the name of the portlet page you want to configure.
  3. Click Content.
  4. Click Add.
  5. Select the portlets that you want to add and click Add.
    The portlets appear in the content list.
  6. Click Save and Continue.
    The Page Filters tab activates, and the list of page filters appears.
  7. Click Add.
  8. Select the appropriate filter for the page and click Add.
    The filter is added to the list of filters.
  9. Click Save and Continue.
    The Layout tab activates, and the layout page appears. Any content portlets and filter portlets you selected are listed in the layout columns.
  10. Place the portlets in the columns that you want them by selecting and moving them to the appropriate columns.
    You can change the column layout using the Layout field at the top of the page.
  11. Click Save and Return.
Set Up Link Parameters for the Portlet Page
If you want users to be able to link to the portlet page, assign a link parameter that users can see in a selection list.
Set up link parameters so users can link to the portlet page from another page in the product. For example, if you create a resource status portlet page, you can create a link to that portlet page from the project team staff page.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click the name of the portlet page.
  3. Click Link Parameters.
  4. Click New and complete the requested information.
  5. Click Save and Return.
Assign User Access to the Portlet Page
Assign access to the portlet page so that users can see the portlet page containing the tabs and portlets. For example, if you assign access, the user can see a link to the portlet page in menus. The user can also open the page and can view the page contents. You can assign access in the following ways:
  • Assign the global access right 
    Page - Viewer - All
     to let users view all pages in the product.
  • Assign instance-level access right to view a specific page only.
 Users must have access rights to the data and the portlet page.
The following procedure explains how to assign individual users access to a specific page. You can also assign access by group or OBS unit. For more information about assigning access by group or OBS unit, see 
Administrating
.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click the name of the portlet page.
  3. Open the Access to this Page menu and click Resource.
  4. Click Add.
    The first step of a two-step process appears.
  5. Select 
    Page - View
     and click Add and Continue.
    If you want users to be able to edit the page, select all access rights.
    The second step of the two-step process appears.
  6. Select the names of the users to whom you want to assign access and click Add.
    If you have a long list of users to add, click Add and Select More.
  7. Click Return when you are done.
Add a Portlet Page to Menu Manager
Add the portlet page to the menu manager so users can access it using the main menu. For example, if you create a portlet page named 
Project Retrospective
, add the portlet page to the Home menu under the Portfolio Management menu.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Menu Manager.
  2. Click a menu.
    The menu hierarchy appears.
  3. Click Add.
  4. Select Page Link and click Next.
  5. Complete the page:
    •  
      Link Name
      Defines the label for the page link that appears in the menu.
    •  
      Page Name 
      Specifies the page that appears when the link is clicked.
    •  
      Parent Menu Item 
      Specifies the menu section in which the link appears.
  6. Click Save and Return.
  7. Open Home, and click the link name under the parent menu item you specified. For example, click Retrospective from Portfolio Management.
     If you do not see your changes reflected in the menu, click 
    Refresh
    .
  8. Verify that the portlet page that appears includes the appropriate portlets with the correct configurations.
Configure a Portlet Page Tab Set
You can configure how a tab set for a portlet page appears to users. The following table shows the tab set configuration actions and the tabbed portlet pages that allow the actions.
 
Portlet page:
 
 
What you can configure:
 
Custom tabbed portlet page
  • Add or delete custom tabs
  • Reorder Tabs
Default portlet page (all objects)
  • Add or delete custom tabs
  • Reorder Tabs
  • Activate or deactivate tabs to control what displays
  • Set a default tab to display initially
 
Project Default Layout
 page
Default portlet page
  • Add or delete custom tabs
  • Reorder Tabs
  • Activate or deactivate tabs to control what displays
  • Set a default tab to display initially
  • Add object actions to the tab menu
Create a Tab
You can add a tab to the following page types:
  • A custom portlet page with the page type 
    Page with Tabs.
     
  • A default layout page for an object; for example, the 
    Project Default Layout 
    page.
 
Follow these steps:
 
  1. With the portlet page open, click Tabs.
  2. Click New.
  3. Complete the following fields:
    •  
      Tab Name
      Defines the name of the tab as it appears to users in the application.
    •  
      Tab ID
      Defines a unique alphanumeric identifier for the tab.
    •  
      Content Source
      Specifies where the data that appears in a portlet or portlet page originates.
      Default:
       Customer
    •  
      Description
      Defines the purpose of the item being created and provides any relevant information.
    •  
      Layout
      Specifies how portlets added to a page or a tab appear. The number of columns indicates the number of portlets for each row and the percentage of the page that is given to each portlet. The Row layout can have one to three portlets in a row with equal space provided for each portlet.
    •  
      Personalizable
      Specifies if a user can make personal changes to a page or a tab. Only the user who changes the page or tab sees the changes.
    •  
      Linkable
      Specifies a tab can be linked to from another location in the application.
  4. Save your changes.
Reorder Tabs
You can set the order in which tabs display in the application. Some default portlet pages have a set order for tabs and do not permit you to reorder those tabs. You can reorder tabs that you create.
 
Follow these steps:
 
    1. With the tabbed portlet page open, click Tabs.
    1. Click Reorder.
  1. The Tabs list appears with the tabs in the current order. Any fixed tabs that you cannot reorder are listed above the Tabs list  .
  2. Select the tabs that you want to move and use the arrow keys to move them into the correct order.
  3. Save your changes.
Activate or Deactivate Tabs
Deactivate a tab to leave it in the tab list but keep it from displaying to users. You can activate the tab if you want to include it in the application for users in the future.
 
Follow these steps:
 
  1. With the tabbed portlet page open, click Tabs.
  2. For each tab, select the Active option to display the tab or clear the check box to hide it.
  3. Select the Default option to indicate the tab that is to display initially when the portlet page opens.
  4. Save your changes.
Select User Object Actions for a Tab Menu
You can select user object actions to appear on the  menu that appears for each tab.
 
Follow these steps:
 
  1. With the tabbed portlet page open, click Configure Tabs.
  2. Click Actions for the tab you want to configure.
  3. In the Default column, select the object actions that you want for the tab menu.
  4. Click Save.
Set Multilingual Names for a Portlet Page Tab
You can rename any stock or custom tab.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Open the portlet page.
  3. Click Tabs.
  4. Click the Translate icon next to the name of the tab you want to rename.
  5. Enter the new tab name in the appropriate language or languages, and click Save and Return.
  6. Click Properties.
  7. To make the changes visible to other users, click Publish.
Add Subpages to a Portlet Page Tab
Use a custom properties view to display multiple subpages on a custom portlet page tab. The custom properties view can be used for custom objects only, not stock objects. You can display subpage links on the tab as a menu option or a submenu option
The process for displaying multiple subpages on multiple tabs using custom properties views includes the following basic steps.
  1. Create a custom properties view.
    The custom properties view defines a set of subpages and the content that appears on each subpage.
  2. Add subpages to the custom properties view.
  3. Define the display of custom subpage links that appear on a custom portlet page tab.
Create a Custom Object Properties View
You can create one or more property views for a custom object on the System partition. The custom object properties view applies to all child partitions.
Only the 
Layout:Edit
 option under Setup in the Views definition is available for a custom properties view. You can use the new custom view on a page or tab layout.
 The Copy, View All, and Export to XML options are not available for custom properties pages.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Objects.
  2. Open a custom object.
  3. On the Properties page, click the Views tab.
  4. Click New. Enter the name of the new properties view and a unique ID.
  5. Click Save.
    The new properties view is added to the views list page.
  6. To use the new view, open Administration, and from Studio, click Portlet Pages.
  7. Open the default layout for your custom object and click the Tabs tab.
  8. Click New.
  9. In the Layout field, select Properties or Subtabs.
  10. In the View field, select the custom object view that you created.
  11. Click Save and Return.
    Instances of your custom object data appear on the new tab.
Add a Subpage to a Custom Properties View
You can add five subpages at a time to a custom properties view. The number of subpages you can add to a properties view is unlimited.
The custom properties view applies to custom objects only, not stock objects.
 
Follow these steps:
 
  1. With the custom object open, click Views.
  2. Locate the custom properties view and click [Layout:Edit] in the Setup column.
    The create page for subpages appears.
  3. Enter a name and ID for each subpage you want to create and click Save and Return.
    The layout page appears showing the new subpages.
  4. Populate the subpages with sections and attributes, and set up display conditions, if needed.
Move a Subpage Between Properties Views
If you have multiple properties views, you can move subpages from one properties view to another. You can change which view data appears for a tab. You can move subpages between stock and custom properties views.
 If a subpage is associated with a subobject, it cannot be deleted from a properties view. In this case, you can move the subpage to another properties view. A custom properties view applies to custom objects only, not stock objects.
 
Follow these steps:
 
  1. With the custom object open, click Views.
  2. Locate the custom properties view and click [Layout:Edit] in the Setup column.
  3. Select the check box next to the subpages you want to move to another properties view, and click Move.
  4. Select the option next to the properties view you want to move the subpages to, and click Move.
    The layout page reappears showing the subpage list without the moved subpages.
  5. Click Return.
    The views list page appears.
  6. Click [Layout: Edit] in the row of the properties set (view) where you moved the subpages.
    The moved subpages are listed in the layout page of the new view.
Delete a Custom Properties View
The following rules apply when deleting a custom properties view:
  • Subpages linked to a subobject associated with the custom properties view must be moved to another properties view before the custom properties view can be deleted. Subpages that are linked to a subobject cannot be deleted.
  • You cannot delete a custom properties view when it is associated with a custom tab. After you remove all associations, a check box appears that allows you to select the view for deletion.
  • You can only delete a custom properties view from the System partition.
  • When you delete a custom properties view from the System partition, the view is also deleted from child partitions.
 A custom properties view applies to custom objects only, not stock objects.
 
Follow these steps:
 
  1. With the custom object open, click Views.
  2. Select the check box for the custom properties view, and click Delete.
Restore Defaults for a Custom Properties View
You can restore the defaults for a custom view as you can for other views. Click Restore Defaults.
  • Restoring the defaults reinstates the original view properties for all users. 
  • Any personalized user changes to the view are overwritten with the defaults.
  • If the custom properties view is associated with a portlet page tab, the Restore Defaults button does not appear.
Display Custom Subpage Links on a Tab
For a custom object, you can display links for custom subpages on a tab in the tab menu or as a submenu item.
 
Follow these steps:
 
  1. Create custom object views and subpages.
  2. Verify that the associated page for a tab has a Type value that is equal to the custom object.
    The Type value is assigned when a page is created. If the Type value for the page you are adding subpages to is not equal to the object on which you created the custom views, continue with the following steps.
  3. Create a new page.
  4. Set the Type value equal to the custom object.
Display Custom Subpage Links as Menu Options
This procedure explains how to display a link for a custom subpage in the menu for a tab. This procedure assumes:
  • The subpage links are being added to a custom object default portlet page.
  • The custom object has had a custom property view added.
 
Follow these steps:
 
  1. Open Administration, and from Studio, click Portlet Pages.
  2. Click the name of the default custom portlet page.
  3. Click Tabs.
  4. Click New.
  5. Complete the following fields:
    •  
      Tab Name
      Defines the name of the tab as it appears to users in the application.
    •  
      Tab ID
      Defines a unique alphanumeric identifier for the tab.
    •  
      Content Source
      Specifies where the data that appears in a portlet or portlet page originates.
      Default:
       Customer
  6. In the Layout field, select Properties.
    The View field appears directly below the Layout field.
  7. In the View field, select the custom view with subpages.
    For information purposes, the individual subpages are listed out for each view with the subpages in parentheses. The subpage that you select is the default that appears for the view when you click the tab.
  8. Save your changes.
  9. View the changes in the application.
Display Subpage Links as Submenu Options
This procedure explains how to display a link for a custom subpage in a tab menu. This procedure assumes:
  • The subpage links are being added to a custom object default portlet page.
  • The custom object has had a custom property view added.
 
Follow these steps:
 
  1. Click Portlet Pages from the Studio menu.
  2. Click the name of the default custom portlet page.
  3. Click Tabs.
  4. Click New.
  5. Complete the following fields:
    •  
      Tab Name
      Defines the name of the tab as it appears to users in the application.
    •  
      Tab ID
      Defines a unique alphanumeric identifier for the tab.
    •  
      Content Source
      Specifies where the data that appears in a portlet or portlet page originates.
      Default:
       Customer
  6. In the Layout field, select Subtabs.
    The View field appears directly below the Layout field.
  7. In the View field, select the custom view with subpages you want to appear on the tab menu.
    For information purposes, the individual subpages are listed out for each view with the subpages in parentheses. The subpage you select is the default that displays for the view when you click the tab.
  8. Select Save and Continue.
    The Content tab activates. Use this page to define submenu options.
  9. Click New.
    A new row appears where you can define additional submenu options.
  10. Complete the following actions for each submenu you want to add for the tab  menu:
    1. Enter a name in the Subtab field.
      The name in the subtab field appears as the submenu name in the tab menu.
    2. Enter a unique identifier in the Subtab field.
    3. Select a property set (view) in the View (Subpage) field.
      The property view that you select appears in the submenu that is defined by the Subtab field.
    4. Click Save.
  11. Click Return.
  12. View the changes in the application.
Personal Portlets and Dashboards
Users can create their own portlets and pages in the application using the same functionality that is available in Studio. A personal dashboard is a type of portlet page. An end user can share a dashboard with other end users.
An end user can export all the content of some portlet pages (for example, the Overview page). The export includes any custom tabs added by the end user. The export is limited to pages of type 
Page with Tabs
 or 
Page Without Tabs
. The 
Fit to page 
option always applies where all portlets for a tab are exported to one page.
 Configure the portlet Chart Section and specify Datapoint Labels and Mouseover Labels. These labels and values also appear when exported to Excel or PowerPoint.
Access Rights for Personal Dashboards
The following table shows the administrator access rights that are required for personal dashboards.
 
Access Right
 
 
What it does in the application
 
 
Scope
 
Portlet Definition Editor
Lets an administrator edit a portlet.
Global/OBS/Instance
Page Definition Editor
Gives a user manager access to a dashboard.
Global/OBS/Instance
The following table shows the user access rights required for personal dashboards.
 
Access Right
 
 
What it does in the application
 
 
Scope
 
Dashboard - Navigate
Shows the Dashboards link for a user in the Home menu.
Global
Portlet - Navigate
Shows the Portlets link for a user in the Home menu.
Global
Dashboard - Create
Lets a user create a dashboard.
Global
Portlet - Create
Lets a user create a portlet.
Global
Portlet - View
Lets a user view a portlet.
Global/OBS/Instance
Page - View
Lets a user view a dashboard.
Global/OBS/Instance
Administrator Access to User Portlets
An administrator has different access to user portlets based on where access is attempted:
  • In 
    Classic PPM
     Studio, an administrator can view all user portlets, make changes to the portlets, and publish the changes.
  • In the application, the administrator can view only those portlets the administrator has created or portlets that have been shared.
Personal Dashboard Operations by User Type
The following table shows which dashboard functions can be performed by different types of users.
 
Dashboard Function
 
 
Studio Administrator
 
 
Dashboard Manager
 
 
Dashboard Viewer
 
Share
Yes
Yes
No
Edit properties
Yes
Yes
No
Publish
Yes
Yes
No
Personalize
No
Yes
Yes
Export
No
Yes
Yes
Personal Dashboard Properties
A dashboard has the following properties:
  • The portlet page type is either 
    Page with Tabs
     or 
    Page Without Tabs
    .
  • The dashboard layout can only be one of the following layouts: Two-column (50-50 percent), two-column (66-34 percent), three-column (25-50-25 percent), or three-column (33-33-33 percent).
  • The portlet page template is always 
    Application Page Template
    .
A dashboard has the following options when exported to Excel or PowerPoint:
  •  
    Fit to page
    : Exports all portlets on a tab to a single page.
  •  
    One portlet per Slide/Sheet
    : Exports each portlet to its own page. If both options are selected, this option takes precedence.