Rough Draft: OpenSRF-based campus-information service specification
Graham Fawcett
<graham....@gmail.com> wrote:
> So far, Syrup has some fairly specific (though fairly obvious) campus
> integration requirements. I'd like to take the Syrup use-cases as a
> starting point, and prepare a draft for a general "OpenSRF campus
> information service". My hope is that we'd establish a "version 1.0"
> spec rather quickly -- one that satisfies Syrup's requirements -- but
> also enage the Evergreen community at large to comment on the spec,
> and consider how they might want to extend or refine it for non-Syrup
> use.
I've written a bare-bones draft of the campus-information service I
had in mind. There are gaps in it, but I think it might give the
extremely interested a clue to what I have in mind. (If you're not
extremely interested, wait a day or two and I'll have a more coherent
version.)
I was going to check the draft into the Syrup SVN repo, but my
computer is fighting me on that front tonight; so instead I'm
attaching an HTML version of my draft to this message.
Comments welcome!
Graham
>
> It's important to remember is that we're specifying the OpenSRF-facing
> interface of the service: the implementation details are *highly*
> specific to the implementing institution. You might implement the
> interface using Perl to communicate with your Active Directory server,
> or using Python to read from your Oracle database; but on the OpenSRF
> side we only see language-neutral method calls and data structures,
> and that's where we want a clear specification.
>
> I plan to write a first reference implementation in Python along with
> the draft, and probably also an LDAP-based Python implementation which
> would be useful to our campus. But the spec is the thing that matters
> most, IMHO, and will be of widest interest. If anyone is interested in
> working on the draft, I'd love to hear from you. I will try to get an
> initial document ready within the next day or two.
>
>> Thoughts? If there's some consensus on this list for this, I'll post
>> this message or a variation of it on the open-ils discussion lists to
>> see what happens.
>
> +1 on cross-posting, Robin. I hope there will be some interest!
>
> Best,
> Graham
>
Graham Fawcett
On Thu, Mar 25, 2010 at 12:16 AM, Graham Fawcett
<graham....@gmail.com> wrote:
>
> I've written a bare-bones draft of the campus-information service I
> had in mind. There are gaps in it, but I think it might give the
> extremely interested a clue to what I have in mind. (If you're not
> extremely interested, wait a day or two and I'll have a more coherent
> version.)
I think I've got a good first-draft ready for review. A PDF version is
attached; the source-text version is available at
Comments welcome. I haven't started on a reference implementation yet,
so if you have feedback it would be great to hear it soon.
(If you read the doc, you might notice that the method-names aren't
very OpenSRF-ish. There are probably other OpenSRF-isms that belong in
the spec, but I don't know what yet.)
Best,
Graham