XOG Object Reference

Stock XOG Object Summary

You can process the following data objects or transactions using the XOG.

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	CA Clarity PPM
Content Pack	Yes	Yes	The transactions include: 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.	CA Clarity 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	CA Clarity PPM
Resource	Yes	Yes	Basic and non-labor resources properties Basic management properties Financial properties Resource contact properties	Enterprise systems

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	CA Clarity
Entity	Yes	Yes	Basic entity properties	CA Clarity
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	Used for import and export of investment objects (for example, asset, application, project, and so on).	CA Clarity
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
outboundTransaction	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 and participant group 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

Application

Use the application XOG object to view inbound and outbound application object instances.

Schema Name

nikuxog_application.xsd

Read and Write XML Files

The following XML files are included:

inv_applications_read.xml. Use this file to export application object instances from applications_write.xml. Use this file to import application object instances that were previously exported from CA Clarity.

Prerequisites

The prerequisites (if any) are the same as that of other non-project investment objects (NPIO).

Business Rules and Processing

The business rules and processing are the same as that of other NPIOs.

Read Filters

The read filters are the same as that of other NPIOs.

Error Handling

The error handling is the same as that of other NPIOs.

Asset

Use the asset XOG object to view inbound and outbound asset object instances.

Schema Name

nikuxog_asset.xsd

Read and Write XML Files

The following XML files are included:

inv_assets_read.xml. Use this file to export asset object instances from CA Clarity.
inv_assets_write.xml. Use this file to import asset object instances that were previously exported from CA Clarity.

Prerequisites

The prerequisites (if any) are the same as that of other non-project investment objects (NPIO).

Business Rules and Processing

The business rules and processing are the same as that of other NPIOs.

Read Filters

The read filters are the same as that of other NPIOs.

Error Handling

The error handling is the same as that of other NPIOs.

Benefit Plan

Use the benefit plan XOG object to view inbound and outbound financial benefit plans. Benefit plans are created for existing investments.

Schema Name

nikuxog_benefitPlan.xsd

Read and Write XML Files

The following XML files are included:

benefitPlan_read.xml. Use this file to export financial benefit plans from CA Clarity.
benefitPlan_write.xml. Use this file to import financial benefit plans that were previously exported from CA Clarity.

Prerequisites

Before using this XOG object, make sure the following objects exist in CA Clarity:

Investments
Entity
Time periods

Business Rules and Processing

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

A Benefit Plan object is created by setting up the benefit plan default properties.
Plan details (line items) are added to the benefit plan.
Existing plan detail records are not deleted.

Read Filters

The following explicit read filters are used:

code: The code for the benefit plan.
name: The name of the benefit plan.
investmentCode: The investment code with which the plan is associated.

Error Handling

The following errors can be thrown:

You must have plan XOG access rights to perform this action.
Plan code is required.
Investment code is missing or invalid.
Period type cannot be changed once defined.
Investment must be associated to an entity before setting up financial plans.
Period date is missing or invalid.
Finish time period is invalid.
Start time period is invalid.
Cannot modify plan periods prior to the freeze date.
Valid fiscal period does not exist for start and end dates for plan detail.

Schema Mapping

Mappings for the following schema tag names are provided:

BenefitPlan Schema Tag

The BenefitPlan tag is part of the schema mapping for the benefit plan XOG object. It has the following attributes:

Code

Required. Defines the unique code of the benefit plan.

Table and Column: CODE

Type: String

FinishPeriod

Required. Defines the finish time period name.

Table and Column: END_PERIOD_ID

Type: String

Investment Code

Required. Defines the Investment code.

Table and Column: OBJECT_ID

Type: String

Investment Type

Required. Defines the investment type.

Table and Column: OBJECT_CODE

Type: String

Name

Required. Defines the benefit plan name.

Table and Column: NAME

Type: String

Period Type

Defines the time period type (for example, monthly).

Table and Column: PERIOD_TYPE_CODE

Type: String

Revision

Used only in XOG read result. Represents the revision of the budget plan.

Table and Column: REVISION

Type: Integer

StartPeriod

Required. Defines the start time period name.

Table and Column: START_PERIOD_ID

Type: String

Description Schema Tag

This schema tag is part of the schema mapping for the Benefit Plan XOG object. This schema tag is a text node.

The following attribute is included in the schema tag:

Description

Defines the benefit plan description.

Table and Column: description

Type: String

Detail Schema Tag

The detail tag is part of the schema mapping for the benefit plan XOG object. This tag defines a benefit plan detail row and is composed primarily of schema tags.

The Detail schema tag includes the following schema tags

Benefit

Defines the benefit for the specific time period segments.

Table and Column: BENEFIT

ActualBenefit

Defines the actual benefit for the specific time period segments.

Table and Column: ACTUAL_BENEFIT

Custom Information

Defines the field names for the custom information.

The Detail schema tag includes the following attribute:

detailName

Required. Defines the name of the benefit plan detail row.

Table and Column: DETAIL

Type: String

Segment Schema Tag

This tag is part of the schema mapping for the Benefit Plan XOG object. The Benefit and ActualBenefit tags can include one or more segments. This tag has the following attributes:

start

Defines the start period for the benefit or actual benefit.

Type: String

finish

Defines the end period for the benefit or actual benefit.

Type: String

value

Defines the value for the benefit or actual benefit.

Type: String

Budget Plan

Use the budget plan XOG object to view inbound and outbound budget plans. A budget plan is created for an existing investment. The structure of a budget plan must meet the following criteria:

When the forceReplace value is true, the budget plan must match the associated source cost plan.
When the Replace value is false, the budget plan must match the associated source cost plan and the latest approved budget. If there is no latest approved budget, the structure must match the current cost plan of record.

Schema Name

nikuxog_budgetPlan.xsd

Read and Write XML Files

The following XML files are included:

budgetPlan_read.xml. Use this file to export budget plans from CA Clarity.
budgetPlan_write.xml. Use this file to import budget plans that were previously exported from CA Clarity.

Prerequisites

Before using this XOG object, make sure the following objects exist in CA Clarity:

Investments
Entity
Time periods
Details used in the plan

Business Rules and Processing

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

A budget plan uses the Cost Plan object internally.
The budget plan structure must match the cost plan of record structure and potentially the latest approved budget plan structure, depending on the value of the forceReplace attribute.
Cost plan details (line items) are added to the budget plan.
Existing plan detail records are not deleted.

Read Filters

The following explicit read filters are used:

code. The code of the budget plan.
name. The name of the budget plan.
investmentCode. The investment code with which the plan is associated.

Error Handling

The following error messages can be thrown:

You must have Budget Plan - XOG Access Rights to perform this action.
Plan code is required.
Grouping attribute is missing or invalid.
Investment code is missing or invalid.
Period type cannot be changed once defined.
Grouping attributes cannot be changed once defined.
Investment must be associated to an entity before setting up financial plans.
Benefit plan ID is missing or invalid.
Period date is missing or invalid.
Grouping attributes in plan details do not match plan grouping attributes.
GL account is missing or invalid.
Missing or invalid value for grouping attribute.
Finish time period is invalid.
Start time period is invalid.
Grouping attributes do not match locked plan structure for associated entity.
Cannot modify plan periods prior to the freeze date.
Valid fiscal period does not exist for start and end dates for plan detail.
Submit for Approval requires a cost plan of record.
A submitted budget already exists.
You cannot submit a plan for approval whose total cost is zero.
The structure of the existing budget and the cost plan of record do not match.

Schema Mapping

Mappings for the following schema tag names are provided:

BudgetPlan Schema Tag

The budgetPlan tag is part of the schema mapping for the Budget Plan XOG object. This tag has the following attributes:

benefitPlanCode

Defines the ID of the benefit plan that is associated with the budget plan.

Table and Column: BENEFIT_PLAN_ID

Type: String

code

Required. Defines the unique code of the cost plan.

Table and Column: CODE

Type: String

finishPeriod

Required. Defines the finish time period name.

Table and Column: END_PERIOD_ID

Type: String

forceReplace

Required. Specifies whether the existing budget structure and period types can be different from the latest approved budget plan. XOG out always uses the value of True.

Field: forceReplace

Type: Boolean

Possible Values: True, False

investmentCode

Required. Defines the Investment code

Table and Column: OBJECT_ID

Type: String

investmentType

Defines the investment type. This attribute is used only in the XOG read result.

Type: String

name

Defines the budget plan name

Table and Column: NAME

Type: String

revision

Used only in XOG read results. Represents the revision of the budget plan.

Field Name: REVISION

Type: Integer

periodType

Defines the time period type.

Field Name: PERIOD_TYPE_CODE

Type: String

sourceCostPlanCode

Defines the ID of the source cost plan for the submitted budget.

Table and Column: SOURCE_COST_PLAN_ID

Type: String

startPeriod

Required. Defines the start time period name.

Field Name: START_PERIOD_ID

Type: String

status

Defines the status of the plan.

Possible Values: Submitted, Approved, Rejected.

Table and Column: STATUS_CODE

Type: String

Description Schema Tag

This schema tag is part of the schema mapping for the Budget Plan XOG object. This is a text node. The schema tag includes the following attribute.

Description

Defines the Budget Plan description.

Table and Column: description

Type: String

Grouping Attributes Schema Tag

This tag is part of the schema mapping for the Budget Plan XOG object. This tag is used to define grouping attributes for a budget plan. The grouping attributes for a budget plan must match the grouping attributes of the cost plan of record for the investment.

Grouping Attribute

Defines a grouping of attributes for a budget plan.

Possible Values:

charge_code_id

role_id

resource_id

department_id

location_id

transaction_class_id

resource_class_id

input_type_code_id

lov1_id

lov2_id

Table and Column: The value is stored in ODF_MULTI_VALUED_ATTRIBUTES table.

Type: String

Detail Schema Tag

This tag is part of the schema mapping for the Budget Plan XOG object. This tag defines a budget plan detail row and is composed primarily of schema tags.

Note: The Detail schema tag also has two attributes: glAccountMain and glAccountSub. These attributes define the GL Account associated with the Detail schema tag. The attributes map to the GL_ACCOUNT_ID column.

The Detail schema tag includes the following tags:

Cost

Defines the cost for specific time period segments.

Table and Column: COST

Units

Defines the quantity for a specific time period segment.

Table and Column:UNITS

Revenue

Defines the revenue for a specific time period segment.

Table and Column: REVENUE

Grouping Attributes

Defines the grouping attribute codes and values for the grouping attributes selected for the cost plan. Each grouping attribute represents a code and value pair for an attribute.

Table and Column: The value is stored in the column corresponding to the groupingAttribute code (for example, location_id, charge_code_id).

Type: String

Custom Information

Defines the field names for the custom information.

Segment Schema Tag

This tag is part of the schema mapping for the Budget Plan XOG object. The Unit, Cost, and Revenue schema tags will include one or more Segment schema tags. This tag has the following attributes:

start

Defines the start period for the unit, cost, or revenue.

Type: String

finish

Defines the end period for the unit, cost, or revenue.

Type: String

value

Defines the value for the unit, cost, or revenue.

Type: String

Capacity Planning Scenario

Use the Capacity Planning Scenario XOG object to view inbound and outbound capacity planning scenario attributes. Scenarios are defined for inbound (write) and outbound (read) processing.

Schema Name

nikuxog_capplanScenario.xsd

Read and Write XML Files

The following XML files are included:

caplan_scenarios_read.xml. Use this file to export capacity planning scenarios from CA Clarity.
caplan_scenarios_write.xml. Use this file to import capacity planning scenarios that were previously exported from CA Clarity.

Prerequisites

The following conditions must be met before importing capacity planning scenarios:

The scenario must be created by you.
Some of the fields that a scenario can include are objects that must already exist in CA Clarity in order to be imported. These include projects identified by SRM_PROJECTS.UNIQUE_NAME.
If CA Clarity is built using XOG imports, charge codes and projects must be imported before importing capacity planning scenarios.
The maximum number of OBS levels you can XOG is 10.

Read Filters

The XOG processes outbound capacity planning schemas based on the following field:

ownerID: The ID of a valid user (CMN_SEC_USERS.ID).

Error Handling

The following fields are written to the Success and Error files when the XOG process generates an error or warning:

ID. For all errors, the scenario ID is posted to the Success and Error files.
Name. For all errors, the scenario name is posted to the Success and Error files.

Schema Mappings

Mappings for the following schema tag names are provided.

Scenario
Segment

Scenario Schema Tag

This tag is part of the schema mapping for the capacity planning scenario XOG object and is composed of the Member element.

The Scenario schema tag has the following attributes:

name

Required. Defines the scenario name. This does not have to be unique.

Table and Column: CAP_SCENARIOS.NAME

Type: String

ownerUserName

Required. Defines the user who owns the scenario. The user_id is found in the CMN_SEC_USERS table.

Table and Column: CAP_SCENARIOS.USER_ID

Type: Number

description

Describes the scenario.

Table and Column: CAP_SCENARIOS.DESCRIPTION

Type: String

budgetBenefit

Contains the scenario (that is, what-if) value for benefit amount.

Table and Column: CAP_SCENARIOS.BDGT_CST_TOTAL

Type: Number

budgetCost

Contains the scenario (that is, what-if) amount for budget cost.

Table and Column: CAP_SCENARIOS.BDGT_REV_TOTAL

Type: Number

isPublic

Currently not used.

Table and Column: :CAP_SCENARIOS.IS_PUBLIC

Type: Number

Member Element

The Member is the sub-element of the Scenario schema tag. It is composed of the following elements:

Expression. A power filter expression that determines which investments to include.
Investment. A specific instance of an investment to include in the scenario.

The member element has the following attributes:

investmentType

Required. Defines the type of investment.

Table and Column: CAP_SCENARIO_MEMBERS.MEMBER_TYPE

Type: String

isExcluded

Required. Indicates if the member is excluded or not considered in this scenario.

Values:

1. True
0. False

Table and Column: CAP_SCENARIO_MEMBERS.IS_EXCLUDED

Type: Boolean.

isActive

Required. Indicates if the member is included in the scenario or hidden.

Values:

1. True
0. False

Table and Column: CAP_SCENARIO_MEMBERS.IS_ACTIVE

Type: Boolean

isApproved

Required. Indicates if the member is considered approved in this scenario.

Values:

1. True
0. False

Table and Column: CAP_SCENARIO_MEMBERS.IS_APPROVED

Type: Boolean

priority

Required. Defines the priority.

Values: 0-36, where:

0. Highest priority
36. Lowest priority

Table and Column: CAP_SCENARIO_MEMBERS.PRIORITY

Type: Integer

lastSynchDate

Required. Defines the last time an expression was synchronized against the pool of available investments.

Table and Column: CAP_SCENARIO_MEMBERS.LAST_SYNC_DATE

Type: Date

Expression Element

This is the sub-element of the Member element. The Expression element has the following attribute:

Expression

Required. Defines the text view of the ODF-based power filter.

Table and Column: ODF_FILTER_EXPRESSIONS.EXPRESSION

Type: String

Investment Element

This is the sub-element of the Member element. The Investment element is composed of the following elements:

Resources. A list of resources allocated to the investment.
Tasks. A list of tasks and assignments for the investment.

The Investment element has the following attributes:

start

Defines the start date for the investment.

Table and Column: CAP_SCENARIO_MEMBERS.START_DATE

Type: Date

finish

The finish date for the investment.

Table and Column: CAP_SCENARIO_MEMBERS.FINISH_DATE

Type: Date

investmentID

Required. Defines the criteria for specifying the investment.

The OBJECT_ID contains the actual key for the investment.

Table and Column: CAP_SCENARIO_MEMBERS.OBJECT_ID

Type: Number

Resource Element

This is a sub-element of the Investment element. Resource is composed of the AllocCurve (Segment) element which is a time-scaled value.

The Resource element has the following attributes:

bookingStatus

Required. The booking status of the resource (hard, soft, or mixed).

Table and Column: CAP_SCENARIO_TEAM.PRBOOKING

Type: Number

defaultAllocation

Required. Defines the repeating segments that represent a resource's allocation to an investment (that is, start, finish, and allocation percentage) stored in the allocation curve.

Table and Column: CAP_SCENARIO_TEAM.PRALLOCCURVE

Type: Number

projectRoleID

Required. Defines the role ID or key.

Table and Column: CAP_SCENARIO_TEAM.PRROLEID

Type: Number

resourceID

Required. Defines the resource ID or key.

Table and Column: CAP_SCENARIO_TEAM.PRRESOURCEID

Type: Number

Segment Schema Tag

This tag is part of the schema mapping for the capacity planning scenario XOG object. Segment is also known as the Time Scale Value.

The Segment schema tag has the following attributes:

finish

Required. Stored as BLOB.

Table and Column: PRALLOCCURVE

Type: Date

start

Required. Stored as BLOB.

Table and Column: PRALLOCCURVE

Type: Date

sum

Required. Stored as BLOB.

Table and Column: PRALLOCCURVE

Type: Float

Task Element

Task is composed of the Assignments (TaskLabor) element, a list of the resources assigned to the task.

The Task element has the following attributes:

duration

Defines the duration of the task in the scenario.

Table and Column: CAP_SCENARIO_TASKS.DURATION

Type: Number

start

Required. Defiines the start date of the task in the scenario.

Table and Column: CAP_SCENARIO_TASKS.START_DATE

Type: Date

finish

Required. Defines the finish date of the task in the scenario.

Table and Column: CAP_SCENARIO_TASKS.FINISH_DATE

Type: Date

name

Output only. Derived from PRTASK.PRNAME.

Table and Column: N/A

Type: String

milestone

Required. Indicates if the task is a milestone.

Values:

1. True
0. False

Table and Column: CAP_SCENARIO_TASKS.IS_MILESTONE

Type: Boolean

taskID

Defines the link to a specific task on the investment.

Table and Column: CAP_SCENARIO_TASKS.EXTERNAL_ID

Type: String

EstCurve (Segment) Element

Segment (EstCurve) element is also known as Time Scale Value. The EstCurve element has the following attributes:

finish

Required. This is stored as BLOB.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.PREXTENSION

Type: Date

start

Required. This is stored as BLOB.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.PREXTENSION

Type: Date

sum

Required. Defines the amount of work remaining. It is stored as BLOB.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.PREXTENSION

Type: Float

TaskLabor Element

TaskLabor is composed of the Segment (EstCurve) element, which is a list of segments inside the Estimate Curve. The TaskLabor has the following attributes:

start

Required. Defines the start date of the task in the scenario.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.START_DATE

Type: Date

remainingWork

Derived from the assignment curve.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.PREXTENSION

Type: Number

actualWork

Derived from the assignment curve.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.PREXTENSION

Type: Number

resourceID

Required. Defines the resource ID or key assigned to the task.

Table and Column: CAP_SCENARIO_ASSIGNMENTS.RESOURCE_ID

Type: Number

Change Request

Use the change request XOG object to view inbound and outbound change request instances.

Schema Name

nikuxog_change.xsd

Read and Write XML Files

The following XML files are included:

change_read.xml. Use this file to export change request instance from CA Clarity.
change_write.xml. Use this file to import change request instances that were previously exported from CA Clarity.

Prerequisites

Before using this XOG object, make sure the referenced objects, such as the project, user, and category, exist in CA Clarity.

Read Filters

The following explicit read filters are used:

projectCode: Defines the code for the associated project.
Name: Defines the name of the change request.
riskCode: Defines the risk of the change request.
statusCode: Defines the status of the change request.
priorityCode: Defines the priority of the change request.
ownerCode: Defines the name of the owner or assignee of the change request.

Error Handling

The following errors can be thrown:

Assessor does not exist in the system.
Approved By does not exist in the system.
Project does not exist in the system.
Category type is not valid.
Status is not valid.
Priority is not valid.
Approach code is not valid.
Owner does not exist in the system.
Impact is not valid.
Probability is not valid.
Resolved By does not exist in the system.
Task does not exist for the given project.
Failed to import risk/issue/change request.

Schema Mapping

Mappings for the following schema tag names are provided:

Change Request

Change Request Schema Tag

The change request tag is part of the schema mapping for the change request XOG object. It has the following attributes:

name

Required. Defines the name of the change request.

Table and Column: NAME

Type: String

code

Required. Defines the unique identifier for this change request.

Table and Column: RIM_RISK_ISSUE_CODE

Type: String

projectCode

Required. Defines the project associated with this change request.

Table and Column: INV_INVESTMENTS.CODE

Type: String

approvedBy

Defines the name of the resource who has approved the request.

Table and Column: APPROVED_BY

Type: String

approvedDate

Defines the date the request was approved.

Table and Column: APPROVED_DATE

Type: Date

assessmentDate

Defines the date the request was assessed.

Table and Column: ASSESSMENT_DATE

Type: Date

assessor

Defines the name of the resource who assessed the request.

Table and Column: ASSESSOR

Type: String

ownerCode

Required. Defines the name of the resource assigned to this change request.

Table and Column: ASSIGNED_TO

Type: String

benefits

Defines the benefits of this request.

Table and Column: BENEFITS

Type: String

categoryTypeCode

Defines the category of this request.

Table and Column: CATEGORY_TYPE_CODE

Type: String

effectOnCost

Change in cost (if any) for this request

Table and Column: EFFECT_ON_COST

Type: Money

effectOnResources

Change in resources (if any) for this request

Table and Column: EFFECT_ON_RESOURCES

Type: Integer

effectOnSchedule

Defines the effect on the schedule in days for this request.

Table and Column: EFFECT_ON_SCHEDULE

Type: number (floating point)

closureDate

Defines the date this request was closed.

Table and Column: CLOSURE_DATE

Type: String

description

Defines the description of this change request.

Table and Column: DESCRIPTION

Type: String

targetResolutionDate

Defines the date this change request is targeted to close.

Table and Column: TARGET_RESOLUTION_DATE

Type: Date

impactBaseline

Defines the impact this change request has on the baseline.

Table and Column: IMPACT_ON_BASELINE

Type: String

impactDescription

Defines the impact this change request has on other projects.

Table and Column: IMPACT_DESCRIPTION

Type: String

priorityCode

Defines the priority of this change request.

Table and Column: PRIORITY_CODE

Type: String

reasons

Defines the reason for the change request.

Table and Column: ASSUMPTIONS

Type: String

reviewDate

Defines the date the request was reviewed.

Table and Column: REVIEW_DATE

Type: Date

statusCode

Defines the status of this change request.

Table and Column: STATUS_CODE

Type: String

Charge Code

Use the charge code XOG object to view inbound and outbound charge code instances.

Schema Name

nikuxog_chargecode.xsd

Read and Write XML Files

The following XML files are included:

prj_chargecodes_read.xm. Use this file to export charge codes from CA Clarity.
prj_chargecodes_write.xml. Use this file to import charge codes that were previously exported from CA Clarity.

Prerequisites

None.

Read Filters

The following explicit read filters are used:

open: Specifies whether the charge code has a status of "Open".
chargeCodeID: Defines the unique identifier for the charge code.

Error Handling

The following errors can be thrown:

Project does not exist in the system.
Cannot change the project for the charge code.
Failed to import Charge Codes.

Schema Mapping

Mappings for the following schema tag name is provided:

Charge Code

Charge Code (Chargecode) Schema Tag

The charge code tag is part schema mapping for the charge code XOG object. It has the following attributes:

chargeCodeID

Required. Defines the charge code's unique identifier.

Table and Column: CHARGECODE

Type: String

name

Required. Defines the charge code's name

Table and Column: NAME

Type: String

openForTimeEntry

Not required. Defines the charge code open status.

Table and Column: OPENFORTIMEENTRY

Type: Boolean

allocationStatus

Not required. Defines the allocation status.

Values: ACTIVE, INACTIVE, ONHOLD

Default: INACTIVE

Table and Column: ALLOCATIONSTATUS

Type: String

projectCode

Not required. Defines the code of the project associated with this charge code.

Table and Column: PROJECTCODE

Type: String

Company

Use the company XOG object to view inbound and outbound company attributes. Companies are defined for inbound (write) and outbound (read) processing.

Schema Name

nikuxog_company.xsd

Read and Write XML Files

The following XML files are included:

biz_companies_read.xml. Use this file to export companies from CA Clarity.
biz_companies_write.xml. Use this file to import companies that were previously exported from CA Clarity.

Terms

The following terms are used with Company XOG object:

Parent and Affiliate Company

These browse fields are used to associate a company with a parent or affiliate company and are used to perform validation against SRM_COMPANIES table.

If the company does not exist, no information is posted to the company supplemental fields and a warning is written to the Success and Error file. If the company exists, the field is populated.

Account Manager

This browse field is used to associate a company with a project manager and to perform validation with uniqueName in the SRM_RESOURCES table.

If the resource does not exist, no information is posted to the company supplemental fields and a warning is posted to the Success and Error file. If the resource uniqueName is contained in CA Clarity, the field is populated.

Internal Contact

This browse field is used to associate an internal contact with a company and perform validation on Last_Name in SRM_RESOURCES.

If the resource does not exist, a blank field is posted to company custom-defined fields and a warning is written to the Success and Error file. If the resource last_name exists, the field is populated.

Billing Address

The billing address of the company. A company can have more than one billing address. If more than one billing address exists, each is associated with the same company.

Custom Fields

Use these to import custom-defined fields. First generate the custom-defined fields with XDM. The XOG allows for an unlimited number of custom-defined fields if you map the generated field to the XML schema. Within the schema for custom-defined fields, you must provide the Column Name, Attribute Name, and Value.

Financial Properties

Prior to importing companies, the following financial properties must be set up in the Financial Administration module. The Default Values must be populated in the Administration Tool's Application Administration/Financial Management/Defaults section. The Location, Department, WIP Class, Project Class, and Company Class values are not required in the XML schema but are required within CA Clarity.

Lookup values

The XML schema requires lookup codes provided later in this guide. These are validated against the values in CMN_LOOKUPS.

OBS association

There is an OBS Associations portlet that contains the OBS unit associated to the company, if any. The OBS association fields can be used for import and export.

Read Filters

The XOG supports outbound processing of companies based on the following fields:

Company Status
Company Type

And and Or processing is supported between these two fields (listed above) and for processing within Company Type. The following combinations are supported:

Company Status = x

where x = Active or Inactive

Company Type = x

where x = Prospect, Other, Competitor, Customer, Department, Marketplace Buyer, Marketplace Supplier, Resource Partner, Project Partner, Trust Client, Vendor

Company Status = x AND Company Type = y

where x = Active or Inactive
where y = one of many Company Types

Error Handling

The following fields are written to the Success and Error file when the XOG process generates an error or warning:

companyId
companyName
externalId
externalSource

The Company XOG object handles errors and warnings. If an error occurs, the table is not updated. You must fix the error and run the XOG again. If a warning occurs, the record is posted but the non-required fields are defaulted because of inconsistencies in the data.

The following errors are validated against Company:

companyId

The unique identifier for the company.

The company ID is validated against the companyId field. If the company ID is not unique, the company is not imported and an error is posted to the Success and Error file.

parentCompany

The name of the parent company associated to the company.

The parent company name is validated against the parentCompany field. If the parent company does not exist, the company is imported without any association to a parent company.

affiliateCompany

The name of the affiliate company associated to the company.

The affiliate company is validated against the affiliateCompany field. If the affiliate company does not exist, the company is imported without any association to an affiliate company.

Schema Mappings

The following schema mappings are provided for the company XOG:

Company Schema Tag

The Company tag is part of the schema mapping for the Company XOG object. It has the following attributes:

companyId

Required. Defines the unique, primary key for the company.

Table and Column: SRM_COMPANIES.Company_ID

Type: String

name

Required. Defines the company name.

Table and Column: SRM_COMPANIES.Company_Name

Type: String

type

Required. Defines the company type.

Values: Prospect, Other, Competitor, Customer, Department, Marketplace Buyer, Marketplace Supplier, Resource Partner, Project Partner, Trusted Client, Vendor

Table and Column: SRM_COMPANIES.Type

Type: String

status

Required. Defines the status for the company.

Values: Active and Inactive

Default: Active

Table and Column: SRM_COMPANIES.Status

Type: String

externalSource

Required by the schema. The lookup value specifies the originating system ID (for example, Oracle).

Table and Column: SRM_COMPANIES.External_Source_ID

Type: String (in schema) and Number (in CA Clarity)

externalId

Required. Defines the originating unique identifier required by the XML schema.

Table and Column: SRM_COMPANIES.External_ID

Type: String

Contact Information Schema Tag

The Contact Information tag is part of the schema mapping for the Company XOG object. Contact information includes phone and fax numbers and mail and email addresses.

This schema tag has the following attributes:

address1

Defines the first line of the address.

Table and Column: SRM_CONTACTS.Address1

Type: String

address2

Defines the second line of the address.

Table and Column: SRM_CONTACTS.Address2

Type: String

city

Defines the city.

Table and Column: SRM_CONTACTS.City

Type: String

county

Defines the county.

Table and Column: SRM_CONTACTS.County

Type: String

state

Defines the state.

Table and Column: SRM_CONTACTS.State_Province

Type: String

postalCode

Defines the postal code.

Table and Column: SRM_CONTACTS.Postal _Code

Type: String

country

Defines the country.

Table and Column: SRM_CONTACTS.Country_ID

Type: Number

workPhone

Defines the work phone number.

Table and Column: SRM_CONTACTS.Phone_Work

Type: String

fax

Defines the fax number.

Table and Column: SRM_CONTACTS.Phone_Fax

Type: String

webAddress

Defines the Web address.

Table and Column: SRM_CONTACTS.URL

Type: String

Supplemental Information Schema Tag

This tag is part of the schema mapping for the Company XOG object. It has the following attributes:

description

Describes the company.

Table and Column: BIZ_COM_SUP_PROPERTIES.Description

Type: String

rating

Lookup values include:

High
Medium
Low

Table and Column: BIZ_COM_SUP_PROPERTIES.Rating

Type: String

sicCode

Lookup values include:

SIC Code 1
SIC Code 2
SIC Code 3

Table and Column: BIZ_COM_SUP_PROPERTIES.SIC_Code

Type: String

parentCompany

Browse this field to specify the parent with which the company is associated.

Table and Column: BIZ_COM_SUP_PROPERTIES.Parent_Company

Type: String

affiliate Company

Browse this field to specify the affiliate with which the company is associated.

Table and Column: BIZ_COM_SUP_PROPERTIES.Affiliate_Company

Type: String

division

Defines the company division.

Table and Column: BIZ_COM_SUP_PROPERTIES.Division

Type: String

category

Defines the company category.

Table and Column: BIZ_COM_SUP_PROPERTIES.Category

Type: String

industry

Defines the industry in which the company operates.

Table and Column: BIZ_COM_SUP_PROPERTIES.Industry

Type: String

numberOfEmployees

Defines the number of employees in the company.

Table and Column: BIZ_COM_SUP_PROPERTIES.Number_of_Employees

Type: Number

ownership

The Lookup value is "Corporation".

Table and Column: BIZ_COM_SUP_PROPERTIES.OwnerShip

Type: String

tickerSymbol

Defines the ticker symbol of the company

Table and Column: BIZ_COM_SUP_PROPERTIES.Ticker_Symbol

Type: String

referralSource

Defines the referral source.

Table and Column: BIZ_COM_SUP_PROPERTIES.Referral_Source

Type: String

accountManager

Browse this field to identify the account manager associated with the company.

Table and Column: BIZ_COM_SUP_PROPERTIES.Account_Manager

Type: String

primaryContactName

Defines the primary contact in the company.

Table and Column: BIZ_COM_SUP_PROPERTIES.Primary_Contact_Name

Type: String

primaryContact Email

Defines the email address of the company's primary contact.

Table and Column: BIZ_COM_SUP_PROPERTIES.Primary_Contact_Email

Type: String

primaryContact Phone

Defines the phone number of the company's primary contact.

Table and Column: BIZ_COM_SUP_PROPERTIES.Primary_Contact_Phone

Type: String

notes

Defines any company notes.

Table and Column: BIZ_COM_SUP_PROPERTIES.Notes

Type: String

Custom Information Schema Tag

The Custom Information tag is part of the schema mapping for the Company XOG object. This tag stores custom-defined fields (CDF). You must allow several CDFs for each company.

This schema tag has the following attributes:

ceoName

Defines the name of the company's Chief Executive Officer.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_CEO_NAME

Type: String

defaultWebSite

Defines the company's default Web address.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_DEFALUTWEBSITE

Type: String

numberOfEmployees

Defines the number of employees in the company.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_NUM_OF_EMPLOYEES

Type: Number

opportunity

Defines the opportunity for the company.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_OPPORTUNITY

Type: Boolean

Default: False

internalContact

Defines the name of the internal contact for the company. This is a browse field.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_PRIM_INTERNAL_CONTACT

Type: String

agreementStartDate

Defines the agreement start date for the company.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_AGREEMENT_START_DATE

Type: Date

industry

Defines the industry type for the company. This is a lookup value.

Table and Column: XDM_CDF_SRM_COMPANIES.XDM_INDUSTRY

Type: String

Financial Information Schema Tag

The Financial Information tag is part of the schema mapping for the Company XOG object. The attribute values are unlike other lookup values. They require you to provide a text string instead of a lookup code.

This tag has the following attributes:

status

Defines the company's status.

Values:

Active
Inactive
No new business

Default: Active

Table and Column: CLNTSUPP.STATUS_TYPE

Type: String

location

Indicates the company location. This is a browse field.

Table and Column: CLNTSUPP.LOCATIONID

Type: String

department

Indicates the department associated with the company. This is a browse field.

Table and Column: CLNTSUPP.DEPARTCODE

Type: String

wipClass

Defines the WIP Class associated with the company. This is a browse field.

Table and Column: CLNTSUPP.CLNTWIPCLASS

Type: String

projectClass

Defines the project class associated with the company. This is a browse field.

Table and Column: CLNTSUPP.PROJCLASS

Type: String

companyClass

Defines the company class associated with the company. This is a browse field.

Table and Column: CLNTSUPP.COMPCLASS

Type: String

batchCycle

Optional. Defines the batch cycle associated with the company.

Table and Column: CLNTSUPP.BILLCYCLE

Type: String

dateOpened

Defines the opened date for the company.

Table and Column: CLNTSUPP.OPENEDDATE

Type: Date

Billing Address Schema Tag

The Billing Address tag is part of the schema mapping for the company XOG object. This is the Billing Address header. Each company can have one or many billing addresses.

This schema tag has the following attributes:

billingCompanyName

Required. Defines the Bill To company name.

Table and Column: CLNTBILLTO.COMPANY_CODE

Type: String

billingCode

Required. Defines the billing code for the company.

Table and Column: CLNTBILLTO.BILL_TO_COMPANY_CODE

Type: String

Billing Address Detail Schema Tag

The Billing Address Detail tag is part of the schema mapping for the company XOG object. It has the following attributes:

address1

Defines the first line of the billing address for the company.

Table and Column: ARMASTER.ADDR1

Type: String

address2

Defines the second line of the billing address for the company.

Table and Column: ARMASTER.ADDR2

Type: String

address3

Defines the third line of the billing address for the company.

Table and Column: ARMASTER.ADDR3

Type: String

address4

Defines the fourth line of the billing address for the company.

Table and Column: ARMASTER.ADDR4

Type: String

address5

Defines the fifth line of the billing address for the company.

Table and Column: ARMASTER.ADDR5

Type: String

attentionName

Defines the name of the individual responsible for the company's billing.

Table and Column: ARMASTER.ATTENTION_NAME

Type: String

attentionPhone

Defines the phone number for the individual responsible for the company's billing.

Table and Column: ARMASTER.ATTENTION_PHONE

Type: String

OBS Associations Schema Tag

The OBS Associations tag is part of the schema mapping for the Company XOG object. No table is referenced for this tag. It is a wrapper for the OBSAssoc elements.

The OBS Associations tables include:

PRJ_OBS_ASSOCIATIONS
PRJ_OBS_TYPES
PRJ_OBS_UNIT
PRJ_OBS_UNITS_FLAT

This schema tag has the following attributes:

completed

Defines whether the OBS associations are complete. This field is optional. When completed, the value is True. Existing OBS associations not listed in the import are deleted.

Table and Column: Not applicable

Type: String

Default: False

id

Required. Defines the unique ID for the OBS type.

Table and Column: PRJ_OBS_TYPES.UNIQUE_NAME

Type: String

name

Defines the name of the OBS type.

Table and Column: PRJ_OBS_TYPES.NAME

Type: String

unitPath

Required. This is a slash-delimited list of unit names that lead to the unit with which the object is associated.

Example: "CAN/BC/VAN".

Table and Column: PRJ_OBS_UNITS.NAME

Type: String

Company Class

Use the Company Class XOG object to view inbound and outbound Company Class instances.

Schema Name

nikuxog_companyclass.xsd

Read and Write XML Files

The following XML files are included:

companyClass_read.xml. Use this file to export Company Class instances from CA Clarity.
companyClass_write.xml. Use this file to import Company Class instances that were previously exported from CA Clarity.

Prerequisites

None.

Read Filters

The following explicit read filters are used:

companyclass: Defines the company class name.
description: Defines the description for the Company Class.
shortdesc: Defines the short description for the Company Class.

Error Handling

The following errors can be thrown:

Could not xog-in item because size of some attributes [description] is not within valid range.

Schema Mapping

Mappings for the following schema tag name is provided:

Company Class

Company Class Schema Tag

The Company Class tag is part of the schema mapping for the Company Class XOG object. It has the following attributes:

companyclass

Required. Defines the unique company class name.

Table and Column: CLNTCLASS

Type: String

description

Required. Defines the description of the company class.

Table and Column: DESCRIPTION

Type: String

shortdesc

Required. Defines the summary of the company class description.

Table and Column: SHORTDESC

Type: String

Content Pack

This object allows you to create new content for CA Clarity PPM. A content item is any item that displays in CA Clarity PPM but is not considered data. For example, a graph portlet is considered a content item, but a project is considered data.

Use this object to view inbound and outbound add-in items.

Schema Names

The following schema names are associated to the content pack XOG object:

nikuxog_contentPack.xsd
nikuxog_pageTypes.xsd
nikuxog_filter_portlet.xsd

Read and Write XML Files

The following XML files are included:

content_pack_read.xml. Use this file to export content packs from CA Clarity.
content_pack_write.xml. Use this file to import content packs that were previously exported from CA Clarity.

Terms

The following terms are used when describing the content pack XOG object:

Content Item: Defines the user-defined add-in item that adds or extends CA Clarity PPM.
Queries: Defines the queries.
Reports and jobs: Defines the reports and jobs. You cannot import or export system-supplied reports using the XOG. They are not considered user-defined add-in items.
Portlets (graph, grid, and HTML): Defines the portlets. You cannot import or export system-supplied portlets using the XOG. They are not considered user-defined add-in items.
Pages: Defines the pages.
Lookups: Defines the lookups. You can export system-supplied lookups.
Menus (menu manager sections and links): Defines the menus.
Content Pack: Defines the collection of content that is bundled into a single distributable package.

Business Rules and Processing

The following business rules and processing apply to this XOG:

When creating add-in items, it is recommended that you set up a staging server that is separate from the production server. After reviewing, testing, and verifying the effectiveness and usability of the new add-in items, you can determine that the add-in items are ready for production. You can then transfer the items to the production server. During this process, the items are exported from the staging server and imported to a production server.
Instead of exporting and importing a series of add-in item XML (XOG) files, you can export many add-in items, then import them as a single XML file.

For example

You can:

Create a page that contains add-in items (portlets, queries, and lookups).
Add the portlets to a menu.
Run the XOG and export the content.
The resulting XML file contains all of the add-in items. The file is fully annotated to describe how each element is filtered.

The attribute values for the filterMapping element (part of the PortletReferenceType complex type) has the following prerequisites unique to the filter portlet type:

The filterPortletCode attribute value must match the portlet code of a valid filter portlet defined in the filter portlet schema.
The fieldCode attribute value must match the field code of a valid filter portlet defined in the filter portlet schema.
The dataProviderItemCode attribute value must match the column code of a valid grid or graph portlet column.
The dataProviderItemCode and fieldCode attribute values must reference an attribute of the same data type.
If the data type is a lookup, then the lookup type codes need to be the same between the attributes.

Dependencies

Add-in items have dependencies that are automatically resolved by the XOG. For example, if a query depends on a lookup and the query is imported, the lookup must also be imported (if it does not already exist). The following dependencies exist when exporting add-in items:

Content Item Depends On	Content Item
Queries	Lookups
Graphs and Grids	Queries or Lookups
Reports and Jobs	Lookups
Pages, Portlets, and Queries	Lookups (sometimes Objects if data provider of portlet is object)
Menu Links	Pages
All items	Security
Objects	Lookups

OBS associations for pages, portlets, jobs and reports will be exported. They are also imported provided that the OBS and OBS unit (including parentage) exist in CA Clarity PPM. The same is true of security, which is imported if the user, group, or OBS unit exists.

Import Rules

Each add-in import request is regarded as a single transaction. If one item fails, the entire add-in is not imported. Add-in items are imported from XML files, which can be produced during the export or created manually.

If an item is modified to include new entries before an item is imported, the new entry is not affected by the import process; the import operation ignores the new entry.

For example

Consider a static lookup named SAMPLE_LOOKUP that contains the following values:

OPEN
CLOSED
IN PROGRESS

You then add a new lookup value of SUSPENDED and change the existing label from CLOSED to FINISHED. Then import a Best Practice Accelerator that includes the definition for SAMPLE_LOOKUP which contains each of the three lookup values (OPEN, CLOSED, and IN PROGRESS) and the new lookup value (DELAYED). When the import operation completes, CA Clarity PPM contains the following lookup values:

OPEN
CLOSED (the change is overwritten)
IN PROGRESS
SUSPENDED (addition made to CA Clarity PPM using the application user interface is preserved)
DELAYED (new item that was present in the input Best Practice Accelerator file is also added)

When you import an add-in item, it is updated with the definition that is present in the file. If a content item contains a new addition that does not exist in CA Clarity PPM, the new addition is also created in CA Clarity PPM. When importing an existing lookup, all rules described in the following table apply. The following table shows the various import rules associated with a lookup and the lookup values. These rules are honored by the user interface. As a result, the XOG import process for lookups honors these rules.

Function	System-restricted	System	User-defined

Static List Lookups
Change Lookup Name and Description	Yes	Yes	Yes
Change Sort Order (Manual or Alphanumeric)	No	Yes	Yes
Deactivate or Activate Lookup	No	No	No
Delete Lookup	No	No	Yes
Change Lookup Value Name and Description	Yes	Yes	Yes
Create New Lookup Values	No	Yes	Yes
Deactivate or Activate Lookup Values	No	Yes (user-defined values) No (seeded values)	Yes
Reorder Lookup Values	Yes	Yes	Yes
Dynamic Niku Query Lookups
Change Lookup Name and Description	Yes	Does not apply	Yes
Edit Query	No	Does not apply	Yes
Edit Parent Window Fields	No	Does not apply	Yes
Edit Browse Window Name and Label Fields	Yes	Does not apply	Yes
Edit Browse Window Field Element Type	No	Does not apply	Yes
Edit Browse Window Selected Fields for Filter and List	No	Does not apply	Yes
Edit Browse Window Filter Field, List Column Order	Yes	Does not apply	Yes
Edit Browse Window Default Sort Column/Order	Yes	Does not apply	Yes

Export Rules

You can export multiple add-in items at the same time. Add-in items can be filtered so that a subset of items can be exported. For example, a system may contain four HTML portlets. The export interface allows for two HTML portlets to be exported at the same time.

Portlets

This feature does not implement business rules for portlets. Most of the attributes and elements are either optional or have default values. While the XML schema does not validate such instances, the import mechanism does validate and generate an error for invalid grids or graphs.

For example, if a Grid portlet is based on a query that does not contain metrics, then no <metricColumn> elements should be present in the imported XML schema.

Jobs and reports definitions

During import, the imported attributes of the definition match the user interface exactly. When parameters are changed, the old parameters are deleted and new ones are added. Existing scheduled jobs and reports are cancelled, since the parameters no longer exist. All saved parameters are deleted. If the update flag is set to "True", then only captions (job and parameters) can be changed. If the update flag is set to "False", the content item is assumed to contain all the parameters and existing parameters are deleted as described above.

Pages

The export of a page includes all non-system portlets. OBS and security associations can be specified and, as with other items, a Warning is written to the log file if the target principal (OBS unit, Group, or User) does not exist.

Lookups

Lookups are either static or dynamic: Dynamic lookups are based on NSQL, Static lookups do not contain the NSQL values contained in dynamic lookups and are generated by executing the NSQL at runtime when they are rendered on a page as a pull-down or as a browse page. Static lookup values are seeded and persist as individual rows in CA Clarity (in the table named CMN_LOOKUPS).

While it is true that for any content item that is part of a Best Practice Accelerator, system objects are not imported or exported, there are exceptions with regard to lookups. Lookups are classified into three categories: System-restricted, System, and User-defined. All lookup types (dynamic and static) can be exported.

Queries

This feature follows all business rules for the query user interface. Items that can be updated via the user interface can be updated with an import request. Although the queries schema allows for multiple, vendor-specific NSQL text, only valid text is imported into CA Clarity. For example, an import request on an Oracle system that contains both dbVendor="mssql" and dbVendor="oracle" imports only the dbVendor="oracle".

Text with dbVendor="all" is always imported.

When creating queries, the user interface in the Administration Tool always sets dbVendor="all". This value cannot be changed in the user interface. Should a query be vendor-specific, you can set the dbVendor attribute value in the XML document.

When querying for items to create a Best Practice Accelerator, you must explicitly query for each type of item in the export (read) request. The following statement returns all portlets that include source="acme.com". Without the <PortletQuery> element in the read request, no portlets are imported. For example:

</PortletQuery>

All add-in items have a source attribute which is used to differentiate originating-system items from CA Clarity PPM-supplied items. The source attribute maps to the column source in various database tables. To change the source for add-in items created with the user interface, use SQL to change the defaultValue for this column; then new add-in items will have the source specified.

This applies to the following tables:

CMN_PORTLETS
CMN_PAGES
CMN_SCH_JOB_DEFINITIONS
CMN_LOOKUP_TYPES
CMN_GG_NSQL_QUERIES

The SQL to change this is:

ALTER TABLE CMN_LOOKUP_TYPES MODIFY SOURCE VARCHAR (80) DEFAULT 'acme.com'

Error Handling

PageTypes filter mappings that do not meet the dependencies (described earlier), will not throw an error, but the mapping will not be implemented.

Schema Mapping

The following schema tags and attributes define the ContentPack filter portlet schema (nikuxog_pageTypes.xsd):

filterMapping
portlet

Filter Mapping (filterMapping) Schema Tag

The filter mapping tag is part of the schema mapping for the Content Pack XOG object. The following attributes describe the mapping of a field on a filter portlet to a data provider attribute of a grid or graph portlet. This element is only valid as a child of a grid or graph portlet reference.

The filerMapping schema tag has the following attributes:

filterPortletCode

Required. Defines the code of the filter portlet.

Table and Column: Portlet ID

Type: String

fieldCode

Required. Defines the code of the filter field.

Table and Column: Field ID

Type: String

dataProviderItemCode

Required. The code of the data provider property or metric.

Table and Column: Attribute ID

Type: String

hidePortletWhenEmpty

When true, the referenced grid or graph portlet is hidden when no filter value is present.

Table and Column: Hide If Empty

Type: Boolean

portlet Schema Tag

This tag is part of the schema mapping for the Content Pack XOG object. The following schema tags and attributes define the ContentPack filter portlet schemas (nikuxog_contentPack.xsd and nikuxog_filter_portlet.xsd):

filterPortlet
Field
lookupParam

The Portlet schema tag has the following attributes:

defaultFilter

The default filter for the page. It can be true for only one portlet on the page.

Table and Column: Default

Type: Boolean

pageLevelFilter

Defines whether the filter values persist across the page.

Values:

True. The filter values persist across this page only.
False. The filter values apply throughout CA Clarity.

Table and Column: Persist

Type: Boolean

filterPortlet Schema Tag

The filterPortlet schema tag inherits existing PortletAttributesTypes found in nikuxog_portlet.xsd and NLS, OBSAssocs, Security, and FilterViewTypes. These items are consistent across all portlets and not specific to filterPortlet. They are not explicitly listed.

The filterPortlet schema tag has the following attributes:

uiType

Defines the UI rendering type.

Table and Column: Render As

Type: FilterPortlet UI Type (section, toolbar)

isCollapsed

Defines the default section state.

Table and Column: Default Filter State

Type: Boolean

bgColorKey

The session key that controls the background color of the toolbar filter portlets.

Table and Column: None

Type: String

Field Schema Tag

The Field schema tag is a filter field, and has the following attributes:

nls

Required. The name and description of the field.

Table and Column: Field Name/Description

Type: NlsType

tip

Defines the tooltip

Table and Column: Tooltip

Type: NlsType

hint

Defines the hint or instructional text.

Table and Column: Hint

Type: NlsType

defaultValue

Defines the default value for the field.

Table and Column: Filter Default

Type: Any type

lookupParam

Defines a parameter of a parameterized lookup.

Table and Column: Lookup Parameter Mappings

Type: See the lookupParam table

code

Required. Defines the code of the field.

Table and Column: Field Id

Type: String

dataType

Required. Defines the data type of the field.

Table and Column: Data Type

Type: String

extDataType

Defines the extended type of the field.

Table and Column: N/A

Type: String

widgetType

Required. Defines the display type of the field.

Table and Column: Display Type

Type: String

extWidgetType

Required. The extended display type of the field.

Table and Column: N/A

Type: String

lookupTypeCode

Defines the lookup code for a lookup field.

Table and Column: Lookup

Type: String

width

Defines the width of the filter field.

Table and Column: Width

Type: Integer

position

Defines the position of the filter field.

Table and Column: Layout

Type: Integer

multiValued

Defines the lookup style of a lookup field.

Table and Column: Lookup Style

Type: Boolean

multiValuedLookup

Indicates if the lookup field is a Multi Valued Lookup data type.

Table and Column: N/A

Type: Boolean

fixedWidget

Indicates if the field is fixed.

Table and Column: N/A

Type: Boolean

hidden

Indicates if the field is hidden.

Table and Column: Hidden in filter

Type: Boolean

required

Indicates if the field requires a value.

Table and Column: Required in Filter

Type: Boolean

readOnly

Indicates if the field's value is read only.

Table and Column: Read-Only in Filter

Type: Boolean

minValue

Defines the minimum default value of a date or numeric range field.

Table and Column: Filter Default From

Type: String

maxValue

Defines the maximum default value of a date or numeric range field.

Table and Column: Filter Default To

Type: String

columnNumber

Defines the field's column or row in the corresponding section or toolbar filter.

Table and Column: Layout

Type: Integer

depParentLookupTypeCode

Defines the lookup code of a dependent lookup.

Table and Column: Lookup

Type: String

depEntry

Defines the lookup code for entry into dependent lookup.

Table and Column: Entry

Type: String

depExit

Defines the lookup code for exit into dependent lookup.

Table and Column: Exit

Type: String

lookupParam Schema Tag

The lookupParam schema tag is a parameter of a parameterized lookup, and has the following attributes:

code

Required. Defines the field code of the parameter.

Table and Column: Field Code

Type: String

dpCode

Required. Defines the NSQL parameter specified in the lookup.

Table and Column: Lookup Parameter

Type: String

Cost Plan

A cost plan is created for an investment that already exists. Use the Cost Plan XOG object to view inbound and outbound financial cost plans.

Schema Name

nikuxog_costPlan.xsd

Read and Write XML Files

The following XML files are included:

costPlan_read.xml. Use this file to export cost plans from CA Clarity.
costPlan_write.xml. Use this file to import cost plans that were previously exported from CA Clarity.

Prerequisites

Before using this XOG, make sure the following objects already exist in CA Clarity:

Investments
Entity
Time periods
Grouping attributes

Business Rules and Processing

The following business rules and processing apply to this XOG:

A Cost Plan object is created by configuring the cost plan setup properties.
Cost plan details (line items) are added to the plan.
Existing plan detail records are not deleted.

Read Filters

The following explicit read filters are used:

code. The code for the cost plan.
name. The name of the cost plan.
investmentCode. The investment code with which the plan is associated.

Error Handling

When importing or exporting the cost plan, the following errors can be thrown:

You must have Plan XOG access rights to perform this action.
Plan code is required.
Grouping Attribute is missing or invalid.
Investment Code is missing or invalid.
Period Type cannot be changed once defined.
Grouping Attributes cannot be changed once defined.
Investment must be associated to an Entity before setting up financial plans.
Benefit plan ID is missing or invalid.
Period Date is missing or invalid.
Grouping Attributes in Plan Details do not match Plan Grouping Attributes.
GL Account is missing or invalid.
Missing or invalid value for Grouping Attribute.
Finish time period is invalid.
Start time period is invalid.
Grouping Attributes do not match locked plan structure for associated entity.
Cannot modify plan periods prior to the freeze date.
Valid Fiscal Period does not exist for start and end dates for plan detail.

Schema Mappings

The following schema tag names are described:

CostPlan Schema Tag

The Cost Plan tag is part of the schema mapping for the Cost Plan XOG object. This tag has the following attributes:

benefitPlanCode

Defines the ID of the benefit plan that is associated to the cost plan.

Table and Column: BENEFIT_PLAN_ID

Type: String

Code

Required. Defines the unique ID of the cost plan for XOG.

Table and Column: CODE

Type: String

FinishPeriod

Required. Defines the finish time period name.

Table and Column: END_PERIOD_ID

Type: String

Investment Code

Required. Defines the investment code.

Table and Column: OBJECT_ID

Type: String

Investment Type

Defines the investment type. This is used only in the XOG read result.

Type: String

isPlanOfRecord

Indicates if the cost plan is the plan of record. If this is not set and it is the first plan of the investment, then the plan is marked as the plan of record.

Table and Column: IS_PLAN_OF_RECORD

Type: String

Name

Required. Defines the name of the cost plan.

Table and Column: NAME

Type: String

Period Type

Required. Defines the time period type.

Table and Column: PERIOD_TYPE_CODE

Type: String

Revision

This is used only in XOG read result. It represents the revision of the cost plan.

Table and Column: REVISION

Type: Integer

StartPeriod

Required. Defines the start time period name.

Table and Column: START_PERIOD_ID

Type: String

Description Schema Tag

This tag is part of the schema mapping for the Cost Plan XOG object. This schema tag is a text node.

Description

Defines the cost plan description.

Table and Column: description

Type: String

Grouping Attributes Schema Tag

This tag is part of the schema mapping for the Cost Plan XOG object. This tag is used to define grouping attributes for a cost plan. The tag includes the following attribute:

Grouping Attribute

Specifies grouping attributes for a cost plan.

Possible Values:

charge_code_id

role_id

resource_id

department_id

location_id

transaction_class_id

resource_class_id

input_type_code_id

lov1_id

lov2_id

Table and Column: The value is stored in the ODF_MULTI_VALUED_ATTRIBUTES table.

Type: String

Detail Schema Tag

This tag is part of the schema mapping for the Cost Plan XOG object. This tag defines a cost plan detail row and is composed primarily of schema tags.

The Detail schema tag includes the following tags:

Cost

Defines the cost for specific time period segments.

Table and Column: COST

Units

Defines the quantity for a specific time period segment.

Table and Column:UNITS

Revenue

Defines the revenue for a specific time period segment.

Table and Column: REVENUE

Grouping Attributes

Defines the grouping attribute codes and values for the grouping attributes selected for the cost plan. Each GroupingAttribute represents a code and value pair for an attribute.

Table and Column: The value is stored in the column corresponding to the groupingAttribute code (for example, location_id, charge_code_id).

Type: String

Custom Information

Defines the field names for the custom information.

Segment Schema Tag

This tag is part of the schema mapping for the Cost Plan XOG object. The Unit, Cost, and Revenue schema tags will include one or more Segment schema tags. This tag has the following attributes:

start

Defines the start period for the unit, cost, or revenue.

Type: String

finish

Defines the end period for the unit, cost, or revenue.

Type: String

value

Defines the value for the unit, cost, or revenue.

Type: String

Cost Plus Code

Use the cost plus code XOG object to view inbound and outbound cost plus code object instances. Cost Plus Codes are an alternate method of determining rates by adding markups to either the Standard or Actual cost.

Schema Name

nikuxog_costPlusCode.xsd

Read and Write XML Files

The following XML files are included:

costPlusCodes_read.xml. Use this file to export cost plus codes from CA Clarity.
costPlusCodes_write.xml. Use this file to import cost plus codes that were previously exported from CA Clarity.

Prerequisites

None

Read Filters

The following explicit read filters are used:

code: Defines the code for the cost plus code.
description: Defines the description for the cost plus code.
appliesTo: Defines the apply to Actual/Standard parameter (values are StandardCost or ActualCost).

Error Handling

When importing or exporting the cost plan, the following error can be thrown:

Failed to export cost plus codes.

Schema Mapping

Mappings for the following schema tag name is provided:

Cost Plus Code

Cost Plus Rule (costplusrule) Schema Tag

The cost plus rule tag is part schema mapping for the Cost Plus Code XOG object. It has the following attributes:

unitsFrom

Required. Defines the beginning units of the cost plus rule.

Table and Column: COSTPLUSRULES.FROMRANGE

Type: Date

unitsTo

Required. Defines the end units of the cost plus rule.

Table and Column: COSTPLUSRULES.TORANGE

Type: Date

multiplierAmount

Defines the multiplier amount for the cost plus rule.

Table and Column: COSTPLUSRULES.MULTAMOUNT

Type: Double

burdenAmount

Defines the burden amount for the cost plus rule.

Table and Column: COSTPLUSRULES.BURDENAMOUNT

Type: Double

overheadAmount

Defines the overhead amount for the cost plus rule

Table and Column: COSTPLUSRULES.OVERHEADAMOUNT

Type: Double

Department

Use the department XOG object to view inbound and outbound department attributes.

Schema Name

nikuxog_department.xsd

Read and Write XML Files

The following XML files are included:

department_read.xml. Use this file to export departments from CA Clarity.
department_write.xml. Use this file to import departments that were previously exported from CA Clarity.

Prerequisites

Before using this XOG, you must ensure that an entity exists.

Business Rules and Processing

When a department is created, a corresponding OBS unit is created in the department OBS referred to by the department's entity.

Read Filters

The following explicit read filter is used:

Entity: The unique entity code for which the departments should be read out.

Error Handling (Writes & Updates)

Errors are thrown based on the following checks:

Entity: Checks if the entity is valid and exists.
Required fields: Ensures all required fields have values.
Location associations: Ensures locations belong to the same entity. If the location does not exist, a warning is output.

Schema Mappings

The following schema tag names are provided to XOG departments:

Departments
Description
LocationAssociations
Budget
Child Department

Departments Schema Tag

This tag is part of the schema mapping for the Department XOG object. This is a placeholder tag for multiple departments.

Department

The actual department object. Department has the following attributes:

department_code

Required. Defines the unique department code.

Table and Column: DEPARTMENTS.departcode

Type: String

short_description

Required. Defines the department name.

Table and Column: DEPARTMENTS.shortdesc

Type: String

dept_identifier

Defines the general ledger segment value mapped to this department.

Table and Column: DEPARTMENTS.departidentifier

Type: String

default_reviewer

Defines the default reviewer for the department.

Table and Column: DEPARTMENTS.default_reviewer

Type: String

alt_default_reviewer

defines the alternate reviewer for the department.

Table and Column: DEPARTMENTS.alt_default_reviewer

Type: String

parent_department_code

Defines the code for parent department.

Table and Column: parent_department_id

Type: String

dept_manager_code

The department manager resource code.

Table and Column: DEPARTMENTS.department_manager_id

Type: String

brm_code

Defines the business relationship manager.

Table and Column: brm_id

Type: String

entity

Required. The identify for the entity to which the department belongs.

Table and Column: DEPARTMENTS.entity_id

Type: String

Description Schema Tag

This tag is part of the schema mapping for the Department XOG object. It is used for the department description. This tag has the following attribute.

Description

Required. Defines the description tag.

Table and Column: description

Type: String

LocationAssociations Schema Tag

This tag is part of the schema mapping for the department XOG object. The placeholder tag for multiple location associations.

LocationAssociation

A location associated to a department. This has the following attribute.

locationcode

Required. Defines the location code. Location must belong to the same entity as the department.

Table and Column: locn_id

Type: String

Budget Schema Tag

The budget tag is part of the schema mapping for the department XOG object. A simple budget including the project's planned cost, NPV, ROI, and breakeven information. The values apply to only one time period from the start date to the finish date of the project.

Subscriptions Schema Tag

The subscriptions tag is part of the schema mapping for the department XOG object.

It is a placeholder tag for the services to which the department subscribes.

Subscription

The service to which the department subscribes and its properties. This has the following attributes.

sla_violations

Defines the number of SLA violations.

Table and Column: DPT_SUBSCRIPTIONS.sla_violations

Type: Integer

sla_violations_th

Defines the threshold for SLA violations.

Table and Column: DPT_SUBSCRIPTIONS.sla_violations_threshold

Type: Integer

incidents

Defines the number of incidents.

Table and Column: DPT_SUBSCRIPTIONS.incidents

Type: Integer

incidents_threshold

Defines the threshold for incidents.

Table and Column: DPT_SUBSCRIPTIONS.incidents_threshold

Type: Integer

change_orders

Defines the number of change orders.

Table and Column: DPT_SUBSCRIPTIONS.change_orders

Type: Integer

charges

Defines the total charges (from chargebacks) against the investment (service) for this subscription.

Table and Column: DPT_SUBSCRIPTIONS.charges

Type: Integer

cust_satisfaction

Defines the customer satisfaction rating for this subscription.

Table and Column: DPT_SUBSCRIPTIONS.customer_satisfaction

Type: Integer

total_users

Defines the total number of users utilizing this subscription.

Table and Column: DPT_SUBSCRIPTIONS.total_users

Type: Integer

active_users

Defines the number of active users utilizing this subscript.

Table and Column: DPT_SUBSCRIPTIONS.active_users

Type: Integer

page_hits

Defines the page hits as captured for this subscription if applicable.

Table and Column: DPT_SUBSCRIPTIONS.page_hits

Type: Integer

entityId

Required. Defines the entity to which the service belongs.

Table and Column: This is a derived attribute.

Type: String

departmentId

Required. Identifies the subscribing department.

Table and Column: DPT_SUBSCRIPTIONS.department_id

Type: String

serviceId

Required. Defines the identifier that makes it unique in combination with the table_name column.

Column: pk_id

Type: String

Department (Child Department) Schema Tag

This tag is part of the schema mapping for the Department XOG object. A child department has all the elements and attributes of the parent department.

obsTypes Schema Tag

This tag is part of the schema mapping for the Department XOG object. It is a placeholder for the two OBS types that represent the Location and Department OBS's. This is similar to the generic OBS XOG structure.

This schema tag is composed of the following:

obs
level
obsAssociations
obs

The obsTypes schema tag has the following attributes:

code

Required. Defines the unique code for OBS type.

Table and Column: PRJ_OBS_TYPES.unique_name

Type: String

name

Required. Defines the name of the OBS type.

Table and Column: PRJ_OBS_TYPES.name

Type: String

description

Required. Describes the OBS type.

Table and Column: PRJ_OBS_TYPES.description

Type: String

level

Level represents a level in the OBS type. At least one level is required. Level has the following attributes.

Name

Required. The name for the level.

Table and Column: Prj_Obs_Levels.Name.

Type: String

depth

Required. The depth of the OBS level.

Table and Column: Prj_Obs_Levels.obs_level

Type: Integer

obsAssociation

The object types that are associated to this OBS type. This tag is optional.

object

Required. The name of the object type associated to this OBS.

Table and Name: Prj_Obs_Associations.table_name

Type: String

associationType

Required.

Table and Name: Prj_Obs_Associations.is_leaf_only

Type: String

Entity

Use the entity XOG object to view inbound and outbound entity attributes.

Schema Name

nikuxog_entity.xsd

Read and Write XML Files

The following XML files are included:

entity_read.xml. Use this file to export entities from CA Clarity.
entity_write.xml. Use this file to import entities that were previously exported from CA Clarity.

Prerequisites

None.

Business Rules and Processing

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

The entity inherits the currency type from the system settings.
In entity create mode, if the OBS types mentioned in the XOG file do not exist, the OBS types are created automatically.
Structural updates to OBS types are not allowed if they are referred to by the entities. Use the location and department XOG files for structural changes.
Ensures that the OBS types are not referred to by another entity.
Creates departments and locations for the OBS units (when in create mode).

Read Filters

The following explicit read filter is used:

Entity: Defines the unique entity code that needs to be read out.
Description: Defines the description of the entity.

Schema Mappings

The following schema tag attributes are described:

Entity
Description
Short Description
OBS Types
GL Periods
Plan Defaults

Entity Schema Tag

This tag is part of the schema mapping for the Entity XOG object. It is a placeholder tag for multiple entities.

Entity

The actual entity object. The entity schema mapping includes definitions for the home and reporting currencies. This schema tag has the following attributes:

entity

Required. Defines the name of the entity. Do not allow truncation.

Table and Column: ENTITY.entity

Type: String

finPeriodCode

Optional. Defines the fiscal time period type of the entity.

Possible Values: WEEKLY, 13_PERIODS_PER_YEAR, SEMI_MONTHLY, MONTHLY, QUARTERLY and ANNUALLY.

Table and Column: ENTITY. FIN_PERIOD_CODE

Type: String

geoOBS

Required. Refers to the OBS that will represent the geographical structure (that is, locations).

Table and Column: ENTITY.geo_chart_obs_type_id

Type: String

orgOBS

Required. Refers to the OBS that will represent the organizational structure (that is, departments).

Table and Column: ENTITY.org_chart_obs_type_id

Type: String

homeCurrency

Required. Defines the lookup values for each ISO standard code. You must validate that it is an active currency.

Table and Column: ENTITY.Home_Currency_Code

Type: String

reportingCurrency

Required. Defines the lookup values for each ISO standard code. You must validate that it is an active currency.

Table and Column: ENTITY.Reporting_Currency_Code

Type: String

billingCurrency

Optional. Defines the lookup values for each ISO standard code. You must validate that the billing currency is an active currency.

Table and Column: ENTITY.Billing_Currency_Code

Type: String

externalID

Required. Refers to the originating system's set of books ID.

Table and Column: ENTITY.External_ID

Type: String

defaultProjectClass

Represents the project class for the entity. Validated against project classes.

Table and Column: ENTITY.PROJECT_CLASS

Type: String

defaultWIPClass

Represents the default WIP class for the entity. Validated against WIP classes

Table and Column: ENTITY.WIP_CLASS

Type: String

defaultClientClass

Represents the default client class for the entity.

Table and Column: ENTITY.CLIENT_CLASS

Type: String

defaultBatchCycle

Represents the default batch cycle for the entity.

Table and Column: ?

Type: String

defaultLaborRateSource

Defines the default rate matrix for labor transactions for the entity.Validated against matrices.

Table and Column: ENTITY.TRANS_RATE_SOURCE_LABOR

Type: String (in schema). Number (in CA Clarity).

defaultLaborCostSource

Defines the default cost rate matrix for labor transactions for the entity. Validated against matrices.

Table and Column: ENTITY.TRANS_COST_SOURCE_LABOR

Type: String (in schema). Number (in CA Clarity).

defaultLaborSourceLocation

Defines the default location for labor transactions for the entity.

Table and Column: ENTITY.TRANS_LOCATION_LABOR

Type: String

Values: Project and Resource

defaultMaterialRateSource

Optional. Defines the default rate matrix for rate of material transactions for the entity. Validated against matrices.

Table and Column: ENTITY.TRANS_RATE_SOURCE_MATERIALS

Type: String (in schema). Number (in CA Clarity).

defaultEquipmentRateSource

Optional. Defines the default rate matrix ID for equipment transactions for the entity. Validated against matrices.

Table and Column: ENTITY.TRANS_RATE_SOURCE_EQUIPMENT

Type: String (in schema). Number (in CA Clarity).

defaultExpenseRateSource

Optional. Defines the default rate matrix for expense transactions for the entity. Validated against matrices.

Table and Column: ENTITY.TRANS_RATE_SOURCE_EXPENSE

Type: String (in schema). Number (in CA Clarity).

exchangeRateTypeLabor

Optional. Defines the labor exchange rate type for the entity.

Table and Column: ENTITY. EXCHANGE_RATE_TYPE_LABOR

Type: String

exchangeRateTypeMaterials

Optional. Defines the materials exchange rate type for the entity.

Table and Column: ENTITY. EXCHANGE_RATE_TYPE_ MATERIALS

Type: String

exchangeRateTypeEquipment

Optional. Defines the equipment exchange rate type for the entity.

Table and Column: ENTITY. EXCHANGE_RATE_TYPE_ EQUIPMENT

Type: String

exchangeRateTypeExpense

Optional. Defines the expense exchange rate type for entity.

Table and Column: ENTITY. EXCHANGE_RATE_TYPE_ EXPENSE

Type: String

Description Schema Tag

This tag is part of the schema mapping for the Entity XOG object. It is used to describe the entity. It has the following attribute:

Description

Required. Defines the description of the entity.

Table and Column: ENTITY.description

Type: String

Short Description (shortDescription) Schema Tag

This tag is part of the schema mapping for the Entity XOG object. The short description for the entity. It has the following attribute:

short description

Required. Defines the short description tag.

Table and Column: ENTITY.shortdesc

Type: String

OBS Types (obsTypes) Schema Tag

This tag is part of the schema mapping for the Entity XOG object. The tag describes the OBS types associated with the entity.

This obsTypes schema tag can include 0 to n number of obs tags.

Each obs tag is composed of the following child elements:

level (minimum 1, maximum 10)
objectAssociation (minimum 0, maximum unbounded)
unit (minimum 0, maximum unbounded)

obs

The obs tag has the following attributes:

code

Required. Defines the unique code for OBS type.

Table and Column: PRJ_OBS_TYPES.unique_name

Type: String

name

Required. Defines the name of the OBS type.

Table and Column: PRJ_OBS_TYPES.name

Type: String

description

Optional. Describes the OBS type.

Table and Column: PRJ_OBS_TYPES.description

Type: String

level

This child element represents a level in the OBS type. At lease one level is required. level has the following attributes:

Name

Required. The name for the level.

Table and Column: Prj_Obs_Levels.Name

Type: String

depth

Required. The depth of the OBS level.

Table and Column: Prj_Obs_Levels.obs_level

Type: Integer (allowed value 1 to 10)

objectAssociation

This child element represents the object types associated with the OBS type. This tag is optional.

object

Required. The name of the object type associated to this OBS.

Table and Name: Prj_Obs_Associations.table_name

Type: String

associationType

Required.

Possible Values: Any Unit, Lowest Level

Table and Name: prj_obs_object_types.is_leaf_only

Type: String

unit

This unit tag represents the units for this OBS type. This tag is optional.

Each unit is composed of the following child elements:

associatedObject
rights
Security

The unit schema tag has the following attributes:

code

Required. Defines the unique code for OBS unit.

Table and Column: PRJ_OBS_UNITS.unique_name

Type: String

name

Required. Defines the name of the OBS unit.

Table and Column: PRJ_OBS_UNITS.name

Type: String

GL Periods [GLPeriods] Schema tag

This tag is part of the schema mapping for the Entity XOG object. The tag describes the GL periods associated with the entity. This schema tag has the following attributes:

periodName

Required. Defines the GL period name.

Table and Column: ?

Type: String

period

Required. Defines the GL period.

Table and Column: ?

Type: Non-negative integer

quarter

Defines the GL quarter.

Table and Column: ?

Type: Non-negative integer

year

Defines the GL year.

Type: Non-negative integer

startDate

Required. Defines the GL period start date.

Type: String

endDate

Required. Defines the GL period end date.

Type: String

description

Optional. Describes the GL period.

Type: String

periodType

Required. Describes the GL period type.

Table and Column: BIZ_COM_PERIODS.PERIOD_TYPE

Type: String

entityId

Required. Provides a unique ID for the GL period.

Table and Column: BIZ_COM_PERIODS.ENTITY_ID

Type: String (Number in database)

isActive

Optional. Indicates if the GL period is active

Table and Column: BIZ_COM_PERIODS.IS_ACTIVE

Type: Boolean (Number in database)

Plan Defaults [PlanDefaults] Schema Tag

This tag is part of the schema mapping for the Entity XOG object. The tag describes the plan defaults associated with the entity. An entity can have only one planDefaults.

This tag includes the child element GroupingAttributes.

The planDefaults schema tag includes the following attributes:

periodTypeCode

The fiscal time period type for planDefaults.

Table and Column: FIN_PLAN_DEFAULTS.PERIOD_TYPE_CODE

Possible Values: WEEKLY, 13_PERIODS_PER_YEAR, SEMI_MONTHLY, MONTHLY, QUARTERLY, and ANNUALLY.

Type: String

startPeriodName

The start period name for planDefaults.

Table and Column: FIN_PLAN_DEFAULTS. START_PERIOD_ID

Type: String (Number in database)

endPeriodName

The end period name for planDefaults.

Table and Column: FIN_PLAN_DEFAULTS. END_PERIOD_ID

Type: String (Number in database)

lockPlanStructure

Flag to identify whether to lock the plan structure (grouping attributes) for planDefaults.

Table and Column: FIN_PLAN_DEFAULTS. LOCK_PLAN_STRUCTURE

Type: Boolean (Number in database)

freezeDate

The freeze date for planDefaults. This means details pertaining to the financial plans of this entity can be edited only if the startDate of a particular period is after this freeze date.

Table and Column: FIN_PLAN_DEFAULTS. FREEZE_DATE

Type: Date

Grouping Attributes Schema Tag

This tag is a child element of the Plan Defaults schema tag. The tag can have a minimum of one and up to 10 grouping attributes.

The tag has the following attributes:

Grouping Attribute

Specifies the grouping attributes for the plan defaults for an entity.

Table and Column: ODF_MULTI_VALUED_LOOKUPS.VALUE

Type: String

Financial Transaction

Use the financial transaction XOG object to view inbound and outbound financial transaction attributes for investments. This XOG object exports WIP transactions from PPA_WWP table so that the data can be imported into an ERP or other enterprise system.

Schema Name

nikuxog_commonTransaction.xsd

Read and Write XML Files

The following XML files are included:

imp_transactions_read.xml. Use this file to export financial transaction attributes for investments from CA Clarity.
imp_transactions_write.xml. Use this file to import financial transaction attributes for investments that were previously exported from CA Clarity.

Prerequisites

Before using this XOG object, make sure that all foreign key references of the financial transaction (for example, resource, investment, and others) have been defined.

Business Rules and Processing

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

The XOG processes WIP transactions based on the following fields:

transactionType

Defines the financial transaction type.

Values: L, M, X, or Q.

projectID

The valid project ID.

clientID

The valid company ID.

transactionDate

Enter Start Date, and End Date to get transaction data for all projects between the dates specified.
And and Or processing is supported among these fields.
Transactions on hold or in error are not processed.
Once a transaction is exported, XOG_EXPORTED is flagged and EXPORTED_DATE is stamped with the time and date in the PPA_WIP and PPA_BILLINGS tables. For adjustments and reversals, a negative amount is exported (or a positive amount if the posting was negative).

Read Filters

None

Schema Mappings

The schema mappings are provided for the following Financial Transaction tag names:

Transactions Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object. It has the following attributes:

transactionID

Required. The transaction identifier. It must be unique.

Table and Column: TRANSNO

Type: Number

applyToTransactionID

Optional. If the transaction is an adjusted, reversed, or transferred transaction, then applyToTransactionID refers to the parent transaction. Otherwise this field is not public.

Table and Column: APPLYTO

Type: Number

clientID

Required. The company identifier.

Table and Column: COMPANY_CODE

Type: String

clientName

Required. Derived from company ID.

Table and Column: CLNTSUPP.COMPANY_NAME

Type: String

projectID

Required. The project identifier.

Table and Column: PROJECT_CODE

Type: String

projectName

Required. Derived from project ID

Table and Column: SRM_PROJECTS.NAME

Type: String

taskID

Optional. A valid task identifier.

Table and Column: TASK_ID

Type: Number

taskName

Optional. Derived from task ID.

Table and Column: PRTASK. PRNAME

Type: String

transactionDate

Required. The date of the transaction.

Table and Column: TRANSDATE

Type: Date

resourceID

Required. The resource identifier.

Table and Column: RESOURCE_CODE

Type: String

resourceName

Required. Derived from resource ID.

Table and Column: SRM_RESOURCES.FULL_NAME

Type: String

roleID

Optional. The role identifier.

Table and Column: ROLE_CODE

Type: String

transactionType

Required. The transaction type.

Table and Column: TRANSTYPE

Type: String

chargeCode

Required. A valid charge code.

Table and Column: COSTCODE

Type: String

inputTypeCode

Optional. Valid input type code

Table and Column: INPUT_TYPE

Type: String

chargeable

Required. Indicates if the transaction can be charged to the company.

Values:

0. Not chargeable
1. chargeable

Table and Column: CHARGEABLE

Type: Number

units

Required. The number of units.

Table and Column: QUANTITY

Type: Number

CurrencyValue ->actualCostRate

Required.

Table and Column: PPA_WIP_VALUES.ACTUALCOST

Type: Number

CurrencyValue ->actualCostRateCurrency

Required. Currency code for actual cost rate

Table and Column: PPA_WIP_VALUES.COST_CURRENCY_CODE

Type: String

CurrencyValue ->stdCostRate

Required. The cost rate per unit.

Table and Column: PPA_WIP_VALUES.STDCOST

Type: Number

CurrencyValue ->stdCostRateCurrency

Optional. The cCurrency code for standard cost rate.

Table and Column: PPA_WIP_VALUES.STDCOST_CURRENCY_CODE

Type: String

CurrencyValue ->billRate

Required. The billing rate per unit.

Table and Column: PPA_WIP_VALUES.BILLRATE

Type: Number

CurrencyValue ->billRateCurrency

Required. The currency code for bill rate.

Table and Column: PPA_WIP_VALUES.RATE_CURRENCY_CODE

Type: String

CurrencyValue-> currencyType

Required. Indicates the currency transaction in the values table. This picks up the HOME, BILLING & NATURAL transaction lines.

Table and Column: PPA_WIP_VALUES.CURRENCY_TYPE

Type: String

CurrencyValue ->totalCost

Required. The ActualCost x quantity.

Table and Column: PPA_WIP_VALUES.TOTALCOST

Type: Number

CurrencyValue ->totalAmount

Required. The (BillRate x quantity) + Factor + Burden + Overhead

Table and Column: PPA_WIP_VALUES.TOTALAMOUNT

Type: String

vendorCode

Optional. The vendor code associated with the transaction.

Table and Column: PPA_WIP_APINFO.VENDOR_CODE

Type: String

notes

Optional. Additional information.

Table and Column: NOTES

Type: String

transactionStatus

Required. The status of the transaction.

Values:

0. Normal
1. Adjusted
2. Reversed
4. Under-adjust
8. Under-bill

Table and Column: STATUS

Type: Number

CurrencyValue ->amountRemaining

Required. The Total Amount - Amount Billed.

Table and Column: PPA_WIP_VALUES.AMOUNTREMAINING

Type: Number

userLov1

Optional. Refers to PRTIMEENTRY_USERLOV1.

Table and Column: USER_LOV1

Type: String

userLov2

Optional. Refers to PRTIMEENTRY_USERLOV2.

Table and Column: USER_LOV2

Type: String

expenseType

Optional. Either CAPITAL_EXPENDITURE or DEPRECIATION.

Table and Column: EXPENSE_TYPE

Type: String

Transaction Import Schema Tag

The transaction import tag is part of the schema mapping for the Financial Transaction XOG object. It has the following attributes:

externalID

Required. The external identifier. The value must be unique.

Table and Column: EXTERNALID

Type: String

clientID

Optional. The valid company ID. If the client ID is empty, the value is taken from the project.

Table and Column: COMPANY_CODE

Type: String

projectID

Required. The valid project ID.

Table and Column: PROJECT_CODE

Type: String

taskID

Required. The valid internal task ID.

Table and Column: TASKID

Type: Number

transactionDate

Required. The date of the transaction. It must be between the project start and end dates.

Table and Column: TRANSDATE

Type: Date

resourceID

Optional. The resource ID associated with the transaction, when applicable. Otherwise, the resource ID from Cost Key Definition default.

Table and Column: RESOURCE_CODE

Type: String

roleID

Optional. The valid role identifier.

Table and Column: ROLE_CODE

Type: String

transactionType

Required. Defines the transaction type.

Values: L, M, X, and Q

Table and Column: TRANSTYPE

Type: String

chargeCode

Optional. A valid charge code.

Table and Column: CHARGE_CODE

Type: String

inputTypeCode

Optional. A valid input type.

Table and Column: INPUT_TYPE

Type: String

Chargeable

Optional. Indicates if the transaction is chargeable to the company.

Values:

0. Not chargeable
1. chargeable

Default: 0

Table and Column: CHARGEABLE

Type: Number

Units

The number of units (for all expense transactions). Not required for expense transactions, but required for all other transaction types.

Values: L, M, and Q (Quantity)

Table and Column: QUANTITY

Type: Number

actualCostRate

Optional. Cost rate per unit. It must be a valid number. If not specified, the cost is taken from the rate matrix.

Table and Column: PPA_WIP_VALUES.ACTUALCOST

Type: Number

actualCostRateCurrency

Optional. ISO currency code for actual cost rate.

Table and Column: PPA_WIP_VALUES.COST_CURRENCY_CODE

Type: String

BillRate

Optional. The billing rate per unit; must be a valid number; if not specified, rate will be picked up from the rate matrix.

Table and Column: RATE

Type: Number

billRateCurrency

Optional. ISO currency code for the bill rate.

Table and Column: RATE_CURRENCY

Type: String

notes

Optional. Additional information.

Table and Column: NOTES

Type: String

importStatus

Optional. The allowed value is N for New.

Table and Column: IMPORTSTATUS

Type: String

importDate

Optional. The date the transaction was imported. If not specified, the current server date is used.

Table and Column: IMPORTDATE

Type: Date

General Ledger Account

The general ledger (GL) account XOG object represents the chart of accounts used to process chargebacks. Use this XOG object to view inbound and outbound general ledger account attributes.

Schema Name

nikuxog_glaccount.xsd

Read and Write XML Files

The following XML files are included:

pac_glaccount_read.xml. Use this file to export GL accounts from CA Clarity.
pac_glaccount_write.xml. Use this file to import GL accounts that were previously exported from CA Clarity.

Prerequisites

The following conditions must be met before using this XOG:

The entities referenced by the GL Accounts must exist prior to importing GL accounts.
The Account Class must be a valid lookup value in CA Clarity.
The Account Type must be a valid lookup value in CA Clarity.

Business Rules and Processing

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

The GL chart of accounts is imported into CA Clarity from an external accounting system. These accounts are used by the Chargeback feature to capture charges and credits.
The GL accounts schema is defined as part of the first step to GL integration.
To enable GL transactions between systems, CA Clarity allows for inbound processing to define GL Accounts, Periods, and Entities. GL Accounts establishes the accounts to which transactions can be posted.

Read Filters

The following explicit read filters are used:

MAIN_ACCOUNT_ID. This is used for filtering by mainAcctId, which is a part of the natural GL account code.
SUB_ACCOUNT_ID. This is used for filtering by subAcctId, which is a part of the natural GL account code.
ACCOUNT_DESCRIPTION. This is used for filtering by description.

Error Handling

If a GL Account file is unsuccessful due to an error, the following fields are output:

entity
accountNumber
externalId
externalSource

Schema Mappings

The following schema mapping is provided for the outbound Financial Transaction tag name, GLAccount:

GLAccount

GLAccount Schema Tag

This tag is part of the schema mapping for the General Ledger XOG object. The values in this table are unlike other lookup values. A text string must be provided, not a lookup code.

The GLAccount schema tag has the following attributes:

entity

Defines the entity name for the GL account code. This attribute is a unique primary key, browse field. Lookup to DPT_ENTITY_DEPT.

Table and Column: Entity

Type: Lookup

mainAcctId

Required. Part of the natural GL account code.

Table and Column: MAIN_ACCOUNT_ID

Type: String

subAcctId

Required. Part of the natural GL account code.

Table and Column: SUB_ACCOUNT_ID

Type: String

Overhead

Optional. Indicates if the GL account is an overhead account.

Table and Column: OVERHEAD

Type: Boolean

Capitalexpense

Indicates if the GL account is a capital expense account.

Table and Column: CAPITAL_EXPENSE

Type: Boolean

noncashexpense

Indicates if the GL account is a non-cash expense account.

Table and Column: NONCASH_EXPENSE

Type: Boolean

description

Defines the description of the general ledger account.

Table and Column: Description

Type: String

Account Type

Required. Defines the GL account type. This attribute determines whether the GL account is a Balance Sheet account or a P&L account. A default is set in the background. Lookup to PAC_CHG_GL_ACCOUNT_TYPE

Table and Column: ACCOUNT_TYPE

Type: Number

Default: Lookup

accountClass

Optional. This attribute determines whether the GL account is an asset or liability. A default is set in the background. Lookup to PAC_CHG_GL_ACCOUNT_CLASS.

Default: 0

Table and Column: ACCOUNT_CLASS

Type: Lookup

Active

Indicates if the general ledger account is active.

Values:

0. Not Active
1. Active

Table and Column: Active

Type: Boolean

Default: 1

externalID

Defines the originating unique identifier.

Table and Column: External_ID

Type: String

externalSource

Defines the external source. The lookup value is the originating system ID.

Example: Oracle

Table and Column: External_Source_ID

Type: String in Schema, but stored as Number in CA Clarity.

General Ledger Allocation Rule

The GL Allocation Rule XOG object represents the debit and credit rules in chargebacks. Use the General Ledger Allocations Rule XOG object to import and export GL allocation rules.

Schema Name

nikuxog_glallocation.xsd

Read and Write XML Files

The following XML files are included:

cbk_allocation_read.xml. Use this file to export GL allocations from CA Clarity.
cbk_allocations_read.xml. Use this file to import GL allocations that were previously exported from CA Clarity.

Prerequisites

Before importing the GL allocation rules, make sure the entities referenced by these rules exist.

Business Rules and Processing

The insert or update of GL Allocation rules are based on the existence of the GL Allocation code in CA Clarity. The GL Allocation code is unique.

Read Filters

The following explicit read filters are used:

ALLOCATION_CODE. A unique code that is used for filtering by the allocation code.
STATUS. This is used for filtering by status (Active, Inactive, or On Hold)
CBK_TYPE. This is used for filtering by chargeback type (Debit, Credit)
CBK_SUB_TYPE. This is used for filtering by chargeback sub type (Standard, Investment or Overhead)

Schema Mapping

The following schema tag is included:

GL Allocation Rule

GL Allocation Rule Schema Tag

The GL allocation rule tag is part of the schema mapping for the General Ledger Allocation Rule XOG object. It has the following attributes:

entityCode

Optional. Defines the unique identifier of the entity tied to the GL allocation rule.

Table and Column: ENTITY_ID

Type: String

locationCode

Optional. Defines the location unique identifier tied to the GL allocation rule.

Table and Column: LOCATION_ID

Type: String

departmentCode

Optional. Defines the department unique identifier tied to the GL allocation rule.

Table and Column: DEPARTMENT_ID

Type: Boolean

resourceClassCode

Optional. Defines the resource class unique identifier tied to the GL allocation rule.

Table and Column: RESOURCECLASS_ID

Type: Boolean

chargeCode

Optional. Defines the charge code unique identifier tied to the GL allocation rule.

Table and Column: PRCHARGECODE_ID

Type: Boolean

investmentCode

Optional. Defines the investment unique identifier tied to the GL allocation rule.

Table and Column: INVESTMENT_ID

Type: Number

utilityCode1

Optional. The lookup to BROWSE_USR_VAL1_ALL.

Table and Column: UTILITY_CODE_1

Type: Lookup

utilityCode2

Optional. The lookup to PRTIMEENTRY_USERLOV2.

Table and Column: UTILITY_CODE_2

Type: Lookup

transactionClassCode

Optional. The lookup to FIN_TRANSCLASSES.

Table and Column: TRANSCLASS

Type: Lookup

typeCode

Optional. The lookup to LOOKUP_INPUT_TYPES.

Table and Column: PRTYPECODE_unique identifier

Type: Lookup

statusCode

Required. The lookup to STATUS_CODE.

Values: Open and Closed

Table and Column: PAC_CHG_STATUS

Type: Lookup

chargeRemToOverhead

Optional. Indicates if the rule charges the reminder to overhead.

Table and Column: CHG_REM_TO_OVERHEAD

Type: Boolean

cbkType

Required. Specifies the chargeback type.

Values: DEBIT and CREDIT

Table and Column: CHARGEBACK_TYPE

Type: String

cbkSubtype

Required. Specifies the chargeback subtype.

Values: STANDARD, INVESTMENT and OVERHEAD

Table and Column: CHARGEBACK_SUBTYPE

Type: String

Allocation Details

glAccountMain, glAccountSub

Required. Defines the main GL account. Lookup to SCH_BROWSE_GL_ACCTS.

Table and Column: GL_ACCOUNT_ID

Type: Lookup

department

Required. Defines the unique identifier of the department to charge. Lookup to SCH_BROWSE_DEPT.

Table and Column: DEPARTMENT_ID

Type: Lookup

flatAmount

Optional. This attribute is not used.

Table and Column: FLAT_AMOUNT

Type: Numeric

weightable

Optional. This attribute is not used.

Table and Column:WEIGHTAGE

Type: Numeric

General Ledger Period

Use the general ledger period XOG object to view inbound and outbound general ledger period attributes.

Schema Name

xog_glperiod.xsd

Read and Write XML Files

The following XML files are included:

pac_glperiod_read.xml. Use this file to export GL periods from CA Clarity.
pac_glperiod_write.xml. Use this file to import GL periods that were previously exported from CA Clarity.

Business Rules and Processing

GL Periods are only defined for inbound (write) processing to CA Clarity. This schema is defined as part of the first step to GL integration.

Read Filters

None

Error Handling

If a GL Period file is unsuccessful due to an error, the following fields are output:

Period Name
Period Type
Period Number
Description
Quarter
Year
Start Date

Schema Mappings

Schema mappings are described for the following outbound General Ledger Period tag name:

Glperiod

Glperiod Schema Tag

This tag is part of the schema mapping for the General Ledger Period XOG object. It has the following attributes:

entity

Required. The unique primary key. A browse field associating the period to an entity.

Table and Column: Entity

Type: String

Period

Required. Defines the unique primary key. The fiscal period (i.e., date) posted for the selected entity.

Table and Column: Period

Type: Date

currentPeriod

Required. Defines the status of the resource.

Values:

1. True
0. False

Default: 1

Table and Column: Currentperiod

Type: Boolean

externalId

Required. The originating unique ID.

Table and Column: External_ID

Type: String

externalSource

Required. A lookup value is the originating system ID (for example, Oracle).

Table and Column: External_Source_ID

Type: String in schema, but stored as Number in the database.

General Ledger Transaction

GL transactions represents an entry in the General Ledger. It includes information such as the accounts credited or debited and other financial transaction information. Use the general ledger transaction XOG object to view outbound general ledger attributes.

Schema Names

nikuxog_transaction.xsd

Read and Write XML Files

The following XML files are included:

pac_gltransactions_read.xml. Use this file to export GL transactions from CA Clarity.
pac_gltransactions_write.xml. Use this file to import GL transactions that were previously exported from CA Clarity.

Prerequisites

The GL transaction must belong to an invoice.

Business Rules and Processing

The GL Transactions schema is defined for outbound (read) GL processing. The GL Transaction object is used to export the data from the CBK_GL_TXNS and CBK_GL_TXN_VALUES tables.

Read Filters

The following explicit read filters are used:

transactionSource. This is used to filter GL transactions by the transaction source (W for WIP, A for Adjusted, or R for Reversed).
entity. This is used to filter by GL transactions by entity.
periodStart. This is used to filter GL transactions by the fiscal period start date, a date filter.
periodEnd. This is used to filter GL transactions by the fiscal period end date, a date filter.
investment_id. This filter is used to filter GL Transactions by the investment.

XOG allows for outbound processing of GL Transactions based upon the value within the glposted field.

When querying the database, by default the query returns all GL transactions where glposted is not equal to 'Y', (that is, transactions are awaiting posting). Once selected and invoices processes, the glposted field is updated to 'Y' to indicate they have been sent to the GL.

Error Handling

Read Transactions

Error handling for read transactions from CA Clarity databases are due to an invalid formats or database unavailability. The adaptor or middleware must handle transaction-level error handling when mapping and transporting into the accounting system. If one transaction is found to be in error, the entire file is not committed. The file must be fixed and resubmitted to keep the balance of debits and credits.

XOG does not have control of processing once an output file is successfully created. If you find an error in the output, you will need to rollback the entire batch to keep debits and credits intact.

If a single record within the batch is found to be in error, the entire batch is rejected. Then:

The external system (adaptor or middleware) must call the Update Transactions schema and provide the error information element tag and the key fields of the error records.
XOG processes the input file and copies all the GL transaction records from the GLCONTROL table into the GLEXCEPTION table.
XOG deletes the records from the GL Control table so they exist in the GLException table.
XOG resets the GLPOSTED field for the transactions from the batch in the PPA_WIP and PPA_BILLING table to 'N' from 'P' (depending if the transaction source is B or W).

You must fix the error batches via CA Clarity, re-post to GLControl, and rerun the XOG to extract the GL transaction records.

Update Transactions

If the entire file cannot be committed, it must be fixed and resubmitted. This is important as all debits and credits must be kept in sync across applications. If an error is found, it is written to the error log. The following fields help to identify the transaction in error:

transactionNumber
transactionSource
sequenceNumber

Schema Mappings

Schema mappings are described for the following outbound General Ledger Transaction tag name:

GLtransaction

GLtransaction Schema Tag

This tag is part of the schema mapping for the General Ledger Transaction XOG object. It has the following attributes:

entity

Optional. The name of the entity for the GL transaction.

Table and Column: CBK_GL_TXNS.ENTITY_ID

Type: String

accountCode

Required. The GL account code.

Table and Column: CBK_GL_TXNS.GL_ACCOUNT_ID

Type: String

amount

Optional. The amount of the transaction.

Table and Column: CBK_GL_TXN_VALUES.AMOUNT

Type: Float

currency

Optional. The currency code of the transaction amount.

Table and Column: CBK_GL_TXN_VALUES.CURRENCY_TYPE, CBK_GL_TXN_VALUES.CURRENCY_CODE

Type: String

transactionNumber

Required. A unique primary key. The transaction number from WIP or PPA-billings.

Table and Column: CBK_GL_TXN_VALUES.TRANSACTION_ID

Type: Positive Integer

transactionSource

Required. A unique primary key. This allows you to define the GL distribution of a transaction based on the module where it originated.

Values:

W. From WIP.
A. From billing.
D. From credit.

Table and Column: TRANSACTION_SOURCE

Type: String

period

Required. The gl period for the transaction.

Table and Column: PPA_WIP.GLPERIOD

Type: String

InvoiceDate

Required. The date of the invoice to which the GL transaction belongs. It must be between the project start and end dates.

Table and Column: CBK_INVOICE.INVOICE_DATE

Type: Date

department

Required. The department id of the transaction

Table and Column: CBK_GL_TXNS.DEPARTMENT_ID

Type: String

transactionDate

Required. The date of the transaction.

Table and Column: CBK_GL_TXNS.TRANSACTION_DATE

Type: Date

investment

Required. The investment on which the transaction is posted.

Table and Column: CBK_GL_TXNS.TRN_INV_ID

Type: String

Idea

The Idea XOG object extends the common investment object as Ideas are a type of investment. Use this XOG object to view inbound (write) and outbound (read) idea processing.

Schema Names

nikuxog_idea.xsd. Use to view inbound idea attributes. It determines which XML elements and attributes are required to import idea information from an external system into CA Clarity.
nikuxog_read.xsd. Use to view outbound idea attributes. It determines the XML format required to export idea information from CA Clarity to another system.

Read and Write XML Files

The following XML files are included:

ideas_read.xml. Use this file to export idea object instances from CA Clarity.
ideas_write.xml. Use this file to import idea object instances that were previously exported from CA Clarity.

Prerequisites

The manager username should exist.

Business Rules and Processing

Prior to importing ideas, the following items must be correctly set up:

ID: The unique identifier for the idea. If the ID does not exist, the XML schema creates a new idea record unless auto-numbering is enabled (then an error is generated and posted to the Success and Error files). If the XOG input includes an idea ID, and an idea with the same ID is found, that record is updated.
Summary: The summary of the idea.
Finish date: The completion date for the idea. If a finish date exists, there must also be a start date. The finish date must also be greater than the start date.
Break-even date: This is the date when the idea is to break-even. If a break-even date exists, it must be greater than or equal to the start date.

Read Filters

The following explicit read filters are used with this XOG:

objectId
managerUserName
lastUpdatedDate

Error Handling

Manager username must be set to NULL if it does not exist in CA Clarity.

Schema Mappings

Idea is composed of the following elements, which are inherited from the investment object, and idea-specific mapping found in the Idea Schema tag:

Allocations
scenarioDependencies
InvestmentAssociations
InvestmentBaselines
InvestmentResources
InvestmentTasks
General
OBSAssocs
CustomInformation

Ideas are different from other investments because they do not include child investments. You can only associate ideas with a simple budget, and they do not have full financial planning capabilities like other investment types.

Idea Schema Tag

This tag is part of the schema mapping for the Idea XOG object. It has the following attributes:

Note: The import validation rule applies only if it is different from the object attribute-level validation rule

ideaspriority

Optional. Defines the priority for the idea.

Table and Column: INV_IDEAS.PRIORITY

Values: High, Medium, Low

estimateType

Optional.

Table and Column: INV_IDEAS.EST_TYPE

Type: Number

Values: Historical, Analytical, High Level, and Commitment

estimatedCost

Optional.

Table and Column: INV_IDEAS.EST_COST

Type: nonNegativeDouble

estimatedBenefit

Optional.

Table and Column: INV_IDEAS.EST_BENEFIT

Type: nonNegativeDouble

benefitDescription

Optional.

Table and Column: INV_IDEAS.BENEFIT_DESC

Type: String

generalNotes

Optional.

Table and Column: INV_IDEAS.GENERAL_NOTES

Type: String

businessUnit

Optional.

Table and Column: INV_IDEAS.BUS_UNIT

Type: String

breakevenDate

Optional.

Table and Column: INV_IDEAS.BREAKEVEN_DATE

Type: investmentDateTimeType

impact

Optional.

Table and Column: INV_IDEAS.IMPACT

Type: String

risks

Optional.

Table and Column: INV_IDEAS.RISKS

Type: String

dependencies

Optional.

Table and Column: INV_IDEAS.DEPENDENCIES

Type: String

estimatedStartDate

Optional.

Table and Column: INV_IDEAS.EST_START_DATE

Type: investmentDateTimeType

estimatedFinishDate

Optional.

Table and Column: INV_IDEAS.EST_FINISH_DATE

Type: investmentDateTimeType

conversionDate

Optional.

Table and Column: INV_IDEAS.CONVERSION_DATE

Type: investmentDateTimeType

createdDate

Optional.

Table and Column: INV_IDEAS.PMA_IDEA.CREATED_DATE

createdBy

Optional.

Table and Column: INV_IDEAS.PMA_IDEA.CREATED_BY

lastUpdatedDate

Optional.

Table and Column: INV_IDEAS.PMA_IDEA.LAST_UPDATED_DATE

lastUpdatedBy

Optional.

Table and Column: INV_IDEAS.PMA_IDEA.LAST_UPDATED_BY

ideaspriority

Optional.

Table and Column: INV_IDEAS.PRIORITY

Type: Number

Import Validation Rule: The priority range used in ideas differs from the range used for investments.

targetManagerUserName

Optional.

Table and Column: INV_IDEAS.TARGET_MANAGER_ID

Type: String

Import Validation Rule: The name of the manager who is targeted to manage the investment after conversion from an idea.

Investments Schema Tag

This tag is part of the schema mapping for the Idea XOG object. The INV_INVESTMENTS table contains the shared investment attributes. This tag has the following attributes:

status

Optional. Defines the status of the investment.

Values: Open, Unapproved, Rejected, Approved, Incomplete, Submitted for Approval, and Converted

Default: Open

Table and Column: INV_INVESTMENTS.STATUS

Type: Number

name

Required.

Table and Column: INV_INVESTMENTS.NAME

Type: String

objectID

Optional. Autonumbering is required if it is not present.

Table and Column: INV_INVESTMENTS.CODE

Type: String

description

Optional.

Table and Column: INV_INVESTMENTS.DESCRIPTION

Type: String

priority

Optional.

Table and Column: INV_INVESTMENTS.PRIORITY

Type: Number

managerUserName

Optional.

Table and Column: INV_INVESTMENTS.MANAGER_ID

Type: String

approvedById

Optional.

Table and Column: INV_INVESTMENTS.APPROVEDBY_ID

Type: String

chargeCodeExtID

Optional.

Table and Column: INV_INVESTMENTS.CHARGECODEID

Type: String

approvedTime

Optional.

Table and Column: INV_INVESTMENTS.APPROVEDTIME

Type: investmentDateTimeType

processCode

Optional.

Table and Column: INV_INVESTMENTS.PROCESS_CODE

Type: investmentCodeType

stageCode

Optional.

Table and Column: INV_INVESTMENTS.STAGE_CODE

Type: investmentCodeType

goalCode

Optional.

Table and Column: INV_INVESTMENTS.GOAL_CODE

Type: investmentCodeType

alignment

Optional.

Table and Column: INV_INVESTMENTS.ALIGNMENT

Type: iNumber

risk

Optional.

Table and Column: INV_INVESTMENTS.RISK

Type: Number

statusIndicator

Optional.

Table and Column: INV_INVESTMENTS.STATUS_INDICATOR

Type: Number

statusComment

Optional.

Table and Column: INV_INVESTMENTS.STATUS_COMMENT

Type: String

progress

Optional.

Default: 0 - Not Started

Table and Column: INV_INVESTMENTS.SPROGRESS

Type: Number

currencyISOcode

Optional.

Note: This attribute replaces currencyCode

Table and Column: INV_INVESTMENTS.CURRENCY_CODE

Type: String

Budget Schema Tag

This tag is part of the schema mapping for the Ideas XOG object. The FIN_FINANCIALS table contains the shared budget attributes.

The Budget schema tag has the following attributes:

plannedCostTotal

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_TOTAL

Type: nonNegativeDouble

plannedCostStart

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_START

Type: investmentDateTimeType

plannedCostFinish

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_FINISH

Type: investmentDateTimeType

plannedBenTotal

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_TOTAL

Type: nonNegativeDouble

plannedBenStart

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_START

Type: investmentDateTimeType

plannedBenFinish

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_FINISH

Type: investmentDateTimeType

budgetCostTotal

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_TOTAL

Type: nonNegativeDouble

budgetCostStart

Optional.

Table and Column: FIN_FINANCIALS.BUDGET _CST_START

Type: investmentDateTimeType

budgetCostFinish

Optional.

Table and Column: FIN_FINANCIALS.BUDGET _CST_FINISH

Type: investmentDateTimeType

budgetCostOnHold

Optional.

Table and Column: FIN_FINANCIALS.BUDGET _CST_ONHOLD

Type: investmentDateTimeType

budgetCostResumed

Optional.

Table and Column: FIN_FINANCIALS.BUDGET _CST_RESUMED

Type: investmentDateTimeType

budgetRevTotal

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_TOTAL

Type: nonNegativeDouble

budgetRevStart

Optional

Table and Column: FIN_FINANCIALS.BUDGET_REV _START

Type: investmentDateTimeType

budgetRevFinish

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV _FINISH

Type: investmentDateTimeType

budgetRevOnHold

Optional.

Table and Column: FIN_FINANCIALS.BUDGET _REV_ONHOLD

Type: investmentDateTimeType

budgetRevResumed

Optional.

Table and Column: FIN_FINANCIALS.BUDGET _REV_RESUMED

Type: investmentDateTimeType

forecastCostTotal

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _CST_TOTAL

Type: nonNegativeDouble

forecastCostStart

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _CST_START

Type: investmentDateTimeType

forecastCostFinish

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _CST_FINISH

Type: investmentDateTimeType

forecastCostOnHold

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _CST_ONHOLD

Type: investmentDateTimeType

forecastCostResumed

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _CST_RESUMED

Type: investmentDateTimeType

forecastRevTotal

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _REV_TOTAL

Type: nonNegativeDouble

forecastRevStart

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _REV _START

Type: investmentDateTimeType

forecastRevFinish

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _REV _FINISH

Type: investmentDateTimeType

forecastRevOnHold

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _REV_ONHOLD

Type: investmentDateTimeType

forecastRevResumed

Optional.

Table and Column: FIN_FINANCIALS.FORECAST _REV_RESUMED

Type: investmentDateTimeType

plannedNPV

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_NPV

Type: Number

plannedROI

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_ROI

Type: Number

plannedBreakEven No

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BREAKEVEN

Type: investmentDateTimeType

budgetNPV

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_NPV

Type: Number

budgetROI

Table and Column: FIN_FINANCIALS.BUDGET_ROI

Type: Number

budgetBreakEven

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_BREAKEVEN

Type: investmentDateTimeType

setBudgetValuesEqualToPlannedValues

Optional.

Table and Column:

Type: Boolean

calculateFinancialMetrics

Optional.

Table and Column:

Type: Boolean

initialInvestment

This column refers to the initial, lump sum cost associated with an investment

Table and Column: FIN_FINANCIALS.INITIAL_INVESTMENT

Type: Number

plannedIRR

Internal Rate of Return on investment as calculated from the planned costs and planned benefits. This is used only in a XOG read result.

Table and Column: FIN_FINANCIALS.PLANNED_IRR

Type: Number

plannedMIRR

Modified internal rate of return on an investment as calculated from the planned costs and planned benefits. This is used only in a XOG read result.

Table and Column: FIN_FINANCIALS.PLANNED_MIRR

Type: Number

plannedPaybackPeriod

Payback period of investment as calculated from the planned costs and planned benefits. This is used only in a XOG read result.

Table and Column:FIN_FINANCIALS.PLANNED_PAYBACK_PERIOD

Type: Number

budgetIRR

Internal rate of return on an investment as calculated from the budgeted costs and budgeted benefits. This is used only in a XOG read result.

Table and Column: FIN_FINANCIALS.BUDGET _IRR

Type: Number

budgetMIRR

Modified internal rate of return on an investment as calculated from the budgeted costs and budgeted benefits. This is used only in a XOG read result.

Table and Column: FIN_FINANCIALS.BUDGET_MIRR

Type: Number

budgetPaybackPeriod

Payback Period of investment as calculated from the budgeted costs and budgeted benefits. This is used only in XOG read result.

Table and Column: FIN_FINANCIALS.BUDGET _PAYBACK_PERIOD

Type: Number

useSystemDefinedTotalCostOfCapital

This column indicates whether an investment uses the system-defined reinvestment rate % for financial metrics calculations.

Table and Column: FIN_FINANCIALS.IS_SYS_VAL_FOR_TCC

Type: Boolean

investmentDefinedTotalCostOfCapital

Investment-specific total cost of capital percentage used for financial metrics calculations based on the value of IS_SYS_VAL_FOR_TCC.

Table and Column: FIN_FINANCIALS.TOTAL_COST_OF_CAPITAL

Type: Number

useSystemDefinedReinvestmentRate

Indicates whether an investment uses the system-defined total cost of capital percentage for financial metrics calculations.

Table and Column: FIN_FINANCIALS.IS_SYS_VAL_FOR_RR

Type: Boolean

investmentDefinedReinvestmentRate

Investment-specific reinvestment rate percentage used for financial metrics calculations based on the value of IS_SYS_VAL_FOR_RR

Table and Column: FIN_FINANCIALS.REINVESTMENT_RATE

Type: String

Inbound Transaction

Use the inbound transaction XOG object to view inbound and outbound inbound transactions. Inbound transactions are the cost and/or revenue posted for tasks or investments.

Schema Name

nikuxog_inboundTransaction.xsd

Read and Write XML Files

The following XML files are included:

imp_transactions_read.xml. Use this file to export inbound incident attributes from CA Clarity.
imp_transactions_read.xml. Use this file to import inbound incident attributes that were previously exported from CA Clarity.

Prerequisites

None

Read Filters

The following explicit read filters are used:

projectID: Defines the name of the investment.
clientID: Defines the company unique identifier.
transactionSource: Defines the transaction source.
transactionDate: Defines the date of the transaction.

Error Handling

The following error can be thrown:

Wip Transaction Object read failed.

Schema Mapping

Mappings for the following schema tag name is provided:

inboundTransactionType

inboundTransactionType Schema Tag

The inboundTransactionType tag is part of the schema mapping for the inbound transaction XOG object. This schema tag has the following attributes:

groupId

Optional. The group unique identifier for the voucher entry.

Table and Column: PPA_TRANSCONTROLAPINFO.ID

Type: Double

voucherNumber

Optional. The voucher number for the voucher entry.

Table - Field Name: PPA_TRANSCONTROLAPINFO.VOUCHERNO

Type: String

poNumber

Optional. The PO number for the voucher entry.

Table and Column: PPA_TRANSCONTROLAPINFO.PONO

Type: String

vendorCode

Optional. The vendor code for the voucher entry.

Table and Column: PPA_TRANSCONTROLAPINFO.VENDOR_CODE

Type: String

incurredBy

Optional. The group Id for the voucher entry.

Table and Column: PPA_TRANSCONTROLAPINFO.INCURRED_BY

Type: String

externalId

Optional. The external id for the voucher entry.

Table and Column: IMP_TRANSACTIONIMPORT.EXTERNAL_ID

Type: String

actualCostRate

Optional. The cost rate for the voucher entry.

Table and Column: IMP_TRANSACTIONIMPORT.COST

Type: Double

actualCostRateCurrency

Optional. The actual cost rate currency for the voucher entry.

Table and Column: IMP_TRANSACTIONIMPORT.COST_CURRENCY

Type: String

billRate

Optional. The bill rate for the voucher entry.

Table and Column: IMP_TRANSACTIONIMPORT.RATE

Type: Double

billRateCurrency

Optional. The billing rate currency for the voucher entry.

Table and Column: IMP_TRANSACTIONIMPORT.RATE_CURRENCY

Type: String

importStatus

Optional. The import status for the voucher entry. The only value allowed is 'N' which means New.

Table and Column: IMP_TRANSACTIONIMPORT.IMPORTSTATUS

Type: String

Incident

Use the incident XOG object to view inbound and outbound incident instances.

Schema Name

nikuxog_incident.xsd

Read and Write XML Files

The following XML files are included:

incident_read.xml. Use this file to export incident object instances from CA Clarity.
incident_write.xml. Use this file to import incident object instances that were previously exported from CA Clarity.

Prerequisites

The referred Investment must exist in the system.

Read Filters

None

Error Handling

The following errors can be thrown:

Required fields: Ensures all required fields have values.
Incident type is not valid.
Status is not valid.
Priority is not valid.
Urgency is not valid.
Impact is not valid.
Category is not valid.
Assigned To Code is not valid.
Reported By Code is not valid.
Assigned Project Manager Code is not valid.
External Source is not valid.
Investment Object {0} is not valid.
Resource for Effort is not valid.
Failed to export incident.
Failed to export category.
Failed to import incident.
Failed to import category.
Estimated Time to Complete cannot be negative.
Investment ID is not valid.
Required attribute categoryCode is missing.

Schema Mapping

The following incident schema tag names are provided to XOG incidents:

incidents Schema Tag

The incidents tag is part of the schema mapping for the incident XOG object. This is a placeholder tag for multiple incidents.

incident

The actual incident object. Incident has the following attributes:

incident_code

Required. Defines the unique incident code.

Table and Column: incidents.departcode

Type: String

short_description

Required. Defines the incident name.

Table and Column: incidents.shortdesc

Type: String

dept_identifier

Defines the general ledger segment value mapped to this incident.

Table and Column: incidents.departidentifier

Type: String

default_reviewer

Defines the default reviewer for the incident.

Table and Column: incidents.default_reviewer

Type: String

alt_default_reviewer

defines the alternate reviewer for the incident.

Table and Column: incidents.alt_default_reviewer

Type: String

parent_incident_code

Defines the code for parent incident.

Table and Column: parent_incident_id

Type: String

dept_manager_code

The incident manager resource code.

Table and Column: incidents.incident_manager_id

Type: String

brm_code

Defines the business relationship manager.

Table and Column: brm_id

Type: String

entity

Required. The identify for the entity to which the incident belongs.

Table and Column: incidentS.entity_id

Type: String

delegate_invoice_approval

Indicates if the incident delegates invoice approval.

Table and Column: incidentS.delegate_inv_appr

Type: Integer

incidents Schema Tag

The description tag is part of the schema mapping for the incident XOG object. This is a placeholder tag for multiple incidents, and has the following attributes:

description

Optional. Defines the description of the incident.

Table and Column: IMM_INCIDENTS.DESCRIPTION

Type: String

Investment

The investment XOG object is used by multiple objects all of which share a common foundation. The nikuxog_inv_common.xsd is a common schema shared among all investments. The schema definition contained in this file along with the extended schema definition in a specialized investment file together make up the schema for a particular investment type.

The investment object is an abstract object that you can only create as one of the following objects which extend the base investment object:

Project
Classes

Schema Name

nikuxog_inv_common.xsd

Read and Write XML Files

A generic read and write xml files is not included for investments. You can read or write investments in their specific investment type form, such as application, asset, or product. The following files contains part of the business logic used to read investments:

inv_common_read.xbl. Use this file to export investments from CA Clarity.
inv_common_write.xbl. Use this file to import investments that were previously exported from CA Clarity.

Prerequisites

Any referenced resources (for example, managerName) should exist in CA Clarity.

Business Rules and Processing

Objects which are based upon the Investment object are defined for inbound (write) and outbound (read) processing. The abstract Investment object itself cannot be written to or read from CA Clarity.

Read Filters

The following explicit read filters are used:

objectID. The investment object's unique ID.
managerUserName. The name of the investment manager.
lastUpdatedDate. The date when the investment was last modified.

Error Handling

The following errors can be thrown:

Exports are truncated if the number of Application objects retrieved is larger than the system default: 5000. This setting can be overridden by setting the argument args_maxrecords with a new max.
Charge code does not exist in the System.
Goal code does not exist in the System.
Category code does not exist in the System.
Process code does not exist in the System
Stage code does not exist in the System.
Approver does not exist in the System.
Currency must be active; on a multicurrency system it must have an exchange rate configured against the base currency.
Entity Code 'XXX' does not exist in the System at this time. Please re-run the XOG if it exists now.
Invalid Chargeback Type with name 'XXX'. This Chargeback Type could not be found in the System
Invalid Bill Expense Type with name 'XXX'. This Bill Expense Type could not be found in the System.
XOG user does not have Approval right for objects of type 'XXX'; status of 'YYY' remains unchanged.
Application with code 'XXX' does not exist in the System, and hence the Service is not updated with Application Code.
Target Manager User Name 'XXX' passed in does not exist in the system.
Investment has financial plans hence entityCode value "XXX" cannot be changed to YYY"
Investment has posted transactions hence entityCode value "XXX" cannot be changed to YYY".
OBS is Lowest Unit for 'XXX'. This unit path is not the lowest unit in its branch
OBS unit (XXX) is invalid.
OBS unit path (XXX) is invalid. So, the OBS Association was not made.
OBS id (XXX) is invalid. So, the OBS Association was not made.
OBS unit path is invalid. So the OBS security was not setup.
OBS unique name is invalid. So the OBS security was not setup.
Group is invalid. So the Group security was not setup.
User is invalid. So the User security was not setup.
{$departcode} and {$locationid} are not associated
{$locationid} cannot be found
{$departcode} cannot be found
Rate Matrix with name XXX referenced in field YYY does not exist in the System at this time. Please re-run the XOG if it exists now.
Invalid Exchange Rate Type with name XXX found for YYY. Default value Average will be used instead.
The allocation status: 'XXX' is invalid.
The chargeback type: 'XXX' is invalid. Should be DEBIT or CREDIT.
The chargeback subtype: 'XXX' is invalid. Should be STANDARD or INVESTMENT or OVERHEAD.
The chgRemtoOverhead has to be 0 or 1.
The allocation code is required.
Cannot determine allocation type from {$cbk_type} and {$cbk_subtype}.
Resource Class -- XXX is invalid.
Charge Code -- XXX is invalid.
Investment -- XXX is invalid.
Investment -- XXX contains Allocation -- YYY that is already in use by another investment.
Investment – XXX contains Allocation -- YYY that is already in use by global allocation.
User Value 1 -- XXX is invalid.
User Value 2 -- XXX is invalid.
Transaction Class -- XXX is invalid.
Input Type -- XXX is invalid.
Gl Account -- {$acctMain} - {$acctSub} is invalid.
Department -- XXX is invalid.
The Scenario Dependency specified - XXX- would cause a circular reference; not added.
The Scenario Dependency specified - XXX - is not active or does not exist.
Missing Edit permission on XXX object; Scenario Dependencies not added.
Specified parent investment XXX does not exist in the System at this time. Please re-run the XOG if it exists now.
Unable to add XXX as a parent investment, due to circular dependencies.
Unable to add XXX as a child investment, due to circular dependencies.
Specified child investment XXX does not exist in the System at this time. Please re-run the XOG if it exists now.
Investment Object operation failed while processing Investment Association.
No match could be found for Assignment teamId = XXX.
When specifying assignments for multiple roles, a teamId is required. role = XXX.
Could not determine the teamUid for assignment resource = XXX.
Team resource does not exist XXX.
Assignment role XXX does not exist.
-- Task XXX has no taskID; Estimate Rules are not imported.
Constraint date attribute cannot be null when delete flag is null. Could not add constraint with type = XXX !
Constraint type attribute is not a correct value. Could not add constraint with type = XXX.
Constraint type attribute is required! Could not add constraint.
When inserting multiple roles for the same role resourceId you must supply a teamId.
Investment Management Object XXX failed.

Schema Mapping

The Investment XOG object is composed of the following:

Investment
Allocations
Details
scenarioDependencies
InvestmentAssociations
InvestmentBaselines
UsageCurve and CostCurve
InvestmentResources
InvestmentTasks
General
OBSAssocs
Custom Information

Investment Schema Tag

This tag is part of the schema mapping for the investment XOG object. The actual tag is Asset, Idea, Project, or any other investment object. The abstract investment object includes attributes related to general properties of the investment, budgeting for the investment, and financial charges information.

An investment is composed of the following sub elements:

Allocations
scenarioDependencies
InvestmentAssociations
InvestmentBaselines
InvestmentResources
InvestmentTasks
General
OBSAssocs
CustomInformation

For the Idea object, the Allocations element is not supported and InvestmentAssociations may only include parents.

The following tables are references in the Investment schema tag:

INV_INVESTMENTS table contains the shared investment attributes.
FIN_FINANCIALS table contains the shared budget attributes.
PAC_MNT_PROJECTS table contains the shared financial attributes (not applicable for Idea)

The Investment schema tag has the following attributes:

ID

Required. Specifies the unique ID for the investment.

Table and Column: PROJCLASS.ID

Type: Number

investmentClass

Required. Specifies the investment class for the investment.

Table and Column: PROJCLASS.PROJCLASS

Type: String

status

Optional. Defines the status of the investment.

Values: Unapproved, Approved, Rejected, and Cancelled

An idea has three additional statuses: Submitted For Approval, Incomplete, and Converted

Table and Column: INV_INVESTMENTS.STATUS

Type: Number

name

Required. The name of the investment.

Table and Column: INV_INVESTMENTS.NAME

Type: String

objectID

Optional. Autonumbering is required if it is not present.

Table and Column: INV_INVESTMENTS.CODE

Type: String

description

A text description of the investment.

Table and Column: INV_INVESTMENTS.DESCRIPTION

Type: String

shortdesc

A short description of the investment.

Table and Column: PROJCLASS.SHORTDESC

Type: String

priority

Optional. Defines the priority.

Values: 0-36, where:

0. Highest priority
36. Lowest priority

Table and Column: INV_INVESTMENTS.PRIORITY

Type: Number

managerUserName

Optional. The name of the manager for the investment.

Table and Column: INV_INVESTMENTS.MANAGER_ID

Type: String

approvedById

Optional. The name of the CA Clarity user who approved the investment.

Table and Column: INV_INVESTMENTS.APPROVEDBY_ID

Type: String

chargeCodeExtID

Optional.

Table and Column: INV_INVESTMENTS.CHARGECODEID

Type: String

createdDate

Optional. Specifies the date the investment was created.

Table and Column: PROJCLASS.CREATED_DATE

Type: Date

createdBy

Optional. Specifies who created the investment.

Table and Column: PROJCLASS.CREATED_BY

Type: String

updatedBy

Optional. Specifies who last updated the investment.

Table and Column: PROJCLASS.UPDATED_BY

Type: String

lastUpdatedBy

Optional. The name of the user who last modified the investment.

Table and Column: INV_INVESTMENTS.LAST_UPDATED_BY

Type: String

lastUpdatedDate

Optional. The date and time when the investment was last modified.

Table and Column: INV_INVESTMENTS.LAST_UPDATE_DATE

Type: investmentDateTimeType

approvedTime

Optional. The date and time when the investment was approved.

Table and Column: INV_INVESTMENTS.APPROVEDTIME

Type: investmentDateTimeType

processCode

Optional. The process associated with the investment.

Table and Column: INV_INVESTMENTS.PROCESS_CODE

Type: investmentCodeType

stageCode

Optional. The stage within the investment process.

Table and Column: INV_INVESTMENTS.STAGE_CODE

Type: investmentCodeType

goalCode

Optional. The business goal of the investment.

Table and Column: INV_INVESTMENTS.GOAL_CODE

Type: investmentCodeType

alignment

Optional. The numeric indicator of alignment with business goals between 0 and 100.

Table and Column: INV_INVESTMENTS.ALIGNMENT

Type: Number

risk

Optional. The risk associated with the investment.

Table and Column: INV_INVESTMENTS.RISK

Type: Number

statusIndicator

Optional. The graphical indicator of the investment status.

Table and Column: INV_INVESTMENTS.STATUS_INDICATOR

Type: Number

statusComment

Optional. The text description of investment status.

Table and Column: INV_INVESTMENTS.STATUS_COMMENT

Type: String

progress

The numeric code for investment progress (Not Started, Started, or Completed).

Default: 0 - Not Started.

Table and Column: INV_INVESTMENTS.PROGRESS

Type: Number

currencyISOcode

Optional. The ISO code for the currency associated with the investment.

Table and Column: INV_INVESTMENTS.CURRENCY_CODE

Type: String

openForTimeEntry

Optional.

Table and Column: INV_INVESTMENTS.IS_OPEN_FOR_TE

Type: Boolean

start

Optional.

Table and Column: INV_INVESTMENTS.SCHEDULE_START

Type: investmentDateTimeType

finish

Optional.

Table and Column: INV_INVESTMENTS.SCHEDULE_FINISH

Type: investmentDateTimeType

cbkType

Optional. Refers to PRTIMEENTRY_USERLOV1.

Table and Column: INV_INVESTMENTS.CBK_TYPE

Type: String

entityCode

Optional.

Table and Column: INV_INVESTMENTS.ENTITY_CODE

Type: String

BillExpenseType

Optional. It is either CAPITAL_EXPENDITURE or DEPRECIATION.

Table and Column: INV_INVESTMENTS.BILL_EXPENSE_TYPE

Type: String

trackMode

Optional.

Table and Column: INV_INVESTMENTS.TRACK_MODE

Type: Number

chargeCodeID

Optional.

Table and Column: INV_INVESTMENTS.CHARGECODEID

Type: String

requiredForScenarios

Optional.

Type: Boolean

plannedCostStart

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_START

Type: investmentDateTimeType

plannedCostFinish

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_FINISH

Type: investmentDateTimeType

plannedBenTotal

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_TOTAL

Type: nonNegativeDouble

plannedBenStart

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_START

Type: investmentDateTimeType

plannedBenFinish

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_FINISH

Type: investmentDateTimeType

budgetCostTotal

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_TOTAL

Type: nonNegativeDouble

budgetCostStart

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_START

Type: investmentDateTimeType

budgetCostFinish

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_FINISH

Type: investmentDateTimeType

budgetCostOnHold

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_ONHOLD

Type: investmentDateTimeType

budgetCostResumed

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_RESUMED

Type: investmentDateTimeType

budgetRevTotal

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_TOTAL

Type: nonNegativeDouble

budgetRevStart

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_START

Type: investmentDateTimeType

budgetRevFinish

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_FINISH

Type: investmentDateTimeType

budgetRevOnHold

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_ONHOLD

Type: InvestmentDateTimeType

budgetRevResumed

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_RESUMED

Type: investmentDateTimeType

forecastCostTotal

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_TOTAL

Type: nonNegativeDouble

forecastCostStart

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_START

Type: investmentDateTimeType

forecastCostFinish

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_FINISH

Type: investmentDateTimeType

forecastCostOnHold

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_ONHOLD

Type: investmentDateTimeType

forecastCostResumed

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_RESUMED

Type: investmentDateTimeType

forecastRevTotal

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_TOTAL

Type: nonNegativeDouble

forecastRevStart

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_START

Type: investmentDateTimeType

forecastRevFinish

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_FINISH

Type: investmentDateTimeType

forecastRevOnHold

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_ONHOLD

Type: investmentDateTimeType

forecastRevResumed

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_RESUMED

Type: investmentDateTimeType

plannedNPV

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_NPV

Type: Number

plannedROI

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_ROI

Type: Number

plannedBreakEven

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BREAKEVEN

Type: investmentDateTimeType

plannedIRR

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_IRR

Type: Number

plannedMIRR

Optional.

Table and Column:FIN_FINANCIALS.PLANNED_MIRR

Type: Number

plannedPaybackPeriod

Optional.

Table and Column:FIN_FINANCIALS.PLANNED_PAYBACK_PERIOD

Type: string

budgetNPV

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_NPV

Type: Number

budgetROI

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_ROI

Type: Number

budgetBreakEven

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_BREAKEVEN

Type: investmentDateTimeType

budgetIRR

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_IRR

Type: Number

budgetMIRR

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_MIRR

Type: Number

budgetPaybackPeriod

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_PAYBACK_PERIOD

Type: String

forecastNPV

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_NPV

Type: Number

forecastROI

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_ROI

Type: Number

forecastBreakEven

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_BREAKEVEN

Type: investmentDateTimeType

forecastEqualsBudget

Optional.

Table and Column: FIN_FINANCIALS.IS_FCST_EQ_BDGT

Type: Boolean

calculatePresentValueInfo

Optional.

Table and Column: FIN_FINANCIALS.IS_CALC_PV_INFO

Type: Boolean

financialLocation

Optional.

Table and Column: PAC_MNT_PROJECTS.LOCATIONID

Type: String

financialDepartment

Optional.

Table and Column: PAC_MNT_PROJECTS.DEPARTCODE

Type: String

financialProjectClass

Optional.

Table and Column: PAC_MNT_PROJECTS.CLASS

Type: String

financialWipClass

Optional.

Table and Column: PAC_MNT_PROJECTS.WIPCLASS

Type: String

laborRateSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCELABOR

Type: String

laborCostSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCELABOR

Type: String

laborExchangeRateType

Optional.

Table and Column: PAC_MNT_PROJECTS.LABOR_EXCHANGE_RATE_TYPE

Type: String

materialRateSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCEMATERIALS

Type: String

materialCostSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCEMATERIALS

Type: String

materialExchangeRateType

Optional.

Table and Column: PAC_MNT_PROJECTS.MATERIALS_EXCHANGE_RATE_TYPE

Type: String

equipmentRateSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCEEQUIPMENT

Type: String

equipmentCostSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCEEQUIPMENT

Type: String

equipmentExchangeRateType

Optional.

Table and Column: PAC_MNT_PROJECTS.EQUIPMENT_EXCHANGE_RATE_TYPE

Type: String

expenseRateSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCEEXPENSES

Type: String

expenseCostSource

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCEEXPENSES

Type: String

expenseExchangeRateType

Optional.

Table and Column: PAC_MNT_PROJECTS.EXPENSE_EXCHANGE_RATE_TYPE

Type: String

expenseExchangeRateType

Optional.

Table and Column:

Type:

plannedCostOperatingTotal

Optional. Refers to planned operating cost of an investment.

Table and Column: FIN_FINANCIALS.PLANNED_CST_OPERATING_TOTAL

Type: Double

plannedCostCapitalTotal

Optional. Refers to planned capital cost of an investment.

Table and Column: FIN_FINANCIALS.PLANNED_CST_CAPITAL_TOTAL

Type: Double

budgetCostOperatingTotal

Optional. Refers to budget operating cost of an investment.

Table and Column: FIN_FINANCIALS.BUDGET_CST_OPERATING_TOTAL

Type: Double

budgetCostCapitalTotal

Optional. Refers to budget capital cost of an investment.

Table and Column: FIN_FINANCIALS.BUDGET_CST_CAPITAL_TOTAL

Type: Double

Allocations Schema Tag

This tag is part of the schema mapping for the financial transaction XOG object.

The Allocations element consists of zero or more allocations. Each Allocation can contain zero or more Detail objects and zero or more CustomInformation objects. The Allocations element at this level indicates the financial allocations used to track charges against different organizational units (for example, a department). The attributes of this tag does not reference tables or columns.

The Allocations schema tag has the following attributes:

allocationCode

Required.

Type: String

entityCode

Optional.

Type: String

locationCode

Optional.

Type: String

departmentCode

Optional.

Type: String

resourceClassCode

Optional.

Type: String

chargeCode

Optional.

Type: String

investmentCode

Optional.

Type: String

tableName

Optional.

Type: String

utilityCode1

Optional.

Type: String

utilityCode2

Optional.

Type: String

transactionClassCode

Optional.

Type: String

transactionClassCode

Optional.

Type: String

statusCode

Optional. The status of the allocation.

Type: String

chgRemtoOverhead

Optional.

Type: Boolean

cbkType

Required.

Type: String

cbkSubtype

Required.

Type: String

Details Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object.

The Details element consists of zero or more allocations. Each Detail object can contain zero or more CustomInformation objects. The Detail object can contain a TSV curve consisting of a percentage. The attributes of this tag does not reference tables or columns.

The Details schema tag has the following attributes:

glAccountMain

Required.

Type: String

glAccountSub

Required.

Type: String

department

Required.

Type: String

flatAmount

Optional.

Type: Number

weightable

Optional.

Type: Number

Financial Transaction (scenarioDependencies) Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object.

The scenarioDependencies element consists of zero or more scenarioDependency elements. This tag reads data from CA Clarity and confirms that the dependency exists when writing to CA Clarity. If the dependency does not exist, a warning is logged.

The scenarioDependencies schema tag has the following attributes:

objectInstanceCode

Required.

Table and Column: INV_INVESTMENTS.CODE

Type: String

name

Optional.

Table and Column: INV_INVESTMENTS.NAME

Type: String

objectType

Optional.

Table and Column: ODF_CA_INV.NAME

Type: investmentObjectCodeType

delete

Optional.

Table and Column: not applicable

Type: Boolean

InvestmentAssociations Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object.

The InvestmentAssociations element consists of zero or more Allocations and Hierarchies elements. Allocations refers to the parent investments of the current investment and Hierarchies to the child investments of the current investments.

Allocations

The Allocations element at this level determines what percentage of the cost of an investment is to be included in any parent investment (for example, Oracle may be used by three different applications so the cost of Oracle can be split between the three applications). The allocations element is a wrapper for zero or more ParentInvestment elements.

ParentInvestment

The ParentInvestment element can contain the following attributes, in addition to zero or more CustomInformation elements:

InvestmentID

Required. The ID of the immediate parent of the current investment.

Table and Column: INV_HIERARCHIES.PARENT_ID

Type: investmentIDType

InvestmentType

Required.

Table and Column: None

Type: investmentObjectCodeType

defaultAllocationPercent

Required. The percentage of the child budget and staff cost to allocate to the parent. This attribute must total to either "0" or "1." This is because an investment must be either completely allocated to its parents or completely unallocated.

Table and Column: INV_HIERARCHIES.DEFAULT_ALLOC_PCT

Type: Number

Hierarchies

The Hierarchies element is a wrapper for zero or more ChildInvestment elements.

ChildInvestment

The ChildInvestment element can contain zero or more CustomInformation elements and the following attributes:

InvestmentID

Required. The ID of the immediate child of the current investment.

Table and Column: INV_HIERARCHIES.CHILD_ID

Type: investmentIDType

InvestmentType

Required.

Table and Column: None

Type: investmentObjectCodeType

defaultAllocationPercent

Optional. The percentage of the child budget and staff cost to allocate to the parent.

Table and Column: INV_HIERARCHIES.DEFAULT_ALLOC_PCT

Type: Number

InvestmentBaselines Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object.

The InvestmentBaselines schema tag contains the following attributes including zero or more InvestmentBaseline elements. Each InvestmentBaseline element can contain a BaselineDetails element.

revisionID

Required.

Table and Column: PRJ_BASELINES.CODE

Type: String

delete

Optional.

Table and Column: None

Type: Boolean

currentRevision

Required.

Table and Column: PRJ_BASELINES.IS_CURRENT

Type: Boolean

name

Required.

Table and Column: PRJ_BASELINES.NAME

Type: String

description

Optional.

Table and Column: PRJ_BASELINES.DESCRIPTION

Type: String

BaselineDetails

The BaselineDetails element contains detailed usage or cost curves for a baseline.

start

Optional.

Table and Column: PRJ_BASELINES_DETAILS.START_DATE

Type: projectDateTimeType

finish

Optional.

Table and Column: PRJ_BASELINES_DETAILS.FINISH_DATE

Type: projectDateTimeType

usageSum

Optional.

Table and Column: PRJ_BASELINES_DETAILS.USAGE_SUM

Type: Number

costSum

Optional.

Table and Column: PRJ_BASELINES_DETAILS.COST_SUM

Type: Number

duration

Optional.

Table and Column: PRJ_BASELINES_DETAILS.DURATION

Type: Number

UsageCurve and CostCurve Schema Tags

These tags are part of the schema mapping for the Financial Transaction XOG object. The curve elements contain segment objects which specify cost or usage over a period of time. The UsageCurve and CostCurve schema tags have the following attributes:

start

Required.

Table and Column: None

Type: projectDateTimeType

finish

Required.

Table and Column: None

Type: projectDateTimeType

sum

Required.

Table and Column: None

Type: Number

InvestmentResources Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object. The InvestmentResources element contains zero or more Resource elements that make up the Team element for an investment. This tag includes the following attributes:

Resource

availFrom

Optional. If the Team field is not set, use the investment start.

Table and Column: PRTEAM.pravailstart

Type: Date

availTo

Optional. If the team field is not set, use the investment finish.

Table and Column: PRTEAM.pravailfinish

Type: Date

openForTimeEntry

Optional.

Table and Column: PRTEAM.prisopen

Type: Boolean

bookingStatus

Optional.

Table and Column: PRTEAM.prbooking

Type: Integer

requestStatus

Optional.

Table and Column: PRTEAM.prstatus

Type: Integer

defaultAllocation

Optional.

Table and Column: PRTEAM.pralloccurve

Type: Float

resourceID

Required.

Table and Column: PRTEAM.prresourceid

Type: String

projectRoleID

Optional.

Table and Column: PRTEAM.prroleid

Type: String

isProjectManager

Optional. Indicates if the resource is the project manager.

Table and Column: Not applicable

Type: Boolean

lastUpdatedBy

Optional.

Table and Column: PRTEAM.last_updated_by

Type: String

lastUpdatedDate

Optional.

Table and Column: PRTEAM.last_updated_date

Type: Date

teamId

Optional. The unique identifier for each team member on an investment.

Table and Column: PRTEAM.team_uid

Type: String

requirementName

Optional.

Table and Column: PRTEAM.requirement_name

Type: String

Subelement <Baselines>

A subelement for Resource or Task. It has the following attributes:

revisionID

Required.

Table and Column: PRJ_BASELINES.code

Type: String

costSum

Optional.

Table and Column: PRJ_BASELINE_DETAILS.cost_sum

Type: Float

duration

Optional.

Table and Column: PRJ_BASELINE_DETAILS.duration

Type: Float

start

Optional.

Table and Column: PRJ_BASELINE_DETAILS.start_date

Type: Date

finish

Optional.

Table and Column: PRJ_BASELINE_DETAILS.finish_date

Type: Date

usageSum

Optional.

Table and Column: PRJ_BASELINE_DETAILS.usage_sum

Type: Float

Subelement <AllocCurve>

AllocCurve is a sub element of the Resource element.

AllocCurve

Optional. A subelement of the Resource element.

Table and Column: PRTEAM.prAllocCurve

Type: Varied

Subelement <HardAllocCurve>

HardAllocCurve is a sub element of the Resource element.

HardAllocCurve

Optional. A subelement of the Resource element.

Table and Column: PRTEAM.prAllocCurve

Type: Varied

Subelement <SkillAssocs>

SkillAssocs is a sub element of the Resource element.

SkillAssocs: A subelement of the Resource element.

InvestmentTasks Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object. The InvestmentTasks element contains zero or more Task elements.

Task

The attributes of the task element are not associated with any table or column. The Task element has the following attributes:

internalTaskID

Optional.

Type: String

delete

Optional.

Type: Boolean

taskID

Optional.

Type: String

name

Optional.

Type: String

parent

Optional.

Type: String

firstChildOf

Optional.

Type: String

lastChildOf

Optional.

Table and Column: Not applicable

Type: String

nestSiblingOf

Optional.

Type: String

orderID

Optional.

Type: Number

outlineLevel

Optional.

Type: Number

start

Optional.

Type: projectDateTimeType

baseStart

Optional.

Type: projectDateTimeType

finish

Optional.

Type: projectDateTimeType

baseFinish

Optional.

Type: projectDateTimeType

milestone

Optional.

Type: Boolean

summary

Optional.

Type: Boolean

key

Optional.

Type: Boolean

category

Optional.

Type: String

status

Optional.

Type: Number

percComp

Optional.

Type: Number

lastUpdatedBy

Optional.

Type: String

lastUpdatedDate

Optional.

Type: projectDateTimeType

priority

Optional.

Type: Number

earlyStart

Optional.

Type: projectDateTimeType

lateStart

Optional.

Type: projectDateTimeType

earlyFinish

Optional.

Type: projectDateTimeType

lateFinish

Optional.

Type: projectDateTimeType

duration

Optional.

Type: Number

baselineDuration

Optional.

Type: Number

totalSlack

Optional.

Type: Number

unplanned

Optional.

Type: Boolean

shortName

Optional.

Type: String

guidelines

Optional.

Type: String

fixed

Optional.

Type: Boolean

lockedForScheduling

Optional.

Type: Boolean

baseFixed

Optional.

Type: Boolean

baseTime

Optional.

Type: projectDateTimeType

critical

Optional.

Type: Boolean

chargeCodeID

Optional.

Type: Number

subproject

Optional.

Type: Boolean

subprojectID

Optional.

Type: String

subprojectTaskID

Optional.

Type: String

subprojectReadOnly

Optional.

Type: Boolean

subprojectIPD

Optional.

Type: Boolean

userText1

Optional.

Type: String

topDownPercent

Optional.

Type: Number

chargeCodeExtID

Optional.

Type: String

General Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object. This tag is not associated with tables and columns. It has the following attributes:

addedBy

Optional.

Type: String

addedDate

Optional.

Type: Date

OBSAssocs Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object. The OBSAssocs element contains the following element, plus zero or more OBSAssoc subelements.

completed

Optional. When completed and this value is set to True. Existing OBS associations not listed in the import are deleted.

Default: False.

Table and Column: None

Type: Boolean

OBSAssoc Element

No tables or columns are associated with the OBSAssoc element. It has the following attributes:

name

Optional.

Type: String

id

Optional.

Type: String

unitPath

Required. This is a slash-delimited list of unit names leading to the unit to which the object is associated (for example, "CAN/BC/VAN").

Type: String

mode

Optional.

Type: OBSRightMode

Custom Information Schema Tag

This tag is part of the schema mapping for the Financial Transaction XOG object.

The CustomInformation element contains data for custom attributes added to the Investment object.

Issue

Use the issue XOG object to view inbound and outbound issue instances.

Schema Name

nikuxog_issue.xsd

Read and Write XML Files

The following XML files are included:

issue_read.xml. Use this file to export issue instances from CA Clarity.
issue_write.xml. Use this file to import issue instances that were previously exported from CA Clarity.

Prerequisites

Before using this XOG object, make sure the referenced objects, such as the project, user, and category, exist in CA Clarity.

Read Filters

The following explicit read filters are used:

projectCode: Defines the code for the associated project.
Name: Defines the name of the issue.
riskCode: Defines the risk of the issue.
statusCode: Defines the status of the issue.
priorityCode: Defines the priority of the issue.
ownerCode: Defines the name of the owner or assignee of the issue.

Error Handling

The following errors can be thrown:

Project does not exist in the system.
Category type is not valid.
Status is not valid.
Priority is not valid.
Owner does not exist in the system.
Impact is not valid.
Resolved By does not exist in the system.
Failed to import risk/issue/change request.

Schema Mapping

Mappings for the following schema tag names are provided:

Issue

Issue Schema Tag

The issue tag is part of the schema mapping for the issue XOG object. It has the following attributes:

ownerCode

Required. Defines the name of the resource assigned to this issue.

Table and Column: ASSIGNED_TO

Type: String

categoryTypeCode

Defines the category of this issue.

Table and Column: CATEGORY_TYPE_CODE

Type: String

description

Defines the description of this issue.

Table and Column: DESCRIPTION

Type: String

code

Required. Defines the unique identifier for this issue.

Table and Column: RIM_RISK_ISSUE_CODE

Type: String

impactDate

Defines the impact date for this issue.

Table and Column: IMPACT_DATE

Type: Date

name

Required. Defines the name of the issue.

Table and Column: NAME

Type: String

priorityCode

Defines the priority of this issue.

Table and Column: PRIORITY_CODE

Type: String

projectCode

Required. Defines the project associated with this issue.

Table and Column: INV_INVESTMENTS.CODE

Type: String

statusCode

Defines the status of this issue.

Table and Column: STATUS_CODE

Type: String

resolution

Defines the description of the resolution for this issue.

Table and Column: RESOLUTION

Type: String

resolvedBy

Defines the name of the resource who resolved the issue.

Table and Column: RESOLVED_BY

Type: Number

resolvedDate

Defines the date the issue was resolved.

Table and Column: RESOLVED_DATE

Type: Date

targetResolutionDate

Defines the date the issues is expected to be resolved and closed.

Table and Column: TARGET_RESOLUTION_DATE

Type: Date

Location

Use the location XOG object to view inbound and outbound location attributes.

Schema Name

nikuxog_location.xsd

Read and Write XML Files

The following XML files are included:

locations_read.xml. Use this file to export locations from CA Clarity.
locations_write.xml. Use this file to import locations that were previously exported from CA Clarity.

Prerequisites

An entity must exist in CA Clarity.

Business Rules and Processing

When a location is created, a corresponding OBS unit is created in the location OBS referred to by the location's entity.

Read Filters

The following explicit read filter is used:

Entity: The unique entity code for which the locations should be read out.

Error Handling

The following attribute values are validated against CA Clarity. If the values do not exist, XOG displays an error message and does not import or update the record.

Entity: Checks if the entity is valid and exists in the system.
Required fields: Ensures all required fields have values.
Department associations: Ensures departments belong to the same entity. Further, if the department does not exist, a warning is output.

Schema Mappings

The following schema mappings are provided for locations:

Locations
Description
DepartmentAssociations
Child Location

Locations Schema Tag

The Locations tag is part of the schema mapping for the Location XOG object.

A placeholder element for multiple locations. This schema tag has the following elements:

Location
Description Schema Tag
DepartmentAssociations Schema Tag

Location Element

The Location element is the actual Location object. It has the following attributes.

locationCode

Required. The unique code for location.

Table and Column: locations.locationid

Type: String

entity

Required. The entity to which the location belongs.

Table and Column: locations.entity

Type: String

description

Required.

Table and Column: locations.locationdescription

Type: String

shortdescription

Required.

Table and Column: locations.shortdesc

Type: String

address1

Optional.

Table and Column: locations.address1

Type: String

address2

Optional.

Table and Column: locations.address2

Type: String

address3

Optional.

Table and Column: locations.address3

Type: String

city

Optional.

Table and Column: locations.city

Type: String

zip

Optional.

Table and Column: locations.zip

Type: String

countryid

Optional.

Table and Column: locations.countryid

Type: String

phone

Optional.

Table and Column: locations.phone

Type: String

fax

Optional.

Table and Column: locations.fax

Type: String

managerResourceCode

Optional. The manager for location department associations.

Table and Column: locations.manager_resource_code

Type: String

name

Required. The name of the location.

Table and Column: locations.shortdesc

Type: String

locationManagerCode

Optional. The resource code for location manager.

Table and Column: locations.location_manager_id

Type: String

stateprov

Optional.

Table and Column: locations.stateprov

Type: String

Description Schema Tag

The Description schema tag contains the attribute for the location description.

Description

Required. The description of the location.

Table and Column: description

Type: String

DepartmentAssociations Schema Tag

The placeholder element for multiple department associations. It has the following attribute.

DepartmentAssociation

Represents the department that is associated to the location. It has the following attribute:

departmentCode

Required. The association to department code. The department must belong to the same entity as the location.

Table and Column: LocationDept.dept_id

Type: String

Child Location Schema Tag

A child location. This element contains all the elements and attributes that the enclosing location has.

Matrix

Use the matrix XOG object to view inbound and outbound cost/rate matrix instances. Rate matrices give you flexibility in defining cost for particular services or resources.

Schema Name

nikuxog_matrix.xsd

Read and Write XML Files

The following XML files are included:

matrices_read.xml. Use this file to export matrices from CA Clarity.
matrices_write.xml. Use this file to import matrices that were previously exported from CA Clarity.

Filters

The following explicit read filters are used:

name: The name of the matrix.
type: The type of the matrix (Cost or Rate).
location: The location of the matrix.

Error Handling

The following errors can be thrown when importing or exporting the cost plan:

Failed to export matrices.
Failed to import matrices.

Schema Mappings

Mappings for the following schema tag names are provided:

columnType Schema Tag

This tag is part of the schema mapping for the matrix XOG object. The columns you assign to a matrix through the XOG are saved to the PPA_MATRIXCOLDEF table.

This tag has the following attribute:

name

Optional. Defines the list of columns to be added to the matrix rows. It has the following attributes:

chargeCode

Defines the charge code for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

clntclass

Optional. Defines the client class for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

company_code

Defines the company code for the matrix row.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

departcode

Defines the department code for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

entity

Defines the entity for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

inputtype

Defines the input type code for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

locationid

Defines the location unique identifier for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

projclass

Defines the project class for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

project_code

Defines the project code for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

resourceClass

Defines the resource class for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

resource_code

Defines the resource code for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

resourceRole

Optional. Defines the resource role for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

transactionClass

Optional. Defines the transaction class for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

projsitecode

Defines the project site code for the matrix column.

Table and Column: PPA_MATRIXCOLDEF.FIELDNAME

Type: String

MatrixRowType Schema Tag

The MatrixRowType tag is part of the schema mapping for the matrix XOG object. The values for the rows you add to the matrix are saved to a column in the PPA_MATRIXVALUES table.

This tag has the following attributes:

fromDate

Optional. Defines the date from which to apply the matrix row.

Table and Column: PPA_MATRIXVALUES.FROMDATE

Type: Date

toDate

Optional. Defines the date until which to apply the matrix row.

Table and Column: PPA_MATRIXVALUES.TODATE

Type: Date

chargecode

Optional. Defines the chargecode for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE1

Type: String

Department

Optional. Defines the department for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE2

Type: String

entity

Optional. Defines the entity for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE3

Type: String

Input type code

Optional. Defines the input type code for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE6

Type: String

location

Optional. Defines the location for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE9

Type: String

Project class

Optional. Defines the project class for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE8

Type: String

Project

Optional. Defines the project for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE7

Type: String

Resource class

Optional. Defines the resource class for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE9

Type: String

Resource

Optional. Defines the resource for the matrix row.

Table and Column: PPA_MATRIXVALUES.VALUE10

Type: String

rate

Optional. Defines the rate for the matrix row.

Table and Column: PPA_MATRIXVALUES.NUMVAL1

Type: Double

standardCost

Optional. Defines the standard cost for the matrix row.

Table and Column: PPA_MATRIXVALUES.NUMVAL2

Type: Double

actualCost

Optional. Defines the actual cost for the matrix row.

Table and Column: PPA_MATRIXVALUES.NUMVAL3

Type: Double

currencyCode

Optional. Defines the currency code for the matrix row.

Table and Column: PPA_MATRIXVALUES.MATRIX_CURRENCY_CODE

Type: String

typeCode

Optional. Defines the cost plus code for the matrix row.

Table and Column: PPA_MATRIXVALUES.STRVAL1

Type: String

Non-Project Investment

Use the Non-project Investments XOG object to view inbound and outbound non-project investment object (NPIO) attributes. NPIOs include:

Asset
Application
Product
Other Work

Schema Names

The following schema files are part of this XOG object:

nikuxog_asset.xsd
nikuxog_application.xsd
nikuxog_product.xsd
nikuxog_otherInvestment.xsd

Read and Write XML Files

None

Business Rules and Processing

The following business rules and processing apply to this XOG:

The non-project investments are flat objects with no hierarchical data.
Each object contains many of the same fields and has essentially the same behavior.
NPIOs are defined for both inbound (write) and outbound (read) processing. On import, if the NPIO exists, it is posted. CA Clarity checks to ensure that the object type and name matches. If the NPIO does not exist, CA Clarity checks to ensure that the name is unique. If the check passes, the NPIO is created and posted.
This XOG imports and exports the team members, if the NPIO has been staffed. The resources must exist on the target system during an import or the import XOG will fail if the NPIO has team members.

Read Filters

The XOG supports the outbound processing of NPIOs based on the following fields:

ObjectId: The unique ID for the NPIO.
managerUserName: The name of the NPIO manager.
lastUpdatedDate: The last date when the NPIO was updated.

If all filters are commented out, all NPIOs for the defined type are exported.

Terms

The following terms are used in this section:

managerUserName

The name of the NPIO manager.

The manager is validated against the CMN_SEC_USERS.USER_NAME field. If the manager does not exist, the NPIO is imported without a manager and a warning is posted to the Success and Error file.

approvedByID

The unique identifier for the NPIO approver.

The approver is validated against the CMN_SEC_USERS.USER_NAME field. If the approver does not exist, the NPIO is not imported and a warning is posted to the Success and Error file.

objectID

The unique identifier for the object.

If the objectID:

Exists and it matches the ID on a different object type, the object is not imported and an error is posted to the Success and Error file.

Does not exist and auto-numbering is not active for the object type, the object is not imported and an error is posted to the Success and Error file.

chargeCodeExtID

The charge code associated to the NPIO.

The charge code is validated against the PRChargeCode table. If the charge code does not exist, the NPIO is not imported and an error is posted to the Success and Error file.

goalCode

The goal code associated with an NPIO.

This is validated against the CMN_LOOKUP_TYPE/CMN_LOOKUPS table. If the charge code does not exist, the NPIO is not imported and an error is posted to the Success and Error file.

processCode

The process code associated with an NPIO.

This is validated against the CMN_LOOKUP_TYPE/CMN_LOOKUPS table. If the process code does not exist, the NPIO is not imported and an error is posted to the Success and Error file.

stageCode

The stage code associated with an NPIO.

The stage code is validated against the CMN_LOOKUP_TYPE/CMN_LOOKUPS table. If the stage code does not exist, the NPIO is not imported and an error is posted to the Success and Error file.

categoryCode

The category code associated with an NPIO.

This is validated against the CMN_LOOKUP_TYPE/CMN_LOOKUPS table. If the category code does not exist, the NPIO is not imported and an error is posted to the Success and Error file.

currencyISOcode

The currency code associated to the NPIO.

The currency code is validated against the CMN_OPTIONS/ CMN_OPTION_VALUES/ CMN_CURRENCIES tables. If the currency is not active or cannot be converted into the base currency, the NPIO is not imported and an error is posted to the Success and Error file.

Schema Mappings

Mappings for the following schema tag names are provided:

Asset Schema Tag

This tag is part of the schema mapping for the Non-project Investment XOG object. The asset schema tag has the following attribute:

totalCostOfOwnership

Optional. The minimum is 0.

Table and Column: PRJ_PROJECTS.INV_TCO

Type: Double

Application Schema Tag

This tag is part of the schema mapping for the Non-project Investment XOG object.

The Application schema tag has the following attributes

totalCostOfOwnership

Optional. The minimum is 0.

Table and Column: PRJ_PROJECTS.INV_TCO

Type: Double

investmentVersion

Table and Column: PRJ_PROJECTS.INV_VERSION

Type: String

supplier

Table and Column: PRJ_PROJECTS.PRJ_PROJECTS.INV_SUPPLIER

Type: String

populationServed

The minimum is 0.

Table and Column:

Type: Number

licenseCount

The minimum is 0.

Table and Column:

Type: Number

functionPoints

The minimum is 0.

Table and Column:

Type: Number

technology

Defines the technology.

Values:

0. data
1. desktop
2. video
3. voice

Table and Column:

Type: Number

platform

Defines the platform.

Values:

0. HP-UX
1. Macintosh
2. Sun
3. Windows
4. other

Table and Column:

Type: Number

Product Schema Tag

The product tag is part of the schema mapping for the Non-project Investment XOG object. The product schema tag has the following attribute:

investmentVersion

Optional.

Table and Column: PRJ_PROJECTS.INV_VERSION

Type: String

Schema Name

nikuxog_product.xsd

Read and Write XML Files

The following XML files are included:

inv_products_read.xml. Use this file to export product instances from CA Clarity.
inv_products_write.xml. Use this file to import product instances that were previously exported from CA Clarity.

Other Work Schema Tag

This tag is part of the schema mapping for the Non-project Investment XOG object. There are no specific attributes for the Other Work schema.

Schema Name

nikuxog_otherInvestment.xsd

Read and Write XML Files

The following XML files are included:

inv_others_read.xml. Use this file to export other investment instances from CA Clarity.
inv_others_write.xml. Use this file to import other investment instances that were previously exported from CA Clarity.

NPIO Common Fields Schema Tag

The NPIO Common Fields tag is part of the schema mapping for the non-project investment XOG object. This schema tag has the following attributes:

name

Required. Defines the name of the investment.

Table and Column: SRM_PROJECTS.NAME

Type: String

objectId

Required. Defines the unique identifier for the investment. You must provide a unique identifier if CA Clarity is not configured for autonumbering.

Table and Column: SRM_PROJECTS.UNIQUE_NAME

Type: String

status

Optional. Defines the status of the investment.

Values:

0. Unapproved
1. Approved
2. On Hold
3. Rejected
4. Cancelled
5. Resumed

Table and Column: PRJ_PROJECTS.STATUS

Type: Number

description

Optional.

Table and Column: SRM_PROJECTS.DESCRIPTION

Type: String

priority

Optional. Defines the priority of the investment.

Values: 0-36, where:

0. Highest priority
36. Lowest priority

Table and Column: PRJ_PROJECTS.prPRIORITY

Type: Number

managerUserName

Optional. Defines the name of the resource managing the investment. The manager's user name must match an existing user name in CA Clarity.

Table and Column: PRJ_PROJECTS.MANAGER_ID

Type: String

approvedById

Required. Defines the name of the resource who approved the investment. The user name must match an existing user name in CA Clarity.

Table and Column: PRJ_PROJECTS.APPROVEDBY_ID

Type: String

chargeCodeExtId

Required.

Table and Column: PRJ_PROJECTS.PRCHARGECODEID

Type: String

lastUpdatedBy

Optional. Defines the name of the resource who last updated the investment.

Default: The name of the resource logged in to CA Clarity.

Table and Column: PRJ_PROJECTS.LAST_UPDATED_BY

Type: String

lastUpdatedDate

Optional. Defines the date the investment was last updated.

Default: Today's date

Table and Column: SRM_PROJECTS.LAST_UPDATED_DATE

Type: dateTime

approvedTime

Optional. Defines the time the investment was approved.

Table and Column: PRJ_PROJECTS.PRAPPROVEDTIME

Type: dateTime

processCode

Required. Defines the process code of the investment. The code must exist in CA Clarity.

Table and Column: PRJ_PROJECTS.PROCESS_CODE

Type: String

stageCode

Required. Defines the stage code of the investment. The code must exist in CA Clarity.

Table and Column: PRJ_PROJECTS.STAGE_CODE

Type: String

categoryCode

Required. Defines the category code of the investment. The code must exist in CA Clarity.

Table and Column: PRJ_PROJECTS.CATEGORY_CODE

Type: String

goalCode

Required. Defines the goal code of the investment. The code must exist in CA Clarity.

Table and Column: PRJ_PROJECTS.GOAL_CODE

Type: String

alignment

Optional. Defines the alignment of the investment.

Table and Column: PRJ_PROJECTS.ALIGNMENT

Type: Number

risk

Optional. Defines the risk of the investment.

Table and Column: PRJ_PROJECTS.RISK

Type: Number

statusIndicator

Optional.

Table and Column: PRJ_PROJECTS.STATUS_INDICATOR

Type: Number

statusComment

Optional.

Table and Column: PRJ_PROJECTS.STATUS_COMMENT

Type: String

progress

Optional.

Values:

0. Not Started
1. Started
2. Completed

Table and Column: PRJ_PROJECTS.PROGRESS

Type: Double

budgetCostTotal

Optional. The minimum is 0.

Table and Column: PRJ_PROJECTS.BDGT_CST_TOTAL

Type: dateTime

budgetCostStart

Optional.

Table and Column: PRJ_PROJECTS.BDGT_CST_START

Type: dateTime

budgetCostFinish

Optional.

Table and Column: PRJ_PROJECTS.BDGT_CST_FINISH

Type: dateTime

budgetCostOnHold

Optional.

Table and Column: PRJ_PROJECTS.BDGT_CST_ONHOLD

Type: dateTime

budgetCostResume

Optional.

Table and Column: PRJ_PROJECTS.BDGT_CST_RESUME

Type: dateTime

budgetRevTotal

Optional. The minimum is 0.

Table and Column: PRJ_PROJECTS.BDGT_REV_TOTAL

Type: Double

budgetRevStart

Optional.

Table and Column: PRJ_PROJECTS.BDGT_REV_START

Type: dateTime

budgetRevFinish

Optional.

Table and Column: PRJ_PROJECTS.BDGT_REV_FINISH

Type: dateTime

budgetRevOnHold

Optional.

Table and Column: PRJ_PROJECTS.BDGT_REV_ONHOLD

Type: dateTime

budgetRevResume

Optional.

Table and Column: PRJ_PROJECTS.BDGT_REV_RESUME

Type: dateTime

budgetNPV

Optional. If the Calculate Present Value Info flag is set, the budgetNPV is recalculated after import.

Table and Column: PRJ_PROJECTS.BDGT_NPV

Type: Float

budgetROI

Optional. If the Calculate Present Value Info flag is set, the budgetROI is recalculated after import. 1.0 is 100%.

Table and Column: PRJ_PROJECTS.BDGT_ROI

Type: Percent

budgetBreakEven

Optional. This is recalculated after import if Calculate Present Value Info flag is set.

Table and Column: PRJ_PROJECTS.BDGT_BREAKEVEN

Type: dateTime

forecastCostTotal

Optional. The minumum is 0.

Table and Column: PRJ_PROJECTS.FCST_CST_TOTAL

Type: Double

forecastCostStart

Optional.

Table and Column: PRJ_PROJECTS.FCST_CST_START

Type: dateTime

forecastCostFinish

Optional.

Table and Column: PRJ_PROJECTS.FCST_CST_FINISH

Type: dateTime

forecastCostOnHold

Optional.

Table and Column: PRJ_PROJECTS.FCST_CST_ONHOLD

Type: dateTime

forecastCostResume

Optional.

Table and Column: PRJ_PROJECTS.FCST_CST_RESUME

Type: dateTime

forecastRevTotal

Optional.

Table and Column: PRJ_PROJECTS.FCST_REV_TOTAL

Type: dateTime

forecastRevStart

Optional.

Table and Column: PRJ_PROJECTS.FCST_REV_START

Type: dateTime

forecastRevFinish

Optional.

Table and Column: PRJ_PROJECTS.FCST_REV_FINISH

Type: dateTime

forecastRevOnHold

Optional.

Table and Column: PRJ_PROJECTS.FCST_REV_ONHOLD

Type: dateTime

forecastRevResume

Optional.

Table and Column: PRJ_PROJECTS.FCST_REV_RESUME

Type: dateTime

forecastNPV

Optional. This is recalculated after import if Calculate Present Value Info flag is set.

Table and Column: PRJ_PROJECTS.FCST_NPV

Type: Float

forecastROI

Optional. This is recalculated after import if Calculate Present Value Info flag is set. 1.0 is 100%.

Table and Column: PRJ_PROJECTS.FCST_ROI

Type: Percent

forecastBreakEven

Optional. This is recalculated after import if Calculate Present Value Info flag is set.

Table and Column: PRJ_PROJECTS.FCST_BREAKEVEN

Type: dateTime

currencyISOcode

Required. The three-character ISO currency code that must be an active currency in CA Clarity.

Table and Column: PRJ_PROJECTS.CURRENCY_CODE

Type: String

calculatePresentValueInfo

Required. If selected, this calculates the NPV,ROI and breakeven after import.

Table and Column: PRJ_PROJECTS.IS_CALC_PV_INFO

Type: Boolean

forecastEqualsBudget

Optional. If selected, forecast values will track the budget values.

Table and Column: PRJ_PROJECTS.IS_CALC_PV_INFO

Type: Boolean

plannedCostStart

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_START

Type: Date

plannedCostFinish

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_CST_FINISH

Type: Date

plannedBenTotal

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_TOTAL

Type: Double

plannedBenStart

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_START

Type: Date

plannedBenFinish

Optional.

Table and Column: FIN_FINANCIALS.PLANNED_BEN_FINISH

Type: Date

budgetCostTotal

Table and Column: FIN_FINANCIALS.BUDGET_CST_TOTAL

Optional.

Type: Double

budgetCostStart

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_START

Type: Date

budgetCostFinish

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_CST_FINISH

Type: Date

budgetRevTotal

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_TOTAL

Type: Double

budgetRevStart

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_START

Type: Date

budgetRevFinish

Optional.

Table and Column: FIN_FINANCIALS.BUDGET_REV_FINISH

Type: Date

forecastCostTotal

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_TOTAL

Type: Double

forecastCostStart

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_START

Type: Date

forecastCostFinish

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_CST_FINISH

Type: Date

forecastRevTotal

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_TOTAL

Type: Double

forecastRevStart

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_START

Type: Date

forecastRevFinish

Optional.

Table and Column: FIN_FINANCIALS.FORECAST_REV_FINISH

Type: Date

plannedNPV

Optional. If the Calculate Present Value Info flag is set, this is recalculated after import.

Table and Column: FIN_FINANCIALS.PLANNED_NPV

Type: Double

plannedROI

Optional. If the Calculate Present Value Info flag is set, this is recalculated after import. 1.0 is 100%.

Table and Column: FIN_FINANCIALS.PLANNED_ROI

Type: Double

plannedBreakEven

Optional. This is recalculated after import if Calculate Present Value Info flag is set.

Table and Column: FIN_FINANCIALS.PLANNED_BREAKEVEN

Type: Date

budgetNPV

Optional. If the Calculate Present Value Info flag is set, this is recalculated after import.

Table and Column: FIN_FINANCIALS.BUDGET_NPV

Type: Double

budgetROI

Optional. If the Calculate Present Value Info flag is set, this is recalculated after import. 1.0 is 100%.

Table and Column: FIN_FINANCIALS.BUDGET_ROI

Type: Double

budgetBreakEven

Optional. This is recalculated after import if Calculate Present Value Info flag is set.

Table and Column: FIN_FINANCIALS.BUDGET_BREAKEVEN

Type: Date

forecastNPV

Optional. If the Calculate Present Value Info flag is set, this is recalculated after import.

Table and Column: FIN_FINANCIALS.FORECAST_NPV

Type: Double

forecastROI

Optional. If the Calculate Present Value Info flag is set, this is recalculated after import. 1.0 is 100%.

Table and Column: FIN_FINANCIALS.FORECAST_ROI.

Type: Double

forecastBreakEven

Optional. This is recalculated after import if Calculate Present Value Info flag is set.

Table and Column: FIN_FINANCIALS.FORECAST_BREAKEVEN

Type: Date

forecastEqualsBudget

Optional. If selected, forecast values will track the budget values.

Table and Column: FIN_FINANCIALS.IS_FCST_EQ_BDGT

Type: Boolean

currencyISOcode

Optional. A three-character ISO currency code that must be an active currency in CA Clarity.

Table and Column: FIN_FINANCIALS.CURRENCY_CODE

Type: String

calculatePresentValueInfo

Optional. If checked, this calculates the NPV, ROI, and breakeven after import.

Table and Column: FIN_FINANCIALS.IS_CALC_PV_INFO

Type: Boolean

Service Schema Tag

The service tag is part of the schema mapping for the Non-project Investment XOG object. It has the following attribute:

applicationCode

Optional. Defines the unique identifier for the service.

Table and Column: INV_SERVICES.APPLICATION_ID

Type: String

Schema Name

nikuxog_service.xsd

Read and Write XML Files

The following XML files are included:

inv_services_read.xml. Use this file to export service instances from CA Clarity.
inv_services_write.xml. Use this file to import service instances that were previously exported from CA Clarity.

Notifications

Use the Notification XOG object to view inbound and outbound configurable notification templates.

Schema Name

nikuxog_notification.xsd

Read and Write XML Files

The following XML files are included:

notification_read.xml. Use this file to export notification templates from CA Clarity.
notification_write.xml. Use this file to import notification templates that were previously exported from CA Clarity.

Prerequisites

None.

Read Filters

The following explicit read filters are used:

functionalAreaCode: Defines the functional area code that refers to the notification template. The values can be obtained from the CMN_LOOKUPS_V table with lookup_type set to ‘NOTIFICATION_TYPE’.
notificationCode: Defines the ID of the notification.
languageCode: Defines the language code of the notification for extracting the name and description fields. This parameter is not required if reading the notification in all languages.

Error Handling

No errors are thrown. If the filter includes invalid values, no records are read.

Schema Mapping

Mappings for the following schema tag names are provided:

Notification

Notification Schema Tag

The notification tag is part of the schema mapping for the notification XOG object. It has the following attributes:

notificationCode

Required. Defines the code for the notification template.

Table and Column: CMN_NOTIFICATIONS.NOTIFICATION_CODE

Type: String

functionalAreaCode

Required. Defines the functional area code that refers to the notification template.

Table and Column: CMN_NOTIFICATIONS.FUNCTIONAL_AREA_ID

Type: String

isCustomized

Identifies if the notification template is customized or not.

Table and Column: CMN_NOTIFIACTIONS.IS_CUSTOMIZED

Type: Boolean

notificationNameDesc

Required. Defines the name and description of the notification template.

Table and Column: CMN_CAPTIONS_NLS.NAME and DESCRIPTIONS with TABLE_NAME mapped to CMN_NOTIFICATIONS

Type: String

notificationSubjectBody

Required. Defines the subject and message body text of the the notification template.

Table and Column: CMN_CAPTIONS_NLS.NAME and DESCRIPTIONS with TABLE_NAME mapped to CMN_NOTIFICATIONS.

Type: String

Portfolio

Use the portfolio XOG object for outbound (read) and inbound (write) processing.

Schema Name

nikuxog_pfm_portfolio.xsd

Read and Write XML Files

The following files are included.

portfolio_read.xml. Use this file to export portfolios data.
portfolio_write.xml. Use this file to import portfolio data previously exported from CA Clarity.

Business Rules and Processing

The Portfolios schema is defined for inbound (write) processing only. Some of the portfolio fields (for example, budgetType, capacityType, capacityUnitType, invType) are optional on the schema but are required fields in the database table. If they are not provided in the input xml, the default values are used for these fields.

Schema Mappings

The following schema mappings are described:

More information:

Portfolio Schema Tag

Contents Schema Tag

Portfolio Schema Tag

The portfolio tag is part of the schema mapping for the portfolio XOG object. It has the following attributes:

code

Required. Defines the unique ID of this portfolio.

Table and Column: pfm_portfolio.code

Type: String

name

Required. Defines the name of this portfolio.

Table and Column: pfm_portfolio.name

Type: String

description

Optional. Defines the description of this portfolio.

Table and Column: pfm_portfolio.description

Type: String

syncschedule_cron

Optional. Defines the portfolio synchronization cadance in a cron like format.

Table and Column: pfm_portfolio.syncschedule_cron

Type: String

department

Optional. Defines the department (if any) associated with the portfolio.

Table and Column: pfm_portfolio.department_id

Type: String

currency_code

Optional. Defines the currency code for the portfolio.

Table and Column: pfm_portfolio.currency_code

Type: String

is_active

Optional. Defines the active status of the portfolio.

Table and Column: pfm_portfolio.is_active

Type: Boolean

page_layout

Optional. Defines the page layout of the portfolio.

Table and Column:

Type: String

partition_code

Optional. Defines the partition where the portfolio resides.

Table and Column: odf_ca_pfm_portfolio.partition_code

Type: String

cap_unit_type

Optional. Defines the capacity unit type for the portfolio (FTE or Hours).

Table and Column: pfm_portfolio.capacity_unit_type

Type: String

operating_cost_target

Optional. Defines the operating cost target for the portfolio.

Table and Column: pfm_portfolio.operating_cost_target

Type: Float

benefits_target

Optional. Defines the benefits target for the portfolio.

Table and Column: pfm_portfolio.benefits_target

Type: Float

resources_target

Optional. Defines the roles target for the portfolio.

Table and Column: pfm_portfolio.resources_target

Type: Float

operating_cost_curve

Optional. Defines the operating cost target for the portfolio as a curve.

Table and Column: pfm_portfolio.operating_cost_curve

Type: CurveType

capital_cost_curve

Optional. Defines the capital cost target for the portfolio as a curve.

Table and Column: pfm_portfolio.capital_cost_curve

Type: CurveType

benefits_curve

Optional. Defines the benefits target for the portfolio as a curve.

Table and Column: pfm_portfolio.benefits_curve

Type: CurveType

resources_curve

Optional. Defines the roles target for the portfolio as a curve.

Table and Column: pfm_portfolio.resources_curve

Type: CurveType

manager

Required. Defines the User ID of the portfolio manager who will manage this portfolio.

Table and Column: PMA_PORTFOLIOS. MANAGER_ID

Type: String

id

Required. Defines the unique identifier for this portfolio.

Table and Column: PMA_PORTFOLIOS.ID

Type: String

parentPortfolioID

Optional. Defines the unique identifier of the parent portfolio (if this a child portfolio).

Table and Column: PMA_PORTFOLIOS. PARENT_ID

Type: String

budgetCost

Required. Defines the budgeted cost of this portfolio.

Table and Column: PMA_PORTFOLIO. BDGT_CST_TOTAL

Type: Number

budgetBenefit

Required. Defines the budgeted benefit of this portfolio.

Table and Column: PMA_PORTFOLIOS. BDGT_REV_TOTAL

Type: Number

budgetType

Optional. Defines the budget type for this portfolio.

Values:

BUDGET_TYPE_TOTAL
BUDGET_TYPE_REMAINING

Default: BUDGET_TYPE_TOTAL

Table and Column: PMA_PORTFOLIOS. BUDGET_TYPE

Type: String

capacityType

Optional. Defines the capacity type for this portfolio.

Values:

CAPACITY_TYPE_TOTAL
CAPACITY_TYPE_REMAINING

Default: CAPACITY_TYPE_TOTAL

Table and Column: PMA_PORTFOLIOS. CAPACITY_TYPE

Type: String

invType

Optional. Defines the investment type for this portfolio.

Values: all, application, asset, idea, other, product, project, and service

Default: all

Table and Column: PMA_PORTFOLIOS. PORTFOLIO_INV_TYPE

Type: String

start_date

Required. Defines the start date for the portfolio horizon.

Table and Column: pfm_portfolio.start_date

Type: dateTime

finish_date

Required. Defines the finish date for the portfolio horizon.

Table and Column: pfm_portfolio.finish_date

Type: dateTime

currencyISOcode

Required.

Table and Column: PMA_PORTFOLIOS.CURRENCY_CODE

Type: String

pageLayoutCode

Optional.

Table and Column: CMN_INSTANCE_PAGES. PAGE_FRAME_ID

Type: String

Contents Schema Tag

This tag is part of the schema mapping for the Portfolio XOG object. It has the following attributes:

isIncluded

Defines whether portfolio content types are included.

Table and Column: PMA_PRTFLIO_INCL_CTNT_TYPES.IS_INCLUDED

investmentType

Required. On include tag.

Table and Column: PMA_PRTFLIO_INCL_CTNT_TYPES.OBJECT_TYPE_CODE

lastSyncDate

Defines the date the portfolio contents were last updated.

Table and Column: PMA_PRTFLIO_INCL_CTNT_TYPES.LAST_SYNC_DATE

runSync

This value is used only while processing.

Table and Column: Not Applicable

investmentID

Required. On contents/include/expression/investment tag and contents/investment tag.

Table and Column: PMA_PORTFOLIO_CONTENTS.INVEST_ID

investmentType

Required. On contents/include/expression/investment tag and contents/investment tag.

Table and Column: PMA_PORTFOLIO_CONTENTS.INVEST_TYPE

Process Notification

Use the Process Notification XOG object to view inbound and outbound configurable notification templates for processes.

Schema Name

nikuxog_processnotification.xsd

Read and Write XML Files

The following XML files are included:

processnotification_read.xml. Use this file to export notification templates from <CA PPM>.
processnotification_write.xml. Use this file to import notification templates that were previously exported from CA Clarity.

Prerequisites

Before using this XOG object, make sure the referenced object, such as the process exists in CA Clarity.

Read Filters

The following explicit read filters are used:

notificationCode: Defines the ID of the notification template.
languageCode: Defines the language code of the notification template for extracting the name and description fields. The parameter is not required if reading the notification template in all languages.
processCode: Defines the process code for which the notification template was defined.

Error Handling

No errors are thrown. If the filter includes invalid values, no records are read.

Schema Mapping

Mappings for the following schema tag names are provided:

Process Notification

Process Notification Schema Tag

The process notification tag is part of the schema mapping for the process notification XOG object. It has the following attributes:

notificationCode

Required. Defines the code for the notification template.

Table and Column: CMN_PROCESS_NOTIFICATIONS.NOTIFICATION_CODE

Type: String

functionalAreaCode

Required. Defines the functional area code that refers to the notification template.

Table and Column: CMN_PROCESS_NOTIFICATIONS.FUNCTIONAL_AREA_ID to the CMN_LOOKUPS_V table with lookup_type set to NOTIFICATION_TYPE

Type: String

isCustomized

Defines if the notification template is customized or not.

Table and Column: CMN_PROCESS_NOTIFICATIONS.IS_CUSTOMIZED

Type: Boolean

notificationNameDesc

Required. Defines the name and description of the notification template.

Table and Column: CMN_CAPTIONS_NLS.NAME and DESCRIPTIONS with TABLE_NAME mapped to CMN_PROCESS_NOTIFICATIONS.

Type: String

notificationSubjectBody

Required. Defines the subject and message body texts of the notification template.

Table and Column: CMN_CAPTIONS_NLS.NAME and DESCRIPTIONS with TABLE_NAME mapped to CMN_PROCESS_NOTIFICATIONS.

Type: String

process_code

Required. Defines the process code to which the current notification is associated with.

Table and Column: BPM_DEF_PROCESSES.PROCESS_CODE that associates to the CMN_PROCESS_NOTIFICATIONS.PROCESS_ID

Type: String

Project

Use the Project XOG object to view inbound and outbound project attributes. Projects are defined for inbound (write) and outbound (read) processing. Common reasons to import and export project data include:

To deliver project plans to drive external systems such as time sheet tools.
To integrate with Oracle Projects and other project systems.
To supply data for sophisticated reporting requirements.

Schema Name

nikuxog_project.xsd

Read and Write XML Files

The following XML files are included:

prj_projects_read.xml. Use this file to export project attributes from CA Clarity.
prj_projects_write.xml. Use this file to import business processes that were previously exported from CA Clarity.

Import Rules

When importing project management information, the user importing the project (XOG user) or the user passed in the Addedby attribute on the project XML, must have the Project - Edit Management - All access right.

The following import rules are applied while importing or updating project financial information:

The Username attribute must be passed and the user must be financially-enabled.
If the project is financially approved, changes to Client, Type, Billing Currency, Forecasting flag Template Flag, Billing Project Code and Exchange Rate Type are not allowed.
If there are transactions on PPA_WIP (with amounts not equal to zero) for a project, then the changing of Status to Close for that project is not allowed.
The Client, Project Class, WIP Class, Location, Department, and Currency used for a project must exist.
Contract Type, Project Document Number, Contract Amount, and Date are required.
Bill Amount, Number of Bills, Bill Frequency, and First Bill Date are entered once and you cannot change the value once imported.
If the rate/cost matrix is used in project financials, the specified rate matrix must be validated along with all the columns mentioned in the rate or cost matrix.
If any transactions exists on PPA_TRANSCONTROL, then the status of the report cannot be changed to "closed".

Deletion Rules

You can delete tasks, assignments, and resources by passing the Deletion attribute (which takes True or False). Only the following delete operations are allowed:

Delete Task: This also deletes all assignments for the task.
Remove a staff member from a project: When you remove staff from a project team, it also removes assignments for the resource.
Remove assignment from task: The deletes the assignment from the task.

You cannot delete teams, tasks, or assignments that are referenced by a time entry with non-zero actuals on a submitted timesheet (with a status other than Not Submitted or Rejected).

Exporting Project Data

When exporting project data from CA Clarity, the following elements are included:

Basic project information
Tasks
Assignments
Management information
Financial information

Read Filters

The following arguments are taken:

Tasks: include_tasks
Resources: include_resources
Baselines: include_baselines
Allocations: include_allocations
Custom: include_custom
Tasks: include_tasks
Estimate date: include_estimate_after_date
Estimates: include_estimates
Actuals: include_actuals
Dependencies: include_dependencies
Subprojects: include_subprojects

Note the following when using these arguments:

When include_tasks and include_resources are Off, only project master record and financial information is exported.
When include_tasks and include_resources arguments are On, all project information is exported, including assignments.
When include_tasks is On and include_resources is Off, the Work Breakdown Structure (WBS) is exported, but not assignments or resource information.
When include_tasks is Off and include_resources is On, project-level resource assignments are exported, but not the WBS or task-level assignments.

The following implicit filter is used:

The project is enabled for management.

The following explicit filters are used:

projectID
approved (Management)
approvedForBilling (Financial)
start date
end date
lastUpdatedDate: This is the most recent date of lastUpdatedDate in the SRM_PROJECTS table or PRModTime in the PRJ_PROJECTS table.
active project
management functionality is enabled

Schema Mappings - Outbound

Schema mappings are described for the following outbound Project tag names:

SRM_PROJECTS
SRM_RESOURCES (Manage Resource ID)
PRJ_PROJECTS
PAC_MNT_PROJECTS
Project Location
CLNTSUPP
PRTEAM
SRM_RESOURCES (Team Resource ID)
SRM_RESOURCES (Project Role ID)
SRM_RESOURCES (Assignment Resource ID)
Phttp://jakarta.apache.org/commonsRTask
PRAssignment
OBS Association
OBSAssoc

Schema Mappings - Inbound

Schema mappings are described for the following inbound Project tag names:

PRJ_PROJECTS
PAC_MNT_PROJECTS
Resource
Task
TaskLabor

SRM_PROJECTS Schema Tag

This tag is part of the outbound schema mapping for the project XOG object.

projectID

Required.

Table and Column: SRM_PROJECTS.UNIQUE_NAME

Type: String

name

Required.

Table and Column: SRM_PROJECTS.NAME

Type: String

description

Optional.

Table and Column: SRM_PROJECTS.DESCRIPTION

Type: String

createdBy

Optional.

Table and Column: SRM_PROJECTS.CREATED_BY

Type: String

createdDate

Optional.

Table and Column: SRM_PROJECTS.CREATED_DATE

Type: dateTime

lastUpdatedDate

Optional.

This uses PRJ_PROJECTS.prModTime

Table and Column: SRM_PROJECTS.LAST_UPDATED_DATE

Type: dateTime

lastUpdatedBy

Optional.

This uses PRJ_PROJECTS.prModBy if PRJ_PROJECTS.prModTime is later than LAST_UPDATED_BY.

Table and Column: SRM_PROJECTS.LAST_UPDATED_BY

Type: String

Active

Optional.

Table and Column: SRM_PROJECTS.IS_ACTIVE

Type: Boolean

program

Optional. Indicates if the project is a program

Table and Column: SRM_PROJECTS.IS_PROGRAM

Type: Boolean

SRM_RESOURCES Schema Tag

The SRM_RESOURCES tag is part of the outbound schema mapping for the project XOG object. This tag uses the SRM_RESOURCES table, where SRM_RESOURCES.USER_ID = CMN_SEC_USERS.ID and CMN_SEC_USERS.USER_NAME = PRJ_PROJECTS.MANAGER_ID.

This schema tag has the following attribute:

manageResourceID

Optional

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

Project (PRJ_PROJECTS) Schema Tag

The PRJ_PROJECTS tag is part of the outbound schema mapping for the project XOG object. It has the following attributes:

start

Optional.

Table and Column: PRJ_PROJECTS.prStart

Type: dateTime

finish

Table and Column: PRJ_PROJECTS.prFinish

Optional.

Type: dateTime

approved

Optional.

True only if prApproveTime is not null.

Table and Column: PRJ_PROJECTS.prApproveTime

Type: Boolean

OpenForTimeEntry

Optional.

Table and Column: PRJ_PROJECTS.prIsOpen

Type: Boolean

Closed

Optional.

True only if prClosedTime is not null.

Table and Column: PRJ_PROJECTS.prClosedTime

Type: Boolean

Project (PAC_MNT_PROJECTS) Schema Tag

The PAC_MNT_PROJECTS tag is part of the outbound schema mapping for the project XOG object. It has the following attributes:

financialLocation

Table and Column: PAC_MNT_PROJECTS.LOCATIONID

Type: String

financialDepartment

Optional.

Table and Column: PAC_MNT_PROJECTS.DEPARTCODE

Type: String

clientID

Optional.

Table and Column: PAC_MNT_PROJECTS.COMPANY_CODE

Type: String

affiliatedProjectID

Optional.

Table and Column: PAC_MNT_PROJECTS.AFFILIATEPROJECT

Type: String

financialStatus

Optional.

Table and Column: PAC_MNT_PROJECTS.STATUS

Type: String

approvedForBilling

Optional.

Table and Column: PAC_MNT_PROJECTS.APPROVED

Type: Boolean

billingType

Defines the billing type.

Values: S, I, and C

Table and Column: PAC_MNT_PROJECTS.TYPE_

Type: String

billingCurrencyCode

Optional.

Table and Column: PAC_MNT_PROJECTS.BILLLING_CURRENCY_CODE

Type: String

costType

Optional. Refers to Cost type for the investment. Possible values are OPERATING/CAPITAL. Default value is OPERATING.

Table and Column: PAC_MNT_PROJECTS.cost_type

Type: String

Project Location Schema Tag

The Project Location tag is part of the outbound schema mapping for the project XOG object. It uses the LOCATIONS table, where LOCATIONS.LOCATIONID = PAC_MNT_PROJECTS.LOCATIONID.

This schema tag has the following attribute.

Entity

Optional

Table and Column: LOCATIONS.ENTITY

Type: String

Project (CLNTSUPP) Schema Tag

This tag is part of the outbound schema mapping for the Project XOG object.

This tag uses the CLNTSUPP table, where CLNTSUPP.COMPANY_CODE = PAC_MNT_PROJECTS.COMPANY_CODE.

It has the following attribute.

clientName

Optional

Table and Column: CLNTSUPP.COMPANY_NAME

Type: String

Resource (PRTEAM) Schema Tag

This tag is part of the outbound schema mapping for the Project XOG object. It has the following attributes:

This tag uses the PRTeam table with zero to many records and where PRTeam.prProjectID = PRJ_PROJECTS.prID.

availFrom

Optional

Table and Column: PRTeam.prAvailStart

Type: dateTime

availTo

Optional

Table and Column: PRTeam.prAvailFinish

Type: dateTime

openForTimeEntry

Optional

Table and Column: PRTeam.prIsOpen

Type: Boolean

lastUpdatedBy

Optional

Table and Column: PRTeam.prModBy

Type: String

lastUpdatedDate

Optional

Table and Column: PRTeam.prModTime

Type: dateTime

capitalPercentage

Optional. Capitalization percent of planned cost at team level. The valid value of this attribute can be any float value from 0 (0%) to 1 (100%). The default value is 0.

Table and Column: PRTEAM.CAPITAL_PERCENTAGE

Type: Float

SRM_RESOURCES Schema Tag

The SRM_RESOURCES tag is part of the outbound schema mapping for the project XOG object. This tag uses the SRM_RESOURCES table where SRM_RESOURCES.ID = PRTeam.prResourceID.

This schema tag has the following attributes:

resourceID

Required.

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

SRM_RESOURCES Schema Tag

The SRM_RESOURCES tag is part of the outbound schema mapping for the project XOG object. This tag uses the SRM_RESOURCES table, where SRM_RESOURCES.ID = PRTeam.prRoleID.

This schema tag has the following attribute:

projectRoleID

Optional.

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

SRM_RESOURCES Schema Tag

The SRM_RESOURCES tag is part of the outbound schema mapping for the project XOG object. This tag uses the SRM_RESOURCES table where SRM_RESOURCES.ID = PRAssignment.prResourceID.

This tag has the following attribute:

resourceID

Required.

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

Task (PRTask) Schema Tag

This tag is part of the outbound schema mapping for the Project XOG object.

This tag uses the PRTask table, with 0 to many records, and where PRTask.prProjectID = PRJ_PROJECTS.prID.

The Task (PRTASK) schema tag has the following attributes:

taskID

Optional. Defines the unique identifier for the task.

Table and Column: PRTask.prExternalID

Type: String

name

Optional. Defines the name for the task.

Table and Column: PRTask.prName

Type: String

orderID

Optional. Defines the unique order identifier for the task.

Table and Column: PRTask.prWBSSequence

Type: Integer

outlineLevel

Optional. Defines the outline level for the task.

Table and Column: PRTask.prWBSLevel

Type: Integer

start

Optional. Defines the start date and time for the task.

Table and Column: PRTask.prStart

Type: dateTime

baseStart

Optional. Defines the base start date and time for the task.

Table and Column: PRTask.prBaseStart

Type: dateTime

finish

Optional. Defines the finish date and time for the task.

Table and Column: PRTask.prFinish

Type: dateTime

baseFinish

Optional. Defines the base finish date and time for the task.

Table and Column: PRTask.prBaseFinish

Type: dateTime

milestone

Optional.

Table and Column: PRTask.prIsMilestone

Type: Boolean

summary

Optional. True only if prIsTask is false.

Table and Column: Not applicable

Type: Boolean

key

Optional.

Table and Column: PRTask.prIsKey

Type: Boolean

category

Optional.

Table and Column: PRTask.prCategory

Type: String

status

Optional. Defines the status of the task.

Values:

0. Not Started
1. Started
2. Complete

Table and Column: PRTask.prStatus

Type: Integer

percComp

Optional. Valid values are between 0 and1 inclusive, where (100% is shown as 1.0.

Table and Column: PRTask.prPctComplete

Type: Float

lastUpdatedBy

Optional.

Table and Column: PRTask.prModBy

Type: String

lastUpdatedDate

Optional.

Table and Column: PRTask.prModTime

Type: dateTime

costType

Optional. Refers to Cost type for the task. Possible values are OPERATING/CAPITAL.

Table and Column: PRTASK.cost_type

Type: String

TaskLabor (PRAssignment) Schema Tag

This tag is part of the outbound schema mapping for the Project XOG object. It has the following attributes:

This tag uses the PRAssignment table, which can have 0 to many records, and where PRAssignment.prTaskID = PRTask.prID.

start

Optional.

Table and Column: PRAssignment.prStart

Type: dateTime

finish

Optional.

Table and Column: PRAssignment.prFinish

Type: dateTime

actualWork

Optional.

Table and Column: PRAssignment.prActSum

Type: Float

remainingWork

Optional.

Table and Column: PRAssignment.prEstSum

Type: Float

baselineWork

Optional.

Table and Column: PRAssignment.prBaseSum

Type: Float

actualThrough

Optional.

Table and Column: PRAssignment.prActThru

Type: dateTime

lastUpdatedBy

Optional.

Table and Column: PRAssignment.prModBy

Type: String

lastUpdatedDate

Optional.

Table and Column: PRAssignment.prModTime

Type: dateTime

OBS Association Schema Tag

The OBS Association tag is part of the outbound schema mapping for the Project XOG object. This schema tag is a wrapper for the OBSAssoc elements. No tables are used.

This tag has the following attribute:

completed

Optional. When completed and this value is True. Existing OBS associations not listed in the import are deleted.

Default: False

Table and Column: Not applicable

Type: String

OBS Association (OBSAssoc) Schema Tag

The OBS association tag is part of the outbound schema mapping for the project XOG object. The following tables are used in this tag:

PRJ_OBS_ASSOCIATIONS (OBS associations)
PRJ_OBS_TYPES (OBS)
PRJ_OBS_UNITS (OBS Units)
PRJ_OBS_UNITS_FLAT (OBS Units Flat Hierarchy)

This tag has the following attributes:

id

Required.

Table and Column: PRJ_OBS_TYPES.UNIQUE_NAME

Type: String

name

Optional.

Table and Column: PRJ_OBS_TYPES.PRJ_OBS_TYPES.NAME

Type: String

unitPath

Required. This is a slash-delimited list of unit names that points to the unit to which the object is associated.

Table and Column: PRJ_OBS_TYPES.PRJ_OBS_UNITS.NAME

Type: String

Example: CAN/BC/VAN

Project (PRJ_PROJECTS) Schema Tag

The PRJ_PROJECTS tag is part of the inbound schema mapping for the project XOG object. It has the following attributes:

Name

Required.

Table and Column: PRJ_PROJECTS.NAME

Type: String

projectID

Required. Uniquely identifies this project and is used as key for sub-project references.

Table and Column: PRJ_PROJECTS.UNIQUE_NAME

Type: String

description

Optional.

Table and Column: PRJ_PROJECTS.DESCRIPTION

Type: String

AddedBy

Optional. When AddedBy (CreatedBy in CA Clarity), the default Collaboration Manager is assigned to the project.

Table and Column: PRJ_PROJECTS.CREATED_BY

Type: String

AddedDate

Optional.

Table and Column: PRJ_PROJECTS.CREATED_DATE

Type: dateTime

lastUpdatedDate

Optional. Uses PRJ_PROJECTS.prModTime if later.

Table and Column: PRJ_PROJECTS.LAST_UPDATED_DATE

Type: dateTime

lastUpdatedBy

Optional. Uses PRJ_PROJECTS.prModBy if PRJ_PROJECTS.prModTime is later than LAST_UPDATED_BY.

Table and Column: PRJ_PROJECTS.LAST_UPDATED_BY

Type: String

Active

Optional.

Table and Column: PRJ_PROJECTS.IS_ACTIVE

Type: Boolean

Type

Required.

Table and Column: PRJ_PROJECTS.TYPE

Type: String

stageIdentifier

Required.

Table and Column: PRJ_PROJECTS.STAGE_IDENTIFIER

Type: String

start

Required.

Table and Column: PRJ_PROJECTS.prStart

Type: dateTime

finish

Required.

Table and Column: PRJ_PROJECTS.prFinish

Type: dateTime

approved

Optional. True only if prApprovedTime is not null. On import, prApprovedTime is set to the current time if it was previously null.

Table and Column: None

Type: Boolean

openForTimeEntry

Optional.

Table and Column: PRJ_PROJECTS.prIsOpen

Type: Boolean

closed

Optional. True only if prClosedTime is not null. On import, prClosedTime is set to the current time if it was previously null.

Table and Column: None

Type: Boolean

guidelines

Optional.

Table and Column: PRJ_PROJECTS.prGuidelines

Type: String

department

Optional.

Table and Column: PRJ_PROJECTS.prDepartment

Type: String

asOf

Optional.

Table and Column: PRJ_PROJECTS.prAsOf

Type: dateTime

cpmType

Optional.

Table and Column: PRJ_PROJECTS.prCPMType

Type: Integer

trackMode

Optional.

Table and Column: PRJ_PROJECTS.prTrackMode

Type: Integer

sponsoredBy

Optional.

Table and Column: PRJ_PROJECTS.prSponsoredBy

Type: String

requestedBy

Optional.

Table and Column: PRJ_PROJECTS.prRequestedBy

Type: String

requestedTime

Optional.

Table and Column: PRJ_PROJECTS.prRequestedTime

Type: dateTime

userText1

Optional.

Table and Column: PRJ_PROJECTS.prUserText1

Type: String

userText2

Optional.

Table and Column: PRJ_PROJECTS.prUserText2

Type: String

userText3

Optional.

Table and Column: PRJ_PROJECTS.prUserText3

Type: String

userText4

Optional.

Table and Column: PRJ_PROJECTS.prUserText4

Type: String

userText5

Optional.

Table and Column: PRJ_PROJECTS.prUserText5

Type: String

userText6

Optional.

Table and Column: PRJ_PROJECTS.prUserText6

Type: String

userText7

Optional.

Table and Column: PRJ_PROJECTS.prUserText7

Type: String

Format

Optional.

Table and Column: PRJ_PROJECTS.prFormat

Type: Integer

Priority

Optional. Defines the priority.

Values: 0-36, where:

0. Highest priority
36. Lowest priority

Table and Column: PRJ_PROJECTS.prPriority

Type: Integer

username

Optional. On import, the ProjectManagerMgmt access right is granted to this user.

Table and Column: PRJ_PROJECTS.prUsername

Type: String

startImposed

Optional.

Table and Column: PRJ_PROJECTS.prStartImposed

Type: Boolean

finishImposed

Optional.

Table and Column: PRJ_PROJECTS.prFinishImposed

Type: Boolean

baseTime

Optional.

Table and Column: PRJ_PROJECTS.prBaseTime

Type: dateTime

baseStart

Optional.

Table and Column: PRJ_PROJECTS.prBaseStart

Type: dateTime

baseFinish

Optional.

Table and Column: PRJ_PROJECTS.prBaseFinish

Type: dateTime

Chargecode

Optional. Validate existence with PRChargeCode.prID

Table and Column: PRJ_PROJECTS.PrChargeCodeID

Type: String

ManagerResource

Optional. Must be a valid resource.

Table and Column: PRJ_PROJECTS.PrUserName

Type: String

PAC_MNT_PROJECTS Schema Tag

The PAC_MNT_PROJECTS tag is part of the inbound schema mapping for the project XOG object. It has the following attributes:

financialLocation

Defines the financial location for the project.

Table and Column: PAC_MNT_PROJECTS.LOCATIONID

Type: String

financialDepartment

Optional. Defines the financial location for the project.

Table and Column: PAC_MNT_PROJECTS.DEPARTCODE

Type: String

clientID

Defines the unique client identifier for the project. If other financial properties fields are present, then clientId is required. Otherwise, clientID and all financial properties are optional.

Table and Column: PAC_MNT_PROJECTS.COMPANY_CODE

Type: String

affiliatedProjectID

Optional. Defines the affiliated project unique identifier for the project.

Table and Column: PAC_MNT_PROJECTS.AFFILIATEPROJECT

Type: String

financialStatus

Optional. Defines the financial status for the project.

Table and Column: PAC_MNT_PROJECTS.STATUS

Type: String

approvedForBilling

Optional.

Table and Column: PAC_MNT_PROJECTS.APPROVED

Type: Boolean

billingType

Optional. Defines the billing type for the project.

Values: S, I.

Table and Column: PAC_MNT_PROJECTS.TYPE_

Type: String

billingCurrencyCode

Required only when CA Clarity is set for multi-currency. Defines the billing currency code for the project.

Table and Column: PAC_MNT_PROJECTS.BILLLING_CURRENCY_CODE

Type: String

ProjectClass

Optional. Defines the project class for the project. This column defaults to clientID if Projectclass is not supplied.

Table and Column: PAC_MNT_PROJECTS.CLASS

Type: String

WIP Class

Optional. Defines the WIP class for the project. This column defaults to clientID if WIP Class is not supplied.

Table and Column: PAC_MNT_PROJECTS.WIPCLASS

Type: String

UseBudget

Optional.

Table and Column: PAC_MNT_PROJECTS.BUDGET

Type: Number

Billing Project

Optional.

Table and Column: PAC_MNT_PROJECTS.BILLING_PROJECT_ID

Type: Number

Send Bill To

Optional.

Table and Column: PAC_MNT_PROJECTS.BILL_TO_COMPANY_CODE

Type: String

billExpenses

Optional.

Table and Column: PAC_MNT_PROJECTS.EX_BILL_EXPENSES

Type: Number

Document number

Optional.

Table and Column: PAC_MNT_PROJECTS.CONTRACTNBR

Type: String

Contract amount

Optional.

Table and Column: PAC_MNT_PROJECTS.Contract Amount

Type: Number

Enforce Contract amount

Optional.

Values:

0. Do not enforce
1. Enforce

Default: 0

Table and Column: PAC_MNT_PROJECTS.ENFORCE_CONTRACT_AMOUNT

Type: Number

Date

Optional.

Table and Column: PAC_MNT_PROJECTS.Contract Date

Type: Date

Labor Rate Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCELABOR

Type: Number

Labor Cost Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCELABOR

Type: Number

Labor Exchange Rate

Optional.

Table and Column: PAC_MNT_PROJECTS.LABOR_EXCHANGE_RATE_TYPE

Type: Number

Materials Rate Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCEMATERIALS

Type: Number

Materials Cost Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCEMATERIALS

Type: Number

Materials Exchange Rate

Optional.

Table and Column: PAC_MNT_PROJECTS.MATERIALS_EXCHANGE_RATE_TYPE

Type: Number

EXPENSES Rate Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCELABOR

Type: Number

EXPENSES Cost Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCE EXPENSES

Type: Number

EXPENSES Exchange Rate

Optional.

Table and Column: PAC_MNT_PROJECTS.EXPENSE_EXCHANGE_RATE_TYPE

Type: Number

EQUIPMENT Rate Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSRATESOURCE EQUIPMENT

Type: Number

EQUIPMENT Cost Source

Optional.

Table and Column: PAC_MNT_PROJECTS.TRANSCOSTSOURCE EQUIPMENT

Type: Number

EQUIPMENT Exchange Rate

Optional.

Table and Column: PAC_MNT_PROJECTS.EQUIPMENT_EXCHANGE_RATE_TYPE

Type: Number

Submitted for Approval

Optional. Set to 1 if the project financial properties is to be marked submitted for approval.

Table and Column: PAC_MNT_PROJECTS.AWAITINGAPPROVAL

Type: Number

Submitted and Approved

Optional. Set to 1 if the project financial properties is to be marked submitted and approved

Table and Column: PAC_MNT_PROJECTS.APPROVED

Type: Number

batchCycle

Optional. Defines the batch cycle associated with the project.

Table and Column:

Type: String

Resource (PRTeam) Schema Tag

This tag is part of the inbound schema mapping for the Project XOG object. PRTeam is populated when you staff a resource to a project.

This tag uses the PRTeam table, which can have 0 to many records and where PRTeam.prProjectID = PRJ_PROJECTS.prID.

The Resource (PRTeam) schema tag has the following attributes:

availFrom

Optional. Uses the PRJ_PROJECTS.prStart if prAvailStart is not set.

Table and Column: PRTeam.prAvailStart

Type: dateTime

availTo

Optional. Uses PRJ_PROJECTS.prFinish if prAvailFinish is not set.

Table and Column: PRTeam.prAvailFinish

Type: dateTime

openForTimeEntry

Optional.

Table and Column: PRTeam.prIsOpen

Type: Boolean

lastUpdatedBy

Optional.

Table and Column: PRTeam.prModBy

Type: String

lastUpdatedDate

Optional.

Table and Column: PRTeam.prModTime

Type: dateTime

bookingStatus

Optional.

Table and Column: PRTeam.prBooking

Type: Integer

requestStatus

Optional.

Table and Column: PRTeam.prStatus

Type: Integer

defaultAllocation

Optional. The default allocation for this team member.

Table and Column: PRTeam.prAllocCurve

Type: Float

resourceID

Optional. May be more than one resource in the prTeam.

Table and Column: PRTeam.prResourceID

Type: String

ProjectRoleID

Optional. May be more than one role in prTeam.

Table and Column: PRTeam.PrRoleId

Type: String

PRTask Schema Tag

This tag is part of the inbound schema mapping for the Project XOG object. PRTeam is populated when you staff a resource to a project.

This tag uses the PRTask table, which can have 0 to many records and where PRTask.prProjectID = PRJ_PROJECTS.prID.

The Task (PRTask) schema tag has the following attributes:

taskID

Optional. Defines the unique identifier for the task. Required, if referenced by Relation tag or as a sub-project.

Table and Column: PRTask.prExternalID

Type: String

name

Optional. Defines the name for the task.

Table and Column: PRTask.prName

Type: String

orderID

Optional.

Table and Column: PRTask.prWBSSequence

Type: Integer

outlineLevel

Optional.

Table and Column: PRTask.prWBSLevel

Type: Integer

start

Optional.

Table and Column: PRTask.prStart

Type: dateTime

baseStart

Optional.

Table and Column: PRTask.prBaseStart

Type: dateTime

finish

Optional.

Table and Column: PRTask.prFinish

Type: dateTime

baseFinish

Optional.

Table and Column: PRTask.prBaseFinish

Type: dateTime

milestone

Optional.

Table and Column: PRTask.prIsMilestone

Type: Boolean

summary

Optional. This is set to True only if prIsTask is False.

Table and Column: Not Applicable

Type: Boolean

key

Optional.

Table and Column: PRTask.prIsKey

Type: Boolean

category

Optional.

Table and Column: PRTask.prCategory

Type: String

status

Optional. Defines the status of the task.

Values:

0. Not Started
1. Started
2. Complete

Table and Column: PRTask.prStatus

Type: Integer

percComp

Optional. Valid values are between 0 and 1 inclusive, where 100% is shown as 1.0.

Table and Column: PRTask.prPctComplete

Type: Float

lastUpdatedBy

Optional.

Table and Column: PRTask.prModBy

Type: String

lastUpdatedDate

Optional.

Table and Column: PRTask.prModTime

Type: dateTime

earlyStart

Optional.

Table and Column: PRTask.prEarlyStart

Type: dateTime

lateStart

Optional.

Table and Column: PRTask.prLateStart

Type: dateTime

earlyFinish

Optional.

Table and Column: PRTask.prEarlyFinish

Type: dateTime

lateFinish

Optional.

Table and Column: PRTask.prLateFinish

Type: dateTime

Duration

Optional.

Table and Column: PRTask.prDuration

Type: Float

baselineDuration

Optional.

Table and Column: PRTask.prBaseDuration

Type: Float

totalSlack

Optional.

Table and Column: PRTask.prTotalFloat

Type: Float

Unplanned

Optional. If the task is being updated, set this to False".

Table and Column: PRTask.prIsUnplanned

Type: Boolean

shortName

Optional.

Table and Column: PRTask.prShortname

Type: String

Guidelines

Optional.

Table and Column: PRTask.prGuidelines

Type: String

Fixed

Optional.

Table and Column: PRTask.prIsFixed

Type: Boolean

Locked

Optional.

Table and Column: PRTask.prIsLocked

Type: Boolean

baseFixed

Optional.

Table and Column: PRTask.prBaseIsFixed

Type: Boolean

baseTime

Optional.

Table and Column: PRTask.prBaseTime

Type: dateTime

TaskLabor (PRAssignment) Schema Tag

This tag is part of the inbound schema mapping for the Project XOG object. This PRAssignment table is populated when a resource is assigned to a task. This feature is not supported in CA Clarity but can be accomplished with Open Workbench or the CA Clarity Microsoft Project interface.

This tag uses the PRAssignment table, which can have 0 to many records, and where PRAssignment.prTaskID = PRTask.prID.

This tag has the following attributes:

Start

Optional.

Table and Column: PrAssignment.prStart

Type: dateTime

finish

Optional.

Table and Column: PrAssignment.prFinish

Type: dateTime

actualWork

Optional.

Table and Column: PrAssignment.prActSum

Type: Float

remainingWork

Optional.

Table and Column: PrAssignment.prEstSum

Type: Float

baselineWork

Optional.

Table and Column: PrAssignment.prBaseSum

Type: Float

actualThrough

Optional.

Table and Column: PrAssignment.prActThru

Type: dateTime

lastUpdatedBy

Optional.

Table and Column: PrAssignment.prModBy

Type: string

lastUpdatedDate

Optional.

Table and Column: PrAssignment.prModTime

Type: dateTime

Unplanned

Optional. During update Unplanned is False.

Table and Column: PrAssignment.prIsUnplanned

Type: Boolean

estPattern

Optional.

Table and Column: PrAssignment.prEstPattern

Type: Integer

basePattern

Optional.

Table and Column: PrAssignment.prBasePattern

Type: Integer

estMax

Optional.

Table and Column: PrAssignment.prEstMax

Type: Float

baseMax

Optional.

Table and Column: PrAssignment.prBaseMax

Type: Float

pendEstSum

Optional.

Table and Column: PrAssignment.prPendEstSum

Type: Float

pendActSum

Optional.

Table and Column: PrAssignment.prPendActSum

Type: Float

pendStart

Optional.

Table and Column: PrAssignment.prPendStart

Type: dateTime

pendFinish

Optional.

Table and Column: PrAssignment.prPendFinish

Type: dateTime

Status

Optional.

Table and Column: PrAssignment.prStatus

Type: Integer

curveType

Required.

Table and Column: PrAssignment.prExtension

Type: Integer

Start

Required.

Table and Column: PrAssignment.prExtension

Type: dateTime

Finish

Required.

Table and Column: PrAssignment.prExtension

Type: dateTime

Sum

Required.

Table and Column: PrAssignment.prExtension

Type: Float

resourceID

Required.

Table and Column: PrAssignment.prResourceID

Type: String

Requirement

Use the requirement XOG object to view inbound and outbound requirements.

The requirement read XOG reads all data from existing requirements and writes them to an xml format. The requirement write XOG writes new requirements or updates existing requirements.

Schema Name

nikuxog_requirement.xsd

Read and Write XML Files

The following XML files are included:

requirements_read.xml. Use this file to export requirements from CA Clarity.
requirements_write.xml. Use this file to import requirements that were previously exported from CA Clarity.

Prerequisites

None

Business Rules and Processing

The following business rules and processing apply to this XOG:

CA Clarity users must have the appropriate access rights to read or write requirements via XOG.
Referenced investments, releases, and users (e.g. manager) must exist in CA Clarity prior to xogging in the requirement or they will not be added.
Requirements are defined for inbound (write) and outbound (read) processing.

Read Filters

The following read filters are used:

objectID
investmentID
managerName
requirementTitle
requirementStatus (New, Need Additional Information, In Pipeline, Active Candidate, Assigned to Release, Approved, Implemented, Duplicate, Rejected, and Draft)
requirementType (Feature, Requirement, User Story)

Error Handling

The following fields are written to the Success and Error files when referenced objects such as users, investments, and releases or lookup values cannot be found, and the XOG process generates a warning:

created_by
currency_code
last_updated_by
manager
requested_by
risk
status
theme
type
release_id
project_id
task_name
investment_id

If dependencies or hierarchy links are included in the inbound XOG file, a warning is written to the Success and Error files if either one of the associated requirements does not exist. Since you can add the missing requirement later to the file, this warning does not imply that the association will never be made when xogging in many requirements. The warning's intention is to provide information to the administrator so that they can confirm that all associations have been made.

Schema Mappings

The requirement element can contain link and dependency elements which relate requirements to one another. The following tables are mapped to requirements:

More information:

RQP_RELEASES Schema Tag

RQP_REQUIREMENTS Schema Tag

RQP_REQ_DEPENDENCIES Schema Tag

PRTASK Schema Tag

SRM_RESOURCES Schema Tag

INV_INVESTMENTS Schema Tag

RQP_RELEASES Schema Tag

The RQP_RELEASES tag is part of the schema mapping for the requirement XOG object. It has the following attributes:

release_id

Table and Column: RQP_RELEASES.CODE

Type: String

RQP_REQUIREMENTS Schema Tag

The RQP_REQUIREMENTS tag is part of the schema mapping for the requirement XOG object. It has the following attributes:

title

Required.

Table and Column: RQP_REQUIREMENTS.TITLE

Type: String

object_id

Required. Must be unique.

Table and Column: RQP_REQUIREMENTS.CODE

Type: String

child

Required.

Table and Column: RQP_REQUIREMENTS.CODE

Type: String

parent

Required.

Table and Column: RQP_REQUIREMENTS.CODE

Type: String

requirement

Required.

Table and Column: RQP_REQUIREMENTS.CODE

Type: String

dependent

Required.

Table and Column: RQP_REQUIREMENTS.CODE

Type: String

description

Required. Must be unique.

Table and Column: RQP_REQUIREMENTS.DESCRIPTION

Type: String

committed

Required. Must be unique.

Table and Column: RQP_REQUIREMENTS.COMMITTED

Type: Boolean

committed

Required. Must be unique.

Table and Column: RQP_REQUIREMENTS.COMMITTED

Type: Boolean

est_op_cost

Table and Column: RQP_REQUIREMENTS.EST_OP_COST

Type: Non-negative number

est_cap_cost

Table and Column: RQP_REQUIREMENTS.EST_CAP_COST

Type: Non-negative number

est_effort

Table and Column: RQP_REQUIREMENTS.EST_EFFORT

Type: Non-negative number

est_hlm_size

Table and Column: RQP_REQUIREMENTS.EST_HLM_SIZE

Type: Integer

est_size

Table and Column: RQP_REQUIREMENTS.EST_SIZE

Type: Non-negative number

bgt_op_cost

Table and Column: RQP_REQUIREMENTS.BGT_OP_COST

Type: Non-negative number

bgt_cap_cost

Table and Column: RQP_REQUIREMENTS.BGT_CAP_COST

Type: Non-negative number

bgt_effort

Table and Column: RQP_REQUIREMENTS.BGT_EFFORT

Type: Non-negative number

bgt_size

Table and Column: RQP_REQUIREMENTS.BGT_SIZE

Type: Non-negative number

priority_1

Table and Column: RQP_REQUIREMENTS.PRIORITY_1

Type: Integer (allowed range 0-100)

priority_2

Table and Column: RQP_REQUIREMENTS.PRIORITY_2

Type: Integer (allowed range 0-100)

priority_3

Table and Column: RQP_REQUIREMENTS.PRIORITY_3

Type: Integer (allowed range 0-100)

priority_4

Table and Column: RQP_REQUIREMENT.PRIORITY_4

Type: Integer (allowed range 0-100)

feature_overview

Table and Column: RQP_REQUIREMENTS.FEATURE_OVERVIEW

Type: String

feature_driver

Table and Column: RQP_REQUIREMENTS.FEATURE_DRIVER

Type: String

feature_vision

Table and Column: RQP_REQUIREMENTS.FEATURE_VISION

Type: String

req_impl_plan

Table and Column: RQP_REQUIREMENTS.REQ_IMPL_PLAN

Type: String

req_impact_analysis

Table and Column: RQP_REQUIREMENTS.REQ_IMPACT_ANALYSIS

Type: String

req_comments

Table and Column: RQP_REQUIREMENTS.REQ_COMMENTS

Type: String

story_text_1

Table and Column: RQP_REQUIREMENTS.STORY_TEXT_1

Type: String

story_text_2

Table and Column: RQP_REQUIREMENTS.STORY_TEXT_2

Type: String

story_text_3

Table and Column: RQP_REQUIREMENTS.STORY_TEXT_3

Type: String

RQP_REQ_DEPENDENCIES Schema Tag

The RQP_REQ_DEPENDENCIES tag is part of the schema mapping for the requirement XOG object. It has the following attributes:

is_mutual

Table and Column: RQP_REQ_DEPENDENCIES.IS_MUTUAL

Type: Boolean

PRTASK Schema Tag

The PRTASK tag is part of the schema mapping for the requirement XOG object. It has the following attributes:

task_name

Table and Column: PRTASK.PRNAME

Type: String

SRM_RESOURCES Schema Tag

The SRM_RESOURCES tag is part of the schema mapping for the requirement XOG object. It has the following attributes:

requested_by

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

manager

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

approved_by

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

created_by

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

last_updated_by

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

INV_INVESTMENTS Schema Tag

The INV_INVESTMENTS tag is part of the schema mapping for the requirement XOG object. It has the following attributes:

project_id

Defines the unique identifier for the project.

Table and Column: INV_INVESTMENTS.CODE

Type: String

investment_id

Defines the unique identifier for the investment.

Table and Column: INV_INVESTMENTS.CODE

Type: String

Resource

Use the resource XOG object to view inbound (write) and outbound (read) resource attributes. This XOG object does not allow you to create a resource for a specific partition; it only supports the _ROOT partition code. You can, however, use the content pack XOG to add a resource as a member of a partition.

Schema Name

nikuxog_resource.xsd

Read and Write XML Files

The following XML files are included:

rsm_resources_read.xml. Use this file to export resource attributes from CA Clarity.
rsm_resources_write.xml. Use this file to import resource attributes that were previously exported from CA Clarity.

Business Rules and Processing

Prior to importing resources, you must set up the following items correctly:

Manager

Defines the resource's manager user name. This is a browse field against the CMN_SEC_USERS table. If the manager does not exist, the XML schema posts the resource without the manager's username and a warning is posted to the Success and Error file. If the username exists, the XML schema fills the field. When this XML schema is run for the first time, many records may be posted without values for the manager. Subsequently when the schema is run, user profiles are updated to include a value for the manager (provided the user was added during the first pass).

Company ID

Defines the unique identifier for the company associated with the resource. This is a browse field against the SRM_COMPANIES table. If the company does not exist, the schema posts the resource, leaves this field blank, and posts a warning to the Success and Error file. If the company exists, the schema fills the field. When this schema is run the first time, many records are posted without values for the company. Subsequently when the schema is run, user profiles are updated to include the company information (provided the user was added during the first pass).

Financial Properties

The financial properties associated with the resource.

Before resources can be imported into CA Clarity, the following financial properties are set up in the Financial Administration module. If the financial properties are not found in CA Clarity, the resource's financial properties are not imported into CA Clarity and an error is written to the Success and Error file. These properties are optional:

Financial Location
Financial Department
Resource Class

Vendor

(This is an exception and is not required for the financial properties. The resource is added without a vendor and a warning is posted to the Success and Error file.)

Transaction Class

The transaction class associated with the resource. The value in the XOG can found in the TRANSCLASS table.

Management Properties

Defines the management properties associated with the resource. The XOG assumes a resource is associated with the standard calendar available for a typical work day's standard number of hours (based upon the standard calendar settings). The value is based on the default Allocation percentage.

OBS association

The OBS associated with the resource. A Security OBS is required for labor resources; all resources can have OBS associations. To accommodate this, there is an OBS Associations portlet that can be used for import and export.

Custom Attributes

The custom fields associated with the resource. The XOG allows for an unlimited number of custom-defined fields, however you must map the generated field to the schema. Within the schema for custom-defined fields, provide the Column Name, Attribute Name, and Value (since these can be modified by CA Clarity users).

Lookup values

Any lookup values associated with the resource. Lookup codes must be provided when appropriate. They are validated against CMN_LOOKUPS. Lookups are extracted for a set of lookup codes.

Primary RoleId

The primary role of this resource. This is a browse field against SRM_RESOURCES. If the primary RoleId passed does not exist, this field is left blank and a warning message is posted to the Success and Error file (the field is filled when the role exists).

Read Filters

The XOG allows for outbound processing of users based on the following fields:

Resource Type
Active
And and Or processing is supported between the two fields and for processing within Type. The following combinations are supported:
isActive = x
```
where x = Active, Inactive
```
ResourceType = x
```
where x = LABOR, MATERIAL, EQUIPMENT or EXPENSE
```
isActive = x AND ResourceType = y
```
where x = Active, Inactive
where y = one of many Resource Types
```
The following arguments are accepted:
- Contact: include_contact
- Management: include_management
- Financials: include_financial
- Custom Information: include_custom
The following statements concern these two arguments:

When all arguments are "Off", only resource basic information is exported.

When all arguments are "On", all resource information is exported.

Error Handling

The following fields are written to the Success and Error file when the XOG process generates an error or warning:

externalId
externalSource
resourceId
lastName

If an error occurs, the table is not updated. You must fix the error and run the XOG again. When a warning occurs because of inconsistencies in the data, the record is posted and the non-required fields are defaulted.

The following errors should be validated against the resource:

Error or Warning Type	Description
resourceId	The unique identifier for the resource. The resource is validated against the resourceId field. If the resource ID: Is not unique, then the resource is not imported and an error is posted to the Success and Error file. Unique, then the resource is imported.
managerUserName	The unique identifier for the manager associated with the resource. The manager is validated against the companyId field. If the manager: Is not found, then the resource is imported without any association to a manager. Exists, then It is also imported.
companyId	The unique identifier for the company associated with the resource. The company ID is validated against the companyId field. If the company: Is not found, then the resource is imported without any association to a company. Exists, then it is also imported.
vendorCode	The unique code for the vendor associated with the resource. The vendor code is validated against the vendorCode field. If the vendor: Is not found, then the resource is imported without any association to a vendor. Exists, then it is also imported.
PAC_MNT_RESOURCES	The financial properties related to the resource. If the financial properties: Do not exist, then the resource is imported without any association to financial properties. Exist, then they are also imported.

Schema Mappings

The following schema tags are described:

Personal Information
Contact Information
Management Information
Financial Information
Expenses
Rates and Costs
Custom Information
OBS Associations
SkillAssocs

Personal Information Schema Tag

The personal information tag is part schema mapping for the resource XOG object. It has the following attributes:

ExternalSource

Required. Required by the schema lookup value. This is the originating system ID (for example Oracle)

Table and Column: SRM_RESOURCES.External_Source_ID

Type: String in the XML Schema) and Number in CA Clarity.

ExternalId

Required. Required by the XML schema. This is the originating unique identifier.

Table and Column: SRM_RESOURCES.External_ID

Type: String

isActive

Optional. Defines the resource's status.

Values:

1. True
0. False

Default: 1

Table and Column: SRM_RESOURCES.Is_Active

Type: Boolean

resourceType

Optional. Defines the resource type.

Values: LABOR, MATERIAL, EQUIPMENT, and EXPENSE

Default: LABOR

Table and Column: SRM_RESOURCES.Resource_type

Type: String

employmentType

Optional. Defines the employment type.

Values: employee and contractor

Default: employee

Table and Column: SRM_RESOURCES.Person_Type

Type: String

hireDate

Optional.

Table and Column: SRM_RESOURCES.Date_of_Hire

Type: Date

terminationDate

Optional.

Table and Column: SRM_RESOURCES.Date_of_Termination

Type: Date

managerUserName

Optional. Identifies the resource's manager.

Table and Column: SRM_RESOURCES.Manager_ID
(User Name)

Type: String

isExternal

Optional. Defines the resource's status.

Values:

1. True
0. False

Default: 0

Table and Column: SRM_RESOURCES.Is_External

Type: Boolean

firstName

Optional.

Table and Column: SRM_RESOURCES.First_Name

Type: String

lastName

Optional. Validates this field for LABOR resources

Table and Column: SRM_RESOURCES.Last_Name

Type: String

middleName

Optional.

Table and Column: SRM_RESOURCES.Middle_Name

Type: String

displayName

Optional. The name to display on the interface.

Table and Column: SRM_RESOURCES.Full_Name

Type: String

emailAddress

Optional. The email address of the resource.

Table and Column: SRM_RESOURCES.Email

Type: String

Contact Information Schema Tag (Resources XOG)

This tag is part schema mapping for the resources XOG object. It has the following attributes:

companyName

Optional. The association of a resource to a company.

Table and Column: SRM_CONTACTS.Company _ID

Type: String

jobTitle

Optional.

Table and Column: SRM_CONTACTS.Job_Title

Type: String

address1

Optional.

Table and Column: SRM_CONTACTS.Address1

Type: String

address2

Optional.

Table and Column: SRM_CONTACTS.Address2

Type: String

address3

Optional.

Table and Column: SRM_CONTACTS.Address3

Type: String

city

Optional.

Table and Column: SRM_CONTACTS.City

Type: String

state

Optional.

Table and Column: SRM_CONTACTS.State_Province

Type: String

postalCode

Optional.

Table and Column: SRM_CONTACTS.Postal _Code

Type: String

countryId

Optional. Lookup values for all countries.

Table and Column: SRM_CONTACTS.Country_ID

Type: Number

homePhone

Optional. No format enforced.

Table and Column: SRM_CONTACTS.Phone_Home

Type: String

workPhone

Optional. No format enforced.

Table and Column: SRM_CONTACTS.Phone_Work

Type: String

mobilePhone

Optional. No format enforced.

Table and Column: SRM_CONTACTS.Phone_Cell

Type: String

fax

Optional. No format enforced.

Table and Column: SRM_CONTACTS.Phone_Fax

Type: String

pager

Optional. No format enforced.

Table and Column: SRM_CONTACTS.Phone_Pager

Type: String

webAddress

Optional.

Table and Column: SRM_CONTACTS.URL

Type: String

Management Information Schema Tag

The Management Information tag is part schema mapping for the resources XOG object. It has the following attributes:

category

Optional. Defines the management category for this resource.

Table and Column: PRJ_RESOURCES.PRCATEGORY

Type: String

defautlAllocationPercentage

Optional. Defines the default allocation percentage for this resource.

Default: 100

Table and Column: PRJ_RESOURCES.DEFAULTALLOCATION

Type: Number

trackMode

Optional. Specifies the method in which this resource tracks time.

Values: Clarity, None, and Other.

Default: Clarity Time

Table and Column: PRJ_RESOURCES.PRTRACKMODE

Type: Number

openForTimeEntry

Optional. Defines whether this resource is open for time entry.

Values:

1. True
0. False

Default: 1

Table and Column: PRJ_RESOURCES.PRISOPEN

Type: Boolean

primaryRoleId

Optional. Indicates the role to which the resource belongs.

Table and Column: PRJ_RESOURCES.PRPRIMARYROLEID

Type: Number

inputTypeCode

Optional. Defines the default input type code for the resource.

Table and Column: PRJ_RESOURCES.PRTYPECODEID

Type: Number

userText1

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERTEXT1

type: String

userText3

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERTEXT2

type: String

userText3

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERTEXT3

type: String

userText4

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERTEXT4

type: String

userFlag1

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERFLAG1

Type: Boolean

userFlag2

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERFLAG2

Type: Boolean

userNumber1

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERNUMBER1

Type: Number

userNumber1

Optional. A user-defined field.

Table and Column: PRJ_RESOURCES.PRUSERNUMBER1

Type: Number

Financial Information Schema Tag

The Financial Information schema tag is part schema mapping for the resource XOG object. It has the following attributes:

FinancialCode

Required. A unique primary key that is equal to the Resource ID. This field is not exposed in the schema.

Table and Column: PAC_MNT_RESOURCES.RESOURCE_CODE

Type: String

location

Optional. The location association to the resource.

Table and Column: PAC_MNT_RESOURCES.LOCATIONID

Type: String

department

Optional. The department association to the resource.

Table and Column: PAC_MNT_RESOURCES.DEPARTCODE

Type: String

resourceClass

Required. The resource class association with the resource .

Table and Column: PAC_MNT_RESOURCES.RESOURCE_CLASS

Type: String

transactionClass

Required. The transaction class associated with the resource.

Table and Column: PAC_MNT_RESOURCES.TRANSCLASS

Type: String

vendorCode

Optional. The vendor association with the resource.

Table and Column: PAC_MNT_RESOURCES.VENDOR_CODE

Type: String

Active

Optional. Defines the resource's status.

Values:

1. True
0. False

Default: 1

Table and Column: PAC_MNT_RESOURCES.ACTIVE

Type: Boolean

Expenses Schema Tag

This tag is part schema mapping for the Resources XOG object. It has the following attributes:

reimbursementCurrency

Optional. The lookup value equal to the ISO standard code. This is the currency used to calculate reimbursements made to the resource. This code is not subject to multi-currency rules.

This field is specific to the resource and can vary from the system settings.

Table and Column: PAC_MNT_RESOURCES.EX_CURRENCY_CODE

Type: String

employeeCountryCode

Optional. The reimbursement country code.

Table and Column: PAC_MNT_RESOURCES.EX_COUNTRY_CODE

Type: String

Rates and Costs Schema Tag

The rates and costs schema tag is part schema mapping for the resource XOG object. It has the following attributes:

targetbillingRate

Optional. Defines the target billing rate for this resource.

Table and Column: PAC_MNT_RESOURCES.TARGETBILLRATE

Type: Float

targetPercentageBillable

Optional. Defines the billable percentage for this resource.

Table and Column: PAC_MNT_RESOURCES.TARGETPERCENTBILLABLE

Type: Float

Custom Information Schema Tag (Resources XOG)

The custom information tag is part schema mapping for the resource XOG object. It describes custom-defined fields. It has the following attributes:

Mentor

Optional. Identifies the mentor associated with this resource.

Table and Column: XDM_CDF_SRM_RESOURCES.XDM_RESOURCE_MENTOR

Type: String

WillingTravel

Optional. Defines the resource's willingness to travel.

Values:

1. True
0. False

Default: 0

Table and Column: XDM_CDF_SRM_RESOURCES.XDM_WILLING_TRAVEL

Type: Boolean

ResourceIndustry

Optional. Defines the industry related to this resource.

Table and Column: XDM_CDF_SRM_RESOURCES.XDM_RESOURCE_INDUSTRY

Type: String

ResourceGrade

Optional. Defines the grade related to this resource.

Values: Bronze, Silver, Gold, and Platinum.

Table and Column: XDM_CDF_SRM_RESOURCES.XDM_RESOURCE_GRADE

Type: String

OBS Associations Schema Tag (Resources XOG)

The OBS Associations tag is part of the schema mapping for the resources XOG object. It is not mapped to any table or column. This schema tag is a wrapper for the OBSAssoc element.

This schema tag has the following attributes:

completed

Optional. When completed and this value is True, existing OBS associations not listed in the import are deleted.

Default: False

Table and Column: None

Type: String

OBSAssoc Element

This element is associated with the following tables:

PRJ_OBS_ASSOCIATIONS (OBS Associations)
PRJ_OBS_TYPES (OBS)
PRJ_OBS_UNITS (OBS Units)
PRJ_OBS_UNITS_FLAT (OBS Units Flat Hierarchy)

This element has the following attributes:

id

Required. Defines the OBS association ID.

Table and Column: PRJ_OBS_TYPES.UNIQUE_NAME

Type: String

name

Optional. Defines the OBS association name.

Table and Column: PRJ_OBS_TYPES.PRJ_OBS_TYPES.NAME

Type: String

unitPath

Required. This is a slash-delimited list of unit names leading up to the unit to which the object is associated.

Table and Column: PRJ_OBS_TYPES.PRJOBS_UNITS.NAME

Type: String

Example: CAN/BC/VAN

SkillAssocs Schema Tag (Resources XOG)

The SkillAssocs tag is part of the schema mapping for the resources XOG object and is a wrapper for the skillAssoc element. It is not mapped to any tables or columns.

This schema tag has the following attributes:

isComplete

Optional. If true, this set of skills associations completely replaces any existing skills associated with the resource.

Default: False

Table and Column: None

Type: Boolean

SkillAssoc Element

The skills associated with each resource.

skillAssoc Element

The skillAssoc element has the following attributes:

skillCode

Required. Defines the code for this skill.

Table and Column: rsm_skills_associations.skill_id

Type: String

interestLevel

Optional. Defines the resource's interest level in this skill.

Table and Column: CMN_LOOKUPS

Note: The lookup code from the cmn_lookups table is based on interest_level_id from the rsm_skills_associations table.

Type: String

proficiencyLevel

Optional. Defines the resource's proficiency level in this skill.

Table and Column: CMN_LOOKUPS

Note: The Lookup code from the cmn_lookups table is based on proficiency_level_id from the rsm_skills_associations table.

Type: String

weight

Optional. Used when searching to produce a weighted average.

Table and Column: rsm_skills_associations.weight

Type: Number

Resource Class

Use the resource class XOG object to view inbound and outbound resource class instances.

Schema Name

nikuxog_resourceclass.xsd

Read and Write XML Files

The following XML files are included:

resourceclass_read.xml. Use this file to export resource class instances from CA Clarity.
resourceclass_write.xml. Use this file to import resource class instances that were previously exported from CA Clarity.

Prerequisites

None.

Read Filters

The following explicit read filters are used:

resource_class: Defines the resource class name.
Resource_type: Defines the resource class type.
description: Defines the description for the resource class.
active: Specifies whether the resource class is active.

Error Handling

The following error can be thrown:

Resource class or description is out of bound.

Schema Mapping

Mappings for the following schema tag name is provided:

Resource Class

Resource Class (resourceclass) Schema Tag

The resource class tag is part schema mapping for the resource class XOG object. It has the following attributes:

id

Required. Defines the unique resource ID.

Table and Column: PAC_FOS_RESOURCE_CLASS .ID

Type: String

resource_class

Required. Defines the unique resource class name.

Table and Column: PAC_FOS_RESOURCE_CLASS.Resource_Class

Type: String

resource_type

Required. Defines the resource type for the resource class.

Values: Q, L, X, and M

Table and Column: PAC_FOS_RESOURCE_CLASS.RESOURCE_TYPE

Type: String

description

Required. Defines the description of the resource class.

Table and Column: PAC_FOS_RESOURCE_CLASS.DESCRIPTION

Type: String

active

Required. Defines the status of the resource class.

Values: 0 and 1

Table and Column: PAC_FOS_RESOURCE_CLASS.ACTIVE

Type: String

Risk

Use the risk XOG object to view inbound and outbound risk attributes associated with projects.

Schema Name

nikuxog_risk.xsd

Read and Write XML Files

The following XML files are included:

risk_read.xml. Use this file to export risk object instances from CA Clarity.
risk_write.xml. Use this file to import risk object instances that were previously exported from CA Clarity.

Prerequisites

Before using this XOG, make sure referenced objects, such as projects, users, and categories, exist in CA Clarity.

Read Filters

The following explicit read filters are used:

projectCode: Defines the code for the associated project.
name: Defines the name of the change request.
riskCode: Defines the risk of the change request.
statusCode: Defines the status of the change request.
priorityCode: Defines the priority of the change request.
ownerCode: Defines the name of the owner or assignee of the change request.

Error Handling

The following errors can be thrown:

Assessor does not exist in the system.
Approved By does not exist in the system.
Project does not exist in the system.
Category type is not valid.
Status is not valid.
Priority is not valid.
Approach code is not valid.
Owner does not exist in the system.
Impact is not valid.
Probability is not valid.
Resolved By does not exist in the system.
Task does not exist for the given project.
Failed to import risk/issue/change request.

Schema Mapping

Mappings for the following schema tag names are provided:

risk

Risk Schema Tag

This tag is part of the schema mapping for the risk XOG object, and includes mapping for:

associatedTasks
associatedRisks
associatedIssues
residualRisks
responseStrategies

It has the following attributes:

name

Required. Defines the risk name.

Table and Column: NAME

Type: String

code

Required. Defines the code for the risk.

Column and Table: CODE

Type: String

description

Defines the description of this risk.

Table and Column: DESCRIPTION

Type: String

projectCode

Defines the code for the associated project

Table and Column: INV_INVESTMENTS.CODE

Type: String

categoryTypeCode

Defines the category of this request.

Table and Column: CATEGORY_TYPE_CODE

Type: String

ownerCode

Defines the name of the owner or assignee of the change request.

Column and Table:

Type: String

statusCode

Risk status.

Table and Column: STATUS_CODE

Type: String

priorityCode

Defines the priority of the risk (lookup).

Table and Column: PRIORITY_CODE

Type: String

assumptions

Defines the assumptions for this risk.

Table and Column: ASSUMPTIONS

Type: String

riskSymptoms

Risk symptoms.

Table and Column: RISK_SYMPTOMS

Type: String

impactDescription

Description of the impact.

Table and Column: IMPACT_DESCRIPTION

Type: String

approachCode

Response type (lookup)

Table and Column: APPROACH_CODE

Type: String

probabilityCode

Defines the probability code.

Table and Column: PROBABILITY_ENUM

Type: number

impactCode

Impact of this risk (lookup).

Table and Column: IMPACT_ENUM

Type: String

impactDate

Defines the impact date.

Table and Column: IMPACT_DATE

Type: date

targetResolutionDate

Targeted date of resolution of this risk.

Table and Column: TARGET_RESOLUTION_DATE

Type: Date

resolvedDate

Date the risk was resolved.

Table and Column: RESOLVED_DATE

Type: Date

resolution

Defines the description or how the risk was resolved.

Table and Column: RESOLUTION

Type: String

resolvedBy

Defines the name of the resource who resolved the risk.

Table and Column: RESOLVED_BY

Type: number

risk Element

The following attribute is part of the associatedRisks schema tag:

code

Required. Defines the code for the associated risk.

Column and Table: CODE

Type: String

issue Element

The following attribute is part of the associatedIssues schema tag:

code

Required. Defines the code for the associated issue.

Column and Table: CODE

Type: String

responseStrategy Element

The following attributes are part of the responseStrategies schema tag:

description

Description of this risk response strategy.

Column and Table: DESCRIPTION

Type: String

assignedTo

Defines the name of the resource assigned to this risk.

Column and Table: ASSIGNED_TO

Type: String

resolveBy

Targeted date of resolution of this risk.

Column and Table: TARGET_RESOLUTION_DATE

Type: Date

Role

Use the role XOG object to view inbound and outbound role attributes.

Schema Name

nikuxog_role.xsd

Read and Write XML Files

The following XML files are included:

roles_read.xml. Use this file to export role attributes from CA Clarity.
roles_write.xml. Use this file to import role attributes that were previously exported from CA Clarity.

Business Rules and Processing

The roles schema is defined for both inbound (write) and outbound (read) processing.

Important! Set up the following items correctly before importing resources:

Financial Properties

The financial properties that are associated with the role.

Before you can import roles into the product, set up the following financial properties in the Financial Administration module. The required property values must be present; otherwise, the financial properties are not imported and an error is written to the Success and Error File.

Transaction Class: Required if the role is financially active. The transaction class that is associated with the role. The value in the XOG can be found in the TRANSCLASS table.
Resource Class: Required if the role is financially active. The resource class that is associated with the role. The value in the XOG can be found in the PAC_FOS_RESOURCE_CLASS table.
Vendor: Optional: The vendor that is associated with the role. This property is not required for the financial properties. If the vendor property value is missing, the role is added without a vendor property and a warning is posted to the Success and Error file.

Read Filters

The XOG allows or outbound processing of roles that are based on the following fields:

active. The possible values for this field are: Active and Inactive.
resourceId. The resourceId corresponds to unique_name in SRM_RESOURCES.

Error Handling

If the parent role or the standard calendar does not exist, XOG displays an error message and does not import or update the record.

Schema Mappings

The following tables and schema tags are mapped to roles:

PRJ_RESOURCES table
SRM_RESOURCES table
PRJ_ROLES_FLAT table
PAC_FOS_RESOURCE_CLASS table
SkillsAssocs schema tag

PRJ_RESOURCES Schema Tag

This tag is part schema mapping for the role XOG object. It has the following attributes:

category

Optional.

Table and Column: PRJ_RESOURCES.PRCategory

Type: String

availability

Required. This attribute is stored as a blob internally. It uses standard calendar for conversion.

Table and Column: PRJ_RESOURCES.PRAvailCurve

Type: Double

SRM_RESOURCES Schema Tag

This tag is part schema mapping for the role XOG object. It has the following attributes:

name

Required. Must be unique.

Table and Column: SRM_RESOURCES.Last_Name,Full_Name

Type: String

resourceId

Required.

Table and Column: SRM_RESOURCES.Unique_Name

Type: String

active

Optional.

Table and Column: SRM_RESOURCES.Is_Active

Type: Boolean

PRJ_ROLES_FLAT Schema Tag

This tag is part schema mapping for the role XOG object. It has the following attribute:

parentRole

Optional.

Table and Column: PRJ_RESOURCES.Branch_Role_Id

The ID of the parent role is stored as the branch_role_id.

Type: String

Financial Information Schema Tag

The Financial Information schema tag is part schema mapping for the role XOG object. It has the following attributes:

Active

Required. Defines the status of the role.

Values:

1. True
0. False

Table and Column: PAC_MNT_RESOURCES.ACTIVE

Type: Boolean

resourceClass

Required. The resource class association with the role.

Table and Column: PAC_MNT_RESOURCES.RESOURCE_CLASS

Type: String

transactionClass

Required. The transaction class associated with the role.

Table and Column: PAC_MNT_RESOURCES.TRANSCLASS

Type: String

vendorCode

Optional. The vendor association with the role.

Table and Column: PAC_MNT_RESOURCES.VENDOR_CODE

Type: String

SkillAssocs Schema Tag

The SkillAssocs tag is part schema mapping for the role XOG object. This is a wrapper for the individual Skills Associations for a role.

The SkillAssocs schema tag has the following attribute:

isComplete

Optional. If true, this set of skills associations completely replaces any existing skills associated with the role.

Default: False

Table and Column: None

Type: Boolean

SkillAssoc (Skills Association) Element

This represents the skills associated with each role.

skillCode

Required. The code for the skill.

Table and Column: rsm_skills_associations.skill_id

Type: String

interestLevel

Optional. The role's interest level in this skill.

Table: CMN_LOOKUPS

The Lookup code from the cmn_lookups table is based on the interest_level_id from the rsm_skills_associations table.

Type: String

proficiencyLevel

Optional. The role's proficiency level in this skill.

Table: CMN_LOOKUPS

The Lookup code from the cmn_lookups table is based on the proficiency_level_id from the rsm_skills_associations table.

Type: String

weight

Optional. Used when searching to produce a weighted average.

Table and Column: rsm_skills_associations.weight

Type: Number

Skill

Use the skill XOG object to view inbound and outbound skill object instances.

Schema Name

nikuxog_skill.xsd

Read and Write XML Files

The following XML files are included:

rsm_skills_read.xml. Use this file to export skill object instances from CA Clarity.
rsm_skills_write.xml. Use this file to import skill object instances that were previously exported from CA Clarity.

Prerequisites

None

Read Filters

The following explicit read filters are used:

skillName
isActive

Error Handling

A basic import failure error can be thrown.

Schema Mapping

Mappings for the following schema tag names are provided:

Skill

Skill Schema Tag

The skill tag is part of the schema mapping for the skill XOG object. It has the following attributes:

isActive

Defines the status of the skill.

Table and Column: IS_ACTIVE

Type: Boolean

description

Defines the description of skill.

Table and Column: DESCRIPTION

Type: String

skillCode

Required. Defines the unique identifier for the skill.

Table and Column: SKILL_CODE

Type: String

name

Defines the skill name.

Table and Column: SKILL_NAME

Type: String

Subproject (Program)

Use the subproject (program) XOG object for inbound (write) and outbound (read) processing of subproject and program data. Subprojects are the links between master projects and the projects they contain.

Schema Name

nikuxog_project.xsd

Read and Write XML Files

The following XML files are included:

prj_programs_read.xml. Use this file to export programs from CA Clarity.
prj_programs_write.xml. Use this file to import programs that were previously exported from CA Clarity.

Business Rules and Processing

The following business rules and processing apply to this XOG:

When you import a subproject, data for the subproject is:
- Updated (if it has already been imported).
- Created (if it has not already been imported).
The only field supported during an update is read-only. To change the content of other fields during an update, delete the existing sub-project and create a new one (all fields are refreshed, not just the read-only field).
When you create a subproject, a proxy task is also created in the WBS of the master project that serves as a place holder for the sub-project. When you remove the subproject, the proxy is also removed.
When you import a proxy task, the WBSSequence for all subsequent tasks is incremented by 1.

Read Filters

To allow for outbound processing of programs, the XOG adds the isProgram filter to projects. This filter performs the following actions. When:

isProgram is commented out, all appropriate programs and projects are exported.
isProgram=1, programs only are exported.
isProgram=0, projects only are exported.

Schema Mappings

The prSubProject table contains information about subprojects. The data it contains is primarily linking information that specifies if the subproject is partial or complete. The link also specifies if the subproject is read-only. By definition, partial subprojects are read-only.

The following schemas are described:

PRSubproject Schema Tag (Inbound and Outbound)

This tag is part schema mapping for the PRSubp XOG object. It has the following attributes:

projectID

Required. The UNIQUE_NAME of the project that becomes the sub-project of the project when imported.

Table and Column: PRSubproject.prRefProjectID

Type: String

TaskID

Optional. The prExternalID of the task that represents the portion of the Work breakdown structure (WBS) that becomes the sub-project of the project. This can be defined at any level of the WBS.

Table and Column: PRSubproject.prRefTaskID

Type: String

succeedingTaskID

Optional. The prExternalID of the task that follows the sub-project in the WBS. If the sub-project is (or should be) the last item in the WBS, the value is not present.

Table and Column: None

Type: String

ReadOnly

Optional. This specifies if changes made to the master project are to be persisted when the master project is saved from Open Workbench or Microsoft Project. For partial sub-projects, this value is always False.

Table and Column: PRSubproject.prReadOnly

Type: Boolean

PRSubproject Schema Tag (Inbound only)

This tag is part schema mapping for the PRSubp XOG object. This tag is associated with the PRSubproject table. It has the following attributes:

delete

Optional. When this attribute is present on an inbound transaction, the sub-project link is deleted with the associated proxy.

Table and Column: None

Type: Boolean

Subscription

Use the subscription XOG object to view inbound and outbound department subscription attributes.

Schema Name

nikuxog_subscription.xsd

Read and Write XML Files

The following XML files are included:

subscription_read.xml. Use this file to export department subscription attributes from CA Clarity.

subscription_write.xml. Use this file to import department subscription attributes that were previously exported from CA Clarity entity, department and service must exist in CA Clarity.

Read Filters

The following explicit read filters are used:

departmentId: The code of the department for which the subscriptions should be read out.

Error Handling

The errors are thrown based on the following checks:

Required fields. Ensures all required fields have values.
Entity. Checks if the entity is valid and exists.
Department. Checks if the department is valid and exists.
Service. Checks if the service is valid and exists.

Schema Mapping

Mappings for the following schema tag name is provided:

Subscription

Subscription Schema Tag

The subscription tag is part of the schema mapping for the subscription XOG object. This is a placeholder tag for multiple subscriptions.

Subscription element

There can be zero or more subscription elements each having an optional keymetrics element, Following are the attributes of a subscription element:

sla_violations

Defines the number of SLA violations.

Table and Column: DPT_SUBSCRIPTIONS.sla_violations

Type: Integer

sla_violations_th

Defines the threshold for SLA violations.

Table and Column: DPT_SUBSCRIPTIONS.sla_violations_threshold

Type: Integer

incidents: Defines the number of incidents.

Table and Column: DPT_SUBSCRIPTIONS.incidents

Type: Integer

incidents_threshold: Defines the threshold for incidents.

Table and Column: DPT_SUBSCRIPTIONS.incidents_threshold

Type: Integer

change_orders: Defines the number of change orders.

Table and Column: DPT_SUBSCRIPTIONS.change_orders

Type: Integer

charges: Defines the total charges (from chargebacks) against the investment (service) for this subscription.

Table and Column: DPT_SUBSCRIPTIONS.charges

Type: Integer

cust_satisfaction: Defines the customer satisfaction rating for this subscription.

Table and Column: DPT_SUBSCRIPTIONS.customer_satisfaction

Type: Integer

total_users: Defines the total number of users utilizing this subscription.

Table and Column: DPT_SUBSCRIPTIONS.total_users

Type: Integer

active_users: Defines the number of active users utilizing this subscript.

Table and Column: DPT_SUBSCRIPTIONS.active_users

Type: Integer

page_hits: Defines the page hits as captured for this subscription if applicable.

Table and Column: DPT_SUBSCRIPTIONS.page_hits

Type: Integer

entityId: Required. Defines the entity to which the service belongs.

Table and Column: This is a derived attribute.

Type: String

departmentId: Required. Identifies the subscribing department.

Table and Column: DPT_SUBSCRIPTIONS.department_id

Type: String

serviceId: Required. Defines the identifier that makes it unique in combination with the table_name column.

Table and Column: pk_id

Type: String

keymetrics Tag

The keymetrics element consists of zero or more keymetric elements. This element contains an optional targetCurve and an actualCurve and may have zero or more CustomInformation elements. It has the following attributes:

metrics_code: Required. Code of the metric.

Table and Column: DPT_KEYMETRICS.METRIC_CODE

Type: String

metrics_code: Optional.

Table and Column: DPT_KEYMETRICS.NAME

Type: String

targetCurve and actualCurve Schema Tag

The curve elements contain segment objects which specify target metrics and actual metrics over a period of time.

Time Period

Use the time period (timesheet) XOG object to view inbound and outbound timesheet attributes. Timesheet information includes time periods and resources assigned to tasks. You can export the data to serve the purposes of system integration.

For example, you might do this when you need the information to drive internal or external billing systems. You do not need to export all timesheets in a system nor do you need to export timesheets individually. Filtering options are therefore provided by the XOG to streamline the export requests.

Schema Name

nikuxog_timeperiod.xsd

Read and Write XML Files

The following XML files are included:

olts_timeperiods_read.xml. Use this file to export time period instances from CA Clarity.

Read Filters

The XOG processes outbound capacity planning schemas based on the following fields:

isPublic: 1 or 0
ownerID: Valid user (CMN_SEC_USERS.ID)

The XOG uses no implicit filters for timesheets (timesheets for non-labor resources are excluded). The explicit filters used are:

Start Date
resourceID
postedInTimePeriodStart

Schema Mappings

Mappings for the following schema tags are provided:

TimePeriod
PRTimeSheet
SRM_RESOURCES
PRTimePeriod
PRTimeEntry
PRChargeCode
PRTypeCode
PRJ_Projects
PRTask
PRAssignments
NoteData

TimePeriod Schema Tag

This tag is part schema mapping for the time period XOG object. It has the following attributes:

start

Required.

Table and Column: PRTimePeriod.prStart

Type: DateTime

finish

Required.

Table and Column: PRTimePeriod.prFinish

Type: DateTime

openForTimeEntry

Optional.

Table and Column: PRTimePeriod.prIsOpen

Type: Boolean

postedTime

Optional.

Table and Column: PRTimePeriod.prPostedTime

Type: DateTime

PRTimeSheet Schema Tag

This tag is part schema mapping for the time period XOG object. It has the following attributes:

ID

Required. This is an internally-generated unique identifier.

Table and Column: PRTimeSheet.prID

Type: Integer

status

Optional.

Values: Unsubmitted, Submitted, Rejected, Approved, and Posted

Table and Column: PRTimeSheet.prStatus

Type: Integer

submittedBy

Optional.

Table and Column: PRTimeSheet.prSubmittedBy

Type: String

approvedBy

Optional.

Table and Column: PRTimeSheet.prApprovedBy

Type: String

adjustedTimeSheetID

Optional. This refers to the ID attribute of the timesheet that this timesheet is adjusted by, if any.

Table and Column: PRTimeSheet.prAdjustedId

Type: Integer

SRM_RESOURCES Schema Tag

The SRM_RESOURCES tag is part schema mapping for the time period XOG object. It has the following attributes:

This tag uses the SRM_RESOURCES table where SRM_RESOURCES.ID = PRTimeSheet.prResourceID.

resourceID

Required.

Table and Column: SRM_RESOURCES.UNIQUE_NAME

Type: String

PRTimePeriod Schema Tag

This tag is part schema mapping for the time period XOG object. This tag uses the PRTimePeriod table where PRTimePeriod.ID = PRTimeSheet.prPostedPeriodID. It has the following attributes:

postedInTimePeriodStart

Optional. The time period in which the timesheet was posted. This may differ from the time period in which this attribute is found if the timesheet was approved late, as with an adjustment.

Table and Column: PRTimePeriodprStart

Type: dateTime

PRTimeEntry Schema Tag

The PRTimeEntry tag is part schema mapping for the time period XOG object. This tag uses the PRTimeEntry table, 0 to many where PRTimeEntry.prTimeSheetID = PRTimeSheet.prID. It has the following attributes:

totalActuals

Optional. The total actuals in hours.

Table and Column: PRTimeEntry.prActSum

Type: float

taskID

Optional. For existing assignments: you can use projectID and taskID; or assignmentID.

For new assignments: you must use projectID and internalTaskID.

Table and Column: prTask.prExternalID

Type: string

projectID

Optional. For existing assignments: you can use projectID and taskID; or assignmentID.

For new assignments: you must use projectID and internalTaskID.

Table and Column: srm_projects.unique_name

Type: string

internalTaskID

Optional. For existing assignments: you can use projectID and taskID; or assignmentID.

For new assignments: you must use projectID and internalTaskID.

Table and Column: srm_projects.prTask.prID

Type: Integer

assignmentID

Optional. You can achieve a timesheet entry without creating an assignment first, but you must specify the task by its internal numeric ID number, such as internalTaskID = "5000876". If an assignment exists, you can use taskID = "abc".

Table and Column: prAssignment.prID

Type: Integer

actualDate

Required. Zero to many records for each day during this time period for which this time entry has actuals.

Table and Column: None

Type: Date

amount

Optional. The data is entered as hours. This is the amount for the date only.

Table and Column: prActCurve

Type: Float

PRTypeCode Schema Tag

The PRTypeCode tag is part schema mapping for the time period XOG object. This tag uses the PRTypeCode table where PRTimeEntry.prTypeCodeID = PRTypeCode.prID. It has the following attributes:

typeCodeID

Optional.

Table and Column: PRTypeCode.prExternalID

Type: String

typeCodeName

Optional.

Table and Column: PRTypeCode.prName

Type: String

PRChargeCode Schema Tag

This tag is part schema mapping for the time period XOG object. It has the following attributes:

This tag uses the PRChargeCode table where PRTimeEntry.prChargeCodeID = PRChargeCode.prID.

ChargeCodeID

Optional.

Table and Column: PRChargeCode.prExternalID

Type: String

ChargeCodeName

Optional.

Table and Column: PRChargeCode.prName

Type: String

PRJ_Projects Schema Tag

This tag is part schema mapping for the time period XOG object.

The following is true regarding the attributes that follow this statement:

From PRJ_PROJECTS, where PRTimeEntry.prAssignmentID = PRAssignment.prID and PRAssignment.prTaskID = PRTask.prID and PRTask.prProjectID = PRJ_PROJECTS.prID.

When prAssignmentID is not set (as for indirect time entries), these fields are not included.

projectID

Optional.

Table and Column: PRJ_PROJECTS.UNIQUE_NAME

Type: String

projectName

Optional.

Table and Column: PRJ_PROJECTS.NAME

Type: String

PRTask Schema Tag

This tag is part schema mapping for the time period XOG object.

The following is true regarding the attributes that follow this statement:

This tag uses the PRTask table where PRTimeEntry.prAssignmentID = PRAssignment.prID and PRAssignment.prTaskID = PRTask.prID).
When prAssignmentID is not set (as for indirect time entries), these fields are not included.

This tag includes the following attributes:

taskID

Optional.

Table and Column: PRTask.prExternalID

Type: String

taskName

Optional.

Table and Column: PRTask.prName

Type: String

PRAssignments Schema Tag

The PRAssignments tag is part schema mapping for the time period XOG object.

The following is true regarding the attributes that follow this statement:

This tag uses the PRAssignments table where PRTimeEntry.prAssignmentID = PRAssignment.prID.
When prAssignmentID is not set (as for indirect time entries), these fields are not included.

This tag includes the following attributes:

assignmentStart

Optional.

Table and Column: PRAssignments.prStart

Type: dateTime

assignmentFinish

Optional.

Table and Column: PRAssignments.prFinish

Type: dateTime

assignmentPendingEstimates

Optional. The value is in hours.

Table and Column: PRAssignments.prPendEstSum

Type: Float

assignmentEstimate

Optional. The value is in hours.

Table and Column: PRAssignments.prEstSum

Type: Float

assignmentEstimateForTimePeriod

Optional. The value is in hours, where the total within this time period only

Table and Column: PRAssignments.prEstCurve

Type: Float

NoteData Schema Tag

The NoteData tag is part schema mapping for the time period XOG object. This tag uses the PRNote, which is 0 to many, and where PRNote.prRecordID = PRTimeSheet.prID and PRNote.prTableName = 'PRTimeSheet. These values are contained in the TimeSheet Notes tag.

category

Optional. Defines the category for the timesheet note.

Table and Column: NoteData.prCategory

Type: String

noteText

Optional. Defines the text for the timesheet note.

Table and Column: NoteData.prValue

Type: String

createdBy

Optional. Defines the name of the resource who created the timesheet note.

Table and Column: NoteData.prCreatedBy

Type: String

createdTime

Optional. Defines the date the timesheet note was created.

Table and Column: NoteData.prCreatedTime

Type: dateTime

Transaction Class

Use the transaction class XOG object to view inbound and outbound transaction class instances.

Schema Name

nikuxog_transactionclass.xsd

Read and Write XML Files

The following XML files are included:

transactionclass_read.xml. Use this file to export transaction class instances from CA Clarity.
transactionclass_write.xml. Use this file to import transaction class instances that were previously exported from CA Clarity.

Prerequisites

None.

Read Filters

The following explicit read filters are used:

transclass: Defines the transaction class name.
transtype: Defines the transaction class type.
description: Defines the transaction class descriptions.
shortdesc: Defines the summary of the transaction class description.

Error Handling

The following errors can be thrown:

Description or short description is out of bound.

Schema Mapping

Mappings for the following schema tag name is provided:

Transaction Class

Transaction Class (transactionclass) Schema Tag

The transaction class tag is part schema mapping for the transaction class XOG object. It has the following attributes:

transactionclass

Required. Defines the unique transaction class name.

Table and Column: TRANSACTIONCLASS

Type: String

transactiontype

Required. Defines the transaction type for the transaction class.

Values: Q, L, X, and M

Table and Column: RESOURCE_TYPE

Type: String

description

Required. Defines the description of the transaction class.

Table and Column: DESCRIPTION

Type: String

shortdesc

Required. Defines the summary of the transaction class description.

Table and Column: SHORTDESC

Type: String

Type Code

Use the type code XOG object to view inbound and outbound type code object instances.

Schema Name

nikuxog_typecode.xsd

Read and Write XML Files

The following XML files are included:

prj_typecodes_read.xml. Use this file to export type codes from CA Clarity.
prj_typecodes_write.xml. Use this file to import type codes that were previously exported from CA Clarity.

Prerequisites

None

Read Filters

The following explicit read filter is used:

open

Error Handling

A basic import failure error can be thrown.

Schema Mapping

Mappings for the following schema tag name is provided:

Type Code

Type Code Schema Tag

The Type Code XOG is composed of the TypeCode element, which has the following attributes:

Id

Defines the unique identifier for the type code.

Table and Column: prID

Type: Integer

typeCodeID

Required. Defines the external unique identifier for the type code.

Table and Column: prExternalID

Type: String

name

Required. Defines the name of the type code.

Table and Column: prName

Type: String

openForTimeEntry

Defines whether the type code is open for timesheet use.

Table and Column: prIsOpen

Type: BOOLEAN

isChargeable

Defines whether the type code is chargeable in financial systems.

Table and Column: IS_CHARGEABLE

Type: BOOLEAN

UI Themes

Use the UI Themes XOG object for outbound (read) and inbound (write) processing.

Schema Name

nikuxog_uitheme.xsd

Read and Write XML Files

The following files are included.

cmn_ui_themes_read.xml. Use this file to export UI themes.
cmn_ui_themes_write.xml. Use this file to import UI themes that were previously exported.

Prerequisites

None

Business Rules and Processing

The last UI theme that is imported with an attribute value of default=true is the default UI theme for the system.

Read Filters

The following explicit read filter is used:

uiThemeID: Defines the unique UI theme ID that must be read out.

Schema Mappings

The following schema mappings are described:

More information:

UITheme Schema Tag

NLS Schema Tag

CSS Schema Tag

UITheme Schema Tag

The UITheme schema tag is part of schema mapping for the UI Theme XOG object. The schema tag has the following attributes:

id

Required. Defines the unique ID of the UI theme.

Table and Column: CMN_UI_THEMES.CODE

Type: String

active

Required. Defines whether the UI theme is active.

Table and Column: CMN_UI_THEMES.IS_ACTIVE

Type: String

Default: True

default

Optional. Defines whether the UI theme is the default UI theme.

Table and Column: CMN_UI_THEMES.IS_DEFAULT

Type: String

Default: False

NLS Schema Tag

The UITheme tag is part of schema mapping for the UI Theme XOG object. It has the following attributes

Name

Required. Defines the name of the UI theme.

Table and Column: CMN_CAPTIONS_NLS.NAME

Type: NlsType

Description

Required. Provides a description of the UI theme.

Table and Column: CMN_CAPTIONS_NLS.DESCRIPTION

Type: NlsType

CSS Schema Tag

This required schema tag defines the CSS code of the UI theme. The content of this element should always be enclosed in a CDATA section so that CSS code is not part of the markup of this schema.

User

Use the user XOG object to view inbound and outbound user object instance attributes.

Schema Name

nikuxog_user.xsd

Read and Write XML Files

The following XML files are included:

cmn_users_read.xml. Use this file to export users from CA Clarity PPM.
cmn_users_write.xml. Use this file to import users that were previously exported from CA Clarity PPM.

Business Rules and Processing

Users are defined for both inbound (write) and outbound (read) processing. Password and Password_Confirm, used to validate the user, are not exposed but are populated with default values (2000). When a user first logs in, they are prompted to reset this default password.

Resource: A labor resource is automatically created for every user imported through XOG.
Company ID: A browse field used to associate a user to a company is run against SRM_COMPANIES. If the company does not exist, the user is posted without a company and a warning message is posted to the Success and Error file. If the company_id exists, the field is populated with that value.
Lookup values: The schema requires lookup codes that are validated against CMN_LOOKUPS.
User type: If not provided, this is defaulted to internal. There is no admin type.
OBS association: With the new OBS Security, a Security OBS is required and any OBS can be associated with a user. To accommodate this, there is an OBS Associations portlet. The OBS association fields can be used for import and export.

Read Filters

This XOG allows for outbound (read) processing of users based on the following two fields: User Status and User Type. And and Or processing is supported between these two fields and for processing within Type. The following combinations are supported:

User Status = x
```
where x = Active, Inactive, or LOCK
```
User Type = x
```
where x = Internal, External
```

User Status = x AND User Type = y

where x = Active, Inactive, or LOCK
where y = one of many User Types

Error Handling

If an error occurs for a user transaction, the following information is written to the Success and Error file:

externalId
ExternalSource

Schema Mappings

The following schema mappings are described:

Personal Information (CMN_SENC_USERS)
OBS Associations (OBSAssocs)
Group Assignments
Global Access Right Assignments (GlobalRights)
Instance Access Right Assignments (InstanceRights)
Instance OBS Access Right Assignments (InstanceOBSRights)
Instance Object (InstanceObject)
Language Support (nls)

Personal Information (CMN_SENC_USERS) Schema Tag

This tag is part schema mapping for the user XOG object. It has the following attributes:

firstName

Required.

Table and Column: CMN_SEC_USERS.First Name

Type: String

lastName

Required.

Table and Column: CMN_SEC_USERS.Last Name

Type: String

userName

Required. A unique primary key.

Table and Column: CMN_SEC_USERS.User_Name

Type: String

userType

Optional.

Values: Internal and External

Default: Internal

Table and Column: CMN_SEC_USERS.User_Type_Id

Type: String

userStatus

Required.

Values: Active, Inactive, and LOCK

Default: Active

Table and Column: CMN_SEC_USERS.User_Status_ID

Type: String

emailAddress

Required.

Table and Column: CMN_SEC_USERS.Email Address

Type: String

userLocale

Optional. The Java Locale format, for example, en_US.

Table and Column: CMN_SEC_USERS.locale

Type: String

userTimezone

Optional. The Java TimeZone format, for example, Europe/London, PST.

Table and Column: CMN_SEC_USERS.timezone

Type: String

userLanguage

Required. Defines the language displayed when the user first logs in.

Values: English, German, Spanish, and French

Default: English

Table and Column: CMN_SEC_USERS.Language

Type: String

resource

Optional. A browse field with a one-to-one relationship between users and resources.

Table and Column: CMN_SEC_USERS.Resource

Type: String

companyId

Optional. This is a browse field. The company association with the user.

Table and Column: CMN_SEC_USERS.Company_ID

Type: String

externalSource

Required by the schema. It is a lookup value that is the originating system ID (for example, Oracle).

Table and Column: CMN_SEC_USERS.External_Source_ID

Type: String (in schema) and Number (in the application)

externalId

Required by the XML schema. The originating unique identifier.

Table and Column: CMN_SEC_USERS.External_ID

Type: String

OBS Associations (OBSAssocs) Schema Tag

This tag is part schema mapping for the user XOG object. This is a wrapper for the OBSAssoc element. It is not mapped to any table.

The OBS Associations schema tag has the following attribute:

completed

Optional. When completed and this value is True, the existing OBS associations not listed in the import are deleted.

Default: False

Table and Column: None

Type: String

OBS Association (OBSAssoc) Element

This element is mapped to the following tables:

PRJ_OBS_ASSOCIATIONS (OBS Associations)
PRJ_OBS_TYPES (OBS)
PRJ_OBS_UNITS (OBS Units)
PRJ_OBS_UNITS_FLAT (OBS Units Flat Hierarchy)

id

Required.

Table and Column: PRJ_OBS_TYPES.UNIQUE_NAME

Type: String

name

Optional.

Table and Column: PRJ_OBS_TYPES.PRJ_OBS_TYPES.NAME

Type: String

unitPath

Required. This is a slash-delimited list of unit names leading up to the unit to which the object is associated.

Table and Column: PRJ_OBS_TYPES.PRJ_OBS_UNITS.NAME

Type: String

Example: CAN/BC/VAN

Group Assignments Schema Tag

This tag is part schema mapping for the user XOG object. It is a wrapper for the Group elements.

The Group Assignments schema tag is not mapped to any table. It has the following attribute:

completed

Optional. If completed and set to True, any existing Group assignments that are not listed in the import are deleted.

Default: False

Table and Column: none

Type: String

Group Assignment (Group Assignments) Element

This is a wrapper element for the Group elements. There can be many Group elements. It has the following attribute:

id

Required.

Table and Column: CMN_SEC_GROUPS.GROUP_CODE

Type: String

Global Access Right Assignments (GlobalRights) Schema Tag

This tag is part schema mapping for the user XOG object. It is a wrapper element for the Right elements. There can be many Right elements.

The Global Access Right Assignments schema tag is not mapped to any table. It has the following attribute:

completed

Optional. If completed and set to True, then existing Right assignments not listed in the import are deleted.

Default: False

Table and Column: None

Type: String

Right Assignment (Right) Element

id

Required.

Table and Column: CMN_SEC_GROUPS.GROUP_CODE

Type: String

Instance Access Right Assignments (InstanceRights) Schema Tag

This tag is part schema mapping for the user XOG object. It is a wrapper element for the Right elements. There can be many Right elements.

The Instance Access Right Assignments schema tag is not mapped to any table. It has the following attribute:

completed

Optional. If completed and set to True, any existing Right assignments not listed in the import are deleted.

Default: False

Table and Column: None

Type: String

Right Assignment (Right) Element

id

Required.

Table and Column: CMN_SEC_GROUPS.GROUP_CODE

Type: String

Instance OBS Access Right Assignments (InstanceOBSRights) Schema Tag

This tag is part schema mapping for the user XOG object. It is a wrapper element for the Right elements. There can be many Right elements.

The Instance OBS Access Right Assignments schema tag is not mapped to any table. It has the following attribute:

completed

Optional. If completed and set to True, any existing Right assignments not listed in the import are deleted.

Default: False

Table and Column: None

Type: String

Right Assignment (Right) Element

id

Required.

Table and Column: CMN_SEC_GROUPS.GROUP_CODE

Type: String

Instance Object (InstanceObject) Schema Tag

This tag is part schema mapping for the user XOG object. It has the following attributes that are mapped to any of the following tables, unless otherwise noted:

SRM_RESOURCES
SRM_PROJECTS
BPM_DEF_PROCESSES
CMN_PAGES
CMN_PORTLETS
CMN_SCH_JOB_DEFINITIONS
INV_APPLICATION
INV_ASSET
INV_OTHER
INV_PRODUCT
SCENARIO

id

Required. The unique code from one of the listed tables.

Type: String

name

Optional. The name from one of the listed tables.

Type: String

type

Required. The key to determine which table is mapped. This is not mapped to any table.

Type: String

Language Support (nls) Schema Tag

This tag is part schema mapping for the user XOG object. It has the following attributes:

name

Optional.

Table and Column: CMN_CAPTIONS_NLS.NAME

Type: String

description

Optional.

Table and Column: CMN_CAPTIONS_NLS.DESCRIPTION

Type: String

languageCode

Optional.

Table and Column: CMN_CAPTIONS_NLS.LANGUAGE_CODE

Type: String

Vendor

Use the Vendor XOG object to view inbound and outbound vendor instances.

Schema Name

nikuxog_vendor.xsd

Read and Write XML Files

The following XML files are included:

vendor_read.xml. Use this file to export Vendor instances from CA Clarity.
vendor_write.xml. Use this file to import Vendor instances that were previously exported from CA Clarity.

Prerequisites

None

Read Filters

The following explicit read filters are used:

code: Defines the unique vendor code.
name: Defines the name of the vendor.
status: Defines the status of the vendor.

Error Handling

The following errors can be thrown:

Could not xog-in item because size of some attributes [description] is not within valid range.

Schema Mapping

Mappings for the following schema tag name is provided:

Vendor

Vendor Schema Tag

The Vendor tag is part schema mapping for the Vendor XOG object. It has the following attributes:

code

Required. Defines the unique vendor code.

Table and Column: VENDOR_CODE

Type: String

name

Required. Defines the name of the vendor.

Table and Column: ADDRESS_NAME

Type: String

affiliation

Optional.

Table and Column: AFFILIATED_VEND_CODE

Type: String

status

Required. Defines the status of the vendor.

Valid Values: Active, Inactive, and No New Business

Table and Column: STATUS_TYPE

Type: String

address1

Optional.

Table and Column: ADDR1

Type: String

address2

Optional.

Table and Column: ADDR2

Type: String

address3

Optional.

Table and Column: ADDR3

Type: String

address4

Optional.

Table and Column: ADDR4

Type: String

address5

Optional.

Table and Column: ADDR5

Type: String

address6

Optional.

Table and Column: ADDR6

Type: String

attentionName

Optional.

Table and Column: ATTENTION_NAME

Type: String

attentionPhone

Optional.

Table and Column: ATTENTION_PHONE

Type: String

contactName

Optional.

Table and Column: CONTACT_NAME

Type: String

contactPhone

Optional.

Table and Column: CONTACT_PHONE

Type: String

WIP Class

Use the WIP class XOG object to view inbound and outbound WIP class instances.

Schema Name

nikuxog_wipclass.xsd

Read and Write XML Files

The following XML files are included:

wipClass_read.xml. Use this file to export WIP class instances from CA Clarity.
wipClass_write.xml. Use this file to import WIP class instances that were previously exported from CA Clarity.

Prerequisites

None.

Read Filters

The following explicit read filters are used:

wipclass: Defines the WIP class name.
description: Defines the description for the WIP class.
shortdesc: Defines the short description for the WIP class.

Error Handling

The following errors can be thrown:

Wipclass or description or short description is out of bound.

Schema Mapping

Mappings for the following schema tag name is provided:

WIP Class

WIP Class (wipclass) Schema Tag

The WIP class tag is part schema mapping for the WIP class XOG object. It has the following attributes:

wipclass

Required. Defines the unique WIP class name.

Table and Column: WIPCLASS

Type: String

description

Required. Defines the description of the WIP class.

Table and Column: DESCRIPTION

Type: String

shortdesc

Required. Defines the summary of the WIP class description.

Table and Column: SHORTDESC

Type: String