# sage-erp-x3/sample-x3-ws-php-webportal architecture

> Architecture diagram of the GitHub repository sage-erp-x3/sample-x3-ws-php-webportal, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sage-erp-x3/sample-x3-ws-php-webportal
- Repository: https://github.com/sage-erp-x3/sample-x3-ws-php-webportal

## Overview

This is a PHP example portal for exercising Sage X3 SOAP web services and its GraphQL API, not a production application. Users navigate portal pages to browse or read purchasing data, create sales orders, inspect products and stock, or generate a JWT; page handlers delegate to SOAP or GraphQL models that format results for display. The GraphQL purchasing flow covers purchase-order lists/details and receipt data, while SOAP models cover sales orders and product/stock operations. The graph reflects README capabilities and indexed references; some page-to-model wiring is unverified because those page sources were not excerpted.

Main entry points: [`includes/menu_home.php`](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/menu_home.php) (Navigation), [`GraphQL/ModelGraphQLX3.php`](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/ModelGraphQLX3.php) (GraphQL client), [`WebServiceSOAP/modelWS/ModelX3.php`](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/ModelX3.php) (SOAP operations), [`page_poh_gq_read.php`](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_poh_gq_read.php) (Purchase details)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_portal["Portal UI"]
  node_nav["Navigation<br/>[menu_home.php]"]
  node_page_shell["Page shell<br/>[head.php]"]
  node_page_end["Page scripts<br/>[end_body.php]"]
  node_purchase_list_page["Purchase order list"]
  node_purchase_detail_page["Purchase details"]
  node_sales_create_page["Sales order form"]
  node_sales_action_page["Sales order submit"]
end

subgraph group_gql["GraphQL Purchasing"]
  node_gql_base["GraphQL client<br/>[ModelGraphQLX3.php]"]
  node_purchase_orders["Purchase orders<br/>[PurchaseOrder.php]"]
  node_purchase_receipts["Purchase receipts"]
  node_gql_api{{"Sage GraphQL API"}}
end

subgraph group_soap["SOAP Integration"]
  node_soap_order["Sales orders<br/>[Order.php]"]
  node_soap_product["Products<br/>[Product.php]"]
  node_soap_stock["Stock<br/>[stock.php]"]
  node_soap_base["SOAP operations<br/>[ModelX3.php]"]
  node_soap_client["SOAP client"]
  node_soap_types["SOAP data types"]
  node_x3_soap{{"Sage X3 SOAP"}}
end

subgraph group_security["Authentication"]
  node_token_page["Token page<br/>[page_get_token.php]"]
  node_jwt["JWT generator<br/>[TokenJWT.php]"]
  node_config["Portal configuration"]
end

node_user(("Portal user"))

node_user -->|"navigates"| node_nav
node_nav -->|"opens"| node_purchase_list_page
node_nav -->|"opens"| node_purchase_detail_page
node_nav -->|"opens"| node_sales_create_page
node_purchase_list_page -->|"renders list"| node_purchase_orders
node_purchase_detail_page -->|"renders details"| node_purchase_orders
node_purchase_detail_page -->|"uses receipt data"| node_purchase_receipts
node_purchase_orders -->|"inherits client"| node_gql_base
node_purchase_receipts -->|"inherits client"| node_gql_base
node_gql_base -->|"gets token"| node_jwt
node_gql_base -.->|"queries"| node_gql_api
node_user -.->|"submits"| node_sales_action_page
node_sales_action_page -->|"creates order"| node_soap_order
node_sales_create_page -->|"uses products"| node_soap_product
node_soap_order -->|"extends"| node_soap_base
node_soap_product -->|"extends"| node_soap_base
node_soap_stock -.->|"uses operations"| node_soap_base
node_soap_base -.->|"calls operations"| node_soap_client
node_soap_client -->|"maps types"| node_soap_types
node_soap_client -->|"sends SOAP"| node_x3_soap
node_user -.->|"requests token"| node_token_page
node_token_page -.->|"generates"| node_jwt
node_jwt -->|"reads credentials"| node_config
node_nav -.->|"appears in"| node_page_shell
node_page_shell -.->|"frames pages"| node_page_end

click node_nav "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/menu_home.php"
click node_page_shell "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/head.php"
click node_page_end "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/end_body.php"
click node_purchase_list_page "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_poh_gq_list.php"
click node_purchase_detail_page "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_poh_gq_read.php"
click node_sales_create_page "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_soh_create.php"
click node_sales_action_page "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_soh_create_action.php"
click node_gql_base "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/ModelGraphQLX3.php"
click node_purchase_orders "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/PurchaseOrder.php"
click node_purchase_receipts "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/PurchaseReceipt.php"
click node_soap_order "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/models/Order.php"
click node_soap_product "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/models/Product.php"
click node_soap_stock "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/models/stock.php"
click node_soap_base "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/ModelX3.php"
click node_soap_client "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/CAdxWebServiceXmlCCService.php"
click node_soap_types "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/CAdxCallContext.php"
click node_token_page "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_get_token.php"
click node_jwt "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/authentication/JWT/TokenJWT.php"
click node_config "https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/config/Config_template.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_nav,node_page_shell,node_page_end,node_purchase_list_page,node_purchase_detail_page,node_sales_create_page,node_sales_action_page,node_user toneBlue
class node_gql_base,node_purchase_orders,node_purchase_receipts,node_gql_api toneAmber
class node_soap_order,node_soap_product,node_soap_stock,node_soap_base,node_soap_client,node_soap_types,node_x3_soap toneMint
class node_token_page,node_jwt,node_config toneRose
```

## Components

### Portal UI

- [Navigation](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/menu_home.php): `includes/menu_home.php`
- [Page shell](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/head.php): `includes/head.php`
- [Page scripts](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/includes/end_body.php): `includes/end_body.php`
- [Purchase order list](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_poh_gq_list.php): `page_poh_gq_list.php`
- [Purchase details](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_poh_gq_read.php): `page_poh_gq_read.php`
- [Sales order form](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_soh_create.php): `page_soh_create.php`
- [Sales order submit](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_soh_create_action.php): `page_soh_create_action.php`

### GraphQL Purchasing

- [GraphQL client](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/ModelGraphQLX3.php): `GraphQL/ModelGraphQLX3.php`
- [Purchase orders](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/PurchaseOrder.php): `GraphQL/PurchaseOrder.php`
- [Purchase receipts](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/GraphQL/PurchaseReceipt.php): `GraphQL/PurchaseReceipt.php`
- **Sage GraphQL API**

### SOAP Integration

- [Sales orders](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/models/Order.php): `WebServiceSOAP/models/Order.php`
- [Products](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/models/Product.php): `WebServiceSOAP/models/Product.php`
- [Stock](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/models/stock.php): `WebServiceSOAP/models/stock.php`
- [SOAP operations](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/ModelX3.php): `WebServiceSOAP/modelWS/ModelX3.php`
- [SOAP client](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/CAdxWebServiceXmlCCService.php): `WebServiceSOAP/modelWS/CAdxWebServiceXmlCCService.php`
- [SOAP data types](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/WebServiceSOAP/modelWS/CAdxCallContext.php): `WebServiceSOAP/modelWS/CAdxCallContext.php`
- **Sage X3 SOAP**

### Authentication

- [Token page](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/page_get_token.php): `page_get_token.php`
- [JWT generator](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/authentication/JWT/TokenJWT.php): `authentication/JWT/TokenJWT.php`
- [Portal configuration](https://github.com/sage-erp-x3/sample-x3-ws-php-webportal/blob/master/config/Config_template.php): `config/Config_template.php`

### Other components

- **Portal user**

## Connections

- Portal user → Navigation: navigates (evidence: `includes/menu_home.php`)
- Navigation → Purchase order list: opens (evidence: `includes/menu_home.php`)
- Navigation → Purchase details: opens (evidence: `includes/menu_home.php`)
- Navigation → Sales order form: opens (evidence: `includes/menu_home.php`)
- Purchase order list → Purchase orders: renders list (evidence: `page_poh_gq_list.php`)
- Purchase details → Purchase orders: renders details (evidence: `page_poh_gq_read.php`)
- Purchase details → Purchase receipts: uses receipt data (evidence: `page_poh_gq_read.php`)
- Purchase orders → GraphQL client: inherits client (evidence: `GraphQL/PurchaseOrder.php`)
- Purchase receipts → GraphQL client: inherits client (evidence: `GraphQL/PurchaseReceipt.php`)
- GraphQL client → JWT generator: gets token (evidence: `GraphQL/ModelGraphQLX3.php`)
- GraphQL client → Sage GraphQL API: queries
- Portal user → Sales order submit: submits
- Sales order submit → Sales orders: creates order (evidence: `page_soh_create_action.php`)
- Sales order form → Products: uses products (evidence: `page_soh_create.php`)
- Sales orders → SOAP operations: extends (evidence: `WebServiceSOAP/models/Order.php`)
- Products → SOAP operations: extends (evidence: `WebServiceSOAP/models/Product.php`)
- Stock → SOAP operations: uses operations
- SOAP operations → SOAP client: calls operations
- SOAP client → SOAP data types: maps types (evidence: `WebServiceSOAP/modelWS/CAdxWebServiceXmlCCService.php`)
- SOAP client → Sage X3 SOAP: sends SOAP (evidence: `WebServiceSOAP/modelWS/CAdxWebServiceXmlCCService.php`)
- Portal user → Token page: requests token
- Token page → JWT generator: generates
- JWT generator → Portal configuration: reads credentials (evidence: `authentication/JWT/TokenJWT.php`)
- Navigation → Page shell: appears in
- Page shell → Page scripts: frames pages
