1 <?xml version="1.0" encoding="UTF-8"?>
\r
2 <chapter xml:id="data_models_and_access" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"
\r
3 xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
\r
5 <title>Evergreen Data Models and Access</title>
\r
7 <section id="_database_schema">
\r
8 <title>Database schema</title>
\r
9 <simpara>The database schema is tied pretty tightly to PostgreSQL. Although PostgreSQL
\r
10 adheres closely to ANSI SQL standards, the use of schemas, SQL functions
\r
11 implemented in both plpgsql and plperl, and PostgreSQL’s native full-text
\r
12 search would make it… challenging… to port to other database platforms.</simpara>
\r
13 <simpara>A few common PostgreSQL interfaces for poking around the schema and
\r
14 manipulating data are:</simpara>
\r
18 psql (the command line client)
\r
23 pgadminIII (a GUI client).
\r
27 <simpara>Or you can read through the source files in Open-ILS/src/sql/Pg.</simpara>
\r
28 <simpara>Let’s take a quick tour through the schemas, pointing out some highlights
\r
29 and some key interdependencies:</simpara>
\r
33 actor.org_unit → asset.copy_location
\r
38 actor.usr → actor.card
\r
43 biblio.record_entry → asset.call_number → asset.copy
\r
48 config.metabib_field → metabib.*_field_entry
\r
53 <section id="_database_access_methods">
\r
54 <title>Database access methods</title>
\r
55 <simpara>You could use direct access to the database via Perl DBI, JDBC, etc,
\r
56 but Evergreen offers several database CRUD services for
\r
57 creating / retrieving / updating / deleting data. These avoid tying
\r
58 you too tightly to the current database schema and they funnel database
\r
59 access through the same mechanism, rather than tying up connections
\r
60 with other interfaces.</simpara>
\r
62 <section id="_evergreen_interface_definition_language_idl">
\r
63 <title>Evergreen Interface Definition Language (IDL)</title>
\r
64 <simpara>Defines properties and required permissions for Evergreen classes.
\r
65 To reduce network overhead, a given object is identified via a
\r
66 class-hint and serialized as a JSON array of properties (no named properties).</simpara>
\r
67 <simpara>As of 1.6, fields will be serialized in the order in which they appear
\r
68 in the IDL definition file, and the is_new / is_changed / is_deleted
\r
69 properties are automatically added. This has greatly reduced the size of
\r
70 the <literal>fm_IDL.xml</literal> file and makes DRY people happier :)</simpara>
\r
74 … oils_persist:readonly tells us, if true, that the data lives in the database, but is pulled from the SELECT statement defined in the <oils_persist:source_definition> child element
\r
78 <simplesect id="_idl_basic_example_config_language_map">
\r
79 <title>IDL basic example (config.language_map)</title>
\r
80 <programlisting language="xml" linenumbering="unnumbered"><class id="clm" controller="open-ils.cstore open-ils.pcrud"
\r
81 oils_obj:fieldmapper="config::language_map"
\r
82 oils_persist:tablename="config.language_map"
\r
83 reporter:label="Language Map" oils_persist:field_safe="true"> <co id="dmCO5-1"/> <co id="dmCO5-2"/> <co id="dmCO5-3"/> <co id="dmCO5-4"/>
\r
84 <fields oils_persist:primary="code" oils_persist:sequence=""> <co id="dmCO5-5"/>
\r
85 <field reporter:label="Language Code" name="code"
\r
86 reporter:selector="value" reporter:datatype="text"/> <co id="dmCO5-6"/>
\r
87 <field reporter:label="Language" name="value"
\r
88 reporter:datatype="text" oils_persist:i18n="true"/> <co id="dmCO5-7"/>
\r
91 <permacrud xmlns="http://open-ils.org/spec/opensrf/IDL/permacrud/v1"> <co id="dmCO5-8"/>
\r
93 <create global_required="true" permission="CREATE_MARC_CODE"> <co id="dmCO5-9"/>
\r
94 <retrieve global_required="true"
\r
95 permission="CREATE_MARC_CODE UPDATE_MARC_CODE DELETE_MARC_CODE">
\r
96 <update global_required="true" permission="UPDATE_MARC_CODE">
\r
97 <delete global_required="true" permission="DELETE_MARC_CODE">
\r
100 </class></programlisting>
\r
102 <callout arearefs="dmCO5-1">
\r
104 The <literal>class</literal> element defines the attributes and permissions for classes,
\r
105 and relationships between classes.
\r
110 The <literal>id</literal> attribute on the <literal>class</literal> element defines the class hint that is
\r
111 used everywhere in Evergreen.
\r
116 The <literal>controller</literal> attribute defines the OpenSRF
\r
117 services that provide access to the data for the class objects.
\r
122 <callout arearefs="dmCO5-2">
\r
124 The <literal>oils_obj::fieldmapper</literal> attribute defines the name of the class that
\r
125 is generated by <literal>OpenILS::Utils::Fieldmapper</literal>.
\r
128 <callout arearefs="dmCO5-3">
\r
130 The <literal>oils_persist:tablename</literal> attribute defines the name of the table
\r
131 that contains the data for the class objects.
\r
134 <callout arearefs="dmCO5-4">
\r
136 The reporter interface uses <literal>reporter:label</literal> attribute values in
\r
137 the source list to provide meaningful class and attribute names. The
\r
138 <literal>open-ils.fielder</literal> service generates a set of methods that provide direct
\r
139 access to the classes for which <literal>oils_persist:field_safe</literal> is <literal>true</literal>. For
\r
142 <screen>srfsh# request open-ils.fielder open-ils.fielder.clm.atomic \
\r
143 {"query":{"code":{"=":"eng"}}}
\r
152 <callout arearefs="dmCO5-5">
\r
154 The <literal>fields</literal> element defines the list of fields for the class.
\r
159 The <literal>oils_persist:primary</literal> attribute defines the column that acts as
\r
160 the primary key for the table.
\r
165 The <literal>oils_persist:sequence</literal> attribute holds the name of the database
\r
171 <callout arearefs="dmCO5-6">
\r
173 Each <literal>field</literal> element defines one property of the class.
\r
178 The <literal>name</literal> attribute defines the getter/setter method name for the field.
\r
183 The <literal>reporter:label</literal> attribute defines the attribute name as used in
\r
184 the reporter interface.
\r
189 The <literal>reporter:selector</literal> attribute defines the field used in the reporter
\r
190 filter interface to provide a selectable list. This gives the user a more
\r
191 meaningful access point than the raw numeric ID or abstract code.
\r
196 The <literal>reporter:datatype</literal> attribute defines the type of data held by
\r
197 this property for the purposes of the reporter.
\r
202 <callout arearefs="dmCO5-7">
\r
204 The <literal>oils_persist:i18n</literal> attribute, when <literal>true</literal>, means that
\r
205 translated values for the field’s contents may be accessible in
\r
209 <callout arearefs="dmCO5-8">
\r
211 The <literal>permacrud</literal> element defines the permissions (if any) required
\r
212 to <emphasis role="strong">c</emphasis>reate, <emphasis role="strong">r</emphasis>etrieve, <emphasis role="strong">u</emphasis>pdate, and <emphasis role="strong">d</emphasis>elete data for this
\r
213 class. <literal>open-ils.permacrud</literal> must be defined as a controller for the class
\r
214 for the permissions to be applied.
\r
217 <callout arearefs="dmCO5-9">
\r
219 Each action requires one or more <literal>permission</literal> values that the
\r
220 user must possess to perform the action.
\r
225 If the <literal>global_required</literal> attribute is <literal>true</literal>, then the user must
\r
226 have been granted that permission globally (depth = 0) to perform
\r
232 The <literal>context_field</literal> attribute denotes the <literal><field></literal> that identifies
\r
233 the org_unit at which the user must have the pertinent permission.
\r
238 An action element may contain a <literal><context_field></literal> element that
\r
239 defines the linked class (identified by the <literal>link</literal> attribute) and
\r
240 the field in the linked class that identifies the org_unit where
\r
241 the permission must be held.
\r
246 If the <literal><context_field></literal> element contains a <literal>jump</literal> attribute,
\r
247 then it defines a link to a link to a class with a field identifying
\r
248 the org_unit where the permission must be held.
\r
257 <simplesect id="_reporter_data_types_and_their_possible_values">
\r
258 <title>Reporter data types and their possible values</title>
\r
262 <literal>bool</literal>: Boolean <literal>true</literal> or <literal>false</literal>
\r
267 <literal>id</literal>: ID of the row in the database
\r
272 <literal>int</literal>: integer value
\r
277 <literal>interval</literal>: PostgreSQL time interval
\r
282 <literal>link</literal>: link to another class, as defined in the <literal><links></literal>
\r
283 element of the class definition
\r
288 <literal>money</literal>: currency amount
\r
293 <literal>org_unit</literal>: list of org_units
\r
298 <literal>text</literal>: text value
\r
303 <literal>timestamp</literal>: PostgreSQL timestamp
\r
308 <simplesect id="_idl_example_with_linked_fields_actor_workstation">
\r
309 <title>IDL example with linked fields (actor.workstation)</title>
\r
310 <simpara>Just as tables often include columns with foreign keys that point
\r
311 to values stored in the column of a different table, IDL classes
\r
312 can contain fields that link to fields in other classes. The <literal><links></literal>
\r
313 element defines which fields link to fields in other classes, and
\r
314 the nature of the relationship:</simpara>
\r
315 <programlisting language="xml" linenumbering="unnumbered"><class id="aws" controller="open-ils.cstore"
\r
316 oils_obj:fieldmapper="actor::workstation"
\r
317 oils_persist:tablename="actor.workstation"
\r
318 reporter:label="Workstation">
\r
319 <fields oils_persist:primary="id"
\r
320 oils_persist:sequence="actor.workstation_id_seq">
\r
321 <field reporter:label="Workstation ID" name="id"
\r
322 reporter:datatype="id"/>
\r
323 <field reporter:label="Workstation Name" name="name"
\r
324 reporter:datatype="text"/>
\r
325 <field reporter:label="Owning Library" name="owning_lib"
\r
326 reporter:datatype="org_unit"/>
\r
327 <field reporter:label="Circulations" name="circulations"
\r
328 oils_persist:virtual="true" reporter:datatype="link"/> <co id="dmCO6-1"/>
\r
330 <links> <co id="dmCO6-2"/>
\r
331 <link field="owning_lib" reltype="has_a" key="id"
\r
332 map="" class="aou"/> <co id="dmCO6-3"/>
\r
333 <link field="circulations" reltype="has_many" key="workstation"
\r
334 map="" class="circ"/>
\r
335 <link field="circulation_checkins" reltype="has_many"
\r
336 key="checkin_workstation" map="" class="circ"/>
\r
338 </class></programlisting>
\r
340 <callout arearefs="dmCO6-1">
\r
342 This field includes an <literal>oils_persist:virtual</literal> attribute with the value of
\r
343 <literal>true</literal>, meaning that the linked class <literal>circ</literal> is a virtual class.
\r
346 <callout arearefs="dmCO6-2">
\r
348 The <literal><links></literal> element contains 0 or more <literal><link></literal> elements.
\r
351 <callout arearefs="dmCO6-3">
\r
353 Each <literal><link></literal> element defines the field (<literal>field</literal>) that links to a different
\r
354 class (<literal>class</literal>), the relationship (<literal>rel_type</literal>) between this field and the target
\r
355 field (<literal>key</literal>). If the field in this class links to a virtual class, the (<literal>map</literal>)
\r
356 attribute defines the field in the target class that returns a list of matching
\r
357 objects for each object in this class.
\r
363 <section id="open_ils_cstore_literal_data_access_interfaces">
\r
364 <title><literal>open-ils.cstore</literal> data access interfaces</title>
\r
365 <simpara>For each class documented in the IDL, the <literal>open-ils.cstore</literal> service
\r
366 automatically generates a set of data access methods, based on the
\r
367 <literal>oils_persist:tablename</literal> class attribute.</simpara>
\r
368 <simpara>For example, for the class hint <literal>clm</literal>, cstore generates the following
\r
369 methods with the <literal>config.language_map</literal> qualifer:</simpara>
\r
373 <literal>open-ils.cstore.direct.config.language_map.id_list {"code" { "like": "e%" } }</literal>
\r
375 <simpara>Retrieves a list composed only of the IDs that match the query.</simpara>
\r
379 <literal>open-ils.cstore.direct.config.language_map.retrieve "eng"</literal>
\r
381 <simpara>Retrieves the object that matches a specific ID.</simpara>
\r
385 <literal>open-ils.cstore.direct.config.language_map.search {"code" : "eng"}</literal>
\r
387 <simpara>Retrieves a list of objects that match the query.</simpara>
\r
391 <literal>open-ils.cstore.direct.config.language_map.create <_object_></literal>
\r
393 <simpara>Creates a new object from the passed in object.</simpara>
\r
397 <literal>open-ils.cstore.direct.config.language_map.update <_object_></literal>
\r
399 <simpara>Updates the object that has been passed in.</simpara>
\r
403 <literal>open-ils.cstore.direct.config.language_map.delete "eng"</literal>
\r
405 <simpara>Deletes the object that matches the query.</simpara>
\r
409 <section id="_open_ils_pcrud_data_access_interfaces">
\r
410 <title>open-ils.pcrud data access interfaces</title>
\r
411 <simpara>For each class documented in the IDL, the <literal>open-ils.pcrud</literal> service
\r
412 automatically generates a set of data access methods, based on the
\r
413 <literal>oils_persist:tablename</literal> class attribute.</simpara>
\r
414 <simpara>For example, for the class hint <literal>clm</literal>, <literal>open-ils.pcrud</literal> generates the following
\r
415 methods that parallel the <literal>open-ils.cstore</literal> interface:</simpara>
\r
419 <literal>open-ils.pcrud.id_list.clm <_authtoken_>, { "code": { "like": "e%" } }</literal>
\r
424 <literal>open-ils.pcrud.retrieve.clm <_authtoken_>, "eng"</literal>
\r
429 <literal>open-ils.pcrud.search.clm <_authtoken_>, { "code": "eng" }</literal>
\r
434 <literal>open-ils.pcrud.create.clm <_authtoken_>, <_object_></literal>
\r
439 <literal>open-ils.pcrud.update.clm <_authtoken_>, <_object_></literal>
\r
444 <literal>open-ils.pcrud.delete.clm <_authtoken_>, "eng"</literal>
\r
449 <section id="_transaction_and_savepoint_control">
\r
450 <title>Transaction and savepoint control</title>
\r
451 <simpara>Both <literal>open-ils.cstore</literal> and <literal>open-ils.pcrud</literal> enable you to control database transactions
\r
452 to ensure that a set of operations either all succeed, or all fail,
\r
453 atomically:</simpara>
\r
457 <literal>open-ils.cstore.transaction.begin</literal>
\r
462 <literal>open-ils.cstore.transaction.commit</literal>
\r
467 <literal>open-ils.cstore.transaction.rollback</literal>
\r
472 <literal>open-ils.pcrud.transaction.begin</literal>
\r
477 <literal>open-ils.pcrud.transaction.commit</literal>
\r
482 <literal>open-ils.pcrud.transaction.rollback</literal>
\r
486 <simpara>At a more granular level, <literal>open-ils.cstore</literal> and <literal>open-ils.pcrud</literal> enable you to set database
\r
487 savepoints to ensure that a set of operations either all succeed, or all
\r
488 fail, atomically, within a given transaction:</simpara>
\r
492 <literal>open-ils.cstore.savepoint.begin</literal>
\r
497 <literal>open-ils.cstore.savepoint.commit</literal>
\r
502 <literal>open-ils.cstore.savepoint.rollback</literal>
\r
507 <literal>open-ils.pcrud.savepoint.begin</literal>
\r
512 <literal>open-ils.pcrud.savepoint.commit</literal>
\r
517 <literal>open-ils.pcrud.savepoint.rollback</literal>
\r
521 <simpara>Transactions and savepoints must be performed within a stateful
\r
522 connection to the <literal>open-ils.cstore</literal> and <literal>open-ils.pcrud</literal> services.
\r
523 In <literal>srfsh</literal>, you can open a stateful connection using the <literal>open</literal>
\r
524 command, and then close the stateful connection using the <literal>close</literal>
\r
525 command - for example:</simpara>
\r
526 <screen>srfsh# open open-ils.cstore
\r
527 ... perform various transaction-related work
\r
528 srfsh# close open-ils.cstore</screen>
\r
529 <simplesect id="_json_queries">
\r
530 <title>JSON Queries</title>
\r
531 <simpara>Beyond simply retrieving objects by their ID using the <literal>\*.retrieve</literal>
\r
532 methods, you can issue queries against the <literal>\*.delete</literal> and <literal>\*.search</literal>
\r
533 methods using JSON to filter results with simple or complex search
\r
534 conditions.</simpara>
\r
535 <simpara>For example, to generate a list of barcodes that are held in a
\r
536 copy location that allows holds and is visible in the OPAC:</simpara>
\r
537 <programlisting language="sh" linenumbering="unnumbered">srfsh# request open-ils.cstore open-ils.cstore.json_query <co id="dmCO7-1"/>
\r
538 {"select": {"acp":["barcode"], "acpl":["name"]}, <co id="dmCO7-2"/>
\r
539 "from": {"acp":"acpl"}, <co id="dmCO7-3"/>
\r
540 "where": [ <co id="dmCO7-4"/>
\r
541 {"+acpl": "holdable"}, <co id="dmCO7-5"/>
\r
542 {"+acpl": "opac_visible"} <co id="dmCO7-6"/>
\r
546 "barcode":"BARCODE1",
\r
551 "barcode":"BARCODE2",
\r
555 <callout arearefs="dmCO7-1">
\r
557 Invoke the <literal>json_query</literal> service.
\r
560 <callout arearefs="dmCO7-2">
\r
562 Select the <literal>barcode</literal> field from the <literal>acp</literal> class and the <literal>name</literal>
\r
563 field from the <literal>acpl</literal> class.
\r
566 <callout arearefs="dmCO7-3">
\r
568 Join the <literal>acp</literal> class to the <literal>acpl</literal> class based on the linked field
\r
569 defined in the IDL.
\r
572 <callout arearefs="dmCO7-4">
\r
574 Add a <literal>where</literal> clause to filter the results. We have more than one
\r
575 condition beginning with the same key, so we wrap the conditions inside
\r
579 <callout arearefs="dmCO7-5">
\r
581 The first condition tests whether the boolean value of the <literal>holdable</literal>
\r
582 field on the <literal>acpl</literal> class is true.
\r
585 <callout arearefs="dmCO7-6">
\r
587 The second condition tests whether the boolean value of the
\r
588 <literal>opac_visible</literal> field on the <literal>acpl</literal> class is true.
\r
592 <simpara>For thorough coverage of the breadth of support offered by JSON
\r
593 query syntax, see <ulink url="http://open-ils.org/dokuwiki/doku.php?id=documentation:technical:jsontutorial">JSON Queries: A Tutorial</ulink>.</simpara>
\r
595 <simplesect id="_fleshing_linked_objects">
\r
596 <title>Fleshing linked objects</title>
\r
597 <simpara>A simplistic approach to retrieving a set of objects that are linked to
\r
598 an object that you are retrieving - for example, a set of call numbers
\r
599 linked to the barcodes that a given user has borrowed - would be to:
\r
600 1. Retrieve the list of circulation objects (<literal>circ</literal> class)
\r
601 for a given user (<literal>usr</literal> class).
\r
602 2. For each circulation object, look up the target copy (<literal>target_copy</literal>
\r
603 field, linked to the <literal>acp</literal> class).
\r
604 3. For each copy, look up the call number for that copy (<literal>call_number</literal>
\r
605 field, linked to the <literal>acn</literal> class).</simpara>
\r
606 <simpara>However, this would result in potentially hundreds of round-trip
\r
607 queries from the client to the server. Even with low-latency connections,
\r
608 the network overhead would be considerable. So, built into the <literal>open-ils.cstore</literal> and
\r
609 <literal>open-ils.pcrud</literal> access methods is the ability to <emphasis>flesh</emphasis> linked fields -
\r
610 that is, rather than return an identifier to a given linked field,
\r
611 the method can return the entire object as part of the initial response.</simpara>
\r
612 <simpara>Most of the interfaces that return class instances from the IDL offer the
\r
613 ability to flesh returned fields. For example, the
\r
614 <literal>open-ils.cstore.direct.\*.retrieve</literal> methods allow you to specify a
\r
615 JSON structure defining the fields you wish to flesh in the returned object.</simpara>
\r
616 <formalpara><title>Fleshing fields in objects returned by <literal>open-ils.cstore</literal></title><para>
\r
617 <programlisting language="sh" linenumbering="unnumbered">srfsh# request open-ils.cstore open-ils.cstore.direct.asset.copy.retrieve 1, \
\r
619 "flesh": 1, <co id="dmCO8-1"/>
\r
620 "flesh_fields": { <co id="dmCO8-2"/>
\r
621 "acp": ["location"]
\r
624 </para></formalpara>
\r
626 <callout arearefs="dmCO8-1">
\r
628 The <literal>flesh</literal> argument is the depth at which objects should be fleshed.
\r
629 For example, to flesh out a field that links to another object that includes
\r
630 a field that links to another object, you would specify a depth of 2.
\r
633 <callout arearefs="dmCO8-2">
\r
635 The <literal>flesh_fields</literal> argument contains a list of objects with the fields
\r
636 to flesh for each object.
\r
640 <simpara>Let’s flesh things a little deeper. In addition to the copy location,
\r
641 let’s also flesh the call number attached to the copy, and then flesh
\r
642 the bibliographic record attached to the call number.</simpara>
\r
643 <formalpara><title>Fleshing fields in fields of objects returned by <literal>open-ils.cstore</literal></title><para>
\r
644 <programlisting language="java" linenumbering="unnumbered">request open-ils.cstore open-ils.cstore.direct.asset.copy.retrieve 1, \
\r
648 "acp": ["location", "call_number"],
\r
652 </para></formalpara>
\r
655 <section id="_adding_an_idl_entry_for_resolverresolver">
\r
656 <title>Adding an IDL entry for ResolverResolver</title>
\r
657 <simpara>Most OpenSRF methods in Evergreen define their object interface in the
\r
658 IDL. Without an entry in the IDL, the prospective caller of a given
\r
659 method is forced to either call the method and inspect the returned
\r
660 contents, or read the source to work out the structure of the JSON
\r
661 payload. At this stage of the tutorial, we have not defined an entry
\r
662 in the IDL to represent the object returned by the
\r
663 <literal>open-ils.resolver.resolve_holdings</literal> method. It is time to complete
\r
664 that task.</simpara>
\r
665 <simpara>The <literal>open-ils.resolver</literal> service is unlike many of the other classes
\r
666 defined in the IDL because its data is not stored in the Evergreen
\r
667 database. Instead, the data is requested from an external Web service
\r
668 and only temporarily cached in <literal>memcached</literal>. Fortunately, the IDL
\r
669 enables us to represent this kind of class by setting the
\r
670 <literal>oils_persist:virtual</literal> class attribute to <literal>true</literal>.</simpara>
\r
671 <simpara>So, let’s add an entry to the IDL for the <literal>open-ils.resolver.resolve_holdings</literal>
\r
673 <programlisting language="xml" linenumbering="unnumbered"></programlisting>
\r
674 <simpara>And let’s make <literal>ResolverResolver.pm</literal> return an array composed of our new
\r
675 <literal>rhr</literal> classes rather than raw JSON objects:</simpara>
\r
676 <programlisting language="perl" linenumbering="unnumbered"></programlisting>
\r
677 <simpara>Once we add the new entry to the IDL and copy the revised <literal>ResolverResolver.pm</literal>
\r
678 Perl module to <literal>/openils/lib/perl5/OpenILS/Application/</literal>, we need to:</simpara>
\r
679 <orderedlist numeration="arabic">
\r
682 Copy the updated IDL to both the <literal>/openils/conf/</literal> and
\r
683 <literal>/openils/var/web/reports/</literal> directories. The Dojo approach to
\r
684 parsing the IDL uses the IDL stored in the reports directory.
\r
689 Restart the Perl services to make the new IDL visible to the services
\r
690 and refresh the <literal>open-ils.resolver</literal> implementation
\r
695 Rerun <literal>/openils/bin/autogen.sh</literal> to regenerate the JavaScript versions
\r
696 of the IDL required by the HTTP translator and gateway.
\r
700 <simpara>We also need to adjust our JavaScript client to use the nifty new
\r
701 objects that <literal>open-ils.resolver.resolve_holdings</literal> now returns.
\r
702 The best approach is to use the support in Evergreen’s Dojo extensions
\r
703 to generate the JavaScript classes directly from the IDL XML file.</simpara>
\r
704 <formalpara><title>Accessing classes defined in the IDL via Fieldmapper</title><para>
\r
705 <programlisting language="html" linenumbering="unnumbered"></programlisting>
\r
706 </para></formalpara>
\r
708 <callout arearefs="">
\r
710 Load the Dojo core.
\r
713 <callout arearefs="">
\r
715 <literal>fieldmapper.AutoIDL</literal> reads <literal>/openils/var/reports/fm_IDL.xml</literal> to
\r
716 generate a list of class properties.
\r
719 <callout arearefs="">
\r
721 <literal>fieldmapper.dojoData</literal> seems to provide a store for Evergreen data
\r
725 <callout arearefs="">
\r
727 <literal>fieldmapper.Fieldmapper</literal> converts the list of class properties into
\r
731 <callout arearefs="">
\r
733 <literal>fieldmapper.standardRequest</literal> invokes an OpenSRF method and returns
\r
734 an array of objects.
\r
737 <callout arearefs="">
\r
739 The first argument to <literal>fieldmapper.standardRequest</literal> is an array
\r
740 containing the OpenSRF service name and method name.
\r
743 <callout arearefs="">
\r
745 The second argument to <literal>fieldmapper.standardRequest</literal> is an array
\r
746 containing the arguments to pass to the OpenSRF method.
\r
749 <callout arearefs="">
\r
751 As Fieldmapper has instantiated the returned objects based on their
\r
752 class hints, we can invoke getter/setter methods on the objects.
\r
757 <section id="dm_attribution">
\r
758 <simpara>This chapter was taken from Dan Scott's <emphasis>Developer Workshop</emphasis>, February 2010.</simpara>
\r