Sap aem int day 3 - further clarifications (#307)

* Initial version of SAP AEM Integration - day 3 * Populating content for 3rd day Populating content for 3rd day, prereqs mostly done, AEM configuration done, importing iflows done, configuring and deploying iflows in progress * Populating codelab for day 3 - configuration steps Added more steps for setting up Integration Suite with security credentials etc. * Adjusted time estimates Adjusted time estimates * Added Overall Duration estimate Added Overall Duration estimate * Finished AEMBusinessPartnerAddressCheck Finished description and configuration and deployment steps for AEMBusinessPartnerAddressCheck iflow. * fixed typos and formatting fixed typos and formatting * Added configuration and deployment for 2 more flows Added configuration and deployment for 2 more flows * Added more details on the LegacyOutputAdapter Added more details on the LegacyOutputAdapter * Finished basic description of event flows Finished basic description of event flows * Finished describing AEM related settings and processing steps Finished describing AEM related settings and processing steps * Added takeaways Added takeaways * Fixed formatting Fixed formatting * Updated day-3 codelab * Formatting updates Formatting updates * updated codelabs * Formatting Formatting * Updated markdown and codelab to fix formatting * More formatting More formatting * Updated codelab * Formatting and new AEM adapter version Formatting and new AEM adapter version * Updated with latest codelab changes * Fixed queue subs and more formatting Fixed queue subs and more formatting * Updated codelabs * Repush updated queue subs for Legacy adapter Repush updated queue subs for Legacy adapter * Formatting Formatting * updated files * Updated section 3 Updated section 3 * Removed Unneeded artifacts Removed unneeded artifacts * More detailed steps More detailed steps, more screenshots. * More improvements and details Added more details on security configuration, reordered iflow steps to prioritise the AEMLegacyOutputAdatper iflow demonstrating the DMQ handling, followed by the AddressChecker, then Email notification iflow last. * Hide Todos Hidden Todos and wip areas. * Updated links Updated links for downloadable content. * Removed downloadables Removed downloadables from codelab (moved to separete repository) * Updated codelabs for SAP AEM INT - Day 3 * Marked BP address checker optional Marked BP address checker optional as it requires set up of SAP BTP's DQM service. * Updated codelabs for SAP AEM INT - Day 3 * Updated codelabs for SAP AEM INT - Day 3 * Updated codelabs SAP AEM INT-Day-3 to remove old redundant artifacts * Restructured code lab Restructured code lab to complete configuration and deployment of one iflow at a time. * Restructured codelab Restructured to separate into 3 separate iflow deployment scenarios, that can be completed one after the other end to end. * Formatting formatting * further formatting formatting * formatting titles * formatting * Added section for CI/CD * Note for CI/CD users Added note to skip over queue configuration for those that used the CI/CD tool in a previous step. * test test * Updates to intro sections and scenario 1 Updates to intro sections and scenario 1 * Prepared scenario 2 for changes Prepared scenario 2 to slot in changes developed by Scott. * Updates to scenario 2 Updates to scenario 2 * Added troubleshooting guide Added troubleshooting guide * fixed link to CI tool fixed link to CI tool * Updating time estimates Updating time estimates * Added security module Added security module * formatting formatting * formatting formatting * more formatting more formatting * format, format format, format * more formatting testing more formatting testing * Updating wording/rephrasing Updating wording/rephrasing * Rephrased prereqs Rephrased prereqs * Added clarifications Added clarifications after RPP in Feb 2024 * Additional instructions for importing the AEM adapter Additional instructions for importing the AEM adapter from SAP. --------- Co-authored-by: HariRangarajan-Solace <[email protected]> Co-authored-by: Hari-Rangarajan-Solace <[email protected]>
SolaceDev · Feb 29, 2024 · f331e99 · f331e99
1 parent 31431d7
commit f331e99
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 6 deletions.
diff --git a/markdown/sap-aem-int-day-3/img/CICopyFlow.png b/markdown/sap-aem-int-day-3/img/CICopyFlow.png
diff --git a/markdown/sap-aem-int-day-3/img/CICopyFlowConnectorTool.png b/markdown/sap-aem-int-day-3/img/CICopyFlowConnectorTool.png
diff --git a/markdown/sap-aem-int-day-3/img/CICopyflowDeleteAdapter.png b/markdown/sap-aem-int-day-3/img/CICopyflowDeleteAdapter.png
diff --git a/markdown/sap-aem-int-day-3/img/CICopyflowEdit.png b/markdown/sap-aem-int-day-3/img/CICopyflowEdit.png
diff --git a/markdown/sap-aem-int-day-3/sap-aem-int-day-3.md b/markdown/sap-aem-int-day-3/sap-aem-int-day-3.md
@@ -41,10 +41,30 @@ Duration: 0:20:00
 ### A) Download and import the template integration flows package
 
 Download [AEM-Rapid-Pilot-day3.zip](https://github.com/SolaceLabs/aem-sap-integration/blob/main/deployable/IS-artifacts/AEM-Rapid-Pilot-day3.zip)
-- Import AEM-Rapid-Pilot.zip as a new package into your Integration Suite tenant:
+- Import AEM-Rapid-Pilot-day3.zip as a new package into your Integration Suite tenant:
 	![CI Package import](img/CIPackageImport.png)
 
-### B) Download and import the AEM adapter for Integration Suite
+### B) Importing the official SAP AdvancedEventMesh Adapter into your CI tenant
+>aside negative A new Advanced Event Mesh specific adapter was made available in January 2024. If you haven't used this adatper in your CI tenant before, you may need to import it once. Follow these steps to get the official adapter from SAP. <br>
+
+- Navigate to your newly imported package: AEM-Rapid-Pilot-day3.
+- Take a copy of the AEMLegacyOutputAdapter flow.
+![CI Copy flow](img/CICopyFlow.png)
+- Choose a new name. (Accepting the default of `AEMLegacyOutputAdapter_copy` will do.)
+- Then open and edit your copy named  `AEMLegacyOutputAdapter_copy` or similar.
+![CI Edit flow](img/CICopyflowEdit.png)
+- Select the line named AdvancedEventMesh and delete it by clicking on the rubbish bin icon that appears.
+![CI delete adapter](img/CICopyflowDeleteAdapter.png)
+- After deletion, select the connector tool from the top and reconnect the Sender box to the Start icon.
+![CI connector tool](img/CICopyFlowConnectorTool.png)
+- You should see a pop up appear in which you can select the AdvancedEventMesh adapter. Selecting this should pull the SAP version of this adapter into your CI tenant.
+
+That's it, we should now be good to proceed.
+(You can cancel the changes in your copy `AEMLegacyOutputAdapter_copy` or similar and delete the copy of the flow now.)
+
+>aside negative Skip over C) if you have successfully completed this step.
+
+### C) Download and import the AEM adapter for Integration Suite
 
 >aside negative A new Advanced Event Mesh specific adapter was made available in January 2024. <br>
 **Only follow this step if you can't see the AdvancedEventMesh adapter in your Integration Suite tenant or if you want to use the preview version (provided) instead.** <br>
@@ -169,6 +189,11 @@ Note that the error handling and retry settings go hand-in-hand with the DMQ and
 > Note: The delayed redelivery settings on the queue are not currently used by the AEM adapter. We can only set these settings in the adapter itself, but the queue needs to have a DMQ configured, a max redelivery count set (as opposed to retrying forever) and the events/messages have had to be published as DMQ eligible by the publisher.
 
 #### 2. Configuring and deploying  the AEMLegacyOutputAdapter iflow:
+
+Remember the connectivity details for our AEM broker from the previous step?
+We will need those now.
+![AEM broker service connectivity details](img/AEMBrokerServiceConnectionDetails.png)
+
 - Hit configure at the top right and fill in the details to connect to your AEM broker service:
 ![AEM service configuration pt1](img/CIAEMLegacyOutputAdapterConfiguration.png)
 ![AEM service configuration pt2](img/CIAEMLegacyOutputAdapterConfiguration-pt2.png)
@@ -331,9 +356,14 @@ b) It sends a new event to `sap.com/salesorder/notified/V1/{salesOrg}/{distribut
 
 #### 2. Configuring and deploying  the AEMSONotificationV2 iflow:
 ![AEM output adapter](img/CIAEMSONotificationV2Configuration.png)
-- Populate the connection details for the AEM broker service to send an event to the AEM broker whenever the flow successfully sends a notification email.
+- Populate the connection details for the AEM broker service to send an event to the AEM broker provided by us whenever the flow successfully sends a notification email.
 - Hit configure at the top right and fill in the details to connect to your AEM broker service:
 
+>aside negative
+> **If you get confused about which parts of your iflow to connect to your broker and which ones to connect to our broker, remember this simple rule:<br>
+> The sender and receiver (left and right of your iflow) connect to your broker.
+> The connector down at the bottom connects to our, from your point of view external, broker.**
+
 ![AEM service configuration pt1](img/CIAEMSONotificationV2Configuration-pt1.png)
 ![AEM service configuration pt2](img/CIAEMSONotificationV2Configuration-pt2.png)
 - No need to configure the adapter connecting to our email service, we've prepopulated this one and we have already deployed the necessary security configuration in the step above.
@@ -487,7 +517,7 @@ Let's configure the security details we will need to connect to the various serv
 - In here, create security credentials for your AEM broker service **(if not already done)**.
 - Create SecureParameter `CABrokerUserPass` and store the password for your `solace-cloud-client` application user credentials.
 - Create OAuth2 Client Credentials and store your credentials from your DQM service key.
- - Token Service URL
+ - Token Service URL (should end in /oauth/token)
  - Client ID
  - Client Secret (either use your own or the one we will have handed out during the workshop.)
 ![DQM client credentials](img/DQM-Client-Credentials.png)
@@ -516,8 +546,8 @@ Lastly, the AEM Receiver adapter is configured to persistently (to avoid message
 
 
 #### 2. Configuring and deploying the AEMBusinessPartnerAddressCheck iflow:
-![DQM service configuration](img/CIDQMServiceConfiguration.png)
-- Populate the connection details for the DQM service call out with the ones for your own DQM service instance.
+![DQM service configuration](img/CIDQMServiceConfiguration.png)You
+- Populate the connection details for the DQM service call out with the ones for your own DQM service instance. (You don't need to change the address, if you are using our DQM service. If you are using your own DQM service, you'll need to take the API URL from your token and append `/dq/addressCleanse/batch` to the end of it. It should look something like `https://api.dqmmicro.cfapps.eu10.hana.ondemand.com/dq/addressCleanse/batch`).
 - Hit configure at the top right and fill in the details to connect to your AEM broker service:
 
 ![AEM service configuration pt1](img/CIAEMBPCheckerConfiguration.png)