XOG: Investment

ccppmop1561
Multiple objects use the investment XOG object, all of which share a common foundation and common schema (nikuxog_inv_common.xsd). The schema definition that is contained in this common file 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
You can read or write investments in their specific investment type, such as application, asset, or product. Generic read and write XML example files for investments are included with the XOG client application. 
Prerequisites
Any referenced resources (for example,
managerName
) should already exist in 
Clarity PPM
.
Business Rules and Processing
Objects which are based on the Investment object are defined for inbound (write) and outbound (read) processing. The abstract Investment object itself cannot be written to or read from 
Clarity PPM
.
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.
  • You might encounter the following error if you assign an invalid value to an attribute. For example,
    disableTSVUpdate
    can be
    true
    (1) or
    false
    (0), but cannot be set to
    yes
    or
    3
    <ErrorInformation> <Severity>FATAL</Severity> <Description>[Error] :1:1: attribute "disableTSVUpdate" has a bad value: "yes" does not satisfy the "boolean" type Invalid attribute in input document. Please remove all instances of attribute from document elements and try again. [Element : Asset, Attribute : disableTSVUpdate ]. </Description> <Exception type="java.lang.Exception">Invalid xml data</Exception> </ErrorInformation>
Schema Mapping
The Investment XOG object is composed of the following.
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 that are 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 
    Clarity PPM
     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 that 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 that is 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 from 0 through 100.
    Table and Column: 
    INV_INVESTMENTS.ALIGNMENT
    Type: 
    Number
  • risk
    Optional. The risk that is 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 that is 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. 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
  • 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
  • disableTSVUpdate
    Optional. Available in 
    Clarity PPM
     15.6 or newer.
    Table and Column: 
    Not applicable for this virtual attribute.
    Type: 
    Boolean
New
disableTSVUpdate
Attribute in XOG Import Files for Projects and Investments
In releases before 15.6, a XOG import (write) file, specifically for a project or non-project investment that included the optional
openForTimeEntry
attribute and associated resources who were also being allocated to a team (a special type of resource introduced in 15.5) through the same XOG import file, would cycle through all the assignments in the investment. This behavior could result in performance issues, especially during attempts to import large numbers of resources (for example, more than 10,000).
  • When adding a resource to a team for an investment in the new or classic user interface, the application appends the ETC or actuals to the previously-generated slice curve.
  • When adding a resource through the XOG, the existing time-scaled value (TSV) curves are unknown and cannot be accessed; instead, the XOG import causes the application to regenerate all TSV curves for all assignments in the investment.
To improve XOG performance in Clarity PPM 15.6 or higher, include the new
disableTSVUpdate
XOG attribute in your XOG import file:
  • If set to
    true
    , the XOG import does not attempt to process the aggregated TSV values; instead, administrators run the Investment Allocation job to update the aggregated totals.
  • If the attribute is set to
    false
    or excluded from the import file, the functionality remains the same as the previous release.
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 that are used to track charges against different organizational units (for example, a department). The attributes of this tag do 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 do 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 
Clarity PPM
 and confirms that the dependency exists when writing to 
Clarity PPM
. 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 refer 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 will 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" 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. This subelement 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. This tag 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 OBS Associations tag is also a shared xsd type and a wrapper for the OBSAssoc elements.
Example:
<xs:complexType name="OBSAssocsType"> <xs:annotation> <xs:documentation xml:lang="en"> <... list of OBS Associations ...> <OBSAssocs complete="false"> </xs:documentation>
The OBSAssocs element contains the following element, plus zero or more OBSAssoc subelements.
  • complete
    An optional field that defines whether the OBS associations are complete. When complete is 
    true
    , existing OBS associations that are not listed in the import are deleted. When the value is 
    false
    , the operation inserts and/or updates any existing OBS associations.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Default: 
    False
    Table and Column: 
    None
    Type: 
    Boolean
OBSAssoc Element
No tables or columns are associated with the OBSAssoc element. This element has the following attributes:
  • name
    Optional.
    Type: 
    String
  • id
    Optional.
    Type: 
    String
  • unitPath
    Required. Slash-delimited list of OBS unit names leading to the associated unit for the object. For example:
    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.