-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapp_model_custom.yaml
1548 lines (1548 loc) · 36.8 KB
/
app_model_custom.yaml
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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
about:
date: 5/17/2024
recent_changes: custom app_model.yaml, api_root, altered Customer/Order/Employee attribute ordering, tab, captions, info, EmpType, dept emps, defaults, show_when, cascade add, toggles, images, security, login, virtual relns, global filters, no IsCommissioned, add expand template to Order, add mode - dialog and exclude - true for a few tables
api_root: '{http_type}://{swagger_host}:{port}/{api}'
authentication:
endpoint: '{http_type}://{swagger_host}:{port}/api/auth/#'
entities:
Category:
columns:
- enabled: true
exclude: false
label: ' Category Name*'
name: CategoryName
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Description
name: Description
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Client_id
name: Client_id
required: false
search: false
sort: false
template: integer
type: INTEGER
- enabled: true
exclude: false
label: Id
name: Id
required: false
search: false
sort: false
template: text
type: INTEGER
detail_template: detail_template.html
favorite: CategoryName
home_template: home_template.html
info_list: <h1>Tour - Application Information, Authorization</h1> <h2>Application
Information</h2> Info is set in the <span style="font-family:'Courier New'">ui/admin/admin.yaml</span>
file with <span style="font-family:'Courier New'">info_list</span> and <span
style="font-family:'Courier New'">info_show</span>. To show info... <ul> <li>On
the page, click (?) to see the info dialog box</li> <li>On the personalization
icon (upper right), click the (?) toggle to see info on the page</li> <li>In
the admin.yaml, set <span style="font-family:'Courier New'">info_toggle_checked</span></li>
</ul> Suggestion - visit the Customer, Department and Employee pages.<br><br>
<h2>Authorization</h2> The table includes 8 rows (login as 'admin' with password
'p', upper right).<br><br> But, logout and login as 'u1' -- only 1 is shown,
per <a target="_blank" href="https://apilogicserver.github.io/Docs/Security-Authorization/">authorization</a>.
<br><br>
mode: dialog
new_template: new_template.html
primary_key:
- Id
type: Category
Customer:
columns:
- enabled: true
exclude: false
label: Id
name: Id
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ' Company Name*'
name: CompanyName
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Balance
name: Balance
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: CreditLimit
name: CreditLimit
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: OrderCount
name: OrderCount
required: false
search: false
sort: false
template: integer
type: INTEGER
- enabled: true
exclude: false
label: UnpaidOrderCount
name: UnpaidOrderCount
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: Client_id
name: Client_id
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: ContactName
name: ContactName
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ContactTitle
name: ContactTitle
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Address
name: Address
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: City
name: City
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Region
name: Region
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: PostalCode
name: PostalCode
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Country
name: Country
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Phone
name: Phone
required: false
search: false
sort: false
template: phone
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Fax
name: Fax
required: false
search: false
sort: false
template: phone
type: VARCHAR(8000)
detail_template: detail_template.html
favorite: CompanyName
home_template: home_template.html
info_list: <h1>List Pages</h1> In this <a target="_blank" href="https://apilogicserver.github.io/Docs/Sample-Database/">Northwind
demo,</a> Info provides Tour suggestions (see Category for instructions). On
this page... <ul> <li> <strong>Search</strong> on multiple fields (Company,
Contact Name) -- try z</li> <li> <strong>Sort</strong> by column headers</li>
<li> <strong>Pagination</strong> (at bottom) to handle large result sets</li>
<li> <strong>Multi-page</strong> <ul> <li>Reset your search / sort so that <span
style="font-family:'Courier New'">Alfreds</span> is at the top </li> <li>Click
<span style="font-family:'Courier New'">Alfreds,</span> to "zoom in" to the
<i>show</i> page <ul><li>More info there</li></ul></li> </ul> </li> </ul> <br><br>
<h2>Authorization</h2> The table includes many rows (login as 'admin' with password
'p', upper right).<br><br> But, logout and login as 's1' -- only 1 is shown,
per <a target="_blank" href="https://apilogicserver.github.io/Docs/Security-Authorization/">authorization</a>.
See `security/declare_logic.py`. <br><br>
info_show: <h1>Multi-table</h1> <ul> <li><strong>Multi-Table Browsing - </strong>Note
the list of related orders <ul> <li><strong>Navigations - </strong> Click first
Order</li> </ul> </li> <li> <strong>Multi-Table Add - </strong> Add a New Order
<ul> <li>Observe several fields are not shown when inserting (e.g., Order.Id)</li>
<li>Observe that the Customer is filled in ("Cascade Add")</li> <li>Lookup an
Employee</li> <li><strong>Click Save and Show</strong></li> <li>Insert several
OrderDetails <ul> <li>Observe OrderId value is defaulted ("Cascade Add") and
not shown ("Show_when")</li> <li>Lookup a Product</li> <li>Click <strong>Save
and Add Another</strong> </li> <li>Lookup another Product, and click <strong>Add</strong>
to see the added Order </li> </ul> </li> </ul>
new_template: new_template.html
primary_key:
- Id
tab_groups:
- direction: tomany
exclude: false
fks:
- CustomerId
label: Placed Order List
name: OrderList
resource: Order
type: Customer
CustomerDemographic:
columns:
- enabled: true
exclude: false
label: ' Id*'
name: Id
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: CustomerDesc
name: CustomerDesc
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
detail_template: detail_template.html
favorite: Id
home_template: home_template.html
exclude: true
new_template: new_template.html
primary_key:
- Id
type: CustomerDemographic
Department:
columns:
- enabled: true
exclude: false
label: ' Department Name*'
name: DepartmentName
required: false
search: true
sort: true
template: text
type: VARCHAR(100)
- enabled: true
exclude: false
label: DepartmentId
name: DepartmentId
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: Id
name: Id
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: SecurityLevel
name: SecurityLevel
required: false
search: false
sort: false
template: text
type: INTEGER
detail_template: detail_template.html
favorite: DepartmentName
home_template: home_template.html
info_list: <h1>Tour - Authorization</h1> <h2>Global Security Filters</h2> Only
role sa & manager can view SecurityLevel > 0 - see security/declare_security.py
<br><br>
new_template: new_template.html
primary_key:
- Id
tab_groups:
- direction: tomany
exclude: false
fks:
- DepartmentId
label: DepartmentList
name: DepartmentList
resource: Department
- direction: toone
exclude: false
fks:
- DepartmentId
label: Department
name: Department
resource: Department
- direction: tomany
exclude: false
fks:
- OnLoanDepartmentId
label: Employees On Loan
name: EmployeeList
resource: Employee
- direction: tomany
exclude: false
fks:
- WorksForDepartmentId
label: Employees
name: EmployeeList1
resource: Employee
type: Department
Employee:
columns:
- enabled: true
exclude: false
label: ' Last Name*'
name: LastName
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: OnLoanDepartmentId
name: OnLoanDepartmentId
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: WorksForDepartmentId
name: WorksForDepartmentId
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: Salary
name: Salary
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: ProperSalary
name: ProperSalary
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: EmployeeType
name: EmployeeType
required: false
search: false
sort: false
template: text
type: VARCHAR(16)
- enabled: true
exclude: false
label: Dues
name: Dues
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: FirstName
name: FirstName
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Id
name: Id
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: Title
name: Title
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: TitleOfCourtesy
name: TitleOfCourtesy
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: BirthDate
name: BirthDate
required: false
search: false
sort: false
template: date
type: VARCHAR(8000)
- enabled: true
exclude: false
label: HireDate
name: HireDate
required: false
search: false
sort: false
template: date
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Address
name: Address
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: City
name: City
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Region
name: Region
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: PostalCode
name: PostalCode
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Country
name: Country
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: HomePhone
name: HomePhone
required: false
search: false
sort: false
template: phone
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Extension
name: Extension
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: Notes
name: Notes
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ReportsTo
name: ReportsTo
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: PhotoPath
name: PhotoPath
required: false
search: false
sort: false
template: text
type: Image
detail_template: detail_template.html
favorite: LastName
home_template: grid_template.html
grid_items: 'LastName, FirstName, HomePhone'
info_list: <h1>Show When</h1> Support for <a target="_blank" href="https://apilogicserver.github.io/Docs/Admin-Customization/#show_when">Show
When</a> means you can define expressions that determine when a field is shown
or hidden. On this page... <ul> <li> Click <strong>Suyama</strong> and note
<span style="font-family:'Courier New'">Dues</span> is hidden, but visible if
you click <strong>Steele</strong> <ul> <li> That is because <span style="font-family:'Courier
New'">Admin.yaml</span> has a expression for the <span style="font-family:'Courier
New'">show_when expression</span> for the <span style="font-family:'Courier
New'">Dues</span> field </li> </ul> </li> <li> Observe the same effect on Update
/ Insert screens as you alter the value of <span style="font-family:'Courier
New'">EmployeeType</span></li> </ul> <h1>Images</h1> Observe that "show" pages
support images. <h1>Virtual Relationships</h1> Observe that "show" pages have
tabs for Manages and Manager.<br> These foreign keys are *not* defined in the
database, but in <span style="font-family:'Courier New'">database/customize_models.py</span>.<br>
<h1>Derived Attributes</h1> <span style="font-family:'Courier New'">ProperSalary</span>
is not defined in the database.<br> See <span style="font-family:'Courier New'">database/customize_models.py</span>.<br>
new_template: new_template.html
primary_key:
- Id
tab_groups:
- direction: toone
exclude: false
fks:
- OnLoanDepartmentId
label: Department
name: Department
resource: Department
- direction: toone
exclude: false
fks:
- WorksForDepartmentId
label: Department1
name: Department1
resource: Department
- direction: tomany
exclude: false
fks:
- ReportsTo
label: Manages
name: Manages
resource: Employee
- direction: toone
exclude: false
fks:
- ReportsTo
label: Manager
name: Manager
resource: Employee
- direction: tomany
exclude: false
fks:
- EmployeeId
label: EmployeeAuditList
name: EmployeeAuditList
resource: EmployeeAudit
- direction: tomany
exclude: false
fks:
- EmployeeId
label: EmployeeTerritoryList
name: EmployeeTerritoryList
resource: EmployeeTerritory
- direction: tomany
exclude: false
fks:
- EmployeeId
label: OrderList
name: OrderList
resource: Order
- direction: toone
exclude: false
fks:
- UnionId
label: Union
name: Union
resource: Union
type: Employee
EmployeeAudit:
columns:
- enabled: true
exclude: false
label: ' Last Name*'
name: LastName
required: false
search: true
sort: true
template: text
type: VARCHAR
- enabled: true
exclude: false
label: EmployeeId
name: EmployeeId
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: Title
name: Title
required: false
search: false
sort: false
template: text
type: VARCHAR
- enabled: true
exclude: false
label: Salary
name: Salary
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: FirstName
name: FirstName
required: false
search: false
sort: false
template: text
type: VARCHAR
- enabled: true
exclude: false
label: CreatedOn
name: CreatedOn
required: false
search: false
sort: false
template: text
type: TEXT
- enabled: true
exclude: false
label: Id
name: Id
required: false
search: false
sort: false
template: text
type: INTEGER
detail_template: detail_template.html
favorite: LastName
home_template: home_template.html
exclude: true
new_template: new_template.html
primary_key:
- Id
tab_groups:
- direction: toone
exclude: false
fks:
- EmployeeId
label: Employee
name: Employee
resource: Employee
type: EmployeeAudit
EmployeeTerritory:
columns:
- enabled: true
exclude: false
label: ' Id*'
name: Id
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: TerritoryId
name: TerritoryId
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: EmployeeId
name: EmployeeId
required: true
search: false
sort: false
template: text
type: INTEGER
detail_template: detail_template.html
favorite: Id
home_template: home_template.html
new_template: new_template.html
primary_key:
- Id
tab_groups:
- direction: toone
exclude: false
fks:
- EmployeeId
label: Employee
name: Employee
resource: Employee
- direction: toone
exclude: false
fks:
- TerritoryId
label: Territory
name: Territory
resource: Territory
type: EmployeeTerritory
Location:
columns:
- enabled: true
exclude: false
label: ' country*'
name: country
required: true
search: true
sort: true
template: text
type: VARCHAR(50)
- enabled: true
exclude: false
label: city
name: city
required: true
search: false
sort: false
template: text
type: VARCHAR(50)
- enabled: true
exclude: false
label: notes
name: notes
required: false
search: false
sort: false
template: text
type: VARCHAR(256)
detail_template: detail_template.html
favorite: country
home_template: home_template.html
mode: dialog
new_template: new_template.html
primary_key:
- country
- city
tab_groups:
- direction: tomany
exclude: false
fks:
- Country
- City
label: OrderList
name: OrderList
resource: Order
type: Location
Order:
columns:
- enabled: true
exclude: false
label: Id
name: Id
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: EmployeeId
name: EmployeeId
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: ShippedDate
name: ShippedDate
required: false
search: false
sort: false
template: date
type: VARCHAR(8000)
- enabled: true
exclude: false
label: OrderDate
name: OrderDate
required: false
search: false
sort: false
template: date
type: DATE
- enabled: true
exclude: false
label: AmountTotal
name: AmountTotal
required: false
search: false
sort: false
template: currency
type: DECIMAL
- enabled: true
exclude: false
label: Ready
name: Ready
required: false
search: false
sort: false
template: checkbox
type: Boolean
- enabled: true
exclude: false
label: CloneFromOrder
name: CloneFromOrder
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: OrderDetailCount
name: OrderDetailCount
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: Freight
name: Freight
required: false
search: false
sort: false
template: text
type: DECIMAL
- enabled: true
exclude: false
label: Country
name: Country
required: false
search: false
sort: false
template: text
type: VARCHAR(50)
- enabled: true
exclude: false
label: City
name: City
required: false
search: false
sort: false
template: text
type: VARCHAR(50)
- enabled: true
exclude: false
label: RequiredDate
name: RequiredDate
required: false
search: false
sort: false
template: date
type: DATE
- enabled: true
exclude: false
label: CustomerId
name: CustomerId
required: true
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ' Ship Name*'
name: ShipName
required: false
search: true
sort: true
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ShipVia
name: ShipVia
required: false
search: false
sort: false
template: text
type: INTEGER
- enabled: true
exclude: false
label: ShipAddress
name: ShipAddress
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ShipCity
name: ShipCity
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ShipRegion
name: ShipRegion
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ShipZip
name: ShipZip
required: false
search: false
sort: false
template: text
type: VARCHAR(8000)
- enabled: true
exclude: false
label: ShipCountry
name: ShipCountry
required: false