CiviCRM Community Forums (archive)

Hi,

I am reconsidering my GSoC proposal as I am willing to switch over to Open Supporter Data Interface (OSDI) Implementation project.
I have submitted a new proposal regarding the same. Further I will be posting my updates on this thread.

More information about OSDI can be found on this thread : http://forum.civicrm.org/index.php/topic,35601.0.html

I am looking forward for all the interested mentors and community members to discuss about OSDI on this thread.

Thank you.

So, we had a discussion on skype today and talked about the first step being to create a basic extension that has an api in it - e.g. OsdiContact.get that returns at least a subset of the api fields for a contact.

We talked about this being a learning / community building exercise so the focus should be on getting to grips with this strange new world of CiviCRM code  and finding ways to ask for help (IRC, this forum thread initially) rather than getting it right. The code from this first stage may not be used in the next stage  (as we all know we often learn so much the first time we 'would do it differently next time'.

The basic starting steps are
1) to install CiviX on your buildkit

https://github.com/totten/civix

2) Use CiviX to create an api that just returns some thing static / hard-coded
http://wiki.civicrm.org/confluence/display/CRMDOC/How+to+migrate+or+write+an+api
http://wiki.civicrm.org/confluence/display/CRMDOC/API+Reference

(Update the wiki if you find anything wrong / unclear)

3) And call your api through the API explorer.

4) replace the hard-coded one with details retrieved using the api

Have a go -

Great Anudit. Sounds like you are working through the things you hit & are progressing on it.

Have you figured out how to get onto IRC? http://book.civicrm.org/user/current/the-civicrm-community/civicrm-community/

Hi Eileen,

I am facing some problems while working with civix. For generating an API, I used civix CLI command:

>civix generate:api contact get

It is showing an exception:
"Failed to locate CMS. Please call civix from somewhere under the CMS root"
But I was already working under my drupal root, also I tried calling civix from drupal module's directory under civicrm but it shows the same thing. Is there is way in which I can tell civix about my CMS installation directory like a XML file or something that I need to define before using the civix ?
Meanwhile without civix I created a custom api file, called it through the API explorer and replaced the hard code.
I really want to know the basic usage and other functionality on civix.
Thanks

Hi Eileen,

After discussing on IRC, the problem I stated before still persists, I used Cygwin to run commands (~/.civix/civix.ini) but it is unable to find the configuration file which may be pointing to a different root or older one. So I want to know (if it works), can I continue using wamp and its php resources and still be able to call civix under its defined root directory ? the problem is I have configured my dev environment (NodeJS, Apache Server, git etc) in windows if I switch back to Ubuntu then I have to do it all again to setup CMS and installing CiviCRM afterwards. (viz. bit time consuming) Also I came to know that vagrant can help me achieve the sharing of files between guest Ubuntu virtual machine and host windows OS. So should I go with setup of vagrant (though I have started with few initial steps) and could you brief me more about its further setup or the former problem that I mentioned can be solved with some steps that I might have missed while troubleshooting.

I believe it would be very helpful if we discuss it on Skype (like screen sharing or something) which would help me figure out what I am doing wrong and what actual implementation is required in this regard. Also my majors will be commencing soon so I want to get over this problem and setup my dev environment before the start of my exam preparations (likely to be in couple of weeks) so that I can begin developing in the coding period.

Thank you.

Yes Joe,
I am running a dual boot machine with Ubuntu 14.04 LTS along with windows.
Looking forward to achieve this with guidance of the Civi community soon.
Thank you.

I concur with the other advice you are getting on using a linux dev environment. A subcontractor of mine had some painful experiences trying to get cygwin to work properly in order to participate in a CiviCRM project for us several years ago. I'm sure things are better now but it adds a unnecessary layer of complications and distractions to an already full project schedule.

Re: profiles, this concept is new, actually. The idea is that there might be common parts of OSDI that certain systems need to implement to do their work. Since all of OSDI is optional (you don't have to implement the whole spec, but if you implement parts of it you need to do it in the way the spec lays out), profiles can help identify common features that certain types of systems need.

For example, a system like Mobile Commons, which does SMS text messaging, probably doesn't need to implement any of the actions (petitions/signatures, fundraising pages/donations, etc...) since their system really doesn't do that. Their profile is more about the people endpoint, custom fields, maybe canvass questions and responses and answers, that kind of thing.

But, a system like Action Network (and like Civi) probably does need those action types, so our profile is a bit different.

I'm not sure you have to worry about profiles too much, like I said it's new, and it's just a way to help organize thinking around implementation. Basically, figuring out what parts of OSDI match to your system and what parts aren't relevant.