![]() |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Application InstallationGetting StartedRBT is a Java EE web application requiring a a web container running Java SE 6 update 5 or higher and Java EE 5 or higher. The installer must have a working knowledge of J2EE deployment descriptors and be able to edit the web.xml of a J2EE web application. To begin the installation, download rbt-1.3.1.zip from the web site and unzip the contents into a work directory - zip file contents are shown below:
Prior to installing RBT you must create the security database objects. In the examples directory you will find the following scripts for creating the database tables: RBT has been tested on on the databases shown above. The scripts can be run to create the required database objects. For databases not in the list, use one of the scripts as an example. RBT should work with any SQL 92 compliant database that has a JDBC 4.0 type 4 driver. XML Configuration File PathRBT configuration is defined in an xml configuration file. RBT configuration file location must be specified with a context parameter entry in the web.xml as shown below: <context-param> <param-name>rbt.configuration.file.path</param-name> <param-value>[your config file directory]/[your config file name].xml</param-value> </context-param> <context-param> <param-name>rbt.configuration.file.path</param-name> <param-value>c:/rbt/configuration/rbt.config.xml</param-value> </context-param> XML Configuration File ExampleAll configurable RBT application parameters are found in the RBT configuration xml file defined by schema: ![]() The individual elements in the configuration file are described in the following sections. An example configuration file is shown below: <?xml version="1.0" encoding="UTF-8"?> <RbtConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://xml.rbt.rbtdata.org/schemas"> <!-- the implementation of the SecurityInterface that provides authentication and access control for RBT applications. If you create your own implementation of SecurityInterface put the class name here --> <securityInterfaceClass>org.rbtdata.rbt.security.JdbcSecurity</securityInterfaceClass> <!-- specifies how deep the RBT application will recursively follow the parent/child table relationships when building the relationship tree--> <maxRecursionDepth>5</maxRecursionDepth> <!-- default font size which will act as base size for all fonts --> <defaultFontSize>10pt</defaultFontSize> <!-- default font to use if no font specuified --> <defaultFontName>Times New Roman</defaultFontName> <!-- default font family to use if no font/font family specified--> <defaultFontFamily>Arial,Helvetica,sans-serif</defaultFontFamily> <!-- default time format for query results if no time mask specified--> <defaultTimeFormat>HH:mm</defaultTimeFormat> <!-- default date format for query results if no date mask specified--> <defaultDateFormat>yyyy-MM-dd</defaultDateFormat> <!-- default timestamp format for query results if no timestamp mask specified--> <defaultTimestampFormat>yyyy-MM-dd HH:mm:ss</defaultTimestampFormat> <!-- default floating point format for query results if no number mask specified--> <defaultFloatFormat>######.00</defaultFloatFormat> <!-- default page size when creating a new document --> <defaultPageSize>8.5inX11in</defaultPageSize> <!-- default page orientation when creating a new document --> <defaultPageOrientation>portrait</defaultPageOrientation> <!-- default page margins when creating a new document --> <defaultPageMargins>0.5,0.5,0.5,0.5</defaultPageMargins> <!-- default page measurement unit when creating a new document --> <defaultMeasurementUnit>inches</defaultMeasurementUnit> <!-- image location for images used in the designer. This can be URL or a directory path. All users can see the images in the root. Under the root, folders can be created with group names and the images placed in these folders will only be avaialble to members of the specific group --> <imageRootDirectory>http://localhost:8088/imgserver/rbtimages</imageRootDirectory> <!-- the following rss parameters will be used for the rss xml output channel entries. --> <rssTitle>RBT Document Channel</rssTitle> <rssDescription>RBT RSS Source for Document Output</rssDescription> <rssUrl>http://www.rbtdata.org/rss</rssUrl> <!-- JDBC datasources which are accessible to the RBT applications. There can be only one security datasource and that will contain the RBT security tables. The security database tables should be created with the appropriate db script found in the dbscripts folder--> <datasources> <!-- security datasource for RBT security tables --> <security> <!-- JDBC JNDI name for the datasource --> <jndiName>jdbc/MySQLRbtDB</jndiName> <!-- User-friendly datasource name for display in administrator and designer --> <displayName>My SQL</displayName> <!-- default schema for database connection --> <schema>rbt</schema> <!-- table type accessible to RBT applications, there can be 1 or more of these. These names are the same used in the java.sql.DatabaseMetaData.getTables() method --> <tableTypes> <tableTypeName>TABLE</tableTypeName> <tableTypeName>VIEW</tableTypeName> </tableTypes> <!-- set to true to use the catalog name in the fully qualified table name for databases where the catalog is provided such as SQL Server 2005 --> <useCatalog>false</useCatalog> <!-- database management system name for display purposes - not currently used --> <dbms>MySQL</dbms> <!-- character to use when quoting database identifiers --> <quotedFieldChar>`</quotedFieldChar> <!-- concatenation operator to use if DBMS does not support SQL concat function --> <dbmsConcatOperator></dbmsConcatOperator> <!-- by default, when the RBT administrator load up to provide setting table access permissions for a user or a group, all tables and columns for each datasource are loaded - this can be expensive and time consuming. If you want to limit the accessible table names for a datasource, put the table names here. If this elements contains table, then only the table information for the specified tables will be loaded --> <tables></tables> </security> <!-- this definition of the datasources elements are the same as the security datasource above. there can be one or more data datasources accessible to RBT applications. --> <data> <jndiName>jdbc/MySQLDB</jndiName> <displayName>Sakila</displayName> <schema>sakila</schema> <useCatalog>false</useCatalog> <dbms>MySQL</dbms> <quotedFieldChar>`</quotedFieldChar> <tableTypes> <tableTypeName>TABLE</tableTypeName> <tableTypeName>VIEW</tableTypeName> <tableTypeName>SYS</tableTypeName> </tableTypes> <tables></tables> </data> <data> <jndiName>jdbc/sqlserver</jndiName> <displayName>DBO</displayName> <schema>dbo</schema> <useCatalog>true</useCatalog> <dbms>SQLServer 2005</dbms> <quotedFieldChar>"</quotedFieldChar> <tableTypes> <tableTypeName>TABLE</tableTypeName> <tableTypeName>VIEW</tableTypeName> <tableTypeName>SYS</tableTypeName> </tableTypes> <tables></tables> </data> <data> <jndiName>jdbc/oraclexehr</jndiName> <displayName>Human Resources</displayName> <schema>HR</schema> <useCatalog>false</useCatalog> <dbms>OracleXE</dbms> <quotedFieldChar>"</quotedFieldChar> <tableTypes> <tableTypeName>TABLE</tableTypeName> <tableTypeName>VIEW</tableTypeName> <tableTypeName>SYS</tableTypeName> </tableTypes> <tables></tables> </data> </datasources> <!-- RBT has 2 configurable NUR (not used recently) caches to improve performance. The dbObjectCache contains the security objects used by the database administrator for security setup. The formatCache contains user-specified date, time, timestamp and float format objects found in the document designs. --> <dbObjectCache> <!-- enable or disable object caching --> <enabled>true</enabled> <!-- max size of cache --> <maxSize>10</maxSize> <!-- interval in milliseconds that the cache will be checked for expired objects --> <checkInterval>100000</checkInterval> <!-- interval in milliseconds that the recently used set will be cleared --> <clearInterval>200000</clearInterval> <!-- default time in milliseconds that a cache object can stay in cache --> <timeToLive>300000</timeToLive> </dbObjectCache> <formatCache> <!-- enable or disable object caching --> <enabled>true</enabled> <!-- max size of cache --> <maxSize>20</maxSize> <!-- interval in milliseconds that the cache will be checked for expired objects --> <checkInterval>200000</checkInterval> <!-- interval in milliseconds that the recently used set will be cleared --> <clearInterval>300000</clearInterval> <!-- default time in milliseconds that a cache object can stay in cache --> <timeToLive>400000</timeToLive> </formatCache> <datasetCache> <!-- enable or disable object caching --> <enabled>true</enabled> <!-- max size of cache --> <maxSize>30</maxSize> <!-- interval in milliseconds that the cache will be checked for expired objects --> <checkInterval>300000</checkInterval> <!-- interval in milliseconds that the recently used set will be cleared --> <clearInterval>400000</clearInterval> <!-- default time in milliseconds that a cache object can stay in cache --> <timeToLive>500000</timeToLive> </datasetCache> <!-- By default the RBT designer provides a generic set of basic fonts and font families for document design - if you want to add more put the names here --> <additionalFonts> <fontName>Tahoma</fontName> <fontName>Sylfaen</fontName> <fontName>Calibri</fontName> <fontName>Century</fontName> <fontName>Engravers MT</fontName> </additionalFonts> </RbtConfiguration> XML Element Descriptions
Datasource DescriptionThere are 2 types of datasource specifications - <security> and <data>. There can be only one <security> datasource specified and this is the database containing the RBT security tables. There can be multiple <data> datasources specified and these define the available databases accessible to users for document design. Element definitions for both <security> and <data> are the same and are described below:
Cache DescriptionThe RBT application maintains 3 caches to improve performance and reduce database overhead:
Logging ConfigurationRBT uses log4j for logging and the log4j.properties file is located in the WEB-INF/classes directory of the rbt-1.3.1.war file. It is expected that the installer has J2EE and log4j knowledge to configure the logging properties as desired. Accessing RBTOnce the rbt war file is deployed to the web container the RBT applications can be accessed at the following URLs:
The initial administrator username and password are: admin/admin. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|