Spool configuration

The spool configuration is set up in the file “cold.<SpoolName>.ini”, which defines all required steps from “Initialize” to “Cleanup”.

Examples of the “_LIMIT” parameters are also given in the chapter Restricting execution times.

SPOOL-#Number#

Nr.

Parameter

Example

0001

 

LogLevel

0

Can be from 0 to 2, where 2 stands for the most detailed log level

0002

 

eMailNotification

No

If set to “YES”, error and status messages are sent per e-mail to <eMailRecipients>.

0003

 

eMailRecipients

batch.processing.manager@t-systems.com

The recipient e-mail addresses to which error messages are sent (with many entries separated by a blank)

0004

 

eMailSender

batch.processing@yoursystem.com

The sender (“from”) that is used in e-mail messages. This can be mandatory for some e-mail servers, which reject to send messages if no valid e-mail address is given.

0005

 

eMailServer

127.0.0.1

IP address of the e-mail server that is used for sending messages

0006

 

eMailSubjectInfo

Error in pre-processing

The e-mail subject of an error message

0007

 

eMailHeaderLines

0

The number of rows before the error message in the e-mail, where the text for each row is defined via the parameters  <eMailHeaderLine_n> (“n” is an increasing integer)

0008

 

eMailFooterLines

0

The number of rows after the error message in the e-mail, where text for each row is defined via the parameters <eMailFooterLine_n> (“n” is an increasing integer)

0009

 

eMailHeaderLine_n

eMailHeaderLine_1=An error occurred in:

eMailHeaderLine_2=Spool <SpoolType> Gen. <Generation>

One line of text in the e-mail before the error message. An integer number “n” must be given, starting with 1 and being increased by 1 for each line.

0010

 

eMailFooterLine_n

eMailFooterLine_1=Do not reply to this e-mail.

One line of text in the e-mail after the error message. An integer number “n” must be given, starting with 1 and being increased by 1 for each line.

0011

 

eMailUseMailx

No

If set to “YES”, the console client “mailx” is used for sending e-mails. It must be present in the system path. For details also see [Wikipedia mailx].

By default (with value “No”) the Perl library “Net::SMTP” [Perl NetSMTP] is used.

If “Net::SMTP” is not available (e.g. in Perl 5.6.x), mailx must be used or the e-mail notification mechanism must be deactivated.

0012

 

<ScriptName>_Limit_DayOfWeek

1,2,3,4,5

Limits the execution of the script to certain weekdays, where multiple days separated by a comma can be given: 0=Sunday, 1=Monday,…, 6=Saturday

The given example limits the execution to every day from Monday until Friday.

Scripts with an execution limitation can temporarily assume the stage “Retry Later”.

0013

 

<ScriptName>_Limit_Hour

4-8,17-22

Limits the execution of the script to certain hours of the day, where several ranges with a dash can be given, separated by commas. (If you want to specify a range that includes midnight, you must split the definition, e.g. “23-24,0-4” represents an interval lasting from 11 pm till 4 am).

Scripts with an execution limitation can temporarily assume the stage “Retry Later”.

0014

 

<ScriptName>_Limit_
FilePattern
FileWorkDir
FileCount


^test[0-9]{3}.txt$
/input
>5

Executes the script only if certain files are present, where all parameters must be set:

  • FilePattern is a regular expression.

  • FileWorkDir is the working directory that is checked.

  • FileCount specifies the required number of files that must be present.

Comparison operators <, = and > are supported.

In the example above there must be at least 5 files in the directory “/input” complying with the pattern that matches filenames like “test000.txt”, “test001.txt”, …, “test999.txt” to trigger the script <ScriptName>.

Scripts with an execution limitation can temporarily assume the stage “Retry Later”.

0015

 

<ScriptName>_Limit_
MinTimeToLastExec

1440

Executes the script only if the last execution time dates back to at least the given number in minutes.

In directory <ColdLogsBaseDirectory>/<SpoolType> the file “lastExec_<ScriptName>.dat” is written, which contains a Unix timestamp that indicates the last execution time.

Scripts with an execution limitation can temporarily assume the stage “Retry Later”.

0016

eMailSubjectInfoWithScriptInfo

Yes

If this flag is set, the mail dump file is displayed in the e-mail subject. This is done even if this parameter is missing. This means that the parameter <eMailSubjectInfo> is extended. <eMailSubjectInfoWithScriptInfo> is mainly used for test purposes.

0017

XmlToolUseExternalProcessor

No

If this parameter is “No”, an internal processor is used for XML files. If the value is set to “Yes”, an external processor is used with the following command:

<XmlToolPath>/<XmlToolName> <XmlToolOptions>

The default is “No”.

Refer to the documentation of the JobModes to find out which requirements have to be met.

0018

XmlToolPath

 

Specifies the path to the XML tool to be used. This field can be left empty if the tool is located in the current path.

This parameter is only relevant if XmlToolUseExternalProcessor has the value “Yes”.

0019

XmlToolName

xsltproc

Specifies the tool to be used for processing XML files. The default is “xsltproc”.

This parameter is only relevant if XmlToolUseExternalProcessor has the value 'Yes'.

0020

XmlToolOptions

<XmlToolConfigurationFile> [FILE]

Specifies the options to be passed to the XML tool. The default is “<XmlToolConfigurationFile> [FILE]”.

This parameter is only relevant if XmlToolUseExternalProcessor has the value “Yes”.

For XmlToolOptions there are the following placeholders:

  • [FILE]: complete filename of the file to be processed

0021

CmdProcTemplateForReexecution

([COMMAND] | sed -e 's/^/stdout: /' ) 2>&1

In some use cases, the backtick operator is used for the execution of external commands to re-execute the command in case of an error to get STDERR.

More precisely, not the original command “any_cmd” but the following is executed:

(any_cmd | sed -e 's/^/stdout: /' ) 2>&1

If in exceptional cases it is necessary to change this behavior, the command template “CmdProcTemplateForReexecution” must be changed. If this is defined as empty, the re-execution is omitted.

The following placeholders exist for this field:

  • [COMMAND]: an (external) command that is executed again in case of an error to get STDERR

0022

XmlToolConfigurationFile

<ColdConfigDirectory>/preprocess/<SpoolType>.xsl

Specifies the configuration file for the XML tool. For XSL transformations this is usually a file with the extension “xsl”, and for XML schema validations a file with the extension “xsd” is used.

0030

eMailUseSecureSMTP No

If this parameter is set to true, the Perl library Net::SMTPS is used. If Net::SMTPS is not installed, another alternative must be used for sending e-mails or the sending of e-mails must be deactivated. Only if this method is selected for sending e-mails, the following parameters are relevant:

  • <eMailDoSSL>

  • <eMailAuthenUser>

  • <eMailAuthenPasswd>

  • <eMailAuthenMethod>

  • <eMailSSLoption1>, ...

0031

eMailDoSSL

starttls

This parameter is passed as a “doSSL” switch to the Net::SMTPS library. It specifies the SSL connection type (“ssl” / “starttls” / undef). The connection type “ssl” wraps connections with SSL, and “starttls” uses the SMTP command “STARTTLS”. See the Net::SMTPS documentation for more information.

0032

eMailSSLoption1

Port => 587

Dedicated SMPT protocol and SSL settings can be specified. One option of the form “Port => 587” can be specified per parameter <eMailSSLoption?>, where the “?” must be replaced by a consecutive number starting with “1”. Further information can be found in the documentation for Net::SMTPS and IO::Socket::SSL.

0033

eMailAuthenUser

 

This parameter contains the user required for SASL authentication. If the parameter is empty, no authentication is performed.

0034

eMailAuthenPasswd

 

This parameter contains the password required for SASL authentication.

0035

eMailAuthenMethod

CRAM-MD5

This parameter contains the method required for SASL authentication, such as “CRAM-MD5”, “LOGIN”, ... etc. If the specified method does not match a method offered by the server, the authentication can fail.

Table 91: Spool configuration parameters with spool number “SPOOL-#”