Clarity: Configure Blueprints for Ideas

ccppmop1592
The Standard Idea blueprint has been introduced in
Classic PPM
 15.6.1 and allows administrators or PMO content designers to configure layouts for ideas based on different business needs. Configure Custom Idea Subobjects and Attributes to appear in blueprints.
Example
: Jason is a
Classic PPM
 administrator. Multiple teams in his organization are using the Ideas grid to develop and evaluate new ideas. The Product Development and the Product Architecture teams often contribute a large number of ideas. However, the management team evaluates their ideas on different criteria. The Product Development team is judged on financial details such as planned cost and planned benefit details. The Product Architecture teams are judged on technical details such as architectural fit, technology compliance, and regulatory compliance. Jason wants to create different blueprints for these teams so that their management teams can quickly view relevant details and take appropriate actions on the idea.
Prerequisites
Depending on your access rights as the application owner, you can configure the blueprinting capabilities in
Clarity
. Verify that you have the appropriate rights for configuring blueprints. Some of the rights available to you are:
  • Blueprint – Create Copy
  • Blueprint – Delete All
  • Blueprint – Edit All
  • Blueprint – View All
For more information about access rights, see
Clarity
Access Rights
in the Reference section.
Explore the Standard Idea Blueprint
The Standard Idea blueprint has been introduced in
Classic PPM
 15.6.1. You can copy this blueprint and configure it to match the specific business requirements of various departments. Thus, when end-users create ideas that are based on the configured blueprint, they only see details that are relevant to their new idea.
Follow these steps:
  1. Log in to the
    Clarity
    .
  2. In the main menu, click
    Administration
    ,
    Blueprints
    .
  3. Click the
    Standard Idea
    blueprint to open it.
  4. The following default attributes are included as fields on the standard blueprint for ideas
    • Subject
    • Idea ID
    • Idea Type
    • Objective
    • Work Status
    • Original Requester
    • Sponsor
    • Manager
    • Start Date
    • Finish Date
  5. Click the
    Back
    button to return to the Blueprints page.
Copy, Edit, and Publish a Blueprint
Create a new blueprint by copying an existing blueprint. From the ⋮ actions menu for the blueprint, click Copy. When you create a blueprint by copying an existing blueprint, the details and modules from the existing blueprint are copied over. You can tailor the details in the new blueprint for specific ideas that may be associated with different teams or departments.
You can rename or edit the configuration of user-defined idea blueprints. You cannot edit or delete the Standard Idea blueprint.
Example
: Jason wants to create a copy of the Standard Idea blueprint. Then, she will customize it to suit the requirements of the product development team.
Follow these steps:
  1. Log in to the
    Clarity
    .
  2. In the main menu, click
    Administration
    ,
    Blueprints
    .
  3. Click the ⋮
    Actions
    menu to the right of the
    Standard Idea
    blueprint and select
    COPY
    to create a new blueprint.
  4. Click the
    Rename
    icon to enter the name of the blueprint.
  5. From the blueprint list, click the name of the blueprint that you want to edit.
  6. On the details page that displays the currently published blueprint layout, click
    Edit
    .
  7. Edit the blueprint details:
    • Drag-and-drop available fields from the Fields list onto an existing section within the blueprint. Use the Search to look for specific fields by label name. Resize any field in the layout using the shaded triangle that appears in the bottom-right of the field.
    • Drag-and-drop fields from a blueprint layout section to another section.
    • Drag-and-drop fields from the blueprint layout sections back to the list of fields. You can also click the X on a field in a section to remove that field. The field goes back to being an available field.
    • Delete a section with or without fields. All fields within that section are removed from the layout and are available again to select from the Fields panel.
    • Drag an existing section up or down within the blueprint to rearrange the sections. All fields that are in the section also move to the new location.
    • Add a section by clicking Add Section or drag-and-drop the Add Section button to where you want to add a section.
  8. If you are unsure of the changes, discard the edits. The edits are deleted and the blueprint details view reverts to the currently published version.
  9. Click
    Publish
    to save your changes and make the new layout available to projects. All projects associated with this blueprint display the new layout.
When you publish a blueprint, all edits in progress for the details and modules are published at once. All ideas that are associated with the blueprint display the latest layout that is configured for the blueprint.
Create a Custom Subobject for an Idea
You can now configure custom subobject modules for Ideas. The subobject will then be available as a module in the Idea Blueprint. You can then publish the blueprint to ensure that the module is available in
Clarity
.
Follow these steps:
  1.   Log in to
    Classic PPM
    UI
    .
  2.   Navigate to
    Administration
    ,
    Studio
    ,
    Objects
    .
  3.   Click
    New
    . The Create Object Definition page opens.
  4.   Specify the following details:
    • Object Name
    • Object ID
  5. Select
    Subobject
    .
  6. In the
    Master Object
    field, type Idea, and select the Idea master object that is populated.
  7. Select the
    API Enabled
    checkbox.
    • Checking the API Enable checkbox lets you view the subobject in
      Clarity
      . You can API enable the already existing custom subobjects.
    • Instance-level access rights do not work on custom sub-objects in
      Clarity
      . Global-level access rights are currently supported in
      Clarity
      .
    .
  8. Click
    Save
    .
Configure an Idea Blueprint to include a Custom Subobject Module
After you have API Enabled the subobject in Studio, the subobject is created and will be available as a module in Blueprints in
Clarity
.
Follow these steps
  1. Log in to
    Clarity
    .
  2. Navigate to
    Administration
    ,
    Blueprints
    , select an Idea Blueprint.
  3. Navigate to the
    Modules
    tab. The new subobject is listed in the
    MODULES
    panel.
    • You will only see custom subobjects that are API enabled as modules.
    • You will see the first-level custom subobjects as modules. The API-enabled, second-level subobjects are automatically added to the Details panel of the first-level subobject.
    • An object's blueprint can include a maximum of 50 modules, including default modules, custom subobjects, and channels. When you reach the limit of 50, you will no longer be able to add modules to the blueprint. Consider removing or combining the least used modules in such cases.
  4. Click
    EDIT
    , drag and drop the new subobject, and click
    PUBLISH
    . The newly created subobject module is now added to Ideas.
Use the Custom Subobject in an Idea
Follow these steps
  1. Log in to
    Clarity
    .
  2. Navigate to
    Ideas
    , select an idea from the grid. The new subobject is now available as one of the modules.
  3. Click the new subobject module, click the (
    +
    ) plus icon to add attributes.
The generic grid properties are applicable to the attributes.
Configure Custom Idea Attributes to Appear in Blueprints
In case you have created custom idea attributes in
Classic PPM
, you can ensure their attributes are available in Idea blueprints.
Follow these steps:
  1. In
    Classic PPM
    , select
    Administration
    ,
    Objects
    .
  2. In the Object Name field, enter
    Idea
    , and select
    Filter
    .
  3. Click the
    Idea
    object and select the
    Attributes
    tab to view all the attributes associated with the Idea object.
  4. Filter and locate the custom idea attribute that you want to display in the standard and user-defined blueprints.
  5. Enter a unique value in the
    API Attribute ID
    file and click
    Save
    to confirm your changes.
  6. Open the blueprint you want to edit.
  7. Locate and drag-drop the custom idea attribute in the appropriate section of the blueprint.
Configure the Financials Module for Ideas Using Blueprint
If you want to enable the Financials module in Ideas, you can do so using the Blueprint.
Ensure that the following rights are provided to the user:
  • Idea - Cost Plan - Edit All
  • Idea - Cost Plan - View All
  • Idea - Cost Plan - Edit
  • Idea - Cost Plan - View
Follow these steps:
  1. Log in to
    Clarity
    .
  2. Navigate to
    Administration
    ,
    Blueprints
    .
  3. Select
    Idea Default
    blueprint and make a copy.
  4. Edit, rename, and open the new Idea blueprint.
  5. Navigate to
    Modules
    , click
    Edit
    , drag and drop the
    Financials
    module, and click
    Publish
    . The Financials module is published and will be available from Ideas.
  6. Navigate to
    Ideas
    from the main menu and open an idea. The Financials module is visible.
  7. Click
    FINANCIALS
    . The cost plan list appears in grid layout.
Explore Modules
In the current release of
Clarity
, the Standard Idea blueprint has the Properties, Financials, Staff, and the Links modules associated with it.
Creating and Executing Business Rules
Administrators can create business rules in Blueprints to control the modules or sections displayed to end-users. Business Rules apply to projects, custom investments, ideas, and custom master objects. Let’s consider an example where the administrator wants to show the Executive Summary section on the Properties module only when the following conditions are met:
  • The user is a member of the PMO portfolio manager group
  • The ROI is greater than 200%
  • The Corporate Priority is High
  • The investment is active
When you define business rules, you need to perform three key steps:
  1. Define a Condition: You use the generic filter to define all the conditions that would trigger the business rule. In this release, you can specify conditions based on:
    1. Access Groups: You can specify that a module or a section would only be hidden to members of:
      1. Selected groups
      2. All groups except the selected group
        In our example, we will specify the condition that Access Group should not equal to PMO Portfolio Manager.
    2. Attributes: You can specify values for one more Clarity attributes. In our example, we will specify the relevant conditions for the ROI, Corporate Priority, and Active attributes.
      You can use the Match All or Match Any options to create compound conditions that include multiple groups and attributes. To learn more about generic filters and matching options, see Common Components. In our example, we will use the Match All option.
  2. Define Actions: In this release of Clarity, actions enable you to hide modules and sections. The actions will only execute when the condition is triggered. In our example, we will use the Hide Sections action.
  3. Define Action Targets: The Action targets specify the modules or sections you can hide when the condition is triggered. In our example, we will select the Executive Summary section to hide it.
In our example, we are hiding the Executive Summary section from all groups except the PMO Portfolio Manager group. Members of this group will only see the section when the ROI is greater than 200% and the Corporate Priority is High.
Follow these steps:
  1. Log into Clarity.
  2. Click
    Administration
    and select
    Blueprints
    .
  3. Select the relevant blueprint to open it and click
    Edit
    .
  4. Navigate to the
    Rules
    tab and select
    New Rule
    .
  5. In the New Rule window, enter the name and description of the rule.
  6. In the Conditions section, use the drop-down list to specify the condition that would trigger the rule.
  7. Use the Match All or Match Any option to finalize the condition.
  8. In the Actions section, select the relevant action.
  9. Define the action targets by specifying the sections and modules you want to hide.
  10. Click
    Create
    . If the rule syntax is correct the rule will be enabled after you click Create.
  11. In the Rules tab, ensure that the rule is enabled so that it’s applied to all the investments associated with the blueprint.
  12. Click
    Publish
    to update the changes to the blueprint.
Some scenarios in which you will see error or warning messages for Business Rules are:
  • You have defined only one Action and the Action Target is missing.
  • You have defined only one Condition is defined and the Condition Value is missing.
  • An administrator deletes or deactivates an attribute that was used in a rule.
  • Business rules apply for projects, custom investments, ideas, and custom master objects.
  • When you select an attribute in the Conditions section, the following attributes are available:
    • Single-Value Lookups (Static and Dynamic)
    • Boolean
    • Strings
    • Number
    • Static Dependent Lookups
    • Parameterized Lookups
  • You can only configure actions for active modules associated with the blueprint.
  • After you edit a rule, you need to publish it again to activate it for the end-user.
  • Blueprint information is cached per user's session. Your end-users may need to log in and out or do a browser refresh to see any new business rule changes that were published.
  • End-user execution of the rule will not dynamically refresh the UI immediately after the rule is triggered - users will need to navigate away and come back or refresh the browser to see the hidden module or section. We will be investigating in an upcoming release to provide a dynamic refresh once the rule is triggered.
  • If you have implemented field-level security
    • The fields will be available for the administrator setting up the Business rules.
    • The rule will be applied but field-level security will be considered when the rule is executed.
  • Anytime a section, module, Clarity group, or custom attributes are deactivated or removed, the administrator should review all the rules to ensure the rule continues to work as expected.
Delete Blueprints
With the appropriate access rights, you can delete any user-defined blueprint. If you delete a blueprint that is not the default, all templates and projects that are associated with the blueprint are then re-associated with the current default blueprint. If the Standard Idea blueprint is the default blueprint, all ideas are associated with this blueprint. If you delete a user-defined default blueprint, then the associated templates and projects are also re-associated with the Standard Idea blueprint. The Standard Idea blueprint becomes the new default blueprint. You cannot delete the Standard Project blueprint.
Use Channels to Embed External Content
Use channels to embed content from another source, such as an external site, application, or Classic PPM context-sensitive investment reports into Clarity. You can interact with the content and make informed business decisions without leaving an investment in Clarity.
As an administrator, you can add a channel to the blueprint, and configure a maximum of fifteen (15) channels. After you create a channel, you can find it in the Modules panel. After you publish the blueprint, the newly created channel appears as a tabbed page within the investment (Project, Custom Investment, Ideas) and Custom Objects.
After you add a channel, you need
not
drag and drop the new channel to the blueprint layout section, it's automatically added.
After you create 15 channels, you can no longer see the New Channel button.
This page contains the following sections:
Configure a Channel
Let's see how you can add a channel and embed content from another source into Clarity.
  1. Go to the
    Blueprint
    and click
    Edit
    .
  2. From the
    Modules
    tab, click
    New Channe
    l.
  3. Enter information in these fields:
    1. Channel Name
      : Enter the channel name
    2. Channel URL
      : Enter the channel URL
    3. Referrer URLs
      : Enter one or more comma-separated referrer URLs. Use Referrer URLs when your channel URL redirects you to another authentication link.
      For example, specify the authentication URL in the referrer URL if your channel URL requires SSO login.
  4. Click
    Preview
    to test the channel.
    Remember, only concrete links can be previewed.
  5. Click
    Publish
    to publish the blueprint.
    Your channel is created. Ask your users to refresh the browser session to see the new channel as a tabbed page within the investment.
Dynamic Parameters for Channels
  • You can use these parameters to construct dynamic content inside your channels
    • project id = ${_internalId}
    • projectCode = ${code}
    • project name =${name}
    • project manager =${manager}
    • logged in user =${_userId}
  • Channels also support custom attributes as input parameters, using attribute API Alias value, of the following attribute type:
    • Number
    • String
    • Single Value Lookup (Static and NSQL based)
Channels also support context-sensitive content with dynamic parameters. Content with dynamic parameters are not rendered in the Preview mode for channels in blueprints, but users can see them within the investment.
Use Relative Paths in a Generic Channel URL
When adding a channel to link back to Classic PPM, replace the server URL with the HTML dot-dot-slash syntax for relative rather than fixed absolute path references. If the data is restored to another server, your channel continues to function.
Original URL
Generic Channel URL
http://my_clarity.ca.com/niku/nu
../../../../../niku/nu
Example 1:
In this example, you define a link in a channel to the
Classic PPM
Project Processes Page:
../../../../../niku/nu#action:projmgr.projectProcessInstances&id=${_internalId}&object_type =project&object_id=${_internalId}&ui.page.space=mainnav.work&ui.page.template=union.appPage
Example 2:
A link to Rally investments would appear as follows:
https://rally1.rallydev.com/#/investments
Example 3:
The following example shows a link to a Jaspersoft report:
https://clarityserver.ca.com/reportservice/flow.html?_flowId=viewReportFlow&reportUnit= %2Fca_ppm%2Freports%2Fproject_management%2FCSK_PRJ_ProjectStatusSummary &standAlone=true&ParentFolderUri=/ca_ppm/reports/project_management &populateProject=1&projectKey_1=${_internalId}
Channels That Link to
Classic PPM
with the Phoenix UI Theme Applied
If you create a channel that links to the
Classic PPM
user interface and the optional Phoenix UI theme is applied, users see two main menus along the left edge of the page. To show just one main menu, follow these steps:
  1. Edit the blueprint.
  2. Open the channel module.
  3. Add the following parameter to the
    Channel URL
    field:
      &puiFullscreen=on
  4. To hide the project-specific menu items, append the following parameter:
      &puiHidePPMTabs=on
  5. Save and publish your blueprint.
image2019-3-19_19-26-6.png
Video: Hide Navigation and Tool Bar in Channels when Phoenix UI Theme is Applied

Troubleshooting Tips for Administrators to Configure Channels
  • Before you preview a channel, refresh the browser page.
  • Advise users to refresh their browser after publishing a blueprint with new or changed channels.
  • Avoid spaces, semicolons, and special characters in referrer URLs.
  • Referrer URLs must be comma-separated.
Known Issues for Channels
Refused to Frame
: You might see a Refused to frame error when you click Preview for a given channel URL because it violates the following Content Security Policy directive: "frame-src app.pendo.io cdn.pendo.iodocops.ca.com 'self' data:”
Resolution:
To resolve this condition, refresh your browser. Refreshing forces Clarity to white list the domain in compliance with the Content Security Policy directive. The new blueprint channel feature has a built-in ability to white list a domain after you define it in the channel. Refresh your browser to white list a domain before you can preview it. Whitelisting allows Clarity to display external applications in the Clarity framework, provided the other application does not have CORS restrictions built-in since Clarity cannot overwrite an external security policy.
Mixed Content
: You might see the following error if you configure a link with HTTP inside a domain that requires a secure HTTPS connection:
Mixed Content: The page at 'https://MY-PPM-SERVER.ondemand.ca.com/pm/#/admin/blueprints/blueprint/edit/5000043' was loaded over HTTPS, but requested an insecure resource 'http://OTHER-SITE.domain.org'. This request has been blocked; the content must be served over HTTPS.
Your browser might show an alert asking you to confirm before loading unsafe scripts. In Chrome, a security shield icon and prompt appear asking you to confirm that you want to open an insecure channel.
Resolution:
To resolve this condition, edit the channel in the blueprint to use HTTPS and then publish the blueprint, or, if you know the HTTP content is safe, preview the HTTP content in another browser.
On-premise administrators can also white list a domain using admin system options. See CSA: Service and Admin Command-Line Utilities (near the bottom of that page).