-
Notifications
You must be signed in to change notification settings - Fork 3
/
enums.py
1417 lines (1094 loc) · 39.9 KB
/
enums.py
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
from pykechain.utils import __dict__inherited__
class Enum:
"""Custom enumeration class to support class attributes as options.
Example
-------
>>> class Toppings(Enum):
... CHEESE = "Cheese"
... SALAMI = "Salami"
>>> topping_choice = Toppings.CHEESE
"""
@classmethod
def options(cls):
"""Provide a sorted list of options."""
return sorted(
(value, name)
for (name, value) in __dict__inherited__(cls=cls, stop=Enum).items()
)
@classmethod
def values(cls):
"""Provide a (sorted) list of values."""
return [value for (value, name) in cls.options()]
class Multiplicity(Enum):
"""The various multiplicities that are accepted by KE-chain.
For more information on the representation in KE-chain, please consult the KE-chain
`Part documentation`_.
:cvar ZERO_ONE: Multiplicity 0 to 1
:cvar ONE: Multiplicity 1
:cvar ZERO_MANY: Multiplicity 0 to infinity
:cvar ONE_MANY: Multiplicity 1 to infinity
"""
ZERO_ONE = "ZERO_ONE"
ONE = "ONE"
ZERO_MANY = "ZERO_MANY"
ONE_MANY = "ONE_MANY"
# M_N = "M_N" # not implemented
class Category(Enum):
"""The various categories of Parts that are accepted by KE-chain.
For more information on the representation in KE-chain, please consult the KE-chain
`Part documentation`_.
:cvar INSTANCE: Category of Instance
:cvar MODEL: Category of Model
"""
INSTANCE = "INSTANCE"
MODEL = "MODEL"
class Classification(Enum):
"""The various classification of Parts that are accepted by KE-chain.
For more information on the representation in KE-chain, please consult the KE-chain
`Part documentation`_.
:cvar PRODUCT: Classification of the part object is Product
:cvar CATALOG: Classification of the part object is a CATALOG
.. _Part documentation: https://support.ke-chain.com/confluence/dosearchsite.action?
queryString=concept+part
"""
PRODUCT = "PRODUCT"
CATALOG = "CATALOG"
FORM = "FORM"
class PropertyType(Enum):
"""The various property types that are accepted by KE-chain.
For more information on the representation in KE-chain, please consult the KE-chain
`Property documentation`_.
:cvar CHAR_VALUE: a charfield property (single line text)
:cvar TEXT_VALUE: text property (long text, may span multiple lines)
:cvar BOOLEAN_VALUE: a boolean value property (True/False)
:cvar INT_VALUE: integer property (whole number)
:cvar FLOAT_VALUE: floating point number property (with digits)
:cvar DATETIME_VALUE: a datetime value property
:cvar ATTACHMENT_VALUE: an attachment property
:cvar LINK_VALUE: url property
:cvar REFERENCE_VALUE: a reference property, a UUID value referring to other part model
.. versionadded:: 1.14
:cvar SINGLE_SELECT_VALUE: single select list property (choose from a list)
:cvar REFERENCES_VALUE: a multi reference property, a list of UUID values referring to
other part models
.. versionadded:: 3.6
:cvar ACTIVITY_REFERENCES_VALUE: Activity References Property
:cvar SCOPE_REFERENCES_VALUE: Scope References Property
:cvar SERVICE_REFERENCES_VALUE: Service Referenes Property
:cvar TEAM_REFERENCES_VALUE: Team References Property
:cvar USER_REFERENCES_VALUE: User References Property
:cvar FORM_REFERENCES_VALUE: Form References Property
:cvar CONTEXT_REFERENCES_VALUE: Context References Property
:cvar JSON_VALUE: Generic JSON storage Property
:cvar GEOJSON_VALUE: GEOJSON property to store map data
:cvar WEATHER_VALUE: Weather JSON property compatible with the response of weatherapi.com
:cvar DATE_VALUE: Date value
:cvar TIME_VALUE: Time value
:cvar DURATION_VALUE: Duration value
.. versionadded:: 3.19
:cvar STATUS_REFERENCES_VALUE: Status References Property
.. _Property documentation: https://support.ke-chain.com/confluence/dosearchsite.action?
queryString=concept+property
"""
CHAR_VALUE = "CHAR_VALUE"
TEXT_VALUE = "TEXT_VALUE"
BOOLEAN_VALUE = "BOOLEAN_VALUE"
INT_VALUE = "INT_VALUE"
FLOAT_VALUE = "FLOAT_VALUE"
DATETIME_VALUE = "DATETIME_VALUE"
DATE_VALUE = "DATE_VALUE"
TIME_VALUE = "TIME_VALUE"
DURATION_VALUE = "DURATION_VALUE"
ATTACHMENT_VALUE = "ATTACHMENT_VALUE"
LINK_VALUE = "LINK_VALUE"
SINGLE_SELECT_VALUE = "SINGLE_SELECT_VALUE"
MULTI_SELECT_VALUE = "MULTI_SELECT_VALUE"
REFERENCE_VALUE = "REFERENCE_VALUE"
REFERENCES_VALUE = "REFERENCES_VALUE"
ACTIVITY_REFERENCES_VALUE = "ACTIVITY_REFERENCES_VALUE"
SCOPE_REFERENCES_VALUE = "SCOPE_REFERENCES_VALUE"
SERVICE_REFERENCES_VALUE = "SERVICE_REFERENCES_VALUE"
FORM_REFERENCES_VALUE = "FORM_REFERENCES_VALUE"
CONTEXT_REFERENCES_VALUE = "CONTEXT_REFERENCES_VALUE"
STATUS_REFERENCES_VALUE = "STATUS_REFERENCES_VALUE"
TEAM_REFERENCES_VALUE = "TEAM_REFERENCES_VALUE"
USER_REFERENCES_VALUE = "USER_REFERENCES_VALUE"
STOREDFILE_REFERENCES_VALUE = "STOREDFILE_REFERENCES_VALUE"
JSON_VALUE = "JSON_VALUE"
GEOJSON_VALUE = "GEOJSON_VALUE"
WEATHER_VALUE = "WEATHER_VALUE"
class ActivityType(Enum):
"""The various Activity types that are accepted by KE-chain.
.. versionadded:: 2.0
:cvar TASK: a normal task
:cvar PROCESS: a subprocess (container) containing other tasks
"""
PROCESS = "PROCESS"
TASK = "TASK"
class ActivityClassification(Enum):
"""The classification of Activities that are accepted by KE-chain.
.. versionadded:: 2.0
.. versionchanged:: 3.2
Add 'APP' environment for KE-chain versions > 3.1
.. versionchanged:: 3.14
Add 'FORM' envornment for KE-chain versions > v2021.10
:cvar WORKFLOW: Classification of the activity is WORKFLOW
:cvar CATALOG: Classification of the activity is CATALOG
:cvar APP: Classification of the activity is APP
:cvar FORM: Classification of the activity is FORM
"""
WORKFLOW = "WORKFLOW"
CATALOG = "CATALOG"
APP = "APP"
FORM = "FORM"
class ActivityRootNames(Enum):
"""The classification of Activities that are accepted by KE-chain.
.. versionadded:: 2.0
.. versionchanged:: 3.2
Add 'APP' environment for KE-chain versions > 3.1
.. versionchanged:: 3.14
Add 'FORM' environment for KE-chain versions >= v2021.10
:cvar WORKFLOW_ROOT: Root of the activity is WORKFLOW_ROOT
:cvar CATALOG_ROOT: Root of the activity is CATALOG_ROOT (below are CATALOG tasks)
:cvar APP_ROOT: Root of the activity is APP_ROOT (below are APP 'tasks' ie. 'screems')
"""
WORKFLOW_ROOT = "WORKFLOW_ROOT"
CATALOG_ROOT = "CATALOG_ROOT"
APP_ROOT = "APP_ROOT"
FORM_ROOT = "FORM_ROOT"
activity_root_name_by_classification = {
ActivityClassification.WORKFLOW: ActivityRootNames.WORKFLOW_ROOT,
ActivityClassification.CATALOG: ActivityRootNames.CATALOG_ROOT,
ActivityClassification.APP: ActivityRootNames.APP_ROOT,
ActivityClassification.FORM: ActivityRootNames.FORM_ROOT,
}
class WidgetNames(Enum):
"""The various Names of the Widget that can be configured.
.. versionchanged:: 3.14
Added FORMMETAPANEL for KE-chain versions >= v2021.10
:cvar SUPERGRIDWIDGET: superGridWidget
:cvar PROPERTYGRIDWIDGET: propertyGridWidget
:cvar HTMLWIDGET: htmlWidget
:cvar FILTEREDGRIDWIDGET: filteredGridWidget
:cvar SERVICEWIDGET: serviceWidget
:cvar NOTEBOOKWIDGET: notebookWidget
:cvar ATTACHMENTVIEWERWIDGET: attachmentViewerWidget
:cvar TASKNAVIGATIONBARWIDGET: taskNavigationBarWidget
:cvar JSONWIDGET: jsonWidget
# KE-chain 3 only
:cvar SIGNATUREWIDGET: signatureWidget
:cvar CARDWIDGET: cardWidget
:cvar METAPANELWIDGET: metaPanelWidget
:cvar FORMMETAPANEL: formMetaPanelWidget
:cvar MULTICOLUMNWIDGET: multiColumnWidget
:cvar PROGRESSWIDGET: progressWidget
:cvar TASKSWIDGET: tasksWidget
:cvar SERVICECARDWIDGET: serviceCardWidget
:cvar DASHBOARDWIDGET: 'dashboardWidget'
:cvar SCOPEMEMBERS: 'scopeMembersWidget'
"""
SUPERGRIDWIDGET = "superGridWidget"
PROPERTYGRIDWIDGET = "propertyGridWidget"
HTMLWIDGET = "htmlWidget"
FILTEREDGRIDWIDGET = "filteredGridWidget"
SERVICEWIDGET = "serviceWidget"
NOTEBOOKWIDGET = "notebookWidget"
ATTACHMENTVIEWERWIDGET = "attachmentViewerWidget"
TASKNAVIGATIONBARWIDGET = "taskNavigationBarWidget"
JSONWIDGET = "jsonWidget"
METAPANELWIDGET = "metaPanelWidget"
FORMMETAPANELWIDGET = "formMetaPanelWidget"
MULTICOLUMNWIDGET = "multiColumnWidget"
SIGNATUREWIDGET = "signatureWidget"
CARDWIDGET = "cardWidget"
PROGRESSWIDGET = "progressWidget"
TASKSWIDGET = "taskWidget"
SERVICECARDWIDGET = "serviceCardWidget"
DASHBOARDWIDGET = "dashboardWidget"
SCOPEMEMBERS = "scopeMembersWidget"
PROJECTINFO = "projectInfoWidget"
class WidgetTypes(Enum):
"""The various widget types for the widget definitions available to the widget api.
.. versionchanged:: 3.14
Added FORMMETAPANEL for KE-chain versions >= v2021.10
:cvar UNDEFINED: Undefined Widget
:cvar PROPERTYGRID: Propertygrid widget
:cvar SUPERGRID: Supergrid widget
:cvar HTML: Html widget
:cvar FILTEREDGRID: Filteredgrid widget
:cvar SERVICE: Service widget
:cvar NOTEBOOK: Notebook widget
:cvar ATTACHMENTVIEWER: Attachmentviewer widget
:cvar TASKNAVIGATIONBAR: Tasknavigationbar widget
:cvar JSON: Json widget
:cvar METAPANEL: Metapanel widget
:cvar FORMMETAPANEL: The FormMetapanel widget
:cvar MULTICOLUMN: Multicolumn widget
:cvar SCOPE: Scope widget
:cvar THIRDPARTY: Thirdparty widget
:cvar PROGRESS: Progress widget
:cvar SIGNATURE: Signature widget
:cvar CARD: Card widget
:cvar TASKS: Tasks widget
:cvar WEATHER: Weather widget
:cvar SERVICECARD: Servicecard widget
:cvar DASHBOARD: Dashboard widget
:cvar SCOPEMEMBERS: Scopemembers widget
"""
UNDEFINED = "UNDEFINED"
PROPERTYGRID = "PROPERTYGRID"
SUPERGRID = "SUPERGRID"
HTML = "HTML"
FILTEREDGRID = "FILTEREDGRID"
SERVICE = "SERVICE"
NOTEBOOK = "NOTEBOOK"
ATTACHMENTVIEWER = "ATTACHMENTVIEWER"
TASKNAVIGATIONBAR = "TASKNAVIGATIONBAR"
JSON = "JSON"
METAPANEL = "METAPANEL"
FORMMETAPANEL = "FORMMETAPANEL"
MULTICOLUMN = "MULTICOLUMN"
SCOPE = "SCOPE"
THIRDPARTY = "THIRDPARTY"
PROGRESS = "PROGRESS"
SIGNATURE = "SIGNATURE"
CARD = "CARD"
TASKS = "TASKS"
WEATHER = "WEATHER"
SERVICECARD = "SERVICECARD"
DASHBOARD = "DASHBOARD"
SCOPEMEMBERS = "SCOPEMEMBERS"
PROJECTINFO = "PROJECTINFO"
WidgetCompatibleTypes = {
WidgetNames.SUPERGRIDWIDGET: WidgetTypes.SUPERGRID,
WidgetNames.PROPERTYGRIDWIDGET: WidgetTypes.PROPERTYGRID,
WidgetNames.HTMLWIDGET: WidgetTypes.HTML,
WidgetNames.FILTEREDGRIDWIDGET: WidgetTypes.FILTEREDGRID,
WidgetNames.SERVICEWIDGET: WidgetTypes.SERVICE,
WidgetNames.NOTEBOOKWIDGET: WidgetTypes.NOTEBOOK,
WidgetNames.ATTACHMENTVIEWERWIDGET: WidgetTypes.ATTACHMENTVIEWER,
WidgetNames.TASKNAVIGATIONBARWIDGET: WidgetTypes.TASKNAVIGATIONBAR,
WidgetNames.JSONWIDGET: WidgetTypes.JSON,
WidgetNames.METAPANELWIDGET: WidgetTypes.METAPANEL,
WidgetNames.FORMMETAPANELWIDGET: WidgetTypes.FORMMETAPANEL,
WidgetNames.MULTICOLUMNWIDGET: WidgetTypes.MULTICOLUMN,
WidgetNames.PROGRESSWIDGET: WidgetTypes.PROGRESS,
WidgetNames.SIGNATUREWIDGET: WidgetTypes.SIGNATURE,
WidgetNames.CARDWIDGET: WidgetTypes.CARD,
WidgetNames.TASKSWIDGET: WidgetTypes.TASKS,
WidgetNames.SERVICECARDWIDGET: WidgetTypes.SERVICECARD,
WidgetNames.DASHBOARDWIDGET: WidgetTypes.DASHBOARD,
WidgetNames.SCOPEMEMBERS: WidgetTypes.SCOPEMEMBERS,
WidgetNames.PROJECTINFO: WidgetTypes.PROJECTINFO,
}
default_metapanel_widget = dict(
name=WidgetNames.METAPANELWIDGET,
config=dict(),
meta=dict(
showAll=True,
),
)
class ActivityStatus(Enum):
"""The various Activity statuses that are accepted by KE-chain.
:cvar OPEN: status of activity is open
:cvar COMPLETED: status of activity is completed
"""
OPEN = "OPEN"
COMPLETED = "COMPLETED"
class ScopeStatus(Enum):
"""The various status of a scope.
.. versionchanged:: 3.0
The `TEMPLATE` ScopeStatus is deprecated in KE-chain 3
:cvar ACTIVE: Status of a scope is active (default)
:cvar CLOSED: Status of a scope is closed
:cvar TEMPLATE: Status of a scope is a template (not actively used)(deprecated in KE-chain 3.0)
:cvar DELETING: Status of a scope when the scope is being deleted
"""
ACTIVE = "ACTIVE"
CLOSED = "CLOSED"
TEMPLATE = "TEMPLATE"
DELETING = "DELETING"
class ScopeCategory(Enum):
"""The various categories of a scope.
.. versionadded::3.0
:cvar LIBRARY_SCOPE: The scope is a library scope
:cvar USER_SCOPE: The scope is a normal user scope
:cvar TEMPLATE_SCOPE: The scope is a template scope
"""
LIBRARY_SCOPE = "LIBRARY_SCOPE"
USER_SCOPE = "USER_SCOPE"
TEMPLATE_SCOPE = "TEMPLATE_SCOPE"
class ServiceType(Enum):
"""The file types of sim script.
:cvar PYTHON_SCRIPT: service is a python script
:cvar NOTEBOOK: service is a jupyter notebook
"""
PYTHON_SCRIPT = "PYTHON SCRIPT"
NOTEBOOK = "NOTEBOOK"
class ServiceEnvironmentVersion(Enum):
"""The acceptable versions of python where services run on.
:cvar PYTHON_3_6: Service execution environment is a python 3.6 container (unsupported)
:cvar PYTHON_3_7: Service execution environment is a python 3.7 container
:cvar PYTHON_3_8: Service execution environment is a python 3.8 container
:cvar PYTHON_3_9: Service execution environment is a python 3.9 container
:cvar PYTHON_3_10: Service execution environment is a python 3.10 container
:cvar PYTHON_3_6_NOTEBOOKS: execution environment is a python 3.6 container with jupyter
notebook preinstalled (unsupported)
:cvar PYTHON_3_8_NOTEBOOKS: execution environment is a python 3.8 container with jupyter
notebook preinstalled
:cvar PYTHON_3_9_NOTEBOOKS: execution environment is a python 3.9 container with jupyter
notebook preinstalled
:cvar PYTHON_3_10_NOTEBOOKS: execution environment is a python 3.10 container with jupyter
notebook preinstalled
"""
PYTHON_3_6 = "3.6" # unsupported
PYTHON_3_7 = "3.7"
PYTHON_3_8 = "3.8"
PYTHON_3_9 = "3.9"
PYTHON_3_10 = "3.10"
PYTHON_3_6_NOTEBOOKS = "3.6_notebook" # unsupported
PYTHON_3_8_NOTEBOOKS = "3.8_notebook"
PYTHON_3_9_NOTEBOOKS = "3.9_notebook"
PYTHON_3_10_NOTEBOOKS = "3.10_notebook"
class ServiceScriptUser(Enum):
"""The acceptable usertypes under which a (trusted) service is run.
:cvar KENODE_USER: Run as "kenode" user. Equivalent to a manager in a scope.
:cvar TEAMMANAGER_USER: Run as "kenode_team". Equivalent to a manager in a team.
(disabled until available)
:cvar CONFIGURATOR_USER: Run as "kenode_configurator". Equivalent to GG:Configurator.
"""
KENODE_USER = "kenode"
# TEAMMANAGER_USER = "kenode_team"
CONFIGURATOR_USER = "kenode_configurator"
class ServiceExecutionStatus(Enum):
"""The acceptable states of a running service.
:cvar LOADING: Execution is in LOADING state (next RUNNING, FAILED)
:cvar RUNNING: Execution is in RUNNING state (next COMPLETED, FAILED, TERMINATING)
:cvar COMPLETED: Execution is in COMPLETED state
:cvar FAILED: Execution is in FAILED state
:cvar TERMINATING: Execution is in TERMINATING state (next TERMINATED)
:cvar TERMINATED: Execution is in TERMINATED state
"""
LOADING = "LOADING"
RUNNING = "RUNNING"
COMPLETED = "COMPLETED"
FAILED = "FAILED"
TERMINATING = "TERMINATING"
TERMINATED = "TERMINATED"
class TeamRoles(Enum):
"""Roles that exist for a team member.
:cvar MEMBER: A normal team member
:cvar MANAGER: A team member that may manage the team (add or remove members, change team)
:cvar OWNER: The owner of a team
"""
MEMBER = "MEMBER"
MANAGER = "MANAGER"
OWNER = "OWNER"
class ScopeRoles(Enum):
"""
Roles that exist for a member of a scope.
:cvar MANAGER: owner of the scope, has full rights
:cvar SUPERVISOR: supervisor member of a scope, has the rights as leadmember and rights to
manage catalog tasks.
:cvar LEADMEMBER: elevated member, has assignment rights, no rights on App tasks or
Catalog tasks.
:cvar MEMBER: normal member, only has viewing rights
"""
MANAGER = "manager"
SUPERVISOR = "supervisor"
LEADMEMBER = "leadmember"
MEMBER = "member"
class ScopeMemberActions(Enum):
"""
Actions to be performed on the members of a scope.
:cvar ADD: add a member to the scope
:cvar REMOVE: delete a member from the scope
"""
ADD = "add"
REMOVE = "remove"
class ContextType(Enum):
"""Types of Contexts.
:cvar STATIC_LOCATION: Geolocation / Featurecollection context with a geolocation.
:cvar TIME_PERIOD: Time Period Context with start_date and due_date
:cvar TEXT_LABEL: generic textual label
"""
STATIC_LOCATION = "STATIC_LOCATION"
TIME_PERIOD = "TIME_PERIOD"
TEXT_LABEL = "TEXT_LABEL"
class ContextGroup(Enum):
"""
Context may have a context_group.
..versionadded: 3.11
This is for context API versions 1.2.0 or later.
:cvar UNDEFINED: UNDEFINED
:cvar DISCIPLINE: Discipline, in nl: Discipline
:cvar ASSET: Asset, in nl: Object, Kunstwerk
:cvar DEPARTMENT: Department, in nl: Onderdeel, Afdeling
:cvar PERIOD: Workperiod, in nl: Werkperiode
:cvar LOCATION: Location, in nl: Locatie
:cvar PHASE: Phase, in nl: Fase
:cvar REQUIREMENT: Requirement, in nl: Eis
:cvar EXTERNALID: External identifier, to be used to provide a generic link to an
external application
:cvar WORKPACKAGE: Workpackage, in nl: Werkpakket
"""
UNDEFINED = "UNDEFINED"
DISCIPLINE = "DISCIPLINE" # nl: Discipline
ASSET = "ASSET" # nl: Object, Kunstwerk
DEPARTMENT = "DEPARTMENT" # nl: Onderdeel, Afdeling
PERIOD = "WORKPERIOD" # nl: Werkperiode
LOCATION = "LOCATION" # nl: Locatie
PHASE = "PHASE" # nl: Fase
REQUIREMENT = "REQUIREMENT" # nl: Eis
EXTERNALID = "EXTERNALID"
WORKPACKAGE = "WORKPACKAGE" # nl: Werkpakket
class KechainEnv(Enum):
"""Environment variables that can be set for pykechain.
:cvar KECHAIN_URL: full url of KE-chain where to connect to eg: 'https://<some>.ke-chain.com'
:cvar KECHAIN_TOKEN: authentication token for the KE-chain user provided from KE-chain user
account control
:cvar KECHAIN_USERNAME: the username for the credentials
:cvar KECHAIN_PASSWORD: the password for the credentials
:cvar KECHAIN_SCOPE: the name of the project / scope. Should be unique, otherwise use scope_id
:cvar KECHAIN_SCOPE_ID: the UUID of the project / scope.
:cvar KECHAIN_FORCE_ENV_USE: set to 'true', '1', 'ok', or 'yes' to always use the environment
variables.
:cvar KECHAIN_SCOPE_STATUS: the status of the Scope to retrieve, defaults to None to retrieve
all scopes
:cvar KECHAIN_CHECK_CERTIFICATES: if the certificates of the URL should be checked.
"""
KECHAIN_FORCE_ENV_USE = "KECHAIN_FORCE_ENV_USE"
KECHAIN_URL = "KECHAIN_URL"
KECHAIN_TOKEN = "KECHAIN_TOKEN"
KECHAIN_USERNAME = "KECHAIN_USERNAME"
KECHAIN_PASSWORD = "KECHAIN_PASSWORD"
KECHAIN_SCOPE = "KECHAIN_SCOPE"
KECHAIN_SCOPE_ID = "KECHAIN_SCOPE_ID"
KECHAIN_SCOPE_STATUS = "KECHAIN_SCOPE_STATUS"
KECHAIN_CHECK_CERTIFICATES = "KECHAIN_CHECK_CERTIFICATES"
class SortTable(Enum):
"""The acceptable sorting options for a grid/table.
:cvar ASCENDING: Table is sorted in ASCENDING ORDER
:cvar DESCENDING: Table is sorted in DESCENDING ORDER
"""
ASCENDING = "ASC"
DESCENDING = "DESC"
class Alignment(Enum):
"""The alignment options for attachment viewer, navigation bar widgets and service widgets.
:cvar LEFT: Aligned to the left
:cvar CENTER: Aligned to the center
:cvar RIGHT: Aligned to the right
"""
LEFT = "left"
CENTER = "center"
RIGHT = "right"
class NavigationBarAlignment(Alignment):
"""The acceptable alignment options for a Navigation Bar Widget."""
pass
class SidebarItemAlignment(Enum):
"""The acceptable alignment options for sidebar button.
:cvar TOP: "top"
:cvar BOTTOM: "bottom"
"""
TOP = "top"
BOTTOM = "bottom"
class SidebarButtonAlignment(SidebarItemAlignment):
"""Compatibility enumeration class for the SidebarItemAlignment."""
pass
class SidebarType(Enum):
"""The types that can exist as a Sidebar Item.
:cvar BUTTON: a button,
:cvar CARD: a card
"""
BUTTON = "BUTTON"
CARD = "CARD"
class PaperSize(Enum):
"""The acceptable paper sizes options for a downloaded PDF.
:cvar A0: Paper of size A0
:cvar A1: Paper of size A1
:cvar A2: Paper of size A2
:cvar A3: Paper of size A3
:cvar A4: Paper of size A4
"""
A0 = "a0paper"
A1 = "a1paper"
A2 = "a2paper"
A3 = "a3paper"
A4 = "a4paper"
AUTO = "automatic"
class PaperOrientation(Enum):
"""The acceptable paper orientation options for a downloaded PDF.
:cvar PORTRAIT: Paper of orientation 'portrait'
:cvar LANDSCAPE: Paper of orientation 'landscape'
"""
PORTRAIT = "portrait"
LANDSCAPE = "landscape"
class PropertyVTypes(Enum):
"""The VTypes (or validator types) that are allowed in the json.
This corresponds to the various validator classes which SHOULD be named:
`vtype[0].upper() + vtype[1:]`
eg: 'numbericRangeValidator' has an implementation class of 'NumericRangeValidator'
.. versionadded:: 2.2
:cvar NONEVALIDATOR: noneValidator - No validation is done
:cvar NUMERICRANGE: numericRangeValidator
:cvar BOOLEANFIELD: booleanFieldValidator
:cvar REQUIREDFIELD: requiredFieldValidator
:cvar EVENNUMBER: evenNumberValidator
:cvar ODDNUMBER: oddNumberValidator
:cvar REGEXSTRING: regexStringValidator
:cvar SINGLEREFERENCE: 'singleReferenceValidator'
:cvar FILEEXTENSION: 'fileExtensionValidator'
:cvar FILESIZE: 'fileSizeValidator'
"""
NONEVALIDATOR = "noneValidator"
NUMERICRANGE = "numericRangeValidator"
BOOLEANFIELD = "booleanFieldValidator"
REQUIREDFIELD = "requiredFieldValidator"
EVENNUMBER = "evenNumberValidator"
ODDNUMBER = "oddNumberValidator"
REGEXSTRING = "regexStringValidator"
SINGLEREFERENCE = "singleReferenceValidator"
FILEEXTENSION = "fileExtensionValidator"
FILESIZE = "fileSizeValidator"
# fallback
ALWAYSALLOW = "alwaysAllowValidator"
class ValidatorEffectTypes(Enum):
"""The effects that can be attached to a validator.
.. versionadded:: 2.2
:cvar NONE_EFFECT: noneEffect
:cvar VISUALEFFECT: visualEffect
:cvar TEXT_EFFECT: textEffect
:cvar ERRORTEXT_EFFECT: errorTextEffect
:cvar HELPTEXT_EFFECT: helpTextEffect
"""
NONE_EFFECT = "noneEffect"
VISUALEFFECT = "visualEffect"
TEXT_EFFECT = "textEffect"
ERRORTEXT_EFFECT = "errorTextEffect"
HELPTEXT_EFFECT = "helpTextEffect"
class PropertyRepresentation(Enum):
"""
The Representation configuration to display a property value.
.. versionadded:: 3.0
.. versionchanged:: 3.11 added geocoordinate in line with KE-chain v2021.5.0
:cvar DECIMAL_PLACES: Amount of decimal places to show the number
:cvar SIGNIFICANT_DIGITS: Number (count) of significant digits to display the number
:cvar LINK_TARGET: configuration of a link to open the link in a new browsertab or not.
:cvar BUTTON: options to represent the choices of a select-list
:cvar THOUSANDS_SEPARATOR: option to display the thousand separator
:cvar AUTOFILL: option to autofill the content of the property
:cvar GEOCOORDINATE: option to display an alternative representation for the geocoordinate
:cvar USE_PROPERTY_NAME: option to display the name of a property for a part actvity ref prop
"""
DECIMAL_PLACES = "decimalPlaces"
SIGNIFICANT_DIGITS = "significantDigits"
LINK_TARGET = "linkTarget"
BUTTON = "buttonRepresentation"
THOUSANDS_SEPARATOR = "thousandsSeparator"
AUTOFILL = "autofill"
GEOCOORDINATE = "geoCoordinate"
USE_PROPERTY_NAME = "usePropertyName"
CAMERA_SCANNER_INPUT = "cameraScannerInput"
SIGNATURE = "signature"
FILE_DISPLAY = "fileDisplay"
SHOW_ONLY_SCOPE_MEMBERS = "showOnlyScopeMembers"
class FileDisplayRepresentationValues(Enum):
"""
Values that can be put in the FileDisplayRepresentationValues for representing stored files.
:cvar CARDS: thumbnails of attachments inside stored files, when applicable.
:cvar TEXT: name of the attachments inside stored files.
"""
CARDS = "CARDS"
TEXT = "TEXT"
class SignatureRepresentationValues(Enum):
"""
Values that can be put in the SignatureRepresentation for representing attachments as sigs.
:cvar CLEAN: a clean signature representation.
:cvar NAME_AND_DATE: A name and Date background to the signature field when filling in.
"""
CLEAN = "clean"
NAME_AND_DATE = "nameAndDate"
class GeoCoordinateConfig(Enum):
"""GeoCoordinate Configuration Enumerations.
:cvar APPROX_ADDRESS: represent the coordinate as approximate address (lookup by Google)
:cvar RD_AMERSFOORT: represent the coordinate as Amersfoort / RN New (epsg: 28992)
:cvar DD: represent the coordinate as Decimal Degrees (WGS84, epsg:4326)
:cvar DMS: represent the coordinate as as Degrees Minutes Seconds (WGS84, epsg:4326)
"""
APPROX_ADDRESS = "approx_address" # As approximated address
# Amersfoort/RD (epsg: 28992) https://www.spatialreference.org/ref/epsg/amersfoort-rd-new/
RD_AMERSFOORT = "rd_amersfoort"
DD = (
# As WSG84 (epsg:4326) decimal degrees representation first lat (-90,+90) then lng
# (-180,+180)
"dd"
)
DMS = (
# As WSG84 (epsg:4326) degrees, minutes, seconds representation first lat N/S then lng E/W
"dms"
)
class OtherRepresentations(Enum):
"""
Other representations used in KE-chain.
:cvar CUSTOM_ICON: different font-awesome icons
"""
CUSTOM_ICON = "customIcon"
class _AllRepresentations(PropertyRepresentation, OtherRepresentations):
pass
class ShowColumnTypes(Enum):
"""The columns that can be shown in a Property grid.
.. versionadded:: 2.3
:cvar UNIT: unit
:cvar DESCRIPTION: description
"""
UNIT = "unit"
DESCRIPTION = "description"
class ScopeWidgetColumnTypes(Enum):
"""The columns that can be shown in a Scope widget grid.
.. versionadded:: 3.0
:cvar PROJECT_NAME: Name
:cvar START_DATE: Start date
:cvar DUE_DATE: Due date
:cvar PROGRESS: Progress
:cvar STATUS: Status
:cvar TAGS: Tags
"""
PROJECT_NAME = "Name"
START_DATE = "Start date"
DUE_DATE = "Due date"
PROGRESS = "Progress"
STATUS = "Status"
TAGS = "Tags"
class FilterType(Enum):
"""The type of pre-filters that can be set on a Multi Reference Property.
.. versionadded:: 3.0
:cvar GREATER_THAN_EQUAL: 'gte'
:cvar LOWER_THAN_EQUAL: 'lte'
:cvar CONTAINS: 'icontains'
:cvar EXACT: 'exact'
"""
GREATER_THAN_EQUAL = "gte"
LOWER_THAN_EQUAL = "lte"
CONTAINS = "icontains"
CONTAINS_SET = "contains"
EXACT = "exact"
class ProgressBarColors(Enum):
"""
Some basic colors that can be set on a Progress Bar inside a Progress Bar Widget.
.. versionadded:: 3.0
:cvar BLACK: '#000000'
:cvar WHITE: '#FFFFFF'
:cvar RED: 'FF0000'
:cvar LIME: '#00FF00'
:cvar BLUE: '#0000FF'
:cvar YELLOW: '#FFFF00'
:cvar CYAN: '#00FFFF'
:cvar MAGENTA: '#FF00FF'
:cvar SILVER: '#C0C0C0'
:cvar GRAY: '#808080'
:cvar MAROON: '#800000'
:cvar OLIVE: '#808000'
:cvar GREEN: '#008000'
:cvar PURPLE: '#800080'
:cvar TEAL: '#008080'
:cvar NAVY: '#000080'
:cvar DEFAULT_COMPLETED: '#339447'
:cvar DEFAULT_IN_PROGRESS: '#FF6600'
:cvar DEFAULT_NO_PROGRESS: '#EEEEEE'
:cvar DEFAULT_IN_PROGRESS_BACKGROUND: '#FC7C3D'
"""
BLACK = "#000000"
WHITE = "#FFFFFF"
RED = "#FF0000"
LIME = "#00FF00"
BLUE = "#0000FF"
YELLOW = "#FFFF00"
CYAN = "#00FFFF"
MAGENTA = "#FF00FF"
SILVER = "#C0C0C0"
GRAY = "#808080"
MAROON = "#800000"
OLIVE = "#808000"
GREEN = "#008000"
PURPLE = "#800080"
TEAL = "#008080"
NAVY = "#000080"
DEFAULT_COMPLETED = "#339447"
DEFAULT_IN_PROGRESS = "#FF6600"
DEFAULT_NO_PROGRESS = "#EEEEEE"
DEFAULT_IN_PROGRESS_BACKGROUND = "#FC7C3D"
class LinkTargets(Enum):
"""
Target for the CardWidget link and Link property representations.
.. versionadded:: 3.0
:cvar SAME_TAB: "_self"
:cvar NEW_TAB: "_blank"
"""
SAME_TAB = "_self"
NEW_TAB = "_blank"
class CardWidgetLinkTarget(LinkTargets):
"""Target for the CardWidget, remaining for backwards compatibility."""
pass
class CardWidgetLinkValue(Enum):
"""
Link Value for the CardWidget.
.. versionadded:: 3.0
:cvar EXTERNAL_LINK: "External link"
:cvar TASK_LINK: "Task link"
:cvar NO_LINK: "No link"
"""
EXTERNAL_LINK = "External link"
TASK_LINK = "Task link"
TREE_VIEW = "Tree view"
NO_LINK = "No link"
class CardWidgetImageValue(Enum):
"""
Image for the CardWidget.
.. versionadded:: 3.0
:cvar CUSTOM_IMAGE: "Custom image"
:cvar NO_IMAGE: "No image"
"""
CUSTOM_IMAGE = "Custom image"
NO_IMAGE = "No image"
class KEChainPages(Enum):
"""
URL names of built-in KE-chain pages.
:cvar DETAIL: "detail"
:cvar FORMS: "forms"
:cvar TASKS: "activities"
:cvar WORK_BREAKDOWN: "activitytree"
:cvar CATALOG_FORMS: "catalogforms"
:cvar CONTEXTS: "contexts"
:cvar WORKFLOWS: "workflows"
:cvar DATA_MODEL: "productmodel"
:cvar EXPLORER: "product"
:cvar SERVICES: "scripts"
"""
DETAIL = "detail"
FORMS = "forms"
TASKS = "activities"
WORK_BREAKDOWN = "activitytree"
CATALOG_FORMS = "catalogforms"
CONTEXTS = "contexts"