Last modified 2 months ago Last modified on 24/11/11 13:15:59

WebappConfig > Webconfig-model.xml

This file configures aspects of how data appears on the InterMine webapp.

NB: This file allows for inheritance - a subclass will inherit the 'long displayers' from its parent class, but only if that subclass has no long displayers set. Configuration settings for the parent class do not overwrite settings for the subclass.

See: FlyMine's webconfig-model.xml, MalariaMine's webconfig-model.xml

Field Configuration

You can configure which fields are displayed on report and result pages for each class in your model.

attribute namepurposerequired?default
fieldExprfield nameyes-
labelhuman readable namenogenerated automagically
showInInlineCollectionshow field in inline collectionnotrue
showInSummaryadd field to query when user clicks on 'Summary' button in QueryBuildernotrue
showInResultsshow field in results tablenotrue
doNotTruncatedon't truncate displaynofalse
fieldExporterspecify class to export file fieldno-
sectionOnRightshow on the right side of the pagenofalse
sectionTitleif sectionOnRight="true", title for section on rightno-
openByDefaultif sectionOnRight="true", whether or not this section should be opennofalse

For example:

	  <class className="org.flymine.model.genomic.Protein">
 	    <fields>
 	      <fieldconfig fieldExpr="primaryIdentifier"/>
 	      <fieldconfig fieldExpr="primaryAccession"/>
 	      <fieldconfig fieldExpr="organism.name"/>
 	      <fieldconfig fieldExpr="length" displayer="/model/sequenceShortDisplayerWithField.jsp" />
 	    </fields>
 	    <longdisplayers>
 	     <!-- attribute links can now be displayed on protein report pages -->
 	     <displayer src="attributeLinkDisplayer.tile"/>
 	    </longdisplayers>
 	    <bagdisplayers>
 	     <!-- attribute links can now be displayed on protein list analysis pages -->
 	     <displayer src="attributeLinkDisplayer.tile"/>
 	    </bagdisplayers>
 	  </class>

Displaying Data on Report pages

ReportDisplayers allow custom display of particular data types on report pages, typically to replace default tables with more appropriate presentation of data.

    <reportdisplayer javaClass="org.intermine.bio.web.displayer.CytoscapeNetworkDisplayer"
                     jspName="model/cytoscapeNetworkDisplayer.jsp"
                     replacesFields="interactions"
                     placement="Interactions"

See: ReportDisplayers

Export Configuration

Users can export data from InterMine in comma or tab-delimited files and in MS Excel format. InterMine also allows for the addition of custom exporters. To add a custom exporter, create a Java class to format the data and add an entry to the web config file, for example:

  <tableExportConfig id="sequenceExporter" actionPath="/exportAction?type=sequenceExporter"
                     className="org.intermine.bio.web.export.SequenceHttpExporter"/>
  <tableExportConfig id="gff3Exporter" actionPath="/exportAction?type=gff3Exporter"
                     className="org.intermine.bio.web.export.GFF3HttpExporter"/>

Widget Configuration

At the bottom of the config file are the configuration entries for widgets. Please see Widgets for detailed information about how to configure widgets.

      <enrichmentwidgetdisplayer id="protein_features" title="UniProt Features"
                                 link="org.intermine.bio.web.widget.UniProtFeaturesURLQuery"
                                 dataSetLoader="org.intermine.bio.web.widget.UniProtFeaturesLdr"
                                 label="Feature"
                                 description="UniProt features enriched for proteins in this list."
                                 filters=""
                                 filterLabel=""
                                 typeClass="org.flymine.model.genomic.Protein"
                                 max="0.10"  />

See: Widgets


Back: WebappConfig