Skip to content

Commit

Permalink
Merge pull request #244 from MayurBagwe/CEXT-3336-Docs-draft
Browse files Browse the repository at this point in the history
CEXT-3336 create event provider draft docs
  • Loading branch information
keharper authored Jul 31, 2024
2 parents 708985e + ed88b2c commit 9f2b02f
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 6 deletions.
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.
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 removed src/pages/_images/events/general-configuration.png
Binary file not shown.
6 changes: 4 additions & 2 deletions src/pages/events/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,17 @@ If you decide to omit the arguments, the `event-types.json` file must have the f
}
```

As an alternative to above steps, you can click the [Create Event Provider](./configure-commerce.md#commerce-admin) button on the **General configuration** section of the Adobe I/O Events page in the Admin.

### Usage

`bin/magento events:create-event-provider --label "<unique_provider_label>" --description "<provider description>"`

### Arguments

`--label` A name that distinguishes your event provider from others in the project. The name can contain English alphanumeric characters and underscores (_) only. The first character must be a letter.
`--label` A name that distinguishes your event provider from others in the project. The name can contain English alphanumeric characters, spaces, underscores (_), and hyphens (-) only. The first character must be a letter.

`--description` A string that describes your event provider.
`--description` A string that describes your event provider. The string can contain English alphanumeric characters, spaces, underscores (_), and hyphens (-) only.

### Example

Expand Down
24 changes: 20 additions & 4 deletions src/pages/events/configure-commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You must configure Commerce to communicate with your project. Configuration incl

1. In the Commerce Admin, navigate to **Stores** > Settings > **Configuration** > **Adobe Services** > **Adobe I/O Events** > **General configuration**. The following screen displays.

![General configuration](../_images/events/general-configuration.png)
![General configuration](../_images/events/general-configuration-empty.png)

1. Select the server-to-server authorization method you implemented from the **Adobe I/O Authorization Type** menu. Adobe recommends using OAuth. JWT has been deprecated.

Expand Down Expand Up @@ -52,6 +52,10 @@ You can also use the `aio` CLI tool to manage providers. See [Provider Commands]
You cannot create an event provider until you have configured and saved instance ID values and a workspace file. If you are using JWT for server-to-server authentication, you must have previously specified the private key.
You can create an event provider using either the [Command line](./configure-commerce.md#command-line) or [Commerce Admin](./configure-commerce.md#commerce-admin).
### Command line
1. Run the following command to create an event provider:
```bash
Expand All @@ -66,18 +70,30 @@ You cannot create an event provider until you have configured and saved instance
The `label` field displays as the name of the created Event Provider in the App Builder UI. The `description` field provides more context about the Event Provider.
**Note**: The label can contain English alphanumeric characters and underscores (_) only. The first character must be a letter.
**Note**: The label can contain English alphanumeric characters, spaces, underscores (_), and hyphens (-) only. The first character must be a letter.
The command displays a message similar to the following:
```terminal
No event provider found, a new event provider will be created
A new event provider has been created with ID 63a1f8fe-e911-45a4-9d3f-f512d2ef4626
A new event provider has been created with ID ad667bc6-1678-49ff-99fc-215d71ebf82f
```
1. Copy the ID returned in the command output into the **Adobe I/O Event Provider ID** field in the Admin.
![General configuration updated](../_images/events/general-configuration-updated.png)
![General configuration updated](../_images/events/general-configuration-providerId-cli.png)
### Commerce Admin
1. In the Commerce Admin, navigate to **Stores** > Settings > **Configuration** > **Adobe Services** > **Adobe I/O Events** > **General configuration**. The following screen displays.
![General configuration](../_images/events/general-configuration-instanceId.png)
2. Click on the **Create Event Provider** button, enter the **Label** and **Description**, and then click submit. The **Adobe I/O Event Provider ID** field will be populated with the newly generated event provider ID
![General configuration](../_images/events/general-configuration-providerInfo.png)
![General configuration](../_images/events/general-configuration-providerId-adminui.png)
## Complete the Commerce configuration
Expand Down

0 comments on commit 9f2b02f

Please sign in to comment.