-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathsetup_definition.xsd
1141 lines (1083 loc) · 55.4 KB
/
setup_definition.xsd
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
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
targetNamespace="http://www.ableneo.com/liferay/setup" xmlns="http://www.ableneo.com/liferay/setup"
version="2.2">
<!-- definitions of elements start -->
<xs:element name="setup">
<xs:annotation>
<xs:appinfo>Liferay Setup Configuration</xs:appinfo>
<xs:documentation xml:lang="en">
This configuration is used to setup Liferay DB with desired entities. It can be applied to: default,
one, many Liferay instances at once. Additionally one can specify the groups on which the setup will
take place.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<!-- specify the email address of user, which will be used for performing
all operations within setup hook -->
<xs:element ref="configuration" minOccurs="1" maxOccurs="1"/>
<xs:element name="company-settings" type="CompanySettings" minOccurs="0" maxOccurs="1"/>
<xs:element ref="roles" minOccurs="0"/>
<xs:element ref="user-groups" minOccurs="0"/>
<xs:element ref="users" minOccurs="0"/>
<xs:element ref="resource-permissions" minOccurs="0" maxOccurs="1"/>
<xs:element ref="sites" minOccurs="0"/>
<xs:element ref="organizations" minOccurs="0"/>
<xs:element ref="custom-fields" minOccurs="0" maxOccurs="1"/>
<xs:element ref="delete-liferay-objects" minOccurs="0" maxOccurs="1"/>
<xs:element maxOccurs="1" minOccurs="0" ref="page-templates"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="configuration">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" ref="run-as-user-email"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="company"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="roles">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="role"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="users">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="user"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="user-groups">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="user-group"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="resource-permissions">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="resource">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="actionId">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="role"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="resource-id" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="organizations">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="organization"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="sites">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="site"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="objects-to-be-deleted">
<xs:complexType>
<xs:choice>
<xs:element ref="roles" minOccurs="0"/>
<xs:element ref="users"/>
<xs:element ref="organizations"/>
<xs:element ref="sites"/>
<xs:element ref="custom-fields"/>
</xs:choice>
<xs:attribute name="deleteMethod" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="excludeListed"/>
<xs:enumeration value="onlyListed"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="run-as-user-email" type="xs:string">
<xs:annotation>
<xs:documentation>
Specify the email address of user, which will be used for performing all operations within setup hook or
specific company. When empty: random user that has Administrator role within a company will be used.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="company">
<xs:annotation>
<xs:documentation>
Used to define companies and groups on whose below defined setup configuration will run. When not
specified setup will only take place on default company and "Guest" group within.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="run-as-user-email" minOccurs="0" maxOccurs="1"></xs:element>
<xs:choice minOccurs="1">
<xs:element name="companyid" type="xs:long"></xs:element>
<xs:element name="companywebid" type="xs:string"></xs:element>
</xs:choice>
<xs:element name="group-name" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Setup configuration will be executed on every provided group or only on "Guest" group if
none is provided. If you need separate setups for different groups create different
configuration file per group and execute all of them.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="organization">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" ref="site"/>
<xs:element ref="custom-field-setting" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="organization" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string"/>
<xs:attribute name="maintain-organization-hierarchy" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="site">
<xs:complexType>
<xs:sequence>
<xs:element name="public-pages" type="PagesType" maxOccurs="1" minOccurs="0"/>
<xs:element name="private-pages" type="PagesType" maxOccurs="1" minOccurs="0"/>
<xs:element ref="document-folder" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="document" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="article-structure" type="StructureType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="article-template" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="article-folder" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="article" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="adt" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="vocabulary" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="staging" minOccurs="0" maxOccurs="1"/>
<xs:element name="ddl-structure" type="StructureType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ddl-recordset" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="custom-field-setting" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="membership" minOccurs="0"/>
<xs:element ref="site" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="menu" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="name-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="site-preferences" type="SitePreferencesType" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="default" type="xs:boolean" default="false"/>
<xs:attribute name="global" type="xs:boolean" default="false"/>
<xs:attribute name="strict-web-folder-definition" type="xs:boolean" default="false"/>
<xs:attribute name="strict-document-folder-definition" type="xs:boolean" default="false"/>
<xs:attribute name="maintain-site-hierarchy" type="xs:boolean" default="false"/>
<xs:attribute name="site-friendly-url" type="xs:string" />
<xs:attribute name="name" type="xs:string"/>
<xs:attribute name="membership-type" type="xs:int" default="2">
<xs:annotation>
<xs:documentation>Uses GroupConstants.TYPE_SITE_* values, default is 'restricted'==2
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="membership">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="user-group-as-member"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="user-as-member"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="role"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="page-templates">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="1" ref="page-template"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="page-template">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="page" type="PageType"/>
<xs:element maxOccurs="1" minOccurs="0" ref="theme"/>
<xs:element name="title-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="page-portlet" type="PagePortletType"/>
<xs:element name="menu-view-portlet" type="MenuViewPortletType"/>
<xs:element name="article-display-portlet" type="ArticleDisplayPortletType"/>
<xs:element name="asset-publisher-portlet" type="AssetPublisherPortletType"/>
<xs:element name="portlet-preference">
<xs:annotation>
<xs:appinfo>W3Schools Note</xs:appinfo>
<xs:documentation xml:lang="en">
Resolves a portlet-preference value with any of the following resolver expressions to a corresponding
value:
<ul>
<li>{{$ARTICLE-ID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ARTICLE-UUIID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ARTICLE-RESID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-TEMPLATE-ID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-TEMPLATE-UUID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-STRUCTURE-ID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-STRUCTURE-UUID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ADT-TEMPLATE-ID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ADT-TEMPLATE-UUID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$FILE-URL=[:: name of the site ::]< documents and media folder path to the file ><
documents and media folder title of the file >$}}
</li>
<li>{{$FILE-ID=[:: name of the site ::]< documents and media folder path to the file ><
documents and media folder title of the file >$}}
</li>
<li>{{$FILE-UUID=[:: name of the site ::]< documents and media folder path to the file ><
documents and media folder title of the file >$}}
</li>
<li>{{$CLASS-ID-BY-NAME=< fully qualified class name >$}}</li>
<li>{{$PRIV-PAGE-ID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the private page
>$}}
</li>
<li>{{$PUB-PAGE-ID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page >$}}</li>
<li>{{$PRIV-PAGE-PLID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the private page
>$}}
</li>
<li>{{$PUB-PAGE-PLID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page
>$}}
</li>
<li>{{$PUB-PAGE-UUID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page
>$}}
</li>
<li>{{$DDL-REC-SET-ID-BY-KEYL=[:: name of the site ::]< key of the DDL record set >$}}</li>
<li>{{ID_OF_ORG_WITH_NAME=< name of the organization >$}}</li>
<li>{{UUID_OF_ORG_WITH_NAME=< name of the organization >$}}</li>
<li>{{ID_OF_USER_GROUP_WITH_NAME=< name of the user group >$}}</li>
<li>{{UUDID_OF_USER_GROUP_WITH_NAME=< name of the user group >$}}</li>
</ul>
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:simpleContent>
<xs:extension base="xs:string"> <!-- Base type is string to allow text content -->
<xs:attribute name="key" type="xs:string" use="required"/> <!-- Key attribute is required -->
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="role">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" ref="define-permissions"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="type" use="optional" default="regular">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="regular"/>
<xs:enumeration value="site"/>
<xs:enumeration value="organization"/>
<xs:enumeration value="provider"/>
<xs:enumeration value="depot"/>
<xs:enumeration value="account"/>
<xs:enumeration value="publications"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<!-- Site or organization name (depend of the role type)-->
<xs:attribute name="site" use="optional" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="role-permissions">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="role-permission" type="RolePermissionType" minOccurs="0"/>
<xs:element maxOccurs="unbounded" name="remove-role-permission" type="RolePermissionType"
minOccurs="0"/>
</xs:sequence>
<xs:attribute name="clear-permissions" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="role-permission" type="RolePermissionType"/>
<xs:element name="permission-action">
<xs:complexType>
<xs:attribute name="action-name" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="menu">
<xs:complexType>
<xs:sequence>
<xs:element ref="menuItem" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="clear-beforehand" use="optional" type="xs:boolean" default="true"/>
</xs:complexType>
</xs:element>
<xs:element name="menuItem">
<xs:complexType>
<xs:sequence>
<xs:element ref="menuItem" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="custom-field-setting" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="type" use="required" type="xs:string"/>
<xs:attribute name="type-settings" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="user">
<xs:complexType>
<xs:sequence>
<xs:element ref="organization" maxOccurs="unbounded" minOccurs="0"/>
<xs:element ref="role" maxOccurs="unbounded" minOccurs="0"/>
<xs:element ref="user-group" maxOccurs="unbounded" minOccurs="0"/>
<xs:element ref="custom-field-setting" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="screen-name" use="required" type="xs:string"/>
<xs:attribute name="email-address" use="required" type="xs:string"/>
<xs:attribute name="password" use="required" type="xs:string"/>
<xs:attribute name="first-name" use="required" type="xs:string"/>
<xs:attribute name="last-name" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="user-group">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element maxOccurs="unbounded" ref="role"/>
<xs:element ref="custom-field-setting" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="user-as-member" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="description" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="user-as-member">
<xs:annotation>
<xs:appinfo>Represents a generic reference to User as a member of other entity.</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="role" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="screen-name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="user-group-as-member">
<xs:annotation>
<xs:appinfo>Represents a generic reference to UserGroup as a member of other entity.</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element ref="role" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="user-group-name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="define-permissions">
<xs:annotation>
<xs:appinfo>Defining Permissions for Roles</xs:appinfo>
<xs:documentation xml:lang="en">
Extract the resource permissions defined for each role:
<br/>
<br/>
SELECT resourcePermissionId, companyId, name, scope, primKey, roleId, ownerId, actionIds
<br/>
FROM ResourcePermission
<br/>
WHERE (roleId = <Role_.roleId>)
<br/>
<br/>
and write down as XML
<br/>
<br/>
<define-permission define-permission-name="<ResourcePermission.name>"><br/>
... resource actions ...
<br/>
</define-permission><br/>
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="define-permission" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="clear-permissions" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="define-permission">
<xs:annotation>
<xs:appinfo>Defining Permission Actions for Roles</xs:appinfo>
<xs:documentation xml:lang="en">
Extract the resource actions that belong to the corresponding resource permission (TransactSQL Dialect):
<br/>
<br/>
SELECT ra.actionId
<br/>
FROM [dbo].[ResourcePermission] rp,
<br/>
[dbo].[]ResourceAction ra
<br/>
where roleid = <roleid> and ra.name = rp.name and ((rp.actionids & ra.bitwiseValue) <>
0) and ra.name = '<name of the resource>'
<br/>
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="permission-action" minOccurs="1"/>
</xs:sequence>
<xs:attribute name="define-permission-name" use="required" type="xs:string"/>
<xs:attribute name="element-primary-key" type="xs:string"/>
<xs:attribute name="scope" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="portal"/>
<xs:enumeration value="site"/>
<xs:enumeration value="site template"/>
<xs:enumeration value="individual"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="custom-fields">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="field">
<xs:complexType>
<xs:sequence>
<xs:element ref="role-permission" maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="name" use="required"/>
<xs:attribute name="type" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="stringArray"/>
<xs:enumeration value="string"/>
<xs:enumeration value="int"/>
<xs:enumeration value="boolean"/>
<xs:enumeration value="date"/>
<xs:enumeration value="long"/>
<xs:enumeration value="double"/>
<xs:enumeration value="float"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="class-name" use="required"/>
<xs:attribute name="indexed" use="optional" default="none">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="none"/>
<xs:enumeration value="text"/>
<xs:enumeration value="keyword"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="display-type" use="optional" default="text-box">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="checkbox"/>
<xs:enumeration value="radio"/>
<xs:enumeration value="selection-list"/>
<xs:enumeration value="text-box"/>
<xs:enumeration value="input-field"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="localized-value" use="optional" default="false" type="xs:boolean"/>
<xs:attribute name="default-data" use="optional"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="custom-field-setting">
<xs:complexType>
<xs:attribute name="key" type="xs:string" use="required"/>
<xs:attribute name="value" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="delete-liferay-objects">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="objects-to-be-deleted"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="theme">
<xs:complexType>
<xs:sequence>
<xs:element name="layoutSetSettings" minOccurs="0" maxOccurs="unbounded" type="PropertyKeyValueType">
<xs:annotation>
<xs:documentation>Any properties for the 'SETTINGS_' field of the row</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="article-template">
<xs:complexType>
<xs:attribute name="name" type="xs:string"/>
<xs:attribute name="key" use="required" type="xs:string"/>
<xs:attribute name="path" use="required" type="xs:string"/>
<xs:attribute name="language" default="ftl" type="xs:string"/>
<xs:attribute name="article-structure-key" type="xs:string"/>
<xs:attribute name="cacheable" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="article-folder">
<xs:complexType>
<xs:sequence>
<xs:element ref="role-permissions" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="folder-path" use="required" type="xs:string"/>
<xs:attribute name="description" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="article">
<xs:annotation>
<xs:appinfo>W3Schools Note</xs:appinfo>
<xs:documentation xml:lang="en">
Resolves any of the following resolver expressions contained in the content of an article to a
corresponding value:
<ul>
<li>{{$ARTICLE-ID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ARTICLE-UUIID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ARTICLE-RESID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-TEMPLATE-ID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-TEMPLATE-UUID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-STRUCTURE-ID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ART-STRUCTURE-UUID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ADT-TEMPLATE-ID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$ADT-TEMPLATE-UUID-BY-KEY=[:: name of the site ::]< article id to look for >$}}</li>
<li>{{$FILE-URL=[:: name of the site ::]< documents and media folder path to the file ><
documents and media folder title of the file >$}}
</li>
<li>{{$FILE-ID=[:: name of the site ::]< documents and media folder path to the file ><
documents and media folder title of the file >$}}
</li>
<li>{{$FILE-UUID=[:: name of the site ::]< documents and media folder path to the file ><
documents and media folder title of the file >$}}
</li>
<li>{{$CLASS-ID-BY-NAME=< fully qualified class name >$}}</li>
<li>{{$PRIV-PAGE-ID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the private page
>$}}
</li>
<li>{{$PUB-PAGE-ID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page >$}}</li>
<li>{{$PRIV-PAGE-PLID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the private page
>$}}
</li>
<li>{{$PUB-PAGE-PLID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page
>$}}
</li>
<li>{{$PUB-PAGE-UUID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page
>$}}
</li>
<li>{{$DDL-REC-SET-ID-BY-KEYL=[:: name of the site ::]< key of the DDL record set >$}}</li>
<li>{{ID_OF_ORG_WITH_NAME=< name of the organization >$}}</li>
<li>{{UUID_OF_ORG_WITH_NAME=< name of the organization >$}}</li>
<li>{{ID_OF_USER_GROUP_WITH_NAME=< name of the user group >$}}</li>
<li>{{UUDID_OF_USER_GROUP_WITH_NAME=< name of the user group >$}}</li>
</ul>
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="title-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="description-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element maxOccurs="1" minOccurs="0" ref="related-assets"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="tag"/>
<xs:element ref="role-permissions" minOccurs="0" maxOccurs="1"/>
<xs:element ref="category" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="article-structure-key" type="xs:string" use="required"/>
<xs:attribute name="article-template-key" type="xs:string" use="required"/>
<xs:attribute name="articleId" type="xs:string" default=""/>
<xs:attribute name="title" use="required" type="xs:string"/>
<xs:attribute name="article-folder-path" type="xs:string"/>
<xs:attribute name="path" use="required" type="xs:string"/>
<xs:attribute name="article-description" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="tag">
<xs:complexType>
<xs:attribute name="name"/>
</xs:complexType>
</xs:element>
<xs:element name="related-assets">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="related-asset"/>
</xs:sequence>
<xs:attribute name="clear-all-assets" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="related-asset">
<xs:complexType>
<xs:attribute name="asset-class" use="required" type="xs:string"/>
<xs:attribute name="asset-class-primary-key" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="document-folder">
<xs:complexType>
<xs:sequence>
<xs:element ref="role-permissions" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="folder-name" use="required" type="xs:string"/>
<xs:attribute name="create-if-not-exists" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="document">
<xs:complexType>
<xs:sequence>
<xs:element ref="role-permissions" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="document-title" type="xs:string" use="required"/>
<xs:attribute name="document-filename" type="xs:string" use="required"/>
<xs:attribute name="extension" type="xs:string" default=""/>
<xs:attribute name="document-folder-name" type="xs:string" default=""/>
<xs:attribute name="file-system-name" use="required" type="xs:string"/>
<xs:attribute name="file-upload-type" use="optional" type="DocumentFileUploadType" default="GENERAL"/>
</xs:complexType>
</xs:element>
<xs:element name="adt">
<xs:complexType>
<xs:attribute name="template-key" type="xs:string"/>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="description" use="required" type="xs:string"/>
<xs:attribute name="language" use="required" type="xs:string"/>
<xs:attribute name="class-name" use="required" type="xs:string"/>
<xs:attribute name="resource-class-name" type="xs:string"/>
<xs:attribute name="path" use="required" type="xs:string"/>
<xs:attribute name="cacheable" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="vocabulary">
<xs:complexType>
<xs:sequence>
<xs:element name="title-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="associated-asset-type" minOccurs="0" maxOccurs="unbounded"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="category"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="description" type="xs:string" default=""/>
<xs:attribute name="multi-valued" type="xs:boolean" default="true"/>
<xs:attribute name="uuid" type="UuidType" default=""/>
</xs:complexType>
</xs:element>
<xs:element name="associated-asset-type">
<xs:complexType>
<xs:attribute name="class-name" use="required" type="xs:string"/>
<xs:attribute name="subtype-structure-key" type="xs:string"/>
<xs:attribute name="required" type="xs:boolean" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="staging">
<xs:annotation>
<xs:documentation>If this element is present for site, it sets the staging environment. If not present, the
staging is untouched.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
</xs:sequence>
<xs:attribute name="type" use="optional" default="local">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="local"/>
<xs:enumeration value="remote"/>
<xs:enumeration value="none"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="branching-public" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If this attribute is set to true site variations will be switched on for public
pages.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="branching-private" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If this attribute is set to true site variations will be switched on for private
pages.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-polls" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Polls.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-blogs" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Blogs.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-message-boards" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Message Boards.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-document-library" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of documents (Document and Media library).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-ddl" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Dynamic Data Lists.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-forms" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of DDL Forms.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-calendar" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of calendar.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-mobile-rules" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Mobile Device Rules.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-adt" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Application (Portlet) Display Templates.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-web-content" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Web Content (Journal Articles).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-wiki" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Wiki.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stage-bookmarks" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Set true to enable staging of Bookmarks.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="ddl-recordset">
<xs:complexType>
<xs:attribute name="key" type="xs:string"/>
<xs:attribute name="name" type="xs:string"/>
<xs:attribute name="description" use="required" type="xs:string"/>
<xs:attribute name="ddl-structure-key" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="category">
<xs:complexType>
<xs:sequence>
<xs:element name="title-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="property" type="PropertyKeyValueType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="category"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="description" type="xs:string" default=""/>
<xs:attribute name="uuid" type="UuidType" default=""/>
</xs:complexType>
</xs:element>
<!-- definitions of elements end -->
<!-- definitions of types start -->
<xs:complexType name="CompanySettings">
<xs:annotation>
<xs:documentation>
Used to define company level settings.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="service-access-policies" type="ServiceAccessPolicies" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ServiceAccessPolicies">
<xs:sequence>
<xs:element name="service-access-policy" type="ServiceAccessPolicy" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="delete-service-access-policy" type="DeleteServiceAccessPolicy" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="DeleteServiceAccessPolicy">
<xs:annotation>
<xs:documentation>
Removes declared service access policy from company if it exists. Logs WARN if policy not found.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
Unique identifier of the Service Access Policy in a company.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ServiceAccessPolicy">
<xs:annotation>
<xs:documentation>
Adds new or replaces declared service access policy according to declarations. If not specified the policy is enabled and applied to unauthenticated requests (Default). Policy name (not title) is used as an identification.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="title" minOccurs="1" maxOccurs="unbounded" type="TranslationType">
<xs:annotation>
<xs:documentation>
Service Access Policy title translation. Title in at least one language is required.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="allowed-service-signatures" type="xs:string" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
List of allowed service signatures. Each entry in separate line. "Advanced mode" documentation (https://learn.liferay.com/dxp/latest/en/installation-and-upgrades/securing-liferay/securing-web-services/setting-service-access-policies.html#creating-a-service-access-policy) applies to contents of the element. It is possible not to define one. In the case library will create empty policy or update attributes of an existing one according to the declaration.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
Unique identifier of the Service Access Policy in a company.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enabled" use="optional" default="true" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Library presumes that policy is to be enabled by default but allows to define a disabling action as well.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unauthenticated" use="optional" default="true" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Library presumes that policy is to be applied to all requests, authenticated and unauthenticated as well.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="SitePreferencesType">
<xs:sequence>
<xs:element name="inheritLocales" minOccurs="0" maxOccurs="1" type="xs:boolean" default="true"/>
<xs:element name="languageId" minOccurs="0" maxOccurs="1" type="xs:string" default="en_US"/>
<xs:element name="locales" minOccurs="0" maxOccurs="unbounded" type="xs:string"/>
<xs:element name="mentionsEnabled" minOccurs="0" maxOccurs="1" type="xs:boolean" default="false"/>
<xs:element name="sharingEnabled" minOccurs="0" maxOccurs="1" type="xs:boolean" default="false"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PageType">
<xs:sequence>
<xs:element name="page" type="PageType" maxOccurs="unbounded" minOccurs="0"/>
<xs:element name="page-portlet" type="PagePortletType" maxOccurs="unbounded" minOccurs="0"/>
<xs:element maxOccurs="1" minOccurs="0" ref="theme"/>
<xs:element name="title-translation" type="TranslationType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="custom-field-setting" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="role-permissions" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="name" use="required"/>
<xs:attribute name="friendly-url" use="required"/>
<xs:attribute name="type" default="portlet"/>
<xs:attribute name="target" use="optional"/>
<xs:attribute name="hidden" type="xs:boolean" default="false"/>
<xs:attribute name="layout" type="xs:string">
<xs:annotation>
<xs:documentation>ID of layout template for this page. Note that if the layout
template is part of a Theme plugin, Theme plugin ID must be configured
as the layoutContainedInThemeWithId attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="layout-theme-id" type="xs:string">
<xs:annotation>
<xs:documentation>If Layout template is delivered as a part of Theme plugin, ID
of this Theme plugin must be defined in this attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="delete-existing-pages" default="false" type="xs:boolean"/>
<xs:attribute name="clear-page" default="true" type="xs:boolean">
<xs:annotation>
<xs:documentation>If this attribute is set to true, all portlets will be removed
from the page before the new ones are set up.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="link-to-url" type="xs:string"/>
</xs:complexType>
<xs:complexType name="PagesType">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" ref="theme"/>
<xs:element maxOccurs="unbounded" name="page" type="PageType"/>
</xs:sequence>
<xs:attribute name="delete-existing-pages" default="false" type="xs:boolean"/>