This section provides the details of all the common components you use in
Manage Your Data in Grid Layout
One of the common components in
Clarityis the dynamic new grid. You can find the grid throughout the application to manage projects, tasks, roadmaps, and ideas, and timesheets to name a few.
The following video captures all the important tasks that you can perform from
The grids are consistent in most aspects; however, specific functionality varies by grid, page, user access rights, and individual user behavior in client browsers.
In addition to its familiar spreadsheet-inspired arrangement of rows, columns, and cells, the grids offer the following functionality:
In the Grid layout, the View Options icon lets you configure the following:
- Set decimal display for numbers and money (formats do not apply to the custom integer attributes that you define in Studio)
- Manage Picklists (instance-specific sets of values)
- Select fiscal periods that should be displayed (Weeks, Months, Quarters, and Years) - InClarity, you can view all the periods that have been defined by your administrator in the fiscal calendar. Many administrators do not define fiscal weeks and hence this information is not available inClarity.
Edit Data in Grids
- Right-click in a grid to use the context menu to add or delete rows.
- Add a row item.
- Copy and paste cell values.
- Observe subtle visual treatments for rows and cells. For example, new rows and cells appear in a different color from saved rows and cells.
- Missing required fields with no default values get added automatically when you add a row. If values are missing from required fields, messages and subtle color shading appear to indicate.
- Pin, resize, reorder, and reset columns to personalize each grid.
- Grids support a preset number of rows per page. For example, the roadmap grid shows 100 rows per page, the Staffing Resources-to-Investments page shows 200 resources, and the Project Staff page shows 500 rows per page. Use the FIRST, PREVIOUS, NEXT, and LAST controls to navigate between multiple pages.
- Select dates from a scrolling calendar with year, month, and day controls.
- Sort by a column in ascending order, and toggle the sort order with a single click in descending order.Fields with multi-value lookup values do not support sorting.
- Shift+Click to sort on up to four columns. To remove sorting on one of the columns, hold down the Shift key and click the column header twice.
- Open a conversation by clicking the comment bubble icon for a line item in the Conversation column. The icon is white or empty when no conversation exists and turns blue after at least one comment appears in a new conversation.
- To show or hide columns on the grid click Column Panel and make your selections. You can also drag a column header cell up and off the grid to hide it from view.
- Hover over a column header to display the≡ Column Heading Optionsmenu with choices for pinning, auto-sizing, and resetting columns.
When you create an display mapping for an attribute on the abstact investment object, that mapping is used when you view the attribute in the
Claritycommon grid. If you create a different display mapping for the same attribute on a concrete object such as a project,
Claritywill still continue to use te mapping specified on the abstract investment object. However, if you create an attribute on the concrete object,
Claritywill use the display mapping associated with the attribute.
Collapse Related Rows Together In Group By Mode
You can see the Group By bar, wherever the Common Grids are used in
Clarity. The Group By feature allows you to do the following tasks:
- Drag a column header and view the data in the grid as rows of logical groups.
- Expand multiple groups simultaneously to view associated data.
- Edit data directly in the grid while you are in the Group By mode.
- Select a row and open the Details panel to edit information. The information that you update in the details panel will automatically be updated in the grid.
When you edit aggregation column values under GroupBy child records, the aggregation sub-totals are not calculated automatically. Click the Refresh button to update the subtotals.
Example:Sid, a Portfolio Manager, wants to group ideas by priority and quickly update the Planned Benefit associated with a few ideas. He then intends to examine the impact of those changes on the total Planned Benefit for High, Medium, and Low Priority ideas. Let’s examine how Sid uses the Group By functionality while analyzing ideas.
Follow these steps:
- OpenClarityand navigate to the Ideas grid.
- Drag theIdea Prioritycolumn to the Group By bar to group the ideas by priority.
- Expand theHigh,Low, andMediumgroups and locate the relevant ideas.
- Edit thePlanned Benefitcolumns directly in the grid or by using the Details panel. You will see a notification informing you that subtotals have changed.
- Click theRefreshbutton to update subtotals and examine the impact of your changes.
The rows remain in the same sort order that is used before you entered Group By mode. The groups appear in ascending sorted order. You cannot change the sort order or can choose which columns to show or hide.
The aggregated subtotals for each group are not supported wherever a mathematical total cannot be calculated. Boolean, Date, Percentage, Calculated, Formula, Aggregation, and Lookup attributes cannot show an aggregate subtotal.
ClarityCharting Capability - Beta
Claritynow provides you an out-of-the-box charting experience in the common grids in
Clarity. The charting experience is very similar to the capabilities you find in spreadsheet applications like Microsoft Excel or Google Sheets but is directly embedded within
Clarity. Let’s consider the example of Sid – a portfolio manager – who wants to review the ideas submitted by his organization and compare the planned cost with planned benefits and planned ROI. Sid needs to navigate to the Ideas page, select the relevant ideas, and use the Chart Range (beta) option. Sid can then edit the chart and export it to share it with other stakeholders.
The following video demonstrates how you can quickly and easily convert important information in the grid to graphs:
Some key points to remember while using charts in the
Claritycommon grid are:
- The string, number, percent, money, and TSV datatypes are supported. If you select cells that include other data types,Claritydoes not consider them while creating a chart.
- The ability to aggregate and group only distinct cell values in the chart is not available in this beta release.
- Every chart consists of categories and series. All the string datatypes included in your selection are considered as categories while the number, percent, money, and TSV datatypes are considered as series.
- When you create a chart, the category will be highlighted in green, while the columns included as series will be highlighted in blue. Columns that are not considered in the chart will not be highlighted.
- You can only select cells that are on your current page if you have multiple pages in the common grid. The grid displays 100 rows on one page.
Create a Chart
You can create a chart by navigating to any of the common grids in
Follow these steps:
- Navigate to any of the common grids inClarity. In our example, Sid can navigate to the Ideas grid.
- Right-click and select all the cells that you want to include in your chart.
- After finalizing the selection criterion, right-click and selectChart Range (beta), and select the type of chart you want to create. You can create Column, Bar, Pie, Line, X-Y (Scatter), and Area charts. The chart is displayed.
After you create a chart, you can perform the following actions:
- Maximize the chart to view it more clearly.
- Edit the chart details by using the Details button.
- Display or hide the selection criterion by using the hyperlink icon. When the selection criterion is visible, you can modify it to update the chart dynamically. When the selection criterion is hidden, you cannot change the initial selection criterion used to create the chart.
- Export the chart as an image file.
Some key points to remember when you create a chart are:
- Claritywill select the first string data type from the left as the default category. All other string datatypes in your selection criterion will be available if you want to edit your chart.
- You can add a category after the chart is displayed. Since you can only edit the chart settings after the chart is displayed.
Edit Chart Details
After you create a chart, you can edit it by performing the following operations.
Follow these steps:
- Use theSettingstab to change the chart type.
- Use theDatatab to modify the categories and series associated with the chart.
- Use theFormattab to edit the look and feel of the chart. Some key activities you can perform are:
- Edit the title and padding associated with the chart
- Edit the legends associated with the chart. You can change the position, padding, font, and font size associated with the legend.
- Edit the axis and grid associated with the chart. You can also use the X-Rotation and Y-Rotation options to ensure that the content in the chart is legible. This feature is useful when your category is an attribute such as the subject of an idea, which includes sentences.
- Edit the series to enable tool-tips, labels, shadow. The chart is dynamically updated to reflect your changes.
- Click the chart to exit the Edit mode.
Export a Chart
After you have finalized editing your chart, click the
Exporticon to save your chart in the PNG format.
Select Favorite Object Instances (On-Premise Only)
You can now mark various object instances as your favorite by associating a star against them. This allows you to easily flag, and find instances that require extra monitoring or attention. You can mark an instance as a favorite by using the Starred attribute available in the Column panel associated with grids in
Clarity. You can mark the following object instances as a favorite:
- Custom Investment Type
- Custom Object
Follow these steps:
- Navigate to the relevant page inClarityand ensure you are on the grid layout.
- Select the Column Panel and add the Starred attribute to the grid.
- Click the relevant row to select the instance as your favorite.
- In this release ofClarity, you can mark an object instance as a favorite only for top-level objects. This functionality is not available for sub-objects such as Tasks.
Multi-Select Delete Now Available in
You can use the Bulk Delete capability in the Common Grid to delete multiple records. Consider a scenario where you have created a project from a template and want to delete specific tasks that were created. You can now select multiple tasks and use the Delete button to delete all the tasks. If you select more than one record,
Claritywill prompt you to confirm your action before deleting the records.
- This capability is not available at an instance-level. Hence, you cannot bulk delete multiple projects, ideas, custom investments or custom objects. However, once you navigate to the Staff, Tasks, or other modules within an investment, you can select multiple records and delete them.
- Claritybusiness logic will supersede the delete request wherever applicable. For example,Claritywill not delete a task that has actuals associated with it.
- You cannot use the Bulk Delete options in the following grid:
- Cost Plans (single delete only)
- Cost Plan Details (single delete only)
- Budgets (not allowed)
- Budgets Plan Details (not allowed)
- Status Report Grid (Project Sub-Object)
- Cross Project Task Grid
- Staffing Workspace
- Roadmap Items
Export Grid Data to a CSV File
You can export the common grid data to a CSV file. Grids that support Export to CSV include projects, custom investments, custom sub-objects for projects, assignments, staff, and ideas.
- TheClassic PPMuser interface supports the export of up to 25000 rows to CSV file. In this releaseClaritysupports the export of up to 250,000 rows to CSV file.
- If you export hyperlinks that are greater than 255 characters,Claritywill truncate the link and display only the label. If the link is less than 255 characters, you can see both the hyperlink and the label.
You cannot export a CSV file when the grid is in group-by mode.
Follow these steps:
- Navigate to a grid that supports the Export to CSV functionality.
- Filter the data, add or remove columns, sort, and modify the view. Exit group-by mode.
- Click theExport to CSVicon:
- If your view includes 500 or fewer rows, your new CSV export file is produced immediately.The application assigns your current view name (or unsaved view) to the downloaded CSV file name. For example, if your view isUnsavedand you click theExport to CSVicon, the downloaded file name is unsaved.csv.
- If your view includes more than 500 rows, the messageExport in Progress. The "Download will be available in..." notificationsappears.The application assignsjobid_viewname.csvas the downloaded CSV file name. For example, if your view name is Export Investment, the downloaded file name is 5000021_Export Investment.csv.The file is saved and is available for download up tosevendays from the date of download. The notification displays the date in the mmm-dd-yyyy format.The export runs in the background. You can continue working in the application.When the file is exported and available for download, a notification appears in the notification (bell) icon at the top right of all pages inClarityto alert you.
- Click the notification (bell) icon to view a link to the file you exported.
- Click the link to download the CSV file.
- To cancel the export, clickCancel.
Data Formatting in the Exported CSV File
- All dates appear in the YYYY-MM-DD format in the CSV file.
- For all locales and language settings, all decimal points appear as a period (.) or dot character.
- Money values do not include any currency symbols.
- Semicolons appear as delimiters in between the values in multi-value lookup fields. For example,Carryover; Required; Top Choice.
Manage Your Data Using Board Layouts
You can use the Board layout in
Clarityto view projects, project tasks, ideas, and custom investments as cards. You can arrange these cards you can arrange with drag-and-drop precision on a board layout with columnar swim lanes. Some key features associated with cards are:
- Cards can now display numeric data and money values (users can adjust the appearance of this data in View Options)
- Cards appear in your choice of colors based on the value you select in the Color By field in View Options. Your color selections appear in the legend and are saved with the view.
- Card titles default to the Name field. If you configure a default value for the Name field in Studio, the application uses that value when creating cards. Without a default value, new cards show New Item as their default name.
- You can double-click a card to edit its name. You are not limited to using the default name. You can change the field used by the cards to display their names. In View Options, select any string attribute.
- You can configure cards to display up to four (4) additional fields in any order (use View Options). When additional fields are selected, the name of the fields appears in the legend area.
- You can configure cards to display up to three (3) numeric metrics in the order that you select. The name of each metric appears in the legend.
Roadmap items are also depicted as cards on a board. However, it currently does not use the common board layout component in
Standard Features Associated with the Board Layout
Show and Hide Columns:
You can use the Columns panel to show and hide columns in the board layout.
Use the Filter Locate Relevant Records:You can apply one or more filters to search for data that meet your filter criteria.
Set Your View Options in the Board Layout:
Follow these steps:
- Open an investment and navigate to the relevant module if applicable.
- Click theBoardlayout.
- ClickView Options.
- Under BOARD OPTIONS:
- COLUMNS: Select the attribute that you want the board to use for each column.
- COLOR BY: Select the attribute that you want the board to use for the color of each card.
- Under CARD OPTIONS:
- CARD TITLE: Select a string attribute to appear at the top to identify each card on the board.
- CARD FIELDS: Select up to four (4) attributes to appear on the face of each card in the order selected.
- CARD METRICS: Select up to three (3) attributes to appear along the bottom of each card to convey meaningful status information or metrics.
- To configure your own display attributes, choices, and the color of each value, clickMANAGE PICKLISTS.
- PICKLIST NAME: Enter a name for your picklist. Each picklist you define can be applied to the current project only.
- ADD CHOICE: To add a value for your picklist, clickADD CHOICE. Edit the name and color for each choice.
- When finished, clickDONE.
Creating New Records in the Board Layout
When you are in the Board layout and try to add a new record, you get an error message because there are required fields that do not have default values. Whenever you create a new record from the board view, the Details panel is automatically displayed. The panel includes all the required fields needed to create a new record. After you populate the required fields,
Clarityrefreshes the Details panel and creates a new record. You can then continue editing the record and close the Details panel after you complete your changes. Remember that your record will be lost if you leave or refresh your current view.
When you are populating required fields for a record in the Details panel, you cannot drag and drop the record across different columns since the record has not yet been created in
Common Features Across Grid and Board Layouts
You can use the following capabilities across the grid and the board layout:
Add an Attribute in Grid and Board Layout
Here are the various ways to add an attribute in Grid and Board Layout:
- On the Grid layout, click theColumn Paneland select the attribute.
- On the Board or Grid layout, select an investment item.
- Click theDETAILSpanel.
- On the Details tab, clickConfigure.
- In the search bar, search the attribute.
- Drag-and-drop the attribute to the details tab.
- Configure Blueprints Properties
- In the Clarity main menu, clickAdministration.
- Open a blueprint and clickEdit.
- In thePropertiestab, search the attribute.
- Drag-and-drop it to the Properties section.
- ClickPublishto publish the blueprint. Ask the users to refresh the browser session to see the new attribute in the properties tab within the investment.
Edit Information by Using the Details Panel
Project Owners and Business users with access rights can configure and use the Details panel to quickly view and update fields in
Clarity. The Details Panel is available as a two-column layout and can be resized to take up 75% of the screen. The Details layout allows you to include two fields per row. You can horizontally drag any field to occupy one or both columns of the layout. You can vertically resize string and large string datatypes.
While the width of the Details panel is persisted for users across pages in
Clarity, the fields in the panel are associated with your view.
The Details panel is available across
Claritywhere you can use the standard grid or board layouts. The panel is also available for the Timeline layout for tasks.
Example: Nicole wants to ensure that every time her team reviews project tasks in
Clarity, they can:
- Review if the task is critical or not so that they can prioritize a critical task
- View what percentage of the task and been completed and the actual effort expended on the task
Follow These Steps:
- OpenClarityand open the relevant project.
- Navigate to the Tasks module and open the Grid layout. Remember that the Details panel is also available in the Timeline (beta) and the Board layout. The updates you make in one layout will persist across the other layouts.
- Click any row in the grid.
- The DETAILS tab appears along the right edge of the page.
- Click theDETAILStab. The DETAILS panel appears.
- On the DETAILS panel, click theDetailstab.
- Search for and locate the Critical field.
- Drag a field from the list of fields to the Details panel layout. Drop the field on the top of an existing field. Your new field is displayed on the layout above the existing field.
- You can drag and drop fields to reorder their sequencing. Remember that you can horizontally drag any field to occupy one or both columns of the layout. You can also vertically resize string and large string datatypes.
- Similarly, add and arrange the % complete and the Actuals fields to the details layout.
- To remove a field, select it on the layout and then clickX Remove.
- ClickVIEW,SAVE AS, and enter the name of a VIEW to save it.
If you see a lock icon next to an attribute in the Details panel, it means that the attribute is locked by a process and cannot be edited.
Add Custom Sub Objects To The Details Panel
You can configure
Clarityto display sub-objects in the Details panel. This allows you to review, edit, and analyze data associated with custom sub-objects in the Details panel. Consider a scenario where a customer uses
Clarityto manage projects and products. They have created a custom master object NPS to capture the Net Promoter Score for products. They have also created two sub-objects to capture data related to Support and Services.
You can view the sub-objects in the Details panel by performing the following steps:
- Ensure that the custom sub-object is API enabled.
- Create a copy of the Custom Object blueprint and edit it.
- Add the sub-object as a module and select theShow in Detailscheckbox.
- Associate the new blueprint with the record.
- Navigate to the custom object and select a record.
- Open the Details panel and navigate to the sub-object module.
- Edit details by using the grid layout.
- The tabs in the Details panel now have names instead of icons to distinguish between various sub-objects.
- The tabs in the Details panel now have a scroll so that you can navigate between various sub-objects.
- Sub-objects share the grid between module and Details panel.
- The Grid View layout defined in the module will be reflected in the details panel. Any changes you make in the Details panel will also be reflected in the grid.
- Sub-objects in the Details panel cannot have their own panel.
- You can expand and close the sub-object to have a larger viewing area.
- The state of the Details panel is retained till the user changes it.Claritypersists the state even if the user logs out ofClarity.
- The tab selected with the Details panel is also retained.
Filter Your Data in Grid or Board Layout
You can use Filters to quickly identify records that match your selection criterion. Consider a scenario where you want to focus on ideas that have a significant impact on your organization. Hence you decide to focus on either high priority ideas or ideas where the planned ROI is between 100 and 400 percent. In such cases, you navigate to the ideas grid and create a filter with Idea Priority and Planned ROI as the parameters and use the Match Any criterion. This criterion uses the logical OR filter to display ideas where the priority is high or the planned ROI is between the specified percentages. We could use the Match All criterion if we want to use the logical AND criterion.
You can also use different operators in your filter criteria to be more specific about the data you want. Consider a scenario where you want to ensure that the ideas with the planned ROI of above 100 percent, have a manager assigned so that the team gets mentored through the process. In this case, set the following values in the filter, with the Match All criterion:
Filter Condition 1
Filter Condition 2
The filter option in the UI does not consider the timestamp for attributes of type date. If you want to filter data with a specific timestamp, use APIs.
Common Search Component
You can use the Search bar available across the board, gird, and timeline layouts to filter values based on the name or ID. Consider an example where you want to locate a specific task in an investment. You can simply type the first few characters of its name in the Search bar to locate it and edit it. The search values are not persisted when you save a view. Also, if you navigate away and return to the workspace, the search bar will be cleared. You can use the Search bar alongside the traditional filter available in
Clarity. Consider an example where you use the filter to identity all the tasks that have not started and then use the search bar to look for a specific task.
Clarityonly displays results that meet the criteria of the filter and the Search bar.
- The Search bar is not available in Roadmaps, the Staff module, and the Assignments module.
- When you are using special characters in Search, you need to use "backslash" \ before the special character to see relevant results. Consider an example where you have created a project named "GTM Transition %50 Takeover". If you simply use "%" in the Search box, you will see all the projects that you can access in Clarity. Use "\%" to Search for projects that include "%" in the Project Name.
The following image shows examples for working with the common drop-down value lists. When a value list appears for a grid column or as a field on a page, it allows you to select one value (a typical single-select field) or multiple values (a typical multi-select field). When these value lists appear as filters, you can typically select multiple values, even for single-select fields. This behavior allows you to filter or search for more records. For example, records that match Selected Choice 1
Select Values in Drop-Down Lists
ORSelected Choice 2.
Clarityallows you to save and modify multiple views that help you achieve your business goals. Some of the key actions a user can perform are:
- Save an existing configuration in the grid, board, or timeline layout as a view
- Update existing views, by using the Quick Save functionality
- Access views saved by other users
- Mark relevant views as favorites so that you can access them easily
- Select default views
- Search for specific views
- Delete your views
Clarityadministrator can also assign the Views – Administer access to a resource. Any resource with this access right can:
- Assign specific views as default views for all users
- Delete views created by other users
Every time you save a view, it automatically gets added to your
If Derrick makes any change to his view, he can click
Saveto save his changes and update the view in a single click.
FAVORITESlist. You can click the Manage option to open the
MANAGE VIEWSwindow and clear the
FAVOURITEcheckbox associated with your view, to remove it from the
Nicole who is a project manager working with Derrick informs him that she has created a view that helps her see the monthly allocation of resources. She has called it Monthly Allocation View. Derrick accesses that view using the Manage option to set it as a favorite so that he can also access it easily.
If Derrick loads the Monthly Allocation View created by Nicole and makes changes to it, the view will now be called "Unsaved copy Monthly Allocation View". Derrick can now click Save to save the view or use the View Selector to save the view with a new name. In either scenario, Derrick's changes will not impact Nicole's original view.
If you have
Views – Administeraccess right, you can set the Monthly Breakdown view as the default view for all users. When users access the Staff grid for the first time, the default view will already be loaded for them. If a view is selected as both default and favorite the default setting will take precedence. The
Views – Administerright also gives you the privilege to delete access rights created by other users.
Any user with the
Views – Administeraccess right will only be able to delete views from areas of the application that have rights to access. For example, if the user has the rights to access the Staff module but not the Financials module for projects, they can only delete views from the Staff module.
When you use an out-of-the-box or custom sub-object associated with the Investment abstract object (Staff, Tasks, Cost Plan), then saved views on those sub-objects are available across various objects and instances. Review the examples given below to learn more about this feature.
Saved Views on Sub-Objects of the Investment Abstract Object Are Available Across Objects and Instances
When you save a view in the Staff module, it will be available across all other instances and objects that are using the Staff module in
Saved Views on the Staff Module
Clarity. The Staff module is available for projects, custom investments, and ideas.
Example:Derek is a resource manager and is responsible for staffing investments. He navigates to the Staff grid for a project and customizes the grid to show per-period metrics for soft and hard allocations. He also configures the grid to display the allocation for each resource every month and saves this view. The view will now be available across all the projects, and custom investment items.
When you save a view in the Tasks module, it will be available across all other instances and objects that are using the Tasks module in
Saved Views on the Tasks Module
Clarity. The Tasks module is available for projects and custom investments. If your current instance or object does not include elements such as picklists or filters, you will receive an error message. Then, you will see an unsaved view with all the elements of the saved view that apply to your current object and instance.
Example:Nicole, the project manager, has created a custom picklist in the timeline layout for the tasks module. She has also set the Periods to months and added a filter to review tasks with ETC between 50 and 100 hours. She now saves her view and calls it High ETC. This view will be available across all projects and custom investments in
Clarity. However, when stakeholders use the High ETC view on the Tasks Module in a different project or custom investment, they will see an unsaved view. This is because the picklist is only associated with the project in which it was created. Stakeholders will see the ETC filter, and the Period will be set to months. Stakeholders can save the unsaved view and continue to use it.
When you save a view in the Cost Plan gird, it will be available across all other instances and objects that are using the generic cost plan grid. The generic Cost Plan grid is available for projects, ideas, and custom investments. If your current object instance does not include a grouping attribute that was used by a filter or group by in the saved view, you will receive an error message. Then, you will see an unsaved view with all the elements of the saved view that apply to your current object and instance.
Saved Views on the Cost Plan Grid
Example:Rita, a financial manager, created a cost plan for an idea and used department and location as a grouping attribute. In the cost plan, she sets the periods to months and a money decimal display. Finally, she groups the costs by location and saves her view. When stakeholders apply this view to a custom investment cost plan where the grouping attribute is Cost Type, they will see an unsaved view. This is because the location grouping attribute is not available in the custom investment. Stakeholders will still see the periods set to months and the relevant money display.
All attribute data types except the following are available for configuration in a grid:
Available Attribute Data Types
- Custom time-scaled value (TSV)
You can perform the following tasks using the attribute data types:
While the attachment attribute is not available in the grid, you can now:
- Configure the attachment attribute to be displayed in the Details panel.
- Configure the blueprint of the corresponding object to display the attachment attribute on the Properties page.
- View, upload, and delete attachments in the Details panel or in the Properties page.
Required attributes display an asterisk (*) after their label.
- Your current saved view might be missing one or more required fields. When you add a new row, the application shows the required fields that do not have predefined default values and your view switches tounsaved. Any custom attributes that are marked as required are also added to the view.
- If you add a required custom attribute inClassic PPMwhen records already exist in the system, provide a default value. We also recommend that you select thePopulate Null Values with the Defaultoption.
- Another way to populate a new required attribute is to specify anAPI Attribute IDso users can add it to the grid using the Column Panel and can enter a value.
API Enable Custom Attributes
When you create a custom attribute, you must API enable the attribute to make it available in
Clarity. This setting will also let you access the attribute through API calls.
Follow these steps:
- Log in toClassic PPM.
- Navigate toAdministration,Studio,Objects.
- Search for the object (such as Project) that has the custom attribute.
- Open the object and navigate to theAttributestab.
- Search for the custom attribute and click to open.
- Specify a unique ID in theAPI Attribute IDfield. The value must begin with a lowercase letter and an underscore. For example, p_uploadImage.The API Attribute ID is the reference key for an attribute that appears in the result set of an API call. To identify your custom attributes and validate the uniqueness, we recommend that you prefix your API Attribute IDs with a consistent short string. Making your API Attribute IDs unique prevents conflicts during a future upgrade when new attributes are introduced. For example, ACME Corporation can assign the following unique API Attribute ID to its Compliance attribute: p_acmeCompliance. We also recommend that you use Camel Case notation to name your custom attributes.
- Save the changes.
Clarity. You can configure the attribute to be visible in the Board Layout, Grid layout, and Detail panel. To view the attribute in the Properties page, configure the blueprint of the object. For more information, see the Edit a Blueprint section.
You can store your filter, column, sorting, and grouping settings in a saved view. If an attribute in the saved view is later removed or inactivated in
What Happens When An Attribute In My Saved View Is Removed Later?
Classic PPMStudio, the following behavior occurs:
- You and other users can still access the view.
- The removed or inactive attribute no longer appears in the filter, columns, sort order, or grouping.
- The named view now appears with theUNSAVEDicon.
Static Dependent lookup and Parameterized lookups are enabled in
Static Dependent and Parameterized Lookups
Clarityfor Projects, Ideas, and Custom Investment type objects. You can configure and API enable the required lookups from
Classic PPMand edit and publish the Blueprint in
Clarityfor the lookups to appear. For more information, see API Enable Attributes.
Static Dependent Lookup- The lookups that can be applied to a single field and have structured hierarchy are static dependent lookups. You can select the lowest level value from the lookup hierarchy based on the highest level selection.
- For the static dependent lookup to appear inClarity, you must populate the API attribute ID.
- Once enabled the lookups are available wherever attributes are applicable and filtered. The static dependent lookups can be added to the Details panel using the Blueprint.
- You can also add static dependent lookups to board cards.
- You can add these attributes as columns in Grid view and in the Details panel. You can also filter data based on the static dependent list lookups.Example:The Investment Stage of a project can be indicated with a static dependent lookup such asInvestment Stage > New Product Development > Maintain.
Parameterized Lookup- Two lookup fields are connected by a passed parameter. Two lookups are defined as two separate attributes in the object and the value from one lookup will determine the available values in the second lookup.
- Parameterized lookups will appear inClarityonce their API alias values are populated.
- The lookups will function the same as inClassic PPMUI.
- Enabled parameterized lookups can be added to blueprints to be included in the Properties page.
- Changes of a lookup value in a grid view or in the Details panel are reflected seamlessly in the other.
- You can also add parameterized lookups to board cards.
- You can filter data based on parameterized lookups. When filtering based on dynamic query-based lookup (lookup that changes options based on primary lookup value) then the filter will display all possible options.
Application Changelookup has two sub-values
COTS Evaluation. After you select the project type, you can select the project category.