McpScreenDocsData.xml
26.5 KB
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
This software is in the public domain under CC0 1.0 Universal plus a
Grant of Patent License.
To the extent possible under law, the author(s) have dedicated all
copyright and related and neighboring rights to this software to the
public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication
along with this software. If not, see
<http://creativecommons.org/publicdomain/zero/1.0/>.
-->
<entity-facade-xml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://moqui.org/xsd/entity-facade-3.xsd">
<!-- MCP Screen Documentation Wiki Space -->
<moqui.resource.wiki.WikiSpace wikiSpaceId="MCP_SCREEN_DOCS"
description="MCP Screen Documentation - LLM instructions for specific screens"
restrictView="N"
restrictUpdate="Y"
rootPageLocation="dbresource://WikiSpace/MCP_SCREEN_DOCS.md"/>
<!-- WikiSpace Root Page -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_SCREEN_DOCS"
parentResourceId=""
filename="MCP_SCREEN_DOCS.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_SCREEN_DOCS"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Moqui MCP Server
This server provides access to Moqui ERP through MCP.
## Getting Started
Use the following discovery tools to explore available functionality:
- `moqui_browse_screens`: Browse Moqui screen hierarchy
- `moqui_search_screens`: Search for screens by name to find their paths
- `moqui_get_screen_details`: Get input parameters for specific screens
## Common Screen Paths
### Catalog Operations
- `/PopCommerce/PopCommerceAdmin/Catalog/dashboard`: Catalog overview and management
- `/PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct`: Search and browse products
- `/PopCommerce/PopCommerceAdmin/Catalog/Feature/FindFeature`: Search by features like color or size
- `/PopCommerce/PopCommerceAdmin/Catalog/Product/EditPrices`: View and update product prices
### Order Management
- `/PopCommerce/PopCommerceAdmin/Order/FindOrder`: Lookup and create sales/purchase orders
- `/PopCommerce/PopCommerceAdmin/QuickSearch`: General order and customer search
### Party & Customer Management
- `/PopCommerce/PopCommerceAdmin/Party/FindParty`: Manage all parties (People, Organizations)
- `/PopCommerce/PopCommerceRoot/Customer`: Customer storefront account management
- `User`: Internal user account, notifications, and messages
- `/PopCommerce/PopCommerceAdmin/QuickSearch`: Customer lookup
### Facility & Accounting
- `/PopCommerce/PopCommerceAdmin/Facility/FindFacility`: Manage warehouses and inventory locations
- `/PopCommerce/PopCommerceAdmin/Accounting/dashboard`: Financial management and GL accounting
### System & Developer Tools
- `/tools/Tools`: Developer tools, entity data editing, and service references
- `/tools/System`: System administration, cache management, and security settings
## Tips for LLM Clients
- All screens support parameterized queries for filtering results
- Use `moqui_render_screen` with screen path to execute screens
- Screen paths use forward slash notation (e.g., `/PopCommerce/PopCommerceAdmin/Catalog/Product`)
- Check `moqui_get_screen_details` for required parameters before rendering
- Use `renderMode: "mcp"` for structured JSON output or `"text"` for human-readable format]]></fileData>
</moqui.resource.DbResourceFile>
<!-- Root Wiki Page -->
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/root"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="root"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/root"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-02 00:00:00.000"/>
<!-- Root Screen Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_ROOT"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="root.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_ROOT"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Moqui MCP Server
This server provides access to Moqui ERP through MCP. Typically you will be searching for a product by name or by a feature like size or color.
If it is a feature based query it is probably best to use the FindFeature screen to locate the feature and then use FindProduct to search for products with that feature.
## Getting Started
Use the following discovery tools to explore available functionality:
- `moqui_browse_screens`: Browse Moqui screen hierarchy
- `moqui_search_screens`: Search for screens by name to find their paths
- `moqui_get_screen_details`: Get input parameters for specific screens
## Common Screen Paths
### Catalog Operations
- `/PopCommerce/PopCommerceAdmin/Catalog/dashboard`: Catalog overview and management
- `/PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct`: Search and browse products
- `/PopCommerce/PopCommerceAdmin/Catalog/Feature/FindFeature`: Search by features like color or size
- `/PopCommerce/PopCommerceAdmin/Catalog/Product/EditPrices`: View and update product prices
### Order Management
- `/PopCommerce/PopCommerceAdmin/Order/FindOrder`: Lookup and create sales/purchase orders
- `/PopCommerce/PopCommerceAdmin/QuickSearch`: General order and customer search
### Party & Customer Management
- `/PopCommerce/PopCommerceAdmin/Party/FindParty`: Manage all parties (People, Organizations)
- `/PopCommerce/PopCommerceRoot/Customer`: Customer storefront account management
- `User`: Internal user account, notifications, and messages
- `/PopCommerce/PopCommerceAdmin/QuickSearch`: Customer lookup
### Facility & Accounting
- `/PopCommerce/PopCommerceAdmin/Facility/FindFacility`: Manage warehouses and inventory locations
- `/PopCommerce/PopCommerceAdmin/Accounting/dashboard`: Financial management and GL accounting
### System & Developer Tools
- `/tools/Tools`: Developer tools, entity data editing, and service references
- `/tools/System`: System administration, cache management, and security settings
## Tips for LLM Clients
- All screens support parameterized queries for filtering results
- Use `moqui_render_screen` with screen path to execute screens
- Screen paths use forward slash notation (e.g., `/PopCommerce/PopCommerceAdmin/Catalog/Product`)
- Check `moqui_get_screen_details` for required parameters before rendering
- Use `renderMode: "mcp"` for structured JSON output or `"text"` for human-readable format]]></fileData>
</moqui.resource.DbResourceFile>
<!-- PopCommerce Root Screen Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_POPCOMM_ROOT"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="PopCommerce/PopCommerceRoot.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_POPCOMM_ROOT"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# PopCommerce Root
Main storefront and customer-facing screens for PopCommerce e-commerce component.
## Key Screens
- **Catalog & Products**: Browse the product catalog and view details
- **Customer Management**: Manage customer profiles and account settings
- **Order Management**: Track order history and status
- **Shopping Cart**: Review items and proceed to checkout
- **Messages**: Access `User/Messages` for internal communications
## Navigation
Use browse tools to explore the full catalog of PopCommerce screens. For administrative tasks, use the `/PopCommerce/PopCommerceAdmin` hierarchy.]]></fileData>
</moqui.resource.DbResourceFile>
<!-- PopCommerce Root Wiki Page -->
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/PopCommerceRoot"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="PopCommerce/PopCommerceRoot"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/PopCommerceRoot"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-02 00:00:00.000"/>
<!-- SimpleScreens Root Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_SIMPLE_ROOT"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="SimpleScreens/Root.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_SIMPLE_ROOT"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Simple Screens Root
Basic Moqui framework demonstration screens showing common patterns and examples.
## Screens
- **Hello World**: Simple text rendering example
- **Examples**: Various framework demonstration screens
- **Forms**: Form input and validation examples
- **Lists**: Data list and table examples
## Usage
These screens are primarily for learning Moqui screen development patterns.]]></fileData>
</moqui.resource.DbResourceFile>
<!-- SimpleScreens Root Wiki Page -->
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/SimpleRoot"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="SimpleScreens/Root"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/SimpleRoot"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-02 00:00:00.000"/>
<!-- User Messages Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_USER_MESSAGES"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="User/Messages.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_USER_MESSAGES"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# User Messages
Current user's messages interface. No partyId required - defaults to logged-in user.
## Recommended: Use FindMessage Subscreen
For full functionality (forms, actions, transitions), use the FindMessage subscreen:
```
path: User/Messages/FindMessage
```
## Send a Message
```
path: User/Messages/FindMessage
action: createMessage
parameters: {
toPartyId: "JohnSales",
subject: "Question about order",
body: "Can you check order status?"
}
```
## Available Subscreens
- **FindMessage**: List and create messages (use this for most operations)
- **MessageThread**: View conversation thread for a specific message
- **EditMessage**: Edit/view a single message
## Difference from Party/PartyMessages
- **User/Messages**: Current user's messages (no partyId needed)
- **Party/PartyMessages**: Admin view of any party's messages (requires partyId)]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/UserMessages"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="User/Messages"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/UserMessages"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-14 00:00:00.000"/>
<!-- Tools Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_TOOLS"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="tools/Tools.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_TOOLS"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Developer Tools
Central hub for developer and data management utilities.
## Key Subscreens
- **Entity**: Data editing, import/export, and performance stats. Use `tools/Tools/Entity/DataEdit/EntityList` to browse and edit any entity.
- **Service**: Service reference and testing tools.
- **AutoScreen**: Automatically generated screens for all entities.
- **GroovyShell**: Execute arbitrary Groovy code (use with extreme caution).
## Usage
Use these tools for low-level data manipulation or system exploration when standard administrative screens are insufficient.]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/Tools"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="tools/Tools"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/Tools"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-14 00:00:00.000"/>
<!-- System Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_SYSTEM"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="tools/System.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_SYSTEM"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# System Administration
Core system management and monitoring screens.
## Key Subscreens
- **Security**: Manage users, user groups, and artifact permissions.
- **Cache**: View and clear system caches.
- **ServiceJob**: Manage scheduled and background service jobs.
- **LogViewer**: View system logs and hit statistics.
## Usage
Use these screens to monitor system health, manage user access, and troubleshoot operational issues.]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/System"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="tools/System"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/System"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-14 00:00:00.000"/>
<!-- ========================================== -->
<!-- Party Management Screens -->
<!-- ========================================== -->
<!-- FindParty Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_FIND_PARTY"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="PopCommerce/PopCommerceAdmin/Party/FindParty.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_FIND_PARTY"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Find Party
Search and create parties (People, Organizations, Sales Accounts, Employees).
## Quick Actions
### Create Person (Minimal)
```
action: createPerson
parameters: {firstName: "John", lastName: "Doe"}
```
### Create Organization
```
action: createOrganization
parameters: {organizationName: "Acme Corp"}
```
### Create Sales Account
```
action: createAccount
parameters: {organizationName: "New Account Inc"}
```
### Create Employee
```
action: createPersonEmployee
parameters: {firstName: "Jane", lastName: "Smith", emailAddress: "jane@example.com"}
```
### Create Customer (Full)
```
action: createPersonCustomer
parameters: {
firstName: "Bob", lastName: "Customer",
roleTypeId: "Customer",
emailAddress: "bob@example.com",
address1: "123 Main St", city: "Austin",
stateProvinceGeoId: "USA_TX", countryGeoId: "USA", postalCode: "78701"
}
```
## Searching
Pass `anyField` parameter to search across all party fields:
```
parameters: {anyField: "john"}
```
## Results
The PartyListForm grid shows matching parties. Click a party ID link to navigate to EditParty for details.
## Key Fields
- **roleTypeId**: Customer, Supplier, Employee, etc. (140 options)
- **partyClassificationId**: CustConsumer, CustDistributor, etc. (49 options)
- **stateProvinceGeoId**: Depends on countryGeoId - use `moqui_get_screen_details` for dynamic options]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/FindParty"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="PopCommerce/PopCommerceAdmin/Party/FindParty"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/FindParty"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-19 00:00:00.000"/>
<!-- EditParty Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_EDIT_PARTY"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="PopCommerce/PopCommerceAdmin/Party/EditParty.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_EDIT_PARTY"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Edit Party
View and modify party details including contact info, roles, classifications, and user accounts.
## Required Parameter
- **partyId**: The party to edit (e.g., `JohnSales`, `100051`)
## Key Actions
### Update Basic Info
```
action: updateParty
parameters: {partyId: "100051", firstName: "John", lastName: "Updated", comments: "VIP customer"}
```
### Add Role
```
action: createPartyRole
parameters: {partyId: "100051", roleTypeId: "Customer"}
```
### Add Classification
```
action: setPartyClassification
parameters: {partyId: "100051", partyClassificationId: "CustConsumer"}
```
### Create User Account
```
action: createUserAccount
parameters: {partyId: "100051", username: "jdoe", emailAddress: "jdoe@example.com", newPassword: "secret123", newPasswordVerify: "secret123", userGroupId: "POP_COMMERCE_USER"}
```
### Add Contact Info
```
action: storePartyContactMech
parameters: {partyId: "100051", emailAddress: "newemail@example.com"}
```
## Subscreens
- **FindDuplicates**: Find potential duplicate party records
- **UpdateContactInfo**: Manage postal addresses, phone numbers, emails
- **UpdatePaymentMethodInfo**: Manage credit cards and payment methods
## Related Entities
This screen manages: Party, Person/Organization, PartyRole, PartyClassification, PartyContactMech, UserAccount]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/EditParty"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="PopCommerce/PopCommerceAdmin/Party/EditParty"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/EditParty"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-19 00:00:00.000"/>
<!-- PartyMessages/FindMessage Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_PARTY_MESSAGES"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="PopCommerce/PopCommerceAdmin/Party/PartyMessages/FindMessage.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_PARTY_MESSAGES"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Party Messages
Send and view messages to/from parties. Use for internal communications about orders, products, or customers.
## Required Parameter
**partyId** is required to view this screen. Always pass a party ID:
```
path: PopCommerce/PopCommerceAdmin/Party/PartyMessages/FindMessage
parameters: {partyId: "JohnSales"}
```
## Send a Message
```
action: createMessage
parameters: {
partyId: "JohnSales",
toPartyId: "JohnSales",
subject: "New product available",
body: "The green variant of DEMO_VAR is now in stock."
}
```
## View Messages for a Party
```
path: PopCommerce/PopCommerceAdmin/Party/PartyMessages/FindMessage
parameters: {partyId: "JohnSales"}
```
This shows all messages to or from the specified party.
## Message Types
Messages are stored as CommunicationEvent entities with:
- **communicationEventTypeId**: Defaults to internal message type
- **statusId**: Message status (sent, read, etc.)
- **fromPartyId**: Sender (defaults to current user)
- **toPartyId**: Recipient party
## Difference from User/Messages
- **Party/PartyMessages**: Admin screen for messaging any party in the system (requires partyId)
- **User/Messages**: User-facing screen for current user's own messages (no partyId needed)
Use PartyMessages when you need to send messages on behalf of the system or to parties who may not have user accounts.]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/PartyMessages"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="PopCommerce/PopCommerceAdmin/Party/PartyMessages/FindMessage"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/PartyMessages"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-19 00:00:00.000"/>
<!-- ========================================== -->
<!-- Catalog/Product Screens -->
<!-- ========================================== -->
<!-- FindProduct Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_FIND_PRODUCT"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_FIND_PRODUCT"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Find Product
Search and create products in the catalog.
## Searching Products
### By Name or ID
```
parameters: {productId: "DEMO", anyField: "widget"}
```
### By Category
```
parameters: {productCategoryId: "CATALOG"}
```
### By Feature
```
parameters: {productFeatureId: "ColorBlue"}
```
## Creating Products
### Standard Product
```
action: createProduct
parameters: {
productName: "New Widget",
productTypeEnumId: "PtAsset",
assetTypeEnumId: "AstTpInventory"
}
```
### Virtual Product (for variants)
```
action: createProduct
parameters: {
productName: "Widget with Options",
productTypeEnumId: "PtVirtual"
}
```
## Product Types
- **PtAsset**: Standard inventory product
- **PtVirtual**: Parent product for variants (has selectable features)
- **PtService**: Service or labor product
- **PtDigital**: Downloadable digital product
## Workflow: Creating Variants
1. Create virtual parent: `productTypeEnumId: "PtVirtual"`
2. Navigate to EditProduct, add selectable features (e.g., Color: Red, Blue)
3. Create variant products: `productTypeEnumId: "PtAsset"`
4. On variants, add distinguishing features (e.g., Color: Red)
5. Create ProductAssoc linking parent to variants with `productAssocTypeEnumId: "PatVariant"`
## Results
ProductListForm grid shows matches. Click product link to navigate to EditProduct.]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/FindProduct"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/FindProduct"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-19 00:00:00.000"/>
<!-- EditProduct Documentation -->
<moqui.resource.DbResource
resourceId="WIKI_MCP_DOCS_EDIT_PRODUCT"
parentResourceId="WIKI_MCP_SCREEN_DOCS"
filename="PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct.md"
isFile="Y"/>
<moqui.resource.DbResourceFile
resourceId="WIKI_MCP_DOCS_EDIT_PRODUCT"
mimeType="text/markdown"
versionName="v1">
<fileData><![CDATA[# Edit Product
Manage product details, features, prices, categories, and associations.
## Required Parameter
- **productId**: Product to edit (e.g., `DEMO_1`, `100000`)
## Key Subscreens
- **EditProduct** (main): Basic product info
- **EditFeatures**: Product features (selectable/distinguishing)
- **EditAssocs**: Product associations (variants, accessories, etc.)
- **EditPrices**: Price configuration
- **EditCategories**: Category membership
## Managing Features
### Add Selectable Feature (Virtual Products)
```
path: PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct/EditFeatures
action: createProductFeature
parameters: {
productId: "DEMO_VAR",
productFeatureId: "ColorRed",
applTypeEnumId: "PfatSelectable"
}
```
### Add Distinguishing Feature (Variant Products)
```
action: createProductFeature
parameters: {
productId: "DEMO_VAR_RED",
productFeatureId: "ColorRed",
applTypeEnumId: "PfatDistinguishing"
}
```
## Feature Application Types
- **PfatSelectable**: Customer can choose this feature (on virtual parent)
- **PfatDistinguishing**: Identifies a specific variant
- **PfatStandard**: Always included with product
- **PfatRequired**: Must be selected at purchase
## Managing Associations
### Link Variant to Parent
```
path: PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct/EditAssocs
action: createProductAssoc
parameters: {
productId: "DEMO_VAR",
toProductId: "DEMO_VAR_RED",
productAssocTypeEnumId: "PatVariant"
}
```
## Association Types
- **PatVariant**: Links virtual parent to variant
- **PatAccessory**: Suggested accessory
- **PatComplement**: Complementary product
- **PatSubstitute**: Equivalent alternative
## Complete Variant Workflow
1. Edit virtual product, go to EditFeatures
2. Add selectable features (PfatSelectable) for each option
3. Create variant products via FindProduct
4. Edit each variant, add distinguishing feature (PfatDistinguishing)
5. Edit parent, go to EditAssocs, create PatVariant associations]]></fileData>
</moqui.resource.DbResourceFile>
<moqui.resource.wiki.WikiPage
wikiPageId="MCP_SCREEN_DOCS/EditProduct"
wikiSpaceId="MCP_SCREEN_DOCS"
pagePath="PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct"
publishedVersionName="v1"
restrictView="N">
</moqui.resource.wiki.WikiPage>
<moqui.resource.wiki.WikiPageHistory
wikiPageId="MCP_SCREEN_DOCS/EditProduct"
historySeqId="1"
versionName="v1"
userId="EX_JOHN_DOE"
changeDateTime="2025-01-19 00:00:00.000"/>
</entity-facade-xml>