Schema for XML API
  
XML Syntax Specification
Legend
Element
Attribute
Reference
Element / Attribute Name            
Root Level 1 Level 2 Level 3 Level 4 Level 5 Cardinality Default Macros Description Comments Type
BuildSet           1..1          
  FormatVersion         1..1 1   Syntax Version    
  Environments         1..1     Build Environments    
    Environment       1..n          
      Name     1..1     Environment Name    
      Tools     1..1     Tool List    
        Tool   1..n          
          Name 1..1     Tool Name    
          AllowRemote 1..1 FALSE   Can this tool run remotely?   Boolean
          OutputFileMasks 1..1 *.*   What output files types should be retrieved from remote agents?   File Mask
          Path 1..1   Yes Absolute path to executable    
          Params 0..1   Yes Default command line for tool    
          OutputPrefix 0..1   Yes Text describing tool operation for Tasks e.g., 'Processing'  
          GroupPrefix 0..1   Yes Text describing tool operation for TaskGroups e.g., 'Processing'  
          SkipIfProjectFailed 0..1 FALSE   Skip all Tool Tasks if a failure occurred.   Boolean
          AutoReserveMemory 0..1 FALSE   Should be set to true when tool or child process is a compiler that uses precompiled headers (e.g. gcc).   Boolean
          VCCompiler 0..1 FALSE   Should be set to true when tool or child process is Visual C/C++ compiler.   Boolean
          SuccessExitCodes 0..1 0   What return codes are defined as successful? e.g., '0..5'
(Currently, 0 is always considered a successful run).
 
          WarningExitCodes 0..1     Tasks returning this exit code are displayed as a yellow bar in the Build Monitor Progress page and are counted as warnings in the Summary page. e.g., '0..5'
Apart from being displayed as a yellow bar and being summed up as warnings, tasks returning these exit codes are considered successful.
 
          SingleInstancePerAgent 0..1 FALSE   Do not allow concurrent instances of this tool on a single Agent.    
          AllowRestartOnLocal 0..1 FALSE   Allow Local Agent to run the same task as a remote Agent in parallel, as a performance optimization.    
          TimeLimit 0..1     Time limit, in seconds, after which a remote task is automatically canceled and reassigned to a different Agent.    
          AutoRecover 0..1     comma-separated list of strings which, when found in tool output,  causes IncrediBuild to reassign the task to another Agent and discard the previous output. Used to automatically recover from recoverable random errors.  
      Variables     0..1     Environment Variable Overrides    
        Variable   1..n          
          Name 1..1     Environment Variable Name    
          Value 1..1     Environment Variable Value    
  Project         1..1     Executed Project    
    Name       1..1     Project Name    
    Env       1..1     Project Environment Must be associated with one of the defined environments under BuildSet  
    WorkingDir       0..1     Project working directory Inherited by used tool  
    TaskGroup       0..n     A Group of Tasks to execute    
      Name     0..1     Group Name    
      Tool     0..1     Group default tool    
      DependsOn     0..1     Dependency Definition Must be associated with existing Task/TaskGroup.
Multiple values allowed, delimited by commas or semi-colons.
 
      WorkingDir     0..1     Group default Working dir Overrides Default project Working directory  
      Env     0..1     TaskGroup Environment Must be associated with one of the defined environments under BuildSet  
      StopOnErrors     0..1     If set to True, build stops immediately if any of the tasks in the task group fail.   Boolean
      Task     0..n     Group sub-Tasks    
      TaskGroup     0..n     Group sub-Groups    
    Task       0..n     A Task to execute    
      Name     0..1     Task Name    
      SourceFile     0..1     Task source file Files masks are allowed (e.g., c:\dev\*.cpp).
Response file supported.
 
      OutputFiles     0..1   Yes Task output file/files Multiple values allowed, delimited by commas or semi-colons.
Response file supported.
 
      InputFiles     0..1     Additional input files Multiple values allowed, delimited by commas or semi-colons.
Response file supported.
 
      Tool     0..1     Task tool Overrides default TaskGroup tool  
      Params     0..1   Yes Command line arguments Overrides default tool arguments. Allows inner Variables.  
      Caption         Yes The caption that will be displayed in the task's progress bar. If not specified, the source filename will be displayed.  
      DependsOn     0..1     Dependency Definition Must be associated with existing Task/TaskGroup.
Multiple values allowed, delimited by commas or semi-colons.
 
      SkipIfProjectFailed     0..1 FALSE   Skip Task if a failure occurred.   Boolean
      WorkingDir     0..1     Task Working dir Overrides Default project Working directory  
      StopOnErrors     0..1 FALSE   If set to True, build stops immediately if the task fails.   Boolean