-
Notifications
You must be signed in to change notification settings - Fork 41
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
docs: 📝 adds docs for optimize setup view #501
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Optimize Setup Validation view | ||
|
||
## Overview | ||
|
||
You can use the Optimize Setup Validation view to check if your application has been set up successfully to use Adobe Experience Platform Optimize. The view validates all pre-requisites have been met, and offers feedback on how to fix your setup in cases where requirements have been missed. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No need for the comma between "... have been met..." and "... and offers feedback..." |
||
|
||
## Getting Started | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Minor nit - we generally sentence case for our headers, so this should just be "Getting started". This goes for the subsequent headers as well. |
||
|
||
To use this view, follow the steps outlined below: | ||
|
||
1. [Set up Adobe Experience Platform Assurance](../set-up.md) | ||
2. [Create](./index.md#creating-sessions) and [connect](./index.md#connecting-to-a-session) to an Assurance session | ||
3. In the **Home** view, select **Validate Setup** | ||
|
||
![Validate Setup](./assets/optimize-configuration/optimize-setup-view.png) | ||
|
||
## Datastream Setup Validation | ||
|
||
At the top of the Optimize Setup Validation view, Platform Assurance inspects your current application's datastream to see if Target or Offer Decisioning has been enabled. In order to use optimize, at least one of extensions needs to be enabled inside your datastream. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe the secondary usage of Assurance is just Assurance by itself, we can just say "... view, Assurance inspects your..." |
||
|
||
![Validate Datastream Section](./assets/optimize-configuration/datastream-validation.png) | ||
|
||
To enable Target in your datastream, go to the datastream view for application app inside the Data Collection UI, and ensure that Adobe Target has been added and enabled. | ||
|
||
![Enable Target Datastream](./assets/optimize-configuration/enable-target-datastream.png) | ||
|
||
To enable Offer Decisioning in your datastream, go to datastream view for your application in the Data Collection UI, and select Edit in the actions menu for Adobe Experience Platform. The toggle shows if Offer Decisioning is enabled. | ||
|
||
![Enable Offer Decisioning Datastream](./assets/optimize-configuration/enable-offer-decisioning-datastream.png) | ||
|
||
## SDK Setup Validation | ||
|
||
Below the datastream validation section, the SDK Setup Validation section offers feedback on two major issues you could face in your application. Firstly, it offers validation that all SDKs have been installed that are required by Optimize to work correctly. Secondly, it validates that the request and response events are flowing from your application in the way the platform expects them to. Errors may arise if your schemas have been improperly implemented, or your application is sending requests that do not receive an appropriate response. This section will provide feedback and identify the events in error, so you can diagnose what went wrong. | ||
|
||
![Enable Offer Decisioning Datastream](./assets/optimize-configuration/sdk-setup-validation.png) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we missing the feedback part? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll need to add metadata on top. You can refer to other pages on the repo to learn how to add metadata! (Or just ping me. I can walk you through it as well.)