Add wiki docs for Party and Product screens
Added MCP screen documentation for: - FindParty: Quick actions for creating people, orgs, accounts, employees - EditParty: Party detail management, roles, classifications, user accounts - PartyMessages/FindMessage: Internal messaging between parties - FindProduct: Product search and creation, variant workflow overview - EditProduct: Features, associations, complete variant setup guide Each doc includes example action calls with parameters.
Showing
1 changed file
with
419 additions
and
0 deletions
| ... | @@ -357,4 +357,423 @@ Use these screens to monitor system health, manage user access, and troubleshoot | ... | @@ -357,4 +357,423 @@ Use these screens to monitor system health, manage user access, and troubleshoot |
| 357 | userId="EX_JOHN_DOE" | 357 | userId="EX_JOHN_DOE" |
| 358 | changeDateTime="2025-01-14 00:00:00.000"/> | 358 | changeDateTime="2025-01-14 00:00:00.000"/> |
| 359 | 359 | ||
| 360 | <!-- ========================================== --> | ||
| 361 | <!-- Party Management Screens --> | ||
| 362 | <!-- ========================================== --> | ||
| 363 | |||
| 364 | <!-- FindParty Documentation --> | ||
| 365 | <moqui.resource.DbResource | ||
| 366 | resourceId="WIKI_MCP_DOCS_FIND_PARTY" | ||
| 367 | parentResourceId="WIKI_MCP_SCREEN_DOCS" | ||
| 368 | filename="PopCommerce/PopCommerceAdmin/Party/FindParty.md" | ||
| 369 | isFile="Y"/> | ||
| 370 | <moqui.resource.DbResourceFile | ||
| 371 | resourceId="WIKI_MCP_DOCS_FIND_PARTY" | ||
| 372 | mimeType="text/markdown" | ||
| 373 | versionName="v1"> | ||
| 374 | <fileData><![CDATA[# Find Party | ||
| 375 | |||
| 376 | Search and create parties (People, Organizations, Sales Accounts, Employees). | ||
| 377 | |||
| 378 | ## Quick Actions | ||
| 379 | |||
| 380 | ### Create Person (Minimal) | ||
| 381 | ``` | ||
| 382 | action: createPerson | ||
| 383 | parameters: {firstName: "John", lastName: "Doe"} | ||
| 384 | ``` | ||
| 385 | |||
| 386 | ### Create Organization | ||
| 387 | ``` | ||
| 388 | action: createOrganization | ||
| 389 | parameters: {organizationName: "Acme Corp"} | ||
| 390 | ``` | ||
| 391 | |||
| 392 | ### Create Sales Account | ||
| 393 | ``` | ||
| 394 | action: createAccount | ||
| 395 | parameters: {organizationName: "New Account Inc"} | ||
| 396 | ``` | ||
| 397 | |||
| 398 | ### Create Employee | ||
| 399 | ``` | ||
| 400 | action: createPersonEmployee | ||
| 401 | parameters: {firstName: "Jane", lastName: "Smith", emailAddress: "jane@example.com"} | ||
| 402 | ``` | ||
| 403 | |||
| 404 | ### Create Customer (Full) | ||
| 405 | ``` | ||
| 406 | action: createPersonCustomer | ||
| 407 | parameters: { | ||
| 408 | firstName: "Bob", lastName: "Customer", | ||
| 409 | roleTypeId: "Customer", | ||
| 410 | emailAddress: "bob@example.com", | ||
| 411 | address1: "123 Main St", city: "Austin", | ||
| 412 | stateProvinceGeoId: "USA_TX", countryGeoId: "USA", postalCode: "78701" | ||
| 413 | } | ||
| 414 | ``` | ||
| 415 | |||
| 416 | ## Searching | ||
| 417 | |||
| 418 | Pass `anyField` parameter to search across all party fields: | ||
| 419 | ``` | ||
| 420 | parameters: {anyField: "john"} | ||
| 421 | ``` | ||
| 422 | |||
| 423 | ## Results | ||
| 424 | |||
| 425 | The PartyListForm grid shows matching parties. Click a party ID link to navigate to EditParty for details. | ||
| 426 | |||
| 427 | ## Key Fields | ||
| 428 | |||
| 429 | - **roleTypeId**: Customer, Supplier, Employee, etc. (140 options) | ||
| 430 | - **partyClassificationId**: CustConsumer, CustDistributor, etc. (49 options) | ||
| 431 | - **stateProvinceGeoId**: Depends on countryGeoId - use `moqui_get_screen_details` for dynamic options]]></fileData> | ||
| 432 | </moqui.resource.DbResourceFile> | ||
| 433 | |||
| 434 | <moqui.resource.wiki.WikiPage | ||
| 435 | wikiPageId="MCP_SCREEN_DOCS/FindParty" | ||
| 436 | wikiSpaceId="MCP_SCREEN_DOCS" | ||
| 437 | pagePath="PopCommerce/PopCommerceAdmin/Party/FindParty" | ||
| 438 | publishedVersionName="v1" | ||
| 439 | restrictView="N"> | ||
| 440 | </moqui.resource.wiki.WikiPage> | ||
| 441 | |||
| 442 | <moqui.resource.wiki.WikiPageHistory | ||
| 443 | wikiPageId="MCP_SCREEN_DOCS/FindParty" | ||
| 444 | historySeqId="1" | ||
| 445 | versionName="v1" | ||
| 446 | userId="EX_JOHN_DOE" | ||
| 447 | changeDateTime="2025-01-19 00:00:00.000"/> | ||
| 448 | |||
| 449 | <!-- EditParty Documentation --> | ||
| 450 | <moqui.resource.DbResource | ||
| 451 | resourceId="WIKI_MCP_DOCS_EDIT_PARTY" | ||
| 452 | parentResourceId="WIKI_MCP_SCREEN_DOCS" | ||
| 453 | filename="PopCommerce/PopCommerceAdmin/Party/EditParty.md" | ||
| 454 | isFile="Y"/> | ||
| 455 | <moqui.resource.DbResourceFile | ||
| 456 | resourceId="WIKI_MCP_DOCS_EDIT_PARTY" | ||
| 457 | mimeType="text/markdown" | ||
| 458 | versionName="v1"> | ||
| 459 | <fileData><![CDATA[# Edit Party | ||
| 460 | |||
| 461 | View and modify party details including contact info, roles, classifications, and user accounts. | ||
| 462 | |||
| 463 | ## Required Parameter | ||
| 464 | |||
| 465 | - **partyId**: The party to edit (e.g., `JohnSales`, `100051`) | ||
| 466 | |||
| 467 | ## Key Actions | ||
| 468 | |||
| 469 | ### Update Basic Info | ||
| 470 | ``` | ||
| 471 | action: updateParty | ||
| 472 | parameters: {partyId: "100051", firstName: "John", lastName: "Updated", comments: "VIP customer"} | ||
| 473 | ``` | ||
| 474 | |||
| 475 | ### Add Role | ||
| 476 | ``` | ||
| 477 | action: createPartyRole | ||
| 478 | parameters: {partyId: "100051", roleTypeId: "Customer"} | ||
| 479 | ``` | ||
| 480 | |||
| 481 | ### Add Classification | ||
| 482 | ``` | ||
| 483 | action: setPartyClassification | ||
| 484 | parameters: {partyId: "100051", partyClassificationId: "CustConsumer"} | ||
| 485 | ``` | ||
| 486 | |||
| 487 | ### Create User Account | ||
| 488 | ``` | ||
| 489 | action: createUserAccount | ||
| 490 | parameters: {partyId: "100051", username: "jdoe", emailAddress: "jdoe@example.com", newPassword: "secret123", newPasswordVerify: "secret123", userGroupId: "POP_COMMERCE_USER"} | ||
| 491 | ``` | ||
| 492 | |||
| 493 | ### Add Contact Info | ||
| 494 | ``` | ||
| 495 | action: storePartyContactMech | ||
| 496 | parameters: {partyId: "100051", emailAddress: "newemail@example.com"} | ||
| 497 | ``` | ||
| 498 | |||
| 499 | ## Subscreens | ||
| 500 | |||
| 501 | - **FindDuplicates**: Find potential duplicate party records | ||
| 502 | - **UpdateContactInfo**: Manage postal addresses, phone numbers, emails | ||
| 503 | - **UpdatePaymentMethodInfo**: Manage credit cards and payment methods | ||
| 504 | |||
| 505 | ## Related Entities | ||
| 506 | |||
| 507 | This screen manages: Party, Person/Organization, PartyRole, PartyClassification, PartyContactMech, UserAccount]]></fileData> | ||
| 508 | </moqui.resource.DbResourceFile> | ||
| 509 | |||
| 510 | <moqui.resource.wiki.WikiPage | ||
| 511 | wikiPageId="MCP_SCREEN_DOCS/EditParty" | ||
| 512 | wikiSpaceId="MCP_SCREEN_DOCS" | ||
| 513 | pagePath="PopCommerce/PopCommerceAdmin/Party/EditParty" | ||
| 514 | publishedVersionName="v1" | ||
| 515 | restrictView="N"> | ||
| 516 | </moqui.resource.wiki.WikiPage> | ||
| 517 | |||
| 518 | <moqui.resource.wiki.WikiPageHistory | ||
| 519 | wikiPageId="MCP_SCREEN_DOCS/EditParty" | ||
| 520 | historySeqId="1" | ||
| 521 | versionName="v1" | ||
| 522 | userId="EX_JOHN_DOE" | ||
| 523 | changeDateTime="2025-01-19 00:00:00.000"/> | ||
| 524 | |||
| 525 | <!-- PartyMessages/FindMessage Documentation --> | ||
| 526 | <moqui.resource.DbResource | ||
| 527 | resourceId="WIKI_MCP_DOCS_PARTY_MESSAGES" | ||
| 528 | parentResourceId="WIKI_MCP_SCREEN_DOCS" | ||
| 529 | filename="PopCommerce/PopCommerceAdmin/Party/PartyMessages/FindMessage.md" | ||
| 530 | isFile="Y"/> | ||
| 531 | <moqui.resource.DbResourceFile | ||
| 532 | resourceId="WIKI_MCP_DOCS_PARTY_MESSAGES" | ||
| 533 | mimeType="text/markdown" | ||
| 534 | versionName="v1"> | ||
| 535 | <fileData><![CDATA[# Party Messages | ||
| 536 | |||
| 537 | Send and view messages to/from parties. Use for internal communications about orders, products, or customers. | ||
| 538 | |||
| 539 | ## Send a Message | ||
| 540 | |||
| 541 | ``` | ||
| 542 | action: createMessage | ||
| 543 | parameters: { | ||
| 544 | toPartyId: "JohnSales", | ||
| 545 | subject: "New product available", | ||
| 546 | body: "The green variant of DEMO_VAR is now in stock." | ||
| 547 | } | ||
| 548 | ``` | ||
| 549 | |||
| 550 | ## Filter Messages | ||
| 551 | |||
| 552 | Pass `partyId` to see messages for a specific party: | ||
| 553 | ``` | ||
| 554 | parameters: {partyId: "JohnSales"} | ||
| 555 | ``` | ||
| 556 | |||
| 557 | ## Message Types | ||
| 558 | |||
| 559 | Messages are stored as CommunicationEvent entities with: | ||
| 560 | - **communicationEventTypeId**: Defaults to internal message type | ||
| 561 | - **statusId**: Message status (sent, read, etc.) | ||
| 562 | - **fromPartyId**: Sender (defaults to current user) | ||
| 563 | - **toPartyId**: Recipient party | ||
| 564 | |||
| 565 | ## Difference from User/Messages | ||
| 566 | |||
| 567 | - **Party/PartyMessages**: Admin screen for messaging any party in the system | ||
| 568 | - **User/Messages**: User-facing screen for current user's own messages | ||
| 569 | |||
| 570 | Use PartyMessages when you need to send messages on behalf of the system or to parties who may not have user accounts.]]></fileData> | ||
| 571 | </moqui.resource.DbResourceFile> | ||
| 572 | |||
| 573 | <moqui.resource.wiki.WikiPage | ||
| 574 | wikiPageId="MCP_SCREEN_DOCS/PartyMessages" | ||
| 575 | wikiSpaceId="MCP_SCREEN_DOCS" | ||
| 576 | pagePath="PopCommerce/PopCommerceAdmin/Party/PartyMessages/FindMessage" | ||
| 577 | publishedVersionName="v1" | ||
| 578 | restrictView="N"> | ||
| 579 | </moqui.resource.wiki.WikiPage> | ||
| 580 | |||
| 581 | <moqui.resource.wiki.WikiPageHistory | ||
| 582 | wikiPageId="MCP_SCREEN_DOCS/PartyMessages" | ||
| 583 | historySeqId="1" | ||
| 584 | versionName="v1" | ||
| 585 | userId="EX_JOHN_DOE" | ||
| 586 | changeDateTime="2025-01-19 00:00:00.000"/> | ||
| 587 | |||
| 588 | <!-- ========================================== --> | ||
| 589 | <!-- Catalog/Product Screens --> | ||
| 590 | <!-- ========================================== --> | ||
| 591 | |||
| 592 | <!-- FindProduct Documentation --> | ||
| 593 | <moqui.resource.DbResource | ||
| 594 | resourceId="WIKI_MCP_DOCS_FIND_PRODUCT" | ||
| 595 | parentResourceId="WIKI_MCP_SCREEN_DOCS" | ||
| 596 | filename="PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct.md" | ||
| 597 | isFile="Y"/> | ||
| 598 | <moqui.resource.DbResourceFile | ||
| 599 | resourceId="WIKI_MCP_DOCS_FIND_PRODUCT" | ||
| 600 | mimeType="text/markdown" | ||
| 601 | versionName="v1"> | ||
| 602 | <fileData><![CDATA[# Find Product | ||
| 603 | |||
| 604 | Search and create products in the catalog. | ||
| 605 | |||
| 606 | ## Searching Products | ||
| 607 | |||
| 608 | ### By Name or ID | ||
| 609 | ``` | ||
| 610 | parameters: {productId: "DEMO", anyField: "widget"} | ||
| 611 | ``` | ||
| 612 | |||
| 613 | ### By Category | ||
| 614 | ``` | ||
| 615 | parameters: {productCategoryId: "CATALOG"} | ||
| 616 | ``` | ||
| 617 | |||
| 618 | ### By Feature | ||
| 619 | ``` | ||
| 620 | parameters: {productFeatureId: "ColorBlue"} | ||
| 621 | ``` | ||
| 622 | |||
| 623 | ## Creating Products | ||
| 624 | |||
| 625 | ### Standard Product | ||
| 626 | ``` | ||
| 627 | action: createProduct | ||
| 628 | parameters: { | ||
| 629 | productName: "New Widget", | ||
| 630 | productTypeEnumId: "PtAsset", | ||
| 631 | assetTypeEnumId: "AstTpInventory" | ||
| 632 | } | ||
| 633 | ``` | ||
| 634 | |||
| 635 | ### Virtual Product (for variants) | ||
| 636 | ``` | ||
| 637 | action: createProduct | ||
| 638 | parameters: { | ||
| 639 | productName: "Widget with Options", | ||
| 640 | productTypeEnumId: "PtVirtual" | ||
| 641 | } | ||
| 642 | ``` | ||
| 643 | |||
| 644 | ## Product Types | ||
| 645 | |||
| 646 | - **PtAsset**: Standard inventory product | ||
| 647 | - **PtVirtual**: Parent product for variants (has selectable features) | ||
| 648 | - **PtService**: Service or labor product | ||
| 649 | - **PtDigital**: Downloadable digital product | ||
| 650 | |||
| 651 | ## Workflow: Creating Variants | ||
| 652 | |||
| 653 | 1. Create virtual parent: `productTypeEnumId: "PtVirtual"` | ||
| 654 | 2. Navigate to EditProduct, add selectable features (e.g., Color: Red, Blue) | ||
| 655 | 3. Create variant products: `productTypeEnumId: "PtAsset"` | ||
| 656 | 4. On variants, add distinguishing features (e.g., Color: Red) | ||
| 657 | 5. Create ProductAssoc linking parent to variants with `productAssocTypeEnumId: "PatVariant"` | ||
| 658 | |||
| 659 | ## Results | ||
| 660 | |||
| 661 | ProductListForm grid shows matches. Click product link to navigate to EditProduct.]]></fileData> | ||
| 662 | </moqui.resource.DbResourceFile> | ||
| 663 | |||
| 664 | <moqui.resource.wiki.WikiPage | ||
| 665 | wikiPageId="MCP_SCREEN_DOCS/FindProduct" | ||
| 666 | wikiSpaceId="MCP_SCREEN_DOCS" | ||
| 667 | pagePath="PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct" | ||
| 668 | publishedVersionName="v1" | ||
| 669 | restrictView="N"> | ||
| 670 | </moqui.resource.wiki.WikiPage> | ||
| 671 | |||
| 672 | <moqui.resource.wiki.WikiPageHistory | ||
| 673 | wikiPageId="MCP_SCREEN_DOCS/FindProduct" | ||
| 674 | historySeqId="1" | ||
| 675 | versionName="v1" | ||
| 676 | userId="EX_JOHN_DOE" | ||
| 677 | changeDateTime="2025-01-19 00:00:00.000"/> | ||
| 678 | |||
| 679 | <!-- EditProduct Documentation --> | ||
| 680 | <moqui.resource.DbResource | ||
| 681 | resourceId="WIKI_MCP_DOCS_EDIT_PRODUCT" | ||
| 682 | parentResourceId="WIKI_MCP_SCREEN_DOCS" | ||
| 683 | filename="PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct.md" | ||
| 684 | isFile="Y"/> | ||
| 685 | <moqui.resource.DbResourceFile | ||
| 686 | resourceId="WIKI_MCP_DOCS_EDIT_PRODUCT" | ||
| 687 | mimeType="text/markdown" | ||
| 688 | versionName="v1"> | ||
| 689 | <fileData><![CDATA[# Edit Product | ||
| 690 | |||
| 691 | Manage product details, features, prices, categories, and associations. | ||
| 692 | |||
| 693 | ## Required Parameter | ||
| 694 | |||
| 695 | - **productId**: Product to edit (e.g., `DEMO_1`, `100000`) | ||
| 696 | |||
| 697 | ## Key Subscreens | ||
| 698 | |||
| 699 | - **EditProduct** (main): Basic product info | ||
| 700 | - **EditFeatures**: Product features (selectable/distinguishing) | ||
| 701 | - **EditAssocs**: Product associations (variants, accessories, etc.) | ||
| 702 | - **EditPrices**: Price configuration | ||
| 703 | - **EditCategories**: Category membership | ||
| 704 | |||
| 705 | ## Managing Features | ||
| 706 | |||
| 707 | ### Add Selectable Feature (Virtual Products) | ||
| 708 | ``` | ||
| 709 | path: PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct/EditFeatures | ||
| 710 | action: createProductFeature | ||
| 711 | parameters: { | ||
| 712 | productId: "DEMO_VAR", | ||
| 713 | productFeatureId: "ColorRed", | ||
| 714 | applTypeEnumId: "PfatSelectable" | ||
| 715 | } | ||
| 716 | ``` | ||
| 717 | |||
| 718 | ### Add Distinguishing Feature (Variant Products) | ||
| 719 | ``` | ||
| 720 | action: createProductFeature | ||
| 721 | parameters: { | ||
| 722 | productId: "DEMO_VAR_RED", | ||
| 723 | productFeatureId: "ColorRed", | ||
| 724 | applTypeEnumId: "PfatDistinguishing" | ||
| 725 | } | ||
| 726 | ``` | ||
| 727 | |||
| 728 | ## Feature Application Types | ||
| 729 | |||
| 730 | - **PfatSelectable**: Customer can choose this feature (on virtual parent) | ||
| 731 | - **PfatDistinguishing**: Identifies a specific variant | ||
| 732 | - **PfatStandard**: Always included with product | ||
| 733 | - **PfatRequired**: Must be selected at purchase | ||
| 734 | |||
| 735 | ## Managing Associations | ||
| 736 | |||
| 737 | ### Link Variant to Parent | ||
| 738 | ``` | ||
| 739 | path: PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct/EditAssocs | ||
| 740 | action: createProductAssoc | ||
| 741 | parameters: { | ||
| 742 | productId: "DEMO_VAR", | ||
| 743 | toProductId: "DEMO_VAR_RED", | ||
| 744 | productAssocTypeEnumId: "PatVariant" | ||
| 745 | } | ||
| 746 | ``` | ||
| 747 | |||
| 748 | ## Association Types | ||
| 749 | |||
| 750 | - **PatVariant**: Links virtual parent to variant | ||
| 751 | - **PatAccessory**: Suggested accessory | ||
| 752 | - **PatComplement**: Complementary product | ||
| 753 | - **PatSubstitute**: Equivalent alternative | ||
| 754 | |||
| 755 | ## Complete Variant Workflow | ||
| 756 | |||
| 757 | 1. Edit virtual product, go to EditFeatures | ||
| 758 | 2. Add selectable features (PfatSelectable) for each option | ||
| 759 | 3. Create variant products via FindProduct | ||
| 760 | 4. Edit each variant, add distinguishing feature (PfatDistinguishing) | ||
| 761 | 5. Edit parent, go to EditAssocs, create PatVariant associations]]></fileData> | ||
| 762 | </moqui.resource.DbResourceFile> | ||
| 763 | |||
| 764 | <moqui.resource.wiki.WikiPage | ||
| 765 | wikiPageId="MCP_SCREEN_DOCS/EditProduct" | ||
| 766 | wikiSpaceId="MCP_SCREEN_DOCS" | ||
| 767 | pagePath="PopCommerce/PopCommerceAdmin/Catalog/Product/EditProduct" | ||
| 768 | publishedVersionName="v1" | ||
| 769 | restrictView="N"> | ||
| 770 | </moqui.resource.wiki.WikiPage> | ||
| 771 | |||
| 772 | <moqui.resource.wiki.WikiPageHistory | ||
| 773 | wikiPageId="MCP_SCREEN_DOCS/EditProduct" | ||
| 774 | historySeqId="1" | ||
| 775 | versionName="v1" | ||
| 776 | userId="EX_JOHN_DOE" | ||
| 777 | changeDateTime="2025-01-19 00:00:00.000"/> | ||
| 778 | |||
| 360 | </entity-facade-xml> | 779 | </entity-facade-xml> | ... | ... |
-
Please register or sign in to post a comment