Log message

Created by akaBot Support, Modified on Wed, 20 Nov, 2024 at 4:39 PM by akaBot Support

About the "Log Message" Activity

TABLE OF CONTENTS

Program name of the activity
Description
Properties
Usage

1. Program name of the activity

RCA.Activities.Core.LogMessage

2. Creating templates

For Studio Versions ~2.0.2.0:
Quick Access:
Toolbox > Core > Log Message

For Studio Versions 2.0.3.0~:
Quick Access:
Toolbox > Core > Log > Log Message

This activity allows you to display a specified message.

When executed in Studio, the message will appear in Studio's Output panel.
When executed from Center, the message will be logged in Center.

Notes:

Tested versions of akaBot Studio: 2.0.2.0, 2.0.3.0, 2.0.4.0.
Some wording or features may vary depending on the version.

3. Properties

Property item	Property name	Input field	Description
Other	Property	Checkbox	Variables and arguments within the activity are written to the log file and pushed to Center. (For details, see the section "About the 'Public' Property".)
Other	Display name	Enter a value (String type)	Reflected in the activity name on the Designer panel.
Input	Message	Enter a value (Object type)	Enter the message to be displayed.
Input	Level	Dropdown selection	Select the log level from the dropdown menu. ※

※ You can select the log level from the dropdown menu: Fatal, Error, Warn, Info, or Trace.

When the "Level" property is set, the log will display the corresponding log level as follows:

Level	Display
Fatal	FATAL
Error	ERROR
Warn	WARNING
Info	INFORMATION
Trace	※

※ "Trace" is displayed only when the "Log Level" of akaBot Agent is set to "ALL" as of akaBot Studio version 2.0.4.0. However, it is currently being updated to also display when the Agent's "Log Level" is set to "Debug".

4. How to use

Drag and drop the "Log Message" activity from "Core" > "Log" in the Toolbox to the Designer panel.

Select the "Level" property from the dropdown menu. For this example, choose "Warn".
※ The choice of log level should be determined by the robot creator/designer.

Set the message you want to display in the "Message" property. For this example, set it to "Display a Warn message".

Click "Home > Start" or press the F5 key to run the process. The log will be displayed in the Output panel. In this case, the message "Display a Warn message" will appear, along with the execution date and time.