xWeb
xWeb is NetForum's XML web services application. NetForum is an enterprise level Association Management System (AMS) developed by Abila that allows associations to manage their customers and related activities. NetForum is used by association staff, members, and the public at large.
xWeb opens up NetForum to external parties via web services, so that authorized programs can interact programatically with NetForum via HTTP/HTTPS and SOAP. Using xWeb, an external program can query NetForum data (to get an event calendar or member roster, for example), or update NetForum , all using the same underlying business objects that power the staff and member applications of NetForum.
In order for an external application to consume NetForum xWeb methods, the client needs to acquire xWeb licenses from Abila. Each application will require its own xWeb license and cannot be shared across applications. For example, if there are two external applications that call xWeb services, two xWeb licenses are required. Please contact Abila for more information on xWeb licenses.
xWeb Architecture
Web Services are URL addressable resources that expose functionality which can be consumed by other systems. In much the same way a person can use a Web browser to request resources (a Web page) from a Web server, a program running on a remote machine can request, or "consume", the functionality made available via a Web Service. NetForum's xWeb uses the power of web services to allow remote access to features within NetForum's AMS. This allows organizations running NetForum to expose pieces of business functionality for use by an external entity, such as a strategic business partner, or internally by other users or groups within the organization.
NetForum Overview
NetForum is an enterprise-wide, Web-based system that includes association management, marketing, eCommerce, and content management capabilities. To run NetForum, users simply need a browser on their machine. NetForum is built with Microsoft's development platform .NET.
Recommendations
Various high level recommendations for configuring the xWeb site. These recommendations are geared toward a NetForum System Administrator audience.
Installing and Configuring xWeb
Intended for site administrators. This is less pertinent to integrators using xWeb. This article explains how to ensure your xWeb site is configured properly in IIS and with other settings. Basic Troubleshooting tips are also included. Various xWeb configuration settings entered in /xweb/web.config are explained in xWeb Configuration Settings.
xWeb User
In order to call any xWeb web methods, a program must Authenticate with a valid xWeb user. See xWeb User Administration for how to add and manage these users and ensure the right level of security. xWeb user will be setup by Abila after the client has purchased a valid xWeb license.
xWeb Web Methods
This page has a summary of the xWeb Web Methods. Each web method has its own page.
Exceptions are returned with a specialized XWebException node.
Sample xWeb Code and Scenarios
- Link to a C# .NET Software Development Kit (SDK) developed by Abila that demonstrates the use of NetForum's eCommerce web methods:
- xWeb eCommerce SDK
- xWeb Ecommerce Scenarios - more on eCommerce development in xWeb.
- Links to various case studies and code samples:
- Authenticate User Sample -- Suggestion for implementing a login from an external site.
- Authenticate ASP VBScript Sample - calling a web service using ASP and VBScript.
- ASP VBScript -- more examples of calling a web service using ASP and VBScript.
- PHP -- using PHP to interact with xWeb and xWeb Secure
- Python -- using Python to interact with xWeb.
- Ruby -- using Ruby to interact with xWeb and xWeb Secure
- ColdFusion - ColdFusion complete CFC with Authenticate, Insert, Update, and Query functionality.
- Links to complete xWeb solutions:
- xWeb: Individual ColdFusion Sample - Set of ColdFusion forms providing the ability to add, edit, and delete address, phone, fax, and e-mail information.
xWeb Development
See these links for tips on building integrations with xWeb.
- SoapUI - a 3rd party tool that is helpful for testing web services
- Fiddler - a 3rd party tool that can capture your outgoing requests to xWeb and the responses that come back from xWeb.
- xWeb Integration Tips - various development tips
- xWeb Laboratory - a website developed by Abila that enables you to work with the GetQuery web method interactively.
- xWeb: Train - a detailed overview of xWeb from the integrator's perspective.
Troubleshooting xWeb
- xWeb Diagnostics - making sure the xWeb site is set up properly.
- SOAP Request Tracing - how to turn on tracing of SOAP requests
- xWebException - Errors in web methods are returned as SOAP Faults with a specialized xWebException.