Clarity: Configure Blueprints for Custom Investments and Custom Objects

ccppmop1591
HID_newux_custom_blueprints
As an application administrator or PMO content designer, use blueprints to configure layouts for different custom investments and custom master objects. You can use blueprints to configure layouts for different types of custom investments in alignment with your organizational goals.
When you create a custom investment or a custom master object, a blueprint is automatically created in
Clarity
. You can create a copy of the blueprint and edit it to suit your goals. For example, a marketing blueprint may be very different from an engineering blueprint.
The key steps you need to follow while editing blueprints are:
  1. Create a copy of the standard blueprint, rename it, and configure its Details layout (sections and fields).
  2. Add the relevant modules to the blueprint.
  3. Publish the blueprint.
  4. Mark a blueprint as the default blueprint for relevant investment items and custom master objects.
2
Edit Blueprint Details
You can add various stock and custom attributes associated with custom investment items and custom master objects to the Properties module in a blueprint.
Follow these steps:
  1. From the blueprint list, click the name of the blueprint that you want to edit.
  2. On the details page that displays the currently published blueprint layout, click
    Edit
    .
  3. 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 contained 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.
      You can only add a custom attribute to a blueprint if it is API enabled.
  4. 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.
  5. Click
    Publish
    to save your changes and make the new layout available.
Add Modules to Blueprints
The various subobjects associated with a custom investment or a custom master object are available as modules. You can add these modules to the blueprint to make them available to your users.
Follow these steps:
  1. From the blueprint list, click the name of the blueprint that you want to edit.
  2. On the details page that displays the currently published blueprint layout, click
    Edit
    .
  3. Select the
    MODULES
    tab.
  4. Drag and drop the relevant modules into the blank boxes to add them to the blueprint.
    • 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.
  5.   Click
    Publish
    to save your changes and make the changes available to users.
Associate a Blueprint with an Investment Item or Custom Master Object
You can navigate to the Custom Investments page or the Custom Objects page and add the Blueprint attribute to the grid. You can then select the relevant blueprint to apply it.
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).