Log File Maintenance
EnterWorks maintains the following sets of log files:
-
Job log files: Log files produced by jobs when they are run.
-
System log files: Log files produced by EnterWorks services.
-
EPX System log files: Log files produced by EPX.
The required maintenance for log files is:
-
Log files must be periodically archived.
-
Archived log files must be periodically deleted or moved to external storage.
Note that the configuration of EnterWorks varies depending on the needs of the customer organization and their archival policies. Any scripts provided with EnterWorks are specific to the organization. Also, the organization is expected to manage the space available on the server and determine how frequently logs are to be archived and how long the archived logs are to be kept.
Job Log Files
Job files are produced when jobs are run. The job files can be accessed via the Job Monitor. When a job is run, up to three types of files may be produced:
-
Job log file.
-
Job error file.
-
Job product file (which may be a correction file).
Job log files and job error files are kept in a directory that can be accessed by all other servers in the configuration via a network connection. (Note that the hosting server also accesses the directory via a network connection.) These job files are stored in sub-folders according to the type of the job that produced them. The path to the job files log folders is:
<drive>:\Enterworks\logs\EnableServer\<type-of-job>
There are two sub-folders that do not hold job files. They are:
-
<drive>\Enterworks\logs\EnableServer\tomcat
-
<drive>\Enterworks\logs\EnableServer\wildfly
These folders hold system log files for the Tomcat, EnableServerWildflyController, and EnableServerWildflyWorker services. They are described in System Log Files.
System Log Files
The EnterWorks components produce system logs. These system logs are kept locally on the server that generates them and are stored according to the component that produced them. Most of these logs are stored in:
<drive>:\Enterworks\logs\<component-name>
The exceptions are:
-
Tomcat's logs are stored in:
<drive>:\Enterworks\logs\EnableServer\tomcat
-
WildflyController and WildflyWorker logs are stored in:
<drive>:\Enterworks\logs\EnableServer\wildfly
-
EPX log files are stored in:
<drive>:\Enterworks\logs\EPX
For all services, the Start Enterworks.cmd
archives and
cleans up the system log files each time it is run, with the exception of the
EPX BIC_<machine-name>.log
system log file,
(see EPX System Log
Files). Therefore, if EnterWorks services are restarted regularly, such
as once a week, the maintenance on these system log files is performed
automatically. However, if EnterWorks services are not restarted frequently
enough, the log files must be cleaned up by the Scheduled
Cleanup feature or manually, (see Manually Archiving and Removing Files).
EPX System Log Files
The EPX system log files are maintained in the same manner as the other system
log files, with the exception of the EPX BIC_<machine-
name>.log
system log file. While EPX is running, this
log file is always open and it cannot be archived.
To archive the file, the EPX service must be stopped, the file archived, then the EPX service must be restarted. (See Restarting EnterWorks Services.)