Content Object Reference

This section contains the following topics:

About Content Objects

CA Clarity provides a collection of portlets, reports, queries, and pages designed to enhance project portfolio management. This content is available out of the box with CA Clarity. The content includes a set of sample data designed for test environments. This appendix provides information on the objects for the content included with CA Clarity.

For more information, see the Project Management User Guide.

Business Alignment

Use the CustomObjectInstances base XOG object to view inbound and outbound Business Alignment instances. Business Alignment instances are created for existing projects and proposals. The CustomObjectInstances service is an entry point to enable XOG communication with instances of custom objects. Instances represent data held within custom objects, not the definition of the objects.

Schema Name

The following schema files are part of this XOG object:

A CustomObjectInstances read request requires the namespace nikuxog_read.xsd and then the <CustomObjectInstanceQuery> element.
The write CustomObjectInstances request services are defined by the nikuxog_customObjectInstance.xsd schema.

Read and Write XML Files

The following XML files are included:

custom_object_instances_read.xml. Use this file to export business alignment instances from CA Clarity.
custom_object_instances_write.xml. Use this file to import business alignment instances that were previously exported from CA Clarity.

Prerequisites

The referred instances should exist in CA Clarity before using this XOG.

Business Rules and Processing

The following business rules and processing apply to this XOG object:

Project or proposal parent instance must exist.
Existing business alignment instances are not deleted.

Read Filters

The CustomObjectInstanceQuery element allows you to filter on instances of one or more custom objects using the following filter attributes:

objectCode: Refers to the custom object ID as defined in Studio.
instanceCode: Refers to the custom object instance ID as defined in Studio.

Error Handling

The following errors can be thrown:

Project does not exist in the system - Invalid parent object instance project code for object project while importing instance instance code for object cbi_biz_alignment.
Invalid Lookup value

Corporate Objectives

Use the CustomObjectInstances base XOG object to view inbound and outbound Corporate Objectives instances. The CustomObjectInstances service is an entry point to enable XOG communication with instances of custom objects. Instances represent data held within custom objects, not the definition of the objects.

Schema Name

The following schema files are part of this XOG object:

A CustomObjectInstances read request requires the namespace nikuxog_read.xsd and then the <CustomObjectInstanceQuery> element.
The write CustomObjectInstances request services are defined by the nikuxog_customObjectInstance.xsd schema.

Read and Write XML Files

The following XML files are included:

custom_object_instances_read.xml. Use this file to export corporate objectives instances from CA Clarity.
custom_object_instances_write.xml. Use this file to import corporate objectives instances that were previously exported from CA Clarity.

Prerequisites

None.

Business Rules and Processing

The following business rules and processing apply to this XOG object:

Existing corporate objectives instances are not deleted.

Read Filters

The CustomObjectInstanceQuery element allows you to filter on instances of one or more custom objects using the following filter attributes:

objectCode

Refers to the custom object ID as defined in Studio. The object id is cbi_corp_objectives.

instanceCode: Refers to the custom object instance ID as defined in Studio.

Error Handling

The following errors can be thrown:

Invalid Lookup value

Documents

Use the CustomObjectInstances base XOG object to view inbound and outbound documents instances. Documents instances are created for existing projects and proposals. The CustomObjectInstances service is an entry point to enable XOG communication with instances of custom objects. Instances represent data held within custom objects, not the definition of the objects.

Schema Name

The following schema files are part of this XOG object:

A CustomObjectInstances read request requires the namespace nikuxog_read.xsd and then the <CustomObjectInstanceQuery> element.
The write CustomObjectInstances request services are defined by the nikuxog_customObjectInstance.xsd schema.

Read and Write XML Files

The following XML files are included:

custom_object_instances_read.xml. Use this file to export documents instances from CA Clarity.
custom_object_instances_write.xml. Use this file to import documents instances previously exported from CA Clarity.

Prerequisites

The referred instances should exist in CA Clarity before using this XOG.

Business Rules and Processing

The following business rules and processing apply to this XOG object:

Project or proposal parent instance must exist.
Existing document instances are not deleted.

Read Filters

The CustomObjectInstanceQuery element allows you to filter on instances of one or more custom objects using the following filter attributes:

objectCode: Refers to the custom object ID as defined in Studio.
instanceCode: Refers to the custom object instance ID as defined in Studio.

Error Handling

The following errors can be thrown:

Project does not exist in the system - Invalid parent object instance project code for object project while importing instance instance code for object cbi_documents.
Invalid Lookup value

Status Updates

Use the CustomObjectInstances base XOG object to view inbound and outbound Status Update instances. Status Updates instances are created for existing projects and proposals. The CustomObjectInstances service is an entry point to enable XOG communication with instances of custom objects. Instances represent data held within custom objects, not the definition of the objects.

Schema Name

The following schema files are part of this XOG object:

A CustomObjectInstances read request requires the namespace nikuxog_read.xsd and then the <CustomObjectInstanceQuery> element.
The write CustomObjectInstances request services are defined by the nikuxog_customObjectInstance.xsd schema.

Read and Write XML Files

The following XML files are included:

custom_object_instances_read.xml. Use this file to export status updates instances from CA Clarity.
custom_object_instances_write.xml Use this file to import status updates instances that were previously exported from CA Clarity.

Prerequisites

The referred instances should exist in CA Clarity before using this XOG.

Business Rules and Processing

The following business rules and processing apply to this XOG object:

Project or proposal parent instance must exist.
Existing status updates instances are not deleted.

Read Filters

The CustomObjectInstanceQuery element allows you to filter on instances of one or more custom objects using the following filter attributes:

objectCode: Refers to the custom object ID as defined in Studio.
instanceCode: Refers to the custom object instance ID as defined in Studio.

Error Handling

The following errors can be thrown:

Project does not exist in the system - Invalid parent object instance project code for object project while importing instance instance code for object cbi_status_report.
Invalid Lookup value