API to RRC
Hi all,
We have been using ReqPro to a great extent by taking the advantage of the API DLLs. We basically develop .NET application and used the DLLs to store data to the ReqPro projects with great ease. Now, we are looking at possible ways to move to RRC. For this, we need to know how we can achieve the same features. As RRC is web based, it might have some services that can be used for such things. I read about OSLC. But could not find how one can access any such services. Does some OSLC based services are installed as part of RRC? Or where can I find such a service to be installed on the RRC server? The basic requirements are inserting requirements, traceabilities, history etc to RRC and retrieving the same. |
Accepted answer
Ralph Schoon (63.6k●3●36●47)
| answered Oct 20 '11, 1:37 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER
Hi,
OSLC is based on REST which is based on pure HTML for create, read, update, delete. These concepts are briefly introduced here: https://jazz.net/projects/DevelopmentItem.jsp?href=content/project/plans/jia-overview/index.html The data is transferred in several formats, where XML is one. OSLC specifies which requests have to be served, which are optional and how to convey error messages. It is using web technologies but is not WSDL based. Here is an article about how to consume OSLC: https://jazz.net/library/article/352/ The Forum Extending Team Concert is used to discuss also OSLC in the context of RTC. The basic concepts are the same for all OSLC implementations. You can search that forum here https://jazz.net/forums/search.php?mode=results using OSLC as keyword. Here is an article on how to consume OSLC with scripts https://jazz.net/library/article/636/ cURL is a library that can be used. You would use tools like cURL or others to do the HTTP GET, POST,... and XML processing tools like xPATH and other technologies to deal with the data. Dependent on the technology you are using it would be different tools. I found this post that talks about C for example: http://blog.boriskuschel.com/2011/07/oslc-development-using-cc-on-jazz-part.html Kangkan Goswami selected this answer as the correct answer
|
7 other answers
Hello
I suggest downloading the existing OSLC workshop located in our Jazz.net library: https://jazz.net/library/article/635 When you work through some of the initial exercises, you will notice that the API works out of the box with CLM 2011 (RTC 3.0.1, RRC 3.0.1 and RQM 3.0.1). No additional installation or configuration is necessary. The workshop currently has OSLC-CM API-based examples. The OSLC-RM API is very similar and will be included in the next update of our workshop. Go through the OSLC-CM examples and it will get you started in the meanwhile. Hi George, Hi- |
Hi Kangkan,
As mentioned by other above, OSLC is REST based which is much more desirable because it avoids SOAP toolkit compatibility issues and just needs a XML Parser and standard HTTP methods to make calls. In this sense, its' not your "traditional" API with a set of interfaces with methods using stubs generated by a toolkit (in your case .NET WS). The good news is that .NET can handle OSLC quite well because all you need is the XML parser and the ability to issue HTTP requests, both of which you can do with .NET quite easily. If we want to compare this with WSDL, then XSD (available on open-services.net) will take the role of describing the content. Instead of generating codes stubs to call you will use your XML parser to extract the content you need using the XSD as input. You can use XPath, for example (practical examples are available on jazz.net. I reccomend the OSLC workshop!) to get the attributes/content you need. To actually GET the content you use HTTP GET with the GET URL formated in such a way to get th object that you want. The format for these URLs are also described on the sites above. You can use HTTP POST to update the objects as well. So, even though i don't have the specifics of what you wish to accomplish, the facilities are there. My recommendation si to definately go through the https://jazz.net/library/content/articles/rtc/2.0.0.2/oslc-extensions-workshop/. It will clarify a lot. At the end of the day, you will find it easier to work with though it may take some time to get used to. Regards, Boris |
Hi-
RRC v3.0.1 implements the OSLC RM v2 API (for the most part). These are all server based APIs and are supported by the RRC server out of the box. No extra installation or configuration is needed. In general, you will find that the OSLC RM API is oriented toward integration with requirements and is limited as far as features that would allow building your own custom application on top of the RRC server. You would need to evaluate the API to determine if it meets your needs before deciding to move to RRC. If you post a bit more about what your .NET application does, I can try to provide some guidance. Information on the OSLC RM api can be found at http://open-services.net. FYI.. We have not plans to provide any compatibility API between the ReqPro RPX api and RRC. Any plans to move your customization to RRC would require a re-write after the necessary APIs are available in RRC. Thanks. George DeCandio |
We are currently working on an update to the existing OSLC workshop on Jazz.net which will include samples and other introduction material for OSLC-RM v2.
With OSLC-RM and OSLC-Core REST-based APIs, one can query for requirements and requirement collections, create requirements or requirement collections and set traceability relationships, among other things. The type of relationship is defined by the specification and can be found by looking at the relationship properties on this page in the specification: http://open-services.net/bin/view/Main/RmSpecificationV2?sortcol=table;table=up#Resource_Requirement Stay tuned. Watch for updates to this article in Jazz.net library: https://jazz.net/library/article/635 Hi all, |
Hi George,
The link to open-services.net works fine and gives the specs. But I failed to locate the API itself or ways how I can access the API for my RRC installation. Does this API comes bundled and installs along with RRC? Or do I need to download and install separately? In that case how and where can I get it? So these are the queries in my mind. Trust, you can help me. Regards, Kangkan Hi- |
I just looked at the workshop and the sample code.
So there is nothing like a SOAP WSDL to get the service details, I think. Or is there any? I am basically looking for connecting to RRC from a .NET client application. Regards, Kangkan Hello Hi George, Hi- |
Geoffrey Clemm (30.1k●3●30●35)
| answered Oct 20 '11, 3:32 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER
Just to make sure there is no confusion ... I'm sure Ralph intended the
initial sentence to say: OSLC is ... based on pure HTTP for create, read, update, delete. (i.e. "HTTP", not "HTML"). Cheers, Geoff On 10/20/2011 1:53 PM, rschoon wrote: Hi, |
Your answer
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.