enaio® manager-for-logfiles
During installation of enaio®, the logging library oxrpt.dll, the configuration file oxrpt.cfg, and enaio® manager-for-logfilesaxprotocolcfg.exe are installed in every directory containing enaio® components.
To change the default logging settings for components contained in this directory, use the oxrpt.cfg configuration file in the same directory or create new channels for components.
Every component reads its logging settings from the configuration file in its directory when the program is launched.
The enaio® manager-for-logfiles User Interface
enaio® manager-for-logfiles is not incorporated in the enaio® rights system. Secure access to enaio® manager-for-logfiles via the operating system.
When the application starts, enaio® manager-for-logfiles opens the installed configuration file oxrpt.cfg from the application directory. The data from this configuration file is used for logging all components from the directory. The path and file name are shown in the title bar and the status bar.
You can change the logging path for standard logs, activate or deactivate flow, SQL, error, and job call logging, and change the logging level for flow logging.
Specify the path using any notation. Relative paths are also possible.
The choice between Internal logging and Text format refers exclusively to the logging for enaio® capture. We recommend that you choose internal logging. Customers who prefer to continue working with the text format, however, can retain the setting. enaio® capture always creates batch-specific logs which can be opened from within the application.
Changes apply to all components in the directory for which no individual channel has been set up.
Channels are created in the Channel settings area, while the Alias settings area allows you to assign channels to components and activate these assignments.
Exit the editor by clicking Cancel or by pressing ESC; any changes you have made will however not be saved. Click Apply to save the changes and then exit the editor.
Channels
A channel accepts messages with the same action ID from one or more components and can store the messages in the internal log format or in OXMISC format.
Logs in the internal log format (*.evn) can be opened using enaio® protocol-viewer; logs found in the OXMISC format can be opened with any editor.
We recommend the internal log format, since logs in enaio® protocol-viewer can be displayed in a highly structured manner.
Internal Log
Channels in the internal log format have the following properties:
Property |
Default value |
Range of values |
|
---|---|---|---|
Action |
15 |
15 = Flow 11 = Memory 9 = SQL 8 = Error 7 = Job call |
|
Level |
1 |
0 = Only error log 1 = Application initialization 2 = Function entry points 3 = Function exit points 4 = Significant function points 5 = Detailed log 6 = Debug log |
|
Stopped |
NO |
NO/YES 'YES' turns off the channel. |
|
Optional |
YES |
NO/YES If 'NO' is set, this prevents the component from starting when the channel is not available. |
|
Share |
YES |
NO/YES If 'YES' is set, multiple components can use the same channel to send messages. |
|
LogRecreation |
YES |
NO/YES If 'YES' is set, a new log file will be created once the current log file exceeds the maximum size. |
|
LogStartupTimeout |
5000 |
A timeout for logging in milliseconds after the start of the component. |
|
LogStopTimeout |
5000 |
A timeout for logging in milliseconds after the component is stopped. |
|
LogFileName |
os%6%7%5.evn |
Specify a path and a name for the log files. A relative path leads to the application directory. The file and folder name may contain the following parameters: |
|
%2 |
Name of the executed component |
||
%3 |
Name of the computer |
||
%5 |
Year in two-digit format |
||
%6 |
Day |
||
%7 |
Month |
||
Enter 'evn' as the file extension. |
|||
LogMaxFileSize |
65536 |
The maximum size of a log file; the value in kilobytes must be between 1024 and 524288. 524288 kilobytes correspond to 512 MB. |
|
LogSizeControlOn |
0 |
0 – disabled, 1 – enabled The size of the log directory can be monitored. |
|
LogExpirationDays |
3 |
Once the high-water mark which defines the size of the log directory is exceeded during log generation, logs that are older than the value specified here will be deleted until either the low-water mark is reached or no more log files exist. |
|
LogHighWater |
192 |
Upper limit for number of files in the directory |
|
LogLowWater |
96 |
Lower limit for number for files in the directory |
OXMISC Log
Channels in OXMISC format have the following properties:
Property |
Default value |
Range of values |
---|---|---|
Action |
15 |
15 = Flow 11 = Memory 9 = SQL 8 = Error 7 = Job call |
Level |
1 |
0 = Only error log 1 = Application initialization 2 = Function entry points 3 = Function exit points 4 = Significant function points 5 = Detailed log 6 = Debug log |
Stopped |
NO |
NO/YES 'YES' turns off the channel. |
Optional |
YES |
NO/YES If 'NO' is set, this prevents the component from starting when the channel is not available. |
Share |
YES |
NO/YES If 'YES' is set, multiple components can use the same channel to send messages. |
MiscLogPath |
Standard path |
The log directory specified in the standard settings is always used. |
MiscLogFormat |
TDUXMJP |
T = Time; D = Date; U = User; X = Station; M = Module; J = Job; P = Procedure |
MiscLogType |
0 |
0, is ignored. |
OXMISC logs are always saved to the log path specified in the default settings. They are given the following names:
Flow logs |
osddmmjj.flw |
SQL logs |
osddmmjj.sql |
Error logs |
osddmmjj.err |
Job call logs |
osddmmjj.log |
An example of an OXMISC log entry:
BEGIN
TIME : 12:55:50
DATE : 02/29/03
USER : THOMAS
STATION : 11D3-080009FEC5ED
MODUL : oxdbodbc
JOB : DisConnect
STRING : SQLFreeEnv(m_hEnv)
End
Setting Up Channels
Use the Channel settings area to set up channels. Click the Edit button to open the Channel configuration dialog.
It lists all pre-configured channels and allows you to edit or delete them.
Press Add to set up a channel.
The Channel properties dialog will now open.
Enter a channel name and select Internal logging or Logging in OXMISC format as the channel type. The default properties of the selected log type will be shown in the Settings area.
Click Edit to modify the properties:
Confirm your changes by pressing OK button in both the Channel properties and the Channel configuration dialog. As a result, the channel will be ready for assignment to components.
Components
The Alias settings area enables you to assign channels to components.
Existing channel assignments are listed in this area and can be edited or deleted. Selected assignments (þ) are active.
Open the Alias properties dialog by pressing Add.
Enter the name of the component in the Alias field. You can assign a channel to each executable file (*.exe) and each library (*.dll). Do not add the file extension when entering the name of the component in the Alias field.
You can enter any text in the Description field.
Select the intended channel from the list of configured channels.
To assign the channel, click OK.
Press Apply to save the configuration and to exit enaio® manager-for-logfiles.