XMS Template Job Service

XMS Template Job Service
Prev	services	Next

Name

service

XMS Template Job Service — Generates emails from data provided by several sources

<service class="xms.template.XMSTemplateJobService" … > child tags </service>

Table 80. Attributes for service tag (for xms.template.XMSTemplateJobService)

Name	Description	Type	Default Value	Required
name	Sets a name for this job for reference	String any character combination	none	no

Service Dependencies

This tag depends on the following services (or a service that extends or implements these classes)

xms.management.XMSManagementService
xms.monitoring.MonitoringService
- XMS Monitoring Service

Child Tags

Template Job

<job … > child tags </job>

Table 81. Attributes for job tag (for xms.template.XMSTemplateJobService)

Name	Description	Type	Default Value	Required
addDate	Add a Date header if none exists	boolean true or false	true	no
addMessageID	Add a Message-ID header if none exists	boolean true or false	true	no
addReceived	Add a Received header	boolean true or false	true	no
charset	The character set to encode emails in	String any character combination	iso-8859-1	no
concurrency	Sets the number of threads that execute this job simultaneously	int any integer	1	no
hostMap	A String Map that maps local IPs to hostnames	StringMap Name of a StringMap as defined in StringMapService	none	no
hostname	Default fully qualified hostname of this machine	String any character combination	localhost	no
interval	Sets the interval in ms at which this service generates messages	int any integer	60	no
name	The name of this TemplateJob for reference	String any character combination	System assigned ID	no
retryImmediately	Poll again immediately if mails were sent	boolean true or false	false	no
target	Specifies the target spool for generated messages	Spool Name of a Service that implements Spool	none	no

Service Dependencies

This tag depends on the following services (or a service that extends or implements these classes)

xms.thread.ThreadPoolService
- XMS Thread Pool Service
xms.monitoring.MonitoringService
- XMS Monitoring Service
xms.dataservices.StringMapService
- XMS String Map Service

Child Tags

TemplateEngine

<engine class="class" … />

Classes Implementing xms.template.TemplateEngine

The following classes can be used in the class attribute for this tag:

Provider

<provider class="class" … />

Classes Implementing xms.template.Provider

The following classes can be used in the class attribute for this tag:

Filter

<filter class="class" … />

Classes Implementing xms.filter.Filter

The following classes can be used in the class attribute for this tag:

Example 75. Example configuration for XMS Template Job Service

Required attributes are marked with a bold typeface

<service class="xms.template.XMSTemplateJobService"
      name="name">
    <job addDate="addDate"
          addMessageID="addMessageID"
          addReceived="addReceived"
          charset="charset"
          concurrency="concurrency"
          hostMap="hostMap"
          hostname="hostname"
          interval="interval"
          name="name"
          retryImmediately="retryImmediately"
          target="target">
        <engine class="class" … />
        <provider class="class" … />
        <filter class="class" … />
    </job>
</service>