"RemoveLogFields" Activity

TABLE OF CONTENTS

1. Activity program name
2. Description
3. Properties
4. How to use

1. Activity program name

RCA.Activities.Core.RemoveLogFields

2. Description

• Up to Studio version 2.0.2.0:
  Quick Access: "Toolbox" > "Core" > "Remove Log Fields"

• From Studio version 2.0.3.0:
  Quick Access: "Toolbox" > "Core" > "Log" > "Remove Log Fields"

This activity allows you to remove custom log fields from each log message.

Tested on Studio versions: 2.1.1.1, 2.1.1.2
Note: Descriptions and terms may vary depending on the version.

3. Properties

4. How to use

This section explains the use of the "Remove Log Fields" activity through an example.

Example: Adding and Then Removing Custom Log Fields

In this example, we'll configure a workflow to add a custom field to log messages, then remove it, and verify the changes.

Step-by-Step Instructions

Place the "Add Log Fields" Activity
Drag and drop the "Core" > "Log" > "Add Log Fields" activity from the Toolbox into the Designer panel.

Configure the Custom Field
Open the "Fields" property of the activity and configure the following:

• Name: Enter "TestField".

• Direction: Ensure it is set to "Input".

• Type: Select "String".

• Value: Enter "Test".
  After entering the values, click "OK".

Place the "Log Message" Activity
Drag and drop the "Core" > "Log" > "Log Message" activity from the Toolbox into the Designer panel.

Configure the Log Message
Set the following properties for the "Log Message" activity:

• Level: Select "Info".

• Message: Enter "Added Field Check".

Place the "Remove Log Fields" Activity
Drag and drop the "Core" > "Log" > "Remove Log Fields" activity from the Toolbox into the Designer panel.

Configure the Field to Remove
Open the "Fields" property of the activity and configure the following:

• Direction: Ensure it is set to "Input".

• Type: Select "String".

• Value: Enter "TestField".

Place Another "Log Message" Activity
Drag and drop another "Log Message" activity into the Designer panel and configure the following:

• Level: Select "Info".

• Message: Enter "Removed Field Check".

Run the Workflow
Save the workflow and execute it by clicking "Home > Start" or pressing F5.

Verify the Logs
After execution, open the log files by clicking "Open Logs" from the top menu. Navigate to the directory containing the log files.

• For example, the log file might be named: yyyy-mm-dd_Studio_Execution.log.

• Open the log file and check the entries:

  • "Added Field Check": The custom field "TestField" will appear with the value "Test".

  • "Removed Field Check": The custom field "TestField" will no longer appear.