Skip to content

Commit 1477392

Browse files
samcrudgeclaudesushmanguptabojanrajh
authored
docs: update Nexus docs for Early Access release (#2339)
* docs: reframe Nexus from beta to Early Access Shopware Nexus has moved from beta to Early Access. Update the Nexus product docs accordingly: rename the status notice, the available-features and limitations sections, and the getting-started prerequisites/limitations. Feature scope and limitations are unchanged; GA remains the target milestone for the roadmap table. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: document Nexus user management, versioning, and current monitoring Add a User Management page (Admin/Builder/Viewer roles, invitations, per-company access) and document workflow versioning (history, compare, restore), which has shipped. Correct the execution-monitoring section: a per-node timeline and per-node payload inspection are now available, so the "no per-node logs / limited payload inspection" limitations are removed. Also surface config templates, manual run, and JSON import/export. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: link the Nexus club for questions and feedback Add a feedback callout on the Nexus overview and a pointer from Troubleshooting to the Nexus club, where Early Access users can ask questions and share feedback. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: troubleshoot activating the Nexus ingestion service via CLI When runtime extension management is disabled (common on composer-managed installations), the Shopware Nexus Event Ingestion Service cannot be activated from the Administration. Document the CLI alternative (app:activate ShopwareNexusIngestionService), based on a merchant report. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Update products/nexus/user-management.md * Update products/nexus/workflow.md * Update products/nexus/user-management.md * Update products/nexus/workflow.md --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: Su <112690947+sushmangupta@users.noreply.github.com> Co-authored-by: Bojan Rajh <117360292+bojanrajh@users.noreply.github.com>
1 parent c94cda3 commit 1477392

5 files changed

Lines changed: 86 additions & 15 deletions

File tree

products/nexus/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav:
1010

1111
- Shopware 6.7 or newer
1212
- Active Shopware subscription
13-
- Beta access granted by Shopware
13+
- Early Access granted by Shopware
1414
- Nexus service activated
1515
- Active Shopware services
1616
- Accept Shopware Service T&C's
@@ -28,14 +28,14 @@ nav:
2828
Your shops are pulled from the Shopware Business Platform.
2929

3030
:::warning
31-
Beta Limitation - Only the first company linked to your user account is used. As such, only shops linked to that first company will be available in Nexus.
31+
Early Access Limitation - Only the first company linked to your user account is used. As such, only shops linked to that first company will be available in Nexus.
3232
:::
3333

3434
## Create workflow
3535

3636
To create a workflow, follow the instructions in the [user documentation](https://docs.shopware.com/en/shopware-6-en/shopware-services/shopware-nexus?category=shopware-6-en/insider-previews).
3737

38-
## Known Limitations - Beta-Specific
38+
## Known Limitations - Early Access
3939

4040
| Limitation | Workaround |
4141
|------------|------------|

products/nexus/index.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,15 @@ nav:
77
# Shopware Nexus Overview
88

99
:::warning
10-
**Beta Notice**
10+
**Early Access Notice**
1111

12-
Shopware Nexus is currently in **beta** status. The range of functions is limited and may expand in future updates. Behaviour and scope may change.
12+
Shopware Nexus is currently in **Early Access**. The range of functions is limited and may expand in future updates. Behaviour and scope may change.
13+
:::
14+
15+
:::info
16+
**Questions or feedback?**
17+
18+
Join the [Nexus club](https://hub.shopware.com/clubs/nexus) to ask questions, share feedback, and help shape where Nexus goes next.
1319
:::
1420

1521
Shopware Nexus is a unified platform for **event-driven automation and integration**.
@@ -22,8 +28,9 @@ It empowers merchants to orchestrate systems visually using low-code simplicity,
2228
- Syncs data bidirectionally between Shopware and external systems (e.g., Microsoft Dynamics Business Central)
2329
- Enables conditional logic and data transformation without coding
2430
- Provides real-time execution monitoring
31+
- Manages team access with role-based permissions
2532

26-
## Available in beta
33+
## Available in Early Access
2734

2835
| Feature | Description |
2936
|----------|------------|
@@ -38,26 +45,28 @@ It empowers merchants to orchestrate systems visually using low-code simplicity,
3845
| S3 Storage | Store data on S3 |
3946
| Data Transformation | Map and filter data |
4047
| Expression Placeholders | Placeholders to insert event data into templates |
41-
| Execution Monitoring | Track runs & metrics |
48+
| Execution Monitoring | Track runs & metrics, including per-node timeline and payloads |
4249
| Delay Node | Add timed delays between steps |
50+
| Workflow Versioning | Published version history with compare and restore |
51+
| User Management & Roles | Admin, Builder, and Viewer roles per company |
4352

44-
## Limitations in beta
53+
## Limitations in Early Access
4554

46-
The following capabilities are **not available during the beta phase**:
55+
The following capabilities are **not available during Early Access**:
4756

4857
- SLA guarantees
4958
- 24/7 support
5059
- Multi-region deployment (EU only)
51-
- On-premise/self-hosted deployment
5260
- Workflow marketplace
5361

54-
## Coming after beta
62+
Nexus is a managed cloud service. On-premise and self-hosted deployment are not being considered at this time.
63+
64+
## Coming after Early Access
5565

5666
| Feature | Planned For | Description |
5767
|----------|------------|------------|
5868
| AI-Assisted Authoring | GA | Intelligent suggestions |
5969
| Advanced Analytics | GA | Performance insights |
6070
| Per-Tenant Quotas | GA | Usage & billing |
61-
| Workflow Versioning UI | GA | Rollback support |
6271
| Additional ERP Connectors | Post-GA | SAP, Oracle, etc. |
6372
| Custom Node Development | Post-GA | Custom workflow nodes |

products/nexus/security.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,13 @@ nav:
2020
| Missing event data | Inspect payload with Log node |
2121
| BC filter returns empty | Validate OData syntax |
2222
| Slack message not sent | Re-authorize Slack |
23+
24+
### Activating the Nexus ingestion service
25+
26+
If runtime extension management is disabled (common on composer-managed installations), the **Shopware Nexus Event Ingestion Service** cannot be activated from the Administration. Activate it from the CLI instead:
27+
28+
```bash
29+
bin/console app:activate ShopwareNexusIngestionService
30+
```
31+
32+
Still stuck? Ask in the [Nexus club](https://hub.shopware.com/clubs/nexus).

products/nexus/user-management.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
nav:
3+
title: User Management
4+
position: 5
5+
---
6+
7+
# User Management
8+
9+
Nexus access is scoped to your company. Every user who belongs to the company is assigned a role that controls what they can see and do.
10+
11+
## Roles
12+
13+
| Role | Access |
14+
|------|--------|
15+
| Admin | Full access — can manage users, settings, and all workflows |
16+
| Builder | Can create and edit workflows, but cannot manage users or settings |
17+
| Viewer | Read-only access — can view workflows and execution results |
18+
19+
## Managing users
20+
21+
Admins manage users from the **User management** screen, which lists everyone in the company with their role and status (Active, Inactive, Pending).
22+
23+
From here, an Admin can:
24+
25+
- **Invite** a new user by email and assign an initial role
26+
- **Change permission** to move a user between roles
27+
- **Remove** a user from the company
28+
29+
:::info
30+
To keep companies from being locked out, you cannot change your own role, and
31+
the last remaining Admin cannot be demoted.
32+
:::
33+
34+
## Invitations
35+
36+
Invited users appear as **Pending** until they accept. Admins can resend or
37+
revoke a pending invitation at any time. Once accepted, the user becomes Active
38+
with the role they were assigned.

products/nexus/workflow.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@ Typical structure:
3131
| Canvas | Visual workspace |
3232
| Node Palette | Available nodes |
3333
| Node Configuration | Params, Credentials, Notes, Debug |
34-
| Toolbar | Save, Publish, Execute, Undeploy |
34+
| Config Templates | Save and reuse node configurations across workflows |
35+
| Toolbar | Save, Publish, Run, Undeploy, Import/Export |
3536
| Execution Tab | Run history and metrics |
3637

38+
A workflow can also be run manually with an optional input payload, and
39+
workflows can be exported to or imported from JSON for backup and sharing.
40+
3741
## Workflow states
3842

3943
| State | Description | Available Actions |
@@ -54,13 +58,23 @@ Workflows move through these states from creation to active execution.
5458
- Execution duration
5559
- Messages processed per node
5660
- Error counts and latency
61+
- Node timeline showing each node's step, label, status, and runtime
62+
- Per-node payload inspection as formatted JSON
5763

5864
## Current Monitoring Limitations
5965

60-
- No per-node execution logs
61-
- Limited payload inspection
6266
- Manual refresh required
6367

68+
## Versioning
69+
70+
Each time you publish a workflow, Nexus stores an immutable version in its history. From the **Versions** panel you can:
71+
72+
- Review every published version with its author and publish time
73+
- Compare two versions to see node, connector, and setting changes
74+
- Restore an earlier version, which replaces the current draft (existing published versions are untouched)
75+
76+
A workflow must be deactivated before you can restore a version.
77+
6478
## Node types
6579

6680
### Trigger nodes

0 commit comments

Comments
 (0)