@adobe/acc-js-sdk 1.1.40 → 1.1.42
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.
- package/docs/Gemfile.lock +2 -1
- package/docs/_config.yml +5 -0
- package/docs/_posts/2022-10-14-welcome.html +0 -1
- package/docs/_posts/2023-12-08-manipulateSchemas.html +364 -0
- package/docs/_posts/2023-12-09-createFDASchema.html +429 -0
- package/docs/blog.html +1 -1
- package/docs/changeLog.html +25 -0
- package/docs/connecting.html +1 -1
- package/docs/xtkJob.html +25 -0
- package/package-lock.json +299 -130
- package/package.json +1 -1
- package/src/client.js +4 -1
- package/src/xtkJob.js +33 -14
- package/test/client.test.js +49 -0
- package/test/xtkJob.test.js +42 -17
|
@@ -0,0 +1,429 @@
|
|
|
1
|
+
---
|
|
2
|
+
layout: post
|
|
3
|
+
title: "Discover and create a FDA schema"
|
|
4
|
+
author: Alexandre Morin
|
|
5
|
+
tags: fda schemas soap
|
|
6
|
+
excerpt: Sequence of APIs to discover and create a FDA schema
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
<p>
|
|
11
|
+
This article will illustrate the following flow and show the corresponding SOAP calls.
|
|
12
|
+
<ul>
|
|
13
|
+
<li>Create an external account corresponding to a FDA PostgreSQL database</li>
|
|
14
|
+
<li>Discover all the tables available in the FDA database</li>
|
|
15
|
+
<li>Choose a table and discover the schema</li>
|
|
16
|
+
<li>Annotate and save the schema</li>
|
|
17
|
+
</ul>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
<h1>Create FDA external account</h1>
|
|
21
|
+
|
|
22
|
+
<p>
|
|
23
|
+
We'll create (or update) an external acount for a FDA database. You need the server, port, database and schema name, user and password.
|
|
24
|
+
</p>
|
|
25
|
+
|
|
26
|
+
<h2>Encrypt the password</h2>
|
|
27
|
+
|
|
28
|
+
<p>
|
|
29
|
+
The first step is to encrypt the password.
|
|
30
|
+
The <b>xtk:persist#EncryptPassword</b> API will by used to encrypt the password.
|
|
31
|
+
</p>
|
|
32
|
+
|
|
33
|
+
<p></p>
|
|
34
|
+
|
|
35
|
+
<pre class="code">
|
|
36
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
37
|
+
<SOAP-ENV:Body>
|
|
38
|
+
|
|
39
|
+
<EncryptPassword xmlns='urn:xtk:persist' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
40
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
41
|
+
|
|
42
|
+
<strDecrypted xsi:type='xsd:string'>admin</strDecrypted>
|
|
43
|
+
|
|
44
|
+
</EncryptPassword>
|
|
45
|
+
</SOAP-ENV:Body>
|
|
46
|
+
</SOAP-ENV:Envelope>
|
|
47
|
+
|
|
48
|
+
</pre>
|
|
49
|
+
|
|
50
|
+
<p>
|
|
51
|
+
The API will return the encrypted password as follows.
|
|
52
|
+
</p>
|
|
53
|
+
|
|
54
|
+
<pre class="code">
|
|
55
|
+
<?xml version='1.0'?>
|
|
56
|
+
<SOAP-ENV:Envelope
|
|
57
|
+
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
58
|
+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
|
|
59
|
+
xmlns:ns='urn:xtk:session'
|
|
60
|
+
xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
61
|
+
<SOAP-ENV:Body>
|
|
62
|
+
<EncryptPasswordResponse
|
|
63
|
+
xmlns='urn:xtk:session' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
64
|
+
<pstrEncrypted xsi:type='xsd:string'>@S/U/D7xOdZfRAwf3+WRM3w==</pstrEncrypted>
|
|
65
|
+
</EncryptPasswordResponse>
|
|
66
|
+
</SOAP-ENV:Body>
|
|
67
|
+
</SOAP-ENV:Envelope>
|
|
68
|
+
</pre>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<h2>Create the external account</h2>
|
|
72
|
+
|
|
73
|
+
<p>
|
|
74
|
+
Now the external account can be created using the <b>xtk:persist#Write</b> API. Give it a name, make sure it's active and set all connection parameters as follows. Make sure you provide the encrypted password
|
|
75
|
+
</p>
|
|
76
|
+
|
|
77
|
+
<pre class="code">
|
|
78
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
79
|
+
<SOAP-ENV:Body>
|
|
80
|
+
|
|
81
|
+
<Write xmlns='urn:xtk:persist' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
82
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
83
|
+
<domDoc xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
84
|
+
|
|
85
|
+
<extAccount xtkschema="nms:extAccount"
|
|
86
|
+
name="pg2" label="Postgres (2)" provider="PostgreSQL" type="7" active="1"
|
|
87
|
+
server="localhost" port="" dbName="fda" dbSchema="public"
|
|
88
|
+
account="postgres" password="@S/U/D7xOdZfRAwf3+WRM3w=="
|
|
89
|
+
timezone="_server_" unicodeData="1">
|
|
90
|
+
</extAccount>
|
|
91
|
+
|
|
92
|
+
</domDoc>
|
|
93
|
+
</Write>
|
|
94
|
+
</SOAP-ENV:Body>
|
|
95
|
+
</SOAP-ENV:Envelope>
|
|
96
|
+
</pre>
|
|
97
|
+
|
|
98
|
+
<p>
|
|
99
|
+
The API does not return anything. Note the the <b>name</b> attribute is a unique key in the nms:account schema. So the same API call can be used to update the account.
|
|
100
|
+
</p>
|
|
101
|
+
|
|
102
|
+
<h2>Test the connection</h2>
|
|
103
|
+
|
|
104
|
+
<p>
|
|
105
|
+
Campaign provides the <b>nms:extAccount#TestAccount</b> API to test the connection. Unfortunately, this API cannot take an extAccount id, but it needs to be passed all the credentials settings again.
|
|
106
|
+
Note that the password is still encrypted.
|
|
107
|
+
</p>
|
|
108
|
+
|
|
109
|
+
<pre class="code">
|
|
110
|
+
|
|
111
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
112
|
+
<SOAP-ENV:Body>
|
|
113
|
+
|
|
114
|
+
<TestAccount xmlns='urn:xtk:persist' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
115
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
116
|
+
|
|
117
|
+
<param xsi:type='xsd:byte'>7</param>
|
|
118
|
+
<param xsi:type='xsd:boolean'>1</param>
|
|
119
|
+
<param xsi:type='xsd:string'>PostgreSQL:localhost</param>
|
|
120
|
+
<param xsi:type='xsd:string'>postgres</param>
|
|
121
|
+
<param xsi:type='xsd:string'>@S/U/D7xOdZfRAwf3+WRM3w==</param>
|
|
122
|
+
<param xsi:type='xsd:string'>fda</param>
|
|
123
|
+
<param xsi:type='xsd:string'>NChar=0;unicodeData=1;timezone=_server_;dbSchema=public;fileMethod=uploadFile;filePath=;</param>
|
|
124
|
+
<param xsi:type='xsd:string'>pg2</param>
|
|
125
|
+
<param xsi:type='xsd:boolean'>0</param>
|
|
126
|
+
<param xsi:type='xsd:string'></param>
|
|
127
|
+
<param xsi:type='xsd:string'></param>
|
|
128
|
+
<param xsi:type='xsd:string'></param>
|
|
129
|
+
<param xsi:type='xsd:string'></param>
|
|
130
|
+
|
|
131
|
+
</TestAccount>
|
|
132
|
+
</SOAP-ENV:Body>
|
|
133
|
+
</SOAP-ENV:Envelope>
|
|
134
|
+
|
|
135
|
+
</pre>
|
|
136
|
+
|
|
137
|
+
<p>
|
|
138
|
+
This should return a string with version information.
|
|
139
|
+
</p>
|
|
140
|
+
|
|
141
|
+
<pre class="code">
|
|
142
|
+
<?xml version='1.0'?>
|
|
143
|
+
<SOAP-ENV:Envelope
|
|
144
|
+
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
145
|
+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
|
|
146
|
+
xmlns:ns='urn:nms:extAccount'
|
|
147
|
+
xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
148
|
+
<SOAP-ENV:Body>
|
|
149
|
+
<TestAccountResponse
|
|
150
|
+
xmlns='urn:nms:extAccount' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
151
|
+
<pstrServer xsi:type='xsd:string'>localhost</pstrServer>
|
|
152
|
+
<pstrDbmsVer xsi:type='xsd:string'>Database server version 'PostgreSQL 12.2, compiled by Visual C++ build 1914, 64-bit'.</pstrDbmsVer>
|
|
153
|
+
<pstrWarehouse xsi:type='xsd:string'></pstrWarehouse>
|
|
154
|
+
<pstrTestDuration xsi:type='xsd:string'>Test connection took: 0 ms</pstrTestDuration>
|
|
155
|
+
</TestAccountResponse>
|
|
156
|
+
</SOAP-ENV:Body>
|
|
157
|
+
</SOAP-ENV:Envelope>
|
|
158
|
+
</pre>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<h2>Query the external account</h2>
|
|
162
|
+
|
|
163
|
+
<p>
|
|
164
|
+
You can also use a query to get information about the external account.
|
|
165
|
+
</p>
|
|
166
|
+
|
|
167
|
+
<pre class="code">
|
|
168
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
169
|
+
<SOAP-ENV:Body>
|
|
170
|
+
|
|
171
|
+
<ExecuteQuery xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
172
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
173
|
+
|
|
174
|
+
<entity xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
175
|
+
<queryDef fullLoad="true" operation="get" schema="nms:extAccount" startPath="/" xtkschema="xtk:queryDef">
|
|
176
|
+
<select>
|
|
177
|
+
<node expr="@id"/>
|
|
178
|
+
<node expr="@name"/>
|
|
179
|
+
<node expr="@label"/>
|
|
180
|
+
<node expr="@provider"/>
|
|
181
|
+
<node expr="@active"/>
|
|
182
|
+
<node expr="@server"/>
|
|
183
|
+
<node expr="@port"/>
|
|
184
|
+
<node expr="@dbName"/>
|
|
185
|
+
<node expr="@dbSchema"/>
|
|
186
|
+
<node expr="@account"/>
|
|
187
|
+
<node expr="@password"/>
|
|
188
|
+
<node expr="@timezone"/>
|
|
189
|
+
<node expr="@unicodeData"/>
|
|
190
|
+
</select>
|
|
191
|
+
<where>
|
|
192
|
+
<condition expr="@name='pg2'"/>
|
|
193
|
+
</where>
|
|
194
|
+
</queryDef>
|
|
195
|
+
</entity>
|
|
196
|
+
|
|
197
|
+
</ExecuteQuery>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</SOAP-ENV:Body>
|
|
201
|
+
</SOAP-ENV:Envelope>
|
|
202
|
+
|
|
203
|
+
</pre>
|
|
204
|
+
|
|
205
|
+
<p>
|
|
206
|
+
It will return something like this
|
|
207
|
+
</p>
|
|
208
|
+
|
|
209
|
+
<pre class="code">
|
|
210
|
+
<?xml version='1.0'?>
|
|
211
|
+
<SOAP-ENV:Envelope
|
|
212
|
+
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
213
|
+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
|
|
214
|
+
xmlns:ns='urn:xtk:queryDef'
|
|
215
|
+
xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
216
|
+
<SOAP-ENV:Body>
|
|
217
|
+
<ExecuteQueryResponse
|
|
218
|
+
xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
219
|
+
<pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
220
|
+
<extAccount account="postgres" active="1" dbName="fda" dbSchema="public" id="4510" label="Postgres (2)" name="pg2" password="@S/U/D7xOdZfRAwf3+WRM3w==" port="" provider="PostgreSQL" server="localhost" timezone="_server_" unicodeData="1"></extAccount>
|
|
221
|
+
</pdomOutput>
|
|
222
|
+
</ExecuteQueryResponse>
|
|
223
|
+
</SOAP-ENV:Body>
|
|
224
|
+
</SOAP-ENV:Envelope>
|
|
225
|
+
|
|
226
|
+
</pre>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<h1>Discover the tables</h1>
|
|
230
|
+
|
|
231
|
+
<p>
|
|
232
|
+
Now you can discover the tables available in the FDA database. The <b>xtk:sqlSchema#BuildTableList</b> API will return a list of tables.
|
|
233
|
+
</p>
|
|
234
|
+
|
|
235
|
+
<pre class="code">
|
|
236
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
237
|
+
<SOAP-ENV:Body>
|
|
238
|
+
|
|
239
|
+
<BuildTableList xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
240
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
241
|
+
|
|
242
|
+
<param xsi:type='xsd:string'>nms:extAccount:pg2</param>
|
|
243
|
+
<param xsi:type='xsd:string'>%%</param>
|
|
244
|
+
|
|
245
|
+
</BuildTableList>
|
|
246
|
+
|
|
247
|
+
</SOAP-ENV:Body>
|
|
248
|
+
</SOAP-ENV:Envelope>
|
|
249
|
+
</pre>
|
|
250
|
+
|
|
251
|
+
<p>
|
|
252
|
+
Which returns the following. In this example, I only have one table named <b>x</b>.
|
|
253
|
+
</p>
|
|
254
|
+
|
|
255
|
+
<pre class="code">
|
|
256
|
+
<?xml version='1.0'?>
|
|
257
|
+
<SOAP-ENV:Envelope
|
|
258
|
+
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
259
|
+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
|
|
260
|
+
xmlns:ns='urn:xtk:sqlSchema'
|
|
261
|
+
xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
262
|
+
<SOAP-ENV:Body>
|
|
263
|
+
<BuildTableListResponse
|
|
264
|
+
xmlns='urn:xtk:sqlSchema' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
265
|
+
<pdomTableList xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
266
|
+
<sqlSchema>
|
|
267
|
+
<table name="public.x"/>
|
|
268
|
+
</sqlSchema>
|
|
269
|
+
</pdomTableList>
|
|
270
|
+
</BuildTableListResponse>
|
|
271
|
+
</SOAP-ENV:Body>
|
|
272
|
+
</SOAP-ENV:Envelope>
|
|
273
|
+
</pre>
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<h1>Create the schema</h1>
|
|
277
|
+
|
|
278
|
+
<p>
|
|
279
|
+
Schema creation is a 3-step process
|
|
280
|
+
<ul>
|
|
281
|
+
<li>First, create a sql schema by discovering the table structure in the FDA database</li>
|
|
282
|
+
<li>Second, modify the schema if necessary and save it as a source schema</li>
|
|
283
|
+
<li>Finally, build the final schema</li>
|
|
284
|
+
</ul>
|
|
285
|
+
</p>
|
|
286
|
+
|
|
287
|
+
<h2>Discover the table structure</h2>
|
|
288
|
+
|
|
289
|
+
<p>
|
|
290
|
+
We'll call the <b>xtk:builder#GenerateSchema</b> API. It's the API behind the schema creation wizard.
|
|
291
|
+
This API takes high level parameters and return an XML document which is the future schema. Note that
|
|
292
|
+
everything happens in memory. At this point, nothing is created in the database.
|
|
293
|
+
</p>
|
|
294
|
+
<p>
|
|
295
|
+
The rationale is that the discovery may not discover anything, so we return a source schema, give you
|
|
296
|
+
a chance to modify it before it is persisted.
|
|
297
|
+
</p>
|
|
298
|
+
|
|
299
|
+
<pre class="code">
|
|
300
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
301
|
+
<SOAP-ENV:Body>
|
|
302
|
+
|
|
303
|
+
<GenerateSchema xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
304
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
305
|
+
|
|
306
|
+
<param xsi:type='xsi:element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
307
|
+
<tmp type="extView" sqltable="public.x" removePrefix="0" advanced="0">
|
|
308
|
+
</tmp>
|
|
309
|
+
</param>
|
|
310
|
+
|
|
311
|
+
<param xsi:type='xsi:element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
312
|
+
<srcSchema dataSource="nms:extAccount:pg2" img="xtk:schema.png" label="NewAPI" mappingType="sql" name="new2" namespace="cus" xtkschema="xtk:srcSchema">
|
|
313
|
+
</srcSchema>
|
|
314
|
+
</param>
|
|
315
|
+
|
|
316
|
+
</GenerateSchema>
|
|
317
|
+
|
|
318
|
+
</SOAP-ENV:Body>
|
|
319
|
+
</SOAP-ENV:Envelope>
|
|
320
|
+
</pre>
|
|
321
|
+
|
|
322
|
+
<p>
|
|
323
|
+
Which returns
|
|
324
|
+
</p>
|
|
325
|
+
|
|
326
|
+
<pre class="code">
|
|
327
|
+
<?xml version='1.0'?>
|
|
328
|
+
<SOAP-ENV:Envelope
|
|
329
|
+
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
330
|
+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
|
|
331
|
+
xmlns:ns='urn:xtk:builder'
|
|
332
|
+
xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
333
|
+
<SOAP-ENV:Body>
|
|
334
|
+
<GenerateSchemaResponse
|
|
335
|
+
xmlns='urn:xtk:builder' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
336
|
+
<pdomSchema xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
337
|
+
|
|
338
|
+
<srcSchema img="xtk:schema.png" label="NewAPI" mappingType="sql" name="new2" namespace="cus" view="true" xtkschema="xtk:srcSchema">
|
|
339
|
+
<element dataSource="nms:extAccount:pg2" label="NewAPI" name="new2" sqltable="public.x">
|
|
340
|
+
<attribute advanced="false" label="i" name="i" sqlname="i" type="long"/>
|
|
341
|
+
</element>
|
|
342
|
+
</srcSchema>
|
|
343
|
+
|
|
344
|
+
</pdomSchema>
|
|
345
|
+
</GenerateSchemaResponse>
|
|
346
|
+
</SOAP-ENV:Body>
|
|
347
|
+
</SOAP-ENV:Envelope>
|
|
348
|
+
</pre>
|
|
349
|
+
|
|
350
|
+
<p>
|
|
351
|
+
As you can see a src schema is returned. In this case, my table only had one column named "i" which is a long.
|
|
352
|
+
</p>
|
|
353
|
+
|
|
354
|
+
<h2>Create the schema</h2>
|
|
355
|
+
|
|
356
|
+
<p>
|
|
357
|
+
Let's extract the srcSchema object from the result of the previous API call. We can modify this XML document
|
|
358
|
+
and, for example, define links, labels, keys, etc.
|
|
359
|
+
|
|
360
|
+
Typically, we'll create at least a key as follows
|
|
361
|
+
</p>
|
|
362
|
+
<pre class="code">
|
|
363
|
+
<srcSchema img="xtk:schema.png" label="NewAPI" mappingType="sql" name="new2" namespace="cus" view="true" xtkschema="xtk:srcSchema">
|
|
364
|
+
<element dataSource="nms:extAccount:pg2" label="NewAPI" name="new2" sqltable="public.x">
|
|
365
|
+
<key name="pk">
|
|
366
|
+
<keyfield xpath="@i"/>
|
|
367
|
+
</key>
|
|
368
|
+
<attribute advanced="false" label="i" name="i" sqlname="i" type="long"/>
|
|
369
|
+
</element>
|
|
370
|
+
</srcSchema>
|
|
371
|
+
</pre>
|
|
372
|
+
<p>
|
|
373
|
+
When happy with the document, it's time to save it and persist the src schema in the database. This
|
|
374
|
+
can be done with a simple <b>xtk:persist#Write</b> API call.
|
|
375
|
+
</p>
|
|
376
|
+
|
|
377
|
+
<pre class="code">
|
|
378
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
379
|
+
<SOAP-ENV:Body>
|
|
380
|
+
|
|
381
|
+
<Write xmlns='urn:xtk:persist' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
382
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
383
|
+
|
|
384
|
+
<domDoc xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
|
|
385
|
+
|
|
386
|
+
<srcSchema img="xtk:schema.png" label="NewAPI" mappingType="sql" name="new2" namespace="cus" view="true" xtkschema="xtk:srcSchema">
|
|
387
|
+
<element dataSource="nms:extAccount:pg2" label="NewAPI" name="new2" sqltable="public.x">
|
|
388
|
+
<key name="pk">
|
|
389
|
+
<keyfield xpath="@i"/>
|
|
390
|
+
</key>
|
|
391
|
+
<attribute advanced="false" label="i" name="i" sqlname="i" type="long"/>
|
|
392
|
+
</element>
|
|
393
|
+
</srcSchema>
|
|
394
|
+
|
|
395
|
+
</domDoc>
|
|
396
|
+
|
|
397
|
+
</Write>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</SOAP-ENV:Body>
|
|
401
|
+
</SOAP-ENV:Envelope>
|
|
402
|
+
</pre>
|
|
403
|
+
|
|
404
|
+
<p>
|
|
405
|
+
This API call does not return anything. But you can check in the database, the schema is there.
|
|
406
|
+
</p>
|
|
407
|
+
|
|
408
|
+
<h2>Build the schema</h2>
|
|
409
|
+
|
|
410
|
+
<p>
|
|
411
|
+
The last step is very important and consists of building a xtk:schema from the xtk:srcSchema which has
|
|
412
|
+
just been created. We can use the <b>xtk:builder#BuildSchemaFromId</b> API call.
|
|
413
|
+
</p>
|
|
414
|
+
|
|
415
|
+
<pre class="code">
|
|
416
|
+
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:persist' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
|
|
417
|
+
<SOAP-ENV:Body>
|
|
418
|
+
|
|
419
|
+
<BuildSchemaFromId xmlns='urn:xtk:builder' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
|
|
420
|
+
<__sessiontoken xsi:type='xsd:string'>{{SESSION_TOKEN}}</__sessiontoken>
|
|
421
|
+
|
|
422
|
+
<schemaId>cus:new2</schemaId>
|
|
423
|
+
|
|
424
|
+
</BuildSchemaFromId>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
</SOAP-ENV:Body>
|
|
428
|
+
</SOAP-ENV:Envelope>
|
|
429
|
+
</pre>
|
package/docs/blog.html
CHANGED
|
@@ -8,7 +8,7 @@ title: Blog (latest posts)
|
|
|
8
8
|
{% for post in site.posts %}
|
|
9
9
|
<li>
|
|
10
10
|
<div class="blog-expert">
|
|
11
|
-
<h2><a href="{{ post.url }}">{{ post.title }}</a></h2>
|
|
11
|
+
<h2><a href="{{ site.baseurl }}/{{ post.url }}">{{ post.title }}</a></h2>
|
|
12
12
|
<div class="blog-header">{{ post.author }} - {{ post.date | date_to_string }}</div>
|
|
13
13
|
{{ post.excerpt }}
|
|
14
14
|
</div>
|
package/docs/changeLog.html
CHANGED
|
@@ -2,6 +2,31 @@
|
|
|
2
2
|
layout: page
|
|
3
3
|
title: Change Log
|
|
4
4
|
---
|
|
5
|
+
<section class="changelog"><h1>Version 1.1.42</h1>
|
|
6
|
+
<h2>2023/12/20</h2>
|
|
7
|
+
<li>
|
|
8
|
+
Fixed a typo in documentation
|
|
9
|
+
</li>
|
|
10
|
+
<li>
|
|
11
|
+
Added 2 blog articles about schema creation (SOAP calls)
|
|
12
|
+
</li>
|
|
13
|
+
<li>
|
|
14
|
+
Fixed the documentation: blog articles links were broken
|
|
15
|
+
</li>
|
|
16
|
+
<li>
|
|
17
|
+
Upgraded Axios to fix a vulnerability
|
|
18
|
+
</li>
|
|
19
|
+
</section>
|
|
20
|
+
|
|
21
|
+
<section class="changelog"><h1>Version 1.1.41</h1>
|
|
22
|
+
<h2>2023/11/01</h2>
|
|
23
|
+
<li>
|
|
24
|
+
Support submitting jobs on static methods
|
|
25
|
+
</li>
|
|
26
|
+
<li>
|
|
27
|
+
Fixed a bug (missing await) when retreiving method object from cache when submitting a job on a non-static method
|
|
28
|
+
</li>
|
|
29
|
+
</section>
|
|
5
30
|
|
|
6
31
|
<section class="changelog"><h1>Version 1.1.40</h1>
|
|
7
32
|
<h2>2023/09/27</h2>
|
package/docs/connecting.html
CHANGED
|
@@ -105,7 +105,7 @@ await client.logoff();
|
|
|
105
105
|
</p>
|
|
106
106
|
|
|
107
107
|
<h2>Login with user and password</h2>
|
|
108
|
-
<p>This is the most common method to log in to Campaign.
|
|
108
|
+
<p>This is the most common method to log in to Campaign. Use the <b>ofUserAndPassword</b> function and pass it the user name and password</p>
|
|
109
109
|
<pre class="code">
|
|
110
110
|
const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword(
|
|
111
111
|
"https://myInstance.campaign.adobe.com",
|
package/docs/xtkJob.html
CHANGED
|
@@ -129,3 +129,28 @@ title: XTK Jobs (xkt:job, xkt:jobInterface)
|
|
|
129
129
|
<pre class="code">
|
|
130
130
|
var result = await job.getResult();
|
|
131
131
|
</pre>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h1>Jobs & Static methods</h1>
|
|
135
|
+
<p>
|
|
136
|
+
Version 1.1.41 and above support submitting jobs on static methods.
|
|
137
|
+
</p>
|
|
138
|
+
<ul>
|
|
139
|
+
<li>Set the jobId parameter with the entity primary key. In the example below, the jobId is the id of the webApp to publish</li>
|
|
140
|
+
<li>Do not pass an object parameter. The method is static, there's no object.</li>
|
|
141
|
+
</ul>
|
|
142
|
+
<pre class="code">
|
|
143
|
+
const job = await client.jobInterface({
|
|
144
|
+
xtkschema: 'nms:webApp',
|
|
145
|
+
jobId: 9876,
|
|
146
|
+
method: 'Publish',
|
|
147
|
+
args: [
|
|
148
|
+
{ where: { condition: { expr: "@id=9876" } } },
|
|
149
|
+
{ type: "byte", value: "10" }
|
|
150
|
+
]
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
const jobId = await job.submitSoapCall();
|
|
154
|
+
</pre>
|
|
155
|
+
|
|
156
|
+
|