Clarity: Configure Custom Investment Types

ccppmop1593
HID_newux_custominvestments
The new Investment Types feature provides a way for administrators to create and configure custom investment objects with the same capabilities that they already enjoy using for projects and other non-project investments. However, investment types are not constrained by the traditional boundaries associated with traditional project management.
2
Prerequisites
This feature provides configurable investment functionality for business users in
Clarity
with a solid administrative foundation inside the
Classic PPM
Studio object architecture.
  • Administrators can create investment types using the
    Classic PPM
    Studio interface. In each
    Clarity
    environment, create no more than 100 of your own custom investment types.
  • Business users can create new instances of these investments in
    Clarity
    .
  • New investment type objects inherit their attributes from abstract objects through object extensions.
  • Investment types leverage the same auto-assignment of access rights that is currently available on non-project investment objects.
  • The appropriate access rights are required to perform the steps described in this article. To create investment type objects, no new access right is required. If a user already had rights to create a custom object, that user can create an investment type object.
  • You cannot set the API Attribute ID (commonly known as the API alias) for new investment types. By default, the application sets your new investment objects to
    API-enabled
    and provides a unique API Alias. The application uses the
    cust
    prefix and the plural form of the name or abbreviated name of your object ID as the API alias. It also applies additional logic to satisfy uniqueness constraints. For example, if you create a custom investment named
    demand
    , the API alias is
    custDemands
    . If you create an object named
    Business Case
    , the API Attribute ID might be
    custBcs
    . If another user attempted to create their
    Business Case
    object, the system might give it an API alias of
    custBs
    . If API alias generation fails due to naming conflicts, change the object name.
Create an Investment Type
You already know that you can manage blueprints, templates, and projects.
Classic PPM
also provides pre-defined non-project investment objects (NPIOs) such as products and applications. However, your organization might want even greater control when managing its own investment types. You want to see your own investment types in the
Clarity
.
As an administrator, you can create investment types in
Classic PPM
and manage new instances of those types in
Clarity
. Investments types represent instances of a unique new abstract master object in
Classic PPM
. In
Clarity
, they open the door to an expanded array of possibilities for managing new products, proposals, coordinated work items, and other new business development opportunities.
When you create a custom investment type in
Classic PPM
, a custom investment type blueprint is automatically generated in
Clarity
. The blueprint uses the same name as the custom investment type. Use the custom investment type blueprints to configure the layouts and details for your investment screens so they accurately reflect your business requirements. See
Clarity
: Configure Blueprints for Projects and Investments
for more information.
Follow these steps
:
  1. In
    Classic PPM
    , click
    Administration
    ,
    Studio
    ,
    Objects
    and click
    New
    .
  2. Define your custom investment type:
    1. In the
      Object Name
      field, enter your investment type. For example, create a custom investment type named
      Product Demo
      or
      Business Case
      .
    2. In the
      Object Extension
      field, select
      Investment Extension
      .
    3. You assign a unique object ID. When you save, the system assigns a unique read-only value in the
      API Attribute ID
      field.
    4. To include the custom investment in hierarchies, select the INCLUDE IN HIERARCHIES button.
    5. Complete the other required and optional fields.
    6. Click
      Save
      .
  3. Verify that the following access rights are enabled for the specific user:
    • <investment_type> - Create
    • <investment_type> - Edit All
    • <investment_type> - Navigate
    • <investment_type> - View All
    • <investment_type> - XOG Access
    • <custom_investment_type>- Cost Plan - Edit All
    • <custom_investment_type>- Cost Plan - View All
    • <custom_investment_type>- Cost Plan - Edit
    • <custom_investment_type>- Cost Plan - View
    The navigation access right (for example,
    Product Demo - Navigate
    )
    is auto-assigned to the user who created the new investment type. The application also assigns the global create right and instance rights for editing to that user.
  4. In
    Classic PPM
    , assign the new navigation rights to users individually through instance-level or global-level access rights:
    • Users with the <
      investment_type>- Navigate
      global access right can navigate to the
      Investments
      page in
      Clarity
      .
    • The custom investment type tiles are shown or hidden based on the system-generated navigation right for each type of custom investment.
    • Only the users with the specific navigate right for a custom investment type (for example,
      Product Demo - Navigate
      ) can view and open the list of those investments.
Investments types are defined in
Classic PPM
; however, they are designed for use in
Clarity
. For this reason, they are hidden in certain places in the
Classic PPM
user interface.
  • Investment type objects are also not available for selection as a master object for another subobject.
  • The investment, parent investment, investment roll-up data, and investment object data providers do not show any of your custom investment types or object instances.
Access Rights Name Updated When You Rename Custom Investment Types
Linked
When you change the name of Custom Investments, you can use the Push Object Captions icon to update OBS access rights, Instance Rights, Global Rights, and Sub-object master object names to reflect the updated Custom Investment name.
Some of the key points you need to remember are:
  • When you push the object name change, it does not update the “Blueprint” name in Clarity.
  • The Object ID and Attribute ID do not get updated when you change the name of the Custom Investment.
Configure Automatic Numbering for Investment IDs
You can configure the application to assign a unique investment identifier for each instance of your new investment type. Without auto-numbering, users are required to enter a unique value in the Investment ID column when they add a new investment.
  1. In
    Classic PPM
    , click
    Administration
    ,
    Studio
    ,
    Objects.
  2. Open your custom investment object.
  3. Click
    Attributes
    .
  4. Select
    Investment ID
    .
  5. Click
    Auto-Numbering
    .
  6. Select the
    Auto-Numbered
    checkbox.
  7. Click
    Save and Return
    .
Create a Custom Subobject for a Custom Investment Type in Studio
You can now create custom subobjects for Custom Investment and API Enable it so that users with appropriate access rights can utilize the modules to further define the custom investment and attributes as fields to help determine the financial breakdown in the custom investment.
Prerequisite
Ensure that a custom investment object is created and published before you create a subobject.
As an administrator, you can grant instance access rights to specific Custom Investment Types instead of Global access rights to all Custom Investment Types. The rights are separated to ensure you can offer specific capabilities as needed. For example, do not grant editing financial field edit rights if your users do not edit financial fields.
Example:
Consider a scenario where you create a custom investment CustInv.
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
    CustInv
    and select the
    CustInv
    master object that is populated.
  7. Select the
    API Enabled
    checkbox. The API ID is auto-generated.
  8. Click
    Save
    .
  9. The object is created and will be available as a module in Blueprints in
    Clarity
    .
    Instance-level access rights do not work on custom sub-objects in
    Clarity
    . Global-level access rights are currently supported in
    Clarity
    .
Configure a Custom Investment Type Blueprint to include a Custom Subobject Module
Follow these steps:
  1. Log in to
    Clarity
    .
  2. Navigate to
    Administration
    ,
    Blueprints
    .
  3. Select a Custom Investment blueprint, make a copy, right-click, and select
    Set as Default
    .
  4. Navigate to
    Modules
    . The new subobject is listed in the MODULES panel.
  5. Click
    EDIT
    , drag and drop the new subobject module, and click
    PUBLISH
    . The subobject is now added to the Custom Investment.
    After making any changes to a blueprint log out and log in to
    Clarity
    for the changes to appear.
Use the Custom Subobject in a Custom Investment Type
Follow these steps:
  1. Log in to
    Clarity
    .
  2. Navigate to
    Investments
    , select a Custom Investment, and navigate to a custom investment. The new subobject is now available as a module.
  3. Click the new subobject, click the
    +
    (plus) icon to add attributes.
The grid layout properties are applicable to the attributes. For more information about common grid see
Common Features: Manage Your
Clarity
Data in Grids
in
Manage Simple Budgets for Custom Investments
Release 15.5.1 introduces the series of
planned
simple budget financial fields on both the grid and the Details page (configurable as a blueprint module). 
For information about how to manage
cost plan and cost plan details
in Custom Investment see
image2018-11-19_15-35-1.png
image2018-11-19_16-10-39.png
Planned
Start and Finish dates are always equal to the Start and Finish dates of the parent custom investment.
The custom investment financial fields enforce the same rules as the
Classic PPM
Financial Summary page for projects and other types of investments:
image2018-11-19_16-9-12.png
Financial Field:
Rules:
Calculate Financial Metrics
Specifies whether financial metrics such as Planned ROI, NPV, IIR, MIRR, Planned Payback Period, and Planned Breakeven for the investment are calculated automatically (if selected or TRUE) or user-defined (if cleared or FALSE).
Planned Capital Cost
Editable if you have edit permissions.
Planned Operating Cost
Editable if you have edit permissions.
Planned Cost
Read-only attribute; the sum of Planned Capital and Planned Operating Cost
Planned Cost Start
Read-only attribute; automatically set to the same value as the Start date of the investment instance.
Planned Cost Finish
Read-only attribute; automatically set to the same value as the Finish date of the investment instance.
Planned Benefit
Editable if you have edit permissions.
Planned Benefit Start
On create of the custom investment, the value will be set to TODAY. Users with edit permission can change this field as long as the value fall within the Start and Finish dates
Planned Benefit Finish
On create of the custom investment, the value will be set to TODAY. Users with edit permission can change this field as long as the value fall within the Start and Finish dates
Planned ROI
If "Calculate Financial Metrics=TRUE", the system will generate a value. If "Calculate Financial Metrics=FALSE", users with edit permission can manually update this field.
Planned Payback Period
If "Calculate Financial Metrics=TRUE", the system will generate a value. If "Calculate Financial Metrics=FALSE", users with edit permission can manually update this field.
Planned NPV
If "Calculate Financial Metrics=TRUE", the system will generate a value. If "Calculate Financial Metrics=FALSE", users with edit permission can manually update this field.
Plannned MIRR
If "Calculate Financial Metrics=TRUE", the system will generate a value. If "Calculate Financial Metrics=FALSE", users with edit permission can manually update this field.
Planned Operating %
Calculated field that displays the percentage of Planned Operating Cost from the Planned Cost total.
Planned Capital %
Calculated field that displays the percentage of Planned Capital Cost from the Planned Cost total.
Is system value for Total Cost of Capital
If TRUE, use the system-level total cost of capital for this investment type. If FALSE, use the Override value for total cost of capital value which determines the annual finance on the capital that is borrowed to fund this investment
Override value for Total Cost of Capital
Determines the annual finance on the capital that is borrowed to fund this investment. Impacts the Financial Metric fields if "Is system value for Total Cost of Capital=FALSE"
Initial Investment
Defines the initial cost of the investment that is used in all financial metric calculations. If "Calculate Financial Metrics=TRUE", impact the values for Planned NPV and ROI.
Is system value for Reinvestment Rate
If selected (TRUE), use the system-level reinvestment rate for this investment type. If clear (FALSE), use the Override Reinvestment Rate value which determines the annual interest rate that is used to reinvest positive cash flow for this investment.
Override Value for Reinvestment Rate
Determines the annual interest rate that is used to reinvest positive cash flow for this investment. Impacts the Financial Metric fields if
Is system value for Reinvestment Rate
is cleared (FALSE).
Planned Breakeven
If
Calculate Financial Metrics
is selected (TRUE), the system generates a value. If
Calculate Financial Metrics
is clear (FALSE), users with edit rights can update this field.
Calculate Financial Metrics
  • If you want the application to calculate certain financial metrics for you, leave the checkbox selected (the default).
  • To manually enter your own values, add the
    Calculate Financial Metrics
    field to your current grid, and then clear the checkbox.
image2019-1-23_16-0-31.png
Be careful here. Any values in those fields are cleared if you select
Calculate Financial Metrics
.
You can also configure the
Calculate Financial Metrics
field to appear on the custom investment details page. The following image demonstrates the following concepts:
  • At left, the
    Calculate Financial Metrics
    field as an attribute of a custom investment object in
    Classic PPM
    .
  • At the bottom, the
    Calculate Financial Metrics
    field has been added to the investment blueprint. For the open investment, the field is cleared so manual entries can be made.
  • At the top right, users can now manually enter values such as 5.45 (or in some locales 5,45) for
    Planned IRR
    (rounded through
    View Options
    to
    5.5%
    ).
image2019-1-23_15-57-3.png
Access Rights
  • Typically, administrators could assign rights to users by OBS unit or group. At this time, investment type rights can only be assigned through global or instance rights.
  • The feature includes create, edit, and view rights, but no separate delete right.
  • The auto-rights behave the same as they do for standard non-project investment custom objects.
Currency and Financials
  • The investment type grid does not support multi-currency.
  • Custom investments cannot have TSVs.
  • You cannot track transaction entries (timesheets or vouchers) against custom investments. The transactions are only available in the PPA_WIP table and the WIP Adjustment portlet.
Reports and Jobs
  • Portlets, reports, and add-in content do not display investment type information.
  • No data warehouse support for attributes on investment type.
  • The Delete Investments job does not delete investment type instances. (In 15.5.1, the
    Delete Investments
    job is renamed to
    Delete Investments and Time Reporting Periods
    .)
  • The Portfolio Synchronization job does not import investment type data.
  • The Investment Allocation job ignores any investment type data.
Administration and Studio
  • Lookups: All lookups that query investment tables do not display any investment type instance data.
  • Aggregated attributes: As you cannot create subobjects for custom investment types, aggregated attributes are not available.
  • Portfolio Job: The Portfolio Synchronization job does not import investment type data.
  • Content Editor: The ability to select investment types from the Content Editor is disabled.
  • Data Providers: Investment types have no object data provider in
    Classic PPM
    Studio and investment type information does not appear in the portfolio data providers.
    Known Issue
    : The legacy Investment data provider from previous 13.x/14.x/15.x releases is capable of displaying data from the new investment type instances. Users who do not want this data to appear can filter out investment type data using a power filter. A fix is already in progress for this issue.
  • Investment types do not support Studio actions or views. The Actions and Views tabs are hidden in
    Classic PPM
    Studio.
  • The system creates a default portlet page for each new investment type, but the ability to display the default portlet page is disabled.
  • You cannot use the
    Classic PPM
    Studio Menu Manager to associate an investment type link or investment type portlet page.
  • You cannot create a subobject under an investment type object.
  • You can enable
    insert
    and
    update
    audit trail on attributes; however, delete is not available. 
  • Insert and Update operations can only be viewed via the Global Audit View in
    Classic PPM
Resource Staffing
  • Disabled the ability to staff resources to an investment type (
    Classic PPM
    and
    Clarity
    )
Data Warehouse Reporting Capabilities for Your Custom Investments
When you enable your custom investment object for the data warehouse, the schema creates a matching new dimension table. If any selected attribute requires language translation, a corresponding language table will also be created in the Data Warehouse. An example showing patents as a custom investment object with a primary key appears below.
Data Warehouse for custom subobject is not supported.
image2019-2-22_17-36-20.png
Custom Investment OOTB data will be captured in the Data Warehouse alongside regular Investment data, provided the Custom Investment is selected for the Data WarehouseData will populate in these existing Data Warehouse tables:DWH_INV_INVESTMENT
DWH_INV_INVESTMENT_LN
DWH_INV_SUMMARY_FACTS
DWH_INV_PERIOD_FACTSThe following existing Data Warehouse security view will also reflect Custom Investments:
DWH_INV_SECURITY_V
Frequently-Asked Questions (FAQ)
5
5
Q: How do I know string datatypes on the grid display a pop-up text area field when in edit mode?
A
: If the
Maximum Size
attribute property in Studio is greater than 80 characters, the string field will display as a text area pop-up. Otherwise, it will display as a regular cell in the grid.
Q: How do I know if my subobject is API-enabled?
A
: In
Classic PPM
Studio on the Object List page, if the API Attribute ID column for the subobject has a value, the subobject is API-enabled.
Q: Is there a way I can identify on the grid if I have view-only permission for a particular row in the grid?
A
: There is no specific UX indicator if you have view-only access to a specific row, but if you try to update a row that you only have view-only access, the system will display an error message noting you do not have the edit permissions for that row.
Q: What happens if I delete/inactivate a field and this field is included in a saved view?
A
: When the end-user accesses this saved view, the view will be placed in an “unsaved” state and the system will do the following :
The deleted/inactivated field will be removed from the grid
If the deleted/inactivated field is included in a filter, it will be removed and the user will be prompted that this field has been removed from the filter
Q: If I do not have sub-object view access, will the sub-object icon on the project tiles be hidden?
A
: No. If this user clicks on the sub-object icon, it will navigate to that module on the project, but the user will not see any sub-object data – the system will display a message saying the user does not have view access to the sub-object.
Q: What happens if I set a default value for the “Blueprint” field in Studio?
A: The defaulting logic for blueprints where if the “Blueprint=NULL”, it will use the “Default” blueprint layout will be override by the default you set in Studio.
Q: On the custom sub-object grid, why am I not seeing required fields automatically added as column on the grid?
A: Check if you have a default value defined in Studio for that required field. The required fields will not be added if you have a default value defined.
Q: Do I have to enter both values when filtering on Number fields on the grid?
A: No. If you enter just the first value (From), it will filter on that value and anything greater than that value. If you enter just the second value (To), it will filter on that value and anything less than that value