XOG: Cost Plan

ccppmop1561
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 
    Clarity PPM
    .
  • costPlan_write.xml. Use this file to import cost plans that were previously exported from 
    Clarity PPM
    .
Prerequisites
Before you use this XOG object, verify the following objects already exist in 
Clarity PPM
:
  • 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 with 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
    cost_type_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 also has two attributes: glAccountMain and glAccountSub. These attributes define the GL Account that is 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 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