Version Differences for AHPTool Documentation

(halfway complete)
Line 46:
  <tr><td rowspan=2>'''getJobProperties'''</td><td rowspan=2>Get properties of a job execution.. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'. </td><td>''-job''</td><td>Can be set via the environment variable AH_JOB_ID. The id of the job execution to get the properties from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-property''</td><td>The name of the property to get the value of. </td><td align=center></td></tr>    <tr><td rowspan=2>'''getJobProperties'''</td><td rowspan=2>Get properties of a job execution.. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'. </td><td>''-job''</td><td>Can be set via the environment variable AH_JOB_ID. The id of the job execution to get the properties from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-property''</td><td>The name of the property to get the value of. </td><td align=center></td></tr> 
  <tr><td rowspan=2>'''getRequestProperties'''</td><td rowspan=2>Get properties of a request.. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'. </td><td>''-request''</td><td>The id of the request to get the properties from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-property''</td><td>The name of the property to get the value of. </td><td align=center></td></tr>    <tr><td rowspan=2>'''getRequestProperties'''</td><td rowspan=2>Get properties of a request.. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'. </td><td>''-request''</td><td>The id of the request to get the properties from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-property''</td><td>The name of the property to get the value of. </td><td align=center></td></tr> 
    + <tr><td rowspan=2>'''getSourceAnalytics'''</td><td rowspan=2>Get a source analytics report of a build life. </td><td>''-buildlife''</td><td>Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the report from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-report''</td><td>The name of the report. </td><td align=center bgcolor=#FFFFDD>X</td></tr>  
    + <tr><td>'''getSourceChanges'''</td><td>Get source changes of a build life. </td><td>''-buildlife''</td><td>Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to add the source changes to.</td><td align=center bgcolor=#FFFFDD>X</td></tr>  
    + <tr><td rowspan=3>'''getStepProperties'''</td><td rowspan=3>Get properties of a step execution.. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'. </td><td>''-job''</td><td>Can be set via the environment variable AH_JOB_ID. The id of the step's job execution to get the properties from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-step''</td><td>The index of the step within the job execution or 'current' for the latest step. </td><td align=center></td></tr><tr><td>''-property''</td><td>The name of the property to get the value of. </td><td align=center></td></tr>  
    + <tr><td>'''getSystemProperties'''</td><td>Get properties of a global system scope. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'. </td><td>''-property''</td><td>The name of the property to get the value of. </td><td align=center></td></tr>  
    + <tr><td rowspan=2>'''getTestCoverage'''</td><td rowspan=2>Get a test coverage report of a build life. </td><td>''-buildlife''</td><td>Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the report from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-report''</td><td>The name of the report. </td><td align=center bgcolor=#FFFFDD>X</td></tr>  
    + <tr><td rowspan=2>'''getTests'''</td><td rowspan=2>Get a test report of a build life. </td><td>''-buildlife''</td><td>Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the report from. </td><td align=center bgcolor=#FFFFDD>X</td></tr><tr><td>''-report''</td><td>The name of the report. </td><td align=center bgcolor=#FFFFDD>X</td></tr>  
  </table>    </table> 
       
       
       
- *'''getSourceAnalytics '''      
- **Get a source analytics report of a build life.      
- ***''-buildlife ''      
- ****Required. Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the report from.      
- ***''-report ''      
- ****Required. The name of the report.      
       
- *'''getSourceChanges '''      
- **Get source changes of a build life.      
- ***''-buildlife ''      
- ****Required. Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the source changes from.      
- *'''getStepProperties '''      
- **Get properties of a step execution.. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'.      
- ***''-job ''      
- ****Required. Can be set via the environment variable AH_JOB_ID. The id of the step's job execution to get the properties from.      
- ***''-step ''      
- ****Optional. The index of the step within the job execution or 'current' for the latest step.      
- ***''-property ''      
- ****Optional. The name of the property to get the value of.      
- *'''getSystemProperties '''      
- **Get properties of a global system scope. To get all properties in XML form, do not give a value for 'property'. To get just the text value of a property, give a property name for 'property'.      
- ***''-property ''      
- ****Optional. The name of the property to get the value of.      
- *'''getTestCoverage '''      
- **Get a test coverage report of a build life.      
- ***''-buildlife ''      
- ****Required. Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the report from.      
- ***''-report ''      
- ****Required. The name of the report.      
- *'''getTests '''      
- **Get a test report of a build life.      
- ***''-buildlife ''      
- ****Required. Can be set via the environment variable AH_BUILD_LIFE_ID. The id of the build life to get the report from.      
- ***''-report ''      
- ****Required. The name of the report.      
  *'''getWorkDir '''    *'''getWorkDir ''' 
  **Get the current working direcotry of a job execution.     **Get the current working direcotry of a job execution.  
-      
-      
       
  *'''setAgentProperties '''    *'''setAgentProperties ''' 
  **Set properties on a agent configuration. Requires XML input.     **Set properties on a agent configuration. Requires XML input.  
    +  
    +  
Line 95:
       
  *'''setBuildLifeProperties '''    *'''setBuildLifeProperties ''' 
  **Set properties on a build life. Requires XML input.     **Set properties on a build life. Requires XML input.  
    +  
    +  
Line 99:
       
  *'''setJobProperties '''    *'''setJobProperties ''' 
  **Set properties on a job execution. Requires XML input.     **Set properties on a job execution. Requires XML input.  
    +  
    +  
Line 103:
       
  *'''setRequestProperties '''    *'''setRequestProperties ''' 
  **Set properties on a request. Requires XML input.     **Set properties on a request. Requires XML input.  
    +  
    +  
Line 107:
       
  *'''setStepProperties '''    *'''setStepProperties ''' 
  **Set properties on a step execution. Requires XML input.     **Set properties on a step execution. Requires XML input.