XOG: Entity

ccppmop1561
Use the entity XOG object to view inbound and outbound entity attributes.
Schema Name
nikuxog_entity.xsd
Read and Write XML Files
The following XML files are included:
  • entity_read.xml. Use this file to export entities from 
    Clarity PPM
    .
  • entity_write.xml. Use this file to import entities that were previously exported from 
    Clarity PPM
    .
Prerequisites
None.
Business Rules and Processing
The following business rules and processing apply to this XOG object:
  • The entity inherits the currency type from the system settings.
  • In entity create mode, if the OBS types in the XOG file do not exist, they are created automatically.
  • Structural updates to OBS types are not allowed if they are referred to by the entities. Use the location and department XOG files for structural changes.
  • Ensures that the OBS types are not referred to by another entity.
  • Creates departments and locations for the OBS units (when in create mode).
  • You can only set one entity as the default entity at any time.
  • Setting an entity as the default results in any other entity that was marked as the default to no longer be the default.
  • A single entity with isDefault="false" does not mark this entity as the default even if this entity is the first one in the system.
  • Multiple entities with isDefault="true" set for one or more of the entities results in the last entity with isDefault="true" to be marked as the default.
Read Filters
The following explicit read filter is used:
  • Entity
    Defines the unique entity code to read out.
  • Description
    Defines the description of the entity.
Schema Mappings
The following schema tag attributes are described.
Entity Schema Tag
This tag is part of the schema mapping for the Entity XOG object. It is a placeholder tag for multiple entities.
Entity
The actual entity object. The entity schema mapping includes definitions for the home and reporting currencies. This schema tag has the following attributes:
  • entity
    Required. Defines the name of the entity. Do not allow truncation.
    Table and Column:
    ENTITY.entity
    Type:
    String
  • finPeriodCode
    Optional. Defines the fiscal time period type of the entity.
    Possible Values
    : WEEKLY, 13_PERIODS_PER_YEAR, SEMI_MONTHLY, MONTHLY, QUARTERLY, and ANNUALLY.
    Table and Column
    : ENTITY.FIN_PERIOD_CODE
    Type
    : String
  • geoOBS
    Required. Refers to the OBS that will represent the geographical structure (that is, locations).
    Table and Column:
    ENTITY.geo_chart_obs_type_id
    Type:
    String
  • orgOBS
    Required. Refers to the OBS that will represent the organizational structure (that is, departments).
    Table and Column:
    ENTITY.org_chart_obs_type_id
    Type:
    String
  • homeCurrency
    Required. Defines the lookup values for each ISO standard code. Validate that it is an active currency.
    Table and Column:
    ENTITY.Home_Currency_Code
    Type:
    String
  • reportingCurrency
    Required. Defines the lookup values for each ISO standard code. Validate that it is an active currency.
    Table and Column:
    ENTITY.Reporting_Currency_Code
    Type:
    String
  • billingCurrency
    Optional. Defines the lookup values for each ISO standard code. Validate that the billing currency is an active currency.
    Table and Column
    : ENTITY.Billing_Currency_Code
    Type
    : String
  • externalID
    Required. Refers to the originating system set of books ID.
    Table and Column:
    ENTITY.External_ID
    Type:
    String
  • defaultProjectClass
    Represents the project class for the entity. Validated against project classes.
    Table and Column:
    ENTITY.PROJECT_CLASS
    Type:
    String
  • defaultWIPClass
    Represents the default WIP class for the entity. Validated against WIP classes
    Table and Column:
    ENTITY.WIP_CLASS
    Type:
    String
  • defaultClientClass
    Represents the default client class for the entity.
    Table and Column:
    ENTITY.CLIENT_CLASS
    Type:
    String
  • defaultBatchCycle
    Represents the default batch cycle for the entity.
    Table and Column:
    Type:
    String
  • defaultLaborRateSource
    Defines the default rate matrix for labor transactions for the entity. Validated against matrices.
    Table and Column
    : ENTITY.TRANS_RATE_SOURCE_LABOR
    Type
    : String (in schema). Number (in 
    Clarity PPM
    ).
  • defaultLaborCostSource
    Defines the default cost rate matrix for labor transactions for the entity. Validated against matrices.
    Table and Column
    : ENTITY.TRANS_COST_SOURCE_LABOR
    Type
    : String (in schema). Number (in 
    Clarity PPM
    ).
  • defaultLaborSourceLocation
    Defines the default location for labor transactions for the entity.
    Table and Column
    : ENTITY.TRANS_LOCATION_LABOR
    Type
    : String
    Values:
    Project and Resource
  • defaultMaterialRateSource
    Optional. Defines the default rate matrix for rate of material transactions for the entity. Validated against matrices.
    Table and Column
    : ENTITY.TRANS_RATE_SOURCE_MATERIALS
    Type
    : String (in schema). Number (in 
    Clarity PPM
    ).
  • defaultEquipmentRateSource
    Optional. Defines the default rate matrix ID for equipment transactions for the entity. Validated against matrices.
    Table and Column
    : ENTITY.TRANS_RATE_SOURCE_EQUIPMENT
    Type
    : String (in schema). Number (in 
    Clarity PPM
    ).
  • defaultExpenseRateSource
    Optional. Defines the default rate matrix for expense transactions for the entity. Validated against matrices.
    Table and Column
    : ENTITY.TRANS_RATE_SOURCE_EXPENSE
    Type
    : String (in schema). Number (in 
    Clarity PPM
    ).
  • exchangeRateTypeLabor
    Optional. Defines the labor exchange rate type for the entity.
    Table and Column
    : ENTITY.EXCHANGE_RATE_TYPE_LABOR
    Type
    : String
  • exchangeRateTypeMaterials
    Optional. Defines the materials exchange rate type for the entity.
    Table and Column
    : ENTITY. EXCHANGE_RATE_TYPE_ MATERIALS
    Type
    : String
  • exchangeRateTypeEquipment
    Optional. Defines the equipment exchange rate type for the entity.
    Table and Column
    : ENTITY. EXCHANGE_RATE_TYPE_ EQUIPMENT
    Type
    : String
  • exchangeRateTypeExpense
    Optional. Defines the expense exchange rate type for entity.
    Table and Column
    : ENTITY.EXCHANGE_RATE_TYPE_ EXPENSE
    Type
    : String
  • isDefault
    Optional. Defines the default entity when set to true. To undo the default entity, set the attribute to false.
    Table and Column
    :
    Type
    : String
Description Schema Tag
This tag, part of the schema mapping for the Entity XOG object, has the following attribute:
  • Description
    Required. A description of the entity.
    Table and Column:
    ENTITY.description
    Type:
    String
Short Description (shortDescription) Schema Tag
This tag is part of the schema mapping for the Entity XOG object. The short description for the entity. It has the following attribute:
  • short description
    Required. Defines the short description tag.
    Table and Column:
    ENTITY.shortdesc
    Type:
    String
OBS Types (obsTypes) Schema Tag
This tag is part of the schema mapping for the Entity XOG object. The tag describes the OBS types that are associated with the entity.
This obsTypes schema tag can include 0 to n number of obs tags.
Each obs tag is composed of the following child elements:
  • level (minimum 1, maximum 10)
  • objectAssociation (minimum 0, maximum unbounded)
  • unit (minimum 0, maximum unbounded)
obs
The obs tag has the following attributes:
  • code
    Required. Defines the unique code for OBS type.
    Table and Column
    : PRJ_OBS_TYPES.unique_name
    Type
    : String
  • name
    Required. Defines the name of the OBS type.
    Table and Column
    : PRJ_OBS_TYPES.name
    Type
    : String
  • description
    Optional. Describes the OBS type.
    Table and Column
    : PRJ_OBS_TYPES.description
    Type
    : String
level
This child element represents a level in the OBS type. At least one level is required.
level
has the following attributes:
  • Name
    Required. The name for the level.
    Table and Column
    : Prj_Obs_Levels.Name
    Type:
    String
  • depth
    Required. The depth of the OBS level.
    Table and Column
    : Prj_Obs_Levels.obs_level
    Type
    : Integer from 1 to 10
objectAssociation
This optional child element represents the object types that are associated with the OBS type.
  • object
    Required. The name of the object type that is associated to this OBS.
    Table and Name
    : Prj_Obs_Associations.table_name
    Type
    : String
  • associationType
    Required.
    Possible Values
    : Any Unit, Lowest Level
    Table and Name
    : prj_obs_object_types.is_leaf_only
    Type
    : String
unit
This optional tag represents the units for this OBS type.
Each unit is composed of the following child elements:
  • associatedObject
  • rights
  • Security
The unit schema tag has the following attributes:
  • code
    Required. Defines the unique code for OBS unit.
    Table and Column
    : PRJ_OBS_UNITS.unique_name
    Type
    : String
  • name
    Required. Defines the name of the OBS unit.
    Table and Column
    : PRJ_OBS_UNITS.name
    Type
    : String
GL Periods GLPeriods Schema Tag
This tag is part of the schema mapping for the Entity XOG object. The tag describes the GL periods that are associated with the entity. This schema tag has the following attributes:
  • periodName
    Required. Defines the GL period name.
    Table and Column:
    Type:
    String
  • period
    Required. Defines the GL period.
    Table and Column:
    Type:
    Non-negative integer
  • quarter
    Defines the GL quarter.
    Table and Column:
    Type:
    Non-negative integer
  • year
    Defines the GL year.
    Type
    : Non-negative integer
  • startDate
    Required. Defines the GL period start date.
    Type
    : String
  • endDate
    Required. Defines the GL period end date.
    Type
    : String
  • description
    Optional. Describes the GL period.
    Type
    : String
  • periodType
    Required. Describes the GL period type.
    Table and Column
    : BIZ_COM_PERIODS.PERIOD_TYPE
    Type
    : String
  • entityId
    Required. Provides a unique ID for the GL period.
    Table and Column
    : BIZ_COM_PERIODS.ENTITY_ID
    Type:
    String (Number in database)
  • isActive
    Optional. Indicates if the GL period is active
    Table and Column
    : BIZ_COM_PERIODS.IS_ACTIVE
    Type:
    Boolean (Number in database)
Plan Defaults PlanDefaults Schema Tag
This tag is part of the schema mapping for the Entity XOG object. The tag describes the plan defaults associated with the entity. An entity can have only one planDefaults.
This tag includes the child element GroupingAttributes.
The planDefaults schema tag includes the following attributes:
  • periodTypeCode
    The fiscal time period type for planDefaults.
    Table and Column
    : FIN_PLAN_DEFAULTS.PERIOD_TYPE_CODE
    Possible Values
    : WEEKLY, 13_PERIODS_PER_YEAR, SEMI_MONTHLY, MONTHLY, QUARTERLY, and ANNUALLY.
    Type
    : String
  • startPeriodName
    The start period name for planDefaults.
    Table and Column
    : FIN_PLAN_DEFAULTS. START_PERIOD_ID
    Type
    : String (Number in database)
  • endPeriodName
    The end period name for planDefaults.
    Table and Column
    : FIN_PLAN_DEFAULTS. END_PERIOD_ID
    Type
    : String (Number in database)
  • lockPlanStructure
    Flag to identify whether to lock the plan structure (grouping attributes) for planDefaults.
    Table and Column
    : FIN_PLAN_DEFAULTS. LOCK_PLAN_STRUCTURE
    Type
    : Boolean (Number in database)
  • freezeDate
    The freeze date for planDefaults. Financial plans for this entity can be edited only if the startDate of a period is after this freeze date.
    Table and Column
    : FIN_PLAN_DEFAULTS. FREEZE_DATE
    Type
    : Date
Grouping Attributes Schema Tag
This tag is a child element of the Plan Defaults schema tag. The tag can have a minimum of one and up to ten grouping attributes.
This tag has the following attributes:
  • Grouping Attribute
    Specifies the grouping attributes for the plan defaults for an entity.
    Table and Column
    : ODF_MULTI_VALUED_LOOKUPS.VALUE
    Type
    : String