Logs
Logging
Logs from b+s Connects for SAP are written by default to the following directory: C:\ProgramData\BucherSuter\logfiles\MCAforSAP
The output files are simple ASCII text and can be opened with a conventional text editor, such as Notepad. However, it is more comfortable to open them with b+s EventLogView. Please contact b+s Customer Services for more information about the usage of this tool.
Logger Settings
All components except the b+s Media Manager share the same logging conecpt. Please follow the chapter Media Manager for logging related information of this component.
All logging related configuration are part of the respective configuration-file (.ini). If the values are <empt> or do not exist at all, the following default values are being set:
| Key | Ini-Default | Range | Description |
|---|---|---|---|
| Path | C:\ProgramData\BucherSuter\logfiles\MCAforSAP\ | - | Path to log file |
| FileSize | 100MB | - | Max. log file size |
| MaxBackupIndex | 10 | 1-50 | Number of log files |
The keys BsLoggerFile, BsLoggerFileSize, and BsLoggerMaxBackupIndex have been renamed to Path, FileSize, and MaxBackupIndex, respectively
These logger settings are not dynamic, i.e. the Windows services must be restarted for the adjusted settings to take effect.
Media Manager
The logging related configuration in the Media Manager component is located in the [Logger]-, and [Main]-section of the configuration-file (MediaManager_SAP1.ini). These settings are not dynamics, hence require a restart. To apply settings without restarting the windows service, the Media Manager command line interface include a refresh-command to apply new entered configuration immediately. For more information please go to Command Line Interface Settings Media Manager.
[MAIN]-Section
| Key | Default | Range | Description |
|---|---|---|---|
| LOG_VERBOSE | 0 | 0-1 | if set, writes short information on each telegram in the log file 1: Verbose logging on 0: Verbose logging off |
[LOGGER]-section
| Key | Default | Range | Description |
|---|---|---|---|
| PATH | C:\ProgramData\BucherSuter\ logfiles\MCAforSAP\ | - | Path where log files are written. To specify an absolute path, use the following syntax: C:\<AbsolutePath>\log |
| NAME | - | - | Short name for the log file (see next parameter for more information) |
| NAME_TYPE | 4 | 0-5 | Defines how the log file is generated (NAME refers the parameter above). 0 = NAME.log 1 = NAME_date.log 2 = NAME_date_timestamp.log 3 = NAME_machine_date_timestamp.log 4 = same as 2, but a new log file is created daily 5 = same as 3, but a new log file is created daily Note: when using NAME_TYPE 4 or 5, log files are automatically deleted after 10 days |
| OUTPUT_LEVEL | W | N, F, E, W, I, T | If the application is started in console mode, defines the log level of messages written to the console N = None F = Fatal Error (least verbose) E = Error W = Warning I = Info T = Trace (most verbose) |
| FILE_LEVEL | W | N, F, E, W, I, T | Defines the log level of messages written into the log file N = None F = Fatal Error (least verbose) E = Error W = Warning I = Info T = Trace (most verbose) |
| EXTERN_LEVEL | N | N, F, E, W, I, T | Defines the log level of messages written to the Windows Event Log. By default, MediaManager does not write any log message to the Event Log. Please note, that the EXTERN_LEVEL should be set to either ‘N’ (no log messages written to Event Log) or ‘E’ (Only Errors are written to the Event Log). Same levels as above. |
| TRACE_MASK | LEVEL2 | LEVEL1, LEVEL2, LEVEL3, LEVEL4 | Controls the trace mask of MediaManager. LEVEL0 => 0x000 LEVEL1 => 0x834 LEVEL2 => 0x876 LEVEL3 => 0x9F6 LEVEL4 => 0xFFF FUNCTION => 0x001 COMMUNICATION => 0x002 MILESTONE => 0x004 HEARTBEAT => 0x008 ERROR => 0x010 WARNING => 0x020 INFO => 0x040 TRACE => 0x080 TIME => 0x100 USER_DEFINED => 0x800 |
Log Trace Mask and Log Trace Collect Mask
Tracing of the b+s Connects for SAP components (except Media Manager) is controlled by the TraceMask- and TraceMaskCollectMsg- setting in the configuration-file (.ini). The two settings are dynamic, i.e. the Windows service does not have to be restarted for the adjusted trace levels to take effect.
Trace levels can be set in the [Dynamic]-Section of the configuration-file (.ini):
[Dynamic]
...
TraceMask=0xXXXXXXXX
TraceMaskCollectMsg=0xXXXXXXXX
...
You can find detailed information about the TraceMask-Settings in the Trace bits-Chapter.
Traces for Troubleshooting
CRMConnectorSAP
TraceMask=0x00000004 TraceMaskCollectMsg=0x00000000
Shows errors, warnings and info messages.
TraceMask=0x8001209f TraceMaskCollectMsg=0xfffffff4
TraceMask=0x8f0fe0ff TraceMaskCollectMsg=0xffffffff
DataStore
TraceMask=0x00000004 TraceMaskCollectMsg=0x00000000
Shows errors, warnings and info messages.
TraceMask=0x8007a01f TraceMaskCollectMsg=0x00000000
TraceMask=0x800fe01f TraceMaskCollectMsg=0xffffffff
Chat Connector
TraceMask=0x80000003 TraceMaskCollectMsg=0x00000003
TraceMask=0xffffffff TraceMaskCollectMsg=0xfffffff5
Media Manager
TraceMask=FILE_LEVEL=W
TraceMask=FILE_LEVEL=T
CRMConnectorOutboundSAP
TraceMask=0x80000003 TraceMaskCollectMsg=0x80000003
TraceMask=0xfffffff5 TraceMaskCollectMsg=0xfffffff5
Changing the default value can have a serious performance impact. It should only be modified by experienced administrators or if requested by a b+s Customer Service representative. Reset the trace level to default once the logs have been collected to avoid performance impact.
Version, Status and Product Activation Key Information
The b+s Connects for SAP components write periodical status information into the logfile:
| Component | Periodical Message |
|---|---|
| CRMConnectorSAP | SysInfo;AS:2;ARM:0;MRI:0;EC:218;WC:113;MAC:0:0:0;MTC:0:0:0;MRC:0:0:0; |
| Data Store | 012.20.23134 VEXE:2.1.0(52621);VDS:2.1.0.52591;AS:4;EC:1;WC:45;MC:15 |
| Media Manager | SysInfo: CTI + (2), MRI + (3) Routing +, MCIL-CL 3, RT-CL 3, Agts 0, PJ-RH 0, PJ-ARM 0 |
| Item | Description |
|---|---|
| AS: | Application Status (1= Idle, 2=Connecting, 3=Reconnecting, 4=Connected) |
| Agts: | Number of Agents |
| ARM: | ARM Interface Status (1=Online, 0=Offline) |
| CTI: | Shows status of CTI connections (+=connected, -=not connected) |
| EC: | Errors Count |
| MAC: | Monitors Agent Count |
| MC: | Transactions Monitor Count |
| MCIL-CL: | Number of MCIL clients connected |
| MRI: | MRI Interface Status (1=Online, 0=Offline, +=enabled) |
| MTC: | Monitors Transactions Count |
| PAK: | Product Activation Key entered during the installation of the CRMConnectorSAP |
| PJ-ARM: | Pending Jobs towards CTI Server |
| PJ-RH: | Internal pending jobs |
| Routing: | Checks if Routing session is available (+=available, -=not available) |
| RT-CL: | Number of Routing Clients |
| VDS: | Version of theIcmDsServiceDll.dl |
| VEXE: | Version of the DataStore.exe |
| WC: | Warnings Count |
The Product Activation Key listed above is just an example and will not be considered as valid in real deployments.
CRMConnectorOutboundSAP
Version Information
The CRMConnectorOutboundSAP writes the following information into its log file at startup:
CRMConnectorOutboundSAP product.ini: 2.1.0.0
Selected: 1
Major: 2
Minor: 1
MaintenanceRelease: 0
Engineering Special: 0
product.ini path: C:\Program Files (x86)\BucherSuter\MCAforSAP\CRMConnectorOutboundSAP\product.ini
Application Start Arguments
The CRMConnectorOutboundSAP writes all application start arguments into its log file at startup.
Initialize CRMConnectorOutboundSAP as Console, instance: SAP1
Application Initialize Arguments
cons
SAP1
Initialization Configuration
The CRMConnectorOutboundSAP writes the complete initialization configuration file into its log file at startup.
Configuration File: CRMConnectorOutboundSAP_testeo.ini
Full path: C:\ProgramData\BucherSuter\MCAforSAP\CRMConnectorOutboundSAP\CRMConnectorOutboundSAP_SAP1.ini
File Content:
[Logger]
MaxLogFileSize=50MB
MaxLogFileCount=10
TraceMask=0xffffffff
...