Skip to content

Commit 53a1dcf

Browse files
committed
Update doc for beta7
1 parent efe72ea commit 53a1dcf

File tree

4 files changed

+23
-6
lines changed

4 files changed

+23
-6
lines changed

doc/change-log.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ currentMenu: change-log
99

1010
__Features__
1111
* Add console client that can query the web API.
12+
* Allow parameters to be passed into a job that implement IParameterizedJob.
1213

1314
__Chores__
1415
* Add IInEngineClient interface to client project.

doc/integration-jobs.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ They are __Integration Job__, __Mail Job__, __Elasticsearch Job__, __Log Job__,
2121
* The interface has one argumentless method called _Run_ which is executed when the job is triggered.
2222
* All other jobs must implement _IIntegrationJob_ directly or indirectly.
2323

24-
### Mail Job
25-
26-
* Implement the _IMailJob_ interface to create a mail job.
27-
* The _MailClient_ property of the _IMailJob_ is automatically instantiated and configured with the mail settings in [IntegrationEngine.json](configuration.html).
28-
* The _MailClient_'s send method can be used to send an _System.Net.Mail.MailMessage_.
29-
3024
### Elasticsearch Job
3125

3226
* Implement the _IElasticsearchJob_ interface to create an Elasticsearch Job.
@@ -42,6 +36,18 @@ They are __Integration Job__, __Mail Job__, __Elasticsearch Job__, __Log Job__,
4236
* The _Log_ instance can be configured to log to a variety of [logging targets](logging.apache.org/log4net/release/features.html#appenders).
4337
* Messages and exception can be logged according to their [severity](http://logging.apache.org/log4net/release/manual/introduction.html#hierarchy).
4438

39+
### Mail Job
40+
41+
* Implement the _IMailJob_ interface to create a mail job.
42+
* The _MailClient_ property of the _IMailJob_ is automatically instantiated and configured with the mail settings in [IntegrationEngine.json](configuration.html).
43+
* The _MailClient_'s _Send_ method can be used to send a _System.Net.Mail.MailMessage_.
44+
45+
### Parameterized Job
46+
47+
* Implement the _IParameterizedJob_ interface to create a parameterized job.
48+
* The _Parameters_ property of the _IParameterizedJob_ is automatically instantiated and populated with the Parameters dictionary stored in the trigger that is used to schedule the job.
49+
* _Parameters_ can be used to configure the job in some way.
50+
4551
### SQL Job
4652

4753
* Implement the _ISqlJob_ interface to create a sql job.

doc/web-api/cron-trigger.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ The CronTrigger endpoint allows for an integration job to be scheduled by creati
2222
<tr><td>StateId</td><td><span class="label label-danger">int</span></td>
2323
<td>An integer identifier that sets the state of the trigger. Valid values are 0 (active) and 1 (paused).</td>
2424
</tr>
25+
<tr>
26+
<td>Parameters</td>
27+
<td><a href="https://msdn.microsoft.com/en-us/library/s4ys34ea%28v=vs.110%29.aspx">System.Collections.Generic.IDictionary<string,string></a></td>
28+
<td>A key/value object that is made available to integration jobs that implement the _IParameterizedJob_ interface.</td>
29+
</tr>
2530
<tr><td>CronExpressionString</td><td><span class="label label-info">string</span></td>
2631
<td>A valid <a href="http://en.wikipedia.org/wiki/Cron#CRON_expression">cron expression</a>.</td>
2732
</tr>

doc/web-api/simple-trigger.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ The SimpleTrigger endpoint allows for an integration job to be scheduled by crea
2222
<tr><td>StateId</td><td><span class="label label-info">int</span></td>
2323
<td>An integer identifier that sets the state of the trigger. Valid values are 0 (active) and 1 (paused).</td>
2424
</tr>
25+
<tr>
26+
<td>Parameters</td>
27+
<td><a href="https://msdn.microsoft.com/en-us/library/s4ys34ea%28v=vs.110%29.aspx">System.Collections.Generic.IDictionary<string,string></a></td>
28+
<td>A key/value object that is made available to integration jobs that implement the _IParameterizedJob_ interface.</td>
29+
</tr>
2530
<tr><td>RepeatInterval</td><td><a href="http://msdn.microsoft.com/en-us/library/system.timespan%28v=vs.110%29.aspx">System.TimeSpan</a></td>
2631
<td>Time interval at which the trigger should repeat.</td>
2732
</tr>

0 commit comments

Comments
 (0)