Skip to content

Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

Directory Structure

TORO Integrate's files and directories are arranged in a certain way to allow for convenient upgrades2, seamless data management and transfer, and easy location, extraction, and configuration of application behavior. For example:

  • Retaining Integrate Packages through upgrades2
  • Making Solr schema and data files accessible; handy when moving embedded Solr search engine data to a remote or cloud instance
  • Performing configuration changes based on a profile

As with most software, TORO Integrate's application files are generated during installation. Seen below is TORO Integrate's hierarchy of application files and folders:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<application-home>
├── bin
├── code
├── conf
│   └── application.properties
│   └── <prefix>.package.properties
│   └── ceji
│   └── jdbc-pool
│   └── transport-connectors
├── core
├── data
│   └── geoip
│   └── hsql
│   └── jms
│   └── solr
│   └── src-index
│   └── transaction-logs
├── lib
├── logs
├── packages
├── solr
├── tmp
├── web

The table below lists the directories above their purpose:

Directory Content and Purpose
bin Scripts, batch files, and shortcuts for starting, stopping, and restarting TORO Integrate. This directory also contains the CLI Tool.
code Gloop Models that belong to the core package, as seen in Coder's Coder Navigator view.
conf .properties files used to configure TORO Integrate; the esb-package.xml file for configuring the core package; the log4j.properties file for configuring application logging; and also contains the Groovy file used by TORO Integrate for customizing the Groovy compiler's behavior.
conf/ceji Text files comprised of messages or responses used by TORO Integrate CEJI.
conf/jdbc-pool3 XML files that contain database connection pool configuration information.
conf/transport-connectors3 XML files that contain Active MQ transport connector configuration information.
core TORO Integrate's Spring configuration files.
data .properties files for setting remote server configuration and overriding default TORO Integrate properties.
data/geoip3 Files used by the Tracker to add geolocation data to Tracker documents.
data/hsql3 Files used by the embedded Hypersonic databases.4
data/jms3 Files used by the embedded Active MQ message broker.5
data/solr3 Search indices used by the embedded Solr search engine.6
data/src-index3 Search index files used by TORO Integrate for code refactoring and searching.
data/transaction-logs3 Files used by TORO Integrate to ensure transactions are executed successfully.
lib JAR files used by TORO Integrate.
logs Log files generated by TORO Integrate.7
packages Contains Integrate Package directories8, each of which contains package-specific code, data, and configuration. Can be changed via the packages.home application property.
solr Configuration files for Tracker, API monetization, and API throttling.
tmp Directory used by the embedded Tomcat web server to store temporary files.
web Web pages and assets used by the web interface (Server Admin UI) of TORO Integrate.

Upgrading TORO Integrate

If you plan on upgrading an instance of TORO Integrate, you should at a minimum copy the following files and directories before overwriting, or migrating to a new installation in order to keep existing configuration, data, and integrations.

  • conf/*
  • data/*
  • packages/*

  1. See installation on Linux, Windows, MacOS, and TORO Cloud deployment. 

  2. Moving from one version of TORO Integrate to another; for example, from v3.0 to v3.1 whilst retaining data. 

  3. Does not appear on a fresh installation of TORO Integrate; not created until TORO Integrate's first start-up. 

  4. TORO Integrate uses HSQL for its core databases by default; for production-use, it is recommended to migrate to a better and more stable database engine. 

  5. See also TORO Integrate and ActiveMQ

  6. TORO Integrate uses Solr in custom search indices, the Monitor search index, and the Tracker search index

  7. See application logging

  8. Folders named after registered Integrate Packages.