Context Group: Framework

 

The Framework Context Group includes a number of parameters that are fundamental to the operation of the Talend Framework.

ParameterDefault
Value
Description
frameworkThis value is set by the Framework during initialisation and should not be modified.
debugfalseThis flag allows you to switch debugging on, or off. This flag may be used by the Framework and your own code.
enableShowContexttrueWhen Context is read from a file, the values may be written to the console output. Any values where the key contains the pattern "password", will be masked.
confirmExecutionfalseIf you are running your Jobs through Design Studio, or from a Command Propmt in foreground, you may optionally request that the user confirms execution of the Job. A simple Yes/No Dialog Box will be displayed. You should not use this option, if your Job is to be run in background, or placed on a schedule.
confirmExecutionMessageYou are exeucting the Job %s in the %s Context.\n\nAre you sure you want to continue?You may choose your own message, when requesting that the user confirms execution of the Job (see confirmExecution). You must provide place holders for the parameters jobName and contextStr.
enableLockFiletrueA lock file is a simple mechanism that prevents two instances of the same Job, from running at the same time. You may use thiss etting inconjunction with any Job Scheduling software that you may be using.
enableErrorOnLockFileExiststrueIf a Job runs, but a lock file already exists (see enableLockFile),this will be considered an error. There may be circumstances where you want the Job to silently close down, without reporting an error condition. In these instances, you may set this value to false.
deleteLockFileInHandledErrorfalseUnder normal operation, a Lock File (see enableLockFile) will be deleted in a Handled Error. You may choos to delete these. The default CHILD_RETURN_CODE for your own Job (see TemplateChild) is 0=SUCCESS or 4=ERROR. If you want errors in your own Job to be considered a Handled Error, you must exit with a return code of 1-3.
isHeadlessfalseAllows you to specify if the Job is being run headless. This flag should be set to true when the Job contains User Input Dialogs that you want to disable for headless operation.
enableJobExecutionReportingtrueOn completion of Job, the library Job LibJobReporting will be executed. This will report on all monitored statistics. This report is presented as an Excel Spreadsheet. If you do not use Excel, you may view this using Open Source products such as Libre Office.
enableEmailErrorReportingOnErrortrueIf an error is encountered during execution of your Job, the framework is able to send an alert via Email. You will beed to define the correct SMTP Email settings (see SendMail).
attachExecutionReportOnErrortrue
enableEmailOnSuccessfalseIf your Job executes successfully, the framework is able to send an alert via Email. You will beed to define the correct SMTP Email settings (see SendMail).
attachExecutionReportOnSuccesstrue
localiseArchiveDirtrueSpecifies if the Archive Directory (see archiveDir) should be localised.

Files placed in a localised directory are usually retained for a period of time, to allow for historical reporting and analysis.

This directory may be automatically localised to the instance of a Job execution, by appending a sub-directory to the path, consisting of the Job Name, together with the date and time of execution, for example: -

.../archive/MyJob.20151021.102251
localiseReportingDirtrueSpecifies if the Reporting Directory (see archiveDir) should be localised.

Files placed in a localised directory are usually retained for a period of time, to allow for historical reporting and analysis.

This directory may be automatically localised to the instance of a Job execution, by appending a sub-directory to the path, consisting of the Job Name, together with the date and time of execution, for example: -

.../reporting/MyJob.20151021.102251
archiveDirRetentionDays-1Specifies the number of days that archived files should be retained for. A negative number indicates that there is no pruning.

If archive directories have been localised (see localiseArchiveDir), then deletion will occur at directory level, rather than deleting individual files)
reportingDirRetentionDays90Specifies the number of days that reporting files should be retained for. A negative number indicates that there is no pruning.

If reporting directories have been localised (see localiseReportingDir), then deletion will occur at directory level, rather than deleting individual files)
outputDirRetentionDays-1Specifies the number of days that output files should be retained for. A negative number indicates that there is no pruning.
workingDirRetentionDays90Specifies the number of days that working files should be retained for. A negative number indicates that there is no pruning.
tmpDirRetentionDays7Specifies the number of days that temporary files should be retained for. A negative number indicates that there is no pruning.
logDirRetentionDays30Specifies the number of days that log and statistics file should be retained for. A negative number indicates that there is no pruning.
processingErrorRecipientSpecifies a delimited list of Email recipients, for receiving processing errors. This list may be delimited by either a comma or semi-colon.
systemErrorRecipientSpecifies a delimited list of Email recipients, for receiving system errors. This list may be delimited by either a comma or semi-colon. If a recipient is not provided, system errors will be reported to SendMail.sendMailTo.