Plan/Manual/Creating ODT Report Templates: Difference between revisions

From KDE UserBase Wiki
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Construction}}
{{Construction}}
==Description==
==Description==
ODT report templates are regular odt files that can be designed using any odt word processor like ''Calligra Words'' or ''LibreOffice Writer''. The technique used is to use variables to hold references to the  information that shall be fetched from the project. The variables are called ''User Fields'' in ''Writer'' and can be found under <menuchoice>Insert->Field->More Fields->Variables->User Fields</menuchoice>. In ''Words'' they are called ''Custom Variables'' and can be found under <menuchoice>Text Editing docker->Variable->Custom</menuchoice>.
ODT report templates are regular odt files that can be designed using any odt word processor like ''Calligra Words'' or ''LibreOffice Writer''. The technique used is to use ''user field'' variables to hold references to the  information that shall be fetched from the project. The variables are called ''User Fields'' in ''Writer'' and can be found under <menuchoice>Insert->Field->More Fields->Variables->User Fields</menuchoice>. In ''Words'' they are called ''Custom Variables'' and can be found under <menuchoice>Text Editing docker->Variable->Custom</menuchoice>.


==Variables==
==User Field Variables==
===Translated Labels===
===Translated Labels===
Translated lables enables us to produce general report templates that can be used in different languages.
Translated lables enables us to produce general report templates that can be used in different languages.
Line 25: Line 25:
| tr.spi || SPI
| tr.spi || SPI
|-
|-
| tr.cpi || SPI
| tr.cpi || CPI
|}
|}


===Project Values===
===Project Values===
Shows values from the main project.
{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
| style="background:#efefef;" | '''Variable Name'''
| style="background:#efefef;" | '''Variable Name'''
Line 73: Line 75:
| schedule.direction || Name || Scheduling direction
| schedule.direction || Name || Scheduling direction
|-
|-
| Todo || The rest || of the values
| schedule.overbooking || Overbooking || Overbooking
|-
| schedule.distribution || Distribution || Distribution
|-
| schedule.plannedstart || Planned Start || Planned Start
|-
| schedule.plannedfinish || Planned Finish || Planned Finish
|-
| schedule.scheduler || Scheduler || Scheduler
|-
| schedule.granularity || Granularity || Granularity
|}
|}


===Tables===
===Tables===
Supported tables:
Supported table types:
* projects
* tasks
* tasks
* taskstatus
* taskstatus
* schedules
* schedules
* projects


To create a table, place a variable just before a table in your template file. The variable name identifies the table and must start with '''table''', e.g. '''table1'''.
To create a table, place a variable just before a table in your template file. The variable name identifies the table and must start with '''table''', e.g. '''table1'''.
Line 117: Line 129:
| '''''table name'''''.risk || Risk || Risk type
| '''''table name'''''.risk || Risk || Risk type
|-
|-
| '''''table name'''''.constraint || Constraint || Type of time constraint  
| '''''table name'''''.constraint || Constraint || Type of time constraint
|-
|-
| '''''table name'''''.constraintstart || Constraint Start ||  
| '''''table name'''''.constraintstart || Constraint Start || Constraint start time
|-
|-
| '''''table name'''''.constraintend || Constraint End ||  
| '''''table name'''''.constraintend || Constraint End || Constraint finish time
|-
|-
| '''''table name'''''.runingaccount || Running Account ||  
| '''''table name'''''.runingaccount || Running Account || Account for runnning costs
|-
|-
| '''''table name'''''.startupaccount || Startup Account ||  
| '''''table name'''''.startupaccount || Startup Account || Account for startup cost
|-
|-
| '''''table name'''''.startupcost || Startup Cost ||  
| '''''table name'''''.startupcost || Startup Cost || The cost incurred at startup of the task
|-
|-
| '''''table name'''''.shutdownaccount || Shutdown Account ||  
| '''''table name'''''.shutdownaccount || Shutdown Account || Accoutn for shutdown cost
|-
|-
| '''''table name'''''.shutdowncost || Shutdown Cost ||  
| '''''table name'''''.shutdowncost || Shutdown Cost || The cost incurred at shutdown of the task
|-
|-
| '''''table name'''''.description || Description ||  
| '''''table name'''''.description || Description || Task description
|-
|-
| '''''table name'''''.expected || Expected ||  
| '''''table name'''''.expected || Expected || Calculated most likely estimate
|-
|-
| '''''table name'''''.varianceest || Variance (Est) ||
| '''''table name'''''.optimistic || Optimistic || Calculated optimistic estimate
|-
| '''''table name'''''.optimistic || Optimistic ||  
|-
|-
| '''''table name'''''.pessimistic || Pessimistic ||  
| '''''table name'''''.pessimistic || Pessimistic || Calculated pessimistic estimate
|-
|-
| '''''table name'''''.starttime || Start Time ||  
| '''''table name'''''.starttime || Start Time || Shceduled start time
|-
|-
| '''''table name'''''.endtime || End Time ||  
| '''''table name'''''.endtime || End Time || Scheduled finish time
|-
|-
| '''''table name'''''.duration || Duration ||  
| '''''table name'''''.duration || Duration || Scheduled duration
|-
|-
| '''''table name'''''.earlystart || Early Start ||  
| '''''table name'''''.earlystart || Early Start || Earliest possible start
|-
|-
| '''''table name'''''.earlyfinish || Early Finish ||  
| '''''table name'''''.earlyfinish || Early Finish || Earliest possible finish
|-
|-
| '''''table name'''''.latestart || Late Start ||  
| '''''table name'''''.latestart || Late Start || Latest possible start
|-
|-
| '''''table name'''''.latefinish || Late Finish ||  
| '''''table name'''''.latefinish || Late Finish || Latest possible finish
|-
|-
| '''''table name'''''.positivefloat || Positive Float ||  
| '''''table name'''''.positivefloat || Positive Float ||  
Line 167: Line 177:
| '''''table name'''''.finishfloat || Finish Float ||  
| '''''table name'''''.finishfloat || Finish Float ||  
|-
|-
| '''''table name'''''.assignaments || Assignments ||  
| '''''table name'''''.assignaments || Assignments || Resource assignments
|-
| '''''table name'''''.varianceest || Variance (Est) ||  
|-
|-
| '''''table name'''''.variancedur || Variance (Dur) ||  
| '''''table name'''''.variancedur || Variance (Dur) ||  
Line 175: Line 187:
| '''''table name'''''.pessimisticdur || Pessimistic (Dur) ||  
| '''''table name'''''.pessimisticdur || Pessimistic (Dur) ||  
|-
|-
| '''''table name'''''.status || Status ||  
| '''''table name'''''.status || Status || Task status as shown in Task Status View
|-
|-
| '''''table name'''''.completion || % Completed ||  
| '''''table name'''''.completion || % Completed || Completion
|-
|-
| '''''table name'''''.plannedeffort || Planned Effort ||  
| '''''table name'''''.plannedeffort || Planned Effort || Planned effort
|-
|-
| '''''table name'''''.actualeffort || Actual Effort ||  
| '''''table name'''''.actualeffort || Actual Effort || Actual effort
|-
|-
| '''''table name'''''.remaningeffort || Remaining Effort ||  
| '''''table name'''''.remaningeffort || Remaining Effort || Remaining effort
|-
|-
| '''''table name'''''.plannedcost || Planned Cost ||  
| '''''table name'''''.plannedcost || Planned Cost || Planned cost
|-
|-
| '''''table name'''''.actualcost || Actual Cost ||  
| '''''table name'''''.actualcost || Actual Cost || Actual cost
|-
|-
| '''''table name'''''.actualstart || Actual Start ||  
| '''''table name'''''.actualstart || Actual Start || Actual start
|-
|-
| '''''table name'''''.started || Started ||  
| '''''table name'''''.started || Started ||  
|-
|-
| '''''table name'''''.actualfinish || Actual Finish ||  
| '''''table name'''''.actualfinish || Actual Finish || Actual finish
|-
|-
| '''''table name'''''.finished || Finished ||  
| '''''table name'''''.finished || Finished ||  
<!--
|-
| '''''table name'''''.statusnote || Status Note ||
-->
|-
|-
| '''''table name'''''.schedulingstatus || Scheduling Status ||  
| '''''table name'''''.schedulingstatus || Scheduling Status ||  
Line 216: Line 224:
|-
|-
| '''''table name'''''.schedulingerror || Scheduling Error ||  
| '''''table name'''''.schedulingerror || Scheduling Error ||  
<!--
|-
|-
| '''''table name'''''.level || Node level", "Level ||  
| '''''table name'''''.bcws || BCWS || Budgeted Cost of Work Scheduled (cost based)
-->
|-
|-
| '''''table name'''''.bcws || Budgeted Cost of Work Scheduled", "BCWS ||
| '''''table name'''''.bcwp || BCWP || Budgeted Cost of Work Performed (cost based)
|-
|-
| '''''table name'''''.bcwp || Budgeted Cost of Work Performed", "BCWP ||
| '''''table name'''''.acwp || ACWP || Actual Cost of Work Performed (cost based)
|-
|-
| '''''table name'''''.acwp || Actual Cost of Work Performed", "ACWP ||  
| '''''table name'''''.spi || SPI || Schedule Performance Index
|-
|-
| '''''table name'''''.spi || Schedule Performance Index", "SPI ||  
| '''''table name'''''.critical || Critical || Task is critical
|-
|-
| '''''table name'''''.cpi || Cost Performance Index", "CPI ||  
| '''''table name'''''.criticalpath || Critical Path || Task is on critical path


<!-- Not interresting:
|-
|-
| '''''table name'''''.critical || Critical ||  
| '''''table name'''''.level || Node level", "Level ||  
-->
<!-- Not implemented:
|-
|-
| '''''table name'''''.criticalpath || Critical Path ||  
| '''''table name'''''.statusnote || Status Note || Note: Not implemented
<!--
-->
<!-- These must not be used, and are not very interesting:
|-
|-
| '''''table name'''''.owner || Owner ||  
| '''''table name'''''.owner || Owner ||  
Line 245: Line 255:
|}
|}


====Projects Table====
===Task Status Table===
Use by placing a variable with name tableX (X=number) with value taskstatus before the table that shall be filled in.
Create a table with an optional header. The header can optionally contain variables. Fill the first row of the table with variables refers the values you want to fetch from the tasskstatus table.
The variable has this format:<br/>
Variable: <code>Name: tableX.<column> (X=number) Value: taskstatus</code><br>
where '''<column>''' is a column name
Example: A table with header. The header fetches column names from the taskstatus table.
<br/>Variable: <code>Name: table1 Value: taskstatus</code>
{| border="1" cellpadding="5" cellspacing="0"
| style="background:#efefef;" | Variable <code>Name: table1.name Value: Name</code>
| style="background:#efefef;" | This is the header so fetches the header of the column
|-
| Variable <code>Name: table1.name Value: Name</code> || This is the values so fetches the actual column value
|}
====Tasks Table====


===Chart===
===Chart===

Revision as of 08:41, 6 February 2018

Under Construction

This is a new page, currently under construction!

Description

ODT report templates are regular odt files that can be designed using any odt word processor like Calligra Words or LibreOffice Writer. The technique used is to use user field variables to hold references to the information that shall be fetched from the project. The variables are called User Fields in Writer and can be found under Insert->Field->More Fields->Variables->User Fields. In Words they are called Custom Variables and can be found under Text Editing docker->Variable->Custom.

User Field Variables

Translated Labels

Translated lables enables us to produce general report templates that can be used in different languages.

Variable Name Variable Value
tr.project Project
tr.manager Manager
tr.schedule Schedule
tr.bcws BCWS
tr.bcwp BCWP
tr.acwp ACWP
tr.spi SPI
tr.cpi CPI

Project Values

Shows values from the main project.

Variable Name Variable Value Description
project.name Name The name of the project
project.manager Manager The name of the project manager
project.bcwscost BCWS Cost Cost based Budgeted Cost of Work Scheduled
project.bcwpcost BCWP Cost Cost based Budgeted Cost of Work Performed
project.acwpcost ACWP Cost Cost based Actual Cost of Work Performed
project.spicost SPI Cost Cost based Schedule Performance Index
project.cpicost CPI Cost Cost based Cost Performance Index
project.bcwseffort BCWS Effort Effort based Budgeted Cost of Work Scheduled
project.bcwpeffort BCWP Effort Effort based Budgeted Cost of Work Performed
project.acwpeffort ACWP Effort Effort based Actual Cost of Work Performed
project.spieffort SPI Effort Effort based Schedule Performance Index
project.cpieffort CPI Effort Effort based Cost Performance Index

Schedule Values

Shows values from current schedule.

Variable Name Variable Value Description
schedule.name Name The name of the schedule
schedule.state State Scheduling state
schedule.direction Name Scheduling direction
schedule.overbooking Overbooking Overbooking
schedule.distribution Distribution Distribution
schedule.plannedstart Planned Start Planned Start
schedule.plannedfinish Planned Finish Planned Finish
schedule.scheduler Scheduler Scheduler
schedule.granularity Granularity Granularity

Tables

Supported table types:

  • tasks
  • taskstatus
  • schedules
  • projects

To create a table, place a variable just before a table in your template file. The variable name identifies the table and must start with table, e.g. table1. The value of the variable is used to point to the data to be fetched and must be one of the supported tables listed above, e.g taskstatus. You then put variables inside the table cells with name and value from the table below.


Note that the schedules table supports the values described in Shedule Values above.


The projects, tasks and taskstatus tables supports the following values:

Variable Name Variable Value Description
table name.name Name The name of the task or project
table name.wbscode WBS Code
table name.type Type Type of task
table name.responsible Responsible
table name.allocation Allocation
table name.estimatetype Estimate Type
table name.calendar Calendar
table name.estimate Estimate Most likely estimate
table name.optimistic Optimistic Optimistic ratio
table name.pessimistic Pessimistic Pessimistic ratio
table name.risk Risk Risk type
table name.constraint Constraint Type of time constraint
table name.constraintstart Constraint Start Constraint start time
table name.constraintend Constraint End Constraint finish time
table name.runingaccount Running Account Account for runnning costs
table name.startupaccount Startup Account Account for startup cost
table name.startupcost Startup Cost The cost incurred at startup of the task
table name.shutdownaccount Shutdown Account Accoutn for shutdown cost
table name.shutdowncost Shutdown Cost The cost incurred at shutdown of the task
table name.description Description Task description
table name.expected Expected Calculated most likely estimate
table name.optimistic Optimistic Calculated optimistic estimate
table name.pessimistic Pessimistic Calculated pessimistic estimate
table name.starttime Start Time Shceduled start time
table name.endtime End Time Scheduled finish time
table name.duration Duration Scheduled duration
table name.earlystart Early Start Earliest possible start
table name.earlyfinish Early Finish Earliest possible finish
table name.latestart Late Start Latest possible start
table name.latefinish Late Finish Latest possible finish
table name.positivefloat Positive Float
table name.freefloat Free Float
table name.negativefloat Negative Float
table name.startfloat Start Float
table name.finishfloat Finish Float
table name.assignaments Assignments Resource assignments
table name.varianceest Variance (Est)
table name.variancedur Variance (Dur)
table name.optimisticdur Optimistic (Dur)
table name.pessimisticdur Pessimistic (Dur)
table name.status Status Task status as shown in Task Status View
table name.completion % Completed Completion
table name.plannedeffort Planned Effort Planned effort
table name.actualeffort Actual Effort Actual effort
table name.remaningeffort Remaining Effort Remaining effort
table name.plannedcost Planned Cost Planned cost
table name.actualcost Actual Cost Actual cost
table name.actualstart Actual Start Actual start
table name.started Started
table name.actualfinish Actual Finish Actual finish
table name.finished Finished
table name.schedulingstatus Scheduling Status
table name.notscheduled Not Scheduled
table name.assignmentmissing Assignment Missing
table name.resourceoverbooked Resource Overbooked
table name.resourceunavailable Resource Unavailable
table name.constrainterror Constraints Error
table name.effortnotmet Effort Not Met
table name.schedulingerror Scheduling Error
table name.bcws BCWS Budgeted Cost of Work Scheduled (cost based)
table name.bcwp BCWP Budgeted Cost of Work Performed (cost based)
table name.acwp ACWP Actual Cost of Work Performed (cost based)
table name.spi SPI Schedule Performance Index
table name.critical Critical Task is critical
table name.criticalpath Critical Path Task is on critical path


Chart

Use by placing a variable with name chartX (X=number) with value project before the chart that shall be used.

The variable has this format:
Variable: Name: chartX (X=number) Value: project; values=data;
where data is a comma separated list of values to be include in the chart.

Possible values are:

  • bcws effort Budgeted cost of work scheduled, effort based.
  • bcwp effort Budgeted cost of work performed, effort based.
  • acwp effort Actual cost of work performed, effort based.
  • spi effort Schedule performance index, effort based.
  • cpi effort Cost performance index, effort based.
  • bcws cost Budgeted cost of work scheduled, cost based.
  • bcwp cost Budgeted cost of work performed, cost based.
  • acwp cost Actual cost of work performed, cost based.
  • spi cost Schedule performance index, cost based.
  • cpi cost Cost performance index, cost based.

The charts you create in you template must have the same (or more) number of columns as the number of values you specify in your variable.


Example: Variable: Name: chart1 Value: values=bcws cost,bcwp cost, acwp cost;


Note that you cannot mix effort- and cost based values. If you want to show both, create two charts.

Gantt

Not supported.