XOG: Budget Plan

ccppmop1561
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 
    Clarity PPM
    .
  • budgetPlan_write.xml. Use this file to import budget plans that were previously exported from 
    Clarity PPM
    .
Prerequisites
Before you use this XOG object, verify that the following objects exist in 
Clarity PPM
:
  • Investments
  • Entity
  • Time periods
  • Details that are 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 with 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
    cost_type_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.
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 grouping attribute 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