1.5 sos.ini

The SOS licence keys are written in the sos.ini file.

Further, general settings for Java or e-mail are made here. Java settings can also be made in the factory.ini file, in the [java] section.

When calling the Job Scheduler from the command line, the path to the file can be specified using the -sos.ini option. For example,

…scheduler installation path…\bin\scheduler.exe -sos.ini=C:/Programme/scheduler/config/sos.ini

During installation of the Job Scheduler, the sos.ini file is written to the

…scheduler installation path…\config

Should settings in the sos.ini file also be used in other products from the SOS GmbH., then this file can be saved centrally.

Should the sos.ini file not be specified when starting the Job Scheduler, then the Scheduler will attempt to find it by looking according to the following criteria:

This file should be saved under Windows in the folder in which Windows expects to find the .ini files. Normally this is the c:\windows folder. Otherwise the file will be sought in the users' home directory.

Settings

Section: java

class_path = file_names Java class path

The Java CLASS_PATH setting is made here. This is a list of paths - on Windows Systems these paths are separated by semi-colons (;), on Unix systems by colons (:).

Note that jokers can be used in these paths. The Job Scheduler then replaces these jokers with the respective file names. i.e. those existing in the file system.

• On Windows systems, the * and ? characters may be used after the last directory separator.
• On Unix systems the [ and ] characters can also be used. Jokers can be used in every folder name of a path (as in the csh shell).
• Linux (GNU) also recognizes the {,} characters, when used in the following syntax:
  "xxx { alternative1 , alternative2 ,...} xxx", e.g. /dir/sos.{hostware,mail.spooler}.jar.

The following points apply to every path in the class_path:

• A path without a joker will be handed over to Java unchanged.
• A path containing a joker will be converted to the existing path before being handed over.
• Should no path corresponding to a joker be found then the path will be ignored.
• A path will also be ignored should it refer to a directory which cannot be read.
• Environment variables (e.g. ${HOME}) will be replaced before a path is converted.

These settings are generally made in the sos.ini (section [java], entry class_path= …) file.

class_path = s:\prod\bind\sos.*.jar;c:\jar\my.jar;c:\jar\*

Environment variables (e.g. $HOME) are replaced by this attribute (see Settings which Allow Environment Variables to be Called).

<config java_class_path="…"> is overwritten by this parameter.

debug = yes_no

debug=yes causes the Java call to be entered in the scheduler.log file. This setting also sets Java in the debug mode, whereby, for example, an exception causes the call stack to be written to stdout (or stderr).

javac = path Path to the Java compiler

This setting is used to specify the path to the Java compiler. The Job Scheduler uses this compiler when quell code is directly written in the <script> element, for example, when developing Java jobs

options = text Java options

This setting specifies the directory in which the HostJava is installed - e.g. -Djava.library.path=.

These options are passed to the Java Virtual Machine.

These settings are generally made using sos.ini (section [java], entry options= …).

options = -Xdebug -Djava.library.path=s:/prod/bind

Environment variables (e.g. $HOME) are replaced by this attribute (see Settings which Allow Environment Variables to be Called).

<config java_options="…"> is overwritten by this parameter.

vm = file_name Java Virtual Machine File Name

The default settings are jvm.dll for Windows, jvm.sl for HP-UX and jvm.so for all other UNIX variants.

The Windows preset value is read out of the registry. The CurrentVersion entry, which contains the current version number (such as "1.5"), is read from the

HKEY_LOCAL_MACHINE\software\JavaSoft\Java Runtime Environment

key. The version key - e.g.:

HKEY_LOCAL_MACHINE\software\JavaSoft\Java Runtime Environment\1.5

is then read and the path to the jvm.dll file taken from the RuntimeLib entry.

Section: licence

key1 = licence_key Licence Key

Users with more than one licence key can enter subsequent keys using key2=, key3= etc.. Note that the numbering must be without spaces.

Section: mail

queue_dir = directory Directory for e-mails which temporarily cannot be sent

E-mails which cannot be sent (because, for example, the SMTP server cannot be contacted) are stored in this directory.

In order to send these e-mails later it is necessary to write a job which calls up the Mail.dequeue() method.

This setting is generally made in sos.ini (section [mail], entry queue_dir= …).

Environment variables (e.g. $HOME) are replaced by this attribute (see Settings which Allow Environment Variables to be Called).

The factory.ini (section [job], entry mail_queue_dir= …) setting has precedence over this parameter.

The factory.ini (section [spooler], entry mail_queue_dir= …) setting has precedence over this parameter.

queue_only = yes|no Do not send e-mail, add it to the e-mail queue

When this parameter is set to yes, then e-mails are sot sent but added to the e-mail queue - see sos.ini (section [mail], entry queue_dir= …).

This setting is generally made in sos.ini (section [mail], entry queue_only= …).

The factory.ini (section [spooler], entry mail_queue_only= …) setting has precedence over this parameter.

smtp = host_address E-mail SMPT server hostname or IP number

These settings are generally made using sos.ini (section [mail], entry smtp= …).

smtp=-queue stops e-mails being sent. Instead mails are written into the file specified in queue_dir. See also sos.ini (section [mail], entry queue_only= …).

The factory.ini (section [job], entry smtp= …) setting has precedence over this parameter.

The factory.ini (section [spooler], entry smtp= …) setting has precedence over this parameter.