Description:

The Log Msg workflow step logs the configured message data to Loggly. The step accepts a single required Message data to log input and provides True and False return paths for subsequent workflow processing.

The step supports:

• Sending workflow message data to Loggly.
• Mapping message data for the log operation.
• Logging information generated during workflow execution.
• Sending structured workflow information to an external logging service.
• Routing the workflow through True or False paths after the logging operation.

Usage:

The Log Msg step is typically used when a workflow needs to send workflow-generated information to Loggly.

A typical workflow pattern is:

Workflow Activity → Log Msg → Continue Processing

For example:

Start
  ↓
Process Request
  ↓
Log Msg
  ↓
Continue Processing

The Loggly step requires a subscription from https://www.loggly.com. After signing up, configure the account information in the FlowWright configuration:

Typical Workflow Suggestions:

Log Workflow Processing Information

Use the Log Msg step to record information about an important workflow operation in Loggly.

Example:

Start
  ↓
Process Request
  ↓
Log Msg
  ↓
Continue Process

For example:

Process: Order Processing
Instance: {{InstanceID}}
Operation: Process Order
Status: Completed

Log Integration Activity

Use Log Msg after an external integration step to record information about the integration activity.

Example:

Prepare Request
      ↓
REST/API Call
      ↓
Log Msg
      ↓
Continue Processing

For example:

Integration: Customer API
Operation: Create Customer
Request ID: {{RequestID}}
Status: Completed

Log Workflow Errors

Use the step in an error-handling path when information about a workflow failure needs to be sent to Loggly.

Example:

Process Data
     ↓
   Error
     ↓
  Log Msg
     ↓
Notify Administrator

Process: Data Processing
Instance: {{InstanceID}}
Status: Error
Message: Data processing failed

Log Status Changes

Use Log Msg when a workflow reaches an important processing state.

Example:

Start
  ↓
Validate Request
  ↓
Log Msg
  ↓
Approve Request
  ↓
Log Msg
  ↓
Complete

Log Information Before or After a Major Operation

Use the step around significant workflow activities when operational information needs to be sent to Loggly.

Example:

Start
  ↓
Log Msg
  ↓
Large Processing Operation
  ↓
Log Msg
  ↓
Complete

Example:

Let’s build and execute the “clsLogglyDef” example.         

• Create a new process definition named “clsLogglyDef” and open it in designer mode. 
• Drag a “clsLoggly” step to the canvas.
• Connect the dots between the “Start” and “clsLoggly” steps, as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Click the “clsLoggly” step to configure its “Required” properties. Provide a name for the step. Click the button to configure the Loggly service message. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the button to configure the message for the Loggly service. A pop-up window appears for configuration. Click the Add Row (+) button to insert an empty row. Enter the key and value. Click the Save button. You may add multiple keys and values using the Add Row button. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. The process step should send messages to the Loggly service as configured.
• Log in to https://www.loggly.com/ using the userID and password to verify this message.

• The received message is stored in JSON format in Loggly.

Tips:

• Provide meaningful information in Message data to log so that the Loggly entry is useful during monitoring or troubleshooting.
• Include relevant workflow context such as the process name, operation, instance information, or processing status where appropriate.
• Use consistent message-data structures across workflows that send similar information to Loggly.
• Keep messages concise enough to remain useful when reviewing Loggly records.
• Avoid including passwords, authentication tokens, secrets, or other sensitive credentials in logged message data.
• Avoid unnecessarily logging confidential or sensitive business information.
• Use workflow Variables where appropriate to include runtime information in the message.
• Test the MessageData mapping before deploying the workflow.
• Verify that the expected message is received by Loggly after workflow execution.
• Connect the False path to appropriate error-handling logic.
• Test both successful and unsuccessful logging scenarios.
• Do not assume that the True return path means the message has been permanently retained unless that behavior has been verified in the FlowWright/Loggly implementation.
• Use meaningful event descriptions when multiple workflows send messages to the same Loggly environment.
• When troubleshooting, include enough workflow context to distinguish one workflow execution from another.
• Keep the MessageData mapping consistent when creating operational dashboards or searches based on the logged information.

Definition Sample:

You may download the sample definition and later import it into your FlowWright Process Definition (XML file) or Form Definition (HTML file).

Note: Verify and complete any missing configuration after importing the sample, including:

• MessageData mapping.
• Workflow Variable references.
• Environment-specific Loggly configuration.
• Loggly authentication/configuration, if required by the deployment.
• Downstream True and False workflow paths.
• Error-handling behavior.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.