Skip to main content

Legacy | Query as a Web Service User Guide

Important: Query as a Web Service has been sunsetted as ETO upgraded to BO 4.3. Previously made queries in QaaWs will still run, but new queries and edits will not be supported.

Please see the below documentation on BO Rest API which has replaced QaaWs. Contact your Account Manager if you have any questions or concerns.

BO Rest API


​Downloading the Query as a web Service Designer installation files

  1. Go to http://s3browser.com/

  2. Click “Download S3 Browser”

  3. Click the file to open it

  4. Click Next

  5. Select "I accept the agreement"

  6. Click Next

  7. Select a folder to save the Browser or choose the default option

  8. Click Next

  9. Click Next

  10. Click Finish

  11. Start the S3 Browser application

  12. Click Accounts > Add New Account

  13. Account Name: BO_Client_Tools

  14. Account Type: Amazon S3 Storage

  15. Access Key ID: AKIAI2U7HMBHBQWBCXSQ

  16. Secret Access Key: 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

  17. Click Add new account

  18. Click Buckets > Add External Bucket (Ctrl+E)

  19. Enter “ssg-business-objects-client-tools” (without quotation marks)

  20. Click Add External Bucket

  21. Open the bucket in the explorer on the left side of the window

  22. Right-click on the zipped folder: BI42_SP4_Client_Tools.zip

  23. Click Download

  24. Save to your Documents folder

Installing the Query as a Web Service Designer tool

  1. Once downloaded, open the zipped folder and extract the files to your Documents folder

  2. Open the folder called “SBOP_BI_PLAT_4.2_SP4_CLNT_WIN_”

  3. Open the DATA_UNITS folder

  4. Open the BusinessObjectsClient folder

  5. Double-click the setup application and work through the setup steps

Logging into the QaaWS Designer application

  1. Login to ETO software

  2. Click on your name in the upper right-hand corner of ETO and click Live Office Account Info. Note your User Name, Password, and Server information to be used in the following steps.

  3. Open the Query as a Web Service Designer application

  4. Click Host and Add

  5. In the Name field: Your discretion, recommend using your database name (e.g. etoclient123) or user name

  6. In the URL field: delete the text that is autogenerated after tabbing out of the name field. Open the Query as a Web Service (QaaWS) End Point URLs help article and locate the URL in the section titled “The End Point URLs for each Cluster” that matches the server in your live office account information. Paste this URL into the URL field.Punctuation and capital letters are important for our purposes.

  7. In the CMS field: Copy and paste from “Server” in Live Office Account Info

  8. In the User field: Copy and paste from User Name in Live Office Account Info and ensure no trailing spaces

  9. If you receive a yellow warning indicator next to URL, click back into that field and wait for the warning to clear. If it does not, ensure that all the login information is correct, including the case of the letters in the URL.

  10. Authentication will turn to “Enterprise”

  11. Click OK

  12. Close

  13. Select the host record you just created in the drop-down

  14. Ensure the proper system and username were populated

  15. Copy and paste your password from the Live Office Account Info in ETO (ensure no trailing spaces)

  16. Click OK to login

Using the QaaWS Designer application

  1. Select Query > New > Query

  2. WebServiceName = title of your query

  3. Next

  4. Select the required Standard or Custom Report Universe from the list (includes all universes you have access to in ETO Results)

  5. Next

  6. Drag the necessary output objects into the Results Objects box like you would in ETO Results

  7. Drag any required filter objects into the Filter Objects box

  8. Next

  9. Review the sample (first 50 rows) output for accuracy

  10. Publish

  11. Note the query’s unique URL

Using the WSDL Generator

  1. Open the WSDL generator link for your ETO environment (found in the Query as a Web Service (QaaWS) End Point URLs article)

  2. Login to ETO software

  3. Click on your name in the upper right-hand corner of ETO and click Live Office Account Info

  4. Copy your User Name, Password, and Server > CMS into the fields in the WSDL generator login page. Ensure you copy no trailing spaces into those fields.

  5. Hit Go to login

  6. This page will contain wsdl links to the XML that can be utilized to access the queries externally.

The output of the WSDL generator will be XML that can be executed by code external to ETO to generate the output of your queries and used with other systems. This tool has been used to produce ETO data sets that are then sent to data warehouses and external funder databases. Bonterra can help you troubleshoot issues with your queries and any XML parser issues from the XML that is generated, but will be unable to support the code that you insert the XML into.

For additional questions regarding Query as a Web Service, please contact customer support at eto@bonterratech.com.

Related articles

Comments

0 comments

Please sign in to leave a comment.