XOG: Matrix

Use the matrix XOG object to view inbound and outbound cost/rate matrix instances. Rate matrices give you flexibility in defining cost for particular services or resources.
ccppmop144
Use the matrix XOG object to view inbound and outbound cost/rate matrix instances. Rate matrices give you flexibility in defining cost for particular services or resources.
To update a rate matrix using XOG, include all the rows in the matrix in the XOG input file. The rows in the matrix do not include unique IDs for each row. The update causes a full replace of all rows in the matrix. If you do not include all the matrix rows in the XOG input file, the update removes the existing rows from the matrix and just adds the new rows.
We recommend that you complete the following steps to update an existing rate matrix:
  1. Perform a XOG read action to create an output file of all the existing rows in the rate matrix.
  2. Update the output file to include any additional rows that you want to add.
  3. Perform the XOG write action to update the matrix.
Schema Name
nikuxog_matrix.xsd
Read and Write XML Files
The following XML files are included:
  • matrices_read.xml. Use this file to export matrices from 
    Clarity Project and Portfolio Management (PPM)
    .
  • matrices_write.xml. Use this file to import matrices that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Filters
The following explicit read filters are used:
  • name
    The name of the matrix.
  • type
    The type of the matrix (Cost or Rate).
  • location
    The location of the matrix.
Error Handling
The following errors can be thrown when importing or exporting the cost plan:
  • Failed to export matrices.
  • Failed to import matrices.
Schema Mappings
Mappings for the following schema tag names are provided.
columnType Schema Tag
This tag is part of the schema mapping for the matrix XOG object. The columns that you assign to a matrix through the XOG are saved to the PPA_MATRIXCOLDEF table.
This tag has the following attribute:
  • name
    Optional. Defines the list of columns to be added to the matrix rows and has the following attributes:
    • chargeCode
      Defines the charge code for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • clntclass
      Optional. Defines the client class for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • company_code
      Defines the company code for the matrix row.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • departcode
      Defines the department code for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • entity
      Defines the entity for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • inputtype
      Defines the input type code for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • locationid
      Defines the location unique identifier for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • projclass
      Defines the project class for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • project_code
      Defines the project code for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • resourceClass
      Defines the resource class for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • resource_code
      Defines the resource code for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • resourceRole
      Optional. Defines the resource role for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • transactionClass
      Optional. Defines the transaction class for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
    • projsitecode
      Defines the project site code for the matrix column.
      Table and Column:
      PPA_MATRIXCOLDEF.FIELDNAME
      Type:
      String
MatrixRowType Schema Tag
The MatrixRowType tag is part of the schema mapping for the matrix XOG object. The values for the rows you add to the matrix are saved to a column in the PPA_MATRIXVALUES table.
This tag has the following attributes:
  • fromDate
    Optional. Defines the date from which to apply the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.FROMDATE
    Type:
    Date
  • toDate
    Optional. Defines the date until which to apply the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.TODATE
    Type:
    Date
  • chargecode
    Optional. Defines the chargecode for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE1
    Type:
    String
  • Department
    Optional. Defines the department for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE2
    Type:
    String
  • entity
    Optional. Defines the entity for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE3
    Type:
    String
  • Input type code
    Optional. Defines the input type code for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE6
    Type:
    String
  • location
    Optional. Defines the location for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE9
    Type:
    String
  • Project class
    Optional. Defines the project class for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE8
    Type:
    String
  • Project
    Optional. Defines the project for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE7
    Type:
    String
  • Resource class
    Optional. Defines the resource class for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE9
    Type:
    String
  • Resource
    Optional. Defines the resource for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.VALUE10
    Type:
    String
  • rate
    Optional. Defines the rate for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.NUMVAL1
    Type:
    Double
  • standardCost
    Optional. Defines the standard cost for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.NUMVAL2
    Type:
    Double
  • actualCost
    Optional. Defines the actual cost for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.NUMVAL3
    Type:
    Double
  • currencyCode
    Optional. Defines the currency code for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.MATRIX_CURRENCY_CODE
    Type:
    String
  • typeCode
    Optional. Defines the cost plus code for the matrix row.
    Table and Column:
    PPA_MATRIXVALUES.STRVAL1
    Type:
    String