[[TOC(Software/bAM/*, depth=2)]]

== Result Aggregate Manager ==

The Result aggregate manager service group provides experimenter access to ML server databases.


''' getSchema '''

{{{
  <service name="getSchema">
    <info>Get the Schema of a given experiment measurement database</info>
    <args>
      <arg value="ExperimentID" name="expID" isRequired="true">
        <info>ID of the Experiment</info>
      </arg>
    </args>
  </service>
}}}

''' listTables '''

Service that lists tables in the experiment with given experiment ID.


{{{
  <service name="listTables">
    <info>Get the list of tables in given experiment measurement database</info>
    <args>
      <arg value="ExperimentID" name="expID" isRequired="true">
        <info>ID of the Experiment</info>
      </arg>
    </args>
}}}

''' querryDatabase '''

{{{    
  <service><service name="queryDatabase">
    <info>Get the Schema of a given experiment measurement database</info>
    <args>
      <arg value="ExperimentID" name="expID" isRequired="true">
        <info>ID of the Experiment</info>
      </arg>
      <arg value="xml | json" name="format" isRequired="true">
        <info>Format to return result in.</info>
      </arg>
      <arg value="SQLquery" name="query" isRequired="true">
        <info>An SQLite query to run against the database</info>
      </arg>
    </args>
  </service>
}}}

''' dumpDatabase '''
{{{
  <service name="dumpDatabase"><info>Dump the complete database holding the measurement results for a given experiment</info>        
    <args>
      <arg value="ExperimentID" name="expID" isRequired="true">
        <info>ID of the Experiment</info>
      </arg>
    </args>
  </service>
}}}

----

''' Notes '''

The result service lives on the console of the domain you are running an experiment on. This console can be directly queried for experiment results. The data sets the results service provides must to be specified via OEDL ruby language extension in the experiment script. More information on OEDL can be found [http://omf.mytestbed.net/projects/omf6/wiki/OEDLOMF6 here]

----

''' Installation and Configuration '''

The Result service is packaged in the ''omf-aggmgr-result-5.4'' package. It can be installed form the package repository with

{{{
apt-get install omf-aggmgr-result-5.4
}}}

Instructions on how to add the Orbit software repository to your list of apt-sources can be found ​here.

Once installed the service is configured by TODO.