Differences

This shows you the differences between two versions of the page.

Link to this comparison view

soloistconfiguration [2011/06/29 15:03]
milorad.poptosic [Other Features] 		soloistconfiguration [2011/07/03 23:25] (current)
milorad.poptosic [Model files]
Line 1: Line 1:
 ====== soloist-config.xml ====== ====== soloist-config.xml ======
 soloist-config.xml represents the basic file for [[configuration|SOLoist project configuration]]. This file is used for configuring the most important aspects of the framework, such as: referenced database, model files, path to file repository etc. soloist-config.xml represents the basic file for [[configuration|SOLoist project configuration]]. This file is used for configuring the most important aspects of the framework, such as: referenced database, model files, path to file repository etc.
 +
 +The easiest way to edit this file is from an IDE (such as Eclipse) with autocomplete.
 +
 ===== Referenced Database ===== ===== Referenced Database =====
 RDBMS (Relational Database Management System) to be used in project is configured by way of an rdmbs tag. The tag contains an attribute dbPropFile which specifies the database configuration file with all the details about the database (in is named db.properties by default). For more details on how to write this file, see [[DatabaseConfiguration|Database Configuration]].  RDBMS (Relational Database Management System) to be used in project is configured by way of an rdmbs tag. The tag contains an attribute dbPropFile which specifies the database configuration file with all the details about the database (in is named db.properties by default). For more details on how to write this file, see [[DatabaseConfiguration|Database Configuration]]. 
Line 8: Line 11:
  <rdbms dbPropFile="mysql_db.properties">mysql</rdbms>  <rdbms dbPropFile="mysql_db.properties">mysql</rdbms>
 </file> </file>
 +
 ===== Model files ===== ===== Model files =====
 As model-driven development framework, SOLoist needs to reference one or more files containing the domain model. These models are written in [[http://en.wikipedia.org/wiki/XML_Metadata_Interchange|XMI (XML Metadata Interchange)]] files, which are generated by the modeling tool (currently StarUML).  As model-driven development framework, SOLoist needs to reference one or more files containing the domain model. These models are written in [[http://en.wikipedia.org/wiki/XML_Metadata_Interchange|XMI (XML Metadata Interchange)]] files, which are generated by the modeling tool (currently StarUML). 
-These XMI files sholud be configured with model-files tag.+These XMI files should be configured with model-files tag.
 <file xml> <file xml>
  <model-files>  <model-files>
 +                <xmi-file>soloist.xmi</xmi-file>
  <xmi-file>domainmodel.xmi</xmi-file>  <xmi-file>domainmodel.xmi</xmi-file>
  </model-files>  </model-files>
 </file> </file>
 +The path to the XMI file is resolved against file-system first, then against Java's classpath.
 ===== File Repository ===== ===== File Repository =====
-SOLoist stores files created and uploaded to the application inside a directory which is called the file repository. It is necessary to configure an absolute path to this directory. +SOLoist stores instances of the data-type File inside a directory which is called the file repository. It is necessary to configure an absolute path to this directory. 
 To do so, you should use the file-repository tag, as in the examples below. To do so, you should use the file-repository tag, as in the examples below.
  
Line 28: Line 34:
  <file-repository>/home/user/soloist/repository</file-repository>  <file-repository>/home/user/soloist/repository</file-repository>
 </file> </file>
-The file repository can be any directory, so long as it is empty. 
 ===== Internationalization and Localization ===== ===== Internationalization and Localization =====
 SOLoist has a full support for [[internationalizationandlocalization|internationalization and localization]] which means supporting multiple languages. The default-locale tag sholud be used for setting the default locale for SOLoist applications. SOLoist has a full support for [[internationalizationandlocalization|internationalization and localization]] which means supporting multiple languages. The default-locale tag sholud be used for setting the default locale for SOLoist applications.
Line 49: Line 54:
 The cacheAppInfo tag is used to optimize loading of SOLoist application in browser. It is set to true by default, and it is recommended not to change it. The cacheAppInfo tag is used to optimize loading of SOLoist application in browser. It is set to true by default, and it is recommended not to change it.
  
-The cacheLazyPanel tag is used for configuring whether lazy panels components will be cached or not. In development it is recommended to set it to false, but for production it should be set to true.+The cacheLazyPanel tag is used for configuring whether lazy panels components will be cached or not. During development, it is recommended to set it to false, but for production it should be set to true.
  
 <file xml> <file xml>
Line 55: Line 60:
  <cacheLazyPanel>false</cacheLazyPanel>  <cacheLazyPanel>false</cacheLazyPanel>
 </file> </file>
 +
 +===== Complete soloist-config.xml Example  =====
 +Below is the complete soloist-config.xml from the Empty Project.
 +
 +<file xml soloist-config.xml>
 +<?xml version="1.0"?>
 +<soloist-config>
 +
 +        <file-repository>d:/temp/repository</file-repository>
 +        
 + <model-files>
 + <xmi-file>emptyproject.xmi</xmi-file>
 + </model-files>
 +
 + <use-shared-cache>true</use-shared-cache>
 +
 + <notifications excludeSlotsForNewInstances="true"
 + visitContexts="true">
 + <excluded-class>rs::sol::SOLoist::server::BuiltInDomains::Commands::Command
 + </excluded-class>
 + <excluded-class>rs::sol::SOLoist::server::BuiltInDomains::Common::ElementDescriptor
 + </excluded-class>
 + </notifications>
 +
 + <resource-bundles>
 + <bundle name="SoloistClient" client="true" />
 + <bundle name="SoloistServer" />
 + <bundle name="emptyproject" default="true" />
 + </resource-bundles>
 +
 + <default-locale>en</default-locale>
 +
 + <readGUIFromCache>true</readGUIFromCache>
 +
 + <cacheAppInfos>true</cacheAppInfos>
 + <cacheLazyPanel>false</cacheLazyPanel>
 +
 + <maxFileSize>5120</maxFileSize>
 +
 +</soloist-config>
 +</file> 

Trace:

Print/export