XOG Object Reference

You can process the following data objects or transactions using the XOG:
ccppmop144
You can process the following data objects or transactions using the XOG:
2
Click a XOG object in the table of contents to the left and read a description and other important information about each XOG object.
Base XOG Objects
The following table describes the base XOG objects:
Object or Transaction
In (Write)
Out (Read)
Scope
Master System
Process
Yes
Yes
  • Multiple actions
  • Step-level escalations
  • Multiple objects
  • Sub-processes
Clarity Project and Portfolio Management (PPM)
Content Pack
Yes
Yes
The transactions include the following items:
  • Read and write the filter portlet type with its fields.
  • Read and write page and tab level metadata concerning filter portlet instance properties.
  • Read and write page and tab level metadata concerning grid or graph portlet filter mappings.
Clarity Project and Portfolio Management (PPM)
customObjectInstance
Yes
Yes
Custom object instance
None
group
Yes
Yes
Groups
None
User
Yes
Yes
  • Basic User Properties
  • OBS association fields
Enterprise systems
Location
Yes
Yes
  • Location properties
  • Association with departments
Clarity Project and Portfolio Management (PPM)
Resource
Yes
Yes
  • Basic and non-labor resources properties
  • Basic management properties
  • Financial properties
  • Resource contact properties
Enterprise systems
Stock XOG Object Summary
The following table describes the product stock XOG object summary:
Object or Transaction
In (Write)
Out (Read)
Scope
Master System
Benefit Plan
Yes
Yes
Financial benefit plans
Accounting systems
Budget Plan
Yes
Yes
Financial budget plans
Accounting systems
Capacity Planning Scenario
Yes
Yes
Public or private scenarios
Scenarios that contain an arbitrary number of project members or expression members with an arbitrary number of terms
Enterprise systems
Cost plan
Yes
Yes
Financial cost plans
Accounting systems
Department
Yes
Yes
Department properties
Clarity Project and Portfolio Management (PPM)
Entity
Yes
Yes
Basic entity properties
Clarity Project and Portfolio Management (PPM)
Financial Transaction
Yes
Yes
Financial Transactions
Accounting systems
General Ledger Account
Yes
Yes
GL Accounts
Accounting systems
General Ledger Allocation Rule
Yes
Yes
  • Standard GL allocation rules and credit rules
  • Investment-specific GL allocation debit rules
Accounting systems
General Ledger Period
Yes
No
GL periods
Enterprise
General Ledger Transaction
No
Yes
GL transactions
Accounting systems
Inbound Transaction
Yes
Yes
Financial transactions
None
Investment
None
None
Import and export of investment objects (for example, asset, application, project, and so on).
Clarity Project and Portfolio Management (PPM)
Invoices
Yes (status)
Yes
Invoices
Enterprise systems
Non-Project investment
Yes
Yes
Includes non-project investment objects such as assets, applications, products, and so on.
None
Outbound Transaction
No
Yes
Exports financial transactions from other systems
None
Portfolio
Yes
No
Import and export portfolios
None
Project
Yes
Yes
Project schema:
  • Export project data including tasks, assignments, custom fields, management and financial properties, OBS association fields
  • Import basic properties, tasks, assignments, management properties, financial properties, custom fields, and OBS association fields
  • Participants import
ERP system
Timesheet system
Oracle Financials
Accounting system
Requisition
Yes
Yes
Import/export requisitions
None
Role
Yes
Yes
  • Basic role information
  • Non-labor roles
Enterprise systems
Skill
Yes
Yes
Skills hierarchy
None
Type Code
Yes
Yes
Typecodes
None
Enable a Custom Object or Attribute for Data Warehouse
Using XOG, you can enable or disable only a custom object or attribute for the Data Warehouse. The Boolean dwEnabled attribute is added for both the custom object and custom attribute to include and exclude them from the Data Warehouse. To enable the object or attribute for the Data Warehouse, set the dwEnabled attribute to true. To disable the object or attribute, set the dwEnabled attribute to false.
Example
<object code="customobject" dwEnabled="true" … > <customAttribute code="customattribute" dwEnabled="true"...>
 
The following rules apply when you enable or disable an object or an attribute for the data warehouse using XOG. You can:
  • Enable or disable custom objects or custom attributes.
  • Enable a custom attribute only when its associated object is enabled.
  • Enable a custom subobject only when its parent or master object is enabled.
  • Disable a master object only when all its subobjects are disabled.
    Note:
    To disable a master object, disable all its subobjects by marking them as dwEnabled="false" in the same XOG file.
When these rules are not met, warning messages appear in the XOG output file.
Nested OBS Units in XOG Files
Pay special attention when performing OBS import operations using the XOG. If you are changing the level of one or more OBS units, maintain all the existing child units in your XML. If you skip a unit, the depth for the missed unit can change in unexpected ways.
Create and move OBS units together. Incomplete XML structure for the root unit you move can also move child units.
Example:
You specify the following OBS structure for unit 1:
/unit1 .. /unit11 .... /unit111 /unit2 .. /unit22 /unit3 .. /unit33 .... /unit333 ...... /unit3333
You want to move unit3 one level lower by making it a child of unit2. In the same operation, you want to add a child unit 3333x under unit333. You specify the following XML for this XOG import:
/unit2 .. /unit22 .. /unit3 .... /unit33 ...... /unit333 ........ /unit3333 ........ /unit3333x
 
You might exclude /unit3333 because it is not changing.
Why include it in my XML if it is not changing?
If you forget to include a child unit, your import indirectly changes. For example, without /unit3333, the original level of /unit3333 changes because you changed the level of /unit3. To avoid unexpected results, include the full unit hierarchy in the XML file.
XOG Custom Content Objects
The XOG CustomObjectInstances service is an entry point to enable XOG communication with instances of custom objects. Instances represent data in custom objects, not the definition of the objects. A collection of content objects (portlets, reports, queries, and pages) enhance project and portfolio management. This content includes sample data that is designed for test environments. The following content objects are included with 
Clarity Project and Portfolio Management (PPM)
:
3
3
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. 
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 
    Clarity Project and Portfolio Management (PPM)
    .
  • custom_object_instances_write.xml. Use this file to import business alignment instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Prerequisites
Before you use this XOG object, the referred instances should exist in 
Clarity Project and Portfolio Management (PPM)
.
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. 
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 
    Clarity Project and Portfolio Management (PPM)
    .
  • custom_object_instances_write.xml. Use this file to import corporate objectives instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
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 error 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.
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 
    Clarity Project and Portfolio Management (PPM)
    .
  • custom_object_instances_write.xml. Use this file to import documents instances previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Prerequisites
Before you use this XOG object, the referred instances should exist in 
Clarity Project and Portfolio Management (PPM)
.
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.
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 
    Clarity Project and Portfolio Management (PPM)
    .
  • custom_object_instances_write.xml Use this file to import status updates instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Prerequisites
Before you use this XOG object, the referred instances should exist in 
Clarity Project and Portfolio Management (PPM)
.
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