Clarity: Viewing Custom Objects and Subobjects

ccppmop1592
HID_Custom_Objects
You can now view custom objects and subobjects that are created in
Classic PPM
in
Clarity
by API enabling them. Let’s consider a scenario, where an organization uses
Clarity
to manage products. They now want to capture Net Promoter Score (NPS) for all their products and save them in
Clarity
. They also want to ask customers certain questions about the support and services processes. However, they want to save this data separately from the NPS scores.
Hence, they create a custom master object in
Classic PPM
called NPS, and API enable it so that it is available in
Clarity
. They can then create two sub-objects namely Services and Support, API-enable it, and save the relevant information in these sub-objects.
ActualsforInvestment.png
Let’s see how we can use Custom Objects and custom sub-objects in
Clarity
.
2
Create a New Custom Object
You can create a custom object in
Classic PPM
if you have administrative privileges.
ActualsforInvestment.png
Follow these steps:
  1. Open
    Administration
    , and from
    Studio
    , click
    Objects
    .
  2. Click
    New
    .
  3. Enter an object name, a unique ID, and a content source.
  4. (Optional) In the Description field, enter any details that remind you and other developers of the purpose of the object.
  5. Select
    Master
    for a new parent object.
  6. Select the
    API Enabled
    checkbox.
  7. Click
    Save
    to save your object.
To learn more about creating custom objects, see
Clarity
PPM Studio Objects and Attributes. When you create a new custom object, a blueprint is automatically created in
Clarity
.
In our example, we can create a custom master object NPS and API enable it. You can also API enable existing custom master objects in
Classic PPM
to make them available in
Clarity
.
Creating Custom Attributes Associated with the Custom Object
Attributes store information that is associated with object views on grids. For example, Start Date and End Date are attributes of the Project object. You can open your custom master object or subobject, navigate to the Attributes tab, create a new custom attribute and API enable it. This attribute will then be available in
Clarity
.
Creating a SubObject for the Custom Object
A subobject is a child of the master object and includes a subset of information that needs to be categorized and made available within the custom object. When you create a subobject in
Classic PPM
, it is available as a module in
Clarity
. You can use blueprints to ensure this module is available to authorized users in
Clarity
.
You can only add up to a maximum of 50 custom subobjects to an object's blueprint.
Follow these steps:
  1. Open
    Administration
    , and from Studio, click
    Objects
    .
  2. Click
    New
    .
  3. Enter an object name, a unique ID, and a content source.
  4. (Optional) In the Description field, enter any details that remind you and other developers of the purpose of the object.
  5. Select
    Subobject
    if the object is the child of another object that you specify in the Master Object field
  6. Select the
    API Enabled
    checkbox.
  7. Click
    Save
    to save your object.
To display the custom subobject as a module in
Clarity
, you need to configure the master object blueprint. For more information, see Add Modules to Blueprints.
API Enable Custom and Stock Virual Attributes Using XOG
You can use XOG to API enable stock and custom virtual attributes in
Classic PPM
. Custom Virtual attributes are only defined on sub-objects. A virtual attribute is a read-only attribute on the sub-object that is linked to a specific attribute on the master object.
You cannot use
Classic PPM
to API enable stock and custom virtual attributes.
Access Rights Associated with Custom Master Objects and Custom-Sub Objects
The Global, OBS, and Instance rights in
Classic PPM
are supported for custom objects and custom sub-objects. However, custom sub-objects also include parent-specific rights.
All users need the Custom Object - Navigate access right to view the Custom Objects page in
Clarity
.
Let’s review the details associated with access rights
Action
Access Rights
Create
  • User has Parent - View instance right (includes Parent - Navigate)
  • Does not automatically grant 'Edit' access
  • User has one of the following
    • <Custom Master Object> Create global right
    • <Parent> - Create - <subobject>
View
  • User has Parent - View instance right (includes Parent - Navigate)
  • User has one of the following
    • <Custom Master Object> View All global right
    • <Custom Master Object> View instance right
    • <Parent> - View All- <subobject>
Edit
  • User has Parent - View instance right (includes Parent - Navigate)
  • Includes the ability to delete
  • User has one of the following
    • <Custom Master Object> Edit All global right
    • <Custom Master Object> Edit instance right
    • <Parent> - Edit All- <subobject>
Delete
  • Capability to delete an instance is granted through the 'Edit' access right. It is not a separate right
  • If a user can Edit an instance, the user will be able to delete the same instance.
Configuring Custom Objects
As an application administrator or executive stakeholder, you can use blueprints to configure layouts for custom objects. When you create a custom object and API enable it, a blueprint is automatically created in
Clarity
. All your API enabled subobjects associated with the object are available as modules.
You can create a copy of the default blueprint that is created and edit it. You can then configure the Details layout based on your business requirements. You can also add various sub-objects as modules to ensure they are available to authorized users.
Working with Custom Objects
You can view a list of Custom objects available to you on the Custom Objects page. You can then click the object to view a list of items associated with it. Since the items are displayed in the
Clarity
common grid, you can perform the following actions:
  • Use the column panel to add attributes to the grid.
  • Use the Details panel to view additional information about them.
  • Filter and identify appropriate items
  • Configure your view options and save your view
  • Export your data as a CSV file
  • Group your data based on relevant attributes
You can learn more about the
Clarity
common grid functionality by reviewing Common Components.
You can click any item to view more information about it. You will see the various attributes and the modules that have been configured for you by using the blueprint. Since the data in the modules is displayed by using the
Clarity
common grid, you can analyze and edit it by using our standard common grid functionality.
Securing Custom Objects
You can now secure custom object attributes by using Field Level Security (FLS). You can leverage the
Clarity
common grid to secure attributes. Once an attribute is secure, it will have a secure icon adjacent to it. This icon is displayed in the Grid layout, the Details panel, and the Properties module.
Group
When a user with the View access right tries to edit the attribute in the grid, they will see a denial icon displayed and the field will be greyed out. Users who do not have View or Edit access, will not have an option to add the secured attribute to their view. If the user accesses a saved view where a secured attribute is included then the view is presented without that attribute, in an unsaved state.
  • You need the Administration - Access and Attributes Management – Navigate access right to setup FLS.
  • You can assign access right only to user groups.
  • Clarity
    Business rules take precedence over FLS.
  • FLS takes precedence over Instance/OBS/Global rights.
  • Field level security is only applicable to
    Clarity
    . FLS does not impact Classic PPM views.
  • You can only secure attributes whose REST API aliases are populated.
To learn more about field-level security, see Secure Field Level Access.