Creating New Portlet Definitions

To create an entirely new standard portlet definition, use the Create Portlet Definition wizard.

  1. Log on to PPM.

  2. From the menu bar, select Open > Administration > Portlet Definitions > Create Portlet Definition.

    The Choose Portlet Type step of the Create Portlet Definition page appears.

  3. Select the type of portlet to create.

    Portlet Type

    Description

    List

    Data is presented in tabular form using rows and columns.

    Pivot Table

    Data is aggregated in a table. Rows, columns, tables, and measurements can be grouped into categories.

    Bar Chart

    Data is displayed as vertical or horizontal bars. Each bar represents a single item.

    Clustered Bar Chart

    Data is displayed as vertical or horizontal bars. Bars can be grouped into categories.

    Stacked Bar Chart

    Data is displayed as vertical or horizontal bars. Each bar can be subdivided into categories.

    Pie Chart

    Data is displayed as a percentage of a whole.

    Line Chart

    Data is displayed to show changes over time.

    Bubble Chart

    Four dimensions of data are displayed on an x-y axis. The x-y axis location pinpoints a spot while the size and color of the bubble indicates additional dimensions of the information.

  4. Click Next.

    The Enter Portlet Information step of the Create Portlet Definition (<Portlet Type>) page appears.

  5. Provide the portlet details using the information from the following table.

    Field Name (*Required)

    Description

    Portlet Information section

    *Name

    Specify a unique name for the portlet.

    Type any alphanumeric string (up to 80 characters in length).

    Category

    Select one or more categories.

    Choices are limited to those categories available on your PPM instance.

    Manage Categories

    Click to add or delete portlet categories.

    See Managing Portlet Categories for details.

    Description

    Specify the portlet definition.

    Type any alphanumeric string (up to 1,800 characters in length).

    It's helpful to describe the main function of the portlet, such as "Shows projects for a desired program." This description is available when you add a portlet to your Dashboard page.

    Default Width

    Select the default width of the portlet.

    Choices include:

    • Narrow

    • Wide

    Note that the default width can be changed when the portlet is personalized.

    Enabled

    Indicate whether or not the portlet can be added to the Dashboard page.

    If a portlet is added to a PPM Dashboard, then disabled, the portlet remains on the Dashboard page.

    Data Source section

    *Data Source

    Select the data source for the current portlet.

    The portlet data source defines the columns or chart entity, and preferences fields for a portlet definition.

    New Data Source

    Click to open the PPM Workbench and create a new portlet data source.

  6. Click Next.

    The Set up Display Options step of the Create Portlet Definition (<Portlet Type>) page appears.

  7. Provide the appropriate information on the Create Portlet Definition (<Portlet Type>) page.

    The information needed to create the different portlet types vary significantly. Field descriptions are provided in the Supplemental Details for the Set Up Display Option Step section.

  8. Click Next.

    The Define Preferences step of the Create Portlet Definition (<Portlet Type>) page appears.

    Initially, all preference fields are mapped from the portlet data source, which indicates the name of the field, type of the field (such as auto-complete or text field), and any default value. Note that preferences requiring default values are shown with a red asterisk.

    1. (Optional) To change the width of preferences, click the Sizing icon ().

    2. (Optional) To rearrange preferences:

      1. Select a preference.

      2. Drag and drop the preference into the desired location.

    3. (Optional) To edit preferences:

      1. Select a preference.

      2. Click Edit.

      3. The Edit Portlet Preference: <Preference> dialog box opens.

      4. Provide the preference details using the information from the following table.

        Field Name (*Required)

        Description

        *Field Prompt

        Specify the prompt that will appear on the Portlet Preference page.

        Type any alphanumeric string (up to 200 characters in length).

        Display

        Select the manner in which this preference is displayed.

        Choices could include one or more of the following (depending on the component type):

        • Editable. Allows the user to edit the field.

        • Required and Editable. Requires the user to provide a value.

        • Non-Editable. Allows user to view, but not edit the field.

        • Hidden. The information is not viewable (or editable) by the user.

        This field is required if a default value is required by the portlet data source.

        Default Value

        Specify the default value that is shown when editing the portlet.

        This field is required if a default value is required by the portlet data source.

      5. Click Done.

        The changes to preference are saved and the Edit Portlet Preference: <Preference> dialog box closes.

    4. (Optional) Select Show Preferences summary on this portlet (user can choose to hide it) if you want the user to have this capability.

    5. (Optional) Select Require user to edit preferences before viewing portlet for the first time if you want to force the user to edit their preferences.

  9. If you do not want to change any of the remaining default values, click Finish. Otherwise, click Next.

    The Configure Portlet Communication step of the Create Portlet Definition (<Portlet Type>) page appears.

    1. (Optional) Select Enable portlet communication (user can choose to disable it) if you want the user to have this capability.

    2. If portlet communication is enabled, you must provide an event topic. Use the auto-complete button to provide an existing event topic or click Manage event topics to add a new topic or delete an existing topic.

  10. If you do not want to change any of the remaining default values, click Finish. Otherwise, click Next.

    The Configure Access step of the Create Portlet Definition (<Portlet Type>) page appears.

    1. (Optional) In the User Access section:

      1. Select one or more access grants (privileges) a user must have in order to add the portlet to a Dashboard page.

      2. Select one or more users or security groups allowed to add the portlet to a Dashboard page.

        By default, access is given to all users belonging to the PPM User security group.

        Tip: Whenever there is no specific (individual or group) user access, this setting reverts to its default.

    2. (Optional) In the Administrator Access section:

      • Select one or more users or security groups allowed to modify the portlet.

        By default, access is given to all users belonging to the PPM User Admin security group.

        Tip: Whenever there is no specific (individual or group) administrator access, this setting reverts to its default.

    3. (Optional) In the WSRP Access section:

      • Select if you want to make the portlet available to WSRP consumers.

      • Click Preview to review the layout and make sure that you have presented the information as desired.

    4. (Optional) In the Drilldown Access section:

      • Select if you want the portlet to support drill-down access.

  11. Click Next.

    The changes are added to the new portlet definition and the Add User Help step of the Create Portlet Definition (<Portlet Type>) page appears.

  12. In the Portlet Help Text field, type the help text.

    This field supports HTML. Use valid HTML tagging when typing the information that defines the functionality of the portlet and lists and describes all of the portlet fields.

    Tip: Click Preview Help to review the help content make sure that you have presented the information as desired.

    Click Preview to review the layout and make sure that you have presented the information as desired.

  13. Click Finish.

    The help data is saved, the portlet definition is created, and a status message displayed.

  14. Review the information to make determine if your portlet definition was successfully created.

    Note: If your PPM instance supports multiple languages, any portlet definition you create is defined in the language you selected at logon (your session language). After the portlet definition is created, it can be modified only in its definition language. For more information, see Multilingual User Interface Guide.