[MOBY-guts] biomoby commit

Wed Feb 7 01:10:22 UTC 2007

mwilkinson
Tue Feb  6 20:10:22 EST 2007
Update of /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl
In directory dev.open-bio.org:/tmp/cvs-serv19891/MOBY-S_API/Perl

Modified Files:
	ConstructingYourService.html RegisterServiceInstance.html 
Added Files:
	DiscoverService.html 
Log Message:
adding and fixing the Perl library documentation
moby-live/Docs/MOBY-S_API/Perl DiscoverService.html,NONE,1.1 ConstructingYourService.html,1.20,1.21 RegisterServiceInstance.html,1.4,1.5
===================================================================
RCS file: /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl/ConstructingYourService.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21

--- /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl/ConstructingYourService.html	2006/06/23 15:16:01	1.20
+++ /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl/ConstructingYourService.html	2007/02/07 01:10:22	1.21
@@ -158,6 +158,8 @@
 <li> The "handle" method starts the script listening.
 </li>
 
+<li> To deploy the dispatcher, simply put it in your cgi-bin folder of your webserver.</li>
+
 </ol>
 
 <h2><a name="GenericExample">The service module</a></h2> 

===================================================================
RCS file: /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl/RegisterServiceInstance.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl/RegisterServiceInstance.html	2006/06/02 08:21:34	1.4
+++ /home/repository/moby/moby-live/Docs/MOBY-S_API/Perl/RegisterServiceInstance.html	2007/02/07 01:10:22	1.5
@@ -63,8 +63,8 @@
 <body>
 <h2><a name ="Registering_your_service"> Registering your service </a></h2>
 <div class="entrytext">
-To register the service getGoTerm service that you created at the end
-of <a href="ConstructingYourService.html">ConstructingYourService</a>
+To register the service <b>getGoTerm</b> that you created at the end
+of <a href="ConstructingYourService.html">Constructing Your Service</a>
 you would use the following code: <p />
 
 <table>
@@ -73,6 +73,36 @@
 use MOBY::Client::Central;
 my $m = MOBY::Client::Central->new;
 
+#NOTE: the service Name MUST be identical to the name you
+# called it in the <a href="ConstructingYourService.html#Dispatcher">Dispatcher</a>
+# and identical to the name of the subroutine itself.
+my $serviceName = "getGoTerm";
+
+
+# this is a term taken from the <a href='http://mobycentral.icapture.ubc.ca:8090/types/Services'>MOBY Service Ontology</a>
+# that most closely reflects the nature of what your service does
+my $serviceType = "Retrieval";
+
+
+# this is a unique string in the form nnn.nnn.nnn that
+# identifies you as a particular service provider.  Your
+# domain name (excluding http://) is most useful
+my $authURI = "mydomain.mycompany.org";
+
+
+# this is the URL where your <a href="ConstructingYourService.html#Dispatcher">Dispatcher</a> is located
+my $URL = "http://mydomain.mycompany.org/cgi-bin/MOBY/Dispatcher.cgi";
+
+
+# finally, you want to make a nice human-readable description for
+# your service.  This should include things like what organism your
+# database provides information about, or what data or algorithm you
+# use.  Things that might help people find you based on a keyword search
+my $description = "This service consumes GO ID's and returns GO Terms and definitions";
+
+
+# now start constructing the descriptions of your inputs and outputs:
+
 my @input_namespaces = ('GO');  
 # a list of valid input namespaces
 my @input_simples = ('Object', \@input_namespaces); 
@@ -96,7 +126,7 @@
      serviceType  => $serviceType,
      authURI      => $authURI,
      contactEmail => "your at mail.address",
-     description => $human_readable_description,
+     description => $description,
      category  =>  "moby" 
      URL    =>  $URL_TO_SERVICE
      input => \@all_inputs,


