Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating develop branch #167

Merged
merged 127 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
127 commits
Select commit Hold shift + click to select a range
0eb0cb3
edits
jhadobe Nov 10, 2023
0b5df98
clean up metadata
jhadobe Nov 10, 2023
4cdcdf7
code review
jhadobe Nov 10, 2023
40e7a74
link fix
jhadobe Nov 10, 2023
8efe5c7
linting
jhadobe Nov 10, 2023
704cd24
updating image, crop
jhadobe Nov 10, 2023
6fe8764
adding nav
jhadobe Nov 13, 2023
08ab70f
updating relative links
jhadobe Nov 13, 2023
c300298
moving to replace the main index page
jhadobe Nov 13, 2023
42c1f98
combining with elements of previous index
jhadobe Nov 13, 2023
3f15a66
spacing
jhadobe Nov 13, 2023
966aed0
spacing 2
jhadobe Nov 13, 2023
87c19ab
Apply suggestions from code review
jhadobe Nov 13, 2023
7bc04a1
Apply suggestions from code review
jhadobe Nov 13, 2023
06c1726
suggestions from code review
jhadobe Nov 13, 2023
5f0469d
Update src/pages/index.md
jhadobe Nov 14, 2023
9cbe6d9
Merge branch 'main' into jh_extensibility_oop
jhadobe Nov 30, 2023
dac2c7c
Adding PMM review
jhadobe Dec 1, 2023
719c1de
Merge branch 'main' into jh_extensibility_oop
jhadobe Jan 8, 2024
13dc0c9
Draft version
MayurBagwe Jan 12, 2024
a785a2c
Update src/pages/events/convert-existing-fields.md
MayurBagwe Jan 12, 2024
8ae3d93
Update src/pages/events/convert-existing-fields.md
MayurBagwe Jan 12, 2024
014868a
Update src/pages/events/convert-existing-fields.md
MayurBagwe Jan 12, 2024
95e1d63
Update src/pages/events/convert-existing-fields.md
MayurBagwe Jan 12, 2024
49abe27
Update src/pages/events/convert-existing-fields.md
MayurBagwe Jan 12, 2024
515dacd
Update src/pages/events/convert-existing-fields.md
MayurBagwe Jan 12, 2024
4d815e6
revised docs
MayurBagwe Jan 12, 2024
86a5815
added converter option and link
MayurBagwe Jan 12, 2024
7b20e56
updated fieldName
MayurBagwe Jan 12, 2024
e52f4f6
Merge branch 'main' into jh_extensibility_oop
jhadobe Jan 17, 2024
4766107
Merge branch 'main' into jh_extensibility_oop
jhadobe Jan 17, 2024
1de2abe
Adding learning path
jhadobe Jan 17, 2024
aa36b01
Major revisions
keharper Jan 17, 2024
4a90c81
CEXT-1699-Docs minor updates
MayurBagwe Jan 18, 2024
4fd6a5e
minor fix
MayurBagwe Jan 18, 2024
f45bc7e
updated exmaple code
MayurBagwe Jan 18, 2024
efc968e
Added blank lines
MayurBagwe Jan 18, 2024
df09805
Update src/pages/events/convert-field-values.md
MayurBagwe Jan 18, 2024
587cd74
Update convert-field-values.md
keharper Jan 18, 2024
35a8419
Fix the broken link to the UI Extensibility guide
keharper Jan 18, 2024
a76cb91
Merge branch 'CEXT-1699-Docs' of https://github.com/MayurBagwe/commer…
keharper Jan 18, 2024
bd5b2ba
Apply suggestions from code review
keharper Jan 18, 2024
1c3890f
Merge pull request #131 from MayurBagwe/CEXT-1699-Docs
keharper Jan 18, 2024
194fb27
Merge pull request #133 from AdobeDocs/main
keharper Jan 18, 2024
711ec9f
SDK 1.3.1 release notes
keharper Jan 22, 2024
8ad6186
review comment
keharper Jan 22, 2024
bdd420d
Update src/pages/admin-ui-sdk/extension-points/product/mass-action.md
keharper Jan 22, 2024
b2f3d83
PMM feedback
jhadobe Jan 24, 2024
3d91ad8
Merge pull request #134 from AdobeDocs/sdk131-develop
keharper Jan 25, 2024
2d86f51
Upgrade theme to v4.11.3 (#140)
dshevtsov Jan 26, 2024
e24fb6b
Correct order view parameters
keharper Jan 30, 2024
58a902d
Typo
keharper Jan 30, 2024
0be75cc
Merge pull request #141 from AdobeDocs/kh_order-button
keharper Jan 30, 2024
1e8f137
PMM review
jhadobe Jan 31, 2024
07efe78
CEXT-2783: Documentation on how to resolve stuck deployment on the Cloud
oshmyheliuk Feb 1, 2024
ddeedd1
CEXT-2783: Documentation on how to resolve stuck deployment on the Cloud
oshmyheliuk Feb 1, 2024
4600c43
update link
jhadobe Feb 1, 2024
69bd20b
Merge branch 'main' into jh_extensibility_oop
jhadobe Feb 1, 2024
5133c45
adding descriptions
jhadobe Feb 1, 2024
c410e15
Merge remote-tracking branch 'refs/remotes/origin/jh_extensibility_oo…
jhadobe Feb 1, 2024
95d1d67
Editorial updates
keharper Feb 5, 2024
7915ecf
Editorial updates
keharper Feb 5, 2024
70caa30
Merge pull request #143 from oshmyheliuk/CEXT-2783
keharper Feb 5, 2024
3db30ff
CEXT-2784: Release commerce eventing and webhook modules
oshmyheliuk Feb 7, 2024
b066654
Update release-notes.md
keharper Feb 7, 2024
0f8c816
Merge pull request #146 from oshmyheliuk/CEXT-2784-events-release-notes
keharper Feb 7, 2024
89f9d74
CEXT-2829: Draft of webhooks admin UI docs page
ryanjcohen Feb 7, 2024
507e104
Webhooks 1.2.0 release notes
keharper Feb 7, 2024
00a577d
CEXT-2829: Style fixes
ryanjcohen Feb 7, 2024
78e6706
Merge pull request #148 from AdobeDocs/relnotes-webhooks120
keharper Feb 7, 2024
10cc707
Update src/pages/events/release-notes.md
keharper Feb 7, 2024
e431b58
Merge branch 'main' into events-develop
keharper Feb 7, 2024
b76c8e9
Merge pull request #149 from AdobeDocs/events-develop
keharper Feb 7, 2024
c7ffbf9
Update src/pages/webhooks/admin-configuration.md
ryanjcohen Feb 7, 2024
58bde08
Update src/pages/webhooks/admin-configuration.md
ryanjcohen Feb 7, 2024
2e250a7
Update src/pages/webhooks/admin-configuration.md
ryanjcohen Feb 7, 2024
aca8902
Update src/pages/webhooks/admin-configuration.md
ryanjcohen Feb 7, 2024
87c2d4a
Update src/pages/webhooks/admin-configuration.md
ryanjcohen Feb 7, 2024
d197383
CEXT-2829: Review updates
ryanjcohen Feb 7, 2024
3c67a3b
Merge branch 'webhooks12-develop' of github.com:AdobeDocs/commerce-ex…
ryanjcohen Feb 7, 2024
f54deee
CEXT-2829: Added link in release notes
ryanjcohen Feb 7, 2024
73f4412
CEXT_2829: Review comments
ryanjcohen Feb 7, 2024
d2f372c
CEXT-2829: Review comments
ryanjcohen Feb 7, 2024
83ffa2a
CEXT-2829: Review comments
ryanjcohen Feb 7, 2024
3ba2673
Update admin-configuration.md
keharper Feb 7, 2024
9409847
Update admin-configuration.md
keharper Feb 7, 2024
38f20b6
Merge pull request #147 from ryanjcohen/webhooks-admin-ui
keharper Feb 7, 2024
c5340d0
Merge branch 'main' into webhooks12-develop
keharper Feb 7, 2024
8c8cadf
Merge pull request #150 from AdobeDocs/webhooks12-develop
keharper Feb 7, 2024
94b9d1a
Webhooks admin configuration warning addition
ryanjcohen Feb 8, 2024
aa2f437
Webhooks admin configuration warning addition
ryanjcohen Feb 8, 2024
5a20d74
Merge pull request #151 from ryanjcohen/webhooks-admin-ui
keharper Feb 8, 2024
31a769f
Merge branch 'main' into jh_extensibility_oop
jhadobe Feb 8, 2024
746710f
Add Admin configuraiton details
keharper Feb 13, 2024
6603f20
typo
keharper Feb 13, 2024
2ae2131
Add missing table columns
keharper Feb 13, 2024
fe3531c
Apply suggestions from code review
keharper Feb 13, 2024
60354aa
Review commands and BIC notice
keharper Feb 13, 2024
7506e5c
Merge pull request #152 from AdobeDocs/kh_admin-webhooks
keharper Feb 13, 2024
08e93cf
PMM and PM updates
jhadobe Feb 14, 2024
4dae2cc
Merge branch 'main' into jh_extensibility_oop
jhadobe Feb 14, 2024
5672d74
Apply suggestions from code review
jhadobe Feb 14, 2024
1b780b4
Code review
jhadobe Feb 14, 2024
578eb64
Merge remote-tracking branch 'refs/remotes/origin/jh_extensibility_oo…
jhadobe Feb 14, 2024
1b8e03f
Merge pull request #104 from AdobeDocs/jh_extensibility_oop
jhadobe Feb 14, 2024
4247458
Reorder sections on front page
keharper Feb 14, 2024
c1b8a9f
Merge pull request #153 from AdobeDocs/kh_section-reorder
keharper Feb 14, 2024
c16e01e
Add logging to learning path
jhadobe Feb 15, 2024
473276f
moving sections
jhadobe Feb 16, 2024
a78266a
add links
jhadobe Feb 16, 2024
211613d
Merge pull request #154 from AdobeDocs/jh_path_update
jhadobe Feb 16, 2024
7da0a48
SDK 1.3.2 release notes
keharper Feb 27, 2024
0a22e7f
Merge pull request #157 from AdobeDocs/relnotes-132
keharper Mar 4, 2024
8cc1f99
CEXT-2869: Release commerce eventing and commerce eventing service
oshmyheliuk Mar 4, 2024
5d4167b
CEXT-2869: Release commerce eventing and commerce eventing service
oshmyheliuk Mar 4, 2024
74df8d9
Grammatical fixes
keharper Mar 4, 2024
e5905d0
Updated description
keharper Mar 4, 2024
fbb4d96
Fix linting error
keharper Mar 4, 2024
cdae3ec
Merge pull request #159 from oshmyheliuk/CEXT-2869
keharper Mar 4, 2024
16408aa
Webhooks 1.2.1 release notes
ryanjcohen Mar 18, 2024
861e0f3
Updates for bookmark removal
ryanjcohen Mar 18, 2024
9d7300f
Update webhooks-grid image
ryanjcohen Mar 18, 2024
23f0211
Change release date
keharper Mar 19, 2024
91aba33
Merge pull request #161 from ryanjcohen/webhooks-121
keharper Mar 19, 2024
994ef89
Update Adobe IO State Library details
keharper Mar 20, 2024
c7bb431
Typo?
keharper Mar 20, 2024
a05b0fe
Merge pull request #164 from AdobeDocs/kh_lib-state
keharper Mar 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"url": "https://github.com/AdobeDocs/commerce-extensibility"
},
"dependencies": {
"@adobe/gatsby-theme-aio": "4.10.7",
"@adobe/gatsby-theme-aio": "^4.11.3",
"gatsby": "4.22.0",
"react": "^17.0.2",
"react-dom": "^17.0.2"
Expand Down
4 changes: 4 additions & 0 deletions src/data/navigation/sections/app-development.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,9 @@ module.exports = [
{
title: "Extensibility examples",
path: "/app-development/examples.md"
},
{
title: "Learning path",
path: "/app-development/learning-path.md"
}
];
4 changes: 4 additions & 0 deletions src/data/navigation/sections/events.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ module.exports = [
title: "Add custom fields",
path: "/events/custom-event-fields.md"
},
{
title: "Convert payload field values",
path: "/events/convert-field-values.md"
},
{
title: "Command reference",
path: "/events/commands.md",
Expand Down
4 changes: 4 additions & 0 deletions src/data/navigation/sections/webhooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ module.exports = [
title: "Configuration reference",
path: "/webhooks/xml-schema.md"
},
{
title: "Admin configuration",
path: "/webhooks/admin-configuration.md"
},
{
title: "Command reference",
path: "/webhooks/commands.md",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/_images/webhooks/edit-hook-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/_images/webhooks/webhooks-grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/pages/admin-ui-sdk/extension-points/order/mass-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ order: {
{
actionId: `${extensionId}::another-first-mass-action`,
label: 'Another Mass Action',
title: 'Another Orders Mass Action',
type: `${extensionId}.another-mass-action`,
path: '#/another-mass-action'
}
Expand All @@ -50,6 +51,7 @@ order: {
| `confirm.message` | string | No | The message displayed on the confirmation dialog for a mass action. |
| `confirm.title` | string | No | The title of a dialog that confirms the mass action. |
| `label` | string | Yes | An Action label to display in the Mass Actions grid. |
| `title` | string | No | An optional page title for the action. If not specified, the label is used.
| `path` | string | Yes | The relative path in the application to redirect to the action. You might need to prepend `#/` to the path to ensure access to the correct page. |
| `orderSelectLimit` | integer | No | Set the maximum number of orders that can be selected for a mass action. By default, the number is unlimited. |
| `type` | string | Yes | A unique ID that identifies the type of action. |
5 changes: 3 additions & 2 deletions src/pages/admin-ui-sdk/extension-points/order/view-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ order: {
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `buttonId` | string | Yes | A unique ID to identify the button. We recommend using the format `<extensionId>::<buttonName>`. |
| `label` | string | No | The label of the button. |
| `label` | string | Yes | The label of the button. |
| `confirm.message` | string | No | Confirmation message to display. |
| `path` | string | Yes | The relative path to the button page in the App. The order ID will be sent as part of the query. |
| `level` | integer | Yes | The position in which a set of buttons are placed in the toolbar. The possible values are `-1` (left), `0` (center), and `1` (right). |
| `level` | integer | No | The position in which a set of buttons are placed in the toolbar. The possible values are `-1` (left), `0` (center), and `1` (right). |
| `sortOrder` | integer | No | The order in which the button is placed inside the level. |
| `class` | string | Yes | The class of the button. Possible values are `save`, `edit`, `reset`, and `custom`. |
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ product: {
actionId: `${extensionId}::another-first-mass-action`,
label: 'Another Mass Action',
type: `${extensionId}.another-mass-action`,
title: 'Another Products Mass Action',
path: '#/another-mass-action'
}
]
Expand All @@ -50,6 +51,7 @@ product: {
| `confirm.message` | string | No | The message displayed on the confirmation dialog for a mass action |
| `confirm.title` | string | No | The title of a dialog that confirms the mass action |
| `label` | string | Yes | An Action label to display in the Mass Actions grid |
| `title` | string | No | An optional page title for the action. If not specified, the label is used. |
| `path` | string | Yes | The relative path in the application to redirect to the action. You might need to prepend `#/` to the path to ensure access to the correct page. |
| `productSelectLimit` | integer | No | Set the maximum number products that can be selected for a mass action. By default, the number is unlimited. |
| `type` | string | Yes | A unique ID that identifies the type of the action. |
30 changes: 30 additions & 0 deletions src/pages/admin-ui-sdk/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,36 @@ keywords:

# Adobe Commerce Admin UI SDK release notes

## Version 1.3.2

### Release date

March 4, 2024

### Bug fixes

* Corrected a condition that allowed administrators who did not have proper permissions to view data in grid columns.

## Version 1.3.1

### Release date

January 25, 2024

### Enhancements

* Enhanced unit coverage by 150%. <!-- CEXT-2345, CEXT-2425, CEXT-2593, CEXT-2596, CEXT-2600, CEXT-2601, CEXT-2602, CEXT-2603, CEXT-2604 -->

* Added the ability to optionally specify a page title for a mass action. <!-- CEXT-2598 -->

* The Admin UI SDK cache is now flushed weekly instead of every 12 hours. <!-- CEXT-2643 -->

* The Admin UI SDK now supports PHP 8.3. <!-- CEXT-2724 -->

### Bug fixes

* The Admin now displays extensions correctly when they are loaded from the extension manager registry. <!-- CEXT-2595 -->

## Version 1.3.0

### Release date
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ The throttling controls of Amazon's Selling Partner APIs significantly impact ap

The `lib-state` library has clear limitations both in practice and from the public documentation. A common misconception is that this library is a replacement for a traditional RDBMS/noSQL database. Instead, it has technical capabilities that are similar to Redis or other caching services. The library [README](https://github.com/adobe/aio-lib-state) lists these limitations:

* Maximum state value size: 2MB
* The namespace must be in the valid AppBuilder format: `amsorg-project(-workspace)`
* Maximum state value size: 1MB
* Maximum state key size: 1024 bytes
* Maximum total state size: 10 GB
* Token expiry (need to re-init after expiry): 1 hour
* Non-supported characters for state keys are: '/', '\', '?', '#'
* Alphanumeric characters are supported as well as `-` (dash), `_` (underbar), and `.` (period)
* The default TTL value is one day. The maximum is 365 days.

These additional limitations should also be considered:

Expand Down
72 changes: 72 additions & 0 deletions src/pages/app-development/learning-path.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Extensibility learning path
description: Follow the learning path links to learn the basics about app builder setup and development.
keywords:
- Extensibility
- App Builder
- API Mesh
- Events
- REST
- Tools
---

# Extensibility learning path

Follow the learning path links to understand the basics about App Builder setup and development.

The following resources will help you get to know the extensibility options offered by Adobe Commerce and start developing:

## How does App Builder work?

- [Introducing App Builder for Commerce](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/introduction-to-app-builder.html) - A high-level business value proposition and ecosystem.
- [Use Cases](https://www.youtube.com/watch?v=spm90jwC94A&t=1s) - a one-hour video on common App Builder use cases.
- [Sample App](https://developer.adobe.com/commerce/extensibility/amazon-sales-channel/) - An internally developed sample app with best practices and references to an example GitHub repo.
- [Demo](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/app-builder-functional-demonstration.html) - A short video demonstrating a functional integration between Commerce and Amazon Marketplace.

## How can I get set up?

- [Getting access to App Builder](https://developer.adobe.com/app-builder/docs/overview/getting_access/) - Information on how to request trial access or purchase a license.
- [Onboarding developers and admins](https://helpx.adobe.com/enterprise/using/manage-developers.html) - Information on how to set up your organization after getting access to App Builder.

## How do I start developing?

- Develop custom applications with Adobe Developer App Builder
- [App Builder overview](https://developer.adobe.com/app-builder/docs/overview/) - An overview of the App Builder ecosystem. The App Builder documentation applies to all Adobe products that integrate with App Builder, including Adobe Commerce.
- [Creating your first App Builder application](https://developer.adobe.com/app-builder/docs/getting_started/first_app/) - A generalized tutorial on creating your first App Builder app. If you are new to App Builder, Adobe recommends reviewing the App Builder overview before beginning this tutorial.
- Orchestration with API Mesh for Adobe Developer App Builder
- [Getting started](https://developer.adobe.com/graphql-mesh-gateway/gateway/getting-started/) - Information on how to get started with API Mesh.
- [Creating a mesh](https://developer.adobe.com/graphql-mesh-gateway/gateway/create-mesh/) - Developer documentation on creating a mesh.
- [Create a mesh walkthrough](https://developer.adobe.com/graphql-mesh-gateway/gateway/mesh_walkthrough/) - Documentation that provides a guided walkthrough of basic API Mesh functionality.
- API Mesh video tutorials - A set of video tutorials that demonstrate basic API Mesh functionality:
- [Getting started with API Mesh](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/api-mesh/getting-started-api-mesh.html)
- [Installing Adobe I/O Runtime CLI and the API Mesh plugin](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/api-mesh/installing-aio-mesh-plugin.html)
- [Working with projects and workspaces](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/api-mesh/aio-projects-workspaces.html)
- [Create a mesh with a single source](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/api-mesh/graphql-single-source.html)
- [Create a mesh with multiple sources](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/api-mesh/graphql-multiple-source.html?lang=en)
- Build event-driven integrations with Adobe I/O Events for Adobe Commerce
- [Adobe I/O Events](https://developer.adobe.com/events/docs/) - Developer documentation for general Adobe I/O Events functionality, not specific to Adobe Commerce. View this documentation for information about consuming events in App Builder using journaling, runtime actions, retry mechanisms, and more.
- [Adobe I/O Events for Adobe Commerce](https://developer.adobe.com/commerce/extensibility/events/) - Developer documentation for Adobe I/O Events for Adobe Commerce.
- [Installation](https://developer.adobe.com/commerce/extensibility/events/installation/) - Developer docs for setting up the I/O Events for Adobe Commerce.
- Eventing video tutorials - A set of developer-facing video tutorials that demonstrate how to set up I/O Events for Adobe Commerce
- [Getting started](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/io-events/getting-started-io-events.html) - A video tutorial on how to use I/O Events for Adobe Commerce.
- Adobe I/O Events installation - Learn how to install several new modules in Adobe Commerce using Composer for the corresponding version.
- [Adobe Commerce 2.4.6](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/io-events/2-4-6-installation.html)
- [Adobe Commerce 2.4.5](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/io-events/2-4-5-installation.html)
- [Configure I/O Events for Adobe Commerce](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/io-events/configure-commerce.html) - A tutorial video on how to set up I/O Events for Adobe Commerce.
- [Create an App Builder project](https://experienceleague.adobe.com/docs/commerce-learn/tutorials/adobe-developer-app-builder/io-events/create-app-builder-project.html) - Learn how to create an Adobe Developer App Builder project to consume events from Adobe Commerce.
- Extend the Admin UI with the Admin UI SDK
- [Admin UI SDK overview](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/) - Developer documentation on how to extend and customize the Commerce Admin to include custom menus and pages.
- [Installation](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/installation/) - Developer documentation on how to set up the Admin UI SDK.
- [Extension points](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/extension-points/) - Developer documentation on how to use existing extension points in any Adobe Developer App Builder application that customizes the Adobe Commerce Admin.
- Extend native Commerce processes with webhooks
- [Overview](https://developer.adobe.com/commerce/extensibility/webhooks/) - An architectural overview of webhooks.
- [Setup and installation](https://developer.adobe.com/commerce/extensibility/webhooks/installation/) - Information on how to install Commerce modules necessary for implementing webhooks.
- [Configuration](https://developer.adobe.com/commerce/extensibility/webhooks/hooks/) - Developer documentation on how to configure hooks for Adobe Commerce.
- [Common use cases](https://developer.adobe.com/commerce/extensibility/webhooks/use-cases/) - Descriptions of common Adobe Commerce use cases for webhooks.
- [Webhooks](https://developer.adobe.com/commerce/extensibility/webhooks/admin-configuration/) - Learn how to extend, override, and create hooks using the Adobe Commerce Admin.

## Troubleshooting

- [Logging and troubleshooting in App Builder](https://developer.adobe.com/commerce/extensibility/amazon-sales-channel/best-practices/logging-troubleshooting/)
- [Adobe I/O Events frequently asked questions](https://developer.adobe.com/events/docs/support/faq/)
- [App Builder security overview](https://developer.adobe.com/app-builder/docs/guides/security/)
8 changes: 6 additions & 2 deletions src/pages/events/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ If you are implementing eventing in a performance testing environment, run the `

### Options

`--fields=<field_name>` Required. An event field to transmit to the Adobe App Builder application. You can specify this option multiple times. Each instance can contain only one field name.
`--fields='{"<name>":"<field-name>", "converter":"<path\to\converterclass>"}'` Required, but the `converter` argument is optional. Specifies an event field to transmit to the Adobe App Builder application. You can specify this option multiple times. Each instance can contain only one field name. The `converter` argument applies the [converter class](convert-field-values.md) to the specified field.

`--force`, `-f` Forces subscription to the event, even if it hasn't been defined locally.

Expand All @@ -203,6 +203,10 @@ If you are implementing eventing in a performance testing environment, run the `

`--rules=<field-name>|<operator>|<value>` Defines a rule that will be applied to the subscribed event. You can apply multiple rules to an event, but each rule must be defined separately. A rule definition must specify the field to be evaluated, an operator, and the value to be evaluated, in that order. The field name in a rule definition does not have to match a field specified with the `--fields` option.

`--fields='{"<name>":"<field-name>", "converter":"<path\to\converterclass>"}'` Applies the converter class to the given field.

`--destination`, `-d` A custom destination for the event. This argument is used for SaaS integrations.

### Example

To subscribe to a native event:
Expand Down Expand Up @@ -379,7 +383,7 @@ If the depth value of `2` was specified, the response would also include details

## Generate a Commerce module based on a list of subscribed events

The `events:generate:module` command generates a module with plugins based on your configuration and places it into the Commerce `app/code/Magento/AdobeCommerceEvents` directory.
The `events:generate:module` command generates a module with plugins based on your configuration and places it into the Commerce `app/code/Magento/AdobeCommerceEvents` directory. This command is applicable for on-premises deployments only.

### Usage

Expand Down
4 changes: 4 additions & 0 deletions src/pages/events/configure-commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ stage:
consumers: []
```

<InlineAlert variant="warning" slots="text" />

The deployment process might become stuck if the consumer runs in the background. The [Troubleshooting](./troubleshooting.md#stuck-deployment-after-configuring-priority-events) topic describes how to resolve this condition.

See [Global variables](https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/configure/env/stage/variables-global.html) for more information about the `ENABLE_EVENTING` variable.

Cloud infrastructure and on-premises instances require different cron management procedures as described here:
Expand Down
Loading
Loading