Scripts use log messages to communicate with users. In EPM Workspace, logs are accessed through the Show Task Status list. On the desktop, in Interactive Reporting Studio, users view dds.log, which is the default name for script log files, and can be changed in the BAT file. In a standard installation, logs are located in the default folder C:\Hyperion\products\biplus\logs. Each execution of the script clears the log file. On the desktop, the log represents the entire set of tasks one for the folder and one for each file.
Note:
In the Dashboard Studio Inspector Utility Custom Update Script feature logging messages are also displayed in Task Options, in the Results window. See Dashboard Studio Inspector Utility.
The higher the level set, the more messages are displayed in the logs. The levels are explained in Table 9.
Table 9. Logging Levels
Level | Description |
|---|---|
Debug | Determines what is happening during script development or to track down problems |
Warn | Warns of recoverable problems that require correcting |
Error | Indicates the inability to correctly perform the requested processing |
Fatal | Indicates the script cannot continue |
Always | Messages that are always displayed |
There are env methods available to log messages at each of these levels. For example, env.logInfo(), env.logDebug(), and so on. See ScriptEnvironment Object.
There is also a default logging level associated with the script execution. The env.log() method logs messages at that level. The default level is initially debug, but can be changed by using env.setLogLevel().
The env.logClassName() method provides information on the type of an object, because values returned by methods are a combination of JavaScript and Java objects.