[[user-comments:mozilla-devel:staff_client_source_code|User Comments]]

===== To Do =====

Currently, a rewrite is happening here: **/ILS/Open-ILS/xul/staff_client/** ([[http://svn.open-ils.org/trac/ILS/browser/trunk/Open-ILS/xul/staff_client|SVN]]).

If you have feedback, advice, code, etc., then please join our mailing lists ([[http://evergreen-ils.org/listserv.html|evergreen-ils.org]])!  Or alternatively, mail us at [[feedback@evergreen-ils.org]]

My current to-do list is here: [[scratchpad::staff_client_todo]]

===== Inside the staff client (for Developers and Admins) =====

  - [[mozilla-devel:introduction_and_technology]]
  - [[mozilla-devel:building_the_staff_client]]
  - [[mozilla-devel:a_walk-through_of_the_source_code]]


===== Scratch Pad =====
  * [[scratchpad:multiple_registrations_hack_with_hosts_file|Multiple Workstation Registrations Hack with Hosts File]]
  * [[scratchpad:packaging_the_staff_client_for_windows|Packaging the staff client for Windows]]
  * [[scratchpad:debug_console|Debug console for staff client]]
  * [[scratchpad:pinging|Ping testing the server]]
  * [[scratchpad:console_clipboard|Copying from the debug console or a command window in Windows]]
  * To build and run a versionless staff client in Linux, in /ILS/Open-ILS/xul/staff_client/:<code>rm -rf ~/.pines/ && make STAFF_CLIENT_BUILD_ID='' && cd build/ && /some/path/xulrunner application.ini ; cd ..</code>
  * To build and run a staff client in Linux with a specific build ID, in /ILS/Open-ILS/xul/staff_client/:<code>rm -rf ~/.pines/ && make STAFF_CLIENT_BUILD_ID='SOME_BUILD_ID' && cd build/ && /some/path/xulrunner application.ini ; cd ..</code>
  * [[http://dev.gapines.org/opac/extras/docgen.xsl|auto-generated api documentation]]
  * [[scratchpad:mock_staff_client_portal|Mock Staff Client Portal]]
  * [[scratchpad:sample_script|Sample script for Circ meeting]]
  * [[scratchpad:debugging_checkin|debugging checkin]]
  * [[scratchpad:staff_client_menus|How to add top-level menus to the staff client]]
  * [[staff_client:removing_the_staff_client|Removing the staff client]]
  * [[http://ftp.mozilla.org/pub/mozilla.org/xulrunner/nightly/latest-trunk/|where to get the latest xulrunners]]
  * To tweak a perl module, edit and copy to correct location in /openils/lib/perl5/ (or wherever, depending on install), in our case on weezie or dev: <code>cp -r ILS/Open-ILS/src/perlmods/OpenILS/* /openils/lib/perl5/OpenILS/</code> then as root, do <code>su - opensrf -c '/openils/bin/osrf_ctl.sh -d /tmp/ -p /openils/conf/bootstrap.conf -c /openils/conf/opensrf_core.xml -a restart_perl'</code>
  * To restart the C code, as root do <code>su - opensrf -c '/openils/bin/osrf_ctl.sh -d /tmp/ -p /openils/conf/bootstrap.conf -c /openils/conf/opensrf_core.xml -a restart_c'</code>
  * The config cgi's for dev: http://fw1/cgi-bin/config.cgi
  * To invoke psql on frankenweezie1 <code>PGUSER=postgres /opt/pg811/bin/psql -p 5433 develooper</code>
  * To invoke oilsrequestor on dev <code>oils_requestor -f ~/.srfsh.xml -i fm_IDL.xml -c srfsh -u staff1 -p staff1</code>
  * From generate_fines.srfsh: <code>open-ils.storage.action.circulation.overdue.generate_fines 1</code>

  * Listing barcodes for open copy transits via sql: <code sql> select b.barcode, c.shortname, a.* from action.transit_copy as a, asset.copy as b, actor.org_unit as c where a.target_copy = b.id and c.id = a.dest and dest_recv_time is null;</code>
  * Listing patron's and barcodes for open circulations via sql: <code sql>select c.usrname, b.barcode, a.id from "action".circulation as a, asset.copy as b, actor.usr as c where a.usr = c.id and a.target_copy = b.id and xact_finish is null;</code>
  * List holds ready for pickup:<code sql>select u.usrname, c.barcode, h.id from action.hold_request as h, asset.copy as c, actor.usr as u where h.current_copy = c.id and h.usr = u.id and h.fulfillment_time is null;</code>
  * List permission groups having a specific permission via sql:<code sql>select t.name from permission.grp_tree as t where t.id in ( select grp from permission.grp_perm_map where perm = (select id from permission.perm_list where code = 'COPY_IS_REFERENCE.override') );</code>
  * List permissions for a specific permission group via sql:<code sql>select code, depth, grantable, a.description from permission.grp_perm_map as c, permission.perm_list as a, permission.grp_tree as b where grp = b.id and perm = a.id and b.name = 'Circ1';</code>

  * How to update just the xul on a brick in production:<code>~/evergreen.sh -a detach_brick
~/evergreen.sh -a update_cvs
~/evergreen.sh -a build_xul -x <NEW_XUL_DIR>
~/evergreen.sh -a attach_brick</code>

  * How to update the whole shebang on a brick in production:<code>
cd /root/scripts/ ; ./evergreen_all.sh -u -x <NEW_XUL_DIR>
</code>

  * New ways to update production:<code>
Fetch a bundle as opensrf:
./evergreen.sh -u http://open-ils.org/downloads/ -f Evergreen-ILS-1.0.2.2.tar.gz -a fetch

Full update as root:
./evergreen_all.sh -u http://open-ils.org/downloads/ -f Evergreen-ILS-1.0.2.2.tar.gz
</code>

  * To start clark kent (reporting) on fw3 (db03):<code>
su postgres -c 'PERL5LIB=/openils/lib/perl5/ /openils/bin/clark-kent.pl -c 4 -d'
</code>

  * An example of rolling back the XUL on a brick:<code>
su - opensrf -c 'cd /openils/var/web/xul/ ; ls -l sc_v100_rc2 ; rm sc_v100_rc2 ; ln -s sc_v100_rc2-50 sc_v100_rc2 ; ls -l sc_v100_rc2'
</code>

  * Using autogen to update static files:<code>su opensrf -c "cd /openils/bin/ && ./autogen.sh ../conf/bootstrap.conf"</code>

  * evergreen.sh is for bricks, osrf_ctl.sh is for a single box

  * in srfsh, to see applications/services registered with the router, enter: <code>request router opensrf.router.info.class.list</code>



**Viewing Reports via web browser**

  * In command line go to where you have the srf shell configured and type in srfsh. <code>user@computer:~$ srfsh</code>
  * Login to it: <code>srfsh# login admin open-ils</code>
  * If you had a successful login you will see something like this:<code>
Received Data: {
	"ilsevent":0,
	"textcode":"SUCCESS",
	"desc":" ",
	"pid":28132,
	"stacktrace":"oils_auth.c:312",
	"payload":{
		"authtoken":"4d2e586236332400795c8d26d95907fd",
		"authtime":420.000000
	}  
}
</code>
  * Keep the terminal open and go to a browser (with OpenSRF and Evergreen running) and go to: <code>localhost/reports/</code>

  * Click on the oils_report.xhtml link. You should see "You are logged in as" and "Loading..."
  * In the address bar you see "https://localhost/reports/oils_rpt.xhtml" add the following onto it <code>?ses=</code>
  * And after the equals sign paste in the "authtoken" that you got from logging in with the srf shell (which should still be open)<code> https://localhost/reports/oils_rpt.xhtml?ses=4d2e586236332400795c8d26d95907fd</code>
  * You should now be able to see the reports pages and use the interface