wiki:OGCEIntegration

Ultrascan-OGCE Bridge Clients Information

Submit Job

Used to submit job to resource using GFAC. This service needs a xml message with job parameters and header data to submit job to compute resource (queenbee, lonestar or Ranger)

Registered resources are

gatekeeper.ranger.tacc.teragrid.org
queenbee.loni-lsu.teragrid.org
lonestar.tacc.teragrid.org
bcf.biochemistry.uthscsa.edu
alamo.biochemistry.uthscsa.edu

Service URL :

http://gf5.ucs.indiana.edu:8080/ogce-rest/job/runjob/async

Sample XML :

<?xml version="1.0" encoding="UTF-8"?>
<Message>
  <Header>
        <hostname>queenbee.loni-lsu.teragrid.org</hostname>
        <processorcount>16</processorcount>
         <hostcount>36</hostcount>
        <queuename>workq</queuename>
        <walltime>60</walltime>
        <userdn>/C=US/O=National Center for Supercomputing Applications/CN=Ultrascan3 Community User</userdn>
  </Header>
    <Body>
        <Method>US3_Run</Method>
        <input>
        </input>
    </Body>
</Message>

All these parameters are set by Ultrascan client call. Parameters like processercount, queuename and walltime are optional. GFAC have default value for optional parameter.

This service returns you a xml message with experimentid in following format

<?xml version="1.0" encoding="UTF-8"?>
<MessageResponse>
    <experimentid>US3-Experiment-1c15651c-d872-4234-a561-f58df81fb542</experimentid>
</MessageResponse>

Job Status

To get status of current experiment. You need to create following url with experimentid which was returned from Submit job service.

Service URL :

http://gf5.ucs.indiana.edu:8080/ogce-rest/job/jobstatus/$experimentid

Service will return xml message with status of current job status on compute resource. Response format is

<?xml version="1.0" encoding="UTF-8"?>
<MessageResponse>
    <status>COMPLETED</status>
    <message>Job working folders etc</message>
</MessageResponse>

Other status are : SUBMITTED|INITIALIZED|PENDING|ACTIVE|COMPLETED|CANCELED|FAILED|DONE (if process is completed but waiting on data)|UNKNOWN(if job id does not exit in job database)

Cancel Job

To cancel running or queued jobs from compute resource. Pass experimentID from Submit Job service.

Service URL :

http://gf5.ucs.indiana.edu:8080/ogce-rest/job/canceljob/$experimentid

Service will return call status. It can either be Success or Already Canceled in following xml format

<?xml version="1.0" encoding="UTF-8"?>
<MessageResponse>
    <status>Success</status>
</MessageResponse>

Other status are: CANCELED | NOTALLOWED(if already canceled or completed) | UNKNOWN(if job id does not exit in job database)

Status Set

GFAC is still listening to a job as GRAM have not reported finished status but US3 LIMS UDP message got a confirmation that job is done. You can use this service to tell GFAC that don't wait for GRAM and start getting the outputs. This will only work on Jobs with Status PENDING|ACTIVE|INITIALIZED|SUBMITTED

Service URL :

http://gf5.ucs.indiana.edu:8080/ogce-rest/job/setstatus/$experimentid

Service will return call status. It can either return SUBMITTED|ALREADY_SUBMITTED|NOTALLOWED

<?xml version="1.0" encoding="UTF-8"?>
<MessageResponse>
  <status>SUBMITTED</status>
<message>GFAC can take upto 5 min to cleanup the job</message>
</MessageResponse>

NOTE: This service will not cancel the running job. Use cancel service to cancel the job.

Register Outputs

This service can be used to request the data output from the job. First, it will look for local outputs, but if they are not there it will get those outputs from compute resource and register with DB. Applicable if the job status is DONE|FAILED|COMPLETE.

Service URL :

http://gf5.ucs.indiana.edu:8080/ogce-rest/job/registeroutput/$experimentid

Service will return SUCCESS. It can either return SUCCESS:ERROR.

<?xml version="1.0" encoding="UTF-8"?>
<MessageResponse>
  <status>SUCCESS</status>
  <message>Register the data to LIMS DB</message>
</MessageResponse>

In case of ERROR message will display the error.

<?xml version="1.0" encoding="UTF-8"?>
<MessageResponse>
  <status>ERROR</status>
  <message>Server refused performing the request. Custom message:  (error code 1) [Nested exception message:  Custom message: Unexpected reply: 500-Command failed. : globus_l_gfs_file_open failed.
500-globus_xio: Unable to open file ///work//us3_application_Sat_Nov_19_15_20_19_EST_2011_3ac1cab8-2c65-45ca-9b09-6a3d09388aed/us3_application.stdout
500-globus_xio: System error in open: No such file or directory
500-globus_xio: A system call failed: No such file or directory
500 End.]</message>
</MessageResponse>

Resource Status Service

This URL provides resource status for XSEDE resources. The resourceStatus tag provides the status. Possible values are UP, DOWN, WARN, and FAILED. WARN means that the resource maintenance is coming up in next 12 hours. Some of the tests run only every 8 to 10 hours, and usually run at 4AM. Machine goes for maintenance at 8AM.

Service URL:

http://community.ucs.indiana.edu:19444/orps-service/XML/gateway/ultrascan

Services Code

SVN location of this code is

https://ogce.svn.sourceforge.net/svnroot/ogce/gateway-staging/ultrascan/US3RestServices/

OGCE Service monitoring and restart

Last modified 7 years ago Last modified on Dec 2, 2011 8:54:10 PM