Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following tables contains the  

Companyname
 directory structure with a description of each directory's or file's purpose. The table also indicates whether a directory or file is required to restore a backup of the system.

Release 2019_01 (June 2019 / Version 6 R10.4 ) or newer

Expand
PathDescriptionRequired for Backup?

On Linux: /etc/EnterpriseWizardConfig.xml

On Windows: C:\EnterpriseWizardConfig.xml
Main Agiloft configuration file. It contains all the parameters of the instance and is used by the installer for upgrades and reconfiguration.Yes
AGILOFT_HOMERoot directory of the Agiloft instance.Yes
All paths below are relative to AGILOFT_HOME.
dataMain directory for non-database data.No
data/backupsContains backups made by Agiloft on a knowledgebase level. It contains a directory for each knowledgebase on the server. The directory names match the knowledgebase names.No
data/<KB NAME>/scriptsContains external scripts used by rules.Yes
data/<KB NAME>/largeObjectsContains the content of attached files in a knowledgebase. Metadata is stored in a database, so if an OS-level backup of the database is done, the directories for each knowledgebase must also be stored.Yes
data/<KB NAME>/reportsContains the results of scheduled reports that have been executed.No
data/<KB NAME>/walletContains the private key used to decrypt knowledgebase data if the encrypt/decrypt feature is used.No
data/<KB NAME>/keystoreContains a backup of the knowledgebase's private key.Yes
jre

Directory for the Java Runtime Environment shipped with

Companyname
. It's used to avoid possible compatibility issues if Java is already installed on the server.

Yes
wildfly

Root directory of the Wildfly Application Server. It contains the server itself and the deployed

Companyname
code. The
Companyname
configuration is stored in the wildfly/standalone/configuration/ directory.

Yes
wildfly/standalone/logContains wildfly logs. Can be excluded from any backups.No
wildfly/standalone/tmpContains application temporary data and should be excluded from any backups.No
logsDirectory for log files of installation, upgrade, and configuration modifications.No
software

Directory for downloaded third-party software that is not included with the

Companyname
distribution.

No
spool

Directory for temporarily storing incoming and outgoing emails used by the

Companyname
email subsystem.

No
resourcesDirectory for all project information, scripts, and nginx-related items.Yes
alWinProperty.propertiesContains build and software update properties.Yes
bin

Directory for

Companyname
internal executables, including installer utilities, start and stop scripts, diagnostics, and other management tools.

Yes
issue/amd64-windows.xml /linux.xmlContains the configuration of all software details and versions.Yes
libDirectory for project-related jar files.Yes
htdocsDirectory for knowledgebase-specific login pages.Yes
EnvironmentVars

File used to set environment variables, such as "EW_STARTUPCHECKER_SKIP_CHECKS_UNLESS_PATCHED=true," and should move with the installation between servers if the

Companyname
application is moved. If any environment variables are set when the application is installed, this file is used.

Yes
Setup.exe

Utility for setting different configuration settings, such as Wildly and database configuration, web server integration,

Companyname
services control, software updates, backups and restores, snapshots, mail settings, etc.

Yes
uninstall.exe

Utility for uninstalling the

Companyname
application.

Yes
clamavRoot directory for ClamAv antivirus.No
Python

Python installation shipped with

Companyname
and used by custom script actions.

No
update/current/Directory used when upgrading that keeps a backup of the current system's configuration files and the latest installer resources. In case of an upgrade failure, the configuration files are restored to help rollback the application to its last working state. With a successful upgrade, the backup files and installer resources are removed from this folder.No
license

Directory for storing html files that describe the terms and conditions of

Companyname
's End-user License Agreement.

No
tmpDirectory for storing temporary files that are required during installation or when upgrading. Files in this directory are generally deleted after usage.No
build.xml

Ant build file with target actions that deploy configuration files and unzip the dependent software resources required to run

Companyname
.

No
confDirectory storing the samplekbconf.xml file, which contains the knowledgebase's configuration of tables and features supported in the system.No
mysqlMySQL DB root directory.Yes



Release 2018_02 (November 2018 / Version 6 R10.3) /  or older

Expand
PathDescriptionRequired for Backup?

On Linux: /etc/EnterpriseWizardConfig.xml

On Windows: C:\EnterpriseWizardConfig.xml
Main Agiloft configuration file. It contains all the parameters of the instance and is used by the installer for upgrades and reconfiguration.Yes
AGILOFT_HOMERoot directory of the Agiloft instance.Yes
All paths below are relative to AGILOFT_HOME.
dataMain directory for non-database data.No
data/backupsContains backups made by Agiloft on a knowledgebase level. It contains a directory for each knowledgebase on the server. The directory names match the knowledgebase names.No
data/<KB NAME>/scriptsContains external scripts used by rules.Yes
data/<KB NAME>/largeObjectsContains the content of attached files in a knowledgebase. Metadata is stored in a database, so if an OS-level backup of the database is done, the directories for each knowledgebase must also be stored.Yes
data/<KB NAME>/reportsContains the results of scheduled reports that have been executed.No
data/<KB NAME>/walletContains the private key used to decrypt knowledgebase data if the encrypt/decrypt feature is used.No
data/<KB NAME>/keystoreContains a backup of the knowledgebase's private key.Yes
jre

Directory for the Java Runtime Environment shipped with

Companyname
. It's used to avoid possible compatibility issues if Java is already installed on the server.

Yes
jboss

Root directory of the Jboss Application Server. It contains the server itself and the deployed

Companyname
code. The
Companyname
configuration and code is stored in the jboss/server/sw directory.

Yes
jboss/server/sw/logContains jboss logs. Can be excluded from any backups.No
jboss/server/sw/tmp

Contains application temporary data and should be excluded from any backups.

No
jboss/server/sw/workContains application temporary data and should be excluded from any backups.No
logsDirectory for log files of installation, upgrade, and configuration modifications.No
software

Directory for downloaded third-party software that is not included with the

Companyname
distribution.

No
spool

Directory for temporarily storing incoming and outgoing emails used by the

Companyname
email subsystem.

No
resourcesDirectory for all project information, scripts, and nginx-related items.Yes
alWinProperty.propertiesContains build and software update properties.Yes
bin

Directory for

Companyname
internal executables, including installer utilities, start and stop scripts, diagnostics, and other management tools.

Yes
issue/amd64-windows.xml /linux.xmlContains the configuration of all software details and versions.Yes
libDirectory for project-related jar files.Yes
htdocsDirectory for knowledgebase-specific login pages.Yes
EnvironmentVars

File used to set environment variables, such as "EW_STARTUPCHECKER_SKIP_CHECKS_UNLESS_PATCHED=true," and should move with the installation between servers if the

Companyname
application is moved. If any environment variables are set when the application is installed, this file is used.

Yes
Setup.exe

Utility for setting different configuration settings, such as Jboss and database configuration, web server integration,

Companyname
services control, software updates, backups and restores, snapshots, mail settings, etc.

Yes
uninstall.exe

Utility for uninstalling the

Companyname
application.

Yes
clamavRoot directory for ClamAv antivirus.No
Python

Python installation shipped with

Companyname
and used by custom script actions.

No
update/current/Directory used when upgrading that keeps a backup of the current system's configuration files and the latest installer resources. In case of an upgrade failure, the configuration files are restored to help rollback the application to its last working state. With a successful upgrade, the backup files and installer resources are removed from this folder.No
license

Directory for storing html files that describe the terms and conditions of

Companyname
's End-user License Agreement.

No
tmpDirectory for storing temporary files that are required during installation or when upgrading. Files in this directory are generally deleted after usage.No
build.xml

Ant build file with target actions that deploy configuration files and unzip the dependent software resources required to run

Companyname
.

No
confDirectory storing the samplekbconf.xml file, which contains the knowledgebase's configuration of tables and features supported in the system.No
mysqlMySQL DB root directory.Yes