Differences

This shows you the differences between two versions of the page.

--- cobi.wms:postman [2021/07/09 06:45] – created tkammer
+++ cobi.wms:postman [2022/02/24 11:26] (current) – tkammer
@@ Line 7: / Line 7: @@
 Once you've installed and started the program for the first time, you can **skip the account creation process** by clicking the small button at the bottom of the login screen of Postman.
-Afterwards you can import this Service Layer **Collection** file into Postman: {{COBI.wms:servicelayer.postman_collection.json}}
+===== Importing the Service Layer Collection =====
-(To open the Import screen of Postman, go to File -> Import or press Ctrl + O.)
+Afterwards you can import this Service Layer **Collection** file into Postman:
-For the Service Layer collection to work, you have to create an **Environment** in Postman. You can open the Environments tab from the left side of the Postman window to create a new one.
+{{COBI.wms:servicelayer.postman_collection.json}}
+To open the Import screen of Postman, go to File -> Import or press Ctrl + O.
+===== Creating an Environment for Service Layer =====
+For the Service Layer Collection to work, you have to create an **Environment** in Postman. You can open the Environments tab from the left side of the Postman window to create a new one.
 You can name the environment however you like, for example "Service Layer." You must then add the following variables:
 ^ Name     ^ Value                                                                          ^
-| SLROOT   | The Service Layer base-URL, such as: **http://sbo-server:50001/b1s/v1**         |
+| SLROOT   | The Service Layer base-URL, such as: **http://sbo-server:50001/b1s/v1**        |
 | COMPANY  | The name of the SAP Business One company database to which you want to connect |
 | USERNAME | The username of a valid SAP Business One user                                  |
 | PASSWORD | The password of the SAP Business One user                                      |
+**Note:** If any value contains a back-slash " **\** " symbol in it, you have to duplicate each back-slash to be two back-slashes.  For example if the username is **"MyDomain\testuser"** then you must write **"MyDomain\\testuser"** instead.  (This does not apply to forward-slash " **/** " symbols, only back-slashes.  And it is **not** needed in the COBI.wms Android App, only in Postman.)
 After saving the environment, you have to **activate it by selecting it from the drop-down towards the top-right corner** of the Postman window, where it normally says **No Environment**.
-You can then open the Service Layer collection by opening the **Collections** tab from the left side of the Postman window, and choosing Service Layer.
+===== Logging in to Service Layer =====
-If you've done everything correctly, you should be able to select the **POST Login** request in the Service Layer collection and click on the blue **Send** button to test the login process.
+You can now open the Service Layer Collection by opening the **Collections** tab from the left side of the Postman window, and choosing **Service Layer**.
+If you've done everything correctly, you should be able to select the **Login** request in the Service Layer collection and click on the blue **Send** button to test the login process.
 A successful login to Service Layer will yield an output such as the following:
@@ Line 36: / Line 46: @@
   }
-Afterwards you can try some of the other requests. For example, the **POST Attachment Upload** request can be used to see if uploading file attachments is working fine. A successful attachment upload will result in a response such as the following:
+===== Testing attachment upload =====
+Sometimes uploading attachments with Service Layer doesn't work even though attachments work fine in the SAP Business One client.  If you get an error while sending attachments from COBI.wms, it's a good idea to check whether the problem is with Service Layer itself.
+To test attachment uploads, just select the **Attachment Upload** query from the Service Layer Collection and send it without making any changes.
+A successful attachment upload will result in a response such as the following:
   {
@@ Line 53: / Line 69: @@
     ]
   }
+If you receive an error instead, it means attachment uploading doesn't work with Service Layer, so the problem isn't related to COBI.wms.  At this point please consult your SAP Partner or open an SAP ticket.