This article provides detailed information about the Web Services in PPO:
- Accessing the web services
- Call a web service
- Adding a web service
- Editing a web service
- Deleting a web service
PPO allows users to set up Business Rules from the front-end of the solution. These rules include actions such as preventing an update if certain criteria aren't met (Validation Rules) and the sending of e-mails based on trigger events in PPO (Send E-mail). Users also have the ability to view all the web services that have been set up on their instance.
To access the business rules, click on the Administration >> Business Rules and then filter on the “Call Web Service” type from the drop-down list.
PPO has a collection of standard web services that form part of any PPO instance. These web services can be called to retrieve information for use in a third-party applications or can be used to update PPO entries based on information from a third party application.
These web services are available at no cost to all clients, subject to reasonable use restrictions. All web services are secure and require the caller to first authenticate him or herself before being able to perform any retrieval or update of information.
For a full list of the available web services, access the following URL:
Web service based integration is best suited to synchronous (i.e. real time) integration where the client has sufficient skills to implement the business logic around the integration.
For more information on using web services through the API, read the following knowledge base article.
Once you have clicked on a specific web service, the following information is provided as per below:
- Description:This provides an applicable description for the web service, so it’s easy for you to identify the web service that has been setup.
- The entity this rule relates to:This displays the applicable entity the web service relates to.
- The events that should trigger the rule:This indicates whether the rule should be triggered on add, update, add and update, or on delete.
- Is the rule active?:This indicates whether the rule is active or not.
- Action: Indicates this is a "Call Web Service" type business rule.
- Sort Order: This is applicable when setting up validation rules.
- XSL transformation of event XML:This box contains the logic code that calls the required web service.
- E-mail address to receive error notifications:This is the e-mail address that will receive all error notifications, should the web service fail.
- Conditions: This section shows the conditions under which the web service will be called. If the conditions section is empty, the web service will be called for all updates of the applicable entity.
- Exceptions:This part of the rule shows the exceptions to the rule, i.e. events for which the rule will not be triggered.
- Summary:A summary at the end of the page will explain the business rule that has been specified.
To add a new web service, click on the Administration menu item, select Business Rules and click on the “Add Business Rule” icon.
Complete all the fields as described above and then submit your web service. If you need any assistance, simply log a support call and the PPO Support Team will gladly help you.
To edit any existing web service, click on the Administration menu item, select Business Rules and select the applicable business rule you wish to change. If you need any assistance in updating any of the web services, simply log a support call and the PPO Support Team will gladly help you.
Should you wish to delete any of the existing web services, you have two options that can be followed:
- Physically delete the web service by clicking on the “Delete Business Rule” icon.
- Mark the web service as “Inactive” by unchecking the Active checkbox.
The advantages of marking the web service as “Inactive” is, that you are able to use the web service again at a later stage, should you require to do so. Deleting the web service means you would need to recreate the business rule from scratch.