Self-service portlet data sources

This topic describes how to create and maintain self-service portlet data sources.

Create self-service portlet data sources from request types

Available in 24.3 and later versions

You can create self-service portlet data sources from request type fields, using request type visible fields as data source columns and searchable fields as filters.

To create a self-service data source from a request type:

  1. From the menu, click Open > Administration > Manage Request Types.

  2. Open the desired request type and then go to the Data Source tab.

  3. Turn on the Enable request type fields as self-service portlet data source switch and click Save.

    A self-service portlet data source named Request Type Name (Requests) is created from the request type, ready for use in self-service portlets:

    • All request fields are listed as columns unless hidden for the current user through Security Group or User settings.

    • All searcheable fields, except Date fields, are used as Datasource filters.

    For details about visible and searchable request fields, see Create request type fields using web UI.

Back to top

Create self-service portlet data sources

You can create self-service portlet data sources from dashboard data sources. Dashboard data sources provide the data and filters for self-service portlet data sources.

To create a self-service portlet data source from a dashboard data source:

  1. Prerequisite: You must have the System: Manage Self-Service Portlet Data Sources access grant.

  2. From the menu bar, click Open > Administration > Portlet Definitions > Manage Self-Service Portlet Data Sources.

    The Self-Service Portlet Data Source Management page opens.

    The predefined self-service portlet data sources, Financial Costs and Portfolio Items, are already listed on this page. For details about these data sources, see Preconfigured self-service portlet data sources.

  3. Click Create in the upper right corner.

  4. On the Create Self-Service Portlet Data Source page, provide information for each of the following sections:

    Section Description
    Information

    Provide the following information for the self-service portlet data source:

    • Enabled. Activates or deactivates the self-service portlet data source.

    • SQL Data Source. Select a dashboard data source that provides data and filters for the self-service portlet data source. Choices are limited to the dashboard data sources available on your PPM instance.

    • Name. Provide a name for the self-service portlet data source.

    • Service Name. By default, the service name is auto-filled based on the data source name. If you want to use another service name, enter the new name. Do not include special character or space in the service name. The service name identifies the self-service portlet data source through its URL path. Do not change the name once the data source is in use.

    • Reference Code. By default, the reference code is auto-filled based on the data source name. If you want to use another reference code, enter the new code.

    Access

    Define who can use the self-service portlet data source.

    • Authorized Users. Specify one or more users.

    • Authorized Security Groups. Specify one or more user groups.

    • Authorized Org. Units. Specify one or more org units.

    Columns

    Use this section to configure the columns that are displayed on the self-service portlet Edit Preferences page.

    For details, see Define data source columns.

    Filters

    Use this section to configure the filter fields that are displayed on the self-service portlet Edit Preferences page.

    This section is only available when the relevant dashboard data source has filters defined.

    For details, see Define data source filters.

    OData Link

    This section is available only when the Allow Creation of OData Links for Self-Service Portlet Data Sources feature toggle is turned on. For details, see Use feature toggles to turn on/off features.

    • OData Link Enabled. If allow users to create OData links for the self-service portlet data source.

      For details, see Work with self-service portlet data source OData links.

    • Authorized Users, Authorized Security Groups, Authorized Org. Units. Use these fields to specify who are allowed to create Odata links for the self-service portlet data source.

  5. Click Create.

To delete a self-service portlet data source:

  1. Open the data source to delete.

  2. Scroll the page down to the bottom, click Remove This Data Source, and click Yes to confirm.

Back to top

Define data source columns

The self-service portlet data source uses the same columns defined in the relevant dashboard data source. You can do the following to customize the columns for the self-service portlet data source:

  • Customize the properties of a column, including the label, hyperlink, and sorting.

  • Customize which columns are shown or hidden and to whom they are shown or hidden.

To customize the properties of a column:

The Columns Information area lists all the columns that are defined in the relevant dashboard data source. You can configure the following properties for each column:

Property Description
Custom Column Label Specify the name of the column to be displayed in the self-service portlet.
Hyperlink Column

Select a column whose hyperlink defined in the SQL data source becomes the hyperlink of the current column.

For example, for the Request ID column, if you select Request URL in Hyperlink Column, the Request ID column becomes clickable which opens the corresponding request.
Sort By

Available in 24.3 and later versions

When a column is displayed in the self-service portlet, it is sorted alphabetically by default. To use a different sorting order, select a column with the desired sorting order defined in the SQL data source. When you select to sort a column by another column, the first column will use the sorting order defined for the second column, and the second column will become unavailable as a source column in the self-service portlet.

For example, for the Forecast Costs column, if you select Date in Sort By column, values in Forecast Costs column are sorted chronologically.

To customize which columns are displayed:

  1. In the Column Mode field, select a display mode:

    • Show All. Shows all the columns to all the users.

    • Show All Except. Shows all columns except the specified columns.

    • Hide All Except. Hide all columns except the specified columns.

  2. If the display mode is Show All Except, specify which columns are shown and to whom they are shown.

    For each column you want to show, do the following:

    1. Click Add Column to select a column you want to show.
    2. In the Users, Security Groups, or Org. Units field, specify one or more users or user groups to which the column is shown.

  3. If the display mode is Hide All Except, specify which columns are hidden and from whom they are hidden.

    For each column you want to hide, do the following:

    1. Click Add Column to select a column you want to hide.
    2. In the Users, Security Groups, or Org. Units field, specify one or more users or user groups from which the column is hidden.

Back to top

Define data source filters

The self-service portlet data source uses the same filter fields defined in the relevant dashboard data source. You can use the Filters section of a self-service portlet data source to:

You can do the following to customize the filters for the self-service portlet data source:

  • Customize the label for a filter.
  • Customize the settings for a filter, including the default value, whether the filter is hidden, read-only, or required, and to whom the filter is hidden, read-only, or required.
  • Customize which filter fields are shown or hidden, and to whom they are shown or hidden.

To customize the label for a filter:

  • In the Custom Filter Labels area, locate each filter field, and enter a label in the Custom Filter Label field.

To customize filter settings:

  1. In the Filters Settings area, click Add Filter Settings to select a filter field that you want to customize the settings.

  2. For each of the filter, configure the following for the filter field:

    Setting Description
    Default Value Specify the default value for the filter.
    Autofill from Context

    Applicable to fields whose values are entities, users, or resources, such as the Program_ID and User_ID fields.

    If selected, the filter field is automatically filled with the current entity or logged in user.

    Hidden If you do not want to use the filter field on the Edit Preferences page, select the checkbox.
    Read Only If you want to make the filter field read only on the Edit Preferences page, select the checkbox.
    Required If you want to make the filter field required on the Edit Preferences page, select the checkbox.

    Users

    Security

    Org. Unit

    Specify to whom the filter settings are applied: one or more users, user from specified groups, or of specified org units.

    If no users or groups are specified, the filter settings apply to all the users.

To customize which filters are displayed:

  1. In the Filter Mode area, select a display mode:

    • Show All. Shows all the filters to all the users.

    • Show All Except. Shows all filters except the specified filters.

    • Hide All Except. Hides all filters except the specified filters.

  2. If the display mode is Show All Except, specify which filters are shown and to whom they are shown.

    For each filter you want to show, do the following:

    1. Click Add Filter to select a filter you want to show.
    2. In the Users, Security Groups, or Org. Units field, specify one or more users or user groups to which the filter is shown.

  3. If the display mode is Hide All Except, specify which filters are hidden and from whom they are hidden.

    For each filter you want to hide, do the following:

    1. Click Add Filter to select a filter you want to hide.
    2. In the Users, Security Groups, or Org. Units field, specify one or more users or user groups from which the filter is hidden.

Back to top

See also: