Skip to main content

By clicking Submit, you agree to the developerWorks terms of use.

The first time you sign into developerWorks, a profile is created for you. Select information in your profile (name, country/region, and company) is displayed to the public and will accompany any content you post. You may update your IBM account at any time.

All information submitted is secure.

  • Close [x]

The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerworks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

By clicking Submit, you agree to the developerWorks terms of use.

All information submitted is secure.

  • Close [x]

Leveraging RIXML with Web services

Exchange research content and metadata

Saikumar V. Dubagunta (sai@appera.com), Chief Technology Officer, Appera Software Inc.
Photo of Saikumar Dubagunta
Saikumar Dubagunta has a Masters degree in Computer Science from Texas A&M University and over 16 years of experience in the software industry. He has lead in the design, development, and release of cutting-edge software tools for the telecommunication, data storage, and financial industries. As a team lead and architect, he was responsible for all stages of development, including requirements, design, coding, testing, documentation, release, and customer support. Saikumar has a wide variety of experience in such technologies as Java, Microsoft .NET, C++, XML, relational and object-oriented databases, communication protocols, and UNIX™. You can reach Saikumar at sai@appera.com.

Summary:  Research Information Exchange Markup Language (RIXML) defines a standard XML schema for exchanging content and metadata that tags content with relevant information such as locations, names, and key information types that organizations can use to efficiently perform look-up, sort, and search operations. Discover how the combination of RIXML and Web services provides a powerful mechanism for exchanging key information.

Date:  16 Dec 2008
Level:  Intermediate PDF:  A4 and Letter (76 KB | 22 pages)Get Adobe® Reader®

Activity:  10362 views
Comments:  

The Product element

A <Research> element can consist of more than one product, each referring to an individual research document. Listing 1 shows an example of this required element.

Set unique identifiers

The <Product> element is a sequence: Each instance of the <Product> element should have the sequence attribute set to a unique value within the document. A sequence number starting at 1 is typically used. The productID is a unique identifier for the research document being delivered as part of the RIXML string. The productID is typically constructed by appending the sequence number to researchID at the root level.

The <StatusInfo> element

The <StatusInfo> element within the <Product> element represents the status of the research. Set statusDateTime to the time at which this research bundle was prepared for transmission. (This attribute should have the same value as createDateTime.) The currentStatusIndicator indicates whether the status represents the current status of the document: it should be set to Yes. The statusType attribute is set to Released in this particular example. It is possible for organizations to use multiple <StatusInfo> instances in the RIXML string. Each instance of the element can represent a particular phase in the life cycle of research, such as Pending, Revised, Recalled, Deleted, Published, Rebroadcast, and Released. If you use multiple instances of <StatusInfo> (perhaps to provide a history of revisions and releases, or a schedule of future releases), you might indicate which instance represents the current status of the research by setting currentStatusIndicator="Yes"; in the other instances of <StatusInfo>, you set currentStatusIndicator="No". However, the typical use of RIXML is to separate each transmission into a separate payload so the processing can be simple at the receiving and transmitting ends. In other words, when a document is sent with a <StatusInfo> value of Published, and then revised, the new RIXML string will only contain a <StatusInfo> of Revised, and the content has the newly revised document. It is recommended that the receiver and transmitter manage the different versions of their documents within their own DMS.


Required <Product> elements

Each <Product> element contains the following four elements:

  • <Source>: This element represents the originator of the research, including the organization name, the analyst producing the information, and details of the analyst, such as phone numbers and e-mail addresses.
  • <Content>: This element contains the actual output of research, including the type of output (for example, Word document, spreadsheet) and the document itself.
  • <Context>: This element contains information related to the area of research, including the product focus described above and information about the company on which the research was conducted.
  • <Legal>: This element consists of legal disclaimers regarding the research and the transmission.

For the sake of simplicity, you should have only one instance of these elements within each product.

5 of 13 | Previous | Next

Comments



static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=XML, SOA and Web services
ArticleID=358584
TutorialTitle=Leveraging RIXML with Web services
publish-date=12162008
author1-email=sai@appera.com
author1-email-cc=dwxed@us.ibm.com