@@ -227,12 +227,64 @@ job.enabled=true
227227# set to "NONE" then it is assumed that there is no end state which also means the consumer can always alter the job.
228228job.endStates =
229229
230+ #
231+ # This property indicates if events caused by a consumer operation shall be published to that consumer. If it is set to true
232+ # then consumer caused events will be published. If set to false only events caused by provider operations will be published.
233+ # This will be the default for most cases. If a specific behaviour is required for a particular functional service provider
234+ # then this property can be set for each provider individually by adding ".<serviceName>" at the end of this property.
235+ # I.e. job.event.includeConsumerRequested.RolloverStudents=true. The <serviceName> is the name of the service
236+ # as defined by the functional Service URL and not the class name of the implementation class.
237+ # Default: false
238+ job.event.includeConsumerRequested =true
239+
240+ # This property lists a number of zone|context for which a functional service event must be published, regardless
241+ # of the originator (consumer) who created the job. Generally events are only sent to the originator of the job but the
242+ # SIF3.x specification also allows events to be sent to specific other consumers that have the permission to get job events.
243+ # These are generally "auditing" zones that needs to capture all job activities. This property can specify to which
244+ # additional zone|context a job event is sent. Because it is possible that there are more than one auditing style zones
245+ # this porperty allows for a comma separated list of zone|contexts. Further if a specific behaviour is required for a
246+ # particular functional service provider then this property can be set for each provider individually by adding \
247+ # ".<serviceName>" at the end of this property. I.e. job.event.auditZones.RolloverStudents=abc|DEFAULT. The <serviceName>
248+ # is the name of the service as defined by the functional Service URL and not the class name of the implementation class.
249+ #
250+ # The exact EBNF notation is: <zoneId>[|<contextId>]{,<zoneId>[|<contextId>]}
251+ #
252+ # If the contextId is not given then DEFAULT is assumed.
253+
254+ # Example: zoneABC|contextXYZ,zoneEFG
255+ # For the above example the job events will all be sent to zone 'zoneABC' with context 'contextXYZ' and zone 'zoneEFG' and
256+ # context 'DEFAULT' (note that context is not set for second zone so the DEFAULT context is used.
257+ #
258+ job.event.auditZones =
259+
230260#
231261# If eventing is enabled then job related events, which are maintained within the framework, will be published at the frequency (in
232262# seconds) given in this property. If not set then the default of 15 minutes is used (900 seconds). To turn off job events then
233- # this property can be set to 0.
263+ # this property can be set to 0. If a different frequency is required for each provider then this property can be set for each
264+ # provider individually by adding ".<serviceName>" at the end of this property. I.e. job.event.frequency.RolloverStudents=600.
265+ # The <serviceName> is the name of the service as defined by the functional Service URL and not the class name of the
266+ # implementation class.
267+ # Default: 900 (15 minutes)
234268job.event.frequency =300
235269
270+ #
271+ # Once a provider is started a delay might be required before events shall be published. This delay is set here in seconds. If not set or
272+ # provided then the default will be 5 seconds. If a different delay is required for each provider then this property can be set for each
273+ # provider individually by adding ".<serviceName>" at the end of this property. I.e. job.event.startup.delay.RolloverStudents=30.
274+ # The <serviceName> is the name of the service as defined by the functional Service URL and not the class name of the
275+ # implementation class.
276+ # This value is in seconds. If the value cannot be set to less than 5 seconds. If it is set to less then it will be defaulted to 5 secs.
277+ #
278+ job.event.startup.delay =5
279+
280+ #
281+ # This property indicates what the maximum number of job objects per SIF Event message should be. This value is defaulted to 10 if not set.
282+ # It can be overridden programatically by an implementer if required. It can also be set at the provider level by adding ".<serviceName>"
283+ # at the end of this property. I.e. job.event.maxObjects.RolloverStudents=25 The <serviceName> is the name of the service as
284+ # defined by the functional Service URL and not the class name of the implementation class.
285+ # Default: 10
286+ job.event.maxObjects =3
287+
236288#
237289# Internally the framework keeps a change log for jobs, so that either events can be published or "changes since" can be supported.
238290# This property indicates how far back in days the change log shall be kept. Any changes older than that will be cleaned up regularly
0 commit comments