Skyone
Skyone
English
English
  • Home
  • Data
    • Getting Started
      • Create an account
      • Recover Password
      • Quick Platform Guide
      • How to test the platform for free
      • Workspace
        • Creating a new Workspace
        • Find a Workspace
        • Sending an invitation to a Workspace
        • Editing a Workspace
      • Organizations
        • Creating an Organization
        • Organization Overview
        • Organization Management
        • Organization Monitoring
      • Settings and Preferences
        • Profile
        • Notifications
        • Usage and Billing
        • Users and Permissions
    • Modules
      • Module management
        • Creating a Module
        • Importing a Module
          • IAC Files - Integration as Code
        • Editing a module
        • Module Options
      • Settings and Operations
        • Module settings
          • Connectivity: Database
          • Connectivity: Email
          • Connectivity: REST
          • Connectivity: SOAP
          • Connectivity: File
          • Connectivity: RFC
          • Connected Account Management
        • Operations
          • Importing operations into REST Modules
          • Operation Management
        • Flows Using This Module
    • Monitoring
    • API Gateway
    • Terminals & Agent
      • Agent
        • Versions supported by Agent
        • How to Update the Agent Version
        • How to back up Agent files
      • Terminals
    • Data
      • Data Stack
        • Process Control
        • Data Stack Upload
        • File Actions
        • File Jobs
        • Data Job Parameters
        • Data Store
        • Data Share Features
        • ODBC
        • How to use the Data Engine Proxy
    • Integrations
      • Integration Management
        • Create integration
        • Import Integration
        • Edit Integration
        • Integration Options
        • Flows of this integration
      • Flows
        • Flow management
          • Creating a flow
          • Flow options
          • Flow Canva: configuring and editing the flow
            • Flow Canva: overview
            • Exception Handler
              • Exception Handler - Configuration
              • Exception Handler - Cases
            • Multicontext Flows
              • Example: Multicontext with an API Gateway
              • Example: Multicontext with a Time Trigger
            • Flow Settings
        • Triggers of a flow
          • API Gateway Triggers: Adding and Setting
          • AS2 Triggers: Adding and Setting
          • Queue Triggers: Adding and Setting
          • Flow Triggers: Adding and Setting
          • Time Triggers: Adding and Setting
          • Webhook Triggers: Adding and Setting
        • Tool Modules
          • AS2 Module
          • CSV Module
          • Data Transform Module
          • Data Balancer Module
          • EDI Module
          • Flow Call Module
          • IF Module
          • JavaScript Module
          • Log Module
          • Loop Do While Module
          • Loop For Module
          • Return Module
          • XML Module
          • Other Tool Modules
        • Module Header
        • Connecting components of a flow
        • Editing triggers and modules
        • Data Operations
          • Object Handling
            • Practical example: Handling variables
          • SMOP (Small Operations)
          • Parameterization rules
    • How to
      • Insert JSON into databases
      • Flattening: Data transformation using JSONata
      • How to use Form Data
      • Understanding recursion in JSONata
      • REST Module Output Consolidation
      • Isolated in execution: concept and application in variables
      • URL Parameters in API Gateway
      • Use case: API Gateway trigger parameters
      • Use case: Exception Handler in financial transactions
      • Use case: using Groups to manage access to flows
      • How to create a download endpoint and integrate with Power BI
      • Is it possible to use two triggers in a single flow?
      • How to set up WhatsApp in Skyone Studio
    • FAQ
    • GIGS: The complete guide
    • Glossary
  • Support
    • How do I request support?
    • Case Severity Levels
    • SLAs
    • Help & Resources
Powered by GitBook
On this page
  • Definition
  • Configuring the Log Module
  1. Data
  2. Integrations
  3. Flows
  4. Tool Modules

Log Module

PreviousJavaScript ModuleNextLoop Do While Module

Last updated 6 months ago

Definition

The "Log" tool module, standard module for use in any flow, was created to make it possible to identify what is happening in each of the operations in a flow, helping to resolve problems with systems external.

During the execution of a flow, you can get various responses from external modules and systems used in the flow. Some of these situations are handled automatically within the flow, but others require notification. The "Log" module fulfills this purpose, recording these situations with all the relevant information and alerting you in the desired way.

As an example, if you requested inclusion in company X, the same call could come back:

  • 200 successful

  • 200 with application error code (code not valid)

  • 500 with server error code

Situation 2 occurs in a loop, during the insertion of hundreds of products. With the Log module, instead of interrupting the flow, the "Log" module records the products that got this type of error, for later analysis.

This is just one example that shows the value of this module. There are many other situations in which there is an interest in recording what information is being manipulated.

Configuring the Log Module

The "Log" module consists of a single operation (Log events), which allows you to select up to three log storage locations, select the information you want to include and create parameters, which will also be used in the log message.

Message configuration

In "Message configuration" you can select or deselect each item, such as the destination, message content, etc.

Where:

  • Target: sends the logs to the entered location; if you don't select an option, the logs will appear in the Logger Components tab.

    • Local: stores the logs in the same repository where the module execution log messages are stored (Logger, Logs tab)

    • Syslog: Syslog server provided (requires additional configuration)

    • E-mail: e-mail address provided (requires additional configuration)

  • Message contents (checkboxes): here you must choose among the optional information that can be displayed in the log message, and you can also choose the log level

    • Integration ID: unique integration identification

    • Flow ID: unique flow identification

    • Execution ID: unique identification of each flow execution

    • Component ID: you should drag here a parameter from the desired operation

    • Severity: severity level of the log that will be displayed (CRITICAL, ERROR, WARNING, DEBUG); if this option is unchecked, DEBUG will be used by default

    • Timestamp: date and time record of the occurrence of a certain event in the flow

      • Date format (JSONATA): here you can change the date format

      • Timezone: the timezone field follows the "±HHMM" format, where ± is either the plus or minus sign and HHMM is the offset in hours and minutes from UTC. Positive offset is for timezones east of UTC, negative offset is for timezones west of UTC. Example: enter “-0300” for “GMT-3”

To finish configuring the module, click on "Save".

.

Parameter: here you can create/delete one or more log parameters to be displayed in the message, and you can drag parameters from other modules and even use a .

Find out about the Module Header here
SMOP
Definition
Configuring the Log Module
Message configuration
Configuration screen