Verj.io Server File System
See also: Introduction to the Server, Starting and Stopping the Server, Server Configuration
Installation
File System Layout
The Verj.io Server file system is divided into two distinct parts:
· Userdata: this file system includes all configurable files, and runtime data like log files and the Verj.io Server Repository Database. This should be separate from your installation directory.
For an external server the location of the server userdata file system is specified at installation time and defaults to <install target>/UserData/Server. The server’s userdata location can be changed using either of the following two methods:
· Edit file VerjioServer.server.inst at the root of the installation and change the VERJIO_SERVER_USERDATA variable
· Set the VERJIO_SERVER_USERDATA environment variable prior to starting the server
For the embedded server used by the studio, the default userdata location is <user home>/Verjio/Studio/embeddedServer
See Server Configuration for more detailed instructions.
The location of each part is specified at installation time.
This file system is initialised by copying the /Server/initData folder from the installation folder when the server is started for the first time.
Folder |
Description |
apps |
Container for Verj.io web applications |
ebase |
Container for each web application – this folder should have the same name as the web application as configured in /tomcat/conf/Catalina/localhost. The default name for the single web application created by the installer is ebase. This folder is returned by API method services.file.getUserDataApplicationPath(). |
backups |
Contains any workspace backups created using the Server Admin App. |
deployments |
Contains files relating to deployments that have been deployed to this web application. |
ebaseConf |
Contains the majority of the Verj.io server configuration files. These files are maintained using the Server Admin App or can be edited directly. |
generatedfiles |
This is the default location where files uploaded by end users are saved. This can be changed using the Server Admin App. |
generatedpdfs |
This is the default location where generated PDF files are saved. This can be changed using the Server Admin App. |
logs |
Contains the Verj.io server log file for this web app. See also tomcat/logs below. |
printFonts |
Optional directory containing additional fonts needed to generate PDFs. |
runtimeResources |
Contains copied web resource files that are configured within Server Resources files in the workspace. |
velocityTemplates |
This is the default location for Velocity templates, as configured in apps/ebase/ebaseConf/velocity.properties. |
webapp |
The root for the web application. Any additional web resources that are required should be added to this folder. This folder is returned by API method services.file.getWebAppRootFilePath(). |
webResources |
Can contain web resources, similar to webapp |
uploadedfiles |
Default location of files uploaded by the Fileupload control. This can be changed using the Server Admin App. |
WEB-INF |
|
classes |
Add any Java class files and property files here. This folder extends the corresponding WEB-INF/classes folder in the installation directory. |
lib |
Add any jar or zip files here. This folder extends the corresponding WEB-INF/lib folder in the installation directory. |
workspace |
The location of the distributed workspace |
conf |
Contains the legacy ebaselogin.config file |
DB |
Contains the distributed Apache Derby Repository database. Your system may be configured to use a different database provider. This configuration is in tomcat/conf/Catalina/localhost/ebase.xml. |
security |
Location of the directory containing the Java trust store. Certificates for any systems called from the Verj.io system may need to be added to this directory e.g. calling REST or SOAP web services. |
tomcat |
The root folder for any tomcat configurations. This extends the tomcat file system in the installation directory. |
bin |
Contains the setenv.bat/sh which is used to set Java memory and parameters when the server is started using the start_verjio_server.bat/sh files in the /Server/bin folder of the installation. |
conf |
Contains most tomcat configuration files, in particular server.xml which contains configuration of http ports and SSL when this is configured at tomcat level. |
Catalina |
|
localhost |
Contains the web application context file appname.xml (default is ebase.xml). This file contains configuration for any database connections defined at app server level plus the configuration for any transaction manager when the default of atomikos is not used. |
lib |
Add jar/zip files for any JDBC drivers here. This extends tomcat/lib in the installation system. |
logs |
Contains tomcat logs. See also apps/ebase/logs for the Verj.io server log. |
temp |
Temporary files |
webapps |
Location to add any non-Verj.io web applications |
work |
Work files. Will contain Java source and class files for any JSPs. |
winservice |
Contains the setvars.bat file which configures Java memory specification and parameters for the server when started as a Windows service. |
This layout is shown for information only. In general, files in this section should not be changed.
Folder |
Description |
.install4j |
Contains files relating to the installation |
ebase_licensing_files |
Internal use |
jre |
The Java runtime shipped with this version. |
licence |
Contains the form to apply for a new licence and supporting program |
OptionalLibraries |
Optional extras which require manual installation |
Pdfs |
Sample PDFs used by tutorials |
processXml |
Contains a legacy program to read scanned documents and run forms from XML files |
scripts |
Internal use |
Server |
Contains executable scripts to start and stop the server |
databaseSchemas |
Contains the database schemas for the repository database for all supported database types. |
initData |
Contains initial data for customer configurable files. This directory is copied to Userdata when the server is started for the first time. |
internalWorkspace |
Contains the Server Admin App and any other internal applications. |
samples |
Contains various sample files used by examples, tutorials etc. |
tomcat |
The root of the Tomcat distribution |
webapp |
The root of the Verj.io web application distribution |
winservice |
Contains scripts to start, stop and edit the Windows service |
wkhtmltopdf |
Contains the wkhtmltopdf executable used to create PDFs. |
taskTrigger |
Contains a batch program to trigger a scheduled task |
Third Party Product Licences |
Contains licences for any third party products included in the distribution. |