XOG: Non-Project Investment

Use the Non-project Investments XOG object to view inbound and outbound non-project investment object (NPIO) attributes. NPIOs include:
ccppmop144
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.
    Clarity Project and Portfolio Management (PPM)
     verifies that the object type and name matches. If the NPIO does not exist, 
    Clarity Project and Portfolio Management (PPM)
     verifies that the name is unique. If the check passes, the NPIO is created and posted.
  • The 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.
    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.
    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.
    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 
    Clarity Project and Portfolio Management (PPM)
    .
  • inv_products_write.xml. Use this file to import product instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
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 
    Clarity Project and Portfolio Management (PPM)
    .
  • inv_others_write.xml. Use this file to import other investment instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
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 
      Clarity Project and Portfolio Management (PPM)
       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 
      Clarity Project and Portfolio Management (PPM)
      .
      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 
      Clarity Project and Portfolio Management (PPM)
      .
      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 that is logged in to 
      Clarity Project and Portfolio Management (PPM)
      .
      Table and Column:
      PRJ_PROJECTS.LAST_UPDATED_BY
      Type:
      String
    • lastUpdatedDate
      Optional. Defines the date that the investment was last updated.
      Default:
      Today's date
      Table and Column:
      SRM_PROJECTS.LAST_UPDATED_DATE
      Type:
      dateTime
    • approvedTime
      Optional. Defines the time that 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 
      Clarity Project and Portfolio Management (PPM)
      .
      Table and Column:
      PRJ_PROJECTS.PROCESS_CODE
      Type:
      String
    • stageCode
      Required. Defines the stage code of the investment. The code must exist in 
      Clarity Project and Portfolio Management (PPM)
      .
      Table and Column:
      PRJ_PROJECTS.STAGE_CODE
      Type:
      String
    • categoryCode
      Required. Defines the category code of the investment. The code must exist in 
      Clarity Project and Portfolio Management (PPM)
      .
      Table and Column:
      PRJ_PROJECTS.CATEGORY_CODE
      Type:
      String
    • goalCode
      Required. Defines the goal code of the investment. The code must exist in 
      Clarity Project and Portfolio Management (PPM)
      .
      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
    • 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 percent.
      Table and Column:
      PRJ_PROJECTS.BDGT_ROI
      Type:
      Percent
    • budgetBreakEven
      Optional. 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. Recalculated after import if Calculate Present Value Info flag is set.
      Table and Column:
      PRJ_PROJECTS.FCST_NPV
      Type:
      Float
    • forecastROI
      Optional. Recalculated after import if Calculate Present Value Info flag is set. 1.0 is 100 percent.
      Table and Column:
      PRJ_PROJECTS.FCST_ROI
      Type:
      Percent
    • forecastBreakEven
      Optional. 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 
      Clarity Project and Portfolio Management (PPM)
      .
      Table and Column:
      PRJ_PROJECTS.CURRENCY_CODE
      Type:
      String
    • calculatePresentValueInfo
      Required. If selected, 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
    • 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 value 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 value is recalculated after import. 1.0 is 100 percent.
      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 value 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 value is recalculated after import. 1.0 is 100 percent.
      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 value 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 value is recalculated after import. 1.0 is 100 percent.
      Table and Column:
      FIN_FINANCIALS.FORECAST_ROI.
      Type:
      Double
    • forecastBreakEven
      Optional. 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 
      Clarity Project and Portfolio Management (PPM)
      .
      Table and Column:
      FIN_FINANCIALS.CURRENCY_CODE
      Type:
      String
    • calculatePresentValueInfo
      Optional. If checked, 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. This tag 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 
    Clarity Project and Portfolio Management (PPM)
    .
  • inv_services_write.xml. Use this file to import service instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .