CHANGE_LOGGING

The CHANGE_LOGGING script function triggers a log file change. Administrators can configure system-wide settings (such as the number of days or maximum file size in MB) that automatically trigger a log file change in the UC_SYSTEM_SETTINGS variable. You can also define temporary changes that apply until the next system restart on the Properties tab of the Administration perspective. The log file storage location is defined in the INI file of the server or agents.

Syntax

CHANGE_LOGGING (Component)

Parameters

Parameter Format Description Allowed Components
Component AE name or script variable

Name of the component whose log file should be changed.
  • Communication Process
  • Work Process
    Important! Even if you change the log file of only one work process, this automatically applies to all work processes.
  • Agent
  • Agent Group
    Important! If you define an agent group, the log files of all corresponding agents change. The system does not return an error if one of the agents is inactive and its log file cannot be changed.

Return Codes

This script function returns the following codes:

  • 0
    The log file has successfully been changed.
  • 20223
    The specified agent group does not exist.
  • 20722
    The indicated server process, agent, or agent group does not exist or is inactive.

Examples

The following example changes the log file of all work processes.

:SET &RET# = CHANGE_LOGGING("AE#WP001")

See also: