-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path210312-extensions.html
503 lines (495 loc) · 18 KB
/
210312-extensions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<title>iAccess Training (March 12, 21)</title>
<link rel="stylesheet" href="dist/reset.css">
<link rel="stylesheet" href="dist/reveal.css">
<link rel="stylesheet" href="dist/theme/solarized.css" id="theme">
<!-- Theme used for syntax highlighted code -->
<link rel="stylesheet" href="plugin/highlight/zenburn.css" id="highlight-theme">
</head>
<body>
<div class="reveal">
<div class="slides">
<!-- ****************************************** -->
<section>
<h2>iAccess for Maconomy</h2>
<p>
<small>Anders Hessellund, Søren Bache<br>March 12, 2021</small>
</p>
</section>
<!-- ****************************************** -->
<section>
<h2>Agenda</h2>
<div class="r-hstack">
<div>
<ol>
<li>Background</li>
<li>Status</li>
<li>Architecture</li>
<li>Extensions</li>
</ol>
</div>
<div style="margin-left: 50px;">
<ol start="5">
<li>Workspaces</li>
<li>Gap Analysis</li>
<li>Tools</li>
<li>Questions</li>
</ol>
</div>
</div>
</section>
<!-- ****************************************** -->
<section>
<h2>Background: What is iAccess</h2>
<div class="r-hstack">
<div style="width: 50%;">
<ul style="font-size: smaller;">
<li>UI for the Web</li>
<li>Desktop and tablets</li>
<li>Based on the new REST API (Java Extensions included)</li>
<li>WSC-like extension model</li>
</ul>
</div>
<div>
<img src="assets/png/iaccess-screenshot.png" style="height: 500px;">
</div>
</div>
</section>
<!-- ****************************************** -->
<section>
<h2>Background: The core team</h2>
<dl>
<dt>Framework team</dt>
<dd>Peter, Anders, Piotr, Christa, Marcus, and Steve<br><em>+Søren as App lead, +Kristoffer as
PdM</em></dd>
<dt>Ambition</dt>
<dd>Build a kick-ass replacement for the old Portal</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Background: The core team</h2>
<dl>
<dt>Limitation</dt>
<dd>The old WSC framework team was 20-25 people<br><em>... vs 6 people on iAccess today</em></dd>
<dt>Consequence</dt>
<dd>Focus, focus, focus<br><em>... and ideally a little less support ;)</em></dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Status: Brief History</h2>
<iframe data-autoplay width="700" height="540" src="assets/html/timeline.html" frameborder="0"></iframe>
</section>
<!-- ****************************************** -->
<section>
<h2>Status: Weekly Usage Today</h2>
<img src="assets/png/google-analytics.png" style="height: 500px;">
</section>
<!-- ****************************************** -->
<section>
<h2>Architecture</h2>
<ul>
<li>Angular application (HTML, CSS, JS)</li>
<li>Communicates with Maconomy over REST</li>
<li>Relies on the same Java Extensions as the WSC</li>
<li>Declarative configuration language in JSON</li>
<li>Translated using Maconomy dictionaries</li>
<li>Goal: <em>Stick with the standards</em></li>
</ul>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2>Architecture</h2>
<img data-id="diagram" src="assets/svg/iaccess-architecture-1.svg"></img>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2>Architecture: Integrations</h2>
<img data-id="diagram" src="assets/svg/iaccess-architecture-2.svg"></img>
</section>
<!-- ****************************************** -->
<section>
<h2>Extensions</h2>
<ul>
<li>WSC-like extension model (...<em>think MDML/MWSL</em>)</li>
<li>Edit and deploy using the Extender</li>
<li>Configurations are stored in <em>MaconomyDir\Web</em></li>
<li>One JSON format vs many XML formats</li>
<li>Different approach to extension file layout</li>
</ul>
</section>
<!-- ****************************************** -->
<section>
<h2>Extensions: File Layout</h2>
<img src="assets/svg/file-layout-1.svg"></img>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2 data-id="code-title">application.json</h2>
<pre data-id="code-animation"><code class="hljs" data-trim data-line-numbers="|2-5|9-11"><script type="text/template">
{
"api": "20.0.0",
"application": {
"version": "2.2.2"
},
"authentication": {
"$ref": "Authentication:Authentication"
},
"shell": {
"$ref": "Shell:Shell"
},
"workspace": {
"$ref": "Workspace:Workspace"
},
"platform": {
"$ref": "Platform:Platform"
}
}
</script></code></pre>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2 data-id="code-title">shell.json</h2>
<pre data-id="code-animation"><code class="hljs" data-trim data-line-numbers="|5-6|2-4"><script type="text/template">
{
"menu": {
"$ref": "Menu"
},
"documentationUrl":
"https://help.deltek.com/Product/MaconomyiAccess/<version>",
"settings": {
"$ref": "Settings"
},
"notifications": {
"$ref": "Notifications"
},
"conversations": {
"$ref": "Conversations"
}
}
</script></code></pre>
</section>
<!-- ****************************************** -->
<section>
<h2>JSON Galore</h2>
<img src="assets/svg/json-dag-1.svg"></img>
</section>
<!-- ****************************************** -->
<section>
<h2>Extensions: File Layout</h2>
<ul>
<li>The browser initially requests <em>application.json</em></li>
<li>The server compiles that based on a large set of JSON files</li>
<li>Observe that this is a directed acyclic graph</li>
<li>Files are split according to a central convention</li>
<li>Goal:<em> Limit the impact of small changes</em></li>
</ul>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2>Impact of Extensions</h2>
<img data-id="files" src="assets/svg/json-dag-2.svg" style="height: 400px;"></img>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2>Impact of Extensions</h2>
<img data-id="files" src="assets/svg/json-dag-3.svg" style="height: 400px;"></img>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2>Impact of Extensions</h2>
<img data-id="files" src="assets/svg/json-dag-4.svg" style="height: 400px;"></img>
</section>
<!-- ****************************************** -->
<section>
<h2>Extensions: File Layout (Big Picture)</h2>
<dl style="font-size: smaller;">
<dt>authencation.json</dt>
<dd>Which login methods and URLs are supported<br>(<em>may eventually be replaced by a workflow for TIA consultants</em>)</dd>
<dt>platform.json</dt>
<dd>Configure language, usage tracking and advanced container overrides</dd>
<dt>shell.json</dt>
<dd>Configure menu, notifications, formats, conversations</dd>
<dt>workspace.json</dt>
<dd>Extend existing workspaces and/or build new ones</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Workspaces</h2>
<div>
<img src="assets/png/expense-sheets.png">
<ul style="font-size: smaller;">
<li>Contained in a single folder with one main file, e.g., <em>ExpenseSheets.json</em></li>
<li>Main properties are <em>dataBindings</em> and <em>layout</em> that correspond to <em>MWSL/MDML</em> in the WSC</li>
</ul>
</div>
</section>
<!-- ****************************************** -->
<section>
<h2>Workspaces</h2>
<div class="r-hstack">
<div style="width: 50%;">
<ul style="font-size: smaller;">
<li>Workspace name included for searchability</li>
<li>Files match UI areas, e.g., heading, list view, each row in the layout</li>
</ul>
</div>
<div>
<img src="assets/png/file-hierarchy.png">
</div>
</div>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2 data-id="code-title">Data Bindings</h2>
<pre data-id="code-animation"><code class="hljs" data-trim data-line-numbers="2-5|17-23|24-30"><script type="text/template">
{
"container": {
"source": "ExpenseSheets",
"type": "search-filter",
"name": "ExpenseSheetsFilter",
"parameters": {
"ExpenseSheetNumber": {
"urlParameter": "ExpenseSheetNumber"
}
},
"orderBy": [
{
"source": "ExpenseSheetNumber",
"order": "descending"
}
],
"bindings": [
{
"binding": "with",
"container": {
"source": "ExpenseSheets",
"type": "card",
"name": "ExpenseSheetsCard",
"bindings": [
{
"binding": "with",
"container": {
"source": "ExpenseSheets",
"type": "table",
"name": "ExpenseSheetsTable",
"bindings": [ ... ]
</script></code></pre>
</section>
<!-- ****************************************** -->
<section>
<h2>Data Bindings: concepts</h2>
<dl style="font-size: smaller;">
<dt>Containers</dt>
<dd>Represents panes from containers made available in the REST API / Extension Framework</dd>
<dt>Bindings</dt>
<dd>The relations between these containers, e.g., primary key, mount, with etc</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Data Bindings: concepts</h2>
<dl style="font-size: smaller;">
<dt>Container types</dt>
<dd>A container can be represented in different ways, e.g., search-filter, card, table, or filter-as-table, or have a special origin, e.g., document, analyzer, or pp</dd>
<dt>Extras</dt>
<dd>URL parameters, Shared Record, OrderBy, Restriction, Paging, and Triggers</dd>
</dl>
</section>
<!-- ****************************************** -->
<section data-auto-animate>
<h2 data-id="code-title">Layout</h2>
<pre data-id="code-animation"><code class="hljs" data-trim data-line-numbers="7|8-10|11-13|14-16|17-19|20-34"><script type="text/template">
{
"name": "ExpenseSheets",
"T$title": "Expenses",
"dataBindings": {
"$ref": "ExpenseSheets_DataBindings"
},
"layout": {
"heading": {
"$ref": "ExpenseSheets_Heading"
},
"record": {
"$ref": "ExpenseSheets_Record"
},
"list": {
"$ref": "ExpenseSheets_List"
},
"actionBar": {
"$ref": "ExpenseSheets_ActionBar"
},
"rows": [
{
"$ref": "ExpenseSheets_Card_Row"
},
{
"tabs": [
{
"$ref": "ExpenseSheets_Registrations_Tab"
},
{
"$ref": "ExpenseSheets_Receipts_Tab"
}
]
}
]
}
}
</script></code></pre>
</section>
<!-- ****************************************** -->
<section>
<h2>Layout: concepts</h2>
<dl style="font-size: smaller;">
<dt>Heading</dt>
<dd>Workspace navigation, e.g., calendar, filter or none</dd>
<dt>List</dt>
<dd>List view where the main search can be controlled</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Layout: concepts</h2>
<dl style="font-size: smaller;">
<dt>Record</dt>
<dd>Summary information about the current, main record, e.g., this expense sheet</dd>
<dt>Action Bar</dt>
<dd>Selected actions</dd>
<dt>Rows</dt>
<dd>The layout rows that constitute the main content. Rows can be divided in columns etc.</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Workspace File Layout - recap</h2>
<img src="assets/png/file-hierarchy.png">
</section>
<!-- ****************************************** -->
<section>
<h2>Workspace: Two Types of Extensions</h2>
<dl style="font-size: smaller;">
<dt>Adapt</dt>
<dd>Extend an existing workspace by <em>overriding</em> on or more files</dd>
<dt>Build</dt>
<dd>Create a new folder with your own workspace<br>(<em>Expense Sheets is a good template</em>)</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>extensions.json</h2>
<img src="assets/png/extensions-json.png">
</section>
<!-- ****************************************** -->
<section>
<h2>Best Practice</h2>
<p class="r-fit-text">Don't try to map all WSC workspaces 1:1 to iAccess</p>
<p><small>It will <strong>not</strong> perform<br>
Too many containers in one workspace is a warning sign.<br>
Consider splitting large workspaces into smaller, more focused ones.</small></p>
</section>
<!-- ****************************************** -->
<section>
<h2>Best Practice</h2>
<p>The data binding hierarchy represents the <em>flow of data</em>,<br>not necessarily how it looks</p>
</section>
<!-- ****************************************** -->
<section>
<h2>Best Practice</h2>
<img src="assets/svg/vsc-vs-iaccess.svg">
</section>
<!-- ****************************************** -->
<section>
<h2>UI Library Tour</h2>
<p>next time?</p>
</section>
<!-- ****************************************** -->
<section>
<h2>Gap Analysis</h2>
<dl style="font-size: smaller;">
<dt>MWSL</dt>
<dd>Majority is covered today</dd>
<dt>MDML</dt>
<dd>Weak areas: styling, cascading, triggers, conditionals</dd>
<dt>EL</dt>
<dd>Still only 20% of WSC functions implemented</dd>
</dl>
</section>
<!-- ****************************************** -->
<section>
<h2>Tooling</h2>
<ul>
<li>Maconomy Extender is the recommended tool</li>
<li>Chrome Developer Tools for debugging</li>
</ul>
</section>
<!-- ****************************************** -->
<section>
<h2>Chrome Developer Tools</h2>
<img src="assets/png/chrome-dev-tools.png">
</section>
<!-- ****************************************** -->
<section>
<h2>Best Practice</h2>
<p>Console logs, the Network tab and HAR files<br>are your new friends</p>
</section>
<!-- ****************************************** -->
<section>
<h2>Best Practice</h2>
<p>When running into weird behavior,<br>double-check with another client, e.g., WSC</p>
</section>
<!-- ****************************************** -->
<section>
<h2>Pro Tip</h2>
<p>While we wait for better tool support, consider <a href="https://code.visualstudio.com/">VS Code</a> for a better overview</p>
<div class="r-hstack">
<img style="width: 60%; margin-right: 20px;" src="assets/png/vs-code-1.png">
<img src="assets/png/vs-code-2.png">
</div>
</section>
<!-- ****************************************** -->
<section>
<h2>Upgrades</h2>
<ul>
<li>Currently, the Maconomy Extender does not provide special upgrade support</li>
<li>Patch upgrades does not require extension work but minor and major upgrades do</li>
<li>For minor and major upgrades, your JSON extensions must be copied to the new version folder</li>
</ul>
</section>
<!-- ****************************************** -->
<section>
<h2>Where can I get help?</h2>
<p><a href="https://help.deltek.com/Product/MaconomyiAccess/2.5/Documentation/InstallationGuide/#/">The Installation Manual</a></p>
<p><a href="https://teams.microsoft.com/l/channel/19%3a5ec71926ad1c4a889a1fb076f3cb5189%40thread.tacv2/UI-iAccess?groupId=e9ad63a6-1d64-4744-a8c7-1f7fd456cf4f&tenantId=37d75c7a-7cb8-4ef7-8a8f-2108fe6cadbe">Use the Maconomy Knowledge Center in MS Teams</a></p>
</section>
<!-- ****************************************** -->
<section>
<h2>Questions</h2>
<p>Go!</p>
</section>
<!-- ****************************************** -->
</div>
</div>
<script src="dist/reveal.js"></script>
<script src="plugin/notes/notes.js"></script>
<script src="plugin/markdown/markdown.js"></script>
<script src="plugin/highlight/highlight.js"></script>
<script>
// More info about initialization & config:
// - https://revealjs.com/initialization/
// - https://revealjs.com/config/
Reveal.initialize({
hash: true,
slideNumber: 'c/t',
// Learn about plugins: https://revealjs.com/plugins/
plugins: [RevealMarkdown, RevealHighlight, RevealNotes]
});
</script>
</body>
</html>