7/24/2019 An Updated Primer on BMC Remedy AR System Web ..

1/2

BMC.com > All Places > Products > Remedy AR System > Documents

This week's theme: Cool Tech Tips

An Updated Primer on BMC Remedy AR System Web ServicesWith the ongoing, and to a large extent, new efforts that organizations are placing on "Web Service enabling" various applications within their

infrastructure, this article will revisit WebServices from a BMC Remedy AR System standpoint. This article provides details on the "inner workings

of a Web Service request" where AR System has published a Web Service that can be consumed by 3rd-party applications. The goal in providing

this information is to help AR developers gain a better understanding of how Web Service requests are processed in AR System. But more

importantly, this information should provide better context when installing and configuring various components of the AR System server and Mid-

Tier, and when performing the various tasks for Web Service enabling an application. Finally, if SOAP, WSDL or W3C are acronyms that are

unfamiliar, you should stop now and read a Web Services primer before continuing this article. You should also read Chapter 13 of the Action

Request System 6.3: Developing AR System Applications: Advanced manual. If you've done both, go ahead and dive right in!

Remedy introduced Web Services capabilities in the AR System platform with the release of AR System 5.1 in late 2002. Since this release, AR

System developers could easily publish and consume Web Services to integrate business processes that span AR-based and other applications.

The diagram on page 381 of the Advanced Developer's manual depicts an external application issuing a Web Service request to AR System (in this

case, AR System has published a Web Service).

Note: Click images for full screen view.

Figure 1 Diagram from Advanced Developers Guide

As depicted in the above diagram, a SOAP request is received by the AR System Mid-Tier. Not shown, the Mid-Tier actually invokes the Apache

AXIS servlet to process the SOAP request (This servlet is installed when installing the AR System Mid-Tier on the web server). The AXIS servlet

parses the request to get the SOAP header and body information for further processing. The SOAP header contains user, password, and

authentication information, which is used by the AR System server to control access and enforce permissions and security. The SOAP body

contains other key information including: Web Service name, operation, XML document, and query string (if appropriate). The AR System Mid-Tier

then expandsthe xpath expressions in the query string that will be needed to modify or retrieve the appropriate data (i.e. OpSet or OpGet, or

OpGetlist). Finally, the AXIS servlet extracts the XML document formatted originally by the consuming application.

Once the SOAP body is parsed, the AR System Mid-Tier retrieves input and output mapping information from the AR System Server (or from

memory) based on the Web Service name (e.g. WS-HD-Incident). This information contains instructions on how to map the data contained in the

XML document to the appropriate data fields in AR System.

Upon receiving the appropriate mapping information from AR System, the Mid-Tier then uses the XML document, SOAP header data, operation

type, query string (if appropriate) and the mapping information to construct a Java API request. This API request uses the (not well-known) ARXML

API to pass the above data to the AR System Server.

When AR System receives the API request, the AR Server parses the XML document by invoking the Xerces library. The AR Server receives the

parsed data and uses this data as well as the mapping information to create the internal C routines that ultimately perform the appropriate data

access / modification routines in the AR System database. The following detailed process flow depicts the above:

Figure 2 Detailed Process Flow

In this response processing, AR System will take the returned data and invoke the Xerces library to format the appropriate response XML

document. AR System will again use the mapping information (this time the output data mappings contained in the API request) to construct the

XML document.

Once the XML document is constructed, the AR Server passes it back to the Mid-Tier. The Mid-Tier completes the last steps of this Web Service

request by invoking the AXIS servlet to send the SOAP response back to the originating requester.

In a future tips and tricks article we will dive into the inner workings of how AR System can consume an external Web Service and more advanced

issues around transaction integrity, error handling, and performance and scalability concerns.

An Updated Primer on BMC Remedy AR System WebServices

Created by Admin Teamon 23-Aug-2006 09:23. Last modified by Sylvain YVONon 25-Oct-2011 08:23.

Version 3

https://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/people/adminhttps://communities.bmc.com/people/syvonhttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/people/syvonhttps://communities.bmc.com/people/adminhttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer2_Large.jpghttps://communities.bmc.com/images/tips/TT2005/TTSeptember05/Primer_Large.jpghttps://communities.bmc.com/community/bmcdn/bmc_remedy_ar_system/content?filterID=contentstatus[published]~objecttype~objecttype[document]https://communities.bmc.com/community/bmcdn/bmc_remedy_ar_systemhttps://communities.bmc.com/community/bmcdnhttps://communities.bmc.com/placeshttp://www.bmc.com/

7/24/2019 An Updated Primer on BMC Remedy AR System Web ..

2/2

Find People Community Help

Support Login Worldwide About BMC BMC.com

Copyright 2005-2016 BMC Software, Inc. Use of this site signifies your acceptance of BMC's Terms of Use, Privacy Policy and Cookie Notice.BMC, BMC Software, the BMC logos, and other BMC marks are trademarks or registered trademarks of BMC Software, Inc. in the U.S. and/or certainother countries.

Manage Cookies

Average User Rating

(5 ratings)

Good luck Web Service enabling your systems!

~ Rick,Product Manager, Joined 1995

~ Kumar,Staff Product Developer, Joined 1997

~ Maruthi,Staff Software Developer, Joined 1999

9697 Views Categories: Tips and Techniques Tags: tips_and_techniques

Loginor Registerto comment

2 Comments

Great document!I am unable to enlarge the images...

Best Regards - Misi, RRR AB, http://rrr.se

Misi Mladoniczky25-Oct-2011 08:38

Like (0)Actions

images are not working as they shld be other than that its a great docmuch thanksVenkat Maddalahttp://RemediesForRemedy.com

Venkat Maddala21-Jun-2012 14:22

Like (1)Actions

0 0Google + 0 0 529

https://communities.bmc.com/people/VenkatMhttp://remediesforremedy.com/https://communities.bmc.com/people/rrrmizhttp://rrr.se/https://communities.bmc.com/login!input.jspa?registerOnly=truehttps://communities.bmc.com/login.jspahttps://communities.bmc.com/community/bmcdn/bmc_remedy_ar_system/tags#/?tags=tips_and_techniqueshttp://www.bmc.com/legal/trademarkshttp://www.bmc.com/legal/cookie-notices/cookie-notice.htmlhttp://www.bmc.com/legal/privacy/privacy-policy.htmlhttp://www.bmc.com/legal/copyright-statement-and-terms-of-usehttp://www.bmc.com/http://www.bmc.com/http://www.bmc.com/corporate?intcmp=header_aboutbmchttp://www.bmc.com/contacts-locations/worldwide?intcmp=header_worldwidehttps://webapps.bmc.com/signon/content/logon.jsp?intcmp=header_support_slhttps://communities.bmc.com/community/abouthttps://communities.bmc.com/people