Previous Topic: UserInfo - Will Set User Information for the Computer TargetsNext Topic: COF Section Locale


COF (Container Order File) Format

The container order file, COF (.cof), is divided into the following sections:

Locale
	codepage=
Container
	Name=
	Password=
	Type=
	Transaction=
	OrderedBy=
	CreationTime=
	ManagerAddress=
	ResultDirectory=
	NumberOfJobs=
	NumberOfLibraries=
	BackgroundProcess=
	ShowProgress=
	Status=
	StatusMessage=
	CompletionTime=
	Secure=
	Validate=
	Hash=
	UserName=
	DomainName=
	Job_1
	Library_1
Locale
codepage=

This parameter is optional.
If codepage is not specified, SecureContainer will set it to 3.
The possible values are
1=ANSI
2=OEM
3=UTF8, or
any code page supported by the current system for example 850.

Container
Name=

Name of the container for log and output.
The name is, by default, the COF file name.

Password=

The password is used to protect the COF file.
The parameter is optional. If given, the value will be encrypted, when executing the SecureContainer command.
The parameter can also be supplied using the command SecureContainer with the optional - p: argument. In that case, the value in the command overrides the value supplied here.

Type=

This parameter denotes the container type.
Valid values are:
0 No Linkage
1 Reserved
2 Batch

Default: 0

Transaction=

This parameter denotes if transaction is used or not for the jobs in the container. It is only applicable to Software Management (SM) batch containers.
Valid values are:
0 False (not used)
1 True (used)

Default: 0

OrderedBy=

This parameter is optional and provides an account name, for example, DomainX\UserY.
Default: Current user running the SecureContainer command.

CreationTime=

(Optional) Specifies the create date and time for the container in the format YYYY-MM-DD hh:mm, where YYYY is the year, MM is the month, DD is the day, hh is the hour, and mm is the minute.

ManagerAddress=

(Optional) Provides the address to the domain manager. If no value is provided, the default value is taken from “currentmanageraddress” in the Common Configuration.
This parameter is used to replace the $csa macro.

ResultDirectory=

This parameter is optional and provides the full path to the output directory.
It can be overridden by the Output Directory parameter value when running ExecuteContainer from the command line.

NumberOfJobs=

This parameter is required. It provides the number of job sections to follow in the COF file.
The default value is 1.
Note: If the value is 1, there should be only one Job section, Job_1. If the value is 2, there should be two sections, Job_1 and Job_2, and so on.

NumberOfLibraries=

This parameter is required. It provides the number of library sections to follow in the COF file.
The default value is 1.
Note: If the value is 1, there should be only one Library section, Library_1. If the value is 2, there should be two sections, Library_1 and Library_2, and so on.

BackgroundProcess=

This parameter states if jobs are to be processed in the background.
Valid values are:
-1 Use the value in the associated procedure
0 No
1 Yes
The default value is -1.
Note: Value in the associated procedure is background if the $#bg macro is used or not background if no macro is supplied.

ShowProgress=

This parameter states if the progress dialog is to be shown or hidden.
Valid values are:
0 No,
1 Yes
The default value is 1.

Status=

This parameter denotes the status of container execution.
Valid (ENU-) values are:
0 OK
1 At least one job failed.
2 Not processed.
3 COF in progress.
4 Reboot initiated.
5 Log off initiated.
6 No COF file.
7 General error reading the COF file, the file might have been tampered with.
8 Password supplied is invalid.
9 The COF file is not secured.
OUT; that is, the parameter value is output in the file *.crf in the supplied results directory.

StatusMessage=

This parameter provides status text, like a native OS message.
The value corresponds to the value of the Status parameter.
OUT; i.e., the parameter value is output in the file *.crf in the supplied results directory.

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.

Secure=

The value of this parameter is set to 1 by executing the sd_acmd SecureContainer command.
OUT; i.e., the parameter value is output in the file *.crf in the supplied results directory.

Validate=

Encrypted value used to validate COF password. Created by sd_acmd ExecuteContainer and removed when processing is finished.

Hash=

Only valid in conjunction with -v. Forces the change to the configuration, if SDPing should fail.

UserName=

This parameter will be inserted when running ExecuteContainer. It provides the currently logged on user.

DomainName=

This parameter will be inserted when running ExecuteContainer. It provides the domain to which the current user logged on, if any.

Job_n

For details, see description of Job section.

Library_n

For details, see description of Library section

Example of COF Files

The following examples of cof files are the smallest possible, using all default settings.

COF file for use of network library

[Container]
NumberOfJobs=1
NumberOfLibraries=1

[Library_1]
Type=1
Path=\\THE_SERVER\SDLIB

[Job_1]
SoftwareName=SuperOffice for Win2000
SoftwareVersion=7.1 ENU (I386)
ProcedureName=InstallSO


COF file for use of CD library

[Container]
NumberOfJobs=1
NumberOfLibraries=1

[Library_1]
Type=2
Path=Lib
Label=001229_1045

[Job_1]
SoftwareName=SuperOffice for Win2000
SoftwareVersion=7.1 ENU (I386)
ProcedureName=InstallSO

Note: A template file, template.cof, is present in the CONF directory (%SDROOT%\ASM\CONF for Windows environment, $SDROOT/asm/conf for UNIX).

Note: There can be more than one Job and Library type section of .In such case these sections are labeled Job_2, Library_2, and so on.

Important! When you are using a text editor to create the COF you need to choose the appropriate coding when saving the COF. That is, you have to check if the current code page of your computer supports all the character you have used. If not choose the appropriate one with the codepage= parameter.

For example, if you use German umlauts, you have to choose UTF-8 (assuming codepage 3).

If codepage is not specified, SecureContainer will set it to 3.