XOG: 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.
ccppmop144
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 
    Clarity Project and Portfolio Management (PPM)
    .
  • caplan_scenarios_write.xml. Use this file to import capacity planning scenarios that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Prerequisites
The following conditions must be met before importing capacity planning scenarios:
  • You must create the scenario.
  • Some of the fields that a scenario can include are objects that must already exist in 
    Clarity Project and Portfolio Management (PPM)
     to be imported. These include projects that are identified by SRM_PROJECTS.UNIQUE_NAME.
  • If 
    Clarity Project and Portfolio Management (PPM)
     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 are 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 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 that 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 that are 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 that are 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. Defines 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
    T
    ype:
    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 that is assigned to the task.
    Table and Column:
    CAP_SCENARIO_ASSIGNMENTS.RESOURCE_ID
    Type:
    Number