Escolar Documentos
Profissional Documentos
Cultura Documentos
This documentation and any related computer software help programs (hereinafter referred to as the "Documentation") are for your informational purposes only and are subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be used or disclosed by you except as may be permitted in a separate confidentiality agreement between you and CA. Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION "AS IS" WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with "Restricted Rights." Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors. Copyright 2010 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.
Contact CA Technologies
Contact Technical Support For your convenience, CA Technologies provides one site where you can access the information you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product
Provide Feedback If you have comments or questions about CA Technologies product documentation, you can send a message to techpubs@ca.com. If you would like to provide feedback about CA Technologies product documentation, complete our short customer survey, which is available on the CA Support website at http://ca.com/docs.
Contents
Chapter 1: About Studio 9
Studio Features and Benefits ................................................................... 9 Key Features and Benefits ................................................................. 10 How to Get Started with Studio ................................................................ 12 The Studio Process Overview .............................................................. 12 About Data Providers ..................................................................... 14 Important Studio Terms....................................................................... 15
Chapter 2: Partitions
17
Partitions Overview ........................................................................... 17 The Benefits of Using Partitions ............................................................ 17 How Partitioning Works ....................................................................... 18 About Partition Models .................................................................... 19 Partitions and Object Views ................................................................ 20 Portlets and Partitioned Data Providers ..................................................... 20 How to Work with Partitions ................................................................... 21 How to Create and Use Partitions .............................................................. 22 Create Partition Models .................................................................... 22 Add a Partition to a Partition Model......................................................... 23 Add Many Partitions to a Partition Model (Quick Create) ..................................... 24 Add Members (Resources) to a Partition .................................................... 25 Apply a Partition Model to an Object ....................................................... 26
27
About Objects ................................................................................ 28 Process Overview: Working with Objects ....................................................... 29 About Data Providers ......................................................................... 30 Objects Data Provider ..................................................................... 31 System Types Data Provider ............................................................... 35 Create Objects ............................................................................... 36 Grant Access to Objects ....................................................................... 37 Object Attributes ............................................................................. 38 Attribute Data Types ...................................................................... 38 How to Add Attributes to Objects .......................................................... 40 Calculated Attributes ...................................................................... 68 Autonumber Object Attributes ............................................................. 79
Contents 5
Modify Object Attributes ................................................................... 84 Delete Object Attributes ................................................................... 85 How to Audit Objects ......................................................................... 87 Delete Objects ............................................................................... 89 About Add-Ins ................................................................................ 90 Apply the Add-In ............................................................................. 90 Views ........................................................................................ 91 Add User-Defined Fields to Views .......................................................... 92 Create Subpages for the Properties View .................................................. 102 Publish Changes to List and Filter Views ................................................... 107 Restore Defaults for Object Views ......................................................... 110 Restore Defaults for Selected Views ....................................................... 110 Restore Defaults Based on Partitions ...................................................... 111 How to Display Multiple Subpages on a Tab ................................................... 114 Define and Manage a Custom Property View ............................................... 114 Display Custom Subpage Links on a Tab Using the Custom Property View ................... 118 Links for Pages and Subpages ................................................................ 120 Link from an Object Page to a Subpage ................................................... 121 Link from an Object Attribute to a Web Page ............................................... 121 Link to Properties Pages from External Applications ........................................ 123 Add Image Fields to List Column Views ........................................................ 124 Add Gantt Chart Fields to List Column Views ............................................... 124 Add Image Link Fields to List Column Views ............................................... 126 Add Progress Bar Fields to List Column Views .............................................. 127 Change Field Properties ...................................................................... 128 How to Change a Field's Appearance .......................................................... 130 Change Field Labels ...................................................................... 130 Display a Range of Values as a Color or Icon............................................... 131 Change the Appearance of Properties View Attributes ...................................... 132 Change the Appearance of List Column View Fields ......................................... 134 Change the Appearance of List Filter View Fields ........................................... 137 Display Fields as Bar or Column Graphs ................................................... 138 Menus, Sections, and Links ................................................................... 141 Add Menu Items or Links ................................................................. 141 Change Sections and Links ............................................................... 143 Move Sections and Links ................................................................. 144 Delete Sections or Links .................................................................. 144 Icons ....................................................................................... 145 Stock Icons ................................................................................. 147
151
Types of Access Rights ....................................................................... 152 Stock Portlets ............................................................................... 154 About Personal Dashboards and Portlets ...................................................... 160 Dashboard Properties Settings ............................................................ 161 Dashboard Access Rights ................................................................. 161 Administrator Access to User Portlets ..................................................... 162 Personal Dashboarding Operations by User Type ........................................... 162 Data Providers for Personal Dashboards ................................................... 163 Interactive Portlets .......................................................................... 164 Create the Interactive Portlet ............................................................. 164 Create Object or Global Parameters ....................................................... 166 Graph Portlets ............................................................................... 167 Data Providers ........................................................................... 168 Graph Portlet Types ...................................................................... 169 Create Graph Portlets .................................................................... 170 Determine Graph Portlet Appearance ...................................................... 172 Determine Graph Portlet Data to Display .................................................. 178 Change Graph Portlets ................................................................... 179 Delete Graph Portlets .................................................................... 180 HTML Text Portlets .......................................................................... 180 Create HTML Portlets ..................................................................... 181 Change HTML Portlets .................................................................... 182 Delete HTML Portlets ..................................................................... 182 Grid Portlets................................................................................. 183 Access Rights and Grid Portlets ........................................................... 183 Grid Portlet Aggregation, Comparison, and Variance Options ................................ 183 Hierarchical Grid Portlets ................................................................. 184 Things to Consider When Creating Grid Portlets ............................................ 184 Create Grid Portlets ...................................................................... 185 Determine the Layout of Grid Portlets ..................................................... 187 Change Grid Portlets ..................................................................... 190 Delete Grid Portlets ...................................................................... 190 Filter Portlets ................................................................................ 191 Filter Precedence ........................................................................ 192 Scope of Filter Portlets ................................................................... 193 Filter Persistence ........................................................................ 193 How to Set Up Filter Portlets .............................................................. 194 Create Filter Portlets ..................................................................... 194 Field Data Types for Adding to Filter Portlets ............................................... 195 View the List of Portlet Pages for Filter Portlets ............................................ 207 Determine the Layout of Fields on Filter Portlets ........................................... 208 Portlet Pages: Deploying Content ............................................................. 209
Contents 7
Create Portlet Pages ..................................................................... 209 Add Filter Portlets to Portlet Pages ........................................................ 213 Delete Portlet Pages ..................................................................... 215 Publish Changes to Portlets................................................................... 215 Access to Portlets and Pages ................................................................. 215 Restrict Access to Portlets or Pages ....................................................... 216 User Configuration Restrictions of Portlets ................................................. 217 Configurable User Actions ................................................................ 219 Delete Filter Portlets ......................................................................... 223
Chapter 5: NSQL
225
About NSQL Queries ......................................................................... 225 The NSQL Syntax ........................................................................ 225 NSQL Constructs ......................................................................... 228 User-Defined Constructs ................................................................. 230 Advanced NSQL Constructs ............................................................... 235 About Queries ............................................................................... 237 Create Queries .......................................................................... 237 Change Queries.......................................................................... 239 Delete Queries ........................................................................... 239 About Lookups .............................................................................. 240 Browse-only Construct for Dynamic Query Lookups ........................................ 241 Hierarchical Queries ......................................................................... 242 Filtering in Hierarchical Queries ........................................................... 242 NSQL Troubleshooting and Tips ............................................................... 243
Index
245
You can propagate the fields and objects you create to CA Clarity PPM interfaces and the CA Clarity PPM XML Open Gateway (XOG). Unlike most configurations, your CA Clarity PPM configurations automatically carry forward to future versions of the product.
Benefits Enables organizations to easily collect, aggregate, analyze and display important information by using a combination of PowerMods and portlets. Through a completely point-and-click user interface, CA Clarity PPM administrators can create fields, deploy them in forms on specific pages, and build portlets to graphically communicate the information collected.
Point-and-click portlet Delivers over 40 stock and an unlimited number of construction user-defined portlets that display graphs, tables, and HTML content. These portlets reflect the users access rights and filter settings and allow them to access and drill into information in a single, consolidated view. Multiple display types Drill-down graphs Displays graphical information in grids or bar, bubble, column, funnel, line, pie, and scatter graphs. Allows administrators to define links that provide users access to underlying data and specific instances of objects. Filter data on any number of predefined, configurable parameters. Reduces administration costs by providing built-in organizational breakdown structure (OBS) security. Once access rights for viewing information are assigned through a configurable, flexible hierarchy, users see only the information for which they have access. Portlets automatically generate graphs and tables based on the privileges of the current user. Supports distributed and diverse organizations by allowing local configurations within a single global instance of CA Clarity PPM. Each partition can be configured with its own fields, forms, processes and branding. Add new business objects to CA Clarity PPM and then configure them with fields, forms, processes, and portlets. Allows users to provide document and other types of attachments for any standard or user-defined business object. Simplifies administration by centralizing the
Partitions
User-defined objects
Attachments
Centralized field
Features control
Benefits management of all user-defined fields within Studio. User-defined fields are automatically deployed to the user interface, to the process engine, to OpenWorkbench, to Microsoft Project, and to the XOG (XML Open Gateway). Provides a consistent user interface across applications by allowing organizations to configure CA Clarity PPM to display colors, logos, menus and pages with a specified corporate look and feel. Easily extends the capabilities of CA Clarity PPM by creating new pages that organize and display information in useful ways for the business, such as a Project Management Office News page, an Executive Dashboard, and a Program Issues Tracking work space. Reduces training and support costs by organizing the CA Clarity PPM menu navigation to match the companys terms and processes. During object creation, you can enable a feature to allow all instances of this object and its subobjects on one properties page. Create a hierarchy of up to three levels of user-defined objects that inherit properties from higher level objects. Create string objects of any length (subject to limitations of your database). Export objects in XML format. Apply add-ins to import a collection of content (pages, portlets, queries, project templates, roles, etc.) as a single entity. Configure and add your own status attributes to action items.
Menu manager
View All
Note: To get started with Studio, launch the CA Clarity PPM Administration Tool and click the links from the Studio menu.
Partitions help you govern centrally and manage locally. Local organizational units can manage their business independently of other organizational units, yet still adhere to governance requirements.
CA Clarity PPM can look one way for one subsidiary or business unit and one way for another.
Definition Access rights determine which CA Clarity PPM object instances you can access and the actions you can take on them, such as view, edit, or approve.
Attributes (Fields) Information that is associated with and may or may not display on an objects pages. Data provider Dimension The source of data used by Studio portlets. Data providers can be objects, queries, and system types. Related data elements in a query. For example project-related data (project ID, name, start date, etc.) is considered a single dimension. If a query contains project and resource data, it contains two dimensions. Drop-down lists or browse lists that filter portlet data. A navigational element of the user interface that provides links to other pages in the application. A value in a dataset, such as booked hours, capacity, or number of tasks that can be measured. An extension of the SQL language that is used to query data in the CA Clarity PPM database. A resource, document, user, access role, or system group. These are particular elements or records that you can attach or associate to an OBS unit. Some of the object types included in CA Clarity PPM are portfolios, resources, programs, projects, applications, assets, products, ideas, other investments, companies, and users. Organizational Breakdown Structures; a hierarchical unit structure used to view the framework of an organization from both a visual and functional perspective for aggregation, drill down, resource searching, and rights. Partitions are local configurations of CA Clarity PPM that may have their own forms, fields, processes, branding, and security rules. A section of a page that is displayed in CA Clarity PPM. Portlets can take the form of lists and graphs among other types. A set of conditions used to retrieve specific information from a database.
OBS
Partition
Portlet
Query
Term Resource
Definition In CA Clarity PPM, a user who can be assigned to perform work on a project is a resource. You can associate resources with skills, primary role, resource pools and OBS. Resource profiles have properties such as, resource name, email address, employment type, manager, available hours per day, target billable rate, and standard cost. A resource does not have to be a user although every user is also a resource. This is the default partition that exists in each CA Clarity PPM enterprise installation. Any partitions you create become children to this partition. A CA Clarity PPM user who has access rights and permissions to use CA Clarity PPM. A CA Clarity PPM user can participate on a collaboration project and can also be a resource. An objects view determines how information displays on a page. Columns whose data is not computed when the query is created (i.e. the data is created in realtime). A field to which CA Clarity PPM can make calls but that does not physically exist in CA Clarity PPM. It may be a calculated field, or a field with temporary values generated by CA Clarity PPM as needed. You cannot access a virtual field because it does not physically exist.
System Partition
User
Chapter 2: Partitions
This section contains the following topics: Partitions Overview (see page 17) How Partitioning Works (see page 18) How to Work with Partitions (see page 21) How to Create and Use Partitions (see page 22)
Partitions Overview
If you create new partitions, you should become familiar with the basic concepts of partitions. If you create even one partition, you will see partition options as you work objects and portlets. You can simply accept the default System Partition and all groups and users will have access to your work. If you do not create new partitions, all the objects you create are automatically assigned to the System Partition.
Chapter 2: Partitions 17
Note: Reports and Jobs cannot be partitioned, but you can control access to them using access rights.
When you create an attribute (field) you can choose to make it available for any ancestor and/or descendant partition, or you can choose to only make it available to the partition for which it was created. This association is called the Partition Association Mode. An attribute, however, can only be associated with one partition at a time.
You can change the partition assignment or partition mode of an attribute at any time. You should carefully consider the impact your changes may have on items that reference those attributes. For example, a grid portlet that uses a user-defined date attribute for Gantt chart columns may no longer be able to render it because the required attribute is no longer available. A process instance may fail because it can no longer evaluate or set a certain attribute.
You can set up multiple partition models, however: A business object can only be assigned to one partition model at a time. As a Studio user, you can be a member of more than one partition within a partition model. However, when you create new objects, you will be asked to select the partitions to use. For example, you may be a member of the United States and European partitions, but you will have to choose which one to use when you create a project. CA Clarity PPM users can only be members of one partition and thus do not need to select a partition. Users that are not member of any partition will see the System Partition (default) views.
Chapter 2: Partitions 19
You do not need to define object views for each partition in a partition model. If a partition has no view, it inherits the view from the nearest ancestor partition. If no ancestor partitions have views defined, the partition uses System Partition views. CA recommends that you first define partitioned views at the top of the partition model. For example, if you are using a geographical partition model with World at the top and United States and Europe as descendants, you should define the World views first (see illustration below.)
If you set up object views for your partition and want to overwrite partitioned views for descendant partitions, you can restore the default view for an ancestor partition.
Partitioned lookups allow you to govern globally by enforcing the use of standard options throughout an entire branch of a partition model. You can manage locally by adding lookup values to meet the unique requirements of a business units partition(s). You can add partitioned values to stock CA Clarity PPM static lookups or to user-defined static lookups. If an object instance is not partitioned, the lookup shows only values for the System Partition. You can assign a lookup to a partition when you create it or you can change an existing lookup and assign it to a partition.
Chapter 2: Partitions 21
Note: To work with partition models, you will need Studio - Access, Partition Administrator and preferably System Partition - Administrator access rights.
Chapter 2: Partitions 23
7. Click Exit. Note: You can authorize resources (users) or groups to be members of this partition.
Chapter 2: Partitions 25
About Objects
About Objects
Objects are the heart of the PowerMods functionality. Objects define the attributes (fields), subpages (links), page layout, and views that make up your configured version of CA Clarity PPM pages. Several stock objects are available for you to use. For example, you can use the Audit stock object to create pages that manage audit trail information. You can use the Audit object as is or you can create a subobject of the object that has only some of the characteristics of the Audit object. In this situation, this object would be the master object and your new object would be a subobject. You can also create a hierarchy of up to three levels of objects and then allow child objects to inherit properties and access rights from parent objects.
If you are using partitions and you add a master object to a partition model, any subobjects you create are automatically assigned to that same partition model. When you change the master object, those changes are automatically made available to the subobject. After you select an object to use, you will then create an instance of the object that you will actually use in your application. Note: As the creator of an object, you automatically have access rights that allow you to view and change the object. For other users to view and change the new object, you will need to grant them access rights to it.
Description Used with the Team object to list data about requests for project resources or roles. This provides combined data for investment types (Projects, Assets, Applications, Products, and Other Investment). This is a subset of the Task object and contains data about key tasks. This provides data about the tasks a resource is assigned to. This contains portfolio data. This contains data about programs and the projects which belong to a program. This contains data about resources assigned to projects. This contains data about resources assigned to projects. This lists data about projects that a resource is assigned to.
Key Tasks Organizer Tasks Portfolios Programs Project Team Members Project Team Selection Resource's Projects List
Contract This object contains information about project contracts. Cost Plan Detail This object details the cost plan information used to create cost projection scenarios and budget revisions for an investment. Cost Plan This object contains the attributes used on the Cost Plan and Budget list pages Department The object represents a place in a company's organizational chart. This object is used primarily as a point of responsibility for staff and budgeting. Dependency This object stores project management dependencies between tasks. Financial Properties This object stores financial properties information displayed on the Financial subpage for NPIOs. Financials This object stores the attributes for the Simple Budget page. Fiscal Time Period This object stores the fiscal time periods used in financial plans and chargebacks. GL Account This object represents the general ledger account. A GL account is used when charging departments costs delivered work, and for crediting departments for the cost of resources. Investment Parents This object contains the attributes used on the Parents subtab under the Hierarchy tab. GL Allocation This object represents the general ledger account. A GL account is used when charging departments costs delivered work, and for crediting departments for the cost of resources. GL Allocation Detail This object is used to capture the percentage of cost debited to a specified GL account-department combination. This is a subobject of the GL Allocation object.
Ideas Ideas are the initial stage of creating new opportunities for investment such as projects, assets, applications, programs, and products. Ideas lay the foundation for a specific type of investment by serving as a container for pertinent information. You can use CA Clarity PPM to track and convert ideas into investment opportunities. Incident This object describes contact information, problem description, effort, resolution, and resolver information for incidents (such as those reported to a help desk). Investment This is an abstract object that contains the base attributes for all CA Clarity PPM investments. Investment Rollup This object stores attributes used in the financial rollup and effort rollup for a project. This information is displayed in subtabs under the Hierarchy tab that displays for a project. Invoice This object stores the invoice attributes used for chargebacks. Issues This is a risk that has been realized. This object enables risk property management to help increase the likelihood of project success. Other Investment Applications, projects, assets, products, programs, and other investments comprise the inventory of a portfolio. Until an organization identifies, catalogues, and adequately describes the complete domain of investments within their portfolio, portfolio management is effectively impossible. Each type has a common set of attributes such as budgeted cost, ROI, Risk, and NPV. Other Work This object stores attributes used within the Other Work investment. Portfolio This object represents a portfolio of investments in CA Clarity PPM. It supports the portfolio management process where decisions about investments to continue, discontinue, postpone, or start are evaluated.
Product A project is a related set of tasks performed to achieve a specific objective. This object describes who is responsible for managing and working on a project, when it needs to be done, and how much it will cost. Projects are key investments within a portfolio. Project Financial Properties This object stores project properties information that appears on the Financial subpage for projects. Project A project is a related set of tasks performed to achieve a specific objective. This object describes who is responsible for managing and working on a project, when it needs to be done, and how much it will cost. Projects are key investments within a portfolio. Requisition The object describes information about requisitions such as the date it was created, by whom, priority, status, description, and the project with which it is associated. This is a subobject of the Project object. Requisition Resource This object stores staffing requisition resource information. This is a subobject of the Requisition object. Resource Credit This object is used to capture a set of attributes that uniquely defines a GL account- department combination when setting chargeback credit rules. Resource Credit Detail This object is used to capture the percentage of cost credited to a specified GL account-department combination. This is a subobject of the Resource Credit object. Risk This object describes the measurement of a project's likelihood of meeting expectations (finishing on time, within the budget, and with the expected quality level), determined by a measurement in the project's methodology. The Risk Indicator reflects the highest risk of component projects. This is a subobject of the Project object. Service This object stores the attributes used by a service investment.
Subscription The object represents the relationship between a consumer department and a investment or service. This is a subobject of the Department object. Task This object describes activities that span a specified period of time. Tasks are part of the WBS and feed the Project Plans. Time can be tracked to a task. This is a subobject of the Project object. Team This describes the resource types that can be added to a team. There are four types of labor resources that make up a team: Staff, a member of the project (resource or role) who is assigned tasks. Participant, a person who can access project to look at documents, discussions, calendars, and properties, but are not assigned tasks. Project Groups, a grouping of participants that can be assembled for the project. Collaboration Manager, a project role that allows you to create project groups and grant participants
Create Objects
Type Portfolios Programs Project Team Members Project Team Selection Resource's Projects List
Description This contains portfolio data. This contains data about programs and the projects which belong to a program. This contains data about resources assigned to projects. This contains data about resources assigned to projects. This lists data about projects that a resource is assigned to.
Create Objects
Use the Object Definition: Properties page to view your CA Clarity PPM object's properties and to define master and subobject relationships. Once your object is created, you can assign access rights to users, OBS units, or groups to access the object. To create a new object 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click New. The Create Object Definition page appears. 3. Complete the following: Object Name Enter a name for the new object. Object ID Enter a unique ID for the new object. Description Enter a brief description for the new object. 4. At Master or Subobject, select the type of object you are creating. Choose Master or Subobject. 5. (Optional, master objects only) At Partition Model, click the Browse icon and select the partition model to which this object should be added, and then click Add.
6. (Subobjects only) Click the Browse icon, select the master object of this subobject, and then click Add. 7. Click Event Enabled to make CA Clarity PPM's process engine aware of object instances that are created or updated. 8. Click Copy Enabled to allow copies to be made of this object's instances. 9. Click Export Enabled to allow this object's instances to be exported into XML from an action on the properties page. 10. Click View All Enabled to allow this object's instances to have a view that contains all properties, subobject lists, and personalizable page portlets on a single page. 11. Click Save.
4. Click Add. 5. Check the box next to the access right(s) you want to grant, and then click Next. 6. Check the box next to each user you want to grant access to. 7. To add these users and quit, click Add. 8. To add more users click Add and Select More. 9. Click Exit when done. 10. To see which users are authorized to use the object, click Full View.
Object Attributes
Object Attributes
Attributes (fields) are information that is associated with, and may or may not display on an object's pages. If you are using an existing object you can choose which of the fields to display on one or more pages. If you create an object, or if you want to add user-defined attributes to an existing object, the topics in this section show you how to create them.
Description A text field that contains up to 2000 characters. This is similar to a string field, but the number of characters is limited only by your database. This type does not support filtering or sorting. A field that contains numbers that can be used in calculations. A field that is a weighted average of two or more number, formula, money, or lookup-number fields. A lookup-number field is a lookup that returns a numeric value rather than a string value. A field that contains currency. A field that indicates one of two exclusive states: on or off true or false yes or no 0 or 1 approved or not approved.
Number Formula
Money Boolean
Object Attributes
Description A field that contains a date. A field in which the user can select from predefined choices. The choices can be static values entered by an administrator or dynamic values returned from querying the database. The following selection types are available: Static Lists, that consist of a set of static values entered by an administrator. Static Dependent Lists, which are like static lists in that the administrator sets up all the possible values, but the values are arranged hierarchically like an OBS. A Stage field for an investment, but you need different stages for different types of investments, such as Research and Develop for a new product but Proposal and Deploy for a new asset. A Model field for a Car object, but you need to offer SL1 and SL2 if the Make is a Saturn whereas you need to offer Metro and Tracker if the Make is a Geo. Dynamic Queries, these lookups provide the most up-to-date values possible and are best suited when you want to offer a selection from a list of objects such as resources, projects, issues, and so forth, as opposed to a selection from a list of statuses or fixed options.
Multi-valued lookup
A lookup field in which more than one value can be set. On the object's properties page, it displays as multi-select browse. In a filter it can display as a drop-down list, select box, single-select or multi-select browse. A field that contains a document attachment (such as a Word document). A field in which a user can enter different values depending on the time period being displayed. The user can enter a start date and an end date for the value entered. The value entered in the field can be one of the following data units (measured per hour or per second): number, percentage, or money.
Attachment Time-varying
Object Attributes
When you add an attribute to an object, the attribute is added to all existing instances of that object. As new instances of the object are created, they will also contain the new attribute. You can also create lookup attributes that display as drop-down or browse lists from which users can select one or more choices. Lookups can be single or multi-valued. Multi-valued lookup attributes are frequently used in filters. If you want to provide a link that users can click to download documents, you can create an attachment attribute. These attributes display as clickable links in list views and as editable text attributes with open and delete icons in property views. When the user clicks the open icon, a document that is associated with the attribute is downloaded or displayed for the user. You can create attributes that provide links to web pages or virtual attributes that are not based upon items in the database, but are derived from other data attributes. Examples of virtual attributes are progress bars, Gantt charts, or attributes that display the calculated results for other attributes.
Object Attributes
Use the Object Attribute page to add string fields to objects. To add a string field to an object 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the name of the object to which you want to add the field. The Object Definition: Properties page appears. 3. Click Attributes from the content menu. The Object Definition: Attributes page appears. 4. Click New. The Object Attribute page appears. 5. Complete the following fields: Attribute Name Defines the name of the new field. Attribute ID Defines the unique ID for the field. Note: Use only alphanumeric and underscore (_) characters. Also avoid SQL reserved words such as SELECT or STRING. Once you save the new field, you cannot change the ID. 6. (Optional if you have created partitions) To associate this field with a particular partition, complete the following fields: Partition Defines the partition with which this field is associated. Partition Association Mode Defines the partition that this field should be associated with.
Object Attributes
Options: Partition, ancestors and descendents. Associates the field with this partition and its parents and child partitions. Partition and ancestors. Associates the field only with this partition and its parents, grandparents, and so on up the chain to the System Partition. Partition and descendents. Associates the field only with this partition and its children, grandchildren down the chain. Partition only. Associates the field only with this partition.
Description Defines the brief description of the field. Data Type Defines the type of data field you want to add. Options: String. Creates a field up to 2000 characters. Large String. Creates a field up to an unlimited number of characters.
Note: Once you save the field, you cannot change the data type. Default Value Defines the value that you want to appear as the default value for the field. Maximum Size Defines the field's maximum size (up to 2000 characters). Populate Null Values with the Default Specifies whether you want to automatically populate existing objects with the default value. Default: Cleared Value Required Specifies whether you want to require that this field be non-blank, either through an administrator-entered default or through end-user entry. Default: Cleared
Object Attributes
Presence Required Specifies whether you want to require that this field appear on the edit properties page on at least one subpage. Default: Cleared Note: If the subpage that contains the field is not visible to some users (due to display conditions or subpage security), then the field will not be visible to the user. Read-Only Specifies whether you want to prevent users from changing the value of this field. Default: Cleared Note: A read-only field must have a Default Value. 7. Click Submit.
Object Attributes
6. (Optional if you have created partitions) To associate this field with a particular partition, at: Partition Select the partition with which this lookup should be associated. Partition Association Mode Defines the partition association mode. Values: Partition, ancestors and descendents, to associate the field with this partition and its parents and child partitions. Partition and ancestors. To associate the field only with this partition and its parents, grandparents, and so on up the chain to the System Partition. Partition and descendents. To associate the field only with this partition and its children, grandchildren, and so on down the chain. Partition only. To associate the field only with this partition.
7. Complete the following fields: Description Defines the brief description for this number field. Data Type Choose Number. Note: Once you save the field, you cannot change the data type. Validation Range Enter the range of values that are acceptable for this field. Enter the lowest number in the first box and the highest number in the second box. Decimal Places Enter the number of decimal places that should appear with this field. Note: Enter 0 to make the field an integer. 8. To display the number as a percent, click Show as Percent. Do not select this check box if you want to display the number with a percent sign. 9. If you want the field to appear with a default value, enter that value at Default Value. 10. To automatically populate existing objects with the Default Value, check Populate Null Values with the Default.
Object Attributes
11. To require that this field be non-blank, either through an administrator-entered default or through end-user entry, check Value Required. 12. To require that this field appear on the Edit Properties view on at least one subpage, check Presence Required. 13. To prevent users from changing this value, check Read-Only. Note: A read-only field must have a Default Value assigned in if you want the field to appear with a default value, enter that value at. 14. (Optional) To display the field in color: a. At Type, choose Color. Note: Once you begin defining a display mapping, you cannot switch display mapping types. To do so, first clear out your existing mapping and save. You can then choose Icon or Color in the Type drop-down list. b. c. d. e. f. At Color, select a color for the field. At Description, enter a brief description of what the color represents. At From, enter a number for the beginning of the range to be represented by the color. At To, enter a number for the end of the range to be represented by the color. Repeat the steps above to define any other ranges of numbers that should be color-coded.
Note: Use color display mappings to associate a value or number range with a description and a color. These colors can be used in many places throughout CA Clarity PPM, such as in stoplight icons, filters, progress bars, Gantt charts, and graph backgrounds. 15. (Optional) To display the field as an icon, at Type choose Icon and do the following: a. b. c. d. Click the Browse icon, select the icon you want to represent this range of numbers, and then click Add. At Description, enter a brief statement of what the icon represents. At From, enter a number to for the beginning of the range to be represented by the icon. At To, enter a number to for the end of the range to be represented by the icon.
Object Attributes
e.
Repeat the steps above to define any other ranges of numbers that should be represented by an icon.
Note: When you define ranges that are adjacent to one another, make sure the ranges do not overlap. For example, the following ranges are correctly defined to avoid number overlap: 0-100, 101-200, 201-300. You can define up to ten ranges in a mapping plus an optional Default Bucket for all values that do not fall into defined ranges. 16. Click Submit.
Object Attributes
Object Attributes
Data Type Choose Formula. Note: Once you save this field, you cannot change the data type. Decimal Places Enter the number of decimal places for data to be returned by the field. Note: Enter 0 to make this an integer field. 7. (Optional) To display the field in color, complete the following fields: a. b. Type, choose Color. Color, select a color for the field. Note: The first item you assign a color is the Default Bucket that contains default values. c. d. e. Description, enter a brief description of what the color represents. From, enter a number to for the beginning of the range to be represented by the color. To, enter a number to for the end of the range to be represented by the color.
8. Repeat Step 7 to define any other ranges of numbers that should be color-coded. 9. (Optional) To display the field as an icon, at Type choose Icon, then: a. b. c. d. Click the Browse icon, select the icon you want to represent this range of numbers, and then click Add. At Description, enter a brief statement of what the icon represents. At From, enter a number for the beginning of the range to be represented by the icon. At To, enter a number for the end of the range to be represented by the icon.
10. Repeat Step 9 to define any other ranges of numbers that should be represented by an icon. 11. At Formula, click [Build Weighted Average Formula] to add a weighted average formula. The Build Weighted Average page appears. a. In the Attribute column, select the name of the field you want to give special consideration in the weighted average calculation.
Object Attributes
b.
At Weighting, enter a number. The Attribute value is multiplied by the number you entered at Weighting to compute the weighted average for that row. Weighted values from all rows are added and their average is computed. The entries you make in the Weighting column cause CA Clarity PPM to consider the attribute to be more important than other attributes when calculating the weighted average. If you do not make any entries in the Weighting column, an ordinary arithmetic average is computed instead. For example: weighted ave = [(Risk * 4) + (Customer Satisfaction * 2) + (Alignment) * 1] /
c. d.
To weight additional attributes, click New Row and repeat the steps above. To see if the weighted average formula works as expected, click Recalculate. The page displays the formula results in the Test section.
Object Attributes
8. At Description, enter a brief statement about the field. 9. At Data Type, choose Money. Note: Once you save this field, you cannot change the data type. 10. To provide a currency code for the field, do one of the following: Select Attribute has its own currency code field.
Object Attributes
At Default Currency Code, choose the default currency code from the drop down. If the currency code is held in an existing field of the same object, select Reference another attribute of this object. Then at Which Field, choose the field that contains the currency code from the drop down.
11. At Validation Range, enter the lowest amount allowed for the field in the first box, and the highest amount allowed in the second box. 12. If you want the field to appear with a default value, at Default Value enter that value. 13. To automatically populate existing objects with the default value, click Populate Null Values with the default. 14. To prevent users from entering values in the field, click Value Required. 15. To prevent users from removing this field from a view, click Presence Required. 16. To prevent users from changing the field, click Read-Only. Note: A read-only field must have a default value assigned. 17. (Optional) To display the field in color: a. b. c. d. e. f. At Type, choose Color. At Color, select a color for the field. At Description, enter a brief description of what the color represents. At From, enter a number to for the beginning of the range to be represented by the color. At To, enter a number to for the end of the range to be represented by the color. Repeat the steps above to define any other ranges of numbers that should be color-coded.
18. (Optional) To display the field as an icon, at Type choose Icon. a. b. c. d. e. Click the Browse icon, select the icon you want to represent this range of numbers, and then click Add. At Description, enter a brief statement of what the icon represents. At From, enter a number for the beginning of the range to be represented by the icon. At To, enter a number for the end of the range to be represented by the icon. Repeat the steps above to define any other ranges of numbers that should be represented by an icon.
Object Attributes
Object Attributes
Object Attributes
Data Type Defines the type of data field you want to add. Choose Boolean. Note: Once you save this field, you cannot change the data type. Default Specifies whether the field's default value is true (selected) or false (cleared). Default: Cleared Populate Null Values with the Default Specifies whether to automatically populate existing objects with the default value. Default: Cleared Presence Required Specifies whether to require that this field appear on the Edit Properties view of at least one subpage. Default: Cleared Note: If the subpage that contains the field is not visible to some users (due to display conditions or subpage security), then the field will not be visible to the user. Read-Only Specifies whether you want to prevent users from changing the value of this field. Default: Cleared 7. In the Display Mapping section of the page, (Optional) to display the field in color, complete the following fields. Repeat this step to define any other ranges of numbers that should be color-coded. Type Choose Color. At Color Select a color for the field. At Description Enter a brief description of what the color represents. 8. In the Display Mapping section of the page, (Optional) to display the field as an icon, in the Type field, choose Icon. Repeat this step to define any other ranges of numbers that should be represented by an icon. a. Click the Browse icon, select the icon you want to represent this the true or false state, and then click Add.
Object Attributes
b.
Enter a brief statement of what the icon represents in the Description field.
9. Click Submit.
Object Attributes
7. At Description, enter a brief description of the field. 8. At Data Type, choose Date. Note: Once you save the field, you cannot change the data type. 9. Indicate the earliest date to include. At Validation From, choose: Rolling Date, and select the macro to use such as Yesterday, Start of Current Year, etc.
Object Attributes
At Specific Date, and select a date (e.g. 10/6/04) and time, or click the Date icon and select one from the calendar. At Time, and select the hour and/or minutes.
10. Indicate the latest date to include. At Validation To, select: At Rolling Date, and select the macro to use such as Yesterday, Start of Current Year, etc. At Specific Date, and select a date (e.g. 10/6/04) and time, or click the Date icon and select one from the calendar. At Time, select the hour and/or minutes.
11. Indicate the default date. At Default Date, select: At Rolling Date, and select the macro to use such as "Yesterday", "Start of Current Year", etc. At Specific Date, and select a date (e.g. 10/6/04) and time, or click the Date icon and select one from the calendar. At Time, and select the hour and/or minutes for the default date.
12. To automatically populate existing objects with the Default Date (that you specified in Indicate the default date), check Populate Null Values with the Default. 13. To require that users enter a value in the field, check Value Required. 14. To prevent users from removing the field in their Edit Properties view, check Presence Required. 15. To prevent users from changing this field, check Read-Only. Note: A read-only date field must have a default date. 16. Click Submit.
Object Attributes
Object Attributes
Description Defines the brief description of the field. Data Type Choose lookup. Note: Once you save the field, you cannot change the data type. Lookup Defines the lookup you want to use, and then click Save. Default Defines the value that you want to appear as the default value for the field. Populate Null Values with the Default Specifies whether you want to automatically populate existing objects with the default value. Default: Cleared Value Required Specifies whether you want to require that this field be non-blank, either through an administrator-entered default or through end-user entry. Default: Cleared Presence Required Specifies whether you want to require that this field appear on the edit properties page on at least one subpage. Default: Cleared Note: If the subpage that contains the field is not visible to some users (due to display conditions or subpage security), then the field will not be visible to the user. Read-Only Specifies whether you want to prevent users from changing the value of this field. Default: Cleared Note: A read-only field must have a Default Value. 6. (Optional) If you selected static lookup, you can set up a display mapping that lets you associate a value or number range with a description and a color. These colors can be used in many places throughout CA Clarity PPM, such as in stoplight icons, filters, progress bars, Gantt charts, and graph backgrounds. To set up a display mapping: a. At Type, choose Color.
Object Attributes
b. c. d. e.
At Color, select a color for the field. At Description, enter a brief description of what the color represents. Repeat the steps above to define any other ranges of numbers that should be color-coded. At Value, select the lookup value to be represented by the color. You can define colors for up to ten values in a mapping plus an optional Default Bucket for all values that do not have an assigned color. Repeat the steps above to define any other color-value combinations.
f.
7. (Optional) To display the field as an icon, at Type choose Icon. a. b. c. Click the Browse icon, select the icon you want to represent this the true or false state, and then click Add. At Description, enter a brief statement of what the icon represents. Repeat the steps above to define any other ranges of numbers that should be represented by an icon.
8. Click Submit.
Object Attributes
Note: The lookup you add must already exist before you can add it to an object. To add a multi-valued lookup field 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the name of the object to which you want to add the field. 3. Click Attributes from the content menu. The Object Definition: Attributes page appears. 4. Click New. The Object Attribute page appears. 5. At Attribute Name, enter the name of the new field. 6. At Attribute ID, enter a unique ID for the field. Note: This code must contain only alphanumeric characters and the underscore (_) character. and it must also not be a SQL reserved word. Once you save a field, you cannot change the ID. 7. (Optional if you have created partitions) To associate this field with a particular partition: a. b. At Partition, select the partition that this lookup should be associated with. At Partition Association Mode, select: Partition, ancestors and descendents, to associate the field with this partition and its parents and child partitions. Partition and ancestors, to associate the field only with this partition and its parents, grandparents, and so on up the chain to the System Partition.
Object Attributes
Partition and descendents, to associate the field only with this partition and its children, grandchildren, and so on down the chain. Partition only, to associate the field only with this partition.
8. At Description, enter a brief description of the field. 9. At Data Type, choose Multi Valued Lookup. Note: Once you save the field, the data type cannot be changed. 10. At Lookup, click the Browse icon, and select the lookup you want to use, then click Save. 11. Click Save.
Object Attributes
8. At Description, enter a brief description of the field. 9. At Data Type, choose Attachment. Note: Once you save a field, you cannot change the data type.
Object Attributes
10. Do one of the following in the Attachment Style field: To attach just one document, select Single Document. To attach up to 10 attachments, select Multiple Documents, then enter the maximum number of attachments allowed in the Maximum Number of Attachments field.
11. To require that users provide an attachment, check Value Required. 12. To require that this field always appears in the user's Edit Properties view and cannot be removed, check Presence Required. 13. Click Submit.
Object Attributes
Object Attributes
7. Complete the following fields: Description Enter a brief description of the field. Data Type Select Time-varying. Once you save the field, you cannot change the data type. Time-varying Data Units. Select the appropriate data unit from the drop-down. This selection determines what the value entered in the field represents: a number value, a monetary value, or a percentage. Time-varying Unit Conversion. Select Seconds or Hours to determine whether the time-varying data units are per hour or per second. Time-Varying Date Constraints. Start and finish dates selected here provide a default date range for the field. A user can enter dates in CA Clarity PPM that override the default dates. If no selection is made, the default values are the widest available range. Defining a date constraint limits the range of data received for the field and improves processing performance.
8. If you selected Money as the time-varying data unit, to provide a currency code for the field, do one of the following: Check the box next to Attribute has its Own Currency Code Field. Then at Default Currency Code, select the default currency code. If the currency code is held in an existing field of the same object, check Reference Another Attribute of this Object. Then at Which Field, select the field that contains the currency code.
9. Click Save.
Object Attributes
Object Attributes
Calculated Attributes
A calculated attribute is a attribute whose value is based on a calculation using the values of other attributes. For example, you might create a attribute called "Remaining Budget" whose value is derived from the following formula:
Remaining Cost = Planned Cost - Actual Cost
In this case, a attribute's value (Remaining Budget) depends on the value of two other attributes (Planned Cost and Actual Cost). The value of a calculated attribute is not stored in the database; it is determined at runtime by extracting the value from an equation set up for the attribute. Because the value is not stored in the database, you cannot sort, use a power filter, or manually update calculated attributes. CA Clarity PPM provides a number of functions for calculation of an attribute's value. The functions can be compounded to produce a complex calculation if that is required for the attribute. For example, you might take the absolute value of the difference in the equation given in the previous example:
Remaining Cost = Absolute (Planned Cost - Actual Cost)
Note that a calculated attribute can include other calculated attributes. CA Clarity PPMdetermines the precedence of any calculated attributes included in an expression at run-time. The following attribute types cannot be used with calculated attributes: Formula Time-varying Attachment Long String Multi-Value Lookups Virtual
The result data type showing the results of the calculation can be one of the following data types, depending on the function: Number. This data type is used for a calculated attribute that requires a number value such as a sum or an average of several numbers. String. This data type is used for a calculated attribute that requires the concatenation of two or more values, for example, the value of the attribute "created_by" and the constant "2007." An example of the value produced by the concatenation is "ssmith 2007." Date. This data type is used to calculate dates using basic arithmetic or to provide the current date.
Object Attributes
Note: You can receive a null result if the value of a parameter (field source) included in an expression is null when the expression is evaluated for an instance. A null result also occurs when the expression cannot be resolved. For example, division by zero produces a null result.
Attribute Parameters Absolute(number) Add(number1, number2) Add(number1, <constant>) (ex: Add(A, 10))
Return Value Absolute value of the number. Adds the value of number1 to the value of number2 and returns the result of the operation. Returns the average of all of the parameters passed in. Concatenated string.
Average
Average(number1, number2 )
Number
Concatenate
String
Date Add
DateAdd(date attribute, unit, number) Date attribute: This value can be an attribute name or a sub-expression only. It cannot be a constant. Unit: Day, Hour, Minute, or Second. This value is case-sensitive. Number: Number of units to add to the date.
Date
(ex: DateAdd(approvedtime, Day,4). This expression returns a date value that equals approvedtime + 4 days.) Date Difference DateDiff(date attribute1, date attribute 2, Number result unit) Date attribute1: The date you are subtracting from. This value can only be an attribute name or a sub-expression. Returns the number value as specified in the result unit, the difference of date attribute1 minus date attribute2.
Object Attributes
Function
Attribute Parameters
Return Value
Date attribute2: The date you are subtracting. This value can only be an attribute name or a sub-expression. Result unit: Day, Hour, Minute, or Second. This value is case sensitive.
(ex: DateDiff(startdate, enddate,Day). This expression returns a value indicating the number of days between startdate and enddate.) Divide Divide(number1, number2) Divide(number1, <constant>) (ex: Divide (A,50)) Maximum Max(number1, number2 ) Number Number Result from attr1 (number) divided by attr2 (divisor). Largest value in the set of values, so if: A=10, B=20, C=30 Max(A, B, C) will return 30.
Minimum
Number
Smallest value in the set of values, so if: A=10, B=20, C=30 Min(A, B, C) will return 10.
Multiply
Number
Now
Now()
Date
Object Attributes
Function Percentage
Attribute Parameters Percentage(number1, number2) (ex: Percentage (A,B)) Percentage(number1, <constant>) (ex: Percentage (A,50))
Return Value Result after the percentage is taken. (ex: If A=1000, A * 60%= 600, the return value will be 600). Result of the number raised to a power specified.
Power
Power(number, power)
Number
Round
Number
Square Root
Sqrt(number)
Number
Subtract
Number
Subtracts the value of number1 from the value of number2 and returns the result of the operation. Sum from the list of attributes. A=10, B=20, C=30 Sum(A, B, C) will return 60.
Sum
Number
Object Attributes
Function Truncate
Return Value Value after removing the decimal or fraction part of the number.
Object Attributes
Object Attributes
Object Attributes
Attribute Name (ID). Select an attribute from the drop-down list to have to attribute's value included in the calculation. The list shows the available object attribute names for the data type selected (number, string, or date). Sub-expression. Select this option to have an expression embedded within the expression you are building for the calculation. You can accept the default name in the text box or enter a different name for the sub-expression.
9. Click Generate to generate the function's expression in the Expression text box. 10. If you selected Sub-expression as one of the options, do the following: a. b. c. d. In the Generate Expression for field, select the name of the sub-expression. In the Function field, select the function that defines the purpose of the sub-expression. Select and define the arguments for the sub-expression. Click Generate to include the defined arguments for the sub-expression in the whole expression.
11. When you are satisfied that all sub-expressions are defined for the whole expression, click Validate to ensure that the expression's syntax is correct and make any adjustments necessary. 12. Click Submit.
Object Attributes
The following figure shows the link for the tool that assists you in building an expression for a calculated attribute.
When you click the Build Calculated Attribute link, the following dialog box appears.
In the example, the absolute value of the difference between two numbers is the desired result. When you select the "Absolute" function, the appropriate fields for defining the function's argument appear. The following figure shows the fields for defining the argument.
Object Attributes
The Absolute function has only one argument. The Sub-expression option is selected to represent the expression for the difference between the numbers. When you click Generate, the expression appears in the Expression text box.
When you include a sub-expression in a generated expression, the Generate Expression for field appears at the top of the dialog box. To define the sub-expression, you must select its name in the Generate Expression for field and you must select the function for the sub-expression (Subtract in this example) in the Function field. Select the arguments for the Subtract function (Planned Cost and Actual Cost) from the available list of attribute names for the object using the drop down list.
Object Attributes
When you click Generate, the entire expression with the sub-expression defined appears in the Expression text box. The following figure shows the full expression for the calculated attribute.
Object Attributes
Object Attributes
You can create an auto-numbering scheme for a string data type object attribute that consists of one or more segments of: Text Alpha-numeric counters (a combination of letters and numbers) Numbers Creation date A reference to an attribute in a parent object
Important! If you use auto-numbering with two or more object types, make sure that generated numbers for different object types cannot be the same. CA Clarity PPM does not ensure that numbers are unique for different types of objects. You can avoid duplications by using an alphanumeric numbering scheme so that object types have a unique prefix such as "ASSET" for asset or "PRJ" for project followed by a numeric counter. Once created, each time a resource creates a new instance of the object, the object ID will automatically populate using the auto-numbering scheme you created. To create an auto-numbering scheme 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the name of the object for which you want to create an auto-numbering scheme. The Object Definition: Properties page appears. 3. Click Attributes from the content menu. The Object Definition: Attributes page appears. 4. Click the name of the string data type attribute for which you want to create an auto-numbering scheme. The Object Attribute page appears.
Object Attributes
5. Click Auto-numbering in the content menu. The Object Definition: Attribute Auto-numbering page appears. 6. In the Schemes section, click New. The Auto-numbering Scheme page appears. 7. In the Scheme Name field, enter up to 80 characters for the scheme name. For example, PRJ or INV. 8. Click Save. 9. In the Segments section, click New. 10. At Type of Segment, select one of the following options: Text. Creates a segment that contains only letters. Numeric Counter. Creates a segment that contains only numbers. Alpha-Numeric Counter. Creates a segment that contains letters and numbers. Instance Creation Date. Creates a segment that is a time stamp for the instance being auto-numbered. The date format is: YYYYMMDD. Parent Object Attribute Reference. (Sub-object attributes only) Creates a segment that has the value of a unique attribute of the parent object. This segment is a constant that cannot be incremented.
As you create the segments for the auto-numbering scheme, the scheme's structure is shown in the General Information section in the Next Number field. 11. If you are creating a text segment, in the Text Value field enter the characters to use for this segment of the scheme. For example PRJ. 12. If you are creating a numeric or alpha-numeric counter segment, do the following: a. b. c. In the Counter Starting Number field enter the first number to use in the numeric sequence. In the Counter Length field, select the number of digits to use for the segment. Select the Auto-extended check box to extend the counter length when the limit of the counter length is reached.
Object Attributes
13. If you are creating a parent object attribute reference segment, do the following: a. In the Referenced Attribute field, click Browse and select the attribute in the parent object. The value of the attribute will be included in the numbering segment. For example, if the referenced attribute is "Name" and the referenced object is "Project," when an instance of the specific sub-object attribute (for example, a new task) is created in the application, the name of the Project (up to 8 characters) is part of the numbering scheme. For example, NewNet00000001 b. In the Segment Max Length field, select the length that you want this segment to be. Note that the replacement value (the referenced attribute) will be truncated if it is longer than the length selected.
14. Click Submit to create the segment. 15. Create as many segments as necessary. 16. In the Schemes section, select the partition the numbering scheme for the attribute applies to. If the attribute's object is not associated with a partition, only the System Partition is available. 17. To activate this scheme, select the Auto-numbered check box in the General section. Note: When auto-numbering is activated, users will not be able to change object IDs because CA Clarity PPM will create them. 18. Click Save.
Object Attributes
As you make changes, the auto-numbering scheme's structure is shown in the General Information section in the Next Number field. 9. Make changes to the segments as needed by clicking the segment name in the Type of Segment column. 10. Click Save.
Object Attributes
Object Attributes
Some attribute information is not deleted. If you use the attribute in reports or reference the attribute in custom database code, these uses are not deleted. Some uses of the attribute in NSQL queries may not be deleted. If an attribute is being used anywhere in the view by a user, you cannot delete the attribute. You must take one of the following actions before you can delete: Contact any users who are using the attribute to have them remove the personalization. When you try to delete an attribute that is being used, you receive an error and a list of users who are currently using the attribute. To have users delete a personalized attribute, have them navigate to the list page of the object and select Configure from the Actions drop-down menu. In the page that appears, the user must click General in the content menu, then click Restore Defaults. Publish the view. This action automatically removes any end-user personalization. After you publish, you can delete the attribute.
Important! As a precaution, remove any use of the attribute in a query or in calculations for attributes before you delete. Deleting an attribute used by a query or included in a calculation can produce unintended results. Once the deletion occurs, the only way to retrieve the data is through a database backup restoration. To delete an object attribute 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the name of the object you want to modify. The Object Definition: Properties page appears. 3. Click Attributes from the content menu. The Object Definition: Attributes page appears.
Object Attributes
4. In the list of attributes, check the box next to the attribute you want to delete and click Delete. The Confirm Object Attribute Delete page appears. 5. Review the list of associated items and make sure none have dependencies (queries or other attributes that use the attribute to be deleted). 6. Complete one of the following: If you find dependencies, click No to exit the page, then remove the dependencies and repeat the procedure to delete the attribute. If no dependencies are listed, click Yes to delete the attribute.
To set up an audit trail for an object 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the name of the object you want to set up for auditing. The Object Definition: Properties page appears. 3. Click Audit Trail from the content menu. The Object Definition: Audit Trail Attributes page appears. 4. In the Audit Attribute section, highlight the attributes you want to audit for changes and click the right arrow to place them in the Audited Attributes list. 5. In the Object Audit section, do the following: Highlight the attributes you want audited for insertions and click the right arrow to place them in the Logged Attributes for Insert Operation list. Highlight the attributes you want audited for deletions and click the right arrow to place them in the Logged Attributes for Delete Operation list.
6. In the Purge Audit Trail section, enter a number to indicate how many days a record for this object is to be kept before being purged when the Purge Audit Trail job is run. Leave the field blank to keep records indefinitely, and click Save. The object is set up for audit trail.
Delete Objects
Delete Objects
Use this procedure to delete user-defined objects. You can delete any object that you create. To delete an object created by another user, you must have the appropriate access rights to the object. CA Clarity PPM stock objects cannot be deleted. When you delete an object, the following information is deleted from the database: Object views Object database tables Object page sets Portlets using the object (through an object data provider)
Some object information is not deleted. If you use the object in reports or reference the object in custom database code, these uses are not deleted. Some uses of the object in NSQL queries may not be deleted. Although audit trail records for the object are deleted, a record of the deletion itself is stored in the Audit Trail log. Queries that use the database table created for the object are identified so that they can be removed manually. Important! As a precaution, remove any use of the object in a query or a portlet before you delete. Deleting an object used to provide information to other parts of CA Clarity PPM can produce unintended results. Once the deletion occurs, the only way to retrieve the data is through a database backup restoration. To delete an object 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. In the list of objects, check the box next to the object you want to delete and click Delete. The Confirm Object Delete page appears. 3. Review the list of associated items and make sure none have dependencies (portlets or queries). 4. Complete one of the following: If you find dependencies, click No to exit the page, then remove the dependencies and repeat the procedure to delete the object. If no dependencies are listed, click Yes to delete the object.
About Add-Ins
About Add-Ins
Add-ins are a collection of content, such as portlets, pages, access groups, processes, reports, and jobs that you can import as a single entity into CA Clarity PPM. To get started with CA Clarity PPM you can install, apply, and use the collection of content that comes with add-ins.
Views
To apply add-in items 1. Log in to CA Clarity PPM, and open the Administration Tool. The Administration Home page appears. 2. Select Add-Ins from the CA Clarity Studio menu. The Add-Ins page appears. 3. Click the name of the add-in from which you want to apply items. The Add-In Details page appears. 4. Review each selected item and accept only the changes that you want. Only those items selected update. You can select or clear the items that you want to apply. 5. Click Apply. Note: If a selected item has dependencies on other items, these dependencies also update. A list of updated items displays in the Confirm Add-In Update or Install page. 6. Do one of the following: Click Yes to update or install the items. Note: If a user has previously changed an item listed on the Confirm Add-In Update or Install page, then you will need to publish the item before users will see the change. Note: See the Studio Developer's Guide for more information on how to publish configured items, such as portlets, pages, and views. Click No to cancel the process.
Views
An object's view determines how information displays on a page. There are three types of views: List Filter View This view is a section that appears at the top of a list column view and allows users to search for information. List Column View This view displays information about object instances in rows and columns. Properties View This view displays and allows users to enter information about an object.
Views
Views
The following image shows a sample page displaying the Applications object with an expanded list filter view (in the filtering section above) and a list column view (in the section below).
To add a field to an object's list filter view 1. Select Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the object category whose List Filter view you want to add a field. Note: The categories that display depend upon how you CA Clarity PPM administrator configured CA Clarity PPM. 3. Click Views from the content menu. The Object Definition: Views page appears. 4. Next to the List Filter category, click Layout. The List Filter Layout page appears. 5. In the Available list, select the field to add and click the right arrow (Add Field) button to move the field to the desired column. 6. Repeat until the fields you want to display are listed in the correct column. 7. Complete the following fields in the Settings section: Section Title Determines the name of the filter section's title bar. Default Filter State Determines how the filter displays initially. Select Collapsed to display only one filter field or select Expanded to display multiple filter options for the user. Allow Power Filter Determines whether the Build Power Filter link is available to the user to build power filters. Select the box to display the link to the user.
Views
8. Click Submit. The Applications page filter section now shows the effects of the options you have selected. 9. Click Publish to replace personalized changes that users have made to this view. Note: This replaces any modifications that users have made to their personal views.
To add a field to an object's list column view 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the object in which you want to display the field. The Object Definition: Properties page appears 3. Click Views from the content menu. The Object Definition: Views page appears. 4. Next to the List Column view you want to add a field, click Layout. The Configure: List Column Layout page appears. 5. In the Available Columns list, select the field you want to add.
Views
6. Click the right-arrow to move the field to the Selected Columns list. 7. Click Submit. 8. Next to List Column view, click Options, then set any of the following options: Secondary Value Display Select one of the options to show the secondary (alternative) value when the user moves the cursor over the field. To show the secondary when the value is null, select the "Show Secondary Null Values" check box. Filter Select an option to indicate whether filter results are shown automatically or shown only after a filter operation is performed. Rows per Page From the drop-down list, select the number of rows to display for this view. Highlight Row by Attribute When the value entered here is not zero, the row is highlighted. Display Currency Code in Column This check box controls the display of currency codes (for example, USD) in investment grids. If multiple currencies are used, this option is selected by default and the check box cannot be cleared. If you clear the check box when a single currency is used, the currency code displays in a legend below the grid. Allow Configuration When you select this option, users can see the Configure option in the Actions field drop-down list. Allow Label Configuration This option works in conjunction with the Allow Configuration option. If you select the Allow Configuration option and you clear the Allow Label Configuration option, field labels become unavailable for configuration while other items can still be configured. Attribute Value Protection Select an option to protect or display attribute values in the list. You can protect attributes using display conditions and secured subpages or secured subpages only, or you can display all attribute values. 9. Submit your changes.
Views
If you add more than one aggregation row, you can change the order in which they appear in the view. The views aggregation rows display on the Configure: List Aggregation page. To add aggregation rows for number fields 1. Select Objects from the Studio menu. The Objects page appears. 2. Click the object to which you want to add an aggregation row. The Object Definition: Properties page appears. 3. Click Views from the content menu. The Object Definition: Views page appears. 4. Next to the List Column view containing number fields for which you want to add an aggregation row, click Aggregation. The Configure: List Aggregation page appears. 5. Do the following for each aggregation row you want to add: a. Click Add. The Aggregation Row Properties page appears. b. Complete the following fields: Label, enter a name for the aggregation row. Select the Show check box to enable the row. At Attribute, select the field you want to use. At Function, select the aggregation function you want to use to calculate values in the row:
Views
Aggregation Function. Select the aggregation function to use; choose from Sum, Average, Count, Maximum, Minimum, Standard Deviation, or Variance Threshold Aggregation Function. Select the aggregation function to use; choose Sum, Average, Count, Maximum, Minimum, Standard Deviation, or Variance. Comparison Column. Select the column to compare with this one. Comparison Column Aggregation Function. Select the aggregation function to use; choose Sum, Average, Count, Maximum, Minimum, Standard Deviation, or Variance. Display. Select the manner in which to display the data; choose Number, Column Graph, or Bar Graph, and then click Save.
c.
Views
Views
3. Configure the properties view for the object to show the time-varying attribute fields and to allow the CA Clarity PPM user to edit the fields and change values. 4. Set up a time slice request for each time-varying attribute. See the CA Clarity PPM Administration Guide for complete information on time slice requests. 5. Run the Time Slicing job. This job can be set up to run on a schedule that suits your business needs. See the CA Clarity PPM Administration Guide for complete information on the Time Slicing job. 6. View the time-varying attributes displayed in the time-scaled virtual column in CA Clarity PPM. To view the time-varying fields, create an instance of the object and include values for the time-varying attributes in the Properties page. Results for the values can be seen in the virtual column on the List page. Note that the user can edit the fields by entering values for different time periods.
Views
4. Create the virtual column by doing the following: a. Click Fields in the object's list view. The Configure: List Column Fields page appears. b. Click New. The Create Virtual List Column page appears. c. d. Select Time Scaled Value and click Submit. In the General section, do the following: In the Available list box, select the attributes you want to list in the column and use the arrow buttons to move the attributes to the Selected list box. Enter a name for the virtual column in the Column Label field. Select the Allow Editing check box to allow users to make changes to the fields in the column. Select the Show Legend Column check box to display each attribute name in the column beside its values. Select the Show Column Label check box to display the column name at the top of the column.
e. f. g.
In the Time Scale section, enter the number of time periods that are to display in the column. Set any other options on the page that apply. Click Submit.
5. Include the column in the object's List view by doing the following: a. Click Layout in the object's List view. The Configure: List Column Layout page appears. b. In the Column Layout section, select the name of the column in the Available Columns list box and move it to the Selected Columns list box using the arrow buttons. Set any other options on the page that apply. Click Submit.
c. d.
6. Click Publish to replace personalized changes that users have made to this view. Note: This replaces any modifications that users have made to their personal views.
Views
Views
Views
Add a Subpage
To add a subpage to an object's property view 1. Click Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the object's name. The Object Definition: Properties page appears. 3. Click Views from the content menu. The Object Definition: Views page appears. 4. Locate the properties view that you want to work with and click [Layout: Edit] from the Setup column in that row. The Property Layout page appears. 5. Click Create Subpages. The Create Subpages page appears. 6. Complete the following fields: Subpage Name Identifies the name that will appear in the content menu as a link to the subpage. Subpage ID Identifies the subpage using a unique alphanumeric identifier. 7. Click Submit. The Property Layout page appears with the new subpage listed.
Views
Views
Function equals not not equals greater than greater than or equal less than less than or equal or and like not like
Example asset.created_by == "marybell" !(asset.created_by == "marybell") asset.created_by != "marybell" asset.planned_cst_total > 25000 asset.planned_cst_total >= 25000 asset.planned_ben_total < 100000 asset.total_ownership_cost <= asset.forecast_cst_total asset.total_ownership_cost > 5000 || asset.planned_ben_total > 5000 asset.is_active == 1 && asset.planned_cst_total > 50000 like( asset.created_by, "marybell" ) notLike( asset.created_by, "marybell" )
Use the following rules to manually enter an expression: Place text values in double quotes. The syntax for the object to attribute relationship is object.attribute. For example, in the expression asset.created_by=="marybell", the object to attribute relationship is shown in the first half of the expression. The expressions are case sensitive when evaluated. Enter values in the appropriate case to ensure you get the correct true or false display value. The Negate Expression button makes the entire expression that displays in the Expression text box negative by enclosing the expression in parentheses and placing and exclamation symbol before the parentheses. For example, !(asset.created_by == "marybell").
Views
The Add Parentheses button encloses the entire expression in parentheses. Use parentheses to specify precedence. For example, in the following expression, asset.created_by != "marybell" || (asset.is_active == 1 && asset.planned_cst_total > 50000), the portion of the expression enclosed in parentheses will be evaluated first. The result of the evaluation will then be compared with asset.created_by != "marybell". The Evaluate button evaluates the expression in the Expression text box. Use this button if you enter text manually or modify text you have created using the Display Condition Builder. The And/Or field is used to create compound expressions in the Expression text box. After the first expression is entered, this field becomes active so that you can choose the operand (And or Or) for the second expression.
There are some operations in the Display Condition Builder that you can use for any object for which you are defining display conditions.
Operation Check resource's global rights Check resource's group Check resource's OBS unit
Syntax checkGlobalRight(<global right code>,<value to check>,<operator>) checkGroup( <group code>, <value to check>, <operator> ) checkOBSUnit( <OBS path>, <OBS Internal ID>, <OBS level>, <value to check>, <operator> )
Check resource's partition checkOBSUnit( <OBS path>, <OBS Internal ID>, <OBS level>, <value to check>, <operator> ) If an attribute is linked to a lookup, you can use the following syntax on the right side of the equation.
Syntax lookup( <lookup code>, <internal lookup value id> ) lookup( "<lookup code>", "<lookup value code>" )
Views
Views
If you are using partitions, the new published view affects only the partition you select. During a CA Clarity PPM upgrade or when installing add-ins, personalized user views are not upgraded. Accordingly, if a view is configured or if the views object is partitioned, the system will not upgrade that view. To keep users current, you may want to publish any new views provided by a CA Clarity PPM upgrade or from an add-in. Note: If upgrade or new system changes to a view's attributes are required for CA Clarity PPM to operate properly, the changes are merged with the user's configured view during an upgrade. The merge of required changes with the user's configured view does not overwrite the user view and does not cause the view to be marked as upgraded. The Views page in Studio provides information that lets you make appropriate decisions about publishing new views. Use this page to determine which views were not upgraded automatically and may require manual upgrading and to publish changes. The Views page shows a list of system views and their current status in CA Clarity PPM. Custom views are not listed. Use the Views page to manage all system views across all objects and their partitions. Use the following columns on this page to assess whether you need to publish a view to users: View::Code Identifies the view name. "View" is the nonspecific part of the name and many views can exist in different partitions or the same partition that have this portion of the name. "Code" is a name attached in CA Clarity PPM that identifies the view more specifically. Using the view::code name, object, category, and partition, each view can be fully identified. Object Identifies the object on which the view is created. Category Specifies the category type for this view. Values: filter, list, and property Type (Properties views) Displays the view type. Values: Creating. The purpose of this view is for creating an instance or an object. Editing. The purpose of this view is for editing an instance or an object.
Views
Partition Displays the partition to which the view pertains. Default: System Personalized Specifies whether at least one user has configured the view in CA Clarity PPM. Publishing a new view or restoring the view default clears this check mark. Modified Specifies whether changes have been made to the view by the CA Clarity PPM administrator since its original installation or since the last time defaults were restored. Upgraded Specifies whether an upgrade has occurred for the view since its original installation. A check mark indicates the view was upgraded because it was not configured. Last Restored Displays the date that view defaults were last restored. Last Version Indicates the last release version in which changes have been made to the out-of-the-box view. The version number in this read-only field is updated only when changes for a view occur in a release. Note: Only the System partition has its views updated when an upgrade occurs. If views from other partitions are in the list, the Last Version field for these views will not show a value. To publish changes to views 1. Select Views from the CA Clarity Studio menu. The Views page appears. 2. Select the views that you want to publish to users, and click Publish. The Restore View Confirmation page appears. 3. Click Yes.
Views
Views
If restoring defaults for a view at a descendent partition: Views are overwritten based on the first ancestor partition that has a configured view. If no ancestor partition has a configured view, attributes settings are applied based on the system partition. The attribute settings cascade from the descendent partition (at which "restore default" was applied) to the first sub-descendent partition that has a configured view. If no view is configured at a sub-descendent partition, attribute settings cascade to the lowest descendent node in the partition model.
Views
Best Practice: Restore defaults for your views from the top-down in your partition model. The following diagram shows how out-of-the-box attribute settings are applied from the system partition level down to the descendent levels in a partition model:
Views
The following diagram shows how out-of-the-box attribute settings are applied from a descendent partition level down to the sub-descendent levels in a partition model:
The process for displaying multiple subpages on multiple tabs using custom property views includes the following basic steps: 1. Create a custom property view. The custom property view defines a set of subpages and the content that appears on each subpage. 2. Define the display of custom subpage links that appear on a custom portlet page tab by selecting the appropriate custom property view.
To delete a custom property view 1. Open the custom object from the CA Clarity Studio menu by clicking Objects and selecting the custom object from the list page that appears. The Object Definition: Properties page appears. 2. Click Views in the content menu on the left. 3. Select the custom property view you want to delete and click Delete.
Display Custom Subpage Links on a Tab Using the Custom Property View
You can display links for subpages on a tab in one of the following ways: In a content menu on the left side of the tab In a set of subtabs below the name of the tab In a combination of content menus and subtabs which also contain content menus
Prerequisite To display custom subpages on a tab, the page that the tabs are associated with must have a Type value that is equal to the custom object on which the custom view and subpages were created. The Type value is assigned when a page is created. If the Type value for the page you are adding subpages to is not equal to the object on which you created the custom views, create a new page and make the Type value equal to the custom object.
Tab ID Indicates an internal identifier for the tab. Enter a unique alphanumeric string. Content Source Indicates the origin of the content for the data on the tab. Select a source from the drop-down menu. 6. In the Layout field, select Properties. The View field appears directly below the Layout field. 7. In the View field, select the custom view with subpages you want to appear on the content menu of the tab. Note: For information purposes, the individual subpages are listed out for each view with the subpages in parentheses. The subpage you select is the default that displays for the view when you click the tab. 8. Click Save and Exit. 9. View the changes in the application.
6. In the Layout field, select Subtab. The View field appears directly below the Layout field. 7. In the View field, select the custom view with subpages you want to appear on the content menu of the tab. Note: For information purposes, the individual subpages are listed out for each view with the subpages in parentheses. The subpage you select is the default that displays for the view when you click the tab. 8. Select Save and Continue. The Tab: Subtabs page appears. Use this page to define subtabs. 9. Click New. A new row appears where you can define additional subtabs. 10. Complete the following actions: a. b. Enter a name in the Subtab field and a unique identifier in the Action Code field. Select a property set (view) from the Property Set drop-down list. The property view you select appears in the content menu on the subtab. If you do not want subpages to appear in the subtab content menu, select General. c. Click Save.
3. Click Attributes from the content menu. The Object Definition: Attributes page appears. 4. Click New. The Object Attribute page appears. 5. Complete the following fields: Attribute Name Enter the name of the new field. Attribute ID Enter a unique ID for the field. Note: This code must contain only alphanumeric characters and the underscore (_) character and it must also not be a SQL reserved word. Once you save a field, you cannot change the ID. Description Enter a brief description of the field. Data Type Choose URL. Note: Once you save a field, you cannot change the data type. Default Value Enter the value you that you want to appear as a default value for the field. Maximum Length Enter the field's maximum length. The maximum size of a string field is 1000 characters. Do one of the following: To automatically populate existing objects with the Default Value, check Populate Null Values with the Default. To require that users enter a value into this field, check Value Required. To require that this field always appears in the user's Edit Properties view and cannot be removed, check Presence Required. To prevent users from changing the value of this field, check Read-Only.
Note: A read-only field must have a Default Value assigned. 6. Click Save.
Defines the stock object definition ID as defined in the administration pages. In the above example, project is the code for the Project stock object.
unique_code=myamazingproject
Determines how the object instance is retrieved. The parameter name unique_code identifies the name of the unique attribute on the object which in turn identifies the object instance that you want to reference. The parameter name you use here depends solely on the object that you want to reference as identified by the odf_code parameter described earlier. In the above example, the object is Project, and unique_code is used to identify a project instance with the unique_code value of myamazingproject. The following is an example of the URL format that you can now use to reference a custom object, BPM Department:
http://someclarity.somebiz.com/niku/app?action=odf.customObjectInstance&odf_c ode=custom_workflow&release=1.0.1A
Defines the custom object definition ID as defined in the Studio object administration pages. In the above example, custom_workflow is the code for the Custom Workflow custom object.
release=1.0.1A
Defines a custom string attribute Release on a custom object Custom Workflow with object code custom_workflow where the release is 1.0.1A. Note: URLs with properly escaped parameter values will work as valid URLs. For example, if you use the attribute name with the value My Green Items, the URL is constructed as ...name=My%20Green%20Items.
At Time Scale, select the time values to show across the top of the chart (e.g. Day, Week, Month, etc.). At Number of Time Periods, enter the number of time periods to be displayed in the chart.
e.
(Optional) At Time Period Offset, enter the number of time periods if you want to shift the beginning of the Gantt bar relative to the Start Date. Note: Use this option only if you also enter a Start Date.
f. g.
At Show Group Header Row, enter the Year, Quarter, Month, or Week (if you want to display a timescale above the Gantt bar). At Column Width, enter the percentage of the view's width that should be allocated to the Gantt chart column.
9. Define the primary bar of the Gantt chart: a. b. c. d. At Item Name Attribute, select the attribute for the primary bar. At Start Date Attribute, select the date field to use for the beginning of the bar. At Finish Date Attribute, select the date field to use for the end of the bar. At Milestone Attribute, select the field to use for milestones. Note: If this field contains a non-zero value, the Gantt chart displays a diamond. e. At Progress Through Date Attribute, select a date field to use to indicate when work is complete. Note: If you choose a Progress Through Date Attribute, it overrides the Progress Percent Attribute. f. g. h. At Progress Percent Attribute, specify the percentage of the bar's length that the progress line shall be. At Color Attribute, select the bar's color. At Show Mouseover, select the values that will appear when the user moves a cursor over the bar. Choose from Item Name, Start Date, Finish Date, Progress Through Date, and Progress Percent.
10. (Optional) To display a second bar below the primary bar (for comparison purposes), check the Show Secondary Bar box and repeat Step 9 above in the secondary bar section. 11. Click Save.
Color Attribute select the attribute that determines the color of each stage. Show Label Click display the name of the current stage in the Progress Bar. Column Width Enter a number that indicates the percentage of the list's width is allocated to the Progress Bar column. 8. Click Submit.
Properties You Can Change Date range validation Decimal Places Default Value Description Formula fields
Comments Applies only to new records. You can only increase the value of this attribute. The default value to display. A description of the field. These fields retain existing calculated values and change only when you edit the Formula field and save it. Links that when clicked, display other CA Clarity
Links
You can't change the Lookup or change the lookup type to Multi-valued. You can, however, change the default value used when the Lookup is updated. You can only increase the value of this attribute. The name of the field. Applies only to new records. Defines whether the field must appear. Only the formula can be changed. If you change this property, only new values are shown as a percent. You can change a field from unique to non-unique, but not vice versa. You can change a field from required to non-required, but not vice versa.
Maximum Length Name Numeric Range Validation Presence Required Risk Show as Percent Unique Value Required status
6. Click Submit. Your changes are saved and the Object Definition: Attributes page appears. 7. To see your changes, click the field's name again. 8. Click Exit.
2. Click the object whose field label you want to change. The Object Definition: Properties page appears by default. 3. Click Views from the content menu. The Object Definition: Views page appears. 4. Find the property view that you want to change, then click Fields next to that view. The Object Definition: Property Fields page appears. 5. In the Property Label row, find the field whose label you want to change and enter a new name. 6. Click Submit.
You cannot use this feature in virtual columns that contain Gantt charts, progress bars, time sliced values, or virtual images. Note: You can only map a display image for those attributes whose data type is "Number." To display a range of values as a color or icon 1. Select Objects from the CA Clarity Studio menu. The Objects page appears. 2. Click the object whose field you want to change. The Object Definition: Properties page appears by default. 3. Click Attributes from the content menu. The Object Definition: Attributes page appears. 4. Click the attribute for which you want to display an image. The Object Attribute page appears.
5. In the Display Mappings section, to represent the range of values as: a color, at Type choose Color. Then select a color from the drop-down list to represent the information. an icon, at Type choose Icon. Then click the Browse icon and select the icon to use to represent the range of values.
6. Complete the following fields in the section: Description Enter a description for the range of values. From Enter the beginning value for the range. To Enter the ending value for the range. 7. If you are creating more than one image for an attribute (for example, a green icon, yellow icon, and red icon for different statuses), repeat Complete the following fields in the section: as many times as necessary. 8. Click Submit.
Property Label Defines the label for the field. Note: To translate the label into another language, click the Translate icon and enter text in another language. If you do not see the Translate icon, try clicking Save. Display Type This field displays for date data type fields. Specifies how you want the date to display. Values: Date, Date and Time Default: Date Hint Enter a message that helps the user use the field. The maximum length of this field is 512 characters. Hint Position Indicates where the hint appears in context with the field. Values: Above or Below Default: Below Tooltip Enter a short message to display when the user moves a cursor over the field. Width Enter the number of characters allowed for the text entry box. Attribute Default Enter the default value for this field. Override Default Enter a new default value for new records created through this view. Attribute Default Date Enter the default date for this field. Override Default Date Specifies the default date. Values: Rolling Date and Specific Date Value Required Check this box to require that users enter a value.
Enter Once Check this box to prevent users from changing this field's value after it has been entered. Hidden Check this box to prevent the field from displaying on user views. Use hidden fields to add data that is used in calculations but does not display on the page. When you add hidden attributes to properties views, they will not appear to the user. You must define a default for hidden attributes. Height Enter the number of lines allowed for a text area box. 6. Click Submit.
Alignment Defines the alignment. Values: Left, to align the field with the left side of the column, Center, to center align the field in the column, or Right, to align the field with the right side of the column.
Allow Word Wrapping in Column Check this box to allow field text to wrap when the text is wider than the column. Allow Word Wrapping in Column Header Check this box to allow header text to wrap when the column header is wider than the column. Column Label Enter the name you want to appear for the column. Column Width Enter the column size (in pixels). Decimal Places Enter the number of decimal places to display for this field. Display Elements Defines the display elements. Values: Image, to display the field as an image. Value, to display the field as a value. Range Description, a descriptive label to represent the range of values.
Note: You can choose to display such columns of information as a value (e.g., 6.4), as a image (such as a green/re/yellow stoplight), as a range description (e.g. super, fair, awful), or a combination of these options.
Display Type Choose: Number to display the field as a number Percent to display the field as a value with a percent sign (for example, .34% or 34%) Calculated Percent to display the field as a calculated value (100 x field value) with a percent sign (for example, 34% or 3400%) Column Graph to display the field as a column graph Bar Graph to display the field as a bar graph.
Disable Link Attribute Select an attribute to indicate whether the value in the Link field appears in a list or grid as text only or as a hyperlink. If the value of the attribute selected equals zero, the text in the corresponding Link field appears as text only. If the value selected in the field is not zero or if a value is not selected, the value selected in the Link field appears as a hyperlink. This field applies only when the Link field has a value selected. Link Select a page to display when users click this link. To have the page display in a pop-up window, check the Open as Pop-up box. Secondary Value Select a secondary field's value to display when the user moves a cursor over the field. Show Column Label Check this box to display the column label. 7. Click Submit. 8. Click the Indicator Images icon next to the field whose appearance you want to change by adding an image. The List Column Field: Indicator Images page appears. 9. In the Available Images list box, select the image or images you want to appear in the field and click the Move Image arrow below the list box. 10. Click the Move Image arrows at the bottom of the page to position the image or images either before or after field content. 11. If you have multiple images, use the up and down arrows to set the order that the images appear in the field. 12. Click Save and Exit.
Filter Default Defines the filter default. Do one of the following: To choose a period to include, select that date from the Rolling Date drop-down list, Enter a date into the Specific box, or Click the Calendar icon and select a date.
Note: If you choose Date Range as the Display Type, the page redraws to show Filter Default From and Filter Default To options so that you can set defaults for both ends of the date range. Required in Filter Check this box to ensure that the field cannot be removed from the List Filter layout. Hidden in Filter Check this box to make the field appear in the List Filter view, but invisible to users. Use hidden fields to include data for calculations that are not displayed. Read-Only in Filter Check this box to prevent users from changing the value of this field in a List Filter view. Note: If you select this option, the field must have the Filter Default value set. Hint Enter a message to help users use the field. Limits: 512 characters Tooltip Enter a short message to display when the user moves the cursor over the field. 7. Click Submit.
3. Click Views from the content menu. The Object Definition: Views page appears. 4. On a list column view type row, click Fields. The Configure: List Column Views page appears. 5. Click the Properties icon in the row that contains the field you want to change. The List Column Field page appears. 6. Change any of the following options (the options that appear depend on the field's data and display type): Column Label Enter the name you want to appear for the column. Show Column Label Check this box to display the column label. Allow Word Wrapping in Column Header Check this box to allow header text to wrap when the column header is wider than the column. 7. Complete the following fields: Display Type Select: Column Graph, to display the field as a column graph, or Bar Graph, to display the field as a bar graph.
Secondary Value Select the attribute whose value displays when the user moves a cursor over the primary bar. Alignment Select: Left, to align the field with the left side of the column, Center, to center align the field in the column, or Right, to align the field with the right side of the column.
Thickness Choose from the following options: Autofit to fit the graph to the column width. Narrow to display a narrow graph. Medium to display a medium-width graph. Wide to display a wide graph.
Maximum Length Enter the length of the bar (in pixels). Length Scaling Choose from the following options: Relative to Same Column. Use this to make the bar length proportional to other bars in the same column. This option is most useful when displaying horizontal bars. For example, the Budget Cost bar in a row with a value of $500,000 would show as twice the height of the Budget Cost bar on a row with a value of $250,000. Relative to Same Row. Use this to make the bar proportional to all other bars in the same row. This option is most useful when displaying vertical bars. For example, the Budget Cost bar with a value of $500,000 would display as twice the height of the Budget Benefit bar with a value of $250,000. Relative to Entire Table. Use this to make the bar proportional to all bars of the same type (vertical or horizontal) in the entire table. For example, in a grid with the Budget Cost column as a vertical bar and a row with a Budget Cost value of $500,000 would display as twice the height as the Budget Cost value of $250,000 in another row. No Scaling. Use this to draw all bars to the maximum length. This can be used to create progress bars. For example, you could have an ETC column with actuals as the threshold value. The part below the threshold shows how much work is already done; the part above shows how much work remains to be done. By looking at a column of these bar graphs you can quickly see how close each task is to being complete relative to the others. Color Select a color for the primary bar. Threshold Line Attribute Select an attribute (field) in the same object that holds the threshold value. Note: In bar graphs, a vertical line marks the threshold value.
Over-threshold Color Select a color to represent values greater than the threshold value. Note: Any portion of the primary bar that extends past the threshold is drawn in the over-threshold color. Any portion of the secondary bar that extends past the threshold is drawn in a darker shade of the same color. Link Select a page to display when the user clicks the primary bar. If you want the page to open in a pop-up window, check the Open as Pop-up box. 8. (Optional) To create a stacked bar, complete the following fields: a. b. c. Stacked Attribute, select the attribute to be represented as a stacked bar. Color, select a color for the stacked bar. Secondary Value, select a value to display when the user moves a cursor over the secondary bar.
9. At Link, select a page to display when the user clicks the secondary bar. 10. Click Submit.
2. To add a link to the: Administration Tool, click Administration Tool Menu. CA Clarity PPM application that users see, click Application Menu.
The Menu Hierarchy page appears and displays all sections and links. A check mark appears in the Active column next to menu items that are currently activated. System pages are always active. 3. Check the box next to the menu that you want to add a section or link to and then click Add. 4. Do one of the following, and click Submit: To create a link, click Link. To create a section, click Section.
5. If you are adding a link, complete the following fields: Link Name Defines the link's name. Description Defines the link's description. Page Name Click the Browse icon and select the page to display when the link is clicked. Parent Menu Item Select the menu in which this link will appear. 6. If you are adding a section: Section Name Enter a name. Section ID Enter unique section ID. Description Enter a description 7. Click Submit. The Menu Hierarchy page re-appears and includes the items you added.
The Menu Hierarchy page appears and displays all sections and links. 3. Check the box next to the item you want to change. 4. You can do the following: Change a link, click Link. Change a section, click Section.
5. Click Submit. 6. Change any of the following fields: Description Enter a description. (Links only) Link Name Enter a name. Page Name Click the Browse icon and select the page to display when the link is clicked. Parent Menu Item Select the section in which this menu item will appear. (Sections only) Section Name Enter a name. Section ID Enter unique section ID. 7. Click Submit.
The Menu Hierarchy page appears and displays all sections and links. A check mark appears in the Active column next to the item that is currently activated. System pages are always active. 3. Click Reorder. 4. At Menu Items, select a section or link and then click the up and down arrow buttons to move it to another position. 5. Click Submit.
Icons
Icons
The following list shows the icons in CA Clarity PPM. You can use these to create image links:
Icons
Stock Icons
Stock Icons
The following list shows the stock icons. You can use these to create image links
Stock Icons
Stock Icons
Portlet Overview
Portlets are snapshots into CA Clarity PPM data and can consist of grids, graphs, or snippets of HTML. You select data to display in the portlet. While portlets do not replace CA Clarity PPM reports, they can be considered as mini-reports. You can create and publish portals across the enterprise. Each portal page is comprised of a set of portletssmall windows of information presented as graphs, tables, or web page snippetsthat appear automatically on the desktops of CA Clarity PPM users with the appropriate access privileges. Users can further personalize their portal pages by deciding which portlets to show or hide and where to show them on the page. Portlets obtain information and business intelligence from CA Clarity PPM, from other databases within the enterprise, and from external sources available in HTML, such as business news and network status information. Users can populate portlets with graphs, tables, workflows, best practices, documents, and forms-all updated and available in real-time without the need to run reports. The following portlet types are available: Graph portlets (see page 167) Provide graphic views into CA Clarity PPM data, such as pie and line charts.
Grid portlets (see page 183) Are lists or tables of data that can be filtered on-the-fly. HTML portlets (see page 180) Formatted in HTML, these portlets grab web page content and plug it into a CA Clarity PPM page. Data can be extracted from other internal or external web sites. Filter portlets (see page 191) Coordinate filtering operations between portlets on a page. Interactive portlets (see page 164) Displays visually-rich, real-time CA Clarity PPM information using imported Xcelsius visualizations.
Portlet Definition Editor Edit and view the portlet definition (requires Studio Access access rights). Portlet Definition Editor - All Edit all portlet page definitions in the Administration Tool (requires Studio Access access rights). Portlet Definition Viewer View the portlet definition (requires Studio Access access rights). Portlet View View a portlet. Portlet Creator - Automatic Edit a portlet (this is automatically granted to a portlet creator). Portlet Page View View a general portlet page in CA Clarity PPM. Users do not need this access right to view instances of portlet pages (such as portfolio pages). Portlet Page Creator - Automatic Edit a portlet page (this access right is automatically granted to the creator of a portlet page). Portlet Page Viewer - All View all configured portlet pages. This access right is dependent on portlet pages being linked to a menu before they can be displayed. If the portlet page is linked to the Administration menu, then the Administration - Access access right must also be granted. Portlet Page Definition Editor Edit, view, and delete a portlet page definition (requires Studio Access access rights). Portlet Page Definition Viewer View the portlet page definition in the Administration Tool (requires Studio Access access rights). Portlet Page Definition Viewer - All View the all portlet page definitions in the Administration Tool (requires Studio Access access rights). Portlet Viewer - All View all portlets and add them to portlet pages.
Stock Portlets
Object Administration Access Object Definition pages (requires the Studio module license). No instance-level access rights exist for queries or for the Menu Manager. You can grant access rights to specific resources, groups, and OBS units over specific portlets and pages. If the portlet and page objects are attached to an OBS, you can assign each portlet and page to an OBS unit, therefore you can give specific resources, groups, or OBS units access to pages and portlets in specific OBS units. In addition to the global access rights, you can grant access rights to individual pages and portlets on a per instance basis, thereby permitting users to modify just those portlets or pages for which they have explicit edit access rights.
Stock Portlets
See following a list of stock portlets that you can use. These portlets are restricted and therefore cant be changed. You can however create new portlets. See the rest of this section for instructions on creating new portlets. Balance Balance ID: Balance Category: Business Intelligence Type: Portfolio Benefits by Goal Benefits by Goal ID: Benefits by Goal Category: Business Intelligence Type: Portfolio Budgeted Costs Budgeted Costs ID: Budgeted Costs Category: Business Intelligence Type: Portfolio
Stock Portlets
Change Requests Assigned change requests ID: Change Requests Category: Project Type: General Cost of Investments Cost of Investments ID: Cost of Investments Category: Business Intelligence Type: General Cost/Benefit Cost/Benefit ID: Cost/Benefit Category: Business Intelligence Type: Portfolio Earned Value History Earned Value History. ID: EVHistory Category: Project Type: Project Financials Financials ID: Financials Category: Business Intelligence Type: Portfolio Gantt Gantt ID: Gantt Category: Business Intelligence Type: Portfolio
Stock Portlets
General General information for a project ID: project.General Category: Project Type: Project Ideas Idea portlet ID: pma.ideaPortlet Category: Business Intelligence Type: General Incident Cost for Investments Incident cost for investments ID: Incident Cost for Investments Category: Business Intelligence Type: General Incidents Assigned to My Team Incidents assigned to my team ID: Team Incidents Category: Business Intelligence Type: General Investment Health Investment health ID: Investment Health Category: BusinessIntelligence Type: General Investments Investments ID: Investments Category: Business Intelligence Type: Portfolio
Stock Portlets
Issues Assigned issues ID: Issues Category: Project Type: General Labor Resource Effort Labor resource effort for a project. ID: project.Effort Category: Project Type: Project Life cycle Funnel Life-cycle funnel ID: Life-cycle Funnel Category: Business intelligence Type: Portfolio Links Links defined for a project ID: project.Links Category: Project Type: Project My Projects Favorite projects ID: projmgr.homeHotList Category: Project Type: General Notifications Summary count of notifications by category ID: personal.notificationsNuggest Category: Collaboration Type: General
Stock Portlets
Realization Realization for a project ID: project.RLZ Category: Project Type: Project Return on Investment Return on investment for a project ID: project.ROI Category: Project Type: Project Risk Exposure by Category Risk exposure by category ID: Risk Exposure by Category Category: Project Type: General Risk Trends Risk Trends ID: Risk Trends Category: Project Type: General Risk/Reward Quadrants Risk reward quadrants ID: Risk/Reward Quadrants Category: Business Intelligence Type: Portfolio Risks Assigned risks ID: Risks Category: Project Type: General
Stock Portlets
ROI/Alignment Zones ROI/Alignment Zones ID: ROI/Alignment Zones Category: Business Intelligence Type: Portfolio Subprojects Subprojects for a project ID: project.Subprojects Category: Project Type: Project Team Utilization Displays the team-based utilization for the current project. Provides a detailed picture of total usage vs. allocation. ID: projmgr.teamUtilization Category: Project Type: Grid Timesheets to Approve Timesheets awaiting your approval ID: projmgr.timesheetAdmin Category: Resource Type: General Unfilled Allocations Unfilled Allocations ID: projmgr.unfilledAllocations Category: Resource Type: General Weekly Detail Weekly detail ID: projmgr.weeklyDetail Category: Resource Type: General
Note: An end user can export all of the content of some CA Clarity PPM portlet pages (for example, the Overview portlet page). The export includes any custom tabs added by the end user. The export is limited to pages of type Page with Tabs or Page Without Tabs. The option will always be Fit to page where all portlets for a tab are exported to one page. Data Providers for User Portlets When a user creates a portlet to be used in a dashboard, the user must select a data provider. Query data providers can be used to provide information to user portlets for dashboards.You can prohibit the use of a query data provider by clearing the Available for User Portlets check box on the query's properties page. When a user selects a data provider for a user portlet, the attributes for each data provider are shown to help the user select the correct data provider. You can modify the attribute names to provide more user friendly names to help users make the correct data provider selection. To re-label query attributes for the user portlet data provider selection 1. Click Queries in the CA Clarity Studio menu. The list page appears. 2. Select the query. The query's properties page appears. 3. Click Attributes in the content menu. The list of attributes for the query appears. 4. Click the name of the attribute you want to re-label. The Query Attribute page appears. 5. Click the Translate icon next to the Attribute Name field. The Translate page appears. 6. Enter the name you want to appear for users in the data provider's attribute list.
7. Click Submit.
Access Right Dashboard - Navigate Portlet - Navigate Dashboard - Create Portlet - Create Portlet Definition Editor Portlet - View Page Definition Editor Page - View
What it does in the application Shows the Dashboard Navigation link for a user. Shows the Portlet Navigation link for a user. Lets a user create a dashboard. Lets a user create a portlet. Lets a user edit a portlet.
Lets a user view a portlet. Global/OBS/Instance Gives a user manager access to a dashboard. Lets a user view a dashboard. Global/OBS/Instance Global/OBS/Instance
Interactive Portlets
Interactive Portlets
Interactive portlets display visually rich CA Clarity PPM information in real time. Interactive portlets are created in CA Clarity PPM and contain Xcelsius visualizations. These visualization are exported as vector-based graphic Adobe Flash (.SWF) files and imported into CA Clarity PPM. Interactive portlets use global and object parameters with Flash variables to establish secured data transfers and to create context-aware visualizations. Use interactive portlets to: Perform a what-if analysis Set up alerts Drill down to go to more detailed information Mouseover areas to view more information
Once you have created Xcelsius visualizations and imported them into CA Clarity PPM interactive portlets, you can associate them with objects, such as Project or Resource. You can also make Xcelsius visualizations available on object pages. Users can personalize their pages and add interactive portlets anywhere in CA Clarity PPM, such as their Overview page, as they can with other portlet types. Note: See the Common Features and Personal Options User Guide for more information.
Interactive Portlets
Portlet Name Defines the name of the portlet. This name appears on the title bar of the portlet and in the list of available portlets. Portlet ID Defines a unique alphanumeric identifier for the portlet. Content Source Specifies where the data that appears in the portlet originates. Category Specifies the general area on which the portlet reports data. Description Defines the purpose of the portlet and provides any relevant information. Active Indicates the portlet is active and are visible to users. You can edit inactive portlets and activate them later. Default: Selected Instance Type Specifies the type of page the portlet can be placed on. If you select General, the portlet can be added to any CA Clarity PPM page. If you select an Object, the portlet can only be added to CA Clarity PPM pages associated with that Object. Visualization File (.swf) Specifies the .SWF file used for the interactive portlet content. Click the Browse icon to select the .SWF file. Do not enter or copy the file path. 4. Save. The Xcelsius visualization is imported into the interactive portlet.
Interactive Portlets
Graph Portlets
Flash Variable Name Defines the name for the flash variable. This name must be the same as the Flash Variable Name associated with the visualization. For Global Parameter, BusinessObjects Session ID, displays the required value: CELogonToken Required: Yes Description Defines the description for the parameter. Limits: 240 characters Required: No 5. Click Submit.
Graph Portlets
You can use graph portlets to display query data in an easy-to-view graphical format. Before you create a graph, see the topics in this section for a detailed description of the various types of graph portlets and display options you can select when creating graphs. You might use various graph types to display the following types of information: Pie charts that show the number of projects with low, medium or high risk Pie charts that show revenue by project or OBS unit Scatter graphs that show NPV or ROI per project Bubble graphs that show NPV, ROI, and cost per project Line graphs that show resource capacity over time
Graph Portlets
Data Providers
Data providers, the source of grid and graph portlet data, are special data constructs that can be accessed directly with portlets or through queries. Data provider types are Queries, Objects, and System. Queries CA Clarity PPM provides a query language called NSQL, that is similar to SQL, that you can use to create queries. If you are not familiar with SQL, you can still create portlets using the built-in data providers that come with CA Clarity PPM. Objects The stock CA Clarity PPM objectsand any objects you createcontain fields that you can use to access database information. System System types are data providers for the restricted portlets. You can use these data providers in addition to stock CA Clarity PPM objects.
Description Used with the Team object to list data about requests for project resources or roles. This provides combined data for investment types (Projects, Assets, Applications, Products, and Other Investment). This is a subset of the Task object and contains data about key tasks. This provides data about the tasks to which a resource is assigned. This contains portfolio data. This contains data about programs and the projects which belong to a program. This contains data about resources assigned to projects. This contains data about resources assigned to projects. This lists data about projects to which a resource is assigned.
Key Tasks Organizer Tasks Portfolios Programs Project Team Members Project Team Selection Resource's Projects List
Graph Portlets
Displays each dimension of the 1 data in a horizontal bar. Displays metrics on the 3 horizontal and vertical axes. Also provides data points on the radius to control data point size that is based on a third metric. Displays each dimension of the 1 data in a vertical bar. Displays the datas dimension 1 objects in proportional slices, like a pie chart, except the greatest values appear in the largest area of the funnel. Displays data points that are connected by lines along the axes. 1
Column Funnel
Unlimited 1
1 Not Available
1 Not Available
Line
Unlimited
Pie
Displays the datas dimension 1 objects in proportional slices. Displays metrics across the x-axis and y-axis. 2
Not Available 2
Not Available 2
Scatter
Graph Portlets
To create a graph portlet 1. Select Portlets from the CA Clarity Studio menu. The Portlets page appears. 2. Click New Portlet and select Graph Portlet from the drop-down menu that appears.. The Graph Portlet: General page appears. 3. Complete the following fields: Portlet Name Defines the name of the portlet. This name appears on the title bar of the portlet and in the list of available portlets. Portlet ID Defines a unique alphanumeric identifier for the portlet. Content Source Specifies where the data that appears in the portlet originates. Category Specifies the general area on which the portlet reports data. Description Defines the purpose of the portlet and provides any relevant information. Base Size Specifies the base size for the portlet. The values are Small, Medium, and Large. If you plan to create a single graph portlet on a personalizable page, you might select Large. If the portlet is to share a page with other portlets, you might select Small. Active Indicates the portlet is active and are visible to users. You can edit inactive portlets and activate them later. Default: Selected
Graph Portlets
Instance Type Specifies the type of page the portlet can be placed on. If you select General, the portlet can be added to any CA Clarity PPM page. If you select an Object, the portlet can only be added to CA Clarity PPM pages associated with that Object. Data Provider Indicates the data construct that provides information to the portlet. Click the Browse icon to select a data provder. 4. Click Next. The Graph Portlet: Graph Type page appears. 5. At Graph Type, choose a graph type, and click Next. The Graph Portlet: Finish page appears. 6. If your query contains multiple metrics, at Metric select a metric to display on the X-axis and click Next. 7. Click Finish and Open. The Graph Portlet: General page appears. 8. Click Save. 9. Select Source Data from the content menu. The Graph Portlet: Source Data page appears. 10. From the Available Metrics column, select the data you want to include in the graph, then use the left and right arrow buttons to move the item into the graph columns. 11. Click Save.
Whats Next?
Now that you have a new graph portlet, you should also perform the following procedures: Determining Graph Portlet Appearance Determining Graph Portlet Data to Display Changing Graph Portlets
Graph Portlets
5. Depending on the type of graph you selected, enter values for the following display options, then click Save. Note: The options are entered in alphabetic order rather than the order they appear on the page. Allow Configuration Indicates a user can make changes to the appearance of a portlet. Select the check box to allow configuration. Allow Label Configuration Indicates a user can make changes to a portlet's labels. Select the check box to allow configuration.
Graph Portlets
Angle of First Slice Defines the position of the first dividing line. Use with Pie and Funnel graphs. Axis Label Displays the metric name along the X, Y, or both axes. Use this option with: Bar. X, Y axis. Column. X, Y axis. Line. X, Y axis. Bubble and Scatter. X axis.
Crosses Opposite Axis At Defines the intersection point of the axis. Use this option with: Bar. Y axis. Column. X axis. Line. X axis. Bubble and Scatter. X axis.
Category Labels Specifies for the X axis of column and line graphs and the Y axis of bar graphs the labels that appear along the category axis. For example, if a column graph shows five months of data with three metrics (shown as red, green and blue bars), the months are the categories and this field determines the label that appears on each one. Datapoint Labels Specifies the data name to be applied next to the value on the graph. Use this option with all data types. Decimal Places Defines the number of decimal places to display for numbers. Use this option with: Bar. X axis. Column. Y axis. Line. Y axis. Bubble and Scatter. X, Y axis.
Graph Portlets
Display Units Specifies how values are rounded up. Select a value for rounding from the drop-down list. Use this option with: Filter Indicates how the results appear initially. Select an option that indicates if you want immediate results or results provided after you set the filter. Link Specifies a page link that appears as a secondary value that the user can select. Select a page from the drop-down list. Logarithmic Indicates that the data points are to be plotted and shown on the axis major grid lines as a logarithmic scale, that is, as a power of 10 rather than a regular linear scale. Major Tick Marks Specifies if major tick marks appear on the axis. Major tick marks are used to identify major intervals on a graph. For example, the numbers 5, 10, 15, and so on may be highlighted with major tick marks. Bar. X axis. Column. X, Y axis. Line. X, Y axis. Bubble and Scatter. X, Y axis. Bar. X axis. Column. Y axis. Line. Y axis. Bubble and Scatter. X, Y axis.
Major Unit Increment Defines the interval of major ticks on the axis. Use this option with: Bar. X axis. Column. Y axis. Line. Y axis. Bubble and Scatter. X, Y axis.
Graph Portlets
Maximum Value Defines the greatest value to display on the axis. Use this option with: Bar. X axis. Column. Y axis. Line. Y axis. Bubble and Scatter. X, Y axis.
Minor Tick Marks Specifies if minor tick marks appear on the axis. Use this option with: Bar. Y axis. Column. X, Y axis. Line. X, Y axis. Bubble and Scatter. X, Y axis.
Minor Unit Increment Defines the interval of minor tick marks on the axis. Use this option with: Bar. X axis. Column. Y axis. Line. Y axis. Bubble and Scatter. X, Y axis.
Mouseover Labels Specifies the data values to show when a user moves the cursor over a graph value. Uses with all graph types. Other Category Threshold Defines the data point at which all records for a specified value are grouped into a category called Other. Use this option if too many items appear on the graph. Use this option with: Bar Column Line Pie and Funnel
Reverse Specifies that the axis goes from maximum value to minimum value. The standard is for an axis to go from minimum to maximum value.
Graph Portlets
Show Axis Indicates whether the Axis line displays. Use this option with: Bar. X, Y axis. Column. X, Y axis. Line. X, Y, axis. Bubble and Scatter. X, Y axis.
Show Legend Indicates a legend is to be displayed for the graph. Use with all graph types. Select the check box to display a legend. Show Line Markers Indicates that data points on the graph; otherwise, only a line displays. Available for line graphs. Select the check box to show line markers. Show Lines Indicates that lines are to connect the data points. Available for line graphs. Select the check box to show lines. Show Major Grid Lines Indicates whether major grid lines display on the graph. Use this option with: Bar. X, Y axis. Column. X, Y axis. Line. X, Y, axis. Bubble and Scatter. X, Y axis.
Show Minor Grid Lines Indicates whether minor grid lines display on the graph. Use this option with: Bar. X, Y axis. Column. X, Y axis. Line. X, Y, axis. Bubble and Scatter. X, Y axis.
Graph Portlets
Show Separator Specifies that a comma is to separate values greater than 999 (for example, 1,000). Use this option with: Bar. X axis. Column. Y axis. Line. Y axis. Bubble and Scatter. X, Y axis.
Show Tick Labels Indicates whether tick labels display on the graph. Use this option with: Bar. X, Y axis. Column. X, Y axis. Line. X, Y, axis. Bubble and Scatter. X, Y axis.
Show Title Indicates that the portlet name is to display. Available for all graph types. Select the check box to show the portlet name. Sort Column Indicates a column is to be the default sort item. This option is available for column graphs. Sub-type Indicates the metrics are to display as separate bars rather than a single merged bar. Select the sub-type that is desired. This option is available for bar and column graphs. Tick Label Angle Sets the angle of a label used with tick marks. Use this option with: Bar. X, Y axis. Column. X, Y axis. Line. X, Y, axis. Bubble and Scatter. X, Y axis.
6. (Optional) If you are configuring a line graph, select Guides in the Options field and click New, then complete the following fields and click Submit. Axis Specifies the axis for which guides are being set. Label Defines the name for the axis. Enter the name you want to appear.
Graph Portlets
Show Label Determines whether the name of the axis displays. Select the check box to display the name. Type Identifies the source of the information that displays on the guide. Select the appropriate option. If you are selecting a type for an X axis, you can only select an attribute. If you are selecting a type for a Y axis, select either the fixed value or the percentage and fill in the amount. Color Specifies the color for the guide.
Graph Portlets
9. To determine which data displays on the graph, under Graph Filter Section, click Fields. Then: a. At Display, select the fields you want to display. Choose All, Selected (to display those you selected in the To add a field, select it from the Available column, then click the right arrow (, or Available (to display all data provided by the query). To change information about a field, click the Properties icon next to the field, enter the new information, then click Save.
b.
4. To change the data metric used for the graph portlet: a. Click Source Data from the content menu. The Graph Portlet: Source Data page appears. b. Select metrics for the new graph type. The method of selection for the graphic varies depending on which graph type was selected. 5. Click Save.
Grid Portlets
Grid Portlets
Use grid portlets to display query data in rows and columns. Before you create a grid, see the detailed description of the various types of grids and display options you can select for grids. Grid portlets are most suitable when your query data contains only one or two dimensions, which are related data elements in a query. For example, project-related data (Project ID, name, start date, etc.) is considered a single dimension. Queries that contain project and resource data are considered to be two-dimensional. Graphs are better suited for query data that contains several dimensions or metrics (query values that can be measured). You might use grids to display: Lists of resources or transactions Capacity and assignment demand for resources over time The number of overdue action items per resource per OBS unit
Grid Portlets
Depending upon the type of data involved, you can choose from the following aggregation or comparison functions: Sum Average Count Minimum Maximum Variance Standard deviation
Note: When the query data is a date, only the COUNT, MIN, and MAX functions are available. String fields cannot be aggregated. If the data in your query has at least two dimensions, you can create another virtual column that compares and aggregates the two fields. Depending upon the data, you can then choose to display the results as a number or a bar or column graph.
Grid Portlets
To create a grid portlet 1. Select Portlets from the CA Clarity Studio menu. The Portlets page appears. 2. Click New and select Grid Portlet from the drop-down menu that appears. The Grid Portlet: General page appears. 3. Complete the following fields: Portlet Name Defines the name of the portlet. This name appears on the title bar of the portlet and in the list of available portlets. Portlet ID Defines a unique alphanumeric identifier for the portlet. Content Source Specifies where the data that appears in the portlet originates. Category Specifies the general area on which the portlet reports data. Description Defines the purpose of the portlet and provides any relevant information. Active Indicates the portlet is active and are visible to users. You can edit inactive portlets and activate them later. Default: Selected
Grid Portlets
Instance Type Specifies the type of page the portlet can be placed on. If you select General, the portlet can be added to any CA Clarity PPM page. If you select an Object, the portlet can only be added to CA Clarity PPM pages associated with that Object. Data Provider Indicates the data construct that provides information to the portlet. Click the Browse icon to select a data provder. 4. Click Next. 5. On the Grid Portlet: Finish page, click Finish and Open.
Whats Next?
After you have created a new grid portlet, you should also perform the following procedures: Determining the Layout of Grid Portlets Restricting Access to Portlets and Pages Using Portlet Pages: Deploying Content
Grid Portlets
Your changes are saved. 5. To determine which fields appear on the grid click Fields from the List Column Section content menu item. The Grid Portlet: List Column Fields page appears. 6. From the Show drop down, select the attributes to display on this page. 7. From the Display drop down, select the values you want to add to the grid.
Grid Portlets
8. To determine grid display options click Options and complete the following fields: Secondary Value Display Indicates the way that secondary values display in a grid cell. Select Mouseover only to have no secondary value display. Select Mouseover and redline to display a secondary value when a user places the pointer over a cell in a grid. This helps you compare values. For example, if you have a column called Cost and another column called Baseline Cost, you might want to display both values in one cell. To show both, you can choose Baseline Cost as the secondary value. The Cost value displays as usual; however, when a user moves the pointer over a cell in the grid, the Baseline Cost also displays. Select Show Null Secondary Values to show the secondary value even when there is no number value to show. Filter Indicates how the results appear initially. Select an option that indicates if you want immediate results or results provided after you set the filter. Rows per Page Specifies the number of rows per page to display. Highlight Row by Attribute Specifies the attribute whose row is highlighted when the attribute's value is not zero. For example, if you want to see all investments in your portfolio that are approved, enable highlighting for the Approved attribute. Then, when an investment is approved, it is highlighted on the grid. Display Currency Code in Column For money attributes, the currency code is shown in the column. This applies only when a single currency is being used. Select the check box to display the currency code. Allow Configuration Indicates a user can make changes to the appearance of a portlet. Select the check box to allow configuration. Allow Label Configuration Indicates a user can make changes to a portlet's labels. Select the check box to allow configuration. Attribute Value Protection Specifies how attribute values will be protected in a grid portlet. 9. Click Save.
Grid Portlets
10. In the List Filter section, click Layout and complete the following actions: a. At Available, select the query fields you want to make available to CA Clarity PPM users who use this portlet. Click Add Field to move them to the Selected Columns lists. At Section Title, enter the text you want to appear at the top of this section. At Default Filter State, select Expanded or Collapsed. Click Allow Power Filter to provide advanced search features. Click Save.
b. c. d. e.
11. In the List Filter Section, click Aggregation and set the following options then click Save: To show one or more aggregation row that group several data items, click Show Aggregation Row. Then, in the Aggregation Rules section, select the field to aggregate and an aggregation function to use for displaying data in the row. To show a comparison row that compares values, click Show Comparison Row. Then in the Comparison Rules section, select the comparison column and comparison aggregation function. Click the link in the Display column to specify how the comparison data will display. To show the difference between the aggregation and comparison rows, click Show Variance Row.
12. To determine the properties to display in the filter field, under List Filter Section, click Fields. Then: a. At Display, select the fields you want to display: b. c. Choose All, Selected (to display those you selected), or Available (to display all possible fields).
To change information about a field, click the Properties icon next to the field, enter the new information, then click Save. Click Save and Exit.
Grid Portlets
5. (Optional) Change the appearance of the grid portlet Note: Click Save on each page to save your changes. 6. (Optional) Change the access restrictions for the gird portlet. 7. Deploy the grid.
Filter Portlets
Filter Portlets
Filter portlets coordinate filtering operations across portlets in CA Clarity PPM. A filter portlet contains defined placeholder filter fields that are mapped to attributes in grid and graph portlets. When you configure and publish a filter portlet on a page with grid or graph portlets, CA Clarity PPM users can filter the page content across portlets using the portlet's fields. When a user clicks the filter portlet's Filter button, the following occurs: All portlets configured to work with the filter portlet are filtered using the filter portlet values. Filter portlet values appear in the filters of portlets on the page. The portlet attribute must be mapped to the filter portlet field for the value to display. A filter portlet can contain fields that do not display in all portlets. In this case, the affected portlets still filter on the filter portlets values, even if the values are not displayed.
Filter Portlets
You can configure a filter portlet to appear on a page in the following ways: Standalone filter section for a tabbed or non-tabbed page Toolbar section in a tabbed or non-tabbed page
Filter Precedence
The following table shows how filter precedence works when multiple filters are mapped to a filter portlet.
Result The filter portlet has precedence and determines the filter values for all portlet attributes mapped to filter portlet fields. The user sees the following behavior: Show All selected at the filter portlet level initiates a Show All behavior for all portlets mapped to the filter portlet. Any portlet attribute that is not mapped does not have its value overridden. Data that displays in an individual portlet is reset, and the result set that appears is determined by the filter criteria of the filter portlet combined with the portlets filter criteria of unmapped portlet attributes. Portlets that have no mapped attributes are not affected by the filter portlet.
The portlet filter has precedence. The user sees the following behavior: If a user clicks Show All on the portlet filter, all the filter records for the portlet appear. Portlet filter values always override the filter values of previously submitted filter portlet requests.
Filter Portlets
Filter Persistence
The following rules determine which filters values persist as filter criteria: If the scope of a filter portlet is page level, the filter portlet field values persist only within that page. If the scope is application level, the filter portlet used last has its field values persisted across pages. If multiple filter portlets are present on a page, the fields of the most recently used filter portlet are persisted. This is true for both page-level and application-level cases.
Filter Portlets
For a filter portlet to work, its fields must be mapped to the appropriate attributes in the portlets that provide content on the page. The following steps show how to configure a filter portlet for a page: 1. Create the filter portlet (see page 194). 2. Add fields to the filter portlet (see page 195). 3. Determine the field layout on the filter portlet (see page 208). 4. Select an existing portlet page or create a portlet page and add content (see page 209). 5. Add the filter portlet to the portlet page (see page 213) and map the filter portlet fields to the attributes of the portlets on the page.
Filter Portlets
Category Specifies the general area on which the portlet reports data. Description Defines the purpose of the portlet and provides any relevant information. Active Indicates the portlet is active and are visible to users. You can edit inactive portlets and activate them later. Default: Selected Instance Type Specifies the type of page the portlet can be placed on. If you select General, the portlet can be added to any CA Clarity PPM page. If you select an Object, the portlet can only be added to CA Clarity PPM pages associated with that Object. 5. Click Submit.
Filter Portlets
3. Click Fields from the content menu. The Filter Portlet: Fields page appears. 4. Click Add. The Filter Portlet: Field Properties page appears. 5. Complete the following fields: Field Name Defines the field name you want to appear in the filter portlet. Field ID Defines a unique alphanumeric identifier for the field. Description Defines the purpose of the field and provides any relevant information. Data Type Specifies the data type for the field. Select String. Display Type Specifies how the field is to be used by to the user. Possible values include: Browse, Text Entry, Numeric Range, Pull-Down, Date, or Date Range. Filter Default Specifies the value that appears in the filter field as the default value. If the filter portlet associated with this field is published to a dashboard as the filter default, this value will be applied to the portlet attributes mapped to this field. Width Defines the width of the field. If you leave the field blank, the field receives the default, which is 30 pixels. The default for date fields is 20 pixels. Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field.
Filter Portlets
Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 6. Click Submit.
Filter Portlets
Display Type Specifies how the field is to be used by to the user. Possible values include: Browse, Text Entry, Numeric Range, Pull-Down, Date, or Date Range. Select Text Entry if a number is to be typed into the field or Numeric Range for a range of numbers. Show as Percent Indicates if the value entered in the field should be shown as a percent. Select the check box to show the value as a percentage. Filter Default Specifies the value that appears in the filter field as the default value. If the filter portlet associated with this field is published to a dashboard as the filter default, this value will be applied to the portlet attributes mapped to this field. Width Defines the width of the field. If you leave the field blank, the field receives the default, which is 30 pixels. The default for date fields is 20 pixels. Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field. Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 6. Click Submit.
Filter Portlets
Filter Portlets
Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field. Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 6. Click Submit.
Filter Portlets
Field ID Defines a unique alphanumeric identifier for the field. Description Defines the purpose of the field and provides any relevant information. Data Type Specifies the data type for the field. Select Boolean. Display Type Specifies how the field is to be used by to the user. Possible values include: Browse, Text Entry, Numeric Range, Pull-Down, Date, or Date Range. Filter Default Specifies the value that appears in the filter field as the default value. If the filter portlet associated with this field is published to a dashboard as the filter default, this value will be applied to the portlet attributes mapped to this field. Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field. Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 6. Click Submit.
Filter Portlets
Filter Portlets
Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field. Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 6. Click Submit.
Filter Portlets
Field ID Defines a unique alphanumeric identifier for the field. Description Defines the purpose of the field and provides any relevant information. Data Type Specifies the data type for the field. Select Lookup or Multivalued Lookup. Display Type Specifies how the field is to be used by to the user. Possible values include: Browse, Text Entry, Numeric Range, Pull-Down, Date, or Date Range. Select Pull-Down or Browse. Lookup Specifies a list of lookup values that appears in the field for the user to choose from. The user views the list according to the display type selected. Click the Browse icon to select the lookup list. 6. Click Save. The fields on the page change to reflect the lookup you select and its data source (static or dynamic). Some of the fields listed in this section may not show on your page. Lookup Style Indicates how many items a user can select for the field when the lookup is executed. Entry (Static dependent lookup lists only). Defines the starting point for the data a user sees listed in the lookup field. Select a level in the Level field or click the Browse icon and select a parent lookup value. Exit (Static dependent lookup lists only). Defines the end point of the data a user sees listed in the lookup field. Filter Default Specifies the value that appears in the filter field as the default value. If the filter portlet associated with this field is published to a dashboard as the filter default, this value will be applied to the portlet attributes mapped to this field.
Filter Portlets
Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field. Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 7. If you selected a parameterized lookup in the Lookup field, complete the mappings in the Lookup Parameter Mappings section. This section is visible only for parameterized lookups. Note: See the Administration Guide for more information. 8. Click Submit.
Filter Portlets
Filter Portlets
Required in Filter Specifies that a value is required in the field when a filter request is executed. If you select this check box, you must enter a value in the Filter Default field. Hidden in Filter Specifies that the field does not display in the filter at runtime, but the default value of the field is included when a filter request is executed. Select the check box to hide the field in the filter. If you select this field, you must provide a value in the Default Filter field. Read-Only in Filter Specifies that the field displays with a default value that cannot be edited by a user. Select the check box to make the field read only in the filter. If you select this field, you must provide a value in the Default Filter field. Hint Provides a short message that helps a user use the field. Tooltip Provides a short message that displays when the user moves a cursor over the field. 4. Click Submit.
Filter Portlets
First determine if the new page will contain tabs and if users can change the new page or add their own tabs. Tabbed pages can provide a useful method to group several related pages under a menu item. You can control whether these pages can be personalized. CA Clarity PPM users can add portlets and create additional tabs. Once a user personalizes a page, those changes will not be effected by changes made in Studio (except the addition of required portlets). Note: To make sure that all users see the same page and any future changes, disable the Personalizable option.
Content Source Select a data source. Type Select a page template (to create a page with tabs, select a template that contains tabs). Description Describe the page. Template Defines the template. Values: Application Page Template. The template for CA Clarity PPM user pages. Admin Page Template. The template for Administration Tool pages. Popup Page Template. The template for popups.
4. Complete the following fields: Personalizable Specifies whether users are allowed to personalize the page. Layout Specifies the option that has the number of columns and column sizes that you want as the default for the portlet page. 5. Click Save and Continue. The Page: Properties page appears. 6. Complete the following field: Linkable (Optional) Specifies whether users are allowed to create links to the page. Select this check box. 7. Click Save and Continue. The Page: Link Parameters page appears.
8. Do the following: a. b. Click New to create a link. Complete the following fields: Parameter Name. Enter a name for the link. This is the name you and others will select when creating links to this page from an object or portlet. Parameter ID. Enter a unique ID for the link.
c. d.
9. To add content to the page, do the following: a. b. Click Add. Select the boxes next to the portlet content you want to add to the page and click Add.
10. Click Save and Continue. The Page: Filter page appears. To add a filter to the page, do the following: a. b. Click Add. Select the boxes next to the content filter you want to add to the page and click Add.
11. Click Save and Continue. The Page: Layout page appears. a. Complete the following field: Layout Specifies the column configuration. Values: Three Column 25-50-25. In this display, the Left column uses 25% of the available page space, the Center column uses 50% of the available space, and the Right column, 25%. Three Column 33-33-33. The three columns share the available page space equally. Two Column 50-50. The Left and Right columns share space equally; the Center column is eliminated. Two Column 66-34. The Left column uses 66% of the available page space, while the Right column uses 34%.
Row Layout. In this display, portlets on each row on a portlet page can be allotted either 33% of the width of the page (three portlets in the row), 50% (two portlets), or 100% (a single portlet). This is unlike other Layout options which apply the column selection to the entire page.
b. c.
Select the content from the left column, then click Move Content to move the content to the center or right columns. Position the content in the correct order in the columns by using the up and down arrows beside each column. Note: If Row Layout is selected, each row on the page can have different column widths. As portlets are moved between the columns, percentages of 33%, 50% or 100% are allotted to the portlets, depending on the number of items included in a single row in the layout columns. The following figure shows rows on a portlet page with a Layout option of Row Layout. The first row defined for the portlet page contains three portlets and each portlet is allotted 33 percent of the width of the page. The second row of the portlet page contains two portlets and each is allotted 50 percent of the width of the page. The remaining rows contain a single portlet and 100 percent of the page width is allocated in these instances.
d.
12. Control access to this portlet. 13. Add this page to a menu.
7. Click the icon next to the filter portlet name. The Page: Filter Content Mappings page appears. This page shows the filter portlet fields listed under each portlet on the page and allows you to map corresponding portlet fields.
8. In the Mapping Field drop-down, for each entry, select the portlet attribute that you want to map to the filter portlet field. The values that appear in the drop-down are filtered based on the data type of the filter portlet field being mapped. If you are mapping lookup attributes, the filter portlet field and the portlet attribute must have the same lookup ID. If a filter portlet field is not mapped to at least one portlet attribute on the page, the field does not display in the filter portlet. If a filter portlet does not have at least one field mapped, the filter portlet does not display on the page.
9. Select the Hide If Empty check box to hide the portlet if a value is not entered in the corresponding filter portlet field during a filter request. If you check the box for multiple attributes in a portlet, a blank corresponding filter portlet field for any of the attributes will cause the portlet not to appear. 10. Click Submit.
2. Click the name of the desired portlet or portlet page. 3. At Access to this Page, click the type of user you want to grant access rights to. Choose from: Resource (a user) Group (a group of users) OBS Unit (an OBS unit)
4. Click Add. 5. Select the rights you want to enable. Choose from the following: Portlet - View Allows users to view a portlet in CA Clarity PPM. Group Allows users to change and view the definition of a portlet (if the user has been granted the Studio Access right. Page - View Portlet Pages only. Allows users to view the page in CA Clarity PPM. Page Definition Editor Portlet Pages only. Allows users to edit, view, and delete the page definition (requires that the user have Studio Access rights). Page Definition Viewer Portlet Pages only. Allows users to view the page definition (requires that the user have Studio Access rights). 6. Click Next and see a list of resources, group or OBS units appear. Note: Click the + icon to expand an OBS unit to see child OBS units. 7. Check the box next to each user for whom you want to grant the access rights you selected in Select the rights you want to enable. Choose from:. 8. (OBS units only) For each OBS unit, select one of the following OBS association modes: Unit and ancestors, grants rights to the OBS unit and all of its parent OBS units.
Unit and descendants, grants rights to the OBS unit and all of its child OBS units. Unit, descendants, and ancestors, grants rights to the OBS unit and all of its parent and child OBS units. Unit only, grants rights to the OBS unit only, not to any parent or child.
9. Click Add.
Allow Label Configuration This option works in conjunction with the Allow Configuration option. If the Allow Configuration option is selected and the Allow Label Configuration option is cleared, field labels become unavailable for configuration while other items can still be configured. Specifically, this option determines whether the following items can be edited: List column fields List column field labels List filter fields List filter field properties (filter label field only) Graph options (metrics section for 1D bar, column, and line graphs) Graph filter fields Graph filter field properties (filter label field only)
5. Click Save.
To create an NSQL query 1. Click Queries from the CA Clarity Studio menu. The Queries page appears. 2. Click New. The Query Properties: General page appears. 3. Complete the following information: Query Name Enter a name for the query. Query ID Enter a unique ID for the query. Content Source Select the content source for the query from the drop-down list.
4. Click Save and Continue. The Query Properties: NSQL page appears. 5. In the NSQL text box, enter the following text and supply the appropriate values where indicated by brackets:
SELECT @SELECT:DIM:USER_DEF:IMPLIED:RESOURCE:I.ID:<alias name>@, @SELECT:DIM_PROP:USER_DEF:IMPLIED:RESOURCE:I. <database table name for attribute "id">:ID@, @SELECT:DIM_PROP:USER_DEF:IMPLIED:RESOURCE:I. <database table name for attribute "name">:NAME@ FROM <database table name> I WHERE @FILTER@
6. Click Save and Continue. The Query Properties: Attributes page appears. The listing of attributes for the query contains the alias name, the ID attribute, and the Name attribute. 7. Click Continue. The Query Properties: Configurable Actions page appears. 8. In the Action Source section, click the Browse icon and select the name of the data provider object for the query. The data provider must be a user-defined object. 9. In the Primary Key (Id:Type) section, select the alias name. Entering the alias name here allows identification of the instance in the portlet view in CA Clarity PPM so that the appropriate configurable action can be applied. 10. Click Save and Exit.
4. In the Action Layout section, select the actions you want available in the portlet and move them to the Selection Actions for Button Bar list box. Use the up and down arrows to put the actions into the proper order for display. 5. Click Save and Exit.
To delete a filter portlet 1. Click Portlets from the CA Clarity Studio menu. The Portlets page appears. 2. Check the box beside the name of the filter portlet you want to delete. 3. Click Delete.
Chapter 5: NSQL
Before you can create a portlet to extract and display data in CA Clarity PPM, you need to write a query that defines the data. The topics in this section discuss the CA Clarity PPM data model and its primary database tables, and how to build NSQL queries and lookups to extract data. This section contains the following topics: About NSQL Queries (see page 225) About Queries (see page 237) About Lookups (see page 240) Hierarchical Queries (see page 242) NSQL Troubleshooting and Tips (see page 243)
SELECT
The SELECT statement retrieves column data from tables. NSQL statements fail with an error message when a query statement does not start with SELECT.
FROM
The FROM clause is a standard SQL statement. It identifies the required tables and includes tables that contain the fields in the SELECT statement lists as well as any additional required tables.
Select @Select:DIM:USER_DEF:IMPLIED:PRJ:P.ID:ProjectID@, @Select:DIM_PROP:IMPLIED:PRJ:P.Name:ProjectName@ FROM SRM_PROJECTS P ------------------------------------------------------------Select @Select:DIM:USER_DEF:IMPLIED:PRJ:SRM_PROJECTS.ID:ProjectID@, @Select:DIM_PROP:IMPLIED:PRJ:SRM_Projects.Start:ProjectStart@, @Select:DIM:USER_DEF:IMPLIED:RES:R.Unique_Name:ResourceID@, @Select:DIM_PROP:IMPLIED:RES:R.Full_Name:ResourceName@ FROM SRM_PROJECTS, SRM_RESOURCES, PRTEAM
WHERE
The WHERE statement filters data returned by a query to be used on portlets. NSQL follows the same syntax with one exception, each WHERE statement must contain a @FILTER@ parameter.
Select @Select:DIM:USER_DEF:IMPLIED:PRJ:P.ID:ProjectID@, @Select:DIM_PROP:IMPLIED:PRJ:P.Name:ProjectName@ FROM SRM_PROJECTS P WHERE @FILTER@ AND P.Is_Active=1 ------------------------------------------------------------------------Select @ Select:DIM:USER_DEF:IMPLIED:PRJ:SRM_PROJECTS.ID:ProjectID@, @Select:DIM_PROP:IMPLIED:PRJ:SRM_Projects.Start:ProjectStart@, @ Select:DIM:USER_DEF:IMPLIED:RES:R.Unique_Name:ResourceID@, @Select:DIM_PROP:IMPLIED:RES:R.Full_Name:ResourceName@ FROM SRM_PROJECTS, SRM_RESOURCES, PRTEAM WHERE @FILTER@ AND SRM_PROJECTS.ID=PRTeam.prProjectID AND SRM_RESOURCES.ID=PRTeam.prResourceID
XPATH (XML Parameter) Constuct There is syntax construct that can be used in the WHERE clause that will allow a portlet to retrieve a name-value pair from the XML page URL where a user-defined portlet is placed. The construct is:
@where:param:xml:string:/data/id/@value@
The syntax construct is called an XPATH or XML Parameter construct. This construct can only be used on a specific portlet instance type, not the General portlet instance type. This construct expects the internal ID value to come from the URL that is displaying the page that contains the portlet. Therefore, the portlet must be created as a specific portlet instance type, such as the Project object portlet instance type to be placed on one of the pages from the project object. If you create and place a General portlet on a general page, there will not be a specific internal ID value in the URL that displays the page containing the portlet. Note: The construct must be entered in lowercased letters Example The following example shows how an NSQL query would use the XPATH construct. The example assumes a portlet is placed on the Project Dashboard. In the example, "id" is the name of the parameter that appears in the Project Dashboard that must be used for this particular query to filter the data.
SELECT @SELECT:DIM:USER_DEF:IMPLIED:PROJECT:P.ID:PID@, @SELECT:DIM_PROP:USER_DEF:IMPLIED:PROJECT:P.UNIQUE_NAME:PNAME@, @SELECT:METRIC:USER_DEF:IMPLIED:COUNT(*):TEAM_COUNT:AGG@ FROM SRM_PROJECTS P, PRTEAM T WHERE P.ID = @where:param:xml:string:/data/id/@value@ AND P.ID = T.PRPROJECTID AND @FILTER@ GROUP BY P.ID, P.UNIQUE_NAME HAVING @HAVING_FILTER@
When using this construct, be sure that you understand the name-value pair that you want to retrieve from the URL on the page where the portlet is placed. If you do not specify the correct named parameter, the portlet will not generate the expected result set.
NSQL Constructs
The constructs described in this section expand to become elements of an NSQL query based on the Datamart and CA Clarity PPM operational model.
OBS Dimensions
The following constructs simplify the OBS structure in NSQL: @SELECT:DIM:DATA_MART:OBS:PROJECT or RESOURCE[:<name>]@ The PROJECT or RESOURCE element specifies if the OBS dimensions are Project or Resource OBS assignments. This element is mandatory. This statement expands to one or more columns to be used in the SELECT list of the query, some of which comprise the OBS dimension and, potentially, some which are properties of the OBS dimension. @FROM:DIM:DATA_MART:OBS[:<name>]@ This expands to include one or more OBS tables needed in the query. These tables have aliases that start with the string OBS_, therefore other aliases in the query must not start with this string. @WHERE:DIM:DATA_MART:OBS:F[:<name>]@ This expands to include criteria to be used in the WHERE clause of the query. The element preceding F is optional, supplied by the application administrator, and is the table name or alias of the fact table used in the query. The NSQL engine can produce the correct string for joining with the OBS information in the fact table. @GROUP_BY:DIM:DATA_MART:OBS[:<name>]@ This expands to the same values of the @SELECT@ sibling but without any column aliases. This way it can be used in the GROUP BY clause of the query.
Security Joins
Some CA Clarity PPM entities enforce instance-level security for certain objects. To slice queries based on the security information of the user that executes the query, NSQL provides the following construct:
@WHERE:SECURITY:<entity type>:<entity id>]@
<entity id> is the query expression that represents the primary key of the entity. For example: SRM_PROJECTS.ID
For example:
@WHERE:SECURITY:PROJECT:SRM.PROJECTS.ID@
User-Defined Constructs
All parts of the SELECT clause must use special NSQL syntax and be specified with an NSQL @SELECT@ construct.
Data Types
The following data types are supported in NSQL, are valid only as part of the Dimension, Properties, and Metrics columns, and cannot be used as parameters: IMPLIED indicates there is no need to further qualify a data type whatever the database contains is used. This data type is allowed only in @SELECT@ constructs since this is the only location from which the NSQL engine can retrieve information about the data type. MONEY (<currency column>) specifies that the value is a monetary amount and that the currency is specified by the column alias in parenthesis. The currency must also be part of the SELECT statement. STRING specifies a basic string that cannot be manipulated. INTEGER FLOAT DATE
Dimensions
A dimension is a grouping of similar data elements from one or more tables. For example, Project may be one dimension and OBS or Tasks could be other dimensions. Dimensions are defined in the SELECT statement using specific syntax. First you define a key value for the dimension, then you can define the other data elements in the dimension. For example:
When defining dimensions: Each statement must begin and end with the @ character. Use IMPLIED if the data type does not need to be further quantified (than what can be derived from the database). <Dimension> is a user-defined name such as RES. <Table.Field> is the table or alias name a field provided by CA Clarity PPM. <label> is a user-defined name or the field that appears in the query. The dimension should be comprised of unique values. If not, portlets based on the query will not work as expected.
For example:
Select Select Select Select @Select:DIM:USER_DEF:IMPLIED:Project:SRM_PROJECTS.ID:ProjectID@ @Select:DIM:USER_DEF:IMPLIED:PRJ:P.ID:ProjectID@ @Select:DIM:USER_DEF:IMPLIED:MyDim:SRM_Projects.Name:ProjectName@ @Select:DIM:USER_DEF:IMPLIED:PRJ:SRM_PROJECTS.ID:ProjectID@ @Select:DIM:USER_DEF:IMPLIED:RES:R.Unique_Name:ResourceID@
The following statement defines the resource dimension as the full name of the resource:
SELECT @SELECT:DIM:USER_DEF:IMPLIED:RESOURCE:R.FULL_NAME:RSRC@
The following construct defines the resource dimension as the primary key of the resource table (SRM_RESOURCES). It is important that the dimension is comprised of unique values. If not, portlets based on the query will not work as expected.
R.ID is the actual column expression. RSRC_RD is the alias the column receives.
When defining the Dimension Properties column: Each statement begins and ends with the @ character. Use IMPLIED if the data type does not need to be further quantified (than what can be derived from the database). <Dimension> must be the same Dimension name as for the Dimension column <Table.Field> is the Table or Alias name and field from CA Clarity PPM. <label> is the user-defined name or the field that appears in the query.
@SELECT:DIM_PROP:USER_DEF:IMPLIED:<Dimension>:<Table.Field>:<label>@
SELECT
Using the sample dimension statement from above, we add the names of the resource and the Manager dimension properties, resulting in the following example:
SELECT @SELECT:DIM:USER_DEF:IMPLIED:RESOURCE:R.ID:RSRC_ID@, @SELECT:DIM_PROP:USER_DEF:IMPLIED:RESOURCE:R.FULL_NAME:RSRC@, @SELECT:DIM_PROP:USER_DEF:IMPLIED:RESOURCE:MR.FULL_NAME:MANAGER@
In the statement above, the unique name of the dimension is the same for the three columns. This tells the NSQL engine that the three columns belong together.
When defining metric columns: Each statement must begin and end with the @ character. The keyword <METRIC> must be present (do not use the dimension name since metrics cross dimensions). Use IMPLIED if the data type does not need to be further quantified (than what can be derived from the database). <Table.Field> is the table or alias name a field provided by CA Clarity PPM. <label> is a user-defined name or the field that appears in the query. Use agg to allow the metric to be totaled when used in a grid.
For example:
@Select:METRIC:USER_DEF:IMPLIED:NBI_PROJECT_CURRENT_FACTS.ACTUAL_HOURS:hrs:agg@ @Select:METRIC:USER_DEF:IMPLIED:PRASSIGNMENT.PRACTSUM/3600:Actuals:agg@, @Select:METRIC:USER_DEF:IMPLIED:PRASSIGNMENT.PRESTSUM/3600:ETC:agg@ @Select:METRIC:USER_DEF:IMPLIED:Count(*):Project_Count:agg@
Specifying a metrics column (or columns) is very similar to specifying a dimension. For example, to add the Project Count (the number of projects this resource has created) metric to the example above:
@SELECT:METRIC:USER_DEF:IMPLIED:COUNT(*):PROJECT_COUNT[:AGG]@
The last segment of the metric SELECT syntax is optional and determines if the column expression uses an aggregation function such as COUNT, AVG, SUM, or is a plain column expression. This is required for Metric Column filters. If the expression uses an aggregate function, the filter is part of the HAVING clause of the query. Otherwise, it becomes part of the WHERE clause. Adding this to the example presented above produces the following query:
SELECT R.ID RSRC_ID, R.FULL_NAME RSRC, MR.FULL_NAME MANAGER, COUNT(*) PROJECT_COUNT
Parameters
Parameters are substitution variables that you use in a query to pass values. Parameters only appear in the SELECT list and in the WHERE clause. There are two kinds of parameters. User-supplied parameters, which are used as filters in portlets and are either based on the query or are fixed when the portlet is created. User-supplied parameters are specified using the following syntax:
@SELECT:PARAM:USER_DEF:DATA_TYPE:PARAM_NAME[:ALIAS]@ or, @WHERE:PARAM:USER_DEF:DATA_TYPE:PARAM_NAME@
Where: DATA_TYPE is the data type for the parameter, and PARAM_NAME is the unique identifier for the parameter. Built-in parameters, which automatically take their values at run-time based on the current user settings or system context. Built-in parameters are specified using the following syntax:
@SELECT:PARAM:PARAM_IDENTIFIER[:ALIAS]@
or, @WHERE:PARAM:PARAM_IDENTIFIER@ Where: PARAM_IDENTIFIER is one of the following: USER_ID USER_NAME LANGUAGE LOCALE
Example
i.xdm_priority = prio.id and prio.language_code = @where:param:language@ and i.act_status = s.id and s.language_code = @where:param:language@ and i.xdm_impact = imp.id and imp.language_code = @where:param:language@ and i.xdm_issue_type = isstype.id and isstype.language_code = @where:param:language
OBS
Use the OBS construct with Datamart tables to limit to an OBS unit level. In the SELECT statement, you will specify if this is a Project or a Resource OBS. In the WHERE statement, you will specify the Datamart table. The syntax for OBS construct is:
@SELECT:DIM:DATA_MART:OBS:<Entity>@, @FROM:DIM:DATA_MART:OBS@ @WHERE:DIM:DATA_MART:OBS:<Datamart Table>@ @GROUP_BY:DIM:DATA_MART:OBS@ <Entity> must be set to either PROJECT or RESOURCE <Datamart Table> must be one of the datamart tables
Example
SELECT @SELECT:DIM:DATA_MART:OBS:PROJECT@, @SELECT:DIM:USER_DEF:IMPLIED:PROJECT:P.PROJECT_CODE:ProjID@, @select:metric:user_def:implied:Sum(P.ACTUAL_HOURS):Actuals:agg@, @select:metric:user_def:IMPLIED:Sum(P.ETC_Hours):ETC:agg@ FROM NBI_PROJECT_CURRENT_FACTS P, @FROM:DIM:DATA_MART:OBS@ WHERE @FILTER@ AND @WHERE:DIM:DATA_MART:OBS:P@ GROUP BY @GROUP_BY:DIM:DATA_MART:OBS@, P.Project_Code HAVING @HAVING_FILTER@
Calendar Time
Use the CALENDAR TIME construct with the following Datamart time tables to show hours or costs across a time scale: NBI_PM_PT_FACTS NBI_PM_PROJECT_TIME_SUMMARY NBI_RT_FACTS NBI_RESOURCE_TIME_SUMMARY
Fiscal Time
Use the FISCAL TIME construct when dealing with fiscal periods:
@SELECT:DIM:DATA_MART:FISCAL_TIME[:<name>]@ @FROM:DIM:DATA_MART:FISCAL_TIME[:<name>]@ @WHERE:DIM:DATA_MART:FISCAL_TIME:F[:<name>]@ @GROUP_BY:DIM:DATA_MART:FISCAL_TIME[:<name>]@
Security
Projects or resources appear only in a grid or graph when a user has sufficient access rights. Use SECURITY in the WHERE clause to verify the users access rights. The syntax for Security construct is:
@WHERE:SECURITY:<entity type>:<entity id>@
When defining a Security construct: Each statement begins and ends with the @ character. WHERE, must appear in the WHERE section of the NSQL. <entity type> is either PROJECT or RESOURCE. <entity id> is the project or resource ID (for example, SRM_PROJECTS.ID or NBI_PROJECT_CURRENT_FACTS.Project_ID).
About Queries
About Queries
Before you can create a portlet in CA Clarity PPM, you need to write a query to extract the data.
Create Queries
This section shows you how to create a simple query. Studio provides a variety of query templates to help you get started. Query templates are available for the following types of data: Collaboration Project Productivity Resource Business Intelligence Framework
Each of the query templates specifies typical data elements for that type of query. Once your query is created, you can use it to populate data in a portlet. Important! If an NSQL querys SELECT statement includes too many columns or aggregate functions at runtime, a system error occurs. The total amount of actual data for sorting (plus the aggregates) cannot be greater than the current database block size. Use the Query Properties: General page to create new queries. To create a new query 1. Select Queries from the CA Clarity Studio menu. The Queries page appears. 2. Click New. The Query Properties: General page appears. 3. Complete the following fields: Query Name Enter a name for the query.
About Queries
Available for User Portlets Specifies that users can use the query as a data provider for user portlets that will be used in personal dashboards. Query ID Enter a unique ID. Content Source Select a data source. Category Select the type of query you are creating. The choices that appear depend upon the categories set by your CA Clarity PPM administrator. Description Enter a description of the query. 4. Click Save and Continue. 5. Enter your NSQL into the query window. 6. Click Save and Continue. 7. Review the data to be included in the query and identify which of the columns can be filtered, which are required, and which can be used as lookups. Click Continue. 8. To define links to another table, click New and complete the following fields: Name Enter a name for the link. Link ID Enter a unique ID for the link. Description Enter a description. Action Select a link (or destination) for the link. Note: Links are predefined. 9. Enter a unique ID in the next field and click Submit.
About Queries
Change Queries
If the query has not yet been associated with an object, you can use the following procedure to change it. To change a query 1. Click Queries from the CA Clarity Studio menu. The Queries page appears. 2. Click the name of the query that you want to change. The Query Properties: General page appears. 3. Select NSQL from the content menu. The Query Properties: NSQL page appears. 4. Enter your changes. 5. Click Save.
Delete Queries
You can delete queries that are not yet associated with a portlet. To delete a query 1. Click Queries from the CA Clarity Studio menu. The Queries page appears. 2. Check the box next to the query that you want to delete. 3. Click Delete, then click Yes.
About Lookups
About Lookups
You can use NSQL to create lookups that dynamically filter portlet data. Rather than have a full-text field as a filter, you can create lookups as drop-down lists and browse lists to filter portlet data. There are three types of lookups: Static List, that consist of a standard set of choices. These are often used as drop-downs or browse lists for reports, user-defined fields, and user-defined XDM forms. Static Dependent Lists, that provide two or more choices. Use this type of lookup to create a hierarchy of lookups and values. Items that appear on the second and subsequent selection lists depend upon choices previously made by the user. For example, if the user selects USA from a country browse list, then a state list may appear from which the user can select an appropriate state. If the user selects Canada in the country browse list, a list of provinces appears in the second selection list. Dynamic Queries, which fetch data from the CA Clarity PPM database in realtime to populate the drop-down or browse lists. These lookups provide the most up-to-date values possible.
The following example shows a dynamic query that returns a list of resources and filters out all resources with a null user_id value. The result set will contain resources with a user account to sign in to the application.
SELECT @SELECT:r.user_id:user_id@, @SELECT:r.unique_name:unique_name@, @SELECT:r.first_name:first_name@, @SELECT:r.last_name:last_name@, @SELECT:r.full_name:full_name@ FROM srm_resources r WHERE r.user_id IS NOT NULL AND @FILTER@
About Lookups
Hierarchical Queries
Hierarchical Queries
A hierarchical query is used to display values in a hierarchical grid portlet. A hierarchical query is written using the same NSQL syntax as a regular query, and all NSQL constructs are available for a hierarchical query. The following items are specific for hierarchical queries: A dimension property with a code of "hg_has_children." The property can be of any data type but is usually number or string. It must be a unique value for all rows in the dimension (or it can be NULL). A value at runtime for this property signifies that the row has children and the row in the grid will have the [+] icon rendered. A NULL value means the row does not have children. A parameter with a code of "hg_row_id." The parameters data type must match that of hg_has_children. This parameter means "the current row." When a user clicks on the expand icon in the grid, the id of the expanded row is passed into the query as this parameter. The value passed in is the same value that was previously returned as hg_has_children. The following rules must be followed when using this parameter: When hg_row_id is null, you return only the top-level rows in the hierarchy. When hg_row_id has a value, you return only the "child" rows for that rowimmediate children only, no grandchildren, great grandchildren, and so on.
Use the following tips to ensure NSQL successful queries: When you create queries for use with pie charts and funnel charts, make sure that the metric does not contain negative values by filtering all values greater than zero. NSQL adds SQL constructs to the end of the statement for automated filtering and other statements. This can create problems when you use UNION in NSQL. As a workaround, use the @SELECT@ in the outer select of an inline view that encapsulates the UNION statement.
Index
A
access 37 access, restricting 217 activating objects, event enabling 36 add-ins applying 90 described 90 admin page template 210 application page template 210 attributes about the object attribute 79 deleting 85 description 68 parameters 67 audit trail 87 auto-numbering creating schemes 80 deactivating 84 modifying schemes 83 using with partitions 79
D
dashboards, user 160 data providers 167 data types adding attributes to 40 supported in CA Clarity PPM 40 date fields adding to objects 56 displaying 56 display mappings 128 displaying 178
F
field data types 38 attachments 38 boolean 38 dates 38 dynamic queries 38 formulas 38 large strings 38 lookups 38 money 38 multi-valued lookups 38 numbers 38 static dependent lists 38 strings 38 time-varying 38 field values displaying as color or icon 131 highlighting range of 131 fields changing appearance 128 changing labels 130 changing properties 128 for column or bar graphs 138 representing number fields 43 filter portlets adding 224 adding Boolean fields 201 adding date fields 203 adding lookup fields 204 adding money fields 200 adding number fields 198 adding string fields 196
B
boolean fields 52
C
calculated attributes building the calculation 74 creating 72 example 76 functions 69 testing 78 colors displaying boolean fields as icons 52 displaying formula fields in 47 displaying money fields in 50 displaying number fields in 43 configurable user actions basic steps for adding 221 description 220 NSQL query for 221 selecting for grid portlet 223 core tables npt.filterPortletProperties 195 currency codes 50
Index 245
adding URL fields 207 basic setup steps 195 creating 195 deleting 224 descriptions 192 layout 209 persistence 194 precedence 193 scope 194 viewing 208 fiscal time 236 formula fields, adding 47
I
icons displaying boolean fields as 52 displaying formula fields as 47 displaying money fields as 50 image fields 124 individuals, access to 37 interactive portlet parameters creating 166 interactive portlets about 164 associating with objects 166 creating 164
G
Gantt fields, adding 124 graph portlets appearance 167, 172, 180 changing 180 creating 170 data display 167, 178, 180 deleting 167, 180 dimensions 169 graph types 169 graphs bar 169 bubble 169 column 169 funnel 169 line 169 metrics 169 pie 169 grid portlets access rights 184 changing 184, 191 comparison 184 considerations 184, 185, 186 creating 186 deleting 184, 191 layout 184, 188, 191 mouseover text 188 using 184 variance 184 guidelines 172
L
legends, graph portlets 172 links 121 list column 91 list column views adding fields 94 adding image fields 124 adding to 126 highlighting in 94 modifying 134 multiple-time varying 98 setting up in 94 sorting in 91, 99 list filter views modifying 137 setting up in 92 lookups about 240 displaying fields 58 partitioned 20 static list 38
M
markers, adding legends 172 master objects, designating 36 menus changing 141 creating links 141 money fields, displaying 50 mouseover 124 multi-valued lookup fields, displaying 61
H
hierarchies (Studio) 29 HTML portlets about 181 changing 181, 182
N
NSQL calendar time 235, 236 constructs 228, 229, 230 data types 230 DATE 230 defining the metrics column 229, 233 dimensions 229, 231 fiscal time 236 FLOAT statement 230 FROM statement 226 GROUP BY command 228 HAVING command 228 IMPLIED 230 INTEGER 230 MONEY 230 OBS construct 235 OBS dimensions 228, 229 parameters 234 queries 225 SELECT command 225 SQL 225 STRING 230 syntax 225 troubleshooting 243 WHERE statement 227 number fields, adding 43
O
objects adding fields to 40 applying partition models to 26 child 29 copy enabling 36 creating new 36 deleting 89 described 29 granting access to 37 process overview 29 resetting views 110
partitions adding to partitions 25 basic guidelines 22 creating and using 22 hierarchies 19 hierarchies and partitions 29 how they work 18 parent 23, 24 partitioned data providers 20 relationship to object views 20 using 17 pop-up page template 210 portlet pages adding to 214 creating 210 deleting 216 portlets deploying content 191, 210, 223 graphs 167 hierarchical grid 185 portlet pages 217 publishing 216 restricting access 191, 216 restricting portlet configuration 218 types 151 portlets and pages, accessing 216 portlets, user 160 power filters 92 PowerMods, configuration 29 progress bar fields 127 properties views about 91 adding to object views 92 fields 132
Q
queries changing 237, 239 deleting 239 described 237
P
partition models about 19 adding partitions to 24 adding to 23 creating 22 partitioned data providers 20
S
scatter graphs 169 secondary values 94 sections adding 141 changing 143 deleting 144 moving 144
Index 247
selecting UI theme 23 static lookups partitions 20 user-defined 20 stock icons 147 stock objects baseline 35 string fields adding large 41 adding to objects 41 Studio 15 subobjects 36 subpages about 121 about the Display Condition Builder 105 adding 102 System Partition 18 system types booking status list 35 investments 35 key tasks 35 organizer tasks 35 portfolios 35
U
user dashboard 160 user portlet 160 user-defined fields creating 40 maximum allowed number 40 user-defined objects 29
V
views described 91 list filter 91 publishing 107 virtual fields 94
W
weighted average 47 word wrapping bar graphs 138 column graphs 138 enabling 138