xWeb
From AvectraWiki, the wiki of Avectra netFORUM
| XWeb |
|---|
 |
 What's New in xWeb! |
Overview
xWeb is netFORUM's XML web services application. netFORUM is an enterprise level Association Management System (AMS) developed by Avectra 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 (to insert new members, financial transactions, or update a member's email address), 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 Avectra. 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 Avectra for more information on xWeb licenses.
Welcome to the xWeb Portal
This wiki contains 220+ pages documenting xWeb, including: general pages, pages on xWeb's 121+ web methods, a self-guided training course, and plenty of code samples in a variety of languages that will help you get started. Some of these pages are oriented more to a reader who is trying to build an integration to netFORUM, and other pages are geared toward a system administrator who is managing the access to xWeb.
If you're trying to learn more about xWeb, either because you're a netFORUM client or prospect trying to understand what xWeb offers, or if you are vendor trying to integrate your application with netFORUM using xWeb, then please start by reading this full page including the links to the Main Articles. These Main Articles are subpages that go into more detail. You can also jump to XWeb Tutorial for a "Quick Start" guide to xWeb.
Finally, once you get your application working, we invite you to contribute code samples and other lessons learned to this site. Many of Avectra's clients, partners, and vendors of our clients, have contributed to this site and to the Avectra community at large.
If, after reading this site, you still have questions (and you probably will), please contact Avectra.
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 an organization running netFORUM to expose pieces of business (AMS) 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 (AMS), E-Marketing, E-Commerce, and content management capabilities (CMS). To run netFORUM, users simply need a browser on their machine. netFORUM is built entirely with Microsoft's new development platform .NET which provides it unparalleled power and flexibility.
Recommendations
Various high level recommendations for configuring the xWeb site. Geared toward a netFORUM System Administrator audience.
Using xWeb
Getting started with xWeb.
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 Avectra 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. On nearly every page relating to xWeb, including this page, you will see a vertical menu on the right of the page that lists all the core xWeb web methods.
Exceptions are returned with a specialized XWebException node.
Initial Release
The page for each web method identifies the build in which it was initially released. If you are working on a site on a build earlier than a particular web method was released, then you will not be able to use that web method until your site is upgraded. Some web methods are released in a later service pack of a build and not in the initial release. If the site you are working on does not contain a certain web method in the WSDL, but you see that web method listed as part of that build, then you may need to have your site upgraded to the latest service pack for that build to be able to use that web method.
Here is a quick summary of which web methods were released in which builds:
netFORUM 2.0 (2006.02)
xWeb's original "core" 20+ web methods are the only methods in 2006.02 and earlier.
netFORUM 2.1 (2007.01)
In 2007.01, we added ExecuteMethod and three others.
netFORUM 2.2 (2008.01)
In 2008.01, we added the 120+ SharePoint methods.
netFORUM 3.0 (2009.01)
Sample xWeb Code and Scenarios
Please post links to any sample programming code that calls xWeb on the methods listed in the section above. Particularly useful would be code that calls the Authenticate method, in various languages (C#, ColdFusion, PHP, etc.), as this is a trouble point for many as it requires sending information in a SOAP Header.
- Link to all articles containing xWeb programming code samples:
- Link to a C# .NET Software Development Kit (SDK) developed by Avectra that demonstrates the use of netFORUM's eCommerce web methods:
- Links to various case studies and code samples:
- XWeb:Authenticate User Sample -- Suggestion for implementing a login from an external site.
- xWeb:Ecommerce Scenarios - General discussion on eCommerce and xWeb.
- XWeb:Authenticate ASP VBScript Sample1 - calling a web service using ASP and VBScript.
- xWeb:ASP VBScript -- more examples of calling a web service using ASP and VBScript.
- xWeb:PHP -- using PHP to interact with xWeb and xWeb Secure
- xWeb:Ruby -- using Ruby to interact with xWeb and xWeb Secure
- XWeb:ColdFusion - ColdFusion complete CFC with Authenticate, Insert, Update, and Query functionality.
- Links to complete xWeb solutions:
- XWeb:Individual_HTML_ColdFusion_Sample1 - Set of ColdFusion forms providing the ability to add/edit/delete address, phone, fax, and e-mail information.
If you add a page with a code sample, please add this Category to the bottom of the page:
[[Category:xWeb Code Sample]]
xWeb Development
See these links for tips on building integrations with xWeb.
- soapUI - a 3rd party tool that is helpful for testing web services
- xWeb Integration Tips - various development tips
- Xweb Laboratory - a website developed by Avectra that enables you to work with the GetQuery web method interactively.
What to do and what not to do
See main article for important tips on optimizing xWeb performance.
Troubleshooting xWeb
See main article for some general troubleshooting tips. Look in the various pages for each Web Method for troubleshooting tips specific to each method as well.
- 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.
System Options
Two system options were added in 2007.01, and another was added in 2008.01. Currently these are the only system options for xWeb.
xWeb Training
- xWeb Training - general information about the course.
- xWeb Training Introduction - the actual training.
xWeb Updates
- XWeb 2008.01 - Changes in xWeb for the 2008.01 build scheduled for summer 2008.
Advanced xWeb
The xWeb methods that have been developed for use in integrating netFORUM with SharePoint or other third-party CMS tools are considered to be part of Advanced xWeb. For more information on getting access or using these methods, contact your sales representative, project manager, or support representative. A list of the Advanced xWeb methods can be found at Category:Advanced xWeb
See Also
- soapUI at http://www.soapui.com and see soapUI
- .NET Webservice Studio is a web service client that can list and invoke web methods interactively.
- Web Wrapper
