The putStandAlone User Command (Meta Macro)

All user commands have the form:

ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }

Which is in the format of a Tcl command, ldasJob, with two required arguments:

1. A Tcl list of user information consisting of username, password, and e-mail address. All fields must be filled or the command will be rejected.
   Client software which would like to receive responses from the LDAS system on a port instead of through email can provide a hostname:port combination as the email argument. A further feature of this method is that the hostname can be replaced with the magic key !host!, and the LDAS system will use the IP address it finds by doing a peername lookup on the connected socket.
2. A user command in the form of a Tcl list, for which there exists a "meta" macro file which can be expanded into Tcl code which can then be evaluated by the LDAS system.
   An argument must be provided to every option field for any given command or the command will be rejected.
   Some option fields will accept a "null" argument consisting of a matching pair of braces "{}" with no interposed space.
   Meta macros consist of a prototype declaration of the arguments for the given user command, and a template describing the calling order of API specific blocks of Tcl code which are concatenated into a larger block comprising the complete request, which can then be distributed by the assistant manager for interpretation by the low level API's.
   These API specific blocks are maintained as API specific macro files consisting of immediately interpretable Tcl code.

• putStandAlone

• putStandAlone

  The putStandAlone user command is the "back end" of the dataStandAlone user command. Wrapper API output data from a dataStandAlone command is read from disk and passed to the eventmon API for ingestion into the database tables.

  Calling convention (all on a single line):

  ldasJob   { -name   "username"   -password   "********"   -email   "user@foobar.edu"}   {putStandAlone   -wrapperdata   URL  -returnprotocol   URL  -metadataapi   URL  -database   dsname   -outputformat   {ilwd ascii | ilwd binary | LIGO_LW }  -subject   {freeform string}  }

  Option Descriptions:

  -wrapperdata:     http ftp file

  The argument of the -wrapperdata option URL format is of the format similar to that of -returnprotocol. The URL specifies the source of of the data to be ingested in ilwd format: it can be files, or directory containing wrapper files. The URL must be valid for the command to be successfully executed.
  • http://filename.ext

  • ftp://filename.ext

  • file:/filename.ext

    NOTES:

    1. Embedded spaces in the argument to the -wrapperdata option will cause the request to fail.

  -metadataapi:     api

  • Optional
    

    Default: metadata The metadata results will be inserted into the database.

    If 'ligolw' is specified e.g. -metadataapi ligolw, and the -returnprotocol specifies a url, the metadata results will be output in the form of xml rather than being inserted into the database i.e. running at a site that does not have a database.

    If 'tee' option is specified, e.g. -metadataapi tee, and the -returnprotocol specifies a url the metadata results will be output both as an xml and also be inserted into the database.

  -database:     dsnamestring

  The argument of -database option is a valid database dataset name for the site that the command applies e.g. dev_1 and dev_test are dataset names for site ldas-dev, lho_1 and lho_test are dataset names for site ldas-wa etc. For dsnames of sites, please visit the LDAS database link on each ldas site web page. If this option is not specified, insertion is done from the default database.

  -subject:  {subject for the return e-mail}

  Default: "jobID completed"
  String to be used as the subject for the e-mail returned by the system on completion of the job.

  Examples of putStandAlone commands:

  Examples on how to use this command

  This example presents a Tcl script which can be run from any computer with a network connection to submit a user command to the LDAS system:

  #!/bin/sh
  # use -*-Tcl-*- \
  exec tclsh "$0" "$@"
  
  # convenient formatted command definition
  # database insertion from wrapper files
  set cmd "ldasJob
     { -name foo -password **** -email foo@foobar.edu }
     {
        putStandAlone
           # subject to be used when e-mailing user
           -subject {test script for putStandAlone}
           
           # input url for converting 
           -wrappperdata file:/ldas_outgoing/jobs/globus_files/NORMAL1548
           
           # ilwd format for output ilwd (optional) 
           -outputformat {ilwd ascii}
           	
          # database if not default
          -database ldas_tst     
     }"
  
  # strip comments and compact cmd into user command format
  set cmd [ split $cmd "\n" ]
  foreach line $cmd {
     set line [ string trim $line ]
     if { [ regexp {^#} $line ] } {
        continue
     }
     lappend tmp $line
  }   
  set cmd [ join $tmp "\n" ]
  regsub -all -- {[\n\s]+} $cmd { } cmd
  
  # connect, issue command, print reply from manager,
  # and disconnect
  set sid [ socket ldas-dev.ligo.caltech.edu 10001 ]
  puts  $sid $cmd
  flush $sid
  puts [ read $sid ]
  close $sid
  

  Which submits this command to the system:
  • ldasJob  {  -name  "foo"  -password  "****"  -email  "foo@foobar.edu" }  { putStandAlone  -subject  {test script for putStandAlone}  -wrappperdata  file:/ldas_outgoing/jobs/globus_files/NORMAL1548  -outputformat  {ilwd ascii}   }

    Example of xml output

    # xml output from wrapper files
    set cmd "ldasJob
       { -name foo -password **** -email foo@foobar.edu }
       {
          putStandAlone
             # subject to be used when e-mailing user
             -subject {test script for putStandAlone}
             
             # input url for converting 
             -wrappperdata file:/ldas_outgoing/jobs/globus_files/NORMAL1548
                    	
    		 -returnprotocol http://results 
    		 
    		 -outputformat {LIGO_LW} 
    		 
    		 -metadataapi { ligolw } 
    		  
       }"
    

    Output will be created by ligolw API in job output directory:

    Your results:
    results.xml
    can be found at:
    http://131.215.115.248/ldas_outgoing/jobs/LDAS-DEV_1049/LDAS-DEV10494929
    

    using the default option for -metadataapi, the response is database insertion:

    Subject: BOX-III98872 tfclu online running on H2:LSC-AS_Q Inserted 
    1 rows into ldas_tst database table process Inserted 14 rows into ldas_tst database 
    table process_params Inserted 1330 rows into ldas_tst database table sngl_burst 
    Inserted 1 rows into ldas_tst database table search_summary
    

    If '-metadataapi tee' option is used, the response is both xml and database output:

    Subject: BOX-III98809 tfclu online running on H2:LSC-AS_Q Inserted 1 rows into ldas_tst database 
    table process Inserted 14 rows into ldas_tst database table process_params 
    Inserted 1330 rows into ldas_tst database table sngl_burst Inserted 1 rows into ldas_tst database 
    table search_summary Your results: tfclusters_result.xml can be found 
    at: http://131.215.114.23/ldas_outgoing/jobs/BOX-III_9/BOX-III98809
    

    Return to Top