# 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:

- Perform a XOG read action to create an output file of all the existing rows in the rate matrix.
- Update the output file to include any additional rows that you want to add.
- 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:

- nameThe name of the matrix.
- typeThe type of the matrix (Cost or Rate).
- locationThe 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:

- nameOptional. Defines the list of columns to be added to the matrix rows and has the following attributes:
- chargeCodeDefines the charge code for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - clntclassOptional. Defines the client class for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - company_codeDefines the company code for the matrix row.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - departcodeDefines the department code for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - entityDefines the entity for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - inputtypeDefines the input type code for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - locationidDefines the location unique identifier for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - projclassDefines the project class for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - project_codeDefines the project code for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - resourceClassDefines the resource class for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - resource_codeDefines the resource code for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - resourceRoleOptional. Defines the resource role for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - transactionClassOptional. Defines the transaction class for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType: - projsitecodeDefines the project site code for the matrix column.
PPA_MATRIXCOLDEF.FIELDNAMETable and Column:StringType:

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:

- fromDateOptional. Defines the date from which to apply the matrix row.
PPA_MATRIXVALUES.FROMDATETable and Column:DateType: - toDateOptional. Defines the date until which to apply the matrix row.
PPA_MATRIXVALUES.TODATETable and Column:DateType: - chargecodeOptional. Defines the chargecode for the matrix row.
PPA_MATRIXVALUES.VALUE1Table and Column:StringType: - DepartmentOptional. Defines the department for the matrix row.
PPA_MATRIXVALUES.VALUE2Table and Column:StringType: - entityOptional. Defines the entity for the matrix row.
PPA_MATRIXVALUES.VALUE3Table and Column:StringType: - Input type codeOptional. Defines the input type code for the matrix row.
PPA_MATRIXVALUES.VALUE6Table and Column:StringType: - locationOptional. Defines the location for the matrix row.
PPA_MATRIXVALUES.VALUE9Table and Column:StringType: - Project classOptional. Defines the project class for the matrix row.
PPA_MATRIXVALUES.VALUE8Table and Column:StringType: - ProjectOptional. Defines the project for the matrix row.
PPA_MATRIXVALUES.VALUE7Table and Column:StringType: - Resource classOptional. Defines the resource class for the matrix row.
PPA_MATRIXVALUES.VALUE9Table and Column:StringType: - ResourceOptional. Defines the resource for the matrix row.
PPA_MATRIXVALUES.VALUE10Table and Column:StringType: - rateOptional. Defines the rate for the matrix row.
PPA_MATRIXVALUES.NUMVAL1Table and Column:DoubleType: - standardCostOptional. Defines the standard cost for the matrix row.
PPA_MATRIXVALUES.NUMVAL2Table and Column:DoubleType: - actualCostOptional. Defines the actual cost for the matrix row.
PPA_MATRIXVALUES.NUMVAL3Table and Column:DoubleType: - currencyCodeOptional. Defines the currency code for the matrix row.
PPA_MATRIXVALUES.MATRIX_CURRENCY_CODETable and Column:StringType: - typeCodeOptional. Defines the cost plus code for the matrix row.
PPA_MATRIXVALUES.STRVAL1Table and Column:StringType: