XOG: Project

ccppmop1561
Use the Project XOG object to view inbound and outbound project attributes. Projects are defined for inbound (write) and outbound (read) processing. Common reasons to import and export project data include:
  • To deliver project plans to drive external systems such as time sheet tools.
  • To integrate with Oracle Projects and other project systems.
  • To supply data for sophisticated reporting requirements.
 
Schema Name
 
nikuxog_project.xsd
 
 
 
Read and Write XML Files
 
The following XML files are included:
  • prj_projects_read.xml. Use this file to export project attributes.
  • prj_projects_write.xml. Use this file to import business processes that were previously exported.
 
Import Rules
 
When importing project management information, the user importing the project (XOG user) or the user passed in the 
Addedby
 attribute on the project XML must have the 
Administration – XOG
 or 
Project – XOG Access
 and 
Project - Create
 access rights. To update an existing project using XOG, you must have the 
Project – Edit
 access right.
The following import rules are applied while importing or updating project financial information:
  • The Username attribute must be passed and the user must be financially-enabled.
  • If the project is financially approved, changes to Client, Type, Billing Currency, Forecasting flag Template Flag, Billing Project Code, and Exchange Rate Type are not allowed.
  • An imported task with no start and finish dates in the inbound XML file inherits the project Start Date and Finish Date values.
  •  A project cannot be closed if 
    • There are transactions on the Post to WIP (PPA_WIP) list with amounts not equal to zero.  
    • There are transactions on the Invalid Transaction list (PPA_TRANSCONTROL).  
  • The Client, Project Class, WIP Class, Location, Department, and Currency that is used for a project must exist.
  • Contract Type, Project Document Number, Contract Amount, and Date are required.
  • Bill Amount, Number of Bills, Bill Frequency, and First Bill Date are entered once. After import, you cannot change the value.
  • If the rate/cost matrix is used in project financials, the specified rate matrix must be validated with all of the columns that are mentioned in the rate or cost matrix.
 
Deletion Rules
 
You can delete tasks, assignments, and resources by passing the Deletion attribute (which takes 
True
 or 
False
). Only the following delete operations are allowed:
  •  
    Delete Task
    : This task also deletes all assignments for the task.
  •  
    Remove a staff member from a project
    : When you remove staff from a project team, it also removes assignments for the resource.
  •  
    Remove assignment from task
    : The task deletes the assignment from the task.
You cannot delete teams, tasks, or assignments that are referenced by a time entry with non-zero actuals on a submitted timesheet with a status other than 
Not Submitted
 or 
Rejected
.
 
Exporting Project Data
 
When exporting project data from 
Clarity PPM
, the following elements are included:
  • Basic project information
  • Tasks
  • Resource Team (Staff) information
  • Assignments
  • Management information
  • Financial information
 
Read Filters
 
The following arguments are taken:
  • Tasks: include_tasks
  • Resources: include_resources
  • Baselines: include_baselines
  • Allocations: include_allocations
  • Custom: include_custom
  • Tasks: include_tasks
  • Estimate date: include_estimate_after_date
  • Estimates: include_estimates
  • Actuals: include_actuals
  • Dependencies: include_dependencies
  • Subprojects: include_subprojects
Consider this information when using these arguments:
  • When include_tasks and include_resources are Off, only project master record and financial information is exported.
  • When include_tasks and include_resources arguments are On, all project information is exported, including assignments.
  • When include_tasks is On and include_resources is Off, the Work Breakdown Structure (WBS) is exported, but not assignments or resource information.
  • When include_tasks is Off and include_resources is On, project-level resource assignments are exported, but not the WBS or task-level assignments.
The following implicit filter is used:
  • The project is enabled for management.
The following explicit filters are used:
  • projectID
  • approved (Management)
  • approvedForBilling (Financial)
  • start date
  • end date
  • lastUpdatedDate: This filter is the most recent date of lastUpdatedDate in the SRM_PROJECTS table or PRModTime in the PRJ_PROJECTS table.
  • active project
  • management functionality is enabled
 
Schema Mappings - Outbound
 
Schema mappings are described for the following outbound Project tag names:
  • SRM_PROJECTS
  • SRM_RESOURCES (Manage Resource ID)
  • PRJ_PROJECTS
  • PAC_MNT_PROJECTS
  • Project Location
  • CLNTSUPP
  • PRTEAM
  • SRM_RESOURCES (Team Resource ID)
  • SRM_RESOURCES (Project Role ID)
  • SRM_RESOURCES (Assignment Resource ID)
  • PRTask
  • PRAssignment
  • OBS Association
  • OBSAssoc
 
Schema Mappings - Inbound
 
Schema mappings are described for the following inbound Project tag names:
  • PRJ_PROJECTS
  • PAC_MNT_PROJECTS
  • Resource
  • Task
  • TaskLabor
 Tag attributes are optional unless 
Required
 appears on this page.
SRM_PROJECTS Schema Tag
This tag is part of the outbound schema mapping for the Project XOG object.
  •  
    projectID
    Required.
    Table and Column: 
    SRM_PROJECTS.UNIQUE_NAME
    Type: 
    String
  •  
    name
    Required.
    Table and Column: 
    SRM_PROJECTS.NAME
    Type: 
    String
  •  
    description
    Table and Column: 
    SRM_PROJECTS.DESCRIPTION
    Type: 
    String
  •  
    createdBy
    Table and Column: 
    SRM_PROJECTS.CREATED_BY
    Type: 
    String
  •  
    createdDate
    Table and Column: 
    SRM_PROJECTS.CREATED_DATE
    Type: 
    dateTime
  •  
    lastUpdatedDate
    Uses PRJ_PROJECTS.prModTime
     
    Table and Column: 
    SRM_PROJECTS.LAST_UPDATED_DATE
    Type: 
    dateTime
  •  
    lastUpdatedBy
    Uses PRJ_PROJECTS.prModBy if PRJ_PROJECTS.prModTime is later than LAST_UPDATED_BY.
     
    Table and Column: 
    SRM_PROJECTS.LAST_UPDATED_BY
    Type: 
    String
  •  
    Active
    Table and Column: 
    SRM_PROJECTS.IS_ACTIVE
    Type: 
    Boolean
  •  
    program
    Indicates if the project is a program
    Table and Column: 
    SRM_PROJECTS.IS_PROGRAM
    Type: 
    Boolean
Project (PRJ_PROJECTS) Schema Tag
The PRJ_PROJECTS tag is part of the outbound schema mapping for the project XOG object and has the following attributes:
  •  
    start
    Table and Column: 
    PRJ_PROJECTS.prStart
    Type: 
    dateTime
  •  
    finish
    Table and Column: 
    PRJ_PROJECTS.prFinish
    Type: 
    dateTime
  •  
    approved
    True only if prApproveTime is not null.
     
    Table and Column: 
    PRJ_PROJECTS.prApproveTime
    Type:
     Boolean
  •  
    OpenForTimeEntry
    Table and Column: 
    PRJ_PROJECTS.prIsOpen
    Type:
     Boolean
  •  
    Closed
    True only if prClosedTime is not null.
     
    Table and Column: 
    PRJ_PROJECTS.prClosedTime
    Type:
     Boolean
Project (PAC_MNT_PROJECTS) Schema Tag
The PAC_MNT_PROJECTS tag is part of the outbound schema mapping for the project XOG object and has the following attributes:
  •  
    financialLocation
    Table and Column: 
    PAC_MNT_PROJECTS.LOCATIONID
    Type:
     String
  •  
    financialDepartment
    Table and Column: 
    PAC_MNT_PROJECTS.DEPARTCODE
    Type:
     String
  •  
    clientID
    Table and Column: 
    PAC_MNT_PROJECTS.COMPANY_CODE
    Type:
     String
  •  
    affiliatedProjectID
    Table and Column: 
    PAC_MNT_PROJECTS.AFFILIATEPROJECT
    Type:
     String
  •  
    financialStatus
    Table and Column: 
    PAC_MNT_PROJECTS.STATUS
    Type:
     String
  •  
    approvedForBilling
    Table and Column: 
    PAC_MNT_PROJECTS.APPROVED
    Type:
     Boolean
  •  
    billingType
    Defines the billing type.
    Values
    : S, I, and C
    Table and Column: 
    PAC_MNT_PROJECTS.TYPE_
    Type:
     String
  •  
    billingCurrencyCode
    Table and Column: 
    PAC_MNT_PROJECTS.BILLLING_CURRENCY_CODE
    Type:
     String
  •  
    costType
    Refers to Cost type for the investment. Possible values are OPERATING/CAPITAL. Default value is OPERATING.
    Table and Column
    : PAC_MNT_PROJECTS.cost_type
    Type:
     String
Project Location Schema Tag
The Project Location tag is part of the outbound schema mapping for the project XOG object. This tag uses the LOCATIONS table, where LOCATIONS.LOCATIONID = PAC_MNT_PROJECTS.LOCATIONID. This schema tag has the following attribute.
  •  
    Entity
    Optional
    Table and Column: 
    LOCATIONS.ENTITY
    Type:
     String
Project (CLNTSUPP) Schema Tag
This tag is part of the outbound schema mapping for the Project XOG object and uses the CLNTSUPP table, where CLNTSUPP.COMPANY_CODE = PAC_MNT_PROJECTS.COMPANY_CODE. This tag has the following attribute.
  •  
    clientName
    Optional
    Table and Column: 
    CLNTSUPP.COMPANY_NAME
    Type:
     String
Resource (PRTEAM) Schema Tag
This tag is part of the outbound schema mapping for the Project XOG object and has the following attributes:
This tag uses the PRTeam table with zero to many records and where PRTeam.prProjectID = PRJ_PROJECTS.prID.
  •  
    availFrom
    Optional
    Table and Column: 
    PRTeam.prAvailStart
    Type:
     dateTime
  •  
    availTo
    Optional
    Table and Column: 
    PRTeam.prAvailFinish
    Type:
     dateTime
  •  
    openForTimeEntry
    Optional
    Table and Column: 
    PRTeam.prIsOpen
    Type:
     Boolean
  •  
    lastUpdatedBy
    Optional
    Table and Column: 
    PRTeam.prModBy
    Type:
     String
  •  
    lastUpdatedDate
    Optional
    Table and Column: 
    PRTeam.prModTime
    Type:
     dateTime
  •  
    capitalPercentage
    Capitalization percent of planned cost at team level. The valid value of this attribute can be any float value from 0 (0 percent) to 1 (100 percent). The default value is 0.
    Table and Column
    : PRTEAM.CAPITAL_PERCENTAGE
    Type
    : Float
  •  
    forecastRate
    The allocation hourly forecast rate. You can export the field only if it contains a value..
    Table and Column
    : PRTEAM.FORECAST_RATE
    Type
    : Double
  •  
    requestedManagerID
    The resource manager requested for fulfilling a role request. You can export the field only if it contains a value..
    Table and Column
    : PRTEAM.REQUESTED_MANAGER_ID
    Type
    : String
  •  
    teamDefinitionId
    The teamDefinitionId attribute contains the code of the team definition associated with the labor resource in the system. During export, if the resource is a team definition, the attribute is added to the <Resource> element into the resulting XML document.
    For a successful import, verify that all the following conditions are true:
    • If a <Resource> element has the teamDefinitionId attribute, then that team definition exists in the target system.
    • The associated resource ID for the team definition in the target system matches the resource ID on the <Resource> element in the import file.
      If necessary, use the REST API to create the team definition on the target system prior to importing.
    • Resources that are also team definitions cannot change the first name, last name, display name, resourceID, isActive flag, or availability of the resources in the target system. Any updates to these fields are ignored.
    Table and Column
    : TEAM_DEFINITIONS.CODE
    Type:
     String
SRM_RESOURCES Schema Tag
The SRM_RESOURCES tag is part of the outbound schema mapping for the project XOG object. This tag uses the following table joins:
  • SRM_RESOURCES.USER_ID = CMN_SEC_USERS.ID 
  • CMN_SEC_USERS.USER_NAME = PRJ_PROJECTS.MANAGER_ID
  • SRM_RESOURCES.ID = PRTeam.prResourceID, or  PRTeam.prRoleID, or PRAssignment.prResourceID
This schema tag has the following attributes:
  •  
    manageResourceID
    Optional
    Table and Column: 
    SRM_RESOURCES.UNIQUE_NAME
    Type:
     String
  •  
    resourceID
    Required.
    Table and Column: 
    SRM_RESOURCES.UNIQUE_NAME
    Type:
     String
  •  
    projectRoleID
    Table and Column: 
    SRM_RESOURCES.UNIQUE_NAME
    Type:
     String
Task (PRTask) Schema Tag
This tag is part of the outbound schema mapping for the Project XOG object and uses the PRTask table, with 0 to many records, and where PRTask.prProjectID = PRJ_PROJECTS.prID. This schema tag has the following attributes:
  •  
    taskID
    Defines the unique identifier for the task. If no value is provided, a new task record is created during import. If a value is provided and there is an existing task with a matching ID the task data is updated. 
    Table and Column: 
    PRTask.prExternalID
    Type:
     String
  •  
    name
    Defines the name for the task.
    Table and Column: 
    PRTask.prName
    Type:
     String
  •  
    orderID
    Defines the unique order identifier for the task.
    Table and Column: 
    PRTask.prWBSSequence
    Type:
     Integer
  •  
    outlineLevel
    Defines the outline level for the task.
    Table and Column: 
    PRTask.prWBSLevel
    Type:
     Integer
  •  
    start
    Defines the start date and time for the task.
    Table and Column: 
    PRTask.prStart
    Type:
     dateTime
  •  
    baseStart
    Defines the base start date and time for the task.
    Table and Column: 
    PRTask.prBaseStart
    Type:
     dateTime
  •  
    finish
    Defines the finish date and time for the task.
    Table and Column: 
    PRTask.prFinish
    Type:
     dateTime
  •  
    baseFinish
    Defines the base finish date and time for the task.
    Table and Column: 
    PRTask.prBaseFinish
    Type:
     dateTime
  •  
    milestone
    Table and Column: 
    PRTask.prIsMilestone
    Type:
     Boolean
  •  
    summary
    True only if prIsTask is false.
    Table and Column: 
    Not applicable
    Type: 
    Boolean
  •  
    key
    Table and Column: 
    PRTask.prIsKey
    Type: 
    Boolean
  •  
    category
    Table and Column: 
    PRTask.prCategory
    Type: 
    String
  •  
    status
    Defines the status of the task.
    Values:
    • 0. Not Started
    • 1. Started
    • 2. Complete
    Table and Column: 
    PRTask.prStatus
    Type: 
    Integer
  •  
    percComp
    Valid values are between 0 and1 inclusive, where 00 percent is shown as 1.0.
    Table and Column: 
    PRTask.prPctComplete
    Type: 
    Float
  •  
    lastUpdatedBy
    Table and Column: 
    PRTask.prModBy
    Type: 
    String
  •  
    lastUpdatedDate
    Table and Column: 
    PRTask.prModTime
    Type: 
    dateTime
  •  
    costType
    Refers to Cost type for the task. Possible values are OPERATING/CAPITAL.
    Table and Column
    : PRTASK.cost_type
    Type
    : String
  •  
    fixed
    Optional
    Determines if the task duration is fixed. Possible values are true/false.
    Table and Column: 
    PRTASK.prIsFixed
    Type: 
    Boolean
     
  •  
    mspTaskType
    Optional. Microsoft Project task type.
    Values:
    • 0. Fixed Units
    • 1. Fixed Duration
    • 2. Fixed Work
    Table and Column: 
    PRTASK.msp_task_type
    Type
    : Number
TaskLabor (PRAssignment) Schema Tag
This tag is part of the outbound schema mapping for the Project XOG object and has the following attributes:
This tag uses the PRAssignment table, which can have 0 to many records, and where PRAssignment.prTaskID = PRTask.prID.
  •  
    start
    Optional.
    Table and Column: 
    PRAssignment.prStart
    Type: 
    dateTime
  •  
    finish
    Optional.
    Table and Column: 
    PRAssignment.prFinish
    Type: 
    dateTime
  •  
    actualWork
    Optional.
    Table and Column: 
    PRAssignment.prActSum
    Type: 
    Float
  •  
    remainingWork
    Optional.
    Table and Column: 
    PRAssignment.prEstSum
    Type: 
    Float
  •  
    baselineWork
    Optional.
    Table and Column: 
    PRAssignment.prBaseSum
    Type: 
    Float
  •  
    actualThrough
    Optional.
    Table and Column: 
    PRAssignment.prActThru
    Type: 
    dateTime
  •  
    lastUpdatedBy
    Optional.
    Table and Column: 
    PRAssignment.prModBy
    Type: 
    String
  •  
    lastUpdatedDate
    Optional.
    Table and Column: 
    PRAssignment.prModTime
    Type: 
    dateTime
  •  
    teamDefinitionId
    Optional. The teamDefinitionId attribute contains the code of the team definition associated with the labor resource in the system. During export, if the resource is a team definition, the attribute is added to the <TaskLabor> element into the resulting XML document.
    For a successful import, verify that all the following conditions are true:
    • If a <Resource> element has the teamDefinitionId attribute, then that team definition exists in the target system.
    • The associated resource ID for the team definition in the target system matches the resource ID on the <Resource> element in the import file.
      If necessary, use the REST API to create the team definition on the target system prior to importing.
    • Resources that also team definitions cannot change the first name, last name, display name, resourceID, isActive flag, or availability of the resources in the target system. Any updates to these fields are ignored.
    Table and Column
    : TEAM_DEFINITIONS.CODE
    Type
    : String
OBS Associations Schema Tag (Project XOG)
The OBS Associations tag is part of the outbound schema mapping for the Project XOG object. This tag is 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
    (Optional) 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
The OBS association tag is part of the outbound schema mapping for the project XOG object. The following tables are used in this tag:
  • PRJ_OBS_ASSOCIATIONS (OBS associations)
  • PRJ_OBS_TYPES (OBS)
  • PRJ_OBS_UNITS (OBS Units)
  • PRJ_OBS_UNITS_FLAT (OBS Units Flat Hierarchy)
This tag has the following attributes:
  •  
    id
    Required.
    Table and Column: 
    PRJ_OBS_TYPES.UNIQUE_NAME
    Type: 
    String
  •  
    name
    Optional.
    Table and Column: 
    PRJ_OBS_TYPES.PRJ_OBS_TYPES.NAME
    Type: 
    String
  •  
    unitPath
    Required. A slash-delimited list of unit names that points to the OBS unit for the object.
    Table and Column: 
    PRJ_OBS_TYPES.PRJ_OBS_UNITS.NAME
    Type: 
    String
    Example:
     CAN/BC/VAN
Project (PRJ_PROJECTS) Schema Tag
The PRJ_PROJECTS tag is part of the inbound schema mapping for the project XOG object and has the following attributes:
  •  
    Name
    Required.
    Table and Column: 
    PRJ_PROJECTS.NAME
    Type:
     String
  •  
    projectID
    Required. Uniquely identifies this project and is used as key for sub-project references.
    Table and Column: 
    PRJ_PROJECTS.UNIQUE_NAME
    Type:
     String
  •  
    description
    Optional.
    Table and Column: 
    PRJ_PROJECTS.DESCRIPTION
    Type:
     String
  •  
    AddedBy
    Optional. When AddedBy (CreatedBy in 
    Clarity PPM
    ), the default Collaboration Manager is assigned to the project.
    Table and Column: 
    PRJ_PROJECTS.CREATED_BY
    Type:
     String
  •  
    AddedDate
    Optional.
    Table and Column: 
    PRJ_PROJECTS.CREATED_DATE
    Type:
     dateTime
  •  
    lastUpdatedDate
    Optional. Uses PRJ_PROJECTS.prModTime if later.
    Table and Column: 
    PRJ_PROJECTS.LAST_UPDATED_DATE
    Type:
     dateTime
  •  
    lastUpdatedBy
    Optional. Uses PRJ_PROJECTS.prModBy if PRJ_PROJECTS.prModTime is later than LAST_UPDATED_BY.
    Table and Column: 
    PRJ_PROJECTS.LAST_UPDATED_BY
    Type:
     String
  •  
    Active
    Optional.
    Table and Column: 
    PRJ_PROJECTS.IS_ACTIVE
    Type:
     Boolean
  •  
    Type
    Required.
    Table and Column: 
    PRJ_PROJECTS.TYPE
    Type:
     String
  •  
    stageIdentifier
    Required.
    Table and Column: 
    PRJ_PROJECTS.STAGE_IDENTIFIER
    Type:
     String
  •  
    start
    Required.
    Table and Column: 
    PRJ_PROJECTS.prStart
    Type:
     dateTime
  •  
    finish
    Required.
    Table and Column: 
    PRJ_PROJECTS.prFinish
    Type:
     dateTime
  •  
    approved
    Optional. True only if prApprovedTime is not null. On import, prApprovedTime is set to the current time if it was previously null.
    Table and Column: 
    None
    Type:
     Boolean
  •  
    openForTimeEntry
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prIsOpen
    Type:
     Boolean
  •  
    closed
    Optional. True only if prClosedTime is not null. On import, prClosedTime is set to the current time if it was previously null.
    Table and Column: 
    None
    Type:
     Boolean
  •  
    guidelines
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prGuidelines
    Type:
     String
  •  
    department
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prDepartment
    Type:
     String
  •  
    asOf
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prAsOf
    Type:
     dateTime
  •  
    cpmType
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prCPMType
    Type:
     Integer
  •  
    trackMode
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prTrackMode
    Type:
     Integer
  •  
    sponsoredBy
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prSponsoredBy
    Type:
     String
  •  
    requestedBy
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prRequestedBy
    Type:
     String
  •  
    requestedTime
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prRequestedTime
    Type:
     dateTime
  •  
    userText1
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText1
    Type:
     String
  •  
    userText2
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText2
    Type:
     String
  •  
    userText3
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText3
    Type:
     String
  •  
    userText4
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText4
    Type:
     String
  •  
    userText5
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText5
    Type:
     String
  •  
    userText6
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText6
    Type:
     String
  •  
    userText7
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prUserText7
    Type:
     String
  •  
    Format
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prFormat
    Type:
     Integer
  •  
    Priority
    Optional. Defines the priority.
    Values:
     0-36, where:
    • 0. Highest priority
    • 36. Lowest priority
    Table and Column: 
    PRJ_PROJECTS.prPriority
    Type:
     Integer
  •  
    username
    Optional. On import, the ProjectManagerMgmt access right is granted to this user.
    Table and Column: 
    PRJ_PROJECTS.prUsername
    Type:
     String
  •  
    startImposed
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prStartImposed
    Type:
     Boolean
  •  
    finishImposed
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prFinishImposed
    Type:
     Boolean
  •  
    baseTime
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prBaseTime
    Type: 
    dateTime
  •  
    baseStart
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prBaseStart
    Type: 
    dateTime
  •  
    baseFinish
    Optional.
    Table and Column: 
    PRJ_PROJECTS.prBaseFinish
    Type: 
    dateTime
  •  
    Chargecode
    Optional. Validate the existence with PRChargeCode.prID
    Table and Column: 
    PRJ_PROJECTS.PrChargeCodeID
    Type: 
    String
  •  
    ManagerResource
    Optional. Must be a valid resource.
    Table and Column: 
    PRJ_PROJECTS.PrUserName
    Type: 
    String
PAC_MNT_PROJECTS Schema Tag
The PAC_MNT_PROJECTS tag is part of the inbound schema mapping for the project XOG object and has the following attributes:
  •  
    financialLocation
    Defines the financial location for the project.
    Table and Column: 
    PAC_MNT_PROJECTS.LOCATIONID
    Type: 
    String
  •  
    financialDepartment
    Optional. Defines the financial location for the project.
    Table and Column: 
    PAC_MNT_PROJECTS.DEPARTCODE
    Type: 
    String
  •  
    clientID
    Defines the unique client identifier for the project. If other financial properties fields are present, then clientId is required. Otherwise, clientID and all financial properties are optional.
    Table and Column: 
    PAC_MNT_PROJECTS.COMPANY_CODE
    Type: 
    String
  •  
    affiliatedProjectID
    Optional. Defines the affiliated project unique identifier for the project.
    Table and Column: 
    PAC_MNT_PROJECTS.AFFILIATEPROJECT
    Type: 
    String
  •  
    financialStatus
    Optional. Defines the financial status for the project.
    Table and Column: 
    PAC_MNT_PROJECTS.STATUS
    Type: 
    String
  •  
    approvedForBilling
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.APPROVED
    Type: 
    Boolean
  •  
    billingType
    Optional. Defines the billing type for the project.
    Values:
     S, I.
    Table and Column: 
    PAC_MNT_PROJECTS.TYPE_
    Type: 
    String
  •  
    billingCurrencyCode
    Required only when 
    Clarity PPM
     is set for multi-currency. Defines the billing currency code for the project.
    Table and Column: 
    PAC_MNT_PROJECTS.BILLLING_CURRENCY_CODE
    Type: 
    String
  •  
    ProjectClass
    Optional. Defines the project class for the project. This column defaults to clientID if Projectclass is not supplied.
    Table and Column: 
    PAC_MNT_PROJECTS.CLASS
    Type: 
    String
  •  
    WIP Class
    Optional. Defines the WIP class for the project. This column defaults to clientID if WIP Class is not supplied.
    Table and Column: 
    PAC_MNT_PROJECTS.WIPCLASS
    Type: 
    String
  •  
    UseBudget
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.BUDGET
    Type: 
    Number
  •  
    Billing Project
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.BILLING_PROJECT_ID
    Type: 
    Number
  •  
    Send Bill To
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.BILL_TO_COMPANY_CODE
    Type: 
    String
  •  
    billExpenses
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.EX_BILL_EXPENSES
    Type: 
    Number
  •  
    Document number
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.CONTRACTNBR
    Type: 
    String
  •  
    Contract amount
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.Contract Amount
    Type: 
    Number
  •  
    Enforce Contract amount
    Optional.
    Values:
    • 0. Do not enforce
    • 1. Enforce
    Default: 
    0
    Table and Column: 
    PAC_MNT_PROJECTS.ENFORCE_CONTRACT_AMOUNT
    Type: 
    Number
  •  
    Date
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.Contract Date
    Type:
     Date
  •  
    Labor Rate Source
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSRATESOURCELABOR
    Type: 
    Number
  •  
    Labor Cost Source
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSCOSTSOURCELABOR
    Type: 
    Number
  •  
    Labor Exchange Rate
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.LABOR_EXCHANGE_RATE_TYPE
    Type: 
    Number
  •  
    Materials Rate Source
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSRATESOURCEMATERIALS
    Type: 
    Number
  •  
    Materials Cost Source
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSCOSTSOURCEMATERIALS
    Type: 
    Number
  •  
    Materials Exchange Rate
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.MATERIALS_EXCHANGE_RATE_TYPE
    Type: 
    Number
  •  
    EXPENSES Rate Source
    Optional.
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSRATESOURCELABOR
    Type: 
    Number
  •  
    EXPENSES Cost Source
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSCOSTSOURCE EXPENSES
    Type: 
    Number
  •  
    EXPENSES Exchange Rate
    Table and Column: 
    PAC_MNT_PROJECTS.EXPENSE_EXCHANGE_RATE_TYPE
    Type: 
    Number
  •  
    EQUIPMENT Rate Source
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSRATESOURCE EQUIPMENT
    Type: 
    Number
  •  
    EQUIPMENT Cost Source
    Table and Column: 
    PAC_MNT_PROJECTS.TRANSCOSTSOURCE EQUIPMENT
    Type: 
    Number
  •  
    EQUIPMENT Exchange Rate
    Table and Column: 
    PAC_MNT_PROJECTS.EQUIPMENT_EXCHANGE_RATE_TYPE
    Type: 
    Number
  •  
    Submitted for Approval
    Set to 1 if the project financial properties will  be marked submitted for approval.
    Table and Column: 
    PAC_MNT_PROJECTS.AWAITINGAPPROVAL
    Type: 
    Number
  •  
    Submitted and Approved
    Set to 1 if the project financial properties will  be marked submitted and approved
    Table and Column: 
    PAC_MNT_PROJECTS.APPROVED
    Type: 
    Number
  •  
    batchCycle
    Defines the batch cycle that is associated with the project.
    Table and Column: 
    Type: 
    String
Resource (PRTeam) Schema Tag
This tag is part of the inbound schema mapping for the Project XOG object. PRTeam is populated when you staff a resource to a project. This tag uses the PRTeam table, which can have 0 to many records and where PRTeam.prProjectID = PRJ_PROJECTS.prID. This schema tag has the following attributes:
  •  
    availFrom
    Uses the PRJ_PROJECTS.prStart if prAvailStart is not set.
    Table and Column: 
    PRTeam.prAvailStart
    Type: 
    dateTime
  •  
    availTo
    Uses PRJ_PROJECTS.prFinish if prAvailFinish is not set.
    Table and Column: 
    PRTeam.prAvailFinish
    Type: 
    dateTime
  •  
    openForTimeEntry
    Table and Column: 
    PRTeam.prIsOpen
    Type: 
    Boolean
  •  
    lastUpdatedBy
    Table and Column: 
    PRTeam.prModBy
    Type: 
    String
  •  
    lastUpdatedDate
    Table and Column: 
    PRTeam.prModTime
    Type: 
    dateTime
  •  
    bookingStatus
    Table and Column: 
    PRTeam.prBooking
    Type: 
    Integer
  •  
    requestStatus
    Table and Column: 
    PRTeam.prStatus
    Type: 
    Integer
  •  
    defaultAllocation
    The default allocation for this team member.
    Table and Column: 
    PRTeam.prAllocCurve
    Type: 
    Float
  •  
    resourceID
    May be more than one resource in the prTeam.
    Table and Column: 
    PRTeam.prResourceID
    Type: 
    String
  •  
    ProjectRoleID
    May be more than one role in prTeam.
    Table and Column: 
    PRTeam.PrRoleId
    Type: 
    String
  •  
    teamDefinitionId
    The teamDefinitionId attribute contains the code of the team definition associated with the labor resource in the system. During export, if the resource is a team definition, the attribute is added to the <Resource> element into the resulting XML document. For a successful import, verify that all the following conditions are true:
    • If a <Resource> element has the teamDefinitionId attribute, then that team definition exists in the target system.
    • The associated resource ID for the team definition in the target system matches the resource ID on the <Resource> element in the import file.
      If necessary, use the REST API to create the team definition on the target system prior to importing.
    • Resources that also team definitions cannot change the first name, last name, display name, resourceID, isActive flag, or availability of the resources in the target system. Any updates to these fields are ignored.
    Table and Column
    : TEAM_DEFINITIONS.CODE
    Type
    : String
PRTask Schema Tag
This tag is part of the inbound schema mapping for the Project XOG object. PRTeam is populated when you staff a resource to a project. This tag uses the PRTask table, which can have 0 to many records and where PRTask.prProjectID = PRJ_PROJECTS.prID. This schema tag has the following attributes:
  •  
    taskID
    Defines the unique identifier for the task. Required, if referenced by Relation tag or as a sub-project.
    Table and Column: 
    PRTask.prExternalID
    Type: 
    String
  •  
    name
    Defines the name for the task.
    Table and Column: 
    PRTask.prName
    Type: 
    String
  •  
    orderID
    Table and Column: 
    PRTask.prWBSSequence
    Type:
     Integer
  •  
    outlineLevel
    Table and Column: 
    PRTask.prWBSLevel
    Type: 
    Integer
  •  
    start
    Table and Column: 
    PRTask.prStart
    Type: 
    dateTime
     An imported task with no start and finish dates in the inbound XML file inherits the project Start Date and Finish Date values.
  •  
    baseStart
    Table and Column: 
    PRTask.prBaseStart
    Type: 
    dateTime
  •  
    finish
    Table and Column: 
    PRTask.prFinish
    Type: 
    dateTime
  •  
    baseFinish
    Table and Column: 
    PRTask.prBaseFinish
    Type: 
    dateTime
  •  
    milestone
    Table and Column: 
    PRTask.prIsMilestone
    Type: 
    Boolean
  •  
    summary
    Set to True only if prIsTask is False.
    Table and Column: 
    Not Applicable
    Type: 
    Boolean
  •  
    key
    Table and Column: 
    PRTask.prIsKey
    Type: 
    Boolean
  •  
    category
    Table and Column: 
    PRTask.prCategory
    Type: 
    String
  •  
    status
    Defines the status of the task.
    Values:
    • 0. Not Started
    • 1. Started
    • 2. Complete
    Table and Column: 
    PRTask.prStatus
    Type: 
    Integer
  •  
    percComp
    Valid values are between 0 and 1 inclusive, where 100 percent is shown as 1.0.
    Table and Column: 
    PRTask.prPctComplete
    Type: 
    Float
  •  
    lastUpdatedBy
    Table and Column: 
    PRTask.prModBy
    Type: 
    String
  •  
    lastUpdatedDate
    Table and Column: 
    PRTask.prModTime
    Type:
     dateTime
  •  
    earlyStart
    Table and Column: 
    PRTask.prEarlyStart
    Type:
     dateTime
  •  
    lateStart
    Table and Column: 
    PRTask.prLateStart
    Type:
     dateTime
  •  
    earlyFinish
    Table and Column: 
    PRTask.prEarlyFinish
    Type:
     dateTime
  •  
    lateFinish
    Table and Column: 
    PRTask.prLateFinish
    Type:
     dateTime
  •  
    Duration
    Table and Column: 
    PRTask.prDuration
    Type:
     Float
  •  
    baselineDuration
    Table and Column: 
    PRTask.prBaseDuration
    Type:
     Float
  •  
    totalSlack
    Table and Column: 
    PRTask.prTotalFloat
    Type:
     Float
  •  
    Unplanned
    If the task is being updated, set to False".
    Table and Column: 
    PRTask.prIsUnplanned
    Type:
     Boolean
  •  
    shortName
    Table and Column: 
    PRTask.prShortname
    Type:
     String
  •  
    Guidelines
    Table and Column: 
    PRTask.prGuidelines
    Type:
     String
  •  
    Fixed
    Table and Column: 
    PRTask.prIsFixed
    Type:
     Boolean
  •  
    Locked
    Table and Column: 
    PRTask.prIsLocked
    Type:
     Boolean
  •  
    baseFixed
    Table and Column: 
    PRTask.prBaseIsFixed
    Type:
     Boolean
  •  
    baseTime
    Table and Column: 
    PRTask.prBaseTime
    Type:
     dateTime
TaskLabor (PRAssignment) Schema Tag
This tag is part of the inbound schema mapping for the Project XOG object and the PRAssignment table is populated when a resource is assigned to a task. This feature is not supported in 
Clarity PPM
 but can be accomplished with Open Workbench or the 
Clarity PPM
 Microsoft Project interface. This tag uses the PRAssignment table, which can have 0 to many records, and where PRAssignment.prTaskID = PRTask.prID. This tag has the following attributes:
  •  
    Start
    Table and Column: 
    PrAssignment.prStart
    Type:
     dateTime
  •  
    finish
    Table and Column: 
    PrAssignment.prFinish
    Type:
     dateTime
  •  
    actualWork
    Table and Column: 
    PrAssignment.prActSum
    Type:
     Float
  •  
    remainingWork
    Table and Column: 
    PrAssignment.prEstSum
    Type:
     Float
  •  
    baselineWork
    Table and Column: 
    PrAssignment.prBaseSum
    Type:
     Float
  •  
    actualThrough
    Table and Column: 
    PrAssignment.prActThru
    Type:
     dateTime
  •  
    lastUpdatedBy
    Table and Column: 
    PrAssignment.prModBy
    Type:
     string
  •  
    lastUpdatedDate
    Table and Column: 
    PrAssignment.prModTime
    Type:
     dateTime
  •  
    Unplanned
    During update Unplanned is False.
    Table and Column: 
    PrAssignment.prIsUnplanned
    Type:
     Boolean
  •  
    estPattern
    Table and Column: 
    PrAssignment.prEstPattern
    Type:
     Integer
  •  
    basePattern
    Table and Column: 
    PrAssignment.prBasePattern
    Type:
     Integer
  •  
    estMax
    Table and Column: 
    PrAssignment.prEstMax
    Type:
     Float
  •  
    baseMax
    Table and Column: 
    PrAssignment.prBaseMax
    Type:
     Float
  •  
    pendEstSum
    Table and Column: 
    PrAssignment.prPendEstSum
    Type:
     Float
  •  
    pendActSum
    Table and Column: 
    PrAssignment.prPendActSum
    Type:
     Float
  •  
    pendStart
    Table and Column: 
    PrAssignment.prPendStart
    Type:
     dateTime
  •  
    pendFinish
    Table and Column: 
    PrAssignment.prPendFinish
    Type:
     dateTime
  •  
    Status
    Table and Column: 
    PrAssignment.prStatus
    Type:
     Integer
  •  
    curveType
    Required.
    Table and Column: 
    PrAssignment.prExtension
    Type:
     Integer
  •  
    Start
    Required.
    Table and Column: 
    PrAssignment.prExtension
    Type:
     dateTime
  •  
    Finish
    Required.
    Table and Column: 
    PrAssignment.prExtension
    Type:
     dateTime
  •  
    Sum
    Required.
    Table and Column: 
    PrAssignment.prExtension
    Type:
     Float
  •  
    resourceID
    Required.
    Table and Column: 
    PrAssignment.prResourceID
    Type:
     String
  •  
    teamDefinitionId  
    The teamDefinitionId attribute contains the code of the team definition associated with the labor resource in the system. During export, if the resource is a team definition, the attribute is added to the <TaskLabor> element into the resulting XML document.
    For a successful import, verify that all the following conditions are true:
    • If a <Resource> element has the teamDefinitionId attribute, then that team definition exists in the target system.
    • The associated resource ID for the team definition in the target system matches the resource ID on the <Resource> element in the import file.
      If necessary, use the REST API to create the team definition on the target system prior to importing.
    • Resources that also team definitions cannot change the first name, last name, display name, resourceID, isActive flag, or availability of the resources in the target system. Any updates to these fields are ignored.
    Type
    : String
Example 1: Export (XOG-out) a Project with a Resource Team
The following example shows an exported project with assignment and staff records from a defined resource of type 
team
. In this example, the Resource and TaskLabor elements contain their own 
teamDefinitionId
 attribute.
<?xml version="1.0" encoding="UTF-8"?> <NikuDataBus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../xsd/nikuxog_project.xsd"> <Header action="write" externalSource="NIKU" objectType="project" version="15.5.0.1"/> <Projects> <Project active="true" allowAssignedTasksOnly="0" approved="false" approvedForBilling="1" assgnPool="0" billingCurrencyCode="USD" billingType="S" budgetCostFinish="2018-07-09T17:00:00" budgetCostStart="2018-07-09T00:00:00" calculateFinancialMetrics="true" closed="false" costType="OPERATING" currencyISOcode="USD" equipmentExchageRateType="AVERAGE" evCalcMethod="0" expenseExchageRateType="AVERAGE" financialStatus="H" finish="2018-07-09T17:00:00" format="0" investmentDefinedReinvestmentRate="0" investmentDefinedTotalCostOfCapital="0" laborExchageRateType="AVERAGE" lastUpdatedBy="admin" lastUpdatedDate="2018-07-09T10:11:38" managerResourceID="admin" materialExchageRateType="AVERAGE" name="My FooBar 2" openForTimeEntry="true" pageLayoutCode="projmgr.projectPageFrame" percentCalcMode="0" percentComplete="0" plannedCostFinish="2018-07-09T17:00:00" plannedCostStart="2018-07-09T00:00:00" priority="10" progress="0" projectID="foobar" requiredForScenarios="false" setBudgetValuesEqualToPlannedValues="true" start="2018-07-09T08:00:00" status="0" syncInvestmentAndBudgetDates="true" template="false" trackMode="2" useSystemDefinedReinvestmentRate="true" useSystemDefinedTotalCostOfCapital="true"> <Resources> <Resource availFrom="2018-07-09T08:00:00" availTo="2018-07-09T17:00:00" bookingStatus="5" capitalPercentage="0" defaultAllocation="1" isProjectManager="false" lastUpdatedBy="admin" lastUpdatedDate="2018-07-09T10:11:13" openForTimeEntry="true" resourceID="TM00005" teamDefinitionId="TM00005"> <CustomInformation> <ColumnValue name="partition_code">NIKU.ROOT</ColumnValue> </CustomInformation> <SkillAssocs/> </Resource> </Resources> <Tasks> <Task evCalcMethod="0" finish="2018-07-09T17:00:00" fixed="false" internalTaskID="5020060" key="false" lastUpdatedBy="admin" lastUpdatedDate="2018-07-09T10:11:13" lockedForScheduling="false" milestone="false" name="My FooBar" openForTimeEntry="true" orderID="1" outlineLevel="1" percComp="0" start="2018-07-09T08:00:00" status="0" summary="false" taskID="~rmw" topDownPercent="0"> <Assignments> <TaskLabor actualWork="0" estMax="1" estPattern="3" finish="2018-07-09T17:00:00" lastUpdatedBy="admin" lastUpdatedDate="2018-07-09T10:11:13" remainingWork="16" resourceID="TM00005" start="2018-07-09T08:00:00" teamDefinitionId="TM00005" unpostedActuals="0"> <CustomInformation> <ColumnValue name="partition_code">NIKU.ROOT</ColumnValue> </CustomInformation> </TaskLabor> </Assignments> <estimateRules/> <CustomInformation> <ColumnValue name="partition_code">NIKU.ROOT</ColumnValue> </CustomInformation> </Task> <Task evCalcMethod="0" finish="2018-07-09T17:00:00" fixed="false" internalTaskID="5020061" key="true" lastUpdatedBy="admin" lastUpdatedDate="2018-07-09T10:11:30" lockedForScheduling="false" milestone="false" name="Test Task 1" nextSiblingOf="~rmw" openForTimeEntry="true" orderID="2" outlineLevel="1" percComp="0" start="2018-07-09T08:00:00" status="0" summary="false" taskID="tt1"> <Assignments> <TaskLabor actualWork="0" estMax="1" estPattern="3" finish="2018-07-09T17:00:00" lastUpdatedBy="admin" lastUpdatedDate="2018-07-09T10:11:38" remainingWork="16" resourceID="TM00005" start="2018-07-09T08:00:00" teamDefinitionId="TM00005" unpostedActuals="0"> <CustomInformation> <ColumnValue name="partition_code">NIKU.ROOT</ColumnValue> </CustomInformation> </TaskLabor> </Assignments> <estimateRules/> <CustomInformation> <ColumnValue name="partition_code">NIKU.ROOT</ColumnValue> </CustomInformation> </Task> </Tasks> <Allocations/> <scenarioDependencies/> <InvestmentAssociations> <Allocations/> <Hierarchies/> </InvestmentAssociations> <General addedBy="admin" addedDate="2018-07-09"/> <OBSAssocs complete="false"/> </Project> </Projects> </NikuDataBus>
In addition, capacity scenarios can be exported/imported and these also may have TaskLabor elements that reference team definitions. They require the teamDefinitionId attribute during export and are subject to team definition validation on import.
Example 2: Import (XOG-in) a Custom Subobject for a Project
CA PPM 15.5.1 introduced a new XOG attribute called 
apiEnabled
. When 
true
, this flag API-enables a new custom subobject, or can be used to update an existing custom subobject. You can API-enable any custom subobject if the parent object is a Project or an Abstract object such as an investment or custom investment type. When API-enabled, all HTTP commands including GET, POST, PUT, and DELETE are available.
 Once you API-enable an object, you cannot undo or disable it from the API.
The API alias follows the same naming rules introduced in 15.5.0 for custom investment types. The object code is used to create an API alias with 
cust
 (short for 
custom
) inserted as a prefix before the plural form of the object name. The final API alias appears in mixed case (CamelCase). For example, if the object code is 
demand
, the generated API is 
custDemands
.
The following XML creates a custom subobject of a Project parent object:
<NikuDataBus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../xsd/nikuxog_contentPack.xsd"> <Header action="write" externalSource="NIKU" objectType="contentPack" version="15.5.1.1"/> <contentPack update="true"> <objects> <object code="base1" apiEnabled="true" entityCodeAttribute="odf_entity_code" fiscalPeriodTypeAttribute="odf_period_type" pageInstanceType="delme1" pageLayoutAttribute="page_layout" parentObjectCode="project" periodEndAttribute="odf_period_end" periodStartAttribute="odf_period_start" raiseEvents="false" source="customer" update="true"> <nls languageCode="en" name="base1"/> <displayMappings/> <scoreContributions/> <autonumbering/> </object> </objects> </contentPack> </NikuDataBus>
 
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) 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.
When you upgrade to Clarity PPM 15.6 or higher, you can improve XOG performance by including the new 
disableTSVUpdate
 XOG attribute:
  • If set to 
    true
    , the XOG import does not attempt to process the aggregated TSV values; instead, administrators would 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.