Property Files

Project

A simple text file ( project.properties ) can be created in the root folder of each project to specify properties (or preferences) to be used by contributed tools or to override a Eclipse preference or project property setting.

Workspace

A simple text file ( workspace.properties ) can be created in the root folder of the Workspace to specify properties (or preferences) to be used when a property file has been defined for a project.

Any property value that represents an operating system path must use '/' character instead of '\'.

Project Properties

AltExe_EnvironmentPropertyFile

Set the name of a properties file containing name/value pairs to use to set environment variables when initializing the operating system process running the alternate executable to build files.

If the filename has no path, will look for the file in the project root folder. If it is not found, this property will be ignored.

AltExe_DebugShowEnvironmentData

Set to 'true' or '1' to show the environment data when option to show debug information is enabled. Otherwise, do not include in the project properties file or set to 'false' or '0' to not display this information. The default is to not display this information.

ForceDestinationName

Override the destination name for a resource with a value that is based on the name of the source file.

forceResource.<Filename>

Assign a BOOLEAN value to force the file to be handled as a resource - do not attempt to compile the file.

forceResourceDir.<ProjectPathToFile>

Assign a BOOLEAN value to force all files in the specified folder to be handled as resources - do not attempt to compile any of the files in the folder.

LogErrorScan

Create a log file for any messages generated by the 'ErrorScan' phase of the build process.

NOMADS_AltExe

A full path to a ProvideX executable to be used for all NOMADS sessions launched for a resource in the project; (Use "/" characters in the path). The path will be verified to be a valid ProvideX executable before it is used. If the validation fails, the first executable found from the following list will be used:

• NOMADS executable for the workspace
• ProvideX executable for the project
• ProvideX executable used by the workbench

NOMADS_ExtDictDir

A folder outside of the project workspace to be used as the location of the ProvideX data dictionary files (Use "/" characters in the path). The file 'PROVIDEX.DDF' must exist in this folder, otherwise, the value of this property will not be used.

NOMADS_xml_export

Enable the prototype feature to create XML files from NOMADS library files.

overrideProperty.pathPreference

Full path to an alternate ProvideX executable to use for actions performed for files in the project/workspace (Use "/" characters in the path)

Any contributed tools triggered as pre/post process events for the build process will execute in the ProvideX environment associated with the workbench.

SetSysParamAI

set the Auto-Increment value; any value outside of the range 1 - 25 will be ignored

StripLeadingWhiteSpace

Strip all leading white space (TABs and spaces) when joining the lines from the source file to create a program line; this may introduce errors in compiled programs if there is not a space before the line continuation character at the end of the source line.

UseLineNumberIncFromAI

set to any value to override the Line Number Increment builder preference and force the use of the 'AI' system parameter value

Preferences

The project/workspace specific properties files can append to string preferences, override the current value of a boolean or string preference, or set a new default to be used for a boolean or string preference.

Append to Preference Value

To append to the value of a string preference, prefix the internal name for the preference with 'appendPreferenceS' and assign a value or list of values to add to the current value of the system preference.

Override Preference

To override the value of a preference, prefix the internal name for the preference with 'overridePreferenceB' or 'overridePreferenceS', depending on the data type of the preference, and assign the new value or override the current value of the system preference.

A Boolean preference can be set to either true or false while a String preference is set to a text value based on the definition of the preference.

Set Default for a Preference

To define the default, prefix the internal name for the preference with 'defaultPreferenceB' or 'defaultPreferenceS' depending on the data type of the preference.

If the preference has already been set, or is changed later, this default value will not be used.

Preferences: Keywords

The values of many preferences can be set in either a project or workspace properties file using the keywords below except where highlighted.

The following sample properties file shows how to use these keywords.

# Force values for preferences
# makes the Eclipse environment for the project consistent for all users
overridePreferenceB._bDebug=false
overridePreferenceB._BtiEnable=false
overridePreferenceB._BuildMaintainCase=true
overridePreferenceB._CheckBinaryDataInFileHeader=true

# Add to list of file extensions for resource files
appendPreferenceS._CommonResourceFileExtensions=bat bin cab cat chm cmd csv log manifest xls xml xsd zip

# Force specific contributed tools to be enabled or disabled 
# (prefix contributed tool class name with an underscore)
overridePreferenceB._extObserver_masStyleCheck=false
overridePreferenceB._extObserver_simpleStyleCheck=true

# Additional file extensions to identify NOMADS libraries
appendPreferenceS._NOMADS_Default_Suffix=M4L LIB

# Force alternate startup program to initialize the build environment
overridePreferenceB._UseStartUp=true
overridePreferenceS._AltStartUp=C:/Dev/Work/ContribTools/CustABL/alt_startup.pvx

Next Section: Preferences - ProvideX Event Manager