diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/helium/properties-table.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/helium/properties-table.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,2235 @@ + + + + + + + + + + + + + + + + + + + Properties (Helium API) + + + + + + + + + + + + + + + + + +
+Helium API + +
+ + +
+ + + +
+

+ Properties table(Sortable) +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescriptionEdit StatusType
absolute.prep.root.dir

This will convert absolute path for prep.root.dir if anybody use relative path.

neverstring
ado.mapping.file

Path to a INI file that contains the mapping between the ADO from Synergy WA and it's location on the BA.

neverstring
ado.quality.mapping.file

Path to a INI file that contains the mapping between the ADO from Synergy WA and it's location on the BA for quality targets.

neverstring
antlib.import.module.path

Path where ant XML files dynamically downloaded from jar file.

neverstring
archive.max.number.of.threads

Set the maximum number of threads running for archiving (for a parallel job).

allowedinteger
archive.using.ec

Set to true to enable EC zipping

recommendedboolean
ats.aste.drop.file

Path for creation of the drop file during the build. Default is ATS3AsteDrop.zip

discouragedstring
ats.aste.email.list

The property is needed if you want to get an email from ATS server after the tests are executed. There can be one to many semicolon(s) ";" separated email addresses.

recommendedstring
ats.aste.plan.name

Modify the plan name if you have understanding of test.xml file or leave it as it is. Deafault value is "plan"

recommendedstring
ats.aste.testrun.name

Modify the test-run name if you have understanding of test.xml file or leave it as it is. Deafault value is a string consist of build id, product name, major and minor versions

recommendedstring
ats.ctc.enabled

Should be "True" if coverage measurement and dynamic analysis (CTC) tool support is to be used by ATS. Deafault value is "False", the values are case-sensitive.

recommendedstring
ats.drop.file

Path for creation of the drop file during the build. Default is ATS3Drop.zip

discouragedstring
ats.drop.location

Server location (UNC path) to save the ATS3Drop file, before sending to the ATS. For example: \\trwsem00\some_folder\. In case, ``ats.script.type`` is set to "import", ATS doesn't need to have access to ats.drop.location, its value can be any local folder on build machine, for example c:\temp (no network share needed).

muststring
ats.email.list

The property is needed if you want to get an email from ATS server after the tests are executed. There can be one to many semicolon(s) ";" separated email addresses.

recommendedstring
ats.flash.images

List of flash images (.fpsx files) to install on the phone. It is not recommended to set the value manually however, it is possible.

allowedstring
ats.flashfiles.minlimit

Limit of minimum number of flash files to execute ats-test target, otherwise ATSDrop.zip will not be generated. Default value is "2" files.

recommendedstring
ats.password

Password for ATS. This password might be different from NOE or HTTP/UNIX password.

muststring
ats.plan.name

Modify the plan name if you have understanding of test.xml file or leave it as it is. Deafault value is "plan"

recommendedstring
ats.product.hwid

Product HardWare ID (HWID) attached to ATS. By default the value of HWID is not set.

recommendedstring
ats.product.name

Name of the product to be tested. For example: "PRODUCT"

muststring
ats.report.location

Sets ATS reports store location. Default location is "${publish.dir}/${publish.subdir}"

allowedstring
ats.script.type

There are two types of ats script files to send drop to ATS server, "runx" and "import"; only difference is that with "import" ATS doesn't have to have access rights to testdrop.zip file, as it is sent to the system over http and import doesn't need network shares. If that is not needed "import" should not be used. Default value is "runx" as "import" involves heavy processing on ATS server

recommendedstring
ats.server

For example: "4fio00105" or "catstresrv001.cats.noklab.net:80". Default server port is "8080", but it is not allowed between intra and Noklab. Because of this we need to define server port as 80. The host can be different depending on site and/or product.

muststring
ats.target.platform

Sets target platform for compiling test components. Default value is "armv5 urel".

recommendedstring
ats.test.timeout

To set test commands execution time limit on ATS3 server, in seconds. Default value is "60".

recommendedstring
ats.testrun.name

Modify the test-run name if you have understanding of test.xml file or leave it as it is. Deafault value is a string consist of build id, product name, major and minor versions

recommendedstring
ats.trace.enabled

Should be "True" if tracing is needed during the tests running on ATS3. Deafault value is "False", the values are case-sensitive.

recommendedstring
ats.username

Username for ATS server. This is NOT the NOE or HTTP/UNIX username.

muststring
binary.root

Defines location of binaries created in build. Used in check-capability target while generating capability scan report.

neverstring
branch.name

this along with week.number used to find proper history file based on releases.

allowedstring
build.cache.dir

Directory where Helium can store files on a temporary basis for a user per build.

neverstring
build.cache.log.dir

Directory where Helium can store log files on a temporary basis for a user per build.

neverstring
build.drive

Substed drive where the build is performed. if not defined then helium should search next available build drive letter and subst autometically

recommendedstring
build.drive.notdefined

used to track if build.drive has predefined or not

neverflag
build.duplicates.log

Default name of the build duplicates log file.

discouragedstring
build.errors.limit

Maximum allowable errors in a build.

allowednumber
build.id

A unique ID for the build.

discouragedstring
build.int.db.dir

The directory where the build integer database text files are stored.

discouragedstring
build.log

Defines name of the log file.

neverstring
build.log.dir

This is where the build logs are stored.

discouragedstring
build.logging.key.stages

Defines which stages are considered as key stages and logged.

discouragedstring
build.logging.start.stage

Defines at which point logging is started.

discouragedstring
build.name

A general label for this type of build. Currently if not defined, product.name will be used to set this property, but this will likely be removed in future.

muststring
build.output.dir

This is the directory where build output is placed.

neverstring
build.property.cache.file

A file where persistent properties for a build should be stored.

neverstring
build.sisfiles.dir

This is the directory where sisfiles are placed.

neverstring
build.summary.file

This is the file where build summary is stored.

discouragedstring
build.system

This specifies which build system is used. Default for this is ebs You can use ec for Electric Cloud..

allowedstring
build.system.ebs

Defined if build.system is set to "ebs", which is the default.

neverstring
build.system.sbs

Defined if ${build.system} is set to "sbs".

neverstring
build.temp.dir

A directory for storing temporary build files.

neverstring
build.type

The general type of the build. This is used for checking the tools environment. Potential values include core, ido, product.

recommendedstring
build.version

Version of the build.

discouragedstring
cache.dir

Root directory where Helium can store files on a temporary basis for a user.

neverstring
call.cleanup

Ensures the cleanup-all target is called when the build finishes.

allowedstring
canonical.sysdef.file

The path of the generated canonical System Definition file that contains all the input System Definition file content.

neverstring
ccm.base.dir

Directory where CCM operations will be performed.

allowedstring
ccm.cache.xml

Location of the cache.xml file which enables global synergy sessions.

allowedstring
ccm.database

Name of the CCM database to use. No default value.

muststring
ccm.database.path

Path of the CCM database. No default value

discouragedstring
ccm.enabled

Defines that property if you want the ccm-get-input step to be run during the build area preparation.

allowedstring
ccm.engine.host

Engine host of CCM database. No default value.

muststring
ccm.home.dir

Home directory of CCM operations.

muststring
ccmgetinput

To check which ccmgetinput helium will be use

allowedstring
ccmtask.python.script.file

The path for the Python script to handle the ccm task bridge to the ccm.py module.

neverstring
ci.min.ba.maintain

Minimal number of build area to keep.

allowedstring
ci.project.config

Location of the configuration that will be generated for the Cruise Control HLMSynergy modificationset.

allowedstring
ci.session.file

Location of the session file which will be created by Helium.

allowedstring
cmaker.component.dir

Location of the cmaker component to install it.

neverstring
cmaker.config.dir

Directory where to execute cMaker.

discouragedstring
cmaker.pp.version

Version of PP(NCP) configuration to be exported

recommendedstring
cmaker.s60.version

Version of S60(require cmaker.pp.version to be set) configuration to be exported

recommendedstring
codescanner.config

Defines the location of a custom configuration for codescanner.

allowedstring
codescanner.format

Defines the format of Codescanner output (html|xml|std).

allowedstring
codescanner.log.unique

Defines if the folder for Codescanner output is unique (on|off).

allowedstring
common.overlay.dir

Location of the common overlay.

muststring
compile.signal.name

Name of the signal to be able to override the compile-main target.

neverstring
compile.symbianos

Property must be set if the Symbian System Definition file is included in a build, in order to do full build from source.

neverstring
compile.sysdef.dtd.stub

compile.sysdef.dtd.stub

neverstring
core.build.version

This Defaults to the ${major.version}.${minor.version} combo and is available so that 1 number can be used (dot can be removed)

allowedstring
core.rom.output.dir

/output/release_flash_images/rnd/core

muststring
create.bom.workarea.root

Your synergy work area directory (Set as the parent of the helium dir by default)

allowedstring
ctool.china.conf

configuration for the chinese variant.

allowedstring
ctool.dir

Location of the configuration tool.

allowedstring
ctool.japan.conf

configuration for the japanese variant.

allowedstring
ctool.region.china

.

neverstring
ctool.western.conf

configuration for the western variant.

allowedstring
current.env.config

Internal property used for environment setting in the beginning of the build.

neverstring
customer.makefile.target

Default makefile target for running customer iMaker ROM building.

neverstring
data.model.file

The data model XML file for the Ant configuration.

neverstring
data.model.parsed

The data model XML file for the Ant configuration parsed.

neverstring
data.model.xsl

Data Model extra content

allowedstring
database.file

Location of helium database

neverstring
delta.ant.file

Temp file

neverstring
delta.exclude.commasep

Comma seperated excluded directories from the zip

allowedstring
delta.zip.delete.file

Special Instructions file for SymDEC

neverstring
delta.zip.file

The zip file

neverstring
delta.zip.file.size

Define the file size of the zipped up released file, this is then used by delta zipping code to determine if a delta zip is required or a full zip should be created. The delta zip will only be published if it is less than 1/2 the size of this property

muststring
delta.zip.location

Output location

neverstring
delta.zip.temp.location

Temp location

neverstring
diamonds.build.id

The ID assigned to the build by the Diamonds server.

neverstring
diamonds.build.url

The full URL to the build entry on the Diamonds server.

neverstring
diamonds.compile.summary

Compilation summary file for diamonds.

neverstring
diamonds.host

Diamonds server's host address.

discouragedstring
diamonds.listener.configuration.file

Diamonds Configuration file with full path used for diamonds listener.

neverstring
diamonds.mail

Email address of diamonds server.

discouragedstring
diamonds.path

Diamonds server build location.

discouragedstring
diamonds.port

Diamonds server port number.

discouragedstring
diamonds.schema

Diamonds rest api schema.

discouragedstring
diamonds.target.list.to.log

List of targets that should be logged in to Diamonds.

discouragedstring
disable.analysis.tool

Set this property to disable Analysis Tool. By default Analysis Tool will run with every build and send api metrics to diamonds but Analysis Tools takes time.

allowedstring
documentation.host

The host server where the Helium documentation is stored.

neverstring
documentation.path

The full path on the host server where the Helium documentation is stored.

neverstring
documentation.path.root

The root of the path on the host server where the Helium documentation is stored.

neverstring
documentation.url.root

Root location of the Helium release documentation.

allowedstring
drop.file.counter

Drop package file counter. Updates its value automatically when a new drop file is created for ATS.

neverinteger
ec.allow.duplicates

Setting this to "1" will force xml2mak to generate only warnings (instead of errors) for duplicate components in the component list

discouragedstring
ec.build.class

Build class for Electric Cloud. No default value.

neverstring
ec.emake

Location of emake tool.

discouragedstring
ec.history.dir

This specifies the directory where Electric Cloud history files are stored. Currently defined in helium.ant.xml and mapped related to publish.root.dir

discouragedstring
ec.history.option

Should be create for single node build and merge for multi node build.

neverstring
ec.historyfile

Temporary location of the EC history file used by the current build.

discouragedstring
ec.makefile.file

Location of the Makefile generated to run the EC build.

discouragedstring
ec.maxagents

Maximum number of agent to be used

allowedstring
ec.mem.limit

memory limit for EC execution. See user guide for more details

neverstring
ec.mode

mode is either serial / parallel - default is parallel

allowedstring
ec.scripts.dir

ec scripts location

discouragedstring
ec.sysdef2make

Location of sysdef2make.pl file, which is used to translate system definition files to make files. Internal property that normally does not require changes.

neverstring
ec.tools.dir

Location of EC-tools. Passed to environment variable EC_TOOLS_DIR, when calling ecbuild_electric.cmd to execute Electric Cloud build.

discouragedstring
ee_roms.log.file

ee log file location

neverstring
ee.makefile.target

Defines make target that is run when creating engineer english images.

allowedstring
ee.rom.output.dir

/output/development_flash_images/engineering_english/logs

muststring
email.ldap.rootdn

Root distinguished name of the LDAP server.

allowedstring
email.ldap.server

Network address of the LDAP server.

allowedstring
email.smtp.server

Network address of the SMTP server.

allowedstring
enabled.aste

Value must be set to execute ats-aste target. for example, 'value="1"'

muststring
enabled.ats

Value must be set to execute ats-test target. for example, 'value="1"'

muststring
epocroot

epocroot path

discouragedstring
error.email.to.list

List of email addresses where email is sent in case of build failure. No default value

neverstring
eunit.prepare.zip

Name of eunit zip file. Need to unzip into build area to start eunit test

muststring
eunit.test.package

The EUnit package name to be unzipped on the environment, for executing EUnit tests."

recommendedstring
eunitexerunner.flags

Flags for EUnit exerunner can be set by setting the value of this variable. The default flags are set to "/E S60AppEnv /R Off".

muststring
exclude.test.layers

Comma seperated excluded test layers. The test components (mentioned in the excluded test layers) will not be included in the ATS test drops

allowedstring
ext.java.lib.dir

External ant library path

neverstring
failonerror

failonerror attribute for exec

neverboolean
file-comparison.bcomp_conf

Defines the location of Beyond Compare configuration file.

allowedstring
file-comparison.bcomp_path

Defines the location of BComp.exe.

allowedstring
file-comparison.left_name

Defines the name of the folder for the left side of comparison.

allowedstring
file-comparison.left_side

The fileset id used on the left side of comparison.

muststring
file-comparison.output

Defines the location where comparison output should be put.

allowedstring
file-comparison.regexp.from

Defines the regexp pattern (in ANT-pattern style) which to mach from given filesets.

allowedstring
file-comparison.regexp.to

Defines the regexp pattern (in ANT-pattern style) what to use in (possible) replacement.

allowedstring
file-comparison.right_name

Defines the name of the folder for the right side of comparison.

allowedstring
file-comparison.right_side

The fileset id used on the right side of comparison.

muststring
flash.config.enabled

Define that property to enable config file generation.

recommendedflag
genxml.output.file

Path for the output XML file generated by genxml used as input to EBS or EC.

neverstring
genxml.output.file.suffix

Suffix used in genxml related output files. This value is added into file names to show that they are genxml related. Used in log files, genxml output files and component list for EE images. Normally does not need to be set.

neverstring
getenv.tool.location

Defines the location of the getenv.pl script.

neverstring
helium.build.dir

The path where Helium-specific outputs are written to.

neverstring
helium.ccm.workarea.dir

The path to a Synergy work area used for updating Helium releases.

allowedstring
helium.dir

Defines the logical path to the helium directory used to start a build.

neverstring
helium.doc.dir

Location of helium doc src.

neverstring
helium.java.lib.dir

helium java library location

neverstring
helium.svn.url

SVN URL where to find Helium.

allowedstring
helium.svn.workarea.dir

The path to a Subversion work area used for updating Helium releases.

allowedstring
helium.version

Contains Helium version information

neverstring
hlm.enable.asserts

Enable helium asserts. Build will fail if this is enabled and asserts fail.

recommendedstring
ido.build.filter

Property is used to define ido build filters in the configuration file.

neverstring
ido.cenrep.root

Path to the cenrep root. Default value is "${build.drive}${env.EPOCROOT}/epoc32/tools/cenrep/ido/src"

neverstring
ido.cenrep.target

Path to the cenrep target directory. Default value is "${build.drive}${env.EPOCROOT}/epoc32/data/z/private/10202be9"

neverstring
ido.codescanner.config

Defines the location of a custom configuration for codescanner.

allowedstring
ido.codescanner.output.dir

Defines the location of Codescanner output.

recommendedstring
ido.codescanner.output.type

Defines the format of Codescanner output (html|xml|std).

allowedstring
ido.keep.old

Once define this property will enable the backup of old ado before doing the copy.

allowedstring
ido.romtree

Path to the build romtree; the location contains iby files. Default value is "${build.drive}${env.EPOCROOT}/epoc32/rom/include"

neverstring
ido.template.robot.ready

Location of the ready.txt FMPP template (override that property if you want to customize the content).

discouragedstring
image_creation.copyto

Path for copying the image files default is output/images

neverstring
image_creation.drive

Drive (environment) to use for creating images

neverstring
imagetool.cfg.xml.parsed

Locates the parsed configuration for ImageTool in the build directory.

neverstring
imagetool.destination

Location where to copy ImageTool and definitions.

allowedstring
imagetool.images

Defines comma separated list of image names.

allowedstring
imagetool.log

Defines name of the ImageTool log file.

neverstring
imagetool.output.dir

Defines the location of ImageTool output files.

neverstring
imagetool.tooldir

Defines the location of ImageTool.

neverstring
imaker.command

The path to the iMaker executable file.

neverstring
imaker.engine

Defines which accelerator to use for running iMaker. (default value from build.system property)

neverstring
imaker.fmpp.ant

Location of the Ant iMaker execution template.

neverstring
imaker.fmpp.makefile

Location of the EC iMaker execution template.

neverstring
internal.api.config

Location of the config to parse the build content.

allowedstring
internal.api.output.postbuild

Location of the postbuild ado header content.

allowedstring
internal.api.output.prebuild

Location of the prebuild ado header content.

allowedstring
is.published

The value is either true or false depending on whether the publish property is set or not.

neverstring
isis_mktarget.list

Comma separated list of file names(main, what, check file names)

neverstring
ivy.file

Location of ivy jar.

neverstring
ivy.filename

Name of ivy jar.

neverstring
last.major.helium.version

Last major helium version

neverstring
loc.output.dir

The directory that will contain the zipped .loc files zip package.

neverstring
loc.output.filename

The filename of the zip-loc-files target output zip file.

neverstring
loc.temp.dir

The location of temporary directory used during zip-loc-files.

neverstring
local.free.space

The amount of free space needed on the build machine in Mbs.

recommendedstring
localisation.buildfile

begining of the localisation buildfile name

neverstring
localisation.files.china

Localisation files for the China region.

recommendedstring
localisation.files.japan

Localisation files for the Japan region.

recommendedstring
localisation.files.western

Localisation files for the western region.

recommendedstring
localisation.language.file

Defined where to find languages.xml.

neverstring
localisation.makefile.target

Makefile target that is executed when creating localised rom images (target localisation-roms).

allowedstring
localisation.s60locfiles.dir

Location of Series 60 localisation input files. Internal property that does not normally needs to be set.

neverstring
localisation.tool

This key defines which tool should be used to localise the build area (localisation-mcss-localiser or localisation-s60-localiser).

neverstring
log.build.build_id

Diamonds logging information.

neverstring
log.build.category

Diamonds logging information.

neverstring
log.build.computer

Diamonds logging information.

neverstring
log.build.user

Diamonds logging information.

neverstring
log.target

Enables logging of the start and end of individual targets.

allowedstring
log4j.cache.dir

Log directory for log4j.

allowedstring
log4j.configuration

Defines the path to log4j configuration.

neverstring
logging.output.file

Location of generated logging config.

neverstring
major.version

Part of a version information that is used to differentiate a build. Major version is the part that changes less frequently. Ie. year.

allowedstring
md5.signature.file

Output location of md5 file

neverstring
md5.split

Number of partial md5 files to use during creation

neverstring
metadata.db.file

The path to the SQLite metadata database file.

neverstring
minor.version

Part of a version information that is used to differentiate a build. Minor version is the part that changes more frequntly. Ie week or a running number.

allowedstring
network.drive

The drive letter of a substed drive that maps to the network location where the build is published.

recommendedstring
network.free.space

Amount of free space in MBs needed on the network drive where the build is published. The ``network.drive`` drive property must also be defined.

allowedstring
notes.database

The Notes database to do DCT5 upload to.

recommendedstring
notes.release.dir

The DCT5 Release Notes SW Release Folder (where your build is Published to, so it can be obtained from there.)

neverstring
notes.server

Lotus notes server name

recommendedstring
number.of.threads

how many parallel threads can run

allowedstring
old.md5.file

A previous builds md5

allowedstring
old.md5.file.present

Is a previous builds md5 being passed manually

allowedstring
overlays.log.file

The path to the overlays output log file.

neverstring
parse_abld_what.tool

Location of the parse_what_log.pl tool.

allowedstring
prep.build.dir

This is the directory where the build area is prepared. Once created it is substed to the build.drive.

neverstring
prep.config.file

Defines configuration file used in prep-copy target. The file defines how files are copied and extracted into build area.

muststring
prep.delivery.file

Defines configuration file used in synergy operations (ccm-get-input for example). This file contains definition of projects that are checkouted or snapshotted.

muststring
prep.delivery.modificationset

Location where the XML modificationset file should be generated. If not defined the file is not generated. (Usefull for CI systems)

allowedstring
prep.root.dir

The directory where new build area directories are created and substed to the build drive.

recommendedstring
product.family

In product builds defines the product family that the build product belong to.

muststring
product.list

In product builds defines the list of products that are build in the configuration. Property is used in rom image creation, localisation release notes creation and data packaging.

muststring
product.printname

A printable name for a product used in release notes.

muststring
product.type

Project ID in release notes.

muststring
programlevel.release.tag

Program level release tag name

allowedstring
publish

Defines whether the build content will be published to the network.

recommendedstring
publish.base.dir

Directory where all builds are published. Same as publish.dir but without build.id at the end

neverstring
publish.ccm.folder

Synergy folder where you want your task to be published.

allowedstring
publish.dir

Directory where the build is published (includes build.id)

muststring
publish.fileset.ids

The fileset id which will be upload

allowedstring
publish.release.dir

The directory where the release of this build is published to on the local network.

neverstring
publish.release.subdir

Subdir part of the publish release dir, relative to publish.root.dir

neverstring
publish.root.dir

Defines the root directory of publish feature. Should point into the root of the folder that will contain published nightly builds/releases.

recommendedstring
publish.subdir

Subdir part of the publish dir, relative to publish.root.dir

allowedstring
python.modules.path

Python modules path.

allowedstring
qmake.enabled

If defined the qmake stage will be enabled during compilation.

allowedstring
qt.configure.args

The command lines argument passed to the configure tool.

allowedstring
qt.configure.log.name

The name of the Qt configure output log.

neverstring
qt.dir

The location of the Qt framework to build.

recommendedstring
qt.qmake.ant.template

The location of the ant template to run qmake commands.

allowedstring
qt.qmake.default.args

Setting default arguments to qMake command line, if the qmakeArgs is defined from the system definition file then those arguments are discarded.

allowedstring
read.build.int

This must be set to enable reading the build.number from a text database file located on the network. It allows automated build number incrementing.

allowedstring
release.dir.root

This is the directory which points to release-directory root.

neverstring
release.images.dir

The directory where flash images of build can be found

neverstring
releasenotes.logo

Defines the logo image file which will be used in release notes.

neverstring
releasenotes.output

Location of output rtf file

neverstring
releasenotes.output.dir

Defines the directory that will contain the output of release notes creation.

neverstring
releasenotes.props

Property file with customer values

neverstring
releasenotes.scan2log

Location of scan2log HTML file

neverstring
releasenotes.temp.errors

Temp file

neverstring
releasenotes.temp.output

Temp file

neverstring
releasenotes.temp.props

Temp file

neverstring
releasenotes.temp.props2

Temp file

neverstring
releasenotes.template

Defines the name of the release note template used.

neverstring
relnotes.config.dir

Defines the directory that contains release notes creation configuration files.

muststring
remote.builds.config.file

The path to the configuration file for remote builds.

neverstring
required.ant.version

The version of Apache Ant required by Helium.

neverstring
robot.email.to

Comma seperated list of email address.

discouragedstring
rombuild.buildinfo.output

Location of the output file.

neverstring
rombuild.buildinfo.template

FMPP template to generate a buildinfo makefile.

neverstring
rombuild.config.file

This key defines where this parsed file will be located.

muststring
rombuild.config.file.parsed

Locates the parsed configuration for ROM builds.

neverstring
rombuild.makefile.name

The filename of the output makefile generated by Helium for iMaker.

allowedstring
rombuild.using.var

Define this property if you build is using Symbian Binary Variation.

allowedboolean
roms.spec.name

Used to select spec-section in rom image configuration for building. Used only for makefpsx.

neverstring
s60.build.robot.date

This property represent the releasing interval. The syntax is as follow: day1,time1,day2,time2,projectname;day1,time1,day2,time2,projectname2

 With day and time matching the following properties: day [1, 14] time [00, 23]:[00, 59] Example: 2,10:00,3,20:00,ABS_domain
muststring
s60.build.robot.path

Location where to publish the build robot delivery.

muststring
s60.delta.config.prefix

Define the prefix part of the configuration name that builds delta variant.

allowedstring
s60.getenv.trigger.location

Define the location of the trigger file that should be used by CI.

allowedstring
sbs.config

Configurations for which the components to be built(armv5,winscw)

allowedstring
sbs.hlm.scanlog

Enable helium scanlog for raptor. (experimental temporary solution)

allowedboolean
sbs.implicit.tools.build

uses tools config to be built before building the actual configuration.

allowedboolean
sbs.tools.config

tools configuration to be built

allowedstring
selge.ini.network.dir

\\\\vcfiler02\\pub\\flash_user\\Crashbin/working\\selge_ini_prep

muststring
signals.buildexception.signalname

Name of the signal configuration that is used when a signal is fired after catching a BuildException failure.

allowedstring
sis.config.file

Configuration file for SIS-file generation.

recommendedstring
skip.ats.sending

Skips sending drop package file to ATS/ASTE after its creation.

allowedboolean
skip.build.duplicates

This allow you to skip the build duplciates log generation.

allowedboolean
skip.codescanner

Skip the codescanner target if true (true/yes/on).

allowedboolean
skip.compile-ec-patch

If defined it skips the buildtools emake patching.

allowedstring
skip.policy-validation

Skip the policy validation target if true (true/yes/on).

allowedboolean
sms.number

sms numbers to report error or build information.

neverstring
sms.server

Server that sends SMSs

allowedstring
src

Source location for junit test class

neverstring
src.classes

Java source files location for helium library

neverstring
src.dir

java source directory location for helium library

neverstring
subcon.build.drive

Build drive for subcon build

neverstring
subcon.log.file

The path to the subcon ROMs log.

neverstring
subcon.makefile.target

The name of the makefile target for making subcon ROMs.

neverstring
subcon.prep.config.file

Subcon prep configuration file location

muststring
subcon.rombuild.config.file

A ROM configuration file for verifying subcon ROMS.

neverstring
subcon.zips.dir

The directory where subcon zips are stored.

neverstring
sysdef.clean.configurations.list

Comma-separated list of System Definition configuration names to be built in the ido-prep-clean stage. If not defined the sysdef.configurations.list will be used to generate that configuration list.

allowedstring
sysdef.configurations.list

Comma-separated list of System Definition configuration names to be built in the compile-main stage.

muststring
team

Used to specify which team configuration is being used. These configuration files are under /mc/mc_build/teams.

recommendedstring
teamlevel.ci.system

Change release tag from team level to product level

allowedboolean
teamlevel.folder.number

Folder name which contains those tasks to change the release tag

allowedstring
temp.build.dir

Directory to store temporary files generated during the process.

neverstring
tools.ivy.config.file

The tools dependencies Ivy settings configuration file.

allowedstring
trace.log.file

The path to the trace ROMs log.

neverstring
trace.makefile.target

The name of the makefile target for making trace ROMs.

neverstring
tracing.csv.file

Path location for the memory tracing data captured by the TracingLogger.

neverstring
tsrc.data.dir

The default value is "data" and refers to the 'data' directory under 'tsrc' directory.

allowedstring
tsrc.path.list

Contains list of the tsrc directories. Gets the list from system definition layer files. Assuming that the test components are defined already in te layers.sysdef.xml files to get compiled. Not recommended, but the property value can be set if there are no system definition file(s), and tsrc directories paths to set manually.

allowedstring
uda.makefile.target

The name of the makefile target for making UDA images.

neverstring
unix.password

Unix password

neverstring
unix.password.available

Equal 0 if the unix password if available

neverstring
unix.username

Unix username.

neverstring
unix.username.available

Equal 0 if the unix username if available

neverstring
unsubst.after.build

Unsubsted drive after build finished. If not defined then helium should left the drive as subst. Set the value as "yes" if you want to unsubst after build finished.

allowedstring
validate.policy.csv

Location of the CSV file that defines policy IDs.

recommendedstring
validate.policy.ignoreroot

Skip the validation of the given root folders.

allowedboolean
validate.policy.log

Location validate policy xml log.

discouragedstring
validate.policy.log.xml

Location of the LogXML output file.

discouragedstring
validate.policy.pattern

Comma separated list of pattern for policy validation. Defualt value is, distribution.policy.s60,distribution.policy

allowedstring
validate.properties.at.startup

display warnings at build startup if required properties are not defined.

neverstring
variant.image.targetpath

Path for copying the variant image files default is under output/variant_images

neverstring
week.number

this is used to identify the history files based on releases

allowedstring
zip.config.file

Path to the the zip specification file

recommendedstring
zip.config.file.parsed

Path to the parsed file of zip specification file

neverstring
zip.ee.log.file

Defines log file where to record archiving of engineering english area.

neverstring
zip.localised.log.file

The path to the localization zipping log file.

neverstring
zip.subcon_roms.log.file

The log file name for zipping subcon_roms.

neverstring
zip.subcon.log.file

Defines log file where to record archiving of subcon environment.

neverstring
zip.trace_roms.log.file

The log file name for zipping trace_roms.

neverstring
zip.uda_roms.log.file

The log file name for zipping uda_roms.

neverstring
zip.wa.file

A unique name for the WA Sources ZIP file.

discouragedstring
zips.build.dir

This is the directory where build area is archived after the build has finished.

neverstring
zips.ee.spec.name

the value should be "ee"

allowedstring
zips.flashfiles.dir

This is the directory where flash files are archived.

neverstring
zips.loc.dir

This is the directory where build area is archived after the localisation.

neverstring
+ + +
+ + + + + + + + + + + + + +
+Helium API + +
+ + + Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html + + + +