How to Install the Web Service APIs
Who is this article for?IT Personnel performing an installation of Ideagen Quality Management 7.
On-Premise Customers only.
Important: This article is part of a series of articles covering the Ideagen Quality Management installation process. Please visit How to Install Ideagen Quality Management to view the entire process.
The Ideagen Quality Management Web Service APIs is an add-on component for Ideagen Quality Management Ideagen Quality Management that allows you to take advantage of the Ideagen Quality Management apps for Android and IOS, giving you the option to view Documents, perform audits or report Occurrences on the move.
As well as allowing you to connect your Ideagen Quality Management app, the Web Services feature gives developers the option to build their own customer API to communicate with Ideagen Quality Management.
Please note that when installed, the Web Services feature will be installed as “QPulse5WebServices”. The reason this has not changed to match the version of Ideagen Quality Management is because a change to the naming convention of these folders would break any existing APIs that were built on older versions of Ideagen Quality Management.
This article outlines how to:
1. Install Web Services
- Browse to the Web Services folder found in the installation media and run setup.exe
- When prompted, specify the Ideagen Quality Management Application server. If the Ideagen Quality Management Application server is
running on the local machine then specify ‘localhost’; otherwise enter the server IP address of
the server running the Ideagen Quality Management Application server service.
- On the next page you will be asked to enter the username and password of a valid Ideagen Quality Management
User. For this section we recommend that you create an API User account with system wide
permissions. This is needed for the Web Service feature to log into your Ideagen Quality Management databases.
If you have more than one Ideagen Quality Management database, you will have to make sure that the API User
password is replicated across each database.
- On the next page you can specify the folder in which Web Services will install to. By default this
would be: C:\inetpub\wwwroot\QPulse5WebServices - On the next page click ‘Install’ to run the Web Services installer and then click finish when
completed - When the installer has completed successfully, browse to the folder where you installed Web
Services. Locate the ‘Web.config’ file and open it in Notepad. - Within the Web.config file, locate the ‘Occurrence Behavior’ binding configuration.
- Update the first endpoint address to include ‘SOAP’ within the first set of quotation marks and
then remove ‘json’ from the last. - Save the Web.config file and close.
2. Test Web Services
| Test Address | Correct Response |
|---|---|
| http://<serverIP>/QPulse5WebServices | Core Service: You have created a service |
| http://<serverIP>/QPulse5WebServices/services/core.svc | An XML list of databases available |
| http://<serverIP>/QPulse5WebServices/services/core.svc/ json/availableconnections |
A list of databases available |
| http://<serverIP/QPulse5WebServices/services/core.svc?wsdl | An XML document |
Next Steps
Your installation is now complete and you can review the Post Installation Configuration Options.