Merge pull request #18281 from MatthiasdelaRoche/master

jmmargo · web-flow · commit 619ecb084400 · 2022-03-31T10:16:24.000-06:00
Automatic commit: Move 'fiori-ios-scpms-floorplan' from QA to Production
diff --git a/tutorials/fiori-ios-scpms-floorplan/fiori-ios-scpms-floorplan.md b/tutorials/fiori-ios-scpms-floorplan/fiori-ios-scpms-floorplan.md
@@ -2,8 +2,9 @@
 title: Create a List Report Floorplan
 description: Use the SAP BTP SDK for iOS to build a simple List Report Floorplan containing an FUISearchBar
 auto_validation: true
-primary_tag: products>ios-sdk-for-sap-btp
-tags: [  tutorial>intermediate, operating-system>ios, topic>mobile, topic>odata, products>sap-business-technology-platform, products>sap-mobile-services ]
+primary_tag: software-product>sap-btp-sdk-for-ios
+tags: [  tutorial>intermediate, operating-system>ios, topic>mobile, programming-tool>odata, software-product>sap-business-technology-platform, software-product>sap-mobile-services ]
+
 time: 60
 ---
 
@@ -84,6 +85,10 @@ with:
 
 ```
 
+
+
+
+
 Instead of instantiating the `MainSplitViewController` the `UIStoryboard` will instantiate the initial View Controller and cast it to the `UINavigationController`.
 
 Lastly, you have to create a new class inheriting from `UITableViewController`. Create a new **Cocoa Touch Class** and name it `SupplierTableViewController`.
@@ -104,11 +109,15 @@ Now that you have the first `UITableViewController` setup you will add code to l
 Open the `SupplierTableViewController.swift` class and add the following import statements for full usage of the SDK:
 
 ```Swift
+import UIKit
 import SAPOData
 import SAPFoundation
 import SAPFiori
 import SAPFioriFlows
 import SAPCommon
+import SAPOfflineOData
+import ESPMContainerFmwk
+import SharedFmwk
 
 ```
 
@@ -133,19 +142,22 @@ Implement the following lines of code directly below the loading indicator prope
 let destinations = FileConfigurationProvider("AppParameters").provideConfiguration().configuration["Destinations"] as! NSDictionary
 
 // Retrieve the data service using the destinations dictionary and return it.
-var dataService: ESPMContainer<OnlineODataProvider>? {
-    guard let odataController = OnboardingSessionManager.shared.onboardingSession?.odataControllers[destinations["com.sap.edm.sampleservice.v2"] as! String] as? Comsapedmsampleservicev2OnlineODataController, let dataService = odataController.espmContainer else {
-        AlertHelper.displayAlert(with: NSLocalizedString("OData service is not reachable, please onboard again.", comment: ""), error: nil, viewController: self)
+let destinations = FileConfigurationProvider("AppParameters").provideConfiguration().configuration["Destinations"] as! NSDictionary
+
+var dataService: ESPMContainer<OfflineODataProvider>? {
+    guard let odataController = OnboardingSessionManager.shared.onboardingSession?.odataControllers[ODataContainerType.eSPMContainer.description] as? ESPMContainerOfflineODataController, let dataService = odataController.dataService else {
+        AlertHelper.displayAlert(with: "OData service is not reachable, please onboard again.", error: nil, viewController: self)
         return nil
     }
     return dataService
 }
 
 ```
 
-> In case you're using an `ODataOfflineProvider` you have to change the above-mentioned code to use `ODataOfflineProvider` instead of `ODataOnlineProvider`. You have to also import `SAPOfflineOData` in addition to the `SAPOData` framework.
 
-Because we're good citizens we want to use an app logger to log important information. Fortunately, SAP is offering a simple-to-use Logging API with the `SAPCommon` framework.
+> In case you're using an `OfflineODataProvider` you have to change the above-mentioned code to use `OfflineODataProvider` instead of `OnlineODataProvider`. You have to also import `SAPOfflineOData` in addition to the `SAPOData` framework.
+
+SAP offers  a simple-to-use Logging API with the `SAPCommon` framework.
 
 Implement the following line of code below the data service declaration:
 
@@ -163,7 +175,7 @@ private var suppliers = [Supplier]()
 
 ```
 
-> From now on bigger code blocks are explained with inline comments. Read the inline comments carefully to fully understand what the code is doing and why we're implementing it.
+> From now on bigger code blocks are explained with inline comments. Read the inline comments carefully to fully understand what the code is doing and why you're implementing it.
 
 Loading all available suppliers is fairly easy using the generated data service. The generated code will handle all authentication and authorization challenges for you and the data service will construct all necessary requests to load, create and update entities in your backend.
 
@@ -224,7 +236,7 @@ First, implement two necessary `UITableViewDataSource` methods which are respons
 ```Swift
 // MARK: - Table view data source
 
-/// We are only displaying one section for this screen, return 1.
+/// Only one section is displayed for this screen, return 1.
 override func numberOfSections(in tableView: UITableView) -> Int {
     return 1
 }
@@ -237,17 +249,17 @@ override func tableView(_ tableView: UITableView, numberOfRowsInSection section:
 ```
 
 Using the `SAPFiori` framework allows you to choose from a large variety of `UITableViewCell` classes.
-Because we're going to display suppliers, and those have a name, an address and probably contact data the `FUIContactCell` would be a perfect fit here. You can always use the **SAP Fiori Mentor** app, available in the App Store for iPad, to get an introduction to the control.
+Because you're going to display suppliers, and those have a name, an address and probably contact data the `FUIContactCell` would be a perfect fit here. You can always use the **SAP Fiori Mentor** app, available in the App Store for iPad, to get an introduction to the control.
 
-Before implementing the `tableView(_cellForRowAt:)` method responsible for dequeuing reusable cells and returning them to the `UITableView`, we want to register the `FUIContactCell` with the `UITableView` first. This is usually done in the `viewDidLoad()` method.
+Before implementing the `tableView(_cellForRowAt:)` method responsible for dequeuing reusable cells and returning them to the `UITableView`, You need to register the `FUIContactCell` with the `UITableView` first. This is usually done in the `viewDidLoad()` method.
 
 Implement the following lines of code before the `updateTableView()` method call in the `viewDidLoad()`:
 
 ```Swift
 // Register the cell with the provided convenience reuse identifier.
 tableView.register(FUIContactCell.self, forCellReuseIdentifier: FUIContactCell.reuseIdentifier)
 
-// Set the seperator style of the table view to none and the background color to the standard Fiori background base color.
+// Set the separator style of the table view to none and the background colour to the standard Fiori background base colour.
 tableView.separatorStyle = .none
 tableView.backgroundColor = .preferredFioriColor(forStyle: .backgroundBase)
 
@@ -268,7 +280,7 @@ override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexP
   cell.headlineText = supplier.supplierName ?? "No Name available!"
   cell.subheadlineText = "\(supplier.street ?? "") \(supplier.houseNumber ?? "") \(supplier.city ?? ""), \(supplier.postalCode ?? "") \(supplier.country ?? "")"
 
-  // Because we're going to implement navigation later this cell has the disclosure indicator as accessory type indicating that navigation to the user.
+  //Navigation will be implemented later. This cell has the disclosure indicator as accessory type indicating that navigation to the user.
   cell.accessoryType = .disclosureIndicator
 
   return cell
@@ -303,7 +315,7 @@ Go back to the `tableView(_cellForRowAt:)` method and add the following lines of
 cell.activityControl.addActivities(activities)
 cell.activityControl.maxVisibleItems = 3
 
-// The FUIActivityControl provides you two different ways of reacting to user's interaction. One would be with a change handler the other would be with a delegate. Because I don't want the communication logic being in the tableView(_cellForRowAt:) method we're using the delegation way.
+// The FUIActivityControl provides you two different ways of reacting to user's interaction. One would be with a change handler the other would be with a delegate. Because I don't want the communication logic being in the tableView(_cellForRowAt:) method you're using the delegation way.
 cell.activityControl.delegate = self
 
 ```
@@ -354,8 +366,8 @@ Tapping on one of the `FUIActivityItem` will result in an alert dialogue showing
 
 [ACCORDION-BEGIN [Step 5: ](Implement the Navigation Between the Supplier List and the Product List)]
 
-In this step, we will implement a second `UITableViewController` displaying all products a supplier provides.
-For this, we will use a storyboard segue to navigate to the `SupplierProductsTableViewController` and pass through the selected supplier.
+In this step, you will implement a second `UITableViewController` displaying all products a supplier provides.
+For this, you will use a storyboard segue to navigate to the `SupplierProductsTableViewController` and pass through the selected supplier.
 
 > In case you're not familiar with segues please visit, and carefully read the official documentation before continuing. [Using Segues](https://developer.apple.com/library/archive/featuredarticles/ViewControllerPGforiPhoneOS/UsingSegues.html)
 
@@ -389,9 +401,9 @@ var supplier: Supplier!
 
 ```
 
-Next, we will implement the `prepare(:for:sender:)` method which is responsible for making necessary preparations before the navigation is fully executed. In our case, we will pass the selected supplier to the `SupplierProductsTableViewController`.
+Next, you will implement the `prepare(:for:sender:)` method which is responsible for making necessary preparations before the navigation is fully executed. In our case, you will pass the selected supplier to the `SupplierProductsTableViewController`.
 
-Implement the `prepare(:for:sender:)` method:
+Implement the `prepare(:for:sender:)` method in `SupplierTableViewController`:
 
 ```Swift
 // MARK: - Navigation
@@ -415,7 +427,7 @@ override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
 
 ```
 
-You can utilize the `tableView(_:didSelectRowAt:)` method to trigger the navigation. Implement the override method:
+You can utilise the `tableView(_:didSelectRowAt:)` method to trigger the navigation. Implement the override method:
 
 ```Swift
 override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
@@ -431,16 +443,20 @@ You can now navigate back and forth between the `SupplierTableViewController` an
 
 [ACCORDION-BEGIN [Step 6: ](Implement the loading and displaying of supplier-specific products)]
 
-This view is similar to the `SupplierTableViewController` but instead of fetching all products, we will fetch supplier-specific products. To achieve that, we again can utilize the OData APIs. `SAPOData` provides the possibility to create so-called `DataQuery` objects which can define typical OData arguments for a backend call.
+This view is similar to the `SupplierTableViewController` but instead of fetching all products, you will fetch supplier-specific products. To achieve that, you again can utilise the OData APIs. `SAPOData` provides the possibility to create so-called `DataQuery` objects which can define typical OData arguments for a backend call.
 
-First, we need to make the needed import statements for that class:
+First, you need to make the needed import statements for that class:
 
 ```Swift
 import SAPOData
 import SAPFoundation
 import SAPFiori
 import SAPFioriFlows
 import SAPCommon
+import ESPMContainerFmwk
+import SharedFmwk
+import SAPOfflineOData
+
 
 ```
 
@@ -457,10 +473,9 @@ Add a couple of class properties necessary for the data service instance and the
 // The available destinations from Mobile Services are hold in the FileConfigurationProvider. Retrieve it to find the correct data service
 let destinations = FileConfigurationProvider("AppParameters").provideConfiguration().configuration["Destinations"] as! NSDictionary
 
-// Retrieve the data service using the destinations dictionary and return it.
-var dataService: ESPMContainer<OnlineODataProvider>? {
-    guard let odataController = OnboardingSessionManager.shared.onboardingSession?.odataControllers[destinations["com.sap.edm.sampleservice.v2"] as! String] as? Comsapedmsampleservicev2OnlineODataController, let dataService = odataController.espmContainer else {
-        AlertHelper.displayAlert(with: NSLocalizedString("OData service is not reachable, please onboard again.", comment: ""), error: nil, viewController: self)
+var dataService: ESPMContainer<OfflineODataProvider>? {
+    guard let odataController = OnboardingSessionManager.shared.onboardingSession?.odataControllers[ODataContainerType.eSPMContainer.description] as? ESPMContainerOfflineODataController, let dataService = odataController.dataService else {
+        AlertHelper.displayAlert(with: "OData service is not reachable, please onboard again.", error: nil, viewController: self)
         return nil
     }
     return dataService
@@ -470,7 +485,7 @@ private var products = [Product]()
 
 ```
 
-Also, we want to utilize the provided loading indicator. Let the class conform to the `SAPFioriLoadingIndicator` protocol.
+Also, you want to utilise the provided loading indicator. Let the class conform to the `SAPFioriLoadingIndicator` protocol.
 
 ```Swift
 class SupplierProductsTableViewController: UITableViewController, SAPFioriLoadingIndicator { ... }
@@ -486,7 +501,7 @@ var loadingIndicator: FUILoadingIndicatorView?
 
 Let's load some data!
 
-We're using the same style we've used in the `SupplierTableViewController`. Implement the following two methods and read the inline comments carefully because you will see that we utilize the `DataQuery` object for making a filter as well as an expand.
+You're using the same style you've used in the `SupplierTableViewController`. Implement the following two methods and read the inline comments carefully because you will see that you utilise the `DataQuery` object for making a filter as well as an expand.
 
 > If you're not familiar with those OData specific terms please make yourself familiar with the OData specification:
 
@@ -539,7 +554,7 @@ override func viewDidLoad() {
 
 ```
 
-We know that the products contain images for each product, it would be nice to display them as well, but to do so we have to write a little bit of code to make that happen.
+Products contain images for each product, it would be nice to display them as well, but to do so you have to write a little bit of code to make that happen.
 
 First, implement a class property holding the image URLs of all products.
 
@@ -548,7 +563,7 @@ private var productImageURLs = [String]()
 
 ```
 
-The user might want to scroll through the products even if the images are not fully loaded yet we have to implement a simple image cache as well as a placeholder image to keep the performance of the table stable.
+The user might want to scroll through the products even if the images are not fully loaded yet you have to implement a simple image cache as well as a placeholder image to keep the performance of the table stable.
 
 Add the following line of code directly below the `productImageURLs`:
 
@@ -591,7 +606,7 @@ private func loadProductImageFrom(_ url: URL, completionHandler: @escaping (_ im
 
 ```
 
-Now we have the foundation for fetching and caching images. You were probably wondering where the mapping from the fetched products to the product image URLs happens. We will implement that now.
+Now you have the foundation for fetching and caching images. You were probably wondering where the mapping from the fetched products to the product image URLs happens. You  will implement that now.
 
 Go back to the `loadData(:)` method and add the following line of code directly below the product assignment. Your `loadData(:)` should look like this now:
 
@@ -619,7 +634,7 @@ private func loadData(completionHandler: @escaping () -> Void) {
 
 ```
 
-Like the last time we have to register a `SAPFiori` cell with the `UITableView`, but this time it is a `FUIObjectTableViewCell`. Add the following lines of code to the `viewDidLoad()` method right before the `updateTableView(:)` method call.
+Like the last time you have to register a `SAPFiori` cell with the `UITableView`, but this time it is a `FUIObjectTableViewCell`. Add the following lines of code to the `viewDidLoad()` method right before the `updateTableView(:)` method call.
 
 ```Swift
 tableView.register(FUIObjectTableViewCell.self, forCellReuseIdentifier: FUIObjectTableViewCell.reuseIdentifier)
@@ -628,9 +643,9 @@ tableView.backgroundColor = .preferredFioriColor(forStyle: .backgroundBase)
 
 ```
 
-As the last step, we have to implement the table views data source methods similar to the `SupplierTableViewController`.
+As the last step, you have to implement the table views data source methods similar to the `SupplierTableViewController`.
 
-Add the following methods directly below the `loadProductImageFrom(_:completionHandler:)` method:
+Add the following methods directly below the `loadProductImageFrom(_:completionHandler:)` method and make sure to modify the value of `baseURL`
 
 ```Swift
 // MARK: - Table view data source
@@ -729,7 +744,7 @@ private func setupSearchBar() {
 
 Xcode will complain now because the `SupplierProductsTableViewController.swift` class is not conforming to the [`UISearchResultsUpdating`](https://developer.apple.com/documentation/uikit/uisearchresultsupdating) protocol.
 
-Add an extension to your class, like we did in the `SupplierTableViewController`:
+Add an extension to your class, like you did in the `SupplierTableViewController`:
 
 ```Swift
 extension SupplierProductsTableViewController: UISearchResultsUpdating {
@@ -740,11 +755,24 @@ extension SupplierProductsTableViewController: UISearchResultsUpdating {
 
 ```
 
+
+Call the `setupSearchBar()` method inside the `viewDidLoad()`:
+
+```Swift
+override func viewDidLoad() {
+    super.viewDidLoad()
+    setupSearchBar()
+    updateTableView()
+
+}
+
+```
+
 If you run the app now you should see the `FUISearchBar` being displayed above the `UITableView`.
 
 ![Supplier Product List](fiori-ios-scpms-floorplan-14.png)
 
-Now we have to implement some search logic to be called in the `updateSearchResults(for:)` method.
+Now you have to implement some search logic to be called in the `updateSearchResults(for:)` method.
 
 Implement the following methods right below the `setupSearchBar()` method and carefully read the inline comments.
 
@@ -775,7 +803,7 @@ Cool! Let's implement the `updateSearchResults(for:)` method:
 ```Swift
 extension SupplierProductsTableViewController: UISearchResultsUpdating {
     func updateSearchResults(for searchController: UISearchController) {
-        // Get the searched-for term, note here that we don't have a time bouncer which waits for the user to finish its input. You could implement that if needed, for this simple example we do life searches for each character. I wouldn't recommend doing that over a large data set.
+        // Get the searched-for term, note here that you don't have a time bouncer which waits for the user to finish its input. You could implement that if needed, for this simple example you do life searches for each character. I wouldn't recommend doing that over a large data set.
         if let searchText = searchController.searchBar.text {
             // Feed it to the search logic.
             searchProducts(searchText)
