Previous Topic: COF Section LocaleNext Topic: COF Section Container


COF Section Job

There is one (Job_1) or more sections (Job_2 and so on) with this name in the COF file. It contains the characteristics of an individual job in the job container.

Name=

This parameter provides names of the job for logging and output.
The default values are SoftwareName and ProcedureName.

Example:
SW:SuperOffice for Win2000 Proc:InstallSO
SoftwareName=

This parameter provides the name of the software package (as found in properties for the software).

Example:
SuperOffice for Win2000
SoftwareVersion=

This parameter provides the version of the package (as found in properties for the software).

Example:
7.1 ENU (I386)
ProcedureName=

This parameter provides the name of the procedure (as found in properties for the procedure) used for the job.

UserParameters=

This parameter value is used if the $up macro is present (enabling setting UserParameters here) in the associated procedure.
It is optional.
The default value is an empty string.

BootBefore=

This parameter specifies whether the target computer is to be rebooted before the job activation, and at what level this should be done.
Valid values are:
-1 Use procedure default
0 No
1 Reboot
2 Logoff
The default value is -1.
This parameter only applies to Windows NT / 2000 and Windows 9x / ME.

BootAfter=

This parameter specifies whether the target computer is to be rebooted after the job activation, and at what level this should be done.
Valid values are:
-1 Use procedure default
0 No
1 Reboot
2 Logoff
4 Reboot after the last job
8 Log off after the last job
The last two values are only of relevance if several jobs are linked together in a job container.
The default value is -1.
This parameter only applies to Windows NT / 2000 and Windows 9x / ME.

ExecutionTimeOut=

This parameter specifies the timeout value for job processing (in minutes).
Valid values are, by default, in the range 1 - 71582.
The default value is 120.

ExecutionTimeoutAction=

This parameter specifies the action to take if the timeout value above elapses.
Valid values are:
0 No action
1 Kill process
The default value is 0.

PromptRemovable=

This parameter specifies whether a prompt for media should occur, if the media is not inserted.
The parameter is only valid if the Type parameter in the associated Library section has the value 2.
Valid values are:
0 No (try next library if the device not present)
1 Yes
The default value is 0.

LogonShield=

This parameter specifies whether the logon shield should be activated.
The parameter is only applicable if the agent policy is set to “per job” (that is, the logon shield procedure Enable per job has been executed in advance on the target computer).
Valid values are:
0 No
1 Yes
The default value is 0.
This parameter only applies to Windows NT / 2000.

LibrarySearchOrder=

This parameter specifies a comma-separated list of indexes that identifies the library section search order.
This parameter is optional.
If no value is supplied, the search order is, by default, 1 if there is only a Library_1 section. It is 1,2 if there are Library_1 and Library_2 sections, and so on.

CompletionTime=

This parameter denotes the job container completion time.
It has the structure YYYY-MM-DD hh:mm (year-month-date hour:minute), for example 2001-04-09 15:34:52.
OUT; i.e., the parameter value is output in the file *.crf in the supplied results directory.

ExitCode=

This parameter stores the exit code supplied by the executable file referred to by the procedure.
OUT: the parameter value is output in the file *.crf in the supplied results directory.

ReturnCode=

This parameter stores the exit code supplied by the executable plug-in SD_JEXEC.
Valid values are:
0 OK
1 Error
2 Not executed
OUT: the parameter value is output in the file *.crf in the supplied results directory.

ErrorMessage=

This parameter stores the error text provided. It could be, for example, a native OS message.
OUT: the parameter value is output in the file *.crf in the supplied results directory.

ResultFileIn=

This parameter stores the desired name of the result file, which is generated automatically if the $rf macro is used in the associated procedure.
The path to the file will be the path that is specified by the ResultDirectory parameter in the Container section.

ResultFileOut=

This parameter stores the full path with file name to the output/log file, which is generated automatically if the $rf macro is used in the associated procedure.
OUT: the parameter value is output in the file *.crf in the supplied results directory.

Reinstall=

This parameter specifies whether the job should be a reinstall job or not.
Valid values are:
0 No
1 Yes
Default: 0