Home / Articles / Adobe ColdFusion / Adobe ColdFusion 10 and SOAP-based Web Services

Adobe ColdFusion 10 and SOAP-based Web Services

  • Sample Chapter is provided courtesy of Adobe Press.
  • Date: Apr 1, 2013.

Chapter Description

A web service is a web-based application or a network-accessible interface that can communicate and exchange data with other such applications over the Internet without regard for application, platform, syntax, or architecture. ColdFusion supports most of the messaging frameworks and protocols required to effectively communicate with different platforms, and web services are no exception.This chapter focuses primarily on using ColdFusion 10 with SOAP-based web services.

Application Settings

Four application-level web service settings can be used to apply certain properties related to web services across a given application. These settings are defined in Application.cfc in the this.wssettings struct, shown in Listing 4.12, which we will discuss one by one. Note that these application settings are introduced in ColdFusion 10 and are not available in previous ColdFusion versions.

Listing 4.12. /cfwack/4/Application.cfc


   <cfset this.name="cfwack_4">

   <cfset this.wssettings.version.publish = 2>
   <cfset this.wssettings.version.consume = 2>
   <cfset this.wssettings.style = "wrapped">
   <cfset this.wssettings.includeCFTypesInWSDL = false>


Including ColdFusion Types in WSDL

In our discussion of complex data types, we looked at the use of ColdFusion native data types with web services. These data types are similar to a number of data types in C++ and Java, but they do not exactly match any of the data types defined in the XML schema used by WSDL and SOAP for data-type representation and conversion.

This lack of a match is fine if a web service is published and consumed within ColdFusion because ColdFusion expects and understands its own data types and can serialize or deserialize them. However, when clients other than ColdFusion call this web service, they will need additional information to convert arguments to be sent with the web service call to data types that ColdFusion expects and understands.

Here is where this.wssettings.includeCFTypesInWSDL comes to our rescue. It tells ColdFusion whether to include ColdFusion’s native type information as an XML schema defined in the WSDL itself. Using this schema, other platforms can understand the arguments and result types.

If your web services will be used only with ColdFusion clients, there is no need to include this type information as it will increase the WSDL size. By default, it is set to false.

Deciding Which Web Service Engine to Use

Let’s step back a bit from our original topic of application settings. We said earlier that there are two web service engines available to us with ColdFusion 10. You can choose the web service engine to use according to your requirements:

  • Web Service Engine Version 1: Use this version if you want to publish WSDL in RPC style, or if you do not want all your existing web service clients to refresh their generated stubs. You should also use this version when you have web service clients on ColdFusion 9 and you use complex data types.
  • Web Service Engine Version 2: Use this version if you want to consume any web service that is based on WSDL 2.0, or if you want to publish WSDL in wrapped style. With ColdFusion 10, this is the default engine for publishing a web service.
  • Either engine: For all other scenarios, you can use either of the web service engines.

Specifying the Web Service Engine

ColdFusion uses Web Service Engine Version 2 by default to publish any component as a web service. However, you can override this behavior and tell ColdFusion which engine to use. You can specify the web service engine used to publish your ColdFusion components in any of three places:

  • Component level: You can specify wsversion with <cfcomponent> to declare the web service engine to use to publish that particular component. The possible values are 1 and 2. This setting takes the precedence over application- and server-level version declarations.
  • Application level: You can specify this.wssettings.version.publish in your Application.cfm file to declare the web service engine at the application level. All the components in the application will then be published using this setting. This setting takes precedence over the server-level setting.
  • Server level: You can specify the web service engine to be used across the server. Select the version on the Web Services page in the Data and Services section of ColdFusion Administrator, shown in Figure 4.4.
    Figure 4.4

    Figure 4.4. Changing the web service version in ColdFusion Administrator.

    While consuming a web service, ColdFusion will try to understand the WSDL style. If the style is Document Literal or Document Literal Wrapped, ColdFusion automatically uses Web Service Engine Version 2, and if the style is RPC Literal, ColdFusion automatically uses Web Service Engine Version 1. However, the caller can override this behavior by specifying the web service engine to be used while consuming web services. There are two places to provide this option:

  • While consuming a service: You can provide wsversion with <cfinvoke> to tell Cold-Fusion which web service engine to use to consume the web service. The possible values are 1 and 2, and this setting takes precedence over the application-level setting.
  • Application level: You can specify this.wssettings.version.consume in your Application.cfm file. Any call to consume web services will now use the specified version of the web service engine.

Choosing the WSDL Style

ColdFusion can publish WSDL and consume web services that publish WSDL in the following styles:

  • RPC Encoded: Specified with the <cfcomponent> attribute style="rpc", this style considers web services as XML-based forms of Remote Procedure Calls (RPCs). Here the SOAP message body contains only one element, which is named after the operation, and all parameters must be represented as subelements of this wrapper element. This style is available only with Web Service Engine Version 1.
  • Document Literal: Specified with the <cfcomponent> attribute style="document", this style considers web services as a means of moving XML information from one place to another. Here, the SOAP message body must follow the XML schema defined in WSDL as types. This style is available with both web service engine versions.
  • Document Literal Wrapped: Specified with the <cfcomponent> attribute style="wrapped", this style is similar to the Document Literal style, except that the SOAP message body is wrapped within a root element. This style is available only with Web Service Engine Version 2.

Alternatively, you can specify the WSDL style to use at the application level as this.wssettings.style. ColdFusion will use this information to generate WSDL in the specified style for all the CFCs in this application. You can individually override this setting with the <cfcomponent> attribute style, which takes precedence over application-level settings.

7. Configuring Web Services in ColdFusion Administrator | Next Section Previous Section

Adobe Press Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Adobe Press and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Adobe Press products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.adobepress.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020