CA Clarity Project & Portfolio Manager

(1)

Studio Developer's Guide

v12.0.0

(2)

"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.

(3)

Contact Technical Support

For your convenience, CA provides one site where you can access the

information you need for your Home Office, Small Business, and Enterprise CA 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 product documentation, you can send a message to techpubs@ca.com.

If you would like to provide feedback about CA product documentation,

complete our short customer survey, which is also available on the CA Support website, found at http://ca.com/docs.

(4)

(5)

Contents 5

Chapter 1: About Studio

11

Studio Features and Benefits ... 11

Key Features and Benefits ... 12

How to Get Started with Studio ... 14

The Studio Process Overview ... 14

About Data Providers ... 16

Important Studio Terms ... 17

Chapter 2: Partitions

19

Partitions Overview ... 19

The Benefits of Using Partitions ... 19

How Partitioning Works ... 20

About Partition Models ... 21

Partitions and Object Views ... 22

Portlets and Partitioned Data Providers ... 22

Access Rights and Partitions ... 23

How to Work with Partitions ... 24

How to Create and Use Partitions ... 24

Create Partition Models ... 25

Add a Partition to a Partition Model ... 26

Add Many Partitions to a Partition Model (Quick Create) ... 27

Add Members (Resources) to a Partition ... 28

Select a Partition‘s UI Theme ... 29

Apply a Partition Model to an Object ... 29

Chapter 3: Configuring CA Clarity PPM (PowerMods)

31

About Objects ... 32

Process Overview: Working with Objects ... 34

Data Providers... 34

Objects Data Provider ... 35

System Types Data Provider ... 40

Create Objects ... 41

Grant Access to Objects ... 42

Object Attributes ... 43

Attribute Data Types ... 43

(6)

6 Studio Developer's Guide

Calculated Attributes ... 73

Autonumber Object Attributes ... 84

Modify Object Attributes ... 89

Delete Object Attributes ... 90

How to Audit Objects... 92

Delete Objects ... 94

About Add-Ins ... 95

Apply Add-Ins ... 95

Views ... 96

Add User-Defined Fields to Views ... 96

Create Subpages for the Properties View ... 107

Publish Changes to List and Filter Views ... 113

Restore Defaults for an Object's View ... 115

Restore Defaults for Selected Views ... 115

How to Display Multiple Subpages on a Tab... 116

Define and Manage a Custom Property View ... 116

Display Custom Subpage Links on a Tab Using the Custom Property View... 120

Links for Pages and Subpages ... 122

Link from an Object Page to a Subpage... 123

Link from an Object Attribute to a Web Page ... 123

Link to Properties Pages from External Applications ... 125

Add Image Fields to List Column Views ... 126

Add Gantt Chart Fields to List Column Views ... 126

Add Image Link Fields to List Column Views... 128

Add Progress Bar Fields to List Column Views ... 129

Change Field Properties ... 130

How to Change a Field's Appearance ... 132

Change Field Labels ... 133

Display a Range of Values as a Color or Icon ... 133

Change the Appearance of Properties View Attributes... 134

Change the Appearance of List Column View Fields ... 136

Change the Appearance of List Filter View Fields ... 139

Display Fields as Bar or Column Graphs ... 141

Menus, Sections, and Links ... 144

Add Menu Items or Links ... 144

Change Sections and Links ... 145

Move Sections and Links... 146

Delete Sections or Links ... 147

Icons ... 147

(7)

Contents 7

Chapter 4: Portlets: Grids, Graphs, Pages, and Menus

151

Portlet Overview ... 152

Types of Access Rights ... 152

Stock Portlets ... 155

Graph Portlets ... 161

Data Providers ... 161

Graph Portlet Types ... 162

Create Graph Portlets ... 164

Determine Graph Portlet Appearance ... 166

Determine Graph Portlet Data to Display ... 171

Change Graph Portlets ... 173

Delete Graph Portlets ... 173

Grid Portlets ... 174

Access Rights and Grid Portlets ... 174

Grid Portlet Aggregation, Comparison, and Variance Options ... 174

Hierarchical Grid Portlets ... 175

Things to Consider When Creating Grid Portlets ... 175

Create Grid Portlets ... 176

Determine the Layout of Grid Portlets ... 178

Change Grid Portlets ... 180

Delete Grid Portlets ... 181

HTML Text Portlets ... 181

Create HTML Portlets ... 182

Change HTML Portlets ... 183

Delete HTML Portlets ... 184

Filter Portlets ... 185

Filter Precedence... 186

Scope of Filter Portlets ... 187

Filter Persistence... 187

How to Set Up Filter Portlets ... 188

Create Filter Portlets ... 188

Field Data Types for Adding to Filter Portlets ... 189

View the List of Portlet Pages for Filter Portlets ... 201

Determine the Layout of Fields on Filter Portlets ... 201

Portlet Pages: Deploying Content ... 202

Create Portlet Pages ... 203

Add Filter Portlets to Portlet Pages ... 206

Delete Portlet Pages... 208

Publish Changes to Portlets ... 209

Access to Portlets and Pages ... 209

Restrict Access to Portlets or Pages ... 210

(8)

Configurable User Actions ... 213

Delete Filter Portlets ... 217

Chapter 5: UI Themes

219

Select UI Themes ... 220

Create Custom UI Themes... 221

Change the CA Clarity PPM Login Image ... 224

Change the Application Logo Image ... 224

Change the Background Tiling Image ... 225

Change Tab and Section Styles ... 226

Customize Graphs ... 228

Customize the Column Header in the Calendar ... 231

Distribute Custom Themes to Servers in the Cluster... 231

Register New Themes ... 232

Chapter 6: NSQL

233

About NSQL Queries ... 233

The NSQL Syntax ... 233

NSQL Constructs ... 236

User-Defined Constructs ... 238

Advanced NSQL Constructs ... 242

About Queries ... 244

Create Queries ... 245

Change Queries ... 246

Delete Queries ... 247

About Lookups... 247

Browse-only Construct for Dynamic Query Lookups ... 248

Hierarchical Queries... 249

Filtering in Hierarchical Queries ... 249

NSQL Troubleshooting and Tips ... 250

Chapter 7: CA Clarity PPM Tables

251

Introduction ... 251

Table Prefixes ... 251

The Core CA Clarity PPM Tables ... 252

Project Tables ... 253

Resource Tables ... 254

Time Slice Tables ... 254

Link Time Slice Tables ... 255

Link Time Slice Queries to PRAssignment ... 256

(9)

Contents 9

Timesheet Reporting Considerations... 257

Adjustment Timesheets ... 257

The Datamart Tables ... 258

XDM Forms Tables ... 258

Index

259

(10)

(11)

Chapter 1: About Studio 11

Chapter 1: About Studio

This section contains the following topics:

Studio Features and Benefits (see page 11)

How to Get Started with Studio (see page 14)

Important Studio Terms (see page 17)

Studio Features and Benefits

Studio is the interface to the PowerMods™ framework that you can use to configure CA Clarity PPM. Use Studio to tailor your CA Clarity PPM system and deploy local configurations and personalized user interfaces. With Studio, organizations and individuals can create a work environment that delivers information in meaningful ways.

Studio‘s point-and-click configuration empowers you to create and deploy portals, dashboards, menus, and business objects that adapt to your business process—not the other way around. Users can personalize their dashboards by choosing which portlets to show or hide and where to show them on a page. Studio:

■ Delivers real-time information to the users who need it most.

■ Allows you to personalize individual user environments with user-defined content and graphics.

■ Reduces training requirements and speeds new user adoption by offering tailored menus, and pages and views that use familiar language and processes.

■ Allows you to tailor portfolio, project, resource, and idea business objects without specialized programming skills using PowerMods.

■ Provides partitions that facilitate local management with global governance while supporting multiple local configurations in a single application

instance.

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.

(12)

Key Features and Benefits

The following key features and benefits are available to you using Studio.

Features Benefits

User-defined portlets 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 construction

Delivers over 40 stock and an unlimited number of user-defined portlets that display graphs, tables, and HTML content. These portlets reflect the user‘s access rights and filter settings and allow them to access and drill into information in a single, consolidated view.

Multiple display types Displays graphical information in grids or bar, bubble, column, funnel, line, pie, and scatter graphs.

Drill-down graphs Allows administrators to define links that provide users access to underlying data and specific instances of objects.

Data filters Filter data on any number of predefined, configurable parameters.

Precision Security™ 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. Partitions 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.

User-defined objects Add new business objects to CA Clarity PPM and then configure them with fields, forms, processes, and portlets.

Attachments Allows users to provide document and other types of attachments for any standard or user-defined

(13)

Features Benefits

business object. Centralized field

control

Simplifies administration by centralizing the

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).

User interface configuration

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. New dashboard page

development

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.

Menu manager Reduces training and support costs by organizing the CA Clarity PPM menu navigation to match the company‘s terms and processes.

View All During object creation, you can enable a feature to allow all instances of this object and its subobjects on one properties page.

Third-level object hierarchy

Create a hierarchy of up to three levels of user-defined objects that inherit properties from higher level objects.

Large string attribute Create string objects of any length (subject to limitations of your database).

Export to XML Export objects in XML format.

Add-Ins Apply add-ins to import a collection of content (pages, portlets, queries, project templates, roles, etc.) as a single entity.

Configurable action items

Configure and add your own status attributes to action items.

(14)

How to Get Started with Studio

To use Studio, you should have the following:

■ The Studio module installed and have a valid license for it.

■ Some knowledge of SQL to set up and manage the data you will use in Studio.

■ Studio access rights (available only with a valid Studio license). Access to Studio is controlled via standard access in the Administration Tool and can be granted for the three components of Studio: menus, pages, and portlets.

Note: To get started with Studio, launch the CA Clarity PPM Administration Tool and click the links from the Studio menu.

The Studio Process Overview

This following is a high-level overview of the process you will use to configure CA Clarity PPM.

Step 1: (Optional) Create Partitions to Control What Users See and Do

With partitions, organizational units can implement and see CA Clarity PPM (pages, processes, user interface themes) in different ways. Partitions allow you to deploy and support different fields, forms, processes, methodologies, and branding but also to control content access rights within your organization. The System Partition is the default partition. If you do not create new

(15)

Chapter 1: About Studio 15 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.

(16)

Step 2: Configure the Interface with User-Defined Objects

Configure and extend business objects to do the following:

■ Create pages with a mix of standard and user-defined fields.

■ Specify validation rules or default values.

■ Create list views with filters and sorts.

■ Create hyperlinks between objects.

Step 3: Create Portlets, Pages, and Menu Items

Facilitate impromptu user reports by creating portlets that contain graphs, tables, best practices, and documents—all of which are updated and available in real-time without the need to execute and review reports. Once created, a portlet‘s presentation is easily manipulated using point-and-click configuration settings available to administrators and users.

With portlets, users can do the following:

■ Show information in bar, bubble, column, funnel, line, pie, or scatter graphs.

■ Use Gantt graph and progress bars to visually communicate schedules, progress, and phase gate status for items such as project tasks, program durations, and asset and application lifecycles.

■ Leverage out-of-the-box histograms to track resource utilization.

■ Build scorecards by segmenting continuous data into groups and applying status icons such as red-yellow-green stoplights, approved/unapproved checkmarks, and leading/steady/trailing performance indicators.

■ Create simple or complex filters to view just the information that is important.

■ Provide real-time drill-down links from portlet content to business objects such as portfolio investments, resources, projects, and ideas.

About Data Providers

Studio portlets access information from data providers (objects, queries, and system types). If you choose to use queries to provide data, you will use NSQL to create them. CA Clarity PPM‘s data model supports most of the business objects you need. You can also create constructs that meet your unique business needs.

(17)

Important Studio Terms

The following terms are used throughout this book.

Term Definition

Access rights 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 object‘s pages.

Data provider The source of data used by Studio portlets. Data providers can be objects, queries, and system types. Dimension 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. Lookup Drop-down lists or browse lists that filter portlet data. Menu A navigational element of the user interface that

provides links to other pages in the application.

Metrics A value in a dataset, such as booked hours, capacity, or number of tasks that can be measured.

NSQL An extension of the SQL language that is used to query data in the CA Clarity PPM database.

Object 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.

OBS 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. Partition Partitions are local configurations of CA Clarity PPM that

may have their own forms, fields, processes, branding, and security rules.

Portlet A section of a page that is displayed in CA Clarity PPM. Portlets can take the form of lists and graphs among other types.

(18)

Term Definition

from a database.

Resource 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.

System Partition This is the default partition that exists in each CA Clarity PPM enterprise installation. Any partitions you create become children to this partition.

User 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.

Views An object‘s view determines how information displays on a page.

Virtual column Columns whose data is not computed when the query is created (i.e. the data is created in realtime).

Virtual field 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.

(19)

Chapter 2: Partitions 19

Chapter 2: Partitions

Partitions Overview (see page 19)

How Partitioning Works (see page 20)

How to Work with Partitions (see page 24)

How to Create and Use Partitions (see page 24)

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.

The Benefits of Using Partitions

With partitions, you can create local configurations of CA Clarity PPM that have their own forms, fields, processes, branding, and security rules.

For example, a corporation can consolidate all regional resource, budget, and program data into a single, global view. A corporation can design and deploy corporate processes, and provide a clear set of parameters to local

organizations for corporate-wide processes. At the local level—which can be geographically-based, organizationally-based or a mixture of both—information can be disseminated to meet local requirements.

You can govern globally by defining fields at the top of your organizational hierarchy and then make them required for every object instance throughout CA Clarity PPM.

Manage locally by deploying fields directly to child (descendant) partitions so that only child partitions must supply values for a field.

(20)

How Partitioning Works

A default System Partition exists in each CA Clarity PPM enterprise installation. Any partitions you create become children to the System Partition. You can also create partitions within partitions.

You can set up partitions by department, geography, industry, division, by legal structures or any other method that makes sense for your organization. For example, the first level of partitions in a partition model may be

geographical while the second level and subsequent levels may be divisional partitions.

See the following example where United States and European partitions have been created to display information that is relevant for each country‘s

operations. CA Clarity PPM pages in each of these partitions may appear differently to reflect the language and operational differences for each location. Within the United States and European operations, each has a marketing organization that has its own partition to reflect the specific needs of those organizations. The company also has an IT division that uses the default System Partition to see the total company view.

You can partition the following:

■ Object user-defined attributes (fields)

■ Object views (Properties, List Column, and List Filter)

■ Object links

■ Lookup values

■ User interface (UI) themes

■ Portlet and process data providers (NSQL queries cannot be partitioned)

■ Programs (a list of projects)

Note: Reports and Jobs cannot be partitioned, but you can control access to them using access rights.

(21)

Chapter 2: Partitions 21 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.

About Partition Models

Partition models organize partitions into a hierarchical model. When you create partitions, you will use this hierarchical model to assign user-defined attributes at any level and make them available (or required) at lower level partitions. This is how you drive governance from the highest level in an organization to lower levels. It also makes partition administration easier by allowing

lower-level objects to automatically inherit partitioned items.

Partition models are similar to Organizational Breakdown Structures (OBS) except the following:

■ OBSs are often used to control security and drive reporting, while

■ Partition models control how objects are managed in CA Clarity PPM. Partition models support resource memberships that are based upon groups or OBS units and thus are a way of grouping resources. 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.

(22)

Partitions and Object Views

Object views determine how information displays in CA Clarity PPM. There are three types of views:

■ Properties views, which display and allow users to enter information about an object,

■ List Column views, which display instances of an object in rows and columns, and

■ List Filter views, which help users search for information.

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.

Portlets and Partitioned Data Providers

CA Clarity PPM portlets and processes retrieve their data from data providers which can be NSQL queries, objects, or system types. Data providers, objects, portlets and processes can be associated with a partition.

To create a portlet that uses a partitioned data provider, you will create partition-specific fields for the object and then build a portlet for the object in the partition.

You can partition static lookup values to associate them with a specific partition. Users of a partitioned lookup see different values depending on the partition to which an object instance belongs.

(23)

Chapter 2: Partitions 23 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 unit‘s 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.

Access Rights and Partitions

CA Clarity PPM access rights determine what a user can see and functions the user can perform. Your CA Clarity PPM administrator can grant access rights to users (resources), groups, OBS units, or globally to all users. Partitioning affects what objects are exposed to users. Therefore, partitioning and access rights work together.

If a user has access rights to an instance of a partitioned object, that user can see partitioned views of that instance—even if the user is not a member of the partition to which the object instance belongs.

Partitioning affects your ability to do the following:

■ Create partitioned fields

■ Change the layout and appearance of fields for partitioned objects

■ Assign an object instance to a partition

■ Select a UI (user interface) theme

■ Select a default partition

■ Switch partition views

■ See and personalize partitioned List Column and List Filter views

(24)

How to Work with Partitions

The following list provides an overview of the partitioning process:

1. Plan your partitioning implementation on paper so that you can carefully consider the impact to users.

Note: Once you create partition models, you cannot delete them, you can only deactivate them. Please plan your partition scheme carefully.

2. Set up a partition model.

3. Select an existing object to use or create a new object.

4. Add fields to the object, assign them to a partition, and select a partition association mode.

5. Configure the views for each partition. 6. (Optional) Add partition-specific object links.

7. (Optional) Create new UI themes and associate them with your partitions. 8. (Optional) Create partitioned lookup values.

9. (Optional) Create portlets based on partitioned objects. 10.(Optional) Create processes.

Note: You do not need to restart CA Clarity PPM to enable partitioning — all partitioning configuration changes are immediately available. You can also transfer partition models and other items created in connection with partitioning from CA Clarity PPM using the XML Open Gateway (XOG).

How to Create and Use Partitions

The basic guidelines for working with partition models are as follows:

■ Once you set up a partition you cannot move it, not even within the same level.

■ You cannot delete partition models—you can only deactivate them.

■ You can set up more than one partition model within CA Clarity PPM.

■ An object can only be assigned to one partition model.

Note: To work with partition models, you will need Studio - Access, Partition - Administrator and preferably System Partition - Administrator access rights.

(25)

Create Partition Models

To create a partition model

1. Select Partition Models from the CA Clarity Studio menu. The Partition Models page appears.

2. Click New.

3. Complete the following fields: Partition Model Name

Enter the partition model name. ID

Enter a unique ID for the partition model.

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.

Description

Enter a brief description of the partition model. 4. Click Submit.

(26)

Add a Partition to a Partition Model

Note: Before you perform this procedure, make sure you have already created a partition model.

To add a partition to a partition model

1. Click Partition Models from the CA Clarity Studio menu. The Partition Models page appears.

2. Click the name of the partition model to which you want to add a partition. 3. Click the Partitions tab.

4. Click New.

5. At Partition Name, enter a name for the partition. 6. At Partition ID, enter a unique ID for this partition.

7. At Description, enter a brief description of the partition. 8. At UI Theme, select a color scheme to use for the partition.

9. If you are not adding the partition to the System Partition, at Parent Partition click the Browse icon, select a (parent) partition, then click Add. 10.Click Submit.

11.(Optional) Repeat step 4 through step 10 add more partitions.

Note: You can authorize resources (users) or groups to be members of this partition.

(27)

Add Many Partitions to a Partition Model (Quick Create)

Use Quick Create to create up to five partitions at once.

To add many partitions to a partition model

1. Click Partition Models from the CA Clarity Studio menu. The Partition Models page appears.

2. Click the name of the partition model you want to use. 3. Click the Partitions tab.

4. Click Quick Create.

5. At Partition Name, enter a name for the partition. 6. At Partition ID, enter a unique ID for this partition.

7. At Description, enter a brief description of the partition.

8. If you are adding the partition to something other than the System

Partition, at Parent Partition click Browse and select that (parent) partition, then click Add.

Note: You will not be able to select a parent partition if you haven‘t saved the parent partition yet.

9. Click Submit.

(28)

Add Members (Resources) to a Partition

To add a member to a partition

1. If you just created the partition and have the Partition Properties page displaying, go to add an individual user (resource). If not, open the Administration Tool, and then select Partition Models from the CA Clarity Studio menu.

The Partition Models page appears.

2. Click the name of the partition model to which you want to add members. 3. Click the Partitions tab.

4. If you do not see the partition you want, click the + icon at the left of the ancestor partition to see child partitions.

5. In the row that contains the partition you want to use, click the Properties icon.

6. To add an individual user (resource): a. Click Resources.

b. Click Add.

c. Select the resource you want to add or at User Name enter the resource‘s name, and then click Filter.

d. Check the box next to the resource name, and then click Add. e. Repeat this step to add more resources to the partition. 7. Click Exit.

(29)

Select a Partition’s UI Theme

You can create a distinctive theme, including color and logo, for users who are members of a partition. Partitions that do not have a designated UI theme setting inherit the UI theme of its closest ancestor partition that does have a UI theme. A user who is not a member of any partition always sees the UI theme of the System Partition.

To select a UI theme for a partition

1. Select Partition Models from the CA Clarity Studio menu. The Partition Models page appears.

2. Click the name of the partition model you want to use. 3. Click the Full View tab.

4. Click the name of the partition to which you want to assign a UI Theme. 5. At UI Theme, select the theme.

6. Click Save and Exit.

Apply a Partition Model to an Object

If you want to apply a partition model to a user-defined object, first create that object.

Note: To perform the procedures in this section you must have Administration - Studio access rights. See the CA Clarity PPM Administration Guide for details. You do not have to be a member of a partition to perform this task.

To apply a partition model 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 apply a partition model. The Object Definition: Properties page appears.

3. At Partition Model, click the Browse icon, select a partition, and then click Add.

(30)

(31)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 31

Chapter 3: Configuring CA Clarity PPM

(PowerMods)

About Objects (see page 32)

Process Overview: Working with Objects (see page 34)

Data Providers (see page 34)

Create Objects (see page 41)

Grant Access to Objects (see page 42)

Object Attributes (see page 43)

How to Audit Objects (see page 92)

Delete Objects (see page 94)

About Add-Ins (see page 95)

Apply Add-Ins (see page 95)

Views (see page 96)

How to Display Multiple Subpages on a Tab (see page 116)

Links for Pages and Subpages (see page 122)

Add Image Fields to List Column Views (see page 126)

Change Field Properties (see page 130)

How to Change a Field's Appearance (see page 132)

Menus, Sections, and Links (see page 144)

Icons (see page 147)

(32)

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.

(33)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 33 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.

(34)

Process Overview: Working with Objects

As you work with objects:

■ Decide if you will use an existing object, or create a new one.

■ Decide if you want to enable the Copy feature to allow objects to be copied. If you select the Copy Enabled check box when you create an object, a user has the ability to copy the attributes of one instance of the object when creating a new instance. The Copy From button appears for the user in CA Clarity PPM only if you select the Copy Enabled check box.

■ Decide if you want to enable the Export feature to allow the object to be exported in XML format.

■ Decide if you want to enable the View All feature that allows the object and all of its subobjects to display on the View All Page Properties page.

■ Define attributes (fields) that display on the object's pages.

■ You can also create portlets that are like mini-reports which display information as graphs, grids, or HTML pages.

■ Create links from the object to other pages.

■ Define a view that determines how information appears with the object.

■ Change how fields appear. For example you can change a field's color or label. You can also use icons to represent data, link to other pages, or downloadable documents. You can also display bar or Gantt charts in a List Column Views.

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 objects—and any objects you create—contain fields that you can use to access database information.

(35)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 35 System

System types are data providers for the restricted portlets. You can use these data providers in addition to stock CA Clarity PPM objects.

System Type Description

Booking Status List Used with the Team object to list data about requests for project resources or roles.

Investments This provides combined data for investment types (Projects, Assets, Applications, Products, and Other Investment).

Key Tasks This is a subset of the Task object and contains data about key tasks.

Organizer Tasks This provides data about the tasks a resource is assigned to.

Portfolios This contains portfolio data.

Programs This contains data about programs and the projects which belong to a program.

Project Team Members This contains data about resources assigned to projects.

Project Team Selection This contains data about resources assigned to projects.

Resource's Projects List This lists data about projects that a resource is assigned to.

Objects Data Provider

The stock objects and any objects you create contain attributes (fields) that you can configure and use to access CA Clarity PPM information. For any object, only the attributes that are listed on the Object Definition: Attributes

page display on its pages.

Note: Object functionality is not available for timesheets, financial transactions, budgets, and forecasts.

Action Item

Action items are the units of work, or tasks, that you assign to members of a project, or to yourself. Action items allow you to track the progress of investments, and ensure that the investment is complete and on time. CA Clarity PPM supports the following action items: personal, project, and process. All action items can be viewed from the Action Item area of the Organizer.

(36)

Applications

See Other Investment object. Asset

See Other Investment object. Assignment

Assignments describe how a staff member will work on a task including the start and finish time and dates, the actual and remaining work, and status. Baseline

The baseline object contains a subset of project objects' fields and is a snapshot of a project over time.

Benefit Plan Detail

This object describes benefit plan information used to enter proposed returns on an investment.

Benefit Plan

This object contains benefit plan information used for the Benefit Plan list page.

Change Requests

This object describes the criteria by which change requests are evaluated and approved. This is a subobject of the Project object.

Constraint

This object stores project management task start and finish 'hints' to scheduling. This is a subobject of the Task object.

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

(37)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 37 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.

(38)

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.

(39)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 39 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.

(40)

40 Studio Developer's Guide 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

This is a subobject of the Project object.

System Types Data Provider

System types are data providers that are not based on a specific CA Clarity PPM object. The following table describes each system type.

System Type Data Provider - Type Descriptions

Type Description

Baseline The baseline object contains a subset of project objects' fields and is a snapshot of a project over time. Booking Status List Used with the Team object to list data about requests

for project resources or roles.

Investments This provides combined data for investment types (Projects, Assets, Applications, Products, and Other Investment).

Key Tasks This is a subset of the Task object and contains data about key tasks.

Organizer Tasks This provides data about the tasks a resource is assigned to.

Portfolios This contains portfolio data.

Programs This contains data about programs and the projects which belong to a program.

Project Team Members

This contains data about resources assigned to projects.

Project Team Selection

This contains data about resources assigned to projects.

(41)

Type Description

Resource's Projects List

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

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

(42)

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.

Grant Access to Objects

Use this procedure to grant access to an object for users, groups, or OBS units.

Organizational breakdown structures (OBS) controls access, department hierarchies, and reporting. If at least one OBS exists for an object, users can associate those OBS's to their object instance.

To grant access to objects

1. If you just created the object and have the Object Properties page displayed, go to To grant rights to:. If not, open the Administration Tool, and click Objects from the CA Clarity Studio menu.

The Objects page appears.

2. Click the name of the object you want to use. 3. To grant rights to:

■ individuals, under Access to this Object, click Resource.

■ groups, under Access to this Object, click Group.

■ OBS Units, under Access to this Object, click OBS Unit. 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.

(43)

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.

Attribute Data Types

There are several procedures for creating attributes (fields). The procedure you use will depend upon the attribute's data type. See a description of available data types in the following table and the page on which the procedure for creating that type of attribute is located.

CA Clarity PPM supports 11 attribute data types and each one has unique information that determines how the attribute is used and displays. Note: Virtual attributes are not listed in the table because they do not

represent actual data in the database. URL (link attributes) also do not appear because they are simply links to other pages.

Data Type Description

String A text field that contains up to 2000 characters. Large String 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.

Number A field that contains numbers that can be used in calculations.

Formula 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.

Money A field that contains currency.

Boolean A field that indicates one of two exclusive states:

■ ―on‖ or ―off‖

■ ―true‖ or ―false‖

■ ―yes‖ or ―no‖

■ ―0‖ or ―1‖

(44)

Data Type Description

Date A field that contains a date.

Lookup 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.

Sample uses include:

■ 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.

Attachment A field that contains a document attachment (such as a Word document).

Time-varying 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.

(45)

How to Add Attributes to Objects

CA Clarity PPM comes with stock attributes that you can use. These are listed on the Object Definition: Attributes page in Studio. If you use a stock attribute, you will not be able to change the attribute's general information (i.e. name, ID, description, data type, lookup), but you can change how the attribute appears.

When you create user-defined attributes:

■ Make sure your attributes meet the needs of your users. Once you create an attribute, you cannot remove it from the object - you can only

deactivate it so that it does not display.

■ Create only the attributes you need. You can add up to 1,000 user-defined attributes to an object, however attributes can increase the amount of time it takes to display pages, so don't create more than you need. 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.

(46)

46 Studio Developer's Guide Add String Fields to Objects

Use this procedure to add a string (text) field. You can also use this procedure to create large string fields whose size are limited only by the constraints of your database. You should also consider the following limitations when using the large string field data type:

■ Large string fields do not display in Lister Filter Views.

■ You cannot sort large string fields.

Use the Object Attribute page to add string fields to objects. To add a string field to an object

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.

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

(47)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 47 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.

(48)

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.

Add Number Fields to Objects

Use this procedure to add a number data type attribute to an object. To add a number field to an object

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

Enter the name of the new field. Attribute ID

Enter a unique ID for the field.

(49)

Chapter 3: Configuring CA Clarity PPM (PowerMods) 49 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.