Hello, I just learned about OSLC yesterday. I’m a simple computer programmer in languages such as C/C++ and Fortran to name a few. I know knowing of HTML.
On a laptop (using Windows 10 or Linux), I’d like to create some type of very simple working OSCL program (of some kind) that pulls data from one application and deposits it in another application.
Is there some YouTube video or Internet webpage that can help me?
Looking for 1 working program, maybe 4:
(1) I do have access to Google Chrome. Can you give me an OSCL program that works only with Google Chrome. How do I run it? I’ve never coded anything for HTML before. So, I need very detailed step by step directions on how to do this. What should I see when I run the program?
Again using OSLC, I’m looking for something that I can run that pulls data from one application to another.
(2) I also have access to Bitbucket, C/C++, and Fortran. Can you give me a second program that does the above with Bitbucket and C/C++ or Fortran?
(3) Third, I might be able to get an account in Jira and Confluence. Do you have another simple program that maybe pulls from Chrome and deposits data in Jira. This is at least something that I should know how to do.
(4) Fourth, what about Jira, Cameo, and Windchill? This is something I should also know how to do.
P.S.: What kind of OSLC support does Jira, Cameo/MagicDraw/SysML, and the PLM program Windchill have?
You can also try to run the Reference implementation GitHub - oslc-op/refimpl. 4 OSLC interfaces, but with no real applications behind them. But it does give an idea about OSLC (and how to implement it).
There was also a very simple helper in Perl that we retired long time ago and a few C++ examples (not a proper library) that I never got a chance to run (though I checked the code just now and would strongly discourage trying to parse the RDF/XML data format using XML tools directly – XML represents a tree data structure, while RDF uses a graph data model, encoded into RDF/XML – there be dragons).
In general, you need two things to interact with an OSLC REST API endpoint:
an HTTP client to make REST API calls (I assume you have access to curl in Fortran or similar), and
an RDF library to marshal and unmarshal graphs (I know of two C-compatible options, serd and redland, assuming you can use produce some FFI bindings to call C code from your language of choice)
For the build instructions, README files should provide enough details. If not, you may find it useful to consult build server configs like this and this one.
Ultimately, I’m looking for a simple OSLC application that programmatically pulls data from one application and deposits it in another application.
You will find it difficult to find a perfect example of what you are trying to do precisely because OSLC discourages copying of data (aka “link, don’t sync”). From what I see, you are specifically after an OSLC client, not building an OSLC-compliant server. Check out these:
For the majority of cases, you can consume the materials for “Jazz Services”, as they are essentially OSLC + Jazz-specific authentication bits, which you can ignore. Most of the learning materials have been created for Jazz or for OSLC-based integration of some tools with Jazz, so you will find it hard to completely avoid all Jazz-specific information.
By the way, we’d be very interested in your feedback on the bits of documentation you will find most and least useful, so that we can use your newcomer status as an advantage when it comes to looking at the docs with the fresh eyes.
For your purpose, Lyo is just a set of libraries for client/server implementation.
In the simplest case (native support), Cameo and Windchill can be integrated (in one direction) without a need for Lyo if one of those tools implements an OSLC REST API (e.g. if a vendor used Lyo server libraries) and another has an OSLC client (using Lyo client libraries, for example). For a bidirectional integration, both tools should expose a REST API following the OSLC standard and both should consume each other’s API. I saw that Cameo supports OSLC via Cameo Datahub (in one direction only, AFAIK) to link to the requirements (primarily against Jazz). Windchill seems to support OSLC, serving as an OSLC server, exactly in the requirements domain. In this case, you simply follow tool manuals for administrators and try to establish an OSLC connection between two tools.
Another option is adversarial integration. Despite a pair of tools not willing to implement OSLC (or parts of it that you specifically care about), you can develop such interfaces yourself using Lyo (or buy them). Koneksys (@axel.reichwein) developed a Magicdraw OSLC server for the SysMLv1 domain (though SysMLv1 was never a standardized OSLC domain, to be clear), SodiusWillert (@Frej) offered Windchill connector in the past (AFAIK, it was phased out in favor of a native OSLC support in Windchill).
This makes sense. Can you give me an exact reference? I.E.: Where can I go for clarification? Are you 50%/…/90%/100% positive?
Question: How difficult would it be to develop an interface between Windchill and Cameo? What would it involve? How long would it take? Not counting blank lines, how many lines of code would a person be looking at?
Where can I get example source code for Koneksys’ and/or SodiusWillert’s interfaces?
Can you describe the classes? How many classes would it take? How many objects would be involved?
What kinds of problems would I run into if I were to try to develop the interface? What are the difficult and not so difficult problems?
Do you recommend doing it?
(In developing these new interfaces, does it make sense to ask: What else has to be installed? What compilers are involved?)
What kind of problems did Koneksys and SodiusWillert have?
In most cases, Java JDK 11+, Apache Maven, and Eclipse Lyo Designer (Lyo is a set of libraries, while Lyo Designer is an Eclipse IDE based modelling and code gen tool) . If you don’t want to use code generation, the JDK and Maven would be enough.
Sorry, Christopher, I was writing hypothetically: if a pair of tools have native support (i.e., offered by the original vendor; has nothing to do with a native environment) for OSLC, then the integration can be done without coding.
Practically, I saw (from the slides linked before) that Cameo supports linking to Jazz Doors NG requirements via some Cameo Datahub (which, in my opinion, would require Cameo Datahub to implement OSLC RM as a client), and Windchill from the public docs (also linked to before) seems to support OSLC RM as a server. By the way, this DataHub thing seems to be quite dead according to Dassault. Its (apparent) successor, Teamwork Cloud claims to support OSLC Architecture Management specification as a server (which is nice, though doesn’t seem to fill the gap of an OSLC Requirements Management client, which DataHub ostensibly did).
“One direction” means that a client can connect to a server, not the other way around. Thus, if the things discussed above work as advertised, it should be possible for you to link from Cameo to Windchill requirements. But not for Windchill to link to Cameo unless someone (you?) implements an OSLC Server on the Cameo side and someone (PTC?) develops an OSLC Client inside Windchill (I think Windchill allows linking to Integrity Modeller but again, haven’t done it in practice, so I am not sure how portable it is).
Regarding the specs, I see OSLC Requirement Management being mentioned in Cameo and Windchill marketing materials, and OSLC Architecture Management in the Dassault Teamwork Cloud.
Have you tried contacting PTC and Dassault with these questions?
As a side note, there is now ongoing work to define OSLC Profiles, which would simplify the job of ascertaining which tools can connect to which. Would you be interested to contribute your use case to the work group? Online calls are on Thursdays at 10:00 AM US Eastern if I didn’t mix up the time zones.
Unfortunately, vendors are reluctant to provide us with the detailed technical specifications of their OSLC interface implementations. Thus, we cannot provide you with the detailed information about specific tools let alone tool pairs, which is why I pointed you to vendors about specific tools.
The link you mentioned points to a tool from MID, Ed Gentry (MID) should be able to help. My knowledge about that Jira connector comes only from the commercial marketing materials from the vendor, same that you have access to. I don’t see him on the forum. You can post to firstname.lastname@example.org | Home mailing list, he should be reading that.
To answer your question about two-way, I don’t think you can expect an out of the box integration from the Cameo side if you only instlall a Jira adaptor. My understanding is that MID relies on information being pulled into Smartfacts in order to create links between pairs of artifacts if such links are not supported by the vendors of the respective tools. In other words, those links back to Cameo artifacts are not done via OSLC but in a proprietary way. See this illustration:
I am the product owner of MID Smartfacts. We have many OSLC based integration. @andrew is correct that some of our integrations to modeling tools have required synchronization into Smartfacts in order to story. We recently upgraded our Cameo/MagicDraw integration so that links are stored directly.
In addition to OSLC integration integrations we also offer our underlying integration technology genOSLC. This is a fully feature OSLC framework that accelerates the implementation of OSLC integration. It is often used to create integration to internal system. For most system you can have a working OSLC based integration proof of concept in just one working day.