@sap/async-xsjs 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +37 -0
  3. package/README.md +445 -0
  4. package/differences.md +162 -0
  5. package/docs/$.Application.html +262 -0
  6. package/docs/$.Session.html +674 -0
  7. package/docs/$.db.CallableStatement.html +2524 -0
  8. package/docs/$.db.Connection.html +511 -0
  9. package/docs/$.db.ParameterMetaData.html +805 -0
  10. package/docs/$.db.PreparedStatement.html +1796 -0
  11. package/docs/$.db.ResultSet.html +1308 -0
  12. package/docs/$.db.ResultSetMetaData.html +800 -0
  13. package/docs/$.db.SQLException.html +259 -0
  14. package/docs/$.db.html +773 -0
  15. package/docs/$.hdb.ColumnMetadata.html +438 -0
  16. package/docs/$.hdb.Connection.html +663 -0
  17. package/docs/$.hdb.ProcedureResult.html +280 -0
  18. package/docs/$.hdb.ResultSet.html +324 -0
  19. package/docs/$.hdb.ResultSetIterator.html +315 -0
  20. package/docs/$.hdb.ResultSetMetaData.html +259 -0
  21. package/docs/$.hdb.SQLException.html +259 -0
  22. package/docs/$.hdb.html +557 -0
  23. package/docs/$.html +471 -0
  24. package/docs/$.jobs.Job.html +783 -0
  25. package/docs/$.jobs.JobLog.html +380 -0
  26. package/docs/$.jobs.JobSchedules.html +852 -0
  27. package/docs/$.jobs.html +238 -0
  28. package/docs/$.net.Destination.html +304 -0
  29. package/docs/$.net.Mail.Part.html +510 -0
  30. package/docs/$.net.Mail.html +504 -0
  31. package/docs/$.net.SMTPConnection.html +347 -0
  32. package/docs/$.net.html +749 -0
  33. package/docs/$.net.http.Client.html +562 -0
  34. package/docs/$.net.http.Destination.html +237 -0
  35. package/docs/$.net.http.Request.html +567 -0
  36. package/docs/$.net.http.html +292 -0
  37. package/docs/$.security.AntiVirus.html +361 -0
  38. package/docs/$.security.Store.html +636 -0
  39. package/docs/$.security.crypto.html +414 -0
  40. package/docs/$.security.html +247 -0
  41. package/docs/$.security.x509.html +373 -0
  42. package/docs/$.text.analysis.Session.html +983 -0
  43. package/docs/$.text.analysis.html +242 -0
  44. package/docs/$.text.html +246 -0
  45. package/docs/$.text.mining.Session.html +2018 -0
  46. package/docs/$.text.mining.html +242 -0
  47. package/docs/$.trace.html +525 -0
  48. package/docs/$.util.SAXParser.html +955 -0
  49. package/docs/$.util.Zip.html +474 -0
  50. package/docs/$.util.codec.html +414 -0
  51. package/docs/$.util.compression.html +357 -0
  52. package/docs/$.util.html +325 -0
  53. package/docs/$.util.sql.html +290 -0
  54. package/docs/$.web.Body.html +333 -0
  55. package/docs/$.web.EntityList.html +296 -0
  56. package/docs/$.web.TupelList.html +496 -0
  57. package/docs/$.web.WebEntityRequest.html +393 -0
  58. package/docs/$.web.WebEntityResponse.html +392 -0
  59. package/docs/$.web.WebRequest.html +560 -0
  60. package/docs/$.web.WebResponse.html +609 -0
  61. package/docs/$.web.html +246 -0
  62. package/docs/Copyright-SAP.html +39 -0
  63. package/docs/Disclaimer-SAP.html +55 -0
  64. package/docs/index.html +232 -0
  65. package/docs/styles/jsdoc-default.css +382 -0
  66. package/lib/AppConfig.js +36 -0
  67. package/lib/AuditLogger.js +41 -0
  68. package/lib/cacert.js +26 -0
  69. package/lib/ctypes.js +153 -0
  70. package/lib/destinations/dest-provider.js +57 -0
  71. package/lib/index.js +235 -0
  72. package/lib/jobs/Action.js +40 -0
  73. package/lib/jobs/Job.js +100 -0
  74. package/lib/jobs/JobManager.js +150 -0
  75. package/lib/jobs/JobsRuntime.js +133 -0
  76. package/lib/jobs/SqlScriptJobRunner.js +36 -0
  77. package/lib/jobs/XsjsJobRunner.js +78 -0
  78. package/lib/jobs/index.js +11 -0
  79. package/lib/logging.js +16 -0
  80. package/lib/middleware.js +125 -0
  81. package/lib/odata/ODataService.js +125 -0
  82. package/lib/odata/index.js +7 -0
  83. package/lib/odata/service-factory.js +26 -0
  84. package/lib/passport-noauth.js +17 -0
  85. package/lib/routes.js +115 -0
  86. package/lib/runtime.js +740 -0
  87. package/lib/sandbox.js +40 -0
  88. package/lib/utils/XsJsFunctionRunner.js +57 -0
  89. package/lib/utils/XsJsLibFunctionRunner.js +57 -0
  90. package/lib/utils/buffer-utils.js +77 -0
  91. package/lib/utils/compression-utils.js +14 -0
  92. package/lib/utils/date-utils.js +104 -0
  93. package/lib/utils/errors/HttpError.js +20 -0
  94. package/lib/utils/errors/wrap-app-error.js +18 -0
  95. package/lib/utils/index.js +17 -0
  96. package/lib/utils/xs-function-runner.js +51 -0
  97. package/lib/utils/xs-types.js +21 -0
  98. package/lib/utils/xspath.js +36 -0
  99. package/lib/utils/xsstack.js +28 -0
  100. package/lib/views/error.html +28 -0
  101. package/lib/xsjs/Application.js +28 -0
  102. package/lib/xsjs/Locale.js +53 -0
  103. package/lib/xsjs/Session.js +31 -0
  104. package/lib/xsjs/constants.js +71 -0
  105. package/lib/xsjs/db/common/DbBase.js +85 -0
  106. package/lib/xsjs/db/common/DbOptions.js +163 -0
  107. package/lib/xsjs/db/common/arguments-validation.js +102 -0
  108. package/lib/xsjs/db/common/connection.js +12 -0
  109. package/lib/xsjs/db/common/enums.js +93 -0
  110. package/lib/xsjs/db/common/execute-batch.js +38 -0
  111. package/lib/xsjs/db/common/parse-time.js +139 -0
  112. package/lib/xsjs/db/dbapi/CallableStatement.js +192 -0
  113. package/lib/xsjs/db/dbapi/Connection.js +78 -0
  114. package/lib/xsjs/db/dbapi/DB.js +39 -0
  115. package/lib/xsjs/db/dbapi/ParameterMetaData.js +118 -0
  116. package/lib/xsjs/db/dbapi/PreparedStatement.js +78 -0
  117. package/lib/xsjs/db/dbapi/ResultSet.js +220 -0
  118. package/lib/xsjs/db/dbapi/ResultSetMetaData.js +116 -0
  119. package/lib/xsjs/db/dbapi/Statement.js +514 -0
  120. package/lib/xsjs/db/dbapi/conversions.js +113 -0
  121. package/lib/xsjs/db/dbapi/fetch-rows.js +32 -0
  122. package/lib/xsjs/db/hdbapi/Connection.js +525 -0
  123. package/lib/xsjs/db/hdbapi/HDB.js +32 -0
  124. package/lib/xsjs/db/hdbapi/ResultSetIterator.js +40 -0
  125. package/lib/xsjs/db/hdbapi/convert.js +77 -0
  126. package/lib/xsjs/db/hdbapi/table-string-parser.js +52 -0
  127. package/lib/xsjs/db/index.js +4 -0
  128. package/lib/xsjs/index.js +13 -0
  129. package/lib/xsjs/jobs/Job.js +228 -0
  130. package/lib/xsjs/jobs/Jobs.js +11 -0
  131. package/lib/xsjs/jobs/Logs.js +127 -0
  132. package/lib/xsjs/jobs/Schedule.js +110 -0
  133. package/lib/xsjs/jobs/Schedules.js +108 -0
  134. package/lib/xsjs/net/Destination.js +43 -0
  135. package/lib/xsjs/net/http/Client.js +220 -0
  136. package/lib/xsjs/net/http/HTTP.js +72 -0
  137. package/lib/xsjs/net/index.js +5 -0
  138. package/lib/xsjs/net/smtp/Mail.js +38 -0
  139. package/lib/xsjs/net/smtp/Part.js +30 -0
  140. package/lib/xsjs/net/smtp/SMTPConnection.js +39 -0
  141. package/lib/xsjs/net/smtp/index.js +18 -0
  142. package/lib/xsjs/net/smtp/nodemailer-util.js +77 -0
  143. package/lib/xsjs/require.js +39 -0
  144. package/lib/xsjs/security/AntiVirus.js +31 -0
  145. package/lib/xsjs/security/Store.js +119 -0
  146. package/lib/xsjs/security/crypto.js +23 -0
  147. package/lib/xsjs/security/index.js +5 -0
  148. package/lib/xsjs/security/x509.js +12 -0
  149. package/lib/xsjs/text/analysis/Session.js +128 -0
  150. package/lib/xsjs/text/index.js +30 -0
  151. package/lib/xsjs/text/mining/Session.js +82 -0
  152. package/lib/xsjs/trace/trace.js +41 -0
  153. package/lib/xsjs/util/SAXParser.js +174 -0
  154. package/lib/xsjs/util/Zip.js +220 -0
  155. package/lib/xsjs/util/codec.js +33 -0
  156. package/lib/xsjs/util/compression.js +24 -0
  157. package/lib/xsjs/util/index.js +22 -0
  158. package/lib/xsjs/web/BasicWebEntity.js +41 -0
  159. package/lib/xsjs/web/EntityList.js +11 -0
  160. package/lib/xsjs/web/TupelLists/CookiesTupelList.js +47 -0
  161. package/lib/xsjs/web/TupelLists/HeadersTupelList.js +55 -0
  162. package/lib/xsjs/web/TupelLists/ParametersTupelList.js +83 -0
  163. package/lib/xsjs/web/TupelLists/TupelListBase.js +45 -0
  164. package/lib/xsjs/web/WebBody.js +135 -0
  165. package/lib/xsjs/web/WebEntityRequest.js +40 -0
  166. package/lib/xsjs/web/WebEntityResponse.js +26 -0
  167. package/lib/xsjs/web/WebRequest.js +209 -0
  168. package/lib/xsjs/web/WebResponse.js +183 -0
  169. package/lib/xsjs/web/index.js +4 -0
  170. package/lib/xsjs/web/utils/HeadersParser.js +53 -0
  171. package/lib/xsjs/web/utils/HttpRequestParser.js +93 -0
  172. package/lib/xsjs/web/utils/MultipartParser.js +163 -0
  173. package/lib/xsjs/web/utils/MultipartResponseBuilder.js +73 -0
  174. package/lib/xsjs/web/utils/SetCookieParser.js +32 -0
  175. package/lib/xsjslib/TextBundleWrapper.js +46 -0
  176. package/lib/xsjslib/index.js +11 -0
  177. package/npm-shrinkwrap.json +11540 -0
  178. package/package.json +84 -0
package/docs/$.jobs.Job.html ADDED
@@ -0,0 +1,783 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Class: Job</title>
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
10
+
11
+
12
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
13
+ <script src="scripts/highlight.js"></script>
14
+ <link rel="canonical" href="$.jobs.Job.html">
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Class: Job</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a><a href="$.jobs.html">.jobs</a>.</span>
23
+ Job
24
+ </h2>
25
+ <div class="class-description">$.jobs.Job Represents an XS scheduled job.</div>
26
+ </header>
27
+ <article>
28
+ <div class="container-overview">
29
+ <dt>
30
+ <h4 class="name" id="Job"><span class="type-signature"></span>new Job<span class="signature">(constructJob)</span><span
31
+ class="type-signature"> -> { Promise }</span></h4>
32
+ </dt>
33
+ <dd>
34
+ <div class="description">
35
+ A scheduled job.<br/>
36
+ Scheduled jobs are created via .xsjob files and can be used to define recurring
37
+ tasks that run in the background.
38
+ The JavaScript API allows developers to add and remove schedules from such jobs.
39
+ </div>
40
+ <h5>Parameters:</h5>
41
+ <table class="params">
42
+ <thead>
43
+ <tr>
44
+ <th>Name</th>
45
+ <th>Type</th>
46
+ <th class="last">Description</th>
47
+ </tr>
48
+ </thead>
49
+ <tbody>
50
+ <tr>
51
+ <td class="name"><code>constructJob</code></td>
52
+ <td class="type">
53
+ <span class="param-type">Object</span>
54
+ </td>
55
+ <td class="description last">parameter object to construct job object
56
+ <h6>Properties</h6>
57
+ <table class="params">
58
+ <thead>
59
+ <tr>
60
+ <th>Name</th>
61
+ <th>Type</th>
62
+ <th>Argument</th>
63
+ <th class="last">Description</th>
64
+ </tr>
65
+ </thead>
66
+ <tbody>
67
+ <tr>
68
+ <td class="name"><code>uri</code></td>
69
+ <td class="type">
70
+ <span class="param-type">String</span>
71
+ </td>
72
+ <td class="attributes">
73
+ </td>
74
+ <td class="description last">absolute or relative path to the xsjob file to
75
+ construct an object for
76
+ </td>
77
+ </tr>
78
+ <tr>
79
+ <td class="name"><code>sqlcc</code></td>
80
+ <td class="type">
81
+ <span class="param-type">String</span>
82
+ </td>
83
+ <td class="attributes">
84
+ &lt;optional><br>
85
+ </td>
86
+ <td class="description last">absolute or relative path to the xssqlcc file to
87
+ use only for database operations that manipulate the job. To be set in case
88
+ the user that runs the code that adds or deletes a schedule does not have
89
+ the necessary privileges.
90
+ </td>
91
+ </tr>
92
+ </tbody>
93
+ </table>
94
+ </td>
95
+ </tr>
96
+ </tbody>
97
+ </table>
98
+ <dl class="details">
99
+ <h5 class="subsection-title">Properties:</h5>
100
+ <dl>
101
+ <table class="props">
102
+ <thead>
103
+ <tr>
104
+ <th>Name</th>
105
+ <th>Type</th>
106
+ <th class="last">Description</th>
107
+ </tr>
108
+ </thead>
109
+ <tbody>
110
+ <tr>
111
+ <td class="name"><code>schedules</code></td>
112
+ <td class="type">
113
+ <span class="param-type"><a
114
+ href="$.jobs.JobSchedules.html">$.jobs.JobSchedules</a></span>
115
+ </td>
116
+ <td class="description last">Object that allows manipulating a job's schedules.</td>
117
+ </tr>
118
+ </tbody>
119
+ </table>
120
+ </dl>
121
+ </dl>
122
+ <h5>Throws:</h5>
123
+ <div class="param-desc">
124
+ Throws an error if the constructJob object is not valid or looking up the job fails.
125
+ </div>
126
+ <h5>Example</h5>
127
+ <pre class="prettyprint"><code>var myjob = <b>await </b>(new $.jobs.Job({uri:"my.xsjob", sqlcc:"sqlcc/otheruser.xssqlcc"}));</code></pre>
128
+ </dd>
129
+ </div>
130
+ <h3 class="subsection-title">Members</h3>
131
+ <dl>
132
+ <dt>
133
+ <h4 class="name" id="concurrencyHint"><span class="type-signature"></span>concurrencyHint<span
134
+ class="type-signature"></span></h4>
135
+ </dt>
136
+ <dd>
137
+ <div class="description">
138
+ Retrieve hint about free CPU resources taking into account the recent average CPU load. Should
139
+ be used with care.
140
+ </div>
141
+ <dl class="details">
142
+ </dl>
143
+ <h5>Example</h5>
144
+ <pre class="prettyprint"><code>var hint = myjob.concurrencyHint;</code></pre>
145
+ </dd>
146
+ </dl>
147
+ <h3 class="subsection-title">Methods</h3>
148
+ <dl>
149
+ <dt>
150
+ <h4 class="name" id="activate"><span class="type-signature">async </span>activate<span class="signature">(credentials)</span><span
151
+ class="type-signature"></span></h4>
152
+ </dt>
153
+ <dd>
154
+ <div class="description">
155
+ Activates an XS Job that has already been configured.
156
+ </div>
157
+ <h5>Parameters:</h5>
158
+ <table class="params">
159
+ <thead>
160
+ <tr>
161
+ <th>Name</th>
162
+ <th>Type</th>
163
+ <th class="last">Description</th>
164
+ </tr>
165
+ </thead>
166
+ <tbody>
167
+ <tr>
168
+ <td class="name"><code>credentials</code></td>
169
+ <td class="type">
170
+ <span class="param-type">Object</span>
171
+ </td>
172
+ <td class="description last">it is recommended to store credentials in the secure store <a
173
+ href="$.security.Store.html">$.security.Store</a>
174
+ <h6>Properties</h6>
175
+ <table class="params">
176
+ <thead>
177
+ <tr>
178
+ <th>Name</th>
179
+ <th>Type</th>
180
+ <th class="last">Description</th>
181
+ </tr>
182
+ </thead>
183
+ <tbody>
184
+ <tr>
185
+ <td class="name"><code>user</code></td>
186
+ <td class="type">
187
+ <span class="param-type">String</span>
188
+ </td>
189
+ <td class="description last">name of the user to run the XS Job. Must be the one
190
+ already configured at the XS Job
191
+ </td>
192
+ </tr>
193
+ <tr>
194
+ <td class="name"><code>password</code></td>
195
+ <td class="type">
196
+ <span class="param-type">String</span>
197
+ </td>
198
+ <td class="description last">password of this user</td>
199
+ </tr>
200
+ </tbody>
201
+ </table>
202
+ </td>
203
+ </tr>
204
+ </tbody>
205
+ </table>
206
+ <dl class="details">
207
+ </dl>
208
+ <h5>Throws:</h5>
209
+ <div class="param-desc">
210
+ Throws an error if activating the job fails (e.g., due to invalid credentials or missing
211
+ privileges)
212
+ </div>
213
+ <h5>Example</h5>
214
+ <pre class="prettyprint"><code><b>await </b>myjob.activate({
215
+ user: "JOBUSER",
216
+ password: "MyPassWd1"
217
+ });</code></pre>
218
+ </dd>
219
+ <dt>
220
+ <h4 class="name" id="configure"><span class="type-signature">async </span>configure<span
221
+ class="signature">(config)</span><span class="type-signature"></span></h4>
222
+ </dt>
223
+ <dd>
224
+ <div class="description">
225
+ Configure an XS Job. The function provides additional means to programmatically configure an XS
226
+ Job.
227
+ Configuring an XS Job via the XS Job Dashboard yields the same result. Configuration must be
228
+ done prior to activate/deactivate an XS Job.
229
+ </div>
230
+ <h5>Parameters:</h5>
231
+ <table class="params">
232
+ <thead>
233
+ <tr>
234
+ <th>Name</th>
235
+ <th>Type</th>
236
+ <th class="last">Description</th>
237
+ </tr>
238
+ </thead>
239
+ <tbody>
240
+ <tr>
241
+ <td class="name"><code>config</code></td>
242
+ <td class="type">
243
+ <span class="param-type">Object</span>
244
+ </td>
245
+ <td class="description last">anonymous object to configure the job. The config object
246
+ contains credentials. It is recommended to store these in the secure store <a
247
+ href="$.security.Store.html">$.security.Store</a>
248
+ <h6>Properties</h6>
249
+ <table class="params">
250
+ <thead>
251
+ <tr>
252
+ <th>Name</th>
253
+ <th>Type</th>
254
+ <th>Argument</th>
255
+ <th class="last">Description</th>
256
+ </tr>
257
+ </thead>
258
+ <tbody>
259
+ <tr>
260
+ <td class="name"><code>user</code></td>
261
+ <td class="type">
262
+ <span class="param-type">String</span>
263
+ </td>
264
+ <td class="attributes">
265
+ </td>
266
+ <td class="description last">name of the user to run the XS Job</td>
267
+ </tr>
268
+ <tr>
269
+ <td class="name"><code>password</code></td>
270
+ <td class="type">
271
+ <span class="param-type">String</span>
272
+ </td>
273
+ <td class="attributes">
274
+ </td>
275
+ <td class="description last">password of the user</td>
276
+ </tr>
277
+ <tr>
278
+ <td class="name"><code>locale</code></td>
279
+ <td class="type">
280
+ <span class="param-type">String</span>
281
+ </td>
282
+ <td class="attributes">
283
+ </td>
284
+ <td class="description last">sets the language encoding required for the locale
285
+ in which the job runs
286
+ </td>
287
+ </tr>
288
+ <tr>
289
+ <td class="name"><code>status</code></td>
290
+ <td class="type">
291
+ <span class="param-type">Boolean</span>
292
+ </td>
293
+ <td class="attributes">
294
+ </td>
295
+ <td class="description last">status of the XS Job: true for active, false for
296
+ inactive
297
+ </td>
298
+ </tr>
299
+ <tr>
300
+ <td class="name"><code>start_time</code></td>
301
+ <td class="type">
302
+ <span class="param-type">Date</span>
303
+ |
304
+ <span class="param-type">Object</span>
305
+ </td>
306
+ <td class="attributes">
307
+ </td>
308
+ <td class="description last">set start time in UTC of the time frame in which
309
+ the job will be scheduled. Can either be a Date object or an object with the
310
+ following properties:
311
+ <h6>Properties</h6>
312
+ <table class="params">
313
+ <thead>
314
+ <tr>
315
+ <th>Name</th>
316
+ <th>Type</th>
317
+ <th>Argument</th>
318
+ <th class="last">Description</th>
319
+ </tr>
320
+ </thead>
321
+ <tbody>
322
+ <tr>
323
+ <td class="name"><code>value</code></td>
324
+ <td class="type">
325
+ <span class="param-type">String</span>
326
+ </td>
327
+ <td class="attributes">
328
+ </td>
329
+ <td class="description last">start time in UTC as a String</td>
330
+ </tr>
331
+ <tr>
332
+ <td class="name"><code>format</code></td>
333
+ <td class="type">
334
+ <span class="param-type">String</span>
335
+ </td>
336
+ <td class="attributes">
337
+ &lt;optional><br>
338
+ </td>
339
+ <td class="description last">specify the format of the value
340
+ string
341
+ </td>
342
+ </tr>
343
+ </tbody>
344
+ </table>
345
+ </td>
346
+ </tr>
347
+ <tr>
348
+ <td class="name"><code>end_time</code></td>
349
+ <td class="type">
350
+ <span class="param-type">Date</span>
351
+ |
352
+ <span class="param-type">Object</span>
353
+ </td>
354
+ <td class="attributes">
355
+ </td>
356
+ <td class="description last">set end time in UTC of the time frame in which the
357
+ job will be scheduled. Can either be a Date object or an object with the
358
+ following properties:
359
+ <h6>Properties</h6>
360
+ <table class="params">
361
+ <thead>
362
+ <tr>
363
+ <th>Name</th>
364
+ <th>Type</th>
365
+ <th>Argument</th>
366
+ <th class="last">Description</th>
367
+ </tr>
368
+ </thead>
369
+ <tbody>
370
+ <tr>
371
+ <td class="name"><code>value</code></td>
372
+ <td class="type">
373
+ <span class="param-type">String</span>
374
+ </td>
375
+ <td class="attributes">
376
+ </td>
377
+ <td class="description last">end time in UTC as a String</td>
378
+ </tr>
379
+ <tr>
380
+ <td class="name"><code>format</code></td>
381
+ <td class="type">
382
+ <span class="param-type">String</span>
383
+ </td>
384
+ <td class="attributes">
385
+ &lt;optional><br>
386
+ </td>
387
+ <td class="description last">specify the format of the value
388
+ string
389
+ </td>
390
+ </tr>
391
+ </tbody>
392
+ </table>
393
+ </td>
394
+ </tr>
395
+ <tr>
396
+ <td class="name"><code>session_timeout</code></td>
397
+ <td class="type">
398
+ <span class="param-type">Integer</span>
399
+ </td>
400
+ <td class="attributes">
401
+ &lt;optional><br>
402
+ </td>
403
+ <td class="description last">configures the timeout in seconds for the session
404
+ in which the XS Job executes. If set to 0 the configuration in
405
+ xsengine.ini->scheduler->sessiontimeout will be used
406
+ </td>
407
+ </tr>
408
+ </tbody>
409
+ </table>
410
+ </td>
411
+ </tr>
412
+ </tbody>
413
+ </table>
414
+ <dl class="details">
415
+ </dl>
416
+ <h5>Throws:</h5>
417
+ <div class="param-desc">
418
+ Throws an error if configuring the job fails (e.g., due to invalid credentials or missing
419
+ privileges)
420
+ </div>
421
+ <h5>Example</h5>
422
+ <pre class="prettyprint"><code><b>await </b>myjob.configure({
423
+ user: "JOBUSER",
424
+ password: "MyPassWd1",
425
+ locale : "EN",
426
+ status: true,
427
+ start_time: {
428
+ value: "25 01 2014 11:57:19",
429
+ format: "DD MM YYYY HH:MI:SS"
430
+ },
431
+ end_time: null
432
+ });</code></pre>
433
+ </dd>
434
+ <dt>
435
+ <h4 class="name" id="deactivate"><span class="type-signature">async </span>deactivate<span
436
+ class="signature">(credentials)</span><span class="type-signature"></span></h4>
437
+ </dt>
438
+ <dd>
439
+ <div class="description">
440
+ Deactivates an XS Job that has already been configured.
441
+ </div>
442
+ <h5>Parameters:</h5>
443
+ <table class="params">
444
+ <thead>
445
+ <tr>
446
+ <th>Name</th>
447
+ <th>Type</th>
448
+ <th class="last">Description</th>
449
+ </tr>
450
+ </thead>
451
+ <tbody>
452
+ <tr>
453
+ <td class="name"><code>credentials</code></td>
454
+ <td class="type">
455
+ <span class="param-type">Object</span>
456
+ </td>
457
+ <td class="description last">it is recommended to store credentials in the secure store <a
458
+ href="$.security.Store.html">$.security.Store</a>
459
+ <h6>Properties</h6>
460
+ <table class="params">
461
+ <thead>
462
+ <tr>
463
+ <th>Name</th>
464
+ <th>Type</th>
465
+ <th class="last">Description</th>
466
+ </tr>
467
+ </thead>
468
+ <tbody>
469
+ <tr>
470
+ <td class="name"><code>user</code></td>
471
+ <td class="type">
472
+ <span class="param-type">String</span>
473
+ </td>
474
+ <td class="description last">name of the user to run the XS Job. Must be the one
475
+ already configured at the XS Job.
476
+ </td>
477
+ </tr>
478
+ <tr>
479
+ <td class="name"><code>password</code></td>
480
+ <td class="type">
481
+ <span class="param-type">String</span>
482
+ </td>
483
+ <td class="description last">password of this user</td>
484
+ </tr>
485
+ </tbody>
486
+ </table>
487
+ </td>
488
+ </tr>
489
+ </tbody>
490
+ </table>
491
+ <dl class="details">
492
+ </dl>
493
+ <h5>Throws:</h5>
494
+ <div class="param-desc">
495
+ Throws an error if deactivating the job fails (e.g., due to invalid credentials or missing
496
+ privileges)
497
+ </div>
498
+ <h5>Example</h5>
499
+ <pre class="prettyprint"><code><b>await </b>myjob.deactivate({
500
+ user: "JOBUSER",
501
+ password: "MyPassWd1"
502
+ });</code></pre>
503
+ </dd>
504
+ <dt>
505
+ <h4 class="name" id="getConfiguration"><span class="type-signature"></span>getConfiguration<span
506
+ class="signature">()</span><span class="type-signature"></span></h4>
507
+ </dt>
508
+ <dd>
509
+ <div class="description">
510
+ This method is not supported in asynx-xsjs.<br/>
511
+ Retrieve current configuration of an XS Job as object.
512
+ </div>
513
+ <dl class="details">
514
+ <h5 class="subsection-title">Properties:</h5>
515
+ <dl>
516
+ <table class="props">
517
+ <thead>
518
+ <tr>
519
+ <th>Name</th>
520
+ <th>Type</th>
521
+ <th class="last">Description</th>
522
+ </tr>
523
+ </thead>
524
+ <tbody>
525
+ <tr>
526
+ <td class="name"><code>user</code></td>
527
+ <td class="type">
528
+ <span class="param-type">String</span>
529
+ </td>
530
+ <td class="description last">name of the user to run the XS Job</td>
531
+ </tr>
532
+ <tr>
533
+ <td class="name"><code>locale</code></td>
534
+ <td class="type">
535
+ <span class="param-type">String</span>
536
+ </td>
537
+ <td class="description last">current language encoding required for the locale in
538
+ which the job runs
539
+ </td>
540
+ </tr>
541
+ <tr>
542
+ <td class="name"><code>status</code></td>
543
+ <td class="type">
544
+ <span class="param-type">Boolean</span>
545
+ </td>
546
+ <td class="description last">status of the XS Job: true for active, false for
547
+ inactive
548
+ </td>
549
+ </tr>
550
+ <tr>
551
+ <td class="name"><code>start_time</code></td>
552
+ <td class="type">
553
+ <span class="param-type">Date</span>
554
+ </td>
555
+ <td class="description last">start time in UTC as a Date object</td>
556
+ </tr>
557
+ <tr>
558
+ <td class="name"><code>end_time</code></td>
559
+ <td class="type">
560
+ <span class="param-type">Date</span>
561
+ </td>
562
+ <td class="description last">end time in UTC as a Date object</td>
563
+ </tr>
564
+ <tr>
565
+ <td class="name"><code>session_timeout</code></td>
566
+ <td class="type">
567
+ <span class="param-type">Integer</span>
568
+ </td>
569
+ <td class="description last">configures the timeout (in seconds) for the session in
570
+ which the XS Job executes.
571
+ </td>
572
+ </tr>
573
+ </tbody>
574
+ </table>
575
+ </dl>
576
+ </dl>
577
+ <h5>Throws:</h5>
578
+ <div class="param-desc">
579
+ Throws an error if retrieving the configuration of the job fails (e.g., due to missing
580
+ privileges)
581
+ </div>
582
+ <h5>Example</h5>
583
+ <pre class="prettyprint"><code>var configuration = myjob.getConfiguration();</code></pre>
584
+ </dd>
585
+ </dl>
586
+ </article>
587
+ </section>
588
+ </div>
589
+ <nav>
590
+ <h2><a href="index.html">Index</a></h2>
591
+ <h3>Classes</h3>
592
+ <table>
593
+ <tr>
594
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
595
+ <td class="oblique">$.security</td>
596
+ </tr>
597
+ <tr>
598
+ <td><a href="$.Application.html">Application</a></td>
599
+ <td class="oblique">$</td>
600
+ </tr>
601
+ <tr>
602
+ <td><a href="$.web.Body.html">Body</a></td>
603
+ <td class="oblique">$.web</td>
604
+ </tr>
605
+ <tr>
606
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
607
+ <td class="oblique">$.db</td>
608
+ </tr>
609
+ <tr>
610
+ <td><a href="$.net.http.Client.html">Client</a></td>
611
+ <td class="oblique">$.net.http</td>
612
+ </tr>
613
+ <tr>
614
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
615
+ <td class="oblique">$.hdb</td>
616
+ </tr>
617
+ <tr>
618
+ <td><a href="$.db.Connection.html">Connection</a></td>
619
+ <td class="oblique">$.db</td>
620
+ </tr>
621
+ <tr>
622
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
623
+ <td class="oblique">$.hdb</td>
624
+ </tr>
625
+ <tr>
626
+ <td><a href="$.net.Destination.html">Destination</a></td>
627
+ <td class="oblique">$.net</td>
628
+ </tr>
629
+ <tr>
630
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
631
+ <td class="oblique">$.net.http</td>
632
+ </tr>
633
+ <tr>
634
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
635
+ <td class="oblique">$.web</td>
636
+ </tr>
637
+ <tr>
638
+ <td><a href="$.jobs.Job.html">Job</a></td>
639
+ <td class="oblique">$.jobs</td>
640
+ </tr>
641
+ <tr>
642
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
643
+ <td class="oblique">$.jobs</td>
644
+ </tr>
645
+ <tr>
646
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
647
+ <td class="oblique">$.jobs</td>
648
+ </tr>
649
+ <tr>
650
+ <td><a href="$.net.Mail.html">Mail</a></td>
651
+ <td class="oblique">$.net</td>
652
+ </tr>
653
+ <tr>
654
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
655
+ <td class="oblique">$.db</td>
656
+ </tr>
657
+ <tr>
658
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
659
+ <td class="oblique">$.net.Mail</td>
660
+ </tr>
661
+ <tr>
662
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
663
+ <td class="oblique">$.db</td>
664
+ </tr>
665
+ <tr>
666
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
667
+ <td class="oblique">$.hdb</td>
668
+ </tr>
669
+ <tr>
670
+ <td><a href="$.net.http.Request.html">Request</a></td>
671
+ <td class="oblique">$.net.http</td>
672
+ </tr>
673
+ <tr>
674
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
675
+ <td class="oblique">$.db</td>
676
+ </tr>
677
+ <tr>
678
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
679
+ <td class="oblique">$.hdb</td>
680
+ </tr>
681
+ <tr>
682
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
683
+ <td class="oblique">$.hdb</td>
684
+ </tr>
685
+ <tr>
686
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
687
+ <td class="oblique">$.db</td>
688
+ </tr>
689
+ <tr>
690
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
691
+ <td class="oblique">$.hdb</td>
692
+ </tr>
693
+ <tr>
694
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
695
+ <td class="oblique">$.util</td>
696
+ </tr>
697
+ <tr>
698
+ <td><a href="$.Session.html">Session</a></td>
699
+ <td class="oblique">$</td>
700
+ </tr>
701
+ <tr>
702
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
703
+ <td class="oblique">$.text.analysis</td>
704
+ </tr>
705
+ <tr>
706
+ <td><a href="$.text.mining.Session.html">Session</a></td>
707
+ <td class="oblique">$.text.mining</td>
708
+ </tr>
709
+ <tr>
710
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
711
+ <td class="oblique">$.net</td>
712
+ </tr>
713
+ <tr>
714
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
715
+ <td class="oblique">$.db</td>
716
+ </tr>
717
+ <tr>
718
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
719
+ <td class="oblique">$.hdb</td>
720
+ </tr>
721
+ <tr>
722
+ <td><a href="$.security.Store.html">Store</a></td>
723
+ <td class="oblique">$.security</td>
724
+ </tr>
725
+ <tr>
726
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
727
+ <td class="oblique">$.web</td>
728
+ </tr>
729
+ <tr>
730
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
731
+ <td class="oblique">$.web</td>
732
+ </tr>
733
+ <tr>
734
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
735
+ <td class="oblique">$.web</td>
736
+ </tr>
737
+ <tr>
738
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
739
+ <td class="oblique">$.web</td>
740
+ </tr>
741
+ <tr>
742
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
743
+ <td class="oblique">$.web</td>
744
+ </tr>
745
+ <tr>
746
+ <td><a href="$.util.Zip.html">Zip</a></td>
747
+ <td class="oblique">$.util</td>
748
+ </tr>
749
+ </table>
750
+ <h3>Namespaces</h3>
751
+ <ul>
752
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
753
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
754
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
755
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
756
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
757
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
758
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
759
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
760
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
761
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
762
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
763
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
764
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
765
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
766
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
767
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
768
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
769
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
770
+ </ul>
771
+ </nav>
772
+ <br clear="both">
773
+ <footer>
774
+ <a href="Copyright-SAP.html">Copyright</a>
775
+ &
776
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
777
+ </footer>
778
+ <script>prettyPrint();</script>
779
+ <script src="scripts/linenumber.js"></script>
780
+
781
+ </body>
782
+
783
+ </html>