-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
604 lines (568 loc) · 31.2 KB
/
index.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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LabVIEW Shortcut Provider</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0">
<link href="/assets/base.css" media="screen" rel="stylesheet" type="text/css" />
<link rel="shortcut icon" href="/assets/favicon.ico" />
<script src="https://kit.fontawesome.com/f98f757188.js" crossorigin="anonymous"></script>
<style>
table {
border-collapse: collapse;
width: 100%;
}
th, td {
padding: 8px;
text-align: left;
border-bottom: 1px solid #ddd;
}
</style>
</head>
<body>
<div class="wrapper">
<div class="profile">
<section class="profile-masthead" id="masthead">
<header class="profile-logo">
<div class="profile-logo-image">
<img alt="LabVIEW Shortcut Provider" src="/LabVIEW_Extensions_Small.png" />
</div>
<div class="profile-name">
<h1>LabVIEW Shortcut Provider</h1>
</div>
</header>
<aside class="profile-summary">
<div class="summary-location summary-module">
<a href="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/releases/tag/1.0.1"><img src="https://img.shields.io/github/v/release/BenjaminRLabVIEWExtensions/lvshortcut_provider?color=orange&logo=labview&style=for-the-badge" alt="GitHub all releases"></a>
<a href="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/wiki"><img src="https://img.shields.io/github/discussions/BenjaminRLabVIEWExtensions/lvshortcut_provider?style=for-the-badge" alt="Wiki"></a>
<a href="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/issues"><img src="https://img.shields.io/github/issues/BenjaminRLabVIEWExtensions/lvshortcut_provider?style=for-the-badge" alt="Issues"></a>
<a href="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/master/LICENSE"><img src="https://img.shields.io/badge/LICENSE-Zero--Clause%20BSD-green?style=for-the-badge" alt="Zero-Clause BSD"></a>
<a href="https://www.linkedin.com/in/benjaminrouffet/"><img src="https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555" alt="LinkedIn"></a>
</div>
</aside>
</section>
<section class="profile-content" id="content">
<!-- TODO header? -->
<div class="profile-description">
<p>Here is an example that demonstrates how to use the LabVIEW Project Provider framework to pimp you LabVIEW Project Explorer.</p>
</div>
<article class="profile-menu" id="menu">
<nav class="menu-navigation">
<ul class="menu-navigation-list">
</ul>
</nav>
<p>The idea. behind this plugin, is to be able to create Shortcuts, as we have on our desktop, to LabVIEW files directly within a LabVIEW project tree. This will allow developper to quickly open VIs, LVClass, RunTime Menu, ..., from the project tree root. </p>
<p>This plugin allows developpers to create a new Shorcut from the popup menu that appears when My Computer is right-clicked. </p>
<div align="left">
<img src="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/blob/19258dcda8c912aee9dc6a3dce5ce02596cf8418/docs/LVProjectShortcut_Popup_New.png?raw=true" alt="PopupMenuNew">
</div>
<p>The Create Shortcut wizard dialog helps the developper define the target file and name of a Shortcut. </p>
<div align="left">
<table style="width:30%" border="0px solid black">
<tr>
<th style="width:15%" border="0px solid black">Shortcut Wizard Target</th>
<th style="width:15%" border="0px solid black">Shortcut Wizard Name</th>
</tr>
<tr>
<td border="0px solid black"><img src="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/blob/19258dcda8c912aee9dc6a3dce5ce02596cf8418/docs/LVProjectShortcut_Wizard_1.png?raw=true" alt="Wizard1"></td>
<td border="0px solid black"><img src="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/blob/main/docs/LVProjectShortcut_Wizard_2.png?raw=true" alt="Wizard2"></td>
</tr>
</table>
</div>
<p>Once the wizard finished, the new Shortcut item appaers in the LabVIEW project tree with the default file type icon with a shortcut arrow overlay. </p>
<div align="left">
<img src="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/blob/19258dcda8c912aee9dc6a3dce5ce02596cf8418/docs/LVProjectShortcut_Item.png?raw=true" alt="Item">
</div>
<p>Double-click on a Shortcut to open it within the active project context. You can also select Open from the right-click menu. </p>
<p>You can edit a Shortcut, using the Edit item from the right-click menu, to either change the target nor change the name. You can also drag and drop any LabVIEW files on the Shortcut in the project tree. This action will ask for confirmation before updating the Shortcut. </p>
<div align="left">
<img src="https://github.com/BenjaminRLabVIEWExtensions/lvshortcut_provider/blob/19258dcda8c912aee9dc6a3dce5ce02596cf8418/docs/LVProjectShortcut_Item_Edit.png?raw=true" alt="Editor">
</div>
<div id="use-cases" class="menu-category">
<h3 class="menu-category-name">Use cases</h3>
<ul>
<li>Quick access to a DQMH Module Main VI to avoid librarie tree expansions.</li>
<li>Add item from the LabVIEW Tools menu to avoid clicks.</li>
</ul>
</div>
<div id="labview-project-providers" class="menu-category">
<h3 class="menu-category-name">LabVIEW Project Providers</h3>
<p>The LabVIEW Project Provider Framework is a previously internal-only feature for adding additional functionality to the LabVIEW Project Explorer. With it you can do things like add new items to the project window and modify existing items by adding extra right-click menu options, glyphs to the icons, extra toolbars, etc.</p>
<p>
<strong>The LabVIEW Project Provider framework is an unsupported feature of LabVIEW.</strong>
</p>
<p>If you’re interested in learning more about this framework, please visit the
<a href=benjaminrlabviewextensions.github.io/lvshortcut_provider/LabVIEW_Project_Provider_Framework.html>
LabVIEW Project Providers page
</a>.
</p>
<p>The LabVIEW Shortcut Provider is a primary LabVIEW Project Provider, responsible for putting one or more new shortcut item types into the project tree.</p>
</article>
</section>
</div>
</div>
<article class="profile-menu" id="menu">
<nav class="menu-navigation">
<ul class="menu-navigation-list">
</ul>
</nav>
<p>Prior LabVIEW 8.0, developers needed to </p>
<ul>
<li>handle files directly from disk. </li>
<li>use the application instance selection shortcut menu, at the the bottom left corner of the front panel window or block diagram, to set the application instance to run a VI. </li>
<li>use script to build applications. </li>
</ul>
<div id="labview-project-explorer" class="menu-category">
<h3 class="menu-category-name">LabVIEW Project Explorer</h3>
<p>The LabVIEW Project Explorer window was introduce in LabVIEW 8.0 to provide a way to group and organize VIs and libraries, hardware and I/O, multiple targets, create build specifications, and deploy or download files to targets.</p>
<p align="center">
<img src="/docs/lvProjectExplorer.png">
</p>
<p>The Project Explorer window includes the following items by default:</p>
<ul>
<li>Project root—Contains all other items in the Project Explorer window. This label on the project root includes the filename for the project.
<ul>
<li>My Computer: Represents the local computer as a target in the project.
<ul>
<li>Dependencies: Includes items that VIs under a target require, such as other VIs, shared libraries, and LabVIEW project libraries.</li>
<li>Build Specifications: Includes build configurations for source distributions and other types of builds available in LabVIEW toolkits and modules,such as:
<ul>
<li>Stand-alone applications.</li>
<li>Installers.</li>
<li>.NET interop assemblies.</li>
<li>Packed libraries.</li>
<li>Shared libraries.</li>
<li>Source distributions.</li>
<li>Web services.</li>
<li>Zip files.</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Refer to the following link to know more about the </p>
<ul>
<li><a href="https://zone.ni.com/reference/en-XX/help/371361R-01/lvconcepts/using_labview_projects/">Managing a Project in LabVIEW</a></li>
<li><a href="https://labviewwiki.org/wiki/Project_Explorer">LabVIEW Wiki - Project Explorer</a></li>
</ul>
<h4 id="labview-project-explorer-anatomy">LabVIEW Project Explorer Anatomy</h4>
<h5 id="project-item">Project Item</h5>
<p>A Project Item is an individual element in a LabVIEW Project, LabVIEW Project Library, LabVIEW Class, or XControl. Each element has its own name and an icon based on the item types. Each item can have a status and properties that can be saved into the project file on disk or stored in memory only. </p>
<p align="center">
<img src="/docs/projectItems.png" width="500" height="400">
</p>
<p>Overlays are smaller icons that appear on the Project Item's icon that show status or other properties.</p>
<ul>
<li>For LabIEW Project Libraries and LabVIEW Classes colored key icons show the access scope of the item.</li>
<li>For LabVIEW Classes and XControls a lock icon appears when the class or XControl is locked and won't allow editing.</li>
</ul>
<p>The actions that occur when an item is double clicked on can differ depending on its type , e.g., it can expand or collapse all sub-items, open or edit it, call an external application. </p>
<p>An item in the tree can be the source or the target for a drag-and-drop operation, e.g., drag and drop the Project Items to re-order them in the project tree, drag and drop Project Items onto another one to add it as nested Project Items. Drop any file, or multiple files and folders, into the Project Explorer to add it to the project.</p>
<h5 id="menu-items">Menu items</h5>
<p align="left">
<img src="/docs/menuItems.png">
</p>
<p>There are two basic types of menu items:</p>
<ul>
<li>the global menu items, which appear in the menu bar of the project window. These menu items appear independent of the item selected in the tree. </li>
<li>the item-specific menu items which apply to items of specific type in the project tree.</li>
</ul>
<h5 id="popup-menu-items">Popup menu items</h5>
<p align="left">
<img src="/docs/popupMenuItems.png">
</p>
<p>The popup menu items appears when an item is right-clicked. The menu can be different depending on the item selected and the state of the item.</p>
<h4 id="toolbar-buttons">Toolbar buttons</h4>
<p align="left">
<img src="/docs/toolbar.png">
</p>
<p>The Project toolbar on the Project Explorer window contains buttons, with a different icon, for instance:</p>
<ul>
<li>Open Project: displays the file dialog box from which you can select a LabVIEW project to open.</li>
<li>Save Project: saves the project.</li>
<li>Filter Project View: allows you to specify which nodes are visible in the Project Explorer window.</li>
<li>Project Properties: displays the Project Properties dialog box.</li>
<li>Resolve Conflicts: displays the Resolve Project Conflicts dialog box.</li>
</ul>
<p>The toolbar buttons can act globally or specifically to an item type. Global toolbar buttons are available regardless of which item is selected in the project tree. Item-specific toolbar buttons only show when an item of a specific type is selected in the tree.</p>
<p>The Toolbar buttons can be removed from the toolbar by right clicking on the project toolbar and deselecting the appropriate provider. You can also </p>
<h3 id="labview-project-provider-framework">LabVIEW Project Provider Framework</h3>
<p>The LabVIEW project window has a plug-in architecture to allow for easy extension of the project window features and capabilities. A Provider is code that plugs into this framework to provide additional set of functionality to a project that will apply:</p>
<ul>
<li>globally (to all items in the project).</li>
<li>item-specifically (to specific item types).</li>
</ul>
<p>You have 2 kinds of plug-ins: </p>
<ul>
<li>Primary: responsible for putting one or more new item types into the project tree. </li>
<li>Secondary Provider: adds additional functionality to existing items.</li>
</ul>
<h4 id="labview-project-provider-anatomy">LabVIEW Project Provider Anatomy</h4>
<p>A project provider is comprised of an INI file and a set of VIs. The INI file contains configuration information for the project. The VIs implement a set of interfaces that provide all the functionality of the provider.</p>
<h5 id="ini-file">INI File</h5>
<p>Each provider contains an INI file that describes the supported item type as well as the "interfaces VI's", that provide the locations of the plugin's functionality VIs. </p>
<p>The Project Provider INI File is located in the following directory:</p>
<ul>
<li>On Windows, <code><LabVIEW install directory>\resource\Framework\Providers\GProviders</code>. </li>
<li>On Mac OS, <code>/Applications/National Instruments/<LabVIEW XXXX 64-bit>/resource/Framework/Providers/GProviders</code>.</li>
</ul>
<p>Here Project Provider INI File token list:</p>
<details>
<summary>Project Provider INI File token List</summary>
<table style="width:30%" border="1px solid black">
<tr>
<th style="width:15%" border="1px solid black">Token</th>
<th style="width:15%" border="1px solid black">Description</th>
</tr>
<tr>
<td border="1px solid black">SupportedInterface</td>
<td border="1px solid black">Indicates which interfaces are supported by the provider.</td>
</tr>
<tr>
<td border="1px solid black">SupportedType</td>
<td border="1px solid black">Specifies a GUID that represents the type of project item. Must be formatted as following: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}.</td>
</tr>
<tr>
<td border="1px solid black">Alias</td>
<td border="1px solid black">Is a unique string that like the GUID, is used to identify the type of a project item (applies to Primary providers only). The SupportedType token in a secondary provider can point to the Alias of the item type it wants to attach to instead of the GUID.</td>
</tr>
<tr>
<td border="1px solid black">IsPrimary</td>
<td border="1px solid black">1 – Primary provider (defines a new item type in the project).
0 – Secondary provider (adds functionality to existing item(s) in the project).</td>
</tr>
<tr>
<td border="1px solid black">ItemInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the “Item” interface.</td>
</tr>
<tr>
<td border="1px solid black">ProviderInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the “Provider” interface.</td>
</tr>
<tr>
<td border="1px solid black">GlobalItemInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the ”Global” item interface.</td>
</tr>
<tr>
<td border="1px solid black">CreateNewWizardInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the “CreateNewWizard” interface.</td>
</tr>
<tr>
<td border="1px solid black">SourceControlInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the “SourceControl” interface.</td>
</tr>
<tr>
<td border="1px solid black">DeployInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the “Deploy” interface.</td>
</tr>
<tr>
<td border="1px solid black">BuildInterfaceVI</td>
<td border="1px solid black">Defines the VI that enumerates the “Build” interface.</td>
</tr>
<tr>
<td border="1px solid black">CreateNewWizardHost</td>
<td border="1px solid black">(Primary providers only) Defines which “New” menu to add to e.g., Source, Build.</td>
</tr>
<tr>
<td border="1px solid black">InterfaceVersion</td>
<td border="1px solid black">Specifies the interface version used by the provider. Currently, this must be set to 1.0.</td>
</tr>
<tr>
<td border="1px solid black">Signature</td>
<td border="1px solid black">Digital signature – generated by NI.</td>
</tr>
</table>
</details>
<p>GUID and Type strings identify items of a specific type. GUIDs can be used as supported types to build a provider for item of a specific type. Here is a list of important GUIDs and Type strings:</p>
<details>
<summary>GUIDs and Type strings List</summary>
<table style="width:55%" border="1px solid black">
<tr>
<th style="width:15%" border="1px solid black">Item type</th>
<th style="width:15%" border="1px solid black">Type String</th>
<th style="width:25%" border="1px solid black">GUID String</th>
</tr>
<tr>
<td border="1px solid black">Virtual Folder</td>
<td border="1px solid black">Folder</td>
<td border="1px solid black">{D60740D6-F254-4BBC-5675-8858F35B820E}</td>
</tr>
<td border="1px solid black">Auto Populating Folder</td>
<td border="1px solid black">Folder</td>
<td border="1px solid black">{D60740D6-F254-4BBC-5675-8858F35B820E}</td>
<tr>
<td border="1px solid black">VI</td>
<td border="1px solid black">VI</td>
<td border="1px solid black">{D60740D6-F254-4BBC-5675-8858F35B810E}</td>
<tr>
<td border="1px solid black">Control</td>
<td border="1px solid black">VI</td>
<td border="1px solid black">{D60740D6-F254-4BBC-5675-8858F35B810E}</td>
<tr>
<td border="1px solid black">(Non-LabVIEW) file</td>
<td border="1px solid black">Document</td>
<td border="1px solid black">{D60740D6-F255-4BBC-5675-8858F35B820E}</td>
<tr>
<td border="1px solid black">LLB-file</td>
<td border="1px solid black">Folder</td>
<td border="1px solid black">{D60740D6-F254-4BBC-5675-8858F35B820E}</td>
<tr>
<td border="1px solid black">Lvlib file</td>
<td border="1px solid black">Library</td>
<td border="1px solid black">{ABC740D6-F254-4BBC-5675-8858F35B820E}</td>
<tr>
<td border="1px solid black">LabVIEW class</td>
<td border="1px solid black">LVClass</td>
<td border="1px solid black">{EFD740D6-F254-4BBC-5675-8858F35B820E}</td>
<tr>
<td border="1px solid black">Class datatype</td>
<td border="1px solid black">Class Private Data</td>
<td border="1px solid black">{64A9BF48-4C55-45DB-8F18-9C796DA0C113}</td>
<tr>
<td border="1px solid black">Property Definition Folder</td>
<td border="1px solid black">Property Definition</td>
<td border="1px solid black">{81C68620-8BE3-4643-B04A-4E83AA6363D2}</td>
<tr>
<td border="1px solid black">LabVIEW XControl</td>
<td border="1px solid black">XControl</td>
<td border="1px solid black">{2E4BD3AC-4E04-45C9-B6C5-AD138962C435}</td>
<tr>
<td border="1px solid black">XControl Method</td>
<td border="1px solid black">Method VI</td>
<td border="1px solid black">{DAABD3DC-4F44-4C3D-8BA3-E5D035A4F27A}</td>
<tr>
<td border="1px solid black">XControl Property</td>
<td border="1px solid black">Property Folder</td>
<td border="1px solid black">{93C4A07A-46E9-442F-AF0F-D6C6039546D1}</td>
<tr>
<td border="1px solid black">XControl Property Read VI</td>
<td border="1px solid black">Property VI</td>
<td border="1px solid black">{DAABD3DB-4F44-4C3D-8BA3-E5D035A4F27A}</td>
<tr>
<td border="1px solid black">XControl Property Write VI</td>
<td border="1px solid black">Property VI</td>
<td border="1px solid black">{DAABD3DB-4F44-4C3D-8BA3-E5D035A4F27A}</td>
<tr>
<td border="1px solid black">XControl ability VI</td>
<td border="1px solid black">Ability VI</td>
<td border="1px solid black">{DAABD3DA-4F44-4C3D-8BA3-E5D035A4F27A}</td>
<tr>
<td border="1px solid black">DAQmx Task</td>
<td border="1px solid black">NI-DAQmx Task</td>
<td border="1px solid black">{0A806145-1BF3-3A50-0B5E-F969F56C8E2A}</td>
<tr>
<td border="1px solid black">DAQmx Virtual Channel</td>
<td border="1px solid black">NI-DAQmx Channel</td>
<td border="1px solid black">{B5F05770-7C71-3A03-C9FB-F73F35629FC1}</td>
<tr>
<td border="1px solid black">DAQmx Scale</td>
<td border="1px solid black">NI-DAQmx Scale</td>
<td border="1px solid black">{BC977C97-1833-3D51-4EF6-D82E6838A8F3}</td>
<tr>
<td border="1px solid black">Shared Network Variable</td>
<td border="1px solid black">Variable</td>
<td border="1px solid black">{9BA597C5-4996-4622-B9BB-444431834D0D}</td>
<tr>
<td border="1px solid black">Hyperlink</td>
<td border="1px solid black">Hyperlink</td>
<td border="1px solid black">{CC472C20-0441-48DC-AF25-3E82ECC9376F}</td>
<tr>
<td border="1px solid black">Dependencies</td>
<td border="1px solid black">Dependencies</td>
<td border="1px solid black">{0D75D917-83D7-9871-AA09-A0FFD6A8099B}</td>
<tr>
<td border="1px solid black">Build Specifications</td>
<td border="1px solid black">Build</td>
<td border="1px solid black">{0C750917-83D7-9871-8908-BB4ED6A8099B}</td>
<tr>
<td border="1px solid black">Application exe</td>
<td border="1px solid black">EXE</td>
<td border="1px solid black">{9A75366A-79D3-4BFD-9532-E3070185C1E8}</td>
<tr>
<td border="1px solid black">DLL</td>
<td border="1px solid black">DLL</td>
<td border="1px solid black">{20A41099-3F2C-42C3-9544-7ABCC1E6CB0D}</td>
<tr>
<td border="1px solid black">Zip</td>
<td border="1px solid black">Build Specifications</td>
<td border="1px solid black">{51F0E16F-7FA4-4E9F-AE30-C81D9D0444B0}</td>
<tr>
<td border="1px solid black">My Computer</td>
<td border="1px solid black">My Computer</td>
<td border="1px solid black">{CEFE1B10-1732-4678-A70A-299293455410}</td>
<tr>
<td border="1px solid black">Source Distribution</td>
<td border="1px solid black">Source Distribution</td>
<td border="1px solid black">{15DA4F9E-0591-4AB1-A339-C3B4D54902D8}</td>
<tr>
<td border="1px solid black">Packed Library</td>
<td border="1px solid black">Packed Library</td>
<td border="1px solid black">{E4492117-CED3-4F31-9F8D-E2118AE04F12}</td>
</tr>
</table>
</details>
<blockquote>
<p><strong>:memo: The INI file needs to be signed.</strong></p>
<p>For LabVIEW to load a Project Provider, its INI file must contain a valid "signature" consisting of an enciphered MD5 hash of certain other values in the INI file.</p>
</blockquote>
<p>It is a 5 step algorithm that is used to sign tokens:
1- Retrieve the values (not the keys) as strings from the INI file and concatenate them with no delimiters.
2- Compute MD5 message-digest.
3- Replace the 0123456789ABCDEF's within the MD5 message-dogest by the T3C5K7W9SBNRJLX2's
4- Switch each pair of two consecutive digits
5- Set the calculated signature to the proper token in the INI file.</p>
<p align="center">
<img src="/docs/computeSignature.png">
</p>
<p>To read/write the INI file we can't use the classic INI File VIs because we can have the same token multiple times, such as supportedtype.</p>
<p align="center">
<img src="/docs/signIniFile.png">
</p>
<p>INI File example:</p>
<p align="left">
<img src="/docs/iniFile.png">
</p>
<h4 id="interface-vis">Interface VIs</h4>
<p>The interface VIs tells the framework which VI's need to be run when a Project Item event occurs. They consist of a list of VI paths that point to each of the required methods that the providers must implement. You can completely customize these VIs event if you must conform to the particular connector pane. </p>
<p>The following interfaces are available for a provider:</p>
<ul>
<li><strong>Build</strong> (Primary providers only): defines events that apply to builds, i.e. items under Build Specifications, in the project tree.
Interface Method VIs:
<ul>
<li>Invoke</li>
<li>Preview</li>
<li>IsRunnable</li>
<li>Run</li>
<li>OnDuplicate</li>
</ul>
</li>
</ul>
<hr>
<ul>
<li><strong>CreateNewWizard</strong> (Primary providers only): defines events that occur while adding items of new types to the project tree.
Interface Method VIs:
<ul>
<li>Init</li>
<li>Invoke</li>
<li>Finalize</li>
<li>GetNewItemInfo</li>
<li>GetCreateNewWeight</li>
<li>IncludeItem</li>
</ul>
</li>
</ul>
<hr>
<ul>
<li><strong>Global</strong> : defines global-level events that are not tied into a specific item type.Interface Method VIs:
<ul>
<li>Init</li>
<li>Exit</li>
<li>OnCommand</li>
<li>OnUpdateCommand</li>
</ul>
</li>
</ul>
<hr>
<ul>
<li><strong>Item</strong> : defines events that occur to individual items in the project tree. Interface Method VIs:
<ul>
<li>Init</li>
<li>Exit</li>
<li>OnCommand</li>
<li>OnUpdateCommand</li>
</ul>
</li>
</ul>
<hr>
<ul>
<li><strong>ProjectDeployItem</strong> : defines events that support deploying of an item in the project tree. Interface Method VIs:
<ul>
<li>GetSupportedCommands</li>
<li>GetDeployState</li>
<li>NotifyCommandCompleted</li>
</ul>
</li>
</ul>
<hr>
<ul>
<li><strong>Provider</strong> : defines events that occur to multiple items in the project tree.Interface Method VIs:
<ul>
<li>InitItems</li>
<li>OnSaveProject</li>
<li>LoadComplete</li>
<li>OnCommand</li>
<li>OnSaveForPrevious</li>
<li>LoadCompleteWithWarnings</li>
<li>Startup</li>
<li>OnSaveForPreviousEx</li>
<li>OnUpdateCommandBegin</li>
<li>Shutdown</li>
<li>OnSaveForPreviousWithWarnings</li>
<li>OnUpdateCommandEnd</li>
<li>OnPopUpMenu</li>
<li>NotifyChanged</li>
</ul>
</li>
</ul>
<hr>
<ul>
<li><strong>SourceControl</strong> : defines events that apply to source code control functionality.
Interface Method VIs:
<ul>
<li>GetRequiredFiles</li>
<li>GetDependents</li>
<li>GetCaller</li>
</ul>
</li>
</ul>
<h4 id="directory-structure">Directory Structure</h4>
<p>All the VI-based providers and provider APIs can be found at:</p>
<ul>
<li>On Windows:<code><LabVIEW install directory>/resource/Framework/Providers/</code>. </li>
<li>On Mac OS: <code>/Applications/National Instruments/<LabVIEW XXXX 64-bit>/resource/Framework/Providers/</code>.</li>
</ul>
<p>This directory further contains following directories:</p>
<ul>
<li><p><strong>API</strong> : this directory contains type-definition controls defining the specifications for the various interface VIs. It also contains several helpful VIs that can be used from within the provider framework to perform frequent provider tasks, e.g., getting or setting project item properties.</p>
</li>
<li><p><strong>Common</strong> : this directory also contains reusable VIs that are useful to writing providers. They are simple VIs and unlike the API VIs do not call into the provider framework.</p>
</li>
<li><p><strong>GProviders</strong> : this directory was introduced in LabVIEW 2011. It is mandatory to have all the INI files in this directory for LabVIEW versions post-2010 for the providers to be loaded. This change is backward-compatible: a provider with its INI in the GProviders directory behaves the same way in a previous version of LabVIEW. It is highly recommended to follow this standard while building providers with any version of LabVIEW.</p>
</li>
<li><p><strong>Icons</strong> : this is the recommended location for all your provider icons. You can place icons at other locations as well but remember to specify the path with respect to the INI file location when setting the icons in provider VIs.</p>
</li>
<li><p><strong><code><Provider></code></strong> : each provider should be located in a separate directory under:</p>
<ul>
<li>On Windows: - On Windows:<code><LabVIEW install directory>/resource/Framework/Providers/</code>. </li>
<li>On Mac OS: <code>/Applications/National Instruments/<LabVIEW XXXX 64-bit>/resource/Framework/Providers/</code>.</li>
</ul>
</li>
</ul>
<p> :bulb: This is not strictly enforced but is highly recommended.</p>
<h4 id="api-vis">API VIs</h4>
<p>The VIs in the API directory call into the provider framework to implement their functionality. A descriptive list of these VIs can be found in the dedicated “API VIs” page.</p>
<h3 id="context">Context</h3>
<p>The VIs under provider framework run in the <code>NI.LV.MxLvProvider</code> context. This can be observed on the front panel of a VI running the provider framework, as shown below:</p>
<p align="center">
<img src="/docs/context.png" width="400" height="200">
</p>
<p>This can make the VIs behave differently than VIs that run under the <code><ProjectName>/My Computer</code> context. Also, the front panels of VIs to be executed under provider framework</p>
</div>
should be designed to not display this information to the user by hiding the scroll bars. </p>
</article>
</div>
<footer class="footer">
<nav class="footer-navigation">
<i class="icon-square-footer"></i>
<ul class="footer-navigation-list">
<li class="footer-navigation-item"><a href="benjaminrlabviewextensions.github.io/lvshortcut_provider/LabVIEW%20Project%20Provider%20Framework">Home</a></li>
<li class="footer-navigation-item"><a href="/about">About</a></li>
<li class="footer-navigation-item"><a href="/aboutme">About Me</a></li>
</ul>
<p class="copyright">© 2022 BenjaminR, maintained by <a href="https://github.com/Benji667">BenjaminR</a>.</p>
</nav>
</footer>
</body>
</html>